summaryrefslogtreecommitdiff
path: root/xnt/commands/__init__.py
blob: 583558bdcfb48bf01c88f5cbfa2708197fcffbd7 (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
#!/usr/bin/env python
"""Commands Module"""

#   Xnt -- A Wrapper Build Tool
#   Copyright (C) 2012  Kenny Ballou

#   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 3 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, see <http://www.gnu.org/licenses/>.

from xnt.commands.help import HelpCommand
from xnt.commands.listtargets import ListTargetsCommand
from xnt.commands.version import VersionCommand
from xnt.commands.target import TargetCommand

COMMANDS = {
    HelpCommand.name: HelpCommand,
    ListTargetsCommand.name: ListTargetsCommand,
    VersionCommand.name: VersionCommand,
    TargetCommand.name: TargetCommand,
}

def get_summaries(ignore_hidden=True):
    """Return a list of summaries about each command"""
    items = []

    for name, command_class in COMMANDS.items():
        if ignore_hidden and command_class.hidden:
            continue
        items.append((name, command_class.summary))

    return sorted(items)