Exheredludis/paludis/slot_requirement.hh

/* vim: set sw=4 sts=4 et foldmethod=syntax : */

/*
 * Copyright (c) 2008, 2011 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_SLOT_REQUIREMENT_HH
#define PALUDIS_GUARD_PALUDIS_SLOT_REQUIREMENT_HH 1

#include <paludis/slot_requirement-fwd.hh>
#include <paludis/name-fwd.hh>
#include <paludis/util/visitor.hh>
#include <paludis/util/type_list.hh>
#include <memory>

namespace paludis
{
    /**
     * A SlotRequirement represents a PackageDepSpec's slot
     * requirement, such as <code>:3</code>, <code>:*</code>,
     * <code>:=</code> or <code>:=3</code>.
     *
     * \ingroup g_dep_spec
     */
    class PALUDIS_VISIBLE SlotRequirement :
        public virtual DeclareAbstractAcceptMethods<SlotRequirement, MakeTypeList<
            SlotExactPartialRequirement, SlotExactFullRequirement, SlotAnyAtAllLockedRequirement, SlotAnyPartialLockedRequirement, SlotAnyUnlockedRequirement, SlotUnknownRewrittenRequirement>::Type>
    {
        public:
            /**
             * String representation, including the leading colon. Not suitable
             * for parsing.
             */
            virtual const std::string as_string() const PALUDIS_ATTRIBUTE((warn_unused_result)) = 0;

            /**
             * If we are a rewritten slot, return what the original requirement
             * would have been; otherwise, returns null.
             *
             * \since 0.79
             */
            virtual const std::shared_ptr<const SlotRequirement> maybe_original_requirement_if_rewritten() const PALUDIS_ATTRIBUTE((warn_unused_result)) = 0;
    };

    /**
     * A SlotExactPartialRequirement is a SlotRequirement for exact slot
     * requirements on the main part of the slot, such as <code>:3</code> or
     * <code>:3=3</code>.
     *
     * \ingroup g_dep_spec
     */
    class PALUDIS_VISIBLE SlotExactPartialRequirement :
        public SlotRequirement,
        public ImplementAcceptMethods<SlotRequirement, SlotExactPartialRequirement>
    {
        public:
            /**
             * The slot in question.
             */
            virtual const SlotName slot() const PALUDIS_ATTRIBUTE((warn_unused_result)) = 0;
    };

    /**
     * A SlotExactFullRequirement is a SlotRequirement for exact slot
     * requirements on both parts of the slot, such as <code>:3/4</code>
     * or <code>:3=3/4</code>.
     *
     * \ingroup g_dep_spec
     */
    class PALUDIS_VISIBLE SlotExactFullRequirement :
        public SlotRequirement,
        public ImplementAcceptMethods<SlotRequirement, SlotExactFullRequirement>
    {
        public:
            /**
             * The slot parts in question.
             */
            virtual const std::pair<SlotName, SlotName> slots() const PALUDIS_ATTRIBUTE((warn_unused_result)) = 0;
    };

    /**
     * A SlotAnyAtAllLockedRequirement is a SlotRequirement for
     * <code>:=</code> slot requirements.
     *
     * \ingroup g_dep_spec
     */
    class PALUDIS_VISIBLE SlotAnyAtAllLockedRequirement :
        public SlotRequirement,
        public ImplementAcceptMethods<SlotRequirement, SlotAnyAtAllLockedRequirement>
    {
    };

    /**
     * A SlotAnyPartialLockedRequirement is a SlotRequirement for
     * <code>:3=</code> slot requirements that do not specify a sub-slot.
     *
     * \ingroup g_dep_spec
     */
    class PALUDIS_VISIBLE SlotAnyPartialLockedRequirement :
        public SlotRequirement,
        public ImplementAcceptMethods<SlotRequirement, SlotAnyPartialLockedRequirement>
    {
        public:
            /**
             * The slot in question.
             */
            virtual const SlotName slot() const PALUDIS_ATTRIBUTE((warn_unused_result)) = 0;
    };

    /**
     * A SlotAnyUnlockedRequirement is a SlotRequirement for
     * <code>:*</code> slot requirements.
     *
     * \ingroup g_dep_spec
     */
    class PALUDIS_VISIBLE SlotAnyUnlockedRequirement :
        public SlotRequirement,
        public ImplementAcceptMethods<SlotRequirement, SlotAnyUnlockedRequirement>
    {
    };

    /**
     * A SlotUnknownRewrittenRequirement is a SlotRequirement for the
     * <code>maybe_original_requirement_if_written()</code> method of
     * <code>:3/3.1=</code> slot requirements that do not indicate whether
     * they were originally of <code>:=</code> or <code>:3=</code> type.
     *
     * \ingroup g_dep_spec
     */
    class PALUDIS_VISIBLE SlotUnknownRewrittenRequirement :
        public SlotRequirement,
        public ImplementAcceptMethods<SlotRequirement, SlotUnknownRewrittenRequirement>
    {
        public:
            /**
             * The slot that the original spec might have specified, if
             * it was of <code>:3=</code> type.
             */
            virtual const SlotName slot() const PALUDIS_ATTRIBUTE((warn_unused_result)) = 0;
    };
}

#endif