1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325
|
/* Copyright (c) 2006-2025 Jonas Fonseca <jonas.fonseca@gmail.com>
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License as
* published by the Free Software Foundation; either version 2 of
* the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*/
#include "tig/argv.h"
#include "tig/view.h"
#include "tig/search.h"
#include "tig/prompt.h"
#include "tig/draw.h"
extern const struct menu_item toggle_menu_items[];
static const char collapse_expand_names[2][13] = {
"Collapse all",
"Expand all"
};
static struct keymap collapse_expand_keymap = {
collapse_expand_names[0], NULL, 0, false
};
static struct keymap toggle_menu_keymap = {
"toggle", NULL, 0, false
};
/*
* Help backend
*/
struct help_state {
int keys_width;
int name_width;
};
struct help {
enum request request;
union {
struct keymap *keymap;
struct menu_item *menu;
} item;
union {
const char *text;
const struct request_info *req_info;
} data;
};
static bool
help_draw(struct view *view, struct line *line, unsigned int lineno)
{
struct help *help = line->data;
const struct keymap *keymap = help->item.keymap;
struct help_state *state = view->private;
if (line->type == LINE_SECTION) {
draw_formatted(view, line->type, "[%c] %s %s",
keymap->hidden ? '+' : '-', keymap->name,
keymap == &collapse_expand_keymap ? "sections" : "bindings");
} else if (line->type == LINE_HELP_GROUP || !keymap) {
draw_text(view, line->type, help->data.text);
} else if (line->type == LINE_HELP_TOGGLE) {
struct menu_item *item = help->item.menu;
char key[2];
if (!string_nformat(key, sizeof(key), NULL, "%c", item->hotkey))
return true;
if (draw_field(view, LINE_DEFAULT, key, state->keys_width + 2, ALIGN_RIGHT, false))
return true;
if (draw_field(view, LINE_HELP_ACTION, item->data, state->name_width, ALIGN_LEFT, false))
return true;
draw_formatted(view, LINE_DEFAULT, "Toggle %s", item->text);
} else if (help->request > REQ_RUN_REQUESTS) {
struct run_request *req = get_run_request(help->request);
const char *key = get_keys(keymap, help->request, true);
const char *sep = format_run_request_flags(req);
int i;
if (draw_field(view, LINE_DEFAULT, key, state->keys_width + 2, ALIGN_RIGHT, false))
return true;
for (i = 0; req->argv[i]; i++) {
if (draw_formatted(view, LINE_HELP_ACTION, "%s%s", sep, req->argv[i]))
return true;
sep = " ";
}
} else {
const struct request_info *req_info = help->data.req_info;
const char *key = get_keys(keymap, req_info->request, true);
if (draw_field(view, LINE_DEFAULT, key, state->keys_width + 2, ALIGN_RIGHT, false))
return true;
if (draw_field(view, LINE_HELP_ACTION, enum_name(req_info->name), state->name_width, ALIGN_LEFT, false))
return true;
draw_text(view, LINE_DEFAULT, req_info->help);
}
return true;
}
static bool
help_grep(struct view *view, struct line *line)
{
struct help *help = line->data;
const struct keymap *keymap = help->item.keymap;
if (line->type == LINE_SECTION) {
const char *text[] = { keymap->name, NULL };
return grep_text(view, text);
} else if (line->type == LINE_HELP_GROUP || !keymap) {
const char *text[] = { help->data.text, NULL };
return grep_text(view, text);
} else if (line->type == LINE_HELP_TOGGLE) {
char key[2];
const char *text[] = { key, help->item.menu->data, "Toggle", help->item.menu->text, NULL };
if (!string_nformat(key, sizeof(key), NULL, "%c", help->item.menu->hotkey))
return false;
return grep_text(view, text);
} else if (help->request > REQ_RUN_REQUESTS) {
struct run_request *req = get_run_request(help->request);
const char *key = get_keys(keymap, help->request, true);
char buf[SIZEOF_STR] = "";
const char *text[] = { key, buf, NULL };
if (!argv_to_string(req->argv, buf, sizeof(buf), " "))
return false;
return grep_text(view, text);
} else {
const struct request_info *req_info = help->data.req_info;
const char *key = get_keys(keymap, req_info->request, true);
const char *text[] = { key, enum_name(req_info->name), req_info->help, NULL };
return grep_text(view, text);
}
}
struct help_request_iterator {
struct view *view;
struct keymap *keymap;
};
static bool
add_help_line(struct view *view, struct help **help_ptr, struct keymap *keymap, enum line_type type)
{
struct help *help;
if (!add_line_alloc(view, &help, type, 0, false))
return false;
help->item.keymap = keymap;
if (help_ptr)
*help_ptr = help;
return true;
}
static bool
help_keys_visitor(void *data, const char *group, struct keymap *keymap,
enum request request, const char *key,
const struct request_info *req_info, const struct run_request *run_req)
{
struct help_request_iterator *iterator = data;
struct view *view = iterator->view;
struct help_state *state = view->private;
struct help *help;
if (iterator->keymap != keymap) {
iterator->keymap = keymap;
if (!add_help_line(view, &help, keymap, LINE_SECTION))
return false;
}
if (keymap->hidden)
return true;
if (group) {
if (!add_help_line(view, &help, keymap, LINE_HELP_GROUP))
return false;
help->data.text = group;
}
if (!add_help_line(view, &help, keymap, LINE_DEFAULT))
return false;
state->keys_width = MAX(state->keys_width, strlen(key));
help->request = request;
if (req_info) {
state->name_width = MAX(state->name_width, strlen(enum_name(req_info->name)));
help->data.req_info = req_info;
}
return true;
}
static bool
help_collapse_expand_keys_visitor(void *data, const char *group, struct keymap *keymap,
enum request request, const char *key,
const struct request_info *req_info, const struct run_request *run_req)
{
struct help_request_iterator *iterator = data;
if (iterator->keymap != keymap) {
iterator->keymap = keymap;
keymap->hidden = collapse_expand_keymap.hidden;
}
return true;
}
static enum status_code
help_open(struct view *view, enum open_flags flags)
{
struct help_request_iterator iterator = { view };
struct help_state *state = view->private;
struct help *help;
reset_view(view);
if (!add_help_line(view, &help, NULL, LINE_HEADER))
return ERROR_OUT_OF_MEMORY;
help->data.text = "Quick reference for tig keybindings:";
if (!add_help_line(view, &help, &collapse_expand_keymap, LINE_SECTION))
return ERROR_OUT_OF_MEMORY;
if (!add_help_line(view, &help, NULL, LINE_DEFAULT))
return ERROR_OUT_OF_MEMORY;
help->data.text = "";
if (!foreach_key(help_keys_visitor, &iterator, true))
return error("Failed to render key bindings");
if (!add_help_line(view, &help, &toggle_menu_keymap, LINE_SECTION))
return ERROR_OUT_OF_MEMORY;
if (!toggle_menu_keymap.hidden) {
int i;
if (!add_help_line(view, &help, NULL, LINE_HELP_GROUP))
return ERROR_OUT_OF_MEMORY;
help->data.text = "Toggle keys (enter: o <key>):";
for (i = 0; toggle_menu_items[i].data; i++) {
state->name_width = MAX(state->name_width, strlen(toggle_menu_items[i].data));
if (!add_help_line(view, &help, (struct keymap *)&toggle_menu_items[i], LINE_HELP_TOGGLE))
return ERROR_OUT_OF_MEMORY;
}
}
return SUCCESS;
}
static enum request
help_request(struct view *view, enum request request, struct line *line)
{
struct help *help = line->data;
switch (request) {
case REQ_ENTER:
if (line->type == LINE_SECTION) {
struct keymap *keymap = help->item.keymap;
keymap->hidden = !keymap->hidden;
if (keymap == &collapse_expand_keymap) {
struct help_request_iterator iterator = { view };
collapse_expand_keymap.name = collapse_expand_names[keymap->hidden];
foreach_key(help_collapse_expand_keys_visitor, &iterator, true);
toggle_menu_keymap.hidden = keymap->hidden;
}
refresh_view(view);
}
return REQ_NONE;
case REQ_REFRESH:
refresh_view(view);
return REQ_NONE;
default:
return request;
}
}
static void
help_select(struct view *view, struct line *line)
{
}
static struct view_ops help_ops = {
"line",
"",
VIEW_NO_GIT_DIR | VIEW_REFRESH,
sizeof(struct help_state),
help_open,
NULL,
help_draw,
help_request,
help_grep,
help_select,
NULL,
};
DEFINE_VIEW(help);
/* vim: set ts=8 sw=8 noexpandtab: */
|