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

/*
 * Copyright (c) 2007, 2008, 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_HOOKER_HH
#define PALUDIS_GUARD_PALUDIS_HOOKER_HH 1

#include <paludis/util/attributes.hh>
#include <paludis/util/pimp.hh>
#include <paludis/util/graph-fwd.hh>
#include <paludis/util/sequence-fwd.hh>
#include <paludis/util/fs_path-fwd.hh>
#include <paludis/output_manager-fwd.hh>
#include <memory>
#include <string>

/** \file
 * Declarations for the Hooker class, which is used to run hooks.
 *
 * \ingroup g_hooks
 *
 * \section Examples
 *
 * - None at this time.
 */

namespace paludis
{
    class Environment;
    class Hook;
    struct HookResult;

    /**
     * A HookFile provides an abstraction of a hook file.
     *
     * \ingroup g_hooks
     * \nosubgrouping
     */
    class PALUDIS_VISIBLE HookFile
    {
        public:
            ///\name Basic operations
            ///\{

            HookFile() = default;
            virtual ~HookFile();

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

            ///\}

            /**
             * \since 0.53 takes optional_output_manager
             */
            virtual HookResult run(
                    const Hook &,
                    const std::shared_ptr<OutputManager> & optional_output_manager) const PALUDIS_ATTRIBUTE((warn_unused_result)) = 0;

            virtual const FSPath file_name() const = 0;

            virtual void add_dependencies(const Hook &, DirectedGraph<std::string, int> &) = 0;

            virtual const std::shared_ptr<const Sequence<std::string> > auto_hook_names() const = 0;
    };

    /**
     * Handles executing hooks.
     *
     * \ingroup g_hooks
     * \nosubgrouping
     */
    class PALUDIS_VISIBLE Hooker
    {
        private:
            Pimp<Hooker> _imp;

            std::shared_ptr<Sequence<std::shared_ptr<HookFile> > > _find_hooks(const Hook &) const;

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

            Hooker(const Environment * const) PALUDIS_ATTRIBUTE((nonnull(2)));
            ~Hooker();

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

            ///\}

            /**
             * Perform a hook, return HookResult.
             *
             * \since 0.53 takes optional_output_manager
             */
            HookResult perform_hook(
                    const Hook &,
                    const std::shared_ptr<OutputManager> & optional_output_manager) const PALUDIS_ATTRIBUTE((warn_unused_result));

            /**
             * Add a new hook directory.
             */
            void add_dir(const FSPath &, const bool output_prefixed);
    };
}

#endif