aboutsummaryrefslogtreecommitdiff
path: root/paludis/dep_parser.hh
blob: 88c7e787cbd4fca92f47ac908023012ed06c269d (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
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
/* vim: set sw=4 sts=4 et foldmethod=syntax : */

/*
 * Copyright (c) 2005, 2006 Ciaran McCreesh <ciaran.mccreesh@blueyonder.co.uk>
 *
 * 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_DEP_PARSER_HH
#define PALUDIS_GUARD_PALUDIS_DEP_PARSER_HH 1

#include <paludis/dep_atom.hh>
#include <paludis/dep_lexer.hh>
#include <paludis/util/counted_ptr.hh>
#include <paludis/util/exception.hh>
#include <paludis/util/instantiation_policy.hh>
#include <string>

/** \file
 * Declarations for the DepParser class.
 *
 * \ingroup DepResolver
 * \ingroup Exception
 */

namespace paludis
{
    /**
     * A DepStringParseError is thrown if an error is encountered when parsing
     * a dependency string.
     *
     * \ingroup Exception
     * \ingroup DepResolver
     */
    class DepStringParseError : public DepStringError
    {
        public:
            /**
             * Constructor.
             */
            DepStringParseError(const std::string & dep_string,
                    const std::string & message) throw ();
    };

    /**
     * A DepStringNestingError is thrown if a dependency string does not have
     * properly balanced parentheses.
     */
    class DepStringNestingError : public DepStringParseError
    {
        public:
            /**
             * Constructor.
             */
            DepStringNestingError(const std::string & dep_string) throw ();
    };

    struct DepParserPolicyInterface
    {
        virtual CountedPtr<DepAtom> new_text_atom(const std::string &) const = 0;

        virtual bool permit_any_deps() const = 0;

        virtual ~DepParserPolicyInterface()
        {
        }

    };

    template <typename TextAtom_, bool permit_any_>
    class DepParserPolicy :
        public DepParserPolicyInterface,
        public InstantiationPolicy<DepParserPolicy<TextAtom_, permit_any_>,
            instantiation_method::SingletonAsNeededTag>
    {
        friend class InstantiationPolicy<DepParserPolicy<TextAtom_, permit_any_>,
            instantiation_method::SingletonAsNeededTag>;

        private:
            DepParserPolicy()
            {
            }

        public:
            virtual CountedPtr<DepAtom> new_text_atom(const std::string & s) const
            {
                return CountedPtr<DepAtom>(new TextAtom_(s));
            }

            virtual bool permit_any_deps() const
            {
                return permit_any_;
            }
    };

    template <bool permit_any_>
    class DepParserPolicy<PackageDepAtom, permit_any_> :
        public DepParserPolicyInterface,
        public InstantiationPolicy<DepParserPolicy<PackageDepAtom, permit_any_>,
            instantiation_method::SingletonAsNeededTag>
    {
        friend class InstantiationPolicy<DepParserPolicy<PackageDepAtom, permit_any_>,
            instantiation_method::SingletonAsNeededTag>;

        private:
            DepParserPolicy()
            {
            }

        public:
            virtual CountedPtr<DepAtom> new_text_atom(const std::string & s) const
            {
                if ((! s.empty()) && ('!' == s.at(0)))
                    return CountedPtr<DepAtom>(new BlockDepAtom(
                                CountedPtr<PackageDepAtom>(new PackageDepAtom(s.substr(1)))));
                else
                    return CountedPtr<DepAtom>(new PackageDepAtom(s));
            }

            virtual bool permit_any_deps() const
            {
                return permit_any_;
            }
    };

    /**
     * The DepParser converts string representations of a dependency
     * specification into a DepAtom instance.
     */
    class DepParser :
        private InstantiationPolicy<DepParser, instantiation_method::NonInstantiableTag>
    {
        private:
            typedef DepParserPolicy<PackageDepAtom, true> DefaultPolicy;

        public:
            /**
             * Parse a given dependency string, and return an appropriate
             * DepAtom tree.
             */
            static CompositeDepAtom::ConstPointer parse(const std::string & s,
                    const DepParserPolicyInterface * const policy = DefaultPolicy::get_instance());
    };
}

#endif