lib/sl/sl.h

   1 /*
   2  * Copyright (c) 1995 - 2004 Kungliga Tekniska Högskolan
   3  * (Royal Institute of Technology, Stockholm, Sweden).
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  *
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  *
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  *
  17  * 3. Neither the name of the Institute nor the names of its contributors
  18  *    may be used to endorse or promote products derived from this software
  19  *    without specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
  22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
  25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31  * SUCH DAMAGE.
  32  */
  33
  34 /* $Id$ */
  35
  36 #ifndef _SL_H
  37 #define _SL_H
  38
  39 #define SL_BADCOMMAND -1
  40
  41 typedef int (*cmd_func)(int, char **);
  42
  43 struct sl_cmd {
  44   const char *name;
  45   cmd_func func;
  46   const char *usage;
  47   const char *help;
  48 };
  49
  50 typedef struct sl_cmd SL_cmd;
  51
  52 #ifdef __cplusplus
  53 extern "C" {
  54 #endif
  55
  56 void sl_help (SL_cmd *, int argc, char **argv);
  57 int  sl_loop (SL_cmd *, const char *prompt);
  58 int  sl_command_loop (SL_cmd *cmds, const char *prompt, void **data);
  59 int  sl_command (SL_cmd *cmds, int argc, char **argv);
  60 int sl_make_argv(char*, int*, char***);
  61 void sl_apropos (SL_cmd *cmd, const char *topic);
  62 SL_cmd *sl_match (SL_cmd *cmds, char *cmd, int exactp);
  63 void sl_slc_help (SL_cmd *cmds, int argc, char **argv);
  64 void sl_did_you_mean(SL_cmd *cmds, const char *match);
  65
  66
  67 #ifdef __cplusplus
  68 }
  69 #endif
  70
  71 #endif /* _SL_H */