看webbench源码的时候碰到命令行解析工具getopt的使用,虽然之前也看过一点,但都不是很全面,只是了解个大概,下面稍微总结一下:
getopt和optind:
getopt被用来解析命令行选项参数。
#include <unistd.h>
extern char *optarg; //选项的参数指针
extern int optind, //下一次调用getopt的时,从optind存储的位置处重新开始检查选项。
extern int opterr, //当opterr=0时,getopt不向stderr输出错误信息。
extern int optopt; //当命令行选项字符不包括在optstring中或者选项缺少必要的参数时,该选项存储在optopt 中,getopt返回‘?’、
int getopt(int argc, char * const argv[], const char *optstring);
调用一次,返回一个选项。 在命令行选项参数再也检查不到optstring中包含的选项时,返回-1,同时optind储存第一个不包含选项的命令行参数。
首先说一下什么是选项,什么是参数。
1.单个字符,表示选项,
2.单个字符后接一个冒号:表示该选项后必须跟一个参数。参数紧跟在选项后或者以空格隔开。该参数的指针赋给optarg。
3 单个字符后跟两个冒号,表示该选项后必须跟一个参数。参数必须紧跟在选项后不能以空格隔开。该参数的指针赋给optarg。(这个特性是GNU的扩张)。
例如gcc -g -o test test.c ,其中g和o表示选项,test为选项o的参数。
上面是getopt()函数的基本含义,大家懂得了这些之后,我们一个例子加深一下理解。
例如我们这样调用getopt(argc, argv, "ab:c:de::");
从上面我们可以知道,选项a,d没有参数,选项b,c有一个参数,选项e有有一个参数且必须紧跟在选项后不能以空格隔开。getopt首先扫描argv[1]到argv[argc-1],并将选项及参数依次放到argv数组的最左边,非选项参数依次放到argv的最后边。
执行程序为:
0 1 2 3 4 5 6 7 8 9
$ ./test file1 -a -b -c code -d file2 -e file3
扫描过程中,optind是下一个选项的索引, 非选项参数将跳过,同时optind增1。optind初始值为1。当扫描argv[1]时,为非选项参数,跳过,optind=2;扫描到-a选项时, 下一个将要扫描的选项是-b,则optind更改为3;扫描到-b选项时,后面有参数(会认为-c为选项b的参数),optind=5,扫描到code非选项跳过optind=6;扫描到-d选项,后面没有参数,optind=7;扫描到file2非选项跳过optind=8;扫描到-e后面本来应该有参数,optind=9但是有空格所以e的参数为空。
扫描结束后,getopt会将argv数组修改成下面的形式 //其实要理解这个函数最重要的就是这个重排和非选项参数的理解。经过getopt函数的遍历,选项及其参数应该会被准确处理,之后还需要处理非选项参数,所以这个函数
0 1 2 3 4 5 6 7 8 9 //把非选项参数都放置到argv参数列表的最后面,然后把optind指向第一个非选项参数,便于后面的处理!!!
$ ./test -a -b -c -d -e file1 code file2 file3
同时,optind会指向非选项的第一个参数,如上面,optind将指向file1
代码如下:
1 #include <unistd.h> 2 #include <stdio.h> 3 int main(int argc, char * argv[]) 4 { 5 int aflag=0, bflag=0, cflag=0; 6 int ch; 7 printf("optind:%d,opterr:%d\n",optind,opterr); 8 printf("--------------------------\n"); 9 while ((ch = getopt(argc, argv, "ab:c:de::")) != -1) 10 { 11 printf("optind: %d,argc:%d,argv[%d]:%s\n", optind,argc,optind,argv[optind]); 12 switch (ch) { 13 case ‘a‘: 14 printf("HAVE option: -a\n\n"); 15 16 break; 17 case ‘b‘: 18 printf("HAVE option: -b\n"); 19 20 printf("The argument of -b is %s\n\n", optarg); 21 break; 22 case ‘c‘: 23 printf("HAVE option: -c\n"); 24 printf("The argument of -c is %s\n\n", optarg); 25 26 break; 27 case ‘d‘: 28 printf("HAVE option: -d\n"); 29 break; 30 case ‘e‘: 31 printf("HAVE option: -e\n"); 32 printf("The argument of -e is %s\n\n", optarg); 33 break; 34 35 case ‘?‘: 36 printf("Unknown option: %c\n",(char)optopt); 37 break; 38 } 39 } 40 printf("----------------------------\n"); 41 printf("optind=%d,argv[%d]=%s\n",optind,optind,argv[optind]); 42 }
执行结果:
[email protected]:~/code$ vim getopt.c
[email protected]:~/code$ gcc getopt.c -o g
[email protected]:~/code$ ./g file1 -a -b -c code -d file2 -e file3
optind:1,opterr:1
--------------------------
optind: 3,argc:10,argv[3]:-b
HAVE option: -a
optind: 5,argc:10,argv[5]:code
HAVE option: -b
The argument of -b is -c
optind: 7,argc:10,argv[7]:file2
HAVE option: -d
optind: 9,argc:10,argv[9]:file3
HAVE option: -e
The argument of -e is (null)
----------------------------
optind=6,argv[6]=file1 //while循环执行完后,optind=6
getopt_long:
getopt_long支持长选项的命令行解析, 所为长选项就是诸如--help
的形式, 使用该函数, 需要引入<getopt.h>
下面是函数原型:
#include <getopt.h> int getopt_long(int argc, char * const argv[], const char *optstring, const struct option *longopts, int *longindex); int getopt_long_only(int argc, char * const argv[], const char *optstring, const struct option *longopts, int *longindex);
其中 argc , argv , optstring 和getopt中的含义一样, 下面解释一下longopts 和longindex
longopts
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指向的变量中的值
下面是longopts的一个示例
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码值.
longindex
longindex表示长选项在longopts中的位置, 例如在上面的示例中, version 对应的 longindex 为0, name 对应的 longindex 为1, help对应的 longindex 为2, 该项主要用于调试, 一般设为 NULL 即可.
下面是一个使用示例:
void use_getpot_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("username is %s\n", optarg); break; case ‘v‘: printf("version is 0.0.1\n"); break; case ‘h‘: printf("this is help\n"); break; case ‘?‘: printf("unknown option\n"); break; case 0 : printf("the return val is 0\n"); break; default: printf("------\n"); } } }
然后我们运行程序 ./test --name zhangjikai --version --help --haha
, 下面是运行结果:
username is zhangjikai version is 0.0.1 this is help ./test: unrecognized option ‘--haha‘ unknown option
当然我们也可以使用短选项 ./test -n zhangjikai -v -h
下面我们对程序做一下修改, 这一次将 struct option 中的 flag 和 longindex 设为具体的值
void use_getpot_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("username is %s\n", optarg); break; case ‘v‘: printf("version is 0.0.1\n"); break; case ‘h‘: printf("this is help\n"); break; case ‘?‘: printf("unknown option\n"); break; case 0 : printf("f_v is %d \n", f_v); printf("f_n is %d \n", f_n); printf("f_h is %d \n", f_h); break; default: printf("------\n"); } printf("opt_index is %d\n\n", opt_index); } }
运行程序: ./test --name zhangjikai --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, 因此会去执行case 0, 并且 val 的值赋给了 flag 指向的变量. 下面我们用短选项执行一下程序 ./test -n zhangjikai -v -h
, 下面是运行结果
username is zhangjikai opt_index is -1 version is 0.0.1 opt_index is -1 this is help opt_index is -1
我们看到使用短选项的时候 getopt_long 就相当于 getopt , flag 和 longindex都不起作用了.
getopt_long 和 getopt_long_only
下面解释一下 getopt_long 和 getopt_long_only的区别, 首先用下列选项运行一下 use_getopt_long ./test -name zhangjkai -version -help
, 下面是输出结果:
username is ame version 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 username is -help
我们看到使用短选项标识符 -
指向长选项时, 程序还是会按短选项来处理, 即一个字符一个字符的解析. 下面我们将 use_getopt_long 做一下更改, 即将 getopt_long
改为 getopt_long_only
, 如下所示:
void use_getpot_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("username is %s\n", optarg); break; case ‘v‘: printf("version is 0.0.1\n"); break; case ‘h‘: printf("this is help\n"); break; case ‘?‘: printf("unknown option\n"); break; case 0 : printf("the return val is 0\n"); break; default: printf("------\n"); } } }
username is zhangjikai下面再运行程序 ./test -name zhangjikai -version -help
, 下面是运行结果:
version is 0.0.1 this is help
即使用 getopt_long_only 时, -
和 --
都可以作用于长选项, 而使用 getopt_only 时, 只有 --
可以作用于长选项.
转载自:http://blog.sina.com.cn/s/blog_64ba2b750100vz5b.html
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/
原文地址:https://www.cnblogs.com/J1ac/p/9063148.html