Commit | Line | Data |
---|---|---|
d57a3c85 TJB |
1 | /* Gdb/Python header for private use by Python module. |
2 | ||
7b6bb8da | 3 | Copyright (C) 2008, 2009, 2010, 2011 Free Software Foundation, Inc. |
d57a3c85 TJB |
4 | |
5 | This file is part of GDB. | |
6 | ||
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. | |
11 | ||
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. | |
16 | ||
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/>. */ | |
19 | ||
20 | #ifndef GDB_PYTHON_INTERNAL_H | |
21 | #define GDB_PYTHON_INTERNAL_H | |
22 | ||
8a1ea21f DE |
23 | #include <stdio.h> |
24 | ||
d57a3c85 TJB |
25 | /* Python 2.4 doesn't include stdint.h soon enough to get {u,}intptr_t |
26 | needed by pyport.h. */ | |
27 | #include <stdint.h> | |
28 | ||
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. | |
aac63f0f JB |
33 | To work around this, undef _POSIX_C_SOURCE before we include Python.h. |
34 | ||
35 | Same problem with _XOPEN_SOURCE. */ | |
d57a3c85 | 36 | #undef _POSIX_C_SOURCE |
aac63f0f | 37 | #undef _XOPEN_SOURCE |
d57a3c85 | 38 | |
aed1781d JB |
39 | /* On sparc-solaris, /usr/include/sys/feature_tests.h defines |
40 | _FILE_OFFSET_BITS, which pyconfig.h also defines. Same work | |
284a3db3 | 41 | around technique as above. */ |
aed1781d JB |
42 | #undef _FILE_OFFSET_BITS |
43 | ||
1c033f8c TT |
44 | /* Request clean size types from Python. */ |
45 | #define PY_SSIZE_T_CLEAN | |
46 | ||
ac534cba JB |
47 | /* Include the Python header files using angle brackets rather than |
48 | double quotes. On case-insensitive filesystems, this prevents us | |
49 | from including our python/python.h header file. */ | |
50 | #include <Python.h> | |
51 | #include <frameobject.h> | |
d57a3c85 | 52 | #if HAVE_LIBPYTHON2_4 |
5171e6b3 TT |
53 | /* Py_ssize_t is not defined until 2.5. |
54 | Logical type for Py_ssize_t is Py_intptr_t, but that fails in 64-bit | |
55 | compilation due to several apparent mistakes in python2.4 API, so we | |
56 | use 'int' instead. */ | |
57 | typedef int Py_ssize_t; | |
d57a3c85 TJB |
58 | #endif |
59 | ||
ca30a762 TT |
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. */ | |
63 | #ifndef WITH_THREAD | |
64 | #define PyGILState_Ensure() ((PyGILState_STATE) 0) | |
548a926a | 65 | #define PyGILState_Release(ARG) ((void)(ARG)) |
aed1781d | 66 | #define PyEval_InitThreads() |
548a926a | 67 | #define PyThreadState_Swap(ARG) ((void)(ARG)) |
aed1781d | 68 | #define PyEval_ReleaseLock() |
ca30a762 TT |
69 | #endif |
70 | ||
74aedc46 TT |
71 | /* Python supplies HAVE_LONG_LONG and some `long long' support when it |
72 | is available. These defines let us handle the differences more | |
73 | cleanly. */ | |
74 | #ifdef HAVE_LONG_LONG | |
75 | ||
76 | #define GDB_PY_LL_ARG "L" | |
77 | #define GDB_PY_LLU_ARG "K" | |
78 | typedef PY_LONG_LONG gdb_py_longest; | |
79 | typedef unsigned PY_LONG_LONG gdb_py_ulongest; | |
80 | #define gdb_py_long_from_longest PyLong_FromLongLong | |
81 | #define gdb_py_long_from_ulongest PyLong_FromUnsignedLongLong | |
82 | #define gdb_py_long_as_ulongest PyLong_AsUnsignedLongLong | |
83 | ||
84 | #else /* HAVE_LONG_LONG */ | |
85 | ||
86 | #define GDB_PY_LL_ARG "L" | |
87 | #define GDB_PY_LLU_ARG "K" | |
88 | typedef long gdb_py_longest; | |
89 | typedef unsigned long gdb_py_ulongest; | |
90 | #define gdb_py_long_from_longest PyLong_FromLong | |
91 | #define gdb_py_long_from_ulongest PyLong_FromUnsignedLong | |
92 | #define gdb_py_long_as_ulongest PyLong_AsUnsignedLong | |
93 | ||
94 | #endif /* HAVE_LONG_LONG */ | |
95 | ||
96 | ||
9cb74f47 PM |
97 | /* In order to be able to parse symtab_and_line_to_sal_object function |
98 | a real symtab_and_line structure is needed. */ | |
99 | #include "symtab.h" | |
100 | ||
d7b32ed3 PM |
101 | /* Also needed to parse enum var_types. */ |
102 | #include "command.h" | |
505500db | 103 | #include "breakpoint.h" |
d7b32ed3 | 104 | |
621c8364 TT |
105 | #include "exceptions.h" |
106 | ||
a73bb892 PK |
107 | enum gdbpy_iter_kind { iter_keys, iter_values, iter_items }; |
108 | ||
f3e9a817 | 109 | struct block; |
a08702d6 | 110 | struct value; |
d452c4bc | 111 | struct language_defn; |
fa33c3cd | 112 | struct program_space; |
505500db | 113 | struct bpstats; |
619cebe8 | 114 | struct inferior; |
d57a3c85 TJB |
115 | |
116 | extern PyObject *gdb_module; | |
a08702d6 | 117 | extern PyTypeObject value_object_type; |
f3e9a817 PM |
118 | extern PyTypeObject block_object_type; |
119 | extern PyTypeObject symbol_object_type; | |
505500db SW |
120 | extern PyTypeObject event_object_type; |
121 | extern PyTypeObject events_object_type; | |
122 | extern PyTypeObject stop_event_object_type; | |
123 | ||
124 | /* Defined in py-breakpoint.c */ | |
125 | typedef struct breakpoint_object breakpoint_object; | |
a08702d6 | 126 | |
595939de PM |
127 | typedef struct |
128 | { | |
129 | PyObject_HEAD | |
130 | ||
131 | /* The thread we represent. */ | |
132 | struct thread_info *thread; | |
133 | ||
134 | /* The Inferior object to which this thread belongs. */ | |
135 | PyObject *inf_obj; | |
136 | } thread_object; | |
137 | ||
8a1ea21f DE |
138 | extern struct cmd_list_element *set_python_list; |
139 | extern struct cmd_list_element *show_python_list; | |
140 | ||
08c637de | 141 | PyObject *gdbpy_history (PyObject *self, PyObject *args); |
adc36818 | 142 | PyObject *gdbpy_breakpoints (PyObject *, PyObject *); |
f8f6f20b | 143 | PyObject *gdbpy_frame_stop_reason_string (PyObject *, PyObject *); |
f3e9a817 | 144 | PyObject *gdbpy_lookup_symbol (PyObject *self, PyObject *args, PyObject *kw); |
6e6fbe60 DE |
145 | PyObject *gdbpy_lookup_global_symbol (PyObject *self, PyObject *args, |
146 | PyObject *kw); | |
d8e22779 | 147 | PyObject *gdbpy_newest_frame (PyObject *self, PyObject *args); |
f8f6f20b | 148 | PyObject *gdbpy_selected_frame (PyObject *self, PyObject *args); |
f3e9a817 | 149 | PyObject *gdbpy_block_for_pc (PyObject *self, PyObject *args); |
2c74e833 | 150 | PyObject *gdbpy_lookup_type (PyObject *self, PyObject *args, PyObject *kw); |
be759fcf | 151 | PyObject *gdbpy_create_lazy_string_object (CORE_ADDR address, long length, |
9a2b4c1b MS |
152 | const char *encoding, |
153 | struct type *type); | |
595939de PM |
154 | PyObject *gdbpy_inferiors (PyObject *unused, PyObject *unused2); |
155 | PyObject *gdbpy_selected_thread (PyObject *self, PyObject *args); | |
2aa48337 | 156 | PyObject *gdbpy_selected_inferior (PyObject *self, PyObject *args); |
07ca107c | 157 | PyObject *gdbpy_string_to_argv (PyObject *self, PyObject *args); |
d7b32ed3 PM |
158 | PyObject *gdbpy_parameter (PyObject *self, PyObject *args); |
159 | PyObject *gdbpy_parameter_value (enum var_types type, void *var); | |
63d97a20 | 160 | char *gdbpy_parse_command_name (const char *name, |
d7b32ed3 PM |
161 | struct cmd_list_element ***base_list, |
162 | struct cmd_list_element **start_list); | |
a08702d6 | 163 | |
f3e9a817 PM |
164 | PyObject *symtab_and_line_to_sal_object (struct symtab_and_line sal); |
165 | PyObject *symtab_to_symtab_object (struct symtab *symtab); | |
166 | PyObject *symbol_to_symbol_object (struct symbol *sym); | |
167 | PyObject *block_to_block_object (struct block *block, struct objfile *objfile); | |
a08702d6 | 168 | PyObject *value_to_value_object (struct value *v); |
2c74e833 | 169 | PyObject *type_to_type_object (struct type *); |
595939de | 170 | PyObject *frame_info_to_frame_object (struct frame_info *frame); |
89c73ade | 171 | |
fa33c3cd DE |
172 | PyObject *pspace_to_pspace_object (struct program_space *); |
173 | PyObject *pspy_get_printers (PyObject *, void *); | |
174 | ||
175 | PyObject *objfile_to_objfile_object (struct objfile *); | |
89c73ade | 176 | PyObject *objfpy_get_printers (PyObject *, void *); |
a08702d6 | 177 | |
595939de PM |
178 | thread_object *create_thread_object (struct thread_info *tp); |
179 | thread_object *find_thread_object (ptid_t ptid); | |
180 | PyObject *find_inferior_object (int pid); | |
505500db | 181 | PyObject *inferior_to_inferior_object (struct inferior *inferior); |
595939de | 182 | |
f3e9a817 PM |
183 | struct block *block_object_to_block (PyObject *obj); |
184 | struct symbol *symbol_object_to_symbol (PyObject *obj); | |
a6bac58e | 185 | struct value *value_object_to_value (PyObject *self); |
a08702d6 | 186 | struct value *convert_value_from_python (PyObject *obj); |
2c74e833 | 187 | struct type *type_object_to_type (PyObject *obj); |
f3e9a817 PM |
188 | struct symtab *symtab_object_to_symtab (PyObject *obj); |
189 | struct symtab_and_line *sal_object_to_symtab_and_line (PyObject *obj); | |
a08702d6 | 190 | |
8a1ea21f | 191 | void gdbpy_initialize_auto_load (void); |
a08702d6 | 192 | void gdbpy_initialize_values (void); |
f8f6f20b | 193 | void gdbpy_initialize_frames (void); |
f3e9a817 | 194 | void gdbpy_initialize_symtabs (void); |
d8906c6f | 195 | void gdbpy_initialize_commands (void); |
f3e9a817 PM |
196 | void gdbpy_initialize_symbols (void); |
197 | void gdbpy_initialize_symtabs (void); | |
198 | void gdbpy_initialize_blocks (void); | |
2c74e833 | 199 | void gdbpy_initialize_types (void); |
bc3b79fd | 200 | void gdbpy_initialize_functions (void); |
fa33c3cd | 201 | void gdbpy_initialize_pspace (void); |
89c73ade | 202 | void gdbpy_initialize_objfile (void); |
adc36818 | 203 | void gdbpy_initialize_breakpoints (void); |
be759fcf | 204 | void gdbpy_initialize_lazy_string (void); |
d7b32ed3 | 205 | void gdbpy_initialize_parameters (void); |
595939de PM |
206 | void gdbpy_initialize_thread (void); |
207 | void gdbpy_initialize_inferior (void); | |
505500db SW |
208 | void gdbpy_initialize_eventregistry (void); |
209 | void gdbpy_initialize_event (void); | |
210 | void gdbpy_initialize_py_events (void); | |
211 | void gdbpy_initialize_stop_event (void); | |
212 | void gdbpy_initialize_signal_event (void); | |
213 | void gdbpy_initialize_breakpoint_event (void); | |
214 | void gdbpy_initialize_continue_event (void); | |
215 | void gdbpy_initialize_exited_event (void); | |
216 | void gdbpy_initialize_thread_event (void); | |
d57a3c85 TJB |
217 | |
218 | struct cleanup *make_cleanup_py_decref (PyObject *py); | |
d452c4bc UW |
219 | |
220 | struct cleanup *ensure_python_env (struct gdbarch *gdbarch, | |
221 | const struct language_defn *language); | |
222 | ||
223 | extern struct gdbarch *python_gdbarch; | |
224 | extern const struct language_defn *python_language; | |
d57a3c85 TJB |
225 | |
226 | /* Use this after a TRY_EXCEPT to throw the appropriate Python | |
227 | exception. */ | |
228 | #define GDB_PY_HANDLE_EXCEPTION(Exception) \ | |
229 | do { \ | |
230 | if (Exception.reason < 0) \ | |
621c8364 | 231 | return gdbpy_convert_exception (Exception); \ |
d57a3c85 TJB |
232 | } while (0) |
233 | ||
adc36818 PM |
234 | /* Use this after a TRY_EXCEPT to throw the appropriate Python |
235 | exception. This macro is for use inside setter functions. */ | |
236 | #define GDB_PY_SET_HANDLE_EXCEPTION(Exception) \ | |
237 | do { \ | |
238 | if (Exception.reason < 0) \ | |
239 | { \ | |
621c8364 | 240 | gdbpy_convert_exception (Exception); \ |
adc36818 PM |
241 | return -1; \ |
242 | } \ | |
243 | } while (0) | |
d57a3c85 TJB |
244 | |
245 | void gdbpy_print_stack (void); | |
246 | ||
8a1ea21f DE |
247 | void source_python_script_for_objfile (struct objfile *objfile, |
248 | FILE *stream, const char *file); | |
249 | ||
d57a3c85 TJB |
250 | PyObject *python_string_to_unicode (PyObject *obj); |
251 | char *unicode_to_target_string (PyObject *unicode_str); | |
252 | char *python_string_to_target_string (PyObject *obj); | |
fbb8f299 | 253 | PyObject *python_string_to_target_python_string (PyObject *obj); |
08c637de | 254 | char *python_string_to_host_string (PyObject *obj); |
b6cb8e7d | 255 | PyObject *target_string_to_unicode (const gdb_byte *str, int length); |
08c637de | 256 | int gdbpy_is_string (PyObject *obj); |
07ca107c DE |
257 | char *gdbpy_obj_to_string (PyObject *obj); |
258 | char *gdbpy_exception_to_string (PyObject *ptype, PyObject *pvalue); | |
259 | ||
be759fcf | 260 | int gdbpy_is_lazy_string (PyObject *result); |
09ca9e2e TT |
261 | void gdbpy_extract_lazy_string (PyObject *string, CORE_ADDR *addr, |
262 | struct type **str_type, | |
263 | long *length, char **encoding); | |
d57a3c85 | 264 | |
595939de PM |
265 | int gdbpy_is_value_object (PyObject *obj); |
266 | ||
b6313243 TT |
267 | /* Note that these are declared here, and not in python.h with the |
268 | other pretty-printer functions, because they refer to PyObject. */ | |
fbb8f299 | 269 | PyObject *apply_varobj_pretty_printer (PyObject *print_obj, |
621c8364 TT |
270 | struct value **replacement, |
271 | struct ui_file *stream); | |
b6313243 TT |
272 | PyObject *gdbpy_get_varobj_pretty_printer (struct value *value); |
273 | char *gdbpy_get_display_hint (PyObject *printer); | |
274 | PyObject *gdbpy_default_visualizer (PyObject *self, PyObject *args); | |
275 | ||
d8906c6f | 276 | extern PyObject *gdbpy_doc_cst; |
a6bac58e TT |
277 | extern PyObject *gdbpy_children_cst; |
278 | extern PyObject *gdbpy_to_string_cst; | |
279 | extern PyObject *gdbpy_display_hint_cst; | |
967cf477 | 280 | extern PyObject *gdbpy_enabled_cst; |
fb6a3ed3 | 281 | extern PyObject *gdbpy_value_cst; |
d8906c6f | 282 | |
621c8364 TT |
283 | /* Exception types. */ |
284 | extern PyObject *gdbpy_gdb_error; | |
285 | extern PyObject *gdbpy_gdb_memory_error; | |
07ca107c DE |
286 | extern PyObject *gdbpy_gdberror_exc; |
287 | ||
621c8364 TT |
288 | extern PyObject *gdbpy_convert_exception (struct gdb_exception); |
289 | ||
595939de PM |
290 | int get_addr_from_python (PyObject *obj, CORE_ADDR *addr); |
291 | ||
74aedc46 TT |
292 | PyObject *gdb_py_object_from_longest (LONGEST l); |
293 | PyObject *gdb_py_object_from_ulongest (ULONGEST l); | |
294 | int gdb_py_int_as_long (PyObject *, long *); | |
295 | ||
d57a3c85 | 296 | #endif /* GDB_PYTHON_INTERNAL_H */ |