Accept and ignore the R_BPF_64_NODLYD32 relocation.
[binutils-gdb.git] / gdb / utils.c
bloba191d26a00701aa8b282792ec751dc6ca7c3bc0c
1 /* General utility routines for GDB, the GNU debugger.
3 Copyright (C) 1986-2023 Free Software Foundation, Inc.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
20 #include "defs.h"
21 #include <ctype.h>
22 #include "gdbsupport/gdb_wait.h"
23 #include "event-top.h"
24 #include "gdbthread.h"
25 #include "fnmatch.h"
26 #include "gdb_bfd.h"
27 #ifdef HAVE_SYS_RESOURCE_H
28 #include <sys/resource.h>
29 #endif /* HAVE_SYS_RESOURCE_H */
31 #ifdef TUI
32 /* For tui_get_command_dimension and tui_disable. */
33 #include "tui/tui.h"
34 #endif
36 #ifdef __GO32__
37 #include <pc.h>
38 #endif
40 #include <signal.h>
41 #include "gdbcmd.h"
42 #include "serial.h"
43 #include "bfd.h"
44 #include "target.h"
45 #include "gdb-demangle.h"
46 #include "expression.h"
47 #include "language.h"
48 #include "charset.h"
49 #include "annotate.h"
50 #include "filenames.h"
51 #include "symfile.h"
52 #include "gdbsupport/gdb_obstack.h"
53 #include "gdbcore.h"
54 #include "top.h"
55 #include "ui.h"
56 #include "main.h"
57 #include "solist.h"
59 #include "inferior.h"
61 #include "gdb_curses.h"
63 #include "readline/readline.h"
65 #include <chrono>
67 #include "interps.h"
68 #include "gdbsupport/gdb_regex.h"
69 #include "gdbsupport/job-control.h"
70 #include "gdbsupport/selftest.h"
71 #include "gdbsupport/gdb_optional.h"
72 #include "cp-support.h"
73 #include <algorithm>
74 #include "gdbsupport/pathstuff.h"
75 #include "cli/cli-style.h"
76 #include "gdbsupport/scope-exit.h"
77 #include "gdbarch.h"
78 #include "cli-out.h"
79 #include "gdbsupport/gdb-safe-ctype.h"
80 #include "bt-utils.h"
81 #include "gdbsupport/buildargv.h"
82 #include "pager.h"
83 #include "run-on-main-thread.h"
85 void (*deprecated_error_begin_hook) (void);
87 /* Prototypes for local functions */
89 static void set_screen_size (void);
90 static void set_width (void);
92 /* Time spent in prompt_for_continue in the currently executing command
93 waiting for user to respond.
94 Initialized in make_command_stats_cleanup.
95 Modified in prompt_for_continue and defaulted_query.
96 Used in report_command_stats. */
98 static std::chrono::steady_clock::duration prompt_for_continue_wait_time;
100 /* A flag indicating whether to timestamp debugging messages. */
102 bool debug_timestamp = false;
104 /* True means that strings with character values >0x7F should be printed
105 as octal escapes. False means just print the value (e.g. it's an
106 international character, and the terminal or window can cope.) */
108 bool sevenbit_strings = false;
109 static void
110 show_sevenbit_strings (struct ui_file *file, int from_tty,
111 struct cmd_list_element *c, const char *value)
113 gdb_printf (file, _("Printing of 8-bit characters "
114 "in strings as \\nnn is %s.\n"),
115 value);
118 /* String to be printed before warning messages, if any. */
120 const char *warning_pre_print = "\nwarning: ";
122 bool pagination_enabled = true;
123 static void
124 show_pagination_enabled (struct ui_file *file, int from_tty,
125 struct cmd_list_element *c, const char *value)
127 gdb_printf (file, _("State of pagination is %s.\n"), value);
133 /* Print a warning message. The first argument STRING is the warning
134 message, used as an fprintf format string, the second is the
135 va_list of arguments for that string. A warning is unfiltered (not
136 paginated) so that the user does not need to page through each
137 screen full of warnings when there are lots of them. */
139 void
140 vwarning (const char *string, va_list args)
142 if (deprecated_warning_hook)
143 (*deprecated_warning_hook) (string, args);
144 else
146 gdb::optional<target_terminal::scoped_restore_terminal_state> term_state;
147 if (target_supports_terminal_ours ())
149 term_state.emplace ();
150 target_terminal::ours_for_output ();
152 if (warning_pre_print)
153 gdb_puts (warning_pre_print, gdb_stderr);
154 gdb_vprintf (gdb_stderr, string, args);
155 gdb_printf (gdb_stderr, "\n");
159 /* Print an error message and return to command level.
160 The first argument STRING is the error message, used as a fprintf string,
161 and the remaining args are passed as arguments to it. */
163 void
164 verror (const char *string, va_list args)
166 throw_verror (GENERIC_ERROR, string, args);
169 /* Emit a message and abort. */
171 static void ATTRIBUTE_NORETURN
172 abort_with_message (const char *msg)
174 if (current_ui == NULL)
175 fputs (msg, stderr);
176 else
177 gdb_puts (msg, gdb_stderr);
179 abort (); /* ARI: abort */
182 /* Dump core trying to increase the core soft limit to hard limit first. */
184 void
185 dump_core (void)
187 #ifdef HAVE_SETRLIMIT
188 struct rlimit rlim = { (rlim_t) RLIM_INFINITY, (rlim_t) RLIM_INFINITY };
190 setrlimit (RLIMIT_CORE, &rlim);
191 #endif /* HAVE_SETRLIMIT */
193 /* Ensure that the SIGABRT we're about to raise will immediately cause
194 GDB to exit and dump core, we don't want to trigger GDB's printing of
195 a backtrace to the console here. */
196 signal (SIGABRT, SIG_DFL);
198 abort (); /* ARI: abort */
201 /* Check whether GDB will be able to dump core using the dump_core
202 function. Returns zero if GDB cannot or should not dump core.
203 If LIMIT_KIND is LIMIT_CUR the user's soft limit will be respected.
204 If LIMIT_KIND is LIMIT_MAX only the hard limit will be respected. */
207 can_dump_core (enum resource_limit_kind limit_kind)
209 #ifdef HAVE_GETRLIMIT
210 struct rlimit rlim;
212 /* Be quiet and assume we can dump if an error is returned. */
213 if (getrlimit (RLIMIT_CORE, &rlim) != 0)
214 return 1;
216 switch (limit_kind)
218 case LIMIT_CUR:
219 if (rlim.rlim_cur == 0)
220 return 0;
221 /* Fall through. */
223 case LIMIT_MAX:
224 if (rlim.rlim_max == 0)
225 return 0;
227 #endif /* HAVE_GETRLIMIT */
229 return 1;
232 /* Print a warning that we cannot dump core. */
234 void
235 warn_cant_dump_core (const char *reason)
237 gdb_printf (gdb_stderr,
238 _("%s\nUnable to dump core, use `ulimit -c"
239 " unlimited' before executing GDB next time.\n"),
240 reason);
243 /* Check whether GDB will be able to dump core using the dump_core
244 function, and print a warning if we cannot. */
246 static int
247 can_dump_core_warn (enum resource_limit_kind limit_kind,
248 const char *reason)
250 int core_dump_allowed = can_dump_core (limit_kind);
252 if (!core_dump_allowed)
253 warn_cant_dump_core (reason);
255 return core_dump_allowed;
258 /* Allow the user to configure the debugger behavior with respect to
259 what to do when an internal problem is detected. */
261 const char internal_problem_ask[] = "ask";
262 const char internal_problem_yes[] = "yes";
263 const char internal_problem_no[] = "no";
264 static const char *const internal_problem_modes[] =
266 internal_problem_ask,
267 internal_problem_yes,
268 internal_problem_no,
269 NULL
272 /* Data structure used to control how the internal_vproblem function
273 should behave. An instance of this structure is created for each
274 problem type that GDB supports. */
276 struct internal_problem
278 /* The name of this problem type. This must not contain white space as
279 this string is used to build command names. */
280 const char *name;
282 /* When this is true then a user command is created (based on NAME) that
283 allows the SHOULD_QUIT field to be modified, otherwise, SHOULD_QUIT
284 can't be changed from its default value by the user. */
285 bool user_settable_should_quit;
287 /* Reference a value from internal_problem_modes to indicate if GDB
288 should quit when it hits a problem of this type. */
289 const char *should_quit;
291 /* Like USER_SETTABLE_SHOULD_QUIT but for SHOULD_DUMP_CORE. */
292 bool user_settable_should_dump_core;
294 /* Like SHOULD_QUIT, but whether GDB should dump core. */
295 const char *should_dump_core;
297 /* Like USER_SETTABLE_SHOULD_QUIT but for SHOULD_PRINT_BACKTRACE. */
298 bool user_settable_should_print_backtrace;
300 /* When this is true GDB will print a backtrace when a problem of this
301 type is encountered. */
302 bool should_print_backtrace;
305 /* Return true if the readline callbacks have been initialized for UI.
306 This is always true once GDB is fully initialized, but during the early
307 startup phase this is initially false. */
309 static bool
310 readline_initialized (struct ui *ui)
312 return ui->call_readline != nullptr;
315 /* Report a problem, internal to GDB, to the user. Once the problem
316 has been reported, and assuming GDB didn't quit, the caller can
317 either allow execution to resume or throw an error. */
319 static void ATTRIBUTE_PRINTF (4, 0)
320 internal_vproblem (struct internal_problem *problem,
321 const char *file, int line, const char *fmt, va_list ap)
323 static int dejavu;
324 int quit_p;
325 int dump_core_p;
326 std::string reason;
328 /* Don't allow infinite error/warning recursion. */
330 static const char msg[] = "Recursive internal problem.\n";
332 switch (dejavu)
334 case 0:
335 dejavu = 1;
336 break;
337 case 1:
338 dejavu = 2;
339 abort_with_message (msg);
340 default:
341 dejavu = 3;
342 /* Newer GLIBC versions put the warn_unused_result attribute
343 on write, but this is one of those rare cases where
344 ignoring the return value is correct. Casting to (void)
345 does not fix this problem. This is the solution suggested
346 at http://gcc.gnu.org/bugzilla/show_bug.cgi?id=25509. */
347 if (write (STDERR_FILENO, msg, sizeof (msg)) != sizeof (msg))
348 abort (); /* ARI: abort */
349 exit (1);
353 #ifdef TUI
354 tui_disable ();
355 #endif
357 /* Create a string containing the full error/warning message. Need
358 to call query with this full string, as otherwize the reason
359 (error/warning) and question become separated. Format using a
360 style similar to a compiler error message. Include extra detail
361 so that the user knows that they are living on the edge. */
363 std::string msg = string_vprintf (fmt, ap);
364 reason = string_printf ("%s:%d: %s: %s\n"
365 "A problem internal to GDB has been detected,\n"
366 "further debugging may prove unreliable.",
367 file, line, problem->name, msg.c_str ());
370 /* Fall back to abort_with_message if gdb_stderr is not set up. */
371 if (current_ui == NULL)
373 fputs (reason.c_str (), stderr);
374 abort_with_message ("\n");
377 /* Try to get the message out and at the start of a new line. */
378 gdb::optional<target_terminal::scoped_restore_terminal_state> term_state;
379 if (target_supports_terminal_ours ())
381 term_state.emplace ();
382 target_terminal::ours_for_output ();
384 if (filtered_printing_initialized ())
385 begin_line ();
387 /* Emit the message unless query will emit it below. */
388 if (problem->should_quit != internal_problem_ask
389 || !confirm
390 || !filtered_printing_initialized ()
391 || !readline_initialized (current_ui)
392 || problem->should_print_backtrace)
393 gdb_printf (gdb_stderr, "%s\n", reason.c_str ());
395 if (problem->should_print_backtrace)
396 gdb_internal_backtrace ();
398 if (problem->should_quit == internal_problem_ask)
400 /* Default (yes/batch case) is to quit GDB. When in batch mode
401 this lessens the likelihood of GDB going into an infinite
402 loop. */
403 if (!confirm || !filtered_printing_initialized ()
404 || !readline_initialized (current_ui))
405 quit_p = 1;
406 else
407 quit_p = query (_("%s\nQuit this debugging session? "),
408 reason.c_str ());
410 else if (problem->should_quit == internal_problem_yes)
411 quit_p = 1;
412 else if (problem->should_quit == internal_problem_no)
413 quit_p = 0;
414 else
415 internal_error (_("bad switch"));
417 gdb_puts (_("\nThis is a bug, please report it."), gdb_stderr);
418 if (REPORT_BUGS_TO[0])
419 gdb_printf (gdb_stderr, _(" For instructions, see:\n%ps."),
420 styled_string (file_name_style.style (),
421 REPORT_BUGS_TO));
422 gdb_puts ("\n\n", gdb_stderr);
424 if (problem->should_dump_core == internal_problem_ask)
426 if (!can_dump_core_warn (LIMIT_MAX, reason.c_str ()))
427 dump_core_p = 0;
428 else if (!filtered_printing_initialized ()
429 || !readline_initialized (current_ui))
430 dump_core_p = 1;
431 else
433 /* Default (yes/batch case) is to dump core. This leaves a GDB
434 `dropping' so that it is easier to see that something went
435 wrong in GDB. */
436 dump_core_p = query (_("%s\nCreate a core file of GDB? "),
437 reason.c_str ());
440 else if (problem->should_dump_core == internal_problem_yes)
441 dump_core_p = can_dump_core_warn (LIMIT_MAX, reason.c_str ());
442 else if (problem->should_dump_core == internal_problem_no)
443 dump_core_p = 0;
444 else
445 internal_error (_("bad switch"));
447 if (quit_p)
449 if (dump_core_p)
450 dump_core ();
451 else
452 exit (1);
454 else
456 if (dump_core_p)
458 #ifdef HAVE_WORKING_FORK
459 if (fork () == 0)
460 dump_core ();
461 #endif
465 dejavu = 0;
468 static struct internal_problem internal_error_problem = {
469 "internal-error", true, internal_problem_ask, true, internal_problem_ask,
470 true, GDB_PRINT_INTERNAL_BACKTRACE_INIT_ON
473 void
474 internal_verror (const char *file, int line, const char *fmt, va_list ap)
476 internal_vproblem (&internal_error_problem, file, line, fmt, ap);
477 throw_quit (_("Command aborted."));
480 static struct internal_problem internal_warning_problem = {
481 "internal-warning", true, internal_problem_ask, true, internal_problem_ask,
482 true, false
485 void
486 internal_vwarning (const char *file, int line, const char *fmt, va_list ap)
488 internal_vproblem (&internal_warning_problem, file, line, fmt, ap);
491 static struct internal_problem demangler_warning_problem = {
492 "demangler-warning", true, internal_problem_ask, false, internal_problem_no,
493 false, false
496 void
497 demangler_vwarning (const char *file, int line, const char *fmt, va_list ap)
499 internal_vproblem (&demangler_warning_problem, file, line, fmt, ap);
502 void
503 demangler_warning (const char *file, int line, const char *string, ...)
505 va_list ap;
507 va_start (ap, string);
508 demangler_vwarning (file, line, string, ap);
509 va_end (ap);
512 /* When GDB reports an internal problem (error or warning) it gives
513 the user the opportunity to quit GDB and/or create a core file of
514 the current debug session. This function registers a few commands
515 that make it possible to specify that GDB should always or never
516 quit or create a core file, without asking. The commands look
517 like:
519 maint set PROBLEM-NAME quit ask|yes|no
520 maint show PROBLEM-NAME quit
521 maint set PROBLEM-NAME corefile ask|yes|no
522 maint show PROBLEM-NAME corefile
524 Where PROBLEM-NAME is currently "internal-error" or
525 "internal-warning". */
527 static void
528 add_internal_problem_command (struct internal_problem *problem)
530 struct cmd_list_element **set_cmd_list;
531 struct cmd_list_element **show_cmd_list;
533 set_cmd_list = XNEW (struct cmd_list_element *);
534 show_cmd_list = XNEW (struct cmd_list_element *);
535 *set_cmd_list = NULL;
536 *show_cmd_list = NULL;
538 /* The add_basic_prefix_cmd and add_show_prefix_cmd functions take
539 ownership of the string passed in, which is why we don't need to free
540 set_doc and show_doc in this function. */
541 const char *set_doc
542 = xstrprintf (_("Configure what GDB does when %s is detected."),
543 problem->name).release ();
544 const char *show_doc
545 = xstrprintf (_("Show what GDB does when %s is detected."),
546 problem->name).release ();
548 add_setshow_prefix_cmd (problem->name, class_maintenance,
549 set_doc, show_doc, set_cmd_list, show_cmd_list,
550 &maintenance_set_cmdlist, &maintenance_show_cmdlist);
552 if (problem->user_settable_should_quit)
554 std::string set_quit_doc
555 = string_printf (_("Set whether GDB should quit when an %s is "
556 "detected."), problem->name);
557 std::string show_quit_doc
558 = string_printf (_("Show whether GDB will quit when an %s is "
559 "detected."), problem->name);
560 add_setshow_enum_cmd ("quit", class_maintenance,
561 internal_problem_modes,
562 &problem->should_quit,
563 set_quit_doc.c_str (),
564 show_quit_doc.c_str (),
565 NULL, /* help_doc */
566 NULL, /* setfunc */
567 NULL, /* showfunc */
568 set_cmd_list,
569 show_cmd_list);
572 if (problem->user_settable_should_dump_core)
574 std::string set_core_doc
575 = string_printf (_("Set whether GDB should create a core file of "
576 "GDB when %s is detected."), problem->name);
577 std::string show_core_doc
578 = string_printf (_("Show whether GDB will create a core file of "
579 "GDB when %s is detected."), problem->name);
580 add_setshow_enum_cmd ("corefile", class_maintenance,
581 internal_problem_modes,
582 &problem->should_dump_core,
583 set_core_doc.c_str (),
584 show_core_doc.c_str (),
585 NULL, /* help_doc */
586 NULL, /* setfunc */
587 NULL, /* showfunc */
588 set_cmd_list,
589 show_cmd_list);
592 if (problem->user_settable_should_print_backtrace)
594 std::string set_bt_doc
595 = string_printf (_("Set whether GDB should print a backtrace of "
596 "GDB when %s is detected."), problem->name);
597 std::string show_bt_doc
598 = string_printf (_("Show whether GDB will print a backtrace of "
599 "GDB when %s is detected."), problem->name);
600 add_setshow_boolean_cmd ("backtrace", class_maintenance,
601 &problem->should_print_backtrace,
602 set_bt_doc.c_str (),
603 show_bt_doc.c_str (),
604 NULL, /* help_doc */
605 gdb_internal_backtrace_set_cmd,
606 NULL, /* showfunc */
607 set_cmd_list,
608 show_cmd_list);
612 /* Same as perror_with_name except that it prints a warning instead
613 of throwing an error. */
615 void
616 perror_warning_with_name (const char *string)
618 std::string combined = perror_string (string);
619 warning (_("%s"), combined.c_str ());
622 /* See utils.h. */
624 void
625 warning_filename_and_errno (const char *filename, int saved_errno)
627 warning (_("%ps: %s"), styled_string (file_name_style.style (), filename),
628 safe_strerror (saved_errno));
631 /* Control C eventually causes this to be called, at a convenient time. */
633 void
634 quit (void)
636 if (sync_quit_force_run)
638 sync_quit_force_run = false;
639 throw_forced_quit ("SIGTERM");
642 #ifdef __MSDOS__
643 /* No steenking SIGINT will ever be coming our way when the
644 program is resumed. Don't lie. */
645 throw_quit ("Quit");
646 #else
647 if (job_control
648 /* If there is no terminal switching for this target, then we can't
649 possibly get screwed by the lack of job control. */
650 || !target_supports_terminal_ours ())
651 throw_quit ("Quit");
652 else
653 throw_quit ("Quit (expect signal SIGINT when the program is resumed)");
654 #endif
657 /* See defs.h. */
659 void
660 maybe_quit (void)
662 if (!is_main_thread ())
663 return;
665 if (sync_quit_force_run)
666 quit ();
668 quit_handler ();
672 /* Called when a memory allocation fails, with the number of bytes of
673 memory requested in SIZE. */
675 void
676 malloc_failure (long size)
678 if (size > 0)
680 internal_error (_("virtual memory exhausted: can't allocate %ld bytes."),
681 size);
683 else
685 internal_error (_("virtual memory exhausted."));
689 /* See common/errors.h. */
691 void
692 flush_streams ()
694 gdb_stdout->flush ();
695 gdb_stderr->flush ();
698 /* My replacement for the read system call.
699 Used like `read' but keeps going if `read' returns too soon. */
702 myread (int desc, char *addr, int len)
704 int val;
705 int orglen = len;
707 while (len > 0)
709 val = read (desc, addr, len);
710 if (val < 0)
711 return val;
712 if (val == 0)
713 return orglen - len;
714 len -= val;
715 addr += val;
717 return orglen;
722 /* An RAII class that sets up to handle input and then tears down
723 during destruction. */
725 class scoped_input_handler
727 public:
729 scoped_input_handler ()
730 : m_quit_handler (&quit_handler, default_quit_handler),
731 m_ui (NULL)
733 target_terminal::ours ();
734 current_ui->register_file_handler ();
735 if (current_ui->prompt_state == PROMPT_BLOCKED)
736 m_ui = current_ui;
739 ~scoped_input_handler ()
741 if (m_ui != NULL)
742 m_ui->unregister_file_handler ();
745 DISABLE_COPY_AND_ASSIGN (scoped_input_handler);
747 private:
749 /* Save and restore the terminal state. */
750 target_terminal::scoped_restore_terminal_state m_term_state;
752 /* Save and restore the quit handler. */
753 scoped_restore_tmpl<quit_handler_ftype *> m_quit_handler;
755 /* The saved UI, if non-NULL. */
756 struct ui *m_ui;
761 /* This function supports the query, nquery, and yquery functions.
762 Ask user a y-or-n question and return 0 if answer is no, 1 if
763 answer is yes, or default the answer to the specified default
764 (for yquery or nquery). DEFCHAR may be 'y' or 'n' to provide a
765 default answer, or '\0' for no default.
766 CTLSTR is the control string and should end in "? ". It should
767 not say how to answer, because we do that.
768 ARGS are the arguments passed along with the CTLSTR argument to
769 printf. */
771 static int ATTRIBUTE_PRINTF (1, 0)
772 defaulted_query (const char *ctlstr, const char defchar, va_list args)
774 int retval;
775 int def_value;
776 char def_answer, not_def_answer;
777 const char *y_string, *n_string;
779 /* Set up according to which answer is the default. */
780 if (defchar == '\0')
782 def_value = 1;
783 def_answer = 'Y';
784 not_def_answer = 'N';
785 y_string = "y";
786 n_string = "n";
788 else if (defchar == 'y')
790 def_value = 1;
791 def_answer = 'Y';
792 not_def_answer = 'N';
793 y_string = "[y]";
794 n_string = "n";
796 else
798 def_value = 0;
799 def_answer = 'N';
800 not_def_answer = 'Y';
801 y_string = "y";
802 n_string = "[n]";
805 /* Automatically answer the default value if the user did not want
806 prompts or the command was issued with the server prefix. */
807 if (!confirm || server_command)
808 return def_value;
810 /* If input isn't coming from the user directly, just say what
811 question we're asking, and then answer the default automatically. This
812 way, important error messages don't get lost when talking to GDB
813 over a pipe. */
814 if (current_ui->instream != current_ui->stdin_stream
815 || !current_ui->input_interactive_p ()
816 /* Restrict queries to the main UI. */
817 || current_ui != main_ui)
819 target_terminal::scoped_restore_terminal_state term_state;
820 target_terminal::ours_for_output ();
821 gdb_stdout->wrap_here (0);
822 gdb_vprintf (gdb_stdout, ctlstr, args);
824 gdb_printf (_("(%s or %s) [answered %c; "
825 "input not from terminal]\n"),
826 y_string, n_string, def_answer);
828 return def_value;
831 if (deprecated_query_hook)
833 target_terminal::scoped_restore_terminal_state term_state;
834 return deprecated_query_hook (ctlstr, args);
837 /* Format the question outside of the loop, to avoid reusing args. */
838 std::string question = string_vprintf (ctlstr, args);
839 std::string prompt
840 = string_printf (_("%s%s(%s or %s) %s"),
841 annotation_level > 1 ? "\n\032\032pre-query\n" : "",
842 question.c_str (), y_string, n_string,
843 annotation_level > 1 ? "\n\032\032query\n" : "");
845 /* Used to add duration we waited for user to respond to
846 prompt_for_continue_wait_time. */
847 using namespace std::chrono;
848 steady_clock::time_point prompt_started = steady_clock::now ();
850 scoped_input_handler prepare_input;
852 while (1)
854 char *response, answer;
856 gdb_flush (gdb_stdout);
857 response = gdb_readline_wrapper (prompt.c_str ());
859 if (response == NULL) /* C-d */
861 gdb_printf ("EOF [assumed %c]\n", def_answer);
862 retval = def_value;
863 break;
866 answer = response[0];
867 xfree (response);
869 if (answer >= 'a')
870 answer -= 040;
871 /* Check answer. For the non-default, the user must specify
872 the non-default explicitly. */
873 if (answer == not_def_answer)
875 retval = !def_value;
876 break;
878 /* Otherwise, if a default was specified, the user may either
879 specify the required input or have it default by entering
880 nothing. */
881 if (answer == def_answer
882 || (defchar != '\0' && answer == '\0'))
884 retval = def_value;
885 break;
887 /* Invalid entries are not defaulted and require another selection. */
888 gdb_printf (_("Please answer %s or %s.\n"),
889 y_string, n_string);
892 /* Add time spend in this routine to prompt_for_continue_wait_time. */
893 prompt_for_continue_wait_time += steady_clock::now () - prompt_started;
895 if (annotation_level > 1)
896 gdb_printf (("\n\032\032post-query\n"));
897 return retval;
901 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
902 answer is yes, or 0 if answer is defaulted.
903 Takes three args which are given to printf to print the question.
904 The first, a control string, should end in "? ".
905 It should not say how to answer, because we do that. */
908 nquery (const char *ctlstr, ...)
910 va_list args;
911 int ret;
913 va_start (args, ctlstr);
914 ret = defaulted_query (ctlstr, 'n', args);
915 va_end (args);
916 return ret;
919 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
920 answer is yes, or 1 if answer is defaulted.
921 Takes three args which are given to printf to print the question.
922 The first, a control string, should end in "? ".
923 It should not say how to answer, because we do that. */
926 yquery (const char *ctlstr, ...)
928 va_list args;
929 int ret;
931 va_start (args, ctlstr);
932 ret = defaulted_query (ctlstr, 'y', args);
933 va_end (args);
934 return ret;
937 /* Ask user a y-or-n question and return 1 iff answer is yes.
938 Takes three args which are given to printf to print the question.
939 The first, a control string, should end in "? ".
940 It should not say how to answer, because we do that. */
943 query (const char *ctlstr, ...)
945 va_list args;
946 int ret;
948 va_start (args, ctlstr);
949 ret = defaulted_query (ctlstr, '\0', args);
950 va_end (args);
951 return ret;
954 /* A helper for parse_escape that converts a host character to a
955 target character. C is the host character. If conversion is
956 possible, then the target character is stored in *TARGET_C and the
957 function returns 1. Otherwise, the function returns 0. */
959 static int
960 host_char_to_target (struct gdbarch *gdbarch, int c, int *target_c)
962 char the_char = c;
963 int result = 0;
965 auto_obstack host_data;
967 convert_between_encodings (target_charset (gdbarch), host_charset (),
968 (gdb_byte *) &the_char, 1, 1,
969 &host_data, translit_none);
971 if (obstack_object_size (&host_data) == 1)
973 result = 1;
974 *target_c = *(char *) obstack_base (&host_data);
977 return result;
980 /* Parse a C escape sequence. STRING_PTR points to a variable
981 containing a pointer to the string to parse. That pointer
982 should point to the character after the \. That pointer
983 is updated past the characters we use. The value of the
984 escape sequence is returned.
986 A negative value means the sequence \ newline was seen,
987 which is supposed to be equivalent to nothing at all.
989 If \ is followed by a null character, we return a negative
990 value and leave the string pointer pointing at the null character.
992 If \ is followed by 000, we return 0 and leave the string pointer
993 after the zeros. A value of 0 does not mean end of string. */
996 parse_escape (struct gdbarch *gdbarch, const char **string_ptr)
998 int target_char = -2; /* Initialize to avoid GCC warnings. */
999 int c = *(*string_ptr)++;
1001 switch (c)
1003 case '\n':
1004 return -2;
1005 case 0:
1006 (*string_ptr)--;
1007 return 0;
1009 case '0':
1010 case '1':
1011 case '2':
1012 case '3':
1013 case '4':
1014 case '5':
1015 case '6':
1016 case '7':
1018 int i = fromhex (c);
1019 int count = 0;
1020 while (++count < 3)
1022 c = (**string_ptr);
1023 if (ISDIGIT (c) && c != '8' && c != '9')
1025 (*string_ptr)++;
1026 i *= 8;
1027 i += fromhex (c);
1029 else
1031 break;
1034 return i;
1037 case 'a':
1038 c = '\a';
1039 break;
1040 case 'b':
1041 c = '\b';
1042 break;
1043 case 'f':
1044 c = '\f';
1045 break;
1046 case 'n':
1047 c = '\n';
1048 break;
1049 case 'r':
1050 c = '\r';
1051 break;
1052 case 't':
1053 c = '\t';
1054 break;
1055 case 'v':
1056 c = '\v';
1057 break;
1059 default:
1060 break;
1063 if (!host_char_to_target (gdbarch, c, &target_char))
1064 error (_("The escape sequence `\\%c' is equivalent to plain `%c',"
1065 " which has no equivalent\nin the `%s' character set."),
1066 c, c, target_charset (gdbarch));
1067 return target_char;
1071 /* Number of lines per page or UINT_MAX if paging is disabled. */
1072 static unsigned int lines_per_page;
1073 static void
1074 show_lines_per_page (struct ui_file *file, int from_tty,
1075 struct cmd_list_element *c, const char *value)
1077 gdb_printf (file,
1078 _("Number of lines gdb thinks are in a page is %s.\n"),
1079 value);
1082 /* Number of chars per line or UINT_MAX if line folding is disabled. */
1083 static unsigned int chars_per_line;
1084 static void
1085 show_chars_per_line (struct ui_file *file, int from_tty,
1086 struct cmd_list_element *c, const char *value)
1088 gdb_printf (file,
1089 _("Number of characters gdb thinks "
1090 "are in a line is %s.\n"),
1091 value);
1094 /* Current count of lines printed on this page, chars on this line. */
1095 static unsigned int lines_printed, chars_printed;
1097 /* True if pagination is disabled for just one command. */
1099 static bool pagination_disabled_for_command;
1101 /* Buffer and start column of buffered text, for doing smarter word-
1102 wrapping. When someone calls wrap_here(), we start buffering output
1103 that comes through gdb_puts(). If we see a newline, we just
1104 spit it out and forget about the wrap_here(). If we see another
1105 wrap_here(), we spit it out and remember the newer one. If we see
1106 the end of the line, we spit out a newline, the indent, and then
1107 the buffered output. */
1109 static bool filter_initialized = false;
1113 /* See readline's rlprivate.h. */
1115 EXTERN_C int _rl_term_autowrap;
1117 /* See utils.h. */
1119 int readline_hidden_cols = 0;
1121 /* Initialize the number of lines per page and chars per line. */
1123 void
1124 init_page_info (void)
1126 if (batch_flag)
1128 lines_per_page = UINT_MAX;
1129 chars_per_line = UINT_MAX;
1131 else
1132 #if defined(TUI)
1133 if (!tui_get_command_dimension (&chars_per_line, &lines_per_page))
1134 #endif
1136 int rows, cols;
1138 #if defined(__GO32__)
1139 rows = ScreenRows ();
1140 cols = ScreenCols ();
1141 lines_per_page = rows;
1142 chars_per_line = cols;
1143 #else
1144 /* Make sure Readline has initialized its terminal settings. */
1145 rl_reset_terminal (NULL);
1147 /* Get the screen size from Readline. */
1148 rl_get_screen_size (&rows, &cols);
1150 /* Readline:
1151 - ignores the COLUMNS variable when detecting screen width
1152 (because rl_prefer_env_winsize defaults to 0)
1153 - puts the detected screen width in the COLUMNS variable
1154 (because rl_change_environment defaults to 1)
1155 - may report one less than the detected screen width in
1156 rl_get_screen_size (when _rl_term_autowrap == 0).
1157 We could set readline_hidden_cols by comparing COLUMNS to cols as
1158 returned by rl_get_screen_size, but instead simply use
1159 _rl_term_autowrap. */
1160 readline_hidden_cols = _rl_term_autowrap ? 0 : 1;
1162 lines_per_page = rows;
1163 chars_per_line = cols + readline_hidden_cols;
1165 /* Readline should have fetched the termcap entry for us.
1166 Only try to use tgetnum function if rl_get_screen_size
1167 did not return a useful value. */
1168 if (((rows <= 0) && (tgetnum ((char *) "li") < 0))
1169 /* Also disable paging if inside Emacs. $EMACS was used
1170 before Emacs v25.1, $INSIDE_EMACS is used since then. */
1171 || getenv ("EMACS") || getenv ("INSIDE_EMACS"))
1173 /* The number of lines per page is not mentioned in the terminal
1174 description or EMACS environment variable is set. This probably
1175 means that paging is not useful, so disable paging. */
1176 lines_per_page = UINT_MAX;
1179 /* If the output is not a terminal, don't paginate it. */
1180 if (!gdb_stdout->isatty ())
1181 lines_per_page = UINT_MAX;
1182 #endif
1185 /* We handle SIGWINCH ourselves. */
1186 rl_catch_sigwinch = 0;
1188 set_screen_size ();
1189 set_width ();
1192 /* Return nonzero if filtered printing is initialized. */
1194 filtered_printing_initialized (void)
1196 return filter_initialized;
1199 set_batch_flag_and_restore_page_info::set_batch_flag_and_restore_page_info ()
1200 : m_save_lines_per_page (lines_per_page),
1201 m_save_chars_per_line (chars_per_line),
1202 m_save_batch_flag (batch_flag)
1204 batch_flag = 1;
1205 init_page_info ();
1208 set_batch_flag_and_restore_page_info::~set_batch_flag_and_restore_page_info ()
1210 batch_flag = m_save_batch_flag;
1211 chars_per_line = m_save_chars_per_line;
1212 lines_per_page = m_save_lines_per_page;
1214 set_screen_size ();
1215 set_width ();
1218 /* An approximation of SQRT(INT_MAX) that is:
1219 - cheap to calculate,
1220 - guaranteed to be smaller than SQRT(INT_MAX), such that
1221 sqrt_int_max * sqrt_int_max doesn't overflow, and
1222 - "close enough" to SQRT(INT_MAX), for instance for INT_MAX == 2147483647,
1223 SQRT(INT_MAX) is ~46341 and sqrt_int_max == 32767. */
1225 static const int sqrt_int_max = INT_MAX >> (sizeof (int) * 8 / 2);
1227 /* Set the screen size based on LINES_PER_PAGE and CHARS_PER_LINE. */
1229 static void
1230 set_screen_size (void)
1232 int rows = lines_per_page;
1233 int cols = chars_per_line;
1235 /* If we get 0 or negative ROWS or COLS, treat as "infinite" size.
1236 A negative number can be seen here with the "set width/height"
1237 commands and either:
1239 - the user specified "unlimited", which maps to UINT_MAX, or
1240 - the user specified some number between INT_MAX and UINT_MAX.
1242 Cap "infinity" to approximately sqrt(INT_MAX) so that we don't
1243 overflow in rl_set_screen_size, which multiplies rows and columns
1244 to compute the number of characters on the screen. */
1246 if (rows <= 0 || rows > sqrt_int_max)
1248 rows = sqrt_int_max;
1249 lines_per_page = UINT_MAX;
1252 if (cols <= 0 || cols > sqrt_int_max)
1254 cols = sqrt_int_max;
1255 chars_per_line = UINT_MAX;
1258 /* Update Readline's idea of the terminal size. */
1259 rl_set_screen_size (rows, cols);
1262 /* Reinitialize WRAP_BUFFER. */
1264 static void
1265 set_width (void)
1267 if (chars_per_line == 0)
1268 init_page_info ();
1270 filter_initialized = true;
1273 static void
1274 set_width_command (const char *args, int from_tty, struct cmd_list_element *c)
1276 set_screen_size ();
1277 set_width ();
1280 static void
1281 set_height_command (const char *args, int from_tty, struct cmd_list_element *c)
1283 set_screen_size ();
1286 /* See utils.h. */
1288 void
1289 set_screen_width_and_height (int width, int height)
1291 lines_per_page = height;
1292 chars_per_line = width;
1294 set_screen_size ();
1295 set_width ();
1298 /* Implement "maint info screen". */
1300 static void
1301 maintenance_info_screen (const char *args, int from_tty)
1303 int rows, cols;
1304 rl_get_screen_size (&rows, &cols);
1306 gdb_printf (gdb_stdout,
1307 _("Number of characters gdb thinks "
1308 "are in a line is %u%s.\n"),
1309 chars_per_line,
1310 chars_per_line == UINT_MAX ? " (unlimited)" : "");
1312 gdb_printf (gdb_stdout,
1313 _("Number of characters readline reports "
1314 "are in a line is %d%s.\n"),
1315 cols,
1316 (cols == sqrt_int_max
1317 ? " (unlimited)"
1318 : (cols == sqrt_int_max - 1
1319 ? " (unlimited - 1)"
1320 : "")));
1322 #ifdef HAVE_LIBCURSES
1323 gdb_printf (gdb_stdout,
1324 _("Number of characters curses thinks "
1325 "are in a line is %d.\n"),
1326 COLS);
1327 #endif
1329 gdb_printf (gdb_stdout,
1330 _("Number of characters environment thinks "
1331 "are in a line is %s (COLUMNS).\n"),
1332 getenv ("COLUMNS"));
1334 gdb_printf (gdb_stdout,
1335 _("Number of lines gdb thinks are in a page is %u%s.\n"),
1336 lines_per_page,
1337 lines_per_page == UINT_MAX ? " (unlimited)" : "");
1339 gdb_printf (gdb_stdout,
1340 _("Number of lines readline reports "
1341 "are in a page is %d%s.\n"),
1342 rows,
1343 rows == sqrt_int_max ? " (unlimited)" : "");
1345 #ifdef HAVE_LIBCURSES
1346 gdb_printf (gdb_stdout,
1347 _("Number of lines curses thinks "
1348 "are in a page is %d.\n"),
1349 LINES);
1350 #endif
1352 gdb_printf (gdb_stdout,
1353 _("Number of lines environment thinks "
1354 "are in a page is %s (LINES).\n"),
1355 getenv ("LINES"));
1358 void
1359 pager_file::emit_style_escape (const ui_file_style &style)
1361 if (can_emit_style_escape () && style != m_applied_style)
1363 m_applied_style = style;
1364 if (m_paging)
1365 m_stream->emit_style_escape (style);
1366 else
1367 m_wrap_buffer.append (style.to_ansi ());
1371 /* See pager.h. */
1373 void
1374 pager_file::reset_style ()
1376 if (can_emit_style_escape ())
1378 m_applied_style = ui_file_style ();
1379 m_wrap_buffer.append (m_applied_style.to_ansi ());
1383 /* Wait, so the user can read what's on the screen. Prompt the user
1384 to continue by pressing RETURN. 'q' is also provided because
1385 telling users what to do in the prompt is more user-friendly than
1386 expecting them to think of Ctrl-C/SIGINT. */
1388 void
1389 pager_file::prompt_for_continue ()
1391 char cont_prompt[120];
1392 /* Used to add duration we waited for user to respond to
1393 prompt_for_continue_wait_time. */
1394 using namespace std::chrono;
1395 steady_clock::time_point prompt_started = steady_clock::now ();
1396 bool disable_pagination = pagination_disabled_for_command;
1398 scoped_restore save_paging = make_scoped_restore (&m_paging, true);
1400 /* Clear the current styling. */
1401 m_stream->emit_style_escape (ui_file_style ());
1403 if (annotation_level > 1)
1404 m_stream->puts (("\n\032\032pre-prompt-for-continue\n"));
1406 strcpy (cont_prompt,
1407 "--Type <RET> for more, q to quit, "
1408 "c to continue without paging--");
1409 if (annotation_level > 1)
1410 strcat (cont_prompt, "\n\032\032prompt-for-continue\n");
1412 /* We must do this *before* we call gdb_readline_wrapper, else it
1413 will eventually call us -- thinking that we're trying to print
1414 beyond the end of the screen. */
1415 reinitialize_more_filter ();
1417 scoped_input_handler prepare_input;
1419 /* Call gdb_readline_wrapper, not readline, in order to keep an
1420 event loop running. */
1421 gdb::unique_xmalloc_ptr<char> ignore (gdb_readline_wrapper (cont_prompt));
1423 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1424 prompt_for_continue_wait_time += steady_clock::now () - prompt_started;
1426 if (annotation_level > 1)
1427 m_stream->puts (("\n\032\032post-prompt-for-continue\n"));
1429 if (ignore != NULL)
1431 char *p = ignore.get ();
1433 while (*p == ' ' || *p == '\t')
1434 ++p;
1435 if (p[0] == 'q')
1436 /* Do not call quit here; there is no possibility of SIGINT. */
1437 throw_quit ("Quit");
1438 if (p[0] == 'c')
1439 disable_pagination = true;
1442 /* Now we have to do this again, so that GDB will know that it doesn't
1443 need to save the ---Type <return>--- line at the top of the screen. */
1444 reinitialize_more_filter ();
1445 pagination_disabled_for_command = disable_pagination;
1447 dont_repeat (); /* Forget prev cmd -- CR won't repeat it. */
1450 /* Initialize timer to keep track of how long we waited for the user. */
1452 void
1453 reset_prompt_for_continue_wait_time (void)
1455 using namespace std::chrono;
1457 prompt_for_continue_wait_time = steady_clock::duration::zero ();
1460 /* Fetch the cumulative time spent in prompt_for_continue. */
1462 std::chrono::steady_clock::duration
1463 get_prompt_for_continue_wait_time ()
1465 return prompt_for_continue_wait_time;
1468 /* Reinitialize filter; ie. tell it to reset to original values. */
1470 void
1471 reinitialize_more_filter (void)
1473 lines_printed = 0;
1474 chars_printed = 0;
1475 pagination_disabled_for_command = false;
1478 void
1479 pager_file::flush_wrap_buffer ()
1481 if (!m_paging && !m_wrap_buffer.empty ())
1483 m_stream->puts (m_wrap_buffer.c_str ());
1484 m_wrap_buffer.clear ();
1488 void
1489 pager_file::flush ()
1491 flush_wrap_buffer ();
1492 m_stream->flush ();
1495 /* See utils.h. */
1497 void
1498 gdb_flush (struct ui_file *stream)
1500 stream->flush ();
1503 /* See utils.h. */
1506 get_chars_per_line ()
1508 return chars_per_line;
1511 /* See ui-file.h. */
1513 void
1514 pager_file::wrap_here (int indent)
1516 /* This should have been allocated, but be paranoid anyway. */
1517 gdb_assert (filter_initialized);
1519 flush_wrap_buffer ();
1520 if (chars_per_line == UINT_MAX) /* No line overflow checking. */
1522 m_wrap_column = 0;
1524 else if (chars_printed >= chars_per_line)
1526 this->puts ("\n");
1527 if (indent != 0)
1528 this->puts (n_spaces (indent));
1529 m_wrap_column = 0;
1531 else
1533 m_wrap_column = chars_printed;
1534 m_wrap_indent = indent;
1535 m_wrap_style = m_applied_style;
1539 /* Print input string to gdb_stdout arranging strings in columns of n
1540 chars. String can be right or left justified in the column. Never
1541 prints trailing spaces. String should never be longer than width.
1542 FIXME: this could be useful for the EXAMINE command, which
1543 currently doesn't tabulate very well. */
1545 void
1546 puts_tabular (char *string, int width, int right)
1548 int spaces = 0;
1549 int stringlen;
1550 char *spacebuf;
1552 gdb_assert (chars_per_line > 0);
1553 if (chars_per_line == UINT_MAX)
1555 gdb_puts (string);
1556 gdb_puts ("\n");
1557 return;
1560 if (((chars_printed - 1) / width + 2) * width >= chars_per_line)
1561 gdb_puts ("\n");
1563 if (width >= chars_per_line)
1564 width = chars_per_line - 1;
1566 stringlen = strlen (string);
1568 if (chars_printed > 0)
1569 spaces = width - (chars_printed - 1) % width - 1;
1570 if (right)
1571 spaces += width - stringlen;
1573 spacebuf = (char *) alloca (spaces + 1);
1574 spacebuf[spaces] = '\0';
1575 while (spaces--)
1576 spacebuf[spaces] = ' ';
1578 gdb_puts (spacebuf);
1579 gdb_puts (string);
1583 /* Ensure that whatever gets printed next, using the filtered output
1584 commands, starts at the beginning of the line. I.e. if there is
1585 any pending output for the current line, flush it and start a new
1586 line. Otherwise do nothing. */
1588 void
1589 begin_line (void)
1591 if (chars_printed > 0)
1593 gdb_puts ("\n");
1597 void
1598 pager_file::puts (const char *linebuffer)
1600 const char *lineptr;
1602 if (linebuffer == 0)
1603 return;
1605 /* Don't do any filtering or wrapping if both are disabled. */
1606 if (batch_flag
1607 || (lines_per_page == UINT_MAX && chars_per_line == UINT_MAX)
1608 || top_level_interpreter () == NULL
1609 || top_level_interpreter ()->interp_ui_out ()->is_mi_like_p ())
1611 flush_wrap_buffer ();
1612 m_stream->puts (linebuffer);
1613 return;
1616 auto buffer_clearer
1617 = make_scope_exit ([&] ()
1619 m_wrap_buffer.clear ();
1620 m_wrap_column = 0;
1621 m_wrap_indent = 0;
1624 /* If the user does "set height 1" then the pager will exhibit weird
1625 behavior. This is pathological, though, so don't allow it. */
1626 const unsigned int lines_allowed = (lines_per_page > 1
1627 ? lines_per_page - 1
1628 : 1);
1630 /* Go through and output each character. Show line extension
1631 when this is necessary; prompt user for new page when this is
1632 necessary. */
1634 lineptr = linebuffer;
1635 while (*lineptr)
1637 /* Possible new page. Note that PAGINATION_DISABLED_FOR_COMMAND
1638 might be set during this loop, so we must continue to check
1639 it here. */
1640 if (pagination_enabled
1641 && !pagination_disabled_for_command
1642 && lines_printed >= lines_allowed)
1643 prompt_for_continue ();
1645 while (*lineptr && *lineptr != '\n')
1647 int skip_bytes;
1649 /* Print a single line. */
1650 if (*lineptr == '\t')
1652 m_wrap_buffer.push_back ('\t');
1653 /* Shifting right by 3 produces the number of tab stops
1654 we have already passed, and then adding one and
1655 shifting left 3 advances to the next tab stop. */
1656 chars_printed = ((chars_printed >> 3) + 1) << 3;
1657 lineptr++;
1659 else if (*lineptr == '\033'
1660 && skip_ansi_escape (lineptr, &skip_bytes))
1662 m_wrap_buffer.append (lineptr, skip_bytes);
1663 /* Note that we don't consider this a character, so we
1664 don't increment chars_printed here. */
1665 lineptr += skip_bytes;
1667 else if (*lineptr == '\r')
1669 m_wrap_buffer.push_back (*lineptr);
1670 chars_printed = 0;
1671 lineptr++;
1673 else
1675 m_wrap_buffer.push_back (*lineptr);
1676 chars_printed++;
1677 lineptr++;
1680 if (chars_printed >= chars_per_line)
1682 unsigned int save_chars = chars_printed;
1684 /* If we change the style, below, we'll want to reset it
1685 before continuing to print. If there is no wrap
1686 column, then we'll only reset the style if the pager
1687 prompt is given; and to avoid emitting style
1688 sequences in the middle of a run of text, we track
1689 this as well. */
1690 ui_file_style save_style = m_applied_style;
1691 bool did_paginate = false;
1693 chars_printed = 0;
1694 lines_printed++;
1695 if (m_wrap_column)
1697 /* We are about to insert a newline at an historic
1698 location in the WRAP_BUFFER. Before we do we want to
1699 restore the default style. To know if we actually
1700 need to insert an escape sequence we must restore the
1701 current applied style to how it was at the WRAP_COLUMN
1702 location. */
1703 m_applied_style = m_wrap_style;
1704 m_stream->emit_style_escape (ui_file_style ());
1705 /* If we aren't actually wrapping, don't output
1706 newline -- if chars_per_line is right, we
1707 probably just overflowed anyway; if it's wrong,
1708 let us keep going. */
1709 m_stream->puts ("\n");
1711 else
1712 this->flush_wrap_buffer ();
1714 /* Possible new page. Note that
1715 PAGINATION_DISABLED_FOR_COMMAND might be set during
1716 this loop, so we must continue to check it here. */
1717 if (pagination_enabled
1718 && !pagination_disabled_for_command
1719 && lines_printed >= lines_allowed)
1721 prompt_for_continue ();
1722 did_paginate = true;
1725 /* Now output indentation and wrapped string. */
1726 if (m_wrap_column)
1728 m_stream->puts (n_spaces (m_wrap_indent));
1730 /* Having finished inserting the wrapping we should
1731 restore the style as it was at the WRAP_COLUMN. */
1732 m_stream->emit_style_escape (m_wrap_style);
1734 /* The WRAP_BUFFER will still contain content, and that
1735 content might set some alternative style. Restore
1736 APPLIED_STYLE as it was before we started wrapping,
1737 this reflects the current style for the last character
1738 in WRAP_BUFFER. */
1739 m_applied_style = save_style;
1741 /* Note that this can set chars_printed > chars_per_line
1742 if we are printing a long string. */
1743 chars_printed = m_wrap_indent + (save_chars - m_wrap_column);
1744 m_wrap_column = 0; /* And disable fancy wrap */
1746 else if (did_paginate)
1747 m_stream->emit_style_escape (save_style);
1751 if (*lineptr == '\n')
1753 chars_printed = 0;
1754 wrap_here (0); /* Spit out chars, cancel further wraps. */
1755 lines_printed++;
1756 m_stream->puts ("\n");
1757 lineptr++;
1761 buffer_clearer.release ();
1764 void
1765 pager_file::write (const char *buf, long length_buf)
1767 /* We have to make a string here because the pager uses
1768 skip_ansi_escape, which requires NUL-termination. */
1769 std::string str (buf, length_buf);
1770 this->puts (str.c_str ());
1773 #if GDB_SELF_TEST
1775 /* Test that disabling the pager does not also disable word
1776 wrapping. */
1778 static void
1779 test_pager ()
1781 string_file *strfile = new string_file ();
1782 pager_file pager (strfile);
1784 /* Make sure the pager is disabled. */
1785 scoped_restore save_enabled
1786 = make_scoped_restore (&pagination_enabled, false);
1787 scoped_restore save_disabled
1788 = make_scoped_restore (&pagination_disabled_for_command, false);
1789 scoped_restore save_batch
1790 = make_scoped_restore (&batch_flag, false);
1791 scoped_restore save_lines
1792 = make_scoped_restore (&lines_per_page, 50);
1793 /* Make it easy to word wrap. */
1794 scoped_restore save_chars
1795 = make_scoped_restore (&chars_per_line, 15);
1796 scoped_restore save_printed
1797 = make_scoped_restore (&chars_printed, 0);
1799 pager.puts ("aaaaaaaaaaaa");
1800 pager.wrap_here (2);
1801 pager.puts ("bbbbbbbbbbbb\n");
1803 SELF_CHECK (strfile->string () == "aaaaaaaaaaaa\n bbbbbbbbbbbb\n");
1806 #endif /* GDB_SELF_TEST */
1808 void
1809 gdb_puts (const char *linebuffer, struct ui_file *stream)
1811 stream->puts (linebuffer);
1814 /* See utils.h. */
1816 void
1817 fputs_styled (const char *linebuffer, const ui_file_style &style,
1818 struct ui_file *stream)
1820 stream->emit_style_escape (style);
1821 gdb_puts (linebuffer, stream);
1822 stream->emit_style_escape (ui_file_style ());
1825 /* See utils.h. */
1827 void
1828 fputs_highlighted (const char *str, const compiled_regex &highlight,
1829 struct ui_file *stream)
1831 regmatch_t pmatch;
1833 while (*str && highlight.exec (str, 1, &pmatch, 0) == 0)
1835 size_t n_highlight = pmatch.rm_eo - pmatch.rm_so;
1837 /* Output the part before pmatch with current style. */
1838 while (pmatch.rm_so > 0)
1840 gdb_putc (*str, stream);
1841 pmatch.rm_so--;
1842 str++;
1845 /* Output pmatch with the highlight style. */
1846 stream->emit_style_escape (highlight_style.style ());
1847 while (n_highlight > 0)
1849 gdb_putc (*str, stream);
1850 n_highlight--;
1851 str++;
1853 stream->emit_style_escape (ui_file_style ());
1856 /* Output the trailing part of STR not matching HIGHLIGHT. */
1857 if (*str)
1858 gdb_puts (str, stream);
1861 void
1862 gdb_putc (int c)
1864 return gdb_stdout->putc (c);
1867 void
1868 gdb_putc (int c, struct ui_file *stream)
1870 return stream->putc (c);
1873 void
1874 gdb_vprintf (struct ui_file *stream, const char *format, va_list args)
1876 stream->vprintf (format, args);
1879 void
1880 gdb_vprintf (const char *format, va_list args)
1882 gdb_stdout->vprintf (format, args);
1885 void
1886 gdb_printf (struct ui_file *stream, const char *format, ...)
1888 va_list args;
1890 va_start (args, format);
1891 gdb_vprintf (stream, format, args);
1892 va_end (args);
1895 /* See utils.h. */
1897 void
1898 fprintf_styled (struct ui_file *stream, const ui_file_style &style,
1899 const char *format, ...)
1901 va_list args;
1903 stream->emit_style_escape (style);
1904 va_start (args, format);
1905 gdb_vprintf (stream, format, args);
1906 va_end (args);
1907 stream->emit_style_escape (ui_file_style ());
1910 void
1911 gdb_printf (const char *format, ...)
1913 va_list args;
1915 va_start (args, format);
1916 gdb_vprintf (gdb_stdout, format, args);
1917 va_end (args);
1921 void
1922 printf_unfiltered (const char *format, ...)
1924 va_list args;
1926 va_start (args, format);
1927 string_file file (gdb_stdout->can_emit_style_escape ());
1928 file.vprintf (format, args);
1929 gdb_stdout->puts_unfiltered (file.string ().c_str ());
1930 va_end (args);
1933 /* Easy -- but watch out!
1935 This routine is *not* a replacement for puts()! puts() appends a newline.
1936 This one doesn't, and had better not! */
1938 void
1939 gdb_puts (const char *string)
1941 gdb_stdout->puts (string);
1944 /* Return a pointer to N spaces and a null. The pointer is good
1945 until the next call to here. */
1946 const char *
1947 n_spaces (int n)
1949 char *t;
1950 static char *spaces = 0;
1951 static int max_spaces = -1;
1953 if (n > max_spaces)
1955 xfree (spaces);
1956 spaces = (char *) xmalloc (n + 1);
1957 for (t = spaces + n; t != spaces;)
1958 *--t = ' ';
1959 spaces[n] = '\0';
1960 max_spaces = n;
1963 return spaces + max_spaces - n;
1966 /* Print N spaces. */
1967 void
1968 print_spaces (int n, struct ui_file *stream)
1970 gdb_puts (n_spaces (n), stream);
1973 /* C++/ObjC demangler stuff. */
1975 /* fprintf_symbol attempts to demangle NAME, a symbol in language
1976 LANG, using demangling args ARG_MODE, and print it filtered to STREAM.
1977 If the name is not mangled, or the language for the name is unknown, or
1978 demangling is off, the name is printed in its "raw" form. */
1980 void
1981 fprintf_symbol (struct ui_file *stream, const char *name,
1982 enum language lang, int arg_mode)
1984 if (name != NULL)
1986 /* If user wants to see raw output, no problem. */
1987 if (!demangle)
1989 gdb_puts (name, stream);
1991 else
1993 gdb::unique_xmalloc_ptr<char> demangled
1994 = language_def (lang)->demangle_symbol (name, arg_mode);
1995 gdb_puts (demangled ? demangled.get () : name, stream);
2000 /* True if CH is a character that can be part of a symbol name. I.e.,
2001 either a number, a letter, or a '_'. */
2003 static bool
2004 valid_identifier_name_char (int ch)
2006 return (ISALNUM (ch) || ch == '_');
2009 /* Skip to end of token, or to END, whatever comes first. Input is
2010 assumed to be a C++ operator name. */
2012 static const char *
2013 cp_skip_operator_token (const char *token, const char *end)
2015 const char *p = token;
2016 while (p != end && !ISSPACE (*p) && *p != '(')
2018 if (valid_identifier_name_char (*p))
2020 while (p != end && valid_identifier_name_char (*p))
2021 p++;
2022 return p;
2024 else
2026 /* Note, ordered such that among ops that share a prefix,
2027 longer comes first. This is so that the loop below can
2028 bail on first match. */
2029 static const char *ops[] =
2031 "[",
2032 "]",
2033 "~",
2034 ",",
2035 "-=", "--", "->", "-",
2036 "+=", "++", "+",
2037 "*=", "*",
2038 "/=", "/",
2039 "%=", "%",
2040 "|=", "||", "|",
2041 "&=", "&&", "&",
2042 "^=", "^",
2043 "!=", "!",
2044 "<<=", "<=", "<<", "<",
2045 ">>=", ">=", ">>", ">",
2046 "==", "=",
2049 for (const char *op : ops)
2051 size_t oplen = strlen (op);
2052 size_t lencmp = std::min<size_t> (oplen, end - p);
2054 if (strncmp (p, op, lencmp) == 0)
2055 return p + lencmp;
2057 /* Some unidentified character. Return it. */
2058 return p + 1;
2062 return p;
2065 /* Advance STRING1/STRING2 past whitespace. */
2067 static void
2068 skip_ws (const char *&string1, const char *&string2, const char *end_str2)
2070 while (ISSPACE (*string1))
2071 string1++;
2072 while (string2 < end_str2 && ISSPACE (*string2))
2073 string2++;
2076 /* True if STRING points at the start of a C++ operator name. START
2077 is the start of the string that STRING points to, hence when
2078 reading backwards, we must not read any character before START. */
2080 static bool
2081 cp_is_operator (const char *string, const char *start)
2083 return ((string == start
2084 || !valid_identifier_name_char (string[-1]))
2085 && strncmp (string, CP_OPERATOR_STR, CP_OPERATOR_LEN) == 0
2086 && !valid_identifier_name_char (string[CP_OPERATOR_LEN]));
2089 /* If *NAME points at an ABI tag, skip it and return true. Otherwise
2090 leave *NAME unmodified and return false. (see GCC's abi_tag
2091 attribute), such names are demangled as e.g.,
2092 "function[abi:cxx11]()". */
2094 static bool
2095 skip_abi_tag (const char **name)
2097 const char *p = *name;
2099 if (startswith (p, "[abi:"))
2101 p += 5;
2103 while (valid_identifier_name_char (*p))
2104 p++;
2106 if (*p == ']')
2108 p++;
2109 *name = p;
2110 return true;
2113 return false;
2116 /* If *NAME points at a template parameter list, skip it and return true.
2117 Otherwise do nothing and return false. */
2119 static bool
2120 skip_template_parameter_list (const char **name)
2122 const char *p = *name;
2124 if (*p == '<')
2126 const char *template_param_list_end = find_toplevel_char (p + 1, '>');
2128 if (template_param_list_end == NULL)
2129 return false;
2131 p = template_param_list_end + 1;
2133 /* Skip any whitespace that might occur after the closing of the
2134 parameter list, but only if it is the end of parameter list. */
2135 const char *q = p;
2136 while (ISSPACE (*q))
2137 ++q;
2138 if (*q == '>')
2139 p = q;
2140 *name = p;
2141 return true;
2144 return false;
2147 /* See utils.h. */
2150 strncmp_iw_with_mode (const char *string1, const char *string2,
2151 size_t string2_len, strncmp_iw_mode mode,
2152 enum language language,
2153 completion_match_for_lcd *match_for_lcd,
2154 bool ignore_template_params)
2156 const char *string1_start = string1;
2157 const char *end_str2 = string2 + string2_len;
2158 bool skip_spaces = true;
2159 bool have_colon_op = (language == language_cplus
2160 || language == language_rust
2161 || language == language_fortran);
2163 gdb_assert (match_for_lcd == nullptr || match_for_lcd->empty ());
2165 while (1)
2167 if (skip_spaces
2168 || ((ISSPACE (*string1) && !valid_identifier_name_char (*string2))
2169 || (ISSPACE (*string2) && !valid_identifier_name_char (*string1))))
2171 skip_ws (string1, string2, end_str2);
2172 skip_spaces = false;
2175 /* Skip [abi:cxx11] tags in the symbol name if the lookup name
2176 doesn't include them. E.g.:
2178 string1: function[abi:cxx1](int)
2179 string2: function
2181 string1: function[abi:cxx1](int)
2182 string2: function(int)
2184 string1: Struct[abi:cxx1]::function()
2185 string2: Struct::function()
2187 string1: function(Struct[abi:cxx1], int)
2188 string2: function(Struct, int)
2190 if (string2 == end_str2
2191 || (*string2 != '[' && !valid_identifier_name_char (*string2)))
2193 const char *abi_start = string1;
2195 /* There can be more than one tag. */
2196 while (*string1 == '[' && skip_abi_tag (&string1))
2199 if (match_for_lcd != NULL && abi_start != string1)
2200 match_for_lcd->mark_ignored_range (abi_start, string1);
2202 while (ISSPACE (*string1))
2203 string1++;
2206 /* Skip template parameters in STRING1 if STRING2 does not contain
2207 any. E.g.:
2209 Case 1: User is looking for all functions named "foo".
2210 string1: foo <...> (...)
2211 string2: foo
2213 Case 2: User is looking for all methods named "foo" in all template
2214 class instantiations.
2215 string1: Foo<...>::foo <...> (...)
2216 string2: Foo::foo (...)
2218 Case 3: User is looking for a specific overload of a template
2219 function or method.
2220 string1: foo<...>
2221 string2: foo(...)
2223 Case 4: User is looking for a specific overload of a specific
2224 template instantiation.
2225 string1: foo<A> (...)
2226 string2: foo<B> (...)
2228 Case 5: User is looking wild parameter match.
2229 string1: foo<A<a<b<...> > > > (...)
2230 string2: foo<A
2232 if (language == language_cplus && ignore_template_params
2233 && *string1 == '<' && *string2 != '<')
2235 /* Skip any parameter list in STRING1. */
2236 const char *template_start = string1;
2238 if (skip_template_parameter_list (&string1))
2240 /* Don't mark the parameter list ignored if the user didn't
2241 try to ignore it. [Case #5 above] */
2242 if (*string2 != '\0'
2243 && match_for_lcd != NULL && template_start != string1)
2244 match_for_lcd->mark_ignored_range (template_start, string1);
2248 if (*string1 == '\0' || string2 == end_str2)
2249 break;
2251 /* Handle the :: operator. */
2252 if (have_colon_op && string1[0] == ':' && string1[1] == ':')
2254 if (*string2 != ':')
2255 return 1;
2257 string1++;
2258 string2++;
2260 if (string2 == end_str2)
2261 break;
2263 if (*string2 != ':')
2264 return 1;
2266 string1++;
2267 string2++;
2269 while (ISSPACE (*string1))
2270 string1++;
2271 while (string2 < end_str2 && ISSPACE (*string2))
2272 string2++;
2273 continue;
2276 /* Handle C++ user-defined operators. */
2277 else if (language == language_cplus
2278 && *string1 == 'o')
2280 if (cp_is_operator (string1, string1_start))
2282 /* An operator name in STRING1. Check STRING2. */
2283 size_t cmplen
2284 = std::min<size_t> (CP_OPERATOR_LEN, end_str2 - string2);
2285 if (strncmp (string1, string2, cmplen) != 0)
2286 return 1;
2288 string1 += cmplen;
2289 string2 += cmplen;
2291 if (string2 != end_str2)
2293 /* Check for "operatorX" in STRING2. */
2294 if (valid_identifier_name_char (*string2))
2295 return 1;
2297 skip_ws (string1, string2, end_str2);
2300 /* Handle operator(). */
2301 if (*string1 == '(')
2303 if (string2 == end_str2)
2305 if (mode == strncmp_iw_mode::NORMAL)
2306 return 0;
2307 else
2309 /* Don't break for the regular return at the
2310 bottom, because "operator" should not
2311 match "operator()", since this open
2312 parentheses is not the parameter list
2313 start. */
2314 return *string1 != '\0';
2318 if (*string1 != *string2)
2319 return 1;
2321 string1++;
2322 string2++;
2325 while (1)
2327 skip_ws (string1, string2, end_str2);
2329 /* Skip to end of token, or to END, whatever comes
2330 first. */
2331 const char *end_str1 = string1 + strlen (string1);
2332 const char *p1 = cp_skip_operator_token (string1, end_str1);
2333 const char *p2 = cp_skip_operator_token (string2, end_str2);
2335 cmplen = std::min (p1 - string1, p2 - string2);
2336 if (p2 == end_str2)
2338 if (strncmp (string1, string2, cmplen) != 0)
2339 return 1;
2341 else
2343 if (p1 - string1 != p2 - string2)
2344 return 1;
2345 if (strncmp (string1, string2, cmplen) != 0)
2346 return 1;
2349 string1 += cmplen;
2350 string2 += cmplen;
2352 if (*string1 == '\0' || string2 == end_str2)
2353 break;
2354 if (*string1 == '(' || *string2 == '(')
2355 break;
2357 /* If STRING1 or STRING2 starts with a template
2358 parameter list, break out of operator processing. */
2359 skip_ws (string1, string2, end_str2);
2360 if (*string1 == '<' || *string2 == '<')
2361 break;
2364 continue;
2368 if (case_sensitivity == case_sensitive_on && *string1 != *string2)
2369 break;
2370 if (case_sensitivity == case_sensitive_off
2371 && (TOLOWER ((unsigned char) *string1)
2372 != TOLOWER ((unsigned char) *string2)))
2373 break;
2375 /* If we see any non-whitespace, non-identifier-name character
2376 (any of "()<>*&" etc.), then skip spaces the next time
2377 around. */
2378 if (!ISSPACE (*string1) && !valid_identifier_name_char (*string1))
2379 skip_spaces = true;
2381 string1++;
2382 string2++;
2385 if (string2 == end_str2)
2387 if (mode == strncmp_iw_mode::NORMAL)
2389 /* Strip abi tag markers from the matched symbol name.
2390 Usually the ABI marker will be found on function name
2391 (automatically added because the function returns an
2392 object marked with an ABI tag). However, it's also
2393 possible to see a marker in one of the function
2394 parameters, for example.
2396 string2 (lookup name):
2397 func
2398 symbol name:
2399 function(some_struct[abi:cxx11], int)
2401 and for completion LCD computation we want to say that
2402 the match was for:
2403 function(some_struct, int)
2405 if (match_for_lcd != NULL)
2407 while ((string1 = strstr (string1, "[abi:")) != NULL)
2409 const char *abi_start = string1;
2411 /* There can be more than one tag. */
2412 while (skip_abi_tag (&string1) && *string1 == '[')
2415 if (abi_start != string1)
2416 match_for_lcd->mark_ignored_range (abi_start, string1);
2420 return 0;
2422 else
2424 if (*string1 == '(')
2426 int p_count = 0;
2430 if (*string1 == '(')
2431 ++p_count;
2432 else if (*string1 == ')')
2433 --p_count;
2434 ++string1;
2436 while (*string1 != '\0' && p_count > 0);
2438 /* There maybe things like 'const' after the parameters,
2439 which we do want to ignore. However, if there's an '@'
2440 then this likely indicates something like '@plt' which we
2441 should not ignore. */
2442 return *string1 == '@';
2445 return *string1 == '\0' ? 0 : 1;
2449 else
2450 return 1;
2453 #if GDB_SELF_TEST
2455 /* Unit tests for strncmp_iw_with_mode. */
2457 #define CHECK_MATCH_LM(S1, S2, MODE, LANG, LCD) \
2458 SELF_CHECK (strncmp_iw_with_mode ((S1), (S2), strlen ((S2)), \
2459 strncmp_iw_mode::MODE, \
2460 (LANG), (LCD)) == 0)
2462 #define CHECK_MATCH_LANG(S1, S2, MODE, LANG) \
2463 CHECK_MATCH_LM ((S1), (S2), MODE, (LANG), nullptr)
2465 #define CHECK_MATCH(S1, S2, MODE) \
2466 CHECK_MATCH_LANG ((S1), (S2), MODE, language_minimal)
2468 #define CHECK_NO_MATCH_LM(S1, S2, MODE, LANG, LCD) \
2469 SELF_CHECK (strncmp_iw_with_mode ((S1), (S2), strlen ((S2)), \
2470 strncmp_iw_mode::MODE, \
2471 (LANG)) != 0)
2473 #define CHECK_NO_MATCH_LANG(S1, S2, MODE, LANG) \
2474 CHECK_NO_MATCH_LM ((S1), (S2), MODE, (LANG), nullptr)
2476 #define CHECK_NO_MATCH(S1, S2, MODE) \
2477 CHECK_NO_MATCH_LANG ((S1), (S2), MODE, language_minimal)
2479 static void
2480 check_scope_operator (enum language lang)
2482 CHECK_MATCH_LANG ("::", "::", NORMAL, lang);
2483 CHECK_MATCH_LANG ("::foo", "::", NORMAL, lang);
2484 CHECK_MATCH_LANG ("::foo", "::foo", NORMAL, lang);
2485 CHECK_MATCH_LANG (" :: foo ", "::foo", NORMAL, lang);
2486 CHECK_MATCH_LANG ("a::b", "a ::b", NORMAL, lang);
2487 CHECK_MATCH_LANG ("a::b", "a\t::b", NORMAL, lang);
2488 CHECK_MATCH_LANG ("a::b", "a \t::b", NORMAL, lang);
2489 CHECK_MATCH_LANG ("a::b", "a\t ::b", NORMAL, lang);
2490 CHECK_MATCH_LANG ("a::b", "a:: b", NORMAL, lang);
2491 CHECK_MATCH_LANG ("a::b", "a::\tb", NORMAL, lang);
2492 CHECK_MATCH_LANG ("a::b", "a:: \tb", NORMAL, lang);
2493 CHECK_MATCH_LANG ("a::b", "a::\t b", NORMAL, lang);
2494 CHECK_MATCH_LANG ("a::b", "a :: b", NORMAL, lang);
2495 CHECK_MATCH_LANG ("a::b", "a ::\tb", NORMAL, lang);
2496 CHECK_MATCH_LANG ("a::b", "a\t:: b", NORMAL, lang);
2497 CHECK_MATCH_LANG ("a::b", "a \t::\t b", NORMAL, lang);
2498 CHECK_MATCH_LANG ("a ::b", "a::b", NORMAL, lang);
2499 CHECK_MATCH_LANG ("a\t::b", "a::b", NORMAL, lang);
2500 CHECK_MATCH_LANG ("a \t::b", "a::b", NORMAL, lang);
2501 CHECK_MATCH_LANG ("a\t ::b", "a::b", NORMAL, lang);
2502 CHECK_MATCH_LANG ("a:: b", "a::b", NORMAL, lang);
2503 CHECK_MATCH_LANG ("a::\tb", "a::b", NORMAL, lang);
2504 CHECK_MATCH_LANG ("a:: \tb", "a::b", NORMAL, lang);
2505 CHECK_MATCH_LANG ("a::\t b", "a::b", NORMAL, lang);
2506 CHECK_MATCH_LANG ("a :: b", "a::b", NORMAL, lang);
2507 CHECK_MATCH_LANG ("a ::\tb", "a::b", NORMAL, lang);
2508 CHECK_MATCH_LANG ("a\t:: b", "a::b", NORMAL, lang);
2509 CHECK_MATCH_LANG ("a \t::\t b", "a::b", NORMAL, lang);
2510 CHECK_MATCH_LANG ("a::b::c", "a::b::c", NORMAL, lang);
2511 CHECK_MATCH_LANG (" a:: b:: c", "a::b::c", NORMAL, lang);
2512 CHECK_MATCH_LANG ("a::b::c", " a:: b:: c", NORMAL, lang);
2513 CHECK_MATCH_LANG ("a ::b ::c", "a::b::c", NORMAL, lang);
2514 CHECK_MATCH_LANG ("a::b::c", "a :: b:: c", NORMAL, lang);
2515 CHECK_MATCH_LANG ("\ta::\tb::\tc", "\ta::\tb::\tc", NORMAL, lang);
2516 CHECK_MATCH_LANG ("a\t::b\t::c\t", "a\t::b\t::c\t", NORMAL, lang);
2517 CHECK_MATCH_LANG (" \ta:: \tb:: \tc", " \ta:: \tb:: \tc", NORMAL, lang);
2518 CHECK_MATCH_LANG ("\t a::\t b::\t c", "\t a::\t b::\t c", NORMAL, lang);
2519 CHECK_MATCH_LANG ("a::b::c", "\ta::\tb::\tc", NORMAL, lang);
2520 CHECK_MATCH_LANG ("a::b::c", "a\t::b\t::c\t", NORMAL, lang);
2521 CHECK_MATCH_LANG ("a::b::c", " \ta:: \tb:: \tc", NORMAL, lang);
2522 CHECK_MATCH_LANG ("a::b::c", "\t a::\t b::\t c", NORMAL, lang);
2523 CHECK_MATCH_LANG ("\ta::\tb::\tc", "a::b::c", NORMAL, lang);
2524 CHECK_MATCH_LANG ("a\t::b\t::c\t", "a::b::c", NORMAL, lang);
2525 CHECK_MATCH_LANG (" \ta:: \tb:: \tc", "a::b::c", NORMAL, lang);
2526 CHECK_MATCH_LANG ("\t a::\t b::\t c", "a::b::c", NORMAL, lang);
2527 CHECK_MATCH_LANG ("a :: b:: c\t", "\ta :: b\t:: c\t\t", NORMAL, lang);
2528 CHECK_MATCH_LANG (" a::\t \t b:: c\t", "\ta ::b:: c\t\t",
2529 NORMAL, lang);
2530 CHECK_MATCH_LANG ("a :: b :: \t\t\tc\t",
2531 "\t\t\t\ta :: \t\t\t b \t\t::c",
2532 NORMAL, lang);
2533 CHECK_MATCH_LANG ("a::b()", "a", NORMAL, lang);
2534 CHECK_MATCH_LANG ("a::b()", "a::", NORMAL, lang);
2535 CHECK_MATCH_LANG ("a::b()", "a::b", NORMAL, lang);
2536 CHECK_MATCH_LANG ("a::b(a)", "a", NORMAL, lang);
2537 CHECK_MATCH_LANG ("a::b(a)", "a::", NORMAL, lang);
2538 CHECK_MATCH_LANG ("a::b(a)", "a::b", NORMAL, lang);
2539 CHECK_MATCH_LANG ("a::b(a,b)", "a", NORMAL, lang);
2540 CHECK_MATCH_LANG ("a::b(a,b)", "a::", NORMAL, lang);
2541 CHECK_MATCH_LANG ("a::b(a,b)", "a::b", NORMAL, lang);
2542 CHECK_MATCH_LANG ("a::b(a,b,c)", "a", NORMAL, lang);
2543 CHECK_MATCH_LANG ("a::b(a,b,c)", "a::", NORMAL, lang);
2544 CHECK_MATCH_LANG ("a::b(a,b,c)", "a::b", NORMAL, lang);
2546 CHECK_NO_MATCH_LANG ("a::", "::a", NORMAL, lang);
2547 CHECK_NO_MATCH_LANG ("::a", "::a()", NORMAL, lang);
2548 CHECK_NO_MATCH_LANG ("::", "::a", NORMAL, lang);
2549 CHECK_NO_MATCH_LANG ("a:::b", "a::b", NORMAL, lang);
2550 CHECK_NO_MATCH_LANG ("a::b()", "a::b(a)", NORMAL, lang);
2551 CHECK_NO_MATCH_LANG ("a::b(a)", "a::b()", NORMAL, lang);
2552 CHECK_NO_MATCH_LANG ("a::b(a,b)", "a::b(a,a)", NORMAL, lang);
2553 CHECK_NO_MATCH_LANG ("a::b", "a()", NORMAL, lang);
2554 CHECK_NO_MATCH_LANG ("a::b", "a::()", NORMAL, lang);
2555 CHECK_NO_MATCH_LANG ("a::b", "a::b()", NORMAL, lang);
2556 CHECK_NO_MATCH_LANG ("a::b", "a(a)", NORMAL, lang);
2557 CHECK_NO_MATCH_LANG ("a::b", "a::(a)", NORMAL, lang);
2558 CHECK_NO_MATCH_LANG ("a::b", "a::b()", NORMAL, lang);
2559 CHECK_NO_MATCH_LANG ("a::b", "a(a,b)", NORMAL, lang);
2560 CHECK_NO_MATCH_LANG ("a::b", "a::(a,b)", NORMAL, lang);
2561 CHECK_NO_MATCH_LANG ("a::b", "a::b(a,b)", NORMAL, lang);
2562 CHECK_NO_MATCH_LANG ("a::b", "a(a,b,c)", NORMAL, lang);
2563 CHECK_NO_MATCH_LANG ("a::b", "a::(a,b,c)", NORMAL, lang);
2564 CHECK_NO_MATCH_LANG ("a::b", "a::b(a,b,c)", NORMAL, lang);
2567 /* Callback for strncmp_iw_with_mode unit tests. */
2569 static void
2570 strncmp_iw_with_mode_tests ()
2572 /* Some of the following tests are nonsensical, but could be input by a
2573 deranged script (or user). */
2575 /* strncmp_iw_mode::NORMAL: strcmp()-like but ignore any whitespace... */
2577 CHECK_MATCH ("", "", NORMAL);
2578 CHECK_MATCH ("foo", "foo", NORMAL);
2579 CHECK_MATCH (" foo", "foo", NORMAL);
2580 CHECK_MATCH ("foo ", "foo", NORMAL);
2581 CHECK_MATCH (" foo ", "foo", NORMAL);
2582 CHECK_MATCH (" foo", "foo", NORMAL);
2583 CHECK_MATCH ("foo ", "foo", NORMAL);
2584 CHECK_MATCH (" foo ", "foo", NORMAL);
2585 CHECK_MATCH ("\tfoo", "foo", NORMAL);
2586 CHECK_MATCH ("foo\t", "foo", NORMAL);
2587 CHECK_MATCH ("\tfoo\t", "foo", NORMAL);
2588 CHECK_MATCH (" \tfoo \t", "foo", NORMAL);
2589 CHECK_MATCH ("\t foo\t ", "foo", NORMAL);
2590 CHECK_MATCH ("\t \t \t\t\t\t foo\t\t\t \t\t \t \t \t \t ",
2591 "foo", NORMAL);
2592 CHECK_MATCH ("foo",
2593 "\t \t \t\t\t\t foo\t\t\t \t\t \t \t \t \t ",
2594 NORMAL);
2595 CHECK_MATCH ("foo bar", "foo", NORMAL);
2596 CHECK_NO_MATCH ("foo", "bar", NORMAL);
2597 CHECK_NO_MATCH ("foo bar", "foobar", NORMAL);
2598 CHECK_NO_MATCH (" foo ", "bar", NORMAL);
2599 CHECK_NO_MATCH ("foo", " bar ", NORMAL);
2600 CHECK_NO_MATCH (" \t\t foo\t\t ", "\t \t \tbar\t", NORMAL);
2601 CHECK_NO_MATCH ("@!%&", "@!%&foo", NORMAL);
2603 /* ... and function parameters in STRING1. */
2604 CHECK_MATCH ("foo()", "foo()", NORMAL);
2605 CHECK_MATCH ("foo ()", "foo()", NORMAL);
2606 CHECK_MATCH ("foo ()", "foo()", NORMAL);
2607 CHECK_MATCH ("foo\t()", "foo()", NORMAL);
2608 CHECK_MATCH ("foo\t ()", "foo()", NORMAL);
2609 CHECK_MATCH ("foo \t()", "foo()", NORMAL);
2610 CHECK_MATCH ("foo()", "foo ()", NORMAL);
2611 CHECK_MATCH ("foo()", "foo ()", NORMAL);
2612 CHECK_MATCH ("foo()", "foo\t()", NORMAL);
2613 CHECK_MATCH ("foo()", "foo\t ()", NORMAL);
2614 CHECK_MATCH ("foo()", "foo \t()", NORMAL);
2615 CHECK_MATCH ("foo()", "foo()", NORMAL);
2616 CHECK_MATCH ("foo ()", "foo ()", NORMAL);
2617 CHECK_MATCH ("foo ()", "foo ()", NORMAL);
2618 CHECK_MATCH ("foo\t()", "foo\t()", NORMAL);
2619 CHECK_MATCH ("foo\t ()", "foo\t ()", NORMAL);
2620 CHECK_MATCH ("foo \t()", "foo \t()", NORMAL);
2621 CHECK_MATCH ("foo(a)", "foo(a)", NORMAL);
2622 CHECK_MATCH ("foo( a)", "foo(a)", NORMAL);
2623 CHECK_MATCH ("foo(a )", "foo(a)", NORMAL);
2624 CHECK_MATCH ("foo(\ta)", "foo(a)", NORMAL);
2625 CHECK_MATCH ("foo(a\t)", "foo(a)", NORMAL);
2626 CHECK_MATCH ("foo(\t a)", "foo(a)", NORMAL);
2627 CHECK_MATCH ("foo( \ta)", "foo(a)", NORMAL);
2628 CHECK_MATCH ("foo(a\t )", "foo(a)", NORMAL);
2629 CHECK_MATCH ("foo(a \t)", "foo(a)", NORMAL);
2630 CHECK_MATCH ("foo( a )", "foo(a)", NORMAL);
2631 CHECK_MATCH ("foo(\ta\t)", "foo(a)", NORMAL);
2632 CHECK_MATCH ("foo(\t a\t )", "foo(a)", NORMAL);
2633 CHECK_MATCH ("foo( \ta \t)", "foo(a)", NORMAL);
2634 CHECK_MATCH ("foo(a)", "foo( a)", NORMAL);
2635 CHECK_MATCH ("foo(a)", "foo(a )", NORMAL);
2636 CHECK_MATCH ("foo(a)", "foo(\ta)", NORMAL);
2637 CHECK_MATCH ("foo(a)", "foo(a\t)", NORMAL);
2638 CHECK_MATCH ("foo(a)", "foo(\t a)", NORMAL);
2639 CHECK_MATCH ("foo(a)", "foo( \ta)", NORMAL);
2640 CHECK_MATCH ("foo(a)", "foo(a\t )", NORMAL);
2641 CHECK_MATCH ("foo(a)", "foo(a \t)", NORMAL);
2642 CHECK_MATCH ("foo(a)", "foo( a )", NORMAL);
2643 CHECK_MATCH ("foo(a)", "foo(\ta\t)", NORMAL);
2644 CHECK_MATCH ("foo(a)", "foo(\t a\t )", NORMAL);
2645 CHECK_MATCH ("foo(a)", "foo( \ta \t)", NORMAL);
2646 CHECK_MATCH ("foo(a,b)", "foo(a,b)", NORMAL);
2647 CHECK_MATCH ("foo(a ,b)", "foo(a,b)", NORMAL);
2648 CHECK_MATCH ("foo(a\t,b)", "foo(a,b)", NORMAL);
2649 CHECK_MATCH ("foo(a,\tb)", "foo(a,b)", NORMAL);
2650 CHECK_MATCH ("foo(a\t,\tb)", "foo(a,b)", NORMAL);
2651 CHECK_MATCH ("foo(a \t,b)", "foo(a,b)", NORMAL);
2652 CHECK_MATCH ("foo(a\t ,b)", "foo(a,b)", NORMAL);
2653 CHECK_MATCH ("foo(a,\tb)", "foo(a,b)", NORMAL);
2654 CHECK_MATCH ("foo(a, \tb)", "foo(a,b)", NORMAL);
2655 CHECK_MATCH ("foo(a,\t b)", "foo(a,b)", NORMAL);
2656 CHECK_MATCH ("foo(a,b)", "foo(a ,b)", NORMAL);
2657 CHECK_MATCH ("foo(a,b)", "foo(a\t,b)", NORMAL);
2658 CHECK_MATCH ("foo(a,b)", "foo(a,\tb)", NORMAL);
2659 CHECK_MATCH ("foo(a,b)", "foo(a\t,\tb)", NORMAL);
2660 CHECK_MATCH ("foo(a,b)", "foo(a \t,b)", NORMAL);
2661 CHECK_MATCH ("foo(a,b)", "foo(a\t ,b)", NORMAL);
2662 CHECK_MATCH ("foo(a,b)", "foo(a,\tb)", NORMAL);
2663 CHECK_MATCH ("foo(a,b)", "foo(a, \tb)", NORMAL);
2664 CHECK_MATCH ("foo(a,b)", "foo(a,\t b)", NORMAL);
2665 CHECK_MATCH ("foo(a,b,c,d)", "foo(a,b,c,d)", NORMAL);
2666 CHECK_MATCH (" foo ( a , b , c , d ) ", "foo(a,b,c,d)", NORMAL);
2667 CHECK_MATCH (" foo ( a , b , c , d ) ", "foo( a , b , c , d )", NORMAL);
2668 CHECK_MATCH ("foo &\t*(\ta b *\t\t&)", "foo", NORMAL);
2669 CHECK_MATCH ("foo &\t*(\ta b *\t\t&)", "foo&*(a b * &)", NORMAL);
2670 CHECK_MATCH ("foo(a) b", "foo(a)", NORMAL);
2671 CHECK_MATCH ("*foo(*a&)", "*foo", NORMAL);
2672 CHECK_MATCH ("*foo(*a&)", "*foo(*a&)", NORMAL);
2673 CHECK_MATCH ("*a&b#c/^d$foo(*a&)", "*a&b#c/^d$foo", NORMAL);
2674 CHECK_MATCH ("* foo", "*foo", NORMAL);
2675 CHECK_MATCH ("foo&", "foo", NORMAL);
2676 CHECK_MATCH ("foo*", "foo", NORMAL);
2677 CHECK_MATCH ("foo.", "foo", NORMAL);
2678 CHECK_MATCH ("foo->", "foo", NORMAL);
2680 CHECK_NO_MATCH ("foo", "foo(", NORMAL);
2681 CHECK_NO_MATCH ("foo", "foo()", NORMAL);
2682 CHECK_NO_MATCH ("foo", "foo(a)", NORMAL);
2683 CHECK_NO_MATCH ("foo", "foo(a)", NORMAL);
2684 CHECK_NO_MATCH ("foo", "foo*", NORMAL);
2685 CHECK_NO_MATCH ("foo", "foo (*", NORMAL);
2686 CHECK_NO_MATCH ("foo*", "foo (*", NORMAL);
2687 CHECK_NO_MATCH ("foo *", "foo (*", NORMAL);
2688 CHECK_NO_MATCH ("foo&", "foo (*", NORMAL);
2689 CHECK_NO_MATCH ("foo &", "foo (*", NORMAL);
2690 CHECK_NO_MATCH ("foo &*", "foo (&)", NORMAL);
2691 CHECK_NO_MATCH ("foo & \t *\t", "foo (*", NORMAL);
2692 CHECK_NO_MATCH ("foo & \t *\t", "foo (*", NORMAL);
2693 CHECK_NO_MATCH ("foo(a*) b", "foo(a) b", NORMAL);
2694 CHECK_NO_MATCH ("foo[aqi:A](a)", "foo(b)", NORMAL);
2695 CHECK_NO_MATCH ("*foo", "foo", NORMAL);
2696 CHECK_NO_MATCH ("*foo", "foo*", NORMAL);
2697 CHECK_NO_MATCH ("*foo*", "*foo&", NORMAL);
2698 CHECK_NO_MATCH ("*foo*", "foo *", NORMAL);
2699 CHECK_NO_MATCH ("&foo", "foo", NORMAL);
2700 CHECK_NO_MATCH ("&foo", "foo&", NORMAL);
2701 CHECK_NO_MATCH ("foo&", "&foo", NORMAL);
2702 CHECK_NO_MATCH ("foo", "foo&", NORMAL);
2703 CHECK_NO_MATCH ("foo", "foo*", NORMAL);
2704 CHECK_NO_MATCH ("foo", "foo.", NORMAL);
2705 CHECK_NO_MATCH ("foo", "foo->", NORMAL);
2706 CHECK_NO_MATCH ("foo bar", "foo()", NORMAL);
2707 CHECK_NO_MATCH ("foo bar", "foo bar()", NORMAL);
2708 CHECK_NO_MATCH ("foo()", "foo(a)", NORMAL);
2709 CHECK_NO_MATCH ("*(*)&", "*(*)*", NORMAL);
2710 CHECK_NO_MATCH ("foo(a)", "foo()", NORMAL);
2711 CHECK_NO_MATCH ("foo(a)", "foo(b)", NORMAL);
2712 CHECK_NO_MATCH ("foo(a,b)", "foo(a,b,c)", NORMAL);
2713 CHECK_NO_MATCH ("foo(a\\b)", "foo()", NORMAL);
2714 CHECK_NO_MATCH ("foo bar(a b c d)", "foobar", NORMAL);
2715 CHECK_NO_MATCH ("foo bar(a b c d)", "foobar ( a b c \td\t)\t", NORMAL);
2717 /* Test scope operator. */
2718 check_scope_operator (language_minimal);
2719 check_scope_operator (language_cplus);
2720 check_scope_operator (language_fortran);
2721 check_scope_operator (language_rust);
2723 /* Test C++ user-defined operators. */
2724 CHECK_MATCH_LANG ("operator foo(int&)", "operator foo(int &)", NORMAL,
2725 language_cplus);
2726 CHECK_MATCH_LANG ("operator foo(int &)", "operator foo(int &)", NORMAL,
2727 language_cplus);
2728 CHECK_MATCH_LANG ("operator foo(int\t&)", "operator foo(int\t&)", NORMAL,
2729 language_cplus);
2730 CHECK_MATCH_LANG ("operator foo (int)", "operator foo(int)", NORMAL,
2731 language_cplus);
2732 CHECK_MATCH_LANG ("operator foo\t(int)", "operator foo(int)", NORMAL,
2733 language_cplus);
2734 CHECK_MATCH_LANG ("operator foo \t(int)", "operator foo(int)", NORMAL,
2735 language_cplus);
2736 CHECK_MATCH_LANG ("operator foo (int)", "operator foo \t(int)", NORMAL,
2737 language_cplus);
2738 CHECK_MATCH_LANG ("operator foo\t(int)", "operator foo \t(int)", NORMAL,
2739 language_cplus);
2740 CHECK_MATCH_LANG ("operator foo \t(int)", "operator foo \t(int)", NORMAL,
2741 language_cplus);
2743 CHECK_MATCH_LANG ("a::operator foo(int&)", "a::operator foo(int &)", NORMAL,
2744 language_cplus);
2745 CHECK_MATCH_LANG ("a :: operator foo(int &)", "a::operator foo(int &)", NORMAL,
2746 language_cplus);
2747 CHECK_MATCH_LANG ("a \t:: \toperator foo(int\t&)", "a::operator foo(int\t&)", NORMAL,
2748 language_cplus);
2749 CHECK_MATCH_LANG ("a::operator foo (int)", "a::operator foo(int)", NORMAL,
2750 language_cplus);
2751 CHECK_MATCH_LANG ("a::operator foo\t(int)", "a::operator foo(int)", NORMAL,
2752 language_cplus);
2753 CHECK_MATCH_LANG ("a::operator foo \t(int)", "a::operator foo(int)", NORMAL,
2754 language_cplus);
2755 CHECK_MATCH_LANG ("a::operator foo (int)", "a::operator foo \t(int)", NORMAL,
2756 language_cplus);
2757 CHECK_MATCH_LANG ("a::operator foo\t(int)", "a::operator foo \t(int)", NORMAL,
2758 language_cplus);
2759 CHECK_MATCH_LANG ("a::operator foo \t(int)", "a::operator foo \t(int)", NORMAL,
2760 language_cplus);
2762 CHECK_NO_MATCH_LANG ("operator foo(int)", "operator foo(char)", NORMAL,
2763 language_cplus);
2764 CHECK_NO_MATCH_LANG ("operator foo(int)", "operator foo(int *)", NORMAL,
2765 language_cplus);
2766 CHECK_NO_MATCH_LANG ("operator foo(int)", "operator foo(int &)", NORMAL,
2767 language_cplus);
2768 CHECK_NO_MATCH_LANG ("operator foo(int)", "operator foo(int, char *)", NORMAL,
2769 language_cplus);
2770 CHECK_NO_MATCH_LANG ("operator foo(int)", "operator bar(int)", NORMAL,
2771 language_cplus);
2773 CHECK_NO_MATCH_LANG ("a::operator b::foo(int)", "a::operator a::foo(char)", NORMAL,
2774 language_cplus);
2775 CHECK_NO_MATCH_LANG ("a::operator foo(int)", "a::operator foo(int *)", NORMAL,
2776 language_cplus);
2777 CHECK_NO_MATCH_LANG ("a::operator foo(int)", "a::operator foo(int &)", NORMAL,
2778 language_cplus);
2779 CHECK_NO_MATCH_LANG ("a::operator foo(int)", "a::operator foo(int, char *)", NORMAL,
2780 language_cplus);
2781 CHECK_NO_MATCH_LANG ("a::operator foo(int)", "a::operator bar(int)", NORMAL,
2782 language_cplus);
2784 /* Skip "[abi:cxx11]" tags in the symbol name if the lookup name
2785 doesn't include them. These are not language-specific in
2786 strncmp_iw_with_mode. */
2788 CHECK_MATCH ("foo[abi:a]", "foo", NORMAL);
2789 CHECK_MATCH ("foo[abi:a]()", "foo", NORMAL);
2790 CHECK_MATCH ("foo[abi:a](a)", "foo", NORMAL);
2791 CHECK_MATCH ("foo[abi:a](a&,b*)", "foo", NORMAL);
2792 CHECK_MATCH ("foo[abi:a](a,b)", "foo(a,b)", NORMAL);
2793 CHECK_MATCH ("foo[abi:a](a,b) c", "foo(a,b) c", NORMAL);
2794 CHECK_MATCH ("foo[abi:a](a)", "foo(a)", NORMAL);
2795 CHECK_MATCH ("foo[abi:a](a,b)", "foo(a,b)", NORMAL);
2796 CHECK_MATCH ("foo[abi:a]", "foo[abi:a]", NORMAL);
2797 CHECK_MATCH ("foo[ abi:a]", "foo[abi:a]", NORMAL);
2798 CHECK_MATCH ("foo[\tabi:a]", "foo[abi:a]", NORMAL);
2799 CHECK_MATCH ("foo[ \tabi:a]", "foo[abi:a]", NORMAL);
2800 CHECK_MATCH ("foo[\t abi:a]", "foo[abi:a]", NORMAL);
2801 CHECK_MATCH ("foo[abi :a]", "foo[abi:a]", NORMAL);
2802 CHECK_MATCH ("foo[abi\t:a]", "foo[abi:a]", NORMAL);
2803 CHECK_MATCH ("foo[abi \t:a]", "foo[abi:a]", NORMAL);
2804 CHECK_MATCH ("foo[abi\t :a]", "foo[abi:a]", NORMAL);
2805 CHECK_MATCH ("foo[abi:a]", "foo[ abi:a]", NORMAL);
2806 CHECK_MATCH ("foo[abi:a]", "foo[\tabi:a]", NORMAL);
2807 CHECK_MATCH ("foo[abi:a]", "foo[ \tabi:a]", NORMAL);
2808 CHECK_MATCH ("foo[abi:a]", "foo[\t abi:a]", NORMAL);
2809 CHECK_MATCH ("foo[abi:a]", "foo[abi :a]", NORMAL);
2810 CHECK_MATCH ("foo[abi:a]", "foo[abi\t:a]", NORMAL);
2811 CHECK_MATCH ("foo[abi:a]", "foo[abi \t:a]", NORMAL);
2812 CHECK_MATCH ("foo[abi:a]", "foo[abi\t :a]", NORMAL);
2813 CHECK_MATCH ("foo[abi:a]", "foo[abi:a ]", NORMAL);
2814 CHECK_MATCH ("foo[abi:a]", "foo[abi:a\t]", NORMAL);
2815 CHECK_MATCH ("foo[abi:a]", "foo[abi:a \t]", NORMAL);
2816 CHECK_MATCH ("foo[abi:a]", "foo[abi:a\t ]", NORMAL);
2817 CHECK_MATCH ("foo[abi:a,b]", "foo[abi:a,b]", NORMAL);
2818 CHECK_MATCH ("foo[abi:::]", "foo[abi:::]", NORMAL);
2819 CHECK_MATCH ("foo[abi : : : ]", "foo[abi:::]", NORMAL);
2820 CHECK_MATCH ("foo[abi:::]", "foo[abi : : : ]", NORMAL);
2821 CHECK_MATCH ("foo[ \t abi \t:\t: : \t]",
2822 "foo[ abi : \t ::]",
2823 NORMAL);
2824 CHECK_MATCH ("foo< bar< baz< quxi > > >(int)", "foo<bar<baz<quxi>>>(int)",
2825 NORMAL);
2826 CHECK_MATCH ("\tfoo<\tbar<\tbaz\t<\tquxi\t>\t>\t>(int)",
2827 "foo<bar<baz<quxi>>>(int)", NORMAL);
2828 CHECK_MATCH (" \tfoo \t< \tbar \t< \tbaz \t< \tquxi \t> \t> \t> \t( \tint \t)",
2829 "foo<bar<baz<quxi>>>(int)", NORMAL);
2830 CHECK_MATCH ("foo<bar<baz<quxi>>>(int)",
2831 "foo < bar < baz < quxi > > > (int)", NORMAL);
2832 CHECK_MATCH ("foo<bar<baz<quxi>>>(int)",
2833 "\tfoo\t<\tbar\t<\tbaz\t<\tquxi\t>\t>\t>\t(int)", NORMAL);
2834 CHECK_MATCH ("foo<bar<baz<quxi>>>(int)",
2835 " \tfoo \t< \tbar \t< \tbaz \t< \tquxi \t> \t> \t> \t( \tint \t)", NORMAL);
2836 CHECK_MATCH ("foo<bar<baz>>::foo(quxi &)", "fo", NORMAL);
2837 CHECK_MATCH ("foo<bar<baz>>::foo(quxi &)", "foo", NORMAL);
2838 CHECK_MATCH ("foo<bar<baz>>::foo(quxi &)", "foo<bar<baz>>::", NORMAL);
2839 CHECK_MATCH ("foo<bar<baz>>::foo(quxi &)", "foo<bar<baz> >::foo", NORMAL);
2840 CHECK_MATCH ("foo[abi:a][abi:b](bar[abi:c][abi:d])", "foo[abi:a][abi:b](bar[abi:c][abi:d])",
2841 NORMAL);
2842 CHECK_MATCH ("foo[abi:a][abi:b](bar[abi:c][abi:d])", "foo", NORMAL);
2843 CHECK_MATCH ("foo[abi:a][abi:b](bar[abi:c][abi:d])", "foo(bar)", NORMAL);
2844 CHECK_MATCH ("foo[abi:a][abi:b](bar[abi:c][abi:d])", "foo[abi:a](bar)", NORMAL);
2845 CHECK_MATCH ("foo[abi:a][abi:b](bar[abi:c][abi:d])", "foo(bar[abi:c])", NORMAL);
2846 CHECK_MATCH ("foo[abi:a][abi:b](bar[abi:c][abi:d])", "foo[abi:a](bar[abi:c])", NORMAL);
2847 CHECK_MATCH ("foo[abi:a][abi:b](bar[abi:c][abi:d])", "foo[abi:a][abi:b](bar)", NORMAL);
2848 CHECK_MATCH ("foo[abi:a][abi:b](bar[abi:c][abi:d])", "foo[abi:a][abi:b](bar[abi:c])",
2849 NORMAL);
2850 CHECK_MATCH("foo<bar[abi:a]>(char *, baz[abi:b])", "foo", NORMAL);
2851 CHECK_NO_MATCH("foo<bar[abi:a]>(char *, baz[abi:b])", "foo()", NORMAL);
2852 CHECK_MATCH("foo<bar[abi:a]>(char *, baz[abi:b])", "foo<bar>", NORMAL);
2853 CHECK_MATCH("foo<bar[abi:a]>(char *, baz[abi:b])", "foo<bar>(char*, baz)", NORMAL);
2854 CHECK_MATCH("foo<bar[abi:a]>(char *, baz[abi:b])", "foo<bar>(char*, baz[abi:b])",
2855 NORMAL);
2856 CHECK_NO_MATCH("foo<bar[abi:a]>(char *, baz[abi:b])", "foo<bar>(char*, baz[abi:A])",
2857 NORMAL);
2858 CHECK_MATCH("foo<bar[abi:a]>(char *, baz[abi:b])", "foo<bar[abi:a]>(char*, baz)",
2859 NORMAL);
2860 CHECK_NO_MATCH("foo<bar[abi:a]>(char *, baz[abi:b])", "foo<bar[abi:A]>(char*, baz)",
2861 NORMAL);
2862 CHECK_MATCH("foo<bar[abi:a]>(char *, baz[abi:b])", "foo<bar[abi:a]>(char*, baz[abi:b])",
2863 NORMAL);
2864 CHECK_NO_MATCH("foo<bar[abi:a]>(char *, baz[abi:b])",
2865 "foo<bar[abi:a]>(char*, baz[abi:B])", NORMAL);
2867 CHECK_NO_MATCH ("foo", "foo[", NORMAL);
2868 CHECK_NO_MATCH ("foo", "foo[]", NORMAL);
2869 CHECK_NO_MATCH ("foo", "foo[ a]", NORMAL);
2870 CHECK_NO_MATCH ("foo", "foo[a ]", NORMAL);
2871 CHECK_NO_MATCH ("foo", "foo[ a ]", NORMAL);
2872 CHECK_NO_MATCH ("foo", "foo[\ta]", NORMAL);
2873 CHECK_NO_MATCH ("foo", "foo[a \t]", NORMAL);
2874 CHECK_NO_MATCH ("foo", "foo[a\t ]", NORMAL);
2875 CHECK_NO_MATCH ("foo", "foo[ \ta]", NORMAL);
2876 CHECK_NO_MATCH ("foo", "foo[\t a]", NORMAL);
2877 CHECK_NO_MATCH ("foo", "foo[ \ta \t]", NORMAL);
2878 CHECK_NO_MATCH ("foo", "foo[\t a\t ]", NORMAL);
2879 CHECK_NO_MATCH ("foo", "foo[abi]", NORMAL);
2880 CHECK_NO_MATCH ("foo", "foo[ abi]", NORMAL);
2881 CHECK_NO_MATCH ("foo", "foo[abi ]", NORMAL);
2882 CHECK_NO_MATCH ("foo", "foo[\tabi]", NORMAL);
2883 CHECK_NO_MATCH ("foo", "foo[abi\t]", NORMAL);
2884 CHECK_NO_MATCH ("foo", "foo[ \tabi]", NORMAL);
2885 CHECK_NO_MATCH ("foo", "foo[\t abi]", NORMAL);
2886 CHECK_NO_MATCH ("foo", "foo[abi \t]", NORMAL);
2887 CHECK_NO_MATCH ("foo", "foo[abi\t ]", NORMAL);
2888 CHECK_NO_MATCH ("foo", "foo[abi :]", NORMAL);
2889 CHECK_NO_MATCH ("foo", "foo[abi\t:]", NORMAL);
2890 CHECK_NO_MATCH ("foo", "foo[abi \t:]", NORMAL);
2891 CHECK_NO_MATCH ("foo", "foo[abi\t :]", NORMAL);
2892 CHECK_NO_MATCH ("foo", "foo[abi: ]", NORMAL);
2893 CHECK_NO_MATCH ("foo", "foo[abi:\t]", NORMAL);
2894 CHECK_NO_MATCH ("foo", "foo[abi: \t]", NORMAL);
2895 CHECK_NO_MATCH ("foo", "foo[abi:\t ]", NORMAL);
2896 CHECK_NO_MATCH ("foo", "foo[abi: a]", NORMAL);
2897 CHECK_NO_MATCH ("foo", "foo[abi:\ta]", NORMAL);
2898 CHECK_NO_MATCH ("foo", "foo[abi: \ta]", NORMAL);
2899 CHECK_NO_MATCH ("foo", "foo[abi:\t a]", NORMAL);
2900 CHECK_NO_MATCH ("foo", "foo[abi:a ]", NORMAL);
2901 CHECK_NO_MATCH ("foo", "foo[abi:a\t]", NORMAL);
2902 CHECK_NO_MATCH ("foo", "foo[abi:a \t]", NORMAL);
2903 CHECK_NO_MATCH ("foo", "foo[abi:a\t ]", NORMAL);
2904 CHECK_NO_MATCH ("foo[abi:a]()", "foo(a)", NORMAL);
2905 CHECK_NO_MATCH ("foo[abi:a]()", "foo(a)", NORMAL);
2906 CHECK_NO_MATCH ("foo[abi:a]()", "foo(a)", NORMAL);
2907 CHECK_NO_MATCH ("foo[abi:a]()", "foo(a)", NORMAL);
2908 CHECK_NO_MATCH ("foo[abi:a]()", "foo(a) c", NORMAL);
2909 CHECK_NO_MATCH ("foo[abi:a]()", "foo(a) .", NORMAL);
2910 CHECK_NO_MATCH ("foo[abi:a]()", "foo(a) *", NORMAL);
2911 CHECK_NO_MATCH ("foo[abi:a]()", "foo(a) &", NORMAL);
2912 CHECK_NO_MATCH ("foo[abi:a](a,b)", "foo(a,b) c", NORMAL);
2913 CHECK_NO_MATCH ("foo[abi:a](a,b)", "foo(a,b) .", NORMAL);
2914 CHECK_NO_MATCH ("foo[abi:a](a,b)", "foo(a,b) *", NORMAL);
2915 CHECK_NO_MATCH ("foo[abi:a](a,b)", "foo(a,b) &", NORMAL);
2916 CHECK_NO_MATCH ("foo[abi:a](a,b)", "foo(a,b)c", NORMAL);
2917 CHECK_NO_MATCH ("foo[abi:a](a,b)", "foo(a,b).", NORMAL);
2918 CHECK_NO_MATCH ("foo[abi:a](a,b)", "foo(a,b)*", NORMAL);
2919 CHECK_NO_MATCH ("foo[abi:a](a,b)", "foo(a,b)&", NORMAL);
2920 CHECK_NO_MATCH ("foo[abi:a](a,b) d", "foo(a,b) c", NORMAL);
2921 CHECK_NO_MATCH ("foo[abi:a](a)", "foo()", NORMAL);
2922 CHECK_NO_MATCH ("foo[abi:a](a)", "foo(b)", NORMAL);
2923 CHECK_NO_MATCH ("foo[abi:a](a)", "foo[abi:b](a)", NORMAL);
2924 CHECK_NO_MATCH ("foo[abi:a](a)", "foo[abi:a](b)", NORMAL);
2925 CHECK_NO_MATCH ("foo[abi:]", "foo[abi:a]", NORMAL);
2926 CHECK_NO_MATCH ("foo[abi:", "foo[abi:a]", NORMAL);
2927 CHECK_NO_MATCH ("foo[abi:]", "foo[abi:a", NORMAL);
2928 CHECK_NO_MATCH ("foo[abi:,]", "foo[abi:a]", NORMAL);
2929 CHECK_NO_MATCH ("foo[abi:a,b]", "foo[abi:a]", NORMAL);
2930 CHECK_NO_MATCH ("foo[abi::a]", "foo[abi:a]", NORMAL);
2931 CHECK_NO_MATCH ("foo[abi:,([a]", "foo[abi:a]", NORMAL);
2933 CHECK_MATCH ("foo <a, b [, c (", "foo", NORMAL);
2934 CHECK_MATCH ("foo >a, b ], c )", "foo", NORMAL);
2935 CHECK_MATCH ("@!%&\\*", "@!%&\\*", NORMAL);
2936 CHECK_MATCH ("()", "()", NORMAL);
2937 CHECK_MATCH ("*(*)*", "*(*)*", NORMAL);
2938 CHECK_MATCH ("[]", "[]", NORMAL);
2939 CHECK_MATCH ("<>", "<>", NORMAL);
2941 /* strncmp_iw_with_mode::MATCH_PARAMS: the "strcmp_iw hack." */
2942 CHECK_MATCH ("foo2", "foo", NORMAL);
2943 CHECK_NO_MATCH ("foo2", "foo", MATCH_PARAMS);
2944 CHECK_NO_MATCH ("foo2", "foo ", MATCH_PARAMS);
2945 CHECK_NO_MATCH ("foo2", "foo\t", MATCH_PARAMS);
2946 CHECK_NO_MATCH ("foo2", "foo \t", MATCH_PARAMS);
2947 CHECK_NO_MATCH ("foo2", "foo\t ", MATCH_PARAMS);
2948 CHECK_NO_MATCH ("foo2", "foo \t", MATCH_PARAMS);
2949 CHECK_NO_MATCH ("foo2", " foo", MATCH_PARAMS);
2950 CHECK_NO_MATCH ("foo2", "\tfoo", MATCH_PARAMS);
2951 CHECK_NO_MATCH ("foo2", " \tfoo", MATCH_PARAMS);
2952 CHECK_NO_MATCH ("foo2", "\t foo", MATCH_PARAMS);
2953 CHECK_NO_MATCH (" foo2", "foo", MATCH_PARAMS);
2954 CHECK_NO_MATCH ("\tfoo2", "foo", MATCH_PARAMS);
2955 CHECK_NO_MATCH (" \tfoo2", "foo", MATCH_PARAMS);
2956 CHECK_NO_MATCH ("\t foo2", "foo", MATCH_PARAMS);
2957 CHECK_NO_MATCH (" foo2 ", " foo ", MATCH_PARAMS);
2958 CHECK_NO_MATCH ("\tfoo2\t", "\tfoo\t", MATCH_PARAMS);
2959 CHECK_NO_MATCH (" \tfoo2 \t", " \tfoo \t", MATCH_PARAMS);
2960 CHECK_NO_MATCH ("\t foo2\t ", "\t foo\t ", MATCH_PARAMS);
2961 CHECK_NO_MATCH ("foo2 ", "foo", MATCH_PARAMS);
2962 CHECK_NO_MATCH ("foo2\t", "foo", MATCH_PARAMS);
2963 CHECK_NO_MATCH ("foo2 ", "foo", MATCH_PARAMS);
2964 CHECK_NO_MATCH ("foo2 \t", "foo", MATCH_PARAMS);
2965 CHECK_NO_MATCH ("foo2\t ", "foo", MATCH_PARAMS);
2966 CHECK_NO_MATCH ("foo2 (args)", "foo", MATCH_PARAMS);
2967 CHECK_NO_MATCH ("foo2 (args)", "foo", MATCH_PARAMS);
2968 CHECK_NO_MATCH ("foo2\t(args)", "foo", MATCH_PARAMS);
2969 CHECK_NO_MATCH ("foo2 \t(args)", "foo", MATCH_PARAMS);
2970 CHECK_NO_MATCH ("foo2\t (args)", "foo", MATCH_PARAMS);
2971 CHECK_NO_MATCH ("foo2 ( args)", "foo", MATCH_PARAMS);
2972 CHECK_NO_MATCH ("foo2(args )", "foo", MATCH_PARAMS);
2973 CHECK_NO_MATCH ("foo2(args\t)", "foo", MATCH_PARAMS);
2974 CHECK_NO_MATCH ("foo2 (args \t)", "foo", MATCH_PARAMS);
2975 CHECK_NO_MATCH ("foo2 (args\t )", "foo", MATCH_PARAMS);
2976 CHECK_MATCH ("foo[abi:a][abi:b](bar[abi:c][abi:d])", "foo[abi:a][abi:b](bar[abi:c][abi:d])",
2977 MATCH_PARAMS);
2978 CHECK_MATCH ("foo[abi:a][abi:b](bar[abi:c][abi:d])", "foo", MATCH_PARAMS);
2979 CHECK_NO_MATCH ("foo(args)@plt", "foo", MATCH_PARAMS);
2980 CHECK_NO_MATCH ("foo((())args(()))@plt", "foo", MATCH_PARAMS);
2981 CHECK_MATCH ("foo((())args(()))", "foo", MATCH_PARAMS);
2982 CHECK_MATCH ("foo(args) const", "foo", MATCH_PARAMS);
2983 CHECK_MATCH ("foo(args)const", "foo", MATCH_PARAMS);
2985 /* strncmp_iw_with_mode also supports case insensitivity. */
2987 CHECK_NO_MATCH ("FoO", "foo", NORMAL);
2988 CHECK_NO_MATCH ("FoO", "foo", MATCH_PARAMS);
2990 scoped_restore restore_case = make_scoped_restore (&case_sensitivity);
2991 case_sensitivity = case_sensitive_off;
2993 CHECK_MATCH ("FoO", "foo", NORMAL);
2994 CHECK_MATCH ("FoO", "foo", MATCH_PARAMS);
2995 CHECK_MATCH ("foo", "FoO", NORMAL);
2996 CHECK_MATCH ("foo", "FoO", MATCH_PARAMS);
2998 CHECK_MATCH ("FoO[AbI:abC]()", "foo", NORMAL);
2999 CHECK_NO_MATCH ("FoO[AbI:abC]()", "foo", MATCH_PARAMS);
3000 CHECK_MATCH ("FoO2[AbI:abC]()", "foo", NORMAL);
3001 CHECK_NO_MATCH ("FoO2[AbI:abC]()", "foo", MATCH_PARAMS);
3003 CHECK_MATCH ("foo[abi:abc]()", "FoO[AbI:abC]()", NORMAL);
3004 CHECK_MATCH ("foo[abi:abc]()", "FoO[AbI:AbC]()", MATCH_PARAMS);
3005 CHECK_MATCH ("foo[abi:abc](xyz)", "FoO[AbI:abC](XyZ)", NORMAL);
3006 CHECK_MATCH ("foo[abi:abc](xyz)", "FoO[AbI:abC](XyZ)", MATCH_PARAMS);
3007 CHECK_MATCH ("foo[abi:abc][abi:def](xyz)", "FoO[AbI:abC](XyZ)", NORMAL);
3008 CHECK_MATCH ("foo[abi:abc][abi:def](xyz)", "FoO[AbI:abC](XyZ)",
3009 MATCH_PARAMS);
3010 CHECK_MATCH ("foo<bar<baz>>(bar<baz>)", "FoO<bAr<BaZ>>(bAr<BaZ>)",
3011 NORMAL);
3012 CHECK_MATCH ("foo<bar<baz>>(bar<baz>)", "FoO<bAr<BaZ>>(bAr<BaZ>)",
3013 MATCH_PARAMS);
3017 #undef MATCH
3018 #undef NO_MATCH
3019 #endif
3021 /* See utils.h. */
3024 strncmp_iw (const char *string1, const char *string2, size_t string2_len)
3026 return strncmp_iw_with_mode (string1, string2, string2_len,
3027 strncmp_iw_mode::NORMAL, language_minimal);
3030 /* See utils.h. */
3033 strcmp_iw (const char *string1, const char *string2)
3035 return strncmp_iw_with_mode (string1, string2, strlen (string2),
3036 strncmp_iw_mode::MATCH_PARAMS, language_minimal);
3039 /* This is like strcmp except that it ignores whitespace and treats
3040 '(' as the first non-NULL character in terms of ordering. Like
3041 strcmp (and unlike strcmp_iw), it returns negative if STRING1 <
3042 STRING2, 0 if STRING2 = STRING2, and positive if STRING1 > STRING2
3043 according to that ordering.
3045 If a list is sorted according to this function and if you want to
3046 find names in the list that match some fixed NAME according to
3047 strcmp_iw(LIST_ELT, NAME), then the place to start looking is right
3048 where this function would put NAME.
3050 This function must be neutral to the CASE_SENSITIVITY setting as the user
3051 may choose it during later lookup. Therefore this function always sorts
3052 primarily case-insensitively and secondarily case-sensitively.
3054 Here are some examples of why using strcmp to sort is a bad idea:
3056 Whitespace example:
3058 Say your partial symtab contains: "foo<char *>", "goo". Then, if
3059 we try to do a search for "foo<char*>", strcmp will locate this
3060 after "foo<char *>" and before "goo". Then lookup_partial_symbol
3061 will start looking at strings beginning with "goo", and will never
3062 see the correct match of "foo<char *>".
3064 Parenthesis example:
3066 In practice, this is less like to be an issue, but I'll give it a
3067 shot. Let's assume that '$' is a legitimate character to occur in
3068 symbols. (Which may well even be the case on some systems.) Then
3069 say that the partial symbol table contains "foo$" and "foo(int)".
3070 strcmp will put them in this order, since '$' < '('. Now, if the
3071 user searches for "foo", then strcmp will sort "foo" before "foo$".
3072 Then lookup_partial_symbol will notice that strcmp_iw("foo$",
3073 "foo") is false, so it won't proceed to the actual match of
3074 "foo(int)" with "foo". */
3077 strcmp_iw_ordered (const char *string1, const char *string2)
3079 const char *saved_string1 = string1, *saved_string2 = string2;
3080 enum case_sensitivity case_pass = case_sensitive_off;
3082 for (;;)
3084 /* C1 and C2 are valid only if *string1 != '\0' && *string2 != '\0'.
3085 Provide stub characters if we are already at the end of one of the
3086 strings. */
3087 char c1 = 'X', c2 = 'X';
3089 while (*string1 != '\0' && *string2 != '\0')
3091 while (ISSPACE (*string1))
3092 string1++;
3093 while (ISSPACE (*string2))
3094 string2++;
3096 switch (case_pass)
3098 case case_sensitive_off:
3099 c1 = TOLOWER ((unsigned char) *string1);
3100 c2 = TOLOWER ((unsigned char) *string2);
3101 break;
3102 case case_sensitive_on:
3103 c1 = *string1;
3104 c2 = *string2;
3105 break;
3107 if (c1 != c2)
3108 break;
3110 if (*string1 != '\0')
3112 string1++;
3113 string2++;
3117 switch (*string1)
3119 /* Characters are non-equal unless they're both '\0'; we want to
3120 make sure we get the comparison right according to our
3121 comparison in the cases where one of them is '\0' or '('. */
3122 case '\0':
3123 if (*string2 == '\0')
3124 break;
3125 else
3126 return -1;
3127 case '(':
3128 if (*string2 == '\0')
3129 return 1;
3130 else
3131 return -1;
3132 default:
3133 if (*string2 == '\0' || *string2 == '(')
3134 return 1;
3135 else if (c1 > c2)
3136 return 1;
3137 else if (c1 < c2)
3138 return -1;
3139 /* PASSTHRU */
3142 if (case_pass == case_sensitive_on)
3143 return 0;
3145 /* Otherwise the strings were equal in case insensitive way, make
3146 a more fine grained comparison in a case sensitive way. */
3148 case_pass = case_sensitive_on;
3149 string1 = saved_string1;
3150 string2 = saved_string2;
3156 static void
3157 show_debug_timestamp (struct ui_file *file, int from_tty,
3158 struct cmd_list_element *c, const char *value)
3160 gdb_printf (file, _("Timestamping debugging messages is %s.\n"),
3161 value);
3165 const char *
3166 paddress (struct gdbarch *gdbarch, CORE_ADDR addr)
3168 /* Truncate address to the size of a target address, avoiding shifts
3169 larger or equal than the width of a CORE_ADDR. The local
3170 variable ADDR_BIT stops the compiler reporting a shift overflow
3171 when it won't occur. */
3172 /* NOTE: This assumes that the significant address information is
3173 kept in the least significant bits of ADDR - the upper bits were
3174 either zero or sign extended. Should gdbarch_address_to_pointer or
3175 some ADDRESS_TO_PRINTABLE() be used to do the conversion? */
3177 int addr_bit = gdbarch_addr_bit (gdbarch);
3179 if (addr_bit < (sizeof (CORE_ADDR) * HOST_CHAR_BIT))
3180 addr &= ((CORE_ADDR) 1 << addr_bit) - 1;
3181 return hex_string (addr);
3184 /* This function is described in "defs.h". */
3186 const char *
3187 print_core_address (struct gdbarch *gdbarch, CORE_ADDR address)
3189 int addr_bit = gdbarch_addr_bit (gdbarch);
3191 if (addr_bit < (sizeof (CORE_ADDR) * HOST_CHAR_BIT))
3192 address &= ((CORE_ADDR) 1 << addr_bit) - 1;
3194 /* FIXME: cagney/2002-05-03: Need local_address_string() function
3195 that returns the language localized string formatted to a width
3196 based on gdbarch_addr_bit. */
3197 if (addr_bit <= 32)
3198 return hex_string_custom (address, 8);
3199 else
3200 return hex_string_custom (address, 16);
3203 /* Convert a string back into a CORE_ADDR. */
3204 CORE_ADDR
3205 string_to_core_addr (const char *my_string)
3207 CORE_ADDR addr = 0;
3209 if (my_string[0] == '0' && TOLOWER (my_string[1]) == 'x')
3211 /* Assume that it is in hex. */
3212 int i;
3214 for (i = 2; my_string[i] != '\0'; i++)
3216 if (ISDIGIT (my_string[i]))
3217 addr = (my_string[i] - '0') + (addr * 16);
3218 else if (ISXDIGIT (my_string[i]))
3219 addr = (TOLOWER (my_string[i]) - 'a' + 0xa) + (addr * 16);
3220 else
3221 error (_("invalid hex \"%s\""), my_string);
3224 else
3226 /* Assume that it is in decimal. */
3227 int i;
3229 for (i = 0; my_string[i] != '\0'; i++)
3231 if (ISDIGIT (my_string[i]))
3232 addr = (my_string[i] - '0') + (addr * 10);
3233 else
3234 error (_("invalid decimal \"%s\""), my_string);
3238 return addr;
3241 #if GDB_SELF_TEST
3243 static void
3244 gdb_realpath_check_trailer (const char *input, const char *trailer)
3246 gdb::unique_xmalloc_ptr<char> result = gdb_realpath (input);
3248 size_t len = strlen (result.get ());
3249 size_t trail_len = strlen (trailer);
3251 SELF_CHECK (len >= trail_len
3252 && strcmp (result.get () + len - trail_len, trailer) == 0);
3255 static void
3256 gdb_realpath_tests ()
3258 /* A file which contains a directory prefix. */
3259 gdb_realpath_check_trailer ("./xfullpath.exp", "/xfullpath.exp");
3260 /* A file which contains a directory prefix. */
3261 gdb_realpath_check_trailer ("../../defs.h", "/defs.h");
3262 /* A one-character filename. */
3263 gdb_realpath_check_trailer ("./a", "/a");
3264 /* A file in the root directory. */
3265 gdb_realpath_check_trailer ("/root_file_which_should_exist",
3266 "/root_file_which_should_exist");
3267 /* A file which does not have a directory prefix. */
3268 gdb_realpath_check_trailer ("xfullpath.exp", "xfullpath.exp");
3269 /* A one-char filename without any directory prefix. */
3270 gdb_realpath_check_trailer ("a", "a");
3271 /* An empty filename. */
3272 gdb_realpath_check_trailer ("", "");
3275 /* Test the gdb_argv::as_array_view method. */
3277 static void
3278 gdb_argv_as_array_view_test ()
3281 gdb_argv argv;
3283 gdb::array_view<char *> view = argv.as_array_view ();
3285 SELF_CHECK (view.data () == nullptr);
3286 SELF_CHECK (view.size () == 0);
3289 gdb_argv argv ("une bonne 50");
3291 gdb::array_view<char *> view = argv.as_array_view ();
3293 SELF_CHECK (view.size () == 3);
3294 SELF_CHECK (strcmp (view[0], "une") == 0);
3295 SELF_CHECK (strcmp (view[1], "bonne") == 0);
3296 SELF_CHECK (strcmp (view[2], "50") == 0);
3300 #endif /* GDB_SELF_TEST */
3302 /* Simple, portable version of dirname that does not modify its
3303 argument. */
3305 std::string
3306 ldirname (const char *filename)
3308 std::string dirname;
3309 const char *base = lbasename (filename);
3311 while (base > filename && IS_DIR_SEPARATOR (base[-1]))
3312 --base;
3314 if (base == filename)
3315 return dirname;
3317 dirname = std::string (filename, base - filename);
3319 /* On DOS based file systems, convert "d:foo" to "d:.", so that we
3320 create "d:./bar" later instead of the (different) "d:/bar". */
3321 if (base - filename == 2 && IS_ABSOLUTE_PATH (base)
3322 && !IS_DIR_SEPARATOR (filename[0]))
3323 dirname[base++ - filename] = '.';
3325 return dirname;
3328 /* Return ARGS parsed as a valid pid, or throw an error. */
3331 parse_pid_to_attach (const char *args)
3333 unsigned long pid;
3334 char *dummy;
3336 if (!args)
3337 error_no_arg (_("process-id to attach"));
3339 dummy = (char *) args;
3340 pid = strtoul (args, &dummy, 0);
3341 /* Some targets don't set errno on errors, grrr! */
3342 if ((pid == 0 && dummy == args) || dummy != &args[strlen (args)])
3343 error (_("Illegal process-id: %s."), args);
3345 return pid;
3348 /* Substitute all occurrences of string FROM by string TO in *STRINGP. *STRINGP
3349 must come from xrealloc-compatible allocator and it may be updated. FROM
3350 needs to be delimited by IS_DIR_SEPARATOR or DIRNAME_SEPARATOR (or be
3351 located at the start or end of *STRINGP. */
3353 void
3354 substitute_path_component (char **stringp, const char *from, const char *to)
3356 char *string = *stringp, *s;
3357 const size_t from_len = strlen (from);
3358 const size_t to_len = strlen (to);
3360 for (s = string;;)
3362 s = strstr (s, from);
3363 if (s == NULL)
3364 break;
3366 if ((s == string || IS_DIR_SEPARATOR (s[-1])
3367 || s[-1] == DIRNAME_SEPARATOR)
3368 && (s[from_len] == '\0' || IS_DIR_SEPARATOR (s[from_len])
3369 || s[from_len] == DIRNAME_SEPARATOR))
3371 char *string_new;
3373 string_new
3374 = (char *) xrealloc (string, (strlen (string) + to_len + 1));
3376 /* Relocate the current S pointer. */
3377 s = s - string + string_new;
3378 string = string_new;
3380 /* Replace from by to. */
3381 memmove (&s[to_len], &s[from_len], strlen (&s[from_len]) + 1);
3382 memcpy (s, to, to_len);
3384 s += to_len;
3386 else
3387 s++;
3390 *stringp = string;
3393 #ifdef HAVE_WAITPID
3395 #ifdef SIGALRM
3397 /* SIGALRM handler for waitpid_with_timeout. */
3399 static void
3400 sigalrm_handler (int signo)
3402 /* Nothing to do. */
3405 #endif
3407 /* Wrapper to wait for child PID to die with TIMEOUT.
3408 TIMEOUT is the time to stop waiting in seconds.
3409 If TIMEOUT is zero, pass WNOHANG to waitpid.
3410 Returns PID if it was successfully waited for, otherwise -1.
3412 Timeouts are currently implemented with alarm and SIGALRM.
3413 If the host does not support them, this waits "forever".
3414 It would be odd though for a host to have waitpid and not SIGALRM. */
3416 pid_t
3417 wait_to_die_with_timeout (pid_t pid, int *status, int timeout)
3419 pid_t waitpid_result;
3421 gdb_assert (pid > 0);
3422 gdb_assert (timeout >= 0);
3424 if (timeout > 0)
3426 #ifdef SIGALRM
3427 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3428 struct sigaction sa, old_sa;
3430 sa.sa_handler = sigalrm_handler;
3431 sigemptyset (&sa.sa_mask);
3432 sa.sa_flags = 0;
3433 sigaction (SIGALRM, &sa, &old_sa);
3434 #else
3435 sighandler_t ofunc;
3437 ofunc = signal (SIGALRM, sigalrm_handler);
3438 #endif
3440 alarm (timeout);
3441 #endif
3443 waitpid_result = waitpid (pid, status, 0);
3445 #ifdef SIGALRM
3446 alarm (0);
3447 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3448 sigaction (SIGALRM, &old_sa, NULL);
3449 #else
3450 signal (SIGALRM, ofunc);
3451 #endif
3452 #endif
3454 else
3455 waitpid_result = waitpid (pid, status, WNOHANG);
3457 if (waitpid_result == pid)
3458 return pid;
3459 else
3460 return -1;
3463 #endif /* HAVE_WAITPID */
3465 /* Provide fnmatch compatible function for FNM_FILE_NAME matching of host files.
3466 Both FNM_FILE_NAME and FNM_NOESCAPE must be set in FLAGS.
3468 It handles correctly HAVE_DOS_BASED_FILE_SYSTEM and
3469 HAVE_CASE_INSENSITIVE_FILE_SYSTEM. */
3472 gdb_filename_fnmatch (const char *pattern, const char *string, int flags)
3474 gdb_assert ((flags & FNM_FILE_NAME) != 0);
3476 /* It is unclear how '\' escaping vs. directory separator should coexist. */
3477 gdb_assert ((flags & FNM_NOESCAPE) != 0);
3479 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
3481 char *pattern_slash, *string_slash;
3483 /* Replace '\' by '/' in both strings. */
3485 pattern_slash = (char *) alloca (strlen (pattern) + 1);
3486 strcpy (pattern_slash, pattern);
3487 pattern = pattern_slash;
3488 for (; *pattern_slash != 0; pattern_slash++)
3489 if (IS_DIR_SEPARATOR (*pattern_slash))
3490 *pattern_slash = '/';
3492 string_slash = (char *) alloca (strlen (string) + 1);
3493 strcpy (string_slash, string);
3494 string = string_slash;
3495 for (; *string_slash != 0; string_slash++)
3496 if (IS_DIR_SEPARATOR (*string_slash))
3497 *string_slash = '/';
3499 #endif /* HAVE_DOS_BASED_FILE_SYSTEM */
3501 #ifdef HAVE_CASE_INSENSITIVE_FILE_SYSTEM
3502 flags |= FNM_CASEFOLD;
3503 #endif /* HAVE_CASE_INSENSITIVE_FILE_SYSTEM */
3505 return fnmatch (pattern, string, flags);
3508 /* Return the number of path elements in PATH.
3509 / = 1
3510 /foo = 2
3511 /foo/ = 2
3512 foo/bar = 2
3513 foo/ = 1 */
3516 count_path_elements (const char *path)
3518 int count = 0;
3519 const char *p = path;
3521 if (HAS_DRIVE_SPEC (p))
3523 p = STRIP_DRIVE_SPEC (p);
3524 ++count;
3527 while (*p != '\0')
3529 if (IS_DIR_SEPARATOR (*p))
3530 ++count;
3531 ++p;
3534 /* Backup one if last character is /, unless it's the only one. */
3535 if (p > path + 1 && IS_DIR_SEPARATOR (p[-1]))
3536 --count;
3538 /* Add one for the file name, if present. */
3539 if (p > path && !IS_DIR_SEPARATOR (p[-1]))
3540 ++count;
3542 return count;
3545 /* Remove N leading path elements from PATH.
3546 N must be non-negative.
3547 If PATH has more than N path elements then return NULL.
3548 If PATH has exactly N path elements then return "".
3549 See count_path_elements for a description of how we do the counting. */
3551 const char *
3552 strip_leading_path_elements (const char *path, int n)
3554 int i = 0;
3555 const char *p = path;
3557 gdb_assert (n >= 0);
3559 if (n == 0)
3560 return p;
3562 if (HAS_DRIVE_SPEC (p))
3564 p = STRIP_DRIVE_SPEC (p);
3565 ++i;
3568 while (i < n)
3570 while (*p != '\0' && !IS_DIR_SEPARATOR (*p))
3571 ++p;
3572 if (*p == '\0')
3574 if (i + 1 == n)
3575 return "";
3576 return NULL;
3578 ++p;
3579 ++i;
3582 return p;
3585 /* See utils.h. */
3587 void
3588 copy_bitwise (gdb_byte *dest, ULONGEST dest_offset,
3589 const gdb_byte *source, ULONGEST source_offset,
3590 ULONGEST nbits, int bits_big_endian)
3592 unsigned int buf, avail;
3594 if (nbits == 0)
3595 return;
3597 if (bits_big_endian)
3599 /* Start from the end, then work backwards. */
3600 dest_offset += nbits - 1;
3601 dest += dest_offset / 8;
3602 dest_offset = 7 - dest_offset % 8;
3603 source_offset += nbits - 1;
3604 source += source_offset / 8;
3605 source_offset = 7 - source_offset % 8;
3607 else
3609 dest += dest_offset / 8;
3610 dest_offset %= 8;
3611 source += source_offset / 8;
3612 source_offset %= 8;
3615 /* Fill BUF with DEST_OFFSET bits from the destination and 8 -
3616 SOURCE_OFFSET bits from the source. */
3617 buf = *(bits_big_endian ? source-- : source++) >> source_offset;
3618 buf <<= dest_offset;
3619 buf |= *dest & ((1 << dest_offset) - 1);
3621 /* NBITS: bits yet to be written; AVAIL: BUF's fill level. */
3622 nbits += dest_offset;
3623 avail = dest_offset + 8 - source_offset;
3625 /* Flush 8 bits from BUF, if appropriate. */
3626 if (nbits >= 8 && avail >= 8)
3628 *(bits_big_endian ? dest-- : dest++) = buf;
3629 buf >>= 8;
3630 avail -= 8;
3631 nbits -= 8;
3634 /* Copy the middle part. */
3635 if (nbits >= 8)
3637 size_t len = nbits / 8;
3639 /* Use a faster method for byte-aligned copies. */
3640 if (avail == 0)
3642 if (bits_big_endian)
3644 dest -= len;
3645 source -= len;
3646 memcpy (dest + 1, source + 1, len);
3648 else
3650 memcpy (dest, source, len);
3651 dest += len;
3652 source += len;
3655 else
3657 while (len--)
3659 buf |= *(bits_big_endian ? source-- : source++) << avail;
3660 *(bits_big_endian ? dest-- : dest++) = buf;
3661 buf >>= 8;
3664 nbits %= 8;
3667 /* Write the last byte. */
3668 if (nbits)
3670 if (avail < nbits)
3671 buf |= *source << avail;
3673 buf &= (1 << nbits) - 1;
3674 *dest = (*dest & (~0U << nbits)) | buf;
3678 #if GDB_SELF_TEST
3679 static void
3680 test_assign_set_return_if_changed ()
3682 bool changed;
3683 int a;
3685 for (bool initial : { false, true })
3687 changed = initial;
3688 a = 1;
3689 assign_set_if_changed (a, 1, changed);
3690 SELF_CHECK (a == 1);
3691 SELF_CHECK (changed == initial);
3694 for (bool initial : { false, true })
3696 changed = initial;
3697 a = 1;
3698 assign_set_if_changed (a, 2, changed);
3699 SELF_CHECK (a == 2);
3700 SELF_CHECK (changed == true);
3703 a = 1;
3704 changed = assign_return_if_changed (a, 1);
3705 SELF_CHECK (a == 1);
3706 SELF_CHECK (changed == false);
3708 a = 1;
3709 assign_set_if_changed (a, 2, changed);
3710 SELF_CHECK (a == 2);
3711 SELF_CHECK (changed == true);
3713 #endif
3715 void _initialize_utils ();
3716 void
3717 _initialize_utils ()
3719 add_setshow_uinteger_cmd ("width", class_support, &chars_per_line, _("\
3720 Set number of characters where GDB should wrap lines of its output."), _("\
3721 Show number of characters where GDB should wrap lines of its output."), _("\
3722 This affects where GDB wraps its output to fit the screen width.\n\
3723 Setting this to \"unlimited\" or zero prevents GDB from wrapping its output."),
3724 set_width_command,
3725 show_chars_per_line,
3726 &setlist, &showlist);
3728 add_setshow_uinteger_cmd ("height", class_support, &lines_per_page, _("\
3729 Set number of lines in a page for GDB output pagination."), _("\
3730 Show number of lines in a page for GDB output pagination."), _("\
3731 This affects the number of lines after which GDB will pause\n\
3732 its output and ask you whether to continue.\n\
3733 Setting this to \"unlimited\" or zero causes GDB never pause during output."),
3734 set_height_command,
3735 show_lines_per_page,
3736 &setlist, &showlist);
3738 add_setshow_boolean_cmd ("pagination", class_support,
3739 &pagination_enabled, _("\
3740 Set state of GDB output pagination."), _("\
3741 Show state of GDB output pagination."), _("\
3742 When pagination is ON, GDB pauses at end of each screenful of\n\
3743 its output and asks you whether to continue.\n\
3744 Turning pagination off is an alternative to \"set height unlimited\"."),
3745 NULL,
3746 show_pagination_enabled,
3747 &setlist, &showlist);
3749 add_setshow_boolean_cmd ("sevenbit-strings", class_support,
3750 &sevenbit_strings, _("\
3751 Set printing of 8-bit characters in strings as \\nnn."), _("\
3752 Show printing of 8-bit characters in strings as \\nnn."), NULL,
3753 NULL,
3754 show_sevenbit_strings,
3755 &setprintlist, &showprintlist);
3757 add_setshow_boolean_cmd ("timestamp", class_maintenance,
3758 &debug_timestamp, _("\
3759 Set timestamping of debugging messages."), _("\
3760 Show timestamping of debugging messages."), _("\
3761 When set, debugging messages will be marked with seconds and microseconds."),
3762 NULL,
3763 show_debug_timestamp,
3764 &setdebuglist, &showdebuglist);
3766 add_internal_problem_command (&internal_error_problem);
3767 add_internal_problem_command (&internal_warning_problem);
3768 add_internal_problem_command (&demangler_warning_problem);
3770 add_cmd ("screen", class_maintenance, &maintenance_info_screen,
3771 _("Show screen characteristics."), &maintenanceinfolist);
3773 #if GDB_SELF_TEST
3774 selftests::register_test ("gdb_realpath", gdb_realpath_tests);
3775 selftests::register_test ("gdb_argv_array_view", gdb_argv_as_array_view_test);
3776 selftests::register_test ("strncmp_iw_with_mode",
3777 strncmp_iw_with_mode_tests);
3778 selftests::register_test ("pager", test_pager);
3779 selftests::register_test ("assign_set_return_if_changed",
3780 test_assign_set_return_if_changed);
3781 #endif