Class type: |
exception |
Include file: |
dexcept.e |
Package: |
Diamond Standard Class Library |
Superclass: |
|
Description: |
Can be used to indicate a mathematical error. Normally, one of its subclasses would be thrown. |
Class type: |
interface |
Include file: |
dcontain.e |
Package: |
Diamond Standard Class Library |
Description: |
Defines the essential methods for limited-access containers. |
Instance methods: |
Count#0 Should return the number of elements in the container. |
|
Get#0 Should return an element of the container specified by the particular container class. |
|
Insert#1 Should insert its parameter into the container at a position specified by the particular container class. |
|
Remove#0 Should remove and return the element of the container specified by the particular container class. |
Class type: |
exception |
Include file: |
dcontain.e |
Package: |
Diamond Standard Class Library |
Superclass: |
|
Description: |
Can be used to indicate that an attempt was made to access a non-existent element of a comtainer. |
Class type: |
exception |
Include file: |
dexcept.e |
Package: |
Diamond Standard Class Library |
Superclass: |
|
Description: |
Can be used to indicate an attempt to perform a prohibited action. |
Class type: |
null class |
Include file: |
diamond.e |
Package: |
Diamond Kernel |
Superclasses: |
All classes. |
Interfaces: |
All interfaces. |
Description: |
Used for error reporting. It does have properties or methods, and no instances can be created. Diamond provides a single pre-created instance: Null_Instance. |
Class type: |
exception |
Include file: |
dexcept.e |
Package: |
Diamond Standard Class Library |
Superclass: |
|
Description: |
Can be used to indicate an overflow condition in a variable. |
Class type: |
exception |
Include file: |
dexcept.e |
Package: |
Diamond Standard Class Library |
Superclass: |
Exception |
Description: |
Can be used to indicate that certain functionality is not available on the current platform.. |
Class type: |
abstract |
Include file: |
dcontain.e |
Package: |
Diamond Standard Class Library |
Superclass: |
|
Interfaces: |
|
Description: |
Provides a data structure in which the elements have a priority level. (See Priority_Queue and Priority_Stack). |
Instance properties: |
Descending (private) Used internally to distinguish Priority_Stack and Priority_Queue subclasses. |
|
Priority (private) a Sorted_Sequence used to track the priorities of the elements. |
Inherited instance property: |
From Basic_Container: Data |
Instance methods: |
clone#0 (normal public) Overrides method inherited from Basic_Container. Clones the Priority property of its target. |
|
delete#0 (normal public) Overrides method inherited from Basic_Container. Deletes the Priority property of its target. |
|
Insert#1 (normal public) Overrides method inherited from Basic_Container. The parameter is the element to be added to the priority container. Inserts the element into its target with priority 0. Returns NIL. |
|
Insert#2 (normal public) Overrides method inherited from Basic_Container. The first parameter is the element to be added to the priority container, the second parameter is the element's priority, which must be an integer. Inserts the element into its target at a location determined by the priority, so that higher priority elements will be removed first. Returns NIL. |
|
Remove#0 (normal public) Overrides method inherited from Basic_Container. Removes and returns the highest priority item in its target. Among elements of equal priority, removes and returns the first for queues and the last for stacks. Throws Container_Empty and returns NIL if its target is empty. |
Inherited instance methods: |
From Basic_Container: Count#0, Find#1, Find_Last#1, Get#0, Get#1, Remove#1, Set#2 |
Class methods: |
new#0 (normal public) Overrides method inherited from Basic_Container. The same as class method new#1, setting the new instance's Descending property to FALSE to specify a stack. |
|
new#1 (normal protected) The parameter must be a boolean. Creates and returns a new instance of its target class. Sets the new instance's Descending property to the parameter--TRUE specifies a queue, FALSE specifies a stack. Sets the new instance's Priority to an empty Sorted_Sequence. Returns Null_Instance if an exception is thrown. |
Class type: |
normal |
Include file: |
dcontain.e |
Package: |
Diamond Standard Class Library |
Superclass: |
|
Interfaces: |
|
Description: |
Provides a queue (a last-in/first-out data structure) in which the elements have a priority level. |
Inherited instance properties: |
From Priority_Container:
Descending, Priority |
Inherited instance methods: |
From Priority_Container:
clone#0, delete#0, Insert#1, Insert#2,
Remove#0 |
Class method: |
new#0 (normal public) Overrides method inherited from Priority_Container. Creates and returns a new instance of its target class by calling Priority_Container's new#1 class method with TRUE as the parameter to specify a queue. |
Inherited class method: |
From Priority_Container: new#1 |
Class type: |
normal |
Include file: |
dcontain.e |
Package: |
Diamond Standard Class Library |
Superclass: |
|
Interfaces: |
|
Description: |
Provides a stack (a last-in/first-out data structure) in which the elements have a priority level. |
Inherited instance properties: |
From Priority_Container:
Descending, Priority |
Inherited instance methods: |
From Priority_Container:
clone#0, delete#0, Insert#1, Insert#2,
Remove#0 |
Inherited class methods: |
From Priority_Container: new#0, new#1 |
Class type: |
normal |
Include file: |
dcontain.e |
Superclass: |
|
Interface: |
|
Description: |
Provides a first-in, first-out data structure. |
Inherited instance property: |
From Basic_Container: Data |
Instance methods: |
Get#0 (normal public) Overrides method inherited from Basic_Container to return the element at the front of the queue. |
|
Remove#0 (normal public) Overrides method inherited from Basic_Container to remove and return the element at the front of the queue. |
Inherited instance methods: |
From Basic_Container: clone#0, Count#0, delete#0, Find#1, Find_Last#1, Get#1, Insert#0, Insert#1, Remove#1, Set#2 |
Inherited class method: |
From Basic_Container: new#0 |
Class type: |
abstract |
Include file: |
dsingle.e |
Package: |
Diamond Standard Class Library |
Superclass: |
|
Description: |
Provides classes which can have only one instance. |
Inhertied class properties: |
From Limited_Instances: Limit |
Inherited instance methods: |
From Limited_Instances: clone#0 |
Class methods: |
Limit#1 (final private) Overrides method inherited from Limited_Instances to return 1 and made final to prevent overriding in subclasses. |
Inherited class methods: |
From Limited_Instances: Initialize#0, new#0 |
Class type: |
normal |
Include file: |
dcontain.e |
Package: |
Diamond Standard Class Library |
Superclass: |
|
Interfaces: |
|
Description: |
Provides self-sorting sequences. |
Instance properties: |
Descending (private) A boolean value indicating whether or not to sort in descending order. Defaults to FALSE. |
|
Ignore_Case (protected private) A boolean value indicating whether or not to ignore case in comparisons. Read access is protected for use by subclassess with custom sorts. Defaults to FALSE. |
|
Unique (private) A boolean value indicating whether or not elements of the sequence must be unique. Defaults to FALSE. |
Inherited instance property: |
From Basic_Container: Data |
Instance methods: |
Custom_Compare#0 (normal private) Returns -1, indicating no custom comparison. To be overridden in subclasses to return the routine_id of a comparison function. |
|
Find#1 (normal public) Overrides method inherited from Basic_Container. Finds the first occurrence of the parameter by binary search, controlled by the values of Ignore_Case and Descending. If Custom_Compare#0 returns a routine_id, does the comparison by using call_func() with the routine_id. Returns the position in the container of the parameter if it is found, otherwise returns the negative of the position at which the parameter would be inserted. |
|
Find_Last#1 (normal public) Overrides method inherited from Basic_Container. Same as Find, but finds the last occurrence of the parameter. |
|
Get#1 (normal public) Overrides method inherited from Basic_Container to make method public. |
|
Get_Data#0 (final protected) Overrides method inherited from Basic_Container to be a null method. |
|
Insert#1 (normal public) Overrides method inherited from Basic_Container. Calls Find_Last#1 to find the last occurrence of the parameter. If the parameter is not found, calls Basic_Container's Insert#2 instance method to insert the parameter. If the parameter is found, throws Duplicate_Element if Unique is TRUE, otherwise calls Basic_Container's Insert#2 instance method to insert the parameter. Returns NIL. |
|
Remove#1 (normal private) Overrides method inherited from Basic_Container to make method public. |
Inherited instance methods: |
From Basic_Container: clone#0, Count#0, delete#0, Get#0, Insert#2, Remove#0, Set#2 |
Class methods: |
new#1 (normal public) Creates and returns a new instance of its target class. Sets the new instance's Ignore_Case property to the value of the parameter, which must be a boolean. Returns Null_Instance if an exception is thrown. |
|
new#2 (normal public) Creates and returns a new instance of its target class. Sets the new instance's Ignore_Case and Descending properties to the values of the parameters, which must be booleans. Returns Null_Instance if an exception is thrown. |
|
new#3 (normal public) Creates and returns a new instance of its target class. Sets the new instance's Ignore_Case, Descending, and Unique properties to the values of the parameters, which must be booleans. Returns Null_Instance if an exception is thrown. |
Inherited class method: |
From Basic_Container: new#0 |
Class type: |
normal |
Include file: |
dcontain.e |
Superclass: |
|
Interface: |
|
Description: |
Provides a last-in, first-out data structure. |
Inherited instance property: |
From Basic_Container: Data |
Inherited instance methods: |
From Basic_Container: clone#0, Count#0, delete#0, Find#1, Find_Last#1, Get#0, Get#1, Insert#0, Insert#1, Remove#0, Remove#1, Set#2 |
Inherited class method: |
From Basic_Container: new#0 |
Class type: |
normal |
Include file: |
dvar.e |
Package: |
Diamond Standard Class Library |
Superclass: |
|
Interface: |
|
Description: |
Provides structures with named elements which are instances of Variable. |
Instance properties: |
Elements (private) Sequence of the names of the elements of the structure. |
|
Type_Checks (private) Sequence of the type checks for each element. Each will be a the routine_id of a type or NO_TYPE_CHECK. This is a transient property. |
|
Variables (private) Sequence of the instances of Variable which constitute the elements. |
Instance methods: |
Add_Element#1 (normal public) Adds an element to the structure whose name is given by the parameter and sets its Type_Check property to NO_TYPE_CHECK. If the structure already contains an element of this name, throws Duplicate_Element. Returnsd NIL. |
|
Add_Element#2 (normal public) Same as Add_Element#1, but sets the element's Type_Check property to the second parameter, which must be the routine_id of a type or NO_TYPE_CHECK. |
|
After_Restore#0 (normal protected) When called automatically by restore_entity(), creates a nappropriate length sequence of NO_TYPE_CHECK as the value of Type_Checks. |
|
clone#0 (normal public) Overrides method inherited from Entity. Makes a deep copy of the target.. |
|
delete#0 (normal public) Overrides method inherited from Entity. Deletes all instances in Variables. |
|
Get#1 (normal public) If the parameter is the name of an element, returns the value of the element by calling the elements's Get#0 method. If not, throws Missing_Element and returns NIL. |
|
Initialized#0 (final public) Returns TRUE if all elements of the structure are initialized, otherwise returns FALSE. |
|
Initialized#1 (final public) If the parameter is the name of an element, returns TRUE if the element has been initialized. In all other cases, returns FALSE. |
|
Link_Get_Handler#2 (final public) If the first parameter is the name of an element, links a handler or a sequence of handlers specified by the second parameter to the element's Set#2 event (see link_handler()). If not, throws Missing_Element. Returns NIL. |
|
Link_Set_Handler#2 (final public) If the first parameter is the name of an element, links a handler or a sequence of handlers specified by the second parameter to the element's Get#1 event (see link_handler()). If not, throws Missing_Element. Returns NIL. |
|
Prototype#0 (normal public) Works the same as clone#0, but does not copy the values of the elements, only thier names and types. |
|
Set#2 (normal public) If the first parameter is the name of an element, writes the second parameter to the element by calling the element's Set#1 method. If not, throws Missing_Element. Returns NIL. |
|
Uninitialize#1 (final public) If the parameter is the name of an element, calls the element's Uninitialize#0 method and returns the element's old value. If not, throws Missing_Element and returns NIL. |
|
Uninitialize#2 (final public) If the parameter is the name of an element, calls the element's Uninitialize#1 method passing the second parameter and returns the element's old value. If not, throws Missing_Element and returns NIL. |
Class method: |
new#0 (normal public) Overrides method inherited from Entity to provide public access. |
Class type: |
exception |
Package: |
Diamond Kernel |
Superclass: |
|
Description: |
Indicates a type check failure. This will be the most commonly throw exception, but will usually thrown by type wrappers. See Type Checking. Uniquely, Type_Check_Failure does not cause program termination if thrown when another Type_Check_Failure is pending. |
Class type: |
exception |
Include file: |
dsingle.e |
Package: |
Diamond Standard Class Library |
Superclass: |
|
Description: |
Indicates an attempt to create more intances of a subclass of Limited_Instances than allowed. |
Class type: |
exception |
Include file: |
dvar.e |
Package: |
Diamond Standard Class Library |
Superclass: |
|
Description: |
Indicates an attempt to get an uninitialized variable. |
Class type: |
exception |
Include file: |
dexcept.e |
Package: |
Diamond Standard Class Library |
Superclass: |
|
Description: |
A generic exception to indicate an error has occurred but no information is available. |
Class type: |
normal |
Include file: |
dvsaver.e |
Package: |
Diamond Standard Class Library |
Superclass: |
|
Description: |
Provides automated saving and restoring of program variables to an EDS database. All instance properties are TRANSIENT -- a Var_Saver instance cannot itself be saved and restored. |
Instance properties: |
Restored (private) If program variables have been restored from the database, is an Indexed_Sequence containing the variable names and values, otherwise is Null_Instance. |
|
Saved (private) An Indexed_Sequence containing variable names and values to be saved to the database. |
|
Table (private) An identifier giving the name of the table in the database to which to save/from which to restore variables. |
Instance methods: |
Clear_Restored#0 (final pubic) Clears Restored by deleting the Indexed_Sequence if it has been created. |
|
Clear_Saved#0 (final public) Clears Saved by removing all of the elements of the Indexed_Sequence. |
|
Clear_Table#0 (final public) Same as Clear_Table#1, clearing all entries. |
|
Clear_Table#1 (final public) Clears the database table indicated by Table. If the parameter is zero, all entries are cleared. If the parameter is a positive integer, the most recent entries equal in number to the parameter are not cleared. If the parameter is a negative integer, the earliest entries equal in number to the negative of the parameter are not cleared. If the absolute value of the parameter is greater than or equal to the number of entries, nothing is cleared. If the parameter is not an integer, clears the entire table. If any entries are cleared, compresses the database. If there is a problem with the database, throws File_Open_Error, File_Lock_Error, or File_Read_Error. Returns NIL. |
|
delete#0 (final public) Overrides method inherited from Entity. Deletes the Indexed_Sequence value of Saved, and of Restored if applicable. |
|
Read#0 (final public) Reads the most recent entry in the database table indicated by Table. Sets Restored to the Indexed_Sequence recreated by using restore_entity() on the table entry. If there is a problem with the database, throws File_Open_Error, File_Lock_Error, or File_Read_Error. If restore_entity() fails, throws Bad_Data. Returns NIL. |
|
Restore#1 (final public) The parameter is any Euphoria object identifying the variable to be restored. (By design, this is not restricted to identifiers to allow encryption, etc.) Returns the variable value. Throws Bad_Data if Restored is equal to Null_Instance (indicating that a previous Read#0 failed or wasn't done). Throws Type_Check_Failure if no variable name in Restored matches the parameter. Returns NIL if an exception is thrown. |
|
Save#2 (final public) The first parameter is any Euphoria object identifying the variable to be saved. (By design, this is not restricted to identifiers to allow encryption, etc.) The second parameter is the variable's value. Stores the variable identifier and value in Saved, overwriting any previous value that may exist. NOTE: non-entity variables have the values at the time Save#2 is called, but Save#2 only saves an entity's handle. Thus an entity's value is the value of its properties at the time Write#0 is called. It is strongly recommended to do all Save#2 calls immediately before calling Write#0. |
|
Write#0 (normal public) Transforms the Indexed_Sequence value of Saved into a storable form by using save_entity(), then writes an new entry in the database table indicated by Table consisting of a record key based on the date and time and a record value of the storable form. If there is a problem with the database, throws File_Open_Error, File_Lock_Error, or File_Write_Error. Returns NIL. |
Inherited instance methods: |
From Entity: clone#0 |
Class methods: |
new#1 (normal public) Creates and returns a new instance of Var_Saver. Sets the Table property of the new instance to the parameter, which must be an identifier. Creates the subdirectory dvsaver under the user's Euphoria directory if doesn't already exist. Creates the EDS database dvsaver.edb in the dvsaver directory if it doesn't already exist, opens it if it does. Adds a table named by the parameter if it doesn't already exist. If there is a problem with the database, throws File_Open_Error, File_Lock_Error, or File_Write_Error. If an exception is thrown, does not create a new instance and returns Null_Instance. |
Inherited class method: |
From Entity: new#0 |
Class type: |
normal |
Include file: |
dvar.e |
Package: |
Diamond Standard Class Library |
Superclass: |
|
Interface: |
|
Description: |
Provides reference variables which generate events when read or written. |
Instance properties: |
Data (private) Stores the value of the variable. |
|
Initialized (public private) A boolean, indicating whether or not the variable has been intialized. |
|
Type_Check (private) The routine_id of a type to be used type-checking the variable, or the constant NO_TYPE_CHECK (the deafult value). |
Instance methods: |
clone#0 (normal public) Overrides method inherited from Entity to provide public access. |
|
delete#0 (normal public) Overrides method inherited from Entity to provide public access. |
|
Get#0 (normal public) Raises Get#1 with the value of the variable as the parameter, then returns the value. If Initialized is FALSE, throws Unintialized_Variable and returns NIL without raising the event. |
|
Set#1 (normal public) If the parameter is of the correct type, writes it to the variable and raises Set#2 with the old and new values as parameters. If not the correct type, throws Type_Check_Failure without raising the event. Returns NIL. |
|
Uninitialize#0 (final public) Sets Data to NIL, sets Initialized to FALSE, sets Type_Check to NO_TYPE_CHECK; returns the variable's old value. |
|
Uninitialize#1 (final public) As Uninitialize#1, but sets Type_Check to the parameter, which must be the routine_id of a type or NO_TYPE_CHECK. |
Class method: |
new#0 (normal public) Overrides method inherited from Entity to provide public access. |
|
new#1 (normal public) Creates and returns a new instance of Variable, setting Type_Check to the parameter, which must be the routine_id of a type or NO_TYPE_CHECK. |
Instance events: |
Get#1 (public private) Raised by the Get#0 method, the parameter is the variable's value. |
|
Set#2 (public private) Raised by the Set#1 method, the parameters are the variable's old and new values. |
Class type: |
exception |
Include file: |
ddelegat.e |
Package: |
Diamond Standard Class Library |
Superclass: |
|
Description: |
Indicates the attempt to call a method of a Delegate that is inappropriate for the type of Delegate. |
Class type: |
exception |
Include file: |
dexcept.e |
Package: |
Diamond Standard Class Library |
Superclass: |
|
Description: |
Can be used to indicate an attempt to divide by zero. |