1 /* Gdb/Python header for private use by Python module.
3 Copyright (C) 2008, 2009, 2010, 2011 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
39 /* On sparc-solaris, /usr/include/sys/feature_tests.h defines
40 _FILE_OFFSET_BITS, which pyconfig.h also defines. Same work
41 around technique as above. */
42 #undef _FILE_OFFSET_BITS
44 /* Request clean size types from Python. */
45 #define PY_SSIZE_T_CLEAN
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. */
51 #include <frameobject.h>
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
57 typedef int Py_ssize_t
;
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()
67 #define PyThreadState_Swap(ARG) ((void)(ARG))
68 #define PyEval_ReleaseLock()
71 /* Python supplies HAVE_LONG_LONG and some `long long' support when it
72 is available. These defines let us handle the differences more
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
84 #else /* HAVE_LONG_LONG */
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
94 #endif /* HAVE_LONG_LONG */
97 /* In order to be able to parse symtab_and_line_to_sal_object function
98 a real symtab_and_line structure is needed. */
101 /* Also needed to parse enum var_types. */
103 #include "breakpoint.h"
105 #include "exceptions.h"
107 enum gdbpy_iter_kind
{ iter_keys
, iter_values
, iter_items
};
111 struct language_defn
;
112 struct program_space
;
116 extern PyObject
*gdb_module
;
117 extern PyTypeObject value_object_type
;
118 extern PyTypeObject block_object_type
;
119 extern PyTypeObject symbol_object_type
;
120 extern PyTypeObject event_object_type
;
121 extern PyTypeObject events_object_type
;
122 extern PyTypeObject stop_event_object_type
;
124 /* Defined in py-breakpoint.c */
125 typedef struct breakpoint_object breakpoint_object
;
131 /* The thread we represent. */
132 struct thread_info
*thread
;
134 /* The Inferior object to which this thread belongs. */
138 extern struct cmd_list_element
*set_python_list
;
139 extern struct cmd_list_element
*show_python_list
;
141 PyObject
*gdbpy_history (PyObject
*self
, PyObject
*args
);
142 PyObject
*gdbpy_breakpoints (PyObject
*, PyObject
*);
143 PyObject
*gdbpy_frame_stop_reason_string (PyObject
*, PyObject
*);
144 PyObject
*gdbpy_lookup_symbol (PyObject
*self
, PyObject
*args
, PyObject
*kw
);
145 PyObject
*gdbpy_lookup_global_symbol (PyObject
*self
, PyObject
*args
,
147 PyObject
*gdbpy_newest_frame (PyObject
*self
, PyObject
*args
);
148 PyObject
*gdbpy_selected_frame (PyObject
*self
, PyObject
*args
);
149 PyObject
*gdbpy_block_for_pc (PyObject
*self
, PyObject
*args
);
150 PyObject
*gdbpy_lookup_type (PyObject
*self
, PyObject
*args
, PyObject
*kw
);
151 PyObject
*gdbpy_create_lazy_string_object (CORE_ADDR address
, long length
,
152 const char *encoding
,
154 PyObject
*gdbpy_inferiors (PyObject
*unused
, PyObject
*unused2
);
155 PyObject
*gdbpy_selected_thread (PyObject
*self
, PyObject
*args
);
156 PyObject
*gdbpy_selected_inferior (PyObject
*self
, PyObject
*args
);
157 PyObject
*gdbpy_string_to_argv (PyObject
*self
, PyObject
*args
);
158 PyObject
*gdbpy_parameter (PyObject
*self
, PyObject
*args
);
159 PyObject
*gdbpy_parameter_value (enum var_types type
, void *var
);
160 char *gdbpy_parse_command_name (const char *name
,
161 struct cmd_list_element
***base_list
,
162 struct cmd_list_element
**start_list
);
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 (const struct block
*block
,
168 struct objfile
*objfile
);
169 PyObject
*value_to_value_object (struct value
*v
);
170 PyObject
*type_to_type_object (struct type
*);
171 PyObject
*frame_info_to_frame_object (struct frame_info
*frame
);
173 PyObject
*pspace_to_pspace_object (struct program_space
*);
174 PyObject
*pspy_get_printers (PyObject
*, void *);
176 PyObject
*objfile_to_objfile_object (struct objfile
*);
177 PyObject
*objfpy_get_printers (PyObject
*, void *);
179 thread_object
*create_thread_object (struct thread_info
*tp
);
180 thread_object
*find_thread_object (ptid_t ptid
);
181 PyObject
*find_inferior_object (int pid
);
182 PyObject
*inferior_to_inferior_object (struct inferior
*inferior
);
184 const struct block
*block_object_to_block (PyObject
*obj
);
185 struct symbol
*symbol_object_to_symbol (PyObject
*obj
);
186 struct value
*value_object_to_value (PyObject
*self
);
187 struct value
*convert_value_from_python (PyObject
*obj
);
188 struct type
*type_object_to_type (PyObject
*obj
);
189 struct symtab
*symtab_object_to_symtab (PyObject
*obj
);
190 struct symtab_and_line
*sal_object_to_symtab_and_line (PyObject
*obj
);
192 void gdbpy_initialize_auto_load (void);
193 void gdbpy_initialize_values (void);
194 void gdbpy_initialize_frames (void);
195 void gdbpy_initialize_symtabs (void);
196 void gdbpy_initialize_commands (void);
197 void gdbpy_initialize_symbols (void);
198 void gdbpy_initialize_symtabs (void);
199 void gdbpy_initialize_blocks (void);
200 void gdbpy_initialize_types (void);
201 void gdbpy_initialize_functions (void);
202 void gdbpy_initialize_pspace (void);
203 void gdbpy_initialize_objfile (void);
204 void gdbpy_initialize_breakpoints (void);
205 void gdbpy_initialize_lazy_string (void);
206 void gdbpy_initialize_parameters (void);
207 void gdbpy_initialize_thread (void);
208 void gdbpy_initialize_inferior (void);
209 void gdbpy_initialize_eventregistry (void);
210 void gdbpy_initialize_event (void);
211 void gdbpy_initialize_py_events (void);
212 void gdbpy_initialize_stop_event (void);
213 void gdbpy_initialize_signal_event (void);
214 void gdbpy_initialize_breakpoint_event (void);
215 void gdbpy_initialize_continue_event (void);
216 void gdbpy_initialize_exited_event (void);
217 void gdbpy_initialize_thread_event (void);
218 void gdbpy_initialize_new_objfile_event (void);
220 struct cleanup
*make_cleanup_py_decref (PyObject
*py
);
222 struct cleanup
*ensure_python_env (struct gdbarch
*gdbarch
,
223 const struct language_defn
*language
);
225 extern struct gdbarch
*python_gdbarch
;
226 extern const struct language_defn
*python_language
;
228 /* Use this after a TRY_EXCEPT to throw the appropriate Python
230 #define GDB_PY_HANDLE_EXCEPTION(Exception) \
232 if (Exception.reason < 0) \
233 return gdbpy_convert_exception (Exception); \
236 /* Use this after a TRY_EXCEPT to throw the appropriate Python
237 exception. This macro is for use inside setter functions. */
238 #define GDB_PY_SET_HANDLE_EXCEPTION(Exception) \
240 if (Exception.reason < 0) \
242 gdbpy_convert_exception (Exception); \
247 void gdbpy_print_stack (void);
249 void source_python_script_for_objfile (struct objfile
*objfile
,
252 PyObject
*python_string_to_unicode (PyObject
*obj
);
253 char *unicode_to_target_string (PyObject
*unicode_str
);
254 char *python_string_to_target_string (PyObject
*obj
);
255 PyObject
*python_string_to_target_python_string (PyObject
*obj
);
256 char *python_string_to_host_string (PyObject
*obj
);
257 PyObject
*target_string_to_unicode (const gdb_byte
*str
, int length
);
258 int gdbpy_is_string (PyObject
*obj
);
259 char *gdbpy_obj_to_string (PyObject
*obj
);
260 char *gdbpy_exception_to_string (PyObject
*ptype
, PyObject
*pvalue
);
262 int gdbpy_is_lazy_string (PyObject
*result
);
263 void gdbpy_extract_lazy_string (PyObject
*string
, CORE_ADDR
*addr
,
264 struct type
**str_type
,
265 long *length
, char **encoding
);
267 int gdbpy_is_value_object (PyObject
*obj
);
269 /* Note that these are declared here, and not in python.h with the
270 other pretty-printer functions, because they refer to PyObject. */
271 PyObject
*apply_varobj_pretty_printer (PyObject
*print_obj
,
272 struct value
**replacement
,
273 struct ui_file
*stream
);
274 PyObject
*gdbpy_get_varobj_pretty_printer (struct value
*value
);
275 char *gdbpy_get_display_hint (PyObject
*printer
);
276 PyObject
*gdbpy_default_visualizer (PyObject
*self
, PyObject
*args
);
278 extern PyObject
*gdbpy_doc_cst
;
279 extern PyObject
*gdbpy_children_cst
;
280 extern PyObject
*gdbpy_to_string_cst
;
281 extern PyObject
*gdbpy_display_hint_cst
;
282 extern PyObject
*gdbpy_enabled_cst
;
283 extern PyObject
*gdbpy_value_cst
;
285 /* Exception types. */
286 extern PyObject
*gdbpy_gdb_error
;
287 extern PyObject
*gdbpy_gdb_memory_error
;
288 extern PyObject
*gdbpy_gdberror_exc
;
290 extern PyObject
*gdbpy_convert_exception (struct gdb_exception
);
292 int get_addr_from_python (PyObject
*obj
, CORE_ADDR
*addr
);
294 PyObject
*gdb_py_object_from_longest (LONGEST l
);
295 PyObject
*gdb_py_object_from_ulongest (ULONGEST l
);
296 int gdb_py_int_as_long (PyObject
*, long *);
298 #endif /* GDB_PYTHON_INTERNAL_H */