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
);
77 /* Initialize an objfile_object.
78 The result is a boolean indicating success. */
81 objfpy_initialize (objfile_object
*self
)
85 self
->printers
= PyList_New (0);
86 if (self
->printers
== NULL
)
89 self
->frame_filters
= PyDict_New ();
90 if (self
->frame_filters
== NULL
)
93 self
->type_printers
= PyList_New (0);
94 if (self
->type_printers
== NULL
)
97 self
->xmethods
= PyList_New (0);
98 if (self
->xmethods
== NULL
)
105 objfpy_new (PyTypeObject
*type
, PyObject
*args
, PyObject
*keywords
)
107 objfile_object
*self
= (objfile_object
*) type
->tp_alloc (type
, 0);
111 if (!objfpy_initialize (self
))
118 return (PyObject
*) self
;
122 objfpy_get_printers (PyObject
*o
, void *ignore
)
124 objfile_object
*self
= (objfile_object
*) o
;
126 Py_INCREF (self
->printers
);
127 return self
->printers
;
131 objfpy_set_printers (PyObject
*o
, PyObject
*value
, void *ignore
)
134 objfile_object
*self
= (objfile_object
*) o
;
138 PyErr_SetString (PyExc_TypeError
,
139 _("Cannot delete the pretty_printers attribute."));
143 if (! PyList_Check (value
))
145 PyErr_SetString (PyExc_TypeError
,
146 _("The pretty_printers attribute must be a list."));
150 /* Take care in case the LHS and RHS are related somehow. */
151 tmp
= self
->printers
;
153 self
->printers
= value
;
159 /* Return the Python dictionary attribute containing frame filters for
162 objfpy_get_frame_filters (PyObject
*o
, void *ignore
)
164 objfile_object
*self
= (objfile_object
*) o
;
166 Py_INCREF (self
->frame_filters
);
167 return self
->frame_filters
;
170 /* Set this object file's frame filters dictionary to FILTERS. */
172 objfpy_set_frame_filters (PyObject
*o
, PyObject
*filters
, void *ignore
)
175 objfile_object
*self
= (objfile_object
*) o
;
179 PyErr_SetString (PyExc_TypeError
,
180 _("Cannot delete the frame filters attribute."));
184 if (! PyDict_Check (filters
))
186 PyErr_SetString (PyExc_TypeError
,
187 _("The frame_filters attribute must be a dictionary."));
191 /* Take care in case the LHS and RHS are related somehow. */
192 tmp
= self
->frame_filters
;
194 self
->frame_filters
= filters
;
200 /* Get the 'type_printers' attribute. */
203 objfpy_get_type_printers (PyObject
*o
, void *ignore
)
205 objfile_object
*self
= (objfile_object
*) o
;
207 Py_INCREF (self
->type_printers
);
208 return self
->type_printers
;
211 /* Get the 'xmethods' attribute. */
214 objfpy_get_xmethods (PyObject
*o
, void *ignore
)
216 objfile_object
*self
= (objfile_object
*) o
;
218 Py_INCREF (self
->xmethods
);
219 return self
->xmethods
;
222 /* Set the 'type_printers' attribute. */
225 objfpy_set_type_printers (PyObject
*o
, PyObject
*value
, void *ignore
)
228 objfile_object
*self
= (objfile_object
*) o
;
232 PyErr_SetString (PyExc_TypeError
,
233 _("Cannot delete the type_printers attribute."));
237 if (! PyList_Check (value
))
239 PyErr_SetString (PyExc_TypeError
,
240 _("The type_printers attribute must be a list."));
244 /* Take care in case the LHS and RHS are related somehow. */
245 tmp
= self
->type_printers
;
247 self
->type_printers
= value
;
253 /* Implementation of gdb.Objfile.is_valid (self) -> Boolean.
254 Returns True if this object file still exists in GDB. */
257 objfpy_is_valid (PyObject
*self
, PyObject
*args
)
259 objfile_object
*obj
= (objfile_object
*) self
;
269 /* Clear the OBJFILE pointer in an Objfile object and remove the
272 py_free_objfile (struct objfile
*objfile
, void *datum
)
274 struct cleanup
*cleanup
;
275 objfile_object
*object
= datum
;
277 cleanup
= ensure_python_env (get_objfile_arch (objfile
), current_language
);
278 object
->objfile
= NULL
;
279 Py_DECREF ((PyObject
*) object
);
280 do_cleanups (cleanup
);
283 /* Return a borrowed reference to the Python object of type Objfile
284 representing OBJFILE. If the object has already been created,
285 return it. Otherwise, create it. Return NULL and set the Python
289 objfile_to_objfile_object (struct objfile
*objfile
)
291 objfile_object
*object
;
293 object
= objfile_data (objfile
, objfpy_objfile_data_key
);
296 object
= PyObject_New (objfile_object
, &objfile_object_type
);
299 if (!objfpy_initialize (object
))
305 object
->objfile
= objfile
;
306 set_objfile_data (objfile
, objfpy_objfile_data_key
, object
);
310 return (PyObject
*) object
;
314 gdbpy_initialize_objfile (void)
316 objfpy_objfile_data_key
317 = register_objfile_data_with_cleanup (NULL
, py_free_objfile
);
319 if (PyType_Ready (&objfile_object_type
) < 0)
322 return gdb_pymodule_addobject (gdb_module
, "Objfile",
323 (PyObject
*) &objfile_object_type
);
328 static PyMethodDef objfile_object_methods
[] =
330 { "is_valid", objfpy_is_valid
, METH_NOARGS
,
331 "is_valid () -> Boolean.\n\
332 Return true if this object file is valid, false if not." },
337 static PyGetSetDef objfile_getset
[] =
339 { "filename", objfpy_get_filename
, NULL
,
340 "The objfile's filename, or None.", NULL
},
341 { "pretty_printers", objfpy_get_printers
, objfpy_set_printers
,
342 "Pretty printers.", NULL
},
343 { "frame_filters", objfpy_get_frame_filters
,
344 objfpy_set_frame_filters
, "Frame Filters.", NULL
},
345 { "type_printers", objfpy_get_type_printers
, objfpy_set_type_printers
,
346 "Type printers.", NULL
},
347 { "xmethods", objfpy_get_xmethods
, NULL
,
348 "Debug methods.", NULL
},
352 static PyTypeObject objfile_object_type
=
354 PyVarObject_HEAD_INIT (NULL
, 0)
355 "gdb.Objfile", /*tp_name*/
356 sizeof (objfile_object
), /*tp_basicsize*/
358 objfpy_dealloc
, /*tp_dealloc*/
365 0, /*tp_as_sequence*/
373 Py_TPFLAGS_DEFAULT
, /*tp_flags*/
374 "GDB objfile object", /* tp_doc */
377 0, /* tp_richcompare */
378 0, /* tp_weaklistoffset */
381 objfile_object_methods
, /* tp_methods */
383 objfile_getset
, /* tp_getset */
386 0, /* tp_descr_get */
387 0, /* tp_descr_set */
388 0, /* tp_dictoffset */
391 objfpy_new
, /* tp_new */