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