1 /* Gdb/Python header for private use by Python module.
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/>. */
20 #ifndef GDB_PYTHON_INTERNAL_H
21 #define GDB_PYTHON_INTERNAL_H
25 /* Python 2.4 doesn't include stdint.h soon enough to get {u,}intptr_t
26 needed by pyport.h. */
29 /* /usr/include/features.h on linux systems will define _POSIX_C_SOURCE
30 if it sees _GNU_SOURCE (which config.h will define).
31 pyconfig.h defines _POSIX_C_SOURCE to a different value than
32 /usr/include/features.h does causing compilation to fail.
33 To work around this, undef _POSIX_C_SOURCE before we include Python.h.
35 Same problem with _XOPEN_SOURCE. */
36 #undef _POSIX_C_SOURCE
40 #include "python2.4/Python.h"
41 #include "python2.4/frameobject.h"
42 /* Py_ssize_t is not defined until 2.5.
43 Logical type for Py_ssize_t is Py_intptr_t, but that fails in 64-bit
44 compilation due to several apparent mistakes in python2.4 API, so we
46 typedef int Py_ssize_t;
47 #elif HAVE_LIBPYTHON2_5
48 #include "python2.5/Python.h"
49 #include "python2.5/frameobject.h"
50 #elif HAVE_LIBPYTHON2_6
51 #include "python2.6/Python.h"
52 #include "python2.6/frameobject.h"
53 #elif HAVE_LIBPYTHON2_7
54 #include "python2.7/Python.h"
55 #include "python2.7/frameobject.h"
57 #error "Unable to find usable Python.h"
60 /* If Python.h does not define WITH_THREAD, then the various
61 GIL-related functions will not be defined. However,
62 PyGILState_STATE will be. */
64 #define PyGILState_Ensure() ((PyGILState_STATE) 0)
65 #define PyGILState_Release(ARG) ((void)(ARG))
66 #define PyEval_InitThreads() 0
67 #define PyThreadState_Swap(ARG) ((void)(ARG))
68 #define PyEval_InitThreads() 0
69 #define PyEval_ReleaseLock() 0
72 /* In order to be able to parse symtab_and_line_to_sal_object function
73 a real symtab_and_line structure is needed. */
76 /* Also needed to parse enum var_types. */
84 extern PyObject *gdb_module;
85 extern PyTypeObject value_object_type;
86 extern PyTypeObject block_object_type;
87 extern PyTypeObject symbol_object_type;
93 /* The thread we represent. */
94 struct thread_info *thread;
96 /* The Inferior object to which this thread belongs. */
100 extern struct cmd_list_element *set_python_list;
101 extern struct cmd_list_element *show_python_list;
103 PyObject *gdbpy_history (PyObject *self, PyObject *args);
104 PyObject *gdbpy_breakpoints (PyObject *, PyObject *);
105 PyObject *gdbpy_frame_stop_reason_string (PyObject *, PyObject *);
106 PyObject *gdbpy_lookup_symbol (PyObject *self, PyObject *args, PyObject *kw);
107 PyObject *gdbpy_selected_frame (PyObject *self, PyObject *args);
108 PyObject *gdbpy_block_for_pc (PyObject *self, PyObject *args);
109 PyObject *gdbpy_lookup_type (PyObject *self, PyObject *args, PyObject *kw);
110 PyObject *gdbpy_create_lazy_string_object (CORE_ADDR address, long length,
111 const char *encoding, struct type *type);
112 PyObject *gdbpy_inferiors (PyObject *unused, PyObject *unused2);
113 PyObject *gdbpy_selected_thread (PyObject *self, PyObject *args);
114 PyObject *gdbpy_string_to_argv (PyObject *self, PyObject *args);
115 PyObject *gdbpy_get_hook_function (const char *);
116 PyObject *gdbpy_parameter (PyObject *self, PyObject *args);
117 PyObject *gdbpy_parameter_value (enum var_types type, void *var);
118 char *gdbpy_parse_command_name (char *text,
119 struct cmd_list_element ***base_list,
120 struct cmd_list_element **start_list);
122 PyObject *symtab_and_line_to_sal_object (struct symtab_and_line sal);
123 PyObject *symtab_to_symtab_object (struct symtab *symtab);
124 PyObject *symbol_to_symbol_object (struct symbol *sym);
125 PyObject *block_to_block_object (struct block *block, struct objfile *objfile);
126 PyObject *value_to_value_object (struct value *v);
127 PyObject *type_to_type_object (struct type *);
128 PyObject *frame_info_to_frame_object (struct frame_info *frame);
130 PyObject *pspace_to_pspace_object (struct program_space *);
131 PyObject *pspy_get_printers (PyObject *, void *);
133 PyObject *objfile_to_objfile_object (struct objfile *);
134 PyObject *objfpy_get_printers (PyObject *, void *);
136 thread_object *create_thread_object (struct thread_info *tp);
137 thread_object *find_thread_object (ptid_t ptid);
138 PyObject *find_inferior_object (int pid);
140 struct block *block_object_to_block (PyObject *obj);
141 struct symbol *symbol_object_to_symbol (PyObject *obj);
142 struct value *value_object_to_value (PyObject *self);
143 struct value *convert_value_from_python (PyObject *obj);
144 struct type *type_object_to_type (PyObject *obj);
145 struct symtab *symtab_object_to_symtab (PyObject *obj);
146 struct symtab_and_line *sal_object_to_symtab_and_line (PyObject *obj);
148 void gdbpy_initialize_auto_load (void);
149 void gdbpy_initialize_values (void);
150 void gdbpy_initialize_frames (void);
151 void gdbpy_initialize_symtabs (void);
152 void gdbpy_initialize_commands (void);
153 void gdbpy_initialize_symbols (void);
154 void gdbpy_initialize_symtabs (void);
155 void gdbpy_initialize_blocks (void);
156 void gdbpy_initialize_types (void);
157 void gdbpy_initialize_functions (void);
158 void gdbpy_initialize_pspace (void);
159 void gdbpy_initialize_objfile (void);
160 void gdbpy_initialize_breakpoints (void);
161 void gdbpy_initialize_lazy_string (void);
162 void gdbpy_initialize_parameters (void);
163 void gdbpy_initialize_thread (void);
164 void gdbpy_initialize_inferior (void);
166 struct cleanup *make_cleanup_py_decref (PyObject *py);
168 struct cleanup *ensure_python_env (struct gdbarch *gdbarch,
169 const struct language_defn *language);
171 extern struct gdbarch *python_gdbarch;
172 extern const struct language_defn *python_language;
174 /* Use this after a TRY_EXCEPT to throw the appropriate Python
176 #define GDB_PY_HANDLE_EXCEPTION(Exception) \
178 if (Exception.reason < 0) \
179 return PyErr_Format (Exception.reason == RETURN_QUIT \
180 ? PyExc_KeyboardInterrupt : PyExc_RuntimeError, \
181 "%s", Exception.message); \
184 /* Use this after a TRY_EXCEPT to throw the appropriate Python
185 exception. This macro is for use inside setter functions. */
186 #define GDB_PY_SET_HANDLE_EXCEPTION(Exception) \
188 if (Exception.reason < 0) \
190 PyErr_Format (Exception.reason == RETURN_QUIT \
191 ? PyExc_KeyboardInterrupt : PyExc_RuntimeError, \
192 "%s", Exception.message); \
197 void gdbpy_print_stack (void);
199 void source_python_script_for_objfile (struct objfile *objfile,
200 FILE *stream, const char *file);
202 PyObject *python_string_to_unicode (PyObject *obj);
203 char *unicode_to_target_string (PyObject *unicode_str);
204 char *python_string_to_target_string (PyObject *obj);
205 PyObject *python_string_to_target_python_string (PyObject *obj);
206 char *python_string_to_host_string (PyObject *obj);
207 PyObject *target_string_to_unicode (const gdb_byte *str, int length);
208 int gdbpy_is_string (PyObject *obj);
209 char *gdbpy_obj_to_string (PyObject *obj);
210 char *gdbpy_exception_to_string (PyObject *ptype, PyObject *pvalue);
212 int gdbpy_is_lazy_string (PyObject *result);
213 gdb_byte *gdbpy_extract_lazy_string (PyObject *string,
214 struct type **str_type,
215 long *length, char **encoding);
217 int gdbpy_is_value_object (PyObject *obj);
219 /* Note that these are declared here, and not in python.h with the
220 other pretty-printer functions, because they refer to PyObject. */
221 PyObject *apply_varobj_pretty_printer (PyObject *print_obj,
222 struct value **replacement);
223 PyObject *gdbpy_get_varobj_pretty_printer (struct value *value);
224 char *gdbpy_get_display_hint (PyObject *printer);
225 PyObject *gdbpy_default_visualizer (PyObject *self, PyObject *args);
227 extern PyObject *gdbpy_doc_cst;
228 extern PyObject *gdbpy_children_cst;
229 extern PyObject *gdbpy_to_string_cst;
230 extern PyObject *gdbpy_display_hint_cst;
231 extern PyObject *gdbpy_enabled_cst;
233 extern PyObject *gdbpy_gdberror_exc;
235 int get_addr_from_python (PyObject *obj, CORE_ADDR *addr);
237 #endif /* GDB_PYTHON_INTERNAL_H */