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 * lesskey [-o output] [input]
15 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
18 * If no input file is specified, standard input is used.
19 * If no output file is specified, $HOME/.less is used.
21 * The .less file is used to specify (to "less") user-defined
22 * key bindings. Basically any sequence of 1 to MAX_CMDLEN
23 * keystrokes may be bound to an existing less function.
25 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
27 * The input file is an ascii file consisting of a
28 * sequence of lines of the form:
29 * string <whitespace> action [chars] <newline>
31 * "string" is a sequence of command characters which form
32 * the new user-defined command. The command
34 * 1. The actual character itself.
35 * 2. A character preceded by ^ to specify a
36 * control character (e.g. ^X means control-X).
37 * 3. A backslash followed by one to three octal digits
38 * to specify a character by its octal value.
39 * 4. A backslash followed by b, e, n, r or t
40 * to specify \b, ESC, \n, \r or \t, respectively.
41 * 5. Any character (other than those mentioned above) preceded
42 * by a \ to specify the character itself (characters which
43 * must be preceded by \ include ^, \, and whitespace.
44 * "action" is the name of a "less" action, from the table below.
45 * "chars" is an optional sequence of characters which is treated
46 * as keyboard input after the command is executed.
48 * Blank lines and lines which start with # are ignored,
49 * except for the special control lines:
50 * #command Signals the beginning of the command
52 * #line-edit Signals the beginning of the line-editing
54 * #env Signals the beginning of the environment
56 * #stop Stops command parsing in less;
57 * causes all default keys to be disabled.
59 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
61 * The output file is a non-ascii file, consisting of a header,
62 * one or more sections, and a trailer.
63 * Each section begins with a section header, a section length word
64 * and the section data. Normally there are three sections:
65 * CMD_SECTION Definition of command keys.
66 * EDIT_SECTION Definition of editing keys.
67 * END_SECTION A special section header, with no
68 * length word or section data.
70 * Section data consists of zero or more byte sequences of the form:
73 * string <0> <action|A_EXTRA> chars <0>
75 * "string" is the command string.
76 * "<0>" is one null byte.
77 * "<action>" is one byte containing the action code (the A_xxx value).
78 * If action is ORed with A_EXTRA, the action byte is followed
79 * by the null-terminated "chars" string.
81 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
94 struct cmdname cmdnames[] =
96 { "back-bracket", A_B_BRACKET },
97 { "back-line", A_B_LINE },
98 { "back-line-force", A_BF_LINE },
99 { "back-screen", A_B_SCREEN },
100 { "back-scroll", A_B_SCROLL },
101 { "back-search", A_B_SEARCH },
102 { "back-window", A_B_WINDOW },
103 { "debug", A_DEBUG },
104 { "digit", A_DIGIT },
105 { "display-flag", A_DISP_OPTION },
106 { "display-option", A_DISP_OPTION },
108 { "examine", A_EXAMINE },
109 { "filter", A_FILTER },
110 { "first-cmd", A_FIRSTCMD },
111 { "firstcmd", A_FIRSTCMD },
112 { "flush-repaint", A_FREPAINT },
113 { "forw-bracket", A_F_BRACKET },
114 { "forw-forever", A_F_FOREVER },
115 { "forw-line", A_F_LINE },
116 { "forw-line-force", A_FF_LINE },
117 { "forw-screen", A_F_SCREEN },
118 { "forw-screen-force", A_FF_SCREEN },
119 { "forw-scroll", A_F_SCROLL },
120 { "forw-search", A_F_SEARCH },
121 { "forw-window", A_F_WINDOW },
122 { "goto-end", A_GOEND },
123 { "goto-line", A_GOLINE },
124 { "goto-mark", A_GOMARK },
126 { "index-file", A_INDEX_FILE },
127 { "invalid", A_UINVALID },
128 { "left-scroll", A_LSHIFT },
129 { "next-file", A_NEXT_FILE },
130 { "next-tag", A_NEXT_TAG },
131 { "noaction", A_NOACTION },
132 { "percent", A_PERCENT },
134 { "prev-file", A_PREV_FILE },
135 { "prev-tag", A_PREV_TAG },
137 { "remove-file", A_REMOVE_FILE },
138 { "repaint", A_REPAINT },
139 { "repaint-flush", A_FREPAINT },
140 { "repeat-search", A_AGAIN_SEARCH },
141 { "repeat-search-all", A_T_AGAIN_SEARCH },
142 { "reverse-search", A_REVERSE_SEARCH },
143 { "reverse-search-all", A_T_REVERSE_SEARCH },
144 { "right-scroll", A_RSHIFT },
145 { "set-mark", A_SETMARK },
146 { "shell", A_SHELL },
147 { "status", A_STAT },
148 { "toggle-flag", A_OPT_TOGGLE },
149 { "toggle-option", A_OPT_TOGGLE },
150 { "undo-hilite", A_UNDO_SEARCH },
151 { "version", A_VERSION },
152 { "visual", A_VISUAL },
156 struct cmdname editnames[] =
158 { "back-complete", EC_B_COMPLETE },
159 { "backspace", EC_BACKSPACE },
160 { "delete", EC_DELETE },
163 { "expand", EC_EXPAND },
164 { "forw-complete", EC_F_COMPLETE },
166 { "insert", EC_INSERT },
167 { "invalid", EC_UINVALID },
168 { "kill-line", EC_LINEKILL },
170 { "literal", EC_LITERAL },
171 { "right", EC_RIGHT },
173 { "word-backspace", EC_W_BACKSPACE },
174 { "word-delete", EC_W_DELETE },
175 { "word-left", EC_W_LEFT },
176 { "word-right", EC_W_RIGHT },
182 struct cmdname *names;
184 char buffer[MAX_USERCMD];
187 struct table cmdtable;
188 struct table edittable;
189 struct table vartable;
190 struct table *currtable = &cmdtable;
192 char fileheader[] = {
198 char filetrailer[] = {
199 C0_END_LESSKEY_MAGIC,
200 C1_END_LESSKEY_MAGIC,
203 char cmdsection[1] = { CMD_SECTION };
204 char editsection[1] = { EDIT_SECTION };
205 char varsection[1] = { VAR_SECTION };
206 char endsection[1] = { END_SECTION };
209 char *outfile = NULL ;
214 extern char version[];
219 fprintf(stderr, "usage: lesskey [-o output] [input]\n");
224 mkpathname(dirname, filename)
230 pathname = calloc(strlen(dirname) + strlen(filename) + 2, sizeof(char));
231 strcpy(pathname, dirname);
232 strcat(pathname, PATHNAME_SEP);
233 strcat(pathname, filename);
238 * Figure out the name of a default file (in the user's HOME directory).
247 if ((p = getenv("HOME")) != NULL && *p != '\0')
248 pathname = mkpathname(p, filename);
250 else if ((p = getenv("INIT")) != NULL && *p != '\0')
251 pathname = mkpathname(p, filename);
255 fprintf(stderr, "cannot find $HOME - using current directory\n");
256 pathname = mkpathname(".", filename);
262 * Parse command line arguments.
265 parse_args(argc, argv)
276 /* Arg does not start with "-"; it's not an option. */
279 /* "-" means standard input. */
281 if (arg[1] == '-' && arg[2] == '\0')
283 /* "--" means end of options. */
291 if (strncmp(arg, "--output", 8) == 0)
295 else if (arg[8] == '=')
301 if (strcmp(arg, "--version") == 0)
308 outfile = &argv[0][2];
310 if (*outfile == '\0')
319 printf("lesskey version %s\n", version);
328 * Open the input file, or use DEF_LESSKEYINFILE if none specified.
333 infile = homefile(DEF_LESSKEYINFILE);
337 * Initialize data structures.
342 cmdtable.names = cmdnames;
343 cmdtable.pbuffer = cmdtable.buffer;
345 edittable.names = editnames;
346 edittable.pbuffer = edittable.buffer;
348 vartable.names = NULL;
349 vartable.pbuffer = vartable.buffer;
353 * Parse one character of a string.
364 static char tstr_control_k[] =
365 { SK_SPECIAL_KEY, SK_CONTROL_K, 6, 1, 1, 1, '\0' };
374 case '0': case '1': case '2': case '3':
375 case '4': case '5': case '6': case '7':
377 * Parse an octal number.
382 ch = 8*ch + (*p - '0');
383 while (*++p >= '0' && *p <= '7' && ++i < 3);
385 if (xlate && ch == CONTROL('K'))
386 return tstr_control_k;
412 case 'u': ch = SK_UP_ARROW; break;
413 case 'd': ch = SK_DOWN_ARROW; break;
414 case 'r': ch = SK_RIGHT_ARROW; break;
415 case 'l': ch = SK_LEFT_ARROW; break;
416 case 'U': ch = SK_PAGE_UP; break;
417 case 'D': ch = SK_PAGE_DOWN; break;
418 case 'h': ch = SK_HOME; break;
419 case 'e': ch = SK_END; break;
420 case 'x': ch = SK_DELETE; break;
422 error("illegal char after \\k");
427 buf[0] = SK_SPECIAL_KEY;
439 * Backslash followed by any other char
440 * just means that char.
445 if (xlate && buf[0] == CONTROL('K'))
446 return tstr_control_k;
451 * Carat means CONTROL.
454 buf[0] = CONTROL(p[1]);
456 if (buf[0] == CONTROL('K'))
457 return tstr_control_k;
463 if (xlate && buf[0] == CONTROL('K'))
464 return tstr_control_k;
469 * Skip leading spaces in a string.
475 while (*s == ' ' || *s == '\t')
481 * Skip non-space characters in a string.
487 while (*s != '\0' && *s != ' ' && *s != '\t')
493 * Clean up an input line:
494 * strip off the trailing newline & any trailing # comment.
503 for (i = 0; s[i] != '\n' && s[i] != '\r' && s[i] != '\0'; i++)
504 if (s[i] == '#' && (i == 0 || s[i-1] != '\\'))
511 * Add a byte to the output command table.
517 if (currtable->pbuffer >= currtable->buffer + MAX_USERCMD)
519 error("too many commands");
522 *(currtable->pbuffer)++ = c;
526 * Add a string to the output command table.
532 for ( ; *s != '\0'; s++)
537 * See if we have a special "control" line.
543 #define PREFIX(str,pat) (strncmp(str,pat,strlen(pat)) == 0)
545 if (PREFIX(s, "#line-edit"))
547 currtable = &edittable;
550 if (PREFIX(s, "#command"))
552 currtable = &cmdtable;
555 if (PREFIX(s, "#env"))
557 currtable = &vartable;
560 if (PREFIX(s, "#stop"))
563 add_cmd_char(A_END_LIST);
573 fputbytes(fd, buf, len)
580 fwrite(buf, sizeof(char), 1, fd);
586 * Output an integer, in special KRADIX form.
595 if (val >= KRADIX*KRADIX)
597 fprintf(stderr, "error: integer too big (%d > %d)\n",
602 fwrite(&c, sizeof(char), 1, fd);
604 fwrite(&c, sizeof(char), 1, fd);
608 * Find an action, given the name of the action.
616 for (i = 0; currtable->names[i].cn_name != NULL; i++)
617 if (strcmp(currtable->names[i].cn_name, actname) == 0)
618 return (currtable->names[i].cn_action);
619 error("unknown action");
627 fprintf(stderr, "line %d: %s\n", linenum, s);
643 * Parse the command string and store it in the current table.
650 if (cmdlen > MAX_CMDLEN)
651 error("command too long");
654 } while (*p != ' ' && *p != '\t' && *p != '\0');
656 * Terminate the command string with a null byte.
661 * Skip white space between the command string
662 * and the action name.
663 * Terminate the action name with a null byte.
668 error("missing action");
677 * Parse the action name and store it in the current table.
679 action = findaction(actname);
682 * See if an extra string follows the action name.
688 add_cmd_char(action);
692 * OR the special value A_EXTRA into the action byte.
693 * Put the extra string after the action byte.
695 add_cmd_char(action | A_EXTRA);
697 add_cmd_str(tstr(&p, 0));
712 } while (*p != ' ' && *p != '\t' && *p != '=' && *p != '\0');
714 * Terminate the variable name with a null byte.
725 add_cmd_char(EV_OK|A_EXTRA);
737 * Parse a line from the lesskey file.
746 * See if it is a control line.
748 if (control_line(line))
751 * Skip leading white space.
752 * Replace the final newline with a null byte.
753 * Ignore blank lines and comments.
755 p = clean_line(line);
759 if (currtable == &vartable)
775 if (getenv("HOME") == NULL)
778 * If there is no HOME environment variable,
779 * try the concatenation of HOMEDRIVE + HOMEPATH.
781 char *drive = getenv("HOMEDRIVE");
782 char *path = getenv("HOMEPATH");
783 if (drive != NULL && path != NULL)
785 char *env = (char *) calloc(strlen(drive) +
786 strlen(path) + 6, sizeof(char));
787 strcpy(env, "HOME=");
796 * Process command line arguments.
798 parse_args(argc, argv);
802 * Open the input file.
804 if (strcmp(infile, "-") == 0)
806 else if ((desc = fopen(infile, "r")) == NULL)
811 fprintf(stderr, "Cannot open %s\n", infile);
817 * Read and parse the input file, one line at a time.
821 while (fgets(line, sizeof(line), desc) != NULL)
828 * Write the output file.
829 * If no output file was specified, use "$HOME/.less"
833 fprintf(stderr, "%d errors; no output produced\n", errors);
838 outfile = getenv("LESSKEY");
840 outfile = homefile(LESSKEYFILE);
841 if ((out = fopen(outfile, "wb")) == NULL)
846 fprintf(stderr, "Cannot open %s\n", outfile);
852 fputbytes(out, fileheader, sizeof(fileheader));
854 /* Command key section */
855 fputbytes(out, cmdsection, sizeof(cmdsection));
856 fputint(out, cmdtable.pbuffer - cmdtable.buffer);
857 fputbytes(out, (char *)cmdtable.buffer, cmdtable.pbuffer-cmdtable.buffer);
858 /* Edit key section */
859 fputbytes(out, editsection, sizeof(editsection));
860 fputint(out, edittable.pbuffer - edittable.buffer);
861 fputbytes(out, (char *)edittable.buffer, edittable.pbuffer-edittable.buffer);
863 /* Environment variable section */
864 fputbytes(out, varsection, sizeof(varsection));
865 fputint(out, vartable.pbuffer - vartable.buffer);
866 fputbytes(out, (char *)vartable.buffer, vartable.pbuffer-vartable.buffer);
869 fputbytes(out, endsection, sizeof(endsection));
870 fputbytes(out, filetrailer, sizeof(filetrailer));