getopt函数

比眉伴天荒 2023-11-12 06:01 131阅读 0赞

一、使用

1、getopt()函数的出处就是unistd.h头文件

2、函数原型：

int getopt(int argc,char \* const argv\[ \],const char \* optstring);//optstring是选项字符串

getopt函数的参数：

参数argc和argv：通常是从main的参数直接传递而来，argc是参数的数量，argv是一个常量字符串数组的地址。  
参数optstring：一个包含正确选项字符的字符串，如果一个字符后面有冒号，那么这个选项在传递参数时就需要跟着一个参数。  
外部变量：

char \*optarg：如果有参数，则包含当前选项参数字符串  
int optind：argv的当前索引值。当getopt函数在while循环中使用时，剩下的字符串为操作数，下标从optind到argc-1。  
int opterr：这个变量非零时，getopt()函数为“无效选项”和“缺少参数选项，并输出其错误信息。  
int optopt：当发现无效选项字符之时，getopt()函数或返回 \\’ ? \\’ 字符，或返回字符 \\’ : \\’ ，并且optopt包含了所发现的无效选项字符。

4、问题解释

问题1：选项到底是个什么鬼？

在linux下大家都用过这样一条指令吧：gcc helloworld.c -o helloworld.out; 这条指令中的-o就是命令行的选项，而后面的helloworld.out就是-o选项所携带的参数。当然熟悉shell指令的人都知道（虽然我并不熟悉）,有些选项是不用带参数的，而这样不带参数的选项可以写在一起（这一点在后面的例子中会用到，希望理解），比如说有两个选项-c和-d，这两个选项都不带参数（而且明显是好基友）,那么他们是可以写在一起，写成-cd的。实际的例子：当我们删除一个文件夹时可以使用指令 rm 目录名 -rf，本来-r表示递归删除，就是删除文件夹中所有的东西，-f表示不提示就立刻删除，他们两个都不带参数，这时他们就可以写在一起。

问题2:选项字符串又是何方神圣？

还是看个例子吧

"a:b:cd::e"，这就是一个选项字符串。对应到命令行就是-a ,-b ,-c ,-d, -e 。冒号又是什么呢？ 冒号表示参数，一个冒号就表示这个选项后面必须带有参数（没有带参数会报错哦），但是这个参数可以和选项连在一起写，也可以用空格隔开，比如-a123 和-a 123（中间有空格） 都表示123是-a的参数；两个冒号的就表示这个选项的参数是可选的，即可以有参数，也可以没有参数，但要注意有参数时，参数与选项之间不能有空格（有空格会报错的哦），这一点和一个冒号时是有区别的。

二、实例

#include <stdio.h>
    #include <string.h>
    #include <stdlib.h>
    #include <unistd.h>
    
    int main(int argc, char *argv[])
    {
        int flags = 0, opt;
        int nsecs = 0, tfnd = 0;
    
        while((opt = getopt(argc, argv, "nt:")) != -1) {
                switch (opt) {
                    case 'n':
                        flags = 1;
                        break;
                    case 't':
                        nsecs = atoi(optarg);
                        tfnd = 1;
                        break;
                    default:
                        printf("optopt = %c\n", (char)optopt);
                        printf("opterr = %d\n", opterr);
                        fprintf(stderr, "usage: %s [-t nsecs] [-n] name\n", argv[0]);
                       exit(EXIT_FAILURE);
                } 
        }
        printf("flags = %d; tfnd = %d; nsecs = %d; optind = %d\n", flags, tfnd, nsecs, optind);
    
        printf("optind = %d\n", optind);
        printf("argc = %d\n", argc);
    #if 1 
        if(optind >= argc) {
            fprintf(stderr, "Expected argument after options\n"); 
            exit(1);
        }
    #endif
        printf("name argument = %s\n", argv[optind]);
        /* Other code omitted */
        return 0;
    }

运行结果：

➜ test ./a.out -a name //首先 -a 是一个非法的选项  
./a.out: invalid option -- 'a' //输出错误信息，因为非法选项  
optind = 2 //此时argv\[optind\]是我们的操作数，也就是我们传递给主函数的参数  
optopt = a //当发现无效项字符时，optopt会包含该字符，正如我们传递的‘a’这个无效项。  
opterr = 1 //opterr变量非零，getopt()函数为“无效选项”和“缺少参数选项，并输出其错误信息。  
usage: ./a.out \[-t nsecs\] \[-n\] name  
  
再次运行：

➜ test ./a.out -t //根据getopt函数的第三个参数，因为‘t’字符后有‘:’冒号，因此在‘-t’选项后需要跟随一个参数。因此此次运行的错误为“缺少参数”，如下提示：  
./a.out: option requires an argument -- 't' //输出了错误信息，因为“缺少参数”  
optind = 2 //argv\[optind\]为空，因为此次运行没有传递参数  
optopt = t //当发现无效项字符时，optopt会包含该字符，正如我们传递的‘t’缺少参数的选项。  
opterr = 1 //opterr变量非零，getopt()函数为“无效选项”和“缺少参数“选项，并输出其错误信息。  
usage: ./a.out \[-t nsecs\] \[-n\] name  
  
再次运行：

➜ test ./a.out -t 123 -n //此时，根据字符串”-nt:“应该得知，-t 后应加参数，-n不用加  
flags = 1; tfnd = 1; nsecs = 123; optind = 4 //在switch语句中将flags=1，tfnd=1，因为optarg变量保存这当前选项参数的字符串，因此此时optarg保存的是‘-t’参数的参数并用atoi函数转称整数，因此nsecs=123。  
optind = 4 //argv\[optind\]为空，因为没有向主函数传递参数  
argc = 4 //一共四个字符串  
Expected argument after options //该程序希望我们至少传递一个参数，因此在if语句中退出。  
  
再次运行：

➜ test ./a.out -t 123 -n hello //‘-t’后加参数，‘-n’不用加，向main函数传递参数叫hello  
flags = 1; tfnd = 1; nsecs = 123; optind = 4  
optind = 4 //argv\[optind\] = ”hello“  
argc = 5 //五个字符串  
name argument = hello //打印参数name argument= hello  
  
其实可以传递多个参数（如果需要，因为此函数只打印第一个参数），例如：

➜ test ./a.out -t 123 -n hello world hello C  
optind = 3  
optind = 4  
flags = 1; tfnd = 1; nsecs = 123; optind = 4  
optind = 4  
argc = 8  
name argument = hello