2 * Copyright (C) 1984-2009 Mark Nudelman
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.
7 * For more information about less, or for information on how to
8 * contact the author, 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
;
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
,
84 CONTROL('R'),0, A_REPAINT
,
85 CONTROL('L'),0, A_REPAINT
,
86 ESC
,'u',0, A_UNDO_SEARCH
,
88 SK(SK_HOME
),0, A_GOLINE
,
97 SK(SK_RIGHT_ARROW
),0, A_RSHIFT
,
98 SK(SK_LEFT_ARROW
),0, A_LSHIFT
,
99 '{',0, A_F_BRACKET
|A_EXTRA
, '{','}',0,
100 '}',0, A_B_BRACKET
|A_EXTRA
, '{','}',0,
101 '(',0, A_F_BRACKET
|A_EXTRA
, '(',')',0,
102 ')',0, A_B_BRACKET
|A_EXTRA
, '(',')',0,
103 '[',0, A_F_BRACKET
|A_EXTRA
, '[',']',0,
104 ']',0, A_B_BRACKET
|A_EXTRA
, '[',']',0,
105 ESC
,CONTROL('F'),0, A_F_BRACKET
,
106 ESC
,CONTROL('B'),0, A_B_BRACKET
,
110 SK(SK_END
),0, A_GOEND
,
126 CONTROL('G'),0, A_STAT
,
130 ESC
,'/',0, A_F_SEARCH
|A_EXTRA
, '*',0,
131 ESC
,'?',0, A_B_SEARCH
|A_EXTRA
, '*',0,
132 'n',0, A_AGAIN_SEARCH
,
133 ESC
,'n',0, A_T_AGAIN_SEARCH
,
134 'N',0, A_REVERSE_SEARCH
,
135 ESC
,'N',0, A_T_REVERSE_SEARCH
,
139 CONTROL('X'),CONTROL('X'),0, A_GOMARK
,
141 ':','e',0, A_EXAMINE
,
142 CONTROL('X'),CONTROL('V'),0, A_EXAMINE
,
143 ':','n',0, A_NEXT_FILE
,
144 ':','p',0, A_PREV_FILE
,
147 ':','x',0, A_INDEX_FILE
,
148 ':','d',0, A_REMOVE_FILE
,
150 ':','t',0, A_OPT_TOGGLE
|A_EXTRA
, 't',0,
151 's',0, A_OPT_TOGGLE
|A_EXTRA
, 'o',0,
152 '_',0, A_DISP_OPTION
,
169 static unsigned char edittable
[] =
171 '\t',0, EC_F_COMPLETE
, /* TAB */
172 '\17',0, EC_B_COMPLETE
, /* BACKTAB */
173 SK(SK_BACKTAB
),0, EC_B_COMPLETE
, /* BACKTAB */
174 ESC
,'\t',0, EC_B_COMPLETE
, /* ESC TAB */
175 CONTROL('L'),0, EC_EXPAND
, /* CTRL-L */
176 CONTROL('V'),0, EC_LITERAL
, /* BACKSLASH */
177 CONTROL('A'),0, EC_LITERAL
, /* BACKSLASH */
178 ESC
,'l',0, EC_RIGHT
, /* ESC l */
179 SK(SK_RIGHT_ARROW
),0, EC_RIGHT
, /* RIGHTARROW */
180 ESC
,'h',0, EC_LEFT
, /* ESC h */
181 SK(SK_LEFT_ARROW
),0, EC_LEFT
, /* LEFTARROW */
182 ESC
,'b',0, EC_W_LEFT
, /* ESC b */
183 ESC
,SK(SK_LEFT_ARROW
),0, EC_W_LEFT
, /* ESC LEFTARROW */
184 SK(SK_CTL_LEFT_ARROW
),0, EC_W_LEFT
, /* CTRL-LEFTARROW */
185 ESC
,'w',0, EC_W_RIGHT
, /* ESC w */
186 ESC
,SK(SK_RIGHT_ARROW
),0, EC_W_RIGHT
, /* ESC RIGHTARROW */
187 SK(SK_CTL_RIGHT_ARROW
),0, EC_W_RIGHT
, /* CTRL-RIGHTARROW */
188 ESC
,'i',0, EC_INSERT
, /* ESC i */
189 SK(SK_INSERT
),0, EC_INSERT
, /* INSERT */
190 ESC
,'x',0, EC_DELETE
, /* ESC x */
191 SK(SK_DELETE
),0, EC_DELETE
, /* DELETE */
192 ESC
,'X',0, EC_W_DELETE
, /* ESC X */
193 ESC
,SK(SK_DELETE
),0, EC_W_DELETE
, /* ESC DELETE */
194 SK(SK_CTL_DELETE
),0, EC_W_DELETE
, /* CTRL-DELETE */
195 SK(SK_CTL_BACKSPACE
),0, EC_W_BACKSPACE
, /* CTRL-BACKSPACE */
196 ESC
,'\b',0, EC_W_BACKSPACE
, /* ESC BACKSPACE */
197 ESC
,'0',0, EC_HOME
, /* ESC 0 */
198 SK(SK_HOME
),0, EC_HOME
, /* HOME */
199 ESC
,'$',0, EC_END
, /* ESC $ */
200 SK(SK_END
),0, EC_END
, /* END */
201 ESC
,'k',0, EC_UP
, /* ESC k */
202 SK(SK_UP_ARROW
),0, EC_UP
, /* UPARROW */
203 ESC
,'j',0, EC_DOWN
, /* ESC j */
204 SK(SK_DOWN_ARROW
),0, EC_DOWN
, /* DOWNARROW */
208 * Structure to support a list of command tables.
212 struct tablelist
*t_next
;
218 * List of command tables and list of line-edit tables.
220 static struct tablelist
*list_fcmd_tables
= NULL
;
221 static struct tablelist
*list_ecmd_tables
= NULL
;
222 static struct tablelist
*list_var_tables
= NULL
;
223 static struct tablelist
*list_sysvar_tables
= NULL
;
227 * Expand special key abbreviations in a command table.
230 expand_special_keys(table
, len
)
240 for (fm
= table
; fm
< table
+ len
; )
243 * Rewrite each command in the table with any
244 * special key abbreviations expanded.
246 for (to
= fm
; *fm
!= '\0'; )
248 if (*fm
!= SK_SPECIAL_KEY
)
254 * After SK_SPECIAL_KEY, next byte is the type
255 * of special key (one of the SK_* contants),
256 * and the byte after that is the number of bytes,
257 * N, reserved by the abbreviation (including the
258 * SK_SPECIAL_KEY and key type bytes).
259 * Replace all N bytes with the actual bytes
260 * output by the special key on this terminal.
262 repl
= special_key_str(fm
[1]);
265 if (repl
== NULL
|| (int) strlen(repl
) > klen
)
267 while (*repl
!= '\0')
272 * Fill any unused bytes between end of command and
273 * the action byte with A_SKIP.
281 while (*fm
++ != '\0')
288 * Initialize the command lists.
294 * Add the default command tables.
296 add_fcmd_table((char*)cmdtable
, sizeof(cmdtable
));
297 add_ecmd_table((char*)edittable
, sizeof(edittable
));
300 * For backwards compatibility,
301 * try to add tables in the OLD system lesskey file.
304 add_hometable(NULL
, BINDIR
"/.sysless", 1);
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);
318 * Add a command table.
321 add_cmd_table(tlist
, buf
, len
)
322 struct tablelist
**tlist
;
326 register struct tablelist
*t
;
331 * Allocate a tablelist structure, initialize it,
332 * and link it into the list of tables.
334 if ((t
= (struct tablelist
*)
335 calloc(1, sizeof(struct tablelist
))) == NULL
)
339 expand_special_keys(buf
, len
);
341 t
->t_end
= buf
+ len
;
348 * Add a command table.
351 add_fcmd_table(buf
, len
)
355 if (add_cmd_table(&list_fcmd_tables
, buf
, len
) < 0)
356 error("Warning: some commands disabled", NULL_PARG
);
360 * Add an editing command table.
363 add_ecmd_table(buf
, len
)
367 if (add_cmd_table(&list_ecmd_tables
, buf
, len
) < 0)
368 error("Warning: some edit commands disabled", NULL_PARG
);
372 * Add an environment variable table.
375 add_var_table(tlist
, buf
, len
)
376 struct tablelist
**tlist
;
380 if (add_cmd_table(tlist
, buf
, len
) < 0)
381 error("Warning: environment variables from lesskey file unavailable", NULL_PARG
);
385 * Search a single command table for the command string in cmd.
388 cmd_search(cmd
, table
, endtable
, sp
)
399 for (p
= table
, q
= cmd
; p
< endtable
; p
++, q
++)
404 * Current characters match.
405 * If we're at the end of the string, we've found it.
406 * Return the action code, which is the character
407 * after the null at the end of the string
408 * in the command table.
418 * We get here only if the original
419 * cmd string passed in was empty ("").
420 * I don't think that can happen,
421 * but just in case ...
426 * Check for an "extra" string.
435 } else if (*q
== '\0')
438 * Hit the end of the user's command,
439 * but not the end of the string in the command table.
440 * The user's command is incomplete.
447 * Skip ahead to the next command in the
448 * command table, and reset the pointer
449 * to the beginning of the user's command.
451 if (*p
== '\0' && p
[1] == A_END_LIST
)
454 * A_END_LIST is a special marker that tells
455 * us to abort the cmd search.
470 * No match found in the entire command table.
476 * Decode a command character and return the associated action.
477 * The "extra" string, if any, is returned in sp.
480 cmd_decode(tlist
, cmd
, sp
)
481 struct tablelist
*tlist
;
485 register struct tablelist
*t
;
486 register int action
= A_INVALID
;
489 * Search thru all the command tables.
490 * Stop when we find an action which is not A_INVALID.
492 for (t
= tlist
; t
!= NULL
; t
= t
->t_next
)
494 action
= cmd_search(cmd
, t
->t_start
, t
->t_end
, sp
);
495 if (action
!= A_INVALID
)
498 if (action
== A_UINVALID
)
504 * Decode a command from the cmdtables list.
511 return (cmd_decode(list_fcmd_tables
, cmd
, sp
));
515 * Decode a command from the edittables list.
522 return (cmd_decode(list_ecmd_tables
, cmd
, sp
));
526 * Get the value of an environment variable.
527 * Looks first in the lesskey file, then in the real environment.
536 a
= cmd_decode(list_var_tables
, var
, &s
);
540 if (s
!= NULL
&& *s
!= '\0')
542 a
= cmd_decode(list_sysvar_tables
, var
, &s
);
550 * Get an "integer" from a lesskey file.
551 * Integers are stored in a funny format:
552 * two bytes, low order first, in radix KRADIX.
561 n
+= *(*sp
)++ * KRADIX
;
566 * Process an old (pre-v241) lesskey file.
569 old_lesskey(buf
, len
)
574 * Old-style lesskey file.
575 * The file must end with either
577 * or ...,cmd,0,action|A_EXTRA,string,0
578 * So the last byte or the second to last byte must be zero.
580 if (buf
[len
-1] != '\0' && buf
[len
-2] != '\0')
582 add_fcmd_table(buf
, len
);
587 * Process a new (post-v241) lesskey file.
590 new_lesskey(buf
, len
, sysvar
)
600 * New-style lesskey file.
601 * Extract the pieces.
603 if (buf
[len
-3] != C0_END_LESSKEY_MAGIC
||
604 buf
[len
-2] != C1_END_LESSKEY_MAGIC
||
605 buf
[len
-1] != C2_END_LESSKEY_MAGIC
)
615 add_fcmd_table(p
, n
);
620 add_ecmd_table(p
, n
);
625 add_var_table((sysvar
) ?
626 &list_sysvar_tables
: &list_var_tables
, p
, n
);
633 * Unrecognized section type.
641 * Set up a user command table, based on a "lesskey" file.
644 lesskey(filename
, sysvar
)
649 register POSITION len
;
656 * Try to open the lesskey file.
658 filename
= shell_unquote(filename
);
659 f
= open(filename
, OPEN_READ
);
665 * Read the file into a buffer.
666 * We first figure out the size of the file and allocate space for it.
667 * {{ Minimal error checking is done here.
668 * A garbage .less file will produce strange results.
669 * To avoid a large amount of error checking code here, we
670 * rely on the lesskey program to generate a good .less file. }}
673 if (len
== NULL_POSITION
|| len
< 3)
676 * Bad file (valid file must have at least 3 chars).
681 if ((buf
= (char *) calloc((int)len
, sizeof(char))) == NULL
)
686 if (lseek(f
, (off_t
)0, SEEK_SET
) == BAD_LSEEK
)
692 n
= read(f
, buf
, (unsigned int) len
);
701 * Figure out if this is an old-style (before version 241)
702 * or new-style lesskey file format.
704 if (buf
[0] != C0_LESSKEY_MAGIC
|| buf
[1] != C1_LESSKEY_MAGIC
||
705 buf
[2] != C2_LESSKEY_MAGIC
|| buf
[3] != C3_LESSKEY_MAGIC
)
706 return (old_lesskey(buf
, (int)len
));
707 return (new_lesskey(buf
, (int)len
, sysvar
));
711 * Add the standard lesskey file "$HOME/.less"
714 add_hometable(envname
, def_filename
, sysvar
)
722 if (envname
!= NULL
&& (filename
= lgetenv(envname
)) != NULL
)
723 filename
= save(filename
);
725 filename
= save(def_filename
);
727 filename
= homefile(def_filename
);
728 if (filename
== NULL
)
730 if (lesskey(filename
, sysvar
) < 0)
732 parg
.p_string
= filename
;
733 error("Cannot use lesskey file \"%s\"", &parg
);
740 * See if a char is a special line-editing command.
750 char usercmd
[MAX_CMDLEN
+1];
753 * An editing character could actually be a sequence of characters;
754 * for example, an escape sequence sent by pressing the uparrow key.
755 * To match the editing string, we use the command decoder
756 * but give it the edit-commands command table
757 * This table is constructed to match the user's keyboard.
759 if (c
== erase_char
|| c
== erase2_char
)
760 return (EC_BACKSPACE
);
762 return (EC_LINEKILL
);
765 * Collect characters in a buffer.
766 * Start with the one we have, and get more if we need them.
773 usercmd
[nch
+1] = '\0';
775 action
= ecmd_decode(usercmd
, &s
);
776 } while (action
== A_PREFIX
);
778 if (flags
& EC_NORIGHTLEFT
)
789 if (flags
& EC_NOHISTORY
)
792 * The caller says there is no history list.
793 * Reject any history-manipulation action.
804 #if TAB_COMPLETE_FILENAME
805 if (flags
& EC_NOCOMPLETE
)
808 * The caller says we don't want any filename completion cmds.
821 if ((flags
& EC_PEEK
) || action
== A_INVALID
)
824 * We're just peeking, or we didn't understand the command.
825 * Unget all the characters we read in the loop above.
826 * This does NOT include the original character that was
827 * passed in as a parameter.
831 ungetcc(usercmd
[--nch
]);