Заголовкові файли у

Про концепцію Заголовкові файли

У 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