|
|
51CTO旗下网站
|
|
移动端

如何写好C main函数?

学习如何构造一个 C 文件并编写一个 C main 函数来成功地处理命令行参数。

作者:Erik O'shaughnessy来源:Linux中国|2019-06-10 19:00

如何写好C main函数?

学习如何构造一个 C 文件并编写一个 C main 函数来成功地处理命令行参数。

我知道,现在孩子们用 Python 和 JavaScript 编写他们的疯狂“应用程序”。但是不要这么快就否定 C 语言 —— 它能够提供很多东西,并且简洁。如果你需要速度,用 C 语言编写可能就是你的答案。如果你正在寻找稳定的职业或者想学习如何捕获空指针解引用,C 语言也可能是你的答案!在本文中,我将解释如何构造一个 C 文件并编写一个 C main 函数来成功地处理命令行参数。

我:一个顽固的 Unix 系统程序员。

你:一个有编辑器、C 编译器,并有时间打发的人。

让我们开工吧。

一个无聊但正确的 C 程序

Parody O'Reilly book cover, "Hating Other People's Code"

Parody O'Reilly book cover, "Hating Other People's Code"

C 程序以 main() 函数开头,通常保存在名为 main.c 的文件中。

  1. /* main.c */
  2. int main(int argc, char *argv[]) {
  3.  
  4. }

这个程序可以编译但不任何事。

  1. $ gcc main.c
  2. $ ./a.out -o foo -vv
  3. $

正确但无聊。

main 函数是唯一的。

main() 函数是开始执行时所执行的程序的第一个函数,但不是第一个执行的函数。第一个函数是 _start(),它通常由 C 运行库提供,在编译程序时自动链入。此细节高度依赖于操作系统和编译器工具链,所以我假装没有提到它。

main() 函数有两个参数,通常称为 argcargv,并返回一个有符号整数。大多数 Unix 环境都希望程序在成功时返回 0(零),失败时返回 -1(负一)。

参数 名称 描述
argc 参数个数 参数向量的个数
argv 参数向量 字符指针数组

参数向量 argv 是调用你的程序的命令行的标记化表示形式。在上面的例子中,argv 将是以下字符串的列表:

  1. argv = [ "/path/to/a.out", "-o", "foo", "-vv" ];

参数向量在其第一个索引 argv[0] 中确保至少会有一个字符串,这是执行程序的完整路径。

main.c 文件的剖析

当我从头开始编写 main.c 时,它的结构通常如下:

  1. /* main.c */
  2. /* 0 版权/许可证 */
  3. /* 1 包含 */
  4. /* 2 定义 */
  5. /* 3 外部声明 */
  6. /* 4 类型定义 */
  7. /* 5 全局变量声明 */
  8. /* 6 函数原型 */
  9.  
  10. int main(int argc, char *argv[]) {
  11. /* 7 命令行解析 */
  12. }
  13.  
  14. /* 8 函数声明 */

下面我将讨论这些编号的各个部分,除了编号为 0 的那部分。如果你必须把版权或许可文本放在源代码中,那就放在那里。

另一件我不想讨论的事情是注释。

  1. “评论谎言。”
  2. - 一个愤世嫉俗但聪明又好看的程序员。

与其使用注释,不如使用有意义的函数名和变量名。

鉴于程序员固有的惰性,一旦添加了注释,维护负担就会增加一倍。如果更改或重构代码,则需要更新或扩充注释。随着时间的推移,代码会变得面目全非,与注释所描述的内容完全不同。

如果你必须写注释,不要写关于代码正在做什么,相反,写下代码为什么要这样写。写一些你将要在五年后读到的注释,那时你已经将这段代码忘得一干二净。世界的命运取决于你。不要有压力。

1、包含

我添加到 main.c 文件的第一个东西是包含文件,它们为程序提供大量标准 C 标准库函数和变量。C 标准库做了很多事情。浏览 /usr/include 中的头文件,你可以了解到它们可以做些什么。

#include 字符串是 C 预处理程序(cpp)指令,它会将引用的文件完整地包含在当前文件中。C 中的头文件通常以 .h 扩展名命名,且不应包含任何可执行代码。它只有宏、定义、类型定义、外部变量和函数原型。字符串 <header.h> 告诉 cpp 在系统定义的头文件路径中查找名为 header.h 的文件,它通常在 /usr/include 目录中。

  1. /* main.c */
  2. #include <stdio.h>
  3. #include <stdlib.h>
  4. #include <unistd.h>
  5. #include <libgen.h>
  6. #include <errno.h>
  7. #include <string.h>
  8. #include <getopt.h>
  9. #include <sys/types.h>

这是我默认会全局包含的最小包含集合,它将引入:

#include 文件 提供的东西
stdio 提供 FILEstdinstdoutstderrfprint() 函数系列
stdlib 提供 malloc()calloc()realloc()
unistd 提供 EXIT_FAILUREEXIT_SUCCESS
libgen 提供 basename() 函数
errno 定义外部 errno 变量及其可以接受的所有值
string 提供 memcpy()memset()strlen() 函数系列
getopt 提供外部 optargopterroptindgetopt() 函数
sys/types 类型定义快捷方式,如 uint32_tuint64_t

2、定义

  1. /* main.c */
  2. <...>
  3.  
  4. #define OPTSTR "vi:o:f:h"
  5. #define USAGE_FMT "%s [-v] [-f hexflag] [-i inputfile] [-o outputfile] [-h]"
  6. #define ERR_FOPEN_INPUT "fopen(input, r)"
  7. #define ERR_FOPEN_OUTPUT "fopen(output, w)"
  8. #define ERR_DO_THE_NEEDFUL "do_the_needful blew up"
  9. #define DEFAULT_PROGNAME "george"

这在现在没有多大意义,但 OPTSTR 定义我这里会说明一下,它是程序推荐的命令行开关。参考 getopt(3) man 页面,了解 OPTSTR 将如何影响 getopt() 的行为。

USAGE_FMT 定义了一个 printf() 风格的格式字符串,它用在 usage() 函数中。

我还喜欢将字符串常量放在文件的 #define 这一部分。如果需要,把它们收集在一起可以更容易地修正拼写、重用消息和国际化消息。

最后,在命名 #define 时全部使用大写字母,以区别变量和函数名。如果需要,可以将单词放连在一起或使用下划线分隔,只要确保它们都是大写的就行。

3、外部声明

  1. /* main.c */
  2. <...>
  3.  
  4. extern int errno;
  5. extern char *optarg;
  6. extern int opterr, optind;

extern 声明将该名称带入当前编译单元的命名空间(即 “文件”),并允许程序访问该变量。这里我们引入了三个整数变量和一个字符指针的定义。opt 前缀的几个变量是由 getopt() 函数使用的,C 标准库使用 errno 作为带外通信通道来传达函数可能的失败原因。

4、类型定义

  1. /* main.c */
  2. <...>
  3.  
  4. typedef struct {
  5. int verbose;
  6. uint32_t flags;
  7. FILE *input;
  8. FILE *output;
  9. } options_t;

在外部声明之后,我喜欢为结构、联合和枚举声明 typedef。命名一个 typedef 是一种传统习惯。我非常喜欢使用 _t 后缀来表示该名称是一种类型。在这个例子中,我将 options_t 声明为一个包含 4 个成员的 struct。C 是一种空格无关的编程语言,因此我使用空格将字段名排列在同一列中。我只是喜欢它看起来的样子。对于指针声明,我在名称前面加上星号,以明确它是一个指针。

5、全局变量声明

  1. /* main.c */
  2. <...>
  3.  
  4. int dumb_global_variable = -11;

全局变量是一个坏主意,你永远不应该使用它们。但如果你必须使用全局变量,请在这里声明,并确保给它们一个默认值。说真的,不要使用全局变量

6、函数原型

  1. /* main.c */
  2. <...>
  3.  
  4. void usage(char *progname, int opt);
  5. int do_the_needful(options_t *options);

在编写函数时,将它们添加到 main() 函数之后而不是之前,在这里放函数原型。早期的 C 编译器使用单遍策略,这意味着你在程序中使用的每个符号(变量或函数名称)必须在使用之前声明。现代编译器几乎都是多遍编译器,它们在生成代码之前构建一个完整的符号表,因此并不严格要求使用函数原型。但是,有时你无法选择代码要使用的编译器,所以请编写函数原型并继续这样做下去。

当然,我总是包含一个 usage() 函数,当 main() 函数不理解你从命令行传入的内容时,它会调用这个函数。

7、命令行解析

  1. /* main.c */
  2. <...>
  3.  
  4. int main(int argc, char *argv[]) {
  5. int opt;
  6. options_t options = { 0, 0x0, stdin, stdout };
  7.  
  8. opterr = 0;
  9.  
  10. while ((opt = getopt(argc, argv, OPTSTR)) != EOF)
  11. switch(opt) {
  12. case 'i':
  13. if (!(options.input = fopen(optarg, "r")) ){
  14. perror(ERR_FOPEN_INPUT);
  15. exit(EXIT_FAILURE);
  16. /* NOTREACHED */
  17. }
  18. break;
  19.  
  20. case 'o':
  21. if (!(options.output = fopen(optarg, "w")) ){
  22. perror(ERR_FOPEN_OUTPUT);
  23. exit(EXIT_FAILURE);
  24. /* NOTREACHED */
  25. }
  26. break;
  27. case 'f':
  28. options.flags = (uint32_t )strtoul(optarg, NULL, 16);
  29. break;
  30.  
  31. case 'v':
  32. options.verbose += 1;
  33. break;
  34.  
  35. case 'h':
  36. default:
  37. usage(basename(argv[0]), opt);
  38. /* NOTREACHED */
  39. break;
  40. }
  41.  
  42. if (do_the_needful(&options) != EXIT_SUCCESS) {
  43. perror(ERR_DO_THE_NEEDFUL);
  44. exit(EXIT_FAILURE);
  45. /* NOTREACHED */
  46. }
  47.  
  48. return EXIT_SUCCESS;
  49. }

好吧,代码有点多。这个 main() 函数的目的是收集用户提供的参数,执行最基本的输入验证,然后将收集到的参数传递给使用它们的函数。这个示例声明一个使用默认值初始化的 options 变量,并解析命令行,根据需要更新 options

main() 函数的核心是一个 while 循环,它使用 getopt() 来遍历 argv,寻找命令行选项及其参数(如果有的话)。文件前面定义的 OPTSTR 是驱动 getopt() 行为的模板。opt 变量接受 getopt() 找到的任何命令行选项的字符值,程序对检测命令行选项的响应发生在 switch 语句中。

如果你注意到了可能会问,为什么 opt 被声明为 32 位 int,但是预期是 8 位 char?事实上 getopt() 返回一个 int,当它到达 argv 末尾时取负值,我会使用 EOF文件末尾标记)匹配。char 是有符号的,但我喜欢将变量匹配到它们的函数返回值。

当检测到一个已知的命令行选项时,会发生特定的行为。在 OPTSTR 中指定一个以冒号结尾的参数,这些选项可以有一个参数。当一个选项有一个参数时,argv 中的下一个字符串可以通过外部定义的变量 optarg 提供给程序。我使用 optarg 来打开文件进行读写,或者将命令行参数从字符串转换为整数值。

这里有几个关于代码风格的要点:

  • opterr 初始化为 0,禁止 getopt 触发 ?
  • main() 的中间使用 exit(EXIT_FAILURE);exit(EXIT_SUCCESS);
  • /* NOTREACHED */ 是我喜欢的一个 lint 指令。
  • 在返回 int 类型的函数末尾使用 return EXIT_SUCCESS;
  • 显示强制转换隐式类型。

这个程序的命令行格式,经过编译如下所示:

  1. $ ./a.out -h
  2. a.out [-v] [-f hexflag] [-i inputfile] [-o outputfile] [-h]

事实上,在编译后 usage() 就会向 stderr 发出这样的内容。

8、函数声明

  1. /* main.c */
  2. <...>
  3.  
  4. void usage(char *progname, int opt) {
  5. fprintf(stderr, USAGE_FMT, progname?progname:DEFAULT_PROGNAME);
  6. exit(EXIT_FAILURE);
  7. /* NOTREACHED */
  8. }
  9.  
  10. int do_the_needful(options_t *options) {
  11.  
  12. if (!options) {
  13. errno = EINVAL;
  14. return EXIT_FAILURE;
  15. }
  16.  
  17. if (!options->input || !options->output) {
  18. errno = ENOENT;
  19. return EXIT_FAILURE;
  20. }
  21.  
  22. /* XXX do needful stuff */
  23.  
  24. return EXIT_SUCCESS;
  25. }

我最后编写的函数不是个样板函数。在本例中,函数 do_the_needful() 接受一个指向 options_t 结构的指针。我验证 options 指针不为 NULL,然后继续验证 inputoutput 结构成员。如果其中一个测试失败,返回 EXIT_FAILURE,并且通过将外部全局变量 errno 设置为常规错误代码,我可以告知调用者常规的错误原因。调用者可以使用便捷函数 perror() 来根据 errno 的值发出便于阅读的错误消息。

函数几乎总是以某种方式验证它们的输入。如果完全验证代价很大,那么尝试执行一次并将验证后的数据视为不可变。usage() 函数使用 fprintf() 调用中的条件赋值验证 progname 参数。接下来 usage() 函数就退出了,所以我不会费心设置 errno,也不用操心是否使用正确的程序名。

在这里,我要避免的最大错误是解引用 NULL 指针。这将导致操作系统向我的进程发送一个名为 SYSSEGV 的特殊信号,导致不可避免的死亡。用户最不希望看到的是由 SYSSEGV 而导致的崩溃。最好是捕获 NULL 指针以发出更合适的错误消息并优雅地关闭程序。

有些人抱怨在函数体中有多个 return 语句,他们喋喋不休地说些“控制流的连续性”之类的东西。老实说,如果函数中间出现错误,那就应该返回这个错误条件。写一大堆嵌套的 if 语句只有一个 return 绝不是一个“好主意”™。

最后,如果你编写的函数接受四个以上的参数,请考虑将它们绑定到一个结构中,并传递一个指向该结构的指针。这使得函数签名更简单,更容易记住,并且在以后调用时不会出错。它还可以使调用函数速度稍微快一些,因为需要复制到函数堆栈中的东西更少。在实践中,只有在函数被调用数百万或数十亿次时,才会考虑这个问题。如果认为这没有意义,那也无所谓。

等等,你不是说没有注释吗!?!!

do_the_needful() 函数中,我写了一种特殊类型的注释,它被是作为占位符设计的,而不是为了说明代码:

  1. /* XXX do needful stuff */

当你写到这里时,有时你不想停下来编写一些特别复杂的代码,你会之后再写,而不是现在。那就是我留给自己再次回来的地方。我插入一个带有 XXX 前缀的注释和一个描述需要做什么的简短注释。之后,当我有更多时间的时候,我会在源代码中寻找 XXX。使用什么前缀并不重要,只要确保它不太可能在另一个上下文环境(如函数名或变量)中出现在你代码库里。

把它们组合在一起

好吧,当你编译这个程序后,它仍然几乎没有任何作用。但是现在你有了一个坚实的骨架来构建你自己的命令行解析 C 程序。

  1. /* main.c - the complete listing */
  2.  
  3. #include <stdio.h>
  4. #include <stdlib.h>
  5. #include <unistd.h>
  6. #include <libgen.h>
  7. #include <errno.h>
  8. #include <string.h>
  9. #include <getopt.h>
  10.  
  11. #define OPTSTR "vi:o:f:h"
  12. #define USAGE_FMT "%s [-v] [-f hexflag] [-i inputfile] [-o outputfile] [-h]"
  13. #define ERR_FOPEN_INPUT "fopen(input, r)"
  14. #define ERR_FOPEN_OUTPUT "fopen(output, w)"
  15. #define ERR_DO_THE_NEEDFUL "do_the_needful blew up"
  16. #define DEFAULT_PROGNAME "george"
  17.  
  18. extern int errno;
  19. extern char *optarg;
  20. extern int opterr, optind;
  21.  
  22. typedef struct {
  23. int verbose;
  24. uint32_t flags;
  25. FILE *input;
  26. FILE *output;
  27. } options_t;
  28.  
  29. int dumb_global_variable = -11;
  30.  
  31. void usage(char *progname, int opt);
  32. int do_the_needful(options_t *options);
  33.  
  34. int main(int argc, char *argv[]) {
  35. int opt;
  36. options_t options = { 0, 0x0, stdin, stdout };
  37.  
  38. opterr = 0;
  39.  
  40. while ((opt = getopt(argc, argv, OPTSTR)) != EOF)
  41. switch(opt) {
  42. case 'i':
  43. if (!(options.input = fopen(optarg, "r")) ){
  44. perror(ERR_FOPEN_INPUT);
  45. exit(EXIT_FAILURE);
  46. /* NOTREACHED */
  47. }
  48. break;
  49.  
  50. case 'o':
  51. if (!(options.output = fopen(optarg, "w")) ){
  52. perror(ERR_FOPEN_OUTPUT);
  53. exit(EXIT_FAILURE);
  54. /* NOTREACHED */
  55. }
  56. break;
  57. case 'f':
  58. options.flags = (uint32_t )strtoul(optarg, NULL, 16);
  59. break;
  60.  
  61. case 'v':
  62. options.verbose += 1;
  63. break;
  64.  
  65. case 'h':
  66. default:
  67. usage(basename(argv[0]), opt);
  68. /* NOTREACHED */
  69. break;
  70. }
  71.  
  72. if (do_the_needful(&options) != EXIT_SUCCESS) {
  73. perror(ERR_DO_THE_NEEDFUL);
  74. exit(EXIT_FAILURE);
  75. /* NOTREACHED */
  76. }
  77.  
  78. return EXIT_SUCCESS;
  79. }
  80.  
  81. void usage(char *progname, int opt) {
  82. fprintf(stderr, USAGE_FMT, progname?progname:DEFAULT_PROGNAME);
  83. exit(EXIT_FAILURE);
  84. /* NOTREACHED */
  85. }
  86.  
  87. int do_the_needful(options_t *options) {
  88.  
  89. if (!options) {
  90. errno = EINVAL;
  91. return EXIT_FAILURE;
  92. }
  93.  
  94. if (!options->input || !options->output) {
  95. errno = ENOENT;
  96. return EXIT_FAILURE;
  97. }
  98.  
  99. /* XXX do needful stuff */
  100.  
  101. return EXIT_SUCCESS;
  102. }

现在,你已经准备好编写更易于维护的 C 语言。如果你有任何问题或反馈,请在评论中分享。

【责任编辑:庞桂玉 TEL:(010)68476606】

点赞 0
分享:
大家都在看
猜你喜欢

订阅专栏+更多

WOT2019全球人工智能技术峰会

WOT2019全球人工智能技术峰会

通用技术、应用领域、企业赋能三大章节,13大技术专场,60+国内外一线人工智能精英大咖站台,分享人工智能的平台工具、算法模型、语音视觉等技术主题,助力人工智能落地。
共50章 | WOT峰会

0人订阅学习

Spring Boot 爬虫搜索轻松游

Spring Boot 爬虫搜索轻松游

全栈式开发之旅
共4章 | 美码师

77人订阅学习

Linux性能调优攻略

Linux性能调优攻略

性能调优规范
共15章 | 南非蚂蚁

225人订阅学习

读 书 +更多

网管员必读—网络应用(第2版)

本书虽然是《网管员必读—网络应用》的改版,但它绝不是简单的修改,而是完完全全的重写,内容更实用、更专业。全书共9章,13个大小方案,...

订阅51CTO邮刊

点击这里查看样刊

订阅51CTO邮刊

51CTO服务号

51CTO播客