lib/libedit/el.h

   1 /*      $OpenBSD: el.h,v 1.22 2016/05/25 09:23:49 schwarze Exp $        */
   2 /*      $NetBSD: el.h,v 1.37 2016/04/18 17:01:19 christos Exp $ */
   3
   4 /*-
   5  * Copyright (c) 1992, 1993
   6  *      The Regents of the University of California.  All rights reserved.
   7  *
   8  * This code is derived from software contributed to Berkeley by
   9  * Christos Zoulas of Cornell University.
  10  *
  11  * Redistribution and use in source and binary forms, with or without
  12  * modification, are permitted provided that the following conditions
  13  * are met:
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions and the following disclaimer.
  16  * 2. Redistributions in binary form must reproduce the above copyright
  17  *    notice, this list of conditions and the following disclaimer in the
  18  *    documentation and/or other materials provided with the distribution.
  19  * 3. Neither the name of the University 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 REGENTS 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 REGENTS 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  *      @(#)el.h        8.1 (Berkeley) 6/4/93
  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       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 CHARSET_IS_UTF8 0x10
  60 #define NARROW_HISTORY  0x40
  61
  62 typedef unsigned char el_action_t;      /* Index to command array       */
  63
  64 typedef struct coord_t {                /* Position on the screen       */
  65         int     h;
  66         int     v;
  67 } coord_t;
  68
  69 typedef struct el_line_t {
  70         wchar_t         *buffer;        /* Input line                   */
  71         wchar_t         *cursor;        /* Cursor position              */
  72         wchar_t         *lastchar;      /* Last character               */
  73         const wchar_t   *limit;         /* Max position                 */
  74 } el_line_t;
  75
  76 /*
  77  * Editor state
  78  */
  79 typedef struct el_state_t {
  80         int             inputmode;      /* What mode are we in?         */
  81         int             doingarg;       /* Are we getting an argument?  */
  82         int             argument;       /* Numeric argument             */
  83         int             metanext;       /* Is the next char a meta char */
  84         el_action_t     lastcmd;        /* Previous command             */
  85         el_action_t     thiscmd;        /* this command                 */
  86         wchar_t         thisch;         /* char that generated it       */
  87 } el_state_t;
  88
  89 #include "tty.h"
  90 #include "prompt.h"
  91 #include "keymacro.h"
  92 #include "terminal.h"
  93 #include "refresh.h"
  94 #include "chared.h"
  95 #include "search.h"
  96 #include "hist.h"
  97 #include "map.h"
  98 #include "sig.h"
  99
 100 struct el_read_t;
 101
 102 struct editline {
 103         wchar_t          *el_prog;      /* the program name             */
 104         FILE             *el_infile;    /* Stdio stuff                  */
 105         FILE             *el_outfile;   /* Stdio stuff                  */
 106         FILE             *el_errfile;   /* Stdio stuff                  */
 107         int               el_infd;      /* Input file descriptor        */
 108         int               el_outfd;     /* Output file descriptor       */
 109         int               el_errfd;     /* Error file descriptor        */
 110         int               el_flags;     /* Various flags.               */
 111         coord_t           el_cursor;    /* Cursor location              */
 112         wchar_t         **el_display;   /* Real screen image = what is there */
 113         wchar_t         **el_vdisplay;  /* Virtual screen image = what we see */
 114         void             *el_data;      /* Client data                  */
 115         el_line_t         el_line;      /* The current line information */
 116         el_state_t        el_state;     /* Current editor state         */
 117         el_terminal_t     el_terminal;  /* Terminal dependent stuff     */
 118         el_tty_t          el_tty;       /* Tty dependent stuff          */
 119         el_refresh_t      el_refresh;   /* Refresh stuff                */
 120         el_prompt_t       el_prompt;    /* Prompt stuff                 */
 121         el_prompt_t       el_rprompt;   /* Prompt stuff                 */
 122         el_chared_t       el_chared;    /* Characted editor stuff       */
 123         el_map_t          el_map;       /* Key mapping stuff            */
 124         el_keymacro_t     el_keymacro;  /* Key binding stuff            */
 125         el_history_t      el_history;   /* History stuff                */
 126         el_search_t       el_search;    /* Search stuff                 */
 127         el_signal_t       el_signal;    /* Signal handling stuff        */
 128         struct el_read_t *el_read;      /* Character reading stuff      */
 129         ct_buffer_t       el_scratch;   /* Scratch conversion buffer    */
 130         ct_buffer_t       el_lgcyconv;  /* Buffer for legacy wrappers   */
 131         LineInfo          el_lgcylinfo; /* Legacy LineInfo buffer       */
 132 };
 133
 134 protected int   el_editmode(EditLine *, int, const wchar_t **);
 135
 136 #ifdef DEBUG
 137 #define EL_ABORT(a)     do { \
 138                                 fprintf(el->el_errfile, "%s, %d: ", \
 139                                          __FILE__, __LINE__); \
 140                                 fprintf a; \
 141                                 abort(); \
 142                         } while( /*CONSTCOND*/0);
 143 #else
 144 #define EL_ABORT(a)     abort()
 145 #endif
 146 #endif /* _h_el */