Clean up my ChangeLog entry
[binutils-gdb.git] / gdb / auto-load.c
index 7b4cd73ea574b26d2d5dab455d4472214d0fc749..9cd70f174c3c3c19f381c35a45000428d6a9cbd8 100644 (file)
@@ -61,8 +61,9 @@ static void maybe_print_script_not_found_warning
    const struct extension_language_defn *language,
    const char *section_name, unsigned offset);
 
-/* Value of the 'set debug auto-load' configuration variable.  */
-static bool debug_auto_load = false;
+/* See auto-load.h.  */
+
+bool debug_auto_load = false;
 
 /* "show" command for the debug_auto_load configuration variable.  */
 
@@ -93,9 +94,9 @@ show_auto_load_gdb_scripts (struct ui_file *file, int from_tty,
                    value);
 }
 
-/* Return non-zero if auto-loading gdb scripts is enabled.  */
+/* See auto-load.h.  */
 
-int
+bool
 auto_load_gdb_scripts_enabled (const struct extension_language_defn *extlang)
 {
   return auto_load_gdb_scripts;
@@ -170,7 +171,7 @@ static char *auto_load_safe_path;
 /* Vector of directory elements of AUTO_LOAD_SAFE_PATH with each one normalized
    by tilde_expand and possibly each entries has added its gdb_realpath
    counterpart.  */
-std::vector<gdb::unique_xmalloc_ptr<char>> auto_load_safe_path_vec;
+static std::vector<gdb::unique_xmalloc_ptr<char>> auto_load_safe_path_vec;
 
 /* Expand $datadir and $debugdir in STRING according to the rules of
    substitute_path_component.  */
@@ -183,8 +184,7 @@ auto_load_expand_dir_vars (const char *string)
   substitute_path_component (&s, "$debugdir", debug_file_directory);
 
   if (debug_auto_load && strcmp (s, string) != 0)
-    fprintf_unfiltered (gdb_stdlog,
-                       _("auto-load: Expanded $-variables to \"%s\".\n"), s);
+    auto_load_debug_printf ("Expanded $-variables to \"%s\".", s);
 
   std::vector<gdb::unique_xmalloc_ptr<char>> dir_vec
     = dirnames_to_char_ptr_vec (s);
@@ -198,10 +198,8 @@ auto_load_expand_dir_vars (const char *string)
 static void
 auto_load_safe_path_vec_update (void)
 {
-  if (debug_auto_load)
-    fprintf_unfiltered (gdb_stdlog,
-                       _("auto-load: Updating directories of \"%s\".\n"),
-                       auto_load_safe_path);
+  auto_load_debug_printf ("Updating directories of \"%s\".",
+                         auto_load_safe_path);
 
   auto_load_safe_path_vec = auto_load_expand_dir_vars (auto_load_safe_path);
   size_t len = auto_load_safe_path_vec.size ();
@@ -222,23 +220,18 @@ auto_load_safe_path_vec_update (void)
       if (debug_auto_load)
        {
          if (strcmp (in_vec.get (), original.get ()) == 0)
-           fprintf_unfiltered (gdb_stdlog,
-                               _("auto-load: Using directory \"%s\".\n"),
-                               in_vec.get ());
+           auto_load_debug_printf ("Using directory \"%s\".",
+                                   in_vec.get ());
          else
-           fprintf_unfiltered (gdb_stdlog,
-                               _("auto-load: Resolved directory \"%s\" "
-                                 "as \"%s\".\n"),
-                               original.get (), in_vec.get ());
+           auto_load_debug_printf ("Resolved directory \"%s\" as \"%s\".",
+                                   original.get (), in_vec.get ());
        }
 
       /* If gdb_realpath returns a different content, append it.  */
       if (strcmp (real_path.get (), in_vec.get ()) != 0)
        {
-         if (debug_auto_load)
-           fprintf_unfiltered (gdb_stdlog,
-                               _("auto-load: And canonicalized as \"%s\".\n"),
-                               real_path.get ());
+         auto_load_debug_printf ("And canonicalized as \"%s\".",
+                                 real_path.get ());
 
          auto_load_safe_path_vec.push_back (std::move (real_path));
        }
@@ -338,10 +331,8 @@ filename_is_in_pattern_1 (char *filename, char *pattern)
   size_t pattern_len = strlen (pattern);
   size_t filename_len = strlen (filename);
 
-  if (debug_auto_load)
-    fprintf_unfiltered (gdb_stdlog, _("auto-load: Matching file \"%s\" "
-                                     "to pattern \"%s\"\n"),
-                       filename, pattern);
+  auto_load_debug_printf ("Matching file \"%s\" to pattern \"%s\"",
+                         filename, pattern);
 
   /* Trim trailing slashes ("/") from PATTERN.  Even for "d:\" paths as
      trailing slashes are trimmed also from FILENAME it still matches
@@ -355,9 +346,7 @@ filename_is_in_pattern_1 (char *filename, char *pattern)
      IS_DIR_SEPARATOR character, such as the 'C:\x.exe' filename.  */
   if (pattern_len == 0)
     {
-      if (debug_auto_load)
-       fprintf_unfiltered (gdb_stdlog,
-                           _("auto-load: Matched - empty pattern\n"));
+      auto_load_debug_printf ("Matched - empty pattern");
       return 1;
     }
 
@@ -370,20 +359,15 @@ filename_is_in_pattern_1 (char *filename, char *pattern)
       filename[filename_len] = '\0';
       if (filename_len == 0)
        {
-         if (debug_auto_load)
-           fprintf_unfiltered (gdb_stdlog,
-                               _("auto-load: Not matched - pattern \"%s\".\n"),
-                               pattern);
+         auto_load_debug_printf ("Not matched - pattern \"%s\".", pattern);
          return 0;
        }
 
       if (gdb_filename_fnmatch (pattern, filename, FNM_FILE_NAME | FNM_NOESCAPE)
          == 0)
        {
-         if (debug_auto_load)
-           fprintf_unfiltered (gdb_stdlog, _("auto-load: Matched - file "
-                                             "\"%s\" to pattern \"%s\".\n"),
-                               filename, pattern);
+         auto_load_debug_printf ("Matched - file \"%s\" to pattern \"%s\".",
+                                 filename, pattern);
          return 1;
        }
 
@@ -434,10 +418,8 @@ filename_is_in_auto_load_safe_path_vec (const char *filename,
        {
          *filename_realp = gdb_realpath (filename);
          if (debug_auto_load && strcmp (filename_realp->get (), filename) != 0)
-           fprintf_unfiltered (gdb_stdlog,
-                               _("auto-load: Resolved "
-                                 "file \"%s\" as \"%s\".\n"),
-                               filename, filename_realp->get ());
+           auto_load_debug_printf ("Resolved file \"%s\" as \"%s\".",
+                                   filename, filename_realp->get ());
        }
 
       if (strcmp (filename_realp->get (), filename) != 0)
@@ -451,10 +433,8 @@ filename_is_in_auto_load_safe_path_vec (const char *filename,
 
   if (pattern != NULL)
     {
-      if (debug_auto_load)
-       fprintf_unfiltered (gdb_stdlog, _("auto-load: File \"%s\" matches "
-                                         "directory \"%s\".\n"),
-                           filename, pattern);
+      auto_load_debug_printf ("File \"%s\" matches directory \"%s\".",
+                             filename, pattern);
       return 1;
     }
 
@@ -464,20 +444,11 @@ filename_is_in_auto_load_safe_path_vec (const char *filename,
 /* See auto-load.h.  */
 
 bool
-file_is_auto_load_safe (const char *filename, const char *debug_fmt, ...)
+file_is_auto_load_safe (const char *filename)
 {
   gdb::unique_xmalloc_ptr<char> filename_real;
   static bool advice_printed = false;
 
-  if (debug_auto_load)
-    {
-      va_list debug_args;
-
-      va_start (debug_args, debug_fmt);
-      vfprintf_unfiltered (gdb_stdlog, debug_fmt, debug_args);
-      va_end (debug_args);
-    }
-
   if (filename_is_in_auto_load_safe_path_vec (filename, &filename_real))
     return true;
 
@@ -563,8 +534,8 @@ struct loaded_script
      inaccessible), or NULL for loaded_script_texts.  */
   const char *full_path;
 
-  /* Non-zero if this script has been loaded.  */
-  int loaded;
+  /* True if this script has been loaded.  */
+  bool loaded;
 
   const struct extension_language_defn *language;
 };
@@ -650,24 +621,24 @@ get_auto_load_pspace_data_for_loading (struct program_space *pspace)
 }
 
 /* Add script file NAME in LANGUAGE to hash table of PSPACE_INFO.
-   LOADED 1 if the script has been (is going to) be loaded, 0 otherwise
-   (such as if it has not been found).
+   LOADED is true if the script has been (is going to) be loaded, false
+   otherwise (such as if it has not been found).
    FULL_PATH is NULL if the script wasn't found.
+
    The result is true if the script was already in the hash table.  */
 
-static int
-maybe_add_script_file (struct auto_load_pspace_info *pspace_info, int loaded,
+static bool
+maybe_add_script_file (struct auto_load_pspace_info *pspace_info, bool loaded,
                       const char *name, const char *full_path,
                       const struct extension_language_defn *language)
 {
   struct htab *htab = pspace_info->loaded_script_files.get ();
   struct loaded_script **slot, entry;
-  int in_hash_table;
 
   entry.name = name;
   entry.language = language;
   slot = (struct loaded_script **) htab_find_slot (htab, &entry, INSERT);
-  in_hash_table = *slot != NULL;
+  bool in_hash_table = *slot != NULL;
 
   /* If this script is not in the hash table, add it.  */
 
@@ -699,23 +670,23 @@ maybe_add_script_file (struct auto_load_pspace_info *pspace_info, int loaded,
 }
 
 /* Add script contents NAME in LANGUAGE to hash table of PSPACE_INFO.
-   LOADED 1 if the script has been (is going to) be loaded, 0 otherwise
-   (such as if it has not been found).
+   LOADED is true if the script has been (is going to) be loaded, false
+   otherwise (such as if it has not been found).
+
    The result is true if the script was already in the hash table.  */
 
-static int
+static bool
 maybe_add_script_text (struct auto_load_pspace_info *pspace_info,
-                      int loaded, const char *name,
+                      bool loaded, const char *name,
                       const struct extension_language_defn *language)
 {
   struct htab *htab = pspace_info->loaded_script_texts.get ();
   struct loaded_script **slot, entry;
-  int in_hash_table;
 
   entry.name = name;
   entry.language = language;
   slot = (struct loaded_script **) htab_find_slot (htab, &entry, INSERT);
-  in_hash_table = *slot != NULL;
+  bool in_hash_table = *slot != NULL;
 
   /* If this script is not in the hash table, add it.  */
 
@@ -766,9 +737,10 @@ auto_load_objfile_script_1 (struct objfile *objfile, const char *realname,
 
   gdb_file_up input = gdb_fopen_cloexec (filename.c_str (), "r");
   debugfile = filename.c_str ();
-  if (debug_auto_load)
-    fprintf_unfiltered (gdb_stdlog, _("auto-load: Attempted file \"%s\" %s.\n"),
-                       debugfile, input ? _("exists") : _("does not exist"));
+
+  auto_load_debug_printf ("Attempted file \"%s\" %s.",
+                         debugfile,
+                         input != nullptr ? "exists" : "does not exist");
 
   std::string debugfile_holder;
   if (!input)
@@ -779,10 +751,9 @@ auto_load_objfile_script_1 (struct objfile *objfile, const char *realname,
       std::vector<gdb::unique_xmalloc_ptr<char>> vec
        = auto_load_expand_dir_vars (auto_load_dir);
 
-      if (debug_auto_load)
-       fprintf_unfiltered (gdb_stdlog, _("auto-load: Searching 'set auto-load "
-                                         "scripts-directory' path \"%s\".\n"),
-                           auto_load_dir);
+      auto_load_debug_printf
+       ("Searching 'set auto-load scripts-directory' path \"%s\".",
+        auto_load_dir);
 
       /* Convert Windows file name from c:/dir/file to /c/dir/file.  */
       if (HAS_DRIVE_SPEC (debugfile))
@@ -796,11 +767,13 @@ auto_load_objfile_script_1 (struct objfile *objfile, const char *realname,
          debugfile = debugfile_holder.c_str ();
 
          input = gdb_fopen_cloexec (debugfile, "r");
-         if (debug_auto_load)
-           fprintf_unfiltered (gdb_stdlog, _("auto-load: Attempted file "
-                                             "\"%s\" %s.\n"),
-                               debugfile,
-                               input ? _("exists") : _("does not exist"));
+
+         auto_load_debug_printf ("Attempted file \"%s\" %s.",
+                                 debugfile,
+                                 (input != nullptr
+                                  ? "exists"
+                                  : "does not exist"));
+
          if (input != NULL)
            break;
        }
@@ -808,15 +781,13 @@ auto_load_objfile_script_1 (struct objfile *objfile, const char *realname,
 
   if (input)
     {
-      int is_safe;
       struct auto_load_pspace_info *pspace_info;
 
-      is_safe
-       = file_is_auto_load_safe (debugfile,
-                                 _("auto-load: Loading %s script \"%s\""
-                                   " by extension for objfile \"%s\".\n"),
-                                 ext_lang_name (language),
-                                 debugfile, objfile_name (objfile));
+      auto_load_debug_printf
+       ("Loading %s script \"%s\" by extension for objfile \"%s\".",
+        ext_lang_name (language), debugfile, objfile_name (objfile));
+
+      bool is_safe = file_is_auto_load_safe (debugfile);
 
       /* Add this script to the hash table too so
         "info auto-load ${lang}-scripts" can print it.  */
@@ -872,10 +843,11 @@ auto_load_objfile_script (struct objfile *objfile,
        {
          len -= lexe;
          realname.get ()[len] = '\0';
-         if (debug_auto_load)
-           fprintf_unfiltered (gdb_stdlog, _("auto-load: Stripped .exe suffix, "
-                                             "retrying with \"%s\".\n"),
-                               realname.get ());
+
+         auto_load_debug_printf
+           ("auto-load: Stripped .exe suffix, retrying with \"%s\".",
+            realname.get ());
+
          auto_load_objfile_script_1 (objfile, realname.get (), language);
        }
     }
@@ -892,7 +864,6 @@ source_script_file (struct auto_load_pspace_info *pspace_info,
                    const char *section_name, unsigned int offset,
                    const char *file)
 {
-  int in_hash_table;
   objfile_script_sourcer_func *sourcer;
 
   /* Skip this script if support is not compiled in.  */
@@ -919,13 +890,12 @@ source_script_file (struct auto_load_pspace_info *pspace_info,
 
   if (opened)
     {
-      if (!file_is_auto_load_safe (opened->full_path.get (),
-                                  _("auto-load: Loading %s script "
-                                    "\"%s\" from section \"%s\" of "
-                                    "objfile \"%s\".\n"),
-                                  ext_lang_name (language),
-                                  opened->full_path.get (),
-                                  section_name, objfile_name (objfile)))
+      auto_load_debug_printf
+       ("Loading %s script \"%s\" from section \"%s\" of objfile \"%s\".",
+        ext_lang_name (language), opened->full_path.get (),
+        section_name, objfile_name (objfile));
+
+      if (!file_is_auto_load_safe (opened->full_path.get ()))
        opened.reset ();
     }
   else
@@ -942,11 +912,10 @@ source_script_file (struct auto_load_pspace_info *pspace_info,
                                            section_name, offset);
     }
 
-  in_hash_table = maybe_add_script_file (pspace_info, bool (opened), file,
-                                        (opened
-                                         ? opened->full_path.get ()
-                                         : NULL),
-                                        language);
+  bool in_hash_table
+    = maybe_add_script_file (pspace_info, bool (opened), file,
+                            (opened ? opened->full_path.get (): NULL),
+                            language);
 
   /* If this file is not currently loaded, load it.  */
   if (opened && !in_hash_table)
@@ -968,7 +937,6 @@ execute_script_contents (struct auto_load_pspace_info *pspace_info,
   objfile_script_executor_func *executor;
   const char *newline, *script_text;
   const char *name;
-  int is_safe, in_hash_table;
 
   /* The first line of the script is the name of the script.
      It must not contain any kind of space character.  */
@@ -1022,14 +990,14 @@ of file %ps."),
       return;
     }
 
-  is_safe = file_is_auto_load_safe (objfile_name (objfile),
-                                   _("auto-load: Loading %s script "
-                                     "\"%s\" from section \"%s\" of "
-                                     "objfile \"%s\".\n"),
-                                   ext_lang_name (language), name,
-                                   section_name, objfile_name (objfile));
+  auto_load_debug_printf
+    ("Loading %s script \"%s\" from section \"%s\" of objfile \"%s\".",
+     ext_lang_name (language), name, section_name, objfile_name (objfile));
 
-  in_hash_table = maybe_add_script_text (pspace_info, is_safe, name, language);
+  bool is_safe = file_is_auto_load_safe (objfile_name (objfile));
+
+  bool in_hash_table
+    = maybe_add_script_text (pspace_info, is_safe, name, language);
 
   /* If this file is not currently loaded, load it.  */
   if (is_safe && !in_hash_table)
@@ -1459,8 +1427,7 @@ auto_load_set_cmdlist_get (void)
 Auto-loading specific settings.\n\
 Configure various auto-load-specific variables such as\n\
 automatic loading of Python scripts."),
-                   &retval, "set auto-load ",
-                   1/*allow-unknown*/, &setlist);
+                   &retval, 1/*allow-unknown*/, &setlist);
 
   return &retval;
 }
@@ -1477,8 +1444,7 @@ auto_load_show_cmdlist_get (void)
 Show auto-loading specific settings.\n\
 Show configuration of various auto-load-specific variables such as\n\
 automatic loading of Python scripts."),
-                        &retval, "show auto-load ",
-                        0/*allow-unknown*/, &showlist);
+                        &retval, 0/*allow-unknown*/, &showlist);
 
   return &retval;
 }
@@ -1499,7 +1465,7 @@ info_auto_load_cmd (const char *args, int from_tty)
     {
       ui_out_emit_tuple option_emitter (uiout, "option");
 
-      gdb_assert (!list->prefixlist);
+      gdb_assert (!list->is_prefix ());
       gdb_assert (list->type == not_set_cmd);
 
       uiout->field_string ("name", list->name);
@@ -1520,12 +1486,15 @@ auto_load_info_cmdlist_get (void)
 Print current status of auto-loaded files.\n\
 Print whether various files like Python scripts or .gdbinit files have been\n\
 found and/or loaded."),
-                   &retval, "info auto-load ",
-                   0/*allow-unknown*/, &infolist);
+                   &retval, 0/*allow-unknown*/, &infolist);
 
   return &retval;
 }
 
+/* See auto-load.h.  */
+
+gdb::observers::token auto_load_new_objfile_observer_token;
+
 void _initialize_auto_load ();
 void
 _initialize_auto_load ()
@@ -1535,8 +1504,9 @@ _initialize_auto_load ()
   char *guile_name_help;
   const char *suffix;
 
-  gdb::observers::new_objfile.attach (auto_load_new_objfile);
-
+  gdb::observers::new_objfile.attach (auto_load_new_objfile,
+                                      auto_load_new_objfile_observer_token,
+                                      "auto-load");
   add_setshow_boolean_cmd ("gdb-scripts", class_support,
                           &auto_load_gdb_scripts, _("\
 Enable or disable auto-loading of canned sequences of commands scripts."), _("\
@@ -1645,7 +1615,8 @@ This option has security implications for untrusted inferiors."),
                                     show_auto_load_safe_path,
                                     auto_load_set_cmdlist_get (),
                                     auto_load_show_cmdlist_get ());
-  gdb::observers::gdb_datadir_changed.attach (auto_load_gdb_datadir_changed);
+  gdb::observers::gdb_datadir_changed.attach (auto_load_gdb_datadir_changed,
+                                             "auto-load");
 
   cmd = add_cmd ("add-auto-load-safe-path", class_support,
                 add_auto_load_safe_path,