QCommandLineOption、QCommandLineParser

最新推荐文章于 2025-02-10 14:41:59 发布
最新推荐文章于 2025-02-10 14:41:59 发布
阅读量1.7k 收藏 5
点赞数 1
分类专栏： Qt Core模块 文章标签： qt
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/kenfan1647/article/details/127530324
版权

QCommandLineOption

一、描述

此类用于描述命令行的选项。

二、类型成员

1、enum QCommandLineOption::Flag

  • HiddenFromHelp：在用户可见的帮助输出中隐藏此选项。默认情况下，所有选项都可见。为特定选项设置此标志使其成为内部选项，即不在帮助输出中列出。
  • ShortOptionStyle：无论 QCommandLineParser::setSingleDashWordOptionMode() 设置了什么，该选项始终被认为是短选项。

三、构造函数

1、QCommandLineOption(const QStringList &names, const QString &description, const QString &valueName = QString(), const QString &defaultValue = QString())

      QCommandLineOption(const QString &name, const QString &description, const QString &valueName = QString(), const QString &defaultValue = QString())

      QCommandLineOption(const QStringList &names)

      QCommandLineOption(const QString &name)

使用给定的参数构造命令行选项对象。

选项的名称为 names。名称可以是短名称或长名称。names 列表中任何长度为一个字符的名称都是短名称。选项名称不能以破折号（—）或斜杠字符开头，不能包含=，并且不能重复。

description 为描述。通常在描述的末尾添加一个“.”。

如果选项需要值，则设置为 valueName。

如果选项有默认值，则设置为 defaultValue。

QCommandLineParser

一、描述

QCoreApplication 将命令行参数作为简单的字符串列表提供。此类提供了处理命令行选项的方法，包括定义一组选项、解析命令行参数以及存储实际使用的选项和选项值等功能。

命令行上的选项被识别为以单个或双字符开头。选项 -（单破折号）是一种特殊情况，通常表示标准输入，不作为选项处理。

1.1、短选项

短选项是单个字母。如选项 v 将通过在命令行上传递 -v 来指定。

1.2、长选项

长选项的长度超过一个字母，不能压缩在一起。如长选项 verbose 将作为 --verbose 或 -verbose 传递。

1.3、选项赋值

将值传递给选项可以使用：

  • 赋值运算符：-v=value --verbose=value
  • 空格： -v value --verbose value。即下一个参数用作值（即使它以-开头）。

此类不支持可选值，选项设置必须存在一个值。如果这样的选项放在最后且没有值，则该选项将被忽略。

1.4、禁用长选项

此类不支持使用：--disable 或 --no 来禁用或否定长选项。但可以通过将 no-option 作为其名称的一部分来显式来禁用或否定长选项。

二、类型成员

1、enum QCommandLineParser::OptionsAfterPositionalArgumentsMode：此枚举描述解析器解释参数之后出现的选项的方式。

  • ParseAsOptions：默认的解析模式。[参数] --opt-t 被解释为设置选项 opt 和 t。
  • ParseAsPositionalArguments：[参数] --opt 被解释为两部分，[参数] 和 --opt。

2、enum QCommandLineParser::SingleDashWordOptionMode：此枚举描述了解析器解释一个短划线后跟多个字母（如 -abc）这类命令行选项的方式。

  • ParseAsCompactedShortOptions：-a-bc 等同于 -a-b-c。
  • ParseAsLongOptions：-abc 将被解析为长选项 abc。如果a选项设置了QCommandLineOption::ShortOptionStyle 标志，则会出现异常，在这种情况下，它被解释为：-a bc。

三、成员函数

1、QCommandLineOption addHelpOption()

添加帮助选项（Windows上的：-h、--help、-?）以及选项：--help-all。

setApplicationDescription() 设置应用程序描述，使用此选项时将显示该描述。

int main(int argc, char *argv[])
{
    QCoreApplication app(argc, argv);
    QCoreApplication::setApplicationName("测试");
    QCoreApplication::setApplicationVersion("1.0");

    QCommandLineParser parser;
    parser.setApplicationDescription("这是程序的帮助文本");
    parser.addHelpOption();
    parser.process(app);
}

2、bool addOption(const QCommandLineOption &option)

      bool addOptions(const QList<QCommandLineOption> &options)

添加解析时要查找的选项。返回是否添加选项成功。

      QString value(const QCommandLineOption &option)

      QString value(const QString &optionName)

      QStringList values(const QCommandLineOption &option)

      QStringList values(const QString &optionName)

返回为 optionName 找到的选项值。

3、bool isSet(const QString &name)

检查选项 name 是否已传递给应用程序。

int main(int argc, char *argv[])
{
    QCoreApplication app(argc, argv);
    QCoreApplication::setApplicationName("复制文件");
    QCoreApplication::setApplicationVersion("1.0");

    QCommandLineParser parser;
    parser.setApplicationDescription("这是程序的帮助文本");
    parser.addHelpOption();

    QCommandLineOption showProgressOption("p","复制期间显示进度.");
    parser.addOption(showProgressOption);
    parser.process(app);

    if(parser.isSet("p"))
    {
        qDebug()<<"复制期间显示进度";
    }
}

      bool isSet(const QCommandLineOption &option)

检查选项 option 是否已传递给应用程序。

int main(int argc, char *argv[])
{
    QCoreApplication app(argc, argv);
    QCoreApplication::setApplicationName("复制文件");
    QCoreApplication::setApplicationVersion("1.0");

    QCommandLineParser parser;
    parser.setApplicationDescription("这是程序的帮助文本");
    parser.addHelpOption();

    //具有单个名称（-p）的布尔选项
    QCommandLineOption showProgressOption("p","复制期间显示进度.");
    parser.addOption(showProgressOption);

    //具有多个名称的布尔选项（-f，--force）
    QCommandLineOption forceOption(QStringList() << "f" << "force","覆盖现有文件.");
    parser.addOption(forceOption);

    //具有值的选项
    QCommandLineOption targetDirectoryOption(QStringList() << "t" << "target-directory","将所有源文件复制到 <directory>.","./defaultPath");
    parser.addOption(targetDirectoryOption);
    parser.process(app);

    if(parser.isSet(showProgressOption))
    {
        qDebug()<<"将在复制期间显示进度";
    }

    if(parser.isSet(forceOption))
    {
        qDebug()<<"复制将覆盖现有文件";
    }

    if(parser.isSet(targetDirectoryOption))
    {
        qDebug()<<"将文件复制到："<<parser.value("target-directory");
    }
}

4、void addPositionalArgument(const QString &name, const QString &description, const QString &syntax = QString())

为应用程序定义一个附加参数，以便用于帮助文本。参数名称和描述将出现在帮助的 Arguments: 部分下。

int main(int argc, char *argv[])
{
    QCoreApplication app(argc, argv);
    QCoreApplication::setApplicationName("复制文件");
    QCoreApplication::setApplicationVersion("1.0");

    QCommandLineParser parser;
    parser.setApplicationDescription("这是程序的帮助文本");
    parser.addHelpOption();
    parser.addVersionOption();

    parser.addPositionalArgument("source", "要复制的源文件.");
    parser.addPositionalArgument("destination", "目标目录.");

    parser.process(app);
    const QStringList args = parser.positionalArguments();
    qDebug()<<"参数："<<args;
}

      QStringList positionalArguments()

返回附加参数列表。

      void clearPositionalArguments()

从帮助文本中清除其他参数的定义。

此函数仅适用于支持具有不同选项的多个命令的特殊情况。一旦确定了实际的命令，就可以定义该命令的选项，并且可以相应地调整该命令的帮助文本。

int main(int argc, char *argv[])
{
    QCoreApplication app(argc, argv);
    QCommandLineParser parser;

    parser.addPositionalArgument("command", "The command to execute.");
    parser.parse(QCoreApplication::arguments());

    const QStringList args = parser.positionalArguments();
    const QString command = args.isEmpty() ? QString() : args.first();

    if (command == "resize")
    {
        parser.clearPositionalArguments();
        parser.addPositionalArgument("resize", "将对象调整为新大小.", "resize [resize_options]");
        QCommandLineOption option("size", "新的大小.", "new_size");
        parser.addOption(option);
        parser.process(app);
        if(parser.isSet(option))
        {
            qDebug()<<"新的大小："<<parser.value("size");
        }
    }
}

5、QCommandLineOption addVersionOption()

添加 -v / --version 选项，该选项显示应用程序的版本字符串。可以使用 QCoreApplication::setApplicationVersio() 设置实际版本字符串。

int main(int argc, char *argv[])
{
    QCoreApplication app(argc, argv);
    QCoreApplication::setApplicationName("复制文件");
//    QCoreApplication::setApplicationVersion("1.0");
    QCoreApplication::setApplicationVersion("版本号：1.2.3.001");

    QCommandLineParser parser;
    parser.addVersionOption();
    parser.process(app);
}

6、QString errorText()

返回错误文本。仅当 parse() 返回 false 时调用此函数才有意义。

7、QString helpText()

返回包含完整帮助信息的字符串。

8、QStringList optionNames()

返回解析器找到的所有已识别选项名称的列表，按的找到顺序排列。

对于形式为｛--option=value｝的长选项，value 部分将被删除。

int main(int argc, char *argv[])
{
    QCoreApplication app(argc, argv);
    QCoreApplication::setApplicationName("复制文件");
    QCoreApplication::setApplicationVersion("1.0");

    QCommandLineParser parser;
    parser.setApplicationDescription("这是程序的帮助文本");
    parser.addHelpOption();

    //具有单个名称（-p）的布尔选项
    QCommandLineOption showProgressOption("p","复制期间显示进度.");
    parser.addOption(showProgressOption);

    //具有多个名称的布尔选项（-f，--force）
    QCommandLineOption forceOption(QStringList() << "f" << "force","覆盖现有文件.");
    parser.addOption(forceOption);

    //具有值的选项
    QCommandLineOption targetDirectoryOption(QStringList() << "t" << "target-directory","将所有源文件复制到 <directory>.","./defaultPath");
    parser.addOption(targetDirectoryOption);
    parser.process(app);

    if(parser.isSet(showProgressOption))
    {
        qDebug()<<"将在复制期间显示进度";
    }

    if(parser.isSet(forceOption))
    {
        qDebug()<<"复制将覆盖现有文件";
    }

    if(parser.isSet(targetDirectoryOption))
    {
        qDebug()<<"将文件复制到："<<parser.value("target-directory");
    }

    qDebug()<<parser.optionNames();
}

9、bool parse(const QStringList &arguments)

分析命令行参数。大多数程序不需要调用此函数，只需调用 process() 就足够了。

10、void process(const QStringList &arguments)

处理命令行参数。除了解析选项（parse()），该函数还处理内置选项和错误。

内置选项为 --version（如果调用了 addVersionOption()）和 --help / --help all（如果调用了 addHelpOption()）。

当调用其中一个选项，或者当发生错误时（例如，传递了一个未知选项），当前进程将使用 exit() 函数停止。

      void process(const QCoreApplication &app)

命令行从 QCoreApplication 实例获得。

11、void setApplicationDescription(const QString &description) 

设置 helpText() 显示的应用程序说明。

12、void showHelp(int exitCode = 0)

显示帮助信息，然后退出应用程序。

这由 --help 选项自动触发，但也可以用于在用户没有正确调用应用程序时显示帮助。

退出代码设置为 exitCode。如果用户请求查看帮助，则应将其设置为0，如果出现错误，则应设置为任何其他值。

13、void showVersion()

显示 QCoreApplication::applicationVersion() 中的版本信息，然后退出应用程序。

这由 --version 选项自动触发，但也可以用于在不使用 process() 时显示版本。

退出代码设置为 exit_SUCCESS（等于 0）。

14、QStringList unknownOptionNames()

返回未知选项名称的列表。

对于形式为｛--option=value｝的长选项，value部分将被删除，只添加长名称。

使用QCommandLineParser类解析命令行参数
PixelLogic的博客
08-22 377
QCommandLineParser类是一个非常方便实用的类，能够帮助我们解析命令行参数，并提供了一些方便实用的功能，例如自动生成帮助信息等。其中，name表示该选项的名称，description表示该选项的描述信息，valueName表示该选项需要指定的参数名称，defaultValue表示该选项未指定时的默认值。在上面的示例中，我们使用了QCommandLineParser类创建了一个命令行解析器，设置了应用程序的名称和版本号，并添加了一些选项和帮助信息。在上面的示例中，我们通过。方法来显示帮助信息。
QT的QCommandLineParser类的使用
希望我的博客，能帮上你解决学习中工作中所遇到的问题
12-05 1303
详细说明 QCommandLineParser类提供了一种处理命令行选项的方法。 QCoreApplication提供命令行参数作为简单的字符串列表。 QCommandLineParser提供了定义一组选项，解析命令行参数以及存储实际使用的选项以及选项值的功能。 任何不是选项的参数（即不是以-开头）都存储为“位置参数”。 解析器处理短名称，长名称，相同选项的多个名称以及选项值。 命令行上的选项被识别为以单字符或双字符开头。选项-（仅单破折号）是一种特殊情况，通常表示标准输入，不被视为选项。解析器会将选项-之
Qt：QCommandLineParser类
OceanStar的博客
04-15 5385
QCommandLineParser类提供了一种处理命令行选项的方法 头文件： #include <QCommandLineParser> cmake: find_package(Qt6 COMPONENTS Core REQUIRED) target_link_libraries(mytarget PRIVATE Qt6::Core) qmake: QT += core 引入： Qt 5.2 详细说明 QCoreApplication以简单的字符串列表的形式提供命令行参数。QCom
QCommandLineParser
lak的专栏
06-27 1866
D:\Qt\Qt5.5.1\Examples\Qt-5.5\widgets\widgets\imageviewer\imageviewer.pro int main(int argc, char *argv[]) { QApplication app(argc, argv); QGuiApplication::setApplicationDisplayName(ImageVi
(Qt)使用QCommandLineParser进行程序的命令行解析
苏州-青蛙
05-10 2198
在开发过程中，由于需要，有时候要对程序中的命令行进行使用，比如最近的开发任务需要用外部exe启动我们的软件，启动的时候传入一些必要的命令行参数，使我们软件启动的时候根据这些参数进行一些必要的操作，这个时候就可以使用Qt自带的QCommandLineParser这个类。 Qt中是用QCommandLineOption和QCommandLineParser这两个类配合进行应用的解析。下面就直接贴出一个例子的简单使用，方便大家理解，其中涉及到一些东西也很多，长，短命令，以及多参，从最基础的用法入手，后面自己学习
Qt：QCommandLineOption类
OceanStar的博客
04-15 1326
QCommandLineOption类定义了可能的命令行选项 头文件： #include <QCommandLineOption> cmake： find_package(Qt6 COMPONENTS Core REQUIRED) target_link_libraries(mytarget PRIVATE Qt6::Core) qmake： QT += core 引入： Qt 5.2 详细说明 该类用于描述命令行上的选项。它允许用不同的方式定义同一个选项，并可能使用多个别名。它也用
QT学习QCommandLineParser与QCommandLineOption
zhaoyun_zzz的专栏
05-16 8571
文章目录QCommandLineParser类QCommandLineOption类 本来想用FFmpeg与QT实现一个简易的播放器，大约看了十几天的QT，发现QT的东西也不少，一时半会还写不出来，只好慢慢来了，一步一步的记录学习过程，直到把这个播放器写出为止。 为了写出播放器，首先就看了QT提供的播放器示例，废话不多说，那就开始记录吧，不然肯定要忘记。 QCommandLineParser类 Q...
3 QT中QCommandLineParser和QCommandLineOption解析命令行参数
jdtugfcg的博客
02-07 389
3 QT中QCommandLineParser和QCommandLineOption解析命令行参数
qcommandlineoption
09-06
通过调用QCommandLineParser的addOption函数，我们可以将QCommandLineOption对象添加到解析器中。例如，我们可以使用以下代码将上面创建的helpOption添加到解析器中： parser.addOption(helpOption); 在接下来的...
qt QCommandLineParser详解
ckg3824278的博客
12-11 1125
QCommandLineParser是Qt框架中提供的一个类，专门用于解析命令行参数。它简化了命令行参数的处理过程，使得开发者能够轻松定义、解析和验证命令行选项和参数。QCommandLineParser适用于需要从命令行获取输入的控制台应用程序，以及需要支持命令行选项的GUI应用程序。
Qt 命令行解析 QCommandLineParser QCommandLineOption
Beyond欣
08-22 3673
写程序时经常需要命令行解析，qt提供了 QCommandLineParser和QCommandLineOption两个类帮助快速解析命令行。 QApplication app(argc, argv); QCommandLineParser a;//建立命令行解析 a.addHelpOption();//增加-h/-help解析命令 a.addVersionOption(); //增加-v ...
QCommandLine
少言才不会咸's Tech-blog
05-14 637
转载： http://blog.csdn.net/aqtata/article/details/30485963Qt从5.2版开始提供了两个类QCommandLineOption和QCommandLineParser来解析应用的命令行参数。/*QCommandLineOption(const QString &name, const QString &description, const QStr
qt -- QCommandLineParser
ccr的博客
03-17 1013
QCommandLineParser类提供了一种处理命令行选项的方法。 QCoreApplication以简单字符串列表的形式提供命令行参数。QCommandLineParser提供了定义一组选项、解析命令行参数和存储实际使用的选项以及选项值的能力。 任何非选项的参数(即不以-开头)都被存储为“位置参数”。 命令行上的选项被识别为以单个或双字符开头。选项-(单破折号单独)是一种特殊情况，通常意味着标准输入，不被视为一个选项。解析器将把选项--(双破折号)之后的所有内容视为位置参数。 短选项是单...
qt QCommandLineOption 详解
最新发布
ckg3824278的博客
02-10 465
QCommandLineOption类是Qt框架中用于解析命令行参数的类。它提供了一种方便的方式来定义和解析命令行选项，并且可以与QCommandLineParser类一起使用，以便在应用程序中轻松处理命令行参数。通过QCommandLineOption类，开发者可以更便捷地处理Qt应用程序的命令行输入，提高程序的灵活性和用户体验。
C程序命令行解析以及Qt命令行解析之QCommandLineParser
haohaohaihuai的博客
05-14 992
Qt命令行解析之QCommandLineParser、QCommandLineOption简介C程序命令行介绍Qt命令行介绍QCommandLineParser类QCommandLineOption类使用例程 简介 我们日常使用的软件很多都支持命令行，即程序参数输入。很多时候因为我们在图形界面下忽略有这么个东西，对于开发一些arm端软件的时候，加入一些执行参数有时候很有作用。 C程序命令行介绍 对于纯c软件，也会有使用命令行输入的场景，下面我们来看一个例子： int main(int argc, char
使用C/C++的QCommandLineParser类
CoderHH的博客
09-05 204
使用QCommandLineParser，您可以定义命令行选项和参数，并在应用程序中检索它们的值。最后，您可以在应用程序中使用QCommandLineParser类的其他方法来处理命令行参数。选项"output"还具有一个参数"filename"，用于指定输出文件的名称。这是一个简单的示例，演示了如何使用QCommandLineParser类处理命令行参数。在解析命令行参数后，您可以使用isSet()方法检查选项是否已设置，以确定用户是否在命令行中提供了该选项。您还可以使用value()方法获取选项的值。
Node.js v12.16.2 的命令行选项（Command Line Options）允许用户定制运行时环境的行为
BLOG域名:programb.blog.csdn.net
04-16 1749
Node.js v12.16.2 的命令行选项（Command Line Options）允许用户定制运行时环境的行为。其中一项重要的选项是。这个选项设置默认为，这是从Node.js 12.x版本开始的标准。然而，这个选项的存在是为了向后兼容旧版的Node.js，允许用户强制使用更安全的TLS版本1.3，即使在那些不自动升级到最新标准的环境中。具体来说，如果你想要在启动Node.js时指定这个选项，你可以这样操作： 这会确保你的脚本在连接到支持TLS 1.3的服务器时能获得最佳安全性。Node.js 提供了
Qt使用命令行 QCommandLineOption QCommandLineParse
giantmfc123
02-26 877
写相关代码 QCommandLineParser parser; QCommandLineOption op1(&quot;a&quot;); QCommandLineOption op2(&quot;b&quot;); QCommandLineOption op3(&quot;c&quot;); QCommandLineOption verboseOption(&quot;verbose&quot
linux top——COMMAND-LINE Options
dyh200896的专栏
06-25 753
COMMAND-LINE Options The command-line syntax for top consists of: -hv|-bcHiOSs -d secs -n max -u|U user -p pid -o fld -w [cols] The typically mandatory switch ('-') and even whitespace are completely optional.
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值