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. Neither the name of the University nor the names of its contributors
  17  *    may be used to endorse or promote products derived from this software
  18  *    without specific prior written permission.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30  * SUCH DAMAGE.
  31  *
  32  * @(#)map.h    8.1 (Berkeley) 6/4/93
  33  * $NetBSD: map.h,v 1.8 2003/08/07 16:44:32 agc Exp $
  34  * $DragonFly: src/lib/libedit/map.h,v 1.4 2005/11/13 11:58:30 corecode Exp $
  35  */
  36
  37 /*
  38  * el.map.h:    Editor maps
  39  */
  40 #ifndef _h_el_map
  41 #define _h_el_map
  42
  43 typedef struct el_bindings_t {  /* for the "bind" shell command */
  44         const char      *name;          /* function name for bind command */
  45         int              func;          /* function numeric value */
  46         const char      *description;   /* description of function */
  47 } el_bindings_t;
  48
  49
  50 typedef struct el_map_t {
  51         el_action_t     *alt;           /* The current alternate key map */
  52         el_action_t     *key;           /* The current normal key map   */
  53         el_action_t     *current;       /* The keymap we are using      */
  54         const el_action_t *emacs;       /* The default emacs key map    */
  55         const el_action_t *vic;         /* The vi command mode key map  */
  56         const el_action_t *vii;         /* The vi insert mode key map   */
  57         int              type;          /* Emacs or vi                  */
  58         el_bindings_t   *help;          /* The help for the editor functions */
  59         el_func_t       *func;          /* List of available functions  */
  60         int              nfunc;         /* The number of functions/help items */
  61 } el_map_t;
  62
  63 #define MAP_EMACS       0
  64 #define MAP_VI          1
  65
  66 protected int   map_bind(EditLine *, int, const char **);
  67 protected int   map_init(EditLine *);
  68 protected void  map_end(EditLine *);
  69 protected void  map_init_vi(EditLine *);
  70 protected void  map_init_emacs(EditLine *);
  71 protected int   map_set_editor(EditLine *, char *);
  72 protected int   map_get_editor(EditLine *, const char **);
  73 protected int   map_addfunc(EditLine *, const char *, const char *, el_func_t);
  74
  75 #endif /* _h_el_map */