Created 2008-03-08 10:53:50 by Nils G. Svedmyr on NILSXP [ Header and license information ]

Class List


Class DelegateArray

Source: CODESPY.PKG
Baseclass: Array



Class cCodeComponent

Source: CODESPY.PKG
Baseclass: DelegateArray


Is the base class for all source components
Can be Class, Procedure, Property, Function
Used for subclassing

Procedures

Functions

DestroyObject - Procedure
Destroys the object and the embedded objects.

ParseString String sLine - Procedure
Seperates a String in all bei blanks seperated Stringparts

AddParameter String sP - Procedure
Adds a parameter to the parameter list of
the Element ( function, procedure )

AddComment String sLine - Procedure
Adds a comment line...

ConvertEmailEntries String sLine Returns String - Function
a emailaddress between < .. > is detected it is changed to a real
html mailto ref. (only one per line!)


Class cFunctionComponent

Source: CODESPY.PKG
Baseclass: cCodeComponent



Class cProcedureComponent

Source: CODESPY.PKG
Baseclass: cCodeComponent



Class cPropertyComponent

Source: CODESPY.PKG
Baseclass: cCodeComponent



Class cCodeComponentList

Source: CODESPY.PKG
Baseclass: Array


List of cCodeComponent Objects...

Procedures

Functions

DestroyObject - Procedure
Sends a DestroyObject to all objects in the list.
And finally sends a Detroy_Object to itself.

DoDeleteLastElement - Procedure
Deletes the last item.

DoCheckPublic String sStr - Procedure
Checks if there is a public statement in the comment.

ReadComments Integer hoID String sLineE - Procedure
Searches upwards for Lines with "//" on the left side
and read this comments into the given ComponentID

OnParsing String sLine Integer hoID - Procedure
For later overwrite...

CreateElement Returns Integer - Function
Creates an element of the object list...

CheckTagLeft String sLine String sTag Returns Integer - Function
Checks if a Tag occurs on the left...

ParseLine String sLine Returns Integer - Function
Tries to run a given line (for known tags)
Returns true if known or false if not


Class cProcedureList

Source: CODESPY.PKG
Baseclass: cCodeComponentList


Containes a list of Procedures

Procedures

Functions

OnStartTag String sLine Integer hoID - Procedure
Fills in the start tag informations

CreateElement Returns Integer - Function
Creates an element of the object list...


Class cFunctionList

Source: CODESPY.PKG
Baseclass: cCodeComponentList


Containes a list of Functions

Procedures

Functions

OnStartTag String sLine Integer hoID - Procedure
Fills in the start tag informations

CreateElement Returns Integer - Function
Creates an element of the object list...


Class cPropertyList

Source: CODESPY.PKG
Baseclass: cCodeComponentList


Containes a list of properties

Procedures

Functions

OnStartTag String sLine Integer hoID - Procedure
Fills in the start tag informations

CreateElement Returns Integer - Function
Creates an element of the object list...


Class cClassComponent

Source: CODESPY.PKG
Baseclass: cCodeComponent


Containes all Information, Procedures, Functions and Properties of a Class

Procedures

Functions

DestroyObject - Procedure
Destroys the object and all children.

ResolveClassNames Integer hoID - Procedure
Tries to get links to the BaseClasses
The given object_id is a cFileClassList object, which is able to resolve a class.
If already parsed!

AddBaseClass String sClassName - Procedure
Adds a base class
first is the real base_class all further calls
are done because of IMPORT_CLASS_PROTOCOL commands.

ClassName Returns String - Function
For an easier access to the classname for the subelements,
like procedures, functions, properties.

BaseClassValueHTML Integer iNr Returns String - Function
Checks if a link to a class is known and the it creates a ref=
if not only the classname is returned.


Class cClassList

Source: CODESPY.PKG
Baseclass: cCodeComponentList


Containes a list of Classes

Procedures

Functions

OnStartTag String sLine Integer hoID - Procedure
Fills in the start tag informations

OnParsing String sLine Integer hoID - Procedure
Is called for all lines between "Class" end "End_Class"
and every line is tried to be parsed either by ProcedueList, FunctionList
or PropertyList.
Parses subcomponents

CreateElement Returns Integer - Function
Creates an element of the object list...


Class cCodeSpy

Source: CODESPY.PKG
Baseclass: Array


Reads all Classes and their subcomponets.
First I had the idea to read all packeges into one of these objects
to get (one file) and a complete class list, but I think such a large html
file would be rather slow to load. So I'd prefer to create one object (means one file)
for one read source file.

Properties

Procedures

Functions

BuffCurrentLine - Property
Object oGlobalProcedures is a cProcedureList // Don't want to support this now.
End_Object
Object oGlobalFunctions is a cFunctionList
End_Object

DestroyObject - Procedure
Clears all entries.

RegisterAllClasses - Procedure
Registers all Classes in the embedded list.

BuffInput - Procedure
Starts to read the data out of the buffer.
Resets BuffCurrentLine and SEQEOF.
Which I also use during this kind of virtual reading.

WriteHeaderHTML - Procedure
Write's the header of the created htmlfile.

WriteHTML String sFile - Procedure
Writes the class-list to a file (HTML formated)

FillBuffer String sFile - Procedure
Reads a source file into the buffer.

ParseSourceFile String sFile - Procedure
Loads a file and parses it.

ParseBuffer - Procedure
Parses the buffer, in which the source file was read before and creates the class-list.

BuffNextLine Returns String - Function
Retrieves the next line of the buffer.

BuffPreviousLine Returns String - Function
Retrieves the previous line of the buffer.

ParseLine String sLine Returns Integer - Function
Parses lines outside of classes.
At the moment are only "Use" statements scanned.


Class cSortSet

Source: CODESPY.PKG
Baseclass: Set


Procedures

Functions

AddAdditionalObject Integer hoID - Procedure
Adds an addtional object.

SwitchItems Integer iItem - Procedure
Switches Item iNr and Item (iNr+1)
Items in addtional objects are also switched.

DoInit - Procedure
Resets the object.

NeedToSwitch Integer iItem Returns Integer - Function
Checks is switching is neccessary.


Class cClassGrouper

Source: CODESPY.PKG
Baseclass: cCodeComponentList


Use this as an simple object list.

Procedures

AddEntry String sGRP String sClass - Procedure
Adds an Entry to the (a) group.


Class cFileClassList

Source: CODESPY.PKG
Baseclass: Array


To link to classes which aren't in the same HTML file its neccessary to
hold a class list where all class name and the fitting html files are in.

Properties

Procedures

Functions

psFileName - Property
Reads and writes to this file

psDirectory - Property
in this dir.

WriteHTML - Procedure
Saves the Classlist also into HTML format for easier access.

EnumClasses Integer iMsg Integer hoDest - Procedure
Sends a given Msg for every class entry.

DoInit - Procedure
Destroys the object and its children.

ReadClasses - Procedure
Reads all classes and their source files into the object
out of psFileName.

WriteClasses - Procedure
Writes all stores classes and their infos into
psFileName.

RegisterClass String sClass String sSource String sRest - Procedure
Creates an entry to the class list and checks before
if an entry for this class already exists, if so
only the SourceFile is changed for the old entry.

PathFileName Returns String - Function
Creates the full file path.

ResolveClassNr Integer iNr Returns String - Function
Tries to resolve a class. (Internal used)

ResolveClass String sClass Returns String - Function
Tries to resolve a class.


Class cMultiFileCodeSpy

Source: CODESPY.PKG
Baseclass: Array


This Class Creates for every file it should parse a cCopySpy object.
So it is a simple object list with a special interface.
This is done to allow to scan for dependencies. ("Use Pack.pkg" Statements)
So every during a scan detected "use" statement will cause a "Delegate send RunParseFile ..."
So this file is parsed, too.

Properties

Procedures

psDirectoryInt - Property
The Outputdirectory

RunParseFile String sFile - Procedure
Creates a cCodeSpy object and parses the given
file in it.


Header and license information

*****************************************************************************************
Created '2000 Michael Kurz
This code can be used in any apllication for free, but must not be sold in any way.
$FileName : CodeSpy
$ProjectName : Analyse VDF code (class definitions)
$Author : Michael Kurz MichaelKurz@gmx.at
$Created : 12-08-2000 @ 00:10
Contents:
Build a structure of all classes and their Properties, Functions and Procedures
*****************************************************************************************
TH-RevisionStart
22.10.2001 12:01 Removed clearing of the Additional Mk SERVER
Objects
TH-RevisionEnd