Simplistic Object Oriented Programming (SOOP) API Library Version 1.0 Beta Created by: Mario SteeleIt is suggested that you look at Documentation Notes before continuing with reading this documentation.Website: http://enchantedblade.trilake.net/ Filename: soop.e Details: This includes the entire soop system for use in the language.
SOOP is a Object Oriented Programming library, that is a basic re-write of the entire PHPized Object Oriented Library. This library still uses the basics of what POOP has entailed, with function such as Class(), new(), method_func(), and so on. It's been renamed, and re-organized, to be easier to maintain, as well as readability to the end user.
SOOP is split up into several files, which deal with each section of the SOOP Architecture. When you want to use SOOP, you simply include soop.e into your program, and everything will be ready for you.
SOOP is free to re-distribute, modify, or hack in general to your liking. However, any redistributions of the SOOP library require that you clearly mark in the library what section of code you modified, and a modified copy of the source code be re-submitted to the author of the library.
For Release Notes, see relnotes.txt
Topic | Description |
Index | Alphabetical list of all items. |
Class Definition | The core of structuring Data and Routines in SOOP |
Class Low Level Routines | These are Low Level Routines specifically for use with the Class Definition system. |
Data Type Low Level | The Core of how Data Types Work |
Data Type System | The new way to do Types! |
Documentation Notes | General Notes about how the Documentation is written. |
Object Low Level Routines | Low level routines that deal with the Object Enviroment |
Object Manipulation | Routines for Creating, Manipulating and Destroying Class Objects. |
Polymorphism | Information for how SOOP handles Polymorphism |
SOOP Constants | Constants used throughout the SOOP library |
SOOP Data Types | Data Types implemented for the SOOP Library. |
SOOP Debug | A Class built on SOOP to display Debug Information |
SOOP Low Level API | A general warning about Low Level API in SOOP |
SOOP Low Level Routines | Low Level routines for use in the SOOP Library, and others. |
proc
] Associates a Routine ID as an Assignment Call.const
] Euphoria's Atomic Data Typeproc
] Begins a Class Definition.proc
] This writes a String to the file defined in the SOOP Debug Class Object.func
] Returns the Class Name of the Object Instance.proc
] Adds RoutineID to the list of Constructors for a class.proc
] This begins the definition of a Data Typeproc
] Returns the Data Type ID for use.func
] Check to see if a DataType allows a Pointer to be returned.proc
] Releases the resources for the DataType variable space.func
] Returns the Data Type's name, as defined.func
] Initalizes the Data Type for use.func
] This retrives the actual data stored in a Data Typefunc
] Calls the handler for the Assignment of data.const
] Tells the debug class to output debug information from the Class enviroment.const
] Tells the debug class to output debug information from the Object enviroment.proc
] Stores a filename for use with the Debug Class.proc
] Adds RoutineID to the list of Deconstructors for a class.proc
] Terminates the Class Definition Block your currently in.proc
] Ends the DataType Definitionproc
] Allows the current class to Inherit attributes from a parent class.const
] Euphoria's Integer Data Typeproc
] Declares MemberName in the current Class Definition, of DataType.proc
] Attaches a Euphoria Routine to a Class Definition.func
] This creates a Method Call Back ID for use with External Libraries.func
] Calls a Method on a Object Instancefunc
] Creates a Method ID on a Method declared on an Object Instance.proc
] Calls a Method on a Object Instance.func
] Creates a New object given by Class, and returns it's instance if successfully created.proc
] Dis-allows for Pointer Retrival.func
] Stores the Object Instance into Memoryconst
] Euphoria's Object Data Typeproc
] This writes a String to the file defined in the SOOP Debug Class Object.func
] Converts an Object Instance back from a ASCII Encoded Sequences Flat String.func
] Converts an Object Instance into an ASCII Encoded Sequence Flat String.func
] This returns the data stored in a Member of Object.func
] Returns the last data retrived with oget() on the object instance.func
] Reads a Object Instance Data from a Memory Locationfunc
] Reads a Object stored in a file, back into a Instance in Memory.proc
] Stores data into a Member on a Object Instance.proc
] Writes an Object Instance to File.proc
] Destroys a Object Instance given.proc
] Associates a Routine ID as an Retrival Call.func
] This returns a Printable String of the SOOP Enviroment for debugging purposes.const
] Euphoria's Sequence Data Typefunc
] This returns a Printable String of the SOOP Enviroment for debugging purposes.func
] func
] Shorthand way to get the Class' instance in the class table.func
] Returns the list of currently defined Classesfunc
] Retrives the Construct Routines for the Given Class.func
] Similar to soop_EnumConstruct()func
] Returns the list of Members defined on the given Class.func
] Returns the Declared Methods on a Class.proc
] Internal SOOP Error Routine.func
] func
] func
] func
] Returns True if the Sequence given is a ASCII Printable stringfunc
] Returns the Data Type of a Memberfunc
] Returns the DataType name for a Memberfunc
] Returns the Routine ID of a Methodfunc
] Returns the Class Instance associated with an Object.func
] Returns a List of Members on an Object.func
] Returns the Value of a Member on an Object.func
] Returns the Number of objects in memoryfunc
] func
] Converts a Sequence Data into a ASCII Printable Stringfunc
] Validates weither the Class Name given has been defined or not.const
] A C-Style String Data Typeconst
] Refers to the current object in question in methods.func
] This function determins weither or not a Object is Valid.proc
] Associates a Routine ID as an Freeing Call.proc
] Associates a Routine ID as an Initalization Call.proc
] Enables Crash Routine Support (2.5+)proc
] Initalizes the DEBUG Class, and stores the Default Valuesproc
] This writes the enviroment based on the flags given in the SOOP Debug Class Object.