xref: /freebsd/contrib/less/option.h (revision b71805e991fb955005640bdec81618e37d3af47c)
1 /*
2  * Copyright (C) 1984-2024  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 
11 #define END_OPTION_STRING       ('$')
12 
13 /*
14  * Types of options.
15  */
16 #define BOOL            01      /* Boolean option: 0 or 1 */
17 #define TRIPLE          02      /* Triple-valued option: 0, 1 or 2 */
18 #define NUMBER          04      /* Numeric option */
19 #define STRING          010     /* String-valued option */
20 #define NOVAR           020     /* No associated variable */
21 #define REPAINT         040     /* Repaint screen after toggling option */
22 #define NO_TOGGLE       0100    /* Option cannot be toggled with "-" cmd */
23 #define HL_REPAINT      0200    /* Repaint hilites after toggling option */
24 #define NO_QUERY        0400    /* Option cannot be queried with "_" cmd */
25 #define INIT_HANDLER    01000   /* Call option handler function at startup */
26 #define UNSUPPORTED     02000   /* Option is unsupported via LESS_UNSUPPORT */
27 
28 #define OTYPE           (BOOL|TRIPLE|NUMBER|STRING|NOVAR)
29 
30 #define OLETTER_NONE    '\1'     /* Invalid option letter */
31 
32 /*
33  * Argument to a handling function tells what type of activity:
34  */
35 #define INIT    0       /* Initialization (from command line) */
36 #define QUERY   1       /* Query (from _ or - command) */
37 #define TOGGLE  2       /* Change value (from - command) */
38 
39 /* Flag to toggle_option to specify how to "toggle" */
40 #define OPT_NO_TOGGLE   0
41 #define OPT_TOGGLE      1
42 #define OPT_UNSET       2
43 #define OPT_SET         3
44 #define OPT_NO_PROMPT   0100
45 
46 /* Error code from findopt_name */
47 #define OPT_AMBIG       1
48 
49 struct optname
50 {
51         constant 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 {
59         char oletter;           /* The controlling letter (a-z) */
60         struct optname *onames; /* Long (GNU-style) option name */
61         int otype;              /* Type of the option */
62         int odefault;           /* Default value */
63         int *ovar;              /* Pointer to the associated variable */
64         void (*ofunc)(int, constant char*); /* Pointer to special handling function */
65         constant char *odesc[3]; /* Description of each value */
66 };
67 
68