aboutsummaryrefslogtreecommitdiff
path: root/paludis/legacy/sync_task.hh
blob: 31384aef692a4d505821f7e3935608e38e646658 (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
/* vim: set sw=4 sts=4 et foldmethod=syntax : */

/*
 * Copyright (c) 2006, 2007, 2010, 2011 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_SYNC_TASK_HH
#define PALUDIS_GUARD_PALUDIS_SYNC_TASK_HH 1

#include <paludis/util/pimp.hh>
#include <paludis/util/wrapped_forward_iterator-fwd.hh>
#include <paludis/util/attributes.hh>
#include <paludis/name-fwd.hh>
#include <string>

/** \file
 * Declarations for SyncTask.
 *
 * \ingroup g_tasks
 *
 * \section Examples
 *
 * - None at this time.
 */

namespace paludis
{
    class Environment;
    class SyncFailedError;

    /**
     * Task to handle syncing some or all repositories.
     *
     * \ingroup g_tasks
     * \nosubgrouping
     */
    class PALUDIS_VISIBLE SyncTask
    {
        private:
            Pimp<SyncTask> _imp;

        protected:
            ///\name Basic operations
            ///\{

            SyncTask(Environment * const env, const bool parallel);

            ///\}

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

            virtual ~SyncTask();

            SyncTask(const SyncTask &) = delete;
            SyncTask & operator= (const SyncTask &) = delete;

            ///\}

            ///\name Add targets
            ///\{

            void add_target(const std::string &);

            ///\}

            ///\name Event callbacks
            ///\{

            virtual void on_sync_all_pre() = 0;
            virtual void on_sync_pre(const RepositoryName &) = 0;
            virtual void on_sync_post(const RepositoryName &) = 0;
            virtual void on_sync_skip(const RepositoryName &) = 0;
            virtual void on_sync_fail(const RepositoryName &, const SyncFailedError &) = 0;
            virtual void on_sync_succeed(const RepositoryName &) = 0;
            virtual void on_sync_all_post() = 0;

            virtual void on_sync_status(const int x, const int y, const int a) = 0;

            ///\}

            ///\name Target iteration
            ///\{

            struct TargetsConstIteratorTag;
            typedef WrappedForwardIterator<TargetsConstIteratorTag, const RepositoryName> TargetsConstIterator;
            TargetsConstIterator begin_targets() const;
            TargetsConstIterator end_targets() const;

            ///\}

            /**
             * Run the task.
             */
            virtual void execute();
    };
}

#endif