ファイルの分割について

Question

ファイルの分割で　#ifdef,#define,#endifの意味が分かりません。初心者に理解できるように教えてください。例文などあれば助かります。

Comments

[mjk]

http://c-lang.sevendays-study.com/day7.html

[cateye]

define（英語）の意味は分かりますか？

[mingos]

たぶんインクルードガードの事を言いたいのでしょうが、せめて具体的なコードを示して、
ここが分からないといった質問をしたほうが回答がつきやすいですよ。

Answer 1

ファイルの分割と、条件コンパイルは別の話題です。
それぞれがわからないのか、どちらも単独では理解していても組み合わせたときがわからないのか、どうなんでしょう。

---

ファイルの分割...といってしまうといろいろありますが、
#includeの働きについて言えば、コンパイルの前段階の処理(プリプロセス)として、指定されたファイルを(""と<>でファイルを探す範囲が決められていますが)その場所に展開する、という働きをします。

///aaa.h
  printf(

///main.h
#include <stdio.h>
int main(void){
#include "aaa.h"
  "Hello, World!\n");
  retrun 0;
}

は、コンパイルの前段階でaaa.hが展開されて

#include <stdio.h> //もちろんこちらも展開されますが、長くなるので略
int main(void){
  printf( ///aaa.hが展開された
  "Hello, World\n");
  return 0;
}

となって処理が進行します。

このような作用を持つため、分割コンパイルに於いては、共通で使用する関数や変数、型の定義をヘッダファイルに書いておくと、それぞれのソースファイルで展開されるのでソースファイルが「完成」する、ということになるものです。

---

条件コンパイルもプリプロセス命令です。
#defineは、コンパイル前に第一パラメータの文字列を第二パラメータの文字列に置き換えます。この機能を「マクロ」と呼びます(関数型マクロの話はとりあえず棚上げ)
#ifdefあるいは#if definedは、パラメータとされた文字列(シンボル)がマクロとして定義されていなかった場合、#elseまたは#endifに出会うまでの内容を削除してコンパイルに進みます。定義されていた場合に#elseがあれば、#elseの後#endifまでを削除してコンパイルに進みます。#ifndefあるいは#if not definedは、シンボルがマクロ定義されていた場合、#elseまたは#endifに出会うまでの内容を削除してコンパイルに進みます。

実際には、ソース中の文字列の置き換えの意図がなくても、#ifdef(あるいは同類の#if)で使うためだけにマクロを定義するのもよくあることです。

#define AAA
///AAAを空文字列に置き換える
//#defineの行をコメントにあるいは削除して動作を比べてみる

#include <stdio.h>
int main(void){
  printf(
  #ifdef AAA
    "AAA defined\n"
  #else
    "I don't know 'AAA'\n"
  #endif
  );
  return 0;
}

とすると、#define AAAの行があればこれは

int main(void){
  printf(
    "AAA defined\n"
  );
  return 0;
}

としてコンパイルされ、#define AAAがなければ

int main(void){
  printf(
    "I don't know 'AAA'\n"
  );
  return 0;
}

してコンパイルされます。

---

これらを組み合わせて、「インクルードガード」というテクニックがしばしば(常識といっていいレベルで)使われます。

typedef int I;
typedef int I;

はエラーになりますが、例えば、

///a.h
typedef int I;

///b.h
#include "a.h"
extern I num;

///main.c
#include "a.h"
#include "b.h"
//以下略

などとしてしまうと、これはこれまでの説明でおわかりかと思いますが

///main.c
//a.hの分
typedef int I;
//ここからb.h分
typedef int I;
extern I num;

となってしまい、エラーが発生します。

ここで、

///a.h
#ifndef A_H
#define A_H
typedef int I;
#endif

としておけば、#includeが展開されると

///main.c
//a.hの分
#ifndef A_H //ここではA_Hは定義されていない
#define A_H //ここでA_Hが定義される
typedef int I;
#endif
//ここからb.h分
#ifndef B_H
#define B_H
#ifndef A_H //この時点ではA_Hは定義済なので...
#define A_H //削除される
typedef int I; //削除される
#endif
extern I num;
#endif

結果として

///main.c
typedef int I;
extern I num;

となり、意図しない二重定義を防げる、ということになります。

まぁ、最近では多分#pragma onceが使える環境が多くなっていると思うので、そちらを使っておけばいいのかも知れません。不用意に_A_HとかやっちゃうとこれはC++では予約済シンボル(アンダースコア+大文字で始まるシンボル)だったりするので、何が起こっても文句が言えないです。

Comments

[DMR]

有難うございました。よくわかりました。後、ヘッダファイルを書くときは、using宣言をしないようにするのですか？

[thkana]

https://teratail.com/questions/286946 なんてのも最近あったのでご参考まで。

よくわかっていただけたならわかると思いますが、ヘッダファイル中にグローバルにusingを使ってしまうと、その影響はインクルードしている側に及んでしまいます。インクルードしている側ではusingを使ったという意識はないわけですから、意図せぬトラブルに巻き込まれるかも知れません。

Answer 2

DMRさん

恐らくインクルードガードの質問かと推測して回答します。

インクルードガードは同じヘッダが複数回呼ばれた場合
ifndefからendifまでを無視することで
多重定義を防ぐためのイディオムです。

最初に読み込まれた時defineで定数を定義しておけば
二度目からはifndefに引っかかり定義部分が無視されるという仕組みです。
wikibooks

ちなみに貴方がstd::coutで標準出力を行いたい時など
iostreamヘッダーをインクルードするかと思いますが。

#include <iostream>
#include <iostream>

と二回立て続けに書いても多重定義は発生しません。
それはiostream内にもインクルードガードが
組み込まれているからだと聞いたことがあります(実際確認してませんごめんなさい)

あと使うコンパイラによるかと思われますが
インクルードガードを書かなくとも

#pragma once

の一行でそのファイルを1度しか呼び出せなくすることが出来るので
そちらのほうが簡潔かと思われます。

下記に書き方の例を記します。

インクルードガードの例

//  func.hpp

//  define定数が定義されていないなら#endifまで実行
//  (最初の一回は必ず下記の処理が読み込まれるが二度目からは
//   FUNC_HPPが定義されているので下記#endifまでは無視される)
#ifndef FUNC_HPP
#define FUNC_HPP//  define定数定義
//  この中に宣言や定義を書く
void func();

#endif

//  func.cpp
#include "./func.hpp"
#include <iostream>

//  実装を記載
void func(){
    std::cout << "funcが呼ばれた" << std::endl;
}

//  main.cpp
#include "./func.hpp"

int main(){
    func();//  関数func呼び出し
    return 0;
}

pragma onceの例

//  func.hpp

#pragma once// この一文のみでこのヘッダは一度しか読み込まれない

void func();

//  func.cpp
#include "./func.hpp"
#include <iostream>

//  実装を記載
void func(){
    std::cout << "funcが呼ばれた" << std::endl;
}

//  main.cpp
#include "./func.hpp"

int main(){
    func();//  関数func呼び出し
    return 0;
}