String lists

var /s_myList1, /s_MyList2
# instead of
# SListClear /s_MyList1
# SListClear /s_MyList2
# you can write
^a = "/s_MyList1"
SListClear ^a
^a = "/s_MyList2"
SListClear ^a

This statement was added to xelagot 3.600 to help migrating old databases to the new DB style. Record number %i (from 1 to number of records obtained with SListCount %c) gets retrieved: the name field is assigned to $n, the other fields are assigned to the variable list, which is similar to the ones in SListGetFields. To migrate the database from old style in /s_old to /s_new, do something like this in a loop, where the name is retrieved in $citnumber, and there are 3 more fields, of which $citname is URLEncoded:

SListGetRecord /s_old %i $citnumber $citname %life %shots
URLDecode $citname $citname
DBSetFields /s_new $citnumber 3 $citname %life %shots

Note: If you need the whole value part of the name=value pair, use SListGetValue.

Similar to the previous statement but retrieves from new style database. May come in useful to retrieve a record by number. Do not use it to migrate databases!

xelagot 3.606 Note: If you need the whole value part of the name=value pair, use DBGetValue.

Put (or modify) a name=value pair in a string list:

1. SListSetValue /s_myList $n $v
2. SListSetValue /s_myList %n $v

Remove a name=value pair from a list:

1. SListDeleteName /s_myList $n
2. SListDeleteName /s_myList %n

List the names as a comma separated string in $a:

1. SListGetNames /s_myList $a

List the names as an SDF comma separated string in $a (xelagot 3.606):

1. SListGetNamesSDF /s_myList $a

use GetFirstSDF $n $a repeatedly to recover individual names in $n, until $n has an empty string.

Get the value associated with a name:

1. IfSListGetValue /s_myList $n $v statement1
   Else statement2
2. IfSListGetValue /s_myList %n $v statement1
   Else statement2

1. SListGetValue /s_myList $n $v
2. SListGetValue /s_myList %n $v

1. IfSListGetNameValue /s_myList $a $n $v statement1
   Else statement2

For parsing a string, for example string $a, there are a few statements associated with string list names. These can be used, for example, to parse chatlines: the script scans all names in the string list to see if one of them appears in string $a, either as a substring of $a or as a word in $a.

Parsing $a for name as substring of $a: test if any of the names is a substring of $a. If this is the case, $a will be split into 3 parts: $a1 containing the part before the name, $n containing the name as spelled in $a, $a2 contains the rest of $a after the name. $v contains the value associated with $n

1. IfNameInString /s_myList $a $a1 $n $a2 $v statement1
   Else statement2
2. IfSListNameInString /s_myList $a $a1 $n $a2 $v statement
   Else statement2

Parsing $a for name as word in $a: test if any of the names is a word of $a. Delimiters for words are: space and .,;:¡!¿?. If this is the case, $a will be split into 3 parts: $a1 containing the part before the name, $n containing the name as spelled in $a, $a2 contains the rest of $a after the name. $v contains the value associated with $n

1. IfNameWordInString /s_myList $a $a1 $n $a2 $v statement1
   Else statement2
2. IfSListNameWordInString /s_myList $a $a1 $n $a2 $v statement
   Else statement2

(x1 2.9999977) To sort a list by names:

1. SListSortNames /s_MyList or
   SListReverseSortNames /s_MyList for string names
2. SListSortUCNames /s_MyList or
   SListReverseSortUCNames /s_MyList for url encoded names
3. SListSortIntNames /s_MyList or
   SListReverseSortIntNames /s_MyList for names if they are integers
4. SListSortNumNames /s_MyList or
   SListReverseSortNumNames /s_MyList for names if they are numbers or date-time
    

(x1 2.9999977) To sort by values, %f must be -1.

1. SListSortField /s_MyList %f or
   SListReverseSortField /s_MyList %f for string field number %f
2. SListSortUCField /s_MyList %f or
   SListReverseSortUCField /s_MyList %f for url encoded field number %f
3. SListSortIntField /s_MyList %f or
   SListReverseSortIntField /s_MyList %f for integer field number %f
4. SListSortNumField /s_MyList %f or
   SListReverseSortNumField /s_MyList %f for numeric or date-time field number %f

1. SListSetField /s_myList $n %f $a
2. SListSetField /s_myList %n %f $a

You can modify more than one field at a time. %c is then the number of the last field to be modified (it may be a literal), 'variables' is a space separated list of variables of the type allowed in fields, starting by field number 1 up to the last field. To avoid modifying a field, just put an 'x' or any characters which are not a variable instead of a variable in the right position in this list.

1. SListSetFields /s_myList $n %c variables
2. SListSetFields /s_myList %n %c variables

To retrieve values from fields, use SListGetField and SListGetFields:

1. SListGetField /s_myList $n %f $a
2. SListGetField /s_myList %n %f $a

1. SListGetFields /s_myList $n %c variables
2. SListGetFields /s_myList %n %c variables

A record can be retrieved by index (xelagot 3.600), this is handy to migrate databases to the new style:

1. SListGetRecord /s_myList %index $name variables

1. IfSListGetValue /s_myList $n $v statement
2. IfSListGetValue /s_myList %n $v statement

Remove a record:

1. SListDeleteName /s_myList $n
2. SListDeleteName /s_myList %n

To totalise a numeric field at position %f, putting the total in %i, use:

1. SListAddField /s_myList %f %i

To make a comma separated list in $a of all the strings in field number %f, use:

1. SListAddField /s_myList %f $a

For a comma separated list of names im $a, use the old

1. SListGetNames /s_myList $a

(x1 2.9999977) To sort a list by names:

1. SListSortNames /s_MyList or
   SListReverseSortNames /s_MyList for string names
2. SListSortUCNames /s_MyList or
   SListReverseSortUCNames /s_MyList for url encoded names
3. SListSortIntNames /s_MyList or
   SListReverseSortIntNames /s_MyList for names if they are integers
4. SListSortNumNames /s_MyList or
   SListReverseSortNumNames /s_MyList for names if they are numbers or date-time
    

(x1 2.9999977) To sort by a field, %f must have the field number (0 for names, 1 or higher for fields).

1. SListSortField /s_MyList %f or
   SListReverseSortField /s_MyList %f for string field number %f
2. SListSortUCField /s_MyList %f or
   SListReverseSortUCField /s_MyList %f for url encoded field number %f
3. SListSortIntField /s_MyList %f or
   SListReverseSortIntField /s_MyList %f for integer field number %f
4. SListSortNumField /s_MyList %f or
   SListReverseSortNumField /s_MyList %f for numeric or date-time field number %f

1. DBSetField /s_myList $n %f $a
2. DBSetField /s_myList %n %f $a

You can modify more than one field at a time. %c is then the number of the last field to be modified (it may be a literal), 'variables' is a space separated list of variables of the type allowed in fields, starting by field number 1 up to the last field number %c. To avoid modifying a field, just put an 'x' or any characters which are not a variable instead of a variable in the right position in this list.

1. DBSetFields /s_myList $n %c variables
2. DBSetFields /s_myList %n %c variables

To retrieve values from fields, use DBGetField and DBGetFields:

1. DBGetField /s_myList $n %f $a
2. DBGetField /s_myList %n %f $a

1. DBGetFields /s_myList $n %c variables
2. DBGetFields /s_myList %n %c variables

A record can be retrieved by index (index starts at 1), $n will receive the name, the variables receive the other fields:

1. DBGetRecord /s_myList %index $n variables

You can test if a record exists by name $n or %n, $v will receive a record, i.e. a comma separated list of DBEncoded fields (as from xelagot 3.600)

1. IfDBGetValue /s_myList $n $v statement
2. IfDBGetValue /s_myList %n $v statement

Or you can simply retrieve the record as in previous statement but without the conditional testing (xelagot 3.606)

1. DBGetValue /s_myList $n $v
2. DBGetValue /s_myList %n $v

This record $v can be used to retrieve the individual field values (xelagot 3.606)

1. DBRecodGetField $v %c variable
2. DBRecodGetFields $v %c variables

similar to DBGetField and DBGetFields, only in this case the information is contained in a string and not a string list.

Remove a record:

1. DBDeleteName /s_myList $n
2. DBDeleteName /s_myList %n

To totalise a numeric field at position %f, putting the total in %i, use:

1. DBAddField /s_myList %f %i

To make a comma separated list in $a of all the strings in field number %f, use:

1. DBAddField /s_myList %f $a

For a comma separated list of DBDecoded names in $a, you can also use:

1. DBGetNames /s_myList $a

For a SDF comma separated list of DBDecoded names in $a, you can also use (xelagot 3.606):

1. DBGetNamesSDF /s_myList $a

use GetFirstSDF $n $a repeatedly to recover individual names in $n, until $n has an empty string.

To load from and save to file (filename $f), use:

1. DBLoad /s_myList $f [%r]
2. DBSave /s_myList $f

To clear the database, to copy from database /s_myList2 to /s_myList1 (clearing /s_myList1 first), and to count the records, use:

1. DBClear /s_myList
2. DBCopy /s_myList1 /s_myList2
3. DBCount /s_myList %c

If the database was retrieved from an SQL query and lacks a name field, i.e. is a pure DBEncoded comma separated list (e.g. when %KeyField = -1 in the query), a numeric name value followed by an equal sign can be prepended to each record, starting with 1 and ending with the number of records (xelagot 3.606)

1. DBRenumber /s_myList

To sort a list by names:

1. DBSortStringNames /s_MyList or
   DBReverseSortStringNames /s_MyList for names if the are (DBEncoded) strings.
2. DBSortIntNames /s_MyList or
   DBReverseSortIntNames /s_MyList for names if they are integers
3. DBSortNumNames /s_MyList or
   DBReverseSortNumNames /s_MyList for names if they are numbers or date-time
    

To sort by a field, %f must have the field number (0 for names, 1 or higher for fields).

1. DBtSortStringField /s_MyList %f or
   DBReverseSortStringField /s_MyList %f for (DBEncoded) string field number %f.
2. DBSortIntField /s_MyList %f or
   DBReverseSortIntField /s_MyList %f for integer field number %f
3. DBSortNumField /s_MyList %f or
   DBReverseSortNumField /s_MyList %f for numeric or date-time field number %f