aboutsummaryrefslogtreecommitdiff
path: root/paludis/syncer.hh
blob: dff8c8678820ab029373bab0aa5e4c1a3637acc6 (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
159
160
161
162
/* vim: set sw=4 sts=4 et foldmethod=syntax : */

/*
 * Copyright (c) 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_SYNCER_HH
#define PALUDIS_GUARD_PALUDIS_SYNCER_HH 1

#include <paludis/util/virtual_constructor.hh>
#include <paludis/util/exception.hh>
#include <paludis/repository.hh>
#include <string>

/** \file
 * Declarations for the Syncer classes.
 *
 * \ingroup grpsyncer
 */

namespace paludis
{
    /**
     * Keys for SyncOptions.
     *
     * \see SyncOptions
     * \ingroup grpsyncer
     */
    enum SyncOptionsKeys
    {
        so_excludefrom,     ///< Filename from which to take a list of excluded files
        so_last             ///< Number of keys.
    };

    /**
     * Tag for SyncOptions.
     *
     * \see SyncOptions
     * \ingroup grpsyncer
     */
    struct SyncOptionsTag :
        SmartRecordTag<comparison_mode::NoComparisonTag, void>,
        SmartRecordKeys<SyncOptionsKeys, so_last>,
        SmartRecordKey<so_excludefrom, std::string>
    {
    };

    /**
     * Defines options to be passed to the syncer.
     *
     * \ingroup grpsyncer
     */
    typedef MakeSmartRecord<SyncOptionsTag>::Type SyncOptions;

    /**
     * A Syncer subclass handles syncing Repository instances.
     *
     * \ingroup grpsyncer
     */
    class Syncer :
        private InstantiationPolicy<Syncer, instantiation_method::NonCopyableTag>,
        public InternalCounted<Syncer>
    {
        protected:
            /**
             * Constructor.
             */
            Syncer()
            {
            }

        public:
            /**
             * Destructor.
             */
            virtual ~Syncer()
            {
            }

            /**
             * Perform the sync.
             */
            virtual void sync(const SyncOptions &) const = 0;
    };

    /**
     * Thrown if a sync fails.
     *
     * \ingroup grpsyncer
     * \ingroup grpexceptions
     */
    class SyncFailedError :
        public PackageActionError
    {
        protected:
            /**
             * Constructor.
             */
            SyncFailedError(const std::string & msg) throw ();

        public:
            /**
             * Constructor.
             */
            SyncFailedError(const std::string & local, const std::string & remote) throw ();
    };

    /**
     * Thrown if a directory exists where a Git repository should be cloned.
     *
     * \ingroup grpsyncer
     * \ingroup grpexceptions
     */
    class SyncGitDirectoryExists :
        public SyncFailedError
    {
        public:
            /**
             * Constructor.
             */
            SyncGitDirectoryExists(const std::string & local) throw ();
    };

    /**
     * Thrown if a syncer of the specified type does not exist.
     *
     * \ingroup grpsyncer
     * \ingroup grpexceptions
     */
    class NoSuchSyncerError : public SyncFailedError
    {
        public:
            /**
             * Constructor.
             */
            NoSuchSyncerError(const std::string & format) throw ();
    };


    /**
     * Virtual constructor for Syncer subclasses.
     *
     * \ingroup grpsyncer
     */
    typedef VirtualConstructor<std::string, Syncer::Pointer (*) (const std::string &, const std::string &),
            virtual_constructor_not_found::ThrowException<NoSuchSyncerError> > SyncerMaker;
}

#endif