Linux程序设计——用getopt处理命令行参数

  Linux程序设计——用getopt处理命令行参数 一

2007年09月13日 星期四 05:52 P.M.

        Linux下很多程序甚至那些具有图形用户界面（graphical user interface，GUI）的程序，都能接受和处理命令行选项。对于某些程序，这是与用户进行交互的主要手段。具有可靠的复杂命令行参数处理机制，会使得您的应用程序更好、更有用。 getopt()是一个专门设计来减轻命令行处理负担的库函数。

1、命令行参数

命令行程序设计的首要任务是解析命令行参数，GUI派的程序员很少关心这个。这里，对参数采用了一种比较通俗的定义：命令行上除命令名之外的字符串。参数由多项构成，项与项之间用空白符彼此隔开。

参数进一步分为 选项和 操作数。选项用于修改程序的默认行为或为程序提供信息，比较老的约定是以短划线开头。选项后可以跟随一些参数，称为选项参数。剩下的就是操作数了。

2、POSIX约定

POSIX表示可移植操作系统接口：Portable Operating System Interface，电气和电子工程师协会（Institute of Electrical and Electronics Engineers，IEEE）最初开发 POSIX 标准，是为了提高 UNIX 环境下应用程序的可移植性。然而，POSIX 并不局限于 UNIX。许多其它的操作系统，例如 DEC OpenVMS 和 Microsoft Windows NT，都支持 POSIX 标准。

下面是POSIX标准中关于程序名、参数的约定：

• 程序名不宜少于2个字符且不多于9个字符；
• 程序名应只包含小写字母和阿拉伯数字；
• 选项名应该是单字符活单数字，且以短横‘-‘为前綴；
• 多个不需要选项参数的选项，可以合并。（譬如：foo -a -b -c ---->foo -abc）
• 选项与其参数之间用空白符隔开；
• 选项参数不可选。
• 若选项参数有多值，要将其并为一个字串传进来。譬如：myprog -u "arnold,joe,jane"。这种情况下，需要自己解决这些参数的分离问题。
• 选项应该在操作数出现之前出现。
• 特殊参数‘--'指明所有参数都结束了，其后任何参数都认为是操作数。
• 选项如何排列没有什么关系，但对互相排斥的选项，如果一个选项的操作结果覆盖其他选项的操作结果时，最后一个选项起作用；如果选项重复，则顺序处理。
• 允许操作数的顺序影响程序行为，但需要作文档说明。
• 读写指定文件的程序应该将单个参数'-'作为有意义的标准输入或输出来对待。

3、GNU长选项

GNU鼓励程序员使用--help、--verbose等形式的长选项。这些选项不仅不与POSIX约定冲突，而且容易记忆，另外也提供了在所有GNU工具之间保持一致性的机会。GNU长选项有自己的约定：

• 对于已经遵循POSIX约定的GNU程序，每个短选项都有一个对应的长选项。
• 额外针对GNU的长选项不需要对应的短选项，仅仅推荐要有。
• 长选项可以缩写成保持惟一性的最短的字串。
• 选项参数与长选项之间或通过空白字符活通过一个'='来分隔。
• 选项参数是可选的（只对短选项有效）。
• 长选项允许以一个短横线为前缀。
  

4、基本的命令行处理技术

C程序通过argc和argv参数访问它的命令行参数。argc是整型数，表示参数的个数（包括命令名）。main()函数的定义方式有两种，区别仅在于argv如何定义：

int main(int argc, char *argv[]) {        …… }

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

当 C 运行时库的程序启动代码调用 main() 时，已经对命令行进行了处理。argc 参数包含参数的计数值，而 argv 包含指向这些参数的指针数组。argv[0]是程序名。

一个很简单的命令行处理技术的例子是echo程序，它可以将参数输出到标准设备上，用空格符隔开，最后换行。若命令行第一个参数为-n，那么就不会换行。

清单1：

＃i nclude <stdio.h> int main(int argc, char **argv) {         int i, nflg;         nflg = 0;         if(argc > 1 && argv[1][0] == '-' && argv[1][1] == 'n'){             nflg++;             argc--;             argv++;         }         for(i=1; i<argc; i++){             fputs(argv[i], stdout);             if(i < argc-1)                 putchar(' ');         }         if(nflg == 0)             putchar('/n');         return 0; }

echo程序中，对于命令行参数的解析是手动实现的。很久以前，Unix支持小组为了简化对于命令行参数的解析，开发了getopt()函数，同时提供了几个外部变量，使得编写遵守POSIX的代码变得更加容易了。

5、命令行参数解析函数 —— getopt()

getopt()函数声明如下：

＃i nclude <unistd.h> int getopt(int argc, char * const argv[], const char *optstring); extern char *optarg; extern int optind, opterr, optopt;

该函数的argc和argv参数通常直接从main()的参数直接传递而来。optstring是选项字母组成的字串。如果该字串里的任一字符后面有冒号，那么这个选项就要求有选项参数。

当给定getopt()命令参数的数量 (argc)、指向这些参数的数组 (argv) 和选项字串 (optstring) 后，getopt() 将返回第一个选项，并设置一些全局变量。使用相同的参数再次调用该函数时，它将返回下一个选项，并设置相应的全局变量。如果不再有可识别的选项，将返回 -1，此任务就完成了。

getopt() 所设置的全局变量包括：

• char *optarg——当前选项参数字串（如果有）。
• int optind——argv的当前索引值。当getopt()在while循环中使用时，循环结束后，剩下的字串视为操作数，在argv[optind]至argv[argc-1]中可以找到。
• int opterr——这个变量非零时，getopt()函数为“无效选项”和“缺少参数选项，并输出其错误信息。
  
• int optopt——当发现无效选项字符之时，getopt()函数或返回'?'字符，或返回':'字符，并且optopt包含了所发现的无效选项字符。

以下面的程序为例：
选项：

• -n —— 显示“我的名字”。
• -g —— 显示“我女朋友的名字”。
• -l —— 带参数的选项.

清单2：

＃i nclude <stdio.h> ＃i nclude <unistd.h> int main (int argc, char **argv) {         int oc;                         /*选项字符 */         char *b_opt_arg;                /*选项参数字串 */         while((oc = getopt(argc, argv, "ngl:")) != -1)         {             switch(oc)             {                 case 'n':                     printf("My name is Lyong./n");                     break;                 case 'g':                     printf("Her name is Xxiong./n");                     break;                 case 'l':                     b_opt_arg = optarg;                     printf("Our love is %s/n", optarg);                     break;             }         }        return 0; }

运行结果：

$ ./opt_parse_demo -n My name is Lyong. $ ./opt_parse_demo -g Her name is Xxiong. $ ./opt_parse_demo -l forever Our love is forever $ ./opt_parse_demo -ngl forever My name is Lyong. Her name is Xxiong. Our love is forever

6、改变getopt()对错误命令行参数信息的输出行为

不正确的调用程序在所难免，这种错误要么是命令行选项无效，要么是缺少选项参数。正常情况下，getopt()会为这两种情况输出自己的出错信息，并且返回'?'。为了验证此事，可以修改一下上面的清单2中的代码。

清单3：

＃i nclude <stdio.h> ＃i nclude <unistd.h> int main (int argc, char **argv) {         int oc;                         /*选项字符 */         char *b_opt_arg;                /*选项参数字串 */         while((oc = getopt(argc, argv, "ngl:")) != -1)         {             switch(oc)             {                 case 'n':                     printf("My name is Lyong./n");                     break;                  case 'g':                     printf("Her name is Xxiong./n");                     break;                 case 'l':                     b_opt_arg = optarg;                     printf("Our love is %s/n", optarg);                     break;                 case '?':                     printf("arguments error!/n");                     break;             }         }         return 0; }

输入一个错误的命令行，结果如下：

$ ./opt_parse_demo -l ./opt_parse_demo: option requires an argument -- l arguments error!

如果不希望输出任何错误信息，或更希望输出自定义的错误信息。可以采用以下两种方法来更改getopt()函数的出错信息输出行为：

1. 在调用getopt()之前，将opterr设置为0，这样就可以在getopt()函数发现错误的时候强制它不输出任何消息。
2. 如果optstring参数的第一个字符是冒号，那么getopt()函数就会保持沉默，并根据错误情况返回不同字符，如下：
   • “无效选项” —— getopt()返回'?'，并且optopt包含了无效选项字符（这是正常的行为）。
   • “缺少选项参数” —— getopt()返回':'，如果optstring的第一个字符不是冒号，那么getopt()返回'?'，这会使得这种情况不能与无效选项的情况区分开。

清单4：

＃i nclude <stdio.h> ＃i nclude <unistd.h> int main (int argc, char **argv) {         int oc;                         /*选项字符 */         char ec;                                 /*无效的选项字符*/         char *b_opt_arg;                /*选项参数字串 */         while((oc = getopt(argc, argv, ":ngl:")) != -1)         {             switch(oc)             {                 case 'n':                     printf("My name is Lyong./n");                     break;                  case 'g':                     printf("Her name is Xxiong./n");                     break;                 case 'l':                     b_opt_arg = optarg;                     printf("Our love is %s/n", optarg);                     break;                 case '?':                     ec = (char)optopt;                     printf("无效的选项字符 /' %c /'!/n", ec);                     break;                 case ':':                     printf("缺少选项参数！/n");                     break;             }         }         return 0; }

测试结果：

$ ./opt_parse_demo -a 无效的选项字符 ' a '! $ ./opt_parse_demo -l 缺少选项参数！

只要从GNU程序或GNU C Library(GLIBC)的CVS档案文件中copy源文件即可（http://sourceware.org/glibc/）。所需源文件是getopt.h、getopt.c和getoptl.c，将这些文件包含在你的项目中。另外，你的项目中最好也将COPYING.LIB文件包含进去，因为 程序需要能够快速处理各个选项和参数，且要求不会浪费开发人员的太多时间。在这一点上，无论是GUI(图形用户交互）程序还是CUI（命令行交互）程序，都是其首要任务，其区别仅在于实现方式的不同。GUI通过菜单、对话框之类的图形控件来完成交互，而CUI使用了纯文本的交互方式。在程序开发中，许多测试程序用CUI来完成是首选方案。