summaryrefslogtreecommitdiffhomepage
path: root/dev/BuildKit/IManifestBuilder.h
blob: abb389f9cc2d7ae271a9c2962fbc80376f65148d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
// ============================================================= //
// nebuild
// Copyright (C) 2024-2025, Amlal El Mahrouss, licensed under BSD-3 license.
// ============================================================= //

#pragma once

#include <BuildKit/Defines.h>

#define NEBUILD_MANIFEST_BUILDER : public ::NeBuild::IManifestBuilder

namespace NeBuild {
/// =========================================================== ///
/// @brief Builder interface class.
/// @note This class is meant to be used as an interface.
/// =========================================================== ///
class IManifestBuilder {
 public:
  IManifestBuilder()          = default;
  virtual ~IManifestBuilder() = default;

  IManifestBuilder& operator=(const IManifestBuilder&) = default;
  IManifestBuilder(const IManifestBuilder&)            = default;

  /// =========================================================== ///
  /// @brief Builds a TOML target from a file.
  /// @param arg_sz filename size (must be 1 or greater).
  /// @param arg_val filename path (must be a valid language file).
  /// @retval true building has succeeded.
  /// @retval false fail to build, see error message.
  /// =========================================================== ///
  virtual bool BuildTarget(const std::string& arg, const bool dry_run = false) = 0;

  /// =========================================================== ///
  /// @brief Returns the build system name.
  /// =========================================================== ///
  virtual const char* BuildSystem() = 0;
};
}  // namespace NeBuild