原著
20 世纪 90 年代,UNIX 应用程序开始支持长选项,即一对短横线、一个描述性选项名称,还可以包含一个使用等号连接到选项的参数。
[命令行参数解析函数:getopt()]
getopt()函数声明如下:
#include <getopt.h>
int getopt(int argc, char * const argv[], const char *optstring);
返回值:
成功时返回选项字符;
如果所有的选项都被处理完毕,则返回-1;
如果遇到未定义的选项字符,返回'?';
如果某个需要参数的选项字符没有带参数,则返回(*optstring == ':')?':':'?'
optstring为选项字母组成的字串,譬如":x:y:mn"。如果该字串里的某一字符后面有冒号,那么就表示这个选项要求有选项参数。
第一次调用getopt(...)时,其将返回第一个选项,同时设置getopt相关的全局变量。使用相同的参数再次调用该函数时,它将返回下一个选项,并设置相关全局变量。当遇到不可识别的选项,将返回 -1表示出错。
getopt() 所设置的全局变量包括:
char *optarg——指向当前选项参数字串(如果有)。
int optind——argv的当前索引值。当getopt()在while循环中使用时,循环结束后,剩下的字串视为操作数,在argv[optind]至argv[argc-1]中可以找到。
int opterr——被置为非零时,若getopt()函数出错则输出出错信息。
int optopt——当发现无效选项字符时,getopt()函数返回'?'字符或':'字符,optopt中为所发现的无效选项字符。
[getopt()的自定义错误提示]
可以采用以下两种方法来改变getopt()函数的出错输出方式:
1. 在调用getopt()之前,将opterr设置为0,强制getopt()函数在发现错误时不输出任何消息。
2. 如果optstring参数的第一个字符是冒号,那么getopt()函数就会保持沉默,并根据错误情况返回不同字符,如下:
“无效选项” —— getopt()返回'?',并且optopt包含了无效选项字符(这是正常的行为);
“缺少选项参数” —— getopt()返回':'。(如果optstring的第一个字符不是冒号,那么getopt()返回'?',这将混淆其与无效选项的错误信息)
[GNU提供的getopt()函数的特点]
上面所设计的getopt()函数是UNIX支持小组提供的,其执行时一碰到不以'-'开始的 命令行参数就停止寻找选项。而GNU提供的getopt()函数与之不同,它会扫描整个命令行来寻找选项。
当调用GNU getopt()函数并处理命令行参数的时候,它重新排列argv中的元素,这样当重排结束时,所有选项都被移动到前面(在任何情况下,碰到特殊参数'--'仍将结束对选项的扫描)。
GNU getopt()第二个特点是可以在optstring中使用特殊的首字符改变getopt()的默认行为:
optstring[0] = '+',这样就与UNIX支持小组提供的getopt()很相近了。
optstring[0] = '-',会在optarg中得到命令行中的每个参数。
以上两种情况下,':'可以作为第二个字符使用。
GNU getopt()第三个特点是optstring中的选项字符后面接两个冒号,就允许该选项有可选的选项参数。在选项参数不存在的情况下,GNU getopt()返回选项字符并将optarg设置为NULL。
(字符串optstring可以下列元素,
1.单个字符,表示选项,
2.单个字符后接一个冒号:表示该选项后必须跟一个参数。参数紧跟在选项后或者以空格隔开。该参数的指针赋给optarg。
3 单个字符后跟两个冒号,表示该选项后必须跟一个参数。参数必须紧跟在选项后不能以空格隔开。该参数的指针赋给optarg。(这个特性是GNU的扩张)。)
Example code:
#include <stdio.h>
int main(int argc, char * argv[])
{
if(argc == 1)
{
printf("Usage : %s"
" -s string\n", argv[0]);
return 0;
}
char opt_char;
opterr = 0;// ignore errors
while((opt_char = getopt(argc, argv, "s:")) != -1)
{
switch(opt_char)
{
case 's':
printf("You arg is %s\n", optarg);
break;
case '?':
case ':'://hehe... = =!~
printf("Argument wrong, you should check it\n");
return 0;
}
}
if(optind == (argc - 1))
{
printf("You should input an opt char.\n");
return 0;
}
return 0;
}/********************************************************************************************************/
GNU提供了getopt-long()和getopt-long-only()函数支持长选项的命令行解析,其中,后者的长选项字串是以一个短横线开始的,而非一对短横线。
getopt_long()
是同时支持长选项和短选项的 getopt()
版本。下面是它们的声明:
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);
getopt_long ()的前三个参数与上面的getopt()相同,第4个参数是指向option结构的数组,option结构被称为“长选项表”。longindex参数 如果没有设置为NULL,那么它就指向一个变量,这个变量会被赋值为寻找到的长选项在longopts中的索引值,这可以用于错误诊断。
option结构在getopt.h中的声明如下:
struct option{
const char *name;
int has_arg;
int *flag;
int val;
};
对结构中的各元素解释如下:
const char *name
int has_arg
符号常量 数值 含义
no_argument 0 选项没有参数
required_argument 1 选项需要参数
optional_argument 2 选项参数可选
int *flag
int val
每个长选项在长选项表中都有一个单独条目,该条目里需要填入正确的数值。数组中最后的元素的值应该全是0。数组不需要排序,getopt_long()会进行线性搜索。但是,根据长名字来排序会使程序员读起来更容易。
以上所说的flag和val的用法看上去有点混乱,但它们很有实用价值,因此有必要搞透彻了。
大部分时候,程序员会根据getopt_long()发现的选项,在选项处理过程中要设置一些标记变量,譬如在使用getopt()时,经常做出如下的程序格式:
int do_name, do_gf_name, do_love; /*标记变量*/
char *b_opt_arg;
while((c = getopt(argc, argv, ":ngl:")) != -1)
{
switch (c){
case 'n':
do_name = 1;
case 'g':
do_gf_name = 1;
break;
break;
case 'l':
b_opt_arg = optarg;//optarg
——指向当前选项参数(如果有)的指针。
……
}
}
当flag 不为NULL时,getopt_long*()会为你设置标记变量。也就是说上面的代码中,关于选项'n'、'l'的处理,只是设置一些标记,如果 flag不为NULL,时,getopt_long()可以自动为各选项所对应的标记变量设置标记,这样就能够将上面的switch语句中的两种种情况减 少到了一种。下面给出一个长选项表以及相应处理代码的例子。
清单5:
#include <stdio.h>#include <getopt.h>
int do_name, do_gf_name;
char *l_opt_arg;
struct option longopts[] = {
{ "name", no_argument, &do_name, 1 },
{ "gf_name", no_argument, &do_gf_name, 1 },
{ "love", required_argument, NULL, 'l' },
{ 0, 0, 0, 0},
};
int main(int argc, char *argv[])
{
int c;
while((c = getopt_long(argc, argv, ":l:", longopts, NULL)) != -1){
switch (c){
case 'l':
l_opt_arg = optarg;
printf("Our love is %s!\n", l_opt_arg);
break;
case 0:
printf("getopt_long()设置变量 : do_name = %d\n", do_name);
printf("getopt_long()设置变量 : do_gf_name = %d\n", do_gf_name);
break;
}
}
return 0;
}
在进行测试之前,再来回顾一下有关option结构中的指针flag的说明吧。
如果这个指针为NULL,那么getopt_long()返回该结构val字段中的数值。如果该指针 不为NULL,getopt_long()会使得它所指向的变量中填入val字段中的数值,并且getopt_long()返回0。如果flag不是 NULL,但未发现长选项,那么它所指向的变量的数值不变。
下面测试一下:
$ ./long_opt_demo --name
getopt_long()设置变量 : do_name = 1
getopt_long()设置变量 : do_gf_name = 0
$ ./long_opt_demo --gf_name
getopt_long()设置变量 : do_name = 0
getopt_long()设置变量 : do_gf_name = 1
$ ./long_opt_demo --love forever
Our love is forever!
$ ./long_opt_demo -l forever
Our love is forever
测试过后,应该有所感触了。关于flag和val的讨论到此为止。下面总结一下get_long()的各种返回值的含义:
返回值 | 含 义 |
0 | getopt_long()设置一个标志,它的值与option结构中的val字段的值一样 |
1 | 每碰到一个命令行参数,optarg都会记录它 |
'?' | 无效选项 |
':' | 缺少选项参数 |
'x' | 选项字符'x' |
-1 | 选项解析结束 |
从实用的角度来说,我们更期望每个长选项都对应一个短选项,这种情况下,在option结构中,只要将flag设置为NULL,并将val设置为长选项所对应的短选项字符即可。譬如上面清单5中的程序,修改如下。
清单6:
#include <stdio.h>#include <getopt.h>
int do_name, do_gf_name;
char *l_opt_arg;
struct option longopts[] = {
{ "name", no_argument, NULL, 'n' },
{ "gf_name", no_argument, NULL, 'g' },
{ "love", required_argument, NULL, 'l'},
{ 0, 0, 0, 0},
};
int main(int argc, char *argv[])
{
int c;
while((c = getopt_long(argc, argv, ":l:", longopts, NULL)) != -1){
switch (c){
case 'n':
printf("My name is LYR.\n");
break;
case 'g':
printf("Her name is BX.\n");
break;
case 'l':
l_opt_arg = optarg;
printf("Our love is %s!\n", l_opt_arg);
break;
}
}
return 0;
}
测试结果如下:
$ ./long_opt_demo --name --gf_name --love forever
My name is LYR.
Her name is BX.
Our love is forever!
$ ./long_opt_demo -ng -l forever
My name is LYR.
Her name is BX.
Our love is forever!
9、在LINUX之外的系统平台上使用GNU getopt()或getopt_long()
只要从GNU程序或GNU C Library(GLIBC)的CVS档案文件中copy源文件即可(http://sourceware.org/glibc/)。所需源文件是 getopt.h、getopt.c和getoptl.c,将这些文件包含在你的项目中。另外,你的项目中最好也将COPYING.LIB文件包含进去, 因为GNU LGPL(GNU 程序库公共许可证)的内容全部包括在命名为COPYING.LIB 的文件中。10、结论 程序需要能够快速处理各个选项和参数,且要求不会浪费开发人员的太多时间。在这一点上,无论是GUI(图形用户交互)程序还是CUI(命令行交互)程序, 都是其首要任务,其区别仅在于实现方式的不同。GUI通过菜单、对话框之类的图形控件来完成交互,而CUI使用了纯文本的交互方式。在程序开发中,许多测 试程序用CUI来完成是首选方案。
getopt()
函数是一个标准库调用,可允许您使用直接的 while/switch 语句方便地逐个处理命令行参数和检测选项(带或不带附加的参数)。与其类似的 getopt_long()
允许在几乎不进行额外工作的情况下处理更具描述性的长选项,这非常受开发人员的欢迎。
0 评论:
Post a Comment