xref: /freebsd/contrib/less/less.h (revision 595e514d0df2bac5b813d35f83e32875dbf16a83)
1 /*
2  * Copyright (C) 1984-2012  Mark Nudelman
3  *
4  * You may distribute under the terms of either the GNU General Public
5  * License or the Less License, as specified in the README file.
6  *
7  * For more information, see the README file.
8  */
9 
10 #define NEWBOT 1
11 
12 /*
13  * Standard include file for "less".
14  */
15 
16 /*
17  * Defines for MSDOS_COMPILER.
18  */
19 #define	MSOFTC		1	/* Microsoft C */
20 #define	BORLANDC	2	/* Borland C */
21 #define	WIN32C		3	/* Windows (Borland C or Microsoft C) */
22 #define	DJGPPC		4	/* DJGPP C */
23 
24 /*
25  * Include the file of compile-time options.
26  * The <> make cc search for it in -I., not srcdir.
27  */
28 #include <defines.h>
29 
30 #ifdef _SEQUENT_
31 /*
32  * Kludge for Sequent Dynix systems that have sigsetmask, but
33  * it's not compatible with the way less calls it.
34  * {{ Do other systems need this? }}
35  */
36 #undef HAVE_SIGSETMASK
37 #endif
38 
39 /*
40  * Language details.
41  */
42 #if HAVE_VOID
43 #define	VOID_POINTER	void *
44 #else
45 #define	VOID_POINTER	char *
46 #define	void  int
47 #endif
48 #if HAVE_CONST
49 #define	constant	const
50 #else
51 #define	constant
52 #endif
53 
54 #define	public		/* PUBLIC FUNCTION */
55 
56 /* Library function declarations */
57 
58 #if HAVE_SYS_TYPES_H
59 #include <sys/types.h>
60 #endif
61 #if HAVE_STDIO_H
62 #include <stdio.h>
63 #endif
64 #if HAVE_FCNTL_H
65 #include <fcntl.h>
66 #endif
67 #if HAVE_UNISTD_H
68 #include <unistd.h>
69 #endif
70 #if HAVE_CTYPE_H
71 #include <ctype.h>
72 #endif
73 #if HAVE_WCTYPE_H
74 #include <wctype.h>
75 #endif
76 #if HAVE_LIMITS_H
77 #include <limits.h>
78 #endif
79 #if HAVE_STDLIB_H
80 #include <stdlib.h>
81 #endif
82 #if HAVE_STRING_H
83 #include <string.h>
84 #endif
85 
86 /* OS-specific includes */
87 #ifdef _OSK
88 #include <modes.h>
89 #include <strings.h>
90 #endif
91 
92 #ifdef __TANDEM
93 #include <floss.h>
94 #endif
95 
96 #if MSDOS_COMPILER==WIN32C || OS2
97 #include <io.h>
98 #endif
99 
100 #if MSDOS_COMPILER==DJGPPC
101 #include <io.h>
102 #include <sys/exceptn.h>
103 #include <conio.h>
104 #include <pc.h>
105 #endif
106 
107 #if !HAVE_STDLIB_H
108 char *getenv();
109 off_t lseek();
110 VOID_POINTER calloc();
111 void free();
112 #endif
113 
114 /*
115  * Simple lowercase test which can be used during option processing
116  * (before options are parsed which might tell us what charset to use).
117  */
118 #define ASCII_IS_UPPER(c)	((c) >= 'A' && (c) <= 'Z')
119 #define ASCII_IS_LOWER(c)	((c) >= 'a' && (c) <= 'z')
120 #define	ASCII_TO_UPPER(c)	((c) - 'a' + 'A')
121 #define	ASCII_TO_LOWER(c)	((c) - 'A' + 'a')
122 
123 #undef IS_UPPER
124 #undef IS_LOWER
125 #undef TO_UPPER
126 #undef TO_LOWER
127 #undef IS_SPACE
128 #undef IS_DIGIT
129 
130 #if HAVE_WCTYPE
131 #define	IS_UPPER(c)	iswupper(c)
132 #define	IS_LOWER(c)	iswlower(c)
133 #define	TO_UPPER(c)	towupper(c)
134 #define	TO_LOWER(c)	towlower(c)
135 #else
136 #if HAVE_UPPER_LOWER
137 #define	IS_UPPER(c)	isupper((unsigned char) (c))
138 #define	IS_LOWER(c)	islower((unsigned char) (c))
139 #define	TO_UPPER(c)	toupper((unsigned char) (c))
140 #define	TO_LOWER(c)	tolower((unsigned char) (c))
141 #else
142 #define	IS_UPPER(c)	ASCII_IS_UPPER(c)
143 #define	IS_LOWER(c)	ASCII_IS_LOWER(c)
144 #define	TO_UPPER(c)	ASCII_TO_UPPER(c)
145 #define	TO_LOWER(c)	ASCII_TO_LOWER(c)
146 #endif
147 #endif
148 
149 #ifdef isspace
150 #define IS_SPACE(c)	isspace((unsigned char)(c))
151 #else
152 #define IS_SPACE(c)	((c) == ' ' || (c) == '\t' || (c) == '\n' || (c) == '\r' || (c) == '\f')
153 #endif
154 
155 #ifdef isdigit
156 #define IS_DIGIT(c)	isdigit((unsigned char)(c))
157 #else
158 #define IS_DIGIT(c)	((c) >= '0' && (c) <= '9')
159 #endif
160 
161 #define IS_CSI_START(c)	(((LWCHAR)(c)) == ESC || (((LWCHAR)(c)) == CSI))
162 
163 #ifndef NULL
164 #define	NULL	0
165 #endif
166 
167 #ifndef TRUE
168 #define	TRUE		1
169 #endif
170 #ifndef FALSE
171 #define	FALSE		0
172 #endif
173 
174 #define	OPT_OFF		0
175 #define	OPT_ON		1
176 #define	OPT_ONPLUS	2
177 
178 #if !HAVE_MEMCPY
179 #ifndef memcpy
180 #define	memcpy(to,from,len)	bcopy((from),(to),(len))
181 #endif
182 #endif
183 
184 #if HAVE_SNPRINTF
185 #define SNPRINTF1(str, size, fmt, v1)             snprintf((str), (size), (fmt), (v1))
186 #define SNPRINTF2(str, size, fmt, v1, v2)         snprintf((str), (size), (fmt), (v1), (v2))
187 #define SNPRINTF3(str, size, fmt, v1, v2, v3)     snprintf((str), (size), (fmt), (v1), (v2), (v3))
188 #define SNPRINTF4(str, size, fmt, v1, v2, v3, v4) snprintf((str), (size), (fmt), (v1), (v2), (v3), (v4))
189 #else
190 /* Use unsafe sprintf if we don't have snprintf. */
191 #define SNPRINTF1(str, size, fmt, v1)             sprintf((str), (fmt), (v1))
192 #define SNPRINTF2(str, size, fmt, v1, v2)         sprintf((str), (fmt), (v1), (v2))
193 #define SNPRINTF3(str, size, fmt, v1, v2, v3)     sprintf((str), (fmt), (v1), (v2), (v3))
194 #define SNPRINTF4(str, size, fmt, v1, v2, v3, v4) sprintf((str), (fmt), (v1), (v2), (v3), (v4))
195 #endif
196 
197 #define	BAD_LSEEK	((off_t)-1)
198 
199 #ifndef SEEK_SET
200 #define SEEK_SET 0
201 #endif
202 #ifndef SEEK_END
203 #define SEEK_END 2
204 #endif
205 
206 #ifndef CHAR_BIT
207 #define CHAR_BIT 8
208 #endif
209 
210 /*
211  * Upper bound on the string length of an integer converted to string.
212  * 302 / 1000 is ceil (log10 (2.0)).  Subtract 1 for the sign bit;
213  * add 1 for integer division truncation; add 1 more for a minus sign.
214  */
215 #define INT_STRLEN_BOUND(t) ((sizeof(t) * CHAR_BIT - 1) * 302 / 1000 + 1 + 1)
216 
217 /*
218  * Special types and constants.
219  */
220 typedef unsigned long LWCHAR;
221 typedef off_t		POSITION;
222 typedef off_t		LINENUM;
223 #define MIN_LINENUM_WIDTH  7	/* Min printing width of a line number */
224 #define MAX_UTF_CHAR_LEN   6	/* Max bytes in one UTF-8 char */
225 
226 #define	NULL_POSITION	((POSITION)(-1))
227 
228 /*
229  * Flags for open()
230  */
231 #if MSDOS_COMPILER || OS2
232 #define	OPEN_READ	(O_RDONLY|O_BINARY)
233 #else
234 #ifdef _OSK
235 #define	OPEN_READ	(S_IREAD)
236 #else
237 #ifdef O_RDONLY
238 #define	OPEN_READ	(O_RDONLY)
239 #else
240 #define	OPEN_READ	(0)
241 #endif
242 #endif
243 #endif
244 
245 #if defined(O_WRONLY) && defined(O_APPEND)
246 #define	OPEN_APPEND	(O_APPEND|O_WRONLY)
247 #else
248 #ifdef _OSK
249 #define OPEN_APPEND	(S_IWRITE)
250 #else
251 #define	OPEN_APPEND	(1)
252 #endif
253 #endif
254 
255 /*
256  * Set a file descriptor to binary mode.
257  */
258 #if MSDOS_COMPILER==MSOFTC
259 #define	SET_BINARY(f)	_setmode(f, _O_BINARY);
260 #else
261 #if MSDOS_COMPILER || OS2
262 #define	SET_BINARY(f)	setmode(f, O_BINARY)
263 #else
264 #define	SET_BINARY(f)
265 #endif
266 #endif
267 
268 /*
269  * Does the shell treat "?" as a metacharacter?
270  */
271 #if MSDOS_COMPILER || OS2 || _OSK
272 #define	SHELL_META_QUEST 0
273 #else
274 #define	SHELL_META_QUEST 1
275 #endif
276 
277 #define	SPACES_IN_FILENAMES 1
278 
279 /*
280  * An IFILE represents an input file.
281  */
282 #define	IFILE		VOID_POINTER
283 #define	NULL_IFILE	((IFILE)NULL)
284 
285 /*
286  * The structure used to represent a "screen position".
287  * This consists of a file position, and a screen line number.
288  * The meaning is that the line starting at the given file
289  * position is displayed on the ln-th line of the screen.
290  * (Screen lines before ln are empty.)
291  */
292 struct scrpos
293 {
294 	POSITION pos;
295 	int ln;
296 };
297 
298 typedef union parg
299 {
300 	char *p_string;
301 	int p_int;
302 	LINENUM p_linenum;
303 } PARG;
304 
305 #define	NULL_PARG	((PARG *)NULL)
306 
307 struct textlist
308 {
309 	char *string;
310 	char *endstring;
311 };
312 
313 #define	EOI		(-1)
314 
315 #define	READ_INTR	(-2)
316 
317 /* A fraction is represented by an int n; the fraction is n/NUM_FRAC_DENOM */
318 #define NUM_FRAC_DENOM			1000000
319 #define NUM_LOG_FRAC_DENOM		6
320 
321 /* How quiet should we be? */
322 #define	NOT_QUIET	0	/* Ring bell at eof and for errors */
323 #define	LITTLE_QUIET	1	/* Ring bell only for errors */
324 #define	VERY_QUIET	2	/* Never ring bell */
325 
326 /* How should we prompt? */
327 #define	PR_SHORT	0	/* Prompt with colon */
328 #define	PR_MEDIUM	1	/* Prompt with message */
329 #define	PR_LONG		2	/* Prompt with longer message */
330 
331 /* How should we handle backspaces? */
332 #define	BS_SPECIAL	0	/* Do special things for underlining and bold */
333 #define	BS_NORMAL	1	/* \b treated as normal char; actually output */
334 #define	BS_CONTROL	2	/* \b treated as control char; prints as ^H */
335 
336 /* How should we search? */
337 #define	SRCH_FORW       (1 << 0)  /* Search forward from current position */
338 #define	SRCH_BACK       (1 << 1)  /* Search backward from current position */
339 #define SRCH_NO_MOVE    (1 << 2)  /* Highlight, but don't move */
340 #define SRCH_FIND_ALL   (1 << 4)  /* Find and highlight all matches */
341 #define SRCH_NO_MATCH   (1 << 8)  /* Search for non-matching lines */
342 #define SRCH_PAST_EOF   (1 << 9)  /* Search past end-of-file, into next file */
343 #define SRCH_FIRST_FILE (1 << 10) /* Search starting at the first file */
344 #define SRCH_NO_REGEX   (1 << 12) /* Don't use regular expressions */
345 #define SRCH_FILTER     (1 << 13) /* Search is for '&' (filter) command */
346 #define SRCH_AFTER_TARGET (1 << 14) /* Start search after the target line */
347 
348 #define	SRCH_REVERSE(t)	(((t) & SRCH_FORW) ? \
349 				(((t) & ~SRCH_FORW) | SRCH_BACK) : \
350 				(((t) & ~SRCH_BACK) | SRCH_FORW))
351 
352 /* */
353 #define	NO_MCA		0
354 #define	MCA_DONE	1
355 #define	MCA_MORE	2
356 
357 #define	CC_OK		0	/* Char was accepted & processed */
358 #define	CC_QUIT		1	/* Char was a request to abort current cmd */
359 #define	CC_ERROR	2	/* Char could not be accepted due to error */
360 #define	CC_PASS		3	/* Char was rejected (internal) */
361 
362 #define CF_QUIT_ON_ERASE 0001   /* Abort cmd if its entirely erased */
363 
364 /* Special char bit-flags used to tell put_line() to do something special */
365 #define	AT_NORMAL	(0)
366 #define	AT_UNDERLINE	(1 << 0)
367 #define	AT_BOLD		(1 << 1)
368 #define	AT_BLINK	(1 << 2)
369 #define	AT_STANDOUT	(1 << 3)
370 #define	AT_ANSI		(1 << 4)  /* Content-supplied "ANSI" escape sequence */
371 #define	AT_BINARY	(1 << 5)  /* LESS*BINFMT representation */
372 #define	AT_HILITE	(1 << 6)  /* Internal highlights (e.g., for search) */
373 
374 #if '0' == 240
375 #define IS_EBCDIC_HOST 1
376 #endif
377 
378 #if IS_EBCDIC_HOST
379 /*
380  * Long definition for EBCDIC.
381  * Since the argument is usually a constant, this macro normally compiles
382  * into a constant.
383  */
384 #define CONTROL(c) ( \
385 	(c)=='[' ? '\047' : \
386 	(c)=='a' ? '\001' : \
387 	(c)=='b' ? '\002' : \
388 	(c)=='c' ? '\003' : \
389 	(c)=='d' ? '\067' : \
390 	(c)=='e' ? '\055' : \
391 	(c)=='f' ? '\056' : \
392 	(c)=='g' ? '\057' : \
393 	(c)=='h' ? '\026' : \
394 	(c)=='i' ? '\005' : \
395 	(c)=='j' ? '\025' : \
396 	(c)=='k' ? '\013' : \
397 	(c)=='l' ? '\014' : \
398 	(c)=='m' ? '\015' : \
399 	(c)=='n' ? '\016' : \
400 	(c)=='o' ? '\017' : \
401 	(c)=='p' ? '\020' : \
402 	(c)=='q' ? '\021' : \
403 	(c)=='r' ? '\022' : \
404 	(c)=='s' ? '\023' : \
405 	(c)=='t' ? '\074' : \
406 	(c)=='u' ? '\075' : \
407 	(c)=='v' ? '\062' : \
408 	(c)=='w' ? '\046' : \
409 	(c)=='x' ? '\030' : \
410 	(c)=='y' ? '\031' : \
411 	(c)=='z' ? '\077' : \
412 	(c)=='A' ? '\001' : \
413 	(c)=='B' ? '\002' : \
414 	(c)=='C' ? '\003' : \
415 	(c)=='D' ? '\067' : \
416 	(c)=='E' ? '\055' : \
417 	(c)=='F' ? '\056' : \
418 	(c)=='G' ? '\057' : \
419 	(c)=='H' ? '\026' : \
420 	(c)=='I' ? '\005' : \
421 	(c)=='J' ? '\025' : \
422 	(c)=='K' ? '\013' : \
423 	(c)=='L' ? '\014' : \
424 	(c)=='M' ? '\015' : \
425 	(c)=='N' ? '\016' : \
426 	(c)=='O' ? '\017' : \
427 	(c)=='P' ? '\020' : \
428 	(c)=='Q' ? '\021' : \
429 	(c)=='R' ? '\022' : \
430 	(c)=='S' ? '\023' : \
431 	(c)=='T' ? '\074' : \
432 	(c)=='U' ? '\075' : \
433 	(c)=='V' ? '\062' : \
434 	(c)=='W' ? '\046' : \
435 	(c)=='X' ? '\030' : \
436 	(c)=='Y' ? '\031' : \
437 	(c)=='Z' ? '\077' : \
438 	(c)=='|' ? '\031' : \
439 	(c)=='\\' ? '\034' : \
440 	(c)=='^' ? '\036' : \
441 	(c)&077)
442 #else
443 #define	CONTROL(c)	((c)&037)
444 #endif /* IS_EBCDIC_HOST */
445 
446 #define	ESC		CONTROL('[')
447 #define	CSI		((unsigned char)'\233')
448 
449 #if _OSK_MWC32
450 #define	LSIGNAL(sig,func)	os9_signal(sig,func)
451 #else
452 #define	LSIGNAL(sig,func)	signal(sig,func)
453 #endif
454 
455 #if HAVE_SIGPROCMASK
456 #if HAVE_SIGSET_T
457 #else
458 #undef HAVE_SIGPROCMASK
459 #endif
460 #endif
461 #if HAVE_SIGPROCMASK
462 #if HAVE_SIGEMPTYSET
463 #else
464 #undef  sigemptyset
465 #define sigemptyset(mp) *(mp) = 0
466 #endif
467 #endif
468 
469 #define	S_INTERRUPT	01
470 #define	S_STOP		02
471 #define S_WINCH		04
472 #define	ABORT_SIGS()	(sigs & (S_INTERRUPT|S_STOP))
473 
474 #define	QUIT_OK		0
475 #define	QUIT_ERROR	1
476 #define	QUIT_INTERRUPT	2
477 #define	QUIT_SAVED_STATUS (-1)
478 
479 #define FOLLOW_DESC     0
480 #define FOLLOW_NAME     1
481 
482 /* filestate flags */
483 #define	CH_CANSEEK	001
484 #define	CH_KEEPOPEN	002
485 #define	CH_POPENED	004
486 #define	CH_HELPFILE	010
487 #define	CH_NODATA  	020	/* Special case for zero length files */
488 
489 
490 #define	ch_zero()	((POSITION)0)
491 
492 #define	FAKE_HELPFILE	"@/\\less/\\help/\\file/\\@"
493 #define FAKE_EMPTYFILE	"@/\\less/\\empty/\\file/\\@"
494 
495 /* Flags for cvt_text */
496 #define	CVT_TO_LC	01	/* Convert upper-case to lower-case */
497 #define	CVT_BS		02	/* Do backspace processing */
498 #define	CVT_CRLF	04	/* Remove CR after LF */
499 #define	CVT_ANSI	010	/* Remove ANSI escape sequences */
500 
501 #include "funcs.h"
502 
503 /* Functions not included in funcs.h */
504 void postoa();
505 void linenumtoa();
506 void inttoa();
507