FreeNOS
HelpCommand.cpp
Go to the documentation of this file.
1/*
2 * Copyright (C) 2009 Niek Linnenbank
3 *
4 * This program is free software: you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation, either version 3 of the License, or
7 * (at your option) any later version.
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program. If not, see <http://www.gnu.org/licenses/>.
16 */
17
18#include <stdio.h>
19#include <HashIterator.h>
20#include "HelpCommand.h"
21#include "ShellCommand.h"
22#include "Shell.h"
23
25 : ShellCommand("help", 0)
26{
27 m_shell = shell;
28 m_help = "Print the help message";
29}
30
31int HelpCommand::execute(const Size nparams, const char **params)
32{
33 printf("List of builtin Shell commands:\r\n\r\n");
34
35 for (HashIterator<String, ShellCommand *> i(m_shell->getCommands()); i.hasCurrent(); i++)
36 {
37 printf("%s -- %s\r\n", i.current()->getName(), i.current()->getHelp());
38 }
39 printf("\r\n");
40 printf("Type 'ls /bin' to see available user commands\r\n");
41
42 return 0;
43}
Iterate through a HashTable.
Shell * m_shell
Shell object.
Definition HelpCommand.h:58
virtual int execute(const Size nparams, const char **params)
Executes the command.
HelpCommand(Shell *shell)
Constructor.
Builtin command for the Shell.
const char * m_help
Command help text.
System command shell interpreter.
Definition Shell.h:34
HashTable< String, ShellCommand * > & getCommands()
Get all shell commands.
Definition Shell.cpp:312
C int printf(const char *format,...)
Output a formatted string to standard output.
Definition printf.cpp:22
unsigned int Size
Any sane size indicator cannot go negative.
Definition Types.h:128