Bring in the minix editor 'mined', in its original form except for necessary
[dragonfly.git] / bin / mined / mined.h
1 /* $DragonFly: src/bin/mined/mined.h,v 1.1 2005/03/15 01:56:24 dillon Exp $ */
2 /*========================================================================*
3  *                              Mined.h                                   *
4  *========================================================================*/
5
6 #define _PROTOTYPE(a, b)        a b
7
8 #include <sys/types.h>
9 #include <fcntl.h>
10 #include <stdlib.h>
11 #include <unistd.h>
12 #include <limits.h>
13
14 #ifndef YMAX
15 #ifdef UNIX
16 #include <stdio.h>
17 #undef putchar
18 #undef getchar
19 #undef NULL
20 #undef EOF
21 extern char *CE, *VS, *SO, *SE, *CL, *AL, *CM;
22 #define YMAX            49
23 #else
24 #define YMAX            24              /* Maximum y coordinate starting at 0 */
25 /* Escape sequences. */
26 extern char *enter_string;      /* String printed on entering mined */
27 extern char *rev_video;         /* String for starting reverse video */
28 extern char *normal_video;      /* String for leaving reverse video */
29 extern char *rev_scroll;        /* String for reverse scrolling */
30 extern char *pos_string;        /* Absolute cursor positioning */
31 #define X_PLUS  ' '             /* To be added to x for cursor sequence */
32 #define Y_PLUS  ' '             /* To be added to y for cursor sequence */
33 #endif /* UNIX */
34
35 #define XMAX            79              /* Maximum x coordinate starting at 0*/
36 #define SCREENMAX       (YMAX - 1)      /* Number of lines displayed */
37 #define XBREAK          (XMAX - 0)      /* Line shift at this coordinate */
38 #define SHIFT_SIZE      25              /* Number of chars to shift */
39 #define SHIFT_MARK      '!'             /* Char indicating line continues */
40 #define MAX_CHARS       1024            /* Maximum chars on one line */
41
42 /* LINE_START must be rounded up to the lowest SHIFT_SIZE */
43 #define LINE_START      (((-MAX_CHARS - 1) / SHIFT_SIZE) * SHIFT_SIZE \
44                                    - SHIFT_SIZE)
45 #define LINE_END        (MAX_CHARS + 1) /* Highest x-coordinate for line */
46
47 #define LINE_LEN        (XMAX + 1)      /* Number of characters on line */
48 #define SCREEN_SIZE     (XMAX * YMAX)   /* Size of I/O buffering */
49 #define BLOCK_SIZE      1024
50
51 /* Return values of functions */
52 #define ERRORS          -1
53 #define NO_LINE         (ERRORS - 1)    /* Must be < 0 */
54 #define FINE            (ERRORS + 1)
55 #define NO_INPUT        (ERRORS + 2)
56
57 #define STD_OUT         1               /* File descriptor for terminal */
58
59 #if (CHIP == INTEL)
60 #define MEMORY_SIZE     (50 * 1024)     /* Size of data space to malloc */
61 #endif
62
63 #define REPORT  2                       /* Report change of lines on # lines */
64
65 typedef int FLAG;
66
67 /* General flags */
68 #define FALSE           0
69 #define TRUE            1
70 #define NOT_VALID       2
71 #define VALID           3
72 #define OFF             4
73 #define ON              5
74
75 /* Expression flags */
76 #define FORWARD         6
77 #define REVERSE         7
78
79 /* Yank flags */
80 #define SMALLER         8
81 #define BIGGER          9
82 #define SAME            10
83 #define EMPTY           11
84 #define NO_DELETE       12
85 #define DELETE          13
86 #define READ            14
87 #define WRITE           15
88
89 /*
90  * The Line structure.  Each line entry contains a pointer to the next line,
91  * a pointer to the previous line, a pointer to the text and an unsigned char
92  * telling at which offset of the line printing should start (usually 0).
93  */
94 struct Line {
95   struct Line *next;
96   struct Line *prev;
97   char *text;
98   unsigned char shift_count;
99 };
100
101 typedef struct Line LINE;
102
103 /* Dummy line indicator */
104 #define DUMMY           0x80
105 #define DUMMY_MASK      0x7F
106
107 /* Expression definitions */
108 #define NO_MATCH        0
109 #define MATCH           1
110 #define REG_ERROR       2
111
112 #define BEGIN_LINE      (2 * REG_ERROR)
113 #define END_LINE        (2 * BEGIN_LINE)
114
115 /*
116  * The regex structure. Status can be any of 0, BEGIN_LINE or REG_ERROR. In
117  * the last case, the result.err_mess field is assigned. Start_ptr and end_ptr
118  * point to the match found. For more details see the documentation file.
119  */
120 struct regex {
121   union {
122         char *err_mess;
123         int *expression;
124   } result;
125   char status;
126   char *start_ptr;
127   char *end_ptr;
128 };
129
130 typedef struct regex REGEX;
131
132 /* NULL definitions */
133 #define NIL_PTR         ((char *) 0)
134 #define NIL_LINE        ((LINE *) 0)
135 #define NIL_REG         ((REGEX *) 0)
136 #define NIL_INT         ((int *) 0)
137
138 /*
139  * Forward declarations
140  */
141 extern int nlines;              /* Number of lines in file */
142 extern LINE *header;            /* Head of line list */
143 extern LINE *tail;              /* Last line in line list */
144 extern LINE *top_line;          /* First line of screen */
145 extern LINE *bot_line;          /* Last line of screen */
146 extern LINE *cur_line;          /* Current line in use */
147 extern char *cur_text;          /* Pointer to char on current line in use */
148 extern int last_y;              /* Last y of screen. Usually SCREENMAX */
149 extern int ymax;
150 extern int screenmax;
151 extern char screen[SCREEN_SIZE];/* Output buffer for "writes" and "reads" */
152
153 extern int x, y;                        /* x, y coordinates on screen */
154 extern FLAG modified;                   /* Set when file is modified */
155 extern FLAG stat_visible;               /* Set if status_line is visible */
156 extern FLAG writable;                   /* Set if file cannot be written */
157 extern FLAG quit;                       /* Set when quit character is typed */
158 extern FLAG rpipe;              /* Set if file should be read from stdin */
159 extern int input_fd;                    /* Fd for command input */
160 extern FLAG loading;                    /* Set if we're loading a file */
161 extern int out_count;                   /* Index in output buffer */
162 extern char file_name[LINE_LEN];        /* Name of file in use */
163 extern char text_buffer[MAX_CHARS];     /* Buffer for modifying text */
164 extern char *blank_line;                /* Clear line to end */
165
166 extern char yank_file[];                /* Temp file for buffer */
167 extern FLAG yank_status;                /* Status of yank_file */
168 extern long chars_saved;                /* Nr of chars saved in buffer */
169
170 /*
171  * Empty output buffer
172  */
173 #define clear_buffer()                  (out_count = 0)
174
175 /*
176  * Print character on terminal
177  */
178 #define putchar(c)                      (void) write_char(STD_OUT, (c))
179
180 /*
181  * Ring bell on terminal
182  */
183 #define ring_bell()                     putchar('\07')
184
185 /*
186  * Print string on terminal
187  */
188 #define string_print(str)               (void) writeline(STD_OUT, (str))
189
190 /*
191  * Flush output buffer
192  */
193 #define flush()                         (void) flush_buffer(STD_OUT)
194
195 /*
196  * Convert cnt to nearest tab position
197  */
198 #define tab(cnt)                        (((cnt) + 8) & ~07)
199 #define is_tab(c)                       ((c) == '\t')
200
201 /*
202  * Word defenitions
203  */
204 #define white_space(c)  ((c) == ' ' || (c) == '\t')
205 #define alpha(c)        ((c) != ' ' && (c) != '\t' && (c) != '\n')
206
207 /*
208  * Print line on terminal at offset 0 and clear tail of line
209  */
210 #define line_print(line)                put_line(line, 0, TRUE)
211
212 /*
213  * Move to coordinates and set textp. (Don't use address)
214  */
215 #define move_to(nx, ny)                 move((nx), NIL_PTR, (ny))
216
217 /*
218  * Move to coordinates on screen as indicated by textp.
219  */
220 #define move_address(address)           move(0, (address), y)
221
222 /*
223  * Functions handling status_line. ON means in reverse video.
224  */
225 #define status_line(str1, str2) (void) bottom_line(ON, (str1), \
226                                                     (str2), NIL_PTR, FALSE)
227 #define error(str1, str2)       (void) bottom_line(ON, (str1), \
228                                                     (str2), NIL_PTR, FALSE)
229 #define get_string(str1,str2, fl) bottom_line(ON, (str1), NIL_PTR, (str2), fl)
230 #define clear_status()          (void) bottom_line(OFF, NIL_PTR, NIL_PTR, \
231                                                     NIL_PTR, FALSE)
232
233 /*
234  * Print info about current file and buffer.
235  */
236 #define fstatus(mess, cnt)      file_status((mess), (cnt), file_name, \
237                                              nlines, writable, modified)
238
239 /*
240  * Get real shift value.
241  */
242 #define get_shift(cnt)          ((cnt) & DUMMY_MASK)
243
244 #endif /* YMAX */
245
246 /* mined1.c */
247
248 _PROTOTYPE(void FS, (void));
249 _PROTOTYPE(void VI, (void));
250 _PROTOTYPE(int WT, (void));
251 _PROTOTYPE(void XWT, (void));
252 _PROTOTYPE(void SH, (void));
253 _PROTOTYPE(LINE *proceed, (LINE *line, int count ));
254 _PROTOTYPE(int bottom_line, (FLAG revfl, char *s1, char *s2, char *inbuf, FLAG statfl ));
255 _PROTOTYPE(int count_chars, (LINE *line ));
256 _PROTOTYPE(void move, (int new_x, char *new_address, int new_y ));
257 _PROTOTYPE(int find_x, (LINE *line, char *address ));
258 _PROTOTYPE(char *find_address, (LINE *line, int x_coord, int *old_x ));
259 _PROTOTYPE(int length_of, (char *string ));
260 _PROTOTYPE(void copy_string, (char *to, char *from ));
261 _PROTOTYPE(void reset, (LINE *head_line, int screen_y ));
262 _PROTOTYPE(void set_cursor, (int nx, int ny ));
263 _PROTOTYPE(void open_device, (void));
264 _PROTOTYPE(int getchar, (void));
265 _PROTOTYPE(void display, (int x_coord, int y_coord, LINE *line, int count ));
266 _PROTOTYPE(int write_char, (int fd, int c ));
267 _PROTOTYPE(int writeline, (int fd, char *text ));
268 _PROTOTYPE(void put_line, (LINE *line, int offset, FLAG clear_line ));
269 _PROTOTYPE(int flush_buffer, (int fd ));
270 _PROTOTYPE(void bad_write, (int fd ));
271 _PROTOTYPE(void catch, (int sig ));
272 _PROTOTYPE(void abort_mined, (void));
273 _PROTOTYPE(void raw_mode, (FLAG state ));
274 _PROTOTYPE(void panic, (char *message ));
275 _PROTOTYPE(char *alloc, (int bytes ));
276 _PROTOTYPE(void free_space, (char *p ));
277 /*
278 #ifdef UNIX
279 _PROTOTYPE(void (*key_map [128]), (void));
280 #else
281 _PROTOTYPE(void (*key_map [256]), (void));
282 #endif
283 */
284 _PROTOTYPE(void initialize, (void));
285 _PROTOTYPE(char *basename, (char *path ));
286 _PROTOTYPE(void load_file, (char *file ));
287 _PROTOTYPE(int get_line, (int fd, char *buffer ));
288 _PROTOTYPE(LINE *install_line, (char *buffer, int length ));
289 _PROTOTYPE(void main, (int argc, char *argv []));
290 _PROTOTYPE(void RD, (void));
291 _PROTOTYPE(void I, (void));
292 _PROTOTYPE(void XT, (void));
293 _PROTOTYPE(void ESC, (void));
294 _PROTOTYPE(int ask_save, (void));
295 _PROTOTYPE(int line_number, (void));
296 _PROTOTYPE(void file_status, (char *message, long count, char *file, int lines,
297                                                  FLAG writefl, FLAG changed ));
298 #if __STDC__
299 void build_string(char *buf, char *fmt, ...);
300 #else
301 void build_string();
302 #endif
303 _PROTOTYPE(char *num_out, (long number ));
304 _PROTOTYPE(int get_number, (char *message, int *result ));
305 _PROTOTYPE(int input, (char *inbuf, FLAG clearfl ));
306 _PROTOTYPE(int get_file, (char *message, char *file ));
307 _PROTOTYPE(int _getchar, (void));
308 _PROTOTYPE(void _flush, (void));
309 _PROTOTYPE(void _putchar, (int c ));
310 _PROTOTYPE(void get_term, (void));
311
312 /* mined2.c */
313
314 _PROTOTYPE(void UP, (void));
315 _PROTOTYPE(void DN, (void));
316 _PROTOTYPE(void LF, (void));
317 _PROTOTYPE(void RT, (void));
318 _PROTOTYPE(void HIGH, (void));
319 _PROTOTYPE(void LOW, (void));
320 _PROTOTYPE(void BL, (void));
321 _PROTOTYPE(void EL, (void));
322 _PROTOTYPE(void GOTO, (void));
323 _PROTOTYPE(void PD, (void));
324 _PROTOTYPE(void PU, (void));
325 _PROTOTYPE(void HO, (void));
326 _PROTOTYPE(void EF, (void));
327 _PROTOTYPE(void SU, (void));
328 _PROTOTYPE(void SD, (void));
329 _PROTOTYPE(int forward_scroll, (void));
330 _PROTOTYPE(int reverse_scroll, (void));
331 _PROTOTYPE(void MP, (void));
332 _PROTOTYPE(void move_previous_word, (FLAG remove ));
333 _PROTOTYPE(void MN, (void));
334 _PROTOTYPE(void move_next_word, (FLAG remove ));
335 _PROTOTYPE(void DCC, (void));
336 _PROTOTYPE(void DPC, (void));
337 _PROTOTYPE(void DLN, (void));
338 _PROTOTYPE(void DNW, (void));
339 _PROTOTYPE(void DPW, (void));
340 _PROTOTYPE(void S, (int character ));
341 _PROTOTYPE(void CTL, (void));
342 _PROTOTYPE(void LIB, (void));
343 _PROTOTYPE(LINE *line_insert, (LINE *line, char *string, int len ));
344 _PROTOTYPE(int insert, (LINE *line, char *location, char *string ));
345 _PROTOTYPE(LINE *line_delete, (LINE *line ));
346 _PROTOTYPE(void delete, (LINE *start_line, char *start_textp, LINE *end_line, char *end_textp ));
347 _PROTOTYPE(void PT, (void));
348 _PROTOTYPE(void IF, (void));
349 _PROTOTYPE(void file_insert, (int fd, FLAG old_pos ));
350 _PROTOTYPE(void WB, (void));
351 _PROTOTYPE(void MA, (void));
352 _PROTOTYPE(void YA, (void));
353 _PROTOTYPE(void DT, (void));
354 _PROTOTYPE(void set_up, (FLAG remove ));
355 _PROTOTYPE(FLAG checkmark, (void));
356 _PROTOTYPE(int legal, (void));
357 _PROTOTYPE(void yank, (LINE *start_line, char *start_textp, LINE *end_line, char *end_textp, FLAG remove ));
358 _PROTOTYPE(int scratch_file, (FLAG mode ));
359 _PROTOTYPE(void SF, (void));
360 _PROTOTYPE(void SR, (void));
361 _PROTOTYPE(REGEX *get_expression, (char *message ));
362 _PROTOTYPE(void GR, (void));
363 _PROTOTYPE(void LR, (void));
364 _PROTOTYPE(void change, (char *message, FLAG file ));
365 _PROTOTYPE(char *substitute, (LINE *line, REGEX *program, char *replacement ));
366 _PROTOTYPE(void search, (char *message, FLAG method ));
367 _PROTOTYPE(int find_y, (LINE *match_line ));
368 _PROTOTYPE(void finished, (REGEX *program, int *last_exp ));
369 _PROTOTYPE(void compile, (char *pattern, REGEX *program ));
370 _PROTOTYPE(LINE *match, (REGEX *program, char *string, FLAG method ));
371 _PROTOTYPE(int line_check, (REGEX *program, char *string, FLAG method ));
372 _PROTOTYPE(int check_string, (REGEX *program, char *string, int *expression ));
373 _PROTOTYPE(int star, (REGEX *program, char *end_position, char *string, int *expression ));
374 _PROTOTYPE(int in_list, (int *list, int c, int list_length, int opcode ));
375 _PROTOTYPE(void dummy_line, (void));