getopt()和getopt_long函数

Posted 2021-07-25 Shemesz

命令行参数解析

• （1）getopt()
• （2）getopt_long()
• （3）getopt_long_only（）

在linux中，经常需要各种命令，通常情况下都会带各种参数，而这些参数是如何解析的呢？通常使用GNU C提供的函数getopt、getopt_long、getopt_long_only函数来解析命令行参数。

（1）getopt()

1. 简介

getopt()函数就是用来解析命令行参数的，包含在<unistd.h>头文件当中。

2.定义

int getopt(int argc, char * const argv[], const char *optstring);
 
extern char *optarg;
extern int optind, opterr, optopt;

参数说明：

• argc：和main()里的参数argc一致，表示参数的个数
• argv：和main()里的参数argv一致，表示参数的字符串变量数组
• optstring：表示短选项字符串
  形式如"ab:c::d"，分别表示程序支持的命令行短选项有-a、-b、-c、-d，冒号含义如下：
  (1)只有一个字符，不带冒号——只表示选项， 如-a
  (2)一个字符，后接一个冒号——表示选项后面带一个参数，如-b 100
  (3)一个字符，后接两个冒号——表示选项后面带一个可选参数，即参数可有可无， 如果带参数，则选项与参数直接不能有空格形式应该如-c200

全局变量说明：

    （1）optarg：表示当前选项对应的参数值。

    （2）optind：表示的是下一个将被处理到的参数在argv中的下标值。

    （3）opterr：如果opterr = 0，在getopt、getopt_long、getopt_long_only遇到错误将不会输出错误信息到标准输出流。opterr在非0时，向屏幕输出错误。

    （4）optopt：表示没有被未标识的选项。

3. 示例

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

int main(int argc, char *argv[])
{
    int     ch; 

    while( (ch = getopt(argc, argv, "abc:")) != -1 )
    {   
        switch(ch)
        {   
            case 'a':
                printf("opt is a, optarg is : %s\\n", optarg);
                break;

            case 'b':
                printf("opt is b, optarg is : %s\\n", optarg);
                break  ;

            case 'c':
                printf("opt is c, optarg is : %s\\n", optarg);
                break;

            case '?':
                printf("error optopt:%c\\n", optopt);
                printf("error optopt:%d\\n", opterr);
                break;
    
            default:
                break;

        }   
    }   
    
    return 0;
}

运行结果

• 第一次运行 ./a.out -a -b -c afei 正常执行和输出

• 第二次运行 ./a.out -abc 由于选项 c 后没有输入参数，于是报错

• 第三次运行 ./a.out -d 由于选项 d 不是我们在 optstring 中预定义的选项，于是报错

4. 可选参数
一个冒号“ ：”表示后面必须跟参数，而还有一种表示方式就是两个冒号“ ：：”表示这是一个可选参数（可以跟参数，也可以不跟参数，即可选参数）

• 注意： 可选参数冒号后边，如果要跟参数， 一定不能加空格

#include <stdio.h>
#include <unistd.h>
 
void usage()
{
    printf("Usage:\\n");
    printf("./a.out [-a] [-b] [-c message] [-h]\\n");
}
 
int main(int argc, char *argv[]) 
{
    int ch;
   
    while ((ch = getopt(argc, argv, "abc::")) != -1) 
    {
        switch (ch) 
        {
            case 'a':
                printf("opt is a, oprarg is: %s\\n", optarg);
                break;
            case 'b':
                printf("opt is b, oprarg is: %s\\n", optarg);
                break;
            case 'c':
                printf("opt is c, oprarg is: %s\\n", optarg);
                break;
            case 'h':
                printf("帮助信息\\n");
                usage(); // 提示使用说明
                break;
            default:
            	break;
        }
    }
    return 0;
}

运行结果

• 第一次运行 ：-c后面直接跟了参数字符，箭头便是打印的参数结果
• 第二次运行 ：-c后面加了空格跟了参数，打印null，表明参数没传进去，所以可选参数后面加参数的时候一定不能加空格，必选参数（一个冒号“ ：”的）加不加空格都可以
• 第三次运行 ：通过usage()打印帮助信息

5. 输入参数：字符串 -> 整形int

注意： optarg都是字符串类型的， 所以在我们有时输入端口号等整形参数，都要注意要用一个字符转换函数atoi()

• 字符串转整形函数：atoi()

（2）getopt_long()

getopt_long是getopt的泛集，
getopt是getopt_long的一个子集，getopt支持的所有特性，getopt_long都支持，包括错误打印、argv元素顺序调整等；
getopt_long相比getopt增加了长选项的解析

• （1）函数原型

#include <getopt.h>

extern char *optarg;
extern int optind, opterr, optopt;
//参数optarg：指向当前选项参数的指针
//参数optind：再次调用getopt_long时的下一个argv指针索引
//参数optopt：表示最后一个未知选项
//如果opterr = 0，在getopt、getopt_long、getopt_long_only遇到错误将不会输出错误信息到标准输出流。opterr在非0时，向屏幕输出错误。

int getopt_long(   
int argc,          
char *const argv[],            
const char *optstring,         //这个参数和getopt（）相应的参数一样，表示短选项字符串
const struct option *longopts,    //表示长选项结构体，指向一个结构体，结构体下面列出。 
int *longindex    // 表示当前长参数在longopts中的索引值  
);

• （2）longopts：表示长选项结构体。结构如下：

struct option 
{  
     const char *name;  
     int         has_arg;  
     int        *flag;  
     int         val;  
};  
eg:
 static struct option longOpts[] = {
      { "daemon", no_argument, NULL, 'D' },
      { "dir", required_argument, NULL, 'd' },
      { "out", required_argument, NULL, 'o' },
      { "log", required_argument, NULL, 'l' },
      { "split", required_argument, NULL, 's' },
      { "http-proxy", required_argument, &lopt, 1 },
      { "http-user", required_argument, &lopt, 2 },
      { "http-passwd", required_argument, &lopt, 3 },
      { "http-proxy-user", required_argument, &lopt, 4 },
      { "http-proxy-passwd", required_argument, &lopt, 5 },
      { "http-auth-scheme", required_argument, &lopt, 6 },
      { "version", no_argument, NULL, 'v' },
      { "help", no_argument, NULL, 'h' },
      { 0, 0, 0, 0 }
    };

• (1)name:表示选项的名称,比如daemon,dir,out等。

• (2)has_arg:表示选项后面是否携带参数。该参数有三个不同值，如下：

     a:  no_argument(或者是0)时    ——参数后面不跟参数值，eg: --version,--help
     b: required_argument(或者是1)时 ——参数输入格式为：--参数 值 或者 --参数=值。eg:--dir=/home 
     c: optional_argument(或者是2)时  ——参数输入格式只能为：--参数=值
  

• (3)flag:这个参数有两个意思，空或者非空。

     a:如果参数为空NULL，那么当选中某个长选项的时候，getopt_long将返回val值。
             eg，可执行程序 --help，getopt_long的返回值为h.             
     b:如果参数不为空，那么当选中某个长选项的时候，getopt_long将返回0，并且将flag指针参数指向val值。
             eg: 可执行程序 --http-proxy=127.0.0.1:80 那么getopt_long返回值为0，并且lopt值为1。
  

• (4)val：表示指定函数找到该选项时的返回值，或者当flag非空时指定flag指向的数据的值val。

（3）返回值：

     （1）如果短选项找到，那么将返回短选项对应的字符。

     （2）如果长选项找到，如果flag为NULL，返回val。如果flag不为空，返回0

     （3）如果遇到一个选项没有在短字符、长字符里面。或者在长字符里面存在二义性的，返回“？”

     （4）如果解析完所有字符没有找到（一般是输入命令参数格式错误，eg： 连斜杠都没有加的选项），返回“-1”

     （5）如果选项需要参数，忘了添加参数。返回值取决于optstring，如果其第一个字符是“：”，则返回“：”，否则返回“？”。

注意：

    （1）longopts的最后一个元素必须是全0填充，否则会报段错误

    （2）短选项中每个选项都是唯一的。而长选项如果简写，也需要保持唯一性。

（3）getopt_long_only（）

getopt_long_only与getopt_long的区别在于：

getopt_long仅仅只能将"–“开始的选项视为长选项，但getopt_long_only将”-“开头选项也会视为长选项，当长选项列表均不满足时，且短选项满足时，”-"才会解析为短选项；