【Linux函数】命令行参数解析函数

已于 2024-08-30 17:09:01 修改
阅读量287 收藏 3
点赞数 5
分类专栏： 嵌入式Linux 文章标签： c语言 linux
于 2024-08-30 17:03:39 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_46004287/article/details/141722581
版权

文章目录

前言

每个开源代码的main函数中都有一个命令行参数解析函数，今天特意参考各种博客资料总结一下。

版本迭代

时间版本版本更新
2024.8.26V1.0初始版本

参考文档

1.https://blog.csdn.net/qq_41816308/article/details/132899633

2.https://blog.csdn.net/Tschome/article/details/129132082

命令行参数

命令行参数可以分为两类，一类是短选项，一类是长选项，短选项在参数前加一杠"-“，长选项在参数前连续加两杠”–"。-a，-A,-b都表示短选项，–all,–almost-all, --author都表示长选项。

getopt()

声明

#include <unistd.h>
int getopt(int argc, char *const argv[], const char *optstring);

描述

用于解析命令行选项。它通过遍历argv数组中的参数，识别选项字符短选项（例如 -a, -b 等），并根据 optstring指定的选项格式返回结果。每次调用getopt返回一个选项字符，直到没有更多选项。

参数

  • argc: 命令行参数的数量。
  • argv: 命令行参数数组。
  • optstring: 指定合法选项的字符串，选项后面可以跟一个冒号（:）表示该选项需要一个参数。

返回值

  • 返回选项字符（例如-a对应a）。
  • 如果没有更多选项，返回-1。
  • 如果遇到无效选项或缺少参数，返回 ? 或 : 。

实例

#include <stdio.h>
#include <unistd.h>

int main(int argc, char *argv[]) 
{
    int opt;
    
    while ((opt = getopt(argc, argv, "ab:c")) != -1) 
	{
        switch (opt)
		{
            case 'a':
                printf("Option a\n");
                break;
            case 'b':
                printf("Option b with value %s\n", optarg);
                break;
            case 'c':
                printf("Option c\n");
                break;
            case '?':
                printf("Unknown option\n");
                break;
        }
    }
    
    return 0;
}

结果

假设命令行输入为：

./program -a -b value -c

输出结果将是：

Option a
Option b with value value
Option c

在此示例中，-a 和 -c不需要参数，-b需要一个参数（value），optarg 用于获取 -b 后面的参数值。如果-a或者-c带了参数也不会从optarg中获取到，他会显示NULL。

case 'a':
//printf("Option a\n");
printf("Option a with value %s\n", optarg);
break;

//结果
Option a with value (null)
Option b with value 20
Option c

getopt_long()

声明

#include <getopt.h>
int getopt_long(int argc, char *const argv[], const char *shortopts, const struct option *longopts, int *longindex);

描述

getopt_long() 是一个扩展的getopt()函数，支持长选项（如 --option）以及短选项（如-o）。

参数

  • argc: 命令行参数的数量。
  • argv: 命令行参数数组。
  • shortopts: 一个字符串，定义所有短选项及其参数要求。
  • longopts: 一个struct option数组，定义所有长选项及其参数要求。数组最后一个元素必须是全零的结构体。（长选项结构体）
  • longindex: 可选参数，用于存储匹配的长选项的索引。如果不需要，可以设置为NULL。
struct option
{
     const char *name;
     int         has_arg;
     int        *flag;
     int         val;
};
eg:
 static struct option longOpts[] = {
      { "daemon", no_argument, NULL, 'D' },
      { "dir", required_argument, NULL, 'd' },
      { "out", required_argument, NULL, 'o' },
      { "log", required_argument, NULL, 'l' },
      { "split", required_argument, NULL, 's' },
      { "http-proxy", required_argument, &lopt, 1 },
      { "http-user", required_argument, &lopt, 2 },
      { "http-passwd", required_argument, &lopt, 3 },
      { "http-proxy-user", required_argument, &lopt, 4 },
      { "http-proxy-passwd", required_argument, &lopt, 5 },
      { "http-auth-scheme", required_argument, &lopt, 6 },
      { "version", no_argument, NULL, 'v' },
      { "help", no_argument, NULL, 'h' },
      { 0, 0, 0, 0 }
    };

/*
	name:表示选项的名称,比如daemon,dir,out等。
	has_arg:表示选项后面是否携带参数。该参数有三个不同值，如下：
		no_argument(或者是0)时 ——参数后面不跟参数值，eg: --version,--help
		required_argument(或者是1)时 ——参数输入格式为：–参数 值 或者 --参数=值。eg:--dir=home 或者 --dir home
		optional_argument(或者是2)时 ——参数输入格式只能为：-–参数=值
	flag:空或者非空。
		如果参数为空NULL，那么当选中某个长选项的时候，getopt_long将返回val值。
		如果参数不为空，那么当选中某个长选项的时候，getopt_long将返回0，并且将flag指针参数指向val值。
	val：表示指定函数找到该选项时的返回值，或者当flag非空时指定flag指向的数据的值val。
*/

全局变量

  • optarg：表示当前选项对应的参数值。

  • optind：表示的是下一个将被处理到的参数在argv中的下标值。

  • opterr：如果opterr = 0，在getopt、getopt_long、getopt_long_only遇到错误将不会输出错误信息到标准输出流。opterr在非0时，向屏幕输出错误。

  • optopt：表示没有被未标识的选项。

返回值

  • 返回选项字符（对于短选项）或longopts中定义的长选项的val字段。
  • 如果遇到未知选项或选项格式不正确，则返回?。
  • 当所有选项被处理完或达到命令行参数数组的末尾时，返回-1。

实例1

#include <stdio.h>
#include <stdlib.h>
#include <getopt.h>

int main(int argc, char *argv[]) {
    int opt;
    int option_index = 0;

    static struct option long_options[] = {
        {"add",    no_argument,       0, 'a'},
        {"append", no_argument,       0, 'b'},
        {"delete", required_argument, 0, 'd'},
        {"create", required_argument, 0, 'c'},
        {"verbose", no_argument,      0, 'v'},
        {"version", no_argument,      0, 'V'},
        {0, 0, 0, 0}
    };

    while ((opt = getopt_long(argc, argv, "ab:d:c:uvV", long_options, &option_index)) != -1) {
        switch (opt) {
            case 'a':
                printf("Option a\n");
                break;
            case 'b':
                printf("Option b\n");
                break;
            case 'c':
                printf("Option c with argument '%s'\n", optarg);
                break;
            case 'd':
                printf("Option d with argument '%s'\n", optarg);
                break;
            case 'v':
                printf("Option v\n");
                break;
            case 'V':
                printf("Option V\n");
                break;
            case '?':
                break;
            default:
                abort();
        }
    }

    return 0;
}

结果1

运行上面的代码，例如：

./test --add --create file.txt -d 123 --delete 567

会输出：

Option a
Option c with argument 'file.txt'
Option d with argument '123'
Option d with argument '567'

在实例中，–delete和-d是等价的。遇到短选项他会直接到switch中找相应的case，如果是长选项他会先去long_options结构体数组中找对应的第四个参数，如果在去switch中找相应的case。

实例2

本案例主要是讲解longOpts中第三个参数lopt这个参数的作用和option_index的用法。

longOpts中的第三个参数如果是NULL，则第四个参数要使用单个字符；如果给了一个int型的地址，第四个参数要用数字。

#include <stdio.h>
#include <stdlib.h>
#include <getopt.h>

int lopt; // 用于接收选项标志的变量

int main(int argc, char *argv[]) {
    int option_index = 0;
    int c;

    // 定义长选项
    static struct option longOpts[] = {
        { "daemon", no_argument, NULL, 'D' },
        { "dir", required_argument, NULL, 'd' },
        { "out", required_argument, NULL, 'o' },
        { "log", required_argument, NULL, 'l' },
        { "split", required_argument, NULL, 's' },
        { "http-proxy", required_argument, &lopt, 1 },
        { "http-user", required_argument, &lopt, 2 },
        { "http-passwd", required_argument, &lopt, 3 },
        { "http-proxy-user", required_argument, &lopt, 4 },
        { "http-proxy-passwd", required_argument, &lopt, 5 },
        { "http-auth-scheme", required_argument, &lopt, 6 },
        { "version", no_argument, NULL, 'v' },
        { "help", no_argument, NULL, 'h' },
        { 0, 0, 0, 0 }
    };

    // 解析命令行选项
    while ((c = getopt_long(argc, argv, "D:d:o:l:s:vh", longOpts, &option_index)) != -1) {
        printf("Option Index: %d\n", option_index);
        switch (c) {
            case 'D':
                printf("Daemon mode enabled\n");
                break;
            case 'd':
                printf("Directory: %s\n", optarg);
                break;
            case 'o':
                printf("Output file: %s\n", optarg);
                break;
            case 'l':
                printf("Log file: %s\n", optarg);
                break;
            case 's':
                printf("Split size: %s\n", optarg);
                break;
            case 'v':
                printf("Version 1.0\n");
                break;
            case 'h':
                printf("Help: Usage: [options]\n");
                break;
            case 1: // http-proxy
                printf("HTTP Proxy: %s\n", optarg);
                break;
            case 2: // http-user
                printf("HTTP User: %s\n", optarg);
                break;
            case 3: // http-passwd
                printf("HTTP Password: %s\n", optarg);
                break;
            case 4: // http-proxy-user
                printf("HTTP Proxy User: %s\n", optarg);
                break;
            case 5: // http-proxy-passwd
                printf("HTTP Proxy Password: %s\n", optarg);
                break;
            case 6: // http-auth-scheme
                printf("HTTP Auth Scheme: %s\n", optarg);
                break;
            case '?':
                // 错误处理，未知选项
                fprintf(stderr, "Unknown option or missing argument\n");
                break;
            default:
                fprintf(stderr, "Unexpected option\n");
                break;
        }
    }

    return 0;
}

结果2

 ./myprogram --daemon --dir /tmp --out output.txt --log error.log --http-proxy http://proxy.example.com --http-user user --http-passwd passwd --version


Option Index: 0
Daemon mode enabled
Option Index: 1
Directory: /tmp
Option Index: 2
Output file: output.txt
Option Index: 3
Log file: error.log
Option Index: 5
Unexpected option
Option Index: 6
Unexpected option
Option Index: 7
Unexpected option
Option Index: 11
Version 1.0

getopt_long_only()

声明

#include <getopt.h>
int getopt_long_only(int argc, char *const argv[], const char *shortopts,
                     const struct option *longopts, int *longindex);

描述

getopt_long_only()函数用于解析命令行选项，支持长选项的解析，并且不处理短选项。

参数

  • argc: 命令行参数的个数，即传递给main函数的argc。
  • argv: 命令行参数数组，即传递给main函数的argv。
  • shortopts: 一个字符串，定义了短选项。如果不处理短选项，此参数可以是NULL。
  • longopts: 一个struct option类型的数组，用于定义长选项。数组的最后一个元素必须是{0, 0, 0, 0}。
  • longindex: 指向整数的指针，用于存储长选项的索引。如果不需要，可以将其设置为NULL。

返回值

  • ?: 遇到未知的选项。
  • :: 短选项缺少必要的参数。
  • 0: 成功解析了一个长选项，并返回与该长选项对应的字符值。
  • -1: 解析完成或出错。

实例

#include <getopt.h>
#include <stdio.h>

int main(int argc, char *argv[]) {
    int opt;
    int option_index = 0;

    static struct option long_options[] = {
        {"add",    no_argument,       0, 0},
        {"create", required_argument, 0, 0},
        {"verbose", no_argument,      0, 0},
        {"version", no_argument,      0, 0},
        {0, 0, 0, 0}
    };

    while ((opt = getopt_long_only(argc, argv, "", long_options, &option_index)) != -1) 
	{
        switch (opt) 
		{
            case 0:
                printf("Long option %s\n", long_options[option_index].name);
                if (long_options[option_index].has_arg == required_argument) 
				{
                    printf("With argument: %s\n", optarg);
                }
                break;
            default:
                fprintf(stderr, "Usage: %s [--add] [--create arg] [--verbose] [--version]\n", argv[0]);
                return 1;
        }
    }

    return 0;
}

结果

运行上述程序时，如果传递以下命令行参数：

./program --add --create example --verbose --version

输出将是：

Long option add
Long option create
With argument: example
Long option verbose
Long option version

总结

getopt():只支持短选项。

getopt_long()：支持短选项和长选项。

getopt_long_only()：只支持长选项。

如果有错误请帮忙指出，谢谢！

April.19th
关注
  • 5
    点赞
  • 踩
  • 3
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
专栏目录
命令行参数解析模块库——Argparse库
qq_41734243的博客
11-13 3233
壹 简介 有时候我们需要像Linux、Windows的shell一样使用命令行操作，而不是使用编译器编译python，这时候我们就可以使用脚本传递命令参数功能。在python中，解析命令行参数的方法有很多种，比如argv、getopt、optparse、argparse等。 optparse库使用一种更具声明性的命令行解析方式：创建OptionParser的实例，用选项填充它，然后解析命令行。optparse允许用户以常规GNU/POSIX语法指定选项，并为您生成用法和帮助消息，但已被Python3.2、
linux 命令行参数解析,Linux C下的命令行参数解析
weixin_39807691的博客
04-29 344
C库中提供了相应的函数接口供用户解析命令行选项，我们常使用的有getopt_long_only和getopt_long，在使用的方法上相差不大。命令行选项中一般可以选择传递长选项和短选项长选项的用法为： ./a.out --username bryant --help短选项的用法为： ./a.out -n bryant -h -v1. 函数接口函数使用的头文件为 #include2. 参数介绍? ...
Linux C 命令行参数解析
绅士喵的博客
02-28 2228
为了提高程序的灵活性，我们常常需要在启动程序时指定参数。比如，我们man ls看一下ls的官方介绍文档：这里的-a 我们称之为短参数，–all 称之为长参数。当然，这些参数后面也可以指定值，如man split： 短参数与后面的值可以加空格，也可以不加空格。如-a 1 和 -a1是相同的。 长参数与后面的值可以加空格，也可以用=号连接。如–byte 3 和–byte=3是相同的。 如果我们想实现...
Linux中c程序命令行参数解析
j5856004的博客
07-28 1010
在Linux中，较为复杂的C程序命令行参数的解析通常使用getopt, getopt_long以及getopt_long_only来进行，如下所示。 #include <unistd.h> int getopt(int argc, char *const argv[], const char *optstring); extern char *optarg; extern int optind, opterr, optopt; #include <getopt.
【Linux】命令行参数
心之王者的博客
12-02 1447
本文简要介绍了Linux的命令及其后面所跟参数的原理
Linux 命令行参数解析函数
u010231083的博客
01-23 447
在linux中，经常需要各种命令，通常情况下都会带各种参数，而这些参数是如何解析的呢？ 通常使用GNU C提供的函数getopt、getopt_long、getopt_long_only函数来解析命令行参数。 使用他们需要引用头文件getopt.h。 原文地址:https://www.cnblogs.com/NickQ/p/11368656.html 1. getopt()函数 getopt()用来解析命令行选项参数的，但是只能解析短选项: -d 100,不能解析长选项：--prefix;其原型：
20120906_命令行参数解析1
08-04
在IT领域，尤其是软件开发中，命令行参数解析是一个至关重要的功能，特别是在编写控制台应用或脚本时。`getopt`函数是Linux系统中用于解析命令行参数的一个标准工具，它允许开发者处理带有选项和参数的命令行输入。...
linux-optparseBASH的简单命令行参数解析器
08-13
在Linux系统中，脚本开发是一项常见的任务，而命令行参数解析是许多脚本的核心功能。`optparse`是一个用于Bash shell脚本的简单命令行选项解析器，它可以帮助开发者更加规范和方便地处理命令行参数。在这个场景中，...
getopt多参数解析函数具体分析命令行参数解析
08-20
`getopt()`函数是C语言中用于解析命令行参数的标准函数，主要应用于Unix/Linux系统，也可以在其他支持C语言的环境中使用。它简化了对带有选项和参数的命令行输入的处理，使得程序能够优雅地解析和理解用户提供的...
LeetCode //C - 329. Longest Increasing Path in a Matrix
Made in Code
08-24 866
【代码】LeetCode //C - 329. Longest Increasing Path in a Matrix。
LeetCode //C - 336. Palindrome Pairs
Made in Code
08-29 818
【代码】LeetCode //C - 336. Palindrome Pairs。
Linux基础知识（一、什么是Linux）
心寒的博客
08-26 1331
什么是Linux Linux创始人
Linux中的常见命令——用户管理命令
qq_45569925的博客
08-27 746
默认创建用户的时候会在home文件夹下创建一个与用户同名的文件夹【该用户的主目录】，也可以在创建用户的时候设置该用户主目录的名称。【输入的密码是不在控制台显示的，输入完之后直接按回车键即可】使用wgh用户查看root下的文件。【此时的用户是没有密码的】给创建的用户设置密码。查看某个用户是否存在。
虚拟内存和linux（操作系统八股文part1）
linjixia的博客
08-24 1354
八股之虚拟内存和Linux部分的笔记。
Linux自旋锁和读写锁
m0_74830524的博客
08-24 1016
在前面的文章中我们已经介绍了有关互斥锁的概念与使用，本篇将开始介绍在 Linux 中的自旋锁和读写锁。这三种锁分别用于在不同的应用场景之中，其中互斥锁最为常用，但是我们需要了解一下其他的锁。 对于自旋锁和读写锁都介绍了其原理以及接口使用，并且给出了样例代码。
linux 系统性能调优技巧
m0_50641264的博客
08-27 589
【代码】linux 系统性能调优技巧。
RockPI 4A单板Linux 4.4内核下的RK3399 GPIO功能解析
m0_67544708的博客
08-26 1065
在GPIO方面，RK3399提供了多达16个GPIO控制器，每个控制器可配置的GPIO引脚数量不等。通过详细的代码解析和示例，帮助读者理解如何在Linux内核中使用GPIO，以及如何通过GPIO实现单板的基本控制和功能扩展。为了更好地理解如何在Linux内核中使用RK3399的GPIO功能，下面是一个简单的示例代码，展示了如何通过GPIO控制LED灯的亮灭。函数，用于设置GPIO引脚的方向。在设置GPIO引脚方向为输出模式后，可以设置GPIO引脚的值。在获取GPIO引脚后，可以设置GPIO引脚的方向。
Linux报错：make[2]: *** No rule to make target ‘/usr/local/lib/libopus.a‘
VIFIN的博客
08-27 424
解决报错：make[2]: *** No rule to make target '/usr/local/lib/libopus.a'
Linux——进程管理
最新发布
m0_67677309的博客
08-29 711
1、通过fork创建的子进程会拷贝父进程(数据段、bss段、堆、栈、I/O缓冲区)，与父进程共享代码段、子进程会继承父进程的信号处理方式。ITIMER_VIRTUAL 虚拟计时器 用户态的计时SIGVTALRM(26)**使用的时候要对应。ITIMER_REAL 真实计时器 程序总的计时时间SIGALRM(14)void (*sa_restorer)(void);// 第一次产生时钟信号的时间 **3秒钟一次，每个两秒。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

April.19th

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值