Linux命令行程序设计,命令行解析函数

转自:

参考:

一、命令行简介

Linux下很多程序甚至那些具有图形用户界面(graphical user
interface,GUI)的程序,都能接受和处理命令行选项。对于某些程序,这是与其他程序或用户进行交互的主要手段。具有可靠的复杂命令行参数处理
机制,会使得您的应用程序更好、更有用。不过很多开发人员都将其宝贵的时间花在了编写自己的命令行解析器,却不使用
getopt(),而后者是一个专门设计来减轻命令行处理负担的库函数。

解释分析命令行通常是所以程序的第一个任务,C语言通过argc和argv参数来访问它的命令行参数。

1、命令行参数

最简单的命令行处理技术可以通过if判断来表示,如下例:

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

  1. if(argc>1 && argv[1][0] ==’-‘ && argv[1][1] ==’h’)  //判断命令行参数是否为-h   
  2. {   
  3.      do _ some thing();   
  4. }   

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

这样处理简单有序的命令行还可以,对于复杂的命令行处理显得有心无力,于是GNU提供两个函数专门用来处理命令行参数:

2、POSIX约定

 

getopt 和getopt_long

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

命令行工具下的参数选项有两种,长选项短选项。短选项以开头,后面跟单个字母;长选项以开头,后面可跟多个字母。

二、getopt函数

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

 

getopt() 函数声明如下:

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

功能:解析命令行短选项参数

  1. #include <unistd.h>     
  2. int getopt(int argc, char *const argv[], const char *optstring);    
  3.      
  4. extern char *optarg;    
  5.    
  6. extern int optind, opterr, optopt;    

当然许多标准从恒许未遵守以上约定,主要是历史兼容问题,因为标准出现之前,就已经存在N多程序了。
3、GNU长选项GNU鼓励程序员使用–help、–verbose等形式的长选项。这些选项不仅不与POSIX约定冲突,而且容易记忆,另外也提供了在所有GNU工具之间保持一致性的机会。GNU长选项有自己的约定:

函数原型:

说 明:

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

#include
<getopt.h>

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

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

int
getopt(int argc, char * const argv[], const char *optstring);

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

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

几个外部变量

getopt()所设置的全家变量包括:

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

extern
char *optarg;  

optarg —- 当前选项参数字符(如果有的话)

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

extern
int optind, opterr, optopt;

optind —-
argv的当前索引值。当getopt()在while循环中使用时,循环结束后,剩下的字串视为操作数,在
            argv[optind]至argv[argc-1]中可以找到。

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

optarg:若短选项后有参数,则optarg指向该参数

optopt —- 用于当发现无效选项字符的时候,getopt函数或者返回 “?”
或者返回 “:” 字符,并且optopt包含了
           
所发现的无效选项字符,或者当输入非法参数的时候,由optopt带回输入的非法参数(字符)

清单1:

optind:扫描选项时,标识下一个选项的索引;扫描结束后,标识第一个非选项参数索引

opterr —-
这个变量非零时,getopt()函数为“无效选项”和“缺少参数选项,并输出其错误信息。

#include <stdio.h>

int main(int argc, char **argv)
{
    int i, nflg;

    nflg = 0;
    if(argc &gt; 1 && argv[1][0] == ‘-‘ && argv[1][1] == ‘n’){
        nflg++;
        argc–;
        argv++;
    }
    for(i=1; i<argc; i++){
        fputs(argv[i], stdout);
        if(i &lt; argc-1)
            putchar(‘ ‘);
    }
    if(nflg == 0)
        putchar(‘\n’);

    return 0;
}

opterr:出现不可识别的选项时,getopt将打印错误信息。将opterr设为0,可不打印错误信息。

另外:

上面代码中,加亮区域仔细研究一下,会发现很有趣。

optopt:存放不可识别的选项至optopt

如果optstring参数的第一个字符是冒号,那么getopt会根据错误情况返回不同的字符:

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

 

(1):当错误是无效选项,getopt返回 “?”

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

1. 参数

(2):当错误是缺少选项参数,getopt返回 “:”

getopt()函数声明如下:

argc:参数的个数(main)

(3): 无错误发生时,正常返回的是对应的字符!

#include &lt;unistd.h>

int getopt(int argc, char * const argv[], const char *optstring);

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

argv:参数数组(main)

注:GNU
getopt()第三个特点是optstring中的选项字符后面接两个冒号,就允许该选项有可选的选项参数。在选项参数不存在的情况下,GNU
getopt()返回选项字符并将optarg设置为NULL。

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

optstring:短选项字符集合,如 -i
-n中的i,n

例子:

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

 

  1. #include<stdio.h>   
  2. #include<unistd.h>   

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

若选项后面有参数,则选项字符后加:, 对应的参数值保存在外部变量optarg中

#include<getopt.h>   

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

如optstring 为”i:a”,则表示程序支持两个短选项 -i
arg和-a, -i后面须有参数值

/*the variables bellow was define in getopt.h 

下面就用getopt()来写个小程序,体验一下命令行解析的快乐。

当执行./a.out
-i filename -a时,optarg指针就指向filename

extern char *optarg;  

程序描述:

 

extern int optind, opterr, optopt; 

程序名:opt_parse_demo

2. 解析过程

*/  

选项:

getopt首先扫描argv[1]到argv[argc-1],并将选项及参数依次放到argv数组的最左边,非选项参数依次放到argv的最后边

char* para = “:ab:c”;  

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

即该函数会改变argv的排列顺序。

void print_extern_val(void)  

清单2:

如执行程序为:

{  

#include <stdio.h>
#include <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;
}

     0     1   2  3  4  5  6   7  8  9 

    printf(“optarg=%s.optind=%d.opterr=%d.optopt=%d=%c[END]/n”,  

运行结果:

$ ./mygetopt
file1 -i infile -a -o outfile -v -h file2

    optarg, optind, opterr, optopt, optopt);  

$ ./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()对错误命令行参数信息的输出行为

扫描过程中,optind是下一个选项的索引(如-i、-a、-o、-v), 非选项参数将跳过,同时optind增1。optind初始值为1。当扫描argv[1]时,为非选项参数,跳过,optind=2;扫描到-i选项时,后面有参数,下一个将要扫描的选项是-a,则optind更改为4;扫描到-a选项时,下一个选项是-o,optind=5;扫描到-o选项时,后面有参数,下一个选项是-v,optind=7;扫描到-v选项时,下一个选项是-h,optind=8;扫描到-h选项时,optind=9

int main(int argc,char* argv[])  

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

 

{  

清单3:

扫描结束后,getopt会将argv数组修改成下面的形式

      

#include <stdio.h>
#include <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;
}

     0    1  2  3  4  5   6  7  8   9

    int oc = -1;  

输入一个错误的命令行,结果如下:

$./mygetopt
-i infile -a -o outfile -v -h file1 file2

      

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

 

    char* b_input = NULL;  

很多时候,我们不希望输出任何错误信息,或更希望输出自己定义的错误信息。可以采用以下两种方法来更改getopt()函数的出错信息输出行为:

同时,optind会指向非选项的第一个参数,如上面,optind将指向file1