[deliverable/binutils-gdb.git] / gdb / python / py-ref.h

/* Python reference-holding class

   Copyright (C) 2016-2018 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

#include "common/gdb_ref_ptr.h"

/* A policy class for gdb::ref_ptr for Python reference counting.  */
template<typename T>
struct gdbpy_ref_policy
{
  static void incref (T *ptr)
  {
    Py_INCREF (ptr);
  }

  static void decref (T *ptr)
  {
    Py_DECREF (ptr);
  }
};

/* A gdb::ref_ptr that has been specialized for Python objects or
   their "subclasses".  */
template<typename T = PyObject> using gdbpy_ref
  = gdb::ref_ptr<T, gdbpy_ref_policy<T>>;

#endif /* GDB_PYTHON_REF_H */
Commit	Line	Data
	1	/* Python reference-holding class
	2
	3	Copyright (C) 2016-2018 Free Software Foundation, Inc.
	4
	5	This file is part of GDB.
	6
	7	This program is free software; you can redistribute it and/or modify
	8	it under the terms of the GNU General Public License as published by
	9	the Free Software Foundation; either version 3 of the License, or
	10	(at your option) any later version.
	11
	12	This program is distributed in the hope that it will be useful,
	13	but WITHOUT ANY WARRANTY; without even the implied warranty of
	14	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	15	GNU General Public License for more details.
	16
	17	You should have received a copy of the GNU General Public License
	18	along with this program. If not, see <http://www.gnu.org/licenses/>. */
	19
	20	#ifndef GDB_PYTHON_REF_H
	21	#define GDB_PYTHON_REF_H
	22
	23	#include "common/gdb_ref_ptr.h"
	24
	25	/* A policy class for gdb::ref_ptr for Python reference counting. */
	26	template<typename T>
	27	struct gdbpy_ref_policy
	28	{
	29	static void incref (T *ptr)
	30	{
	31	Py_INCREF (ptr);
	32	}
	33
	34	static void decref (T *ptr)
	35	{
	36	Py_DECREF (ptr);
	37	}
	38	};
	39
	40	/* A gdb::ref_ptr that has been specialized for Python objects or
	41	their "subclasses". */
	42	template<typename T = PyObject> using gdbpy_ref
	43	= gdb::ref_ptr<T, gdbpy_ref_policy<T>>;
	44
	45	#endif /* GDB_PYTHON_REF_H */