gs.h revision 1.17
1/* $OpenBSD: gs.h,v 1.17 2016/05/02 18:24:25 martijn Exp $ */ 2 3/*- 4 * Copyright (c) 1993, 1994 5 * The Regents of the University of California. All rights reserved. 6 * Copyright (c) 1993, 1994, 1995, 1996 7 * Keith Bostic. All rights reserved. 8 * 9 * See the LICENSE file for redistribution information. 10 * 11 * @(#)gs.h 10.34 (Berkeley) 9/24/96 12 */ 13 14#define TEMPORARY_FILE_STRING "/tmp" /* Default temporary file name. */ 15 16/* 17 * File reference structure (FREF). The structure contains the name of the 18 * file, along with the information that follows the name. 19 * 20 * !!! 21 * The read-only bit follows the file name, not the file itself. 22 */ 23struct _fref { 24 TAILQ_ENTRY(_fref) q; /* Linked list of file references. */ 25 char *name; /* File name. */ 26 char *tname; /* Backing temporary file name. */ 27 28 recno_t lno; /* 1-N: file cursor line. */ 29 size_t cno; /* 0-N: file cursor column. */ 30 31#define FR_CURSORSET 0x0001 /* If lno/cno values valid. */ 32#define FR_DONTDELETE 0x0002 /* Don't delete the temporary file. */ 33#define FR_EXNAMED 0x0004 /* Read/write renamed the file. */ 34#define FR_NAMECHANGE 0x0008 /* If the name changed. */ 35#define FR_NEWFILE 0x0010 /* File doesn't really exist yet. */ 36#define FR_RECOVER 0x0020 /* File is being recovered. */ 37#define FR_TMPEXIT 0x0040 /* Modified temporary file, no exit. */ 38#define FR_TMPFILE 0x0080 /* If file has no name. */ 39#define FR_UNLOCKED 0x0100 /* File couldn't be locked. */ 40 u_int16_t flags; 41}; 42 43/* Action arguments to scr_exadjust(). */ 44typedef enum { EX_TERM_CE, EX_TERM_SCROLL } exadj_t; 45 46/* Screen attribute arguments to scr_attr(). */ 47typedef enum { SA_ALTERNATE, SA_INVERSE } scr_attr_t; 48 49/* Key type arguments to scr_keyval(). */ 50typedef enum { KEY_VEOF, KEY_VERASE, KEY_VKILL, KEY_VWERASE } scr_keyval_t; 51 52/* 53 * GS: 54 * 55 * Structure that describes global state of the running program. 56 */ 57struct _gs { 58 int id; /* Last allocated screen id. */ 59 TAILQ_HEAD(_dqh, _scr) dq; /* Displayed screens. */ 60 TAILQ_HEAD(_hqh, _scr) hq; /* Hidden screens. */ 61 62 SCR *ccl_sp; /* Colon command-line screen. */ 63 64 void *cl_private; /* Curses support private area. */ 65 66 /* File references. */ 67 TAILQ_HEAD(_frefh, _fref) frefq; 68 69#define GO_COLUMNS 0 /* Global options: columns. */ 70#define GO_LINES 1 /* Global options: lines. */ 71#define GO_SECURE 2 /* Global options: secure. */ 72#define GO_TERM 3 /* Global options: terminal type. */ 73 OPTION opts[GO_TERM + 1]; 74 75 MSGH msgq; /* User message list. */ 76#define DEFAULT_NOPRINT '\1' /* Emergency non-printable character. */ 77 char noprint; /* Cached, unprintable character. */ 78 79 char *tmp_bp; /* Temporary buffer. */ 80 size_t tmp_blen; /* Temporary buffer size. */ 81 82 /* 83 * Ex command structures (EXCMD). Defined here because ex commands 84 * exist outside of any particular screen or file. 85 */ 86#define EXCMD_RUNNING(gp) (LIST_FIRST(&(gp)->ecq)->clen != 0) 87 LIST_HEAD(_excmdh, _excmd) ecq; /* Ex command linked list. */ 88 EXCMD excmd; /* Default ex command structure. */ 89 char *if_name; /* Current associated file. */ 90 recno_t if_lno; /* Current associated line number. */ 91 92 char *c_option; /* Ex initial, command-line command. */ 93 94#ifdef DEBUG 95 FILE *tracefp; /* Trace file pointer. */ 96#endif 97 98 EVENT *i_event; /* Array of input events. */ 99 size_t i_nelem; /* Number of array elements. */ 100 size_t i_cnt; /* Count of events. */ 101 size_t i_next; /* Offset of next event. */ 102 103 CB *dcbp; /* Default cut buffer pointer. */ 104 CB dcb_store; /* Default cut buffer storage. */ 105 LIST_HEAD(_cuth, _cb) cutq; /* Linked list of cut buffers. */ 106 107#define MAX_BIT_SEQ 128 /* Max + 1 fast check character. */ 108 LIST_HEAD(_seqh, _seq) seqq; /* Linked list of maps, abbrevs. */ 109 bitstr_t bit_decl(seqb, MAX_BIT_SEQ); 110 111#define MAX_FAST_KEY 254 /* Max fast check character.*/ 112#define KEY_LEN(sp, ch) \ 113 ((unsigned char)(ch) <= MAX_FAST_KEY ? \ 114 (sp)->gp->cname[(unsigned char)(ch)].len : \ 115 v_key_len((sp), (ch))) 116#define KEY_NAME(sp, ch) \ 117 ((unsigned char)(ch) <= MAX_FAST_KEY ? \ 118 (sp)->gp->cname[(unsigned char)(ch)].name : \ 119 v_key_name((sp), (ch))) 120 struct { 121 char name[MAX_CHARACTER_COLUMNS + 1]; 122 u_int8_t len; 123 } cname[MAX_FAST_KEY + 1]; /* Fast lookup table. */ 124 125#define KEY_VAL(sp, ch) \ 126 ((unsigned char)(ch) <= MAX_FAST_KEY ? \ 127 (sp)->gp->special_key[(unsigned char)(ch)] : \ 128 (unsigned char)(ch) > (sp)->gp->max_special ? 0 : \ 129 v_key_val((sp),(ch))) 130 char max_special; /* Max special character. */ 131 u_char /* Fast lookup table. */ 132 special_key[MAX_FAST_KEY + 1]; 133 134/* Flags. */ 135#define G_ABBREV 0x0001 /* If have abbreviations. */ 136#define G_BELLSCHED 0x0002 /* Bell scheduled. */ 137#define G_INTERRUPTED 0x0004 /* Interrupted. */ 138#define G_RECOVER_SET 0x0008 /* Recover system initialized. */ 139#define G_SCRIPTED 0x0010 /* Ex script session. */ 140#define G_SCRWIN 0x0020 /* Scripting windows running. */ 141#define G_SNAPSHOT 0x0040 /* Always snapshot files. */ 142#define G_SRESTART 0x0080 /* Screen restarted. */ 143#define G_TMP_INUSE 0x0100 /* Temporary buffer in use. */ 144 u_int32_t flags; 145 146 /* Screen interface functions. */ 147 /* Add a string to the screen. */ 148 int (*scr_addstr)(SCR *, const char *, size_t); 149 /* Toggle a screen attribute. */ 150 int (*scr_attr)(SCR *, scr_attr_t, int); 151 /* Terminal baud rate. */ 152 int (*scr_baud)(SCR *, u_long *); 153 /* Beep/bell/flash the terminal. */ 154 int (*scr_bell)(SCR *); 155 /* Display a busy message. */ 156 void (*scr_busy)(SCR *, const char *, busy_t); 157 /* Clear to the end of the line. */ 158 int (*scr_clrtoeol)(SCR *); 159 /* Return the cursor location. */ 160 int (*scr_cursor)(SCR *, size_t *, size_t *); 161 /* Delete a line. */ 162 int (*scr_deleteln)(SCR *); 163 /* Get a keyboard event. */ 164 int (*scr_event)(SCR *, EVENT *, u_int32_t, int); 165 /* Ex: screen adjustment routine. */ 166 int (*scr_ex_adjust)(SCR *, exadj_t); 167 int (*scr_fmap) /* Set a function key. */ 168(SCR *, seq_t, char *, size_t, char *, size_t); 169 /* Get terminal key value. */ 170 int (*scr_keyval)(SCR *, scr_keyval_t, unsigned char *, int *); 171 /* Insert a line. */ 172 int (*scr_insertln)(SCR *); 173 /* Handle an option change. */ 174 int (*scr_optchange)(SCR *, int, char *, u_long *); 175 /* Move the cursor. */ 176 int (*scr_move)(SCR *, size_t, size_t); 177 /* Message or ex output. */ 178 void (*scr_msg)(SCR *, mtype_t, char *, size_t); 179 /* Refresh the screen. */ 180 int (*scr_refresh)(SCR *, int); 181 /* Rename the file. */ 182 int (*scr_rename)(SCR *, char *, int); 183 /* Set the screen type. */ 184 int (*scr_screen)(SCR *, u_int32_t); 185 /* Suspend the editor. */ 186 int (*scr_suspend)(SCR *, int *); 187 /* Print usage message. */ 188 void (*scr_usage)(void); 189}; 190