aboutsummaryrefslogtreecommitdiff
path: root/paludis/repositories/e/dep_lexer.hh
blob: bfdb91ddaee8706ec34712d4ac19bbffc5346f7f (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
/* vim: set sw=4 sts=4 et foldmethod=syntax : */

/*
 * Copyright (c) 2005, 2006, 2007 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_E_DEP_LEXER_HH
#define PALUDIS_GUARD_PALUDIS_E_DEP_LEXER_HH 1

#include <paludis/util/exception.hh>
#include <paludis/util/instantiation_policy.hh>
#include <paludis/util/private_implementation_pattern.hh>
#include <paludis/util/wrapped_forward_iterator-fwd.hh>
#include <string>

/** \file
 * Declarations for the DepLexer class.
 *
 * \ingroup grpdeplexer
 */

namespace paludis
{
    namespace erepository
    {
        /**
         * A DepStringError descendent is thrown if an invalid depend string is
         * encountered.
         *
         * \ingroup grpdeplexer
         * \ingroup grpexceptions
         */
        class PALUDIS_VISIBLE DepStringError : public Exception
        {
            protected:
                /**
                 * Constructor.
                 */
                DepStringError(const std::string & dep_string,
                        const std::string & message) throw ();
        };

        /**
         * A DepStringLexError is thrown if a lex-level error is encountered when
         * parsing a dependency string.
         *
         * \ingroup grpdeplexer
         * \ingroup grpexceptions
         */
        class PALUDIS_VISIBLE DepStringLexError : public DepStringError
        {
            public:
                /**
                 * Constructor.
                 */
                DepStringLexError(const std::string & dep_string,
                        const std::string & message) throw ();
        };

        /**
         * Lexemes used by DepLexer.
         *
         * \see DepLexer
         *
         * \ingroup grpdeplexer
         */
        enum DepLexerLexeme
        {
            dpl_whitespace,        ///< whitespace
            dpl_text,              ///< a package or item name
            dpl_use_flag,          ///< a use flag
            dpl_double_bar,        ///< a double bar ('any' marker)
            dpl_open_paren,        ///< open paren
            dpl_close_paren,       ///< close paren
            dpl_arrow,             ///< arrow
            dpl_label              ///< a label
        };

        /**
         * Converts a dependency string into a sequence of tokens, which are
         * then handled by DepParser.
         *
         * \see DepParser
         * \ingroup grpdeplexer
         * \nosubgrouping
         */
        class PALUDIS_VISIBLE DepLexer :
            private InstantiationPolicy<DepLexer, instantiation_method::NonCopyableTag>,
            private PrivateImplementationPattern<DepLexer>
        {
            public:
                ///\name Iterate over our items
                ///\{

                struct ConstIteratorTag;
                typedef WrappedForwardIterator<ConstIteratorTag,
                        const std::pair<DepLexerLexeme, std::string> > ConstIterator;

                ConstIterator begin() const;

                ConstIterator end() const;

                ///\}

                ///\name Basic operations
                ///\{

                DepLexer(const std::string &);
                ~DepLexer();

                ///\}
        };
    }
}

#endif