الملفات الرأسية في

نبذة عن الملفات الرأسية

في 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