NL::参数解析器::帮助选项

#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

公共属性

应用描述

const char * AppDesc

应用程序目的/行为的描述。

应用名称

const char * AppName

命令行应用程序的名称。

应用使用

const char * AppUsage

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

应用版本

const char * AppVersion

公共职能

处理选项

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

帮助选项

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

帮助选项

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

打印简介

void PrintBriefUsage(
  FILE *s
)

打印命令用法的简短说明,然后是有关如何获得更多帮助的说明。

打印长时间使用

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

打印完整的使用信息,包括所有可用选项的信息。

印刷版

void PrintVersion(
  FILE *s
)