LifeLines Programmers Reference

Version 3.0.2

up | previous | next | Tom Wetmore | ttw@shore.net | LifeLines


Built-in Functions

The LifeLines programming language provides a long list of built-in functions. Most built-ins return values and require parameters. The values of the parameters and the values returned by built-ins belong to a variety of value types that are supported by the programming language. The table below describes the types of values that are used in LifeLines programs; these are the types of variables, parameters (to procedures, functions and built-ins) and return values (from functions and built-ins). In the remaining sections the built-in functions are separated into logical categories and described.


Value Types

Anyunion of all types
Intinteger (on most systems a 32-bit signed value)
Boolboolean (0 represents false; anything else represents true)
Stringtext string
Listarbitrary length list of any values
Tablekeyed look-up table
Indiperson; reference to a GEDCOM person record
Famfamily; reference to a GEDCOM family record
Setarbitrary length set of persons
NodeGEDCOM node; reference to a line in a GEDCOM tree/record
Eventevent; reference to substructure of nodes in a GEDCOM record
Voidtype with no values

In the summaries of built-in functions, each function is shown with its argument types and its return type. The types are from the preceding list. Sometimes an argument to a built-in function must be a variable; when this is so its type is given as XXX_V, where XXX is one of the types above. The built-ins do not check the types of their arguments. Variables can hold values of any type, though at any one time they will hold values of only one type. Note that Event is a subtype of Node, and Bool is a subtype of Int. Built-ins with type Void actually return null (zero) value.


up | previous | next | Tom Wetmore | ttw@shore.net | LifeLines

1/1/00