aboutsummaryrefslogtreecommitdiff
path: root/0.8.0/paludis/util/validated.hh
blob: 0cb54b7e5356053afa6397147a530c644d5d0084 (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
/* vim: set sw=4 sts=4 et foldmethod=syntax : */

/*
 * Copyright (c) 2005, 2006 Ciaran McCreesh <ciaranm@ciaranm.org>
 *
 * 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_VALIDATED_HH
#define PALUDIS_GUARD_PALUDIS_VALIDATED_HH 1

#include <iosfwd>
#include <paludis/util/comparison_policy.hh>

/** \file
 * Validated declarations.
 *
 * \ingroup grpvalidated
 */

namespace paludis
{
    /**
     * A Validated wraps a particular class instance, ensuring that it always
     * meets certain validation criteria.
     *
     * \ingroup grpvalidated
     */
    template <typename ValidatedDataType_, typename Validator_>
    class Validated : public ComparisonPolicy<
                          Validated<ValidatedDataType_, Validator_>,
                          comparison_mode::FullComparisonTag,
                          comparison_method::CompareByMemberTag<ValidatedDataType_> >
    {
        private:
            ValidatedDataType_ _value;

        public:
            ///\name Basic operations
            ///\{

            /**
             * Copy constructor (no validation needed).
             */
            Validated(const Validated<ValidatedDataType_, Validator_> & other);

            /**
             * Constructor (validation needed).
             */
            explicit Validated(const ValidatedDataType_ & value);

            /**
             * Assignment (no validation needed).
             */
            const Validated<ValidatedDataType_, Validator_> & operator=
                (const Validated<ValidatedDataType_,Validator_> & other)
            {
                _value = other._value;
                return *this;
            }

            ///\}

            /**
             * Fetch to our ValidatedDataType_. This should not be a cast
             * operator to avoid problems with ambiguous comparison operators.
             */
            const ValidatedDataType_ & data() const
            {
                return _value;
            }
    };


    template <typename ValidatedDataType_, typename Validator_>
    Validated<ValidatedDataType_, Validator_>::Validated(
            const Validated<ValidatedDataType_, Validator_> & other) :
        ComparisonPolicy<
            Validated<ValidatedDataType_, Validator_>,
            comparison_mode::FullComparisonTag,
            comparison_method::CompareByMemberTag<ValidatedDataType_> >
                (other),
        _value(other._value)
    {
    }

    template <typename ValidatedDataType_, typename Validator_>
    Validated<ValidatedDataType_, Validator_>::Validated(const ValidatedDataType_ & value) :
        ComparisonPolicy<
            Validated<ValidatedDataType_, Validator_>,
            comparison_mode::FullComparisonTag,
            comparison_method::CompareByMemberTag<ValidatedDataType_> >
                (&Validated<ValidatedDataType_, Validator_>::_value),
        _value(value)
    {
        Validator_::validate(_value);
    }

    /**
     * Writing a Validated instance to a stream is done by its data.
     *
     * \ingroup grpvalidated
     */
    template <typename D_, typename V_>
    std::ostream &
    operator<< (std::ostream & s, const Validated<D_, V_> & v)
    {
        s << v.data();
        return s;
    }
}

#endif