All Identifiers

Standard callback procedure that outputs the given text to the console using colors. In this implementation it only mirrors the use of the Write function, but before that it changes the color of the console. It is expected for this type of callback that the output is performed without a line break at the end of it. The original color is not restored impacting future outputs.

Suggested dark color theme. Good to use with a console that has a dark background. Can be assigned to CommandBuilder's ColorTheme property.

Returns an argument list configured for CommandBuilder as a simple string. It will be used to display argument usage info to the user.

Interface representing an argument that can be registered in CommandBuilder for later use by the user.

Interface that represents the CommandBuilder, its main purpose is to configure the arguments, commands and options accepted by the tool. Central point of the library, responsible for comparing and validating the parameters passed via the command line against the configured parameters, later executing the callback linked to the localized command.

Base interface for any validation that needs to be implemented. Specification validations need to inherit from this interface by convention from this library. It already has control for the successor validator as well as its automatic call at the appropriate time.

This command outputs text for each color represented by the constant colors in this unit. You may add this command to the application using TCommandBuilder.AddCommand, so you can check how a given color is displayed on console. There is sample app called colors on the source code repository that shows how this command works.

Configure UsageCommand with standard parameters.

Removes the first "-" and second "-" characters if found from the string passed as a parameter. Returns a new string without these characters.

Standard callback function to read input from user. Automatically configured on CommandBuilder startup.

Initial color themes available from the library. Can be assigned to CommandBuilder's ColorTheme property.

Callback function signature need to add a command using the overloaded version of CommandBuilder.AddCommand. This signature is different to avoid collision with the TCommandCallback signature. The return result is not required.

Enumerated type that defines constraints that apply on arguments. It is used to indicate to the CommandBuilder the rules for using arguments, allowing its validation to be done automatically.

Class that implements the ICommand interface that represents a command that can be registered in CommandBuilder for later use by the user.

Class that implements the ICommandBuilder interface, its main purpose is to configure the arguments, commands and options accepted by the tool. Central point of the library, responsible for comparing and validating the parameters passed by the command line with the configured parameters, later executing the callback linked to the localized command.

Enumerated type that defines constraints that apply on commands. It is used to indicate to the CommandBuilder the rules for using the command, allowing its validation to be done automatically.

Returns an error if a command was configured without a callback

Returns an error if an option was passed twice.

Class that implements the IOption interface that represents an option that can be configured as expected for a command.

Callback procedure signature that is intended to output text to the console, or other desired output. The library provides a standard callback that simply calls WriteLn, but it can be overridden so that the output is redirected to a file, a test function, etc.

Returns an error if not required arguments were passed to the command and the constraint ccNoArgumentsButCommands is active for the command.

Returns an error if more arguments were passed than what was set for the command.

Returns an error if an argument has been passed to a command that does not require parameters. Only works if ccNoParameters is set for the command.

Returns an error if an argument has been passed to a command with out at least one option. Only works if ccRequiresOneOption is not set for the command.

Returns an error if a non-existent option was passed to a command.

Returns an error if an option has been passed without a value and it is configured to require a value.

Base class for any validation that needs to be implemented. Specification validations need to inherit from this class by convention from this library. It already has control for the successor validator as well as its automatic call at the appropriate time.

Outputs text describing command usage according to commands, options and arguments configured using application command builder. If a different color theme is specified to the TCommandBuilder.ColorTheme, this command displays the usage info in different colors.

Outputs general help information for the application, including command usage syntax, command list, command description, arguments that are acceptable. Also displays application title and version information.