2 * Copyright notice from original mutt:
3 * Copyright (C) 1996-2000 Michael R. Elkins <me@mutt.org>
5 * This file is part of mutt-ng, see http://www.muttng.org/.
6 * It's licensed under the GNU General Public License,
7 * please see the file GPL in the top level source directory.
17 #include "mutt_curses.h"
25 static struct binding_t *help_lookupFunction (int op, int menu)
28 struct binding_t *map;
30 if (menu != MENU_PAGER) {
31 /* first look in the generic map for the function */
32 for (i = 0; OpGeneric[i].name; i++)
33 if (OpGeneric[i].op == op)
34 return (&OpGeneric[i]);
37 if ((map = km_get_table (menu))) {
38 for (i = 0; map[i].name; i++)
46 void mutt_make_help (char *d, size_t dlen, char *txt, int menu, int op)
48 char buf[SHORT_STRING];
50 if (km_expand_key (buf, sizeof (buf), km_find_func (menu, op)) ||
51 km_expand_key (buf, sizeof (buf), km_find_func (MENU_GENERIC, op)))
52 snprintf (d, dlen, "%s:%s", buf, txt);
57 char *mutt_compile_help (char *buf, size_t buflen, int menu,
58 struct mapping_t *items)
64 for (i = 0; items[i].name && buflen > 2; i++) {
70 mutt_make_help (pbuf, buflen, _(items[i].name), menu, items[i].value);
71 len = mutt_strlen (pbuf);
78 static int print_macro (FILE * f, int maxwidth, const char **macro)
84 size_t len = mutt_strlen (*macro);
85 mbstate_t mbstate1, mbstate2;
87 memset (&mbstate1, 0, sizeof (mbstate1));
88 memset (&mbstate2, 0, sizeof (mbstate2));
89 for (; len && (k = mbrtowc (&wc, *macro, len, &mbstate1));
90 *macro += k, len -= k) {
91 if (k == (size_t) (-1) || k == (size_t) (-2)) {
92 k = (k == (size_t) (-1)) ? 1 : len;
93 wc = replacement_char ();
95 /* glibc-2.1.3's wcwidth() returns 1 for unprintable chars! */
96 if (IsWPrint (wc) && (w = wcwidth (wc)) >= 0) {
101 char buf[MB_LEN_MAX * 2];
104 if ((n1 = wcrtomb (buf, wc, &mbstate2)) != (size_t) (-1) &&
105 (n2 = wcrtomb (buf + n1, 0, &mbstate2)) != (size_t) (-1))
109 else if (wc < 0x20 || wc == 0x7f) {
122 fprintf (f, "^%c", (char) ((wc + '@') & 0x7f));
131 return (maxwidth - n);
134 static int pad (FILE * f, int col, int i)
139 snprintf (fmt, sizeof (fmt), "%%-%ds", i - col);
140 fprintf (f, fmt, "");
147 static void format_line (FILE * f, int ismacro,
148 const char *t1, const char *t2, const char *t3)
157 /* don't try to press string into one line with less than 40 characters.
158 The double paranthesis avoid a gcc warning, sigh ... */
159 if ((split = COLS < 40)) {
165 col_a = COLS > 83 ? (COLS - 32) >> 2 : 12;
166 col_b = COLS > 49 ? (COLS - 10) >> 1 : 19;
167 col = pad (f, mutt_strlen (t1), col_a);
171 if (!mutt_strcmp (Pager, "builtin"))
177 col += print_macro (f, col_b - col - 4, &t2);
178 if (mutt_strlen (t2) > col_b - col)
183 col += print_macro (f, col_b - col - 1, &t2);
187 col = pad (f, col, col_b);
190 print_macro (f, LONG_STRING, &t3);
200 /* FIXME: this is completely wrong */
201 if ((n = mutt_strlen (t3)) > COLS - col) {
203 for (col_a = n; col_a > 0 && t3[col_a] != ' '; col_a--);
209 print_macro (f, n, &t3);
212 if (mutt_strcmp (Pager, "builtin")) {
218 if (option (OPTMARKERS))
221 col = pad (f, n, col_b);
229 static void dump_menu (FILE * f, int menu)
231 struct keymap_t *map;
233 char buf[SHORT_STRING];
235 /* browse through the keymap table */
236 for (map = Keymaps[menu]; map; map = map->next) {
237 if (map->op != OP_NULL) {
238 km_expand_key (buf, sizeof (buf), map);
240 if (map->op == OP_MACRO) {
241 if (map->descr == NULL)
242 format_line (f, -1, buf, "macro", map->macro);
244 format_line (f, 1, buf, map->macro, map->descr);
247 b = help_lookupFunction (map->op, menu);
248 format_line (f, 0, buf, b ? b->name : "UNKNOWN",
249 b ? _(HelpStrings[b->op]) :
250 _("ERROR: please report this bug"));
256 static int is_bound (struct keymap_t *map, int op)
258 for (; map; map = map->next)
264 static void dump_unbound (FILE * f,
265 struct binding_t *funcs,
266 struct keymap_t *map, struct keymap_t *aux)
270 for (i = 0; funcs[i].name; i++) {
271 if (!is_bound (map, funcs[i].op) &&
272 (!aux || !is_bound (aux, funcs[i].op)))
273 format_line (f, 0, funcs[i].name, "", _(HelpStrings[funcs[i].op]));
277 void mutt_help (int menu)
279 char t[_POSIX_PATH_MAX];
280 char buf[SHORT_STRING];
283 struct binding_t *funcs;
287 funcs = km_get_table (menu);
288 desc = mutt_getnamebyvalue (menu, Menus);
290 desc = _("<UNKNOWN>");
293 if ((f = safe_fopen (t, "w")) == NULL) {
299 if (menu != MENU_EDITOR && menu != MENU_PAGER) {
300 fputs (_("\nGeneric bindings:\n\n"), f);
301 dump_menu (f, MENU_GENERIC);
304 fputs (_("\nUnbound functions:\n\n"), f);
306 dump_unbound (f, funcs, Keymaps[menu], NULL);
307 if (menu != MENU_PAGER)
308 dump_unbound (f, OpGeneric, Keymaps[MENU_GENERIC], Keymaps[menu]);
312 snprintf (buf, sizeof (buf), _("Help for %s"), desc);
315 (mutt_do_pager (buf, t,
316 M_PAGER_RETWINCH | M_PAGER_MARKER | M_PAGER_NSKIP, NULL)
317 == OP_REFORMAT_WINCH);