1 /* Python interface to types.
3 Copyright (C) 2008, 2009, 2010 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/>. */
22 #include "exceptions.h"
23 #include "python-internal.h"
26 #include "cp-support.h"
31 typedef struct pyty_type_object
36 /* If a Type object is associated with an objfile, it is kept on a
37 doubly-linked list, rooted in the objfile. This lets us copy the
38 underlying struct type when the objfile is deleted. */
39 struct pyty_type_object
*prev
;
40 struct pyty_type_object
*next
;
43 static PyTypeObject type_object_type
;
46 typedef struct pyty_field_object
50 /* Dictionary holding our attributes. */
54 static PyTypeObject field_object_type
;
56 /* This is used to initialize various gdb.TYPE_ constants. */
65 #define ENTRY(X) { X, #X }
67 static struct pyty_code pyty_codes
[] =
69 ENTRY (TYPE_CODE_PTR
),
70 ENTRY (TYPE_CODE_ARRAY
),
71 ENTRY (TYPE_CODE_STRUCT
),
72 ENTRY (TYPE_CODE_UNION
),
73 ENTRY (TYPE_CODE_ENUM
),
74 ENTRY (TYPE_CODE_FLAGS
),
75 ENTRY (TYPE_CODE_FUNC
),
76 ENTRY (TYPE_CODE_INT
),
77 ENTRY (TYPE_CODE_FLT
),
78 ENTRY (TYPE_CODE_VOID
),
79 ENTRY (TYPE_CODE_SET
),
80 ENTRY (TYPE_CODE_RANGE
),
81 ENTRY (TYPE_CODE_STRING
),
82 ENTRY (TYPE_CODE_BITSTRING
),
83 ENTRY (TYPE_CODE_ERROR
),
84 ENTRY (TYPE_CODE_METHOD
),
85 ENTRY (TYPE_CODE_METHODPTR
),
86 ENTRY (TYPE_CODE_MEMBERPTR
),
87 ENTRY (TYPE_CODE_REF
),
88 ENTRY (TYPE_CODE_CHAR
),
89 ENTRY (TYPE_CODE_BOOL
),
90 ENTRY (TYPE_CODE_COMPLEX
),
91 ENTRY (TYPE_CODE_TYPEDEF
),
92 ENTRY (TYPE_CODE_NAMESPACE
),
93 ENTRY (TYPE_CODE_DECFLOAT
),
94 ENTRY (TYPE_CODE_INTERNAL_FUNCTION
),
95 { TYPE_CODE_UNDEF
, NULL
}
101 field_dealloc (PyObject
*obj
)
103 field_object
*f
= (field_object
*) obj
;
104 Py_XDECREF (f
->dict
);
105 f
->ob_type
->tp_free (obj
);
111 field_object
*result
= PyObject_New (field_object
, &field_object_type
);
114 result
->dict
= PyDict_New ();
121 return (PyObject
*) result
;
126 /* Return the code for this type. */
128 typy_get_code (PyObject
*self
, void *closure
)
130 struct type
*type
= ((type_object
*) self
)->type
;
131 return PyInt_FromLong (TYPE_CODE (type
));
134 /* Helper function for typy_fields which converts a single field to a
135 dictionary. Returns NULL on error. */
137 convert_field (struct type
*type
, int field
)
139 PyObject
*result
= field_new ();
145 if (!field_is_static (&TYPE_FIELD (type
, field
)))
147 arg
= PyLong_FromLong (TYPE_FIELD_BITPOS (type
, field
));
151 if (PyObject_SetAttrString (result
, "bitpos", arg
) < 0)
155 if (TYPE_FIELD_NAME (type
, field
))
156 arg
= PyString_FromString (TYPE_FIELD_NAME (type
, field
));
164 if (PyObject_SetAttrString (result
, "name", arg
) < 0)
167 arg
= TYPE_FIELD_ARTIFICIAL (type
, field
) ? Py_True
: Py_False
;
169 if (PyObject_SetAttrString (result
, "artificial", arg
) < 0)
172 if (TYPE_CODE (type
) == TYPE_CODE_CLASS
)
173 arg
= field
< TYPE_N_BASECLASSES (type
) ? Py_True
: Py_False
;
177 if (PyObject_SetAttrString (result
, "is_base_class", arg
) < 0)
180 arg
= PyLong_FromLong (TYPE_FIELD_BITSIZE (type
, field
));
183 if (PyObject_SetAttrString (result
, "bitsize", arg
) < 0)
186 /* A field can have a NULL type in some situations. */
187 if (TYPE_FIELD_TYPE (type
, field
) == NULL
)
193 arg
= type_to_type_object (TYPE_FIELD_TYPE (type
, field
));
196 if (PyObject_SetAttrString (result
, "type", arg
) < 0)
208 /* Return a sequence of all fields. Each field is a dictionary with
209 some pre-defined keys. */
211 typy_fields (PyObject
*self
, PyObject
*args
)
215 struct type
*type
= ((type_object
*) self
)->type
;
217 /* We would like to make a tuple here, make fields immutable, and
218 then memoize the result (and perhaps make Field.type() lazy).
219 However, that can lead to cycles. */
220 result
= PyList_New (0);
222 for (i
= 0; i
< TYPE_NFIELDS (type
); ++i
)
224 PyObject
*dict
= convert_field (type
, i
);
230 if (PyList_Append (result
, dict
))
241 /* Return the type's tag, or None. */
243 typy_get_tag (PyObject
*self
, void *closure
)
245 struct type
*type
= ((type_object
*) self
)->type
;
246 if (!TYPE_TAG_NAME (type
))
248 return PyString_FromString (TYPE_TAG_NAME (type
));
251 /* Return the type, stripped of typedefs. */
253 typy_strip_typedefs (PyObject
*self
, PyObject
*args
)
255 struct type
*type
= ((type_object
*) self
)->type
;
257 return type_to_type_object (check_typedef (type
));
260 /* Return a Type object which represents a pointer to SELF. */
262 typy_pointer (PyObject
*self
, PyObject
*args
)
264 struct type
*type
= ((type_object
*) self
)->type
;
265 volatile struct gdb_exception except
;
267 TRY_CATCH (except
, RETURN_MASK_ALL
)
269 type
= lookup_pointer_type (type
);
271 GDB_PY_HANDLE_EXCEPTION (except
);
273 return type_to_type_object (type
);
276 /* Return the range of a type represented by SELF. The return type is
277 a tuple. The first element of the tuple contains the low bound,
278 while the second element of the tuple contains the high bound. */
280 typy_range (PyObject
*self
, PyObject
*args
)
282 struct type
*type
= ((type_object
*) self
)->type
;
284 PyObject
*low_bound
= NULL
, *high_bound
= NULL
;
285 /* Initialize these to appease GCC warnings. */
286 LONGEST low
= 0, high
= 0;
288 if (TYPE_CODE (type
) != TYPE_CODE_ARRAY
289 && TYPE_CODE (type
) != TYPE_CODE_STRING
290 && TYPE_CODE (type
) != TYPE_CODE_RANGE
)
292 PyErr_SetString (PyExc_RuntimeError
,
293 "This type does not have a range.");
297 switch (TYPE_CODE (type
))
299 case TYPE_CODE_ARRAY
:
300 case TYPE_CODE_STRING
:
301 low
= TYPE_LOW_BOUND (TYPE_INDEX_TYPE (type
));
302 high
= TYPE_HIGH_BOUND (TYPE_INDEX_TYPE (type
));
304 case TYPE_CODE_RANGE
:
305 low
= TYPE_LOW_BOUND (type
);
306 high
= TYPE_HIGH_BOUND (type
);
310 low_bound
= PyLong_FromLong (low
);
314 high_bound
= PyLong_FromLong (high
);
318 result
= PyTuple_New (2);
322 if (PyTuple_SetItem (result
, 0, low_bound
) != 0)
327 if (PyTuple_SetItem (result
, 1, high_bound
) != 0)
329 Py_DECREF (high_bound
);
336 Py_XDECREF (high_bound
);
337 Py_XDECREF (low_bound
);
341 /* Return a Type object which represents a reference to SELF. */
343 typy_reference (PyObject
*self
, PyObject
*args
)
345 struct type
*type
= ((type_object
*) self
)->type
;
346 volatile struct gdb_exception except
;
348 TRY_CATCH (except
, RETURN_MASK_ALL
)
350 type
= lookup_reference_type (type
);
352 GDB_PY_HANDLE_EXCEPTION (except
);
354 return type_to_type_object (type
);
357 /* Return a Type object which represents the target type of SELF. */
359 typy_target (PyObject
*self
, PyObject
*args
)
361 struct type
*type
= ((type_object
*) self
)->type
;
363 if (!TYPE_TARGET_TYPE (type
))
365 PyErr_SetString (PyExc_RuntimeError
, "type does not have a target");
369 return type_to_type_object (TYPE_TARGET_TYPE (type
));
372 /* Return a const-qualified type variant. */
374 typy_const (PyObject
*self
, PyObject
*args
)
376 struct type
*type
= ((type_object
*) self
)->type
;
377 volatile struct gdb_exception except
;
379 TRY_CATCH (except
, RETURN_MASK_ALL
)
381 type
= make_cv_type (1, 0, type
, NULL
);
383 GDB_PY_HANDLE_EXCEPTION (except
);
385 return type_to_type_object (type
);
388 /* Return a volatile-qualified type variant. */
390 typy_volatile (PyObject
*self
, PyObject
*args
)
392 struct type
*type
= ((type_object
*) self
)->type
;
393 volatile struct gdb_exception except
;
395 TRY_CATCH (except
, RETURN_MASK_ALL
)
397 type
= make_cv_type (0, 1, type
, NULL
);
399 GDB_PY_HANDLE_EXCEPTION (except
);
401 return type_to_type_object (type
);
404 /* Return an unqualified type variant. */
406 typy_unqualified (PyObject
*self
, PyObject
*args
)
408 struct type
*type
= ((type_object
*) self
)->type
;
409 volatile struct gdb_exception except
;
411 TRY_CATCH (except
, RETURN_MASK_ALL
)
413 type
= make_cv_type (0, 0, type
, NULL
);
415 GDB_PY_HANDLE_EXCEPTION (except
);
417 return type_to_type_object (type
);
420 /* Return the size of the type represented by SELF, in bytes. */
422 typy_get_sizeof (PyObject
*self
, void *closure
)
424 struct type
*type
= ((type_object
*) self
)->type
;
425 volatile struct gdb_exception except
;
427 TRY_CATCH (except
, RETURN_MASK_ALL
)
429 check_typedef (type
);
431 /* Ignore exceptions. */
433 return PyLong_FromLong (TYPE_LENGTH (type
));
437 typy_lookup_typename (char *type_name
)
439 struct type
*type
= NULL
;
440 volatile struct gdb_exception except
;
441 TRY_CATCH (except
, RETURN_MASK_ALL
)
443 if (!strncmp (type_name
, "struct ", 7))
444 type
= lookup_struct (type_name
+ 7, NULL
);
445 else if (!strncmp (type_name
, "union ", 6))
446 type
= lookup_union (type_name
+ 6, NULL
);
447 else if (!strncmp (type_name
, "enum ", 5))
448 type
= lookup_enum (type_name
+ 5, NULL
);
450 type
= lookup_typename (python_language
, python_gdbarch
,
453 if (except
.reason
< 0)
455 PyErr_Format (except
.reason
== RETURN_QUIT
456 ? PyExc_KeyboardInterrupt
: PyExc_RuntimeError
,
457 "%s", except
.message
);
465 typy_lookup_type (struct demangle_component
*demangled
)
469 enum demangle_component_type demangled_type
;
471 /* Save the type: typy_lookup_type() may (indirectly) overwrite
472 memory pointed by demangled. */
473 demangled_type
= demangled
->type
;
475 if (demangled_type
== DEMANGLE_COMPONENT_POINTER
476 || demangled_type
== DEMANGLE_COMPONENT_REFERENCE
477 || demangled_type
== DEMANGLE_COMPONENT_CONST
478 || demangled_type
== DEMANGLE_COMPONENT_VOLATILE
)
480 type
= typy_lookup_type (demangled
->u
.s_binary
.left
);
484 switch (demangled_type
)
486 case DEMANGLE_COMPONENT_REFERENCE
:
487 return lookup_reference_type (type
);
488 case DEMANGLE_COMPONENT_POINTER
:
489 return lookup_pointer_type (type
);
490 case DEMANGLE_COMPONENT_CONST
:
491 return make_cv_type (1, 0, type
, NULL
);
492 case DEMANGLE_COMPONENT_VOLATILE
:
493 return make_cv_type (0, 1, type
, NULL
);
497 type_name
= cp_comp_to_string (demangled
, 10);
498 type
= typy_lookup_typename (type_name
);
505 typy_template_argument (PyObject
*self
, PyObject
*args
)
507 int i
, argno
, n_pointers
;
508 struct type
*type
= ((type_object
*) self
)->type
;
509 struct demangle_component
*demangled
;
511 struct type
*argtype
;
513 if (! PyArg_ParseTuple (args
, "i", &argno
))
516 type
= check_typedef (type
);
517 if (TYPE_CODE (type
) == TYPE_CODE_REF
)
518 type
= check_typedef (TYPE_TARGET_TYPE (type
));
520 if (TYPE_NAME (type
) == NULL
)
522 PyErr_SetString (PyExc_RuntimeError
, "null type name");
526 /* Note -- this is not thread-safe. */
527 demangled
= cp_demangled_name_to_comp (TYPE_NAME (type
), &err
);
530 PyErr_SetString (PyExc_RuntimeError
, err
);
534 /* Strip off component names. */
535 while (demangled
->type
== DEMANGLE_COMPONENT_QUAL_NAME
536 || demangled
->type
== DEMANGLE_COMPONENT_LOCAL_NAME
)
537 demangled
= demangled
->u
.s_binary
.right
;
539 if (demangled
->type
!= DEMANGLE_COMPONENT_TEMPLATE
)
541 PyErr_SetString (PyExc_RuntimeError
, "type is not a template");
545 /* Skip from the template to the arguments. */
546 demangled
= demangled
->u
.s_binary
.right
;
548 for (i
= 0; demangled
&& i
< argno
; ++i
)
549 demangled
= demangled
->u
.s_binary
.right
;
553 PyErr_Format (PyExc_RuntimeError
, "no argument %d in template",
558 argtype
= typy_lookup_type (demangled
->u
.s_binary
.left
);
562 return type_to_type_object (argtype
);
566 typy_str (PyObject
*self
)
568 volatile struct gdb_exception except
;
569 char *thetype
= NULL
;
573 TRY_CATCH (except
, RETURN_MASK_ALL
)
575 struct cleanup
*old_chain
;
578 stb
= mem_fileopen ();
579 old_chain
= make_cleanup_ui_file_delete (stb
);
581 type_print (type_object_to_type (self
), "", stb
, -1);
583 thetype
= ui_file_xstrdup (stb
, &length
);
584 do_cleanups (old_chain
);
586 if (except
.reason
< 0)
589 GDB_PY_HANDLE_EXCEPTION (except
);
592 result
= PyUnicode_Decode (thetype
, length
, host_charset (), NULL
);
600 static const struct objfile_data
*typy_objfile_data_key
;
603 save_objfile_types (struct objfile
*objfile
, void *datum
)
605 type_object
*obj
= datum
;
607 struct cleanup
*cleanup
;
609 /* This prevents another thread from freeing the objects we're
611 cleanup
= ensure_python_env (get_objfile_arch (objfile
), current_language
);
613 copied_types
= create_copied_types_hash (objfile
);
617 type_object
*next
= obj
->next
;
619 htab_empty (copied_types
);
621 obj
->type
= copy_type_recursive (objfile
, obj
->type
, copied_types
);
629 htab_delete (copied_types
);
631 do_cleanups (cleanup
);
635 set_type (type_object
*obj
, struct type
*type
)
639 if (type
&& TYPE_OBJFILE (type
))
641 struct objfile
*objfile
= TYPE_OBJFILE (type
);
643 obj
->next
= objfile_data (objfile
, typy_objfile_data_key
);
645 obj
->next
->prev
= obj
;
646 set_objfile_data (objfile
, typy_objfile_data_key
, obj
);
653 typy_dealloc (PyObject
*obj
)
655 type_object
*type
= (type_object
*) obj
;
658 type
->prev
->next
= type
->next
;
659 else if (type
->type
&& TYPE_OBJFILE (type
->type
))
661 /* Must reset head of list. */
662 struct objfile
*objfile
= TYPE_OBJFILE (type
->type
);
664 set_objfile_data (objfile
, typy_objfile_data_key
, type
->next
);
667 type
->next
->prev
= type
->prev
;
669 type
->ob_type
->tp_free (type
);
672 /* Create a new Type referring to TYPE. */
674 type_to_type_object (struct type
*type
)
676 type_object
*type_obj
;
678 type_obj
= PyObject_New (type_object
, &type_object_type
);
680 set_type (type_obj
, type
);
682 return (PyObject
*) type_obj
;
686 type_object_to_type (PyObject
*obj
)
688 if (! PyObject_TypeCheck (obj
, &type_object_type
))
690 return ((type_object
*) obj
)->type
;
695 /* Implementation of gdb.lookup_type. */
697 gdbpy_lookup_type (PyObject
*self
, PyObject
*args
, PyObject
*kw
)
699 static char *keywords
[] = { "name", NULL
};
700 char *type_name
= NULL
;
701 struct type
*type
= NULL
;
703 if (! PyArg_ParseTupleAndKeywords (args
, kw
, "s", keywords
, &type_name
))
706 type
= typy_lookup_typename (type_name
);
710 return (PyObject
*) type_to_type_object (type
);
714 gdbpy_initialize_types (void)
718 typy_objfile_data_key
719 = register_objfile_data_with_cleanup (save_objfile_types
, NULL
);
721 if (PyType_Ready (&type_object_type
) < 0)
723 if (PyType_Ready (&field_object_type
) < 0)
726 for (i
= 0; pyty_codes
[i
].name
; ++i
)
728 if (PyModule_AddIntConstant (gdb_module
,
729 /* Cast needed for Python 2.4. */
730 (char *) pyty_codes
[i
].name
,
731 pyty_codes
[i
].code
) < 0)
735 Py_INCREF (&type_object_type
);
736 PyModule_AddObject (gdb_module
, "Type", (PyObject
*) &type_object_type
);
738 Py_INCREF (&field_object_type
);
739 PyModule_AddObject (gdb_module
, "Field", (PyObject
*) &field_object_type
);
744 static PyGetSetDef type_object_getset
[] =
746 { "code", typy_get_code
, NULL
,
747 "The code for this type.", NULL
},
748 { "sizeof", typy_get_sizeof
, NULL
,
749 "The size of this type, in bytes.", NULL
},
750 { "tag", typy_get_tag
, NULL
,
751 "The tag name for this type, or None.", NULL
},
755 static PyMethodDef type_object_methods
[] =
757 { "const", typy_const
, METH_NOARGS
,
759 Return a const variant of this type." },
760 { "fields", typy_fields
, METH_NOARGS
,
762 Return a sequence holding all the fields of this type.\n\
763 Each field is a dictionary." },
764 { "pointer", typy_pointer
, METH_NOARGS
,
765 "pointer () -> Type\n\
766 Return a type of pointer to this type." },
767 { "range", typy_range
, METH_NOARGS
,
768 "range () -> tuple\n\
769 Return a tuple containing the lower and upper range for this type."},
770 { "reference", typy_reference
, METH_NOARGS
,
771 "reference () -> Type\n\
772 Return a type of reference to this type." },
773 { "strip_typedefs", typy_strip_typedefs
, METH_NOARGS
,
774 "strip_typedefs () -> Type\n\
775 Return a type formed by stripping this type of all typedefs."},
776 { "target", typy_target
, METH_NOARGS
,
777 "target () -> Type\n\
778 Return the target type of this type." },
779 { "template_argument", typy_template_argument
, METH_VARARGS
,
780 "template_argument (arg) -> Type\n\
781 Return the type of a template argument." },
782 { "unqualified", typy_unqualified
, METH_NOARGS
,
783 "unqualified () -> Type\n\
784 Return a variant of this type without const or volatile attributes." },
785 { "volatile", typy_volatile
, METH_NOARGS
,
786 "volatile () -> Type\n\
787 Return a volatile variant of this type" },
791 static PyTypeObject type_object_type
=
793 PyObject_HEAD_INIT (NULL
)
795 "gdb.Type", /*tp_name*/
796 sizeof (type_object
), /*tp_basicsize*/
798 typy_dealloc
, /*tp_dealloc*/
805 0, /*tp_as_sequence*/
813 Py_TPFLAGS_DEFAULT
| Py_TPFLAGS_HAVE_ITER
, /*tp_flags*/
814 "GDB type object", /* tp_doc */
817 0, /* tp_richcompare */
818 0, /* tp_weaklistoffset */
821 type_object_methods
, /* tp_methods */
823 type_object_getset
, /* tp_getset */
826 0, /* tp_descr_get */
827 0, /* tp_descr_set */
828 0, /* tp_dictoffset */
834 static PyTypeObject field_object_type
=
836 PyObject_HEAD_INIT (NULL
)
838 "gdb.Field", /*tp_name*/
839 sizeof (field_object
), /*tp_basicsize*/
841 field_dealloc
, /*tp_dealloc*/
848 0, /*tp_as_sequence*/
856 Py_TPFLAGS_DEFAULT
| Py_TPFLAGS_HAVE_ITER
, /*tp_flags*/
857 "GDB field object", /* tp_doc */
860 0, /* tp_richcompare */
861 0, /* tp_weaklistoffset */
869 0, /* tp_descr_get */
870 0, /* tp_descr_set */
871 offsetof (field_object
, dict
), /* tp_dictoffset */