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

 

我知道,现在孩子们用 Python 和 JavaScript 编写他们的疯狂“应用程序”。但是不要这么快就否定 C 语言 —— 它能够提供很多东西,并且简洁。

如果你需要速度,用 C 语言编写可能就是你的答案。如果你正在寻找稳定的职业或者想学习如何捕获空指针解引用,C 语言也可能是你的答案!在本文中,我将解释如何构造一个 C 文件并编写一个 C main 函数来成功地处理命令行参数。

我:一个顽固的 sd程序员。

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

让我们开工吧。

一个无聊但正确的 C 程序

 

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

/* main.c */

int main(int argc, char *argv[]) {

}

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

$ gcc main.c

$ ./a.out -o foo -vv

$

正确但无聊。

main 函数是唯一的。

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

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

 

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

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

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

main.c 文件的剖析

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

/* main.c */

/* 0 版权/许可证 */

/* 1 包含 */

/* 2 定义 */

/* 3 外部声明 */

/* 4 类型定义 */

/* 5 全局变量声明 */

/* 6 函数原型 */

int main(int argc, char *argv[]) {

/* 7 命令行解析 */

}

/* 8 函数声明 */

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

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

“评论谎言。”

- 一个愤世嫉俗但聪明又好看的程序员。

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

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

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

1、包含

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

#include 字符串是 C 预处理程序(cpp)指令,它会将引用的文件完整地包含在当前文件中。C 中的头文件通常以 .h 扩展名命名,且不应包含任何可执行代码。

它只有宏、定义、类型定义、外部变量和函数原型。字符串 <header.h> 告诉 cpp 在系统定义的头文件路径中查找名为 header.h的文件,它通常在 /usr/include 目录中。

/* main.c */

#include <stdio.h>

#include <stdlib.h>

#include <unistd.h>

#include <libgen.h>

#include <errno.h>

#include <string.h>

#include <getopt.h>

#include <sys/types.h>

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

 

2、定义

/* main.c */

<...>

#define OPTSTR "vi:o:f:h"

#define USAGE_FMT  "%s [-v] [-f hexflag] [-i inputfile] [-o outputfile] [-h]"

#define ERR_FOPEN_INPUT  "fopen(input, r)"

#define ERR_FOPEN_OUTPUT "fopen(output, w)"

#define ERR_DO_THE_NEEDFUL "do_the_needful blew up"

#define DEFAULT_PROGNAME "george"

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

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

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

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

3、外部声明

/* main.c */

<...>

extern int errno;

extern char *optarg;

extern int opterr, optind;

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

4、类型定义

/* main.c */

<...>

typedef struct {

int          verbose;

uint32_t      flags;

FILE        *input;

FILE        *output;

} options_t;

在外部声明之后,我喜欢为结构、联合和枚举声明 typedef。命名一个 typedef 是一种传统习惯。

我非常喜欢使用 _t 后缀来表示该名称是一种类型。在这个例子中,我将 options_t 声明为一个包含 4 个成员的 struct。

C 是一种空格无关的编程语言,因此我使用空格将字段名排列在同一列中。我只是喜欢它看起来的样子。对于指针声明,我在名称前面加上星号,以明确它是一个指针。

5、全局变量声明

/* main.c */

<...>

int dumb_global_variable = -11;

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

6、函数原型

/* main.c */

<...>

void usage(char *progname, int opt);

int do_the_needful(options_t *options);

在编写函数时,将它们添加到 main() 函数之后而不是之前,在这里放函数原型。早期的 C 编译器使用单遍策略,这意味着你在程序中使用的每个符号(变量或函数名称)必须在使用之前声明。

现代编译器几乎都是多遍编译器,它们在生成代码之前构建一个完整的符号表,因此并不严格要求使用函数原型。但是,有时你无法选择代码要使用的编译器,所以请编写函数原型并继续这样做下去。

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

7、命令行解析

/* main.c */

<...>

int main(int argc, char *argv[]) {

int opt;

options_t options = { 0, 0x0, stdin, stdout };

opterr = 0;

while ((opt = getopt(argc, argv, OPTSTR)) != EOF)

switch(opt) {

case 'i':

if (!(options.input = fopen(optarg, "r")) ){

perror(ERR_FOPEN_INPUT);

exit(EXIT_FAILURE);

/* NOTREACHED */

}

break;

case 'o':

if (!(options.output = fopen(optarg, "w")) ){

perror(ERR_FOPEN_OUTPUT);

exit(EXIT_FAILURE);

/* NOTREACHED */

}

break;

case 'f':

options.flags = (uint32_t )strtoul(optarg, NULL, 16);

break;

case 'v':

options.verbose += 1;

break;

case 'h':

default:

usage(basename(argv[0]), opt);

/* NOTREACHED */

break;

}

if (do_the_needful(&options) != EXIT_SUCCESS) {

perror(ERR_DO_THE_NEEDFUL);

exit(EXIT_FAILURE);

/* NOTREACHED */

}

return EXIT_SUCCESS;

}

好吧,代码有点多。这个 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;。

♜  显示强制转换隐式类型。

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

$ ./a.out -h

a.out [-v] [-f hexflag] [-i inputfile] [-o outputfile] [-h]

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

8、函数声明

/* main.c */

<...>

void usage(char *progname, int opt) {

fprintf(stderr, USAGE_FMT, progname?progname:DEFAULT_PROGNAME);

exit(EXIT_FAILURE);

/* NOTREACHED */

}

int do_the_needful(options_t *options) {

if (!options) {

errno = EINVAL;

return EXIT_FAILURE;

}

if (!options->input || !options->output) {

errno = ENOENT;

return EXIT_FAILURE;

}

/* XXX do needful stuff */

return EXIT_SUCCESS;

}

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

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

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

最后,如果你编写的函数接受四个以上的参数,请考虑将它们绑定到一个结构中,并传递一个指向该结构的指针。

这使得函数签名更简单,更容易记住,并且在以后调用时不会出错。它还可以使调用函数速度稍微快一些,因为需要复制到函数堆栈中的东西更少。在实践中,只有在函数被调用数百万或数十亿次时,才会考虑这个问题。如果认为这没有意义,那也无所谓。

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

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

/* XXX do needful stuff */

当你写到这里时,有时你不想停下来编写一些特别复杂的代码,你会之后再写,而不是现在。

那就是我留给自己再次回来的地方。我插入一个带有 XXX 前缀的注释和一个描述需要做什么的简短注释。

之后,当我有更多时间的时候,我会在源代码中寻找 XXX。使用什么前缀并不重要,只要确保它不太可能在另一个上下文环境(如函数名或变量)中出现在你代码库里。

把它们组合在一起

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

/* main.c - the complete listing */

#include <stdio.h>

#include <stdlib.h>

#include <unistd.h>

#include <libgen.h>

#include <errno.h>

#include <string.h>

#include <getopt.h>

#define OPTSTR "vi:o:f:h"

#define USAGE_FMT  "%s [-v] [-f hexflag] [-i inputfile] [-o outputfile] [-h]"

#define ERR_FOPEN_INPUT  "fopen(input, r)"

#define ERR_FOPEN_OUTPUT "fopen(output, w)"

#define ERR_DO_THE_NEEDFUL "do_the_needful blew up"

#define DEFAULT_PROGNAME "george"

extern int errno;

extern char *optarg;

extern int opterr, optind;

typedef struct {

int          verbose;

uint32_t      flags;

FILE        *input;

FILE        *output;

} options_t;

int dumb_global_variable = -11;

void usage(char *progname, int opt);

int  do_the_needful(options_t *options);

int main(int argc, char *argv[]) {

int opt;

options_t options = { 0, 0x0, stdin, stdout };

opterr = 0;

while ((opt = getopt(argc, argv, OPTSTR)) != EOF)

switch(opt) {

case 'i':

if (!(options.input = fopen(optarg, "r")) ){

perror(ERR_FOPEN_INPUT);

exit(EXIT_FAILURE);

/* NOTREACHED */

}

break;

case 'o':

if (!(options.output = fopen(optarg, "w")) ){

perror(ERR_FOPEN_OUTPUT);

exit(EXIT_FAILURE);

/* NOTREACHED */

}

break;

case 'f':

options.flags = (uint32_t )strtoul(optarg, NULL, 16);

break;

case 'v':

options.verbose += 1;

break;

case 'h':

default:

usage(basename(argv[0]), opt);

/* NOTREACHED */

break;

}

if (do_the_needful(&options) != EXIT_SUCCESS) {

perror(ERR_DO_THE_NEEDFUL);

exit(EXIT_FAILURE);

/* NOTREACHED */

}

return EXIT_SUCCESS;

}

void usage(char *progname, int opt) {

fprintf(stderr, USAGE_FMT, progname?progname:DEFAULT_PROGNAME);

exit(EXIT_FAILURE);

/* NOTREACHED */

}

int do_the_needful(options_t *options) {

if (!options) {

errno = EINVAL;

return EXIT_FAILURE;

}

if (!options->input || !options->output) {

errno = ENOENT;

return EXIT_FAILURE;

}

/* XXX do needful stuff */

return EXIT_SUCCESS;

}

现在,你已经准备好编写更易于维护的 C 语言了吗。


如果你想学习编程,小编推荐我的C语言/C++编程学习基地【点击进入】!

都是学编程小伙伴们,带你入个门还是简简单单啦,一起学习,一起加油~

还有许多学习资料和视频,相信你会喜欢的!

涉及:游戏开发、常用软件开发、编程基础知识、课程设计、黑客等等......

 

如何写好 C语言 main 函数!你准备好编写 C 程序了吗?的更多相关文章

  1. c语言main函数返回值、参数详解(返回值是必须的,0表示正常退出)

    C语言Main函数返回值 main函数的返回值,用于说明程序的退出状态.如果返回0,则代表程序正常退出:返回其它数字的含义则由系统决定.通常,返回非零代表程序异常退出. 很多人甚至市面上的一些书籍,都 ...

  2. C 语言main 函数终极探秘(&& 的含义是:如果 && 前面的程序正常退出,则继续执行 && 后面的程序,否则不执行)

           所有的C程序必须定义一个称之为main的外部函数,这个函数是程序的入口,也就是当程序启动时所执行的第一个函数,当这个函数返回时,程序也将终止,并且这个函数的返回值被看成是程序成功或失败的 ...

  3. c语言main函数的参数argc,argv说明

    main函数参数argc,argv说明   C/C++语言中的main函数,经常带有参数argc,argv,如下: int main(int argc, char** argv) int main(i ...

  4. 解决:一个项目中写多个包含main函数的源文件并分别调试运行

    自己在学c++的时候,一个项目中的多个cpp文件默认不允许多个main函数的出现,但是通过选项操作能够指定单个cpp文件进行运行,如下: 1.此时我就想运行第二个cpp文件,我们只需要把其他的两个右键 ...

  5. 01-JAVA语言基础——课程作业1—编写一个程序,此程序从命令行接收多个数字,求和之后输出结果。

    1.题目:编写一个程序,此程序从命令行接收多个数字,求和之后输出结果. 2.程序设计思想: 通过运行配置输入数字后,其保存类型为String类型,因此需要采用Integer.valueOf(arg)将 ...

  6. C语言main函数的参数

    在Windows下使用gcc编译器: 1.首先介绍下MinGW MinGW(Minimalist GNU for Windows),又称mingw32,是将GCC编译器和GNU Binutils移植到 ...

  7. C语言的main函数到底该怎么写

    公众号[编程珠玑]:专注但不限于分享计算机编程基础,Linux,C语言,C++,Python,数据库等编程相关[原创]技术文章,号内包含大量经典电子书和视频学习资源.欢迎一起交流学习,一起修炼计算机“ ...

  8. 为什么c程序里一定要写main函数

    一. 学习过程 编写程序f.c: 对其进行编译,正常通过,再对其进行连接,出现错误: 显示的出错信息为: 翻译成中文是:在c0s模块没有定义符号’_main’. 那么这个错误信息可能与文件c0s.ob ...

  9. .NET/C# 中你可以在代码中写多个 Main 函数,然后按需要随时切换

    .NET/C# 程序从 Main 函数开始执行,基本上各种书籍资料都是这么写的.不过,我们可以写多个 Main 函数,然后在项目文件中设置应该选择哪一个 Main 函数. 你可能会觉得这样没有什么用, ...

随机推荐

  1. request的各种方法

    protected void doPost(HttpServletRequest request, HttpServletResponse response)        throws Servle ...

  2. 记一次线上OOM问题分析与解决

    一.问题情况 最近用户反映系统响应越来越慢,而且不是偶发性的慢.根据后台日志,可以看到系统已经有oom现象. 根据jdk自带的jconsole工具,可以监视到系统处于堵塞时期.cup占满,活动线程数持 ...

  3. 修改mysql、sqlserver数据库默认用户,不允许为root、sa等

    1.mysql cmd进入dos命令,输入mysql -u root -P 1202 -h localhost -p敲回车输入密码 use mysql; 修改用户名root为其他用户 update u ...

  4. Docker添加TLS认证修复2375端口暴露引发的漏洞

    #### 1.环境准备 ```bash# 查看Docker服务器主机名hostnamectl``` ![1582697962553](C:\Users\86176\AppData\Roaming\Ty ...

  5. vue 中后台 列表的增删改查同一解决方案

    查看 & 查询 常⻅业务列表⻚都是由 搜索栏 和 数据列表 组成. 其中: 搜索栏包含 搜索条件 . 新增 . 批量xx . 导出 等对 数据列表 全局操作功能项. 数据列表包含 分⻚ 和每条 ...

  6. java虚拟机5 字节码

    java字节码本质是java程序的格式化表示,便于机器处理.所以他是java程序的另一种表示,java程序包含的信息他都包含并且更加结构化. java虚拟机字节码格式: magic 魔数,标识该文件是 ...

  7. Linux安装软件总结

    1.安装jdk1.8 1.首先去官网下载jdk https://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133 ...

  8. Jmeter(二十四) - 从入门到精通 - JMeter函数 - 中篇(详解教程)

    1.简介 在性能测试中为了真实模拟用户请求,往往我们需要让提交的表单内容每次都发生变化,这个过程叫做参数化.JMeter配置元件与前置处理器都能帮助我们进行参数化,但是都有局限性,为了帮助我们能够更好 ...

  9. xss利用——BeEF#stage2(初始并持续化控制)

    全文概览 浏览器攻击方法流程 攻击浏览器一般分为几个阶段,如下图 整个过程分为三个步骤,第一步是初始化控制,第二步是持续控制,第三步是攻击.在第三步中的七个攻击方法是可以交叉的,比如可以同时攻击用户和 ...

  10. 工具请求接口参数为string类型的JSON字符串时需要加转义字符模拟测试

    例如postMan传String类型的json字符串请后台接口时,需要\转义