Documentation for SOOP API Library v1.0
Table of Contents

SOOP Debug

A Class built on SOOP to display Debug Information


SOOP Debug is a Class to debug the SOOP Enviroment for the programmer. This provides vital information for them to see, when they need it.

  • proc Class()   This writes a String to the file defined in the SOOP Debug Class Object.
  • proc debug_file( sfStr )   Stores a filename for use with the Debug Class.
  • proc Object()   This writes a String to the file defined in the SOOP Debug Class Object.
  • func sClass()   This returns a Printable String of the SOOP Enviroment for debugging purposes.
  • func sObject()   This returns a Printable String of the SOOP Enviroment for debugging purposes.
  • proc with_crash_routine()   Enables Crash Routine Support (2.5+)
  • proc with_debug( eInt flags )   Initalizes the DEBUG Class, and stores the Default Values
  • proc write()   This writes the enviroment based on the flags given in the SOOP Debug Class Object.

    Documentation for SOOP API Library v1.0
    Table of Contents

    [proc]
    Class
    ()

    This writes a String to the file defined in the SOOP Debug Class Object.

    Category: SOOP Debug

    This proceudre writes an ASCII Character string to the file given in the SOOP Debug object. It is actually a method, not a euphoria procedure, and therefore reqires it's utilization through methid_proc() routine. It can only be accessed through the DEBUG Object after using with_debug() to initalize it.

    See Also: debug_file, Object, sClass, sObject, with_crash_routine, with_debug, write


    Documentation for SOOP API Library v1.0
    Table of Contents

    [proc]
    debug_file
    ( sfStr )

    Stores a filename for use with the Debug Class.

    Category: SOOP Debug

    This is used to store the file name or path and file name to store debug information in, when the method write() is called. This is similar to Euphoria's crash_file() routine, defined in machine.e.

    See Also: Class, Object, sClass, sObject, with_crash_routine, with_debug, write


    Documentation for SOOP API Library v1.0
    Table of Contents

    [proc]
    Object
    ()

    This writes a String to the file defined in the SOOP Debug Class Object.

    Category: SOOP Debug

    This proceudre writes an ASCII Character string to the file given in the SOOP Debug object Class. It is actually a method, not a euphoria procedure, and therefore reqires it's utilization through methid_proc() routine. It can only be accessed through the DEBUG Object after using with_debug() to initalize it.

    See Also: Class, debug_file, sClass, sObject, with_crash_routine, with_debug, write


    Documentation for SOOP API Library v1.0
    Table of Contents

    [func]
    sClass
    ()

    This returns a Printable String of the SOOP Enviroment for debugging purposes.

    Returns: String of Text

    Category: SOOP Debug

    This function returns an ASCII character string to display the current status of the SOOP class definition enviroment. It is actually a Method, not a euphoria function, and therefore requires it's utilization through the method_func() routine. It can be accessed through the DEBUG Object after using with_debug() to initalize it.

    See Also: Class, debug_file, Object, sObject, with_crash_routine, with_debug, write


    Documentation for SOOP API Library v1.0
    Table of Contents

    [func]
    sObject
    ()

    This returns a Printable String of the SOOP Enviroment for debugging purposes.

    Returns: String of Text

    Category: SOOP Debug

    This function returns an ASCII character string to display the current status of the SOOP object instance enviroment. It is actually a Method, not a euphoria function, and therefore requires it's utilization through the method_func() routine. It can be accessed through the DEBUG Object after using with_debug() to initalize it.

    See Also: Class, debug_file, Object, sClass, with_crash_routine, with_debug, write


    Documentation for SOOP API Library v1.0
    Table of Contents

    [proc]
    with_crash_routine
    ()

    Enables Crash Routine Support (2.5+)

    Category: SOOP Debug

    with_crash_routine() allows for Programmers using Euphoria 2.5+ to utilize the crash_routine() system, to write out debug information to disk. This function is not comptable on Euphoria Interpreter's Pre 2.5 Release. It allows for debug information to be written, weither the SOOP Library crashes out, or Normal Euphoria crashes out with a normal Run-Time Error, or Machine Exception error. It allows for the SOOP Enviroment to be available to the End User, in a Readable Format, so that they can better figure out if the problem occured within the SOOP Lirbary, or somewhere else in their own program. The SOOP Crash Routine is also smart enough to figure out if it was a SOOP Error that occured, or if Euphoria errored out, and write the first 3 lines of the ex.err to soop.err (Default Crash File for SOOP). This will not be compatable if crash_file() has been used, since it looks for ex.err.

    See Also: Class, debug_file, Object, sClass, sObject, with_debug, write


    Documentation for SOOP API Library v1.0
    Table of Contents

    [proc]
    with_debug
    ( eInt flags )

    Initalizes the DEBUG Class, and stores the Default Values

    Category: SOOP Debug

    with_debug() is a way to show how to dynamically create classes, and define routines outside of it, so that new classes can be derived from existing functions. with_debug() does just that, initalizes the Debug Class definition, and creates the object instance, storing it in DEBUG. This allows for the DEBUG class to exist, but not utilized unless with_debug() is used. This keeps the Class Enviroment, and the Object Enviroment clean for your own Class and Objects.

    See Also: Class, debug_file, Object, sClass, sObject, with_crash_routine, write


    Documentation for SOOP API Library v1.0
    Table of Contents

    [proc]
    write
    ()

    This writes the enviroment based on the flags given in the SOOP Debug Class Object.

    Category: SOOP Debug

    This procedure writes an ASCII Character string tothe file give in the SOOP Debug object, based apon the flags stored in the object. You can change what information is written to file by utilizing oset(DEBUG,"flag",DBG_CLASS), oset(DEBUG,"flag",DBG_OBJECT) or oset(DEBUG,"flag",DBG_CLASS+OBJECT). This is not a normal Euphoria function, and therefore requires the usage of method_proc() to utitilize it.

    See Also: Class, debug_file, Object, sClass, sObject, with_crash_routine, with_debug