首页 > Computer > Linux > GNU长选项命令行解析getopt_long()
2011
06-16

GNU长选项命令行解析getopt_long()

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

GNU提供了getopt-long()和getopt-long-only()函数支持长选项的命令行解析,其中,后者的长选项字串是以一个短横线开始的,而非一对短横线。

getopt_long() 是同时支持长选项和短选项的 getopt() 版本。下面是它们的声明:

#i nclude <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);

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

Linux系统下,需要大量的命令行选项,如果自己手动解析他们的话实在是有违软件复用的思想,不过还好,GNU C library留给我们一个解析命令行的接口(X/Open规范),好好使用它可以使你的程序改观不少。

使用getopt_long()需要引入头文件

#include <getopt.h>

     现在我们使用一个例子来说明它的使用。

一个应用程序需要如下的短选项和长选项。 

 短选项 长选项   作用
-h –help 输出程序命令行参数说明然后退出
-o filename –output filename 给定输出文件名
-v –version 显示程序当前版本后退后

 


      为了使用getopt_long函数,我们需要先确定两个结构:

1.一个字符串,包括所需要的短选项字符,如果选项后有参数,字符后加一个”:”符号。本例中,这个字符串应该为”ho:v”。(因为-o后面有参数filename,所以字符后面要加”:”)

2.一个包含长选项字符串的结构体数组,每一个结构体包含4个域,第一个域为长选项字符串,第二个域是一个标识,只能为0或1,分别代表没有、有。第三个域永远为NULL。第四个域为对应的短选项字符串(即getopt_long函数的返回值)。结构体数组的最后一个元素全部为NULL和0,标识结束。在本例中,它应该像一下的样子:

const struct option long_options[] = {
         { "help", 0, NULL, 'h' },
         { "output", 1, NULL, 'o' },
         { "version", 0, NULL, 'v' },
         { NULL, 0, NULL, 0}
      };

     调用时需要把main的两个参数argc和argv以及上述两个数据结构传给getopt_long。
每次调用getopt_long,它会解析一个符号,返回相应的短选项字符,如果解析完毕返回-1。所以需要使用一个循环来处理所有的参数,而相应的循环里会使用switch语句进行选择。如果getopt_long遇到一个无效的选项字符,它会打印一个错误消息并且返回’?’,很多程序会打印出帮助信息并且中止运行;当getopt_long解析到一个长选项并且发现后面没有参数则返回’:’,表示缺乏参数。当处理一个参数时,全局变量optarg指向下一个要处理的变量。当getopt_long处理完所有的选项后,全局变量optind指向第一个未知的选项索引。

这一个例子代码为下:

 

//编译使用gcc -o getopt_long getopt_long.c

#include <getopt.h>
#include <stdio.h>
#include <stdlib.h>

/*程序的名字*/
const char* program_name;

/* 打印程序参数 */
void print_usage (FILE* stream, int exit_code)
{
fprintf (stream, "Usage: %s options [ inputfile ... ]\n", program_name);
fprintf (stream, " -h --help 显示这个帮助信息.\n"
                             " -o --output filename 将输出定位到文件.\n"
                             " -v --version 打印版本信息.\n");
exit (exit_code);
}


/* 主程序 */
int main (int argc, char* argv[])
{
int next_option;//下一个要处理的参数符号

int haveargv = 0;//是否有我们要的正确参数,一个标识

          
/* 包含短选项字符的字符串,注意这里的‘:’ */
         
const char* const short_options = "ho:v";
             
/* 标识长选项和对应的短选项的数组 */
             
const struct option long_options[] = {
                   { "help", 0, NULL, 'h' },
                   { "output", 1, NULL, 'o' },
                   { "version", 0, NULL, 'v' },
                   { NULL, 0, NULL, 0 }};//最后一个元素标识为NULL

                   
    /* 此参数用于承放指定的参数,默认为空 */
const char* output_filename = NULL;
/* 一个标志,是否显示版本号 */
int verbose = 0;

/* argv[0]始终指向可执行的文件文件名 */
                            
program_name = argv[0];
   
do
{
    next_option = getopt_long (argc, argv, short_options, long_options, NULL);
    switch (next_option)
    {
     case 'h': /* -h or --help */ 
       haveargv = 1;
       print_usage (stdout, 0);
     case 'o': /* -o or --output */
         /* 此时optarg指向--output后的filename */
      output_filename = optarg;
      haveargv = 1;
      break;
     case 'v': /* -v or --version */
      verbose = 1;
      haveargv = 1;
      break;
     case ':': /* 缺乏长选项内容 */
      break;
     case '?': /* 出现一个未指定的参数*/
      print_usage (stderr, 1);
     case -1: /* 处理完毕后返回-1 */
             if (!haveargv)
             {
                   print_usage (stderr, 1);
             }
      break;
     default: /* 未指定的参数出现,出错处理 */
      print_usage (stderr, 1);
                                  break;
    }
}while (next_option !=-1);
                           
if (verbose)
{
    int i;
    for (i = optind; i < argc; ++i)
    printf ("Argument: %s\n", argv[i]);
} 
                       
return 0;
}


option结构在getopt.h中的声明如下:

struct option{
     const char *name;
     int has_arg;
     int *flag;
     int val;
};

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

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的用法看上去有点混乱,但它们很有实用价值,因此有必要搞透彻了。

大部分时候,程序员会根据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;
     ……
     }
}

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

清单5:

#i nclude <stdio.h>
#i nclude <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:

#i nclude <stdio.h>
#i nclude <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() 允许在几乎不进行额外工作的情况下处理更具描述性的长选项,这非常受开发人员的欢迎。

最后编辑:
作者:wy182000
这个作者貌似有点懒,什么都没有留下。

留下一个回复