File tom/Constants


class tom.Constants

The constants used throughout the tom unit.

variables

Trie constants

const TRIE_PLAIN = 0;
The plain option indicates absence of other options.
const TRIE_REVERSED = 1;
Reverse the string before insertion or lookup.
const TRIE_FOLD_CASE = 2;
Ignore the case during a lookup; use lower-case characters during an insert.
const TRIE_LOOKUP_PREFIX = 4;
Do not require a full match in a lookup; the longest prefix will match with this option specified.

Open flags

const FILE_EXIST_NOTHING = 1;
If the file exists, do nothing (and return nil).
const FILE_EXIST_RAISE = 2;
If the file exists, raise a condition.
const FILE_EXIST_TRUNCATE = 4;
If the file exists and output_p, truncate it to zero length.
const FILE_EXIST_SUPERSEDE = 8;
If the file exists and output_p, a new version of the file will be created (by unlinking the old file first).
const FILE_NOT_EXIST_NOTHING = 16;
If the file does not exist, do nothing (and return nil). If only input_p, nil will also be returned if it can't be opened anyway.
const FILE_NOT_EXIST_RAISE = 32;
If the file does not exist, raise a condition.
const FILE_NOT_EXIST_CREATE = 64;
If the file does not exist and output_p, create it.
const FILE_APPEND = 128;
Every write will append to the end of the file.
const FILE_MASK = 255;
A mask for the above flags.
const FILE_TYPE_NONEXISTENT = 0;
Retrieving information about a file.
const FILE_TYPE_OTHER = 1;
const FILE_TYPE_SOCKET = 2;
const FILE_TYPE_LINK = 3;
const FILE_TYPE_REGULAR = 4;
const FILE_TYPE_BLOCK = 5;
const FILE_TYPE_DIRECTORY = 6;
const FILE_TYPE_CHARACTER = 7;
const FILE_TYPE_FIFO = 8;

Positioning a SeekableStream

const STREAM_SEEK_SET = 0;
Position absolute.
const STREAM_SEEK_CUR = 1;
Position relative to the current position.
const STREAM_SEEK_END = 2;
Position relative to the end of the file.

TypeDescription types.

const TYPEDESC_VOID = 0;
This value indicates the void type. The other values follow the same naming convention.
const TYPEDESC_BOOLEAN = 1;
const TYPEDESC_BYTE = 2;
const TYPEDESC_CHAR = 3;
const TYPEDESC_INT = 4;
const TYPEDESC_LONG = 5;
const TYPEDESC_FLOAT = 6;
const TYPEDESC_DOUBLE = 7;
const TYPEDESC_POINTER = 8;
const TYPEDESC_SELECTOR = 9;
const TYPEDESC_REFERENCE = 10;
const TYPEDESC_DYNAMIC = 11;
const TYPEDESC_NUM = 12;
This is not a real type; it merely denotes the number of TYPEDESC_ values.

instance tom.Constants


Generated by tm 1.01.