Version 0.1.10 from FTP
[asterisk/asterisk.git] / include / asterisk / cli.h
1 /*
2  * Asterisk -- A telephony toolkit for Linux.
3  *
4  * Standard Command Line Interface
5  * 
6  * Copyright (C) 1999, Mark Spencer
7  *
8  * Mark Spencer <markster@linux-support.net>
9  *
10  * This program is free software, distributed under the terms of
11  * the GNU General Public License
12  */
13
14 #ifndef _ASTERISK_CLI_H
15 #define _ASTERISK_CLI_H
16
17 #if defined(__cplusplus) || defined(c_plusplus)
18 extern "C" {
19 #endif
20
21 #include <stdarg.h>
22
23 extern void ast_cli(int fd, char *fmt, ...);
24
25 #define RESULT_SUCCESS          0
26 #define RESULT_SHOWUSAGE        1
27 #define RESULT_FAILURE          2
28
29 #define AST_MAX_CMD_LEN         16
30
31 #define AST_MAX_ARGS 64
32
33 //! A command line entry */
34 struct ast_cli_entry {
35         /*! Null terminated list of the words of the command */
36         char *cmda[AST_MAX_CMD_LEN];
37         /*! Handler for the command (fd for output, # of arguments, argument list).  Returns RESULT_SHOWUSAGE for improper arguments */
38         int (*handler)(int fd, int argc, char *argv[]);
39         /*! Summary of the command (< 60 characters) */
40         char *summary;
41         /*! Detailed usage information */
42         char *usage;
43         /*! Generate a list of possible completions for a given word */
44         char *(*generator)(char *line, char *word, int pos, int state);
45         /*! For linking */
46         struct ast_cli_entry *next;
47 };
48
49 //! Interprets a command
50 /*! Interpret a command s, sending output to fd
51  * Returns 0 on succes, -1 on failure 
52  */
53 extern int ast_cli_command(int fd, char *s);
54
55 //! Registers a command
56 /*! 
57  * \param fd File descriptor that I/O is done to
58  * \param s string given at prompt
59  * Register your own command
60  * Returns 0 on success, -1 on failure
61  */
62 extern int ast_cli_register(struct ast_cli_entry *e);
63
64 //! Unregisters a command
65 /*!
66  * \param e which cli entry to unregister
67  * Unregister your own command.  You must pass a completed ast_cli_entry structur
68  * Returns 0 on success, -1 on failure
69  */
70 extern int ast_cli_unregister(struct ast_cli_entry *e);
71
72 //! Readline madness
73 /* Useful for readline, that's about it
74  * Returns 0 on success, -1 on failure
75  */
76 extern char *ast_cli_generator(char *, char *, int);
77
78 #if defined(__cplusplus) || defined(c_plusplus)
79 }
80 #endif
81
82 #endif