#includeの意味

Question

ソースファイルのはじめに#include<> や #include ~.hppを記述するやり方は見慣れていて特に何も考えずスルーしていたのですが、最近ソースファイルの途中で#includeを記述しているのを見かけました。

これはどういった技術名？テクニック名？なんでしょうか？
何を行う時に使用するのでしょうか教えてください。
僕が見たのは以下のような使い方です。(うる覚えです)

bbb.cファイル
struct a{
~;
~;
~;
};

a = {
'#include aaaa.h
};

aaaa.hファイル
'#define MACRO(x,y,z) {z,y,z},

extern {
'MACRO(x1,y1,z1)
：
：
：
}

Answer 1

こんにちは。

私も名前は知らないのですが、時々使います。
#define MACRO(...は、bbb.cファイル側にあるはずです。
aaaa.hファイルには、下記のようなイメージの筈です。

MACRO(x1,y1,z1)
MACRO(x2,y2,z2)
MACRO(x3,y3,z3)

#define MACRO(x,y,z) {x,y,z},と定義した場合、aaaa.hは下記のように展開されます。

{x1,y1,z1},
{x2,y2,z2},
{x3,y3,z3},

これをインクルードした結果、bbbb.cファイルは下記のように展開されます。

struct a{ 
    ~; 
    ~; 
    ~; 
};

a = { 
{x1,y1,z1},
{x2,y2,z2},
{x3,y3,z3},
};

もしかすると、x1,y1,z1を{"x1","y1","z1"}のような文字列で受け取りたい場合もあるかもしれません。
その時は、`#define MACRO(x,y,z) {#x,#y,#z},
と定義すればできます。
このように「本質的に同じものを異なる形式で解釈したいものが、多数ある時」に使うと便利なテクニックです。

デバッグがたいへんやりにくくなりますので痛し痒しですが、本質的に同じものを書式を変えて何度も書くよりは良いと思います。

Comments

[FfJab]

ご回答してくださりありがとうございます！
僕の見たコードをもとに（うるおぼえなのにありがとうございます）、展開後の形を示してくださったのでイメージがしやすく大変助かりました。
＞「本質的に同じものを異なる形式で解釈したいものが、多数ある時」に使うと便利なテクニック
このテクニックをどういう場合に使うとよいかまで教えていただき大変勉強になりました。

Answer 2

プリプロセッサの普通の機能です。

プリプロセッサの#includeディレクティブは、「#include <ファイル名>」または「#include "ファイル名"」の部分をそのファイルの内容に置き換えたものをコンパイラ本体に渡す、それ未満でもそれを超えるものでもありません。インクルードされるファイルにどのようなことが書かれていても、#includeディレクティブをどこで使っても、プリプロセッサは機械的にマージしてコンパイラ本体に渡すので、C/C++言語的な事項に関してはコンパイラ本体にお任せです。

ご存じかと思いますが、マクロの展開、#ifdefディレクティブなどに基づくコードの抑制、#ifディレクティブの右に書かれた定数式の評価などをプリプロセッサが行います。コメント/* */ // の除去をプリプロセッサで行うコンパイラもありますね。

マクロ定義や関数のプロトタイプ宣言、構造体・クラスの宣言をヘッダファイルと呼ばれるファイルに分離して、ソースファイルの先頭部分の#includeディレクティブによってコンパイル時にマージするのは、その方が開発・保守効率が良いゆえの慣習です。#includeディレクティブをソースファイルの最後に持ってきてもプリプロセッサ的には問題ありません。ただ、C++のメンバの定義にはメンバの宣言が先行していなければコンパイラ本体でエラーになるので、そうしない慣例になっているにすぎません。また、同クラス同関数定義をヘッダファイルに書き、複数のソースファイルでインクルードすればリンクエラーになります。

ぶっちゃけ、ヘッダファイルに何を書こうが、#includeディレクティブをどのように使おうが、エラーにならない限り自由です。でも、実際上の約束があることはご存じのとおりです。宣言を手動でいちいち複数のソースファイル間でコピペしていれば保守性が悪いからしません。

よって、エラーにならず保守性が良ければ、ヘッダファイル・#includeディレクティブをどのような利用法も可能だと思います。

gccでは-Eオプション、他のコンパイラでも同様の手段でプリプロセッサ実行だけがなされるので、その結果をご覧になると良くわかるかと思います。

Comments

[FfJab]

ご回答してくださりありがとうございます。
プリプロセッサによって#include ～のファイル内容が記述した場所に展開される（記述する場所はとわない）。
ただし、コンパイラでエラーとならないように記述する箇所にはプログラマ自身で気をつける必要があると理解することができました！

[FfJab]

gccで-Eオプションを利用して結果もみてみたいと思います！
教えてくださりありがとうございます！

Answer 3

各種データ値を開発終盤まで正確に値は決められない（たびたび変更しながら調整していく）けど、ファイル化して実行時に読ませるということはしたくない、できれば実行モジュールに埋め込みたい、かといってハードコーディングだとその都度ソースコードを編集しないといけなくなりミスを誘発してしまうのでそれは避けたい、というときに、ソースコードの「データ部分だけを別ファイル」にして、それをソースコードの途中に「埋め込む」という手法をとることがよくあります。その際、データをカンマで区切ったCSVファイルのような形式にすることが多いです。配列や構造体などの代入書式と親和性が高いからです。
データを別のツール（例えばExcelなど）で管理し、それをテキストファイルで出力してソースコードに埋め込む、というように使うことも多いです。

ちなみに、私の場合、その目的のファイルに付ける拡張子は.hではなく.incにすることが多いです。そして、ヘッダーファイルとは呼ばずにインクルードファイルと呼びます。なぜなら、ヘッダーではないからです（ヘッダーファイルと同じ場所でインクルードするとエラーになります）。

これはどういった技術名？テクニック名？なんでしょうか？

すみません。私も聞いたことがありません。

Comments

[FfJab]

ご回答してくださりありがとうございました！
「データ部分だけを別ファイル」にして、それをソースコードの途中に「埋め込む」テクニックなんですね。
どういう目的でこのテクニックを使うのかも教えていただきありがとうございます。
「データ部分だけを別ファイル」にしたものは、通常のヘッダファイルと同じように何も考えずに先頭に書くとコンパイルエラーを起こすこともわかりました。このファイルの管理方法については別途考えます。ヘッダファイルと区別して拡張子を変更したほうが僕もわかりやすいと思いました。

Answer 4

コンパイラにとって#includeの位置は、重要です。#include は任意のファイルを書かれた場所に展開する機能によりその場所に内容を展開します。
（実際はプリプロセッサが展開してcコンパイラに渡すのですが）

・ファイルincl1.hとincl2.hで値を定義します。
>cat incl1.h
int a1;
>cat incl2.h
char *a2;

>cat hoge.c
#include <stdio.h>↲
↲
・下記のプログラムはコンパイルエラーです。（a2が定義されていない）a2をincl2.hの後にします。
int main(int argc, char *argv[])↲
{↲
#include "incl1.h"↲
  a1=1;↲
  a2="bhh";↲
#include "incl2.h"↲
}↲
~

Comments

[FfJab]

ご回答してくださりありがとうございます。
ヘッダファイルがいつも先頭に書かれているのは、ご回答の中にあるコンパイルエラー例をなくすための習慣のようなものだと理解することができました。
いつもおまじないのように先頭でinclude記述をしていましたが意味を理解することができ勉強になりました。

Answer 5

テクニックでもなんでもありません。
#include なんちゃら は なんちゃらの内容がそこに書き下されたのと同じ。

なのでたとえば

// CSV.h ここから
  1, 2, 3, 4,
  5, 6, 7, 8,
// CSV.h ここまで

// use.cpp
int a[] = {
#include "CSV.h"
};

と書けば

int a[] = {
  1, 2, 3, 4,
  5, 6, 7, 8,
};

ってことになります。

Comments

[FfJab]

素早く回答してくださりありがとうございます！
シンプルで例も出していただいたのでわかりやすかったです。勉強になります！