gmslAPI  0.1
gmslAPI: An API for Developing Upgrade Solutions using Great Migrations Technology
gmslLibrary.Enums Namespace Reference

Classes

class  Defines
 
class  ObjectType
 

Enumerations

enum  AuthorLibType { AuthorLibType.off = 0, AuthorLibType.on = 1, AuthorLibType.deploy = 2 }
 The AuthorLibType enumeration specifies the ways in which interface description files are authored when libraries or control projects are translated. More...
 
enum  BuildFileStatus { BuildFileStatus.off = 0, BuildFileStatus.on = 1, BuildFileStatus.Local = 2, BuildFileStatus.Global = 3 }
 The BuildFileStatus enumeration specifies the external handling strategies for migration. More...
 
enum  CharacterSets { CharacterSets.ASCII = 0, CharacterSets.UTF8 = 1, CharacterSets.Shift_JIS = 2 }
 The CharacterSets enumeration specifies the source character tht can be specified via the "charset" select property. More...
 
enum  CheckDeclarationType { CheckDeclarationType.off = 0, CheckDeclarationType.on = 1, CheckDeclarationType.ignore = 2, CheckDeclarationType.audit = 3 }
 The CheckDeclarationType enumeration specifies the checking and reporting alternatives for the consistency between DECLARE statements in the source codes and those in a interface description files. More...
 
enum  ComponentType {
  ComponentType.Method = 0, ComponentType.Accessor = 1, ComponentType.Event = 2, ComponentType.Property = 3,
  ComponentType.Enumeration = 4, ComponentType.EnumEntry = 5, ComponentType.Structure = 6, ComponentType.Argument = 7,
  ComponentType.Constant = 8, ComponentType.TextBlock = 9, ComponentType.Statements = 10, ComponentType.Statement = 11,
  ComponentType.Attribute = 12, ComponentType.BeginProp = 13, ComponentType.NameValue = 14
}
 The ComponentType enumeration specifies the types of library components declared in interface description files. It is stored in the "tLibComp" property "refType". More...
 
enum  Dialects {
  off = 0, vb7 = 1, gms = 2, jav = 3,
  jvs = 3, cob = 4, cmd = 5, vbp = 6,
  vbn = 7, csh = 8, wpf = 9, loc = 10,
  lob = 11, wpb = 12, mig = 13
}
 
enum  LexemeType {
  LexemeType.EndOfRecord = 0, LexemeType.Special = 1, LexemeType.Identifier = 2, LexemeType.Integer = 3,
  LexemeType.Float = 4, LexemeType.Quoted = 5, LexemeType.HexCons = 6, LexemeType.Minus = 10,
  LexemeType.Not = 11, LexemeType.ToPower = 12, LexemeType.Multiply = 13, LexemeType.Divide = 14,
  LexemeType.IntegerDivide = 15, LexemeType.Modulo = 16, LexemeType.Add = 17, LexemeType.Subtract = 18,
  LexemeType.Concatenate = 19, LexemeType.NotEqual = 20, GreaterOrEqual = 21, LessOrEqual = 22,
  Equal = 23, GreaterThan = 24, LessThan = 25, InclusiveOr = 26,
  And = 27, Like = 28, Is = 29, ExclusiveOr = 30,
  Equivalent = 31, Implies = 32, BitwiseAnd = 33, BitwiseOr = 34,
  As = 40, EndScript = 41, EndStatement = 42, OpenBlock = 43,
  CloseBlock = 44, Byref = 71, Byval = 72, Doevents = 73,
  Else = 74, False = 75, For = 76, Me = 77,
  Mid = 78, New = 79, Nothing = 80, Optional = 81,
  Paramarray = 82, Then = 84, To = 85, True = 86,
  In = 91, Instance = 92, Of = 93, Typeof = 94,
  Function = 95, Void = 96, Break = 97, Case = 98,
  Catch = 99, Continue = 100, Debugger = 101, Default = 102,
  Delete = 103, Do = 104, ElseStatement = 105, Finally = 106,
  ForStatement = 107, If = 108, Return = 109, Switch = 110,
  Throw = 111, Try = 112, Var = 113, While = 114,
  With = 115, Error = 116, Bool = 117, String = 118,
  Int = 119
}
 Tokens, as define by a parser, represent a pair (lexeme type, lexeme value). The LexemeType enumeration lists the types of lexeme. More...
 
enum  DisplayType {
  DisplayType.INTEGER_VALUE = 1, DisplayType.PARENT_OFFSET = 2, DisplayType.OBJECT_TYPE = 3, DisplayType.FULL_IDENT = 4,
  DisplayType.MIGRATE_STATUS = 5, DisplayType.STRING_VALUE = 6, DisplayType.PATTERN = 7, DisplayType.CONTEXT_FLAGS = 8,
  DisplayType.ASP_CONTEXT = 9, DisplayType.IDENT_OFFSET = 10, DisplayType.OBJECT_NAME = 11, DisplayType.INTERFACES = 12,
  DisplayType.REFERENCES = 13, DisplayType.INFO_STATUS = 14, DisplayType.CURRENT_CODE = 15, DisplayType.CHILDCONTROLS = 16,
  DisplayType.LIBRARY_TYPE = 17, DisplayType.MIGRATE_FLAGS = 18, DisplayType.BINARY_TYPE = 19, DisplayType.AUDIT_TEXT = 20,
  DisplayType.MIGRATE2_FLAGS = 21, DisplayType.SOURCE_NAME = 22, DisplayType.TARGET_NAME = 23, DisplayType.FULL_NAME = 24
}
 The DisplayType enumeration lists the various types of component displays that can be performed on specified information values by the Symbol.DisplayInfo method. More...
 
enum  EchoType { off = 0, pass1 = 1, pass2 = 2, all = 3 }
 
enum  EventType {
  CodeReference = 0, AdjustPropertiese = 1, AuthorProperties = 2, AuthorDeclarations = 3,
  AuthorAllocations = 4, ControlMigration = 5, UndefinedProperty = 6, AuthorSubsystem = 7,
  RefactorHost = 8, InitializeComponent = 9
}
 
enum  ControlMigration { BlockAddRange = 1, BlockControlAnalysis = 2 }
 
enum  LibraryType { Internal = 0, Native = 1, ActiveX = 2, LocalImport = 3 }
 
enum  ExceptionType { ExceptionType.simple = 0, ExceptionType.seterrorobject = 1, ExceptionType.useTryCatch = 2 }
 The ExceptionType enumeration lists how the analyzer should deal with exception handling when doing VB.NET target translations. More...
 
enum  FixedType { FixedType.SHORT = 2, FixedType.INTEGER = 3, FixedType.LONG = 4 }
 The FixedType enumerations lists the integer types that are used within BASIC codes. More...
 
enum  MissingType { MissingType.off = 0, MissingType.JustDoIt = 1, MissingType.Fatal = 2 }
 The MissingType enumeration describes the treatment of missing references either to project file references to external libraries or ASP page references to include files. More...
 
enum  OutStyle { Text = 0, Html = 1, Tabbed = 2 }
 
enum  ProcessingStatus { Ignore = 0, Warn = 1, Warning = 1, Error = 2 }
 
enum  StorageUnit {
  StorageUnit.USER = 1, StorageUnit.LANG = 2, StorageUnit.TEMP = 3, StorageUnit.INFO = 4,
  StorageUnit.CLIENT = 5, StorageUnit.SCRATCH = 6, StorageUnit.METHODS = 7, StorageUnit.DATA = 8
}
 The StorageUnit enumeration defines the different storage areas used by the Store class. More...
 

Enumeration Type Documentation

◆ AuthorLibType

The AuthorLibType enumeration specifies the ways in which interface description files are authored when libraries or control projects are translated.

Enumerator
off 

The off entry requests that no interface description file be authored.

on 

The on entry requests that an interface description file be authored to the code bundle. It is not sent to the "local" location until the bundle is deployed

deploy 

The deploy entry requests that the IDF be authored directly to the "local" location when the defining source code is translated.

◆ BuildFileStatus

The BuildFileStatus enumeration specifies the external handling strategies for migration.

Enumerator
off 

The off entry specifies that some other migration approach is being used. No stubs, local or global, are being used.

on 

The on entry specifies that local stubs are being authored. It is deprecated.

Local 

The Local entry specifies that local stubs are being authored.

Global 

The Global entry specifies that global native stub files have been created and should be used. This will be the typical setting, once a code set migration is running beyond its initial steps.

◆ CharacterSets

The CharacterSets enumeration specifies the source character tht can be specified via the "charset" select property.

Enumerator
ASCII 

The ASCII CharacterSet can contain single byte codes in the range 128-255 which simply represent other special characters. This is the default and corresponds to the original design of the tool.

UTF8 

The UTF8 character set contains sequences of two or more bytes all of whose codes are greater than 127. These multibyte sequences each represent a single character.

Shift_JIS 

The Shift_JIS CharacterSet supports double byte sequences whose first byte is greater than 127 and whose second byte can be any value in the range 0-255. The double byte sequences are treated as a single character. The tool has explicit support implemented for this Character Set

◆ CheckDeclarationType

The CheckDeclarationType enumeration specifies the checking and reporting alternatives for the consistency between DECLARE statements in the source codes and those in a interface description files.

Enumerator
off 

The off entry does not use external descriptions to check declares.

on 

The on entry checks the declares and warns about inconsistencies.

ignore 

The ignore entry checks the declares but ignores differences between source and external descriptions

audit 

The audit reports on all Declares found in the source codes.

◆ ComponentType

The ComponentType enumeration specifies the types of library components declared in interface description files. It is stored in the "tLibComp" property "refType".

Enumerator
Method 

The Method entry indicates that the component was defined in a "Method" declaration.

Accessor 

The Accessor entry indicates that the component was defined in an "Accessor" declaration.

Event 

The Event entry indicates that the component was defined in an "Event" declaration.

Property 

The Property entry indicates that the component was defined in a "Property" declaration.

Enumeration 

The Enumeration entry indicates that the component was defined in an "Enumeration" declaration.

EnumEntry 

The EnumEntry entry indicates that the component was defined in an "Entry" declaration within an enumeration.

Structure 

The Structure entry indicates that the component was defined in a "Structure" or "Union" declaration.

Argument 

The Argument entry indicates that the component was defined in an "Argument" declaration within a Method or Event.

Constant 

The Constant entry indicates that the component was defined in a "Constant" declaration.

TextBlock 

The TextBlock entry has been deprecated. It related to blocks of text that have been replaced by the more general gmSL methods.

Statements 

The Statements entry indicates that the component contains a set of "Statemetnts" defined with the language file.

Statement 

The Statement entry indicates that the entry defines a "Statement" within a block of statements.

Attribute 

The Attribute entry indicates that the component was defined in an "Attribute" declaration in the language file.

BeginProp 

The BeginProp entry has been deprecated in favor of the more general gmSL approach.

NameValue 

The NameValue entry has been deprecated in favor of the more general gmSL approach.

◆ DisplayType

The DisplayType enumeration lists the various types of component displays that can be performed on specified information values by the Symbol.DisplayInfo method.

Enumerator
INTEGER_VALUE 

Regardless of the role of the information value, it's actual integer value is displayed.

PARENT_OFFSET 

The role of the information value is assumed to be a component root offset. The offset of it's parent is displayed as an integer value.

OBJECT_TYPE 

The role of the information value is assumed to be a component root offset. The extended name of its object type is displayed.

FULL_IDENT 

The role of the information value is assumed to be a component root offset. Its fully-qualified source identifier is displayed.

MIGRATE_STATUS 

The role of the information value is to contain migration status flags. The set flag identifiers are displayed concatenated with a '|'.

STRING_VALUE 

The role of the information value is to contain the offset in storage of a string. The string is accessed and displayed.

PATTERN 

The role of the information value is to contain the offset of a surface pattern. The pattern is accessed and displayed.

CONTEXT_FLAGS 

The role of the information value is to contain compilation context flags. The set flag identifiers are displayed concatenated with '|'.

ASP_CONTEXT 

The role of the information value is to contain ASP compilation context flags. The set flag identifiers are displayed concatenated with '|'.

IDENT_OFFSET 

The role of the information value is assumed to be a component root offset. Its simple identifier is displayed combined with the value of its offset.

OBJECT_NAME 

The role of the information value is assumed to be an object type specification. Its name is displayed.

INTERFACES 

The role of the information value is to contain the offset in storage of a list of interfaces. The identifiers of those interfaces are displayed.

REFERENCES 

The role of the information value is to contain the offset in storage of a list of references. The identifiers of those references are displayed.

INFO_STATUS 

The role of the information value is to contain the offset of a list of information items. The offset followed by the number of entries in the list are displayed.

CURRENT_CODE 

The role of the information value is assumed to be a component root offset for a component that can have code blocks associated with it. The code corresponding to the current dialect is displayed.

CHILDCONTROLS 

The role of the information value is assumed to be a component root offset for a component that has controls as children. The properties of those controls are displayed.

LIBRARY_TYPE 

The role of the information value is to contain a library type code which is displayed.

MIGRATE_FLAGS 

The role of the information value is to contain migration flag. The set flag identifiers are displayed concatenated with a '|'

BINARY_TYPE 

The information value specifies the binary type code of a symbol. If it is within the OPCODE range then it is a basic binary type. If it is a positive offset,then it is the root address of a user type in the user storage area. If it is a negative offset, then it is the root offset of a user type in the language area.

AUDIT_TEXT 

The information value is the offset of a text stream. The text within that stream is displayed.

MIGRATE2_FLAGS 

The role of the information value is to contain additional migration flag. The set flag identifiers are displayed concatenated with a '|'.

SOURCE_NAME 

The role of the information value is assumed to be a component root offset. Its simple source identifier is displayed.

TARGET_NAME 

The role of the information value is assumed to be a component root offset. Its simple target identifier is displayed.

FULL_NAME 

The role of the information value is assumed to be a component root offset. Its fully-qualified target name is displayed.

◆ ExceptionType

The ExceptionType enumeration lists how the analyzer should deal with exception handling when doing VB.NET target translations.

Enumerator
simple 

The simple entry indicates that logic to set the VBNET.Err object will not be authored.

seterrorobject 

The seterrorobject entry indicates that logic should be authored in try/catch blocks so that the VBNET.Err object will be set to reflect the error number.

useTryCatch 

The useTryCatch entry indicates that the tool should use Try-Catch as opposed to On Error GoTo style error handling for VBN translations. In essence, this entry tells the analyzer to use the same analyzer method that is presently used for CSH for VBN as well.

◆ FixedType

The FixedType enumerations lists the integer types that are used within BASIC codes.

Enumerator
SHORT 

The SHORT entry treats BASIC integers as 2-byte integers in the target languages.

INTEGER 

The INTEGER entry treats BASIC integers as 4-byte integers in the target languages.

LONG 

The LONG entry treats BASIC integers as 8-byte integers in the target languages.

◆ LexemeType

Tokens, as define by a parser, represent a pair (lexeme type, lexeme value). The LexemeType enumeration lists the types of lexeme.

Enumerator
EndOfRecord 

The EndOfRecord entry is the generic end of the current record. It has a lexeme length of zero.

Special 

The Special entry is some character that could not not be classified as part of one of the defined lexemes. In this case the lexeme-length is one and the lexeme-value is the character.

Identifier 

The Identifier entry is a valid identifier or keyword – i.e. it begins with an identifier character and continues until a character that is neither an identifier nor a digit is encountered.

Integer 

The Integer entry is an integer constant.

Float 

The Float entry is a floating-point constant. At this time ANSI-C format is assumed for floating point constants.

Quoted 

The Quoted entry is a quoted string. The quotes used to enclose the lexeme value are not include and the conventions for internal quotes vary by the language dialect being processed.

HexCons 

The HexCons enty is an exact reresentation numeric constant of some sort. Its syntax varies by the language dialect being processed.

Minus 

The Minus entry is the character "-" in all language dialects.

Not 

The Not entry is the Basic word "not" and the Java symbol "!".

ToPower 

The ToPower entry is the Basic symbol "^".

Multiply 

The Multiply enter is the symbol "*" in all language dialects.

Divide 

The Divide entry is the symbol "\" in all language dialects.

IntegerDivide 

The IntegerDivide entry is the Basic symbol "/".

Modulo 

The Modulo entry is the Basic word "mod" and the Java symbol "%".

Add 

The Add entry is the symbol "+" in all language dialects.

Subtract 

The Subtract entry is deprecated as it matchs the entry Minus in all language dialects.

Concatenate 

The Concatenate entry is the Basic ampersand symbol.

NotEqual 

The NotEqual entry is the Basic symbol "LT GT" and the Java symbol "!=".

◆ MissingType

The MissingType enumeration describes the treatment of missing references either to project file references to external libraries or ASP page references to include files.

Enumerator
off 

Issue a warning message about the missing reference and continue processing.

JustDoIt 

Issue no message and continue processing as though the referenced library description file or include file had been found and loaded.

Fatal 

Issue a message about the missing reference end execution.

◆ StorageUnit

The StorageUnit enumeration defines the different storage areas used by the Store class.

Enumerator
USER 

USER is the default storage area for application defined information.

LANG 

LANG is the storage area used to contain the language file controlling the translation.

TEMP 

TEMP is a temporary storage area used within specific tasks. It is never left open, between tasks.

INFO 

INFO is a temporary storage area used by the gmPL utility statements like IncludeOrder.

CLIENT 

CLIENT is a storage area used to contain the GlobalSettings information.

SCRATCH 

SCRATCH is a storage are used internally for scratch storage during the execution of gmSL.

METHODS 

METHODS is a storage area used to contain compiled gmSL methods to be used by a translation.

DATA 

DATA is a storage area used to contain tables ma ganged via the DataStore class.