1. 程式人生 > >c++如何寫標頭檔案.h

c++如何寫標頭檔案.h

一、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++程式設計師們帶來了很多好處,同時也引出了一種編寫程式的方法。考慮一下,如果有一個很常用的函式“void f() {}”,在整個程式中的許多.cpp檔案中都會被調,一個函式還 好對付,宣告起來也就一句話。但是,如果函式多了,比如是一大堆的數學函式,那怎麼辦?能保證每個程式設計師都可以完完全全地把所有函式的形式都 準確地記下來並寫出來嗎?

二、什麼是標頭檔案

很顯然,答案是不可能。但是有一個很簡單粗暴地辦法,可以幫助程式設計師們省去記住那麼多函式原型的麻煩:我們可以把那幾百個函式的宣告語句全都先寫好,放在一個檔案裡,等到程式設計師需要它們的時候,就把這些東西全部copy進他的原始碼中。
這 個方法固然可行,但還是太麻煩,而且還顯得很笨拙。於是,標頭檔案便可以發揮它的作用了。所謂的標頭檔案,其實它的內容跟.cpp檔案中的內容是一樣的,都是 C++的原始碼。但標頭檔案不用被編譯。我們把所有的函式宣告全部放進一個頭檔案中,當某一個.cpp原始檔需要它們時,它們就可以通過“#include”包含進這個.cpp檔案中,從而把它們的內容合併到.cpp檔案中去。當.cpp檔案被編譯時,這些被包含進去的.h檔案的作用便發 揮了。
舉一個例子吧,假設所有的數學函式只有兩個:f1和f2,那麼我們把它們的定義放在math.cpp裡:

/* math.cpp */
double f1()
{
    //do something here....
    return;
}
double f2(double a)
{
    //do something here...
    return a * a;
}
/* end of math.cpp */

並把“這些”函式的宣告放在一個頭檔案math.h中:
/* **math.h** */
double f1();
double f2(double);
/* end of math.h */

在另一個檔案main.cpp中,我要呼叫這兩個函式,那麼就只需要把標頭檔案包含進來:
/* main.cpp */
#include "math.h"
main()
{
    int number1 = f1();
    int number2 = f2(number1);
}
/* end of main.cpp */

這 樣,便是一個完整的程式了。需要注意的是,.h檔案要在編譯器找得到的地方(比如跟main.cpp在一個目錄下)。 main.cpp和math.cpp都可以分別通過編譯,生成main.o和math.o,然後再把這兩個目標檔案進行連結,程式就可以運行了。

三、#include

說明:#include 是一個來自C語言的巨集命令,它在編譯器進行編譯之前,即在預編譯的時候就會起作用。#include的作用是把它後面所寫的那個檔案的內容,完完整整地、 一字不改地包含到當前的檔案中來。簡單的文字替換,別無其他。因此,main.cpp檔案中的第一句(#include “math.h”),在編譯之前就會被替換成math.h檔案的內容。即在編譯過程將要開始的時候,main.cpp的內容已經發生了改變:

/* ~main.cpp */
double f1();
double f2(double);
main()
{
    int number1 = f1();
    int number2 = f2(number1);
}
/* end of ~main.cpp */

其他的.cpp檔案也用到了f1和f2函式的話,那麼它們也通通只需要在使用這兩個函式前寫上一句#include “math.h”就行了。

四、標頭檔案中應該寫什麼

通 過上面的討論,我們可以瞭解到,標頭檔案的作用就是被其他的.cpp包含進去的。它們本身並不參與編譯,但實際上,它們的內容卻在多個.cpp檔案中得到了編譯。通過“定義只能有一次”的規則,我們很容易可以得出,標頭檔案中應該只放變數和函式的宣告,而不能放它們的定義。因為一個頭檔案的內容實際上是會被引 入到多個不同的.cpp檔案中的,並且它們都會被編譯。如果放了定義,那麼也就相當於在多個檔案中出現了對於一個符號(變數或函式)的定 義,縱然這些定義都是相同的,但對於編譯器來說,這樣做不合法。
即,只能在標頭檔案中寫形如:extern int a;和void f();的句子。這些才是宣告。如果寫上int a;或者void f() {}這樣的句子,那麼一旦這個標頭檔案被兩個或兩個以上的.cpp檔案包含的話,編譯器會立馬報錯。(關於extern,前面有討論過,這裡不再討論定義跟宣告的區別了。)
但是,這個規則是有三個例外的。
一,標頭檔案中可以寫const物件的定義。因為全域性的const物件默 認是沒有extern的宣告的,所以它只在當前檔案中有效。同時,因為這些.cpp檔案中的該物件都是從一個頭檔案中包含進去的,這樣也就保證 了這些.cpp檔案中的這個const物件的值是相同的,可謂一舉兩得。同理,static物件的定義也可以放進標頭檔案。
二,標頭檔案中可 以寫行內函數(inline)的定義。因為inline函式是需要編譯器在遇到它的地方根據它的定義把它內聯展開的,而並非是普通函式那樣可以先宣告再鏈 接的(行內函數不會連結),所以編譯器就需要在編譯時看到行內函數的完整定義才行。如果行內函數像普通函式一樣只能定義一次的話,這事兒就難辦了。因為在 一個檔案中還好,我可以把行內函數的定義寫在最開始,這樣可以保證後面使用的時候都可以見到定義;但是,如果我在其他的檔案中還使用到了這個函式那怎麼辦 呢?這幾乎沒什麼太好的解決辦法,因此C++規定,行內函數可以在程式中定義多次,只要行內函數在一個.cpp檔案中只出現一次,並且在所有的.cpp文 件中,這個行內函數的定義是一樣的,就能通過編譯。那麼顯然,把行內函數的定義放進一個頭檔案中是非常明智的做法。
三,標頭檔案中可以寫類 (class)的定義。因為在程式中建立一個類的物件時,編譯器只有在這個類的定義完全可見的情況下,才能知道這個類的物件應該如何佈局,所以,關於類的 定義的要求,跟行內函數是基本一樣的。所以把類的定義放進標頭檔案,在使用到這個類的.cpp檔案中去包含這個標頭檔案,是一個很好的做法。在這裡,值得一提的是,類的定義中包含著資料成員和函式成員。資料成員是要等到具體的物件被建立時才會被定義(分配空間),但函式成員卻是需要在一開始就被定義的,這也就 是我們通常所說的類的實現。一般,我們的做法是,把類的定義放在標頭檔案中,而把函式成員的實現程式碼放在一個.cpp檔案中。這是可以的,也是很好的辦法。 不過,還有另一種辦法。那就是直接把函式成員的實現程式碼也寫進類定義裡面。在C++的類中,如果函式成員在類的定義體中被定義,那麼編譯器會視這個函式內聯的。因此,把函式成員的定義寫進類定義體,一起放進標頭檔案中,是合法的。注意一下,如果把函式成員的定義寫在類定義的標頭檔案中,而沒有寫進類定義中, 這是不合法的,因為這個函式成員此時就不是內聯的了。一旦標頭檔案被兩個或兩個以上的.cpp檔案包含,這個函式成員就被重定義了。
五、標頭檔案中的保護措施
注意上面提到的三個例外不能直接或間接的被同一個cpp檔案包含,設想一下,如果a.h中含有類A的定義,b.h中含有類B的定 義,由於類B的定義依賴了類A,所以b.h中也#include了a.h。現在有一個原始檔,它同時用到了類A和類B,於是程式設計師在這個原始檔中既把 a.h包含進來了,也把b.h包含進來了。這時,問題就來了:類A的定義在這個原始檔中出現了兩次!於是整個程式就不能通過編譯了。你也許會認為這是程式 員的失誤——他應該知道b.h包含了a.h——但事實上他不應該知道。
使用”#define”配合條件編譯可以很好地解決這個問題。在一個頭檔案中,通過#define定義一個名字,並且通過條件編譯#ifndef…#endif使得編譯器可以根據這個名字是否被定義,再決定要不要繼續編譯該頭文中後續的內容。這個方法雖然簡單,但是寫標頭檔案時一定記得寫進去。