| 1 | /* Line completion stuff for GDB, the GNU debugger. |
| 2 | Copyright (C) 2000-2017 Free Software Foundation, Inc. |
| 3 | |
| 4 | This file is part of GDB. |
| 5 | |
| 6 | This program is free software; you can redistribute it and/or modify |
| 7 | it under the terms of the GNU General Public License as published by |
| 8 | the Free Software Foundation; either version 3 of the License, or |
| 9 | (at your option) any later version. |
| 10 | |
| 11 | This program is distributed in the hope that it will be useful, |
| 12 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 14 | GNU General Public License for more details. |
| 15 | |
| 16 | You should have received a copy of the GNU General Public License |
| 17 | along with this program. If not, see <http://www.gnu.org/licenses/>. */ |
| 18 | |
| 19 | #include "defs.h" |
| 20 | #include "symtab.h" |
| 21 | #include "gdbtypes.h" |
| 22 | #include "expression.h" |
| 23 | #include "filenames.h" /* For DOSish file names. */ |
| 24 | #include "language.h" |
| 25 | #include "gdb_signals.h" |
| 26 | #include "target.h" |
| 27 | #include "reggroups.h" |
| 28 | #include "user-regs.h" |
| 29 | #include "arch-utils.h" |
| 30 | #include "location.h" |
| 31 | #include <algorithm> |
| 32 | #include "linespec.h" |
| 33 | #include "cli/cli-decode.h" |
| 34 | |
| 35 | /* FIXME: This is needed because of lookup_cmd_1 (). We should be |
| 36 | calling a hook instead so we eliminate the CLI dependency. */ |
| 37 | #include "gdbcmd.h" |
| 38 | |
| 39 | /* Needed for rl_completer_word_break_characters() and for |
| 40 | rl_filename_completion_function. */ |
| 41 | #include "readline/readline.h" |
| 42 | |
| 43 | /* readline defines this. */ |
| 44 | #undef savestring |
| 45 | |
| 46 | #include "completer.h" |
| 47 | |
| 48 | /* Misc state that needs to be tracked across several different |
| 49 | readline completer entry point calls, all related to a single |
| 50 | completion invocation. */ |
| 51 | |
| 52 | struct gdb_completer_state |
| 53 | { |
| 54 | /* The current completion's completion tracker. This is a global |
| 55 | because a tracker can be shared between the handle_brkchars and |
| 56 | handle_completion phases, which involves different readline |
| 57 | callbacks. */ |
| 58 | completion_tracker *tracker = NULL; |
| 59 | |
| 60 | /* Whether the current completion was aborted. */ |
| 61 | bool aborted = false; |
| 62 | }; |
| 63 | |
| 64 | /* The current completion state. */ |
| 65 | static gdb_completer_state current_completion; |
| 66 | |
| 67 | /* An enumeration of the various things a user might attempt to |
| 68 | complete for a location. If you change this, remember to update |
| 69 | the explicit_options array below too. */ |
| 70 | |
| 71 | enum explicit_location_match_type |
| 72 | { |
| 73 | /* The filename of a source file. */ |
| 74 | MATCH_SOURCE, |
| 75 | |
| 76 | /* The name of a function or method. */ |
| 77 | MATCH_FUNCTION, |
| 78 | |
| 79 | /* A line number. */ |
| 80 | MATCH_LINE, |
| 81 | |
| 82 | /* The name of a label. */ |
| 83 | MATCH_LABEL |
| 84 | }; |
| 85 | |
| 86 | /* Prototypes for local functions. */ |
| 87 | |
| 88 | /* readline uses the word breaks for two things: |
| 89 | (1) In figuring out where to point the TEXT parameter to the |
| 90 | rl_completion_entry_function. Since we don't use TEXT for much, |
| 91 | it doesn't matter a lot what the word breaks are for this purpose, |
| 92 | but it does affect how much stuff M-? lists. |
| 93 | (2) If one of the matches contains a word break character, readline |
| 94 | will quote it. That's why we switch between |
| 95 | current_language->la_word_break_characters() and |
| 96 | gdb_completer_command_word_break_characters. I'm not sure when |
| 97 | we need this behavior (perhaps for funky characters in C++ |
| 98 | symbols?). */ |
| 99 | |
| 100 | /* Variables which are necessary for fancy command line editing. */ |
| 101 | |
| 102 | /* When completing on command names, we remove '-' from the list of |
| 103 | word break characters, since we use it in command names. If the |
| 104 | readline library sees one in any of the current completion strings, |
| 105 | it thinks that the string needs to be quoted and automatically |
| 106 | supplies a leading quote. */ |
| 107 | static const char gdb_completer_command_word_break_characters[] = |
| 108 | " \t\n!@#$%^&*()+=|~`}{[]\"';:?/>.<,"; |
| 109 | |
| 110 | /* When completing on file names, we remove from the list of word |
| 111 | break characters any characters that are commonly used in file |
| 112 | names, such as '-', '+', '~', etc. Otherwise, readline displays |
| 113 | incorrect completion candidates. */ |
| 114 | /* MS-DOS and MS-Windows use colon as part of the drive spec, and most |
| 115 | programs support @foo style response files. */ |
| 116 | static const char gdb_completer_file_name_break_characters[] = |
| 117 | #ifdef HAVE_DOS_BASED_FILE_SYSTEM |
| 118 | " \t\n*|\"';?><@"; |
| 119 | #else |
| 120 | " \t\n*|\"';:?><"; |
| 121 | #endif |
| 122 | |
| 123 | /* Characters that can be used to quote completion strings. Note that |
| 124 | we can't include '"' because the gdb C parser treats such quoted |
| 125 | sequences as strings. */ |
| 126 | static const char gdb_completer_quote_characters[] = "'"; |
| 127 | \f |
| 128 | /* Accessor for some completer data that may interest other files. */ |
| 129 | |
| 130 | const char * |
| 131 | get_gdb_completer_quote_characters (void) |
| 132 | { |
| 133 | return gdb_completer_quote_characters; |
| 134 | } |
| 135 | |
| 136 | /* This can be used for functions which don't want to complete on |
| 137 | symbols but don't want to complete on anything else either. */ |
| 138 | |
| 139 | void |
| 140 | noop_completer (struct cmd_list_element *ignore, |
| 141 | completion_tracker &tracker, |
| 142 | const char *text, const char *prefix) |
| 143 | { |
| 144 | } |
| 145 | |
| 146 | /* Complete on filenames. */ |
| 147 | |
| 148 | void |
| 149 | filename_completer (struct cmd_list_element *ignore, |
| 150 | completion_tracker &tracker, |
| 151 | const char *text, const char *word) |
| 152 | { |
| 153 | int subsequent_name; |
| 154 | VEC (char_ptr) *return_val = NULL; |
| 155 | |
| 156 | subsequent_name = 0; |
| 157 | while (1) |
| 158 | { |
| 159 | char *p, *q; |
| 160 | |
| 161 | p = rl_filename_completion_function (text, subsequent_name); |
| 162 | if (p == NULL) |
| 163 | break; |
| 164 | /* We need to set subsequent_name to a non-zero value before the |
| 165 | continue line below, because otherwise, if the first file |
| 166 | seen by GDB is a backup file whose name ends in a `~', we |
| 167 | will loop indefinitely. */ |
| 168 | subsequent_name = 1; |
| 169 | /* Like emacs, don't complete on old versions. Especially |
| 170 | useful in the "source" command. */ |
| 171 | if (p[strlen (p) - 1] == '~') |
| 172 | { |
| 173 | xfree (p); |
| 174 | continue; |
| 175 | } |
| 176 | |
| 177 | if (word == text) |
| 178 | /* Return exactly p. */ |
| 179 | q = p; |
| 180 | else if (word > text) |
| 181 | { |
| 182 | /* Return some portion of p. */ |
| 183 | q = (char *) xmalloc (strlen (p) + 5); |
| 184 | strcpy (q, p + (word - text)); |
| 185 | xfree (p); |
| 186 | } |
| 187 | else |
| 188 | { |
| 189 | /* Return some of TEXT plus p. */ |
| 190 | q = (char *) xmalloc (strlen (p) + (text - word) + 5); |
| 191 | strncpy (q, word, text - word); |
| 192 | q[text - word] = '\0'; |
| 193 | strcat (q, p); |
| 194 | xfree (p); |
| 195 | } |
| 196 | tracker.add_completion (gdb::unique_xmalloc_ptr<char> (q)); |
| 197 | } |
| 198 | #if 0 |
| 199 | /* There is no way to do this just long enough to affect quote |
| 200 | inserting without also affecting the next completion. This |
| 201 | should be fixed in readline. FIXME. */ |
| 202 | /* Ensure that readline does the right thing |
| 203 | with respect to inserting quotes. */ |
| 204 | rl_completer_word_break_characters = ""; |
| 205 | #endif |
| 206 | } |
| 207 | |
| 208 | /* The corresponding completer_handle_brkchars |
| 209 | implementation. */ |
| 210 | |
| 211 | static void |
| 212 | filename_completer_handle_brkchars (struct cmd_list_element *ignore, |
| 213 | completion_tracker &tracker, |
| 214 | const char *text, const char *word) |
| 215 | { |
| 216 | set_rl_completer_word_break_characters |
| 217 | (gdb_completer_file_name_break_characters); |
| 218 | } |
| 219 | |
| 220 | /* Possible values for the found_quote flags word used by the completion |
| 221 | functions. It says what kind of (shell-like) quoting we found anywhere |
| 222 | in the line. */ |
| 223 | #define RL_QF_SINGLE_QUOTE 0x01 |
| 224 | #define RL_QF_DOUBLE_QUOTE 0x02 |
| 225 | #define RL_QF_BACKSLASH 0x04 |
| 226 | #define RL_QF_OTHER_QUOTE 0x08 |
| 227 | |
| 228 | /* Find the bounds of the current word for completion purposes, and |
| 229 | return a pointer to the end of the word. This mimics (and is a |
| 230 | modified version of) readline's _rl_find_completion_word internal |
| 231 | function. |
| 232 | |
| 233 | This function skips quoted substrings (characters between matched |
| 234 | pairs of characters in rl_completer_quote_characters). We try to |
| 235 | find an unclosed quoted substring on which to do matching. If one |
| 236 | is not found, we use the word break characters to find the |
| 237 | boundaries of the current word. QC, if non-null, is set to the |
| 238 | opening quote character if we found an unclosed quoted substring, |
| 239 | '\0' otherwise. DP, if non-null, is set to the value of the |
| 240 | delimiter character that caused a word break. */ |
| 241 | |
| 242 | struct gdb_rl_completion_word_info |
| 243 | { |
| 244 | const char *word_break_characters; |
| 245 | const char *quote_characters; |
| 246 | const char *basic_quote_characters; |
| 247 | }; |
| 248 | |
| 249 | static const char * |
| 250 | gdb_rl_find_completion_word (struct gdb_rl_completion_word_info *info, |
| 251 | int *qc, int *dp, |
| 252 | const char *line_buffer) |
| 253 | { |
| 254 | int scan, end, found_quote, delimiter, pass_next, isbrk; |
| 255 | char quote_char; |
| 256 | const char *brkchars; |
| 257 | int point = strlen (line_buffer); |
| 258 | |
| 259 | /* The algorithm below does '--point'. Avoid buffer underflow with |
| 260 | the empty string. */ |
| 261 | if (point == 0) |
| 262 | { |
| 263 | if (qc != NULL) |
| 264 | *qc = '\0'; |
| 265 | if (dp != NULL) |
| 266 | *dp = '\0'; |
| 267 | return line_buffer; |
| 268 | } |
| 269 | |
| 270 | end = point; |
| 271 | found_quote = delimiter = 0; |
| 272 | quote_char = '\0'; |
| 273 | |
| 274 | brkchars = info->word_break_characters; |
| 275 | |
| 276 | if (info->quote_characters != NULL) |
| 277 | { |
| 278 | /* We have a list of characters which can be used in pairs to |
| 279 | quote substrings for the completer. Try to find the start of |
| 280 | an unclosed quoted substring. */ |
| 281 | /* FOUND_QUOTE is set so we know what kind of quotes we |
| 282 | found. */ |
| 283 | for (scan = pass_next = 0; |
| 284 | scan < end; |
| 285 | scan++) |
| 286 | { |
| 287 | if (pass_next) |
| 288 | { |
| 289 | pass_next = 0; |
| 290 | continue; |
| 291 | } |
| 292 | |
| 293 | /* Shell-like semantics for single quotes -- don't allow |
| 294 | backslash to quote anything in single quotes, especially |
| 295 | not the closing quote. If you don't like this, take out |
| 296 | the check on the value of quote_char. */ |
| 297 | if (quote_char != '\'' && line_buffer[scan] == '\\') |
| 298 | { |
| 299 | pass_next = 1; |
| 300 | found_quote |= RL_QF_BACKSLASH; |
| 301 | continue; |
| 302 | } |
| 303 | |
| 304 | if (quote_char != '\0') |
| 305 | { |
| 306 | /* Ignore everything until the matching close quote |
| 307 | char. */ |
| 308 | if (line_buffer[scan] == quote_char) |
| 309 | { |
| 310 | /* Found matching close. Abandon this |
| 311 | substring. */ |
| 312 | quote_char = '\0'; |
| 313 | point = end; |
| 314 | } |
| 315 | } |
| 316 | else if (strchr (info->quote_characters, line_buffer[scan])) |
| 317 | { |
| 318 | /* Found start of a quoted substring. */ |
| 319 | quote_char = line_buffer[scan]; |
| 320 | point = scan + 1; |
| 321 | /* Shell-like quoting conventions. */ |
| 322 | if (quote_char == '\'') |
| 323 | found_quote |= RL_QF_SINGLE_QUOTE; |
| 324 | else if (quote_char == '"') |
| 325 | found_quote |= RL_QF_DOUBLE_QUOTE; |
| 326 | else |
| 327 | found_quote |= RL_QF_OTHER_QUOTE; |
| 328 | } |
| 329 | } |
| 330 | } |
| 331 | |
| 332 | if (point == end && quote_char == '\0') |
| 333 | { |
| 334 | /* We didn't find an unclosed quoted substring upon which to do |
| 335 | completion, so use the word break characters to find the |
| 336 | substring on which to complete. */ |
| 337 | while (--point) |
| 338 | { |
| 339 | scan = line_buffer[point]; |
| 340 | |
| 341 | if (strchr (brkchars, scan) != 0) |
| 342 | break; |
| 343 | } |
| 344 | } |
| 345 | |
| 346 | /* If we are at an unquoted word break, then advance past it. */ |
| 347 | scan = line_buffer[point]; |
| 348 | |
| 349 | if (scan) |
| 350 | { |
| 351 | isbrk = strchr (brkchars, scan) != 0; |
| 352 | |
| 353 | if (isbrk) |
| 354 | { |
| 355 | /* If the character that caused the word break was a quoting |
| 356 | character, then remember it as the delimiter. */ |
| 357 | if (info->basic_quote_characters |
| 358 | && strchr (info->basic_quote_characters, scan) |
| 359 | && (end - point) > 1) |
| 360 | delimiter = scan; |
| 361 | |
| 362 | point++; |
| 363 | } |
| 364 | } |
| 365 | |
| 366 | if (qc != NULL) |
| 367 | *qc = quote_char; |
| 368 | if (dp != NULL) |
| 369 | *dp = delimiter; |
| 370 | |
| 371 | return line_buffer + point; |
| 372 | } |
| 373 | |
| 374 | /* See completer.h. */ |
| 375 | |
| 376 | const char * |
| 377 | advance_to_expression_complete_word_point (completion_tracker &tracker, |
| 378 | const char *text) |
| 379 | { |
| 380 | gdb_rl_completion_word_info info; |
| 381 | |
| 382 | info.word_break_characters |
| 383 | = current_language->la_word_break_characters (); |
| 384 | info.quote_characters = gdb_completer_quote_characters; |
| 385 | info.basic_quote_characters = rl_basic_quote_characters; |
| 386 | |
| 387 | const char *start |
| 388 | = gdb_rl_find_completion_word (&info, NULL, NULL, text); |
| 389 | |
| 390 | tracker.advance_custom_word_point_by (start - text); |
| 391 | |
| 392 | return start; |
| 393 | } |
| 394 | |
| 395 | /* See completer.h. */ |
| 396 | |
| 397 | bool |
| 398 | completion_tracker::completes_to_completion_word (const char *word) |
| 399 | { |
| 400 | if (m_lowest_common_denominator_unique) |
| 401 | { |
| 402 | const char *lcd = m_lowest_common_denominator; |
| 403 | |
| 404 | if (strncmp_iw (word, lcd, strlen (lcd)) == 0) |
| 405 | { |
| 406 | /* Maybe skip the function and complete on keywords. */ |
| 407 | size_t wordlen = strlen (word); |
| 408 | if (word[wordlen - 1] == ' ') |
| 409 | return true; |
| 410 | } |
| 411 | } |
| 412 | |
| 413 | return false; |
| 414 | } |
| 415 | |
| 416 | /* Complete on linespecs, which might be of two possible forms: |
| 417 | |
| 418 | file:line |
| 419 | or |
| 420 | symbol+offset |
| 421 | |
| 422 | This is intended to be used in commands that set breakpoints |
| 423 | etc. */ |
| 424 | |
| 425 | static void |
| 426 | complete_files_symbols (completion_tracker &tracker, |
| 427 | const char *text, const char *word) |
| 428 | { |
| 429 | int ix; |
| 430 | completion_list fn_list; |
| 431 | const char *p; |
| 432 | int quote_found = 0; |
| 433 | int quoted = *text == '\'' || *text == '"'; |
| 434 | int quote_char = '\0'; |
| 435 | const char *colon = NULL; |
| 436 | char *file_to_match = NULL; |
| 437 | const char *symbol_start = text; |
| 438 | const char *orig_text = text; |
| 439 | |
| 440 | /* Do we have an unquoted colon, as in "break foo.c:bar"? */ |
| 441 | for (p = text; *p != '\0'; ++p) |
| 442 | { |
| 443 | if (*p == '\\' && p[1] == '\'') |
| 444 | p++; |
| 445 | else if (*p == '\'' || *p == '"') |
| 446 | { |
| 447 | quote_found = *p; |
| 448 | quote_char = *p++; |
| 449 | while (*p != '\0' && *p != quote_found) |
| 450 | { |
| 451 | if (*p == '\\' && p[1] == quote_found) |
| 452 | p++; |
| 453 | p++; |
| 454 | } |
| 455 | |
| 456 | if (*p == quote_found) |
| 457 | quote_found = 0; |
| 458 | else |
| 459 | break; /* Hit the end of text. */ |
| 460 | } |
| 461 | #if HAVE_DOS_BASED_FILE_SYSTEM |
| 462 | /* If we have a DOS-style absolute file name at the beginning of |
| 463 | TEXT, and the colon after the drive letter is the only colon |
| 464 | we found, pretend the colon is not there. */ |
| 465 | else if (p < text + 3 && *p == ':' && p == text + 1 + quoted) |
| 466 | ; |
| 467 | #endif |
| 468 | else if (*p == ':' && !colon) |
| 469 | { |
| 470 | colon = p; |
| 471 | symbol_start = p + 1; |
| 472 | } |
| 473 | else if (strchr (current_language->la_word_break_characters(), *p)) |
| 474 | symbol_start = p + 1; |
| 475 | } |
| 476 | |
| 477 | if (quoted) |
| 478 | text++; |
| 479 | |
| 480 | /* Where is the file name? */ |
| 481 | if (colon) |
| 482 | { |
| 483 | char *s; |
| 484 | |
| 485 | file_to_match = (char *) xmalloc (colon - text + 1); |
| 486 | strncpy (file_to_match, text, colon - text); |
| 487 | file_to_match[colon - text] = '\0'; |
| 488 | /* Remove trailing colons and quotes from the file name. */ |
| 489 | for (s = file_to_match + (colon - text); |
| 490 | s > file_to_match; |
| 491 | s--) |
| 492 | if (*s == ':' || *s == quote_char) |
| 493 | *s = '\0'; |
| 494 | } |
| 495 | /* If the text includes a colon, they want completion only on a |
| 496 | symbol name after the colon. Otherwise, we need to complete on |
| 497 | symbols as well as on files. */ |
| 498 | if (colon) |
| 499 | { |
| 500 | collect_file_symbol_completion_matches (tracker, |
| 501 | complete_symbol_mode::EXPRESSION, |
| 502 | symbol_start, word, |
| 503 | file_to_match); |
| 504 | xfree (file_to_match); |
| 505 | } |
| 506 | else |
| 507 | { |
| 508 | size_t text_len = strlen (text); |
| 509 | |
| 510 | collect_symbol_completion_matches (tracker, |
| 511 | complete_symbol_mode::EXPRESSION, |
| 512 | symbol_start, word); |
| 513 | /* If text includes characters which cannot appear in a file |
| 514 | name, they cannot be asking for completion on files. */ |
| 515 | if (strcspn (text, |
| 516 | gdb_completer_file_name_break_characters) == text_len) |
| 517 | fn_list = make_source_files_completion_list (text, text); |
| 518 | } |
| 519 | |
| 520 | if (!fn_list.empty () && !tracker.have_completions ()) |
| 521 | { |
| 522 | char *fn; |
| 523 | |
| 524 | /* If we only have file names as possible completion, we should |
| 525 | bring them in sync with what rl_complete expects. The |
| 526 | problem is that if the user types "break /foo/b TAB", and the |
| 527 | possible completions are "/foo/bar" and "/foo/baz" |
| 528 | rl_complete expects us to return "bar" and "baz", without the |
| 529 | leading directories, as possible completions, because `word' |
| 530 | starts at the "b". But we ignore the value of `word' when we |
| 531 | call make_source_files_completion_list above (because that |
| 532 | would not DTRT when the completion results in both symbols |
| 533 | and file names), so make_source_files_completion_list returns |
| 534 | the full "/foo/bar" and "/foo/baz" strings. This produces |
| 535 | wrong results when, e.g., there's only one possible |
| 536 | completion, because rl_complete will prepend "/foo/" to each |
| 537 | candidate completion. The loop below removes that leading |
| 538 | part. */ |
| 539 | for (const auto &fn_up: fn_list) |
| 540 | { |
| 541 | char *fn = fn_up.get (); |
| 542 | memmove (fn, fn + (word - text), strlen (fn) + 1 - (word - text)); |
| 543 | } |
| 544 | } |
| 545 | |
| 546 | tracker.add_completions (std::move (fn_list)); |
| 547 | |
| 548 | if (!tracker.have_completions ()) |
| 549 | { |
| 550 | /* No completions at all. As the final resort, try completing |
| 551 | on the entire text as a symbol. */ |
| 552 | collect_symbol_completion_matches (tracker, |
| 553 | complete_symbol_mode::EXPRESSION, |
| 554 | orig_text, word); |
| 555 | } |
| 556 | } |
| 557 | |
| 558 | /* See completer.h. */ |
| 559 | |
| 560 | completion_list |
| 561 | complete_source_filenames (const char *text) |
| 562 | { |
| 563 | size_t text_len = strlen (text); |
| 564 | |
| 565 | /* If text includes characters which cannot appear in a file name, |
| 566 | the user cannot be asking for completion on files. */ |
| 567 | if (strcspn (text, |
| 568 | gdb_completer_file_name_break_characters) |
| 569 | == text_len) |
| 570 | return make_source_files_completion_list (text, text); |
| 571 | |
| 572 | return {}; |
| 573 | } |
| 574 | |
| 575 | /* Complete address and linespec locations. */ |
| 576 | |
| 577 | static void |
| 578 | complete_address_and_linespec_locations (completion_tracker &tracker, |
| 579 | const char *text) |
| 580 | { |
| 581 | if (*text == '*') |
| 582 | { |
| 583 | tracker.advance_custom_word_point_by (1); |
| 584 | text++; |
| 585 | const char *word |
| 586 | = advance_to_expression_complete_word_point (tracker, text); |
| 587 | complete_expression (tracker, text, word); |
| 588 | } |
| 589 | else |
| 590 | { |
| 591 | linespec_complete (tracker, text); |
| 592 | } |
| 593 | } |
| 594 | |
| 595 | /* The explicit location options. Note that indexes into this array |
| 596 | must match the explicit_location_match_type enumerators. */ |
| 597 | |
| 598 | static const char *const explicit_options[] = |
| 599 | { |
| 600 | "-source", |
| 601 | "-function", |
| 602 | "-line", |
| 603 | "-label", |
| 604 | NULL |
| 605 | }; |
| 606 | |
| 607 | /* The probe modifier options. These can appear before a location in |
| 608 | breakpoint commands. */ |
| 609 | static const char *const probe_options[] = |
| 610 | { |
| 611 | "-probe", |
| 612 | "-probe-stap", |
| 613 | "-probe-dtrace", |
| 614 | NULL |
| 615 | }; |
| 616 | |
| 617 | /* Returns STRING if not NULL, the empty string otherwise. */ |
| 618 | |
| 619 | static const char * |
| 620 | string_or_empty (const char *string) |
| 621 | { |
| 622 | return string != NULL ? string : ""; |
| 623 | } |
| 624 | |
| 625 | /* A helper function to collect explicit location matches for the given |
| 626 | LOCATION, which is attempting to match on WORD. */ |
| 627 | |
| 628 | static void |
| 629 | collect_explicit_location_matches (completion_tracker &tracker, |
| 630 | struct event_location *location, |
| 631 | enum explicit_location_match_type what, |
| 632 | const char *word, |
| 633 | const struct language_defn *language) |
| 634 | { |
| 635 | const struct explicit_location *explicit_loc |
| 636 | = get_explicit_location (location); |
| 637 | |
| 638 | /* Note, in the various MATCH_* below, we complete on |
| 639 | explicit_loc->foo instead of WORD, because only the former will |
| 640 | have already skipped past any quote char. */ |
| 641 | switch (what) |
| 642 | { |
| 643 | case MATCH_SOURCE: |
| 644 | { |
| 645 | const char *source = string_or_empty (explicit_loc->source_filename); |
| 646 | completion_list matches |
| 647 | = make_source_files_completion_list (source, source); |
| 648 | tracker.add_completions (std::move (matches)); |
| 649 | } |
| 650 | break; |
| 651 | |
| 652 | case MATCH_FUNCTION: |
| 653 | { |
| 654 | const char *function = string_or_empty (explicit_loc->function_name); |
| 655 | linespec_complete_function (tracker, function, |
| 656 | explicit_loc->source_filename); |
| 657 | } |
| 658 | break; |
| 659 | |
| 660 | case MATCH_LINE: |
| 661 | /* Nothing to offer. */ |
| 662 | break; |
| 663 | |
| 664 | case MATCH_LABEL: |
| 665 | { |
| 666 | const char *label = string_or_empty (explicit_loc->label_name); |
| 667 | linespec_complete_label (tracker, language, |
| 668 | explicit_loc->source_filename, |
| 669 | explicit_loc->function_name, |
| 670 | label); |
| 671 | } |
| 672 | break; |
| 673 | |
| 674 | default: |
| 675 | gdb_assert_not_reached ("unhandled explicit_location_match_type"); |
| 676 | } |
| 677 | |
| 678 | if (tracker.completes_to_completion_word (word)) |
| 679 | { |
| 680 | tracker.discard_completions (); |
| 681 | tracker.advance_custom_word_point_by (strlen (word)); |
| 682 | complete_on_enum (tracker, explicit_options, "", ""); |
| 683 | complete_on_enum (tracker, linespec_keywords, "", ""); |
| 684 | } |
| 685 | else if (!tracker.have_completions ()) |
| 686 | { |
| 687 | /* Maybe we have an unterminated linespec keyword at the tail of |
| 688 | the string. Try completing on that. */ |
| 689 | size_t wordlen = strlen (word); |
| 690 | const char *keyword = word + wordlen; |
| 691 | |
| 692 | if (wordlen > 0 && keyword[-1] != ' ') |
| 693 | { |
| 694 | while (keyword > word && *keyword != ' ') |
| 695 | keyword--; |
| 696 | /* Don't complete on keywords if we'd be completing on the |
| 697 | whole explicit linespec option. E.g., "b -function |
| 698 | thr<tab>" should not complete to the "thread" |
| 699 | keyword. */ |
| 700 | if (keyword != word) |
| 701 | { |
| 702 | keyword = skip_spaces (keyword); |
| 703 | |
| 704 | tracker.advance_custom_word_point_by (keyword - word); |
| 705 | complete_on_enum (tracker, linespec_keywords, keyword, keyword); |
| 706 | } |
| 707 | } |
| 708 | else if (wordlen > 0 && keyword[-1] == ' ') |
| 709 | { |
| 710 | /* Assume that we're maybe past the explicit location |
| 711 | argument, and we didn't manage to find any match because |
| 712 | the user wants to create a pending breakpoint. Offer the |
| 713 | keyword and explicit location options as possible |
| 714 | completions. */ |
| 715 | tracker.advance_custom_word_point_by (keyword - word); |
| 716 | complete_on_enum (tracker, linespec_keywords, keyword, keyword); |
| 717 | complete_on_enum (tracker, explicit_options, keyword, keyword); |
| 718 | } |
| 719 | } |
| 720 | } |
| 721 | |
| 722 | /* If the next word in *TEXT_P is any of the keywords in KEYWORDS, |
| 723 | then advance both TEXT_P and the word point in the tracker past the |
| 724 | keyword and return the (0-based) index in the KEYWORDS array that |
| 725 | matched. Otherwise, return -1. */ |
| 726 | |
| 727 | static int |
| 728 | skip_keyword (completion_tracker &tracker, |
| 729 | const char * const *keywords, const char **text_p) |
| 730 | { |
| 731 | const char *text = *text_p; |
| 732 | const char *after = skip_to_space (text); |
| 733 | size_t len = after - text; |
| 734 | |
| 735 | if (text[len] != ' ') |
| 736 | return -1; |
| 737 | |
| 738 | int found = -1; |
| 739 | for (int i = 0; keywords[i] != NULL; i++) |
| 740 | { |
| 741 | if (strncmp (keywords[i], text, len) == 0) |
| 742 | { |
| 743 | if (found == -1) |
| 744 | found = i; |
| 745 | else |
| 746 | return -1; |
| 747 | } |
| 748 | } |
| 749 | |
| 750 | if (found != -1) |
| 751 | { |
| 752 | tracker.advance_custom_word_point_by (len + 1); |
| 753 | text += len + 1; |
| 754 | *text_p = text; |
| 755 | return found; |
| 756 | } |
| 757 | |
| 758 | return -1; |
| 759 | } |
| 760 | |
| 761 | /* A completer function for explicit locations. This function |
| 762 | completes both options ("-source", "-line", etc) and values. If |
| 763 | completing a quoted string, then QUOTED_ARG_START and |
| 764 | QUOTED_ARG_END point to the quote characters. LANGUAGE is the |
| 765 | current language. */ |
| 766 | |
| 767 | static void |
| 768 | complete_explicit_location (completion_tracker &tracker, |
| 769 | struct event_location *location, |
| 770 | const char *text, |
| 771 | const language_defn *language, |
| 772 | const char *quoted_arg_start, |
| 773 | const char *quoted_arg_end) |
| 774 | { |
| 775 | if (*text != '-') |
| 776 | return; |
| 777 | |
| 778 | int keyword = skip_keyword (tracker, explicit_options, &text); |
| 779 | |
| 780 | if (keyword == -1) |
| 781 | complete_on_enum (tracker, explicit_options, text, text); |
| 782 | else |
| 783 | { |
| 784 | /* Completing on value. */ |
| 785 | enum explicit_location_match_type what |
| 786 | = (explicit_location_match_type) keyword; |
| 787 | |
| 788 | if (quoted_arg_start != NULL && quoted_arg_end != NULL) |
| 789 | { |
| 790 | if (quoted_arg_end[1] == '\0') |
| 791 | { |
| 792 | /* If completing a quoted string with the cursor right |
| 793 | at the terminating quote char, complete the |
| 794 | completion word without interpretation, so that |
| 795 | readline advances the cursor one whitespace past the |
| 796 | quote, even if there's no match. This makes these |
| 797 | cases behave the same: |
| 798 | |
| 799 | before: "b -function function()" |
| 800 | after: "b -function function() " |
| 801 | |
| 802 | before: "b -function 'function()'" |
| 803 | after: "b -function 'function()' " |
| 804 | |
| 805 | and trusts the user in this case: |
| 806 | |
| 807 | before: "b -function 'not_loaded_function_yet()'" |
| 808 | after: "b -function 'not_loaded_function_yet()' " |
| 809 | */ |
| 810 | gdb::unique_xmalloc_ptr<char> text_copy |
| 811 | (xstrdup (text)); |
| 812 | tracker.add_completion (std::move (text_copy)); |
| 813 | } |
| 814 | else if (quoted_arg_end[1] == ' ') |
| 815 | { |
| 816 | /* We're maybe past the explicit location argument. |
| 817 | Skip the argument without interpretion, assuming the |
| 818 | user may want to create pending breakpoint. Offer |
| 819 | the keyword and explicit location options as possible |
| 820 | completions. */ |
| 821 | tracker.advance_custom_word_point_by (strlen (text)); |
| 822 | complete_on_enum (tracker, linespec_keywords, "", ""); |
| 823 | complete_on_enum (tracker, explicit_options, "", ""); |
| 824 | } |
| 825 | return; |
| 826 | } |
| 827 | |
| 828 | /* Now gather matches */ |
| 829 | collect_explicit_location_matches (tracker, location, what, text, |
| 830 | language); |
| 831 | } |
| 832 | } |
| 833 | |
| 834 | /* A completer for locations. */ |
| 835 | |
| 836 | void |
| 837 | location_completer (struct cmd_list_element *ignore, |
| 838 | completion_tracker &tracker, |
| 839 | const char *text, const char * /* word */) |
| 840 | { |
| 841 | int found_probe_option = -1; |
| 842 | |
| 843 | /* If we have a probe modifier, skip it. This can only appear as |
| 844 | first argument. Until we have a specific completer for probes, |
| 845 | falling back to the linespec completer for the remainder of the |
| 846 | line is better than nothing. */ |
| 847 | if (text[0] == '-' && text[1] == 'p') |
| 848 | found_probe_option = skip_keyword (tracker, probe_options, &text); |
| 849 | |
| 850 | const char *option_text = text; |
| 851 | int saved_word_point = tracker.custom_word_point (); |
| 852 | |
| 853 | const char *copy = text; |
| 854 | |
| 855 | explicit_completion_info completion_info; |
| 856 | event_location_up location |
| 857 | = string_to_explicit_location (©, current_language, |
| 858 | &completion_info); |
| 859 | if (completion_info.quoted_arg_start != NULL |
| 860 | && completion_info.quoted_arg_end == NULL) |
| 861 | { |
| 862 | /* Found an unbalanced quote. */ |
| 863 | tracker.set_quote_char (*completion_info.quoted_arg_start); |
| 864 | tracker.advance_custom_word_point_by (1); |
| 865 | } |
| 866 | |
| 867 | if (location != NULL) |
| 868 | { |
| 869 | if (*copy != '\0') |
| 870 | { |
| 871 | tracker.advance_custom_word_point_by (copy - text); |
| 872 | text = copy; |
| 873 | |
| 874 | /* We found a terminator at the tail end of the string, |
| 875 | which means we're past the explicit location options. We |
| 876 | may have a keyword to complete on. If we have a whole |
| 877 | keyword, then complete whatever comes after as an |
| 878 | expression. This is mainly for the "if" keyword. If the |
| 879 | "thread" and "task" keywords gain their own completers, |
| 880 | they should be used here. */ |
| 881 | int keyword = skip_keyword (tracker, linespec_keywords, &text); |
| 882 | |
| 883 | if (keyword == -1) |
| 884 | { |
| 885 | complete_on_enum (tracker, linespec_keywords, text, text); |
| 886 | } |
| 887 | else |
| 888 | { |
| 889 | const char *word |
| 890 | = advance_to_expression_complete_word_point (tracker, text); |
| 891 | complete_expression (tracker, text, word); |
| 892 | } |
| 893 | } |
| 894 | else |
| 895 | { |
| 896 | tracker.advance_custom_word_point_by (completion_info.last_option |
| 897 | - text); |
| 898 | text = completion_info.last_option; |
| 899 | |
| 900 | complete_explicit_location (tracker, location.get (), text, |
| 901 | current_language, |
| 902 | completion_info.quoted_arg_start, |
| 903 | completion_info.quoted_arg_end); |
| 904 | |
| 905 | } |
| 906 | } |
| 907 | else |
| 908 | { |
| 909 | /* This is an address or linespec location. */ |
| 910 | complete_address_and_linespec_locations (tracker, text); |
| 911 | } |
| 912 | |
| 913 | /* Add matches for option names, if either: |
| 914 | |
| 915 | - Some completer above found some matches, but the word point did |
| 916 | not advance (e.g., "b <tab>" finds all functions, or "b -<tab>" |
| 917 | matches all objc selectors), or; |
| 918 | |
| 919 | - Some completer above advanced the word point, but found no |
| 920 | matches. |
| 921 | */ |
| 922 | if ((text[0] == '-' || text[0] == '\0') |
| 923 | && (!tracker.have_completions () |
| 924 | || tracker.custom_word_point () == saved_word_point)) |
| 925 | { |
| 926 | tracker.set_custom_word_point (saved_word_point); |
| 927 | text = option_text; |
| 928 | |
| 929 | if (found_probe_option == -1) |
| 930 | complete_on_enum (tracker, probe_options, text, text); |
| 931 | complete_on_enum (tracker, explicit_options, text, text); |
| 932 | } |
| 933 | } |
| 934 | |
| 935 | /* The corresponding completer_handle_brkchars |
| 936 | implementation. */ |
| 937 | |
| 938 | static void |
| 939 | location_completer_handle_brkchars (struct cmd_list_element *ignore, |
| 940 | completion_tracker &tracker, |
| 941 | const char *text, |
| 942 | const char *word_ignored) |
| 943 | { |
| 944 | tracker.set_use_custom_word_point (true); |
| 945 | |
| 946 | location_completer (ignore, tracker, text, NULL); |
| 947 | } |
| 948 | |
| 949 | /* Helper for expression_completer which recursively adds field and |
| 950 | method names from TYPE, a struct or union type, to the OUTPUT |
| 951 | list. */ |
| 952 | |
| 953 | static void |
| 954 | add_struct_fields (struct type *type, completion_list &output, |
| 955 | char *fieldname, int namelen) |
| 956 | { |
| 957 | int i; |
| 958 | int computed_type_name = 0; |
| 959 | const char *type_name = NULL; |
| 960 | |
| 961 | type = check_typedef (type); |
| 962 | for (i = 0; i < TYPE_NFIELDS (type); ++i) |
| 963 | { |
| 964 | if (i < TYPE_N_BASECLASSES (type)) |
| 965 | add_struct_fields (TYPE_BASECLASS (type, i), |
| 966 | output, fieldname, namelen); |
| 967 | else if (TYPE_FIELD_NAME (type, i)) |
| 968 | { |
| 969 | if (TYPE_FIELD_NAME (type, i)[0] != '\0') |
| 970 | { |
| 971 | if (! strncmp (TYPE_FIELD_NAME (type, i), |
| 972 | fieldname, namelen)) |
| 973 | output.emplace_back (xstrdup (TYPE_FIELD_NAME (type, i))); |
| 974 | } |
| 975 | else if (TYPE_CODE (TYPE_FIELD_TYPE (type, i)) == TYPE_CODE_UNION) |
| 976 | { |
| 977 | /* Recurse into anonymous unions. */ |
| 978 | add_struct_fields (TYPE_FIELD_TYPE (type, i), |
| 979 | output, fieldname, namelen); |
| 980 | } |
| 981 | } |
| 982 | } |
| 983 | |
| 984 | for (i = TYPE_NFN_FIELDS (type) - 1; i >= 0; --i) |
| 985 | { |
| 986 | const char *name = TYPE_FN_FIELDLIST_NAME (type, i); |
| 987 | |
| 988 | if (name && ! strncmp (name, fieldname, namelen)) |
| 989 | { |
| 990 | if (!computed_type_name) |
| 991 | { |
| 992 | type_name = type_name_no_tag (type); |
| 993 | computed_type_name = 1; |
| 994 | } |
| 995 | /* Omit constructors from the completion list. */ |
| 996 | if (!type_name || strcmp (type_name, name)) |
| 997 | output.emplace_back (xstrdup (name)); |
| 998 | } |
| 999 | } |
| 1000 | } |
| 1001 | |
| 1002 | /* See completer.h. */ |
| 1003 | |
| 1004 | void |
| 1005 | complete_expression (completion_tracker &tracker, |
| 1006 | const char *text, const char *word) |
| 1007 | { |
| 1008 | struct type *type = NULL; |
| 1009 | char *fieldname; |
| 1010 | enum type_code code = TYPE_CODE_UNDEF; |
| 1011 | |
| 1012 | /* Perform a tentative parse of the expression, to see whether a |
| 1013 | field completion is required. */ |
| 1014 | fieldname = NULL; |
| 1015 | TRY |
| 1016 | { |
| 1017 | type = parse_expression_for_completion (text, &fieldname, &code); |
| 1018 | } |
| 1019 | CATCH (except, RETURN_MASK_ERROR) |
| 1020 | { |
| 1021 | return; |
| 1022 | } |
| 1023 | END_CATCH |
| 1024 | |
| 1025 | if (fieldname && type) |
| 1026 | { |
| 1027 | for (;;) |
| 1028 | { |
| 1029 | type = check_typedef (type); |
| 1030 | if (TYPE_CODE (type) != TYPE_CODE_PTR && !TYPE_IS_REFERENCE (type)) |
| 1031 | break; |
| 1032 | type = TYPE_TARGET_TYPE (type); |
| 1033 | } |
| 1034 | |
| 1035 | if (TYPE_CODE (type) == TYPE_CODE_UNION |
| 1036 | || TYPE_CODE (type) == TYPE_CODE_STRUCT) |
| 1037 | { |
| 1038 | int flen = strlen (fieldname); |
| 1039 | completion_list result; |
| 1040 | |
| 1041 | add_struct_fields (type, result, fieldname, flen); |
| 1042 | xfree (fieldname); |
| 1043 | tracker.add_completions (std::move (result)); |
| 1044 | return; |
| 1045 | } |
| 1046 | } |
| 1047 | else if (fieldname && code != TYPE_CODE_UNDEF) |
| 1048 | { |
| 1049 | VEC (char_ptr) *result; |
| 1050 | struct cleanup *cleanup = make_cleanup (xfree, fieldname); |
| 1051 | |
| 1052 | collect_symbol_completion_matches_type (tracker, fieldname, fieldname, |
| 1053 | code); |
| 1054 | do_cleanups (cleanup); |
| 1055 | return; |
| 1056 | } |
| 1057 | xfree (fieldname); |
| 1058 | |
| 1059 | complete_files_symbols (tracker, text, word); |
| 1060 | } |
| 1061 | |
| 1062 | /* Complete on expressions. Often this means completing on symbol |
| 1063 | names, but some language parsers also have support for completing |
| 1064 | field names. */ |
| 1065 | |
| 1066 | void |
| 1067 | expression_completer (struct cmd_list_element *ignore, |
| 1068 | completion_tracker &tracker, |
| 1069 | const char *text, const char *word) |
| 1070 | { |
| 1071 | complete_expression (tracker, text, word); |
| 1072 | } |
| 1073 | |
| 1074 | /* See definition in completer.h. */ |
| 1075 | |
| 1076 | void |
| 1077 | set_rl_completer_word_break_characters (const char *break_chars) |
| 1078 | { |
| 1079 | rl_completer_word_break_characters = (char *) break_chars; |
| 1080 | } |
| 1081 | |
| 1082 | /* See definition in completer.h. */ |
| 1083 | |
| 1084 | void |
| 1085 | set_gdb_completion_word_break_characters (completer_ftype *fn) |
| 1086 | { |
| 1087 | const char *break_chars; |
| 1088 | |
| 1089 | /* So far we are only interested in differentiating filename |
| 1090 | completers from everything else. */ |
| 1091 | if (fn == filename_completer) |
| 1092 | break_chars = gdb_completer_file_name_break_characters; |
| 1093 | else |
| 1094 | break_chars = gdb_completer_command_word_break_characters; |
| 1095 | |
| 1096 | set_rl_completer_word_break_characters (break_chars); |
| 1097 | } |
| 1098 | |
| 1099 | /* Complete on symbols. */ |
| 1100 | |
| 1101 | void |
| 1102 | symbol_completer (struct cmd_list_element *ignore, |
| 1103 | completion_tracker &tracker, |
| 1104 | const char *text, const char *word) |
| 1105 | { |
| 1106 | collect_symbol_completion_matches (tracker, complete_symbol_mode::EXPRESSION, |
| 1107 | text, word); |
| 1108 | } |
| 1109 | |
| 1110 | /* Here are some useful test cases for completion. FIXME: These |
| 1111 | should be put in the test suite. They should be tested with both |
| 1112 | M-? and TAB. |
| 1113 | |
| 1114 | "show output-" "radix" |
| 1115 | "show output" "-radix" |
| 1116 | "p" ambiguous (commands starting with p--path, print, printf, etc.) |
| 1117 | "p " ambiguous (all symbols) |
| 1118 | "info t foo" no completions |
| 1119 | "info t " no completions |
| 1120 | "info t" ambiguous ("info target", "info terminal", etc.) |
| 1121 | "info ajksdlfk" no completions |
| 1122 | "info ajksdlfk " no completions |
| 1123 | "info" " " |
| 1124 | "info " ambiguous (all info commands) |
| 1125 | "p \"a" no completions (string constant) |
| 1126 | "p 'a" ambiguous (all symbols starting with a) |
| 1127 | "p b-a" ambiguous (all symbols starting with a) |
| 1128 | "p b-" ambiguous (all symbols) |
| 1129 | "file Make" "file" (word break hard to screw up here) |
| 1130 | "file ../gdb.stabs/we" "ird" (needs to not break word at slash) |
| 1131 | */ |
| 1132 | |
| 1133 | enum complete_line_internal_reason |
| 1134 | { |
| 1135 | /* Preliminary phase, called by gdb_completion_word_break_characters |
| 1136 | function, is used to either: |
| 1137 | |
| 1138 | #1 - Determine the set of chars that are word delimiters |
| 1139 | depending on the current command in line_buffer. |
| 1140 | |
| 1141 | #2 - Manually advance RL_POINT to the "word break" point instead |
| 1142 | of letting readline do it (based on too-simple character |
| 1143 | matching). |
| 1144 | |
| 1145 | Simpler completers that just pass a brkchars array to readline |
| 1146 | (#1 above) must defer generating the completions to the main |
| 1147 | phase (below). No completion list should be generated in this |
| 1148 | phase. |
| 1149 | |
| 1150 | OTOH, completers that manually advance the word point(#2 above) |
| 1151 | must set "use_custom_word_point" in the tracker and generate |
| 1152 | their completion in this phase. Note that this is the convenient |
| 1153 | thing to do since they'll be parsing the input line anyway. */ |
| 1154 | handle_brkchars, |
| 1155 | |
| 1156 | /* Main phase, called by complete_line function, is used to get the |
| 1157 | list of possible completions. */ |
| 1158 | handle_completions, |
| 1159 | |
| 1160 | /* Special case when completing a 'help' command. In this case, |
| 1161 | once sub-command completions are exhausted, we simply return |
| 1162 | NULL. */ |
| 1163 | handle_help, |
| 1164 | }; |
| 1165 | |
| 1166 | /* Helper for complete_line_internal to simplify it. */ |
| 1167 | |
| 1168 | static void |
| 1169 | complete_line_internal_normal_command (completion_tracker &tracker, |
| 1170 | const char *command, const char *word, |
| 1171 | const char *cmd_args, |
| 1172 | complete_line_internal_reason reason, |
| 1173 | struct cmd_list_element *c) |
| 1174 | { |
| 1175 | const char *p = cmd_args; |
| 1176 | |
| 1177 | if (c->completer == filename_completer) |
| 1178 | { |
| 1179 | /* Many commands which want to complete on file names accept |
| 1180 | several file names, as in "run foo bar >>baz". So we don't |
| 1181 | want to complete the entire text after the command, just the |
| 1182 | last word. To this end, we need to find the beginning of the |
| 1183 | file name by starting at `word' and going backwards. */ |
| 1184 | for (p = word; |
| 1185 | p > command |
| 1186 | && strchr (gdb_completer_file_name_break_characters, |
| 1187 | p[-1]) == NULL; |
| 1188 | p--) |
| 1189 | ; |
| 1190 | } |
| 1191 | |
| 1192 | if (reason == handle_brkchars) |
| 1193 | { |
| 1194 | completer_handle_brkchars_ftype *brkchars_fn; |
| 1195 | |
| 1196 | if (c->completer_handle_brkchars != NULL) |
| 1197 | brkchars_fn = c->completer_handle_brkchars; |
| 1198 | else |
| 1199 | { |
| 1200 | brkchars_fn |
| 1201 | = (completer_handle_brkchars_func_for_completer |
| 1202 | (c->completer)); |
| 1203 | } |
| 1204 | |
| 1205 | brkchars_fn (c, tracker, p, word); |
| 1206 | } |
| 1207 | |
| 1208 | if (reason != handle_brkchars && c->completer != NULL) |
| 1209 | (*c->completer) (c, tracker, p, word); |
| 1210 | } |
| 1211 | |
| 1212 | /* Internal function used to handle completions. |
| 1213 | |
| 1214 | |
| 1215 | TEXT is the caller's idea of the "word" we are looking at. |
| 1216 | |
| 1217 | LINE_BUFFER is available to be looked at; it contains the entire |
| 1218 | text of the line. POINT is the offset in that line of the cursor. |
| 1219 | You should pretend that the line ends at POINT. |
| 1220 | |
| 1221 | See complete_line_internal_reason for description of REASON. */ |
| 1222 | |
| 1223 | static void |
| 1224 | complete_line_internal_1 (completion_tracker &tracker, |
| 1225 | const char *text, |
| 1226 | const char *line_buffer, int point, |
| 1227 | complete_line_internal_reason reason) |
| 1228 | { |
| 1229 | char *tmp_command; |
| 1230 | const char *p; |
| 1231 | int ignore_help_classes; |
| 1232 | /* Pointer within tmp_command which corresponds to text. */ |
| 1233 | const char *word; |
| 1234 | struct cmd_list_element *c, *result_list; |
| 1235 | |
| 1236 | /* Choose the default set of word break characters to break |
| 1237 | completions. If we later find out that we are doing completions |
| 1238 | on command strings (as opposed to strings supplied by the |
| 1239 | individual command completer functions, which can be any string) |
| 1240 | then we will switch to the special word break set for command |
| 1241 | strings, which leaves out the '-' character used in some |
| 1242 | commands. */ |
| 1243 | set_rl_completer_word_break_characters |
| 1244 | (current_language->la_word_break_characters()); |
| 1245 | |
| 1246 | /* Decide whether to complete on a list of gdb commands or on |
| 1247 | symbols. */ |
| 1248 | tmp_command = (char *) alloca (point + 1); |
| 1249 | p = tmp_command; |
| 1250 | |
| 1251 | /* The help command should complete help aliases. */ |
| 1252 | ignore_help_classes = reason != handle_help; |
| 1253 | |
| 1254 | strncpy (tmp_command, line_buffer, point); |
| 1255 | tmp_command[point] = '\0'; |
| 1256 | if (reason == handle_brkchars) |
| 1257 | { |
| 1258 | gdb_assert (text == NULL); |
| 1259 | word = NULL; |
| 1260 | } |
| 1261 | else |
| 1262 | { |
| 1263 | /* Since text always contains some number of characters leading up |
| 1264 | to point, we can find the equivalent position in tmp_command |
| 1265 | by subtracting that many characters from the end of tmp_command. */ |
| 1266 | word = tmp_command + point - strlen (text); |
| 1267 | } |
| 1268 | |
| 1269 | if (point == 0) |
| 1270 | { |
| 1271 | /* An empty line we want to consider ambiguous; that is, it |
| 1272 | could be any command. */ |
| 1273 | c = CMD_LIST_AMBIGUOUS; |
| 1274 | result_list = 0; |
| 1275 | } |
| 1276 | else |
| 1277 | { |
| 1278 | c = lookup_cmd_1 (&p, cmdlist, &result_list, ignore_help_classes); |
| 1279 | } |
| 1280 | |
| 1281 | /* Move p up to the next interesting thing. */ |
| 1282 | while (*p == ' ' || *p == '\t') |
| 1283 | { |
| 1284 | p++; |
| 1285 | } |
| 1286 | |
| 1287 | tracker.advance_custom_word_point_by (p - tmp_command); |
| 1288 | |
| 1289 | if (!c) |
| 1290 | { |
| 1291 | /* It is an unrecognized command. So there are no |
| 1292 | possible completions. */ |
| 1293 | } |
| 1294 | else if (c == CMD_LIST_AMBIGUOUS) |
| 1295 | { |
| 1296 | const char *q; |
| 1297 | |
| 1298 | /* lookup_cmd_1 advances p up to the first ambiguous thing, but |
| 1299 | doesn't advance over that thing itself. Do so now. */ |
| 1300 | q = p; |
| 1301 | while (*q && (isalnum (*q) || *q == '-' || *q == '_')) |
| 1302 | ++q; |
| 1303 | if (q != tmp_command + point) |
| 1304 | { |
| 1305 | /* There is something beyond the ambiguous |
| 1306 | command, so there are no possible completions. For |
| 1307 | example, "info t " or "info t foo" does not complete |
| 1308 | to anything, because "info t" can be "info target" or |
| 1309 | "info terminal". */ |
| 1310 | } |
| 1311 | else |
| 1312 | { |
| 1313 | /* We're trying to complete on the command which was ambiguous. |
| 1314 | This we can deal with. */ |
| 1315 | if (result_list) |
| 1316 | { |
| 1317 | if (reason != handle_brkchars) |
| 1318 | complete_on_cmdlist (*result_list->prefixlist, tracker, p, |
| 1319 | word, ignore_help_classes); |
| 1320 | } |
| 1321 | else |
| 1322 | { |
| 1323 | if (reason != handle_brkchars) |
| 1324 | complete_on_cmdlist (cmdlist, tracker, p, word, |
| 1325 | ignore_help_classes); |
| 1326 | } |
| 1327 | /* Ensure that readline does the right thing with respect to |
| 1328 | inserting quotes. */ |
| 1329 | set_rl_completer_word_break_characters |
| 1330 | (gdb_completer_command_word_break_characters); |
| 1331 | } |
| 1332 | } |
| 1333 | else |
| 1334 | { |
| 1335 | /* We've recognized a full command. */ |
| 1336 | |
| 1337 | if (p == tmp_command + point) |
| 1338 | { |
| 1339 | /* There is no non-whitespace in the line beyond the |
| 1340 | command. */ |
| 1341 | |
| 1342 | if (p[-1] == ' ' || p[-1] == '\t') |
| 1343 | { |
| 1344 | /* The command is followed by whitespace; we need to |
| 1345 | complete on whatever comes after command. */ |
| 1346 | if (c->prefixlist) |
| 1347 | { |
| 1348 | /* It is a prefix command; what comes after it is |
| 1349 | a subcommand (e.g. "info "). */ |
| 1350 | if (reason != handle_brkchars) |
| 1351 | complete_on_cmdlist (*c->prefixlist, tracker, p, word, |
| 1352 | ignore_help_classes); |
| 1353 | |
| 1354 | /* Ensure that readline does the right thing |
| 1355 | with respect to inserting quotes. */ |
| 1356 | set_rl_completer_word_break_characters |
| 1357 | (gdb_completer_command_word_break_characters); |
| 1358 | } |
| 1359 | else if (reason == handle_help) |
| 1360 | ; |
| 1361 | else if (c->enums) |
| 1362 | { |
| 1363 | if (reason != handle_brkchars) |
| 1364 | complete_on_enum (tracker, c->enums, p, word); |
| 1365 | set_rl_completer_word_break_characters |
| 1366 | (gdb_completer_command_word_break_characters); |
| 1367 | } |
| 1368 | else |
| 1369 | { |
| 1370 | /* It is a normal command; what comes after it is |
| 1371 | completed by the command's completer function. */ |
| 1372 | complete_line_internal_normal_command (tracker, |
| 1373 | tmp_command, word, p, |
| 1374 | reason, c); |
| 1375 | } |
| 1376 | } |
| 1377 | else |
| 1378 | { |
| 1379 | /* The command is not followed by whitespace; we need to |
| 1380 | complete on the command itself, e.g. "p" which is a |
| 1381 | command itself but also can complete to "print", "ptype" |
| 1382 | etc. */ |
| 1383 | const char *q; |
| 1384 | |
| 1385 | /* Find the command we are completing on. */ |
| 1386 | q = p; |
| 1387 | while (q > tmp_command) |
| 1388 | { |
| 1389 | if (isalnum (q[-1]) || q[-1] == '-' || q[-1] == '_') |
| 1390 | --q; |
| 1391 | else |
| 1392 | break; |
| 1393 | } |
| 1394 | |
| 1395 | if (reason != handle_brkchars) |
| 1396 | complete_on_cmdlist (result_list, tracker, q, word, |
| 1397 | ignore_help_classes); |
| 1398 | |
| 1399 | /* Ensure that readline does the right thing |
| 1400 | with respect to inserting quotes. */ |
| 1401 | set_rl_completer_word_break_characters |
| 1402 | (gdb_completer_command_word_break_characters); |
| 1403 | } |
| 1404 | } |
| 1405 | else if (reason == handle_help) |
| 1406 | ; |
| 1407 | else |
| 1408 | { |
| 1409 | /* There is non-whitespace beyond the command. */ |
| 1410 | |
| 1411 | if (c->prefixlist && !c->allow_unknown) |
| 1412 | { |
| 1413 | /* It is an unrecognized subcommand of a prefix command, |
| 1414 | e.g. "info adsfkdj". */ |
| 1415 | } |
| 1416 | else if (c->enums) |
| 1417 | { |
| 1418 | if (reason != handle_brkchars) |
| 1419 | complete_on_enum (tracker, c->enums, p, word); |
| 1420 | } |
| 1421 | else |
| 1422 | { |
| 1423 | /* It is a normal command. */ |
| 1424 | complete_line_internal_normal_command (tracker, |
| 1425 | tmp_command, word, p, |
| 1426 | reason, c); |
| 1427 | } |
| 1428 | } |
| 1429 | } |
| 1430 | } |
| 1431 | |
| 1432 | /* Wrapper around complete_line_internal_1 to handle |
| 1433 | MAX_COMPLETIONS_REACHED_ERROR. */ |
| 1434 | |
| 1435 | static void |
| 1436 | complete_line_internal (completion_tracker &tracker, |
| 1437 | const char *text, |
| 1438 | const char *line_buffer, int point, |
| 1439 | complete_line_internal_reason reason) |
| 1440 | { |
| 1441 | TRY |
| 1442 | { |
| 1443 | complete_line_internal_1 (tracker, text, line_buffer, point, reason); |
| 1444 | } |
| 1445 | CATCH (except, RETURN_MASK_ERROR) |
| 1446 | { |
| 1447 | if (except.error != MAX_COMPLETIONS_REACHED_ERROR) |
| 1448 | throw_exception (except); |
| 1449 | } |
| 1450 | } |
| 1451 | |
| 1452 | /* See completer.h. */ |
| 1453 | |
| 1454 | int max_completions = 200; |
| 1455 | |
| 1456 | /* Initial size of the table. It automagically grows from here. */ |
| 1457 | #define INITIAL_COMPLETION_HTAB_SIZE 200 |
| 1458 | |
| 1459 | /* See completer.h. */ |
| 1460 | |
| 1461 | completion_tracker::completion_tracker () |
| 1462 | { |
| 1463 | m_entries_hash = htab_create_alloc (INITIAL_COMPLETION_HTAB_SIZE, |
| 1464 | htab_hash_string, (htab_eq) streq, |
| 1465 | NULL, xcalloc, xfree); |
| 1466 | } |
| 1467 | |
| 1468 | /* See completer.h. */ |
| 1469 | |
| 1470 | void |
| 1471 | completion_tracker::discard_completions () |
| 1472 | { |
| 1473 | xfree (m_lowest_common_denominator); |
| 1474 | m_lowest_common_denominator = NULL; |
| 1475 | |
| 1476 | m_lowest_common_denominator_unique = false; |
| 1477 | |
| 1478 | m_entries_vec.clear (); |
| 1479 | |
| 1480 | htab_delete (m_entries_hash); |
| 1481 | m_entries_hash = htab_create_alloc (INITIAL_COMPLETION_HTAB_SIZE, |
| 1482 | htab_hash_string, (htab_eq) streq, |
| 1483 | NULL, xcalloc, xfree); |
| 1484 | } |
| 1485 | |
| 1486 | /* See completer.h. */ |
| 1487 | |
| 1488 | completion_tracker::~completion_tracker () |
| 1489 | { |
| 1490 | xfree (m_lowest_common_denominator); |
| 1491 | htab_delete (m_entries_hash); |
| 1492 | } |
| 1493 | |
| 1494 | /* See completer.h. */ |
| 1495 | |
| 1496 | bool |
| 1497 | completion_tracker::maybe_add_completion (gdb::unique_xmalloc_ptr<char> name) |
| 1498 | { |
| 1499 | void **slot; |
| 1500 | |
| 1501 | if (max_completions == 0) |
| 1502 | return false; |
| 1503 | |
| 1504 | if (htab_elements (m_entries_hash) >= max_completions) |
| 1505 | return false; |
| 1506 | |
| 1507 | slot = htab_find_slot (m_entries_hash, name.get (), INSERT); |
| 1508 | if (*slot == HTAB_EMPTY_ENTRY) |
| 1509 | { |
| 1510 | const char *match_for_lcd_str = name.get (); |
| 1511 | |
| 1512 | recompute_lowest_common_denominator (match_for_lcd_str); |
| 1513 | |
| 1514 | *slot = name.get (); |
| 1515 | m_entries_vec.push_back (std::move (name)); |
| 1516 | } |
| 1517 | |
| 1518 | return true; |
| 1519 | } |
| 1520 | |
| 1521 | /* See completer.h. */ |
| 1522 | |
| 1523 | void |
| 1524 | completion_tracker::add_completion (gdb::unique_xmalloc_ptr<char> name) |
| 1525 | { |
| 1526 | if (!maybe_add_completion (std::move (name))) |
| 1527 | throw_error (MAX_COMPLETIONS_REACHED_ERROR, _("Max completions reached.")); |
| 1528 | } |
| 1529 | |
| 1530 | /* See completer.h. */ |
| 1531 | |
| 1532 | void |
| 1533 | completion_tracker::add_completions (completion_list &&list) |
| 1534 | { |
| 1535 | for (auto &candidate : list) |
| 1536 | add_completion (std::move (candidate)); |
| 1537 | } |
| 1538 | |
| 1539 | /* Generate completions all at once. Does nothing if max_completions |
| 1540 | is 0. If max_completions is non-negative, this will collect at |
| 1541 | most max_completions strings. |
| 1542 | |
| 1543 | TEXT is the caller's idea of the "word" we are looking at. |
| 1544 | |
| 1545 | LINE_BUFFER is available to be looked at; it contains the entire |
| 1546 | text of the line. |
| 1547 | |
| 1548 | POINT is the offset in that line of the cursor. You |
| 1549 | should pretend that the line ends at POINT. */ |
| 1550 | |
| 1551 | void |
| 1552 | complete_line (completion_tracker &tracker, |
| 1553 | const char *text, const char *line_buffer, int point) |
| 1554 | { |
| 1555 | if (max_completions == 0) |
| 1556 | return; |
| 1557 | complete_line_internal (tracker, text, line_buffer, point, |
| 1558 | handle_completions); |
| 1559 | } |
| 1560 | |
| 1561 | /* Complete on command names. Used by "help". */ |
| 1562 | |
| 1563 | void |
| 1564 | command_completer (struct cmd_list_element *ignore, |
| 1565 | completion_tracker &tracker, |
| 1566 | const char *text, const char *word) |
| 1567 | { |
| 1568 | complete_line_internal (tracker, word, text, |
| 1569 | strlen (text), handle_help); |
| 1570 | } |
| 1571 | |
| 1572 | /* The corresponding completer_handle_brkchars implementation. */ |
| 1573 | |
| 1574 | static void |
| 1575 | command_completer_handle_brkchars (struct cmd_list_element *ignore, |
| 1576 | completion_tracker &tracker, |
| 1577 | const char *text, const char *word) |
| 1578 | { |
| 1579 | set_rl_completer_word_break_characters |
| 1580 | (gdb_completer_command_word_break_characters); |
| 1581 | } |
| 1582 | |
| 1583 | /* Complete on signals. */ |
| 1584 | |
| 1585 | void |
| 1586 | signal_completer (struct cmd_list_element *ignore, |
| 1587 | completion_tracker &tracker, |
| 1588 | const char *text, const char *word) |
| 1589 | { |
| 1590 | size_t len = strlen (word); |
| 1591 | int signum; |
| 1592 | const char *signame; |
| 1593 | |
| 1594 | for (signum = GDB_SIGNAL_FIRST; signum != GDB_SIGNAL_LAST; ++signum) |
| 1595 | { |
| 1596 | /* Can't handle this, so skip it. */ |
| 1597 | if (signum == GDB_SIGNAL_0) |
| 1598 | continue; |
| 1599 | |
| 1600 | signame = gdb_signal_to_name ((enum gdb_signal) signum); |
| 1601 | |
| 1602 | /* Ignore the unknown signal case. */ |
| 1603 | if (!signame || strcmp (signame, "?") == 0) |
| 1604 | continue; |
| 1605 | |
| 1606 | if (strncasecmp (signame, word, len) == 0) |
| 1607 | { |
| 1608 | gdb::unique_xmalloc_ptr<char> copy (xstrdup (signame)); |
| 1609 | tracker.add_completion (std::move (copy)); |
| 1610 | } |
| 1611 | } |
| 1612 | } |
| 1613 | |
| 1614 | /* Bit-flags for selecting what the register and/or register-group |
| 1615 | completer should complete on. */ |
| 1616 | |
| 1617 | enum reg_completer_target |
| 1618 | { |
| 1619 | complete_register_names = 0x1, |
| 1620 | complete_reggroup_names = 0x2 |
| 1621 | }; |
| 1622 | DEF_ENUM_FLAGS_TYPE (enum reg_completer_target, reg_completer_targets); |
| 1623 | |
| 1624 | /* Complete register names and/or reggroup names based on the value passed |
| 1625 | in TARGETS. At least one bit in TARGETS must be set. */ |
| 1626 | |
| 1627 | static void |
| 1628 | reg_or_group_completer_1 (completion_tracker &tracker, |
| 1629 | const char *text, const char *word, |
| 1630 | reg_completer_targets targets) |
| 1631 | { |
| 1632 | size_t len = strlen (word); |
| 1633 | struct gdbarch *gdbarch; |
| 1634 | const char *name; |
| 1635 | |
| 1636 | gdb_assert ((targets & (complete_register_names |
| 1637 | | complete_reggroup_names)) != 0); |
| 1638 | gdbarch = get_current_arch (); |
| 1639 | |
| 1640 | if ((targets & complete_register_names) != 0) |
| 1641 | { |
| 1642 | int i; |
| 1643 | |
| 1644 | for (i = 0; |
| 1645 | (name = user_reg_map_regnum_to_name (gdbarch, i)) != NULL; |
| 1646 | i++) |
| 1647 | { |
| 1648 | if (*name != '\0' && strncmp (word, name, len) == 0) |
| 1649 | { |
| 1650 | gdb::unique_xmalloc_ptr<char> copy (xstrdup (name)); |
| 1651 | tracker.add_completion (std::move (copy)); |
| 1652 | } |
| 1653 | } |
| 1654 | } |
| 1655 | |
| 1656 | if ((targets & complete_reggroup_names) != 0) |
| 1657 | { |
| 1658 | struct reggroup *group; |
| 1659 | |
| 1660 | for (group = reggroup_next (gdbarch, NULL); |
| 1661 | group != NULL; |
| 1662 | group = reggroup_next (gdbarch, group)) |
| 1663 | { |
| 1664 | name = reggroup_name (group); |
| 1665 | if (strncmp (word, name, len) == 0) |
| 1666 | { |
| 1667 | gdb::unique_xmalloc_ptr<char> copy (xstrdup (name)); |
| 1668 | tracker.add_completion (std::move (copy)); |
| 1669 | } |
| 1670 | } |
| 1671 | } |
| 1672 | } |
| 1673 | |
| 1674 | /* Perform completion on register and reggroup names. */ |
| 1675 | |
| 1676 | void |
| 1677 | reg_or_group_completer (struct cmd_list_element *ignore, |
| 1678 | completion_tracker &tracker, |
| 1679 | const char *text, const char *word) |
| 1680 | { |
| 1681 | reg_or_group_completer_1 (tracker, text, word, |
| 1682 | (complete_register_names |
| 1683 | | complete_reggroup_names)); |
| 1684 | } |
| 1685 | |
| 1686 | /* Perform completion on reggroup names. */ |
| 1687 | |
| 1688 | void |
| 1689 | reggroup_completer (struct cmd_list_element *ignore, |
| 1690 | completion_tracker &tracker, |
| 1691 | const char *text, const char *word) |
| 1692 | { |
| 1693 | reg_or_group_completer_1 (tracker, text, word, |
| 1694 | complete_reggroup_names); |
| 1695 | } |
| 1696 | |
| 1697 | /* The default completer_handle_brkchars implementation. */ |
| 1698 | |
| 1699 | static void |
| 1700 | default_completer_handle_brkchars (struct cmd_list_element *ignore, |
| 1701 | completion_tracker &tracker, |
| 1702 | const char *text, const char *word) |
| 1703 | { |
| 1704 | set_rl_completer_word_break_characters |
| 1705 | (current_language->la_word_break_characters ()); |
| 1706 | } |
| 1707 | |
| 1708 | /* See definition in completer.h. */ |
| 1709 | |
| 1710 | completer_handle_brkchars_ftype * |
| 1711 | completer_handle_brkchars_func_for_completer (completer_ftype *fn) |
| 1712 | { |
| 1713 | if (fn == filename_completer) |
| 1714 | return filename_completer_handle_brkchars; |
| 1715 | |
| 1716 | if (fn == location_completer) |
| 1717 | return location_completer_handle_brkchars; |
| 1718 | |
| 1719 | if (fn == command_completer) |
| 1720 | return command_completer_handle_brkchars; |
| 1721 | |
| 1722 | return default_completer_handle_brkchars; |
| 1723 | } |
| 1724 | |
| 1725 | /* Used as brkchars when we want to tell readline we have a custom |
| 1726 | word point. We do that by making our rl_completion_word_break_hook |
| 1727 | set RL_POINT to the desired word point, and return the character at |
| 1728 | the word break point as the break char. This is two bytes in order |
| 1729 | to fit one break character plus the terminating null. */ |
| 1730 | static char gdb_custom_word_point_brkchars[2]; |
| 1731 | |
| 1732 | /* Since rl_basic_quote_characters is not completer-specific, we save |
| 1733 | its original value here, in order to be able to restore it in |
| 1734 | gdb_rl_attempted_completion_function. */ |
| 1735 | static const char *gdb_org_rl_basic_quote_characters = rl_basic_quote_characters; |
| 1736 | |
| 1737 | /* Get the list of chars that are considered as word breaks |
| 1738 | for the current command. */ |
| 1739 | |
| 1740 | static char * |
| 1741 | gdb_completion_word_break_characters_throw () |
| 1742 | { |
| 1743 | /* New completion starting. Get rid of the previous tracker and |
| 1744 | start afresh. */ |
| 1745 | delete current_completion.tracker; |
| 1746 | current_completion.tracker = new completion_tracker (); |
| 1747 | |
| 1748 | completion_tracker &tracker = *current_completion.tracker; |
| 1749 | |
| 1750 | complete_line_internal (tracker, NULL, rl_line_buffer, |
| 1751 | rl_point, handle_brkchars); |
| 1752 | |
| 1753 | if (tracker.use_custom_word_point ()) |
| 1754 | { |
| 1755 | gdb_assert (tracker.custom_word_point () > 0); |
| 1756 | rl_point = tracker.custom_word_point () - 1; |
| 1757 | gdb_custom_word_point_brkchars[0] = rl_line_buffer[rl_point]; |
| 1758 | rl_completer_word_break_characters = gdb_custom_word_point_brkchars; |
| 1759 | rl_completer_quote_characters = NULL; |
| 1760 | |
| 1761 | /* Clear this too, so that if we're completing a quoted string, |
| 1762 | readline doesn't consider the quote character a delimiter. |
| 1763 | If we didn't do this, readline would auto-complete {b |
| 1764 | 'fun<tab>} to {'b 'function()'}, i.e., add the terminating |
| 1765 | \', but, it wouldn't append the separator space either, which |
| 1766 | is not desirable. So instead we take care of appending the |
| 1767 | quote character to the LCD ourselves, in |
| 1768 | gdb_rl_attempted_completion_function. Since this global is |
| 1769 | not just completer-specific, we'll restore it back to the |
| 1770 | default in gdb_rl_attempted_completion_function. */ |
| 1771 | rl_basic_quote_characters = NULL; |
| 1772 | } |
| 1773 | |
| 1774 | return rl_completer_word_break_characters; |
| 1775 | } |
| 1776 | |
| 1777 | char * |
| 1778 | gdb_completion_word_break_characters () |
| 1779 | { |
| 1780 | /* New completion starting. */ |
| 1781 | current_completion.aborted = false; |
| 1782 | |
| 1783 | TRY |
| 1784 | { |
| 1785 | return gdb_completion_word_break_characters_throw (); |
| 1786 | } |
| 1787 | CATCH (ex, RETURN_MASK_ALL) |
| 1788 | { |
| 1789 | /* Set this to that gdb_rl_attempted_completion_function knows |
| 1790 | to abort early. */ |
| 1791 | current_completion.aborted = true; |
| 1792 | } |
| 1793 | END_CATCH |
| 1794 | |
| 1795 | return NULL; |
| 1796 | } |
| 1797 | |
| 1798 | /* See completer.h. */ |
| 1799 | |
| 1800 | const char * |
| 1801 | completion_find_completion_word (completion_tracker &tracker, const char *text, |
| 1802 | int *quote_char) |
| 1803 | { |
| 1804 | size_t point = strlen (text); |
| 1805 | |
| 1806 | complete_line_internal (tracker, NULL, text, point, handle_brkchars); |
| 1807 | |
| 1808 | if (tracker.use_custom_word_point ()) |
| 1809 | { |
| 1810 | gdb_assert (tracker.custom_word_point () > 0); |
| 1811 | *quote_char = tracker.quote_char (); |
| 1812 | return text + tracker.custom_word_point (); |
| 1813 | } |
| 1814 | |
| 1815 | gdb_rl_completion_word_info info; |
| 1816 | |
| 1817 | info.word_break_characters = rl_completer_word_break_characters; |
| 1818 | info.quote_characters = gdb_completer_quote_characters; |
| 1819 | info.basic_quote_characters = rl_basic_quote_characters; |
| 1820 | |
| 1821 | return gdb_rl_find_completion_word (&info, quote_char, NULL, text); |
| 1822 | } |
| 1823 | |
| 1824 | /* See completer.h. */ |
| 1825 | |
| 1826 | void |
| 1827 | completion_tracker::recompute_lowest_common_denominator (const char *new_match) |
| 1828 | { |
| 1829 | if (m_lowest_common_denominator == NULL) |
| 1830 | { |
| 1831 | /* We don't have a lowest common denominator yet, so simply take |
| 1832 | the whole NEW_MATCH as being it. */ |
| 1833 | m_lowest_common_denominator = xstrdup (new_match); |
| 1834 | m_lowest_common_denominator_unique = true; |
| 1835 | } |
| 1836 | else |
| 1837 | { |
| 1838 | /* Find the common denominator between the currently-known |
| 1839 | lowest common denominator and NEW_MATCH. That becomes the |
| 1840 | new lowest common denominator. */ |
| 1841 | size_t i; |
| 1842 | |
| 1843 | for (i = 0; |
| 1844 | (new_match[i] != '\0' |
| 1845 | && new_match[i] == m_lowest_common_denominator[i]); |
| 1846 | i++) |
| 1847 | ; |
| 1848 | if (m_lowest_common_denominator[i] != new_match[i]) |
| 1849 | { |
| 1850 | m_lowest_common_denominator[i] = '\0'; |
| 1851 | m_lowest_common_denominator_unique = false; |
| 1852 | } |
| 1853 | } |
| 1854 | } |
| 1855 | |
| 1856 | /* See completer.h. */ |
| 1857 | |
| 1858 | void |
| 1859 | completion_tracker::advance_custom_word_point_by (size_t len) |
| 1860 | { |
| 1861 | m_custom_word_point += len; |
| 1862 | } |
| 1863 | |
| 1864 | /* Build a new C string that is a copy of LCD with the whitespace of |
| 1865 | ORIG/ORIG_LEN preserved. |
| 1866 | |
| 1867 | Say the user is completing a symbol name, with spaces, like: |
| 1868 | |
| 1869 | "foo ( i" |
| 1870 | |
| 1871 | and the resulting completion match is: |
| 1872 | |
| 1873 | "foo(int)" |
| 1874 | |
| 1875 | we want to end up with an input line like: |
| 1876 | |
| 1877 | "foo ( int)" |
| 1878 | ^^^^^^^ => text from LCD [1], whitespace from ORIG preserved. |
| 1879 | ^^ => new text from LCD |
| 1880 | |
| 1881 | [1] - We must take characters from the LCD instead of the original |
| 1882 | text, since some completions want to change upper/lowercase. E.g.: |
| 1883 | |
| 1884 | "handle sig<>" |
| 1885 | |
| 1886 | completes to: |
| 1887 | |
| 1888 | "handle SIG[QUIT|etc.]" |
| 1889 | */ |
| 1890 | |
| 1891 | static char * |
| 1892 | expand_preserving_ws (const char *orig, size_t orig_len, |
| 1893 | const char *lcd) |
| 1894 | { |
| 1895 | const char *p_orig = orig; |
| 1896 | const char *orig_end = orig + orig_len; |
| 1897 | const char *p_lcd = lcd; |
| 1898 | std::string res; |
| 1899 | |
| 1900 | while (p_orig < orig_end) |
| 1901 | { |
| 1902 | if (*p_orig == ' ') |
| 1903 | { |
| 1904 | while (p_orig < orig_end && *p_orig == ' ') |
| 1905 | res += *p_orig++; |
| 1906 | p_lcd = skip_spaces (p_lcd); |
| 1907 | } |
| 1908 | else |
| 1909 | { |
| 1910 | /* Take characters from the LCD instead of the original |
| 1911 | text, since some completions change upper/lowercase. |
| 1912 | E.g.: |
| 1913 | "handle sig<>" |
| 1914 | completes to: |
| 1915 | "handle SIG[QUIT|etc.]" |
| 1916 | */ |
| 1917 | res += *p_lcd; |
| 1918 | p_orig++; |
| 1919 | p_lcd++; |
| 1920 | } |
| 1921 | } |
| 1922 | |
| 1923 | while (*p_lcd != '\0') |
| 1924 | res += *p_lcd++; |
| 1925 | |
| 1926 | return xstrdup (res.c_str ()); |
| 1927 | } |
| 1928 | |
| 1929 | /* See completer.h. */ |
| 1930 | |
| 1931 | completion_result |
| 1932 | completion_tracker::build_completion_result (const char *text, |
| 1933 | int start, int end) |
| 1934 | { |
| 1935 | completion_list &list = m_entries_vec; /* The completions. */ |
| 1936 | |
| 1937 | if (list.empty ()) |
| 1938 | return {}; |
| 1939 | |
| 1940 | /* +1 for the LCD, and +1 for NULL termination. */ |
| 1941 | char **match_list = XNEWVEC (char *, 1 + list.size () + 1); |
| 1942 | |
| 1943 | /* Build replacement word, based on the LCD. */ |
| 1944 | |
| 1945 | match_list[0] |
| 1946 | = expand_preserving_ws (text, end - start, |
| 1947 | m_lowest_common_denominator); |
| 1948 | |
| 1949 | if (m_lowest_common_denominator_unique) |
| 1950 | { |
| 1951 | /* We don't rely on readline appending the quote char as |
| 1952 | delimiter as then readline wouldn't append the ' ' after the |
| 1953 | completion. */ |
| 1954 | char buf[2] = { quote_char () }; |
| 1955 | |
| 1956 | match_list[0] = reconcat (match_list[0], match_list[0], |
| 1957 | buf, (char *) NULL); |
| 1958 | match_list[1] = NULL; |
| 1959 | |
| 1960 | /* If the tracker wants to, or we already have a space at the |
| 1961 | end of the match, tell readline to skip appending |
| 1962 | another. */ |
| 1963 | bool completion_suppress_append |
| 1964 | = (suppress_append_ws () |
| 1965 | || match_list[0][strlen (match_list[0]) - 1] == ' '); |
| 1966 | |
| 1967 | return completion_result (match_list, 1, completion_suppress_append); |
| 1968 | } |
| 1969 | else |
| 1970 | { |
| 1971 | int ix; |
| 1972 | |
| 1973 | for (ix = 0; ix < list.size (); ++ix) |
| 1974 | match_list[ix + 1] = list[ix].release (); |
| 1975 | match_list[ix + 1] = NULL; |
| 1976 | |
| 1977 | return completion_result (match_list, list.size (), false); |
| 1978 | } |
| 1979 | } |
| 1980 | |
| 1981 | /* See completer.h */ |
| 1982 | |
| 1983 | completion_result::completion_result () |
| 1984 | : match_list (NULL), number_matches (0), |
| 1985 | completion_suppress_append (false) |
| 1986 | {} |
| 1987 | |
| 1988 | /* See completer.h */ |
| 1989 | |
| 1990 | completion_result::completion_result (char **match_list_, |
| 1991 | size_t number_matches_, |
| 1992 | bool completion_suppress_append_) |
| 1993 | : match_list (match_list_), |
| 1994 | number_matches (number_matches_), |
| 1995 | completion_suppress_append (completion_suppress_append_) |
| 1996 | {} |
| 1997 | |
| 1998 | /* See completer.h */ |
| 1999 | |
| 2000 | completion_result::~completion_result () |
| 2001 | { |
| 2002 | reset_match_list (); |
| 2003 | } |
| 2004 | |
| 2005 | /* See completer.h */ |
| 2006 | |
| 2007 | completion_result::completion_result (completion_result &&rhs) |
| 2008 | { |
| 2009 | if (this == &rhs) |
| 2010 | return; |
| 2011 | |
| 2012 | reset_match_list (); |
| 2013 | match_list = rhs.match_list; |
| 2014 | rhs.match_list = NULL; |
| 2015 | number_matches = rhs.number_matches; |
| 2016 | rhs.number_matches = 0; |
| 2017 | } |
| 2018 | |
| 2019 | /* See completer.h */ |
| 2020 | |
| 2021 | char ** |
| 2022 | completion_result::release_match_list () |
| 2023 | { |
| 2024 | char **ret = match_list; |
| 2025 | match_list = NULL; |
| 2026 | return ret; |
| 2027 | } |
| 2028 | |
| 2029 | /* See completer.h */ |
| 2030 | |
| 2031 | void |
| 2032 | completion_result::sort_match_list () |
| 2033 | { |
| 2034 | if (number_matches > 1) |
| 2035 | { |
| 2036 | /* Element 0 is special (it's the common prefix), leave it |
| 2037 | be. */ |
| 2038 | std::sort (&match_list[1], |
| 2039 | &match_list[number_matches + 1], |
| 2040 | compare_cstrings); |
| 2041 | } |
| 2042 | } |
| 2043 | |
| 2044 | /* See completer.h */ |
| 2045 | |
| 2046 | void |
| 2047 | completion_result::reset_match_list () |
| 2048 | { |
| 2049 | if (match_list != NULL) |
| 2050 | { |
| 2051 | for (char **p = match_list; *p != NULL; p++) |
| 2052 | xfree (*p); |
| 2053 | xfree (match_list); |
| 2054 | match_list = NULL; |
| 2055 | } |
| 2056 | } |
| 2057 | |
| 2058 | /* Helper for gdb_rl_attempted_completion_function, which does most of |
| 2059 | the work. This is called by readline to build the match list array |
| 2060 | and to determine the lowest common denominator. The real matches |
| 2061 | list starts at match[1], while match[0] is the slot holding |
| 2062 | readline's idea of the lowest common denominator of all matches, |
| 2063 | which is what readline replaces the completion "word" with. |
| 2064 | |
| 2065 | TEXT is the caller's idea of the "word" we are looking at, as |
| 2066 | computed in the handle_brkchars phase. |
| 2067 | |
| 2068 | START is the offset from RL_LINE_BUFFER where TEXT starts. END is |
| 2069 | the offset from RL_LINE_BUFFER where TEXT ends (i.e., where |
| 2070 | rl_point is). |
| 2071 | |
| 2072 | You should thus pretend that the line ends at END (relative to |
| 2073 | RL_LINE_BUFFER). |
| 2074 | |
| 2075 | RL_LINE_BUFFER contains the entire text of the line. RL_POINT is |
| 2076 | the offset in that line of the cursor. You should pretend that the |
| 2077 | line ends at POINT. |
| 2078 | |
| 2079 | Returns NULL if there are no completions. */ |
| 2080 | |
| 2081 | static char ** |
| 2082 | gdb_rl_attempted_completion_function_throw (const char *text, int start, int end) |
| 2083 | { |
| 2084 | /* Completers that provide a custom word point in the |
| 2085 | handle_brkchars phase also compute their completions then. |
| 2086 | Completers that leave the completion word handling to readline |
| 2087 | must be called twice. If rl_point (i.e., END) is at column 0, |
| 2088 | then readline skips the handle_brkchars phase, and so we create a |
| 2089 | tracker now in that case too. */ |
| 2090 | if (end == 0 || !current_completion.tracker->use_custom_word_point ()) |
| 2091 | { |
| 2092 | delete current_completion.tracker; |
| 2093 | current_completion.tracker = new completion_tracker (); |
| 2094 | |
| 2095 | complete_line (*current_completion.tracker, text, |
| 2096 | rl_line_buffer, rl_point); |
| 2097 | } |
| 2098 | |
| 2099 | completion_tracker &tracker = *current_completion.tracker; |
| 2100 | |
| 2101 | completion_result result |
| 2102 | = tracker.build_completion_result (text, start, end); |
| 2103 | |
| 2104 | rl_completion_suppress_append = result.completion_suppress_append; |
| 2105 | return result.release_match_list (); |
| 2106 | } |
| 2107 | |
| 2108 | /* Function installed as "rl_attempted_completion_function" readline |
| 2109 | hook. Wrapper around gdb_rl_attempted_completion_function_throw |
| 2110 | that catches C++ exceptions, which can't cross readline. */ |
| 2111 | |
| 2112 | char ** |
| 2113 | gdb_rl_attempted_completion_function (const char *text, int start, int end) |
| 2114 | { |
| 2115 | /* Restore globals that might have been tweaked in |
| 2116 | gdb_completion_word_break_characters. */ |
| 2117 | rl_basic_quote_characters = gdb_org_rl_basic_quote_characters; |
| 2118 | |
| 2119 | /* If we end up returning NULL, either on error, or simple because |
| 2120 | there are no matches, inhibit readline's default filename |
| 2121 | completer. */ |
| 2122 | rl_attempted_completion_over = 1; |
| 2123 | |
| 2124 | /* If the handle_brkchars phase was aborted, don't try |
| 2125 | completing. */ |
| 2126 | if (current_completion.aborted) |
| 2127 | return NULL; |
| 2128 | |
| 2129 | TRY |
| 2130 | { |
| 2131 | return gdb_rl_attempted_completion_function_throw (text, start, end); |
| 2132 | } |
| 2133 | CATCH (ex, RETURN_MASK_ALL) |
| 2134 | { |
| 2135 | } |
| 2136 | END_CATCH |
| 2137 | |
| 2138 | return NULL; |
| 2139 | } |
| 2140 | |
| 2141 | /* Skip over the possibly quoted word STR (as defined by the quote |
| 2142 | characters QUOTECHARS and the word break characters BREAKCHARS). |
| 2143 | Returns pointer to the location after the "word". If either |
| 2144 | QUOTECHARS or BREAKCHARS is NULL, use the same values used by the |
| 2145 | completer. */ |
| 2146 | |
| 2147 | const char * |
| 2148 | skip_quoted_chars (const char *str, const char *quotechars, |
| 2149 | const char *breakchars) |
| 2150 | { |
| 2151 | char quote_char = '\0'; |
| 2152 | const char *scan; |
| 2153 | |
| 2154 | if (quotechars == NULL) |
| 2155 | quotechars = gdb_completer_quote_characters; |
| 2156 | |
| 2157 | if (breakchars == NULL) |
| 2158 | breakchars = current_language->la_word_break_characters(); |
| 2159 | |
| 2160 | for (scan = str; *scan != '\0'; scan++) |
| 2161 | { |
| 2162 | if (quote_char != '\0') |
| 2163 | { |
| 2164 | /* Ignore everything until the matching close quote char. */ |
| 2165 | if (*scan == quote_char) |
| 2166 | { |
| 2167 | /* Found matching close quote. */ |
| 2168 | scan++; |
| 2169 | break; |
| 2170 | } |
| 2171 | } |
| 2172 | else if (strchr (quotechars, *scan)) |
| 2173 | { |
| 2174 | /* Found start of a quoted string. */ |
| 2175 | quote_char = *scan; |
| 2176 | } |
| 2177 | else if (strchr (breakchars, *scan)) |
| 2178 | { |
| 2179 | break; |
| 2180 | } |
| 2181 | } |
| 2182 | |
| 2183 | return (scan); |
| 2184 | } |
| 2185 | |
| 2186 | /* Skip over the possibly quoted word STR (as defined by the quote |
| 2187 | characters and word break characters used by the completer). |
| 2188 | Returns pointer to the location after the "word". */ |
| 2189 | |
| 2190 | const char * |
| 2191 | skip_quoted (const char *str) |
| 2192 | { |
| 2193 | return skip_quoted_chars (str, NULL, NULL); |
| 2194 | } |
| 2195 | |
| 2196 | /* Return a message indicating that the maximum number of completions |
| 2197 | has been reached and that there may be more. */ |
| 2198 | |
| 2199 | const char * |
| 2200 | get_max_completions_reached_message (void) |
| 2201 | { |
| 2202 | return _("*** List may be truncated, max-completions reached. ***"); |
| 2203 | } |
| 2204 | \f |
| 2205 | /* GDB replacement for rl_display_match_list. |
| 2206 | Readline doesn't provide a clean interface for TUI(curses). |
| 2207 | A hack previously used was to send readline's rl_outstream through a pipe |
| 2208 | and read it from the event loop. Bleah. IWBN if readline abstracted |
| 2209 | away all the necessary bits, and this is what this code does. It |
| 2210 | replicates the parts of readline we need and then adds an abstraction |
| 2211 | layer, currently implemented as struct match_list_displayer, so that both |
| 2212 | CLI and TUI can use it. We copy all this readline code to minimize |
| 2213 | GDB-specific mods to readline. Once this code performs as desired then |
| 2214 | we can submit it to the readline maintainers. |
| 2215 | |
| 2216 | N.B. A lot of the code is the way it is in order to minimize differences |
| 2217 | from readline's copy. */ |
| 2218 | |
| 2219 | /* Not supported here. */ |
| 2220 | #undef VISIBLE_STATS |
| 2221 | |
| 2222 | #if defined (HANDLE_MULTIBYTE) |
| 2223 | #define MB_INVALIDCH(x) ((x) == (size_t)-1 || (x) == (size_t)-2) |
| 2224 | #define MB_NULLWCH(x) ((x) == 0) |
| 2225 | #endif |
| 2226 | |
| 2227 | #define ELLIPSIS_LEN 3 |
| 2228 | |
| 2229 | /* gdb version of readline/complete.c:get_y_or_n. |
| 2230 | 'y' -> returns 1, and 'n' -> returns 0. |
| 2231 | Also supported: space == 'y', RUBOUT == 'n', ctrl-g == start over. |
| 2232 | If FOR_PAGER is non-zero, then also supported are: |
| 2233 | NEWLINE or RETURN -> returns 2, and 'q' -> returns 0. */ |
| 2234 | |
| 2235 | static int |
| 2236 | gdb_get_y_or_n (int for_pager, const struct match_list_displayer *displayer) |
| 2237 | { |
| 2238 | int c; |
| 2239 | |
| 2240 | for (;;) |
| 2241 | { |
| 2242 | RL_SETSTATE (RL_STATE_MOREINPUT); |
| 2243 | c = displayer->read_key (displayer); |
| 2244 | RL_UNSETSTATE (RL_STATE_MOREINPUT); |
| 2245 | |
| 2246 | if (c == 'y' || c == 'Y' || c == ' ') |
| 2247 | return 1; |
| 2248 | if (c == 'n' || c == 'N' || c == RUBOUT) |
| 2249 | return 0; |
| 2250 | if (c == ABORT_CHAR || c < 0) |
| 2251 | { |
| 2252 | /* Readline doesn't erase_entire_line here, but without it the |
| 2253 | --More-- prompt isn't erased and neither is the text entered |
| 2254 | thus far redisplayed. */ |
| 2255 | displayer->erase_entire_line (displayer); |
| 2256 | /* Note: The arguments to rl_abort are ignored. */ |
| 2257 | rl_abort (0, 0); |
| 2258 | } |
| 2259 | if (for_pager && (c == NEWLINE || c == RETURN)) |
| 2260 | return 2; |
| 2261 | if (for_pager && (c == 'q' || c == 'Q')) |
| 2262 | return 0; |
| 2263 | displayer->beep (displayer); |
| 2264 | } |
| 2265 | } |
| 2266 | |
| 2267 | /* Pager function for tab-completion. |
| 2268 | This is based on readline/complete.c:_rl_internal_pager. |
| 2269 | LINES is the number of lines of output displayed thus far. |
| 2270 | Returns: |
| 2271 | -1 -> user pressed 'n' or equivalent, |
| 2272 | 0 -> user pressed 'y' or equivalent, |
| 2273 | N -> user pressed NEWLINE or equivalent and N is LINES - 1. */ |
| 2274 | |
| 2275 | static int |
| 2276 | gdb_display_match_list_pager (int lines, |
| 2277 | const struct match_list_displayer *displayer) |
| 2278 | { |
| 2279 | int i; |
| 2280 | |
| 2281 | displayer->puts (displayer, "--More--"); |
| 2282 | displayer->flush (displayer); |
| 2283 | i = gdb_get_y_or_n (1, displayer); |
| 2284 | displayer->erase_entire_line (displayer); |
| 2285 | if (i == 0) |
| 2286 | return -1; |
| 2287 | else if (i == 2) |
| 2288 | return (lines - 1); |
| 2289 | else |
| 2290 | return 0; |
| 2291 | } |
| 2292 | |
| 2293 | /* Return non-zero if FILENAME is a directory. |
| 2294 | Based on readline/complete.c:path_isdir. */ |
| 2295 | |
| 2296 | static int |
| 2297 | gdb_path_isdir (const char *filename) |
| 2298 | { |
| 2299 | struct stat finfo; |
| 2300 | |
| 2301 | return (stat (filename, &finfo) == 0 && S_ISDIR (finfo.st_mode)); |
| 2302 | } |
| 2303 | |
| 2304 | /* Return the portion of PATHNAME that should be output when listing |
| 2305 | possible completions. If we are hacking filename completion, we |
| 2306 | are only interested in the basename, the portion following the |
| 2307 | final slash. Otherwise, we return what we were passed. Since |
| 2308 | printing empty strings is not very informative, if we're doing |
| 2309 | filename completion, and the basename is the empty string, we look |
| 2310 | for the previous slash and return the portion following that. If |
| 2311 | there's no previous slash, we just return what we were passed. |
| 2312 | |
| 2313 | Based on readline/complete.c:printable_part. */ |
| 2314 | |
| 2315 | static char * |
| 2316 | gdb_printable_part (char *pathname) |
| 2317 | { |
| 2318 | char *temp, *x; |
| 2319 | |
| 2320 | if (rl_filename_completion_desired == 0) /* don't need to do anything */ |
| 2321 | return (pathname); |
| 2322 | |
| 2323 | temp = strrchr (pathname, '/'); |
| 2324 | #if defined (__MSDOS__) |
| 2325 | if (temp == 0 && ISALPHA ((unsigned char)pathname[0]) && pathname[1] == ':') |
| 2326 | temp = pathname + 1; |
| 2327 | #endif |
| 2328 | |
| 2329 | if (temp == 0 || *temp == '\0') |
| 2330 | return (pathname); |
| 2331 | /* If the basename is NULL, we might have a pathname like '/usr/src/'. |
| 2332 | Look for a previous slash and, if one is found, return the portion |
| 2333 | following that slash. If there's no previous slash, just return the |
| 2334 | pathname we were passed. */ |
| 2335 | else if (temp[1] == '\0') |
| 2336 | { |
| 2337 | for (x = temp - 1; x > pathname; x--) |
| 2338 | if (*x == '/') |
| 2339 | break; |
| 2340 | return ((*x == '/') ? x + 1 : pathname); |
| 2341 | } |
| 2342 | else |
| 2343 | return ++temp; |
| 2344 | } |
| 2345 | |
| 2346 | /* Compute width of STRING when displayed on screen by print_filename. |
| 2347 | Based on readline/complete.c:fnwidth. */ |
| 2348 | |
| 2349 | static int |
| 2350 | gdb_fnwidth (const char *string) |
| 2351 | { |
| 2352 | int width, pos; |
| 2353 | #if defined (HANDLE_MULTIBYTE) |
| 2354 | mbstate_t ps; |
| 2355 | int left, w; |
| 2356 | size_t clen; |
| 2357 | wchar_t wc; |
| 2358 | |
| 2359 | left = strlen (string) + 1; |
| 2360 | memset (&ps, 0, sizeof (mbstate_t)); |
| 2361 | #endif |
| 2362 | |
| 2363 | width = pos = 0; |
| 2364 | while (string[pos]) |
| 2365 | { |
| 2366 | if (CTRL_CHAR (string[pos]) || string[pos] == RUBOUT) |
| 2367 | { |
| 2368 | width += 2; |
| 2369 | pos++; |
| 2370 | } |
| 2371 | else |
| 2372 | { |
| 2373 | #if defined (HANDLE_MULTIBYTE) |
| 2374 | clen = mbrtowc (&wc, string + pos, left - pos, &ps); |
| 2375 | if (MB_INVALIDCH (clen)) |
| 2376 | { |
| 2377 | width++; |
| 2378 | pos++; |
| 2379 | memset (&ps, 0, sizeof (mbstate_t)); |
| 2380 | } |
| 2381 | else if (MB_NULLWCH (clen)) |
| 2382 | break; |
| 2383 | else |
| 2384 | { |
| 2385 | pos += clen; |
| 2386 | w = wcwidth (wc); |
| 2387 | width += (w >= 0) ? w : 1; |
| 2388 | } |
| 2389 | #else |
| 2390 | width++; |
| 2391 | pos++; |
| 2392 | #endif |
| 2393 | } |
| 2394 | } |
| 2395 | |
| 2396 | return width; |
| 2397 | } |
| 2398 | |
| 2399 | /* Print TO_PRINT, one matching completion. |
| 2400 | PREFIX_BYTES is number of common prefix bytes. |
| 2401 | Based on readline/complete.c:fnprint. */ |
| 2402 | |
| 2403 | static int |
| 2404 | gdb_fnprint (const char *to_print, int prefix_bytes, |
| 2405 | const struct match_list_displayer *displayer) |
| 2406 | { |
| 2407 | int printed_len, w; |
| 2408 | const char *s; |
| 2409 | #if defined (HANDLE_MULTIBYTE) |
| 2410 | mbstate_t ps; |
| 2411 | const char *end; |
| 2412 | size_t tlen; |
| 2413 | int width; |
| 2414 | wchar_t wc; |
| 2415 | |
| 2416 | end = to_print + strlen (to_print) + 1; |
| 2417 | memset (&ps, 0, sizeof (mbstate_t)); |
| 2418 | #endif |
| 2419 | |
| 2420 | printed_len = 0; |
| 2421 | |
| 2422 | /* Don't print only the ellipsis if the common prefix is one of the |
| 2423 | possible completions */ |
| 2424 | if (to_print[prefix_bytes] == '\0') |
| 2425 | prefix_bytes = 0; |
| 2426 | |
| 2427 | if (prefix_bytes) |
| 2428 | { |
| 2429 | char ellipsis; |
| 2430 | |
| 2431 | ellipsis = (to_print[prefix_bytes] == '.') ? '_' : '.'; |
| 2432 | for (w = 0; w < ELLIPSIS_LEN; w++) |
| 2433 | displayer->putch (displayer, ellipsis); |
| 2434 | printed_len = ELLIPSIS_LEN; |
| 2435 | } |
| 2436 | |
| 2437 | s = to_print + prefix_bytes; |
| 2438 | while (*s) |
| 2439 | { |
| 2440 | if (CTRL_CHAR (*s)) |
| 2441 | { |
| 2442 | displayer->putch (displayer, '^'); |
| 2443 | displayer->putch (displayer, UNCTRL (*s)); |
| 2444 | printed_len += 2; |
| 2445 | s++; |
| 2446 | #if defined (HANDLE_MULTIBYTE) |
| 2447 | memset (&ps, 0, sizeof (mbstate_t)); |
| 2448 | #endif |
| 2449 | } |
| 2450 | else if (*s == RUBOUT) |
| 2451 | { |
| 2452 | displayer->putch (displayer, '^'); |
| 2453 | displayer->putch (displayer, '?'); |
| 2454 | printed_len += 2; |
| 2455 | s++; |
| 2456 | #if defined (HANDLE_MULTIBYTE) |
| 2457 | memset (&ps, 0, sizeof (mbstate_t)); |
| 2458 | #endif |
| 2459 | } |
| 2460 | else |
| 2461 | { |
| 2462 | #if defined (HANDLE_MULTIBYTE) |
| 2463 | tlen = mbrtowc (&wc, s, end - s, &ps); |
| 2464 | if (MB_INVALIDCH (tlen)) |
| 2465 | { |
| 2466 | tlen = 1; |
| 2467 | width = 1; |
| 2468 | memset (&ps, 0, sizeof (mbstate_t)); |
| 2469 | } |
| 2470 | else if (MB_NULLWCH (tlen)) |
| 2471 | break; |
| 2472 | else |
| 2473 | { |
| 2474 | w = wcwidth (wc); |
| 2475 | width = (w >= 0) ? w : 1; |
| 2476 | } |
| 2477 | for (w = 0; w < tlen; ++w) |
| 2478 | displayer->putch (displayer, s[w]); |
| 2479 | s += tlen; |
| 2480 | printed_len += width; |
| 2481 | #else |
| 2482 | displayer->putch (displayer, *s); |
| 2483 | s++; |
| 2484 | printed_len++; |
| 2485 | #endif |
| 2486 | } |
| 2487 | } |
| 2488 | |
| 2489 | return printed_len; |
| 2490 | } |
| 2491 | |
| 2492 | /* Output TO_PRINT to rl_outstream. If VISIBLE_STATS is defined and we |
| 2493 | are using it, check for and output a single character for `special' |
| 2494 | filenames. Return the number of characters we output. |
| 2495 | Based on readline/complete.c:print_filename. */ |
| 2496 | |
| 2497 | static int |
| 2498 | gdb_print_filename (char *to_print, char *full_pathname, int prefix_bytes, |
| 2499 | const struct match_list_displayer *displayer) |
| 2500 | { |
| 2501 | int printed_len, extension_char, slen, tlen; |
| 2502 | char *s, c, *new_full_pathname; |
| 2503 | const char *dn; |
| 2504 | extern int _rl_complete_mark_directories; |
| 2505 | |
| 2506 | extension_char = 0; |
| 2507 | printed_len = gdb_fnprint (to_print, prefix_bytes, displayer); |
| 2508 | |
| 2509 | #if defined (VISIBLE_STATS) |
| 2510 | if (rl_filename_completion_desired && (rl_visible_stats || _rl_complete_mark_directories)) |
| 2511 | #else |
| 2512 | if (rl_filename_completion_desired && _rl_complete_mark_directories) |
| 2513 | #endif |
| 2514 | { |
| 2515 | /* If to_print != full_pathname, to_print is the basename of the |
| 2516 | path passed. In this case, we try to expand the directory |
| 2517 | name before checking for the stat character. */ |
| 2518 | if (to_print != full_pathname) |
| 2519 | { |
| 2520 | /* Terminate the directory name. */ |
| 2521 | c = to_print[-1]; |
| 2522 | to_print[-1] = '\0'; |
| 2523 | |
| 2524 | /* If setting the last slash in full_pathname to a NUL results in |
| 2525 | full_pathname being the empty string, we are trying to complete |
| 2526 | files in the root directory. If we pass a null string to the |
| 2527 | bash directory completion hook, for example, it will expand it |
| 2528 | to the current directory. We just want the `/'. */ |
| 2529 | if (full_pathname == 0 || *full_pathname == 0) |
| 2530 | dn = "/"; |
| 2531 | else if (full_pathname[0] != '/') |
| 2532 | dn = full_pathname; |
| 2533 | else if (full_pathname[1] == 0) |
| 2534 | dn = "//"; /* restore trailing slash to `//' */ |
| 2535 | else if (full_pathname[1] == '/' && full_pathname[2] == 0) |
| 2536 | dn = "/"; /* don't turn /// into // */ |
| 2537 | else |
| 2538 | dn = full_pathname; |
| 2539 | s = tilde_expand (dn); |
| 2540 | if (rl_directory_completion_hook) |
| 2541 | (*rl_directory_completion_hook) (&s); |
| 2542 | |
| 2543 | slen = strlen (s); |
| 2544 | tlen = strlen (to_print); |
| 2545 | new_full_pathname = (char *)xmalloc (slen + tlen + 2); |
| 2546 | strcpy (new_full_pathname, s); |
| 2547 | if (s[slen - 1] == '/') |
| 2548 | slen--; |
| 2549 | else |
| 2550 | new_full_pathname[slen] = '/'; |
| 2551 | new_full_pathname[slen] = '/'; |
| 2552 | strcpy (new_full_pathname + slen + 1, to_print); |
| 2553 | |
| 2554 | #if defined (VISIBLE_STATS) |
| 2555 | if (rl_visible_stats) |
| 2556 | extension_char = stat_char (new_full_pathname); |
| 2557 | else |
| 2558 | #endif |
| 2559 | if (gdb_path_isdir (new_full_pathname)) |
| 2560 | extension_char = '/'; |
| 2561 | |
| 2562 | xfree (new_full_pathname); |
| 2563 | to_print[-1] = c; |
| 2564 | } |
| 2565 | else |
| 2566 | { |
| 2567 | s = tilde_expand (full_pathname); |
| 2568 | #if defined (VISIBLE_STATS) |
| 2569 | if (rl_visible_stats) |
| 2570 | extension_char = stat_char (s); |
| 2571 | else |
| 2572 | #endif |
| 2573 | if (gdb_path_isdir (s)) |
| 2574 | extension_char = '/'; |
| 2575 | } |
| 2576 | |
| 2577 | xfree (s); |
| 2578 | if (extension_char) |
| 2579 | { |
| 2580 | displayer->putch (displayer, extension_char); |
| 2581 | printed_len++; |
| 2582 | } |
| 2583 | } |
| 2584 | |
| 2585 | return printed_len; |
| 2586 | } |
| 2587 | |
| 2588 | /* GDB version of readline/complete.c:complete_get_screenwidth. */ |
| 2589 | |
| 2590 | static int |
| 2591 | gdb_complete_get_screenwidth (const struct match_list_displayer *displayer) |
| 2592 | { |
| 2593 | /* Readline has other stuff here which it's not clear we need. */ |
| 2594 | return displayer->width; |
| 2595 | } |
| 2596 | |
| 2597 | extern int _rl_completion_prefix_display_length; |
| 2598 | extern int _rl_print_completions_horizontally; |
| 2599 | |
| 2600 | EXTERN_C int _rl_qsort_string_compare (const void *, const void *); |
| 2601 | typedef int QSFUNC (const void *, const void *); |
| 2602 | |
| 2603 | /* GDB version of readline/complete.c:rl_display_match_list. |
| 2604 | See gdb_display_match_list for a description of MATCHES, LEN, MAX. |
| 2605 | Returns non-zero if all matches are displayed. */ |
| 2606 | |
| 2607 | static int |
| 2608 | gdb_display_match_list_1 (char **matches, int len, int max, |
| 2609 | const struct match_list_displayer *displayer) |
| 2610 | { |
| 2611 | int count, limit, printed_len, lines, cols; |
| 2612 | int i, j, k, l, common_length, sind; |
| 2613 | char *temp, *t; |
| 2614 | int page_completions = displayer->height != INT_MAX && pagination_enabled; |
| 2615 | |
| 2616 | /* Find the length of the prefix common to all items: length as displayed |
| 2617 | characters (common_length) and as a byte index into the matches (sind) */ |
| 2618 | common_length = sind = 0; |
| 2619 | if (_rl_completion_prefix_display_length > 0) |
| 2620 | { |
| 2621 | t = gdb_printable_part (matches[0]); |
| 2622 | temp = strrchr (t, '/'); |
| 2623 | common_length = temp ? gdb_fnwidth (temp) : gdb_fnwidth (t); |
| 2624 | sind = temp ? strlen (temp) : strlen (t); |
| 2625 | |
| 2626 | if (common_length > _rl_completion_prefix_display_length && common_length > ELLIPSIS_LEN) |
| 2627 | max -= common_length - ELLIPSIS_LEN; |
| 2628 | else |
| 2629 | common_length = sind = 0; |
| 2630 | } |
| 2631 | |
| 2632 | /* How many items of MAX length can we fit in the screen window? */ |
| 2633 | cols = gdb_complete_get_screenwidth (displayer); |
| 2634 | max += 2; |
| 2635 | limit = cols / max; |
| 2636 | if (limit != 1 && (limit * max == cols)) |
| 2637 | limit--; |
| 2638 | |
| 2639 | /* If cols == 0, limit will end up -1 */ |
| 2640 | if (cols < displayer->width && limit < 0) |
| 2641 | limit = 1; |
| 2642 | |
| 2643 | /* Avoid a possible floating exception. If max > cols, |
| 2644 | limit will be 0 and a divide-by-zero fault will result. */ |
| 2645 | if (limit == 0) |
| 2646 | limit = 1; |
| 2647 | |
| 2648 | /* How many iterations of the printing loop? */ |
| 2649 | count = (len + (limit - 1)) / limit; |
| 2650 | |
| 2651 | /* Watch out for special case. If LEN is less than LIMIT, then |
| 2652 | just do the inner printing loop. |
| 2653 | 0 < len <= limit implies count = 1. */ |
| 2654 | |
| 2655 | /* Sort the items if they are not already sorted. */ |
| 2656 | if (rl_ignore_completion_duplicates == 0 && rl_sort_completion_matches) |
| 2657 | qsort (matches + 1, len, sizeof (char *), (QSFUNC *)_rl_qsort_string_compare); |
| 2658 | |
| 2659 | displayer->crlf (displayer); |
| 2660 | |
| 2661 | lines = 0; |
| 2662 | if (_rl_print_completions_horizontally == 0) |
| 2663 | { |
| 2664 | /* Print the sorted items, up-and-down alphabetically, like ls. */ |
| 2665 | for (i = 1; i <= count; i++) |
| 2666 | { |
| 2667 | for (j = 0, l = i; j < limit; j++) |
| 2668 | { |
| 2669 | if (l > len || matches[l] == 0) |
| 2670 | break; |
| 2671 | else |
| 2672 | { |
| 2673 | temp = gdb_printable_part (matches[l]); |
| 2674 | printed_len = gdb_print_filename (temp, matches[l], sind, |
| 2675 | displayer); |
| 2676 | |
| 2677 | if (j + 1 < limit) |
| 2678 | for (k = 0; k < max - printed_len; k++) |
| 2679 | displayer->putch (displayer, ' '); |
| 2680 | } |
| 2681 | l += count; |
| 2682 | } |
| 2683 | displayer->crlf (displayer); |
| 2684 | lines++; |
| 2685 | if (page_completions && lines >= (displayer->height - 1) && i < count) |
| 2686 | { |
| 2687 | lines = gdb_display_match_list_pager (lines, displayer); |
| 2688 | if (lines < 0) |
| 2689 | return 0; |
| 2690 | } |
| 2691 | } |
| 2692 | } |
| 2693 | else |
| 2694 | { |
| 2695 | /* Print the sorted items, across alphabetically, like ls -x. */ |
| 2696 | for (i = 1; matches[i]; i++) |
| 2697 | { |
| 2698 | temp = gdb_printable_part (matches[i]); |
| 2699 | printed_len = gdb_print_filename (temp, matches[i], sind, displayer); |
| 2700 | /* Have we reached the end of this line? */ |
| 2701 | if (matches[i+1]) |
| 2702 | { |
| 2703 | if (i && (limit > 1) && (i % limit) == 0) |
| 2704 | { |
| 2705 | displayer->crlf (displayer); |
| 2706 | lines++; |
| 2707 | if (page_completions && lines >= displayer->height - 1) |
| 2708 | { |
| 2709 | lines = gdb_display_match_list_pager (lines, displayer); |
| 2710 | if (lines < 0) |
| 2711 | return 0; |
| 2712 | } |
| 2713 | } |
| 2714 | else |
| 2715 | for (k = 0; k < max - printed_len; k++) |
| 2716 | displayer->putch (displayer, ' '); |
| 2717 | } |
| 2718 | } |
| 2719 | displayer->crlf (displayer); |
| 2720 | } |
| 2721 | |
| 2722 | return 1; |
| 2723 | } |
| 2724 | |
| 2725 | /* Utility for displaying completion list matches, used by both CLI and TUI. |
| 2726 | |
| 2727 | MATCHES is the list of strings, in argv format, LEN is the number of |
| 2728 | strings in MATCHES, and MAX is the length of the longest string in |
| 2729 | MATCHES. */ |
| 2730 | |
| 2731 | void |
| 2732 | gdb_display_match_list (char **matches, int len, int max, |
| 2733 | const struct match_list_displayer *displayer) |
| 2734 | { |
| 2735 | /* Readline will never call this if complete_line returned NULL. */ |
| 2736 | gdb_assert (max_completions != 0); |
| 2737 | |
| 2738 | /* complete_line will never return more than this. */ |
| 2739 | if (max_completions > 0) |
| 2740 | gdb_assert (len <= max_completions); |
| 2741 | |
| 2742 | if (rl_completion_query_items > 0 && len >= rl_completion_query_items) |
| 2743 | { |
| 2744 | char msg[100]; |
| 2745 | |
| 2746 | /* We can't use *query here because they wait for <RET> which is |
| 2747 | wrong here. This follows the readline version as closely as possible |
| 2748 | for compatibility's sake. See readline/complete.c. */ |
| 2749 | |
| 2750 | displayer->crlf (displayer); |
| 2751 | |
| 2752 | xsnprintf (msg, sizeof (msg), |
| 2753 | "Display all %d possibilities? (y or n)", len); |
| 2754 | displayer->puts (displayer, msg); |
| 2755 | displayer->flush (displayer); |
| 2756 | |
| 2757 | if (gdb_get_y_or_n (0, displayer) == 0) |
| 2758 | { |
| 2759 | displayer->crlf (displayer); |
| 2760 | return; |
| 2761 | } |
| 2762 | } |
| 2763 | |
| 2764 | if (gdb_display_match_list_1 (matches, len, max, displayer)) |
| 2765 | { |
| 2766 | /* Note: MAX_COMPLETIONS may be -1 or zero, but LEN is always > 0. */ |
| 2767 | if (len == max_completions) |
| 2768 | { |
| 2769 | /* The maximum number of completions has been reached. Warn the user |
| 2770 | that there may be more. */ |
| 2771 | const char *message = get_max_completions_reached_message (); |
| 2772 | |
| 2773 | displayer->puts (displayer, message); |
| 2774 | displayer->crlf (displayer); |
| 2775 | } |
| 2776 | } |
| 2777 | } |
| 2778 | |
| 2779 | void |
| 2780 | _initialize_completer (void) |
| 2781 | { |
| 2782 | add_setshow_zuinteger_unlimited_cmd ("max-completions", no_class, |
| 2783 | &max_completions, _("\ |
| 2784 | Set maximum number of completion candidates."), _("\ |
| 2785 | Show maximum number of completion candidates."), _("\ |
| 2786 | Use this to limit the number of candidates considered\n\ |
| 2787 | during completion. Specifying \"unlimited\" or -1\n\ |
| 2788 | disables limiting. Note that setting either no limit or\n\ |
| 2789 | a very large limit can make completion slow."), |
| 2790 | NULL, NULL, &setlist, &showlist); |
| 2791 | } |