全部博文(685)
分类: 嵌入式
2014-09-26 17:18:20
getopt_long支持长选项的命令行解析,使用man getopt_long,得到其声明如下:
#include
int getopt_long(int argc, char * const argv[],
const char *optstring,
const struct option *longopts,
int *longindex);
int getopt_long_only(int argc, char * const argv[],
const char *optstring, const struct option *longopts, int *longindex);
说明:函数中的argc和argv通常直接从main()到两个参数传递而来。optsting是选项参数组成的字符串,如果该字符串里任一字母后有冒号,那么这个选项就要求有参数。下一个参数是指向数组的指针,这个数组是
option结构数组,option结构称为长选项表,其声明如下:
struct option {
const char *name;
int has_arg;
int *flag;
int val;
};
结构中的元素解释如下:
const char *name:选项名,前面没有短横线。譬如"help"、"verbose"之类。
int has_arg:描述长选项是否有选项参数,如果有,是哪种类型的参数,其值见下表:
符号常量数值含义
no_argument0选项没有参数
required_argument1选项需要参数
optional_argument2选项参数是可选的
int *flag:
如果该指针为NULL,那么getopt_long返回val字段的值;
如果该指针不为NULL,那么会使得它所指向的结构填入val字段的值,同时getopt_long返回0
int val:
如果flag是NULL,那么val通常是个字符常量,如果短选项和长选项一致,那么该字符就应该与optstring中出现的这个选项的参数相同;
最后一个参数:longindex参数一般赋为NULL即可;如果没有设置为NULL,那么它就指向一个变量,这个变量会被赋值为寻找到的长选项在longopts中的索引值,这可以用于错误诊断。
注:GNU提供的getopt-long()和getopt-long-only()函数,其中,后者的长选项字串是以一个短横线开始的,而非一对短横线。
命令行约定:
几乎所有的GNU/Linux程序都遵循一些命令行参数定义的约定。程序希望出现的参数可以分成两种:选项(options or flags)、其他类型的的参数。Options修饰了程序运行的方式,其他类型的参数则提供了输入(例如,输入文件的名称)。
对于options类型参数可以有两种方式:
1)短选项(short options):顾名思义,就是短小参数。它们通常包含一个连字号和一个字母(大写或小写字母)。例如:-s,-h等。
2)长选项(long options):长选项,包含了两个连字号和一些大小写字母组成的单词。例如,--size,--help等。
*注:一个程序通常会提供包括short options和long options两种参数形式的参数。
对于其他类型参数的说明:
这种类型的参数,通常跟随在options类型参数之后。例如,ls –s /功能为显示root目录的大小。’/ ’这个参数告诉ls要显示目录的路径。
getopt_long()函数使用规则:
(1)使用前准备两种数据结构
字符指针型变量
该数据结构包括了所有要定义的短选项,每一个选项都只用单个字母表示。如果该选项需要参数(如,需要文件路径等),则其后跟一个冒号。例如,三个短选项分别为‘-h’‘-o’‘-v’,其中-o需要参数,其他两个不需要参数。那么,我们可以将数据结构定义成如下形式:
const char *const shor_options = “ho:v” ;
如果是否有参数是可选的,则在后面有两个冒号。
struct option 类型数组
该数据结构中的每个元素对应了一个长选项,并且每个元素是由四个域组成。通常情况下,可以按以下规则使用。
第一个元素,描述长选项的名称;
第二个选项,代表该选项是否需要跟着参数,需要参数则为1,反之为0;
第三个选项,可以赋为NULL;
第四个选项,是该长选项对应的短选项名称。
另外,数据结构的最后一个元素,要求所有域的内容均为0,即{NULL,0,NULL,0}。下面举例说明,还是按照短选项为‘-h’‘-o’‘-v’的例子,该数据结构可以定义成如下形式:
const struct option long_options = {
{“help”,0,NULL,‘h’},
{“output”,1,NULL,‘o’},
{“verbose”,0,NULL,‘v’},
{NULL,0,NULL,0}
};
(2)调用方法
参照(1)准备的两个数据结构,则调用方式可为:
getopt_long( argc, argv, short_options, long_options, NULL);
(3)几种常见返回值
(a)每次调用该函数,它都会分析一个选项,并且返回它的短选项,如果分析完毕,即已经没有选项了,则会返回-1。
(b)如果getopt_long()在分析选项时,遇到一个没有定义过的选项,则返回值为‘?’,此时,程序员可以打印出所定义命令行的使用信息给用户。
(c)当处理一个带参数的选项时,全局变量optarg会指向它的参数
(d)当函数分析完所有参数时,全局变量optind(into argv)会指向第一个‘非选项’的位置
实践小例子:
view plaincopy to clipboardprint?
#include
#include
char *l_opt_arg;
char* const short_options = "nbl:";
struct option long_options[] = {
{ "name",0,NULL,'n'},
{ "bf_name",0,NULL,'b'},
{ "love",1,NULL,'l'},
{0,0,0,0},
};
int main(int argc, char *argv[])
{
int c;
while((c = getopt_long (argc, argv, short_options, long_options, NULL)) != -1)
{
switch (c)
{
case 'n':
printf("My name is XL.\n");
break;
case 'b':
printf("His name is ST.\n");
break;
case 'l':
l_opt_arg = optarg;
printf("Our love is %s!\n", l_opt_arg);
break;
}
}
return 0;
}
编译并运行:
[root@localhost liuxltest]# gcc -o getopt getopt.c
[root@localhost liuxltest]# ./getopt -n -b -l forever
My name is XL.
His name is ST.
Our love is forever!
[root@localhost liuxltest]#
[root@localhost liuxltest]# ./getopt -nb -l forever
My name is XL.
His name is ST.
Our love is forever!
[root@localhost liuxltest]# ./getopt -nbl forever
My name is XL.
His name is ST.
Our love is forever!
刚开始接触 一些处理命令行参数的操作,开始不太明白,用例子测试了一下,感觉比以前明了多了。
命令行参数有长参数如version, 还有短参数 如 v, 那么用这两个都可以。程序处理的时候,会首先把长参数转换成对应的短参数,如会把version转成v, 再进行 v 对应的操作就可以了。
命令行参数的选项,有的需要参数,有的不需要参数,或者有的参数是可选的,那么怎么区分呢?
首先,对这些选项,如何组织起来? 是以字符串的形式组织起来了。如我有一个程序,有两个选项,-a, -b, 我输入的时候是./a.out-a -b, 那么中间会处理成这种 ab这种字符串的形式,这个字符串就是所有的命令行的输入选项。区别是否有参数就在于此。如果某个选项必须有参数,则这一选项后有一个参数,如果参数是可选的,则其后面有两个冒号。如
-a是没有参数的, -b 后面必须有参数, -c 后面是否有参数是可选的。则短的命令行选项是:ab:c::
下面我们通过一个简单的例子看一下。
#include
#include
#include
char *l_opt_arg;
const char* const short_options = "myl:";
struct option long_options[] = {
{ "name",0,NULL,'m'}, //长选项对应的短选项参数, 第二个0表示选项后面无参数, 1为有参数,2为可选
{ "yourname",0,NULL,'y'},
{ "love",1,NULL,'l'},
{0,0,0,0},
};
int main(int argc, char *argv[])
{
int c, i;
printf("before:\n");
for (i = 1; i < argc; i++)
printf("arg:%d\r\targv:%s\n", i, argv[i]);
printf("\n");
while((c = getopt_long (argc, argv, short_options, long_options, NULL)) != -1)
{
switch (c)
{
case 'm':
printf("My name is A.\n");
break;
case 'y':
printf("His name is B.\n");
break;
case 'l':
l_opt_arg = optarg;
printf("Our love is %s!\n", l_opt_arg);
break;
}
}
printf("optind:%d\n", optind);
printf("\nafter:\n");
for (i=1; i
printf("................................\n");
for (i = optind; i < argc; i++)
printf("arg:%d\rargv:%s\n",i,argv[i]);
return 0;
}
注意,此程序可接收的的选项有三个, 一个是m ,不带参数, y 不带参数, l要求有参数。
那如果-m 不带参数,如果我写了参数,会怎么样呢?下面看测试
在调用 getopt_long 以后, optind 的值随之变化。在while循环后,我们再把开始的命令行参数打印出来,看一下有什么不同。
把上面的代码命名为: getopt_long.c
编译,可执行文件为 a.out
$ gccgetopt_long.c
$ ./a.out -m -y
before:
arg:1 : -m
arg:2 : -y
My name is A.
His name is B.
optind:3
after:
arg:1 : -m
arg:2 : -y
$ ./a.out -m -y -l banana
before:
arg:1 : -m
arg:2 : -y
arg:3 : -l
arg:4 : banana
My name is A.
His name is B.
Our love is banana!
optind:5
after:
arg:1 : -m
arg:2 : -y
arg:3 : -l
arg:4 : banana
$./a.out -m lisi -y zhangsan-l bananaaaa
before:
arg:1 : -m
arg:2 : lisi
arg:3 : -y
arg:4 : zhangsan
arg:5 : -l
arg:6 : banana
arg:7 : aaa
My name is A.
His name is B.
Our love is banana!
optind:5
after:
arg:1 : -m
arg:2 : -y
arg:3 : -l
arg:4 : banana
arg:5 : lisi
arg:6 : zhangsan
arg:7 : aaa
注意 argv 里面值的顺序已经和原来不一样了,对命令行的参数重新组织了一下顺序,也就是不认识的命令行参数,都放在了argv的最后,其中 optind 指向了这些没有被解释的参数的第一个。
optind有作用吧!如果你想输出哪些命令行参数没有被识别,可以打印出来
for (i=optind; i
printf("%s\n", argv[i]); 即可
附:如果是长参数,则使用 --, 如 --help, 因为 -help时,(选项不需要参数的情况) 会把它当成 四个选项, -h -e -l -p. 所以使用长参数时,要用两个 横线 --
#include
#include
#include
const char* program_name;
void print_usage (FILE* stream, int exit_code)
{
fprintf (stream, "Usage: %s options [ inputfile ... ]\n", program_name);
fprintf (stream, " -h --help显示这个帮助信息.\n"
" -o --output filename 将输出定位到文件.\n"
" -v --version打印版本信息.\n");
exit (exit_code);
}
int main (int argc, char* argv[])
{
int next_option;//下一个要处理的参数符号
int haveargv = 0;//是否有我们要的正确参数,一个标识
const char* const short_options = "ho:v";
const struct option long_options[] = {
{ "help",0,NULL,'h' },
{ "output",1,NULL,'o' },
{ "version",0,NULL,'v' },
{ NULL,0,NULL,0}};//最后一个元素标识为NULL
const char *output_filename = NULL;
int verbose = 0;
program_name = argv[0];
do
{
next_option = getopt_long (argc, argv, short_options, long_options, NULL);
switch (next_option)
{
case 'h':
haveargv = 1;
print_usage (stdout, 0);
case 'o':
output_filename = optarg;
haveargv = 1;
break;
case 'v':
verbose = 1;
haveargv = 1;
break;
case ':':
break;
case '?':
print_usage (stderr, 1);
case -1:
if (!haveargv)
{
print_usage (stderr, 1);
}
break;
default:
print_usage (stderr, 1);
break;
}
}while (next_option != -1);
printf("optind.................%d\n",optind);
if (haveargv)
{
int i;
for (i = optind; i < argc; ++i)
printf ("Argument: %s\n", argv[i]);
}
return 0;
}