linux 中解析命令行参数 (getopt_long用法)

来源:互联网 发布:mysql 基数低 不走索引 编辑:程序博客网 时间:2024/06/06 20:11

getopt_long支持长选项的命令行解析,使用man getopt_long,得到其声明如下:

#include <getopt.h>       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_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()函数,其中,后者的长选项字串是以一个短横线开始的

,而非一对短横线。

Linux 命令行约定:
几乎所有的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)会指向第一个‘非选项’的位置

实践小例子:

[c-sharp] view plain copy #include <stdio.h>  #include <getopt.h>  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!

————————————————————————》
getopt_long, getopt_long_only – 命令行解析函数,支持长选项解析

【说明】getopt_long/getopt_long_only是getopt的泛集,getopt是getopt_long的一个子集,getopt支持的所有特性,getopt_long都支持,包括错误打印、argv元素顺序调整等;getopt_long相比getopt增加了长选项的解析,具体如下:

1、形如:cmd [–create][–file] //对长选项的解析;

2、形如:cmd [–create a_argument][-file b_argument] //对长选项及长选项的参数解析;

3、形如:cmd [–create [a_argument]] //选项create的参数也是可选的情况解析

getopt_long_only与getopt_long的区别在于:getopt_long仅仅只能将”–”开始的选项视为长选项,但getopt_long_only将”-“开头选项也会视为长选项,当长选项列表均不满足时,且短选项满足时,”-“才会解析为短选项;

原型:

#define _GNU_SOURCE#include <getopt.h>extern char *optarg;extern int optind, opterr, optopt;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);
1、注意相比getopt,使用getopt_long需要加头文件<getopt.h>;2、getopt_long除了会接受长选项,其他概念和getopt是一样的;3、如果使用getopt_long想只接受短选项,设置longopts为NULL即可;如果只想接受长选项,相应地设置optstring为NULL即可;4、长选项名是可以使用缩写方式,比如:选项有--file\--create,那么输入--c/--cr/--cre等均会被正确识别为create选项;5、对于带参数的长选项格式是:--arg=param或--arg param;6、longopts是指向struct option数组的第一个元素的指针,struct option定义在<getopt.h>中;7、longindex如果非NULL,则是返回识别到struct option数组中元素的位置指针;

struct option的说明:
/*
name: 长选项名

has_arg: 是否带参数或可选参数,这个值在getopt.h中有宏定义,如下:

 # define no_argument        0 # define required_argument  1 # define optional_argument  2

flag: 确定函数返回值的情况,如果flag==NULL,则识别选项后返回val(常用的如:设置val为长命令的短命令字符);否则,识别后getopt_long返回0,flag指向一个设置到val的变量;

val: 设置为返回值,或者是flag指向的变量;这里要注意不要写-1到val,否则其作用是getopt_long返回-1,然后停止解析选项;

[注意] longopts的最后一个元素必须是全0填充,否则会报段错误

*/

struct option {    const char *name;     int has_arg;      int *flag;    int val;};
返回值:1、如果识别短选项,同getopt一样返回短选项字符;2、如果识别长选项,根据flag的设置返回不同的内容,一般flag都设置为NULL,返回val;3、如果发生错误,如:未识别选项或者必须加参数的选项丢失参数,返回'?',如果在optstring中设置了第一个字符为':',丢失参数返回':',这个同getopt返回时一样的;4、当缩写长选项引起歧义时或者不需要的选项强加了参数,都会返回'?';5、返回-1表示选项处理全部结束;6、如果在输入的argv[]中包含了独立的"--"字符串,同getopt一样,解析到这里返回-1,停止选项的解析;

测试实例:

#include <stdio.h>#include <stdlib.h>#include <getopt.h>int main(int argc, char **argv){        extern char *optarg;        extern int optind, opterr, optopt;        int c;        int digit_optind = 0;        while (1)        {                int this_option_optind= optind ? optind : 1;                int option_index = 0;                static struct option long_options[] =                {                        {"add", required_argument, NULL, 0},                        {"append", no_argument, NULL, 0},                        {"delete", required_argument, NULL, 0},                        {"verbose", no_argument, NULL, 0},                        {"create", required_argument, NULL, 'c'},                        {"file", required_argument, NULL, 0},                        {0, 0, 0, 0},                };                c = getopt_long(argc, argv, ":abc:d:012", long_options, &option_index);                if (c == -1)                        break;                switch (c)                {                        case 0:                                printf ("option %s", long_options[option_index].name);                                if (optarg)                                        printf (" with arg %s", optarg);                                printf ("\n");                                break;                        case '0':                        case '1':                        case '2':                                if (digit_optind != 0 && digit_optind != this_option_optind)                                        printf ("digits occur in two different argv-elements.\n");                                digit_optind = this_option_optind;                                printf ("option %c\n", c);                                break;                        case 'a':                                printf ("option a\n");                                break;                        case 'b':                                printf ("option b\n");                                break;                        case 'c':                                printf ("option c with value \"%s\"\n", optarg);                                break;                        case 'd':                                printf ("option d with value \"%s\"\n", optarg);                                break;                        case '?':                                break;                        default:                                printf ("?? getopt returned character code 0%o ??\n", c);                }        }        if (optind < argc) {                 printf ("non-option ARGV-elements: ");                 while (optind < argc)                          printf ("%s ", argv[optind++]);                 printf ("\n");         }        exit(0);}
阅读全文
1 0