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  *      $NetBSD: map.h,v 1.5 2000/09/04 22:06:31 lukem Exp $
  38  * $FreeBSD$
  39  */
  40
  41 /*
  42  * el.map.h:    Editor maps
  43  */
  44 #ifndef _h_el_map
  45 #define _h_el_map
  46
  47 typedef struct el_bindings_t {  /* for the "bind" shell command */
  48         const char      *name;          /* function name for bind command */
  49         int              func;          /* function numeric value */
  50         const char      *description;   /* description of function */
  51 } el_bindings_t;
  52
  53
  54 typedef struct el_map_t {
  55         el_action_t     *alt;           /* The current alternate key map */
  56         el_action_t     *key;           /* The current normal key map   */
  57         el_action_t     *current;       /* The keymap we are using      */
  58         const el_action_t *emacs;       /* The default emacs key map    */
  59         const el_action_t *vic;         /* The vi command mode key map  */
  60         const el_action_t *vii;         /* The vi insert mode key map   */
  61         int              type;          /* Emacs or vi                  */
  62         el_bindings_t   *help;          /* The help for the editor functions */
  63         el_func_t       *func;          /* List of available functions  */
  64         int              nfunc;         /* The number of functions/help items */
  65 } el_map_t;
  66
  67 #define MAP_EMACS       0
  68 #define MAP_VI          1
  69
  70 protected int   map_bind(EditLine *, int, char **);
  71 protected int   map_init(EditLine *);
  72 protected void  map_end(EditLine *);
  73 protected void  map_init_vi(EditLine *);
  74 protected void  map_init_emacs(EditLine *);
  75 protected int   map_set_editor(EditLine *, char *);
  76 protected int   map_get_editor(EditLine *, const char **);
  77 protected int   map_addfunc(EditLine *, const char *, const char *, el_func_t);
  78
  79 #endif /* _h_el_map */