aboutsummaryrefslogtreecommitdiff
path: root/src/clients/cave/command.hh
blob: 25bcae92fad1414257af82682015a7b516373d6a (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
/* vim: set sw=4 sts=4 et foldmethod=syntax : */

/*
 * Copyright (c) 2008 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_SRC_CLIENTS_CAVE_COMMAND_HH
#define PALUDIS_GUARD_SRC_CLIENTS_CAVE_COMMAND_HH 1

#include <paludis/util/attributes.hh>
#include <paludis/args/man.hh>
#include <paludis/environment-fwd.hh>
#include <tr1/memory>

namespace paludis
{
    namespace cave
    {
        class PALUDIS_VISIBLE Command
        {
            public:
                virtual ~Command() = 0;

                virtual int run(
                        const std::tr1::shared_ptr<Environment> &,
                        const std::tr1::shared_ptr<const Sequence<std::string > > & args
                        ) PALUDIS_ATTRIBUTE((warn_unused_result)) = 0;

                virtual std::tr1::shared_ptr<args::ArgsHandler> make_doc_cmdline() = 0;
        };
    }
}

#endif