Unit Command.Builder
Description
Main unit of the library, contains the implementation of the main interfaces.
Overview
Classes, Interfaces, Objects and Records
| Name | Description |
|---|---|
Class TOption |
Class that implements the IOption interface that represents an option that can be configured as expected for a command. |
Class TCommand |
Class that implements the ICommand interface that represents a command that can be registered in CommandBuilder for later use by the user. |
Class TArgument |
Class that implements the IArgument interface that represents an argument that can be registered in CommandBuilder for later use by the user. |
Class TCommandBuilder |
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. |
Functions and Procedures
function StandardConsoleInputLn: string; |
procedure StandardConsoleOutput(const AMessage: string); |
procedure ColorConsoleOutput(const AMessage: string; const AColor: byte); |
Description
Functions and Procedures
function StandardConsoleInputLn: string; |
|
Standard callback function to read input from user. Automatically configured on CommandBuilder startup. |
procedure StandardConsoleOutput(const AMessage: string); |
|
Standard callback procedure that outputs the given text to the console. In this implementation it just mirrors the use of the WriteLn function. It is expected for this type of callback that the output will be performed with a line break at the end of it. |
procedure ColorConsoleOutput(const AMessage: string; const AColor: byte); |
|
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. |
Generated by PasDoc 0.16.0.