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>
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.
9 * For more information, see the README file.
13 * Routines to decode user commands.
15 * This is all table driven.
16 * A command table is a sequence of command descriptors.
17 * Each command descriptor is a sequence of bytes with the following format:
18 * <c1><c2>...<cN><0><action>
19 * The characters c1,c2,...,cN are the command string; that is,
20 * the characters which the user must type.
21 * It is terminated by a null <0> byte.
22 * The byte after the null byte is the action code associated
23 * with the command string.
24 * If an action byte is OR-ed with A_EXTRA, this indicates
25 * that the option byte is followed by an extra string.
27 * There may be many command tables.
28 * The first (default) table is built-in.
29 * Other tables are read in from "lesskey" files.
30 * All the tables are linked together and are searched in order.
37 extern int erase_char
, erase2_char
, kill_char
;
38 extern int secure
, less_is_more
;
41 SK_SPECIAL_KEY, (k), 6, 1, 1, 1
43 * Command table is ordered roughly according to expected
44 * frequency of use, so the common commands are near the beginning.
47 static unsigned char cmdtable
[] =
53 SK(SK_DOWN_ARROW
), 0, A_F_LINE
,
54 CONTROL('E'), 0, A_F_LINE
,
55 CONTROL('N'), 0, A_F_LINE
,
58 CONTROL('Y'), 0, A_B_LINE
,
59 SK(SK_CONTROL_K
), 0, A_B_LINE
,
60 CONTROL('P'), 0, A_B_LINE
,
61 SK(SK_UP_ARROW
), 0, A_B_LINE
,
66 CONTROL('D'), 0, A_F_SCROLL
,
68 CONTROL('U'), 0, A_B_SCROLL
,
71 CONTROL('F'), 0, A_F_SCREEN
,
72 CONTROL('V'), 0, A_F_SCREEN
,
73 SK(SK_PAGE_DOWN
), 0, A_F_SCREEN
,
75 CONTROL('B'), 0, A_B_SCREEN
,
76 ESC
, 'v', 0, A_B_SCREEN
,
77 SK(SK_PAGE_UP
), 0, A_B_SCREEN
,
80 ESC
, ' ', 0, A_FF_SCREEN
,
82 ESC
, 'F', 0, A_F_UNTIL_HILITE
,
85 CONTROL('R'), 0, A_REPAINT
,
86 CONTROL('L'), 0, A_REPAINT
,
87 ESC
, 'u', 0, A_UNDO_SEARCH
,
89 SK(SK_HOME
), 0, A_GOLINE
,
91 ESC
, '<', 0, A_GOLINE
,
94 ESC
, '[', 0, A_LSHIFT
,
95 ESC
, ']', 0, A_RSHIFT
,
96 ESC
, '(', 0, A_LSHIFT
,
97 ESC
, ')', 0, A_RSHIFT
,
98 SK(SK_RIGHT_ARROW
), 0, A_RSHIFT
,
99 SK(SK_LEFT_ARROW
), 0, A_LSHIFT
,
100 '{', 0, A_F_BRACKET
|A_EXTRA
, '{', '}', 0,
101 '}', 0, A_B_BRACKET
|A_EXTRA
, '{', '}', 0,
102 '(', 0, A_F_BRACKET
|A_EXTRA
, '(', ')', 0,
103 ')', 0, A_B_BRACKET
|A_EXTRA
, '(', ')', 0,
104 '[', 0, A_F_BRACKET
|A_EXTRA
, '[', ']', 0,
105 ']', 0, A_B_BRACKET
|A_EXTRA
, '[', ']', 0,
106 ESC
, CONTROL('F'), 0, A_F_BRACKET
,
107 ESC
, CONTROL('B'), 0, A_B_BRACKET
,
109 ESC
, '>', 0, A_GOEND
,
111 SK(SK_END
), 0, A_GOEND
,
127 CONTROL('G'), 0, A_STAT
,
131 ESC
, '/', 0, A_F_SEARCH
|A_EXTRA
, '*', 0,
132 ESC
, '?', 0, A_B_SEARCH
|A_EXTRA
, '*', 0,
133 'n', 0, A_AGAIN_SEARCH
,
134 ESC
, 'n', 0, A_T_AGAIN_SEARCH
,
135 'N', 0, A_REVERSE_SEARCH
,
136 ESC
, 'N', 0, A_T_REVERSE_SEARCH
,
140 CONTROL('X'), CONTROL('X'), 0, A_GOMARK
,
142 ':', 'e', 0, A_EXAMINE
,
143 CONTROL('X'), CONTROL('V'), 0, A_EXAMINE
,
144 ':', 'n', 0, A_NEXT_FILE
,
145 ':', 'p', 0, A_PREV_FILE
,
148 ':', 'x', 0, A_INDEX_FILE
,
149 ':', 'd', 0, A_REMOVE_FILE
,
150 ':', 't', 0, A_OPT_TOGGLE
|A_EXTRA
, 't', 0,
157 SK(SK_F1
), 0, A_HELP
,
166 static unsigned char lesstable
[] = {
167 '-', 0, A_OPT_TOGGLE
,
168 's', 0, A_OPT_TOGGLE
|A_EXTRA
, 'o', 0,
169 '_', 0, A_DISP_OPTION
172 static unsigned char moretable
[] = {
176 static unsigned char edittable
[] =
178 '\t', 0, EC_F_COMPLETE
, /* TAB */
179 '\17', 0, EC_B_COMPLETE
, /* BACKTAB */
180 SK(SK_BACKTAB
), 0, EC_B_COMPLETE
, /* BACKTAB */
181 ESC
, '\t', 0, EC_B_COMPLETE
, /* ESC TAB */
182 CONTROL('L'), 0, EC_EXPAND
, /* CTRL-L */
183 CONTROL('V'), 0, EC_LITERAL
, /* BACKSLASH */
184 CONTROL('A'), 0, EC_LITERAL
, /* BACKSLASH */
185 ESC
, 'l', 0, EC_RIGHT
, /* ESC l */
186 SK(SK_RIGHT_ARROW
), 0, EC_RIGHT
, /* RIGHTARROW */
187 ESC
, 'h', 0, EC_LEFT
, /* ESC h */
188 SK(SK_LEFT_ARROW
), 0, EC_LEFT
, /* LEFTARROW */
189 ESC
, 'b', 0, EC_W_LEFT
, /* ESC b */
190 ESC
, SK(SK_LEFT_ARROW
), 0, EC_W_LEFT
, /* ESC LEFTARROW */
191 SK(SK_CTL_LEFT_ARROW
), 0, EC_W_LEFT
, /* CTRL-LEFTARROW */
192 ESC
, 'w', 0, EC_W_RIGHT
, /* ESC w */
193 ESC
, SK(SK_RIGHT_ARROW
), 0, EC_W_RIGHT
, /* ESC RIGHTARROW */
194 SK(SK_CTL_RIGHT_ARROW
), 0, EC_W_RIGHT
, /* CTRL-RIGHTARROW */
195 ESC
, 'i', 0, EC_INSERT
, /* ESC i */
196 SK(SK_INSERT
), 0, EC_INSERT
, /* INSERT */
197 ESC
, 'x', 0, EC_DELETE
, /* ESC x */
198 SK(SK_DELETE
), 0, EC_DELETE
, /* DELETE */
199 ESC
, 'X', 0, EC_W_DELETE
, /* ESC X */
200 ESC
, SK(SK_DELETE
), 0, EC_W_DELETE
, /* ESC DELETE */
201 SK(SK_CTL_DELETE
), 0, EC_W_DELETE
, /* CTRL-DELETE */
202 SK(SK_CTL_BACKSPACE
), 0, EC_W_BACKSPACE
, /* CTRL-BACKSPACE */
203 ESC
, '\b', 0, EC_W_BACKSPACE
, /* ESC BACKSPACE */
204 ESC
, '0', 0, EC_HOME
, /* ESC 0 */
205 SK(SK_HOME
), 0, EC_HOME
, /* HOME */
206 ESC
, '$', 0, EC_END
, /* ESC $ */
207 SK(SK_END
), 0, EC_END
, /* END */
208 ESC
, 'k', 0, EC_UP
, /* ESC k */
209 SK(SK_UP_ARROW
), 0, EC_UP
, /* UPARROW */
210 ESC
, 'j', 0, EC_DOWN
, /* ESC j */
211 SK(SK_DOWN_ARROW
), 0, EC_DOWN
, /* DOWNARROW */
212 CONTROL('G'), 0, EC_ABORT
, /* CTRL-G */
216 * Structure to support a list of command tables.
219 struct tablelist
*t_next
;
225 * List of command tables and list of line-edit tables.
227 static struct tablelist
*list_fcmd_tables
= NULL
;
228 static struct tablelist
*list_ecmd_tables
= NULL
;
229 static struct tablelist
*list_var_tables
= NULL
;
230 static struct tablelist
*list_sysvar_tables
= NULL
;
234 * Expand special key abbreviations in a command table.
237 expand_special_keys(char *table
, int len
)
245 for (fm
= table
; fm
< table
+ len
; ) {
247 * Rewrite each command in the table with any
248 * special key abbreviations expanded.
250 for (to
= fm
; *fm
!= '\0'; ) {
251 if (*fm
!= SK_SPECIAL_KEY
) {
256 * After SK_SPECIAL_KEY, next byte is the type
257 * of special key (one of the SK_* contants),
258 * and the byte after that is the number of bytes,
259 * N, reserved by the abbreviation (including the
260 * SK_SPECIAL_KEY and key type bytes).
261 * Replace all N bytes with the actual bytes
262 * output by the special key on this terminal.
264 repl
= special_key_str(fm
[1]);
267 if (repl
== NULL
|| strlen(repl
) > klen
)
269 while (*repl
!= '\0')
274 * Fill any unused bytes between end of command and
275 * the action byte with A_SKIP.
282 while (*fm
++ != '\0')
289 * Initialize the command lists.
295 * Add the default command tables.
297 add_fcmd_table((char *)cmdtable
, sizeof (cmdtable
));
298 add_ecmd_table((char *)edittable
, sizeof (edittable
));
300 add_fcmd_table((char *)moretable
, sizeof (moretable
));
303 add_fcmd_table((char *)lesstable
, sizeof (lesstable
));
307 * Try to add the tables in the system lesskey file.
309 add_hometable("LESSKEY_SYSTEM", LESSKEYFILE_SYS
, 1);
311 * Try to add the tables in the standard lesskey file "$HOME/.less".
313 add_hometable("LESSKEY", LESSKEYFILE
, 0);
317 * Add a command table.
320 add_cmd_table(struct tablelist
**tlist
, char *buf
, int len
)
327 * Allocate a tablelist structure, initialize it,
328 * and link it into the list of tables.
330 if ((t
= calloc(1, sizeof (struct tablelist
))) == NULL
) {
333 expand_special_keys(buf
, len
);
335 t
->t_end
= buf
+ len
;
342 * Add a command table.
345 add_fcmd_table(char *buf
, int len
)
347 if (add_cmd_table(&list_fcmd_tables
, buf
, len
) < 0)
348 error("Warning: some commands disabled", NULL
);
352 * Add an editing command table.
355 add_ecmd_table(char *buf
, int len
)
357 if (add_cmd_table(&list_ecmd_tables
, buf
, len
) < 0)
358 error("Warning: some edit commands disabled", NULL
);
362 * Add an environment variable table.
365 add_var_table(struct tablelist
**tlist
, char *buf
, int len
)
367 if (add_cmd_table(tlist
, buf
, len
) < 0)
368 error("Warning: environment variables from "
369 "lesskey file unavailable", NULL
);
373 * Search a single command table for the command string in cmd.
376 cmd_search(const char *cmd
, char *table
, char *endtable
, char **sp
)
383 for (p
= table
, q
= cmd
; p
< endtable
; p
++, q
++) {
386 * Current characters match.
387 * If we're at the end of the string, we've found it.
388 * Return the action code, which is the character
389 * after the null at the end of the string
390 * in the command table.
396 if (a
== A_END_LIST
) {
398 * We get here only if the original
399 * cmd string passed in was empty ("").
400 * I don't think that can happen,
401 * but just in case ...
406 * Check for an "extra" string.
414 } else if (*q
== '\0') {
416 * Hit the end of the user's command,
417 * but not the end of the string in the command table.
418 * The user's command is incomplete.
424 * Skip ahead to the next command in the
425 * command table, and reset the pointer
426 * to the beginning of the user's command.
428 if (*p
== '\0' && p
[1] == A_END_LIST
) {
430 * A_END_LIST is a special marker that tells
431 * us to abort the cmd search.
446 * No match found in the entire command table.
452 * Decode a command character and return the associated action.
453 * The "extra" string, if any, is returned in sp.
456 cmd_decode(struct tablelist
*tlist
, const char *cmd
, char **sp
)
459 int action
= A_INVALID
;
462 * Search thru all the command tables.
463 * Stop when we find an action which is not A_INVALID.
465 for (t
= tlist
; t
!= NULL
; t
= t
->t_next
) {
466 action
= cmd_search(cmd
, t
->t_start
, t
->t_end
, sp
);
467 if (action
!= A_INVALID
)
470 if (action
== A_UINVALID
)
476 * Decode a command from the cmdtables list.
479 fcmd_decode(const char *cmd
, char **sp
)
481 return (cmd_decode(list_fcmd_tables
, cmd
, sp
));
485 * Decode a command from the edittables list.
488 ecmd_decode(const char *cmd
, char **sp
)
490 return (cmd_decode(list_ecmd_tables
, cmd
, sp
));
494 * Get the value of an environment variable.
495 * Looks first in the lesskey file, then in the real environment.
504 * Ignore lookups of any LESS* setting when we are more, and ignore
508 if (strncmp(var
, "LESS", 4) == 0) {
511 return (getenv(var
));
513 a
= cmd_decode(list_var_tables
, var
, &s
);
517 if (s
!= NULL
&& *s
!= '\0')
519 a
= cmd_decode(list_sysvar_tables
, var
, &s
);
526 * Get an "integer" from a lesskey file.
527 * Integers are stored in a funny format:
528 * two bytes, low order first, in radix KRADIX.
536 n
+= *(*sp
)++ * KRADIX
;
541 * Process an old (pre-v241) lesskey file.
544 old_lesskey(char *buf
, int len
)
547 * Old-style lesskey file.
548 * The file must end with either
550 * or ...,cmd,0,action|A_EXTRA,string,0
551 * So the last byte or the second to last byte must be zero.
553 if (buf
[len
-1] != '\0' && buf
[len
-2] != '\0')
555 add_fcmd_table(buf
, len
);
560 * Process a new (post-v241) lesskey file.
563 new_lesskey(char *buf
, int len
, int sysvar
)
570 * New-style lesskey file.
571 * Extract the pieces.
573 if (buf
[len
-3] != C0_END_LESSKEY_MAGIC
||
574 buf
[len
-2] != C1_END_LESSKEY_MAGIC
||
575 buf
[len
-1] != C2_END_LESSKEY_MAGIC
)
583 add_fcmd_table(p
, n
);
588 add_ecmd_table(p
, n
);
593 add_var_table((sysvar
) ?
594 &list_sysvar_tables
: &list_var_tables
, p
, n
);
601 * Unrecognized section type.
609 * Set up a user command table, based on a "lesskey" file.
612 lesskey(char *filename
, int sysvar
)
622 * Try to open the lesskey file.
624 filename
= shell_unquote(filename
);
625 f
= open(filename
, O_RDONLY
);
631 * Read the file into a buffer.
632 * We first figure out the size of the file and allocate space for it.
633 * {{ Minimal error checking is done here.
634 * A garbage .less file will produce strange results.
635 * To avoid a large amount of error checking code here, we
636 * rely on the lesskey program to generate a good .less file. }}
639 if (len
== -1 || len
< 3) {
641 * Bad file (valid file must have at least 3 chars).
646 if ((buf
= calloc((int)len
, sizeof (char))) == NULL
) {
650 if (lseek(f
, (off_t
)0, SEEK_SET
) == (off_t
)-1) {
655 n
= read(f
, buf
, (unsigned int) len
);
663 * Figure out if this is an old-style (before version 241)
664 * or new-style lesskey file format.
666 if (buf
[0] != C0_LESSKEY_MAGIC
|| buf
[1] != C1_LESSKEY_MAGIC
||
667 buf
[2] != C2_LESSKEY_MAGIC
|| buf
[3] != C3_LESSKEY_MAGIC
)
668 return (old_lesskey(buf
, (int)len
));
669 return (new_lesskey(buf
, (int)len
, sysvar
));
673 * Add the standard lesskey file "$HOME/.less"
676 add_hometable(char *envname
, char *def_filename
, int sysvar
)
681 if (envname
!= NULL
&& (filename
= lgetenv(envname
)) != NULL
)
682 filename
= estrdup(filename
);
684 filename
= estrdup(def_filename
);
686 filename
= homefile(def_filename
);
687 if (filename
== NULL
)
689 if (lesskey(filename
, sysvar
) < 0) {
690 parg
.p_string
= filename
;
691 error("Cannot use lesskey file \"%s\"", &parg
);
697 * See if a char is a special line-editing command.
700 editchar(int c
, int flags
)
705 char usercmd
[MAX_CMDLEN
+1];
708 * An editing character could actually be a sequence of characters;
709 * for example, an escape sequence sent by pressing the uparrow key.
710 * To match the editing string, we use the command decoder
711 * but give it the edit-commands command table
712 * This table is constructed to match the user's keyboard.
714 if (c
== erase_char
|| c
== erase2_char
)
715 return (EC_BACKSPACE
);
717 return (EC_LINEKILL
);
720 * Collect characters in a buffer.
721 * Start with the one we have, and get more if we need them.
727 usercmd
[nch
] = (char)c
;
728 usercmd
[nch
+1] = '\0';
730 action
= ecmd_decode(usercmd
, &s
);
731 } while (action
== A_PREFIX
);
733 if (flags
& EC_NORIGHTLEFT
) {
741 if (flags
& EC_NOHISTORY
) {
743 * The caller says there is no history list.
744 * Reject any history-manipulation action.
753 if (flags
& EC_NOCOMPLETE
) {
755 * The caller says we don't want any filename completion cmds.
766 if ((flags
& EC_PEEK
) || action
== A_INVALID
) {
768 * We're just peeking, or we didn't understand the command.
769 * Unget all the characters we read in the loop above.
770 * This does NOT include the original character that was
771 * passed in as a parameter.
774 ungetcc(usercmd
[--nch
]);