The References class provides utility methods to produce, scan, and audit sorted lists of tReference records sorted by the offset of the symbol being referenced. These reference lists are produced automatically by the compiler to aid in the analysis process. In addition, more extensive reference lists can be produced via this class. More...

Static Public Member Functions

static void DisplayObjectType (int objType, int iRoot)

The DisplayObjectType method displays the object type of a component. The object type of a component can be one of the following: (1) One of the storage object types list in the ObjectType enumeration; (2) For VARIABLES it is either Parameter, Variable, of Field; (3) One of the special library component types in the ComponentType enumeration; (4) A VB6 internal class or enumeration type from the OPCODE list; (5) An enumeration or class defined in the language file; (6) A user defined control with a particular control type. More...

static void DisplayIdentifier (int iRoot, int maxStorage)

The DisplayIdentifier method displays the source identifier associated with a root offset. If the root offset is not within range "Null" is displayed. If the component is a method within a property – get, set, or let – then its name is combined with the property name. More...

static void DisplayLibraryName (int iRoot)

The DisplayLibraryName method displays the source identifier of the library containing a specified component. For components within library description files this is the library being described. For components within VB6 projects this is the project nameSpace. For any other components this is simply the highest symbol in the tree above the specified one. More...

static void DisplayClassName (int objRoot, int maxStorage)

The DisplayClassName method displays the source identifier of the class containing a specified component. For components within library description files this is the name of the class or enumeration that contains it. For components within VB6 projects, this is the the name of the class, module, or form that contains it. If for some reason an appropriate class cannot be found, then the library name is used instead. If the root is not well-formed then "Null" is displayed. More...

static void DisplayBinaryType (int binaryType)

The DisplayBinaryType method displays a binary type as represented by a signed integer value. If negative then it represents a user type in the language file. If positive and less than the maximum operation code then it is a primitive type defined via the subcodes of the TYP operation. If it is a greater than the maximum operation code the it is the root offset of a user defined type or class. The integer value of the type is also displated with its identifier for the non primitive types. More...

static void DisplayDeclaration (int iRoot, int maxStorage)

The DisplayDeclaration method displays the declaration information about a component. For all components this includes the source identifier. For subprograms, variables, fields, and constants the source identifier is preceeded by the context flags associated with the component. For subprograms the source identifier is followed by its parameters. More...

static void DisplayPathname (int iRoot, int pathPart, int maxStorage)

The DisplayPathname method displays the psthname of a component. For components within library description files the pathname is the hintpath of the library containing the component. For components within VB6 projects, it is the identifier of the file that contains the component. More...

static int DisplayTextRecord (int hostFile, int textRoot, int lineNo)

The DisplayTextRecord displays a record from text stream. These are created by the tool when it stores source or translation files. /summary>

Parameters

hostFile	The hostFile parameter specifies the root offset of the component that contains the text stream.
textRoot	The textRoot parameter specifies the root offset of the actual text stream to be search for the record. If it is zero, this method will attempt to obtain it from the hostFile information.
lineNo	The lineNo parameter specifies the line number of the record to be displayed.

Returns: The method returns the root offset of the text stream.

static void SearchDefinitions (int BaseRoot)

The SearchDefinitions method produces a sorted symbol definitions list. Its purpose is to detect how often user code components are used and in particular which user defined components are never used. More...

static void SearchReferences (int BaseRoot, int extended)

The SearchReferences method produces a sorted symbol reference list. The list itself may either be a simple list of symbol references or an extended list of external symbol references. More...

static void SimpleSearch (int BaseRoot)

The SimpleSearch method produces a sorted symbol reference list. The list itself is is a simple list of symbol references. references. More...

static void ExtendedSearch (int BaseRoot)

The ExtendedSearcgh method produces a sorted symbol reference list. The list itself is an extended list of external symbol references. More...

Detailed Description

The References class provides utility methods to produce, scan, and audit sorted lists of tReference records sorted by the offset of the symbol being referenced. These reference lists are produced automatically by the compiler to aid in the analysis process. In addition, more extensive reference lists can be produced via this class.

Member Function Documentation

◆ DisplayBinaryType()

static void gmslLibrary.Services.References.DisplayBinaryType ( int binaryType )

static

The DisplayBinaryType method displays a binary type as represented by a signed integer value. If negative then it represents a user type in the language file. If positive and less than the maximum operation code then it is a primitive type defined via the subcodes of the TYP operation. If it is a greater than the maximum operation code the it is the root offset of a user defined type or class. The integer value of the type is also displated with its identifier for the non primitive types.

Parameters

binaryType The binaryType parameter specifies the binary type value to be displayed.

◆ DisplayClassName()

static void gmslLibrary.Services.References.DisplayClassName	(	int	objRoot,
		int	maxStorage
	)

static

The DisplayClassName method displays the source identifier of the class containing a specified component. For components within library description files this is the name of the class or enumeration that contains it. For components within VB6 projects, this is the the name of the class, module, or form that contains it. If for some reason an appropriate class cannot be found, then the library name is used instead. If the root is not well-formed then "Null" is displayed.

Parameters

iRoot	The parameter iRoot specifies the root offset of the component whose class name is to be displayed. A positive offset indicates the current storage area; while a negative offset indicates the language file.
maxStorage	The parameter maxStorage specifies the maximum root offset into the current storage area.

◆ DisplayDeclaration()

static void gmslLibrary.Services.References.DisplayDeclaration	(	int	iRoot,
		int	maxStorage
	)

static

The DisplayDeclaration method displays the declaration information about a component. For all components this includes the source identifier. For subprograms, variables, fields, and constants the source identifier is preceeded by the context flags associated with the component. For subprograms the source identifier is followed by its parameters.

///

Parameters

iRoot	The parameter iRoot specifies the root offset of the component whose declaration is to be displayed.
maxStorage	The parameter maxStorage specifies the maximum root offset into the current storage area.

◆ DisplayIdentifier()

static void gmslLibrary.Services.References.DisplayIdentifier	(	int	iRoot,
		int	maxStorage
	)

static

The DisplayIdentifier method displays the source identifier associated with a root offset. If the root offset is not within range "Null" is displayed. If the component is a method within a property – get, set, or let – then its name is combined with the property name.

Parameters

iRoot	The parameter iRoot specifies the root offset of the component whose identifier is to be displayed. A positive offset indicates the current storage area; while a negative offset indicates the language file.
maxStorage	The parameter maxStorage specifies the maximum root offset into the current storage area.

◆ DisplayLibraryName()

static void gmslLibrary.Services.References.DisplayLibraryName ( int iRoot )

static

The DisplayLibraryName method displays the source identifier of the library containing a specified component. For components within library description files this is the library being described. For components within VB6 projects this is the project nameSpace. For any other components this is simply the highest symbol in the tree above the specified one.

Parameters

iRoot The parameter iRoot specifies the root offset of the component whose library name is to be displayed. A positive offset indicates the current storage area; while a negative offset indicates the language file.

◆ DisplayObjectType()

static void gmslLibrary.Services.References.DisplayObjectType	(	int	objType,
		int	iRoot
	)

static

The DisplayObjectType method displays the object type of a component. The object type of a component can be one of the following: (1) One of the storage object types list in the ObjectType enumeration; (2) For VARIABLES it is either Parameter, Variable, of Field; (3) One of the special library component types in the ComponentType enumeration; (4) A VB6 internal class or enumeration type from the OPCODE list; (5) An enumeration or class defined in the language file; (6) A user defined control with a particular control type.

Parameters

objType	The various grouping are layed out in such a manner that all can be represented uniquely with a signed integer value. The parameter objType specifies this value.
iRoot	The parameter iRoot specifies the root offset of the component whose object type is being displayed.

◆ DisplayPathname()

static void gmslLibrary.Services.References.DisplayPathname	(	int	iRoot,
		int	pathPart,
		int	maxStorage
	)

static

The DisplayPathname method displays the psthname of a component. For components within library description files the pathname is the hintpath of the library containing the component. For components within VB6 projects, it is the identifier of the file that contains the component.

Parameters

iRoot The parameter iRoot specifies the root offset of the component whose pathname is to be displayed.

param name="pathPart"> If the parameter pathPart is zero, then the entire pathname is displayed; else only the local part of the name is displayed.

Parameters

maxStorage The parameter maxStorage specifies the maximum root offset into the current storage area.

◆ ExtendedSearch()

static void gmslLibrary.Services.References.ExtendedSearch ( int BaseRoot )

static

The ExtendedSearcgh method produces a sorted symbol reference list. The list itself is an extended list of external symbol references.

Parameters

BaseRoot The BaseRoot parameter, if not zero, limits the list to the components associated with the specified root offset of a VBP project; else all components in the currently active storage area are included.

◆ SearchDefinitions()

static void gmslLibrary.Services.References.SearchDefinitions ( int BaseRoot )

static

The SearchDefinitions method produces a sorted symbol definitions list. Its purpose is to detect how often user code components are used and in particular which user defined components are never used.

Parameters

BaseRoot The BaseRoot parameter, if not zero, limits the list to the components associated with the specified root offset of a VBP project; else all components in the currently active storage area are included.

◆ SearchReferences()

static void gmslLibrary.Services.References.SearchReferences	(	int	BaseRoot,
		int	extended
	)

static

The SearchReferences method produces a sorted symbol reference list. The list itself may either be a simple list of symbol references or an extended list of external symbol references.

Parameters

BaseRoot	The BaseRoot parameter, if not zero, limits the list to the components associated with the specified root offset of a VBP project; else all components in the currently active storage area are included.
extended	The extended parameter, if not zero, requests that an extended search for external symbol references be performed; else a simple reference search is performed.

◆ SimpleSearch()

static void gmslLibrary.Services.References.SimpleSearch ( int BaseRoot )

static

The SimpleSearch method produces a sorted symbol reference list. The list itself is is a simple list of symbol references. references.

Parameters

BaseRoot The BaseRoot parameter, if not zero, limits the list to the components associated with the specified root offset of a VBP project; else all components in the currently active storage area are included.

The documentation for this class was generated from the following file:

C:/gmProducts/gmStudio_dev/src/gmslAPI/gmslLibrary/References.cs