c - c包括，防止冗余代码

Question

如果我有一个c项目，我的主程序需要file1和file2但file2也需要file1。有什么办法可以解决在main和file1中都包含file2的问题？如果我有一个include防护，这会阻止file1.c被添加两次吗？

//file1.h
#ifndef FILE1_H
#define FILE1_H

void func1(void);
#endif

-

//file1.c
#include "file1.h"
void func1(void) {
  ..do something
}

-

//file2.h
#ifndef FILE2_H
#define FILE2_H

void func2(void);
#endif

-

//file2.c
#include "file2.h"
#include "file1.h"

void func2(void) {
  ..do something
  func1();
}

-

//main.c
#include "file1.h"
#include "file2.h"

int main(void) {
  func1();
  func2();

  return 0;
}

-由于file2包含file1，我可以这样做吗？它会防止文件1代码重复吗？

//main.c (alternate)
#include "file2.h"

int main(void) {
  func1();
  func2();

  return 0;
}

我不太担心如果file2决定将来不再包含file1时出现的问题。我更关心浪费的空间。

我想知道的是A：包含保护功能是否可以防止代码重复，如果是这样，则在main.c和file2.c中都包含file1不会占用额外的空间。 B：如果使用了多余的空间，我的替代main.c是否可以工作？

Answer 1

快速说明（注意所有这些都可以被知道自己在做什么的人覆盖）：

首先，有两个定义：声明是指当您写下某物存在时。例如，“ int foo();”或“ struct bar;”。请注意，我们还不能真正使用此东西，我们只是给它起了一个名字。只要将它们声明为同一事物，就可以根据需要多次声明！ （变量声明有其自己的规则）。

您想要使用的任何东西都必须在引用之前进行声明。

定义是当您说声明是什么时。 int foo() {asdfadf;}或struct bar{int x;}。声明时可以定义（并且经常定义）事物，但并非总是如此。

在C语言中，您必须遵循一个定义规则。可以根据需要随意声明事物，但是每个翻译单元只能定义一次（定义在1秒钟内）。 （此外，每个完整的可执行文件只能声明一次函数调用）。

在使用它们之前，几乎没有什么需要定义的……除了变量之外，您只需要在需要大小或访问其成员的上下文中使用结构之前定义一个结构。

什么是翻译单位？它是用于编译单个源文件的所有文件。您的头文件不是编译目标。只有您的.c文件（称为“源文件”）。对于每个c文件，我们都有一个“翻译单元”的概念，它是用于编译该c文件的所有文件。该代码的最终输出是.o文件。 .o文件包含运行该c ++文件中定义的代码所需的所有符号。因此，您的c文件和所有包含的文件都与头文件一起使用。注意：并非必须在翻译单元中声明的所有内容都定义在其中以获得有效的.o文件。

那么头文件中有什么？好吧（总的来说），您有几件事：


函数声明
全局定义和声明
结构定义和声明


基本上，您需要在翻译单元之间共享基本的声明和定义。 #include允许您将其保存在一个共享文件中，而不是整个复制和粘贴此代码。

您的定义只能发生一次，因此包含保护可防止出现问题。但是，如果您仅具有声明，则从技术上讲您并不需要包含警戒。 （无论如何，您仍然应该使用它们，它们可以限制您所做的交叉包含，并可以防止无限递归包含）。但是，您确实需要包括与每个翻译单元有关的所有声明，因此您很可能会多次包含它。还行吧。声明至少在一个文件中。

编译.o文件时，编译器将检查您是否遵循一个定义规则，以及所有语法是否正确。这就是为什么在“创建.o”编译步骤中会出现这些类型的错误的原因。

因此，在您的示例中，编译后，我们得到file1.o（包含func1的定义），file2.o（包含func2的定义）和main.o（包含main的定义）。下一步是使用链接器将所有这些文件链接在一起。完成后，编译器将获取所有这些.o文件，并确保文件中每个功能符号只有一个定义。这就是让main.o知道file1.o和file2.o中内容的魔力所在：它解析“未解析的符号”并检测何时存在冲突的符号。

最后的想法：

保持代码简短是一种误导的任务。您希望代码可维护和可读，而使代码尽可能短则恰恰相反。我可以在一行上只写一个字母字母数字变量名称来编写整个程序，但没人会知道它的作用……要避免的是在声明之类的代码中重复代码。维护一长串#include可能会变得很棘手，因此将相关功能组合在一起通常是一件好事（一个很好的经验法则是，如果我几乎总是同时使用A和B），那么它们应该应该在同一个头文件中。

我偶尔要做的另一件事（有时是因为它有一些严重的缺点）是使用便捷头文件：

//convience.h
#ifndef CONVIENIENCE_H
#define CONVIENIENCE_H
#include "file1.h"
#include "file2.h"
#endif

便利头文件中仅包含其他头文件，这确保了它永不包含代码，这使它的维护稍微容易一些，但仍然有些混乱。还要注意，如果您在file1和file2中执行include防护，那么convienience防护就不是必需的，尽管它可以（理论上）加快编译速度。