lib/libedit/el.h

   1 /*      $NetBSD: el.h,v 1.34 2016/02/24 17:13:22 christos Exp $ */
   2
   3 /*-
   4  * Copyright (c) 1992, 1993
   5  *      The Regents of the University of California.  All rights reserved.
   6  *
   7  * This code is derived from software contributed to Berkeley by
   8  * Christos Zoulas of Cornell University.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  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  * 3. Neither the name of the University nor the names of its contributors
  19  *    may be used to endorse or promote products derived from this software
  20  *    without specific prior written permission.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32  * SUCH DAMAGE.
  33  *
  34  *      @(#)el.h        8.1 (Berkeley) 6/4/93
  35  * $FreeBSD$
  36  */
  37
  38 /*
  39  * el.h: Internal structures.
  40  */
  41 #ifndef _h_el
  42 #define _h_el
  43 /*
  44  * Local defaults
  45  */
  46 #define KSHVI
  47 #define VIDEFAULT
  48 #define ANCHOR
  49
  50 #include "histedit.h"
  51 #include "chartype.h"
  52
  53 #define EL_BUFSIZ       ((size_t)1024)  /* Maximum line size            */
  54
  55 #define HANDLE_SIGNALS  0x01
  56 #define NO_TTY          0x02
  57 #define EDIT_DISABLED   0x04
  58 #define UNBUFFERED      0x08
  59 #define NARROW_HISTORY  0x40
  60
  61 typedef unsigned char el_action_t;      /* Index to command array       */
  62
  63 typedef struct coord_t {                /* Position on the screen       */
  64         int     h;
  65         int     v;
  66 } coord_t;
  67
  68 typedef struct el_line_t {
  69         Char            *buffer;        /* Input line                   */
  70         Char            *cursor;        /* Cursor position              */
  71         Char            *lastchar;      /* Last character               */
  72         const Char      *limit;         /* Max position                 */
  73 } el_line_t;
  74
  75 /*
  76  * Editor state
  77  */
  78 typedef struct el_state_t {
  79         int             inputmode;      /* What mode are we in?         */
  80         int             doingarg;       /* Are we getting an argument?  */
  81         int             argument;       /* Numeric argument             */
  82         int             metanext;       /* Is the next char a meta char */
  83         el_action_t     lastcmd;        /* Previous command             */
  84         el_action_t     thiscmd;        /* this command                 */
  85         Char            thisch;         /* char that generated it       */
  86 } el_state_t;
  87
  88 /*
  89  * Until we come up with something better...
  90  */
  91 #define el_malloc(a)    malloc(a)
  92 #define el_realloc(a,b) realloc(a, b)
  93 #define el_free(a)      free(a)
  94
  95 #include "tty.h"
  96 #include "prompt.h"
  97 #include "keymacro.h"
  98 #include "terminal.h"
  99 #include "refresh.h"
 100 #include "chared.h"
 101 #include "search.h"
 102 #include "hist.h"
 103 #include "fcns.h"       /* el_func_t is needed for map.h */
 104 #include "map.h"
 105 #include "sig.h"
 106 #include "read.h"
 107
 108 struct editline {
 109         Char             *el_prog;      /* the program name             */
 110         FILE             *el_infile;    /* Stdio stuff                  */
 111         FILE             *el_outfile;   /* Stdio stuff                  */
 112         FILE             *el_errfile;   /* Stdio stuff                  */
 113         int               el_infd;      /* Input file descriptor        */
 114         int               el_outfd;     /* Output file descriptor       */
 115         int               el_errfd;     /* Error file descriptor        */
 116         int               el_flags;     /* Various flags.               */
 117         int               el_errno;     /* Local copy of errno          */
 118         coord_t           el_cursor;    /* Cursor location              */
 119         Char            **el_display;   /* Real screen image = what is there */
 120         Char            **el_vdisplay;  /* Virtual screen image = what we see */
 121         void             *el_data;      /* Client data                  */
 122         el_line_t         el_line;      /* The current line information */
 123         el_state_t        el_state;     /* Current editor state         */
 124         el_terminal_t     el_terminal;  /* Terminal dependent stuff     */
 125         el_tty_t          el_tty;       /* Tty dependent stuff          */
 126         el_refresh_t      el_refresh;   /* Refresh stuff                */
 127         el_prompt_t       el_prompt;    /* Prompt stuff                 */
 128         el_prompt_t       el_rprompt;   /* Prompt stuff                 */
 129         el_chared_t       el_chared;    /* Characted editor stuff       */
 130         el_map_t          el_map;       /* Key mapping stuff            */
 131         el_keymacro_t     el_keymacro;  /* Key binding stuff            */
 132         el_history_t      el_history;   /* History stuff                */
 133         el_search_t       el_search;    /* Search stuff                 */
 134         el_signal_t       el_signal;    /* Signal handling stuff        */
 135         el_read_t         el_read;      /* Character reading stuff      */
 136 #ifdef WIDECHAR
 137         ct_buffer_t       el_scratch;   /* Scratch conversion buffer    */
 138         ct_buffer_t       el_lgcyconv;  /* Buffer for legacy wrappers   */
 139         LineInfo          el_lgcylinfo; /* Legacy LineInfo buffer       */
 140 #endif
 141 };
 142
 143 protected int   el_editmode(EditLine *, int, const Char **);
 144
 145 #ifdef DEBUG
 146 #define EL_ABORT(a)     do { \
 147                                 fprintf(el->el_errfile, "%s, %d: ", \
 148                                          __FILE__, __LINE__); \
 149                                 fprintf a; \
 150                                 abort(); \
 151                         } while( /*CONSTCOND*/0);
 152 #else
 153 #define EL_ABORT(a)     abort()
 154 #endif
 155 #endif /* _h_el */