All Identifiers

Name Unit Description
ACommandLineAbbreviation linearc

This class represents the abbreviated form of a command-line option.

ACommandLineChoice linearc

This class represents a command-line option that expects a value to be chosen from a list of pre-defined values.

ACommandLineFlag linearc

This class represents a command-line flag; that is, an option with a value that is only true if the user specifies the name of the option on the command line.

ACommandLineFloatRange linearc

This class represents an option that expects a floating-point value which falls between a predefined minimum and maximum.

ACommandLineIntegerRange linearc

This class represents an option that expects an integer value which falls between a predefined minimum and maximum.

ACommandLineList linearc

This class represents an option that can be specified more than once on the command line; each time it occurs, the value specified is added to a list of values.

ACommandLineNumber linearc

This class represents an option that expectas a numeric value.

ACommandLineOption linearc

 

ACommandLineOptionDictionary linearc

This class represents a dictionary of command-line options.

ACommandLineString linearc

This class represents a command-line option that expects a string value.

ACommandLineSwitch linearc

This class represents a command-line switch; that is, an option that accepts a value which may be True or False.

ALinearCAssignmentStatement linearc

This class represents an assignment statement in LinearC; that is, the portion of a command line where a value is assigned to a named option.

ALinearCBooleanExpression linearc

This class represents a boolean expression in LinearC, which is an expression that consists of a single keyword belonging to either RULE_TRUTH or RULE_FALSEHOOD.

ALinearCCompoundExpression linearc

This class represents a compound expression in LinearC, which can be made up of one or more subexpressions.

ALinearCConsoleApplication linearc

This class represents a single process running as a console application, which expects to receive arguments on its command line and which can parse those arguments with an instance of ALinearCParser.

ALinearCExpression linearc

This class represents an expression in LinearC.

ALinearCIdentifierExpression linearc

This class represents an identifier expression in LinearC, which is an expression that refers to the name of an option.

ALinearCNumericExpression linearc

This class represents a numeric expression in LinearC, which is an expression that consists of a single number, either integer or floating-point.

ALinearCParser linearc

This class represents a parser for the LinearC language.

ALinearCPathExpression linearc

This class represents a path expression in LinearC, which an expression that begins with a path delimiter, such as lcopDivideString or lcdlBackslashString and which is not contained in quotes (otherwise it would be seen as a string expression).

ALinearCRestArgument linearc

This class represents a statement in LinearC that is composed entirely of a rest argument; that is, an argument which does not include the name of an existing option.

ALinearCStatement linearc

This class represents a single statement that is pared by the LinearC parser.

ALinearCStatementBlock linearc

This class represents a statement block that is parsed by the LinearC parser.

ALinearCStringExpression linearc

This class represents a string expression in LinearC, which is an expression that consists of a single string, delimited by either lcdlQuote1String or lcdlQuote2String.

AnOptionDirtiedHandler linearc

This type is used to specify a callback routine which is invoked after the options have been parsed and if the option has been set.

AnOptionValueError linearc

An instance of this exception class is raised by ACommandLineOption.setValue if the value to be set does not conform to the option's definition.

AnOptionValueType linearc

This type is used to contain the flags which indicate what type of value is accepted by an instance of ACommandLineOption.

clchAcceptedValuesDescription linearc

This string controls the format of the extra string appended to the result returned when ACommandLineChoice.usageString is called.

clchDefaultValueDescription linearc

This string contains the default description returned by ACommandLineChoice.valueDescription if no other description is set when the option is constructed.

clchErrorValueExpected linearc

This string controls the format of the error message emitted by ACommandLineChoice.setValue in the event that the routine is given a value which is incompatible with the option.

clflDefaultValueDescription linearc

This string contains the default description returned by ACommandLineFlag.valueDescription if no other description is set when the option is constructed.

clfrAcceptedValuesDescription linearc

This string controls the format of the extra string appended to the result returned when ACommandLineFloatRange.usageString is called.

clfrDefaultValueDescription linearc

This string contains the default description returned by ACommandLineFloatRange.valueDescription if no other description is set when the option is constructed.

clfrErrorValueExpected linearc

This string controls the format of the error message emitted by ACommandLineFloatRange.setValue in the event that the routine is given a value which is incompatible with the option.

clirAcceptedValuesDescription linearc

This string controls the format of the extra string appended to the result returned when ACommandLineIntegerRange.usageString is called.

clirDefaultValueDescription linearc

This string contains the default description returned by ACommandLineIntegerRange.valueDescription if no other description is set when the option is constructed.

clirErrorValueExpected linearc

This string controls the format of the error message emitted by ACommandLineIntegerRange.setValue in the event that the routine is given a value which is incompatible with the option.

clnmDefaultValueDescription linearc

This string contains the default description returned by ACommandLineNumber.valueDescription if no other description is set when the option is constructed.

clodPrintHeaderRepresentation linearc

This string controls the format of the header printed when ACommandLineOptionDictionary.printUsageTo is called.

clopAbbreviationsRepresentation linearc

This string controls the format of the string used to indicate to the user what abbreviations may be given instead of the full name of an option.

clopAssignmentOperator linearc

This string determines the character that is used to indicate a value should be assigned to a named option.

clopAssignmentRepresentation linearc

This string controls the format of the string used to indicate to the user which values may be assigned to an option.

clopDefaultValueDescription linearc

This string contains the default description returned by ACommandLineOption.valueDescription if no other description is set when the option is constructed.

clopDefaultValueRepresentation linearc

This string controls the format of the string used to indicate the default value of an option to the user.

clopDescriptionColumn linearc

This constant is used to determine where the descriptions of command-line options begin when printed to a text-based device, such as a console.

clopErrorValueExpected linearc

This string controls the format of the error message issued in the event that ACommandLineOption.setValue is given a value that it cannot use, based on the definition of the option.

clopFlagRepresentation linearc

This string controls the format of the string used to indicate to the user which values may be assigned to an option.

clopNameColumn linearc

This constant is used to determine where the names of command-line options begin when printed to a text-based device, such as a console.

clopParameterAbbreviationDelimiter linearc

This string determines the characters that are used to indicate the abbreviated name of a command line parameter when it is passed on the command line.

clopParameterNameDelimiter linearc

This string determines the characters that are used to indicate a parameter name on the command line.

clopRequiredRepresentation linearc

This string controls the string used to indicate when an option is required.

clopStringRepresentation linearc

This string controls the format of the string returned when ACommandLineOption.usageString is called.

clstDefaultValueDescription linearc

This string contains the default description returned by ACommandLineString.valueDescription if no other description is set when the option is constructed.

clswDefaultValueDescription linearc

This string contains the default description returned by ACommandLineSwitch.valueDescription if no other description is set when the option is constructed.

lcappErrorUnsetRequiredOption linearc

 

lcappHelpDescription linearc

 

lcappHelpLongString linearc

 

lcappHelpShortString linearc

linearcstatements.inc - A descendant of AConsoleApplication that builds and executes a command-line parser automatically.

lcappUsageHelpDescription linearc

 

lcappUsageStringFormat linearc

 

lcappVersionDefaultAdditionalItems linearc

This array can be used to determine whether and how ALinearCConsoleApplication.printVersionTo prints additional items besides just the program name and version.

lcappVersionDescription linearc

 

lcappVersionLongString linearc

 

lcappVersionStringFormat linearc

 

lcbxErrorBooleanExpressionExpected linearc

This string controls the format of the error message emitted by ALinearCBooleanExpression.parse when an invalid boolean expression is encountered.

lccsDigit linearc

This string specifies the characters that LinearC recognizes as beginning a numeric constant.

lccsLetter linearc

This string specifies the characters that LinearC recognizes as alphanumeric.

lccsSpecial linearc

This string specifies the characters that LinearC recognizes as operators or delimiters.

lccxErrorInvalidOperation linearc

This string controls the format of the error message emitted by ALinearCCompoundExpression.performOperation when an attempt is made to peform a mathematical operation on incompatible value types.

lcdlBackslash linearc

 

lcdlBackslashString linearc

In order to parse Windows-style paths, the LinearC parser must know about backslash characters.

lcdlBeginLongOption linearc

 

lcdlBeginShortOption linearc

 

lcdlLeftParen linearc

 

lcdlLeftParenString linearc

In order to parse compound expressions, the LinearC parser must know when one expression begins and ends.

lcdlQuote1 linearc

 

lcdlQuote1String linearc

In order to parse strings, the LinearC parser must know when one begins and ends.

lcdlQuote2 linearc

 

lcdlQuote2String linearc

In order to parse strings, the LinearC parser must know when one begins and ends.

lcdlRightParen linearc

 

lcdlRightParenString linearc

In order to parse compound expressions, the LinearC parser must know when one expression begins and ends.

lckwFalse linearc

 

lckwFalseString linearc

In order to process switch options, LinearC must define some tokens that represent truth and falsehood.

lckwNoFull linearc

 

lckwNoFullString linearc

In order to process switch options, LinearC must define some tokens that represent truth and falsehood.

lckwNoShort linearc

 

lckwNoShortString linearc

In order to process switch options, LinearC must define some tokens that represent truth and falsehood.

lckwOff linearc

 

lckwOffString linearc

In order to process switch options, LinearC must define some tokens that represent truth and falsehood.

lckwOn linearc

 

lckwOnString linearc

In order to process switch options, LinearC must define some tokens that represent truth and falsehood.

lckwTrue linearc

 

lckwTrueString linearc

In order to process switch options, LinearC must define some tokens that represent truth and falsehood.

lckwYesFull linearc

 

lckwYesFullString linearc

In order to process switch options, LinearC must define some tokens that represent truth and falsehood.

lckwYesShort linearc

 

lckwYesShortString linearc

In order to process switch options, LinearC must define some tokens that represent truth and falsehood.

lcnxErrorInvalidNumber linearc

This string controls the format of the error message emitted by ALinearCNumericExpression.parse when it encounters something that looks like it should be a number, but which cannot be evaluated as such.

lcopAnd linearc

 

lcopAndString linearc

The LinearC parser allows bitwise operations on numeric values.

lcopAssign linearc

 

lcOpcodeCount linearc

This constant represents the total number of opcodes defined for the LinearC language.

lcopDivide linearc

 

lcopDivideString linearc

The LinearC parser supports basic arithmetic operations on the command line.

lcopEquality linearc

 

lcopEqualityString linearc

The LinearC parser allows equality tests on numeric values.

lcopExponent linearc

 

lcopExponentString linearc

The LinearC parser supports basic arithmetic operations on the command line.

lcopGreater linearc

 

lcopGreaterOrEqual linearc

 

lcopGreaterOrEqualString linearc

The LinearC parser allows equality tests on numeric values.

lcopGreaterString linearc

The LinearC parser allows equality tests on numeric values.

lcopInequality linearc

 

lcopInequalityString linearc

The LinearC parser allows equality tests on numeric values.

lcopLesser linearc

 

lcopLesserOrEqual linearc

 

lcopLesserOrEqualString linearc

The LinearC parser allows equality tests on numeric values.

lcopLesserString linearc

The LinearC parser allows equality tests on numeric values.

lcopMinus linearc

 

lcopMinusString linearc

The LinearC parser supports basic arithmetic operations on the command line.

lcopModulo linearc

 

lcopModuloString linearc

The LinearC parser supports basic arithmetic operations on the command line.

lcopNot linearc

 

lcopNotString linearc

The LinearC parser allows boolean options to be defined as NOT true or NOT false.

lcopOr linearc

 

lcopOrString linearc

The LinearC parser allows bitwise operations on numeric values.

lcopPlus linearc

The opcodes recognized by the language

lcopPlusString linearc

The LinearC parser supports basic arithmetic operations on the command line.

lcopShl linearc

 

lcopShlString linearc

The LinearC parser allows bitwise operations on numeric values.

lcopShr linearc

 

lcopShrString linearc

The LinearC parser allows bitwise operations on numeric values.

lcopTimes linearc

 

lcopTimesString linearc

The LinearC parser supports basic arithmetic operations on the command line.

lcopXor linearc

 

lcopXorString linearc

The LinearC parser allows bitwise operations on numeric values.

lcstWarningUnknownOption linearc

This string controls the format of the warning issued in the event that ALinearCAssignmentStatement.parse encounters an attempt to name an option on the command line that was not defined in its list of available options.

lcsxErrorInvalidEscapeSpecifier linearc

This string controls the format of the error message emitted by ALinearCStringExpression.convertEscapeSequence when it encounters something that looks like it should be a C-style escape sequence, but cannot parse it.

lcxpErrorValidExpressionExpected linearc

This string controls the format of the error message emitted by ALinearCExpression.parse when an invalid expression is encountered.

LC_APP_RUN_HELP_REQUESTED linearc

This constant is used as the return value of ALinearCConsoleApplication.run to indicate that the user requested help from the command line.

LC_APP_RUN_VERSION_REQUESTED linearc

This constant is used as the return value of ALinearCConsoleApplication.run to indicate the user requested version information from the command line.

RULE_ARITHMETIC_OPERATORS linearc

This constant represents one of the rules defined by TheLinearCLanguage.defineRules; in this case, the types of tokens that may be used as arithmetic operators.

RULE_BEGIN_EXPRESSION linearc

This constant represents one of the rules defined by TheLinearCLanguage.defineRules; in this case, the tokens that are allowed to begin an expression, which in LinearC consists of those tokens encountered after the assignment operator.

RULE_BEGIN_PATH linearc

This constant represents one of the rules defined by TheLinearCLanguage.defineRules; in this case, the tokens that are allowed to begin a path.

RULE_BEGIN_SIMPLE_EXPRESSION linearc

This constant represents one of the rules defined by TheLinearCLanguage.defineRules; in this case, the tokens that are allowed to begin a simple expression.

RULE_BITWISE_OPERATORS linearc

This constant represents one of the rules defined by TheLinearCLanguage.defineRules; in this case, the types of tokens that may be used as bitwise operators.

RULE_DELIMIT_STRING linearc

This constant represents one of the rules defined by TheLinearCLanguage.defineRules; in this case, the tokens that are allowed to delimit string literals.

RULE_END_EXPRESSION linearc

This constant represents one of the rules defined by TheLinearCLanguage.defineRules; in this case, the tokens that are allowed to end an expression.

RULE_EQUALITY_OPERATORS linearc

This constant represents one of the rules defined by TheLinearCLanguage.defineRules; in this case, the types of tokens that may be used as equality-test operators.

RULE_FALSEHOOD linearc

This constant represents one of the rules defined by TheLinearCLanguage.defineRules; in this case, the tokens that are allowed to represent a False value when setting switch options.

RULE_OPERATOR linearc

This constant represents one of the rules defined by TheLinearCLanguage.defineRules; in this case, the tokens that are allowed to represent operators, which may appear between two expressions.

RULE_PRECEDE_ASSIGNMENT linearc

This constant represents one of the rules defined by TheLinearCLanguage.defineRules; in this case, the types of tokens that may precede an assignment expression.

RULE_TRUTH linearc

This constant represents one of the rules defined by TheLinearCLanguage.defineRules; in this case, the tokens that are allowed to represent a True value when setting switch options.

RULE_UNARY_OPERATORS linearc

This constant represents one of the rules defined by TheLinearCLanguage.defineRules; in this case, the tokens that are allowed to represent unary operators, which may appear at the forefront of an expression.

TheLinearCLanguage linearc

This class represents the language specification for a command-line "language" named LinearC.

TOptionValueType linearc

This enumeration indicates the types of options that can be accepted on the command line:

  • ovtNone: Indicates an invalid option; not really used

  • ovtFlag: A flag value, which is assumed to be False unless it is specified on the command-line. A flag value might be specified as --flag when passed on the command line. Represented by instances of ACommandLineFlag.

  • ovtSwitch: A switch, which may be True or False. Unlike flag values, the value of a switch must be explicitly set on the command line. A switch might be specified as --switch=y or --switch=false when passed on the command line. Represented by instances of ACommandLineSwitch.

  • ovtNumber: A numeric value, either integer or floating-point. The only constraints on the value are the limits of the int64 or double types. A numeric value might be specified as --value=23 or --value=42.0 when passed on the command line. Represented by instances of ACommandLineNumber.

  • ovtIntegerRange, ovtFloatRange: A numeric value that must fall between a minimum and maximum value. Represented by instances of ACommandLineIntegerRange and ACommandLineFloatRange.

  • ovtString: A string value. A string value might be specified as --value=text or --value="text" when passed on the command line. Represented by instances of ACommandLineString.

  • ovtMultipleChoice: A value that must match one of a list of provided values. Represented by instances of ACommandLineChoice.

  • ovtList: A value that can be specified more than once on the command line; each occurrence is collected into a list of values. Represented by instances of ACommandLineList.

  • ovtRest: An argument that is specified without a name preceding it. These are usually used to indicate file names. This value is combined with one of the above values.


Generated by PasDoc 0.13.0 on 2015-06-25 11:07:51