RoutineComponent Class Reference

<class>RoutineComponent</class> is a subclass of <class>Component</class>. More...

Inheritance diagram for RoutineComponent:

Collaboration diagram for RoutineComponent:

Public Member Functions
	FindInventoryRecord (_.Library.String rtnData)
	Scans the routine represented by this <class>RoutineComponent</class> for a comment string beginning. More...
	GenerateSHA1Hash (_.Library.String string)
	Retrieve the system-generated CRC for the routine and store it as the <property>SHA1Hash</property> property. More...
Public Member Functions inherited from Hashable
	GenerateSHA1HashFromStream (_.Stream.Object stream)
	Generate a base 64 encoded SHA1 hash of the contents of stream and store it as the <property>SHA1Hash</property> property. More...

Public Attributes
	InventoryRecord
	The contents of an optional tagged comment inside the routine represented by this <class>RoutineComponent</class>, used to track its origins. More...
	Size
	The size of the compiled code, in bytes, of the routine represented by this <class>RoutineComponent</class>. More...
Public Attributes inherited from Component
	Name
	The name of this component, which distinguishes it from other components of the same type. More...
	ParentComponent
	The parent component of this component. More...
	Scan
	The <class>Scan</class> which found this component. More...
	SubComponents
	The subcomponents of this component. More...
Public Attributes inherited from Hashable
	SHA1Hash
	The SHA1Hash of the object, base 64 encoded. More...

Static Public Attributes
	XMLNAME = None
	The element name used in the XML representation of the component.
	XMLTYPE = None
	The identifier used to distinguish the type of this component in the XML representation.
Static Public Attributes inherited from Component
	XMLNAME = None
	The element name used in the XML representation of the component.
	XMLTYPE = None
	The identifier used to distinguish the type of this component in the XML representation.

Private Member Functions
_.Library.List	__Strings (_.Library.String data, _.Library.String minLen, _.Library.String tag)
	Extract strings from input data and return as a $LIST More...

Detailed Description

<class>RoutineComponent</class> is a subclass of <class>Component</class>.

An instance represents a routine.

It contains properties representing the routine's name, size, an optional <property>InventoryRecord</property>, and a SHA1 hash of the routine's compiled code.

Member Function Documentation

FindInventoryRecord()

FindInventoryRecord

(

_.Library.String

rtnData

)

Scans the routine represented by this <class>RoutineComponent</class> for a comment string beginning.

with ";; ISC-TAG:". If present, sets the <property>InventoryRecord</property> property of this object to the remainder of the string.

GenerateSHA1Hash()

GenerateSHA1Hash

(

_.Library.String

string

)

Retrieve the system-generated CRC for the routine and store it as the <property>SHA1Hash</property> property.

of this object.
string is assumed to be the value of the ^rOBJ node of the routine.

Reimplemented from Hashable.

__Strings()

_.Library.List __Strings ( _.Library.String  data, _.Library.String  minLen, _.Library.String  tag  )

private

Extract strings from input data and return as a $LIST

minlen specifies how long the string must be to be selected

tag specifies the bytes that must be contained in the string to be selected

Member Data Documentation

InventoryRecord

InventoryRecord

The contents of an optional tagged comment inside the routine represented by this <class>RoutineComponent</class>, used to track its origins.

 

Size

Size

The size of the compiled code, in bytes, of the routine represented by this <class>RoutineComponent</class>.