lib/libedit/map.h

   1 /*-
   2  * Copyright (c) 1992, 1993
   3  *      The Regents of the University of California.  All rights reserved.
   4  *
   5  * This code is derived from software contributed to Berkeley by
   6  * Christos Zoulas of Cornell University.
   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  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  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  * 3. All advertising materials mentioning features or use of this software
  17  *    must display the following acknowledgement:
  18  *      This product includes software developed by the University of
  19  *      California, Berkeley and its contributors.
  20  * 4. Neither the name of the University nor the names of its contributors
  21  *    may be used to endorse or promote products derived from this software
  22  *    without specific prior written permission.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  34  * SUCH DAMAGE.
  35  *
  36  *      @(#)map.h       8.1 (Berkeley) 6/4/93
  37  */
  38
  39 /*
  40  * el.map.h:    Editor maps
  41  */
  42 #ifndef _h_el_map
  43 #define _h_el_map
  44
  45 typedef struct el_bindings_t {  /* for the "bind" shell command */
  46     const char   *name;         /* function name for bind command */
  47     int     func;               /* function numeric value */
  48     const char   *description;  /* description of function */
  49 } el_bindings_t;
  50
  51
  52 typedef struct el_map_t {
  53     el_action_t   *alt;         /* The current alternate key map        */
  54     el_action_t   *key;         /* The current normal key map           */
  55     el_action_t   *current;     /* The keymap we are using              */
  56     el_action_t   *emacs;       /* The default emacs key map            */
  57     el_action_t   *vic;         /* The vi command mode key map          */
  58     el_action_t   *vii;         /* The vi insert mode key map           */
  59     int            type;        /* Emacs or vi                          */
  60     el_bindings_t *help;        /* The help for the editor functions    */
  61     el_func_t     *func;        /* List of available functions          */
  62     int            nfunc;       /* The number of functions/help items   */
  63 } el_map_t;
  64
  65 #define MAP_EMACS       0
  66 #define MAP_VI          1
  67
  68 protected int   map_bind                __P((EditLine *, int, char **));
  69 protected int   map_init                __P((EditLine *));
  70 protected void  map_end                 __P((EditLine *));
  71 protected void  map_init_vi             __P((EditLine *));
  72 protected void  map_init_emacs          __P((EditLine *));
  73 protected int   map_set_editor          __P((EditLine *, char *));
  74 protected int   map_addfunc             __P((EditLine *, const char *,
  75                                              const char *, el_func_t));
  76
  77 #endif /* _h_el_map */