C命令行参数解析——getoptgetopt_long及getopt_long_only

Posted 2020-12-03 evenleee

前言

在linux下学习开源代码Webbench，遇到get_long等函数的用法，一时有点懵，故想深入了解这类命令行解析函数，并记此博文。

1、getopt

getopt主要用来处理短命令行选项，例如 ./test -v 中的 -v 就是一个短选项。使用该函数需引入头文件<unistd.h>，下面是该函数定义：

int getopt (int ___argc, char *const *___argv, const char *__shortopts);

其中___argc和___argv是main函数中传递的参数个数和内容，__shortopts用来指定可以处理哪些选项，以下为__shortopts的示例：

"a:bc"

该示例表明该程序可以接受3个选项：-a  -b  -c ，其中a后面的 ：表示该选项后面跟一个参数，即如 -a text 的形式，选项后面跟的参数会被保存到optarg变量中。下面是一个使用的示例：

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

void use_getopt(int argc,char **argv){

  int ch;
  while((ch = getopt(argc,argv,"a:b")) != -1){
    switch(ch){
    case ‘a‘:
      printf("option a: %s
",optarg);
      break;
    case ‘b‘:
      printf("option b: 
");
      break;
    case ‘?‘:
      printf("unknown option 
");
      break;
    default:
      printf("default");
    }
  }
}

int main(int argc,char **argv){

  use_getopt(argc,argv);
  return 0;
}

执行 ./test -a aa -b -c 输出结果如下：

option a: aa
option b: 
./test: invalid option -- ‘c‘
unknown option 

2、getopt_long

getopt_long支持长选项的命令行解析，所谓长选项即诸如 --help 的形式，使用该函数需要引入头文件<getopt.h>，下面是getopt_long和getopt_long_only的函数原型：

#include <getopt.h>

int getopt_long (int ___argc,
                 char *const *___argv,
                 const char *__shortopts,
                 const struct option *__longopts,
                 int *__longind);

int getopt_long_only (int ___argc,
                      char *const *___argv,
                      const char *__shortopts,
                      const struct option *__longopts,
                      int *__longind);

其中___argc，___argv， __shortopts 和 getopt 中的含义一样，下面解释 __longopts 和 __longind.

 __longopts指向一个 struct option 的数组，下面是option的定义：

struct option
{
  const char *name;
  int has_arg;
  int *flag;
  int val;
};

• name — 长选项的名称，例如 help
• has_arg — 是否带参数，0不带参数，1必须带参数，2参数可选
• flag — 指定长选项如何返回结果，如果flag为NULL， getopt_long()会返回val. 如果flag不为NULL，getopt_long会返回0，并且将val的值存储到flag中
• val — 将要被getopt_long返回或者存储到flag指向的变量中的值

下面是一个使用示例：

 struct option opts[] = {
    {"version", 0, NULL, ‘v‘},
    {"name", 1, NULL, ‘n‘},
    {"help", 0, NULL, ‘h‘}
  };

以上{"version", 0, NULL, ‘v‘}， version 即为长选项的名称, 即按如下形式 --version,，0 表示该选项后面不带参数，NULL 表示直接将v返回(字符v在ascii码中对应的数值)， 即在使用getopt_long遍历到该条选项时，getopt_long 返回值为字符v对应的ascii码值。

__longind表示长选项在__longopts中的位置，例如上面的例子中，version对应的__longind为0，name对应的__longind为1，help对应的__longind为2，该项主要用于调试，一般设为NULL即可。

下面是一个使用示例：

void use_getopt_long(int argc,char **argv){

  const char *optstring = "vn:h";
  int c;
  struct option opts[] = {
    {"version", 0, NULL, ‘v‘},
    {"name", 1, NULL, ‘n‘},
    {"help", 0, NULL, ‘h‘}
  };

  while((c = getopt_long(argc,argv,optstring,opts,NULL)) != -1){
    switch(c){
    case ‘n‘:
      printf("name is %s
",optarg);
      break;
    case ‘v‘:
      printf("verson is 0.0.1
");
      break;
    case ‘h‘:
      printf("this is help
");
      break;
    case ‘?‘:
      printf("unknown option
");
      break;
    case 0:
      printf("the return val is 0
");
      break;
    default:
      printf("default");
    }
  }
}

运行程序 ./test --name evenleo --version --help --haha ，结果如下：

name is evenleo
verson is 0.0.1
this is help
./test: unrecognized option ‘--haha‘
unknown option

当然也可以使用短选项 ./test -n evenleo -v -h，结果如下：

name is evenleo
verson is 0.0.1
this is help

将上面的程序进行修改，将struct option中的flag和__longind设为具体值

void use_getopt_long2(int argc, char *argv[]) {

  const char *optstring = "vn:h";
  int c;
  int f_v = -1, f_n = -1, f_h = -1, opt_index = -1;
  struct option opts[] = {
    {"version", 0, &f_v, ‘v‘},
    {"name", 1, &f_n, ‘n‘},
    {"help", 0, &f_h, ‘h‘}
  };

  while((c = getopt_long(argc, argv, optstring, opts, &opt_index)) != -1) {
    switch(c) {
    case ‘n‘:
      printf("name is %s
", optarg);
      break;
    case ‘v‘:
      printf("version is 0.0.1
");
      break;
    case ‘h‘:
      printf("this is help
");
      break;
    case ‘?‘:
      printf("unknown option
");
      break;
    case 0 :
      printf("f_v is %d 
", f_v);
      printf("f_n is %d 
", f_n);
      printf("f_h is %d 
", f_h);
      break;
    default:
      printf("------
");
    }
    printf("opt_index is %d

", opt_index);
  }
}

运行 ./test -name evenleo -version -help，结果如下：

f_v is -1 
f_n is 110 
f_h is -1 
opt_index is 1

f_v is 118 
f_n is 110 
f_h is -1 
opt_index is 0

f_v is 118 
f_n is 110 
f_h is 104 
opt_index is 2

以上结果可以看出，当给flag指定具体的指针后，getopt_long会返回0，并且val的值赋给了flag指向的变量，下面我们用短选项执行一下程序，运行 ./test -n evenleo -v -h ，结果如下：

name is evenleo
opt_index is -1

version is 0.0.1
opt_index is -1

this is help
opt_index is -1

可以看出使用短选项时getopt_long相当于getopt，flag和__longind不起作用。

3、getopt_long和getopt_long_only区别

下面解释一下 getopt_long 和 getopt_long_only的区别，用use_getopt_long函数 ，运行 ./test -name evenleo -verson -help，结果如下:

name is ame
verson is 0.0.1
./test: invalid option -- ‘e‘
unknown option
./test: invalid option -- ‘r‘
unknown option
./test: invalid option -- ‘s‘
unknown option
./test: invalid option -- ‘i‘
unknown option
./test: invalid option -- ‘o‘
unknown option
name is -help

可以看出使用短选项标识符 - 指向长选项时，程序还是会按短选项来处理，即一个字符一个字符的解析。下面将函数use_getopt_long做一些更改，即将getopt_long改为getopt_long_only，如下：

void use_getopt_long3(int argc,char **argv){

  const char *optstring = "vn:h";
  int c;
  struct option opts[] = {
    {"version", 0, NULL, ‘v‘},
    {"name", 1, NULL, ‘n‘},
    {"help", 0, NULL, ‘h‘}
  };

  while((c = getopt_long_only(argc,argv,optstring,opts,NULL)) != -1){
    switch(c){
    case ‘n‘:
      printf("name is %s
",optarg);
      break;
    case ‘v‘:
      printf("verson is 0.0.1
");
      break;
    case ‘h‘:
      printf("this is help
");
      break;
    case ‘?‘:
      printf("unknown option
");
      break;
    case 0:
      printf("the return val is 0
");
      break;
    default:
      printf("default");
    }
  }
}

再运行 ./test -name evenleo -version -help，结果如下：

name is evenleo
verson is 0.0.1
this is help

即使用 getopt_long_only 时， - 和 -- 都可以作用于长选项, 而使用 getopt_long 时，只有 -- 可以作用于长选项.

 

文章大部分内容参考http://blog.zhangjikai.com/2016/03/05/%E3%80%90C%E3%80%91%E8%A7%A3%E6%9E%90%E5%91%BD%E4%BB%A4%E8%A1%8C%E5%8F%82%E6%95%B0--getopt%E5%92%8Cgetopt_long/