c++頭文件重復引用問題


引子----之前寫C++ 時遇到的坑

之前由於Java實在太好用了,C++的工程代碼幾乎沒怎么碰,真的寫起來的時候總會有些小bug,這里就對其中的一個進行個總結
a.h

#include "b.h"
class a{
  public: a();
          ~a();
}

a.cpp

#incldue "a.h"
a::a(){
  ....
};
a::~a(){
  ....
};

b.h

#include "a.h"
class b{
  public: b();
          ~b();
}

b.cpp

#incldue "b.h"
b::b(){
  ....
};
b::~b(){
  ....
};

假設有上述兩個類的頭文件,我需要對a b類進行互相的調用,如果如同上述的形式操作絕對會陷入頭文件的重復包含問題.正確的做法應該分別在.cpp文件中進行包含.至於理由,寫在了下面.

c++中的頭文件和源文件

通常,在一個C++程序中,只包含兩類文件——.cpp文件和.h文件。其中.cpp文件被稱作C++源文件,里面放的都是C++的源代碼;而.h文件則被稱作C++頭文件,里面放的也是C++的源代碼。

C+ +語言支持“分別編譯”(separate compilation)。也就是說,一個程序所有的內容,可以分成不同的部分分別放在不同的.cpp文件里。.cpp文件里的東西都是相對獨立的,在編 譯(compile)時不需要與其他文件互通,只需要在編譯成目標文件后再與其他的目標文件做一次鏈接(link)就行了。比如,在文件a.cpp中定義 了一個全局函數“void a() {}”,而在文件b.cpp中需要調用這個函數。即使這樣,文件a.cpp和文件b.cpp並不需要相互知道對方的存在,而是可以分別地對它們進行編譯, 編譯成目標文件之后再鏈接,整個程序就可以運行了。

這是怎么實現的呢?從寫程序的角度來講,很簡單。在文件b.cpp中,在調用 “void a()”函數之前,先聲明一下這個函數“void a();”,就可以了。這是因為編譯器在編譯b.cpp的時候會生成一個符號表(symbol table),像“void a()”這樣的看不到定義的符號,就會被存放在這個表中。再進行鏈接的時候,編譯器就會在別的目標文件中去尋找這個符號的定義。一旦找到了,程序也就可以 順利地生成了。
注意這里提到了兩個概念,一個是“定義”,一個是“聲明”。簡單地說,“定義”就是把一個符號完完整整地描述出來:它是變 量還是函數,返回什么類型,需要什么參數等等。而“聲明”則只是聲明這個符號的存在,即告訴編譯器,這個符號是在其他文件中定義的,我這里先用着,你鏈接 的時候再到別的地方去找找看它到底是什么吧。定義的時候要按C++語法完整地定義一個符號(變量或者函數),而聲明的時候就只需要寫出這個符號的原型了。 需要注意的是,一個符號,在整個程序中可以被聲明多次,但卻要且僅要被定義一次。

什么是頭文件

所謂的頭文件,其實它的內容跟.cpp文件中的內容是一樣的,都是 C++的源代碼。但 頭文件不用被編譯 。我們把所有的函數聲明全部放進一個頭文件中,當某一個.cpp源文件需要它們時,它們就可以通過一個宏命令 “#include”包含進這個.cpp文件中,從而把它們的內容合並到.cpp文件中去。當.cpp文件被編譯時,這些被包含進去的.h文件的作用便發 揮了。

頭文件中應該寫什么

頭文件的作用就是被其他的.cpp包含進去的。它們本身並不參與編譯,但實際上,它們的內容卻在多個.cpp文件中得到了編譯。通過“定義只能有一次”的規則,我們很容易可以得出,頭文件中應該只放變量和函數的聲明,而不能放它們的定義。因為一個頭文件的內容實際上是會被引 入到多個不同的.cpp文件中的,並且它們都會被編譯。放聲明當然沒事,如果放了定義,那么也就相當於在多個文件中出現了對於一個符號(變量或函數)的定義,縱然這些定義都是相同的,但對於編譯器來說,這樣做不合法。
所以,應該記住的一點就是,.h頭文件中,只能存在變量或者函數的聲明, 而不要放定義。即,只能在頭文件中寫形如:extern int a;和void f();的句子。這些才是聲明。如果寫上int a;或者void f() {}這樣的句子,那么一旦這個頭文件被兩個或兩個以上的.cpp文件包含的話,編譯器會立馬報錯。

但是,這個規則是有三個例外的。

一,頭文件中可以寫const對象的定義。

因為全局的const對象默 認是沒有extern的聲明的,所以它只在當前文件中有效。把這樣的對象寫進頭文件中,即使它被包含到其他多個.cpp文件中,這個對象也都只在包含它的 那個文件中有效,對其他文件來說是不可見的,所以便不會導致多重定義。同時,因為這些.cpp文件中的該對象都是從一個頭文件中包含進去的,這樣也就保證 了這些.cpp文件中的這個const對象的值是相同的,可謂一舉兩得。同理,static對象的定義也可以放進頭文件。

二,頭文件中可 以寫內聯函數(inline)的定義。

因為inline函數是需要編譯器在遇到它的地方根據它的定義把它內聯展開的,而並非是普通函數那樣可以先聲明再鏈 接的(內聯函數不會鏈接),所以編譯器就需要在編譯時看到內聯函數的完整定義才行。如果內聯函數像普通函數一樣只能定義一次的話,這事兒就難辦了。因為在 一個文件中還好,我可以把內聯函數的定義寫在最開始,這樣可以保證后面使用的時候都可以見到定義;但是,如果我在其他的文件中還使用到了這個函數那怎么辦 呢?這幾乎沒什么太好的解決辦法,因此C++規定,內聯函數可以在程序中定義多次,只要內聯函數在一個.cpp文件中只出現一次,並且在所有的.cpp文 件中,這個內聯函數的定義是一樣的,就能通過編譯。那么顯然,把內聯函數的定義放進一個頭文件中是非常明智的做法。

三,頭文件中可以寫類 (class)的定義。

因為在程序中創建一個類的對象時,編譯器只有在這個類的定義完全可見的情況下,才能知道這個類的對象應該如何布局,所以,關於類的 定義的要求,跟內聯函數是基本一樣的。所以把類的定義放進頭文件,在使用到這個類的.cpp文件中去包含這個頭文件,是一個很好的做法。在這里,值得一提 的是,類的定義中包含着數據成員和函數成員。數據成員是要等到具體的對象被創建時才會被定義(分配空間),但函數成員卻是需要在一開始就被定義的,這也就 是我們通常所說的類的實現。一般,我們的做法是,把類的定義放在頭文件中,而把函數成員的實現代碼放在一個.cpp文件中。這是可以的,也是很好的辦法。 不過,還有另一種辦法。那就是直接把函數成員的實現代碼也寫進類定義里面。在C++的類中,如果函數成員在類的定義體中被定義,那么編譯器會視這個函數為 內聯的。因此,把函數成員的定義寫進類定義體,一起放進頭文件中,是合法的。注意一下,如果把函數成員的定義寫在類定義的頭文件中,而沒有寫進類定義中, 這是不合法的,因為這個函數成員此時就不是內聯的了。一旦頭文件被兩個或兩個以上的.cpp文件包含,這個函數成員就被重定義了。

總結

在預處理階段,預處理器看到#include "文件名"就把這個文件讀進來,比如它編譯a.cpp,看到#include"a.h",它就把a.h的內容讀進來。如果像之前一樣在頭文件內部重復嵌套,造成的后果就是.cpp文件在#include 時導入的a.h文件里包含了b.h這個時候要將b.h里的內容也讀入.在b.h里面由於也引用了a.h所以造成了對a內的變量及方法的二次定義.編譯器報錯是理所當然的. 其實由編譯原理的知識也知道編譯階段內部維護了一張表. 此時的錯誤就是對表內的變量進行了二次的定義.


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM