命令行参数解析之getopt

简介

getopt作为Linux下经典的命令行解析工具,得到广泛的使用,下面简单的作一下介绍。

定义

getopt提供了4个变量、1个结构体、3个外部接口、1个内部接口:

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

struct option
{
#if defined (__STDC__) && __STDC__
const char *name;
#else
char *name;
#endif
int has_arg;
int *flag;
int val;
};

int getopt (int argc, char *const *argv, const char *optstring)

int getopt_long (int argc, char *const *argv, const char *options,
const struct option *long_options, int *opt_index)

int getopt_long_only (int argc, char *const *argv, const char *options,
const struct option *long_options, int *opt_index)

int _getopt_internal (int argc, char *const *argv, const char *optstring,
const struct option *longopts, int *longind, int long_only)

optarg

optarg用于从getopt到调用者的交互。
当 getopt 找到带参数的选项时,optarg 被赋值为这个参数;当枚举变量 ordering 等于 RETURN_IN_ORDER 时,没有选项的参数赋值给 optarg。

optind

ARGV中将要被处理的下一个元素的下标。用于和调用者交互,并连续调用getopt。
在进入getopt时,零表示这是第一个调用; 初始化。当getopt返回-1时,表示这是第一个没有选项的参数,需要调用者自己做处理。正常情况下,optind表示ARGV中已经处理的元素个数。

opterr

当getopt遇到无法识别的选项时,调用者通过给opterr赋值零来阻止打印错误消息。

optopt

optopt表示无法识别的选项字符。

struct option

描述应用程序中使用到的长名称选项。
getopt_long或getopt_long_only方法中的LONG_OPTIONS参数,是一个option结构体的容器,并以名称为零的元素结尾。

has_arg
no_argument(0) 代表此选项没有参数;
required_argument(1) 代表此选项需要参数;
optional_argument(2) 代表此选项的参数可有可无;

flag
当flag不等于零时,如果找到选项,那么选项的参数被赋值为val变量;否则不作任何修改;

在使用长名称选项时,除了将int设置为编译常量之外,还需要设置一个来自optarg的值,设置flag为零,设置val为非零(等效的单字母选项,如果有的话)。对于flag字段为零的长选项,getopt返回val字段的值。

getopt

短名称选项的解析。

getopt_long

兼容长名称和短名称选项的解析。

getopt_long_only

长名称选项的解析。

_getopt_internal

长短名称选项的内部解析实现。从给定的OPTSTRING字符串中,搜索(长度为ARGC)ARGV的元素中相匹配的字符选项。

如果ARGV元素以 - 符号开始,并且不等于 - 或 – 那么这个元素是选项,这个元素中的字符是选项的名称。当调用循环getopt时,将成功返回每个元素中的字符。

当getopt找到选项时,将返回元素中的字符,并更新optind和nextchar变量,以便下次搜索时使用。

当查找完成后,getopt返回-1。此时optind被赋值为ARGV中第一个非选项的下标。

OPTSTRING是一个包含合法选项字符的字符串。如果ARGV中的元素不在OPTSTRING中时,getopt输出错误住处,并返回?。当设置opterr为零时,不输出错误,仍返回?。如果OPTSTRING中的字符后面紧跟一个冒号,说明这个短选项需要参数,参数存在’optarg’中;如果字符后面紧跟两个冒号,说明这个短选项的参数可选,参数存在’optarg’中;如果OPTSTRING以 - 或 + 符号开始,那么你需要自己处理非选项的ARGV元素。详情参阅RETURN_IN_ORDER和REQUIRE_ORDER的说明。

长名称选项以 – 符号开始,名称可以使用全称或缩写,并保证名称的唯一性。长选项的参数,可以放在长选项的下一个元素,也可以通过 = 紧跟在长选项的后面。当getopt'发现一个长命名选项时,如果该选项的flag’字段为非零,则返回零,如果’flag’字段为零,则返回该选项的’val’字段的值。

ARGV中的元素并不是真正的常量。我们当作常量来使用,以保证与其他系统的兼容性。

LONGOPTS是一个option结构体的容器,并以名称为零的元素结尾。
LONGIND代表长名称选项在LONGOPT中的下标。仅在长名称选项匹配成功时有效。
LONG_ONLY为非零时,- 符号和 – 符号一样代表长名称的起始。

示例

int main(int argc, char **argv)
{
trueint c;
trueint digit_optind = 0;

truewhile (1)
true{
truetrueint this_option_optind = optind ? optind : 1;
truetrueint option_index = 0;
truetruestatic struct option long_options[] =
truetruetruetrue{
truetruetruetruetruetrue{"add", 1, 0, 0},
truetruetruetruetruetrue{"append", 0, 0, 0},
truetruetruetruetruetrue{"delete", 1, 0, 0},
truetruetruetruetruetrue{"verbose", 0, 0, 0},
truetruetruetruetruetrue{"create", 0, 0, 0},
truetruetruetruetruetrue{"file", 1, 0, 0},
truetruetruetruetruetrue{0, 0, 0, 0}};

truetruec = getopt_long(argc, argv, "abc:d:0123456789",
truetruetruetruetruetruetruetruetruetruelong_options, &option_index);
truetrueif (c == -1)
truetruetruebreak;

truetrueswitch (c)
truetrue{
truetruecase 0:
truetruetrueprintf("option %s", long_options[option_index].name);
truetruetrueif (optarg)
truetruetruetrueprintf(" with arg %s", optarg);
truetruetrueprintf("\n");
truetruetruebreak;

truetruecase '0':
truetruecase '1':
truetruecase '2':
truetruecase '3':
truetruecase '4':
truetruecase '5':
truetruecase '6':
truetruecase '7':
truetruecase '8':
truetruecase '9':
truetruetrueif (digit_optind != 0 && digit_optind != this_option_optind)
truetruetruetrueprintf("digits occur in two different argv-elements.\n");
truetruetruedigit_optind = this_option_optind;
truetruetrueprintf("option %c\n", c);
truetruetruebreak;

truetruecase 'a':
truetruetrueprintf("option a\n");
truetruetruebreak;

truetruecase 'b':
truetruetrueprintf("option b\n");
truetruetruebreak;

truetruecase 'c':
truetruetrueprintf("option c with value `%s'\n", optarg);
truetruetruebreak;

truetruecase 'd':
truetruetrueprintf("option d with value `%s'\n", optarg);
truetruetruebreak;

truetruecase '?':
truetruetruebreak;

truetruedefault:
truetruetrueprintf("?? getopt returned character code 0%o ??\n", c);
truetrue}
true}

trueif (optind < argc)
true{
truetrueprintf("non-option ARGV-elements: ");
truetruewhile (optind < argc)
truetruetrueprintf("%s ", argv[optind++]);
truetrueprintf("\n");
true}

trueexit(0);
}