1 /* Python interface to objfiles.
3 Copyright (C) 2008-2014 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. */
36 /* The frame filter list of functions. */
37 PyObject
*frame_filters
;
38 /* The type-printer list. */
39 PyObject
*type_printers
;
41 /* The debug method matcher list. */
45 static PyTypeObject objfile_object_type
46 CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF ("objfile_object");
48 static const struct objfile_data
*objfpy_objfile_data_key
;
52 /* An Objfile method which returns the objfile's file name, or None. */
54 objfpy_get_filename (PyObject
*self
, void *closure
)
56 objfile_object
*obj
= (objfile_object
*) self
;
59 return PyString_Decode (objfile_name (obj
->objfile
),
60 strlen (objfile_name (obj
->objfile
)),
61 host_charset (), NULL
);
66 objfpy_dealloc (PyObject
*o
)
68 objfile_object
*self
= (objfile_object
*) o
;
70 Py_XDECREF (self
->printers
);
71 Py_XDECREF (self
->frame_filters
);
72 Py_XDECREF (self
->type_printers
);
73 Py_XDECREF (self
->xmethods
);
74 Py_TYPE (self
)->tp_free (self
);
78 objfpy_new (PyTypeObject
*type
, PyObject
*args
, PyObject
*keywords
)
80 objfile_object
*self
= (objfile_object
*) type
->tp_alloc (type
, 0);
86 self
->printers
= PyList_New (0);
93 self
->frame_filters
= PyDict_New ();
94 if (!self
->frame_filters
)
100 self
->type_printers
= PyList_New (0);
101 if (!self
->type_printers
)
107 self
->xmethods
= PyList_New (0);
108 if (self
->xmethods
== NULL
)
114 return (PyObject
*) self
;
118 objfpy_get_printers (PyObject
*o
, void *ignore
)
120 objfile_object
*self
= (objfile_object
*) o
;
122 Py_INCREF (self
->printers
);
123 return self
->printers
;
127 objfpy_set_printers (PyObject
*o
, PyObject
*value
, void *ignore
)
130 objfile_object
*self
= (objfile_object
*) o
;
134 PyErr_SetString (PyExc_TypeError
,
135 _("Cannot delete the pretty_printers attribute."));
139 if (! PyList_Check (value
))
141 PyErr_SetString (PyExc_TypeError
,
142 _("The pretty_printers attribute must be a list."));
146 /* Take care in case the LHS and RHS are related somehow. */
147 tmp
= self
->printers
;
149 self
->printers
= value
;
155 /* Return the Python dictionary attribute containing frame filters for
158 objfpy_get_frame_filters (PyObject
*o
, void *ignore
)
160 objfile_object
*self
= (objfile_object
*) o
;
162 Py_INCREF (self
->frame_filters
);
163 return self
->frame_filters
;
166 /* Set this object file's frame filters dictionary to FILTERS. */
168 objfpy_set_frame_filters (PyObject
*o
, PyObject
*filters
, void *ignore
)
171 objfile_object
*self
= (objfile_object
*) o
;
175 PyErr_SetString (PyExc_TypeError
,
176 _("Cannot delete the frame filters attribute."));
180 if (! PyDict_Check (filters
))
182 PyErr_SetString (PyExc_TypeError
,
183 _("The frame_filters attribute must be a dictionary."));
187 /* Take care in case the LHS and RHS are related somehow. */
188 tmp
= self
->frame_filters
;
190 self
->frame_filters
= filters
;
196 /* Get the 'type_printers' attribute. */
199 objfpy_get_type_printers (PyObject
*o
, void *ignore
)
201 objfile_object
*self
= (objfile_object
*) o
;
203 Py_INCREF (self
->type_printers
);
204 return self
->type_printers
;
207 /* Get the 'xmethods' attribute. */
210 objfpy_get_xmethods (PyObject
*o
, void *ignore
)
212 objfile_object
*self
= (objfile_object
*) o
;
214 Py_INCREF (self
->xmethods
);
215 return self
->xmethods
;
218 /* Set the 'type_printers' attribute. */
221 objfpy_set_type_printers (PyObject
*o
, PyObject
*value
, void *ignore
)
224 objfile_object
*self
= (objfile_object
*) o
;
228 PyErr_SetString (PyExc_TypeError
,
229 _("Cannot delete the type_printers attribute."));
233 if (! PyList_Check (value
))
235 PyErr_SetString (PyExc_TypeError
,
236 _("The type_printers attribute must be a list."));
240 /* Take care in case the LHS and RHS are related somehow. */
241 tmp
= self
->type_printers
;
243 self
->type_printers
= value
;
249 /* Implementation of gdb.Objfile.is_valid (self) -> Boolean.
250 Returns True if this object file still exists in GDB. */
253 objfpy_is_valid (PyObject
*self
, PyObject
*args
)
255 objfile_object
*obj
= (objfile_object
*) self
;
265 /* Clear the OBJFILE pointer in an Objfile object and remove the
268 py_free_objfile (struct objfile
*objfile
, void *datum
)
270 struct cleanup
*cleanup
;
271 objfile_object
*object
= datum
;
273 cleanup
= ensure_python_env (get_objfile_arch (objfile
), current_language
);
274 object
->objfile
= NULL
;
275 Py_DECREF ((PyObject
*) object
);
276 do_cleanups (cleanup
);
279 /* Return a borrowed reference to the Python object of type Objfile
280 representing OBJFILE. If the object has already been created,
281 return it. Otherwise, create it. Return NULL and set the Python
284 objfile_to_objfile_object (struct objfile
*objfile
)
286 objfile_object
*object
;
288 object
= objfile_data (objfile
, objfpy_objfile_data_key
);
291 object
= PyObject_New (objfile_object
, &objfile_object_type
);
294 object
->objfile
= objfile
;
296 object
->printers
= PyList_New (0);
297 if (!object
->printers
)
303 object
->frame_filters
= PyDict_New ();
304 if (!object
->frame_filters
)
310 object
->type_printers
= PyList_New (0);
311 if (!object
->type_printers
)
317 object
->xmethods
= PyList_New (0);
318 if (object
->xmethods
== NULL
)
324 set_objfile_data (objfile
, objfpy_objfile_data_key
, object
);
328 return (PyObject
*) object
;
332 gdbpy_initialize_objfile (void)
334 objfpy_objfile_data_key
335 = register_objfile_data_with_cleanup (NULL
, py_free_objfile
);
337 if (PyType_Ready (&objfile_object_type
) < 0)
340 return gdb_pymodule_addobject (gdb_module
, "Objfile",
341 (PyObject
*) &objfile_object_type
);
346 static PyMethodDef objfile_object_methods
[] =
348 { "is_valid", objfpy_is_valid
, METH_NOARGS
,
349 "is_valid () -> Boolean.\n\
350 Return true if this object file is valid, false if not." },
355 static PyGetSetDef objfile_getset
[] =
357 { "filename", objfpy_get_filename
, NULL
,
358 "The objfile's filename, or None.", NULL
},
359 { "pretty_printers", objfpy_get_printers
, objfpy_set_printers
,
360 "Pretty printers.", NULL
},
361 { "frame_filters", objfpy_get_frame_filters
,
362 objfpy_set_frame_filters
, "Frame Filters.", NULL
},
363 { "type_printers", objfpy_get_type_printers
, objfpy_set_type_printers
,
364 "Type printers.", NULL
},
365 { "xmethods", objfpy_get_xmethods
, NULL
,
366 "Debug methods.", NULL
},
370 static PyTypeObject objfile_object_type
=
372 PyVarObject_HEAD_INIT (NULL
, 0)
373 "gdb.Objfile", /*tp_name*/
374 sizeof (objfile_object
), /*tp_basicsize*/
376 objfpy_dealloc
, /*tp_dealloc*/
383 0, /*tp_as_sequence*/
391 Py_TPFLAGS_DEFAULT
, /*tp_flags*/
392 "GDB objfile object", /* tp_doc */
395 0, /* tp_richcompare */
396 0, /* tp_weaklistoffset */
399 objfile_object_methods
, /* tp_methods */
401 objfile_getset
, /* tp_getset */
404 0, /* tp_descr_get */
405 0, /* tp_descr_set */
406 0, /* tp_dictoffset */
409 objfpy_new
, /* tp_new */