在C程序中,getopt_long()支持长选项的命令行解析,是C程序在命令场景下的必须掌握函数之一.
函数原型如下:
#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);
在.h文件中,需引入 getopt.h
文件
Linux 命令行约定:
几乎所有的GNU/Linux程序都遵循一些命令行参数定义的约定。程序希望出现的参数可以分成两种:选项(options or flags)、其他类型的的参数。Options修饰了程序运行的方式,其他类型的参数则提供了输入(例如,输入文件的名称)。
对于options类型参数可以有两种方式:
短选项(short options):顾名思义,就是短小参数。它们通常包含一个连字号和一个字母(大写
或小写字母)。例如:-s,-h等。长选项(long options):长选项,包含了两个连字号和一些大小写字母组成的单词。例如,
--size
,--help
等。
NOTE:一个程序通常会提供包括short options和long options两种参数形式的参数。
使用方法
使用前准备两种数据结构
字符指针型变量
该数据结构包括了所有要定义的短选项,每一个选项都只用单个字母表示。如果该选项需要参数(如,需要文件路径等),则其后跟一个冒号。例如,三个短选项分别为‘-f’‘-r’‘-u’,其中-u需要参数,其他两个不需要参数。那么,我们可以将数据结构定义成如下形式:
// 长短参数需对应
const char const *short_option = "fru:";
struct option 类型数组
该数据结构中的每个元素对应了一个长选项,并且每个元素是由四个域组成。通常情况下,可以按以下规则使用。
- 第一个元素,描述长选项的名称;
- 第二个选项,代表该选项是否需要跟着参数,需要参数则为1,反之为0;
- 第三个选项,可以赋为NULL;
- 第四个选项,是该长选项对应的短选项名称。
另外,数据结构的最后一个元素,要求所有域的内容均为0,即{NULL,0,NULL,0}
。下面举例说明,还是按照短选项为‘-r’‘-u’
‘-v’的例子,该数据结构可以定义成如下形式:
const struct option long_option[] =
{
"force", 0, NULL, 'f',
"retry", 0, NULL, 'r',
"url", 1, NULL, 'u',
NULL, 0, NULL, 0,
};
调用方法
参照(1)准备的两个数据结构,则调用方式可为:
getopt_long( argc, argv, short_options, long_options, NULL);
几种常见返回值
每次调用该函数,它都会分析一个选项,并且返回它的短选项,如果分析完毕,即已经没有选项了,则会返回-1。
如果
getopt_long()
在分析选项时,遇到一个没有定义过的选项,则返回值为‘?’,此时,程序员可以打印出所定义命令行的使用信息给用户。当处理一个带参数的选项时,全局变量optarg会指向它的参数
当函数分析完所有参数时,全局变量optind(into argv)会指向第一个‘非选项’的位置
完整demo
httpc.h中
//
// Created by yangtianrui on 17-4-4.
//
#ifndef CINHTTPDEMO_HTTPC_H
#define CINHTTPDEMO_HTTPC_H
#include <stdio.h>
#include <getopt.h>
// 长短参数需对应
const char const *short_option = "fru:";
const struct option long_option[] =
{
"force", 0, NULL, 'f',
"retry", 0, NULL, 'r',
"url", 1, NULL, 'u',
NULL, 0, NULL, 0,
};
#endif //CINHTTPDEMO_HTTPC_H
httpc.c中
//
// Created by yangtianrui on 17-4-4.
//
#include "httpc.h"
/*
* @params argc 参数个数,初始是1.
* @params *argv[] 参数列表, 第一个参数是文件路径和文件名
* 此处传入的参数为 -f -r -u baidu.com
*/
int main(int argc, char *argv[])
{
// argv 第一个参数时文件路径和文件名, 默认会会有一个参数
///home/yangtianrui/.CLion2016.1/system/cmake/generated/CInHttpDemo-811edc10/811edc10/Debug/CInHttpDemoHello
//printf("%s", argv[0]);
// 接收两个参数演示
printf("argc=%d, argv[1]=%s\n", argc, *(argv + 1));
//argc=2, argv[1]=sectond_params
char *opt;
int idx;
while ((idx = getopt_long(argc, argv, short_option, long_option, NULL)) != EOF) {
switch (idx) {
case 'f':
printf("First force params. \n");
break;
case 'r':
printf("Second Reload params. \n");
break;
case 'u':
// 获取接收的参数
opt = optarg;
printf("url is %s! \n", opt);
break;
default:
break;
}
}
}
运行结果
// 传入的参数为 -f -r -u baidu.com
argc=5, argv[1]=-f
First force params.
Second Reload params.
url is baidu.com!