mirror of
https://sourceware.org/git/binutils-gdb.git
synced 2024-12-21 04:42:53 +08:00
590042fc45
With this patch, the help docs now respect 2 invariants: * The first line of a command help is terminated by a '.' character. * The last character of a command help is not a newline character. Note that the changes for the last invariant were done by Tom, as part of : [PATCH] Remove trailing newlines from help text https://sourceware.org/ml/gdb-patches/2019-06/msg00050.html but some occurrences have been re-introduced since then. Some help docs had to be rephrased/restructured to respect the above invariants. Before this patch, print_doc_line was printing the first line of a command help documentation, but stopping at the first '.' or ',' character. This was giving inconsistent results : * The first line of command helps was sometimes '.' terminated, sometimes not. * The first line of command helps was not always designed to be readable/understandable/unambiguous when stopping at the first '.' or ',' character. This e.g. created the following inconsistencies/problems: < catch exception -- Catch Ada exceptions < catch handlers -- Catch Ada exceptions < catch syscall -- Catch system calls by their names < down-silently -- Same as the `down' command while the new help is: > catch exception -- Catch Ada exceptions, when raised. > catch handlers -- Catch Ada exceptions, when handled. > catch syscall -- Catch system calls by their names, groups and/or numbers. > down-silently -- Same as the `down' command, but does not print anything. Also, the command help doc should not be terminated by a newline character, but this was not respected by all commands. The cli-option -OPT framework re-introduced some occurences. So, the -OPT build help framework was changed to not output newlines at the end of %OPTIONS% replacement. This patch changes the help documentations to ensure the 2 invariants given above. It implied to slightly rephrase or restructure some help docs. Based on the above invariants, print_doc_line (called by 'apropos' and 'help' commands to print the first line of a command help) now outputs the full first line of a command help. This all results in a lot of small changes in the produced help docs. There are less code changes than changes in the help docs, as a lot of docs are produced by some code (e.g. the remote packet usage settings). gdb/ChangeLog 2019-08-07 Philippe Waroquiers <philippe.waroquiers@skynet.be> * cli/cli-decode.h (print_doc_line): Add for_value_prefix argument. * cli/cli-decode.c (print_doc_line): Likewise. It now prints the full first line, except when FOR_VALUE_PREFIX. In this case, the trailing '.' is not output, and the first character is uppercased. (print_help_for_command): Update call to print_doc_line. (print_doc_of_command): Likewise. * cli/cli-setshow.c (deprecated_show_value_hack): Likewise. * cli/cli-option.c (append_indented_doc): Do not append newline. (build_help_option): Append newline after first appended_indented_doc only if a second call is done. (build_help): Append 2 new lines before each option, except the first one. * compile/compile.c (_initialize_compile): Add new lines after %OPTIONS%, when not at the end of the help. Change help doc or code producing the help doc to respect the invariants. * maint-test-options.c (_initialize_maint_test_options): Likewise. Also removed the new line after 'Options:', as all other commands do not put an empty line between 'Options:' and the first option. * printcmd.c (_initialize_printcmd): Likewise. * stack.c (_initialize_stack): Likewise. * interps.c (interpreter_exec_cmd): Fix "Usage:" line that was incorrectly telling COMMAND is optional. * ada-lang.c (_initialize_ada_language): Change help doc or code producing the help doc to respect the invariants. * ada-tasks.c (_initialize_ada_tasks): Likewise. * breakpoint.c (_initialize_breakpoint): Likewise. * cli/cli-cmds.c (_initialize_cli_cmds): Likewise. * cli/cli-logging.c (_initialize_cli_logging): Likewise. * cli/cli-setshow.c (_initialize_cli_setshow): Likewise. * cli/cli-style.c (cli_style_option::add_setshow_commands, _initialize_cli_style): Likewise. * corelow.c (core_target_info): Likewise. * dwarf-index-cache.c (_initialize_index_cache): Likewise. * dwarf2read.c (_initialize_dwarf2_read): Likewise. * filesystem.c (_initialize_filesystem): Likewise. * frame.c (_initialize_frame): Likewise. * gnu-nat.c (add_task_commands): Likewise. * infcall.c (_initialize_infcall): Likewise. * infcmd.c (_initialize_infcmd): Likewise. * interps.c (_initialize_interpreter): Likewise. * language.c (_initialize_language): Likewise. * linux-fork.c (_initialize_linux_fork): Likewise. * maint-test-settings.c (_initialize_maint_test_settings): Likewise. * maint.c (_initialize_maint_cmds): Likewise. * memattr.c (_initialize_mem): Likewise. * printcmd.c (_initialize_printcmd): Likewise. * python/lib/gdb/function/strfns.py (_MemEq, _StrLen, _StrEq, _RegEx): Likewise. * ravenscar-thread.c (_initialize_ravenscar): Likewise. * record-btrace.c (_initialize_record_btrace): Likewise. * record-full.c (_initialize_record_full): Likewise. * record.c (_initialize_record): Likewise. * regcache-dump.c (_initialize_regcache_dump): Likewise. * regcache.c (_initialize_regcache): Likewise. * remote.c (add_packet_config_cmd, init_remote_threadtests, _initialize_remote): Likewise. * ser-tcp.c (_initialize_ser_tcp): Likewise. * serial.c (_initialize_serial): Likewise. * skip.c (_initialize_step_skip): Likewise. * source.c (_initialize_source): Likewise. * stack.c (_initialize_stack): Likewise. * symfile.c (_initialize_symfile): Likewise. * symtab.c (_initialize_symtab): Likewise. * target-descriptions.c (_initialize_target_descriptions): Likewise. * top.c (init_main): Likewise. * tracefile-tfile.c (tfile_target_info): Likewise. * tracepoint.c (_initialize_tracepoint): Likewise. * tui/tui-win.c (_initialize_tui_win): Likewise. * utils.c (add_internal_problem_command): Likewise. * valprint.c (value_print_option_defs): Likewise. gdb/testsuite/ChangeLog 2019-08-07 Philippe Waroquiers <philippe.waroquiers@skynet.be> * gdb.base/style.exp: Update tests for help doc new invariants. * gdb.base/help.exp: Likewise.
1200 lines
33 KiB
C
1200 lines
33 KiB
C
/* Multiple source language support for GDB.
|
||
|
||
Copyright (C) 1991-2019 Free Software Foundation, Inc.
|
||
|
||
Contributed by the Department of Computer Science at the State University
|
||
of New York at Buffalo.
|
||
|
||
This file is part of GDB.
|
||
|
||
This program is free software; you can redistribute it and/or modify
|
||
it under the terms of the GNU General Public License as published by
|
||
the Free Software Foundation; either version 3 of the License, or
|
||
(at your option) any later version.
|
||
|
||
This program is distributed in the hope that it will be useful,
|
||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||
GNU General Public License for more details.
|
||
|
||
You should have received a copy of the GNU General Public License
|
||
along with this program. If not, see <http://www.gnu.org/licenses/>. */
|
||
|
||
/* This file contains functions that return things that are specific
|
||
to languages. Each function should examine current_language if necessary,
|
||
and return the appropriate result. */
|
||
|
||
/* FIXME: Most of these would be better organized as macros which
|
||
return data out of a "language-specific" struct pointer that is set
|
||
whenever the working language changes. That would be a lot faster. */
|
||
|
||
#include "defs.h"
|
||
#include <ctype.h>
|
||
#include "symtab.h"
|
||
#include "gdbtypes.h"
|
||
#include "value.h"
|
||
#include "gdbcmd.h"
|
||
#include "expression.h"
|
||
#include "language.h"
|
||
#include "varobj.h"
|
||
#include "target.h"
|
||
#include "parser-defs.h"
|
||
#include "demangle.h"
|
||
#include "symfile.h"
|
||
#include "cp-support.h"
|
||
#include "frame.h"
|
||
#include "c-lang.h"
|
||
#include <algorithm>
|
||
#include "gdbarch.h"
|
||
|
||
static int unk_lang_parser (struct parser_state *);
|
||
|
||
static void set_range_case (void);
|
||
|
||
static void unk_lang_emit_char (int c, struct type *type,
|
||
struct ui_file *stream, int quoter);
|
||
|
||
static void unk_lang_printchar (int c, struct type *type,
|
||
struct ui_file *stream);
|
||
|
||
static void unk_lang_value_print (struct value *, struct ui_file *,
|
||
const struct value_print_options *);
|
||
|
||
static CORE_ADDR unk_lang_trampoline (struct frame_info *, CORE_ADDR pc);
|
||
|
||
/* Forward declaration */
|
||
extern const struct language_defn unknown_language_defn;
|
||
|
||
/* The current (default at startup) state of type and range checking.
|
||
(If the modes are set to "auto", though, these are changed based
|
||
on the default language at startup, and then again based on the
|
||
language of the first source file. */
|
||
|
||
enum range_mode range_mode = range_mode_auto;
|
||
enum range_check range_check = range_check_off;
|
||
enum case_mode case_mode = case_mode_auto;
|
||
enum case_sensitivity case_sensitivity = case_sensitive_on;
|
||
|
||
/* The current language and language_mode (see language.h). */
|
||
|
||
const struct language_defn *current_language = &unknown_language_defn;
|
||
enum language_mode language_mode = language_mode_auto;
|
||
|
||
/* The language that the user expects to be typing in (the language
|
||
of main(), or the last language we notified them about, or C). */
|
||
|
||
const struct language_defn *expected_language;
|
||
|
||
/* The list of supported languages. Keep this in the same order as
|
||
the 'enum language' values. */
|
||
|
||
static const struct language_defn *languages[] = {
|
||
&unknown_language_defn,
|
||
&auto_language_defn,
|
||
&c_language_defn,
|
||
&objc_language_defn,
|
||
&cplus_language_defn,
|
||
&d_language_defn,
|
||
&go_language_defn,
|
||
&f_language_defn,
|
||
&m2_language_defn,
|
||
&asm_language_defn,
|
||
&pascal_language_defn,
|
||
&opencl_language_defn,
|
||
&rust_language_defn,
|
||
&minimal_language_defn,
|
||
&ada_language_defn,
|
||
};
|
||
|
||
/* The current values of the "set language/range/case-sensitive" enum
|
||
commands. */
|
||
static const char *language;
|
||
static const char *range;
|
||
static const char *case_sensitive;
|
||
|
||
/* Warning issued when current_language and the language of the current
|
||
frame do not match. */
|
||
char lang_frame_mismatch_warn[] =
|
||
"Warning: the current language does not match this frame.";
|
||
|
||
/* This page contains the functions corresponding to GDB commands
|
||
and their helpers. */
|
||
|
||
/* Show command. Display a warning if the language set
|
||
does not match the frame. */
|
||
static void
|
||
show_language_command (struct ui_file *file, int from_tty,
|
||
struct cmd_list_element *c, const char *value)
|
||
{
|
||
enum language flang; /* The language of the frame. */
|
||
|
||
if (language_mode == language_mode_auto)
|
||
fprintf_filtered (gdb_stdout,
|
||
_("The current source language is "
|
||
"\"auto; currently %s\".\n"),
|
||
current_language->la_name);
|
||
else
|
||
fprintf_filtered (gdb_stdout,
|
||
_("The current source language is \"%s\".\n"),
|
||
current_language->la_name);
|
||
|
||
if (has_stack_frames ())
|
||
{
|
||
struct frame_info *frame;
|
||
|
||
frame = get_selected_frame (NULL);
|
||
flang = get_frame_language (frame);
|
||
if (flang != language_unknown
|
||
&& language_mode == language_mode_manual
|
||
&& current_language->la_language != flang)
|
||
printf_filtered ("%s\n", lang_frame_mismatch_warn);
|
||
}
|
||
}
|
||
|
||
/* Set command. Change the current working language. */
|
||
static void
|
||
set_language_command (const char *ignore,
|
||
int from_tty, struct cmd_list_element *c)
|
||
{
|
||
enum language flang = language_unknown;
|
||
|
||
/* "local" is a synonym of "auto". */
|
||
if (strcmp (language, "local") == 0)
|
||
language = "auto";
|
||
|
||
/* Search the list of languages for a match. */
|
||
for (const auto &lang : languages)
|
||
{
|
||
if (strcmp (lang->la_name, language) == 0)
|
||
{
|
||
/* Found it! Go into manual mode, and use this language. */
|
||
if (lang->la_language == language_auto)
|
||
{
|
||
/* Enter auto mode. Set to the current frame's language, if
|
||
known, or fallback to the initial language. */
|
||
language_mode = language_mode_auto;
|
||
try
|
||
{
|
||
struct frame_info *frame;
|
||
|
||
frame = get_selected_frame (NULL);
|
||
flang = get_frame_language (frame);
|
||
}
|
||
catch (const gdb_exception_error &ex)
|
||
{
|
||
flang = language_unknown;
|
||
}
|
||
|
||
if (flang != language_unknown)
|
||
set_language (flang);
|
||
else
|
||
set_initial_language ();
|
||
expected_language = current_language;
|
||
return;
|
||
}
|
||
else
|
||
{
|
||
/* Enter manual mode. Set the specified language. */
|
||
language_mode = language_mode_manual;
|
||
current_language = lang;
|
||
set_range_case ();
|
||
expected_language = current_language;
|
||
return;
|
||
}
|
||
}
|
||
}
|
||
|
||
internal_error (__FILE__, __LINE__,
|
||
"Couldn't find language `%s' in known languages list.",
|
||
language);
|
||
}
|
||
|
||
/* Show command. Display a warning if the range setting does
|
||
not match the current language. */
|
||
static void
|
||
show_range_command (struct ui_file *file, int from_tty,
|
||
struct cmd_list_element *c, const char *value)
|
||
{
|
||
if (range_mode == range_mode_auto)
|
||
{
|
||
const char *tmp;
|
||
|
||
switch (range_check)
|
||
{
|
||
case range_check_on:
|
||
tmp = "on";
|
||
break;
|
||
case range_check_off:
|
||
tmp = "off";
|
||
break;
|
||
case range_check_warn:
|
||
tmp = "warn";
|
||
break;
|
||
default:
|
||
internal_error (__FILE__, __LINE__,
|
||
"Unrecognized range check setting.");
|
||
}
|
||
|
||
fprintf_filtered (gdb_stdout,
|
||
_("Range checking is \"auto; currently %s\".\n"),
|
||
tmp);
|
||
}
|
||
else
|
||
fprintf_filtered (gdb_stdout, _("Range checking is \"%s\".\n"),
|
||
value);
|
||
|
||
if (range_check != current_language->la_range_check)
|
||
warning (_("the current range check setting "
|
||
"does not match the language.\n"));
|
||
}
|
||
|
||
/* Set command. Change the setting for range checking. */
|
||
static void
|
||
set_range_command (const char *ignore,
|
||
int from_tty, struct cmd_list_element *c)
|
||
{
|
||
if (strcmp (range, "on") == 0)
|
||
{
|
||
range_check = range_check_on;
|
||
range_mode = range_mode_manual;
|
||
}
|
||
else if (strcmp (range, "warn") == 0)
|
||
{
|
||
range_check = range_check_warn;
|
||
range_mode = range_mode_manual;
|
||
}
|
||
else if (strcmp (range, "off") == 0)
|
||
{
|
||
range_check = range_check_off;
|
||
range_mode = range_mode_manual;
|
||
}
|
||
else if (strcmp (range, "auto") == 0)
|
||
{
|
||
range_mode = range_mode_auto;
|
||
set_range_case ();
|
||
return;
|
||
}
|
||
else
|
||
{
|
||
internal_error (__FILE__, __LINE__,
|
||
_("Unrecognized range check setting: \"%s\""), range);
|
||
}
|
||
if (range_check != current_language->la_range_check)
|
||
warning (_("the current range check setting "
|
||
"does not match the language.\n"));
|
||
}
|
||
|
||
/* Show command. Display a warning if the case sensitivity setting does
|
||
not match the current language. */
|
||
static void
|
||
show_case_command (struct ui_file *file, int from_tty,
|
||
struct cmd_list_element *c, const char *value)
|
||
{
|
||
if (case_mode == case_mode_auto)
|
||
{
|
||
const char *tmp = NULL;
|
||
|
||
switch (case_sensitivity)
|
||
{
|
||
case case_sensitive_on:
|
||
tmp = "on";
|
||
break;
|
||
case case_sensitive_off:
|
||
tmp = "off";
|
||
break;
|
||
default:
|
||
internal_error (__FILE__, __LINE__,
|
||
"Unrecognized case-sensitive setting.");
|
||
}
|
||
|
||
fprintf_filtered (gdb_stdout,
|
||
_("Case sensitivity in "
|
||
"name search is \"auto; currently %s\".\n"),
|
||
tmp);
|
||
}
|
||
else
|
||
fprintf_filtered (gdb_stdout,
|
||
_("Case sensitivity in name search is \"%s\".\n"),
|
||
value);
|
||
|
||
if (case_sensitivity != current_language->la_case_sensitivity)
|
||
warning (_("the current case sensitivity setting does not match "
|
||
"the language.\n"));
|
||
}
|
||
|
||
/* Set command. Change the setting for case sensitivity. */
|
||
|
||
static void
|
||
set_case_command (const char *ignore, int from_tty, struct cmd_list_element *c)
|
||
{
|
||
if (strcmp (case_sensitive, "on") == 0)
|
||
{
|
||
case_sensitivity = case_sensitive_on;
|
||
case_mode = case_mode_manual;
|
||
}
|
||
else if (strcmp (case_sensitive, "off") == 0)
|
||
{
|
||
case_sensitivity = case_sensitive_off;
|
||
case_mode = case_mode_manual;
|
||
}
|
||
else if (strcmp (case_sensitive, "auto") == 0)
|
||
{
|
||
case_mode = case_mode_auto;
|
||
set_range_case ();
|
||
return;
|
||
}
|
||
else
|
||
{
|
||
internal_error (__FILE__, __LINE__,
|
||
"Unrecognized case-sensitive setting: \"%s\"",
|
||
case_sensitive);
|
||
}
|
||
|
||
if (case_sensitivity != current_language->la_case_sensitivity)
|
||
warning (_("the current case sensitivity setting does not match "
|
||
"the language.\n"));
|
||
}
|
||
|
||
/* Set the status of range and type checking and case sensitivity based on
|
||
the current modes and the current language.
|
||
If SHOW is non-zero, then print out the current language,
|
||
type and range checking status. */
|
||
static void
|
||
set_range_case (void)
|
||
{
|
||
if (range_mode == range_mode_auto)
|
||
range_check = current_language->la_range_check;
|
||
|
||
if (case_mode == case_mode_auto)
|
||
case_sensitivity = current_language->la_case_sensitivity;
|
||
}
|
||
|
||
/* Set current language to (enum language) LANG. Returns previous
|
||
language. */
|
||
|
||
enum language
|
||
set_language (enum language lang)
|
||
{
|
||
enum language prev_language;
|
||
|
||
prev_language = current_language->la_language;
|
||
current_language = languages[lang];
|
||
set_range_case ();
|
||
return prev_language;
|
||
}
|
||
|
||
|
||
/* Print out the current language settings: language, range and
|
||
type checking. If QUIETLY, print only what has changed. */
|
||
|
||
void
|
||
language_info (int quietly)
|
||
{
|
||
if (quietly && expected_language == current_language)
|
||
return;
|
||
|
||
expected_language = current_language;
|
||
printf_unfiltered (_("Current language: %s\n"), language);
|
||
show_language_command (NULL, 1, NULL, NULL);
|
||
|
||
if (!quietly)
|
||
{
|
||
printf_unfiltered (_("Range checking: %s\n"), range);
|
||
show_range_command (NULL, 1, NULL, NULL);
|
||
printf_unfiltered (_("Case sensitivity: %s\n"), case_sensitive);
|
||
show_case_command (NULL, 1, NULL, NULL);
|
||
}
|
||
}
|
||
|
||
|
||
/* Returns non-zero if the value is a pointer type. */
|
||
int
|
||
pointer_type (struct type *type)
|
||
{
|
||
return TYPE_CODE (type) == TYPE_CODE_PTR || TYPE_IS_REFERENCE (type);
|
||
}
|
||
|
||
|
||
/* This page contains functions that return info about
|
||
(struct value) values used in GDB. */
|
||
|
||
/* Returns non-zero if the value VAL represents a true value. */
|
||
int
|
||
value_true (struct value *val)
|
||
{
|
||
/* It is possible that we should have some sort of error if a non-boolean
|
||
value is used in this context. Possibly dependent on some kind of
|
||
"boolean-checking" option like range checking. But it should probably
|
||
not depend on the language except insofar as is necessary to identify
|
||
a "boolean" value (i.e. in C using a float, pointer, etc., as a boolean
|
||
should be an error, probably). */
|
||
return !value_logical_not (val);
|
||
}
|
||
|
||
/* This page contains functions for the printing out of
|
||
error messages that occur during type- and range-
|
||
checking. */
|
||
|
||
/* This is called when a language fails a range-check. The
|
||
first argument should be a printf()-style format string, and the
|
||
rest of the arguments should be its arguments. If range_check is
|
||
range_check_on, an error is printed; if range_check_warn, a warning;
|
||
otherwise just the message. */
|
||
|
||
void
|
||
range_error (const char *string,...)
|
||
{
|
||
va_list args;
|
||
|
||
va_start (args, string);
|
||
switch (range_check)
|
||
{
|
||
case range_check_warn:
|
||
vwarning (string, args);
|
||
break;
|
||
case range_check_on:
|
||
verror (string, args);
|
||
break;
|
||
case range_check_off:
|
||
/* FIXME: cagney/2002-01-30: Should this function print anything
|
||
when range error is off? */
|
||
vfprintf_filtered (gdb_stderr, string, args);
|
||
fprintf_filtered (gdb_stderr, "\n");
|
||
break;
|
||
default:
|
||
internal_error (__FILE__, __LINE__, _("bad switch"));
|
||
}
|
||
va_end (args);
|
||
}
|
||
|
||
|
||
/* This page contains miscellaneous functions. */
|
||
|
||
/* Return the language enum for a given language string. */
|
||
|
||
enum language
|
||
language_enum (const char *str)
|
||
{
|
||
for (const auto &lang : languages)
|
||
if (strcmp (lang->la_name, str) == 0)
|
||
return lang->la_language;
|
||
|
||
if (strcmp (str, "local") == 0)
|
||
return language_auto;
|
||
|
||
return language_unknown;
|
||
}
|
||
|
||
/* Return the language struct for a given language enum. */
|
||
|
||
const struct language_defn *
|
||
language_def (enum language lang)
|
||
{
|
||
return languages[lang];
|
||
}
|
||
|
||
/* Return the language as a string. */
|
||
|
||
const char *
|
||
language_str (enum language lang)
|
||
{
|
||
return languages[lang]->la_name;
|
||
}
|
||
|
||
static void
|
||
set_check (const char *ignore, int from_tty)
|
||
{
|
||
printf_unfiltered (
|
||
"\"set check\" must be followed by the name of a check subcommand.\n");
|
||
help_list (setchecklist, "set check ", all_commands, gdb_stdout);
|
||
}
|
||
|
||
static void
|
||
show_check (const char *ignore, int from_tty)
|
||
{
|
||
cmd_show_list (showchecklist, from_tty, "");
|
||
}
|
||
|
||
|
||
/* Build and install the "set language LANG" command. */
|
||
|
||
static void
|
||
add_set_language_command ()
|
||
{
|
||
static const char **language_names;
|
||
|
||
/* Build the language names array, to be used as enumeration in the
|
||
"set language" enum command. +1 for "local" and +1 for NULL
|
||
termination. */
|
||
language_names = new const char *[ARRAY_SIZE (languages) + 2];
|
||
|
||
/* Display "auto", "local" and "unknown" first, and then the rest,
|
||
alpha sorted. */
|
||
const char **language_names_p = language_names;
|
||
*language_names_p++ = auto_language_defn.la_name;
|
||
*language_names_p++ = "local";
|
||
*language_names_p++ = unknown_language_defn.la_name;
|
||
const char **sort_begin = language_names_p;
|
||
for (const auto &lang : languages)
|
||
{
|
||
/* Already handled above. */
|
||
if (lang->la_language == language_auto
|
||
|| lang->la_language == language_unknown)
|
||
continue;
|
||
*language_names_p++ = lang->la_name;
|
||
}
|
||
*language_names_p = NULL;
|
||
std::sort (sort_begin, language_names_p, compare_cstrings);
|
||
|
||
/* Add the filename extensions. */
|
||
for (const auto &lang : languages)
|
||
if (lang->la_filename_extensions != NULL)
|
||
{
|
||
for (size_t i = 0; lang->la_filename_extensions[i] != NULL; ++i)
|
||
add_filename_language (lang->la_filename_extensions[i],
|
||
lang->la_language);
|
||
}
|
||
|
||
/* Build the "help set language" docs. */
|
||
string_file doc;
|
||
|
||
doc.printf (_("Set the current source language.\n"
|
||
"The currently understood settings are:\n\nlocal or "
|
||
"auto Automatic setting based on source file"));
|
||
|
||
for (const auto &lang : languages)
|
||
{
|
||
/* Already dealt with these above. */
|
||
if (lang->la_language == language_unknown
|
||
|| lang->la_language == language_auto)
|
||
continue;
|
||
|
||
/* FIXME: i18n: for now assume that the human-readable name is
|
||
just a capitalization of the internal name. */
|
||
/* Note that we add the newline at the front, so we don't wind
|
||
up with a trailing newline. */
|
||
doc.printf ("\n%-16s Use the %c%s language",
|
||
lang->la_name,
|
||
/* Capitalize first letter of language name. */
|
||
toupper (lang->la_name[0]),
|
||
lang->la_name + 1);
|
||
}
|
||
|
||
add_setshow_enum_cmd ("language", class_support,
|
||
language_names,
|
||
&language,
|
||
doc.c_str (),
|
||
_("Show the current source language."),
|
||
NULL, set_language_command,
|
||
show_language_command,
|
||
&setlist, &showlist);
|
||
}
|
||
|
||
/* Iterate through all registered languages looking for and calling
|
||
any non-NULL struct language_defn.skip_trampoline() functions.
|
||
Return the result from the first that returns non-zero, or 0 if all
|
||
`fail'. */
|
||
CORE_ADDR
|
||
skip_language_trampoline (struct frame_info *frame, CORE_ADDR pc)
|
||
{
|
||
for (const auto &lang : languages)
|
||
{
|
||
if (lang->skip_trampoline != NULL)
|
||
{
|
||
CORE_ADDR real_pc = lang->skip_trampoline (frame, pc);
|
||
|
||
if (real_pc)
|
||
return real_pc;
|
||
}
|
||
}
|
||
|
||
return 0;
|
||
}
|
||
|
||
/* Return demangled language symbol, or NULL.
|
||
FIXME: Options are only useful for certain languages and ignored
|
||
by others, so it would be better to remove them here and have a
|
||
more flexible demangler for the languages that need it.
|
||
FIXME: Sometimes the demangler is invoked when we don't know the
|
||
language, so we can't use this everywhere. */
|
||
char *
|
||
language_demangle (const struct language_defn *current_language,
|
||
const char *mangled, int options)
|
||
{
|
||
if (current_language != NULL && current_language->la_demangle)
|
||
return current_language->la_demangle (mangled, options);
|
||
return NULL;
|
||
}
|
||
|
||
/* See language.h. */
|
||
|
||
int
|
||
language_sniff_from_mangled_name (const struct language_defn *lang,
|
||
const char *mangled, char **demangled)
|
||
{
|
||
gdb_assert (lang != NULL);
|
||
|
||
if (lang->la_sniff_from_mangled_name == NULL)
|
||
{
|
||
*demangled = NULL;
|
||
return 0;
|
||
}
|
||
|
||
return lang->la_sniff_from_mangled_name (mangled, demangled);
|
||
}
|
||
|
||
/* Return class name from physname or NULL. */
|
||
char *
|
||
language_class_name_from_physname (const struct language_defn *lang,
|
||
const char *physname)
|
||
{
|
||
if (lang != NULL && lang->la_class_name_from_physname)
|
||
return lang->la_class_name_from_physname (physname);
|
||
return NULL;
|
||
}
|
||
|
||
/* Return non-zero if TYPE should be passed (and returned) by
|
||
reference at the language level. */
|
||
int
|
||
language_pass_by_reference (struct type *type)
|
||
{
|
||
return current_language->la_pass_by_reference (type);
|
||
}
|
||
|
||
/* Return zero; by default, types are passed by value at the language
|
||
level. The target ABI may pass or return some structs by reference
|
||
independent of this. */
|
||
int
|
||
default_pass_by_reference (struct type *type)
|
||
{
|
||
return 0;
|
||
}
|
||
|
||
/* Return the default string containing the list of characters
|
||
delimiting words. This is a reasonable default value that
|
||
most languages should be able to use. */
|
||
|
||
const char *
|
||
default_word_break_characters (void)
|
||
{
|
||
return " \t\n!@#$%^&*()+=|~`}{[]\"';:?/>.<,-";
|
||
}
|
||
|
||
/* Print the index of array elements using the C99 syntax. */
|
||
|
||
void
|
||
default_print_array_index (struct value *index_value, struct ui_file *stream,
|
||
const struct value_print_options *options)
|
||
{
|
||
fprintf_filtered (stream, "[");
|
||
LA_VALUE_PRINT (index_value, stream, options);
|
||
fprintf_filtered (stream, "] = ");
|
||
}
|
||
|
||
void
|
||
default_get_string (struct value *value,
|
||
gdb::unique_xmalloc_ptr<gdb_byte> *buffer,
|
||
int *length, struct type **char_type, const char **charset)
|
||
{
|
||
error (_("Getting a string is unsupported in this language."));
|
||
}
|
||
|
||
/* See language.h. */
|
||
|
||
bool
|
||
default_symbol_name_matcher (const char *symbol_search_name,
|
||
const lookup_name_info &lookup_name,
|
||
completion_match_result *comp_match_res)
|
||
{
|
||
const std::string &name = lookup_name.name ();
|
||
completion_match_for_lcd *match_for_lcd
|
||
= (comp_match_res != NULL ? &comp_match_res->match_for_lcd : NULL);
|
||
strncmp_iw_mode mode = (lookup_name.completion_mode ()
|
||
? strncmp_iw_mode::NORMAL
|
||
: strncmp_iw_mode::MATCH_PARAMS);
|
||
|
||
if (strncmp_iw_with_mode (symbol_search_name, name.c_str (), name.size (),
|
||
mode, language_minimal, match_for_lcd) == 0)
|
||
{
|
||
if (comp_match_res != NULL)
|
||
comp_match_res->set_match (symbol_search_name);
|
||
return true;
|
||
}
|
||
else
|
||
return false;
|
||
}
|
||
|
||
/* See language.h. */
|
||
|
||
bool
|
||
default_is_string_type_p (struct type *type)
|
||
{
|
||
type = check_typedef (type);
|
||
while (TYPE_CODE (type) == TYPE_CODE_REF)
|
||
{
|
||
type = TYPE_TARGET_TYPE (type);
|
||
type = check_typedef (type);
|
||
}
|
||
return (TYPE_CODE (type) == TYPE_CODE_STRING);
|
||
}
|
||
|
||
/* See language.h. */
|
||
|
||
symbol_name_matcher_ftype *
|
||
get_symbol_name_matcher (const language_defn *lang,
|
||
const lookup_name_info &lookup_name)
|
||
{
|
||
/* If currently in Ada mode, and the lookup name is wrapped in
|
||
'<...>', hijack all symbol name comparisons using the Ada
|
||
matcher, which handles the verbatim matching. */
|
||
if (current_language->la_language == language_ada
|
||
&& lookup_name.ada ().verbatim_p ())
|
||
return current_language->la_get_symbol_name_matcher (lookup_name);
|
||
|
||
if (lang->la_get_symbol_name_matcher != nullptr)
|
||
return lang->la_get_symbol_name_matcher (lookup_name);
|
||
return default_symbol_name_matcher;
|
||
}
|
||
|
||
/* Define the language that is no language. */
|
||
|
||
static int
|
||
unk_lang_parser (struct parser_state *ps)
|
||
{
|
||
return 1;
|
||
}
|
||
|
||
static void
|
||
unk_lang_emit_char (int c, struct type *type, struct ui_file *stream,
|
||
int quoter)
|
||
{
|
||
error (_("internal error - unimplemented "
|
||
"function unk_lang_emit_char called."));
|
||
}
|
||
|
||
static void
|
||
unk_lang_printchar (int c, struct type *type, struct ui_file *stream)
|
||
{
|
||
error (_("internal error - unimplemented "
|
||
"function unk_lang_printchar called."));
|
||
}
|
||
|
||
static void
|
||
unk_lang_printstr (struct ui_file *stream, struct type *type,
|
||
const gdb_byte *string, unsigned int length,
|
||
const char *encoding, int force_ellipses,
|
||
const struct value_print_options *options)
|
||
{
|
||
error (_("internal error - unimplemented "
|
||
"function unk_lang_printstr called."));
|
||
}
|
||
|
||
static void
|
||
unk_lang_print_type (struct type *type, const char *varstring,
|
||
struct ui_file *stream, int show, int level,
|
||
const struct type_print_options *flags)
|
||
{
|
||
error (_("internal error - unimplemented "
|
||
"function unk_lang_print_type called."));
|
||
}
|
||
|
||
static void
|
||
unk_lang_val_print (struct type *type,
|
||
int embedded_offset, CORE_ADDR address,
|
||
struct ui_file *stream, int recurse,
|
||
struct value *val,
|
||
const struct value_print_options *options)
|
||
{
|
||
error (_("internal error - unimplemented "
|
||
"function unk_lang_val_print called."));
|
||
}
|
||
|
||
static void
|
||
unk_lang_value_print (struct value *val, struct ui_file *stream,
|
||
const struct value_print_options *options)
|
||
{
|
||
error (_("internal error - unimplemented "
|
||
"function unk_lang_value_print called."));
|
||
}
|
||
|
||
static CORE_ADDR unk_lang_trampoline (struct frame_info *frame, CORE_ADDR pc)
|
||
{
|
||
return 0;
|
||
}
|
||
|
||
/* Unknown languages just use the cplus demangler. */
|
||
static char *unk_lang_demangle (const char *mangled, int options)
|
||
{
|
||
return gdb_demangle (mangled, options);
|
||
}
|
||
|
||
static char *unk_lang_class_name (const char *mangled)
|
||
{
|
||
return NULL;
|
||
}
|
||
|
||
static const struct op_print unk_op_print_tab[] =
|
||
{
|
||
{NULL, OP_NULL, PREC_NULL, 0}
|
||
};
|
||
|
||
static void
|
||
unknown_language_arch_info (struct gdbarch *gdbarch,
|
||
struct language_arch_info *lai)
|
||
{
|
||
lai->string_char_type = builtin_type (gdbarch)->builtin_char;
|
||
lai->bool_type_default = builtin_type (gdbarch)->builtin_int;
|
||
lai->primitive_type_vector = GDBARCH_OBSTACK_CALLOC (gdbarch, 1,
|
||
struct type *);
|
||
}
|
||
|
||
const struct language_defn unknown_language_defn =
|
||
{
|
||
"unknown",
|
||
"Unknown",
|
||
language_unknown,
|
||
range_check_off,
|
||
case_sensitive_on,
|
||
array_row_major,
|
||
macro_expansion_no,
|
||
NULL,
|
||
&exp_descriptor_standard,
|
||
unk_lang_parser,
|
||
null_post_parser,
|
||
unk_lang_printchar, /* Print character constant */
|
||
unk_lang_printstr,
|
||
unk_lang_emit_char,
|
||
unk_lang_print_type, /* Print a type using appropriate syntax */
|
||
default_print_typedef, /* Print a typedef using appropriate syntax */
|
||
unk_lang_val_print, /* Print a value using appropriate syntax */
|
||
unk_lang_value_print, /* Print a top-level value */
|
||
default_read_var_value, /* la_read_var_value */
|
||
unk_lang_trampoline, /* Language specific skip_trampoline */
|
||
"this", /* name_of_this */
|
||
true, /* store_sym_names_in_linkage_form_p */
|
||
basic_lookup_symbol_nonlocal, /* lookup_symbol_nonlocal */
|
||
basic_lookup_transparent_type,/* lookup_transparent_type */
|
||
unk_lang_demangle, /* Language specific symbol demangler */
|
||
NULL,
|
||
unk_lang_class_name, /* Language specific
|
||
class_name_from_physname */
|
||
unk_op_print_tab, /* expression operators for printing */
|
||
1, /* c-style arrays */
|
||
0, /* String lower bound */
|
||
default_word_break_characters,
|
||
default_collect_symbol_completion_matches,
|
||
unknown_language_arch_info, /* la_language_arch_info. */
|
||
default_print_array_index,
|
||
default_pass_by_reference,
|
||
default_get_string,
|
||
c_watch_location_expression,
|
||
NULL, /* la_get_symbol_name_matcher */
|
||
iterate_over_symbols,
|
||
default_search_name_hash,
|
||
&default_varobj_ops,
|
||
NULL,
|
||
NULL,
|
||
default_is_string_type_p,
|
||
"{...}" /* la_struct_too_deep_ellipsis */
|
||
};
|
||
|
||
/* These two structs define fake entries for the "local" and "auto"
|
||
options. */
|
||
const struct language_defn auto_language_defn =
|
||
{
|
||
"auto",
|
||
"Auto",
|
||
language_auto,
|
||
range_check_off,
|
||
case_sensitive_on,
|
||
array_row_major,
|
||
macro_expansion_no,
|
||
NULL,
|
||
&exp_descriptor_standard,
|
||
unk_lang_parser,
|
||
null_post_parser,
|
||
unk_lang_printchar, /* Print character constant */
|
||
unk_lang_printstr,
|
||
unk_lang_emit_char,
|
||
unk_lang_print_type, /* Print a type using appropriate syntax */
|
||
default_print_typedef, /* Print a typedef using appropriate syntax */
|
||
unk_lang_val_print, /* Print a value using appropriate syntax */
|
||
unk_lang_value_print, /* Print a top-level value */
|
||
default_read_var_value, /* la_read_var_value */
|
||
unk_lang_trampoline, /* Language specific skip_trampoline */
|
||
"this", /* name_of_this */
|
||
false, /* store_sym_names_in_linkage_form_p */
|
||
basic_lookup_symbol_nonlocal, /* lookup_symbol_nonlocal */
|
||
basic_lookup_transparent_type,/* lookup_transparent_type */
|
||
unk_lang_demangle, /* Language specific symbol demangler */
|
||
NULL,
|
||
unk_lang_class_name, /* Language specific
|
||
class_name_from_physname */
|
||
unk_op_print_tab, /* expression operators for printing */
|
||
1, /* c-style arrays */
|
||
0, /* String lower bound */
|
||
default_word_break_characters,
|
||
default_collect_symbol_completion_matches,
|
||
unknown_language_arch_info, /* la_language_arch_info. */
|
||
default_print_array_index,
|
||
default_pass_by_reference,
|
||
default_get_string,
|
||
c_watch_location_expression,
|
||
NULL, /* la_get_symbol_name_matcher */
|
||
iterate_over_symbols,
|
||
default_search_name_hash,
|
||
&default_varobj_ops,
|
||
NULL,
|
||
NULL,
|
||
default_is_string_type_p,
|
||
"{...}" /* la_struct_too_deep_ellipsis */
|
||
};
|
||
|
||
|
||
/* Per-architecture language information. */
|
||
|
||
static struct gdbarch_data *language_gdbarch_data;
|
||
|
||
struct language_gdbarch
|
||
{
|
||
/* A vector of per-language per-architecture info. Indexed by "enum
|
||
language". */
|
||
struct language_arch_info arch_info[nr_languages];
|
||
};
|
||
|
||
static void *
|
||
language_gdbarch_post_init (struct gdbarch *gdbarch)
|
||
{
|
||
struct language_gdbarch *l;
|
||
|
||
l = GDBARCH_OBSTACK_ZALLOC (gdbarch, struct language_gdbarch);
|
||
for (const auto &lang : languages)
|
||
if (lang != NULL && lang->la_language_arch_info != NULL)
|
||
{
|
||
lang->la_language_arch_info (gdbarch,
|
||
l->arch_info + lang->la_language);
|
||
}
|
||
|
||
return l;
|
||
}
|
||
|
||
struct type *
|
||
language_string_char_type (const struct language_defn *la,
|
||
struct gdbarch *gdbarch)
|
||
{
|
||
struct language_gdbarch *ld
|
||
= (struct language_gdbarch *) gdbarch_data (gdbarch, language_gdbarch_data);
|
||
|
||
return ld->arch_info[la->la_language].string_char_type;
|
||
}
|
||
|
||
struct type *
|
||
language_bool_type (const struct language_defn *la,
|
||
struct gdbarch *gdbarch)
|
||
{
|
||
struct language_gdbarch *ld
|
||
= (struct language_gdbarch *) gdbarch_data (gdbarch, language_gdbarch_data);
|
||
|
||
if (ld->arch_info[la->la_language].bool_type_symbol)
|
||
{
|
||
struct symbol *sym;
|
||
|
||
sym = lookup_symbol (ld->arch_info[la->la_language].bool_type_symbol,
|
||
NULL, VAR_DOMAIN, NULL).symbol;
|
||
if (sym)
|
||
{
|
||
struct type *type = SYMBOL_TYPE (sym);
|
||
|
||
if (type && TYPE_CODE (type) == TYPE_CODE_BOOL)
|
||
return type;
|
||
}
|
||
}
|
||
|
||
return ld->arch_info[la->la_language].bool_type_default;
|
||
}
|
||
|
||
/* Helper function for primitive type lookup. */
|
||
|
||
static struct type **
|
||
language_lookup_primitive_type_1 (const struct language_arch_info *lai,
|
||
const char *name)
|
||
{
|
||
struct type **p;
|
||
|
||
for (p = lai->primitive_type_vector; (*p) != NULL; p++)
|
||
{
|
||
if (strcmp (TYPE_NAME (*p), name) == 0)
|
||
return p;
|
||
}
|
||
return NULL;
|
||
}
|
||
|
||
/* See language.h. */
|
||
|
||
struct type *
|
||
language_lookup_primitive_type (const struct language_defn *la,
|
||
struct gdbarch *gdbarch,
|
||
const char *name)
|
||
{
|
||
struct language_gdbarch *ld =
|
||
(struct language_gdbarch *) gdbarch_data (gdbarch, language_gdbarch_data);
|
||
struct type **typep;
|
||
|
||
typep = language_lookup_primitive_type_1 (&ld->arch_info[la->la_language],
|
||
name);
|
||
if (typep == NULL)
|
||
return NULL;
|
||
return *typep;
|
||
}
|
||
|
||
/* Helper function for type lookup as a symbol.
|
||
Create the symbol corresponding to type TYPE in language LANG. */
|
||
|
||
static struct symbol *
|
||
language_alloc_type_symbol (enum language lang, struct type *type)
|
||
{
|
||
struct symbol *symbol;
|
||
struct gdbarch *gdbarch;
|
||
|
||
gdb_assert (!TYPE_OBJFILE_OWNED (type));
|
||
|
||
gdbarch = TYPE_OWNER (type).gdbarch;
|
||
symbol = GDBARCH_OBSTACK_ZALLOC (gdbarch, struct symbol);
|
||
|
||
symbol->ginfo.name = TYPE_NAME (type);
|
||
symbol->ginfo.language = lang;
|
||
symbol->owner.arch = gdbarch;
|
||
SYMBOL_OBJFILE_OWNED (symbol) = 0;
|
||
SYMBOL_TYPE (symbol) = type;
|
||
SYMBOL_DOMAIN (symbol) = VAR_DOMAIN;
|
||
SYMBOL_ACLASS_INDEX (symbol) = LOC_TYPEDEF;
|
||
|
||
return symbol;
|
||
}
|
||
|
||
/* Initialize the primitive type symbols of language LD.
|
||
The primitive type vector must have already been initialized. */
|
||
|
||
static void
|
||
language_init_primitive_type_symbols (struct language_arch_info *lai,
|
||
const struct language_defn *la,
|
||
struct gdbarch *gdbarch)
|
||
{
|
||
int n;
|
||
|
||
gdb_assert (lai->primitive_type_vector != NULL);
|
||
|
||
for (n = 0; lai->primitive_type_vector[n] != NULL; ++n)
|
||
continue;
|
||
|
||
lai->primitive_type_symbols
|
||
= GDBARCH_OBSTACK_CALLOC (gdbarch, n + 1, struct symbol *);
|
||
|
||
for (n = 0; lai->primitive_type_vector[n] != NULL; ++n)
|
||
{
|
||
lai->primitive_type_symbols[n]
|
||
= language_alloc_type_symbol (la->la_language,
|
||
lai->primitive_type_vector[n]);
|
||
}
|
||
|
||
/* Note: The result of symbol lookup is normally a symbol *and* the block
|
||
it was found in. Builtin types don't live in blocks. We *could* give
|
||
them one, but there is no current need so to keep things simple symbol
|
||
lookup is extended to allow for BLOCK_FOUND to be NULL. */
|
||
}
|
||
|
||
/* See language.h. */
|
||
|
||
struct symbol *
|
||
language_lookup_primitive_type_as_symbol (const struct language_defn *la,
|
||
struct gdbarch *gdbarch,
|
||
const char *name)
|
||
{
|
||
struct language_gdbarch *ld
|
||
= (struct language_gdbarch *) gdbarch_data (gdbarch, language_gdbarch_data);
|
||
struct language_arch_info *lai = &ld->arch_info[la->la_language];
|
||
struct type **typep;
|
||
struct symbol *sym;
|
||
|
||
if (symbol_lookup_debug)
|
||
{
|
||
fprintf_unfiltered (gdb_stdlog,
|
||
"language_lookup_primitive_type_as_symbol"
|
||
" (%s, %s, %s)",
|
||
la->la_name, host_address_to_string (gdbarch), name);
|
||
}
|
||
|
||
typep = language_lookup_primitive_type_1 (lai, name);
|
||
if (typep == NULL)
|
||
{
|
||
if (symbol_lookup_debug)
|
||
fprintf_unfiltered (gdb_stdlog, " = NULL\n");
|
||
return NULL;
|
||
}
|
||
|
||
/* The set of symbols is lazily initialized. */
|
||
if (lai->primitive_type_symbols == NULL)
|
||
language_init_primitive_type_symbols (lai, la, gdbarch);
|
||
|
||
sym = lai->primitive_type_symbols[typep - lai->primitive_type_vector];
|
||
|
||
if (symbol_lookup_debug)
|
||
fprintf_unfiltered (gdb_stdlog, " = %s\n", host_address_to_string (sym));
|
||
return sym;
|
||
}
|
||
|
||
/* Initialize the language routines. */
|
||
|
||
void
|
||
_initialize_language (void)
|
||
{
|
||
static const char *const type_or_range_names[]
|
||
= { "on", "off", "warn", "auto", NULL };
|
||
|
||
static const char *const case_sensitive_names[]
|
||
= { "on", "off", "auto", NULL };
|
||
|
||
language_gdbarch_data
|
||
= gdbarch_data_register_post_init (language_gdbarch_post_init);
|
||
|
||
/* GDB commands for language specific stuff. */
|
||
|
||
add_prefix_cmd ("check", no_class, set_check,
|
||
_("Set the status of the type/range checker."),
|
||
&setchecklist, "set check ", 0, &setlist);
|
||
add_alias_cmd ("c", "check", no_class, 1, &setlist);
|
||
add_alias_cmd ("ch", "check", no_class, 1, &setlist);
|
||
|
||
add_prefix_cmd ("check", no_class, show_check,
|
||
_("Show the status of the type/range checker."),
|
||
&showchecklist, "show check ", 0, &showlist);
|
||
add_alias_cmd ("c", "check", no_class, 1, &showlist);
|
||
add_alias_cmd ("ch", "check", no_class, 1, &showlist);
|
||
|
||
add_setshow_enum_cmd ("range", class_support, type_or_range_names,
|
||
&range,
|
||
_("Set range checking (on/warn/off/auto)."),
|
||
_("Show range checking (on/warn/off/auto)."),
|
||
NULL, set_range_command,
|
||
show_range_command,
|
||
&setchecklist, &showchecklist);
|
||
|
||
add_setshow_enum_cmd ("case-sensitive", class_support, case_sensitive_names,
|
||
&case_sensitive, _("\
|
||
Set case sensitivity in name search (on/off/auto)."), _("\
|
||
Show case sensitivity in name search (on/off/auto)."), _("\
|
||
For Fortran the default is off; for other languages the default is on."),
|
||
set_case_command,
|
||
show_case_command,
|
||
&setlist, &showlist);
|
||
|
||
add_set_language_command ();
|
||
|
||
language = "auto";
|
||
range = "auto";
|
||
case_sensitive = "auto";
|
||
|
||
/* Have the above take effect. */
|
||
set_language (language_auto);
|
||
}
|