xref: /openbsd/usr.bin/less/option.h (revision 021cd5d5)
1 /*
2  * Copyright (C) 1984-2012  Mark Nudelman
3  * Modified for use with illumos by Garrett D'Amore.
4  * Copyright 2014 Garrett D'Amore <garrett@damore.org>
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 #define	END_OPTION_STRING	('$')
13 
14 /*
15  * Types of options.
16  */
17 #define	BOOL		01	/* Boolean option: 0 or 1 */
18 #define	TRIPLE		02	/* Triple-valued option: 0, 1 or 2 */
19 #define	NUMBER		04	/* Numeric option */
20 #define	STRING		010	/* String-valued option */
21 #define	NOVAR		020	/* No associated variable */
22 #define	REPAINT		040	/* Repaint screen after toggling option */
23 #define	NO_TOGGLE	0100	/* Option cannot be toggled with "-" cmd */
24 #define	HL_REPAINT	0200	/* Repaint hilites after toggling option */
25 #define	NO_QUERY	0400	/* Option cannot be queried with "_" cmd */
26 #define	INIT_HANDLER	01000	/* Call option handler function at startup */
27 #define	MORE_OK		02000	/* Allow when less_is_more */
28 
29 #define	OTYPE		(BOOL|TRIPLE|NUMBER|STRING|NOVAR)
30 
31 #define	OLETTER_NONE	'\1'	/* Invalid option letter */
32 
33 /*
34  * Argument to a handling function tells what type of activity:
35  */
36 #define	INIT	0	/* Initialization (from command line) */
37 #define	QUERY	1	/* Query (from _ or - command) */
38 #define	TOGGLE	2	/* Change value (from - command) */
39 
40 /* Flag to toggle_option to specify how to "toggle" */
41 #define	OPT_NO_TOGGLE	0
42 #define	OPT_TOGGLE	1
43 #define	OPT_UNSET	2
44 #define	OPT_SET		3
45 #define	OPT_NO_PROMPT	0100
46 
47 /* Error code from findopt_name */
48 #define	OPT_AMBIG	1
49 
50 struct optname {
51 	char *oname;		/* Long (GNU-style) option name */
52 	struct optname *onext;	/* List of synonymous option names */
53 };
54 
55 #define	OPTNAME_MAX	32	/* Max length of long option name */
56 
57 struct loption {
58 	char oletter;		/* The controlling letter (a-z) */
59 	struct optname *onames; /* Long (GNU-style) option name */
60 	int otype;		/* Type of the option */
61 	int odefault;		/* Default value */
62 	int *ovar;		/* Pointer to the associated variable */
63 	void (*ofunc)(int, char *); /* Pointer to special handling function */
64 	char *odesc[3];		/* Description of each value */
65 };
66