マクロとその代替 | Programming Place Plus　C++編【言語解説】　第１０章

関数形式マクロを関数テンプレートに置き換えることに加えて、インライン関数にする場合もあります。インライン関数とは、宣言時に inline指定子を付加された関数のことです。

inline void f();

もちろん、関数の本体も記述して、定義にしても構いません。

inline void f() {}

inline指定子は、関数テンプレートの定義にも付加できます。このような関数テンプレートから実体化された関数は、inline指定子が付加された関数になっています。

template <typename T>
inline T max(T a, T b)
{
    return (a) > (b) ? (a) : (b);
}

inline指定子は、インライン展開を行うことを要請します。インライン展開とは、関数の本体のコードを、その関数を呼び出している箇所に展開することです。これは、関数形式マクロがしていることと実質的に同じといえます。

【上級】インライン展開は多くの場合、コンパイル時に行われますが、リンク時など、ほかのタイミングで行われる可能性もあります。

インライン展開が行われることで、関数呼び出しのコストを避けられます。一方で、呼び出し箇所ごとにコードが重複することになるので、プログラムのサイズは大きくなるかもしれません。

インライン関数の本体が小さければ、かえってプログラムサイズが小さくなる可能性はあります。

inline指定子は、インライン展開して欲しいという要請に過ぎず、強制的な指示ではありません。インライン展開することが難しい場面もあるため、要請は無視される可能性があります。インライン展開が行われなかった場合は、通常の関数呼び出しの仕組みが使われます。

【上級】ループを含む関数や、再帰呼び出しを行う関数、仮想関数（第２７章）では、inline指定子の要請を無視することがあります。

【上級】ある呼び出し箇所ではインライン展開され、ほかの呼び出し箇所ではインライン展開されないということも起こり得ます。たとえば、インライン関数のメモリアドレスを取得している箇所があると、関数の実体が必要になるため、インライン展開を行わないはずです。しかし、それとは別の箇所でインライン展開可能なら、効率を優先して、インライン展開を行うかもしれません。

反対に、inline指定子を付加していなくとも、通常の最適化の一環として、関数がインライン展開されることもあります。

結局、inline指定子を付加してもしなくても、インライン展開は行われるかもしれないし、行われないかもしれないということです。インライン関数を使うことによる多少の弊害もあるため、inline指定子を付けることには慎重であるべきです。

弊害とはたとえば、インライン関数の本体のコードをヘッダファイル側に露出しなければならないため、後から実装を変更すると、呼び出し側の再コンパイルを必要とすることなどがあります。大規模な開発では、プログラムのビルド時間も開発効率に大きく影響します。

インライン関数は、これを呼び出そうとするすべてのソースファイルに、それぞれまったく同一内容の定義がなければなりません。そのため、複数のソースファイルから呼び出したいのであれば、インライン関数の定義をヘッダファイルに記述して、各ソースファイルからインクルードさせるようにします。

以下は、inline指定子を付加した関数テンプレートの使用例です。

// main.cpp

#include <iostream>
#include "sub.h"

int main()
{
    std::cout << max(10, 20) << std::endl;
    std::cout << max(10.5, 10.1) << std::endl;
    std::cout << max('a', 'c') << std::endl;
}

// sub.h

#ifndef SUB_H_INCLUDED
#define SUB_H_INCLUDED

template <typename T>
inline T max(T a, T b)
{
    return (a) > (b) ? (a) : (b);
}

#endif

実行結果：

20
10.5
c

C++11 で、__cplusplus の置換結果が 201103L に変わりました。

__cplusplusマクロは、Ｃ言語のソースファイルと C++ のソースファイルが混ざったプログラムを作るときに利用されることがあります。

Ｃ言語のソースファイルと、C++ のソースファイルを混在すると、うまくいかないことがあります。たとえば、次のサンプルプログラムはリンクエラーになります。

// main.cpp
#include <iostream>
#include "sub.h"

int main()
{
    std::cout << function(100) << std::endl;
}

/* sub.c */
#include "sub.h"

int function(int num)
{
    return num * 2;
}

/* sub.h */

int function(int num);

main.cpp は C++ で書かれています。一方、sub.c と sub.h はＣ言語のつもりで書かれています。「つもり」というのは、sub.c も sub.h も、C++ とみなしても何ら問題のないソースコードになっているからです。ここでは、拡張子が .c であることで、コンパイラがＣ言語であるとみなしているものとします。

Visual Studio が拡張子によってプログラミング言語を判断することについて、「Visual Studio編＞拡張子について」のページで取り上げています。このページでは、拡張子によらず、強制的に言語を指定する方法も取り上げています。

このプログラムを、Visual Studio でビルドすると、次のようなログが出ます。

1>コンパイルしています...
1>sub.c
1>コンパイルしています...
1>main.cpp
1>リンクしています...
1>main.obj : error LNK2019: 未解決の外部シンボル "int __cdecl function(int)" (?function@@YAHH@Z) が関数 _main で参照されました。
1>C:\test.exe : fatal error LNK1120: 外部参照 1 が未解決です。

sub.c 、main.cpp のコンパイルには成功していますが、リンクの過程で失敗しているようです。

ログを良く見ると、“?function@@YAHH@Z” という謎の文字列が含まれています。この文字列は、C++ としてコンパイルされる main.cpp での、function関数の呼び名です。このように C++ では、関数などの名前が、コンパイラによって別の名前に置き換えられることがあります。これは、名前マングリング（名前修飾）と呼ばれています。

つまり、main.cpp は function関数を “?function@@YAHH@Z” という名前で main.obj に出力しています。一方、Ｃ言語としてコンパイルされる sub.c では恐らく、“function” を “function” という名前のままで sub.obj に出力します。そのため、リンクの段階で、“?function@@YAHH@Z” の定義を見つけることができずにエラーになります。

【上級】Ｃ言語では、名前マングリングに関する仕様は特に決められていません。必要がなければ行わないでしょうし、処理系が独自に行うかもしれません。いずれにしても、Ｃ言語と C++ とでルールが異なるのなら、この問題が起こります。

なお、名前マングリングでどのような名前になるかは、処理系依存です。

名前マングリング後の名前を知る方法が用意されていることがあります。

名前マングリングが必要な理由はいくつかありますが、たとえば、関数オーバーロードの存在が代表的です。オーバーロードされた関数群はいずれも同じ名前なので、コンパイル後は何らかのルールで名前を変えておかないと、リンク時に区別を付けられません。

関数オーバーロード以外にも名前マングリングの必要性はあるため、関数オーバーロードを行っていないからといって、名前マングリングが行われないとは限りません。

【上級】たとえば、どの名前空間に含まれているか、どのクラス（第１１章）のメンバであるか、などが関係する可能性があります。いずれにしても、ルールは処理系依存です。

名前マングリングによって、Ｃ言語と C++ の連携がうまくいかないときには、extern “C” という目印を、関数宣言に付けます。こうすると、Ｃ言語のルールに従った名前でコンパイルされます（“C” はＣ言語を意味しています）。

/* sub.h */

extern "C" int function(int num);

あるいは、次のようにも書けます。こちらの表記は、複数の名前にまとめて extern “C” の効果を与えられます。あとで説明しますが、こちらの記法を使うことが多いです。

/* sub.h */

extern "C" {

int function(int num);

}

こうしておけば、C++ のコンパイラが main.cpp をコンパイルするとき、“function” という名前をＣ言語のルールで出力します。これで、sub.obj に出力される名前と一致するはずなので、正しくリンクできます。

しかしまだ問題があります。extern “C” 自体が C++ 独自の機能であるため、Ｃ言語としてコンパイルするソースファイルからこの記述が見えていると、コンパイルエラーになってしまいます。

そこで、__cplusplusマクロを利用して、C++ としてコンパイルされるときにだけ、extern “C” が有効になるようにします。

/* sub.h */

#ifdef __cplusplus
extern "C" {
#endif

int function(int num);

#ifdef __cplusplus
}
#endif

このような記述になるため、extern “C” は { } を使った形式で書いた方が便利です。

プログラムの全体像は、次のようになります。

/* main.c */
#include <stdio.h>
#include "sub.h"

int main(void)
{
    printf("%d\n", function(100));
}

// sub.cpp
#include "sub.h"

int function(int num)
{
    return num * 2;
}

/* sub.h */

#ifdef __cplusplus
extern "C" {
#endif

int function(int num);

#ifdef __cplusplus
}
#endif

実行結果：

200