common/screen.h

   1 /*-
   2  * Copyright (c) 1992, 1993, 1994
   3  *      The Regents of the University of California.  All rights reserved.
   4  * Copyright (c) 1992, 1993, 1994, 1995, 1996
   5  *      Keith Bostic.  All rights reserved.
   6  *
   7  * See the LICENSE file for redistribution information.
   8  *
   9  *      $Id: screen.h,v 10.49 2002/03/02 23:47:02 skimo Exp $ (Berkeley) $Date: 2002/03/02 23:47:02 $
  10  */
  11
  12 /*
  13  * There are minimum values that vi has to have to display a screen.  The row
  14  * minimum is fixed at 1 (the svi code can share a line between the text line
  15  * and the colon command/message line).  Column calculation is a lot trickier.
  16  * For example, you have to have enough columns to display the line number,
  17  * not to mention guaranteeing that tabstop and shiftwidth values are smaller
  18  * than the current column value.  It's simpler to have a fixed value and not
  19  * worry about it.
  20  *
  21  * XXX
  22  * MINIMUM_SCREEN_COLS is almost certainly wrong.
  23  */
  24 #define MINIMUM_SCREEN_ROWS      1
  25 #define MINIMUM_SCREEN_COLS     20
  26
  27 /*
  28  * WIN --
  29  *      A list of screens that are displayed as a whole.
  30  */
  31 struct _win {
  32         CIRCLEQ_ENTRY(_win)         q;      /* Windows. */
  33
  34         CIRCLEQ_HEAD(_scrh, _scr)   scrq;   /* Screens */
  35
  36         GS      *gp;                    /* Pointer to global area. */
  37
  38         SCR     *ccl_sp;                /* Colon command-line screen. */
  39
  40         void    *perl_private;          /* Perl interpreter. */
  41
  42         void    *ip_private;            /* IP support private area. */
  43
  44         void    *th_private;            /* Threading support private area. */
  45
  46         /*
  47          * Ex command structures (EXCMD).  Defined here because ex commands
  48          * exist outside of any particular screen or file.
  49          */
  50 #define EXCMD_RUNNING(wp)       ((wp)->ecq.lh_first->clen != 0)
  51         LIST_HEAD(_excmdh, _excmd) ecq; /* Ex command linked list. */
  52         EXCMD           excmd;          /* Default ex command structure. */
  53         char           *if_name;        /* Current associated file. */
  54         db_recno_t      if_lno;         /* Current associated line number. */
  55
  56         EVENT   *i_event;               /* Array of input events. */
  57         size_t   i_nelem;               /* Number of array elements. */
  58         size_t   i_cnt;                 /* Count of events. */
  59         size_t   i_next;                /* Offset of next event. */
  60
  61         CB      *dcbp;                  /* Default cut buffer pointer. */
  62         CB       dcb_store;             /* Default cut buffer storage. */
  63         LIST_HEAD(_cuth, _cb) cutq;     /* Linked list of cut buffers. */
  64
  65         /* For now, can be either char or CHAR_T buffer */
  66         char    *tmp_bp;                /* Temporary buffer. */
  67         size_t   tmp_blen;              /* Temporary buffer size. */
  68
  69         char    *l_lp;                  /* Log buffer. */
  70         size_t   l_len;                 /* Log buffer length. */
  71
  72         CONVWIN  cw;
  73
  74 /* Flags. */
  75 #define W_TMP_INUSE     0x0001          /* Temporary buffer in use. */
  76         u_int32_t flags;
  77
  78                                         /* Message or ex output. */
  79         void    (*scr_msg) __P((SCR *, mtype_t, char *, size_t));
  80 };
  81
  82 /*
  83  * SCR --
  84  *      The screen structure.  To the extent possible, all screen information
  85  *      is stored in the various private areas.  The only information here
  86  *      is used by global routines or is shared by too many screens.
  87  */
  88 struct _scr {
  89 /* INITIALIZED AT SCREEN CREATE. */
  90         CIRCLEQ_ENTRY(_scr) q;          /* Screens. */
  91         CIRCLEQ_ENTRY(_scr) eq;         /* Screens. */
  92
  93         int      id;                    /* Screen id #. */
  94         int      refcnt;                /* Reference count. */
  95
  96         WIN     *wp;                    /* Pointer to window. */
  97         GS      *gp;                    /* Pointer to global area. */
  98         SCR     *nextdisp;              /* Next display screen. */
  99         SCR     *ccl_parent;            /* Colon command-line parent screen. */
 100         EXF     *ep;                    /* Screen's current EXF structure. */
 101
 102         CHAR_T  *c_lp;                  /* Cached line. */
 103         size_t   c_len;                 /* Cached line length. */
 104         /* May move out again once we use DB
 105          * to cache internal representation
 106          */
 107         size_t   c_blen;                /* Cached line buffer length. */
 108         db_recno_t       c_lno;         /* Cached line number. */
 109
 110         FREF    *frp;                   /* FREF being edited. */
 111         char    **argv;                 /* NULL terminated file name array. */
 112         char    **cargv;                /* Current file name. */
 113
 114         u_long   ccnt;                  /* Command count. */
 115         u_long   q_ccnt;                /* Quit or ZZ command count. */
 116
 117                                         /* Screen's: */
 118         size_t   rows;                  /* 1-N: number of rows. */
 119         size_t   cols;                  /* 1-N: number of columns. */
 120         size_t   t_rows;                /* 1-N: cur number of text rows. */
 121         size_t   t_maxrows;             /* 1-N: max number of text rows. */
 122         size_t   t_minrows;             /* 1-N: min number of text rows. */
 123         size_t   coff;                  /* 0-N: screen col offset in display. */
 124         size_t   roff;                  /* 0-N: screen row offset in display. */
 125
 126                                         /* Cursor's: */
 127         db_recno_t       lno;                   /* 1-N: file line. */
 128         size_t   cno;                   /* 0-N: file character in line. */
 129
 130         size_t   rcm;                   /* Vi: 0-N: Most attractive column. */
 131
 132 #define L_ADDED         0               /* Added lines. */
 133 #define L_CHANGED       1               /* Changed lines. */
 134 #define L_DELETED       2               /* Deleted lines. */
 135 #define L_JOINED        3               /* Joined lines. */
 136 #define L_MOVED         4               /* Moved lines. */
 137 #define L_SHIFT         5               /* Shift lines. */
 138 #define L_YANKED        6               /* Yanked lines. */
 139         db_recno_t       rptlchange;            /* Ex/vi: last L_CHANGED lno. */
 140         db_recno_t       rptlines[L_YANKED + 1];/* Ex/vi: lines changed by last op. */
 141
 142         TEXTH    tiq;                   /* Ex/vi: text input queue. */
 143
 144         SCRIPT  *script;                /* Vi: script mode information .*/
 145
 146         db_recno_t       defscroll;     /* Vi: ^D, ^U scroll information. */
 147
 148                                         /* Display character. */
 149         u_char   cname[MAX_CHARACTER_COLUMNS + 1];
 150         size_t   clen;                  /* Length of display character. */
 151
 152         enum {                          /* Vi editor mode. */
 153             SM_APPEND = 0, SM_CHANGE, SM_COMMAND, SM_INSERT,
 154             SM_REPLACE } showmode;
 155
 156         void    *ex_private;            /* Ex private area. */
 157         void    *vi_private;            /* Vi private area. */
 158         void    *perl_private;          /* Perl private area. */
 159         void    *cl_private;            /* Curses private area. */
 160
 161         CONV    conv;
 162
 163         struct _log_state  state;       /* State during log traversal. */
 164
 165 /* PARTIALLY OR COMPLETELY COPIED FROM PREVIOUS SCREEN. */
 166         char    *alt_name;              /* Ex/vi: alternate file name. */
 167
 168         CHAR_T   at_lbuf;               /* Ex/vi: Last executed at buffer. */
 169
 170                                         /* Ex/vi: re_compile flags. */
 171 #define RE_WSTART       L("[[:<:]]")    /* Ex/vi: not-in-word search pattern. */
 172 #define RE_WSTOP        L("[[:>:]]")
 173 #define RE_WSTART_LEN   (sizeof(RE_WSTART)/sizeof(CHAR_T)-1)
 174 #define RE_WSTOP_LEN    (sizeof(RE_WSTOP)/sizeof(CHAR_T)-1)
 175                                         /* Ex/vi: flags to search routines. */
 176 #define SEARCH_CSCOPE   0x000001        /* Search for a cscope pattern. */
 177 #define SEARCH_CSEARCH  0x000002        /* Compile search replacement. */
 178 #define SEARCH_CSUBST   0x000004        /* Compile substitute replacement. */
 179 #define SEARCH_EOL      0x000008        /* Offset past EOL is okay. */
 180 #define SEARCH_EXTEND   0x000010        /* Extended RE. */
 181 #define SEARCH_FIRST    0x000020        /* Search from the first line. */
 182 #define SEARCH_IC       0x000040        /* Ignore case. */
 183 #define SEARCH_ICL      0x000080        /* Ignore case. */
 184 #define SEARCH_INCR     0x000100        /* Search incrementally. */
 185 #define SEARCH_LITERAL  0x000200        /* Literal string. */
 186 #define SEARCH_MSG      0x000400        /* Display search messages. */
 187 #define SEARCH_NOOPT    0x000800        /* Ignore edit options. */
 188 #define SEARCH_PARSE    0x001000        /* Parse the search pattern. */
 189 #define SEARCH_SET      0x002000        /* Set search direction. */
 190 #define SEARCH_TAG      0x004000        /* Search for a tag pattern. */
 191 #define SEARCH_WMSG     0x008000        /* Display search-wrapped messages. */
 192 #define SEARCH_WRAP     0x010000        /* Wrap past sof/eof. */
 193
 194                                         /* Ex/vi: RE information. */
 195         dir_t    searchdir;             /* Last file search direction. */
 196         regex_t  re_c;                  /* Search RE: compiled form. */
 197         CHAR_T  *re;                    /* Search RE: uncompiled form. */
 198         size_t   re_len;                /* Search RE: uncompiled length. */
 199         regex_t  subre_c;               /* Substitute RE: compiled form. */
 200         CHAR_T  *subre;                 /* Substitute RE: uncompiled form. */
 201         size_t   subre_len;             /* Substitute RE: uncompiled length). */
 202         CHAR_T  *repl;                  /* Substitute replacement. */
 203         size_t   repl_len;              /* Substitute replacement length.*/
 204         size_t  *newl;                  /* Newline offset array. */
 205         size_t   newl_len;              /* Newline array size. */
 206         size_t   newl_cnt;              /* Newlines in replacement. */
 207         u_int8_t c_suffix;              /* Edcompatible 'c' suffix value. */
 208         u_int8_t g_suffix;              /* Edcompatible 'g' suffix value. */
 209
 210         OPTION   opts[O_OPTIONCOUNT];   /* Ex/vi: Options. */
 211
 212 /*
 213  * Screen flags.
 214  *
 215  * Editor screens.
 216  */
 217 #define SC_EX           0x00000001      /* Ex editor. */
 218 #define SC_VI           0x00000002      /* Vi editor. */
 219
 220 /*
 221  * Screen formatting flags, first major, then minor.
 222  *
 223  * SC_SCR_EX
 224  *      Ex screen, i.e. cooked mode.
 225  * SC_SCR_VI
 226  *      Vi screen, i.e. raw mode.
 227  * SC_SCR_EXWROTE
 228  *      The editor had to write on the screen behind curses' back, and we can't
 229  *      let curses change anything until the user agrees, e.g. entering the
 230  *      commands :!utility followed by :set.  We have to switch back into the
 231  *      vi "editor" to read the user's command input, but we can't touch the
 232  *      rest of the screen because it's known to be wrong.
 233  * SC_SCR_REFORMAT
 234  *      The expected presentation of the lines on the screen have changed,
 235  *      requiring that the intended screen lines be recalculated.  Implies
 236  *      SC_SCR_REDRAW.
 237  * SC_SCR_REDRAW
 238  *      The screen doesn't correctly represent the file; repaint it.  Note,
 239  *      setting SC_SCR_REDRAW in the current window causes *all* windows to
 240  *      be repainted.
 241  * SC_SCR_CENTER
 242  *      If the current line isn't already on the screen, center it.
 243  * SC_SCR_TOP
 244  *      If the current line isn't already on the screen, put it at the to@.
 245  */
 246 #define SC_SCR_EX       0x00000004      /* Screen is in ex mode. */
 247 #define SC_SCR_VI       0x00000008      /* Screen is in vi mode. */
 248 #define SC_SCR_EXWROTE  0x00000010      /* Ex overwrite: see comment above. */
 249 #define SC_SCR_REFORMAT 0x00000020      /* Reformat (refresh). */
 250 #define SC_SCR_REDRAW   0x00000040      /* Refresh. */
 251
 252 #define SC_SCR_CENTER   0x00000080      /* Center the line if not visible. */
 253 #define SC_SCR_TOP      0x00000100      /* Top the line if not visible. */
 254
 255 /* Screen/file changes. */
 256 #define SC_EXIT         0x00000200      /* Exiting (not forced). */
 257 #define SC_EXIT_FORCE   0x00000400      /* Exiting (forced). */
 258 #define SC_FSWITCH      0x00000800      /* Switch underlying files. */
 259 #define SC_SSWITCH      0x00001000      /* Switch screens. */
 260
 261 #define SC_ARGNOFREE    0x00002000      /* Argument list wasn't allocated. */
 262 #define SC_ARGRECOVER   0x00004000      /* Argument list is recovery files. */
 263 #define SC_AT_SET       0x00008000      /* Last at buffer set. */
 264 #define SC_COMEDIT      0x00010000      /* Colon command-line edit window. */
 265 #define SC_EX_GLOBAL    0x00020000      /* Ex: executing a global command. */
 266 #define SC_EX_SILENT    0x00040000      /* Ex: batch script. */
 267 #define SC_EX_WAIT_NO   0x00080000      /* Ex: don't wait for the user. */
 268 #define SC_EX_WAIT_YES  0x00100000      /* Ex:    do wait for the user. */
 269 #define SC_READONLY     0x00200000      /* Persistent readonly state. */
 270 #define SC_RE_SEARCH    0x00400000      /* Search RE has been compiled. */
 271 #define SC_RE_SUBST     0x00800000      /* Substitute RE has been compiled. */
 272 #define SC_SCRIPT       0x01000000      /* Shell script window. */
 273 #define SC_STATUS       0x02000000      /* Welcome message. */
 274 #define SC_STATUS_CNT   0x04000000      /* Welcome message plus file count. */
 275 #define SC_TINPUT       0x08000000      /* Doing text input. */
 276 #define SC_TINPUT_INFO  0x10000000      /* Doing text input on info line. */
 277 #define SC_CONV_ERROR   0x20000000      /* Met with a conversion error. */
 278         u_int32_t flags;
 279
 280         int         db_error;           /* Return code from db function. */
 281 };