原文:http://blog.youkuaiyun.com/cashey1991/article/details/7942809
原文:http://blog.youkuaiyun.com/bailyzheng/article/details/8048733
原文:http://blog.youkuaiyun.com/hcx25909/article/details/7388750
一·、linux 命令行约定:
几乎所有的GNU/Linux程序都遵循一些命令行参数定义的约定。程序希望出现的参数可以分成两种:选
项(options or flags)、其他类型的的参数。Options修饰了程序运行的方式,其他类型的参数则提供了输
入(例如,输入文件的名称)。
对于options类型参数可以有两种方式:
1)短选项(short options):顾名思义,就是短小参数。它们通常包含一个连字号和一个字母(大写
或小写字母)。例如:-s,-h等。
2)长选项(long options):长选项,包含了两个连字号和一些大小写字母组成的单词。例如,--
size,--help等。
*注:一个程序通常会提供包括short options和long options两种参数形式的参数。
二、短参数, getopt()
在讨论参数处理之前,我们先明确两个概念:选项、选项参数
gcc -g -o test test.c
我们经常使用上面的命令来编译程序,这里g和o就是选项,其中test就是o的选项参数
下面我们来看一下getopt:
首先是函数声明:
- #include <unistd.h>
- extern char *optarg;
- extern int optind;
- extern int optopt;
- extern int opterr;
- extern int optreset;
- int getopt(int argc, char * const *argv, const char *optstring);
直接看一个例子:
- /* getopt.c */
- #include <unistd.h>
- #include <stdio.h>
- int main(int argc, char * argv[])
- {
- int aflag=0, bflag=0, cflag=0;
- int ch;
- while ((ch = getopt(argc, argv, "ab:c")) != -1)
- {
- printf("optind: %d\n", optind);
- switch (ch) {
- case 'a':
- printf("HAVE option: -a\n");
- aflag = 1;
- break;
- case 'b':
- printf("HAVE option: -b\n");
- bflag = 1;
- printf("The argument of -b is %s\n", optarg);
- break;
- case 'c':
- printf("HAVE option: -c");
- cflag = 1;
- break;
- case '?':
- printf("Unknown option: %c\n",(char)optopt);
- break;
- }
- }
- }
通过上面的例子,大家应该可以照猫画虎,就可以在自己的程序中使用getopt函数了。
getopt()每调用一次返回一个选项。
argc 和 argv 很显然就是 main 函数的两个参数。
字符串 optstring 可以包含下列元素:单个字符,字符后面接一个冒号说明后面跟随一个选项参数,字符后面接两个冒号说明后面跟随一个可有可无的选项参数。例如,一个选项字符 "x" 表示选项 "-x" ,选项字符 "x:" 表示选项和其参数 "-x argument",选项字符 "x::" 表示选项 x 的参数是可选的(“::” 是 GNU 增加的,不一定在所有的UNIX 系统下都可以使用)。
getopt()的返回后,如果有选项参数的话 optarg 指向选项参数,并且变量 optind 包含下一个 argv 参数作为对 getopt() 下一次调用的索引。变量 optopt 保存最后一个由 getopt() 返回的已知的选项。
当参数列已经到结尾时getopt()函数返回-1,当遇到一个未知的选项时 getopt 返回'?'。参数列中选项的解释可能会被'--'取消,由于它引起 getopt()给参数处理发送结束信号并返回-1。
很多时候,我们不希望输出任何错误信息,或更希望输出自己定义的错误信息。可以采用以下两种方法来更改getopt()函数的出错信息输出行为:
在调用getopt()之前,将opterr设置为0,这样就可以在getopt()函数发现错误的时候强制它不输出任何消息。
如果optstring参数的第一个字符是冒号,那么getopt()函数就会保持沉默,并根据错误情况返回不同字符,如下:
“无效选项” ―― getopt()返回'?',并且optopt包含了无效选项字符(这是正常的行为)。
“缺少选项参数” ―― getopt()返回':',如果optstring的第一个字符不是冒号,那么getopt()返回'?',这会使得这种情况不能与无效选项的情况区分开。
例如optstring为:a:b::c,表示a带一个参数,b可选,c不带参数
如果输入d,“无效选项“,getopt返回'?'
如果输入的a忘记带参数,“缺少选项参数”,getopt应返':' ;如果不再optstring的第一个字符不是':'的话,那么将会把这个错当成"无效参数",从而getopt返回'?';从而无法区别错误类型。
三、长参数, getopt_long(), getopt_long_only()
我敢说,几乎每个人在接触到一个新的命令的时候,第一件干的事情就是 cmd -h 或者是 cmd --help,-h我们都知道是使用getopt来实现的,那么--help是怎么实现的呢?那就是getopt_long了,它可以支持长参数。
int getopt(int argc, char * const argv[],
const char *optstring);
int getopt_long(int argc, char * const argv[],
const char *optstring,
const struct option *longopts, int *longindex);
果该字符串里任一字母后有冒号,那么这个选项就要求有参数。下一个参数是指向数组的指针,这个数组是
option结构数组,option结构称为长选项表,其声明如下:
struct option {
const char *name;
int has_arg;
int *flag;
int val;
};
结构中的元素解释如下:
const char *name:选项名,前面没有短横线。譬如"help"、"verbose"之类。
int has_arg:描述长选项是否有选项参数,如果有,是哪种类型的参数,其值见下表:
符号常量 数值 含义
no_argument 0 选项没有参数
required_argument 1 选项需要参数
optional_argument 2 选项参数是可选的
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()函数,其中,后者的长选项字串是以一个短横线开始的
,而非一对短横线。最后说说getopt_long_only函数,它与getopt_long函数使用相同的参数表,在功能上基本一致,只是getopt_long只将--name当作长参数,但getopt_long_only会将--name和-name两种选项都当作长参数来匹配。在getopt_long在遇到-name时,会拆解成-n -a -m -e到optstring中进行匹配,而getopt_long_only只在-name不能在longopts中匹配时才将其拆解成-n -a -m -e这样的参数到optstring中进行匹配。
四、 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)会指向第一个‘非选项’的位置
- #include <unistd.h>
- #include <stdlib.h>
- #include <stdio.h>
- #include <getopt.h>
- int
- main(int argc, char **argv)
- {
- int opt;
- int digit_optind = 0;
- int option_index = 0;
- char *optstring = "a:b:c:d";
- static struct option long_options[] = {
- {"reqarg", required_argument, NULL, 'r'},
- {"noarg", no_argument, NULL, 'n'},
- {"optarg", optional_argument, NULL, 'o'},
- {0, 0, 0, 0}
- };
- while ( (opt = getopt_long(argc, argv, optstring, long_options, &option_index)) != -1)
- {
- printf("opt = %c\n", opt);
- printf("optarg = %s\n", optarg);
- printf("optind = %d\n", optind);
- printf("argv[optind - 1] = %s\n", argv[optind - 1]);
- printf("option_index = %d\n", option_index);
- }
- return 0;
- }
编译运行以上程序并运行,可以得到以下结果:
- cashey@ubuntu:~/Desktop/getopt$ ./test_getopt_long -a 100 --reqarg 100 --nonarg
- opt = a
- optarg = 100
- optind = 3
- argv[optind - 1] = 100
- option_index = 0
- opt = r
- optarg = 100
- optind = 5
- argv[optind - 1] = 100
- option_index = 0
- ./test_getopt_long: unrecognized option '--nonarg'
- opt = ?
- optarg = (null)
- optind = 6
- argv[optind - 1] = --nonarg
- option_index = 0
当所给的参数存在问题时,opt(即函数返回值是'?'),如:
- cashey@ubuntu:~/Desktop/getopt$ ./test_getopt_long -a
- ./test_getopt_long: option requires an argument -- 'a'
- opt = ?
- optarg = (null)
- optind = 2
- argv[optind - 1] = -a
- option_index = 0
- cashey@ubuntu:~/Desktop/getopt$ ./test_getopt_long --reqarg
- ./test_getopt_long: option '--reqarg' requires an argument
- opt = ?
- optarg = (null)
- optind = 2
- argv[optind - 1] = --reqarg
=== Questions ===
1、如何在getopt中指定可选参数
2、能否实现使用一个选项带多个参数,例如 scanner -i 1.1.1.1 2.2.2.2 3.3.3.3