gdb/auto-load.h

   1 /* GDB routines for supporting auto-loaded scripts.
   2
   3    Copyright (C) 2012-2023 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 #ifndef AUTO_LOAD_H
  21 #define AUTO_LOAD_H 1
  22
  23 struct objfile;
  24 struct program_space;
  25 struct auto_load_pspace_info;
  26 struct extension_language_defn;
  27
  28 namespace gdb {
  29 namespace observers {
  30 struct token;
  31 } /* namespace observers */
  32 } /* namespace gdb */
  33
  34 /* Value of the 'set debug auto-load' configuration variable.  */
  35
  36 extern bool debug_auto_load;
  37
  38 /* Print an "auto-load" debug statement.  */
  39
  40 #define auto_load_debug_printf(fmt, ...) \
  41   debug_prefixed_printf_cond (debug_auto_load, "auto-load", fmt, ##__VA_ARGS__)
  42
  43 extern bool global_auto_load;
  44
  45 extern bool auto_load_local_gdbinit;
  46 extern char *auto_load_local_gdbinit_pathname;
  47 extern bool auto_load_local_gdbinit_loaded;
  48
  49 /* Token used for the auto_load_new_objfile observer, so other observers can
  50    specify it as a dependency. */
  51 extern gdb::observers::token auto_load_new_objfile_observer_token;
  52
  53 extern struct auto_load_pspace_info *
  54   get_auto_load_pspace_data_for_loading (struct program_space *pspace);
  55 extern void auto_load_objfile_script (struct objfile *objfile,
  56                                       const struct extension_language_defn *);
  57 extern void load_auto_scripts_for_objfile (struct objfile *objfile);
  58 extern char auto_load_info_scripts_pattern_nl[];
  59 extern void auto_load_info_scripts (program_space *pspace, const char *pattern,
  60                                     int from_tty,
  61                                     const extension_language_defn *);
  62
  63 extern struct cmd_list_element **auto_load_set_cmdlist_get (void);
  64 extern struct cmd_list_element **auto_load_show_cmdlist_get (void);
  65 extern struct cmd_list_element **auto_load_info_cmdlist_get (void);
  66
  67 /* Return true if FILENAME is located in one of the directories of
  68    AUTO_LOAD_SAFE_PATH.  Otherwise call warning and return false.  FILENAME does
  69    not have to be an absolute path.
  70
  71    Existence of FILENAME is not checked.  Function will still give a warning
  72    even if the caller would quietly skip non-existing file in unsafe
  73    directory.  */
  74
  75 extern bool file_is_auto_load_safe (const char *filename);
  76
  77 /* Return true if auto-loading gdb scripts is enabled.  */
  78
  79 extern bool auto_load_gdb_scripts_enabled
  80   (const struct extension_language_defn *extlang);
  81
  82 #endif /* AUTO_LOAD_H */