1 /* $NetBSD: decode.c,v 1.4 2013/09/04 19:44:21 tron Exp $ */
4 * Copyright (C) 1984-2012 Mark Nudelman
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.
14 * Routines to decode user commands.
16 * This is all table driven.
17 * A command table is a sequence of command descriptors.
18 * Each command descriptor is a sequence of bytes with the following format:
19 * <c1><c2>...<cN><0><action>
20 * The characters c1,c2,...,cN are the command string; that is,
21 * the characters which the user must type.
22 * It is terminated by a null <0> byte.
23 * The byte after the null byte is the action code associated
24 * with the command string.
25 * If an action byte is OR-ed with A_EXTRA, this indicates
26 * that the option byte is followed by an extra string.
28 * There may be many command tables.
29 * The first (default) table is built-in.
30 * Other tables are read in from "lesskey" files.
31 * All the tables are linked together and are searched in order.
38 extern int erase_char
, erase2_char
, kill_char
;
42 SK_SPECIAL_KEY, (k), 6, 1, 1, 1
44 * Command table is ordered roughly according to expected
45 * frequency of use, so the common commands are near the beginning.
48 static unsigned char cmdtable
[] =
54 SK(SK_DOWN_ARROW
),0, A_F_LINE
,
55 CONTROL('E'),0, A_F_LINE
,
56 CONTROL('N'),0, A_F_LINE
,
59 CONTROL('Y'),0, A_B_LINE
,
60 SK(SK_CONTROL_K
),0, A_B_LINE
,
61 CONTROL('P'),0, A_B_LINE
,
62 SK(SK_UP_ARROW
),0, A_B_LINE
,
67 CONTROL('D'),0, A_F_SCROLL
,
69 CONTROL('U'),0, A_B_SCROLL
,
72 CONTROL('F'),0, A_F_SCREEN
,
73 CONTROL('V'),0, A_F_SCREEN
,
74 SK(SK_PAGE_DOWN
),0, A_F_SCREEN
,
76 CONTROL('B'),0, A_B_SCREEN
,
77 ESC
,'v',0, A_B_SCREEN
,
78 SK(SK_PAGE_UP
),0, A_B_SCREEN
,
81 ESC
,' ',0, A_FF_SCREEN
,
83 ESC
,'F',0, A_F_UNTIL_HILITE
,
86 CONTROL('R'),0, A_REPAINT
,
87 CONTROL('L'),0, A_REPAINT
,
88 ESC
,'u',0, A_UNDO_SEARCH
,
90 SK(SK_HOME
),0, A_GOLINE
,
99 SK(SK_RIGHT_ARROW
),0, A_RSHIFT
,
100 SK(SK_LEFT_ARROW
),0, A_LSHIFT
,
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 '[',0, A_F_BRACKET
|A_EXTRA
, '[',']',0,
106 ']',0, A_B_BRACKET
|A_EXTRA
, '[',']',0,
107 ESC
,CONTROL('F'),0, A_F_BRACKET
,
108 ESC
,CONTROL('B'),0, A_B_BRACKET
,
112 SK(SK_END
),0, A_GOEND
,
128 CONTROL('G'),0, A_STAT
,
132 ESC
,'/',0, A_F_SEARCH
|A_EXTRA
, '*',0,
133 ESC
,'?',0, A_B_SEARCH
|A_EXTRA
, '*',0,
134 'n',0, A_AGAIN_SEARCH
,
135 ESC
,'n',0, A_T_AGAIN_SEARCH
,
136 'N',0, A_REVERSE_SEARCH
,
137 ESC
,'N',0, A_T_REVERSE_SEARCH
,
141 CONTROL('X'),CONTROL('X'),0, A_GOMARK
,
143 ':','e',0, A_EXAMINE
,
144 CONTROL('X'),CONTROL('V'),0, A_EXAMINE
,
145 ':','n',0, A_NEXT_FILE
,
146 ':','p',0, A_PREV_FILE
,
149 ':','x',0, A_INDEX_FILE
,
150 ':','d',0, A_REMOVE_FILE
,
152 ':','t',0, A_OPT_TOGGLE
|A_EXTRA
, 't',0,
153 's',0, A_OPT_TOGGLE
|A_EXTRA
, 'o',0,
154 '_',0, A_DISP_OPTION
,
171 static unsigned char edittable
[] =
173 '\t',0, EC_F_COMPLETE
, /* TAB */
174 '\17',0, EC_B_COMPLETE
, /* BACKTAB */
175 SK(SK_BACKTAB
),0, EC_B_COMPLETE
, /* BACKTAB */
176 ESC
,'\t',0, EC_B_COMPLETE
, /* ESC TAB */
177 CONTROL('L'),0, EC_EXPAND
, /* CTRL-L */
178 CONTROL('V'),0, EC_LITERAL
, /* BACKSLASH */
179 CONTROL('A'),0, EC_LITERAL
, /* BACKSLASH */
180 ESC
,'l',0, EC_RIGHT
, /* ESC l */
181 SK(SK_RIGHT_ARROW
),0, EC_RIGHT
, /* RIGHTARROW */
182 ESC
,'h',0, EC_LEFT
, /* ESC h */
183 SK(SK_LEFT_ARROW
),0, EC_LEFT
, /* LEFTARROW */
184 ESC
,'b',0, EC_W_LEFT
, /* ESC b */
185 ESC
,SK(SK_LEFT_ARROW
),0, EC_W_LEFT
, /* ESC LEFTARROW */
186 SK(SK_CTL_LEFT_ARROW
),0, EC_W_LEFT
, /* CTRL-LEFTARROW */
187 ESC
,'w',0, EC_W_RIGHT
, /* ESC w */
188 ESC
,SK(SK_RIGHT_ARROW
),0, EC_W_RIGHT
, /* ESC RIGHTARROW */
189 SK(SK_CTL_RIGHT_ARROW
),0, EC_W_RIGHT
, /* CTRL-RIGHTARROW */
190 ESC
,'i',0, EC_INSERT
, /* ESC i */
191 SK(SK_INSERT
),0, EC_INSERT
, /* INSERT */
192 ESC
,'x',0, EC_DELETE
, /* ESC x */
193 SK(SK_DELETE
),0, EC_DELETE
, /* DELETE */
194 ESC
,'X',0, EC_W_DELETE
, /* ESC X */
195 ESC
,SK(SK_DELETE
),0, EC_W_DELETE
, /* ESC DELETE */
196 SK(SK_CTL_DELETE
),0, EC_W_DELETE
, /* CTRL-DELETE */
197 SK(SK_CTL_BACKSPACE
),0, EC_W_BACKSPACE
, /* CTRL-BACKSPACE */
198 ESC
,'\b',0, EC_W_BACKSPACE
, /* ESC BACKSPACE */
199 ESC
,'0',0, EC_HOME
, /* ESC 0 */
200 SK(SK_HOME
),0, EC_HOME
, /* HOME */
201 ESC
,'$',0, EC_END
, /* ESC $ */
202 SK(SK_END
),0, EC_END
, /* END */
203 ESC
,'k',0, EC_UP
, /* ESC k */
204 SK(SK_UP_ARROW
),0, EC_UP
, /* UPARROW */
205 ESC
,'j',0, EC_DOWN
, /* ESC j */
206 SK(SK_DOWN_ARROW
),0, EC_DOWN
, /* DOWNARROW */
207 CONTROL('G'),0, EC_ABORT
, /* CTRL-G */
211 * Structure to support a list of command tables.
215 struct tablelist
*t_next
;
221 * List of command tables and list of line-edit tables.
223 static struct tablelist
*list_fcmd_tables
= NULL
;
224 static struct tablelist
*list_ecmd_tables
= NULL
;
225 static struct tablelist
*list_var_tables
= NULL
;
226 static struct tablelist
*list_sysvar_tables
= NULL
;
228 static int add_cmd_table
__P((struct tablelist
**, char *, int));
229 static int cmd_decode
__P((struct tablelist
*, char *, char **));
230 static int gint
__P((char **));
231 static int old_lesskey
__P((char *, int));
232 static int new_lesskey
__P((char *, int, int));
235 * Expand special key abbreviations in a command table.
238 expand_special_keys(table
, len
)
248 for (fm
= table
; fm
< table
+ len
; )
251 * Rewrite each command in the table with any
252 * special key abbreviations expanded.
254 for (to
= fm
; *fm
!= '\0'; )
256 if (*fm
!= SK_SPECIAL_KEY
)
262 * After SK_SPECIAL_KEY, next byte is the type
263 * of special key (one of the SK_* contants),
264 * and the byte after that is the number of bytes,
265 * N, reserved by the abbreviation (including the
266 * SK_SPECIAL_KEY and key type bytes).
267 * Replace all N bytes with the actual bytes
268 * output by the special key on this terminal.
270 repl
= special_key_str(fm
[1]);
273 if (repl
== NULL
|| (int) strlen(repl
) > klen
)
275 while (*repl
!= '\0')
280 * Fill any unused bytes between end of command and
281 * the action byte with A_SKIP.
289 while (*fm
++ != '\0')
296 * Initialize the command lists.
302 * Add the default command tables.
304 add_fcmd_table((char*)cmdtable
, sizeof(cmdtable
));
305 add_ecmd_table((char*)edittable
, sizeof(edittable
));
308 * For backwards compatibility,
309 * try to add tables in the OLD system lesskey file.
312 add_hometable(NULL
, BINDIR
"/.sysless", 1);
315 * Try to add the tables in the system lesskey file.
317 add_hometable("LESSKEY_SYSTEM", LESSKEYFILE_SYS
, 1);
319 * Try to add the tables in the standard lesskey file "$HOME/.less".
321 add_hometable("LESSKEY", LESSKEYFILE
, 0);
326 * Add a command table.
329 add_cmd_table(tlist
, buf
, len
)
330 struct tablelist
**tlist
;
334 register struct tablelist
*t
;
339 * Allocate a tablelist structure, initialize it,
340 * and link it into the list of tables.
342 if ((t
= (struct tablelist
*)
343 calloc(1, sizeof(struct tablelist
))) == NULL
)
347 expand_special_keys(buf
, len
);
349 t
->t_end
= buf
+ len
;
356 * Add a command table.
359 add_fcmd_table(buf
, len
)
363 if (add_cmd_table(&list_fcmd_tables
, buf
, len
) < 0)
364 error("Warning: some commands disabled", NULL_PARG
);
368 * Add an editing command table.
371 add_ecmd_table(buf
, len
)
375 if (add_cmd_table(&list_ecmd_tables
, buf
, len
) < 0)
376 error("Warning: some edit commands disabled", NULL_PARG
);
380 * Add an environment variable table.
383 add_var_table(tlist
, buf
, len
)
384 struct tablelist
**tlist
;
388 if (add_cmd_table(tlist
, buf
, len
) < 0)
389 error("Warning: environment variables from lesskey file unavailable", NULL_PARG
);
393 * Search a single command table for the command string in cmd.
396 cmd_search(cmd
, table
, endtable
, sp
)
407 for (p
= table
, q
= cmd
; p
< endtable
; p
++, q
++)
412 * Current characters match.
413 * If we're at the end of the string, we've found it.
414 * Return the action code, which is the character
415 * after the null at the end of the string
416 * in the command table.
426 * We get here only if the original
427 * cmd string passed in was empty ("").
428 * I don't think that can happen,
429 * but just in case ...
434 * Check for an "extra" string.
443 } else if (*q
== '\0')
446 * Hit the end of the user's command,
447 * but not the end of the string in the command table.
448 * The user's command is incomplete.
455 * Skip ahead to the next command in the
456 * command table, and reset the pointer
457 * to the beginning of the user's command.
459 if (*p
== '\0' && p
[1] == A_END_LIST
)
462 * A_END_LIST is a special marker that tells
463 * us to abort the cmd search.
478 * No match found in the entire command table.
484 * Decode a command character and return the associated action.
485 * The "extra" string, if any, is returned in sp.
488 cmd_decode(tlist
, cmd
, sp
)
489 struct tablelist
*tlist
;
493 register struct tablelist
*t
;
494 register int action
= A_INVALID
;
497 * Search thru all the command tables.
498 * Stop when we find an action which is not A_INVALID.
500 for (t
= tlist
; t
!= NULL
; t
= t
->t_next
)
502 action
= cmd_search(cmd
, t
->t_start
, t
->t_end
, sp
);
503 if (action
!= A_INVALID
)
506 if (action
== A_UINVALID
)
512 * Decode a command from the cmdtables list.
519 return (cmd_decode(list_fcmd_tables
, cmd
, sp
));
523 * Decode a command from the edittables list.
530 return (cmd_decode(list_ecmd_tables
, cmd
, sp
));
534 * Get the value of an environment variable.
535 * Looks first in the lesskey file, then in the real environment.
544 a
= cmd_decode(list_var_tables
, var
, &s
);
548 if (s
!= NULL
&& *s
!= '\0')
550 a
= cmd_decode(list_sysvar_tables
, var
, &s
);
558 * Get an "integer" from a lesskey file.
559 * Integers are stored in a funny format:
560 * two bytes, low order first, in radix KRADIX.
569 n
+= *(*sp
)++ * KRADIX
;
574 * Process an old (pre-v241) lesskey file.
577 old_lesskey(buf
, len
)
582 * Old-style lesskey file.
583 * The file must end with either
585 * or ...,cmd,0,action|A_EXTRA,string,0
586 * So the last byte or the second to last byte must be zero.
588 if (buf
[len
-1] != '\0' && buf
[len
-2] != '\0')
590 add_fcmd_table(buf
, len
);
595 * Process a new (post-v241) lesskey file.
598 new_lesskey(buf
, len
, sysvar
)
608 * New-style lesskey file.
609 * Extract the pieces.
611 if (buf
[len
-3] != C0_END_LESSKEY_MAGIC
||
612 buf
[len
-2] != C1_END_LESSKEY_MAGIC
||
613 buf
[len
-1] != C2_END_LESSKEY_MAGIC
)
623 add_fcmd_table(p
, n
);
628 add_ecmd_table(p
, n
);
633 add_var_table((sysvar
) ?
634 &list_sysvar_tables
: &list_var_tables
, p
, n
);
641 * Unrecognized section type.
649 * Set up a user command table, based on a "lesskey" file.
652 lesskey(filename
, sysvar
)
657 register POSITION len
;
664 * Try to open the lesskey file.
666 filename
= shell_unquote(filename
);
667 f
= open(filename
, OPEN_READ
);
673 * Read the file into a buffer.
674 * We first figure out the size of the file and allocate space for it.
675 * {{ Minimal error checking is done here.
676 * A garbage .less file will produce strange results.
677 * To avoid a large amount of error checking code here, we
678 * rely on the lesskey program to generate a good .less file. }}
681 if (len
== NULL_POSITION
|| len
< 3)
684 * Bad file (valid file must have at least 3 chars).
689 if ((buf
= (char *) calloc((int)len
, sizeof(char))) == NULL
)
694 if (lseek(f
, (off_t
)0, SEEK_SET
) == BAD_LSEEK
)
700 n
= read(f
, buf
, (unsigned int) len
);
709 * Figure out if this is an old-style (before version 241)
710 * or new-style lesskey file format.
712 if (buf
[0] != C0_LESSKEY_MAGIC
|| buf
[1] != C1_LESSKEY_MAGIC
||
713 buf
[2] != C2_LESSKEY_MAGIC
|| buf
[3] != C3_LESSKEY_MAGIC
)
714 return (old_lesskey(buf
, (int)len
));
715 return (new_lesskey(buf
, (int)len
, sysvar
));
719 * Add the standard lesskey file "$HOME/.less"
722 add_hometable(envname
, def_filename
, sysvar
)
730 if (envname
!= NULL
&& (filename
= lgetenv(envname
)) != NULL
)
731 filename
= save(filename
);
733 filename
= save(def_filename
);
735 filename
= homefile(def_filename
);
736 if (filename
== NULL
)
738 if (lesskey(filename
, sysvar
) < 0)
740 parg
.p_string
= filename
;
741 error("Cannot use lesskey file \"%s\"", &parg
);
748 * See if a char is a special line-editing command.
757 char *s
= NULL
; /* XXX: GCC */
758 char usercmd
[MAX_CMDLEN
+1];
761 * An editing character could actually be a sequence of characters;
762 * for example, an escape sequence sent by pressing the uparrow key.
763 * To match the editing string, we use the command decoder
764 * but give it the edit-commands command table
765 * This table is constructed to match the user's keyboard.
767 if (c
== erase_char
|| c
== erase2_char
)
768 return (EC_BACKSPACE
);
770 return (EC_LINEKILL
);
773 * Collect characters in a buffer.
774 * Start with the one we have, and get more if we need them.
781 usercmd
[nch
+1] = '\0';
783 action
= ecmd_decode(usercmd
, &s
);
784 } while (action
== A_PREFIX
);
786 if (flags
& EC_NORIGHTLEFT
)
797 if (flags
& EC_NOHISTORY
)
800 * The caller says there is no history list.
801 * Reject any history-manipulation action.
812 #if TAB_COMPLETE_FILENAME
813 if (flags
& EC_NOCOMPLETE
)
816 * The caller says we don't want any filename completion cmds.
829 if ((flags
& EC_PEEK
) || action
== A_INVALID
)
832 * We're just peeking, or we didn't understand the command.
833 * Unget all the characters we read in the loop above.
834 * This does NOT include the original character that was
835 * passed in as a parameter.
839 ungetcc(usercmd
[--nch
]);