aboutsummaryrefslogtreecommitdiff
path: root/gdb/python/py-ref.h
blob: f0e4aae9f317bb857131a3120cc5917f4a9e8e91 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
/* Python reference-holding class

   Copyright (C) 2016 Free Software Foundation, Inc.

   This file is part of GDB.

   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 3 of the License, or
   (at your option) any later version.

   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with this program.  If not, see <http://www.gnu.org/licenses/>.  */

#ifndef GDB_PYTHON_REF_H
#define GDB_PYTHON_REF_H

/* An instance of this class either holds a reference to a PyObject,
   or is "NULL".  If it holds a reference, then when the object is
   destroyed, the PyObject is decref'd.

   Normally an instance is constructed using a PyObject*.  This sort
   of initialization lets this class manage the lifetime of that
   reference.

   Assignment and copy construction will make a new reference as
   appropriate.  Assignment from a plain PyObject* is disallowed to
   avoid confusion about whether this acquires a new reference;
   instead use the "reset" method -- which, like the PyObject*
   constructor, transfers ownership.
*/
class gdbpy_ref
{
 public:

  /* Create a new NULL instance.  */
  gdbpy_ref ()
    : m_obj (NULL)
  {
  }

  /* Create a new instance.  OBJ is a reference, management of which
     is now transferred to this class.  */
  explicit gdbpy_ref (PyObject *obj)
    : m_obj (obj)
  {
  }

  /* Copy another instance.  */
  gdbpy_ref (const gdbpy_ref &other)
    : m_obj (other.m_obj)
  {
    Py_XINCREF (m_obj);
  }

  /* Transfer ownership from OTHER.  */
  gdbpy_ref (gdbpy_ref &&other)
    : m_obj (other.m_obj)
  {
    other.m_obj = NULL;
  }

  /* Destroy this instance.  */
  ~gdbpy_ref ()
  {
    Py_XDECREF (m_obj);
  }

  /* Copy another instance.  */
  gdbpy_ref &operator= (const gdbpy_ref &other)
  {
    /* Do nothing on self-assignment.  */
    if (this != &other)
      {
	reset (other.m_obj);
	Py_XINCREF (m_obj);
      }
    return *this;
  }

  /* Transfer ownership from OTHER.  */
  gdbpy_ref &operator= (gdbpy_ref &&other)
  {
    /* Do nothing on self-assignment.  */
    if (this != &other)
      {
	reset (other.m_obj);
	other.m_obj = NULL;
      }
    return *this;
  }

  /* Change this instance's referent.  OBJ is a reference, management
     of which is now transferred to this class.  */
  void reset (PyObject *obj)
  {
    Py_XDECREF (m_obj);
    m_obj = obj;
  }

  /* Return this instance's referent.  In Python terms this is a
     borrowed pointer.  */
  PyObject *get () const
  {
    return m_obj;
  }

  /* Return this instance's referent, and stop managing this
     reference.  The caller is now responsible for the ownership of
     the reference.  */
  PyObject *release ()
  {
    PyObject *result = m_obj;

    m_obj = NULL;
    return result;
  }

 private:

  PyObject *m_obj;
};

inline bool operator== (const gdbpy_ref &self, const gdbpy_ref &other)
{
  return self.get () == other.get ();
}

inline bool operator== (const gdbpy_ref &self, const PyObject *other)
{
  return self.get () == other;
}

inline bool operator== (const PyObject *self, const gdbpy_ref &other)
{
  return self == other.get ();
}

inline bool operator!= (const gdbpy_ref &self, const gdbpy_ref &other)
{
  return self.get () != other.get ();
}

inline bool operator!= (const gdbpy_ref &self, const PyObject *other)
{
  return self.get () != other;
}

inline bool operator!= (const PyObject *self, const gdbpy_ref &other)
{
  return self != other.get ();
}

#endif /* GDB_PYTHON_REF_H */