fake_package_id.hh

/* vim: set sw=4 sts=4 et foldmethod=syntax : */
 
/*
 * Copyright (c) 2007, 2008, 2009, 2010, 2011, 2014 Ciaran McCreesh
 *
 * This file is part of the Paludis package manager. Paludis is free software;
 * you can redistribute it and/or modify it under the terms of the GNU General
 * Public License version 2, as published by the Free Software Foundation.
 *
 * Paludis is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
 * Place, Suite 330, Boston, MA  02111-1307  USA
 */
 
#ifndef PALUDIS_GUARD_PALUDIS_REPOSITORIES_FAKE_FAKE_PACKAGE_ID_HH
#define PALUDIS_GUARD_PALUDIS_REPOSITORIES_FAKE_FAKE_PACKAGE_ID_HH 1
 
#include <paludis/package_id.hh>
#include <paludis/metadata_key.hh>
#include <paludis/mask.hh>
#include <paludis/util/set.hh>
#include <functional>
 
namespace paludis
{
    class FakeRepositoryBase;
 
    template <typename C_>
    class PALUDIS_VISIBLE FakeMetadataCollectionKey :
        public MetadataCollectionKey<C_>
    {
        protected:
            Pimp<FakeMetadataCollectionKey<C_> > _imp;
 
            FakeMetadataCollectionKey(const std::string &, const std::string &, const MetadataKeyType,
                    const std::shared_ptr<const PackageID> &, const Environment * const);
 
        public:
            ~FakeMetadataCollectionKey() override;
 
            const std::shared_ptr<const C_> parse_value() const override PALUDIS_ATTRIBUTE((warn_unused_result));
 
            const std::string raw_name() const override PALUDIS_ATTRIBUTE((warn_unused_result));
            const std::string human_name() const override PALUDIS_ATTRIBUTE((warn_unused_result));
            MetadataKeyType type() const override PALUDIS_ATTRIBUTE((warn_unused_result));
 
            const std::string pretty_print_value(
                    const PrettyPrinter &,
                    const PrettyPrintOptions &) const override PALUDIS_ATTRIBUTE((warn_unused_result));
    };
 
    class PALUDIS_VISIBLE FakeMetadataKeywordSetKey :
        public FakeMetadataCollectionKey<KeywordNameSet>
    {
        public:
            FakeMetadataKeywordSetKey(const std::string &, const std::string &, const std::string &, const MetadataKeyType,
                    const std::shared_ptr<const PackageID> &, const Environment * const);
 
            void set_from_string(const std::string &);
 
            const std::string pretty_print_value(
                    const PrettyPrinter &,
                    const PrettyPrintOptions &) const override PALUDIS_ATTRIBUTE((warn_unused_result));
    };
 
    template <typename C_>
    class PALUDIS_VISIBLE FakeMetadataSpecTreeKey :
        public MetadataSpecTreeKey<C_>
    {
        private:
            Pimp<FakeMetadataSpecTreeKey<C_> > _imp;
 
        public:
            FakeMetadataSpecTreeKey(const std::string &, const std::string &, const std::string &,
                    const std::function<const std::shared_ptr<const C_> (const std::string &)> &, const MetadataKeyType);
            ~FakeMetadataSpecTreeKey() override;
 
            const std::shared_ptr<const C_> parse_value() const
                override PALUDIS_ATTRIBUTE((warn_unused_result));
 
            void set_from_string(const std::string &);
 
            const std::string raw_name() const override PALUDIS_ATTRIBUTE((warn_unused_result));
            const std::string human_name() const override PALUDIS_ATTRIBUTE((warn_unused_result));
            MetadataKeyType type() const override PALUDIS_ATTRIBUTE((warn_unused_result));
 
            const std::string pretty_print_value(
                    const PrettyPrinter &,
                    const PrettyPrintOptions &) const override PALUDIS_ATTRIBUTE((warn_unused_result));
    };
 
    template <>
    class PALUDIS_VISIBLE FakeMetadataSpecTreeKey<FetchableURISpecTree> :
        public MetadataSpecTreeKey<FetchableURISpecTree>
    {
        private:
            Pimp<FakeMetadataSpecTreeKey<FetchableURISpecTree> > _imp;
 
        public:
            FakeMetadataSpecTreeKey(const std::string &, const std::string &, const std::string &,
                    const std::function<const std::shared_ptr<const FetchableURISpecTree> (const std::string &)> &,
                    const MetadataKeyType);
            ~FakeMetadataSpecTreeKey() override;
 
            const std::shared_ptr<const FetchableURISpecTree> parse_value() const
                override PALUDIS_ATTRIBUTE((warn_unused_result));
 
            void set_from_string(const std::string &);
 
            const std::shared_ptr<const URILabel> initial_label() const
                override PALUDIS_ATTRIBUTE((warn_unused_result));
 
            const std::string raw_name() const override PALUDIS_ATTRIBUTE((warn_unused_result));
            const std::string human_name() const override PALUDIS_ATTRIBUTE((warn_unused_result));
            MetadataKeyType type() const override PALUDIS_ATTRIBUTE((warn_unused_result));
 
            const std::string pretty_print_value(
                    const PrettyPrinter &,
                    const PrettyPrintOptions &) const override PALUDIS_ATTRIBUTE((warn_unused_result));
    };
 
    template <>
    class PALUDIS_VISIBLE FakeMetadataSpecTreeKey<DependencySpecTree> :
        public MetadataSpecTreeKey<DependencySpecTree>
    {
        private:
            Pimp<FakeMetadataSpecTreeKey<DependencySpecTree> > _imp;
 
        public:
            FakeMetadataSpecTreeKey(const std::string &, const std::string &, const std::string &,
                    const std::function<const std::shared_ptr<const DependencySpecTree> (const std::string &)> &,
                    const std::shared_ptr<const DependenciesLabelSequence> &,
                    const MetadataKeyType);
            ~FakeMetadataSpecTreeKey() override;
 
            const std::shared_ptr<const DependencySpecTree> parse_value() const
                override PALUDIS_ATTRIBUTE((warn_unused_result));
 
            void set_from_string(const std::string &);
 
            const std::shared_ptr<const DependenciesLabelSequence> initial_labels() const
                override PALUDIS_ATTRIBUTE((warn_unused_result));
 
            const std::string raw_name() const override PALUDIS_ATTRIBUTE((warn_unused_result));
            const std::string human_name() const override PALUDIS_ATTRIBUTE((warn_unused_result));
            MetadataKeyType type() const override PALUDIS_ATTRIBUTE((warn_unused_result));
 
            const std::string pretty_print_value(
                    const PrettyPrinter &,
                    const PrettyPrintOptions &) const override PALUDIS_ATTRIBUTE((warn_unused_result));
    };
 
    class PALUDIS_VISIBLE FakeMetadataChoicesKey :
        public MetadataValueKey<std::shared_ptr<const Choices> >
    {
        private:
            Pimp<FakeMetadataChoicesKey> _imp;
 
        public:
            FakeMetadataChoicesKey(
                    const Environment * const,
                    const std::shared_ptr<const PackageID> &);
            ~FakeMetadataChoicesKey() override;
 
            void add(const std::string &, const std::string &);
            const std::shared_ptr<const Choices> parse_value() const override PALUDIS_ATTRIBUTE((warn_unused_result));
 
            const std::string raw_name() const override PALUDIS_ATTRIBUTE((warn_unused_result));
            const std::string human_name() const override PALUDIS_ATTRIBUTE((warn_unused_result));
            MetadataKeyType type() const override PALUDIS_ATTRIBUTE((warn_unused_result));
    };
 
    class PALUDIS_VISIBLE FakeUnacceptedMask :
        public UnacceptedMask
    {
        private:
            Pimp<FakeUnacceptedMask> _imp;
 
        public:
            FakeUnacceptedMask(const char, const std::string &, const std::string &);
            ~FakeUnacceptedMask() override;
 
            char key() const override;
            const std::string description() const override;
            const std::string unaccepted_key_name() const override;
    };
 
    class PALUDIS_VISIBLE FakeUnsupportedMask :
        public UnsupportedMask
    {
        public:
            FakeUnsupportedMask();
            ~FakeUnsupportedMask() override;
 
            char key() const override;
            const std::string description() const override;
            const std::string explanation() const override;
    };
 
    /**
     * A PackageID in a FakeRepository or a FakeInstalledRepository.
     *
     * Various keys can be modified.
     *
     * \ingroup g_fake_repository
     * \since 0.26
     */
    class PALUDIS_VISIBLE FakePackageID :
        public PackageID,
        public std::enable_shared_from_this<FakePackageID>
    {
        private:
            Pimp<FakePackageID> _imp;
 
        protected:
            void need_keys_added() const override;
            void need_masks_added() const override;
 
        public:
            ///\name Basic operations
            ///\{
 
            FakePackageID(const Environment * const e,
                    const RepositoryName &,
                    const QualifiedPackageName &, const VersionSpec &);
            ~FakePackageID() override;
 
            ///\}
 
            const std::string canonical_form(const PackageIDCanonicalForm) const override;
 
            const QualifiedPackageName name() const override;
            const VersionSpec version() const override;
            const RepositoryName repository_name() const override;
            PackageDepSpec uniquely_identifying_spec() const override;
 
            const std::shared_ptr<const MetadataValueKey<Slot> > slot_key() const override;
            const std::shared_ptr<const MetadataCollectionKey<KeywordNameSet> > keywords_key() const override;
            const std::shared_ptr<const MetadataSpecTreeKey<DependencySpecTree> > dependencies_key() const override;
            const std::shared_ptr<const MetadataSpecTreeKey<DependencySpecTree> > build_dependencies_key() const override;
            const std::shared_ptr<const MetadataSpecTreeKey<DependencySpecTree> > run_dependencies_key() const override;
            const std::shared_ptr<const MetadataSpecTreeKey<DependencySpecTree> > post_dependencies_key() const override;
            const std::shared_ptr<const MetadataSpecTreeKey<FetchableURISpecTree> > fetches_key() const override;
            const std::shared_ptr<const MetadataSpecTreeKey<SimpleURISpecTree> > homepage_key() const override;
            const std::shared_ptr<const MetadataValueKey<std::string> > short_description_key() const override;
            const std::shared_ptr<const MetadataValueKey<std::string> > long_description_key() const override;
            const std::shared_ptr<const MetadataTimeKey> installed_time_key() const override;
            const std::shared_ptr<const MetadataValueKey<FSPath> > fs_location_key() const override;
            virtual const std::shared_ptr<const MetadataValueKey<long> > size_of_download_required_key() const;
            virtual const std::shared_ptr<const MetadataValueKey<long> > size_of_all_distfiles_key() const;
            const std::shared_ptr<const MetadataCollectionKey<Set<std::string> > > behaviours_key() const override;
            const std::shared_ptr<const MetadataCollectionKey<Set<std::string> > > from_repositories_key() const override;
            const std::shared_ptr<const MetadataValueKey<std::shared_ptr<const Choices> > > choices_key() const override;
 
            const std::shared_ptr<const MetadataSpecTreeKey<LicenseSpecTree> > license_key() const;
 
            ///\name Modifiable keys
            ///\{
 
            const std::shared_ptr<FakeMetadataKeywordSetKey> keywords_key();
            const std::shared_ptr<FakeMetadataSpecTreeKey<DependencySpecTree> > build_dependencies_key();
            const std::shared_ptr<FakeMetadataSpecTreeKey<DependencySpecTree> > run_dependencies_key();
            const std::shared_ptr<FakeMetadataSpecTreeKey<DependencySpecTree> > post_dependencies_key();
            const std::shared_ptr<FakeMetadataSpecTreeKey<FetchableURISpecTree> > fetches_key();
            const std::shared_ptr<FakeMetadataSpecTreeKey<SimpleURISpecTree> > homepage_key();
            const std::shared_ptr<FakeMetadataChoicesKey> choices_key();
 
            const std::shared_ptr<Set<std::string> > behaviours_set();
 
            void set_slot(const SlotName &);
            void set_slot(const SlotName &, const SlotName &);
 
            ///\}
 
            char use_expand_separator() const;
 
            bool arbitrary_less_than_comparison(const PackageID &) const override;
            std::size_t extra_hash_value() const override;
 
            bool supports_action(const SupportsActionTestBase &) const override PALUDIS_ATTRIBUTE((warn_unused_result));
            void perform_action(Action &) const override;
 
            const std::shared_ptr<const Contents> contents() const override;
 
    };
}
 
#endif