代码拉取完成，页面将自动刷新
SqConsole provide command-line interface (mainly for SqAppTool). It must use with SqCommand and SqOption.
Note: SqConsole is in sqxcsupport library.
Relationship of SqConsole, SqCommand, and SqOption.
1 : N 1 : N
SqConsole ───┬─── SqCommand 1 ───┬─── SqOption 1-1
│ │
│ └─── SqOption 1-2
│
└─── SqCommand 2 ───┬─── SqOption 2-1
│
└─── SqOption 2-2
User can use SqCommand to define constant (or dynamic) command and it's options. Because it derives from SqType, SqCommand's options can use Sqxc to output JSON or SQL.
SqConsole use this to parse data from command-line and store parsed data in SqCommandValue.
SqType
│
└─── SqCommand
It defines option in command. Because it derives from SqEntry, you can set SQB_POINTER in SqOption::bit_field if the option value in C/C++ language is a pointer type.
SqEntry
│
└─── SqOption
SqCommandValue stores option values and arguments from command-line.
e.g. Define new command "mycommand", which has 3 options: "help", "quiet" and "step".
First define structure MyCommandOptions for options of 'mycommand'.
struct MyCommandOptions
{
bool help;
bool quiet;
int step;
};
// The function will be called when your command is executed.
void mycommand_handle(SqCommandValue *commandValue, SqConsole *console, void *data)
{
MyCommandOptions *options = (MyCommandOptions*)commandValue->options;
// do something here...
}
If you define constant SqCommand, it must use with pointer array of SqOption.
static const SqOption mycommand_option_array[] = {
{SQ_TYPE_BOOL, "help", offsetof(MyCommandOptions, help),
.shortcut = "h", .default_value = "true",
.description = "Display help for the given command."},
{SQ_TYPE_BOOL, "quiet", offsetof(MyCommandOptions, quiet),
.shortcut = "q", .default_value = "true",
.description = "Do not output any message."},
{SQ_TYPE_INT, "step", offsetof(MyCommandOptions, step),
.shortcut = "s", .default_value = "1",
.description = "Take step."},
};
static const SqOption *mycommand_options[] = {
& mycommand_option_array[0],
& mycommand_option_array[1],
& mycommand_option_array[2],
};
Setting SQB_POINTER in SqOption::bit_field if the option value in C/C++ language is a pointer type.
const SqOption options[] = {
{SQ_TYPE_MY_OBJECT, "obj", offsetof(MyCommandOptions, obj), SQB_POINTER},
// ^^^^^^^^^^^
// Omitted
}
To define constant SqCommand, you can use C99 designated initializer (or C++ aggregate initialization) or use C macro SQ_COMMAND_INITIALIZER().
const SqCommand mycommand = SQ_COMMAND_INITIALIZER(
MyCommandOptions, // StructureType
0, // bit_field
"mycommand", // command name
mycommand_options, // pointer array of SqOption
mycommand_handle, // handle function
"mycommand parameterName", // parameter string
"mycommand description" // description string
);
/* above SQ_COMMAND_INITIALIZER() Macro Expands to
const SqCommand mycommand = {
// --- SqType members ---
.size = sizeof(MyCommandOptions),
.parse = sq_command_parse_option,
.write = sq_type_object_write,
.name = "mycommand",
.entry = (SqEntry**) mycommand_options,
.n_entry = sizeof(mycommand_options) / sizeof(SqOption*),
.bit_field = 0,
.on_destroy = NULL,
// --- SqCommand members ---
.handle = (SqCommandFunc) mycommand_handle,
.parameter = "mycommand parameterName",
.description = "mycommand description",
};
*/
If you create dynamic SqCommand, it can add both constant and dynamic options.
e.g. create 'mycommand' by function.
use C language
SqCommand *mycommand;
mycommand = sq_command_new("mycommand");
mycommand->size = sizeof(MyCommandOptions);
mycommand->handle = mycommand_handle;
sq_command_set_parameter(mycommand, "mycommand parameterName");
sq_command_set_description(mycommand, "mycommand description");
use C++ language
Sq::Command *mycommand;
mycommand = new Sq::Command("mycommand");
mycommand->size = sizeof(MyCommandOptions);
mycommand->handle = mycommand_handle;
mycommand->setParameter("mycommand parameterName");
mycommand->setDescription("mycommand description");
To add options to command, you can use C function sq_command_add_option(), C++ method addOption().
Add constant array of SqOption
e.g. add array that has 3 options to 'mycommand'.
// C function
sq_command_add_option(mycommand, mycommand_option_array, 3);
// C++ method
mycommand->addOption(mycommand_option_array, 3);
Add dynamic SqOption
e.g. create a option and add it to command.
use C language
SqOption *option;
option = sq_option_new(SQ_TYPE_BOOL);
option->offset = offsetof(MyCommandOptions, help);
sq_option_set_name(option, "help");
sq_option_set_shortcut(option, "h");
sq_option_set_default_value(option, "true");
sq_option_set_description(option, "Display help for the given command.");
sq_command_add_option(mycommand, option, 1);
use C++ language
Sq::Option *option;
option = new Sq::Option(SQ_TYPE_BOOL);
option->offset = offsetof(MyCommandOptions, help);
option->setName("help");
option->setShortcut("h");
option->setDefault("true");
option->setDescription("Display help for the given command.");
mycommand->addOption(option);
Calling pointer() if the option value in C/C++ language is a pointer type.
// C function
sq_option_pointer(option);
// C++ method
option->pointer();
// C function
sq_console_add(console, &mycommand);
// C++ method
console->add(&mycommand)
e.g. execute program with specified command, options, and arguments.
program mycommand --step=5 argument1 argument2
Calling parse() to parse command-line arguments.
use C language
int main(int argc, char **argv)
{
SqCommandValue *commandValue;
int command_in_argv = 1;
commandValue = sq_console_parse(console, argc, argv, command_in_argv);
}
use C++ language
int main(int argc, char **argv)
{
Sq::CommandValue *commandValue;
int command_in_argv = 1;
commandValue = console->parse(argc, argv, command_in_argv);
}
The return value of sq_console_parse() is 'commandValue', and its member values should be as follows:
commandValue->type = mycommand;
commandValue->arguments.data[0] = "argument1";
commandValue->arguments.data[1] = "argument2";
commandValue->arguments.length = 2;
MyCommandOptions *options = commandValue->options;
options->help = false;
options->quiet = false;
options->step = 5;
If you only need to parse options and arguments and no command, calling parse() and specify the last argument as 0. In this case, SqConsole use first added command by default.
e.g. Execute the program with only options and parameters, no command specified.
program --step=5 argument1 argument2
Call parse() and specify the last argument as 0 to parse command-line arguments without a command.
int command_in_argv = 0;
// C function
commandValue = sq_console_parse(console, argc, argv, command_in_argv);
// C++ method
commandValue = console->parse(argc, argv, command_in_argv);
If you want to parse both a command or just options, call parse() and specify -1 as the last argument. If there are only options on the command-line, SqConsole use first added command by default.
e.g. print version information (by handler of first added command).
program --version
release memory of 'commandValue'
use C language
SqCommandValue *commandValue;
sq_command_value_free(commandValue);
use C++ language
C++ Sq::CommandValue has defined destructor, so user can use 'delete' keyword to free memory.
Sq::CommandValue *commandValue;
delete commandValue;
// or
// commandValue->free();
To print help message, you can use C function sq_console_print_help(), C++ method printHelp().
If 'command' is NULL, they use first added SqCommand to print help message without name of command.
SqCommand* command = mycommand;
// C function
sq_console_print_help(console, command);
// C++ method
console->printHelp(command);
When your program has multiple command, you can use printList() to list all commands added in SqConsole.
const char *program_description = "Program description, which is printed before other help messages.";
// C function
q_console_print_list(console, program_description);
// C++ method
console->printList(program_description);
此处可能存在不合适展示的内容，页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容，可点击提交进行申诉，我们将尽快为您处理。
马建仓 AI 助手
