From ed1669453be56d71351c77377acee097aefe83b1 Mon Sep 17 00:00:00 2001 From: Tom Tromey Date: Wed, 26 Apr 2017 21:49:55 -0600 Subject: [PATCH] Change return type of find_and_open_script This changes find_and_open_script to return a gdb::optional, where open_script is a new type encapsulating the two return values. The new type helps avoid cleanups in the callers. ChangeLog 2017-08-03 Tom Tromey * cli/cli-cmds.c (find_and_open_script): Change return type. Remove "streamp" and "full_path" parameters. (source_script_with_search): Update. * auto-load.c (source_script_file): Update. * cli/cli-cmds.h (find_and_open_script): Change type. (open_script): New struct. --- gdb/ChangeLog | 9 +++++++++ gdb/auto-load.c | 32 +++++++++++++------------------- gdb/cli/cli-cmds.c | 40 ++++++++++++++++++---------------------- gdb/cli/cli-cmds.h | 21 +++++++++++++++++++-- 4 files changed, 59 insertions(+), 43 deletions(-) diff --git a/gdb/ChangeLog b/gdb/ChangeLog index 17a818cc6b3..80b9c2bbfc0 100644 --- a/gdb/ChangeLog +++ b/gdb/ChangeLog @@ -1,3 +1,12 @@ +2017-08-03 Tom Tromey + + * cli/cli-cmds.c (find_and_open_script): Change return type. + Remove "streamp" and "full_path" parameters. + (source_script_with_search): Update. + * auto-load.c (source_script_file): Update. + * cli/cli-cmds.h (find_and_open_script): Change type. + (open_script): New struct. + 2017-08-03 Tom Tromey * xml-support.c (xml_fetch_content_from_file): Update. diff --git a/gdb/auto-load.c b/gdb/auto-load.c index 292f2ae88e9..9f1f13f926d 100644 --- a/gdb/auto-load.c +++ b/gdb/auto-load.c @@ -928,10 +928,7 @@ source_script_file (struct auto_load_pspace_info *pspace_info, const char *section_name, unsigned int offset, const char *file) { - FILE *stream; - char *full_path; - int opened, in_hash_table; - struct cleanup *cleanups; + int in_hash_table; objfile_script_sourcer_func *sourcer; /* Skip this script if support is not compiled in. */ @@ -953,27 +950,22 @@ source_script_file (struct auto_load_pspace_info *pspace_info, return; } - opened = find_and_open_script (file, 1 /*search_path*/, - &stream, &full_path); + gdb::optional opened = find_and_open_script (file, + 1 /*search_path*/); - cleanups = make_cleanup (null_cleanup, NULL); if (opened) { - make_cleanup_fclose (stream); - make_cleanup (xfree, full_path); - - if (!file_is_auto_load_safe (full_path, + 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), full_path, + ext_lang_name (language), + opened->full_path.get (), section_name, objfile_name (objfile))) - opened = 0; + opened.reset (); } else { - full_path = NULL; - /* If one script isn't found it's not uncommon for more to not be found either. We don't want to print a message for each script, too much noise. Instead, we print the warning once and tell the @@ -986,14 +978,16 @@ source_script_file (struct auto_load_pspace_info *pspace_info, section_name, offset); } - in_hash_table = maybe_add_script_file (pspace_info, opened, file, full_path, + 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) - sourcer (language, objfile, stream, full_path); - - do_cleanups (cleanups); + sourcer (language, objfile, opened->stream.get (), + opened->full_path.get ()); } /* Subroutine of source_section_scripts to simplify it. diff --git a/gdb/cli/cli-cmds.c b/gdb/cli/cli-cmds.c index 8f0376e5f03..46505324101 100644 --- a/gdb/cli/cli-cmds.c +++ b/gdb/cli/cli-cmds.c @@ -506,22 +506,21 @@ show_script_ext_mode (struct ui_file *file, int from_tty, /* Try to open SCRIPT_FILE. If successful, the full path name is stored in *FULL_PATHP, - the stream is stored in *STREAMP, and return 1. - The caller is responsible for freeing *FULL_PATHP. - If not successful, return 0; errno is set for the last file + and the stream is returned. + If not successful, return NULL; errno is set for the last file we tried to open. If SEARCH_PATH is non-zero, and the file isn't found in cwd, search for it in the source search path. */ -int -find_and_open_script (const char *script_file, int search_path, - FILE **streamp, char **full_pathp) +gdb::optional +find_and_open_script (const char *script_file, int search_path) { char *file; int fd; struct cleanup *old_cleanups; int search_flags = OPF_TRY_CWD_FIRST | OPF_RETURN_REALPATH; + gdb::optional opened; file = tilde_expand (script_file); old_cleanups = make_cleanup (xfree, file); @@ -531,32 +530,33 @@ find_and_open_script (const char *script_file, int search_path, /* Search for and open 'file' on the search path used for source files. Put the full location in *FULL_PATHP. */ + char *temp_path; fd = openp (source_path, search_flags, - file, O_RDONLY, full_pathp); + file, O_RDONLY, &temp_path); + gdb::unique_xmalloc_ptr full_path (temp_path); if (fd == -1) { int save_errno = errno; do_cleanups (old_cleanups); errno = save_errno; - return 0; + return opened; } do_cleanups (old_cleanups); - *streamp = fdopen (fd, FOPEN_RT); - if (*streamp == NULL) + FILE *result = fdopen (fd, FOPEN_RT); + if (result == NULL) { int save_errno = errno; close (fd); - if (full_pathp) - xfree (*full_pathp); errno = save_errno; - return 0; } + else + opened.emplace (gdb_file_up (result), std::move (full_path)); - return 1; + return opened; } /* Load script FILE, which has already been opened as STREAM. @@ -607,14 +607,12 @@ source_script_from_stream (FILE *stream, const char *file, static void source_script_with_search (const char *file, int from_tty, int search_path) { - FILE *stream; - char *full_path; - struct cleanup *old_cleanups; if (file == NULL || *file == 0) error (_("source command requires file name of file to source.")); - if (!find_and_open_script (file, search_path, &stream, &full_path)) + gdb::optional opened = find_and_open_script (file, search_path); + if (!opened) { /* The script wasn't found, or was otherwise inaccessible. If the source command was invoked interactively, throw an @@ -629,15 +627,13 @@ source_script_with_search (const char *file, int from_tty, int search_path) } } - old_cleanups = make_cleanup (xfree, full_path); - make_cleanup_fclose (stream); /* The python support reopens the file, so we need to pass full_path here in case the file was found on the search path. It's useful to do this anyway so that error messages show the actual file used. But only do this if we (may have) used search_path, as printing the full path in errors for the non-search case can be more noise than signal. */ - source_script_from_stream (stream, file, search_path ? full_path : file); - do_cleanups (old_cleanups); + source_script_from_stream (opened->stream.get (), file, + search_path ? opened->full_path.get () : file); } /* Wrapper around source_script_with_search to export it to main.c diff --git a/gdb/cli/cli-cmds.h b/gdb/cli/cli-cmds.h index 7ff1fca0b54..1122a97b349 100644 --- a/gdb/cli/cli-cmds.h +++ b/gdb/cli/cli-cmds.h @@ -17,6 +17,9 @@ #if !defined (CLI_CMDS_H) #define CLI_CMDS_H 1 +#include "common/filestuff.h" +#include "common/gdb_optional.h" + /* Chain containing all defined commands. */ extern struct cmd_list_element *cmdlist; @@ -117,8 +120,22 @@ extern void source_script (const char *, int); /* Exported to objfiles.c. */ -extern int find_and_open_script (const char *file, int search_path, - FILE **streamp, char **full_path); +/* The script that was opened. */ +struct open_script +{ + gdb_file_up stream; + gdb::unique_xmalloc_ptr full_path; + + open_script (gdb_file_up &&stream_, + gdb::unique_xmalloc_ptr &&full_path_) + : stream (std::move (stream_)), + full_path (std::move (full_path_)) + { + } +}; + +extern gdb::optional + find_and_open_script (const char *file, int search_path); /* Command tracing state. */ -- 2.30.2