Current File : /home/inlingua/miniconda3/include/mamba/specs/channel.hpp

// Copyright (c) 2023, QuantStack and Mamba Contributors
//
// Distributed under the terms of the BSD 3-Clause License.
//
// The full license is in the file LICENSE, distributed with this software.

#include <optional>
#include <string>
#include <string_view>
#include <unordered_map>
#include <vector>

#include "mamba/specs/authentication_info.hpp"
#include "mamba/specs/conda_url.hpp"
#include "mamba/specs/error.hpp"
#include "mamba/specs/unresolved_channel.hpp"
#include "mamba/util/flat_set.hpp"
#include "mamba/util/weakening_map.hpp"

#ifndef MAMBA_SPECS_CHANNEL_HPP
#define MAMBA_SPECS_CHANNEL_HPP

namespace mamba::specs
{
    struct ChannelResolveParams;
    struct ChannelResolveParamsView;

    class Channel
    {
    public:

        using platform_list = util::flat_set<std::string>;
        using channel_list = std::vector<Channel>;

        [[nodiscard]] static auto resolve(  //
            UnresolvedChannel uc,
            const ChannelResolveParams& params
        ) -> expected_parse_t<channel_list>;

        [[nodiscard]] static auto resolve(  //
            UnresolvedChannel uc,
            ChannelResolveParamsView params
        ) -> expected_parse_t<channel_list>;

        Channel(CondaURL url, std::string display_name, platform_list platforms = {});
        Channel(std::vector<CondaURL> mirror_urls, std::string display_name, platform_list platforms = {});

        [[nodiscard]] auto is_package() const -> bool;

        [[nodiscard]] auto mirror_urls() const -> const std::vector<CondaURL>&;
        [[nodiscard]] auto platform_mirror_urls() const -> std::vector<CondaURL>;
        [[nodiscard]] auto platform_mirror_urls(const std::string_view platform) const
            -> std::vector<CondaURL>;

        [[nodiscard]] auto url() const -> const CondaURL&;
        auto clear_url() -> const CondaURL;
        void set_url(CondaURL url);

        [[nodiscard]] auto platform_urls() const -> std::vector<CondaURL>;

        [[nodiscard]] auto platform_url(std::string_view platform) const -> CondaURL;

        [[nodiscard]] auto platforms() const -> const platform_list&;
        auto clear_platforms() -> platform_list;
        void set_platforms(platform_list platforms);

        /*
         * This ID is a cross URL id, and is dependent on the
         * channel_alias when the channel has not been specified in
         * the new mirrored_channel section of the configuration.
         */
        [[nodiscard]] auto id() const -> const std::string&;
        [[nodiscard]] auto display_name() const -> const std::string&;
        auto clear_display_name() -> std::string;
        void set_display_name(std::string display_name);

        enum struct Match
        {
            No,
            InOtherPlatform,
            Full,
        };

        [[nodiscard]] auto url_equivalent_with(const Channel& other) const -> bool;

        [[nodiscard]] auto is_equivalent_to(const Channel& other) const -> bool;

        [[nodiscard]] auto contains_equivalent(const Channel& other) const -> bool;

        [[nodiscard]] auto contains_package(const CondaURL& pkg) const -> Match;

    private:

        CondaURL platform_url_impl(const CondaURL& url, const std::string_view platform) const;

        std::vector<CondaURL> m_mirror_urls;
        std::string m_display_name;
        std::string m_id;
        util::flat_set<std::string> m_platforms;
    };

    struct ChannelResolveParams
    {
        /**
         * The weakener for @ref ResolveParams::custom_channels.
         */
        struct NameWeakener
        {
            /**
             * Return the key unchanged.
             */
            [[nodiscard]] auto make_first_key(std::string_view key) const -> std::string_view;

            /**
             * Remove the last element of the '/'-separated name.
             */
            [[nodiscard]] auto weaken_key(std::string_view key) const
                -> std::optional<std::string_view>;
        };

        template <typename Key, typename Value>
        using name_map = util::weakening_map<std::unordered_map<Key, Value>, NameWeakener>;

        using platform_list = util::flat_set<std::string>;
        using channel_list = std::vector<Channel>;
        using channel_map = name_map<std::string, Channel>;
        using multichannel_map = name_map<std::string, channel_list>;

        platform_list platforms = {};
        CondaURL channel_alias = {};
        channel_map custom_channels = {};
        multichannel_map custom_multichannels = {};
        AuthenticationDataBase authentication_db = {};
        std::string home_dir = {};
        std::string current_working_dir = {};
    };

    struct ChannelResolveParamsView
    {
        const ChannelResolveParams::platform_list& platforms = {};
        const CondaURL& channel_alias = {};
        const ChannelResolveParams::channel_map& custom_channels = {};
        const ChannelResolveParams::multichannel_map& custom_multichannels = {};
        const AuthenticationDataBase& authentication_db = {};
        std::string_view home_dir = {};
        std::string_view current_working_dir = {};
    };

    /** Tuple-like equality of all observable members */
    auto operator==(const Channel& a, const Channel& b) -> bool;
    auto operator!=(const Channel& a, const Channel& b) -> bool;
}

template <>
struct std::hash<mamba::specs::Channel>
{
    auto operator()(const mamba::specs::Channel& c) const -> std::size_t;
};

#endif