C语言中的 getopt

平时在写程序时常常需要对命令行参数进行处理,当命令行参数个数较多时,如果按照顺序一个一个定义参数含义很容易造成混乱,而且如果程序只按顺序处理参数的话,一些“可选参数”的功能将很难实现。

我们可以用 getopt() 、 getopt_long() 、 getopt_long_only() 这几个函数来解决这个问题。

1. getopt()

int getopt(int argc,char * const argv[ ],const char * optstring);extern char *optarg;extern int optind, opterr, optopt;

所设置的全局变量包括:

l optarg :指向当前选项参数(如果有)的指针。

l optind :再次调用 getopt() 时的下一个 argv 指针的索引。

l optopt :最后一个未知选项。

参数 argc 和 argv 分别代表参数个数和内容,跟 main() 函数的命令行参数是一样的。参数 optstring 为选项字符串, 告知 getopt() 可以处理哪个选项以及哪个选项需要参数,如果选项字符串里的字母后接着冒号“:”,则表示还有相关的参数,全域变量optarg 即会指向此额外参数。如果在处理期间遇到了不符合optstring指定的其他选项 getopt() 将显示一个错误消息,并将全域变量 optarg 设为 “?” 字符,如果不希望 getopt() 打印出错信息,则只要将全域变量 opterr 设为 0 即可。

optstring中的指定的内容的意义(例如getopt(argc, argv, “ab:c:de::”);)

l 单个字符,表示选项,(如上例中的abcde各为一个选项)

l 单个字符后接一个冒号:表示该选项后必须跟一个参数。参数紧跟在选项后或者以空格隔开。该参数的指针赋给optarg。

l 单个字符后跟两个冒号,表示该选项后可以跟一个参数,也可以不跟。如果跟一个参数,参数必须紧跟在选项后不能以空格隔开。该参数的指针赋给optarg。

#include

#include

int main(int argc,char *argv[]){  int ch;  

opterr=0;    

while((ch=getopt(argc,argv,"a:b::cde"))!=-1)  

{    

printf("optind:%d\n",optind);    

printf("optarg:%s\n",optarg);    

printf("ch:%c\n",ch);    

switch(ch)    

{      

case 'a':        

printf("option a:'%s'\n",optarg);        

break;      

case 'b':        

printf("option b:'%s'\n",optarg);        

break;      

case 'c':        

printf("option c\n");        

break;      

case 'd':        

printf("option d\n");        

break;      

case 'e':        

printf("option e\n");        

break;      

default:        

printf("other option:%c\n",ch);    

}    

printf("optopt:%c\n",optopt);    

printf("--------");  }}

运行:

./getopt -a1234 -b432 -c -d

输出:

optind:2

optarg:1234

ch:a

option a:’1234’

optopt:

-——-

optind:3

optarg:432

ch:b

option b:’432’

optopt:

-——-

optind:4

optarg:(null)

ch:c

option c

optopt:

-——-

optind:5

optarg:(null)

ch:d

option d

optopt:

-——-

2. getopt_long()

getopt_long 支持长选项的命令行解析。

int getopt_long(int argc, char * const argv[],                

const char *optstring,                

const struct option *longopts,                

int *longindex);

函数中的argc和argv通常直接从main()的两个参数传递而来。optsting是选项参数组成的字符串,字符串 optstring 可以下列元素:

l 单个字符,表示选项,

l 单个字符后接一个冒号:表示该选项后必须跟一个参数。参数紧跟在选项后或者以空格隔开。该参数的指针赋给optarg。

l 单个字符后跟两个冒号,表示该选项后可以有参数也可以没有参数。如果有参数,参数必须紧跟在选项后不能以空格隔开。该参数的指针赋给optarg。(这个特性是GNU的扩张)。

optstring 是一个字符串,表示可以接受的参数。例如,”a:b:cd”,表示可以接受的参数是a,b,c,d,其中,a和b参数后面跟有更多的参数值。(例如:-a host -b name)

参数longopts,其实是一个结构的实例:

struct option {    

const char *name;   // name表示的是长参数名    

int has_arg;       // has_arg有3个值:                        

// no_argument(或者是0),表示该参数后面不跟参数值                        

// required_argument(或者是1),表示该参数后面一定要跟个参数值                        

// optional_argument(或者是2),表示该参数后面可以跟,也可以不跟参数值    

int *flag;          // 用来决定,getopt_long()的返回值到底是什么。                        

// 如果flag是null(通常情况),则函数会返回与该项option匹配的val值;                        

// 如果flag不是NULL,则将val值赋予flag所指向的内存,并且返回值设置为0。    

int val;            //和flag联合决定返回值

}

参数longindex,表示当前长参数在longopts中的索引值。

给个例子:

struct option long_options[] = {    

{"a123", required_argument, 0, 'a'},    

{"c123", no_argument, 0, 'c'},

}

现在,如果命令行的参数是-a 123,那么调用 getopt_long() 将返回字符’a’,并且将字符串 123 由 optarg 返回(注意注意!字符串 123 由 optarg 带回!optarg 不需要定义,在getopt.h 中已经有定义),那么,如果命令行参数是-c,那么调用 getopt_long() 将返回字符 ‘c’,而此时,optarg 是null。最后,当 getopt_long() 将命令行所有参数全部解析完成后,返回-1。

#include  

#include  

#include  

#include        

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

int opt;      

int digit_optind = 0;      

int option_index = 0;      

char *optstring = "a:b:c:d";      

static struct option long_options[] = {          

{"reqarg", required_argument, NULL, 'r'},          

{"noarg",  no_argument,       NULL, 'n'},          

{"optarg", optional_argument, NULL, 'o'},          

{0, 0, 0, 0}      

};            

while ( (opt = getopt_long(argc, argv, optstring, long_options, &option_index)) != -1)      {          

printf("opt = %c\n", opt);          

printf("optarg = %s\n", optarg);          

printf("optind = %d\n", optind);          

printf("argv[optind - 1] = %s\n",  

argv[optind - 1]);          

printf("option_index = %d\n", option_index);        printf("--------");    

}            

return 0;  

}

输入:

./getopt_long -a 100 --reqarg 100 --nonarg

输出:

opt = a

optarg = 100

optind = 3

argv[optind - 1] = 100

option_index = 0

-——-

opt = r

optarg = 100

optind = 5

argv[optind - 1] = 100

option_index = 0

-——-

./getopt_long: unrecognized option ‘–nonarg’

opt = ?

optarg = (null)

optind = 6

argv[optind - 1] = –nonarg

option_index = 0

-——-

当所给的参数存在问题时,opt(即函数返回值是’?’)。

输入:

./getopt_long --reqarg

输出:

opt = ?

optarg = (null)

optind = 2

argv[optind - 1] = –reqarg

option_index = 0

3. getopt_long_only()

getopt_long_only 函数,它与 getopt_long 函数使用相同的参数表,在功能上基本一致,只是 getopt_long 只将 –name 当作长参数,但 getopt_long_only 会将 –name 和 -name两 种选项都当作长参数来匹配。在 getopt_long 在遇到 -name 时,会拆解成 -n -a -m -e 到 optstring 中进行匹配,而 getopt_long_only 只在 -name 不能在 longopts 中匹配时才将其拆解成 -n -a -m -e 这样的参数到 optstring 中进行匹配。

the end

评论(0)