gdb/auto-load.h

   1 /* GDB routines for supporting auto-loaded scripts.
   2
   3    Copyright (C) 2012-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 #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 extern bool global_auto_load;
  29
  30 extern bool auto_load_local_gdbinit;
  31 extern char *auto_load_local_gdbinit_pathname;
  32 extern bool auto_load_local_gdbinit_loaded;
  33
  34 extern struct auto_load_pspace_info *
  35   get_auto_load_pspace_data_for_loading (struct program_space *pspace);
  36 extern void auto_load_objfile_script (struct objfile *objfile,
  37                                       const struct extension_language_defn *);
  38 extern void load_auto_scripts_for_objfile (struct objfile *objfile);
  39 extern char auto_load_info_scripts_pattern_nl[];
  40 extern void auto_load_info_scripts (const char *pattern, int from_tty,
  41                                     const struct extension_language_defn *);
  42
  43 extern struct cmd_list_element **auto_load_set_cmdlist_get (void);
  44 extern struct cmd_list_element **auto_load_show_cmdlist_get (void);
  45 extern struct cmd_list_element **auto_load_info_cmdlist_get (void);
  46
  47 /* Return true if FILENAME is located in one of the directories of
  48    AUTO_LOAD_SAFE_PATH.  Otherwise call warning and return false.  FILENAME does
  49    not have to be an absolute path.
  50
  51    Existence of FILENAME is not checked.  Function will still give a warning
  52    even if the caller would quietly skip non-existing file in unsafe
  53    directory.  */
  54
  55 extern bool file_is_auto_load_safe (const char *filename,
  56                                     const char *debug_fmt, ...)
  57   ATTRIBUTE_PRINTF (2, 3);
  58
  59 extern int auto_load_gdb_scripts_enabled
  60   (const struct extension_language_defn *extlang);
  61
  62 #endif /* AUTO_LOAD_H */