vcpkg/toolsrc/include/vcpkg_Build.h

#pragma once

#include "CStringView.h"
#include "PackageSpec.h"
#include "StatusParagraphs.h"
#include "VcpkgPaths.h"
#include "vcpkg_Files.h"
#include "vcpkg_optional.h"

#include <array>
#include <map>
#include <vector>

namespace vcpkg::Build
{
    enum class UseHeadVersion
    {
        NO = 0,
        YES
    };

    inline UseHeadVersion to_use_head_version(const bool value)
    {
        return value ? UseHeadVersion::YES : UseHeadVersion::NO;
    }

    inline bool to_bool(const UseHeadVersion value) { return value == UseHeadVersion::YES; }

    enum class AllowDownloads
    {
        NO = 0,
        YES
    };

    inline AllowDownloads to_allow_downloads(const bool value)
    {
        return value ? AllowDownloads::YES : AllowDownloads::NO;
    }

    inline bool to_bool(const AllowDownloads value) { return value == AllowDownloads::YES; }

    struct BuildPackageOptions
    {
        UseHeadVersion use_head_version;
        AllowDownloads allow_downloads;
    };

    enum class BuildResult
    {
        NULLVALUE = 0,
        SUCCEEDED,
        BUILD_FAILED,
        POST_BUILD_CHECKS_FAILED,
        FILE_CONFLICTS,
        CASCADED_DUE_TO_MISSING_DEPENDENCIES
    };

    static constexpr std::array<BuildResult, 5> BUILD_RESULT_VALUES = {
        BuildResult::SUCCEEDED,
        BuildResult::BUILD_FAILED,
        BuildResult::POST_BUILD_CHECKS_FAILED,
        BuildResult::FILE_CONFLICTS,
        BuildResult::CASCADED_DUE_TO_MISSING_DEPENDENCIES};

    const std::string& to_string(const BuildResult build_result);
    std::string create_error_message(const BuildResult build_result, const PackageSpec& spec);
    std::string create_user_troubleshooting_message(const PackageSpec& spec);

    /// <summary>
    /// Settings from the triplet file which impact the build environment and post-build checks
    /// </summary>
    struct PreBuildInfo
    {
        /// <summary>
        /// Runs the triplet file in a "capture" mode to create a PreBuildInfo
        /// </summary>
        static PreBuildInfo from_triplet_file(const VcpkgPaths& paths, const Triplet& triplet);

        std::string target_architecture;
        std::string cmake_system_name;
        std::string cmake_system_version;
        std::string platform_toolset;
    };

    std::wstring make_build_env_cmd(const PreBuildInfo& pre_build_info, const Toolset& toolset);

    struct ExtendedBuildResult
    {
        BuildResult code;
        std::vector<PackageSpec> unmet_dependencies;
    };

    struct BuildPackageConfig
    {
        BuildPackageConfig(const SourceParagraph& src,
                           const Triplet& triplet,
                           fs::path&& port_dir,
                           const BuildPackageOptions& build_package_options)
            : src(src)
            , scf(nullptr)
            , triplet(triplet)
            , port_dir(std::move(port_dir))
            , build_package_options(build_package_options)
            , feature_list(nullptr)
        {
        }

        BuildPackageConfig(const SourceControlFile& src,
                           const Triplet& triplet,
                           fs::path&& port_dir,
                           const BuildPackageOptions& build_package_options,
                           const std::unordered_set<std::string>& feature_list)
            : src(*src.core_paragraph)
            , scf(&src)
            , triplet(triplet)
            , port_dir(std::move(port_dir))
            , build_package_options(build_package_options)
            , feature_list(&feature_list)
        {
        }

        const SourceParagraph& src;
        const SourceControlFile* scf;
        const Triplet& triplet;
        fs::path port_dir;
        const BuildPackageOptions& build_package_options;
        const std::unordered_set<std::string>* feature_list;
    };

    ExtendedBuildResult build_package(const VcpkgPaths& paths,
                                      const BuildPackageConfig& config,
                                      const StatusParagraphs& status_db);

    enum class BuildPolicy
    {
        EMPTY_PACKAGE,
        DLLS_WITHOUT_LIBS,
        ONLY_RELEASE_CRT,
        EMPTY_INCLUDE_FOLDER,
        ALLOW_OBSOLETE_MSVCRT,
        // Must be last
        COUNT,
    };

    constexpr std::array<BuildPolicy, size_t(BuildPolicy::COUNT)> G_ALL_POLICIES = {
        BuildPolicy::EMPTY_PACKAGE,
        BuildPolicy::DLLS_WITHOUT_LIBS,
        BuildPolicy::ONLY_RELEASE_CRT,
        BuildPolicy::EMPTY_INCLUDE_FOLDER,
        BuildPolicy::ALLOW_OBSOLETE_MSVCRT,
    };

    const std::string& to_string(BuildPolicy policy);
    CStringView to_cmake_variable(BuildPolicy policy);

    struct BuildPolicies
    {
        BuildPolicies() = default;
        BuildPolicies(std::map<BuildPolicy, bool>&& map) : m_policies(std::move(map)) {}

        bool is_enabled(BuildPolicy policy) const
        {
            const auto it = m_policies.find(policy);
            if (it != m_policies.cend()) return it->second;
            return false;
        }

    private:
        std::map<BuildPolicy, bool> m_policies;
    };

    enum class LinkageType : char
    {
        DYNAMIC,
        STATIC,
    };

    Optional<LinkageType> to_linkage_type(const std::string& str);

    struct BuildInfo
    {
        LinkageType crt_linkage;
        LinkageType library_linkage;

        Optional<std::string> version;

        BuildPolicies policies;
    };

    BuildInfo read_build_info(const Files::Filesystem& fs, const fs::path& filepath);
}