common/gs.h

   1 /*-
   2  * Copyright (c) 1993, 1994
   3  *      The Regents of the University of California.  All rights reserved.
   4  * Copyright (c) 1993, 1994, 1995, 1996
   5  *      Keith Bostic.  All rights reserved.
   6  *
   7  * See the LICENSE file for redistribution information.
   8  *
   9  *      $Id: gs.h,v 10.55 2001/11/01 10:28:25 skimo Exp $ (Berkeley) $Date: 2001/11/01 10:28:25 $
  10  */
  11
  12 #define TEMPORARY_FILE_STRING   "/tmp"  /* Default temporary file name. */
  13
  14 /*
  15  * File reference structure (FREF).  The structure contains the name of the
  16  * file, along with the information that follows the name.
  17  *
  18  * !!!
  19  * The read-only bit follows the file name, not the file itself.
  20  */
  21 struct _fref {
  22         CIRCLEQ_ENTRY(_fref) q;         /* Linked list of file references. */
  23         char    *name;                  /* File name. */
  24         char    *tname;                 /* Backing temporary file name. */
  25
  26         db_recno_t       lno;                   /* 1-N: file cursor line. */
  27         size_t   cno;                   /* 0-N: file cursor column. */
  28
  29 #define FR_CURSORSET    0x0001          /* If lno/cno values valid. */
  30 #define FR_DONTDELETE   0x0002          /* Don't delete the temporary file. */
  31 #define FR_EXNAMED      0x0004          /* Read/write renamed the file. */
  32 #define FR_NAMECHANGE   0x0008          /* If the name changed. */
  33 #define FR_NEWFILE      0x0010          /* File doesn't really exist yet. */
  34 #define FR_RECOVER      0x0020          /* File is being recovered. */
  35 #define FR_TMPEXIT      0x0040          /* Modified temporary file, no exit. */
  36 #define FR_TMPFILE      0x0080          /* If file has no name. */
  37 #define FR_UNLOCKED     0x0100          /* File couldn't be locked. */
  38         u_int16_t flags;
  39 };
  40
  41 /* Action arguments to scr_exadjust(). */
  42 typedef enum { EX_TERM_CE, EX_TERM_SCROLL } exadj_t;
  43
  44 /* Screen attribute arguments to scr_attr(). */
  45 typedef enum { SA_ALTERNATE, SA_INVERSE } scr_attr_t;
  46
  47 /* Key type arguments to scr_keyval(). */
  48 typedef enum { KEY_VEOF, KEY_VERASE, KEY_VKILL, KEY_VWERASE } scr_keyval_t;
  49
  50 /*
  51  * GS:
  52  *
  53  * Structure that describes global state of the running program.
  54  */
  55 struct _gs {
  56         char    *progname;              /* Programe name. */
  57
  58         int      id;                    /* Last allocated screen id. */
  59         CIRCLEQ_HEAD(_dqh, _win) dq;    /* Displayed windows. */
  60         CIRCLEQ_HEAD(_hqh, _scr) hq;    /* Hidden screens. */
  61
  62         void    *perl_interp;           /* Perl interpreter. */
  63         void    *tcl_interp;            /* Tcl_Interp *: Tcl interpreter. */
  64
  65         void    *cl_private;            /* Curses support private area. */
  66         void    *tk_private;            /* Tk/Tcl support private area. */
  67
  68                                         /* File references. */
  69         CIRCLEQ_HEAD(_frefh, _fref) frefq;
  70                                         /* File structures. */
  71         CIRCLEQ_HEAD(_exfh, _exf) exfq;
  72
  73 #define GO_COLUMNS      0               /* Global options: columns. */
  74 #define GO_LINES        1               /* Global options: lines. */
  75 #define GO_SECURE       2               /* Global options: secure. */
  76 #define GO_TERM         3               /* Global options: terminal type. */
  77         OPTION   opts[GO_TERM + 1];
  78
  79         DB      *msg;                   /* Message catalog DB. */
  80         MSGH     msgq;                  /* User message list. */
  81 #define DEFAULT_NOPRINT '\1'            /* Emergency non-printable character. */
  82         CHAR_T   noprint;               /* Cached, unprintable character. */
  83
  84         char    *c_option;              /* Ex initial, command-line command. */
  85
  86 #ifdef DEBUG
  87         FILE    *tracefp;               /* Trace file pointer. */
  88 #endif
  89
  90 #define MAX_BIT_SEQ     128             /* Max + 1 fast check character. */
  91         LIST_HEAD(_seqh, _seq) seqq;    /* Linked list of maps, abbrevs. */
  92         bitstr_t bit_decl(seqb, MAX_BIT_SEQ);
  93
  94 #define MAX_FAST_KEY    255             /* Max fast check character.*/
  95 #define KEY_LEN(sp, ch)                                                 \
  96         ((UCHAR_T)(ch) <= MAX_FAST_KEY ?                        \
  97             sp->gp->cname[(unsigned char)ch].len : v_key_len(sp, ch))
  98 #define KEY_NAME(sp, ch)                                                \
  99         ((UCHAR_T)(ch) <= MAX_FAST_KEY ?                                \
 100             sp->gp->cname[(unsigned char)ch].name : v_key_name(sp, ch))
 101         struct {
 102                 u_char   name[MAX_CHARACTER_COLUMNS + 1];
 103                 u_int8_t len;
 104         } cname[MAX_FAST_KEY + 1];      /* Fast lookup table. */
 105
 106 #define KEY_VAL(sp, ch)                                                 \
 107         ((UCHAR_T)(ch) <= MAX_FAST_KEY ?                                \
 108             sp->gp->special_key[(UCHAR_T)ch] :                          \
 109             (UCHAR_T)(ch) > sp->gp->max_special ? K_NOTUSED : v_key_val(sp,ch))
 110         CHAR_T   max_special;           /* Max special character. */
 111         u_char                          /* Fast lookup table. */
 112             special_key[MAX_FAST_KEY + 1];
 113
 114 /* Flags. */
 115 #define G_ABBREV        0x0001          /* If have abbreviations. */
 116 #define G_BELLSCHED     0x0002          /* Bell scheduled. */
 117 #define G_INTERRUPTED   0x0004          /* Interrupted. */
 118 #define G_RECOVER_SET   0x0008          /* Recover system initialized. */
 119 #define G_SCRIPTED      0x0010          /* Ex script session. */
 120 #define G_SCRWIN        0x0020          /* Scripting windows running. */
 121 #define G_SNAPSHOT      0x0040          /* Always snapshot files. */
 122 #define G_SRESTART      0x0080          /* Screen restarted. */
 123         u_int32_t flags;
 124
 125         /* Screen interface functions. */
 126                                         /* Add a string to the screen. */
 127         int     (*scr_addstr) __P((SCR *, const char *, size_t));
 128                                         /* Add a string to the screen. */
 129         int     (*scr_waddstr) __P((SCR *, const CHAR_T *, size_t));
 130                                         /* Toggle a screen attribute. */
 131         int     (*scr_attr) __P((SCR *, scr_attr_t, int));
 132                                         /* Terminal baud rate. */
 133         int     (*scr_baud) __P((SCR *, u_long *));
 134                                         /* Beep/bell/flash the terminal. */
 135         int     (*scr_bell) __P((SCR *));
 136                                         /* Display a busy message. */
 137         void    (*scr_busy) __P((SCR *, const char *, busy_t));
 138                                         /* Prepare child. */
 139         int     (*scr_child) __P((SCR *));
 140                                         /* Clear to the end of the line. */
 141         int     (*scr_clrtoeol) __P((SCR *));
 142                                         /* Return the cursor location. */
 143         int     (*scr_cursor) __P((SCR *, size_t *, size_t *));
 144                                         /* Delete a line. */
 145         int     (*scr_deleteln) __P((SCR *));
 146                                         /* Discard a screen. */
 147         int     (*scr_discard) __P((SCR *, SCR **));
 148                                         /* Get a keyboard event. */
 149         int     (*scr_event) __P((SCR *, EVENT *, u_int32_t, int));
 150                                         /* Ex: screen adjustment routine. */
 151         int     (*scr_ex_adjust) __P((SCR *, exadj_t));
 152         int     (*scr_fmap)             /* Set a function key. */
 153             __P((SCR *, seq_t, CHAR_T *, size_t, CHAR_T *, size_t));
 154                                         /* Get terminal key value. */
 155         int     (*scr_keyval) __P((SCR *, scr_keyval_t, CHAR_T *, int *));
 156                                         /* Insert a line. */
 157         int     (*scr_insertln) __P((SCR *));
 158                                         /* Handle an option change. */
 159         int     (*scr_optchange) __P((SCR *, int, char *, u_long *));
 160                                         /* Move the cursor. */
 161         int     (*scr_move) __P((SCR *, size_t, size_t));
 162                                         /* Refresh the screen. */
 163         int     (*scr_refresh) __P((SCR *, int));
 164                                         /* Rename the file. */
 165         int     (*scr_rename) __P((SCR *, char *, int));
 166                                         /* Reply to an event. */
 167         int     (*scr_reply) __P((SCR *, int, char *));
 168                                         /* Set the screen type. */
 169         int     (*scr_screen) __P((SCR *, u_int32_t));
 170                                         /* Split the screen. */
 171         int     (*scr_split) __P((SCR *, SCR *));
 172                                         /* Suspend the editor. */
 173         int     (*scr_suspend) __P((SCR *, int *));
 174                                         /* Print usage message. */
 175         void    (*scr_usage) __P((void));
 176
 177         /* Threading stuff */
 178         void    *th_private;
 179
 180         int     (*run) __P((WIN *, void *(*)(void*), void *));
 181
 182         int     (*lock_init) __P((WIN *, void **));
 183 #define LOCK_INIT(wp,s)                                                     \
 184         wp->gp->lock_init(wp, &s->lock)
 185         int     (*lock_try) __P((WIN *, void **));
 186 #define LOCK_TRY(wp,s)                                                      \
 187         wp->gp->lock_try(wp, &s->lock)
 188         int     (*lock_unlock) __P((WIN *, void **));
 189 #define LOCK_UNLOCK(wp,s)                                                   \
 190         wp->gp->lock_unlock(wp, &s->lock)
 191         int     (*lock_end) __P((WIN *, void **));
 192 #define LOCK_END(wp,s)                                                      \
 193         wp->gp->lock_end(wp, &s->lock)
 194 };
 195
 196 /*
 197  * XXX
 198  * Block signals if there are asynchronous events.  Used to keep DB system calls
 199  * from being interrupted and not restarted, as that will result in consistency
 200  * problems.  This should be handled by DB.
 201  */
 202 #ifdef BLOCK_SIGNALS
 203 #include <signal.h>
 204 extern sigset_t __sigblockset;
 205 #define SIGBLOCK \
 206         (void)sigprocmask(SIG_BLOCK, &__sigblockset, NULL)
 207 #define SIGUNBLOCK \
 208         (void)sigprocmask(SIG_UNBLOCK, &__sigblockset, NULL);
 209 #else
 210 #define SIGBLOCK
 211 #define SIGUNBLOCK
 212 #endif