Return gdbpy_ref<> from symbol_to_symbol_object

This changes symbol_to_symbol_object to return a gdbpy_ref<>,
using the type system to convey that a new reference is always
returned.

Approved-By: Simon Marchi <simon.marchi@efficios.com>

8 files changed, 32 insertions, 39 deletions

diff --git a/gdb/python/py-block.c b/gdb/python/py-block.c
index bebbb32d844..718aca17829 100644
--- a/gdb/python/py-block.c
+++ b/gdb/python/py-block.c
@@ -127,7 +127,7 @@ blpy_get_function (PyObject *self, void *closure)
 
   sym = block->function ();
   if (sym)
-    return symbol_to_symbol_object (sym);
+    return symbol_to_symbol_object (sym).release ();
 
   Py_RETURN_NONE;
 }
@@ -274,7 +274,7 @@ blpy_getitem (PyObject *self, PyObject *key)
   for (struct symbol *sym : block_iterator_range (block, &lookup_name))
     {
       /* Just stop at the first match */
-      return symbol_to_symbol_object (sym);
+      return symbol_to_symbol_object (sym).release ();
     }
 
   PyErr_SetObject (PyExc_KeyError, key);
@@ -412,7 +412,7 @@ blpy_block_syms_iternext (PyObject *self)
       return NULL;
     }
 
-  return symbol_to_symbol_object (sym);
+  return symbol_to_symbol_object (sym).release ();
 }
 
 static void
diff --git a/gdb/python/py-finishbreakpoint.c b/gdb/python/py-finishbreakpoint.c
index 14e9f18c863..43dffd64adc 100644
--- a/gdb/python/py-finishbreakpoint.c
+++ b/gdb/python/py-finishbreakpoint.c
@@ -268,7 +268,7 @@ bpfinishpy_init (PyObject *self, PyObject *args, PyObject *kwargs)
 		  PyErr_Clear ();
 
 		  self_bpfinish->func_symbol
-		    = symbol_to_symbol_object (function);
+		    = symbol_to_symbol_object (function).release ();
 		  PyErr_Clear ();
 		}
 	    }
diff --git a/gdb/python/py-frame.c b/gdb/python/py-frame.c
index 65a6ec669dd..90571d76d8c 100644
--- a/gdb/python/py-frame.c
+++ b/gdb/python/py-frame.c
@@ -351,7 +351,7 @@ frapy_function (PyObject *self, PyObject *args)
     }
 
   if (sym)
-    return symbol_to_symbol_object (sym);
+    return symbol_to_symbol_object (sym).release ();
 
   Py_RETURN_NONE;
 }
diff --git a/gdb/python/py-objfile.c b/gdb/python/py-objfile.c
index 36acdb06a25..16584f7c8f8 100644
--- a/gdb/python/py-objfile.c
+++ b/gdb/python/py-objfile.c
@@ -477,7 +477,7 @@ objfpy_lookup_global_symbol (PyObject *self, PyObject *args, PyObject *kw)
       if (sym == nullptr)
 	Py_RETURN_NONE;
 
-      return symbol_to_symbol_object (sym);
+      return symbol_to_symbol_object (sym).release ();
     }
   catch (const gdb_exception &except)
     {
@@ -512,7 +512,7 @@ objfpy_lookup_static_symbol (PyObject *self, PyObject *args, PyObject *kw)
       if (sym == nullptr)
 	Py_RETURN_NONE;
 
-      return symbol_to_symbol_object (sym);
+      return symbol_to_symbol_object (sym).release ();
     }
   catch (const gdb_exception &except)
     {
diff --git a/gdb/python/py-record-btrace.c b/gdb/python/py-record-btrace.c
index 90d9ecd95a8..1974dd3e939 100644
--- a/gdb/python/py-record-btrace.c
+++ b/gdb/python/py-record-btrace.c
@@ -354,7 +354,7 @@ recpy_bt_func_symbol (PyObject *self, void *closure)
   if (func->sym == NULL)
     Py_RETURN_NONE;
 
-  return symbol_to_symbol_object (func->sym);
+  return symbol_to_symbol_object (func->sym).release ();
 }
 
 /* Implementation of RecordFunctionSegment.instructions [list] for btrace.
diff --git a/gdb/python/py-symbol.c b/gdb/python/py-symbol.c
index 736774bd94f..d51f4823315 100644
--- a/gdb/python/py-symbol.c
+++ b/gdb/python/py-symbol.c
@@ -336,7 +336,7 @@ set_symbol (symbol_object *obj, struct symbol *symbol)
 
 /* Create a new symbol object (gdb.Symbol) that encapsulates the struct
    symbol object from GDB.  */
-PyObject *
+gdbpy_ref<>
 symbol_to_symbol_object (struct symbol *sym)
 {
   symbol_object *sym_obj;
@@ -348,13 +348,13 @@ symbol_to_symbol_object (struct symbol *sym)
   else
     sym_obj = sympy_registry.lookup (sym->arch (), sym);
   if (sym_obj != nullptr)
-    return (PyObject*)sym_obj;
+    return gdbpy_ref<> (sym_obj);
 
   sym_obj = PyObject_New (symbol_object, &symbol_object_type);
   if (sym_obj)
     set_symbol (sym_obj, sym);
 
-  return (PyObject *) sym_obj;
+  return gdbpy_ref<> (sym_obj);
 }
 
 /* Return the symbol that is wrapped by this symbol object.  */
@@ -409,7 +409,7 @@ gdbpy_lookup_symbol (PyObject *self, PyObject *args, PyObject *kw)
   const char *name;
   static const char *keywords[] = { "name", "block", "domain", NULL };
   struct symbol *symbol = NULL;
-  PyObject *block_obj = NULL, *sym_obj, *bool_obj;
+  PyObject *block_obj = NULL, *bool_obj;
   const struct block *block = NULL;
 
   if (!gdb_PyArg_ParseTupleAndKeywords (args, kw, "s|O!i", keywords, &name,
@@ -448,18 +448,16 @@ gdbpy_lookup_symbol (PyObject *self, PyObject *args, PyObject *kw)
   if (ret_tuple == NULL)
     return NULL;
 
+  gdbpy_ref<> sym_obj;
   if (symbol)
     {
       sym_obj = symbol_to_symbol_object (symbol);
-      if (!sym_obj)
-	return NULL;
+      if (sym_obj == nullptr)
+	return nullptr;
     }
   else
-    {
-      sym_obj = Py_None;
-      Py_INCREF (Py_None);
-    }
-  PyTuple_SET_ITEM (ret_tuple.get (), 0, sym_obj);
+    sym_obj = gdbpy_ref<>::new_reference (Py_None);
+  PyTuple_SET_ITEM (ret_tuple.get (), 0, sym_obj.release ());
 
   bool_obj = PyBool_FromLong (is_a_field_of_this.type != NULL);
   PyTuple_SET_ITEM (ret_tuple.get (), 1, bool_obj);
@@ -477,7 +475,6 @@ gdbpy_lookup_global_symbol (PyObject *self, PyObject *args, PyObject *kw)
   const char *name;
   static const char *keywords[] = { "name", "domain", NULL };
   struct symbol *symbol = NULL;
-  PyObject *sym_obj;
 
   if (!gdb_PyArg_ParseTupleAndKeywords (args, kw, "s|i", keywords, &name,
 					&domain))
@@ -493,19 +490,17 @@ gdbpy_lookup_global_symbol (PyObject *self, PyObject *args, PyObject *kw)
       return gdbpy_handle_gdb_exception (nullptr, except);
     }
 
+  gdbpy_ref<> sym_obj;
   if (symbol)
     {
       sym_obj = symbol_to_symbol_object (symbol);
-      if (!sym_obj)
-	return NULL;
+      if (sym_obj == nullptr)
+	return nullptr;
     }
   else
-    {
-      sym_obj = Py_None;
-      Py_INCREF (Py_None);
-    }
+    sym_obj = gdbpy_ref<>::new_reference (Py_None);
 
-  return sym_obj;
+  return sym_obj.release ();
 }
 
 /* Implementation of
@@ -518,7 +513,6 @@ gdbpy_lookup_static_symbol (PyObject *self, PyObject *args, PyObject *kw)
   int domain = VAR_DOMAIN;
   static const char *keywords[] = { "name", "domain", NULL };
   struct symbol *symbol = NULL;
-  PyObject *sym_obj;
 
   if (!gdb_PyArg_ParseTupleAndKeywords (args, kw, "s|i", keywords, &name,
 					&domain))
@@ -561,19 +555,17 @@ gdbpy_lookup_static_symbol (PyObject *self, PyObject *args, PyObject *kw)
       return gdbpy_handle_gdb_exception (nullptr, except);
     }
 
+  gdbpy_ref<> sym_obj;
   if (symbol)
     {
       sym_obj = symbol_to_symbol_object (symbol);
-      if (!sym_obj)
-	return NULL;
+      if (sym_obj == nullptr)
+	return nullptr;
     }
   else
-    {
-      sym_obj = Py_None;
-      Py_INCREF (Py_None);
-    }
+    sym_obj = gdbpy_ref<>::new_reference (Py_None);
 
-  return sym_obj;
+  return sym_obj.release ();
 }
 
 /* Implementation of
@@ -622,9 +614,10 @@ gdbpy_lookup_static_symbols (PyObject *self, PyObject *args, PyObject *kw)
 
 		  if (symbol != nullptr)
 		    {
-		      PyObject *sym_obj = symbol_to_symbol_object (symbol);
+		      gdbpy_ref<> sym_obj = symbol_to_symbol_object (symbol);
 		      if (sym_obj == nullptr
-			  || PyList_Append (return_list.get (), sym_obj) == -1)
+			  || PyList_Append (return_list.get (),
+					    sym_obj.get ()) == -1)
 			return false;
 		    }
 		}
diff --git a/gdb/python/py-unwind.c b/gdb/python/py-unwind.c
index c50df8377f9..110b010913c 100644
--- a/gdb/python/py-unwind.c
+++ b/gdb/python/py-unwind.c
@@ -692,7 +692,7 @@ pending_framepy_function (PyObject *self, PyObject *args)
     }
 
   if (sym != nullptr)
-    return symbol_to_symbol_object (sym);
+    return symbol_to_symbol_object (sym).release ();
 
   Py_RETURN_NONE;
 }
diff --git a/gdb/python/python-internal.h b/gdb/python/python-internal.h
index feabf270464..979bf2498da 100644
--- a/gdb/python/python-internal.h
+++ b/gdb/python/python-internal.h
@@ -497,7 +497,7 @@ PyObject *gdbpy_register_tui_window (PyObject *self, PyObject *args,
 
 gdbpy_ref<> symtab_and_line_to_sal_object (struct symtab_and_line sal);
 PyObject *symtab_to_symtab_object (struct symtab *symtab);
-PyObject *symbol_to_symbol_object (struct symbol *sym);
+gdbpy_ref<> symbol_to_symbol_object (struct symbol *sym);
 PyObject *block_to_block_object (const struct block *block,
 				 struct objfile *objfile);
 PyObject *value_to_value_object (struct value *v);