Chinaunix首页 | 论坛 | 博客
  • 博客访问: 1093224
  • 博文数量: 242
  • 博客积分: 10209
  • 博客等级: 上将
  • 技术积分: 3028
  • 用 户 组: 普通用户
  • 注册时间: 2008-03-12 09:27
文章分类

全部博文(242)

文章存档

2014年(1)

2013年(1)

2010年(51)

2009年(65)

2008年(124)

我的朋友

分类: LINUX

2009-06-20 16:26:36

在实际程序之中我们经常要对命令行参数进行分析. 比如我们有一个程序a可以接受许多参数.一个可能的情况是 
a -d print --option1 hello --option2 world 
那么我们如何对这个命令的参数进行分析呢?经常用函数是getopt和getopt_long. 

一、函数定义

相关的函数、数据结构、以及几个全局变量定义在/usr/include/getopt.h中。
#include     //函数的实现应该在这个库里
#include     //函数声明
int getopt(int argc,char const **argv, const char *optstring);
int getopt_long(int argc,char const **argc,
             const char *optstring,const struct option *longopts, int *longindex);

extern char *optarg;
extern int optind,opterr,optopt;

struct option {
char *name;
int has_flag;
int *flag;
int value;
    };

getopt_long是getopt的扩展.getopt接受的命令行参数只可以是以(-)开头,而getopt_long还可以接受(--) 开头的参数.一般以(-)开头的参数的标志只有一个字母,而以(--)开头的参数可以是一个字符串.如上面的 -d,--option1选项. 


二、getopt()函数

argc,和argv参数是main函数的参数.optstring指出了我们可以接受的参数.其一般的形式为:参数1[:]参数 2[:].... 其中参数是我们可以接受的参数,如果后面的冒号没有省略,那么表示这个参数出现时后面必需要带参数值,字符后面接两个冒号说明后面跟随一个可有可无的选项参数。 比如一个optstring为abc:d:e::表示这个参数选项可以为a,b,c,d,e,其中c,d出现时候必须要有参数值,而e出现时参数可有可无。(注意“::” 是 GNU 增加的,不一定在所有的UNIX 系统下都可以使用)。如果我们输入了一个我们没有提供的参数选项.系统将会说 不认识 的 选项. getopt()返回我们指定的参数选项.同时将参数值保存在optarg中,变量 optind 包含下一个 argv 参数作为对 getopt() 下一次调用的索引,变量 optopt 保存最后一个由 getopt() 返回的已知的选项。如果已经分析完成所有的参数函数返回-1.这个时候optind指 出非可选参数的开始位置.

#include 
#include 

int main(int argc,char **argv)
{
 int is_a,is_b,is_c,is_d,i;
 char *a_value,*b_value,*c_value,temp;

 is_a=is_b=is_c=is_d=0;
 a_value=b_value=c_value=NULL;
 
 if(argc==1)
   {
    fprintf(stderr,"Usage:%s [-a value] [-b value] [-c value] [-d] arglist ...\n",
argv[0]);
    exit(1);
   }

 while((temp=getopt(argc,argv,"a:b:c:d"))!=-1)
  {
     switch (temp) 
   {
   case 'a':
is_a=1;
a_value=optarg;
        break;
   case 'b':
is_b=1;
b_value=optarg;
break;
   case 'c':
is_c=1;
c_value=optarg;
break;
   case 'd':
is_d=1;
break;
  }
   }

 printf("Option has a:%s with value:%s\n",is_a?"YES":"NO",a_value);
 printf("Option has b:%s with value:%s\n",is_b?"YES":"NO",b_value);
 printf("Option has c:%s with value:%s\n",is_c?"YES":"NO",c_value);
 printf("OPtion has d:%s\n",is_d?"YES":"NO");
 i=optind;
   while(argv[i]) printf(" with arg:%s\n",argv[i++]);
 exit(0);
}  


注意事项:
1.当遇到一个未知的选项时 getopt 返回提示信息。比如命令行中给出不存在的选项-e,就会有提示信息'invalid option -- e' ,但其他选项和参数照样正常读取执行。

2.当调用GNU getopt()函数并处理命令行参数的时候,它重新排列argv中的元素,这样当重排结束时,所有选项都被移动到前面并且那些继续检查argv [optind]至argv[argc-1]中剩余参数的代码仍正常工作,但在任何情况下,碰到特殊参数'--'就结束对选项的扫描,把后面的全部当成是非可选参数。

3.很多时候,我们不希望输出任何错误信息,或更希望输出自己定义的错误信息。可以采用以下两种方法来更改getopt()函数的出错信息输出行为:
(a)在调用getopt()之前,将opterr设置为0,这样就可以在getopt()函数发现错误的时候强制它不输出任何消息。
(b)如果optstring参数的第一个字符是冒号,那么getopt()函数就会保持沉默,并根据错误情况返回不同字符,如下:
   “无效选项” ―― getopt()返回'?',并且optopt包含了无效选项字符(这是正常的行为)。
   “缺少选项参数” ―― getopt()返回':'。
如果optstring的第一个字符不是冒号,那么缺少选项参数时getopt()返回  '?',这会使得这种情况不能与无效选项的情况区分开。
例如optstring为:a:b::c,表示a带一个参数,b可选,c不带参数
如果输入d,“无效选项“,getopt返回'?'
如果输入的a忘记带参数,“缺少选项参数”,getopt应返':' ;如果optstring的第一个字符不是':'的话,那么将会把这个错当成"无效参数",从而getopt返回'?';从而无法区别错误类型。

三、getopt_long()函数

20 世纪 90 年代,UNIX 应用程序开始支持长选项,即一对短横线、一个描述性选项名称,还可以包含一个使用等号连接到选项的参数。

getopt_long ()的前三个参数与上面的getopt()相同,第4个参数是指向option结构的数组,option结构被称为“长选项表”。longindex参数 如果没有设置为NULL,那么它就指向一个变量,这个变量会被赋值为寻找到的长选项在longopts中的索引值,这可以用于错误诊断。

对option结构中的各元素解释如下:

const char *name

这是选项名,前面没有短横线。譬如"help"、"verbose"之类。

int has_arg

描述了选项是否有选项参数。如果有,是哪种类型的参数,此时,它的值一定是下表中的一个。
符号常量 数值 含义
no_argument 0 选项没有参数
required_argument 1 选项需要参数
optional_argument 2 选项参数可选

int *flag

如果这个指针为NULL,那么 getopt_long()返回该结构val字段中的数值。如果该指针不为NULL,getopt_long()会使得它所指向的变量中填入val字段中 的数值,并且getopt_long()返回0。如果flag不是NULL,但未发现长选项,那么它所指向的变量的数值不变。

int val

这个值是发现了长选项时的返回值,或者flag不是NULL时载入*flag中的值。典型情况下,若flag不是NULL,那么val是个真/假值,譬如1或0;另一方面,如果flag是NULL,那么 val通常是字符常量,若长选项与短选项一致,那么该字符常量应该与optstring中出现的这个选项的参数相同。

每个长选项在长选项表中都有一个单独条目,该条目里需要填入正确的数值。数组中最后的元素的值应该全是0。数组不需要排序,getopt_long()会进行线性搜索。但是,根据长名字来排序会使程序员读起来更容易。

以上所说的flag和val的用法看上去有点混乱,但它们很有实用价值,因此有必要搞透彻了。

(1)利用flag不设为NULL,可以用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;
         break;
     case 'g':
         do_gf_name = 1;
         break;
     case 'l':
         b_opt_arg = optarg;
     ……
     }
}

上面的代码中,关于选项'n'、'l'的处理,只是设置一些标记,如果flag不为NULL时,getopt_long()可以自动为各选项所对应的标记变量设置标记,这样就能够将上面的switch语句中的两 种种情况减少到了一种。下面给出一个长选项表以及相应处理代码的例子。


#include
#include

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!


(2)从实用的角度来说,我们更期望每个长选项都对应一个短选项,这种情况下,在option结构中,只要将flag设置为NULL,并将val设置为长选项所对应的短选项字符即可。

譬如上面的程序,修改如下。


#include
#include

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!


阅读(1340) | 评论(0) | 转发(0) |
给主人留下些什么吧!~~