[review] Change tui_source_window_base::set_contents to return bool

Message ID gerrit.1573774548000.I8c5212400cd7aadf35760c22d5344cd3b9435674@gnutoolchain-gerrit.osci.io
State New, archived
Headers

Commit Message

Simon Marchi (Code Review) Nov. 14, 2019, 11:35 p.m. UTC
  Change URL: https://gnutoolchain-gerrit.osci.io/r/c/binutils-gdb/+/638
......................................................................

Change tui_source_window_base::set_contents to return bool

This changes tui_source_window_base::set_contents to return bool,
rather than tui_status.  It also changes one implementation of
set_contents to use early returns rather than a variable, which IMO
makes it easier to follow.

gdb/ChangeLog
2019-11-14  Tom Tromey  <tom@tromey.com>

	* tui/tui-winsource.h (struct tui_source_window_base)
	<set_contents>: Return bool.
	* tui/tui-winsource.c
	(tui_source_window_base::update_source_window_as_is): Update.
	* tui/tui-source.h (struct tui_source_window) <set_contents>:
	Return bool.
	* tui/tui-source.c (tui_source_window::set_contents): Return
	bool.  Simplify.
	* tui/tui-disasm.h (struct tui_disasm_window) <set_contents>:
	Return bool.
	* tui/tui-disasm.c (tui_disasm_window::set_contents): Return
	bool.

Change-Id: I8c5212400cd7aadf35760c22d5344cd3b9435674
---
M gdb/ChangeLog
M gdb/tui/tui-disasm.c
M gdb/tui/tui-disasm.h
M gdb/tui/tui-source.c
M gdb/tui/tui-source.h
M gdb/tui/tui-winsource.c
M gdb/tui/tui-winsource.h
7 files changed, 81 insertions(+), 75 deletions(-)
  

Patch

diff --git a/gdb/ChangeLog b/gdb/ChangeLog
index 619815b..f665148 100644
--- a/gdb/ChangeLog
+++ b/gdb/ChangeLog
@@ -1,5 +1,20 @@ 
 2019-11-14  Tom Tromey  <tom@tromey.com>
 
+	* tui/tui-winsource.h (struct tui_source_window_base)
+	<set_contents>: Return bool.
+	* tui/tui-winsource.c
+	(tui_source_window_base::update_source_window_as_is): Update.
+	* tui/tui-source.h (struct tui_source_window) <set_contents>:
+	Return bool.
+	* tui/tui-source.c (tui_source_window::set_contents): Return
+	bool.  Simplify.
+	* tui/tui-disasm.h (struct tui_disasm_window) <set_contents>:
+	Return bool.
+	* tui/tui-disasm.c (tui_disasm_window::set_contents): Return
+	bool.
+
+2019-11-14  Tom Tromey  <tom@tromey.com>
+
 	* tui/tui-winsource.c (tui_update_source_windows_with_addr)
 	(tui_update_source_windows_with_line): Call update_source_window.
 	* tui/tui-source.h (struct tui_source_window)
diff --git a/gdb/tui/tui-disasm.c b/gdb/tui/tui-disasm.c
index 322c73e..cac6f25 100644
--- a/gdb/tui/tui-disasm.c
+++ b/gdb/tui/tui-disasm.c
@@ -198,7 +198,7 @@ 
 }
 
 /* Function to set the disassembly window's content.  */
-enum tui_status
+bool
 tui_disasm_window::set_contents (struct gdbarch *arch,
 				 struct symtab *s,
 				 struct tui_line_or_address line_or_addr)
@@ -214,7 +214,7 @@ 
   gdb_assert (line_or_addr.loa == LOA_ADDRESS);
   CORE_ADDR pc = line_or_addr.u.addr;
   if (pc == 0)
-    return TUI_FAILURE;
+    return false;
 
   gdbarch = arch;
   start_line_or_addr.loa = LOA_ADDRESS;
@@ -251,7 +251,7 @@ 
       src->line_or_addr.u.addr = asm_lines[i].addr;
       src->is_exec_point = asm_lines[i].addr == cur_pc;
     }
-  return TUI_SUCCESS;
+  return true;
 }
 
 
diff --git a/gdb/tui/tui-disasm.h b/gdb/tui/tui-disasm.h
index f5cc373..ec8d7f1 100644
--- a/gdb/tui/tui-disasm.h
+++ b/gdb/tui/tui-disasm.h
@@ -55,10 +55,9 @@ 
 
   void do_scroll_vertical (int num_to_scroll) override;
 
-  enum tui_status set_contents
-    (struct gdbarch *gdbarch,
-     struct symtab *s,
-     struct tui_line_or_address line_or_addr) override;
+  bool set_contents (struct gdbarch *gdbarch,
+		     struct symtab *s,
+		     struct tui_line_or_address line_or_addr) override;
 
 private:
   /* Answer whether a particular line number or address is displayed
diff --git a/gdb/tui/tui-source.c b/gdb/tui/tui-source.c
index 197a3bb..6b6a978 100644
--- a/gdb/tui/tui-source.c
+++ b/gdb/tui/tui-source.c
@@ -38,7 +38,7 @@ 
 #include "gdb_curses.h"
 
 /* Function to display source in the source window.  */
-enum tui_status
+bool
 tui_source_window::set_contents (struct gdbarch *arch,
 				 struct symtab *s, 
 				 struct tui_line_or_address line_or_addr)
@@ -46,69 +46,64 @@ 
   gdb_assert (line_or_addr.loa == LOA_LINE);
   int line_no = line_or_addr.u.line_no;
 
-  enum tui_status ret = TUI_FAILURE;
+  if (s == NULL)
+    return false;
 
-  if (s != NULL)
+  int line_width, nlines;
+
+  line_width = width - TUI_EXECINFO_SIZE - 1;
+  /* Take hilite (window border) into account, when
+     calculating the number of lines.  */
+  nlines = (line_no + (height - 2)) - line_no;
+
+  std::string srclines;
+  if (!g_source_cache.get_source_lines (s, line_no, line_no + nlines,
+					&srclines))
+    return false;
+
+  int cur_line_no, cur_line;
+  struct tui_locator_window *locator
+    = tui_locator_win_info_ptr ();
+  const char *s_filename = symtab_to_filename_for_display (s);
+
+  title = s_filename;
+
+  m_fullname = make_unique_xstrdup (symtab_to_fullname (s));
+
+  cur_line = 0;
+  gdbarch = get_objfile_arch (SYMTAB_OBJFILE (s));
+  start_line_or_addr.loa = LOA_LINE;
+  cur_line_no = start_line_or_addr.u.line_no = line_no;
+
+  const char *iter = srclines.c_str ();
+  content.resize (nlines);
+  while (cur_line < nlines)
     {
-      int line_width, nlines;
+      struct tui_source_element *element
+	= &content[cur_line];
 
-      ret = TUI_SUCCESS;
-      line_width = width - TUI_EXECINFO_SIZE - 1;
-      /* Take hilite (window border) into account, when
-	 calculating the number of lines.  */
-      nlines = (line_no + (height - 2)) - line_no;
+      std::string text;
+      if (*iter != '\0')
+	text = tui_copy_source_line (&iter, cur_line_no,
+				     horizontal_offset,
+				     line_width);
 
-      std::string srclines;
-      if (!g_source_cache.get_source_lines (s, line_no, line_no + nlines,
-					    &srclines))
-	ret = TUI_FAILURE;
-      else
-	{
-	  int cur_line_no, cur_line;
-	  struct tui_locator_window *locator
-	    = tui_locator_win_info_ptr ();
-	  const char *s_filename = symtab_to_filename_for_display (s);
+      /* Set whether element is the execution point
+	 and whether there is a break point on it.  */
+      element->line_or_addr.loa = LOA_LINE;
+      element->line_or_addr.u.line_no = cur_line_no;
+      element->is_exec_point
+	= (filename_cmp (locator->full_name.c_str (),
+			 symtab_to_fullname (s)) == 0
+	   && cur_line_no == locator->line_no);
 
-	  title = s_filename;
+      content[cur_line].line = std::move (text);
 
-	  m_fullname = make_unique_xstrdup (symtab_to_fullname (s));
-
-	  cur_line = 0;
-	  gdbarch = get_objfile_arch (SYMTAB_OBJFILE (s));
-	  start_line_or_addr.loa = LOA_LINE;
-	  cur_line_no = start_line_or_addr.u.line_no = line_no;
-
-	  const char *iter = srclines.c_str ();
-	  content.resize (nlines);
-	  while (cur_line < nlines)
-	    {
-	      struct tui_source_element *element
-		= &content[cur_line];
-
-	      std::string text;
-	      if (*iter != '\0')
-		text = tui_copy_source_line (&iter, cur_line_no,
-					     horizontal_offset,
-					     line_width);
-
-	      /* Set whether element is the execution point
-		 and whether there is a break point on it.  */
-	      element->line_or_addr.loa = LOA_LINE;
-	      element->line_or_addr.u.line_no = cur_line_no;
-	      element->is_exec_point
-		= (filename_cmp (locator->full_name.c_str (),
-				 symtab_to_fullname (s)) == 0
-		   && cur_line_no == locator->line_no);
-
-	      content[cur_line].line = std::move (text);
-
-	      cur_line++;
-	      cur_line_no++;
-	    }
-	  ret = TUI_SUCCESS;
-	}
+      cur_line++;
+      cur_line_no++;
     }
-  return ret;
+
+  return true;
 }
 
 
diff --git a/gdb/tui/tui-source.h b/gdb/tui/tui-source.h
index a573ce4..36515e7 100644
--- a/gdb/tui/tui-source.h
+++ b/gdb/tui/tui-source.h
@@ -60,10 +60,9 @@ 
 
   void do_scroll_vertical (int num_to_scroll) override;
 
-  enum tui_status set_contents
-    (struct gdbarch *gdbarch,
-     struct symtab *s,
-     struct tui_line_or_address line_or_addr) override;
+  bool set_contents (struct gdbarch *gdbarch,
+		     struct symtab *s,
+		     struct tui_line_or_address line_or_addr) override;
 
 private:
 
diff --git a/gdb/tui/tui-winsource.c b/gdb/tui/tui-winsource.c
index ce4e655..9126f7b 100644
--- a/gdb/tui/tui-winsource.c
+++ b/gdb/tui/tui-winsource.c
@@ -176,10 +176,9 @@ 
    struct symtab *s,
    struct tui_line_or_address line_or_addr)
 {
-  enum tui_status ret
-    = set_contents (gdbarch, s, line_or_addr);
+  bool ret = set_contents (gdbarch, s, line_or_addr);
 
-  if (ret == TUI_FAILURE)
+  if (!ret)
     erase_source_content ();
   else
     {
diff --git a/gdb/tui/tui-winsource.h b/gdb/tui/tui-winsource.h
index cde024d..830b547 100644
--- a/gdb/tui/tui-winsource.h
+++ b/gdb/tui/tui-winsource.h
@@ -87,10 +87,9 @@ 
 
   void rerender () override;
 
-  virtual enum tui_status set_contents
-    (struct gdbarch *gdbarch,
-     struct symtab *s,
-     struct tui_line_or_address line_or_addr) = 0;
+  virtual bool set_contents (struct gdbarch *gdbarch,
+			     struct symtab *s,
+			     struct tui_line_or_address line_or_addr) = 0;
 
 public: