summaryrefslogtreecommitdiffstats
path: root/akonadi2_cli/modules/help/help.cpp
blob: aaff6fb3c404279eb6a47a2ecda700cbcf82d2a2 (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
/*
 * Copyright (C) 2014 Aaron Seigo <aseigo@kde.org>
 *
 *   This program is free software; you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License as published by
 *   the Free Software Foundation; either version 2 of the License, or
 *   (at your option) any later version.
 *
 *   This program 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.,
 *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
 */

#include "help.h"

#include <QObject>
#include <QSet>
#include <QTextStream>

#include "module.h"

namespace CLI
{

Help::Help()
{
    Syntax topLevel = Syntax(QObject::tr("help"), &Help::showHelp, QObject::tr("Print command information: help [command]"));
    setSyntax(topLevel);
}

bool Help::showHelp(const QStringList &commands, State &)
{
    Module::Command command = Module::match(commands);
    QTextStream stream(stdout);
    if (commands.isEmpty()) {
        stream << QObject::tr("Welcome to the Akonadi2 command line tool!") << "\n";
        stream << QObject::tr("Top-level commands:") << "\n";
        QSet<QString> sorted;
        for (auto module: Module::modules()) {
            sorted.insert(module.syntax().keyword);
        }

        for (auto keyword: sorted) {
            stream << "\t" << keyword << "\n";
        }
    } else if (const Syntax *syntax = command.first) {
        //TODO: get parent!
        stream << QObject::tr("Command `%1`").arg(syntax->keyword);

        if (!syntax->help.isEmpty()) {
            stream << ": " << syntax->help;
        }
        stream << "\n";

        if (!syntax->children.isEmpty()) {
            stream << "\tSub-commands:\n";
            QSet<QString> sorted;
            for (auto childSyntax: syntax->children) {
                sorted.insert(childSyntax.keyword);
            }

            for (auto keyword: sorted) {
                stream << "\t" << keyword << "\n";
            }
        }
    } else {
        stream << "Unknown command: " << commands.join(" ") << "\n";
    }

    return true;
}

} // namespace CLI