Linux-C getopt命令行参数解析

墨蓝 2022-12-25 00:56 195阅读 0赞

###                                                                                                                       Linux-C getopt命令行参数解析 ###

### **一、简述** ###

记--C语言 使用getopt()、getopt\_long()解析命令行参数，有时候需要在调用应用程序时传入不同的参数来实现不同版本效果，比如新旧版本兼容，设置调试等级，还可以在使用程序前查看程序使用方法，查看程序版本、查看程序编译时间等。。。

### **二、getopt()** ###

2.1 **getopt**函数说明

<table> 
 <tbody> 
 <tr> 
 <td>功能</td> 
 <td colspan="4">用来解析命令行参数、命令行选项</td> 
 </tr> 
 <tr> 
 <td colspan="1">头文件</td> 
 <td colspan="4">#include &lt;unistd.h&gt;</td> 
 </tr> 
 <tr> 
 <td colspan="1">原型</td> 
 <td colspan="4">int getopt(int argc, char * const argv[],&nbsp;const char *optstring);</td> 
 </tr> 
 <tr> 
 <td colspan="1">参数</td> 
 <td>argc</td> 
 <td colspan="3">main函数的argc，参数个数</td> 
 </tr> 
 <tr> 
 <td colspan="1">argv</td> 
 <td colspan="3">main函数的argv，实际命令行参数</td> 
 </tr> 
 <tr> 
 <td>optstring</td> 
 <td colspan="3">要解析的选项 "a:b:c:d" 表示解析-a -b -c -d 后面有一个冒号的表示附带参数，比如-a 100表示-a选项参数时100</td> 
 </tr> 
 <tr> 
 <td colspan="1">返回值</td> 
 <td colspan="4"> 如果成功找到optstring中的选项，则返回选项字符。如果所有命令行选项都已解析完成，则返回-1。如果解析到一个选项 不在optstring中的字符，会返回'?'。如果遇到缺少参数的选项，则返回值取决于optstring中的第一个字符：如果是 ':'，则返回':'；否则返回'?'。 </td> 
 </tr> 
 <tr> 
 <td colspan="1">说明</td> 
 <td colspan="4">更多请查看man手册，man 3 getopt</td> 
 </tr> 
 </tbody> 
</table>

2.2 函数使用例子

测试代码：

#include <unistd.h>
 #include <stdio.h>
 
 extern char *optarg;
 extern int optind, opterr, optopt;
 	 
 void printUsage()
 {
 	printf("getopt_test - V0.0.1 Complile at %s %s\r\n", __DATE__, __TIME__);
 	printf("usage: getopt_test [arguments]\r\n");
 	printf("arguments:\r\n");
 	printf("\t-a\r\n");
 	printf("\t-b\r\n");
 	printf("\t-c\r\n");
 	printf("\t-d\r\n");
 	printf("\t-h \tPrint Help (this message) and exit\r\n");
 	printf("\t-v \tPrint Version Information\r\n");
 }	
 	 
 void printVersion()
 {
 	printf("getopt_test\r\n");
 	printf("version:V0.0.1\r\n");
 	printf("date:%s\r\n", __DATE__);
 } 
 	 
 int main(int argc, char * argv[])
 { 
 int opt;
 	const char *optstring = "a:bc:hv"; //-a 100 -b -c 200//a、c后面带一个参数说明要带参数, b后面没有冒号说明不带参数，
 printf("optind:%d，opterr：%d\r\n", optind, opterr);//在unistd.h
 	printf("===========================================\r\n");
 	while (-1 != (opt = getopt(argc, argv, optstring))) {
 		printf("optind:%d.\r\n", optind);
 		switch (opt) {
 			case 'a':
 				printf("option: -%c, optarg: %s\r\n", opt, optarg);
 				break;
 			case 'b':
 				printf("option: -%c\r\n", opt);
 				break;
 			case 'c':
 				printf("option: -%c, optarg: %s\r\n", opt, optarg);
 				break;
 			case 'h':
 				printUsage();
 				break;
 			case 'v':
 				printVersion();
 				break;
 			case '?'://未定义参数项
 				printf("arg err:\r\n");
 				printf("Try 'getopt_test -h' for more information.\r\n");
 				break;
 			default:
 				printf("getopt_test: invalid option -- '%c'\r\n", opt);
 				printf("Try 'getopt_test -h' for more information.\r\n");
 				break;
 		}
 	}
 	printf("===========================================\r\n");
 	return 0;
 }

测试结果：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L25hbmZlaWJ1eWk_size_16_color_FFFFFF_t_70][]

### 三、getopt\_long ###

getopt\_long()函数既可以使用短参数也可以使用长参数。

3.1 **getopt\_long**函数说明

<table> 
 <tbody> 
 <tr> 
 <td>功能</td> 
 <td colspan="5">用来解析命令行参数、命令行选项</td> 
 </tr> 
 <tr> 
 <td colspan="1">头文件</td> 
 <td colspan="5">#include &lt;getopt.h&gt;</td> 
 </tr> 
 <tr> 
 <td colspan="1">原型</td> 
 <td colspan="5">int getopt_long(int argc, char * const argv[], &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; const char *optstring, &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; const struct option *longopts, int *longindex);</td> 
 </tr> 
 <tr> 
 <td colspan="1">参数</td> 
 <td style="width:89px;">argc</td> 
 <td>main函数的argc，参数个数</td> 
 </tr> 
 <tr> 
 <td>argv</td> 
 <td>main函数的argv，实际命令行参数</td> 
 </tr> 
 <tr> 
 <td>optstring</td> 
 <td>要解析的选项 "a:b:c:d" 表示解析-a -b -c -d 后面有一个冒号的表示附带参数，比如-a 100表示-a选项参数时100</td> 
 </tr> 
 <tr> 
 <td>longopts</td> 
 <td> 前面带两个'-'的长参数，如--help struct option { &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;const char *name;//表示参数项名称 &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;int &nbsp; &nbsp; &nbsp; &nbsp; has_arg;//标识参数项是否带参数，0：不带参数 1：带参数&nbsp; 2：参数可选&nbsp; &nbsp; （对应no_argument、required_argument、optional_argument） &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;int &nbsp; &nbsp; &nbsp; &nbsp;*flag;//指示getopt_long()的返回值，如果设置为NULL，那么getopt_long返回val，如果是可用的地址，那么将val填充到该地址。 &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;int &nbsp; &nbsp; &nbsp; &nbsp; val;//getopt_long的返回值，或者是填充到flag指向的地址。 &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;}; </td> 
 </tr> 
 <tr> 
 <td colspan="1">返回值</td> 
 <td colspan="5"> 当识别到短选项时，getopt_long()返回对应的选项字符。对于长选项，如果flag为NULL，则返回val，否则返回0。错误返回-1，未知参数返回? </td> 
 </tr> 
 <tr> 
 <td colspan="1">说明</td> 
 <td colspan="5">更多请查看man手册，man 3 getopt_long</td> 
 </tr> 
 </tbody> 
</table>

3.2 **getopt\_long**函数使用例子

测试代码：

#include <unistd.h>
 #include <stdio.h>
 #include <getopt.h>//getopt_long
 
 extern char *optarg;
 extern int optind, opterr, optopt;
 	 
 void printUsage()
 {
 	printf("getopt_test - V0.0.1 Complile at %s %s\r\n", __DATE__, __TIME__);
 	printf("usage: getopt_test [arguments]\r\n");
 	printf("arguments:\r\n");
 	printf("\t-a or --add \r\n");
 	printf("\t-h or --help \tPrint Help (this message) and exit\r\n");
 	printf("\t-v or --version\tPrint Version Information\r\n");
 }	
 	 
 void printVersion()
 {
 	printf("getopt_test\r\n");
 	printf("version:V0.0.1\r\n");
 	printf("date:%s\r\n", __DATE__);
 } 
 	 
 int main(int argc, char * argv[])
 { 
 int opt;
 	const char *short_options = "a:hv";
 	int option_index = 0;
 	struct option long_options[] = {
 		{"add", 	 required_argument, 0, 'a' },
 		{"help", 	 no_argument, 0, 'h' },
 		{"version", no_argument,		0, 'v' },
 		{0, 	 0, 0, 0 }
 };
 	while (-1 != (opt = getopt_long(argc, argv, short_options, long_options, &option_index))) {
 		switch (opt) {
 			case 'a':
 				printf("option: -%c, optarg: %s\r\n", opt, optarg);
 				break;
 			case 'h':
 				printUsage();
 				break;
 			case 'v':
 				printVersion();
 				break;
 			case '?'://未定义参数项
 				printf("arg err:\r\n");
 				printf("Try 'getopt_test -h' for more information.\r\n");
 				break;
 			default:
 				printf("getopt_test: invalid option -- '%c'\r\n", opt);
 				printf("Try 'getopt_test -h' for more information.\r\n");
 				break;
 		}
 	}
 	return 0;
 }

测试结果：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L25hbmZlaWJ1eWk_size_16_color_FFFFFF_t_70 1][]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L25hbmZlaWJ1eWk_size_16_color_FFFFFF_t_70]: /images/20221120/cbc5b7133175480ea677e7a6a2dbff6b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L25hbmZlaWJ1eWk_size_16_color_FFFFFF_t_70 1]: /images/20221120/6131974793d64ed980c9c451d13680b6.png