C++的策略/二進制兼容性問題
我們在coding-style中提到了C++二進制兼容性問題，這里我們也來學習下。
定義
庫是二進制兼容的，如果動態鏈接到該庫的舊版本的程序，無需重新編譯，就可以與該庫的新版本一起運行。
庫是源代碼兼容的，如果對於庫的新版本，程序需要重新編譯才能運行，但不需要任何進一步的修改。
二進制兼容性解決了很多麻煩。 它使為特定平台分發軟件變得更加容易。 如果不能確保發行版之間的二進制兼容性，人們將不得不提供靜態鏈接的二進制文件。 靜態二進制文件很糟糕，因為它們
- 浪費資源（尤其是內存）
- 程序不能從庫的bug修復或功能擴展中受益
在KDE項目中，對於核心庫（kdelibs，kdepimlibs）的主要發行版的生命周期，我們提供二進制兼容性。
ABI注意事項
本文適用於KDE構建用的編譯器使用的大多數C++ ABI。它主要基於Itanium C++ ABI草案，GCC C++編譯器從3.4版本開始使用。 有關Microsoft Visual C++名稱改編方案的信息主要來自於關於調用約定的文章（這是迄今為止有關MSVC ABI和名稱改編的最完整信息）。
此處指定的某些約束可能不適用於給定的編譯器。 此處的目標是列出最嚴格的一組條件，用於編寫跨平台C++代碼，這意味着會被多種不同的編譯器編譯。
發現新的二進制不兼容問題時，此頁面會同步更新。
可做與不可做
你可以...
-
添加新的非虛擬功能，包括信號和槽以及構造函數。
-
在類中添加一個新的枚舉。
-
將新的枚舉值追加到現有枚舉。
- 例題：如果這導致編譯器為枚舉選擇了更大的基礎類型，則這更改是二進制不兼容的。不幸的是，編譯器有一些選擇基礎類型的余地，因此從API設計的角度來看，建議添加一個Max....枚舉值，並顯式設置一個較大的值(=255, =1<<15, 等)，以創建一個保證可以適合所選基礎類型的枚舉值的范圍。
-
重新實現在類層次結構中原始基類定義的虛函數（該虛函數定義在第一個非虛基類，或該類的第一個非虛基類中，依此類推），如果程序鏈接到先前版本的庫，且該庫調用了基類中的實現而不是派生類中的實現，是安全的。這很棘手，可能很危險。三思而后行。或者，請參閱下面的解決方法。
- 例外：如果重新實現的函數具有協變返回類型，則如果派生更多的類型始終與派生較小的類型具有相同的指針地址，則它僅是二進制兼容性的變動。如有疑問，請勿使用協變返回類型來進行覆寫。
-
更改內聯函數或使內聯函數變為非內聯，如果程序鏈接到先前版本的庫，且該庫調用了舊的實現，是安全的。這很棘手，可能很危險。三思而后行。
-
移除私有非虛函數，如果它們沒有被任何內聯函數調用過（並且從未使用過）。
-
移除私有靜態成員變量，如果它們沒有被任何內聯函數調用過（並且從未使用過）。
-
添加新的靜態數據成員變量。
-
更改方法的默認參數。但是，它需要重新編譯才能使用實際的新的默認參數值。
-
添加新類。
-
導出以前未導出的類。
-
在類中添加或刪除友元聲明。
-
重命名保留的成員類型。
-
擴展保留的位字段，前提是這不會導致位字段超出其基礎類型的邊界(8 bits for char & bool, 16 bits for short, 32 bits for int, etc.)
-
將Q_OBJECT宏添加到類中，如果該類已經從QObject繼承。
-
添加Q_PROPERTY，Q_ENUMS或Q_FLAGS宏，因為它僅修改由moc生成的元對象，而不修改類本身。
你不可以...
- 對於現有類：
- 對於模板類：
- 以任何方式更改模板參數（添加，刪除或重新排序）。
- 對於任意類型的現有函數：
- 取消導出。
- 移除。
- 移除已聲明函數的實現。符號來自函數的實現，因此實際上就是函數。
- 變為內聯（這包括將成員函數的主體移至類定義，即使沒有inline關鍵字也是如此）
- 添加一個新的重載函數（BC，而不是SC：使＆func變得模棱兩可），將重載函數添加到已經被重載的函數中是可以的（對＆func的任何使用都已經需要強制轉換）。
- 更改其簽名。這包括：
- 對於虛成員函數：
- 向沒有任何虛函數或虛基類的類中添加虛函數。
- 向非葉節點的類添加新的虛函數，因為這會破壞子類。請注意，設計為用於應用程序子類化的類始終是非葉類。請參閱下面的一些解決方法，或在郵件列表中詢問。
- 以任何理由添加新的虛函數，甚至在葉節點類中，如果該類旨在Windows上保持二進制兼容性。這樣做可能會重排現有的虛函數並破壞二進制兼容性。
- 在類聲明中更改虛函數的順序。
- 覆寫已存在的虛函數，如果該函數不在原始基類中（第一個非虛基類，或原始基類的原始基類，一路往上）。
- 覆寫已存在的虛函數，如果重載函數具有協變量返回類型，而其高派生類型的指針地址與低派生的指針地址不同（通常發生在，在低派生和高派生之間，有多重繼承或虛繼承）。
- 移除虛函數，即使它是基類虛函數的重新實現。
- 對於靜態非私有成員或非靜態非成員公有數據：
- 移除或取消導出
- 更改其類型
- 更改其CV限定符 - 對於非靜態成員變量：
- 添加新的數據成員到現有的類中。
- 更改類中非靜態數據成員的順序。
- 更改成員的類型（變量名符號除外）
- 從已有的類中刪除已有的非靜態數據成員。
如果需要添加擴展/修改現有函數的參數列表，則需要添加新函數，而不是新參數。在這種情況下，您可能想添加簡短說明，在庫的更高版本中，這兩個函數應通過默認參數進行合並：
void functionname( int a );
void functionname( int a, int b ); //BCI: merge with int b = 0
你應該...
為了類在將來可擴展，您應該遵循以下規則：
- 添加d指針。見下文。
- 添加非內聯虛析構函數，即使主體為空。
- 在QObject派生的類中重新實現event，即使新函數的主體只是調用基類的實現。這是專門為避免，因添加已重新實現的虛函數而引起的問題，如下所述。
- 使所有構造函數非內聯。
- 編寫拷貝構造函數和賦值運算符的非內聯實現，除非類無法進行值拷貝（例如，從QObject繼承的類是不能的）
庫程序員的技巧
編寫庫時最大的問題是，不能安全地添加數據成員，因為這會改變每個class類，struct結構，或者對象類型數組的大小和布局。
位標志
位標志是一種例外。 如果對枚舉或布爾使用位標志，則至少在下一個字節減去1bit之前是安全的。具有下面成員的類
uint m1 : 1;
uint m2 : 3;
uint m3 : 1;
uint m1 : 1;
uint m2 : 3;
uint m3 : 1;
uint m4 : 2; // new member
不會破壞二進制兼容性。 請四舍五入到最多7位（如果已經大於8，則為15位）。使用最后一位可能會在某些編譯器上引起問題。
使用d指針
位標記和預定義的保留變量很好，但遠遠不夠。這就是d指針技術發揮作用的地方。"d指針"的名稱源於Trolltech's Arnt Gulbrandsen，他首先將該技術引入到Qt，使其成為最早的C++ GUI庫之一，用於在更大的發行版之間保持二進制兼容性。看到它的每個人都迅速將該技術用作KDE庫的通用編程模式。這是一個絕妙的技巧，能夠在不破壞二進制兼容性的情況下將新的私有數據成員添加到類中。
備注：d指針模式在計算機科學歷史上已經以不同的名稱被多次描述過，例如pimpl，handle/body或cheshire cat。Google可以幫助您找到其中任何一種的在線論文，只需將C++添加到搜索詞中即可。
在類Foo的定義中，定義一個前向聲明
class FooPrivate;
和私有成員中的d指針：
private:
FooPrivate* d;
FooPrivate類本身完全定義在類實現文件（通常為*.cpp）中，例如：
class FooPrivate {
public:
FooPrivate()
: m1(0), m2(0)
{}
int m1;
int m2;
QString s;
};
您現在要做的就是，在構造函數或初始化函數中使用以下方法創建私有數據：
d = new FooPrivate;
並在析構函數中將其刪除
delete d;
在大多數情況下，您將需要使d指針為const，以捕獲意外修改或拷貝它的情況，這時將失去對私有對象的所有權，並造成內存泄漏：
private:
FooPrivate* const d;
這使您可以修改d指向的對象，但不能在初始化后修改d的值。
但是，您可能不希望所有成員變量都存在於私有數據對象中。對於經常使用的成員，將它們直接放入類中會更快，因為內聯函數無法訪問d指針數據。還要注意，盡管在d指針本身中已聲明為公有，但d指針所涵蓋的所有數據都是私有的。對於公有或受保護的訪問，請同時提供set和get函數。例如
QString Foo::string() const
{
return d->s;
}
void Foo::setString( const QString& s )
{
d->s = s;
}
也可以將d指針的私有類聲明為嵌套的私有類。如果使用此技術，請記住，嵌套的私有類將繼承包含的導出類的公有符號可見性。這將導致私有類的函數在動態庫的符號表中被命名。您可以在嵌套私有類的實現中使用Q_DECL_HIDDEN來手動重新隱藏符號。從技術上講，這是ABI變動，但不會影響KDE開發人員支持的公共ABI，因此私有符號錯誤可能重新隱藏，而不會發出進一步的警告。
故障排除
在沒有d指針的情況下將新數據成員添加到類中
如果您沒有自由的位標志，保留的變量並且也沒有d指針，但是您必須添加一個新的私有成員變量，那么仍然存在一些可能性。如果您的類繼承自QObject，則可以例如將其他數據放在一個特殊的子對象中，並通過遍歷子對象列表來查找它們。您可以使用QObject::children()訪問子列表。但是，更簡便，通常更快的方法是使用哈希表存儲對象與額外數據之間的映射。為此，Qt提供了一個基於指針的字典，稱為QHash（或Qt3中的Templat::Qt3）。
在Foo類的實現中的基本技巧是：
-
創建一個私有數據類FooPrivate。
-
創建一個靜態QHash<Foo *, FooPrivate *>。
-
請注意，有些編譯器/鏈接器（不幸的是，幾乎所有的）都無法在動態庫中創建靜態對象。他們只是忘了調用構造函數。因此，您應該使用
Q_GLOBAL_STATIC宏來創建和訪問該對象：// BCI: Add a real d-pointer typedef QHash<Foo *, FooPrivate *> FooPrivateHash; Q_GLOBAL_STATIC(FooPrivateHash, d_func) static FooPrivate *d(const Foo *foo) { FooPrivate *ret = d_func()->value(foo); if ( ! ret ) { ret = new FooPrivate; d_func()->insert(foo, ret); } return ret; } static void delete_d(const Foo *foo) { FooPrivate *ret = d_func()->value(foo); delete ret; d_func()->remove(foo); } -
現在，您可以像以前的代碼一樣簡單地在類中使用d指針，只需調用d(this)即可。例如：
d(this)->m1 = 5; -
在析構函數中添加一行：
delete_d(this); -
不要忘記添加一個BCI注釋，以便可以在庫的下一版本中刪除該hack。
-
不要忘記在下一個類中添加d指針。
添加已重新實現的虛函數
正如已經說明的，你可以安全的重新實現定義在其中一個基類中的虛函數，如果程序鏈接到先前版本的庫，且該庫調用了基類中的實現而不是派生類中的實現，是安全的。這是因為如果編譯器可以確定要調用哪個虛函數，則有時會直接調用該虛函數。例如，如果您有
void C::foo()
{
B::foo();
}
那么B::foo()直接被調用。如果類B繼承自實現了foo()函數的類A，而B本身未重新實現，則 C::foo() 實際上將調用A::foo()。如果該庫的較新版本添加了B::foo()，則C::foo() 僅在重新編譯后才調用B::foo() 。
另一個更常見的示例是：
B b; // B derives from A
b.foo();
那么對foo()的調用將不會使用虛擬表。這意味着如果庫中以前不存在B::foo()，但現在存在了，則使用較早版本庫進行編譯的代碼仍將調用A::foo()。
如果不能保證無需重新編譯就能繼續工作，請將函數功能從A::foo()移至新的受保護函數A::foo2()，並使用以下代碼：
void A::foo()
{
if( B* b = dynamic_cast< B* >( this ))
b->B::foo(); // B:: is important
else
foo2();
}
void B::foo()
{
// added functionality
A::foo2(); // call base function with real functionality
}
類型B（或繼承）的對象對A::foo()的所有調用將導致調用B::foo()。唯一無法正常工作的情況是對A::foo()的調用，該調用顯式指定了A::foo()，但B::foo()則調用了A::foo2()，其他地方別這樣做。
使用新類
一種相對簡單的“擴展”類的方法是編寫一個替換類，該替換類還將包括新功能（可能從舊類繼承代碼以重復利用）。當然，這需要使用該庫來適應和重新編譯應用程序，因此這種方法不可能用來修復或擴展類的功能，該類是應用程序編譯用的舊版本庫中的類。 但是，特別是對於小型的和/或性能至關重要的類，編寫它們可能會更簡單，而不必確保它們將來會易於擴展；如果以后需要，可編寫一個新的替代類，以提供新的功能或更好的性能。
向葉節點類添加新的虛函數
這種技術是使用新類的一種情況，這對向類中添加新的虛函數有幫助，該類必須保持二進制兼容性，而該類的繼承類沒必要繼續保持二進制兼容性（即所有的繼承類都在應用程序中）。在這種情況下，可以添加一個繼承自原始類的新類，並將其添加進來。當然，使用新功能的應用程序必須進行修改以使用新類。
class A {
public:
virtual void foo();
};
class B : public A { // newly added class
public:
virtual void bar(); // newly added virtual function
};
void A::foo()
{
// here it's needed to call a new virtual function
if( B* this2 = dynamic_cast< B* >( this ))
this2->bar();
}
當還有其他的繼承類也必須保持二進制兼容性時，則無法使用此技術，因為它們不得不從新類繼承。
使用信號代替虛功能
Qt的信號和槽設計由Q_OBJECT宏創建的特殊的虛函數調用，它存在於從QObject繼承的每個類中。因此，添加新的信號和槽不會影響二進制兼容性，並且可以使用信號/槽機制來模擬虛函數。
class A : public QObject {
Q_OBJECT
public:
A();
virtual void foo();
signals:
void bar( int* ); // added new "virtual" function
protected slots:
// implementation of the virtual function in A
void barslot( int* );
};
A::A()
{
connect(this, SIGNAL( bar(int*)), this, SLOT( barslot(int*)));
}
void A::foo()
{
int ret;
emit bar( &ret );
}
void A::barslot( int* ret )
{
*ret = 10;
}
函數bar()的作用類似於虛函數，barslot()實現了函數的實際功能。由於信號的返回值為void，因此必須使用參數來返回數據。 由於只有一個槽函數連接從槽中返回數據的信號，因此這種方式可以正常工作。 注意，要使Qt4起作用，連接類型必須為Qt::DirectConnection。
如果繼承類要重新實現bar()的功能，則它必須提供自己的槽函數：
class B : public A {
Q_OBJECT
public:
B();
protected slots: // necessary to specify as a slot again
void barslot( int* ); // reimplemented functionality of bar()
};
B::B()
{
disconnect(this, SIGNAL(bar(int*)), this, SLOT(barslot(int*)));
connect(this, SIGNAL(bar(int*)), this, SLOT(barslot(int*)));
}
void B::barslot( int* ret )
{
*ret = 20;
}
現在，B::barslot()將像重新實現虛函數A::bar()一樣。請注意，有必要再次將barlot()指定為B中的槽，並且在構造函數中，有必要先斷開連接，然后再次連接，這將斷開A::barslot()並連接B::barslot() 。
注意：可以通過實現虛槽函數來實現相同目的。
原創造福大家，共享改變世界
獻出一片愛心，溫暖作者心靈
