| /branches/shell/uspace/app/bdsh/cmds/modules/quit/quit.def |
|---|
| 0,0 → 1,14 |
| { |
| "quit", |
| "Exit the console", |
| &cmd_quit, |
| &help_cmd_quit, |
| -1 |
| }, |
| { |
| "exit", |
| NULL, |
| &cmd_quit, |
| &help_cmd_quit, |
| -1 |
| }, |
| /branches/shell/uspace/app/bdsh/cmds/modules/quit/quit.c |
|---|
| 0,0 → 1,56 |
| /* Copyright (c) 2008, Tim Post <tinkertim@gmail.com> |
| * All rights reserved. |
| * |
| * Redistribution and use in source and binary forms, with or without |
| * modification, are permitted provided that the following conditions are met: |
| * |
| * Redistributions of source code must retain the above copyright notice, this |
| * list of conditions and the following disclaimer. |
| * |
| * Redistributions in binary form must reproduce the above copyright notice, |
| * this list of conditions and the following disclaimer in the documentation |
| * and/or other materials provided with the distribution. |
| * |
| * Neither the name of the original program's authors nor the names of its |
| * contributors may be used to endorse or promote products derived from this |
| * software without specific prior written permission. |
| * |
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
| * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
| * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
| * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE |
| * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
| * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
| * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
| * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
| * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
| * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
| * POSSIBILITY OF SUCH DAMAGE. |
| */ |
| #include <stdio.h> |
| #include <stdlib.h> |
| #include "entry.h" |
| #include "quit.h" |
| #include "cmds.h" |
| static char *cmdname = "quit"; |
| unsigned int cli_quit = 0; |
| extern volatile int cli_lasterror; |
| extern const char *progname; |
| void * help_cmd_quit(unsigned int level) |
| { |
| printf("Type `%s' to exit %s\n", cmdname, progname); |
| return CMD_VOID; |
| } |
| /* Quits the program and returns the status of whatever command |
| * came before invoking 'quit' */ |
| int * cmd_quit(char *argv[]) |
| { |
| /* Inform that we're outta here */ |
| cli_quit = 1; |
| return CMD_SUCCESS; |
| } |
| /branches/shell/uspace/app/bdsh/cmds/modules/quit/entry.h |
|---|
| 0,0 → 1,10 |
| #ifndef QUIT_ENTRY_H_ |
| #define QUIT_ENTRY_H_ |
| /* Entry points for the quit command */ |
| extern void * help_cmd_quit(unsigned int); |
| extern int * cmd_quit(char *[]); |
| #endif |
| /branches/shell/uspace/app/bdsh/cmds/modules/quit/quit.h |
|---|
| 0,0 → 1,6 |
| #ifndef QUIT_H |
| #define QUIT_H |
| /* Prototypes for the quit command (excluding entry points) */ |
| #endif |
| /branches/shell/uspace/app/bdsh/cmds/modules/help/help.def |
|---|
| 0,0 → 1,7 |
| { |
| "help", |
| "Show help for commands", |
| &cmd_help, |
| &help_cmd_help, |
| 0 |
| }, |
| /branches/shell/uspace/app/bdsh/cmds/modules/help/entry.h |
|---|
| 0,0 → 1,8 |
| #ifndef HELP_ENTRY_H_ |
| #define HELP_ENTRY_H_ |
| /* Entry points for the help command */ |
| extern void * help_cmd_help(unsigned int); |
| extern int * cmd_help(char *[]); |
| #endif |
| /branches/shell/uspace/app/bdsh/cmds/modules/help/help.c |
|---|
| 0,0 → 1,165 |
| /* Copyright (c) 2008, Tim Post <tinkertim@gmail.com> |
| * All rights reserved. |
| * |
| * Redistribution and use in source and binary forms, with or without |
| * modification, are permitted provided that the following conditions are met: |
| * |
| * Redistributions of source code must retain the above copyright notice, this |
| * list of conditions and the following disclaimer. |
| * |
| * Redistributions in binary form must reproduce the above copyright notice, |
| * this list of conditions and the following disclaimer in the documentation |
| * and/or other materials provided with the distribution. |
| * |
| * Neither the name of the original program's authors nor the names of its |
| * contributors may be used to endorse or promote products derived from this |
| * software without specific prior written permission. |
| * |
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
| * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
| * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
| * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE |
| * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
| * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
| * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
| * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
| * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
| * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
| * POSSIBILITY OF SUCH DAMAGE. |
| */ |
| #include <stdio.h> |
| #include <stdlib.h> |
| #include <string.h> |
| #include "entry.h" |
| #include "help.h" |
| #include "cmds.h" |
| #include "modules.h" |
| #include "builtins.h" |
| #include "errors.h" |
| const char *cmdname = "help"; |
| extern const char *progname; |
| extern unsigned int cli_interactive; |
| #define HELP_IS_MODULE 1 |
| #define HELP_IS_BUILTIN 0 |
| #define HELP_IS_RUBBISH -1 |
| volatile int mod_switch = -1; |
| /* Just use a pointer here, no need for mod_switch */ |
| int is_mod_or_builtin(char *cmd) |
| { |
| int rc = HELP_IS_RUBBISH; |
| rc = is_builtin(cmd); |
| if (rc > -1) { |
| mod_switch = rc; |
| return HELP_IS_BUILTIN; |
| } |
| rc = is_module(cmd); |
| if (rc > -1) { |
| mod_switch = rc; |
| return HELP_IS_MODULE; |
| } |
| return HELP_IS_RUBBISH; |
| } |
| void *help_cmd_help(unsigned int level) |
| { |
| if (level == HELP_SHORT) { |
| printf( |
| "\n %s [command] <extended>\n" |
| " Use help [command] extended for detailed help on [command] " |
| ", even `help'\n\n", cmdname); |
| } else { |
| printf( |
| "\n `%s' - shows help for commands\n" |
| " Examples:\n" |
| " %s [command] Show help for [command]\n" |
| " %s [command] extended Show extended help for [command]\n" |
| "\n If no argument is given to %s, a list of commands are shown\n\n", |
| cmdname, cmdname, cmdname, cmdname); |
| } |
| return CMD_VOID; |
| } |
| int *cmd_help(char *argv[]) |
| { |
| module_t *mod; |
| builtin_t *cmd; |
| unsigned int i = 0; |
| int rc = 0; |
| int argc; |
| int level = HELP_SHORT; |
| for (argc = 0; argv[argc] != NULL; argc ++); |
| if (argc > 3) { |
| printf("\nToo many arguments to `%s', try:\n", cmdname); |
| help_cmd_help(HELP_SHORT); |
| return CMD_FAILURE; |
| } |
| if (argc == 3) { |
| if (!strcmp("extended", argv[2])) |
| level = HELP_LONG; |
| else |
| level = HELP_SHORT; |
| } |
| if (argc > 1) { |
| rc = is_mod_or_builtin(argv[1]); |
| switch (rc) { |
| case HELP_IS_RUBBISH: |
| printf("Invalid command %s\n", argv[1]); |
| return CMD_FAILURE; |
| case HELP_IS_MODULE: |
| help_module(mod_switch, level); |
| return CMD_SUCCESS; |
| case HELP_IS_BUILTIN: |
| help_builtin(mod_switch, level); |
| return CMD_SUCCESS; |
| } |
| } |
| printf("%sAvailable commands are:\n", cli_interactive ? "\n " : ""); |
| if (cli_interactive) |
| printf( |
| " ------------------------------------------------------------\n"); |
| /* First, show a list of built in commands that are available in this mode */ |
| for (cmd = builtins; cmd->name != NULL; cmd++, i++) { |
| if (!builtin_is_restricted(i)) { |
| if (is_builtin_alias(cmd->name)) |
| printf(" %-16s\tAlias for `%s'\n", cmd->name, |
| alias_for_builtin(cmd->name)); |
| else |
| printf(" %-16s\t%s\n", cmd->name, cmd->desc); |
| } |
| } |
| i = 0; |
| /* Now, show a list of module commands that are available in this mode */ |
| for (mod = modules; mod->name != NULL; mod++, i++) { |
| if (!module_is_restricted(i)) { |
| if (is_module_alias(mod->name)) |
| printf(" %-16s\tAlias for `%s'\n", mod->name, |
| alias_for_module(mod->name)); |
| else |
| printf(" %-16s\t%s\n", mod->name, mod->desc); |
| } |
| } |
| /* Provide a little more information and inform them of history / line |
| * editing features if they are present */ |
| if (cli_interactive) |
| printf("\n Try %s %s for more information on how `%s' works.\n\n", |
| cmdname, cmdname, cmdname); |
| return CMD_SUCCESS; |
| } |
| /branches/shell/uspace/app/bdsh/cmds/modules/help/help.h |
|---|
| 0,0 → 1,7 |
| #ifndef HELP_H |
| #define HELP_H |
| /* Prototypes for the help command (excluding entry points) */ |
| extern int is_mod_or_builtin(char *); |
| #endif |
| /branches/shell/uspace/app/bdsh/cmds/modules/module_aliases.h |
|---|
| 0,0 → 1,19 |
| #ifndef MODULE_ALIASES_H |
| #define MODULE_ALIASES_H |
| /* Modules that declare multiple names for themselves but use the |
| * same entry functions are aliases. This array helps to determine if |
| * a module is an alias, as such it can be invoked differently. |
| * format is alias , real_name */ |
| /* So far, this is only used in the help display but could be used to |
| * handle a module differently even prior to reaching its entry code. |
| * For instance, 'exit' could behave differently than 'quit', prior to |
| * the entry point being reached. */ |
| char *mod_aliases[] = { |
| "exit", "quit", |
| NULL, NULL |
| }; |
| #endif |
| /branches/shell/uspace/app/bdsh/cmds/modules/README |
|---|
| 0,0 → 1,8 |
| Modules are commands or full programs (anything can be made into a module that can return |
| int type) should go here. Note, modules do not update the structures containing user info |
| such as the working directory, euid, etc. |
| Stuff that needs to write to the user structures contained in scli.h should be made as |
| built-in commands, not modules. |
| /branches/shell/uspace/app/bdsh/cmds/modules/modules.h |
|---|
| 0,0 → 1,33 |
| #ifndef MODULES_H |
| #define MODULES_H |
| /* Each built in function has two files, one being an entry.h file which |
| * prototypes the run/help entry functions, the other being a .def file |
| * which fills the modules[] array according to the cmd_t structure |
| * defined in cmds.h. |
| * |
| * To add or remove a module, just make a new directory in cmds/modules |
| * for it and copy the 'show' example for basics, then include it here. |
| * (or reverse the process to remove one) |
| * |
| * NOTE: See module_ aliases.h as well, this is where aliases (commands that |
| * share an entry point with others) are indexed */ |
| #include "config.h" |
| /* Prototypes for each module's entry (help/exec) points */ |
| #include "help/entry.h" |
| #include "quit/entry.h" |
| /* Each .def function fills the module_t struct with the individual name, entry |
| * point, help entry point, etc. You can use config.h to control what modules |
| * are loaded based on what libraries exist on the system. */ |
| module_t modules[] = { |
| #include "help/help.def" |
| #include "quit/quit.def" |
| {NULL, NULL, NULL, NULL} |
| }; |
| #endif |