Annotation of src/usr.bin/mg/def.h, Revision 1.51
1.51 ! vincent 1: /* $OpenBSD: def.h,v 1.50 2003/10/27 11:21:12 vincent Exp $ */
1.30 vincent 2:
3: #include <sys/queue.h>
1.6 niklas 4:
1.1 deraadt 5: /*
6: * This file is the general header file for all parts
1.4 millert 7: * of the Mg display editor. It contains all of the
1.1 deraadt 8: * general definitions and macros. It also contains some
9: * conditional compilation flags. All of the per-system and
10: * per-terminal definitions are in special header files.
11: * The most common reason to edit this file would be to zap
12: * the definition of CVMVAS or BACKUP.
13: */
1.4 millert 14: #include "sysdef.h" /* Order is critical. */
1.1 deraadt 15: #include "ttydef.h"
16: #include "chrdef.h"
17:
18: #ifdef NO_MACRO
19: #ifndef NO_STARTUP
1.4 millert 20: #define NO_STARTUP /* NO_MACRO implies NO_STARTUP */
1.1 deraadt 21: #endif
22: #endif
23:
1.47 vincent 24: typedef int (*PF)(int, int); /* generally useful type */
1.1 deraadt 25:
26: /*
27: * Table sizes, etc.
28: */
1.7 art 29: #define NFILEN 1024 /* Length, file name. */
30: #define NBUFN NFILEN /* Length, buffer name. */
1.4 millert 31: #define NLINE 256 /* Length, line. */
32: #define PBMODES 4 /* modes per buffer */
33: #define NKBDM 256 /* Length, keyboard macro. */
34: #define NPAT 80 /* Length, pattern. */
35: #define HUGE 1000 /* A rather large number. */
36: #define NSRCH 128 /* Undoable search commands. */
37: #define NXNAME 64 /* Length, extended command. */
38: #define NKNAME 20 /* Length, key names */
1.1 deraadt 39: /*
40: * Universal.
41: */
1.4 millert 42: #define FALSE 0 /* False, no, bad, etc. */
43: #define TRUE 1 /* True, yes, good, etc. */
44: #define ABORT 2 /* Death, ^G, abort, etc. */
1.1 deraadt 45:
1.4 millert 46: #define KPROMPT 2 /* keyboard prompt */
1.1 deraadt 47:
48: /*
49: * These flag bits keep track of
50: * some aspects of the last command. The CFCPCN
51: * flag controls goal column setting. The CFKILL
52: * flag controls the clearing versus appending
53: * of data in the kill buffer.
54: */
1.4 millert 55: #define CFCPCN 0x0001 /* Last command was C-P, C-N */
56: #define CFKILL 0x0002 /* Last command was a kill */
57: #define CFINS 0x0004 /* Last command was self-insert */
1.1 deraadt 58:
59: /*
60: * File I/O.
61: */
1.4 millert 62: #define FIOSUC 0 /* Success. */
63: #define FIOFNF 1 /* File not found. */
64: #define FIOEOF 2 /* End of file. */
65: #define FIOERR 3 /* Error. */
66: #define FIOLONG 4 /* long line partially read */
1.1 deraadt 67:
68: /*
69: * Directory I/O.
70: */
1.4 millert 71: #define DIOSUC 0 /* Success. */
72: #define DIOEOF 1 /* End of file. */
73: #define DIOERR 2 /* Error. */
1.1 deraadt 74:
75: /*
76: * Display colors.
77: */
1.4 millert 78: #define CNONE 0 /* Unknown color. */
79: #define CTEXT 1 /* Text color. */
80: #define CMODE 2 /* Mode line color. */
81:
82: /*
1.22 millert 83: * Flags for keyboard invoked functions.
1.4 millert 84: */
85: #define FFUNIV 1 /* universal argument */
1.27 deraadt 86: #define FFNEGARG 2 /* negative only argument */
1.4 millert 87: #define FFOTHARG 4 /* other argument */
88: #define FFARG 7 /* any argument */
89: #define FFRAND 8 /* Called by other function */
1.1 deraadt 90:
91: /*
92: * Flags for "eread".
93: */
1.4 millert 94: #define EFFUNC 0x0001 /* Autocomplete functions. */
95: #define EFBUF 0x0002 /* Autocomplete buffers. */
96: #define EFFILE 0x0004 /* " files (maybe someday) */
97: #define EFAUTO 0x0007 /* Some autocompleteion on */
98: #define EFNEW 0x0008 /* New prompt. */
99: #define EFCR 0x0010 /* Echo CR at end; last read. */
1.20 art 100: #define EFDEF 0x0020 /* buffer contains default args */
1.1 deraadt 101:
102: /*
103: * Flags for "ldelete"/"kinsert"
104: */
105: #define KNONE 0
106: #define KFORW 1
107: #define KBACK 2
108:
1.49 vincent 109:
110: /*
111: * This structure holds the starting position
112: * (as a line/offset pair) and the number of characters in a
113: * region of a buffer. This makes passing the specification
114: * of a region around a little bit easier.
115: */
116: typedef struct {
117: struct LINE *r_linep; /* Origin LINE address. */
118: int r_offset; /* Origin LINE offset. */
119: RSIZE r_size; /* Length in characters. */
120: } REGION;
121:
122:
1.1 deraadt 123: /*
124: * All text is kept in circularly linked
125: * lists of "LINE" structures. These begin at the
126: * header line (which is the blank line beyond the
127: * end of the buffer). This line is pointed to by
128: * the "BUFFER". Each line contains a the number of
129: * bytes in the line (the "used" size), the size
130: * of the text array, and the text. The end of line
131: * is not stored as a byte; it's implied. Future
132: * additions will include update hints, and a
133: * list of marks into the line.
134: */
1.4 millert 135: typedef struct LINE {
1.18 mickey 136: struct LINE *l_fp; /* Link to the next line */
137: struct LINE *l_bp; /* Link to the previous line */
138: int l_size; /* Allocated size */
139: int l_used; /* Used size */
1.26 vincent 140: char *l_text; /* Content of the line */
1.4 millert 141: } LINE;
1.1 deraadt 142:
143: /*
144: * The rationale behind these macros is that you
145: * could (with some editing, like changing the type of a line
146: * link from a "LINE *" to a "REFLINE", and fixing the commands
147: * like file reading that break the rules) change the actual
148: * storage representation of lines to use something fancy on
149: * machines with small address spaces.
150: */
151: #define lforw(lp) ((lp)->l_fp)
152: #define lback(lp) ((lp)->l_bp)
153: #define lgetc(lp, n) (CHARMASK((lp)->l_text[(n)]))
154: #define lputc(lp, n, c) ((lp)->l_text[(n)]=(c))
155: #define llength(lp) ((lp)->l_used)
156: #define ltext(lp) ((lp)->l_text)
157:
158: /*
159: * All repeated structures are kept as linked lists of structures.
160: * All of these start with a LIST structure (except lines, which
161: * have their own abstraction). This will allow for
162: * later conversion to generic list manipulation routines should
163: * I decide to do that. it does mean that there are four extra
164: * bytes per window. I feel that this is an acceptable price,
165: * considering that there are usually only one or two windows.
166: */
167: typedef struct LIST {
168: union {
1.18 mickey 169: struct MGWIN *l_wp;
170: struct BUFFER *x_bp; /* l_bp is used by LINE */
171: struct LIST *l_nxt;
1.1 deraadt 172: } l_p;
1.36 vincent 173: const char *l_name;
1.1 deraadt 174: } LIST;
1.4 millert 175:
1.1 deraadt 176: /*
177: * Usual hack - to keep from uglifying the code with lotsa
178: * references through the union, we #define something for it.
179: */
180: #define l_next l_p.l_nxt
181:
182: /*
183: * There is a window structure allocated for
184: * every active display window. The windows are kept in a
185: * big list, in top to bottom screen order, with the listhead at
186: * "wheadp". Each window contains its own values of dot and mark.
187: * The flag field contains some bits that are set by commands
188: * to guide redisplay; although this is a bit of a compromise in
189: * terms of decoupling, the full blown redisplay is just too
190: * expensive to run for every input character.
191: */
1.4 millert 192: typedef struct MGWIN {
1.18 mickey 193: LIST w_list; /* List header */
194: struct BUFFER *w_bufp; /* Buffer displayed in window */
195: struct LINE *w_linep; /* Top line in the window */
196: struct LINE *w_dotp; /* Line containing "." */
197: struct LINE *w_markp; /* Line containing "mark" */
198: int w_doto; /* Byte offset for "." */
199: int w_marko; /* Byte offset for "mark" */
200: char w_toprow; /* Origin 0 top row of window */
201: char w_ntrows; /* # of rows of text in window */
202: char w_force; /* If NZ, forcing row. */
203: char w_flag; /* Flags. */
1.49 vincent 204: LIST_HEAD(, undo_rec) w_undo; /* Undo actions list */
205: REGION w_undopos; /* Where we were during the last
206: undo action */
207: struct undo_rec *w_undoptr;
1.4 millert 208: } MGWIN;
1.1 deraadt 209: #define w_wndp w_list.l_p.l_wp
210: #define w_name w_list.l_name
211:
212: /*
213: * Window flags are set by command processors to
214: * tell the display system what has happened to the buffer
215: * mapped by the window. Setting "WFHARD" is always a safe thing
216: * to do, but it may do more work than is necessary. Always try
217: * to set the simplest action that achieves the required update.
218: * Because commands set bits in the "w_flag", update will see
219: * all change flags, and do the most general one.
220: */
1.43 vincent 221: #define WFFORCE 0x01 /* Force reframe. */
222: #define WFMOVE 0x02 /* Movement from line to line. */
223: #define WFEDIT 0x04 /* Editing within a line. */
224: #define WFHARD 0x08 /* Better to a full display. */
225: #define WFMODE 0x10 /* Update mode line. */
1.1 deraadt 226:
1.35 vincent 227: struct undo_rec;
228:
1.1 deraadt 229: /*
230: * Text is kept in buffers. A buffer header, described
231: * below, exists for every buffer in the system. The buffers are
232: * kept in a big list, so that commands that search for a buffer by
233: * name can find the buffer header. There is a safe store for the
234: * dot and mark in the header, but this is only valid if the buffer
235: * is not being displayed (that is, if "b_nwnd" is 0). The text for
236: * the buffer is kept in a circularly linked list of lines, with
237: * a pointer to the header line in "b_linep".
238: */
1.4 millert 239: typedef struct BUFFER {
1.18 mickey 240: LIST b_list; /* buffer list pointer */
241: struct BUFFER *b_altb; /* Link to alternate buffer */
242: struct LINE *b_dotp; /* Link to "." LINE structure */
243: struct LINE *b_markp; /* ditto for mark */
244: struct LINE *b_linep; /* Link to the header LINE */
245: struct MAPS_S *b_modes[PBMODES]; /* buffer modes */
246: int b_doto; /* Offset of "." in above LINE */
247: int b_marko; /* ditto for the "mark" */
248: short b_nmodes; /* number of non-fundamental modes */
249: char b_nwnd; /* Count of windows on buffer */
250: char b_flag; /* Flags */
251: char b_fname[NFILEN];/* File name */
252: struct fileinfo b_fi; /* File attributes */
1.4 millert 253: } BUFFER;
1.1 deraadt 254: #define b_bufp b_list.l_p.x_bp
255: #define b_bname b_list.l_name
256:
1.43 vincent 257: #define BFCHG 0x01 /* Changed. */
258: #define BFBAK 0x02 /* Need to make a backup. */
1.1 deraadt 259: #ifdef NOTAB
1.43 vincent 260: #define BFNOTAB 0x04 /* no tab mode */
1.1 deraadt 261: #endif
1.43 vincent 262: #define BFOVERWRITE 0x08 /* overwrite mode */
263: #define BFREADONLY 0x10 /* read only mode */
1.37 vincent 264:
1.1 deraadt 265:
266: /*
1.30 vincent 267: * This structure holds information about recent actions for the Undo command.
268: */
269: struct undo_rec {
1.34 deraadt 270: LIST_ENTRY(undo_rec) next;
1.30 vincent 271: enum {
272: INSERT = 1,
273: DELETE,
274: BOUNDARY
275: } type;
276: REGION region;
277: int pos;
1.34 deraadt 278: char *content;
1.30 vincent 279: };
280:
281: /*
1.4 millert 282: * Prototypes.
283: */
284:
1.5 millert 285: /* tty.c X */
1.29 millert 286: void ttinit(void);
287: void ttreinit(void);
288: void tttidy(void);
289: void ttmove(int, int);
290: void tteeol(void);
291: void tteeop(void);
292: void ttbeep(void);
293: void ttinsl(int, int, int);
294: void ttdell(int, int, int);
295: void ttwindow(int, int);
296: void ttnowindow(void);
297: void ttcolor(int);
298: void ttresize(void);
1.31 deraadt 299:
300: volatile sig_atomic_t winch_flag;
1.4 millert 301:
302: /* ttyio.c */
1.29 millert 303: void ttopen(void);
304: int ttraw(void);
305: void ttclose(void);
306: int ttcooked(void);
307: int ttputc(int);
308: void ttflush(void);
309: int ttgetc(void);
310: int ttwait(int);
311: int typeahead(void);
1.4 millert 312:
313: /* dir.c */
1.29 millert 314: void dirinit(void);
315: int changedir(int, int);
316: int showcwdir(int, int);
1.4 millert 317:
318: /* dired.c */
1.29 millert 319: int dired(int, int);
320: int d_otherwindow(int, int);
321: int d_undel(int, int);
322: int d_undelbak(int, int);
323: int d_findfile(int, int);
324: int d_ffotherwindow(int, int);
325: int d_expunge(int, int);
326: int d_copy(int, int);
327: int d_del(int, int);
328: int d_rename(int, int);
1.48 vincent 329: int d_shell_command(int, int);
330: int d_create_directory(int, int);
1.5 millert 331:
332: /* file.c X */
1.29 millert 333: int fileinsert(int, int);
334: int filevisit(int, int);
1.40 vincent 335: int filevisitro(int, int);
1.29 millert 336: int poptofile(int, int);
337: BUFFER *findbuffer(char *);
338: int readin(char *);
339: int insertfile(char *, char *, int);
340: int filewrite(int, int);
341: int filesave(int, int);
342: int buffsave(BUFFER *);
343: int makebkfile(int, int);
344: int writeout(BUFFER *, char *);
345: void upmodes(BUFFER *);
1.5 millert 346:
347: /* line.c X */
1.29 millert 348: LINE *lalloc(int);
349: int lrealloc(LINE *, int);
350: void lfree(LINE *);
351: void lchange(int);
352: int linsert(int, int);
353: int lnewline(void);
354: int ldelete(RSIZE, int);
355: int ldelnewline(void);
356: int lreplace(RSIZE, char *, int);
357: void kdelete(void);
358: int kinsert(int, int);
359: int kremove(int);
1.5 millert 360:
361: /* window.c X */
1.50 vincent 362: MGWIN *new_window(BUFFER *);
363: void free_window(MGWIN *);
1.29 millert 364: int reposition(int, int);
365: int refresh(int, int);
366: int nextwind(int, int);
367: int prevwind(int, int);
368: int onlywind(int, int);
369: int splitwind(int, int);
370: int enlargewind(int, int);
371: int shrinkwind(int, int);
372: int delwind(int, int);
373: MGWIN *wpopup(void);
1.4 millert 374:
375: /* buffer.c */
1.47 vincent 376: int togglereadonly(int, int);
1.36 vincent 377: BUFFER *bfind(const char *, int);
1.29 millert 378: int poptobuffer(int, int);
379: int killbuffer(int, int);
380: int savebuffers(int, int);
381: int listbuffers(int, int);
382: int addlinef(BUFFER *, char *, ...);
1.12 art 383: #define addline(bp, text) addlinef(bp, "%s", text)
1.29 millert 384: int anycb(int);
385: int bclear(BUFFER *);
386: int showbuffer(BUFFER *, MGWIN *, int);
387: MGWIN *popbuf(BUFFER *);
388: int bufferinsert(int, int);
389: int usebuffer(int, int);
390: int notmodified(int, int);
391: int popbuftop(BUFFER *);
1.4 millert 392:
393: /* display.c */
1.29 millert 394: int vtresize(int, int, int);
395: void vtinit(void);
396: void vttidy(void);
397: void update(void);
1.5 millert 398:
399: /* echo.c X */
1.29 millert 400: void eerase(void);
1.36 vincent 401: int eyorn(const char *);
402: int eyesno(const char *);
1.29 millert 403: void ewprintf(const char *fmt, ...);
404: int ereply(const char *, char *, int, ...);
405: int eread(const char *, char *, int, int, ...);
406: int getxtra(LIST *, LIST *, int, int);
407: void free_file_list(LIST *);
1.4 millert 408:
409: /* fileio.c */
1.36 vincent 410: int ffropen(const char *, BUFFER *);
411: int ffwopen(const char *, BUFFER *);
1.29 millert 412: int ffclose(BUFFER *);
413: int ffputbuf(BUFFER *);
414: int ffgetline(char *, int, int *);
1.36 vincent 415: int fbackupfile(const char *);
416: char *adjustname(const char *);
1.29 millert 417: char *startupfile(char *);
418: int copy(char *, char *);
419: BUFFER *dired_(char *);
420: int d_makename(LINE *, char *, int);
421: LIST *make_file_list(char *);
1.4 millert 422:
1.5 millert 423: /* kbd.c X */
1.29 millert 424: int do_meta(int, int);
425: int bsmap(int, int);
426: void ungetkey(int);
427: int getkey(int);
428: int doin(void);
429: int rescan(int, int);
430: int universal_argument(int, int);
431: int digit_argument(int, int);
432: int negative_argument(int, int);
433: int selfinsert(int, int);
434: int quote(int, int);
1.4 millert 435:
436: /* main.c */
1.29 millert 437: int ctrlg(int, int);
438: int quit(int, int);
1.4 millert 439:
440: /* ttyio.c */
1.29 millert 441: void panic(char *);
1.4 millert 442:
443: /* cinfo.c */
1.29 millert 444: char *keyname(char *, size_t, int);
1.4 millert 445:
446: /* basic.c */
1.29 millert 447: int gotobol(int, int);
448: int backchar(int, int);
449: int gotoeol(int, int);
450: int forwchar(int, int);
451: int gotobob(int, int);
452: int gotoeob(int, int);
453: int forwline(int, int);
454: int backline(int, int);
455: void setgoal(void);
456: int getgoal(LINE *);
457: int forwpage(int, int);
458: int backpage(int, int);
459: int forw1page(int, int);
460: int back1page(int, int);
461: int pagenext(int, int);
462: void isetmark(void);
463: int setmark(int, int);
464: int swapmark(int, int);
465: int gotoline(int, int);
1.5 millert 466:
467: /* random.c X */
1.29 millert 468: int showcpos(int, int);
469: int getcolpos(void);
470: int twiddle(int, int);
471: int openline(int, int);
472: int newline(int, int);
473: int deblank(int, int);
474: int justone(int, int);
475: int delwhite(int, int);
476: int indent(int, int);
477: int forwdel(int, int);
478: int backdel(int, int);
479: int killline(int, int);
480: int yank(int, int);
481: int space_to_tabstop(int, int);
1.5 millert 482:
483: /* extend.c X */
1.29 millert 484: int insert(int, int);
485: int bindtokey(int, int);
486: int localbind(int, int);
487: int define_key(int, int);
488: int unbindtokey(int, int);
489: int localunbind(int, int);
490: int extend(int, int);
491: int evalexpr(int, int);
492: int evalbuffer(int, int);
493: int evalfile(int, int);
1.36 vincent 494: int load(const char *);
1.29 millert 495: int excline(char *);
1.5 millert 496:
497: /* help.c X */
1.29 millert 498: int desckey(int, int);
499: int wallchart(int, int);
500: int help_help(int, int);
501: int apropos_command(int, int);
1.5 millert 502:
503: /* paragraph.c X */
1.29 millert 504: int gotobop(int, int);
505: int gotoeop(int, int);
506: int fillpara(int, int);
507: int killpara(int, int);
508: int fillword(int, int);
509: int setfillcol(int, int);
1.5 millert 510:
511: /* word.c X */
1.29 millert 512: int backword(int, int);
513: int forwword(int, int);
514: int upperword(int, int);
515: int lowerword(int, int);
516: int capword(int, int);
517: int delfword(int, int);
518: int delbword(int, int);
519: int inword(void);
1.5 millert 520:
521: /* region.c X */
1.29 millert 522: int killregion(int, int);
523: int copyregion(int, int);
524: int lowerregion(int, int);
525: int upperregion(int, int);
526: int prefixregion(int, int);
527: int setprefix(int, int);
1.30 vincent 528: int region_get_data(REGION *, char *, int);
529: int region_put_data(const char *, int);
1.5 millert 530:
531: /* search.c X */
1.29 millert 532: int forwsearch(int, int);
533: int backsearch(int, int);
534: int searchagain(int, int);
535: int forwisearch(int, int);
536: int backisearch(int, int);
537: int queryrepl(int, int);
538: int forwsrch(void);
539: int backsrch(void);
540: int readpattern(char *);
1.5 millert 541:
542: /* spawn.c X */
1.29 millert 543: int spawncli(int, int);
1.5 millert 544:
545: /* ttykbd.c X */
1.29 millert 546: void ttykeymapinit(void);
547: void ttykeymaptidy(void);
1.5 millert 548:
549: /* match.c X */
1.29 millert 550: int showmatch(int, int);
1.5 millert 551:
552: /* version.c X */
1.29 millert 553: int showversion(int, int);
1.5 millert 554:
555: #ifndef NO_MACRO
556: /* macro.c X */
1.29 millert 557: int definemacro(int, int);
558: int finishmacro(int, int);
559: int executemacro(int, int);
1.5 millert 560: #endif /* !NO_MACRO */
561:
562: /* modes.c X */
1.29 millert 563: int indentmode(int, int);
564: int fillmode(int, int);
565: int blinkparen(int, int);
1.5 millert 566: #ifdef NOTAB
1.29 millert 567: int notabmode(int, int);
1.5 millert 568: #endif /* NOTAB */
1.29 millert 569: int overwrite(int, int);
570: int set_default_mode(int,int);
1.5 millert 571:
572: #ifdef REGEX
573: /* re_search.c X */
1.29 millert 574: int re_forwsearch(int, int);
575: int re_backsearch(int, int);
576: int re_searchagain(int, int);
577: int re_queryrepl(int, int);
578: int setcasefold(int, int);
579: int delmatchlines(int, int);
580: int delnonmatchlines(int, int);
581: int cntmatchlines(int, int);
582: int cntnonmatchlines(int, int);
1.5 millert 583: #endif /* REGEX */
1.1 deraadt 584:
1.30 vincent 585: /* undo.c X */
1.35 vincent 586: void free_undo_record(struct undo_rec *);
1.47 vincent 587: int undo_dump(int, int);
1.30 vincent 588: int undo_enable(int);
1.39 vincent 589: int undo_add_custom(int, int, LINE *, int, void *, int);
1.30 vincent 590: int undo_add_boundary(void);
591: int undo_add_insert(LINE *, int, int);
592: int undo_add_delete(LINE *, int, int);
593: int undo_add_change(LINE *, int, int);
1.32 vincent 594: int undo(int, int);
1.41 vincent 595:
596: /* autoexec.c X */
597: int auto_execute(int, int);
598: PF *find_autoexec(const char *);
599: int add_autoexec(const char *, const char *);
1.46 vincent 600:
601: /* mail.c X */
602: void mail_init(void);
1.30 vincent 603:
1.1 deraadt 604: /*
605: * Externals.
606: */
1.5 millert 607: extern BUFFER *bheadp;
608: extern BUFFER *curbp;
609: extern MGWIN *curwp;
610: extern MGWIN *wheadp;
611: extern int thisflag;
612: extern int lastflag;
613: extern int curgoal;
1.45 deraadt 614: extern int startrow;
1.5 millert 615: extern int epresf;
616: extern int sgarbf;
617: extern int mode;
618: extern int nrow;
619: extern int ncol;
620: extern int ttrow;
621: extern int ttcol;
622: extern int tttop;
623: extern int ttbot;
624: extern int tthue;
625: extern int defb_nmodes;
626: extern int defb_flag;
1.17 mickey 627: extern const char cinfo[];
1.5 millert 628: extern char *keystrings[];
1.25 vincent 629: extern char pat[NPAT];
1.5 millert 630: #ifndef NO_DPROMPT
631: extern char prompt[];
632: #endif /* !NO_DPROMPT */
633:
634: /*
635: * Globals.
636: */
637: int tceeol;
638: int tcinsl;
639: int tcdell;
![[BACK]](/icons/back.gif){kind=icon}
Return to def.h CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / mg