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

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

#include <paludis/util/counted_ptr.hh>
#include <paludis/util/instantiation_policy.hh>

namespace paludis
{
    /**
     * Private implementation data, to be specialised for any class that
     * uses PrivateImplementationPattern.
     */
    template <typename C_>
    struct Implementation;

    /**
     * A class descended from PrivateImplementationPattern has an associated
     * Implementation instance.
     */
    template <typename C_>
    class PrivateImplementationPattern :
        private InstantiationPolicy<PrivateImplementationPattern<C_>, instantiation_method::NonCopyableTag>
    {
        protected:
            /**
             * Pointer to our implementation data.
             */
            CountedPtr<Implementation<C_>, count_policy::InternalCountTag> _implementation;

        public:
            /**
             * Constructor.
             */
            explicit PrivateImplementationPattern(Implementation<C_> * i) :
                _implementation(i)
            {
            }
    };
}

#endif