1 /* Python interface to objfiles.
3 Copyright (C) 2008-2012 Free Software Foundation, Inc.
5 This file is part of GDB.
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.
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.
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/>. */
21 #include "python-internal.h"
30 /* The corresponding objfile. */
31 struct objfile *objfile;
33 /* The pretty-printer list of functions. */
37 static PyTypeObject objfile_object_type;
39 static const struct objfile_data *objfpy_objfile_data_key;
43 /* An Objfile method which returns the objfile's file name, or None. */
45 objfpy_get_filename (PyObject *self, void *closure)
47 objfile_object *obj = (objfile_object *) self;
50 return PyString_Decode (obj->objfile->name, strlen (obj->objfile->name),
51 host_charset (), NULL);
56 objfpy_dealloc (PyObject *o)
58 objfile_object *self = (objfile_object *) o;
60 Py_XDECREF (self->printers);
61 self->ob_type->tp_free ((PyObject *) self);
65 objfpy_new (PyTypeObject *type, PyObject *args, PyObject *keywords)
67 objfile_object *self = (objfile_object *) type->tp_alloc (type, 0);
73 self->printers = PyList_New (0);
80 return (PyObject *) self;
84 objfpy_get_printers (PyObject *o, void *ignore)
86 objfile_object *self = (objfile_object *) o;
88 Py_INCREF (self->printers);
89 return self->printers;
93 objfpy_set_printers (PyObject *o, PyObject *value, void *ignore)
96 objfile_object *self = (objfile_object *) o;
100 PyErr_SetString (PyExc_TypeError,
101 _("Cannot delete the pretty_printers attribute."));
105 if (! PyList_Check (value))
107 PyErr_SetString (PyExc_TypeError,
108 _("The pretty_printers attribute must be a list."));
112 /* Take care in case the LHS and RHS are related somehow. */
113 tmp = self->printers;
115 self->printers = value;
121 /* Implementation of gdb.Objfile.is_valid (self) -> Boolean.
122 Returns True if this object file still exists in GDB. */
125 objfpy_is_valid (PyObject *self, PyObject *args)
127 objfile_object *obj = (objfile_object *) self;
137 /* Clear the OBJFILE pointer in an Objfile object and remove the
140 py_free_objfile (struct objfile *objfile, void *datum)
142 struct cleanup *cleanup;
143 objfile_object *object = datum;
145 cleanup = ensure_python_env (get_objfile_arch (objfile), current_language);
146 object->objfile = NULL;
147 Py_DECREF ((PyObject *) object);
148 do_cleanups (cleanup);
151 /* Return a borrowed reference to the Python object of type Objfile
152 representing OBJFILE. If the object has already been created,
153 return it. Otherwise, create it. Return NULL and set the Python
156 objfile_to_objfile_object (struct objfile *objfile)
158 objfile_object *object;
160 object = objfile_data (objfile, objfpy_objfile_data_key);
163 object = PyObject_New (objfile_object, &objfile_object_type);
166 object->objfile = objfile;
168 object->printers = PyList_New (0);
169 if (!object->printers)
175 set_objfile_data (objfile, objfpy_objfile_data_key, object);
179 return (PyObject *) object;
183 gdbpy_initialize_objfile (void)
185 objfpy_objfile_data_key
186 = register_objfile_data_with_cleanup (NULL, py_free_objfile);
188 if (PyType_Ready (&objfile_object_type) < 0)
191 Py_INCREF (&objfile_object_type);
192 PyModule_AddObject (gdb_module, "Objfile",
193 (PyObject *) &objfile_object_type);
198 static PyMethodDef objfile_object_methods[] =
200 { "is_valid", objfpy_is_valid, METH_NOARGS,
201 "is_valid () -> Boolean.\n\
202 Return true if this object file is valid, false if not." },
207 static PyGetSetDef objfile_getset[] =
209 { "filename", objfpy_get_filename, NULL,
210 "The objfile's filename, or None.", NULL },
211 { "pretty_printers", objfpy_get_printers, objfpy_set_printers,
212 "Pretty printers.", NULL },
216 static PyTypeObject objfile_object_type =
218 PyObject_HEAD_INIT (NULL)
220 "gdb.Objfile", /*tp_name*/
221 sizeof (objfile_object), /*tp_basicsize*/
223 objfpy_dealloc, /*tp_dealloc*/
230 0, /*tp_as_sequence*/
238 Py_TPFLAGS_DEFAULT, /*tp_flags*/
239 "GDB objfile object", /* tp_doc */
242 0, /* tp_richcompare */
243 0, /* tp_weaklistoffset */
246 objfile_object_methods, /* tp_methods */
248 objfile_getset, /* tp_getset */
251 0, /* tp_descr_get */
252 0, /* tp_descr_set */
253 0, /* tp_dictoffset */
256 objfpy_new, /* tp_new */