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.27 1996/12/16 09:39:52 bostic Exp $ (Berkeley) $Date: 1996/12/16 09:39:52 $
  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  * SCR --
  29  *      The screen structure.  To the extent possible, all screen information
  30  *      is stored in the various private areas.  The only information here
  31  *      is used by global routines or is shared by too many screens.
  32  */
  33 struct _scr {
  34 /* INITIALIZED AT SCREEN CREATE. */
  35         CIRCLEQ_ENTRY(_scr) q;          /* Screens. */
  36
  37         int      id;                    /* Screen id #. */
  38         int      refcnt;                /* Reference count. */
  39
  40         GS      *gp;                    /* Pointer to global area. */
  41         SCR     *nextdisp;              /* Next display screen. */
  42         SCR     *ccl_parent;            /* Colon command-line parent screen. */
  43         EXF     *ep;                    /* Screen's current EXF structure. */
  44
  45         FREF    *frp;                   /* FREF being edited. */
  46         char    **argv;                 /* NULL terminated file name array. */
  47         char    **cargv;                /* Current file name. */
  48
  49         u_long   ccnt;                  /* Command count. */
  50         u_long   q_ccnt;                /* Quit or ZZ command count. */
  51
  52                                         /* Screen's: */
  53         size_t   rows;                  /* 1-N: number of rows. */
  54         size_t   cols;                  /* 1-N: number of columns. */
  55         size_t   t_rows;                /* 1-N: cur number of text rows. */
  56         size_t   t_maxrows;             /* 1-N: max number of text rows. */
  57         size_t   t_minrows;             /* 1-N: min number of text rows. */
  58         size_t   coff;                  /* 0-N: screen col offset in display. */
  59         size_t   roff;                  /* 0-N: screen row offset in display. */
  60
  61                                         /* Cursor's: */
  62         recno_t  lno;                   /* 1-N: file line. */
  63         size_t   cno;                   /* 0-N: file character in line. */
  64
  65         size_t   rcm;                   /* Vi: 0-N: Most attractive column. */
  66
  67 #define L_ADDED         0               /* Added lines. */
  68 #define L_CHANGED       1               /* Changed lines. */
  69 #define L_DELETED       2               /* Deleted lines. */
  70 #define L_JOINED        3               /* Joined lines. */
  71 #define L_MOVED         4               /* Moved lines. */
  72 #define L_SHIFT         5               /* Shift lines. */
  73 #define L_YANKED        6               /* Yanked lines. */
  74         recno_t  rptlchange;            /* Ex/vi: last L_CHANGED lno. */
  75         recno_t  rptlines[L_YANKED + 1];/* Ex/vi: lines changed by last op. */
  76
  77         TEXTH    tiq;                   /* Ex/vi: text input queue. */
  78
  79         SCRIPT  *script;                /* Vi: script mode information .*/
  80
  81         recno_t  defscroll;             /* Vi: ^D, ^U scroll information. */
  82
  83                                         /* Display character. */
  84         CHAR_T   cname[MAX_CHARACTER_COLUMNS + 1];
  85         size_t   clen;                  /* Length of display character. */
  86
  87         enum {                          /* Vi editor mode. */
  88             SM_APPEND = 0, SM_CHANGE, SM_COMMAND, SM_INSERT,
  89             SM_REPLACE } showmode;
  90
  91         void    *ex_private;            /* Ex private area. */
  92         void    *vi_private;            /* Vi private area. */
  93         void    *perl_private;          /* Perl private area. */
  94
  95 /* PARTIALLY OR COMPLETELY COPIED FROM PREVIOUS SCREEN. */
  96         char    *alt_name;              /* Ex/vi: alternate file name. */
  97
  98         CHAR_T   at_lbuf;               /* Ex/vi: Last executed at buffer. */
  99
 100                                         /* Ex/vi: re_compile flags. */
 101 #define RE_WSTART       "[[:<:]]"       /* Ex/vi: not-in-word search pattern. */
 102 #define RE_WSTOP        "[[:>:]]"
 103                                         /* Ex/vi: flags to search routines. */
 104 #define SEARCH_CSCOPE   0x000001        /* Search for a cscope pattern. */
 105 #define SEARCH_CSEARCH  0x000002        /* Compile search replacement. */
 106 #define SEARCH_CSUBST   0x000004        /* Compile substitute replacement. */
 107 #define SEARCH_EOL      0x000008        /* Offset past EOL is okay. */
 108 #define SEARCH_EXTEND   0x000010        /* Extended RE. */
 109 #define SEARCH_FIRST    0x000020        /* Search from the first line. */
 110 #define SEARCH_IC       0x000040        /* Ignore case. */
 111 #define SEARCH_ICL      0x000080        /* Ignore case. */
 112 #define SEARCH_INCR     0x000100        /* Search incrementally. */
 113 #define SEARCH_LITERAL  0x000200        /* Literal string. */
 114 #define SEARCH_MSG      0x000400        /* Display search messages. */
 115 #define SEARCH_NOOPT    0x000800        /* Ignore edit options. */
 116 #define SEARCH_PARSE    0x001000        /* Parse the search pattern. */
 117 #define SEARCH_SET      0x002000        /* Set search direction. */
 118 #define SEARCH_TAG      0x004000        /* Search for a tag pattern. */
 119 #define SEARCH_WMSG     0x008000        /* Display search-wrapped messages. */
 120 #define SEARCH_WRAP     0x010000        /* Wrap past sof/eof. */
 121
 122                                         /* Ex/vi: RE information. */
 123         dir_t    searchdir;             /* Last file search direction. */
 124         regex_t  re_c;                  /* Search RE: compiled form. */
 125         char    *re;                    /* Search RE: uncompiled form. */
 126         size_t   re_len;                /* Search RE: uncompiled length. */
 127         regex_t  subre_c;               /* Substitute RE: compiled form. */
 128         char    *subre;                 /* Substitute RE: uncompiled form. */
 129         size_t   subre_len;             /* Substitute RE: uncompiled length). */
 130         char    *repl;                  /* Substitute replacement. */
 131         size_t   repl_len;              /* Substitute replacement length.*/
 132         size_t  *newl;                  /* Newline offset array. */
 133         size_t   newl_len;              /* Newline array size. */
 134         size_t   newl_cnt;              /* Newlines in replacement. */
 135         u_int8_t c_suffix;              /* Edcompatible 'c' suffix value. */
 136         u_int8_t g_suffix;              /* Edcompatible 'g' suffix value. */
 137
 138         OPTION   opts[O_OPTIONCOUNT];   /* Ex/vi: Options. */
 139
 140 /*
 141  * Screen flags.
 142  *
 143  * Editor screens.
 144  */
 145 #define SC_EX           0x00000001      /* Ex editor. */
 146 #define SC_VI           0x00000002      /* Vi editor. */
 147
 148 /*
 149  * Screen formatting flags, first major, then minor.
 150  *
 151  * SC_SCR_EX
 152  *      Ex screen, i.e. cooked mode.
 153  * SC_SCR_VI
 154  *      Vi screen, i.e. raw mode.
 155  * SC_SCR_EXWROTE
 156  *      The editor had to write on the screen behind curses' back, and we can't
 157  *      let curses change anything until the user agrees, e.g. entering the
 158  *      commands :!utility followed by :set.  We have to switch back into the
 159  *      vi "editor" to read the user's command input, but we can't touch the
 160  *      rest of the screen because it's known to be wrong.
 161  * SC_SCR_REFORMAT
 162  *      The expected presentation of the lines on the screen have changed,
 163  *      requiring that the intended screen lines be recalculated.  Implies
 164  *      SC_SCR_REDRAW.
 165  * SC_SCR_REDRAW
 166  *      The screen doesn't correctly represent the file; repaint it.  Note,
 167  *      setting SC_SCR_REDRAW in the current window causes *all* windows to
 168  *      be repainted.
 169  * SC_SCR_CENTER
 170  *      If the current line isn't already on the screen, center it.
 171  * SC_SCR_TOP
 172  *      If the current line isn't already on the screen, put it at the to@.
 173  */
 174 #define SC_SCR_EX       0x00000004      /* Screen is in ex mode. */
 175 #define SC_SCR_VI       0x00000008      /* Screen is in vi mode. */
 176 #define SC_SCR_EXWROTE  0x00000010      /* Ex overwrite: see comment above. */
 177 #define SC_SCR_REFORMAT 0x00000020      /* Reformat (refresh). */
 178 #define SC_SCR_REDRAW   0x00000040      /* Refresh. */
 179
 180 #define SC_SCR_CENTER   0x00000080      /* Center the line if not visible. */
 181 #define SC_SCR_TOP      0x00000100      /* Top the line if not visible. */
 182
 183 /* Screen/file changes. */
 184 #define SC_EXIT         0x00000200      /* Exiting (not forced). */
 185 #define SC_EXIT_FORCE   0x00000400      /* Exiting (forced). */
 186 #define SC_FSWITCH      0x00000800      /* Switch underlying files. */
 187 #define SC_SSWITCH      0x00001000      /* Switch screens. */
 188
 189 #define SC_ARGNOFREE    0x00002000      /* Argument list wasn't allocated. */
 190 #define SC_ARGRECOVER   0x00004000      /* Argument list is recovery files. */
 191 #define SC_AT_SET       0x00008000      /* Last at buffer set. */
 192 #define SC_COMEDIT      0x00010000      /* Colon command-line edit window. */
 193 #define SC_EX_GLOBAL    0x00020000      /* Ex: executing a global command. */
 194 #define SC_EX_SILENT    0x00040000      /* Ex: batch script. */
 195 #define SC_EX_WAIT_NO   0x00080000      /* Ex: don't wait for the user. */
 196 #define SC_EX_WAIT_YES  0x00100000      /* Ex:    do wait for the user. */
 197 #define SC_READONLY     0x00200000      /* Persistent readonly state. */
 198 #define SC_RE_SEARCH    0x00400000      /* Search RE has been compiled. */
 199 #define SC_RE_SUBST     0x00800000      /* Substitute RE has been compiled. */
 200 #define SC_SCRIPT       0x01000000      /* Shell script window. */
 201 #define SC_STATUS       0x02000000      /* Welcome message. */
 202 #define SC_STATUS_CNT   0x04000000      /* Welcome message plus file count. */
 203 #define SC_TINPUT       0x08000000      /* Doing text input. */
 204 #define SC_TINPUT_INFO  0x10000000      /* Doing text input on info line. */
 205         u_int32_t flags;
 206 };