Documentation for SOOP API Library v1.0
Table of Contents

Class Low Level Routines

These are Low Level Routines specifically for use with the Class Definition system.


These routines are specifically for use with the Class Definition Core of the SOOP API Library.

  • func soop_ClassIX( sfStr ClassName )   Shorthand way to get the Class' instance in the class table.
  • func soop_EnumClasses()   Returns the list of currently defined Classes
  • func soop_EnumConstruct( eAtom ClassIX )   Retrives the Construct Routines for the Given Class.
  • func soop_EnumDeconstruct( eAtom ClassIX )   Similar to soop_EnumConstruct()
  • func soop_EnumMembers( eAtom ClassIX )   Returns the list of Members defined on the given Class.
  • func soop_EnumMethods( eAtom ClassIX )   Returns the Declared Methods on a Class.
  • func soop_MemberType( eAtom ClassIX, eAtom MemberIX )   Returns the Data Type of a Member
  • func soop_MemberTypeName( eAtom ClassIX, eAtom MemberIX )   Returns the DataType name for a Member
  • func soop_MethodRID( eAtom ClassIX, eAtom MethodIX )   Returns the Routine ID of a Method
  • func soop_ValidClass( sfStr ClassName )   Validates weither the Class Name given has been defined or not.

    Documentation for SOOP API Library v1.0
    Table of Contents

    [func]
    soop_ClassIX
    ( sfStr ClassName )

    Shorthand way to get the Class' instance in the class table.

    Returns: Atom, Instance of the Class

    Category: Class Low Level Routines

    This is used to get the Class Instance in the sequence for Class definitions. This was primarly developed, to remove the need to constantly find the Class instance in other support routines.

    See Also: soop_EnumClasses, soop_EnumConstruct, soop_EnumDeconstruct, soop_EnumMembers, soop_EnumMethods, soop_MemberType, soop_MemberTypeName, soop_MethodRID, soop_ValidClass


    Documentation for SOOP API Library v1.0
    Table of Contents

    [func]
    soop_EnumClasses
    ()

    Returns the list of currently defined Classes

    Returns: Sequence of Strings

    Category: Class Low Level Routines

    This returns the list of currently defined classes in the SOOP Class Enviroment. It was mainly put in for the SOOP_Debug class in soop_debug.e

    See Also: soop_ClassIX, soop_EnumConstruct, soop_EnumDeconstruct, soop_EnumMembers, soop_EnumMethods, soop_MemberType, soop_MemberTypeName, soop_MethodRID, soop_ValidClass


    Documentation for SOOP API Library v1.0
    Table of Contents

    [func]
    soop_EnumConstruct
    ( eAtom ClassIX )

    Retrives the Construct Routines for the Given Class.

    Returns: Sequence containing Routine IDs

    Category: Class Low Level Routines

    This is the easy way of obtaining the list of Constructors for a class definition. This was mainly implemented so that I could access the list of constructs, to execute when a new object instance was created.

    See Also: soop_ClassIX, soop_EnumClasses, soop_EnumDeconstruct, soop_EnumMembers, soop_EnumMethods, soop_MemberType, soop_MemberTypeName, soop_MethodRID, soop_ValidClass


    Documentation for SOOP API Library v1.0
    Table of Contents

    [func]
    soop_EnumDeconstruct
    ( eAtom ClassIX )

    Similar to soop_EnumConstruct()

    Returns: Sequence containing Routine IDs

    Category: Class Low Level Routines

    This does the same thing as soop_EnumConstruct(), only it applies to the deconstruction routines, for when a user destroys a Object instance.

    See Also: soop_ClassIX, soop_EnumClasses, soop_EnumConstruct, soop_EnumMembers, soop_EnumMethods, soop_MemberType, soop_MemberTypeName, soop_MethodRID, soop_ValidClass


    Documentation for SOOP API Library v1.0
    Table of Contents

    [func]
    soop_EnumMembers
    ( eAtom ClassIX )

    Returns the list of Members defined on the given Class.

    Returns: Sequence of Strings

    Category: Class Low Level Routines

    This returns the names of the members defined on a Class instance. This was developed, so that it would be easy to grab the Member names, for faster detection in the Object core.

    See Also: soop_ClassIX, soop_EnumClasses, soop_EnumConstruct, soop_EnumDeconstruct, soop_EnumMethods, soop_MemberType, soop_MemberTypeName, soop_MethodRID, soop_ValidClass


    Documentation for SOOP API Library v1.0
    Table of Contents

    [func]
    soop_EnumMethods
    ( eAtom ClassIX )

    Returns the Declared Methods on a Class.

    Returns: Sequence of Strings

    Category: Class Low Level Routines

    This returns a list of strings that represent the methods defined on a class instance, for faster retrival in the SOOP Object given.

    See Also: soop_ClassIX, soop_EnumClasses, soop_EnumConstruct, soop_EnumDeconstruct, soop_EnumMembers, soop_MemberType, soop_MemberTypeName, soop_MethodRID, soop_ValidClass


    Documentation for SOOP API Library v1.0
    Table of Contents

    [func]
    soop_MemberType
    ( eAtom ClassIX, eAtom MemberIX )

    Returns the Data Type of a Member

    Returns: DataType Constant

    Category: Class Low Level Routines

    This returns the data type used for a member in the class at the time of it's definition. It was implemented for easy access to the Type data, without copying the member data to the Object Core Memory.

    See Also: soop_ClassIX, soop_EnumClasses, soop_EnumConstruct, soop_EnumDeconstruct, soop_EnumMembers, soop_EnumMethods, soop_MemberTypeName, soop_MethodRID, soop_ValidClass


    Documentation for SOOP API Library v1.0
    Table of Contents

    [func]
    soop_MemberTypeName
    ( eAtom ClassIX, eAtom MemberIX )

    Returns the DataType name for a Member

    Returns: String

    Category: Class Low Level Routines

    Returns the String Identifier for a DataType defined as a member of the Class Instance. It's mainly a macro, but was implemented for SOOP_Debug class, to make it easier to debug the enviroment with the DataType's actual name.

    See Also: soop_ClassIX, soop_EnumClasses, soop_EnumConstruct, soop_EnumDeconstruct, soop_EnumMembers, soop_EnumMethods, soop_MemberType, soop_MethodRID, soop_ValidClass


    Documentation for SOOP API Library v1.0
    Table of Contents

    [func]
    soop_MethodRID
    ( eAtom ClassIX, eAtom MethodIX )

    Returns the Routine ID of a Method

    Returns: Routine ID

    Category: Class Low Level Routines

    Returns the Euphoria Routine ID for a Method, for use in method_proc(), method_func(), method_id(), method_call_back().

    See Also: soop_ClassIX, soop_EnumClasses, soop_EnumConstruct, soop_EnumDeconstruct, soop_EnumMembers, soop_EnumMethods, soop_MemberType, soop_MemberTypeName, soop_ValidClass


    Documentation for SOOP API Library v1.0
    Table of Contents

    [func]
    soop_ValidClass
    ( sfStr ClassName )

    Validates weither the Class Name given has been defined or not.

    Returns: Boolean, True or False

    Category: Class Low Level Routines

    This can be used in two methods, to figure out if a Class that your library requires, has been defined yet or not, or to ensure that the name isn't already in use. It's one of the internal function's used by the Object Instance Core library, to confirm weither the class has been defined or not.

    See Also: soop_ClassIX, soop_EnumClasses, soop_EnumConstruct, soop_EnumDeconstruct, soop_EnumMembers, soop_EnumMethods, soop_MemberType, soop_MemberTypeName, soop_MethodRID