nl::ArgParser::HelpOptions

#include <src/lib/support/nlargparser.hpp>

用于处理信息选项(帮助、版本)的常用 OptionSet

摘要

继承

继承自: nl::ArgParser::OptionSetBase

构造函数和析构函数

HelpOptions(const char *appName, const char *appUsage, const char *appVersion)
HelpOptions(const char *appName, const char *appUsage, const char *appVersion, const char *appDesc)

公共属性

AppDesc
const char *
应用目的/行为的说明。
AppName
const char *
命令行应用的名称。
AppUsage
const char *
描述应用命令行语法的简短字符串。
AppVersion
const char *

公共函数

HandleOption(const char *progName, OptionSet *optSet, int id, const char *name, const char *arg)
virtual bool
PrintBriefUsage(FILE *s)
void
输出该命令使用的简短说明,以及有关如何获取更多帮助的说明。
PrintLongUsage(OptionSet *optSets[], FILE *s)
void
输出完整的使用情况信息,包括所有可用选项的相关信息。
PrintVersion(FILE *s)
void

公共属性

AppDesc

const char * AppDesc

应用目的/行为的说明。

AppName

const char * AppName

命令行应用的名称。

AppUsage

const char * AppUsage

描述应用命令行语法的简短字符串。

AppVersion

const char * AppVersion

公共函数

HandleOption

virtual bool HandleOption(
  const char *progName,
  OptionSet *optSet,
  int id,
  const char *name,
  const char *arg
)

HelpOptions

 HelpOptions(
  const char *appName,
  const char *appUsage,
  const char *appVersion
)

HelpOptions

 HelpOptions(
  const char *appName,
  const char *appUsage,
  const char *appVersion,
  const char *appDesc
)

PrintBriefUsage

void PrintBriefUsage(
  FILE *s
)

输出该命令使用的简短说明,以及有关如何获取更多帮助的说明。

PrintLongUsage

void PrintLongUsage(
  OptionSet *optSets[],
  FILE *s
)

输出完整的使用情况信息,包括所有可用选项的相关信息。

PrintVersion

void PrintVersion(
  FILE *s
)