aboutsummaryrefslogtreecommitdiff
path: root/src/clients/cave/cmd_help.cc
blob: c2422895698d02248c5f841e77e36c12f8416452 (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
/* vim: set sw=4 sts=4 et fdm=syntax: */

/*
 * Copyright (c) 2008 Saleem Abdulrasool
 *
 * 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 version2, 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., 55 Temple
 * Place, Suite 330, Boston, MA  02111-1308  USA
 */

#include "cmd_help.hh"
#include "colours.hh"

#include <cstdlib>
#include <iostream>
#include <algorithm>
#include <functional>
#include <iomanip>
#include <paludis/args/args.hh>
#include <paludis/args/do_help.hh>
#include <paludis/util/sequence.hh>
#include <paludis/util/enum_iterator.hh>

#include "command_factory.hh"
#include "command_command_line.hh"

using namespace paludis;
using namespace cave;

using std::cout;

namespace
{
    struct HelpCommandLine :
        CaveCommandCommandLine
    {
        args::ArgsGroup g_general;
        args::SwitchArg a_all;

        HelpCommandLine() :
            g_general(main_options_section(), "General Options", "General Options"),
            a_all(&g_general, "all", 'a', "Print all available commands to standard output.", false)
        {
            add_usage_line("[-a|--all] [COMMAND]");
        }

        virtual std::string app_name() const
        {
            return "cave help";
        }

        virtual std::string app_synopsis() const
        {
            return "display help information";
        }

        virtual std::string app_description() const
        {
            return "Display help information for a particular command.";
        }
    };
}

int
HelpCommand::run(const std::shared_ptr<Environment> & env,
                 const std::shared_ptr< const Sequence<std::string> > & args)
{
    HelpCommandLine cmdline;
    cmdline.run(args, "CAVE", "CAVE_HELP_OPTIONS", "CAVE_HELP_CMDLINE");

    if (cmdline.a_help.specified())
    {
        cout << cmdline;
        return EXIT_SUCCESS;
    }

    if (std::distance(cmdline.begin_parameters(), cmdline.end_parameters()) > 1)
        throw args::DoHelp("help takes at most one parameter");

    if (cmdline.begin_parameters() == cmdline.end_parameters())
    {
        if (cmdline.a_all.specified())
            cout << "All available cave commands:" << std::endl;
        else
            cout << "The most commonly used cave commands (add --all for the rest) are:" << std::endl;

        for (EnumIterator<CommandImportance> e, e_end(cmdline.a_all.specified() ? last_ci : CommandImportance(ci_supplemental + 1)) ;
                e != e_end ; ++e)
            for (CommandFactory::ConstIterator cmd(CommandFactory::get_instance()->begin()), cmd_end(CommandFactory::get_instance()->end()) ;
                    cmd != cmd_end ; ++cmd)
            {
                std::shared_ptr<Command> instance(CommandFactory::get_instance()->create(*cmd));

                if (instance->importance() == *e)
                    cout << "    " << (*e == ci_core ? c::bold_blue().colour_string() : "") << std::left << std::setw(30) << *cmd
                        << c::normal().colour_string() << " " << instance->make_doc_cmdline()->app_synopsis() << std::endl;
            }

        return EXIT_SUCCESS;
    }
    else
    {
        std::shared_ptr< Sequence<std::string> > help(std::make_shared<Sequence<std::string>>());
        help->push_back("--help");

        return CommandFactory::get_instance()->create(*cmdline.begin_parameters())->run(env, help);
    }

    return EXIT_FAILURE;
}

std::shared_ptr<args::ArgsHandler>
HelpCommand::make_doc_cmdline()
{
    return std::make_shared<HelpCommandLine>();
}

CommandImportance
HelpCommand::importance() const
{
    return ci_supplemental;
}