opttbl.c revision 1.3.8.1
1/*	$NetBSD: opttbl.c,v 1.3.8.1 2014/08/19 23:46:50 tls Exp $	*/
2
3/*
4 * Copyright (C) 1984-2012  Mark Nudelman
5 *
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Less License, as specified in the README file.
8 *
9 * For more information, see the README file.
10 */
11
12
13/*
14 * The option table.
15 */
16
17#include "less.h"
18#include "option.h"
19
20/*
21 * Variables controlled by command line options.
22 */
23public int quiet;		/* Should we suppress the audible bell? */
24public int how_search;		/* Where should forward searches start? */
25public int top_scroll;		/* Repaint screen from top?
26				   (alternative is scroll from bottom) */
27public int pr_type;		/* Type of prompt (short, medium, long) */
28public int bs_mode;		/* How to process backspaces */
29public int know_dumb;		/* Don't complain about dumb terminals */
30public int quit_at_eof;		/* Quit after hitting end of file twice */
31public int quit_if_one_screen;	/* Quit if EOF on first screen */
32public int be_helpful;		/* more(1) style -d */
33public int squeeze;		/* Squeeze multiple blank lines into one */
34public int tabstop;		/* Tab settings */
35public int back_scroll;		/* Repaint screen on backwards movement */
36public int forw_scroll;		/* Repaint screen on forward movement */
37public int caseless;		/* Do "caseless" searches */
38public int linenums;		/* Use line numbers */
39public int autobuf;		/* Automatically allocate buffers as needed */
40public int bufspace;		/* Max buffer space per file (K) */
41public int ctldisp;		/* Send control chars to screen untranslated */
42public int force_open;		/* Open the file even if not regular file */
43public int swindow;		/* Size of scrolling window */
44public int jump_sline;		/* Screen line of "jump target" */
45public long jump_sline_fraction = -1;
46public long shift_count_fraction = -1;
47public int chopline;		/* Truncate displayed lines at screen width */
48public int no_init;		/* Disable sending ti/te termcap strings */
49public int no_keypad;		/* Disable sending ks/ke termcap strings */
50public int twiddle;             /* Show tildes after EOF */
51public int show_attn;		/* Hilite first unread line */
52public int shift_count;		/* Number of positions to shift horizontally */
53public int status_col;		/* Display a status column */
54public int use_lessopen;	/* Use the LESSOPEN filter */
55public int quit_on_intr;	/* Quit on interrupt */
56public int follow_mode;		/* F cmd Follows file desc or file name? */
57public int oldbot;		/* Old bottom of screen behavior {{REMOVE}} */
58public int opt_use_backslash;	/* Use backslash escaping in option parsing */
59#if HILITE_SEARCH
60public int hilite_search;	/* Highlight matched search patterns? */
61#endif
62
63public int less_is_more = 0;	/* Make compatible with POSIX more */
64
65/*
66 * Long option names.
67 */
68static struct optname a_optname      = { "search-skip-screen",   NULL };
69static struct optname b_optname      = { "buffers",              NULL };
70static struct optname B__optname     = { "auto-buffers",         NULL };
71static struct optname c_optname      = { "clear-screen",         NULL };
72static struct optname d_optname      = { "dumb",                 NULL };
73#if MSDOS_COMPILER
74static struct optname D__optname     = { "color",                NULL };
75#endif
76static struct optname e_optname      = { "quit-at-eof",          NULL };
77static struct optname f_optname      = { "force",                NULL };
78static struct optname F__optname     = { "quit-if-one-screen",   NULL };
79#if HILITE_SEARCH
80static struct optname g_optname      = { "hilite-search",        NULL };
81#endif
82static struct optname h_optname      = { "max-back-scroll",      NULL };
83static struct optname i_optname      = { "ignore-case",          NULL };
84static struct optname j_optname      = { "jump-target",          NULL };
85static struct optname J__optname     = { "status-column",        NULL };
86#if USERFILE
87static struct optname k_optname      = { "lesskey-file",         NULL };
88#endif
89static struct optname K__optname     = { "quit-on-intr",         NULL };
90static struct optname L__optname     = { "no-lessopen",          NULL };
91static struct optname m_optname      = { "long-prompt",          NULL };
92static struct optname n_optname      = { "line-numbers",         NULL };
93#if LOGFILE
94static struct optname o_optname      = { "log-file",             NULL };
95static struct optname O__optname     = { "LOG-FILE",             NULL };
96#endif
97static struct optname p_optname      = { "pattern",              NULL };
98static struct optname P__optname     = { "prompt",               NULL };
99static struct optname q2_optname     = { "silent",               NULL };
100static struct optname q_optname      = { "quiet",                &q2_optname };
101static struct optname r_optname      = { "raw-control-chars",    NULL };
102static struct optname s_optname      = { "squeeze-blank-lines",  NULL };
103static struct optname S__optname     = { "chop-long-lines",      NULL };
104#if TAGS
105static struct optname t_optname      = { "tag",                  NULL };
106static struct optname T__optname     = { "tag-file",             NULL };
107#endif
108static struct optname u_optname      = { "underline-special",    NULL };
109static struct optname V__optname     = { "version",              NULL };
110static struct optname w_optname      = { "hilite-unread",        NULL };
111static struct optname x_optname      = { "tabs",                 NULL };
112static struct optname X__optname     = { "no-init",              NULL };
113static struct optname y_optname      = { "max-forw-scroll",      NULL };
114static struct optname z_optname      = { "window",               NULL };
115static struct optname quote_optname  = { "quotes",               NULL };
116static struct optname tilde_optname  = { "tilde",                NULL };
117static struct optname query_optname  = { "help",                 NULL };
118static struct optname pound_optname  = { "shift",                NULL };
119static struct optname keypad_optname = { "no-keypad",            NULL };
120static struct optname oldbot_optname = { "old-bot",              NULL };
121static struct optname follow_optname = { "follow-name",          NULL };
122static struct optname use_backslash_optname = { "use-backslash", NULL };
123
124
125/*
126 * Table of all options and their semantics.
127 *
128 * For BOOL and TRIPLE options, odesc[0], odesc[1], odesc[2] are
129 * the description of the option when set to 0, 1 or 2, respectively.
130 * For NUMBER options, odesc[0] is the prompt to use when entering
131 * a new value, and odesc[1] is the description, which should contain
132 * one %d which is replaced by the value of the number.
133 * For STRING options, odesc[0] is the prompt to use when entering
134 * a new value, and odesc[1], if not NULL, is the set of characters
135 * that are valid in the string.
136 */
137static struct loption option[] =
138{
139	{ 'a', &a_optname,
140		TRIPLE, OPT_ONPLUS, &how_search, NULL,
141		{
142			"Search includes displayed screen",
143			"Search skips displayed screen",
144			"Search includes all of displayed screen"
145		}
146	},
147
148	{ 'b', &b_optname,
149		NUMBER|INIT_HANDLER, 64, &bufspace, opt_b,
150		{
151			"Max buffer space per file (K): ",
152			"Max buffer space per file: %dK",
153			NULL
154		}
155	},
156	{ 'B', &B__optname,
157		BOOL, OPT_ON, &autobuf, NULL,
158		{
159			"Don't automatically allocate buffers",
160			"Automatically allocate buffers when needed",
161			NULL
162		}
163	},
164	{ 'c', &c_optname,
165		TRIPLE, OPT_OFF, &top_scroll, NULL,
166		{
167			"Repaint by scrolling from bottom of screen",
168			"Repaint by painting from top of screen",
169			"Repaint by painting from top of screen"
170		}
171	},
172#if 1
173	{ 'd', &d_optname,
174		BOOL, OPT_OFF, &be_helpful, NULL,
175		{ "Be less helpful in prompts",
176		"Be helpful in prompts",
177		NULL }
178	},
179#endif
180	{ -1, &d_optname,
181		BOOL|NO_TOGGLE, OPT_OFF, &know_dumb, NULL,
182		{
183			"Assume intelligent terminal",
184			"Assume dumb terminal",
185			NULL
186		}
187	},
188#if MSDOS_COMPILER
189	{ 'D', &D__optname,
190		STRING|REPAINT|NO_QUERY, 0, NULL, opt_D,
191		{
192			"color desc: ",
193			"Ddknsu0123456789.",
194			NULL
195		}
196	},
197#endif
198	{ 'e', &e_optname,
199		TRIPLE, OPT_OFF, &quit_at_eof, NULL,
200		{
201			"Don't quit at end-of-file",
202			"Quit at end-of-file",
203			"Quit immediately at end-of-file"
204		}
205	},
206	{ 'f', &f_optname,
207		BOOL, OPT_OFF, &force_open, NULL,
208		{
209			"Open only regular files",
210			"Open even non-regular files",
211			NULL
212		}
213	},
214	{ 'F', &F__optname,
215		BOOL, OPT_OFF, &quit_if_one_screen, NULL,
216		{
217			"Don't quit if end-of-file on first screen",
218			"Quit if end-of-file on first screen",
219			NULL
220		}
221	},
222#if HILITE_SEARCH
223	{ 'g', &g_optname,
224		TRIPLE|HL_REPAINT, OPT_ONPLUS, &hilite_search, NULL,
225		{
226			"Don't highlight search matches",
227			"Highlight matches for previous search only",
228			"Highlight all matches for previous search pattern",
229		}
230	},
231#endif
232	{ 'h', &h_optname,
233		NUMBER, -1, &back_scroll, NULL,
234		{
235			"Backwards scroll limit: ",
236			"Backwards scroll limit is %d lines",
237			NULL
238		}
239	},
240	{ 'i', &i_optname,
241		TRIPLE|HL_REPAINT, OPT_OFF, &caseless, opt_i,
242		{
243			"Case is significant in searches",
244			"Ignore case in searches",
245			"Ignore case in searches and in patterns"
246		}
247	},
248	{ 'j', &j_optname,
249		STRING, 0, NULL, opt_j,
250		{
251			"Target line: ",
252			"0123456789.-",
253			NULL
254		}
255	},
256	{ 'J', &J__optname,
257		BOOL|REPAINT, OPT_OFF, &status_col, NULL,
258		{
259			"Don't display a status column",
260			"Display a status column",
261			NULL
262		}
263	},
264#if USERFILE
265	{ 'k', &k_optname,
266		STRING|NO_TOGGLE|NO_QUERY, 0, NULL, opt_k,
267		{ NULL, NULL, NULL }
268	},
269#endif
270	{ 'K', &K__optname,
271		BOOL, OPT_OFF, &quit_on_intr, NULL,
272		{
273			"Interrupt (ctrl-C) returns to prompt",
274			"Interrupt (ctrl-C) exits less",
275			NULL
276		}
277	},
278	{ 'L', &L__optname,
279		BOOL, OPT_ON, &use_lessopen, NULL,
280		{
281			"Don't use the LESSOPEN filter",
282			"Use the LESSOPEN filter",
283			NULL
284		}
285	},
286	{ 'm', &m_optname,
287		TRIPLE, OPT_OFF, &pr_type, NULL,
288		{
289			"Short prompt",
290			"Medium prompt",
291			"Long prompt"
292		}
293	},
294	{ 'n', &n_optname,
295		TRIPLE|REPAINT, OPT_ON, &linenums, NULL,
296		{
297			"Don't use line numbers",
298			"Use line numbers",
299			"Constantly display line numbers"
300		}
301	},
302#if LOGFILE
303	{ 'o', &o_optname,
304		STRING, 0, NULL, opt_o,
305		{ "log file: ", NULL, NULL }
306	},
307	{ 'O', &O__optname,
308		STRING, 0, NULL, opt__O,
309		{ "Log file: ", NULL, NULL }
310	},
311#endif
312	{ 'p', &p_optname,
313		STRING|NO_TOGGLE|NO_QUERY, 0, NULL, opt_p,
314		{ NULL, NULL, NULL }
315	},
316	{ 'P', &P__optname,
317		STRING, 0, NULL, opt__P,
318		{ "prompt: ", NULL, NULL }
319	},
320	{ 'q', &q_optname,
321		TRIPLE, OPT_OFF, &quiet, NULL,
322		{
323			"Ring the bell for errors AND at eof/bof",
324			"Ring the bell for errors but not at eof/bof",
325			"Never ring the bell"
326		}
327	},
328	{ 'r', &r_optname,
329		TRIPLE|REPAINT, OPT_OFF, &ctldisp, NULL,
330		{
331			"Display control characters as ^X",
332			"Display control characters directly",
333			"Display control characters directly, processing ANSI sequences"
334		}
335	},
336	{ 's', &s_optname,
337		BOOL|REPAINT, OPT_OFF, &squeeze, NULL,
338		{
339			"Display all blank lines",
340			"Squeeze multiple blank lines",
341			NULL
342		}
343	},
344	{ 'S', &S__optname,
345		BOOL|REPAINT, OPT_OFF, &chopline, NULL,
346		{
347			"Fold long lines",
348			"Chop long lines",
349			NULL
350		}
351	},
352#if TAGS
353	{ 't', &t_optname,
354		STRING|NO_QUERY, 0, NULL, opt_t,
355		{ "tag: ", NULL, NULL }
356	},
357	{ 'T', &T__optname,
358		STRING, 0, NULL, opt__T,
359		{ "tags file: ", NULL, NULL }
360	},
361#endif
362	{ 'u', &u_optname,
363		TRIPLE|REPAINT, OPT_OFF, &bs_mode, NULL,
364		{
365			"Display underlined text in underline mode",
366			"Backspaces cause overstrike",
367			"Print backspace as ^H"
368		}
369	},
370	{ 'V', &V__optname,
371		NOVAR, 0, NULL, opt__V,
372		{ NULL, NULL, NULL }
373	},
374	{ 'w', &w_optname,
375		TRIPLE|REPAINT, OPT_OFF, &show_attn, NULL,
376		{
377			"Don't highlight first unread line",
378			"Highlight first unread line after forward-screen",
379			"Highlight first unread line after any forward movement",
380		}
381	},
382	{ 'x', &x_optname,
383		STRING|REPAINT, 0, NULL, opt_x,
384		{
385			"Tab stops: ",
386			"0123456789,",
387			NULL
388		}
389	},
390	{ 'X', &X__optname,
391		BOOL|NO_TOGGLE, OPT_OFF, &no_init, NULL,
392		{
393			"Send init/deinit strings to terminal",
394			"Don't use init/deinit strings",
395			NULL
396		}
397	},
398	{ 'y', &y_optname,
399		NUMBER, -1, &forw_scroll, NULL,
400		{
401			"Forward scroll limit: ",
402			"Forward scroll limit is %d lines",
403			NULL
404		}
405	},
406	{ 'z', &z_optname,
407		NUMBER, -1, &swindow, NULL,
408		{
409			"Scroll window size: ",
410			"Scroll window size is %d lines",
411			NULL
412		}
413	},
414	{ '"', &quote_optname,
415		STRING, 0, NULL, opt_quote,
416		{ "quotes: ", NULL, NULL }
417	},
418	{ '~', &tilde_optname,
419		BOOL|REPAINT, OPT_ON, &twiddle, NULL,
420		{
421			"Don't show tildes after end of file",
422			"Show tildes after end of file",
423			NULL
424		}
425	},
426	{ '?', &query_optname,
427		NOVAR, 0, NULL, opt_query,
428		{ NULL, NULL, NULL }
429	},
430	{ '#', &pound_optname,
431		STRING, 0, NULL, opt_shift,
432		{
433			"Horizontal shift: ",
434			"0123456789.",
435			NULL
436		}
437	},
438	{ OLETTER_NONE, &keypad_optname,
439		BOOL|NO_TOGGLE, OPT_OFF, &no_keypad, NULL,
440		{
441			"Use keypad mode",
442			"Don't use keypad mode",
443			NULL
444		}
445	},
446	{ OLETTER_NONE, &oldbot_optname,
447		BOOL, OPT_OFF, &oldbot, NULL,
448		{
449			"Use new bottom of screen behavior",
450			"Use old bottom of screen behavior",
451			NULL
452		}
453	},
454	{ OLETTER_NONE, &follow_optname,
455		BOOL, FOLLOW_DESC, &follow_mode, NULL,
456		{
457			"F command follows file descriptor",
458			"F command follows file name",
459			NULL
460		}
461	},
462	{ OLETTER_NONE, &use_backslash_optname,
463		BOOL, OPT_OFF, &opt_use_backslash, NULL,
464		{
465			"Use backslash escaping in command line parameters",
466			"Don't use backslash escaping in command line parameters",
467			NULL
468		}
469	},
470	{ '\0', NULL, NOVAR, 0, NULL, NULL, { NULL, NULL, NULL } }
471};
472
473
474/*
475 * Initialize each option to its default value.
476 */
477	public void
478init_option()
479{
480	register struct loption *o;
481	char *p;
482
483	p = lgetenv("LESS_IS_MORE");
484	if (p != NULL && *p != '\0')
485		less_is_more = 1;
486
487	for (o = option;  o->oletter != '\0';  o++)
488	{
489		/*
490		 * Set each variable to its default.
491		 */
492		if (o->ovar != NULL)
493			*(o->ovar) = o->odefault;
494		if (o->otype & INIT_HANDLER)
495			(*(o->ofunc))(INIT, (char *) NULL);
496	}
497}
498
499/*
500 * Find an option in the option table, given its option letter.
501 */
502	public struct loption *
503findopt(c)
504	int c;
505{
506	register struct loption *o;
507
508	for (o = option;  o->oletter != '\0';  o++)
509	{
510		if (o->oletter == c)
511			return (o);
512		if ((o->otype & TRIPLE) && ASCII_TO_UPPER(o->oletter) == c)
513			return (o);
514	}
515	return (NULL);
516}
517
518/*
519 *
520 */
521	static int
522is_optchar(c)
523	char c;
524{
525	if (ASCII_IS_UPPER(c))
526		return 1;
527	if (ASCII_IS_LOWER(c))
528		return 1;
529	if (c == '-')
530		return 1;
531	return 0;
532}
533
534/*
535 * Find an option in the option table, given its option name.
536 * p_optname is the (possibly partial) name to look for, and
537 * is updated to point after the matched name.
538 * p_oname if non-NULL is set to point to the full option name.
539 */
540	public struct loption *
541findopt_name(p_optname, p_oname, p_err)
542	char **p_optname;
543	char **p_oname;
544	int *p_err;
545{
546	char *optname = *p_optname;
547	register struct loption *o;
548	register struct optname *oname;
549	register int len;
550	int uppercase;
551	struct loption *maxo = NULL;
552	struct optname *maxoname = NULL;
553	int maxlen = 0;
554	int ambig = 0;
555	int exact = 0;
556
557	/*
558	 * Check all options.
559	 */
560	for (o = option;  o->oletter != '\0';  o++)
561	{
562		/*
563		 * Check all names for this option.
564		 */
565		for (oname = o->onames;  oname != NULL;  oname = oname->onext)
566		{
567			/*
568			 * Try normal match first (uppercase == 0),
569			 * then, then if it's a TRIPLE option,
570			 * try uppercase match (uppercase == 1).
571			 */
572			for (uppercase = 0;  uppercase <= 1;  uppercase++)
573			{
574				len = sprefix(optname, oname->oname, uppercase);
575				if (len <= 0 || is_optchar(optname[len]))
576				{
577					/*
578					 * We didn't use all of the option name.
579					 */
580					continue;
581				}
582				if (!exact && len == maxlen)
583					/*
584					 * Already had a partial match,
585					 * and now there's another one that
586					 * matches the same length.
587					 */
588					ambig = 1;
589				else if (len > maxlen)
590				{
591					/*
592					 * Found a better match than
593					 * the one we had.
594					 */
595					maxo = o;
596					maxoname = oname;
597					maxlen = len;
598					ambig = 0;
599					exact = (len == (int)strlen(oname->oname));
600				}
601				if (!(o->otype & TRIPLE))
602					break;
603			}
604		}
605	}
606	if (ambig)
607	{
608		/*
609		 * Name matched more than one option.
610		 */
611		if (p_err != NULL)
612			*p_err = OPT_AMBIG;
613		return (NULL);
614	}
615	*p_optname = optname + maxlen;
616	if (p_oname != NULL)
617		*p_oname = maxoname == NULL ? NULL : maxoname->oname;
618	return (maxo);
619}
620