aboutsummaryrefslogtreecommitdiff
path: root/paludis/resolver/serialise.hh
blob: 6262e1be8528af73b49795fa4273e77ed9d99382 (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
158
/* vim: set sw=4 sts=4 et foldmethod=syntax : */

/*
 * Copyright (c) 2009 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_RESOLVER_SERIALISE_HH
#define PALUDIS_GUARD_PALUDIS_RESOLVER_SERIALISE_HH 1

#include <paludis/resolver/serialise-fwd.hh>
#include <paludis/util/attributes.hh>
#include <paludis/util/private_implementation_pattern.hh>
#include <paludis/util/simple_parser-fwd.hh>
#include <paludis/util/wrapped_forward_iterator-fwd.hh>
#include <paludis/environment-fwd.hh>
#include <tr1/memory>
#include <string>
#include <ostream>

namespace paludis
{
    namespace resolver
    {
        namespace serialise
        {
            struct container;
            struct might_be_null;
        }

        template <
            typename Flag1_ = void,
            typename Flag2_ = void,
            typename Flag3_ = void
            >
        struct SerialiserFlags
        {
            typedef Flag1_ Flag1;
            typedef Flag2_ Flag2;
            typedef Flag3_ Flag3;
        };

        class PALUDIS_VISIBLE SerialiserObjectWriter
        {
            private:
                Serialiser & _serialiser;

            public:
                SerialiserObjectWriter(Serialiser &);
                ~SerialiserObjectWriter();

                template <
                    typename Flags_,
                    typename T_>
                SerialiserObjectWriter & member(
                        const Flags_ &,
                        const std::string & item_name,
                        const T_ &);
        };

        class PALUDIS_VISIBLE Serialiser
        {
            private:
                std::ostream & _stream;

            public:
                Serialiser(std::ostream &);
                ~Serialiser();

                SerialiserObjectWriter object(const std::string & class_name)
                    PALUDIS_ATTRIBUTE((warn_unused_result));

                std::ostream & raw_stream() PALUDIS_ATTRIBUTE((warn_unused_result));

                void escape_write(const std::string &);
        };

        class PALUDIS_VISIBLE Deserialiser :
            private PrivateImplementationPattern<Deserialiser>
        {
            public:
                Deserialiser(const Environment * const, const std::string &);
                ~Deserialiser();

                const Environment * environment() const PALUDIS_ATTRIBUTE((warn_unused_result));
                SimpleParser & parser() PALUDIS_ATTRIBUTE((warn_unused_result));
        };

        class PALUDIS_VISIBLE Deserialisation :
            private PrivateImplementationPattern<Deserialisation>
        {
            public:
                Deserialisation(const std::string &, Deserialiser &);
                ~Deserialisation();

                const Deserialiser & deserialiser() const PALUDIS_ATTRIBUTE((warn_unused_result));

                const std::string item_name() const PALUDIS_ATTRIBUTE((warn_unused_result));

                const std::string class_name() const PALUDIS_ATTRIBUTE((warn_unused_result));

                const std::string string_value() const PALUDIS_ATTRIBUTE((warn_unused_result));

                bool null() const PALUDIS_ATTRIBUTE((warn_unused_result));

                struct ConstIteratorTag;
                typedef WrappedForwardIterator<ConstIteratorTag,
                        const std::tr1::shared_ptr<Deserialisation> > ConstIterator;
                ConstIterator begin_children() const PALUDIS_ATTRIBUTE((warn_unused_result));
                ConstIterator end_children() const PALUDIS_ATTRIBUTE((warn_unused_result));
        };

        class PALUDIS_VISIBLE Deserialisator :
            private PrivateImplementationPattern<Deserialisator>
        {
            public:
                Deserialisator(
                        Deserialisation &,
                        const std::string & class_name);

                ~Deserialisator();

                const Deserialisation & deserialisation() const PALUDIS_ATTRIBUTE((warn_unused_result));

                template <typename T_> T_ member(const std::string & key_name);

                const std::tr1::shared_ptr<Deserialisation> find_remove_member(
                        const std::string &) PALUDIS_ATTRIBUTE((warn_unused_result));

        };

        template <typename T_>
        std::tr1::shared_ptr<T_> deserialise(
                const Environment * const,
                const std::string &,
                const std::string &) PALUDIS_VISIBLE PALUDIS_ATTRIBUTE((warn_unused_result));
    }

#ifdef PALUDIS_HAVE_EXTERN_TEMPLATE
    extern template class PrivateImplementationPattern<resolver::Deserialiser>;
    extern template class PrivateImplementationPattern<resolver::Deserialisation>;
    extern template class PrivateImplementationPattern<resolver::Deserialisator>;
#endif
}

#endif