ヘッダー の

ヘッダーについて

C++では、宣言と定義を分けて書くことがよくあります。 宣言はヘッダーファイルと呼ばれるファイルにまとめ、それに対応する実装はソースファイルに置きます。 ヘッダーファイルはAPIだと思うとよいでしょう。 ヘッダーファイルを見れば、そのコードベースが_何_を提供しているのかがわかります。_どのように_実装されているかの詳細までは示しません。

ヘッダーとソース

ヘッダーファイルの拡張子として最もよく使われるのは.hです。 プロジェクトによっては.hppを使ったり、拡張子をまったく付けなかったりします。

定義は別の.cppファイルに書きます。 両者を再び結び付けるために、ソースファイルは対応するヘッダーファイルを_インクルード_するところから始まります。

"quick_math"という名前のライブラリを書いて、その中によく使う"super_root"という関数を用意したい場合、ファイルは次のようになります。

// A file named quick_math.h
#pragma once

namespace quick_math {

double super_root(double x, int n);

}

// A file named quick_math.cpp
#include <cmath>

#include "quick_math.h"

double quick_math::super_root(double x, int n) {
    while (n) {
        x = std::sqrt(x), --n;
    }
    return x;
}

実装でだけ必要になるヘッダーをインクルードする場合は、対応する#includeの行はソースファイルにだけ書けば済みます。 ヘッダーでインクルードしたものは、.cppファイルでもそのまま使えます。たとえば、次の例のstringライブラリがそうです。 注意: ;はヘッダーファイルの宣言のあとには必要ですが、ソースファイルの定義のあとには必要ありません。

クラスとヘッダー

クラスはとても複雑になることがあり、ヘッダーとソースの分担との関係はわかりにくく感じられるかもしれません。 構成のひとつとして、実装の詳細はすべてソースファイルに置き、宣言とメンバー変数はすべてヘッダーに置くという方法があります。

// A file named robot_flower.h
#if !defined(ROBOT_FLOWER_H)
#define ROBOT_FLOWER_H

#include <string>

namespace robots {

class Flower {
   private:
    bool needs_water{};
    int size{};
    std::string name{};

   public:
    Flower(std::string name, int size = 0);
    void give_water();
    std::string get_name();
    int get_size();
    void start_next_day();
};
}  // namespace robots
#endif

// A file named robot_flower.cpp
#include "robot_flower.h"

robots::Flower::Flower(std::string name, int size) {
    this->name = "Robotica " + name;
    this->size = size;
}

void robots::Flower::start_next_day() {
    if (!needs_water) ++size;
    needs_water = true;
}

std::string robots::Flower::get_name() { return name; }

int robots::Flower::get_size() { return size; }

ヘッダーをAPIの概要として使う場合、デフォルト値のような情報を探すのはこのヘッダーです。 そのため、コンストラクターのsize仮引数のデフォルト値は、実装側ではなくヘッダー側で指定します。 ソースファイルの定義には、名前空間robotsとクラスFlowerを先頭に付けます。

もうひとつの構成は、.cppファイルをまったく持たない_ヘッダーのみ_のライブラリです。

// A file named robot_flower.h
#pragma once

#include <string>

namespace robots {

class Flower {
   private:
    bool needs_water{};
    int size{};
    std::string name{};

   public:
    Flower(std::string name, int size = 0) {
        this->name = "Robotica " + name;
        this->size = size;
    }
    void give_water() { needs_water = false; }
    std::string get_name() { return name; }
    int get_size() { return size; }
    void start_next_day() {
        if (!needs_water) ++size;
        needs_water = true;
    }
};
}  // namespace robots

プロジェクトではこれらの構成を組み合わせて使うこともあり、それぞれの用途に何が最適かについては多くの議論があります。

インクルードガード

上のヘッダーファイルの例にあった#pragma onceの行にお気づきになったかもしれません。 これはインクルードガードと呼ばれ、コンパイルの間にそのファイルの内容が一度だけインクルードされるようにして、エラーを防ぎます。 インクルードガードには、#ifndefで始まり#endifで終わる、より複雑な書き方もあります。詳しくは後述します。

int myFunction(int n) {
    if (n < 10) {
        return n;
    } else {
        return myOtherFunction(n / 10);
    }
}

int myOtherFunction(int m) { return myFunction(m / 2); }

int myFunction(int n);       // Forward declaration of myFunction
int myOtherFunction(int m);  // Forward declaration of myOtherFunction

// Definition of myFunction
int myFunction(int n) {
    if (n < 0) {
        return 0;
    } else {
        return myOtherFunction(n - 2);
    }
}

// Definition of myOtherFunction
int myOtherFunction(int m) { return myFunction(m / 2); }

#ifndef MY_HEADER_FILE_H /* any name uniquely mapped to file name */
#define MY_HEADER_FILE_H

// file content

#endif