The AuditVbi class writes component audit reports to the currently selected output file in the syntax style specified for that file. It is used extensively by the "gmMetrics" program but may also be used for debugging purposes by any translation program. More...

Static Public Member Functions
static void	SearchSymbols (int BaseRoot)
	The method SearchSymbols produces an "Audit of Symbol tree" report for a specified parent symbol. The symbol tree is hierarchical and the report contains 5 columns. The "Lev" column shows the nesting level relative to the root symbol of the symbol. The "Address" column is the root address of the symbol. All symbols are assigned a unique root address in the symbol table which remain constant over multiple translation runs. Since the same identifier is often used for many different components, finding specific references to components in the audit reports is often difficult. The address on the other hand are unique and are always appended to symbols in the detailed reports to make them easy to find. The "Parent" column specifies the root address of the parent of the symbol in the hierarchical tree. The "Symbol Type" column specifies the symbol object type. The "Full Symbol Identifier" column is the fully qualified identifier of the symbol. These identifiers are used to specify particular components in the "Refactoring" statements. They are relatively easy to construct but simply copying them out of an audit report is often easier. More...

static void	MigInfo (int iRoot)
	The method MigInfo audits the "tMigInfo" migration information for a specified component. The tMigInfo class is the initial parent class of those component classes that can be migrated. More...

static void	VbCompInfo (int iRoot)
	The method VbCompInfo audits the "tVbComp" information for a specified component. The tVbComp class controls the content of component description blocks that where produced by the VB6 compiler. It is a child of the tMigInfo class and is the parent of the classes that represent the various VB6 components. More...

static void	QuantityInfo (int iRoot)
	The method QuantityInfo audits the "tQuantity" information for a specified component. The tQuantity class controls the content of component description blocks that contain values that were defined in the user code. More...

static void	InfoFile (int iRoot)
	The method InfoFile audits the content of tInfoFile components. Within the class structure of the tool, language source files are associated with the tInfoFile class. This class contains not only but the source file that was compiled but also the translation file that was produced. The entities that are represented via the tInfoFile class are: project files, form files of various types, class files, module files, asp files, and include files. More...

static void	Subprogram (int iRoot)
	The method Subprogram audits the contents of tVbSub components which describe the subprograms, functions, and event handlers defined in the user code. They have values and therefore are children of the the tQuantity class. More...

static void	Variable (int iRoot)
	The method Variable audits the contents of tVariable components which are used for fields, variables, and parameters defined in the source code. They are used to contain values and therefore are children of the the tQuantity class. More...

static void	Constant (int iRoot)
	The method Constant audits the contents of tVbConst components which are used constants defined in the source code. They are used to contain values and therefore are children of the tQuantity class. More...

static void	Property (int iRoot)
	The method Property audits the contents of properties defined in the source code. They are simply represented via the the tQuantity class. More...

static void	Declare (int iRoot)
	The method Declare audits the contents of tVbDeclare components produced by the compiler to represent the VB6 Declare statement. They are used to contain values and therefore are children of the tQuantity class. More...

static void	Structure (int iRoot)
	The method Structure audits the contents of structures defined in the source code via the "Type" statement. They are simply represented via the the tVbComp class. More...

static void	Enumeration (int iRoot)
	The method Enumeration audits the contents of enumerations defined in the source code via the "Enum" statement. They are simply represented via the the tVbComp class. More...

static void	StateLabel (int iRoot)
	The method StateLabel audits the "tStateLabel" components which describe the content of statement labels that where encountered by the VB6 compiler. These labels are often migrated via the GoTo and GoSub simplification logic in the analyser and are childern of the tMigInfo class. More...

static void	Event (int iRoot)
	The method Event audits the contents of tVbEvent components produced by the compiler to represent the VB6 Event statement. Events do not have binary types and therefore are children of the tVbComp class. More...

static void	Vbname (int iRoot)
	The method Vbname audits the contents of tVbName components produced by the compiler to link class files to class names. More...

static void	Library (int iRoot)
	The method Library audits the contents of tLibrary components defined in the interface description files via the gmPL "Library" declaraction. More...

static void	Interface (int iRoot)
	The method Interface audits the contents of tInterface components defined in the interface description files via the gmPL "Class" declaraction. They represent the class interfaces supported by the external library and are children of the "tMigInfo" class. More...

static void	Coclass (int iRoot)
	The method Coclass audits the contents of tCoclass components defined in the interface description files via the gmPL "Coclass" declaraction. A coclass is a union of a group of classes and/or interfaces defined in an interface description class. They are children of the "tMigInfo" class. More...

static void	Typedef (int iRoot)
	The method Typedef audits the contents of tVbTypedef components defined in the interface description files via the gmPL "Typedef" declaraction. A typedef suppies an alternative identifier for a type. They are children of the "tMigInfo" class. More...

static void	LibComponent (int iRoot)
	The method LibComponent audits the contents of tLibComp components defined in the interface description files via various gmPL declaraction. The tLibComp componenta are value bearing components within an external library. They are children of the "tMigInfo" class. More...

static void	FrxAudit (int iRoot)
	The method FrxAudit audits the contents of resource components with the object type "ResXinfo". VB6 stashes property information assigned at design time to Forms in FRX files. In addition, there are even more binary files that provide the same service for User Controls (.CTX), Property Pages (.PGX), User Documents (.DOX), and Active Designer projects(.DSX). Among the various property information stored in these files are graphics, which can include bitmaps (.BMP and .DIB), GIFs, JPEGs (.JPG), Metafiles (.WMF, .EMF), cursors (.CUR), and icons (.ICO). Note that these are stored as binary information and are audited using Base64 encoding. The actual format for Base64 encoding as described by "Http://www.freesoft.org/CIE/RFC/1521/7.htm" as follows: Base64 Content-Transfer-Encoding is designed to represent arbitrary sequences of octets in a form that need not be humanly readable.... More...

static void	DataStore (int iRoot)
	The method DataStore audits the content of tDataStore components that contain gathered tables and arrays produced via a simple command language. More...

static void	UserControl (int iRoot)
	The method UserControl audits the "tVbControl" components which describe the content of user controls defined within the various types of VB6 form files, designer files, document files, and user control files. They do not have values and therefore are children of the tMigInfo class. More...

Detailed Description

The AuditVbi class writes component audit reports to the currently selected output file in the syntax style specified for that file. It is used extensively by the "gmMetrics" program but may also be used for debugging purposes by any translation program.

Member Function Documentation

◆ Coclass()

static void gmslLibrary.Services.AuditVbi.Coclass ( int iRoot )

static

The method Coclass audits the contents of tCoclass components defined in the interface description files via the gmPL "Coclass" declaraction. A coclass is a union of a group of classes and/or interfaces defined in an interface description class. They are children of the "tMigInfo" class.

Parameters

iRoot The parameter iRoot is the root offset of the Coclass component being audited.

◆ Constant()

static void gmslLibrary.Services.AuditVbi.Constant ( int iRoot )

static

The method Constant audits the contents of tVbConst components which are used constants defined in the source code. They are used to contain values and therefore are children of the tQuantity class.

Parameters

iRoot The parameter iRoot is the root offset of the component being audited.

◆ DataStore()

static void gmslLibrary.Services.AuditVbi.DataStore ( int iRoot )

static

The method DataStore audits the content of tDataStore components that contain gathered tables and arrays produced via a simple command language.

Parameters

iRoot The parameter iRoot is the root offset of the tDataStore component being audited.

◆ Declare()

static void gmslLibrary.Services.AuditVbi.Declare ( int iRoot )

static

The method Declare audits the contents of tVbDeclare components produced by the compiler to represent the VB6 Declare statement. They are used to contain values and therefore are children of the tQuantity class.

Parameters

iRoot The parameter iRoot is the root offset of the declare being audited.

◆ Enumeration()

static void gmslLibrary.Services.AuditVbi.Enumeration ( int iRoot )

static

The method Enumeration audits the contents of enumerations defined in the source code via the "Enum" statement. They are simply represented via the the tVbComp class.

Parameters

iRoot The parameter iRoot is the root offset of the enumeration being audited.

◆ Event()

static void gmslLibrary.Services.AuditVbi.Event ( int iRoot )

static

The method Event audits the contents of tVbEvent components produced by the compiler to represent the VB6 Event statement. Events do not have binary types and therefore are children of the tVbComp class.

Parameters

iRoot The parameter iRoot is the root offset of the declare being audited.

◆ FrxAudit()

static void gmslLibrary.Services.AuditVbi.FrxAudit ( int iRoot )

static

The method FrxAudit audits the contents of resource components with the object type "ResXinfo". VB6 stashes property information assigned at design time to Forms in FRX files. In addition, there are even more binary files that provide the same service for User Controls (.CTX), Property Pages (.PGX), User Documents (.DOX), and Active Designer projects(.DSX). Among the various property information stored in these files are graphics, which can include bitmaps (.BMP and .DIB), GIFs, JPEGs (.JPG), Metafiles (.WMF, .EMF), cursors (.CUR), and icons (.ICO). Note that these are stored as binary information and are audited using Base64 encoding. The actual format for Base64 encoding as described by "Http://www.freesoft.org/CIE/RFC/1521/7.htm" as follows: Base64 Content-Transfer-Encoding is designed to represent arbitrary sequences of octets in a form that need not be humanly readable....

Parameters

iRoot The parameter iRoot is the root offset of the ResXinfo component being audited.

◆ InfoFile()

static void gmslLibrary.Services.AuditVbi.InfoFile ( int iRoot )

static

The method InfoFile audits the content of tInfoFile components. Within the class structure of the tool, language source files are associated with the tInfoFile class. This class contains not only but the source file that was compiled but also the translation file that was produced. The entities that are represented via the tInfoFile class are: project files, form files of various types, class files, module files, asp files, and include files.

Parameters

iRoot The parameter iRoot is the root offset of the component being audited.

◆ Interface()

static void gmslLibrary.Services.AuditVbi.Interface ( int iRoot )

static

The method Interface audits the contents of tInterface components defined in the interface description files via the gmPL "Class" declaraction. They represent the class interfaces supported by the external library and are children of the "tMigInfo" class.

Parameters

iRoot The parameter iRoot is the root offset of the class interface component being audited.

◆ LibComponent()

static void gmslLibrary.Services.AuditVbi.LibComponent ( int iRoot )

static

The method LibComponent audits the contents of tLibComp components defined in the interface description files via various gmPL declaraction. The tLibComp componenta are value bearing components within an external library. They are children of the "tMigInfo" class.

Parameters

iRoot The parameter iRoot is the root offset of the tLibComp component being audited.

◆ Library()

static void gmslLibrary.Services.AuditVbi.Library ( int iRoot )

static

The method Library audits the contents of tLibrary components defined in the interface description files via the gmPL "Library" declaraction.

Parameters

iRoot The parameter iRoot is the root offset of the library component being audited.

◆ MigInfo()

static void gmslLibrary.Services.AuditVbi.MigInfo ( int iRoot )

static

The method MigInfo audits the "tMigInfo" migration information for a specified component. The tMigInfo class is the initial parent class of those component classes that can be migrated.

Parameters

iRoot The parameter iRoot is the root offset of the component being audited.

◆ Property()

static void gmslLibrary.Services.AuditVbi.Property ( int iRoot )

static

The method Property audits the contents of properties defined in the source code. They are simply represented via the the tQuantity class.

Parameters

iRoot The parameter iRoot is the root offset of the property being audited.

◆ QuantityInfo()

static void gmslLibrary.Services.AuditVbi.QuantityInfo ( int iRoot )

static

The method QuantityInfo audits the "tQuantity" information for a specified component. The tQuantity class controls the content of component description blocks that contain values that were defined in the user code.

Parameters

iRoot The parameter iRoot is the root offset of the component being audited.

◆ SearchSymbols()

static void gmslLibrary.Services.AuditVbi.SearchSymbols ( int BaseRoot )

static

The method SearchSymbols produces an "Audit of Symbol tree" report for a specified parent symbol. The symbol tree is hierarchical and the report contains 5 columns. The "Lev" column shows the nesting level relative to the root symbol of the symbol. The "Address" column is the root address of the symbol. All symbols are assigned a unique root address in the symbol table which remain constant over multiple translation runs. Since the same identifier is often used for many different components, finding specific references to components in the audit reports is often difficult. The address on the other hand are unique and are always appended to symbols in the detailed reports to make them easy to find. The "Parent" column specifies the root address of the parent of the symbol in the hierarchical tree. The "Symbol Type" column specifies the symbol object type. The "Full Symbol Identifier" column is the fully qualified identifier of the symbol. These identifiers are used to specify particular components in the "Refactoring" statements. They are relatively easy to construct but simply copying them out of an audit report is often easier.

Parameters

BaseRoot The parameter BaseRoot if not zero specifies the root symbol for the tree to be audited. If it is zero, then the entire symbol tree is audited.

◆ StateLabel()

static void gmslLibrary.Services.AuditVbi.StateLabel ( int iRoot )

static

The method StateLabel audits the "tStateLabel" components which describe the content of statement labels that where encountered by the VB6 compiler. These labels are often migrated via the GoTo and GoSub simplification logic in the analyser and are childern of the tMigInfo class.

Parameters

iRoot The parameter iRoot is the root offset of the statement label being audited.

◆ Structure()

static void gmslLibrary.Services.AuditVbi.Structure ( int iRoot )

static

The method Structure audits the contents of structures defined in the source code via the "Type" statement. They are simply represented via the the tVbComp class.

Parameters

iRoot The parameter iRoot is the root offset of the structure being audited.

◆ Subprogram()

static void gmslLibrary.Services.AuditVbi.Subprogram ( int iRoot )

static

The method Subprogram audits the contents of tVbSub components which describe the subprograms, functions, and event handlers defined in the user code. They have values and therefore are children of the the tQuantity class.

Parameters

iRoot The parameter iRoot is the root offset of the component being audited.

◆ Typedef()

static void gmslLibrary.Services.AuditVbi.Typedef ( int iRoot )

static

The method Typedef audits the contents of tVbTypedef components defined in the interface description files via the gmPL "Typedef" declaraction. A typedef suppies an alternative identifier for a type. They are children of the "tMigInfo" class.

Parameters

iRoot The parameter iRoot is the root offset of the tVbTypedef component being audited.

◆ UserControl()

static void gmslLibrary.Services.AuditVbi.UserControl ( int iRoot )

static

The method UserControl audits the "tVbControl" components which describe the content of user controls defined within the various types of VB6 form files, designer files, document files, and user control files. They do not have values and therefore are children of the tMigInfo class.

Parameters

iRoot The parameter iRoot is the root offset of the uiser control being audited.

◆ Variable()

static void gmslLibrary.Services.AuditVbi.Variable ( int iRoot )

static

The method Variable audits the contents of tVariable components which are used for fields, variables, and parameters defined in the source code. They are used to contain values and therefore are children of the the tQuantity class.

Parameters

iRoot The parameter iRoot is the root offset of the component being audited.

◆ VbCompInfo()

static void gmslLibrary.Services.AuditVbi.VbCompInfo ( int iRoot )

static

The method VbCompInfo audits the "tVbComp" information for a specified component. The tVbComp class controls the content of component description blocks that where produced by the VB6 compiler. It is a child of the tMigInfo class and is the parent of the classes that represent the various VB6 components.

Parameters

iRoot The parameter iRoot is the root offset of the component being audited.

◆ Vbname()

static void gmslLibrary.Services.AuditVbi.Vbname ( int iRoot )

static

The method Vbname audits the contents of tVbName components produced by the compiler to link class files to class names.

Parameters

iRoot The parameter iRoot is the root offset of the class name being audited.

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

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

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ Coclass()

◆ Constant()

◆ DataStore()

◆ Declare()

◆ Enumeration()

◆ Event()

◆ FrxAudit()

◆ InfoFile()

◆ Interface()

◆ LibComponent()

◆ Library()

◆ MigInfo()

◆ Property()

◆ QuantityInfo()

◆ SearchSymbols()

◆ StateLabel()

◆ Structure()

◆ Subprogram()

◆ Typedef()

◆ UserControl()

◆ Variable()

◆ VbCompInfo()

◆ Vbname()