[轉載][總結]函數getopt()，getopt_long及其參數optind
看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的最後邊。
$ ./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 }
執行結果：
shiqi@wjl-desktop:~/code$ vim getopt.c
shiqi@wjl-desktop:~/code$ gcc getopt.c -o g
shiqi@wjl-desktop:~/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/
[轉載][總結]函數getopt()，getopt_long及其參數optind