gdb/python/py-auto-load.c

   1 /* GDB routines for supporting auto-loaded scripts.
   2
   3    Copyright (C) 2010-2021 Free Software Foundation, Inc.
   4
   5    This file is part of GDB.
   6
   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.
  11
  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.
  16
  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/>.  */
  19
  20 #include "defs.h"
  21 #include "top.h"
  22 #include "gdbcmd.h"
  23 #include "objfiles.h"
  24 #include "python.h"
  25 #include "auto-load.h"
  26 #include "python-internal.h"
  27
  28 /* User-settable option to enable/disable auto-loading of Python scripts:
  29    set auto-load python-scripts on|off
  30    This is true if we should auto-load associated Python scripts when an
  31    objfile is opened, false otherwise.  */
  32 static bool auto_load_python_scripts = true;
  33
  34 /* "show" command for the auto_load_python_scripts configuration variable.  */
  35
  36 static void
  37 show_auto_load_python_scripts (struct ui_file *file, int from_tty,
  38                                struct cmd_list_element *c, const char *value)
  39 {
  40   fprintf_filtered (file, _("Auto-loading of Python scripts is %s.\n"), value);
  41 }
  42
  43 /* See python-internal.h.  */
  44
  45 bool
  46 gdbpy_auto_load_enabled (const struct extension_language_defn *extlang)
  47 {
  48   return auto_load_python_scripts;
  49 }
  50
  51 /* Wrapper for "info auto-load python-scripts".  */
  52
  53 static void
  54 info_auto_load_python_scripts (const char *pattern, int from_tty)
  55 {
  56   auto_load_info_scripts (pattern, from_tty, &extension_language_python);
  57 }
  58 \f
  59 int
  60 gdbpy_initialize_auto_load (void)
  61 {
  62   add_setshow_boolean_cmd ("python-scripts", class_support,
  63                            &auto_load_python_scripts, _("\
  64 Set the debugger's behaviour regarding auto-loaded Python scripts."), _("\
  65 Show the debugger's behaviour regarding auto-loaded Python scripts."), _("\
  66 If enabled, auto-loaded Python scripts are loaded when the debugger reads\n\
  67 an executable or shared library.\n\
  68 This options has security implications for untrusted inferiors."),
  69                            NULL, show_auto_load_python_scripts,
  70                            auto_load_set_cmdlist_get (),
  71                            auto_load_show_cmdlist_get ());
  72
  73   set_show_commands auto_load_scripts_cmds
  74     = add_setshow_boolean_cmd ("auto-load-scripts", class_support,
  75                                &auto_load_python_scripts, _("\
  76 Set the debugger's behaviour regarding auto-loaded Python scripts, "
  77                                                                  "deprecated."),
  78                                _("\
  79 Show the debugger's behaviour regarding auto-loaded Python scripts, "
  80                                                                  "deprecated."),
  81                                NULL, NULL, show_auto_load_python_scripts,
  82                                &setlist, &showlist);
  83   deprecate_cmd (auto_load_scripts_cmds.set, "set auto-load python-scripts");
  84   deprecate_cmd (auto_load_scripts_cmds.show, "show auto-load python-scripts");
  85
  86   add_cmd ("python-scripts", class_info, info_auto_load_python_scripts,
  87            _("Print the list of automatically loaded Python scripts.\n\
  88 Usage: info auto-load python-scripts [REGEXP]"),
  89            auto_load_info_cmdlist_get ());
  90
  91   cmd_list_element *info_auto_load_scripts_cmd
  92     = add_info ("auto-load-scripts", info_auto_load_python_scripts, _("\
  93 Print the list of automatically loaded Python scripts, deprecated."));
  94   deprecate_cmd (info_auto_load_scripts_cmd, "info auto-load python-scripts");
  95
  96   return 0;
  97 }