2 * Copyright (C) 1984-2019 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, see the README file.
12 * lesskey [-o output] [input]
14 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
17 * If no input file is specified, standard input is used.
18 * If no output file is specified, $HOME/.less is used.
20 * The .less file is used to specify (to "less") user-defined
21 * key bindings. Basically any sequence of 1 to MAX_CMDLEN
22 * keystrokes may be bound to an existing less function.
24 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
26 * The input file is an ascii file consisting of a
27 * sequence of lines of the form:
28 * string <whitespace> action [chars] <newline>
30 * "string" is a sequence of command characters which form
31 * the new user-defined command. The command
33 * 1. The actual character itself.
34 * 2. A character preceded by ^ to specify a
35 * control character (e.g. ^X means control-X).
36 * 3. A backslash followed by one to three octal digits
37 * to specify a character by its octal value.
38 * 4. A backslash followed by b, e, n, r or t
39 * to specify \b, ESC, \n, \r or \t, respectively.
40 * 5. Any character (other than those mentioned above) preceded
41 * by a \ to specify the character itself (characters which
42 * must be preceded by \ include ^, \, and whitespace.
43 * "action" is the name of a "less" action, from the table below.
44 * "chars" is an optional sequence of characters which is treated
45 * as keyboard input after the command is executed.
47 * Blank lines and lines which start with # are ignored,
48 * except for the special control lines:
49 * #command Signals the beginning of the command
51 * #line-edit Signals the beginning of the line-editing
53 * #env Signals the beginning of the environment
55 * #stop Stops command parsing in less;
56 * causes all default keys to be disabled.
58 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
60 * The output file is a non-ascii file, consisting of a header,
61 * one or more sections, and a trailer.
62 * Each section begins with a section header, a section length word
63 * and the section data. Normally there are three sections:
64 * CMD_SECTION Definition of command keys.
65 * EDIT_SECTION Definition of editing keys.
66 * END_SECTION A special section header, with no
67 * length word or section data.
69 * Section data consists of zero or more byte sequences of the form:
72 * string <0> <action|A_EXTRA> chars <0>
74 * "string" is the command string.
75 * "<0>" is one null byte.
76 * "<action>" is one byte containing the action code (the A_xxx value).
77 * If action is ORed with A_EXTRA, the action byte is followed
78 * by the null-terminated "chars" string.
80 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
93 struct cmdname cmdnames
[] =
95 { "back-bracket", A_B_BRACKET
},
96 { "back-line", A_B_LINE
},
97 { "back-line-force", A_BF_LINE
},
98 { "back-screen", A_B_SCREEN
},
99 { "back-scroll", A_B_SCROLL
},
100 { "back-search", A_B_SEARCH
},
101 { "back-window", A_B_WINDOW
},
102 { "clear-mark", A_CLRMARK
},
103 { "debug", A_DEBUG
},
104 { "digit", A_DIGIT
},
105 { "display-flag", A_DISP_OPTION
},
106 { "display-option", A_DISP_OPTION
},
108 { "end-scroll", A_RRSHIFT
},
109 { "examine", A_EXAMINE
},
110 { "filter", A_FILTER
},
111 { "first-cmd", A_FIRSTCMD
},
112 { "firstcmd", A_FIRSTCMD
},
113 { "flush-repaint", A_FREPAINT
},
114 { "forw-bracket", A_F_BRACKET
},
115 { "forw-forever", A_F_FOREVER
},
116 { "forw-until-hilite", A_F_UNTIL_HILITE
},
117 { "forw-line", A_F_LINE
},
118 { "forw-line-force", A_FF_LINE
},
119 { "forw-screen", A_F_SCREEN
},
120 { "forw-screen-force", A_FF_SCREEN
},
121 { "forw-scroll", A_F_SCROLL
},
122 { "forw-search", A_F_SEARCH
},
123 { "forw-window", A_F_WINDOW
},
124 { "goto-end", A_GOEND
},
125 { "goto-end-buffered", A_GOEND_BUF
},
126 { "goto-line", A_GOLINE
},
127 { "goto-mark", A_GOMARK
},
129 { "index-file", A_INDEX_FILE
},
130 { "invalid", A_UINVALID
},
131 { "left-scroll", A_LSHIFT
},
132 { "next-file", A_NEXT_FILE
},
133 { "next-tag", A_NEXT_TAG
},
134 { "noaction", A_NOACTION
},
135 { "no-scroll", A_LLSHIFT
},
136 { "percent", A_PERCENT
},
138 { "prev-file", A_PREV_FILE
},
139 { "prev-tag", A_PREV_TAG
},
141 { "remove-file", A_REMOVE_FILE
},
142 { "repaint", A_REPAINT
},
143 { "repaint-flush", A_FREPAINT
},
144 { "repeat-search", A_AGAIN_SEARCH
},
145 { "repeat-search-all", A_T_AGAIN_SEARCH
},
146 { "reverse-search", A_REVERSE_SEARCH
},
147 { "reverse-search-all", A_T_REVERSE_SEARCH
},
148 { "right-scroll", A_RSHIFT
},
149 { "set-mark", A_SETMARK
},
150 { "set-mark-bottom", A_SETMARKBOT
},
151 { "shell", A_SHELL
},
152 { "status", A_STAT
},
153 { "toggle-flag", A_OPT_TOGGLE
},
154 { "toggle-option", A_OPT_TOGGLE
},
155 { "undo-hilite", A_UNDO_SEARCH
},
156 { "version", A_VERSION
},
157 { "visual", A_VISUAL
},
161 struct cmdname editnames
[] =
163 { "back-complete", EC_B_COMPLETE
},
164 { "backspace", EC_BACKSPACE
},
165 { "delete", EC_DELETE
},
168 { "expand", EC_EXPAND
},
169 { "forw-complete", EC_F_COMPLETE
},
171 { "insert", EC_INSERT
},
172 { "invalid", EC_UINVALID
},
173 { "kill-line", EC_LINEKILL
},
174 { "abort", EC_ABORT
},
176 { "literal", EC_LITERAL
},
177 { "right", EC_RIGHT
},
179 { "word-backspace", EC_W_BACKSPACE
},
180 { "word-delete", EC_W_DELETE
},
181 { "word-left", EC_W_LEFT
},
182 { "word-right", EC_W_RIGHT
},
188 struct cmdname
*names
;
190 char buffer
[MAX_USERCMD
];
193 struct table cmdtable
;
194 struct table edittable
;
195 struct table vartable
;
196 struct table
*currtable
= &cmdtable
;
198 char fileheader
[] = {
204 char filetrailer
[] = {
205 C0_END_LESSKEY_MAGIC
,
206 C1_END_LESSKEY_MAGIC
,
209 char cmdsection
[1] = { CMD_SECTION
};
210 char editsection
[1] = { EDIT_SECTION
};
211 char varsection
[1] = { VAR_SECTION
};
212 char endsection
[1] = { END_SECTION
};
215 char *outfile
= NULL
;
220 extern char version
[];
225 fprintf(stderr
, "usage: lesskey [-o output] [input]\n");
230 mkpathname(dirname
, filename
)
236 pathname
= calloc(strlen(dirname
) + strlen(filename
) + 2, sizeof(char));
237 strcpy(pathname
, dirname
);
238 strcat(pathname
, PATHNAME_SEP
);
239 strcat(pathname
, filename
);
244 * Figure out the name of a default file (in the user's HOME directory).
253 if ((p
= getenv("HOME")) != NULL
&& *p
!= '\0')
254 pathname
= mkpathname(p
, filename
);
256 else if ((p
= getenv("INIT")) != NULL
&& *p
!= '\0')
257 pathname
= mkpathname(p
, filename
);
261 fprintf(stderr
, "cannot find $HOME - using current directory\n");
262 pathname
= mkpathname(".", filename
);
268 * Parse command line arguments.
271 parse_args(argc
, argv
)
282 /* Arg does not start with "-"; it's not an option. */
285 /* "-" means standard input. */
287 if (arg
[1] == '-' && arg
[2] == '\0')
289 /* "--" means end of options. */
297 if (strncmp(arg
, "--output", 8) == 0)
301 else if (arg
[8] == '=')
307 if (strcmp(arg
, "--version") == 0)
314 outfile
= &argv
[0][2];
316 if (*outfile
== '\0')
325 printf("lesskey version %s\n", version
);
334 * Open the input file, or use DEF_LESSKEYINFILE if none specified.
339 infile
= homefile(DEF_LESSKEYINFILE
);
343 * Initialize data structures.
346 init_tables(VOID_PARAM
)
348 cmdtable
.names
= cmdnames
;
349 cmdtable
.pbuffer
= cmdtable
.buffer
;
351 edittable
.names
= editnames
;
352 edittable
.pbuffer
= edittable
.buffer
;
354 vartable
.names
= NULL
;
355 vartable
.pbuffer
= vartable
.buffer
;
359 * Parse one character of a string.
370 static char tstr_control_k
[] =
371 { SK_SPECIAL_KEY
, SK_CONTROL_K
, 6, 1, 1, 1, '\0' };
380 case '0': case '1': case '2': case '3':
381 case '4': case '5': case '6': case '7':
383 * Parse an octal number.
388 ch
= 8*ch
+ (*p
- '0');
389 while (*++p
>= '0' && *p
<= '7' && ++i
< 3);
391 if (xlate
&& ch
== CONTROL('K'))
392 return tstr_control_k
;
418 case 'u': ch
= SK_UP_ARROW
; break;
419 case 'd': ch
= SK_DOWN_ARROW
; break;
420 case 'r': ch
= SK_RIGHT_ARROW
; break;
421 case 'l': ch
= SK_LEFT_ARROW
; break;
422 case 'U': ch
= SK_PAGE_UP
; break;
423 case 'D': ch
= SK_PAGE_DOWN
; break;
424 case 'h': ch
= SK_HOME
; break;
425 case 'e': ch
= SK_END
; break;
426 case 'x': ch
= SK_DELETE
; break;
428 error("illegal char after \\k", NULL_PARG
);
433 buf
[0] = SK_SPECIAL_KEY
;
445 * Backslash followed by any other char
446 * just means that char.
451 if (xlate
&& buf
[0] == CONTROL('K'))
452 return tstr_control_k
;
457 * Caret means CONTROL.
460 buf
[0] = CONTROL(p
[1]);
462 if (buf
[0] == CONTROL('K'))
463 return tstr_control_k
;
469 if (xlate
&& buf
[0] == CONTROL('K'))
470 return tstr_control_k
;
475 * Skip leading spaces in a string.
481 while (*s
== ' ' || *s
== '\t')
487 * Skip non-space characters in a string.
493 while (*s
!= '\0' && *s
!= ' ' && *s
!= '\t')
499 * Clean up an input line:
500 * strip off the trailing newline & any trailing # comment.
509 for (i
= 0; s
[i
] != '\n' && s
[i
] != '\r' && s
[i
] != '\0'; i
++)
510 if (s
[i
] == '#' && (i
== 0 || s
[i
-1] != '\\'))
517 * Add a byte to the output command table.
523 if (currtable
->pbuffer
>= currtable
->buffer
+ MAX_USERCMD
)
525 error("too many commands", NULL_PARG
);
528 *(currtable
->pbuffer
)++ = c
;
532 * Add a string to the output command table.
538 for ( ; *s
!= '\0'; s
++)
543 * See if we have a special "control" line.
549 #define PREFIX(str,pat) (strncmp(str,pat,strlen(pat)) == 0)
551 if (PREFIX(s
, "#line-edit"))
553 currtable
= &edittable
;
556 if (PREFIX(s
, "#command"))
558 currtable
= &cmdtable
;
561 if (PREFIX(s
, "#env"))
563 currtable
= &vartable
;
566 if (PREFIX(s
, "#stop"))
569 add_cmd_char(A_END_LIST
);
579 fputbytes(fd
, buf
, len
)
586 fwrite(buf
, sizeof(char), 1, fd
);
592 * Output an integer, in special KRADIX form.
601 if (val
>= KRADIX
*KRADIX
)
603 fprintf(stderr
, "error: integer too big (%d > %d)\n",
608 fwrite(&c
, sizeof(char), 1, fd
);
610 fwrite(&c
, sizeof(char), 1, fd
);
614 * Find an action, given the name of the action.
622 for (i
= 0; currtable
->names
[i
].cn_name
!= NULL
; i
++)
623 if (strcmp(currtable
->names
[i
].cn_name
, actname
) == 0)
624 return (currtable
->names
[i
].cn_action
);
625 error("unknown action", NULL_PARG
);
634 fprintf(stderr
, "line %d: %s\n", linenum
, s
);
651 * Parse the command string and store it in the current table.
657 cmdlen
+= (int) strlen(s
);
658 if (cmdlen
> MAX_CMDLEN
)
659 error("command too long", NULL_PARG
);
662 } while (*p
!= ' ' && *p
!= '\t' && *p
!= '\0');
664 * Terminate the command string with a null byte.
669 * Skip white space between the command string
670 * and the action name.
671 * Terminate the action name with a null byte.
676 error("missing action", NULL_PARG
);
685 * Parse the action name and store it in the current table.
687 action
= findaction(actname
);
690 * See if an extra string follows the action name.
696 add_cmd_char(action
);
700 * OR the special value A_EXTRA into the action byte.
701 * Put the extra string after the action byte.
703 add_cmd_char(action
| A_EXTRA
);
705 add_cmd_str(tstr(&p
, 0));
720 } while (*p
!= ' ' && *p
!= '\t' && *p
!= '=' && *p
!= '\0');
722 * Terminate the variable name with a null byte.
729 error("missing =", NULL_PARG
);
733 add_cmd_char(EV_OK
|A_EXTRA
);
745 * Parse a line from the lesskey file.
754 * See if it is a control line.
756 if (control_line(line
))
759 * Skip leading white space.
760 * Replace the final newline with a null byte.
761 * Ignore blank lines and comments.
763 p
= clean_line(line
);
767 if (currtable
== &vartable
)
783 if (getenv("HOME") == NULL
)
786 * If there is no HOME environment variable,
787 * try the concatenation of HOMEDRIVE + HOMEPATH.
789 char *drive
= getenv("HOMEDRIVE");
790 char *path
= getenv("HOMEPATH");
791 if (drive
!= NULL
&& path
!= NULL
)
793 char *env
= (char *) calloc(strlen(drive
) +
794 strlen(path
) + 6, sizeof(char));
795 strcpy(env
, "HOME=");
804 * Process command line arguments.
806 parse_args(argc
, argv
);
810 * Open the input file.
812 if (strcmp(infile
, "-") == 0)
814 else if ((desc
= fopen(infile
, "r")) == NULL
)
819 fprintf(stderr
, "Cannot open %s\n", infile
);
825 * Read and parse the input file, one line at a time.
829 while (fgets(line
, sizeof(line
), desc
) != NULL
)
836 * Write the output file.
837 * If no output file was specified, use "$HOME/.less"
841 fprintf(stderr
, "%d errors; no output produced\n", errors
);
846 outfile
= getenv("LESSKEY");
848 outfile
= homefile(LESSKEYFILE
);
849 if ((out
= fopen(outfile
, "wb")) == NULL
)
854 fprintf(stderr
, "Cannot open %s\n", outfile
);
860 fputbytes(out
, fileheader
, sizeof(fileheader
));
862 /* Command key section */
863 fputbytes(out
, cmdsection
, sizeof(cmdsection
));
864 fputint(out
, cmdtable
.pbuffer
- cmdtable
.buffer
);
865 fputbytes(out
, (char *)cmdtable
.buffer
, cmdtable
.pbuffer
-cmdtable
.buffer
);
866 /* Edit key section */
867 fputbytes(out
, editsection
, sizeof(editsection
));
868 fputint(out
, edittable
.pbuffer
- edittable
.buffer
);
869 fputbytes(out
, (char *)edittable
.buffer
, edittable
.pbuffer
-edittable
.buffer
);
871 /* Environment variable section */
872 fputbytes(out
, varsection
, sizeof(varsection
));
873 fputint(out
, vartable
.pbuffer
- vartable
.buffer
);
874 fputbytes(out
, (char *)vartable
.buffer
, vartable
.pbuffer
-vartable
.buffer
);
877 fputbytes(out
, endsection
, sizeof(endsection
));
878 fputbytes(out
, filetrailer
, sizeof(filetrailer
));