博远课题笔记之——命令行参数解析

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

getopt(...) 接受三个参数:

• argc : 程序主函数接受到的 args 数量
• argv[] : 程序接受到的 argument vector
• optstring : 一个包含了所有正确 options 的字串, getopt 使用它做解析

需要注意的是, 调用 getopt(...) 时只会解析一次, 所以需要通过循环重复解析, 直到 getopt(...) 的返回值为 -1, 此时才解析完毕

我们可以通过一段伪代码来查看 getopt(..) 的使用方式:

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

int main(int argc, char *argv[])
{
    ...//DO SOMETHING

    while (1)
    {
        int opt = getopt(argc, argv, "abc"); // -a -b -c are accepted
        if (opt == -1)
        {
            break; // done parsing
        }
        printf("%c\n", (char)opt); // print the parsed option, one by one
    }

    ... //DO SOMETHING

    return 0;
}

假设用户输入了一个不在 optstring 中的 option, getopt(...) 会返回 ?

此时如果我们希望获得用户输入的无效 option , 可以参考 [Manual]​ 中列出的外部变量:

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

所以只需要访问 optopt 就行了

int getopt_long(int argc, char *const argv[],
           const char *optstring,
           const struct option *longopts, int *longindex);

前三个参数和之前的一样, 后面的突然就看不懂了, 于是继续读 [Manual]​…

• longindex

  长选项在 longopts 中的 index

• struct option

  查阅 [手册]​ 可得:

  longopts is a pointer to the first element of an array of struct option
  declared in <getopt.h> as
  
      struct option {
          const char *name;
          int         has_arg;
          int        *flag;
          int         val;
      };
  
  The meanings of the different fields are:
  
  name   is the name of the long option.
  
  has_arg
         is:  no_argument (or 0) if the option does not take an argument;
         required_argument (or 1) if the option requires an argument;  or
         optional_argument  (or  2) if the option takes an optional argu‐
         ment.
  
  flag   specifies how results are returned for a long option.   If  flag
         is  NULL,  then  getopt_long()  returns  val.  (For example, the
         calling program may set val to the equivalent short option char‐
         acter.)   Otherwise, getopt_long() returns 0, and flag points to
         a variable which is set to val if the option is found, but  left
         unchanged if the option is not found.
  
  val    is  the value to return, or to load into the variable pointed to
         by flag.
  
  The last element of the array has to be filled with zeros.
  
  If longindex is not NULL, it points to a variable which is set  to  the
  index of the long option relative to longopts.
  

  所以对于 option 结构体：

  1. *name: option 的名字
  2. has_args: option 是否含有参数 (0->无参数; 1->有参数; 2->可选参数)
  3. *flag: 需要改变的 flag
  4. val: flag 的改变值 / 函数返回值

这么说还是很抽象, 比如 flag 是干什么的, 莫名其妙就出现了

这里给一个 option 结构体的使用例 (伪代码):

int flag;

struct option foo_options[] =
{
    {"a", 0, &flag, 1},
    {"b", 1, &flag, 0},
    {"c", 0, NULL, 'c'},
    {0, 0, 0, 0} // null terminator, like '\0'
};

在这个示例中, foo_options[2] 的 name 被设置为 c, 返回值被设置为 'c' , 于是开发者可以用 switch 语句来处理返回值, 执行 --c 所对应的语句了

对于 --a, --b 这两个 option , 它们都返回 0 , 但会修改 flag 的值, 然后开发者就可以用 flag 来做其它的判断