gdb/python/python-internal.h

   1 /* Gdb/Python header for private use by Python module.
   2
   3    Copyright (C) 2008, 2009, 2010 Free Software Foundation, Inc.
   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
  23 #include <stdio.h>
  24
  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.
  33    To work around this, undef _POSIX_C_SOURCE before we include Python.h.  */
  34 #undef _POSIX_C_SOURCE
  35
  36 #if HAVE_LIBPYTHON2_4
  37 #include "python2.4/Python.h"
  38 #include "python2.4/frameobject.h"
  39 /* Py_ssize_t is not defined until 2.5.
  40    Logical type for Py_ssize_t is Py_intptr_t, but that fails in 64-bit
  41    compilation due to several apparent mistakes in python2.4 API, so we
  42    use 'int' instead.  */
  43 typedef int Py_ssize_t;
  44 #elif HAVE_LIBPYTHON2_5
  45 #include "python2.5/Python.h"
  46 #include "python2.5/frameobject.h"
  47 #elif HAVE_LIBPYTHON2_6
  48 #include "python2.6/Python.h"
  49 #include "python2.6/frameobject.h"
  50 #else
  51 #error "Unable to find usable Python.h"
  52 #endif
  53
  54 /* If Python.h does not define WITH_THREAD, then the various
  55    GIL-related functions will not be defined.  However,
  56    PyGILState_STATE will be.  */
  57 #ifndef WITH_THREAD
  58 #define PyGILState_Ensure() ((PyGILState_STATE) 0)
  59 #define PyGILState_Release(ARG) ((void)(ARG))
  60 #define PyEval_InitThreads() 0
  61 #define PyThreadState_Swap(ARG) ((void)(ARG))
  62 #define PyEval_InitThreads() 0
  63 #define PyEval_ReleaseLock() 0
  64 #endif
  65
  66 /* In order to be able to parse symtab_and_line_to_sal_object function
  67    a real symtab_and_line structure is needed.  */
  68 #include "symtab.h"
  69
  70 /* Also needed to parse enum var_types. */
  71 #include "command.h"
  72
  73 struct block;
  74 struct value;
  75 struct language_defn;
  76 struct program_space;
  77
  78 extern PyObject *gdb_module;
  79 extern PyTypeObject value_object_type;
  80 extern PyTypeObject block_object_type;
  81 extern PyTypeObject symbol_object_type;
  82
  83 extern struct cmd_list_element *set_python_list;
  84 extern struct cmd_list_element *show_python_list;
  85
  86 PyObject *gdbpy_history (PyObject *self, PyObject *args);
  87 PyObject *gdbpy_breakpoints (PyObject *, PyObject *);
  88 PyObject *gdbpy_frame_stop_reason_string (PyObject *, PyObject *);
  89 PyObject *gdbpy_lookup_symbol (PyObject *self, PyObject *args, PyObject *kw);
  90 PyObject *gdbpy_selected_frame (PyObject *self, PyObject *args);
  91 PyObject *gdbpy_block_for_pc (PyObject *self, PyObject *args);
  92 PyObject *gdbpy_lookup_type (PyObject *self, PyObject *args, PyObject *kw);
  93 PyObject *gdbpy_create_lazy_string_object (CORE_ADDR address, long length,
  94                                            const char *encoding, struct type *type);
  95 PyObject *gdbpy_string_to_argv (PyObject *self, PyObject *args);
  96 PyObject *gdbpy_get_hook_function (const char *);
  97 PyObject *gdbpy_parameter (PyObject *self, PyObject *args);
  98 PyObject *gdbpy_parameter_value (enum var_types type, void *var);
  99 char *gdbpy_parse_command_name (char *text,
 100                                 struct cmd_list_element ***base_list,
 101                                 struct cmd_list_element **start_list);
 102
 103 PyObject *symtab_and_line_to_sal_object (struct symtab_and_line sal);
 104 PyObject *symtab_to_symtab_object (struct symtab *symtab);
 105 PyObject *symbol_to_symbol_object (struct symbol *sym);
 106 PyObject *block_to_block_object (struct block *block, struct objfile *objfile);
 107 PyObject *value_to_value_object (struct value *v);
 108 PyObject *type_to_type_object (struct type *);
 109
 110 PyObject *pspace_to_pspace_object (struct program_space *);
 111 PyObject *pspy_get_printers (PyObject *, void *);
 112
 113 PyObject *objfile_to_objfile_object (struct objfile *);
 114 PyObject *objfpy_get_printers (PyObject *, void *);
 115
 116 struct block *block_object_to_block (PyObject *obj);
 117 struct symbol *symbol_object_to_symbol (PyObject *obj);
 118 struct value *value_object_to_value (PyObject *self);
 119 struct value *convert_value_from_python (PyObject *obj);
 120 struct type *type_object_to_type (PyObject *obj);
 121 struct symtab *symtab_object_to_symtab (PyObject *obj);
 122 struct symtab_and_line *sal_object_to_symtab_and_line (PyObject *obj);
 123
 124 void gdbpy_initialize_auto_load (void);
 125 void gdbpy_initialize_values (void);
 126 void gdbpy_initialize_frames (void);
 127 void gdbpy_initialize_symtabs (void);
 128 void gdbpy_initialize_commands (void);
 129 void gdbpy_initialize_symbols (void);
 130 void gdbpy_initialize_symtabs (void);
 131 void gdbpy_initialize_blocks (void);
 132 void gdbpy_initialize_types (void);
 133 void gdbpy_initialize_functions (void);
 134 void gdbpy_initialize_pspace (void);
 135 void gdbpy_initialize_objfile (void);
 136 void gdbpy_initialize_breakpoints (void);
 137 void gdbpy_initialize_lazy_string (void);
 138 void gdbpy_initialize_parameters (void);
 139
 140 struct cleanup *make_cleanup_py_decref (PyObject *py);
 141
 142 struct cleanup *ensure_python_env (struct gdbarch *gdbarch,
 143                                    const struct language_defn *language);
 144
 145 extern struct gdbarch *python_gdbarch;
 146 extern const struct language_defn *python_language;
 147
 148 /* Use this after a TRY_EXCEPT to throw the appropriate Python
 149    exception.  */
 150 #define GDB_PY_HANDLE_EXCEPTION(Exception)                              \
 151     do {                                                                \
 152       if (Exception.reason < 0)                                         \
 153         return PyErr_Format (Exception.reason == RETURN_QUIT            \
 154                              ? PyExc_KeyboardInterrupt : PyExc_RuntimeError, \
 155                              "%s", Exception.message);                  \
 156     } while (0)
 157
 158 /* Use this after a TRY_EXCEPT to throw the appropriate Python
 159    exception.  This macro is for use inside setter functions.  */
 160 #define GDB_PY_SET_HANDLE_EXCEPTION(Exception)                          \
 161     do {                                                                \
 162       if (Exception.reason < 0)                                         \
 163         {                                                               \
 164           PyErr_Format (Exception.reason == RETURN_QUIT                 \
 165                         ? PyExc_KeyboardInterrupt : PyExc_RuntimeError, \
 166                         "%s", Exception.message);                       \
 167           return -1;                                                    \
 168         }                                                               \
 169     } while (0)
 170
 171 void gdbpy_print_stack (void);
 172
 173 void source_python_script_for_objfile (struct objfile *objfile,
 174                                        FILE *stream, const char *file);
 175
 176 PyObject *python_string_to_unicode (PyObject *obj);
 177 char *unicode_to_target_string (PyObject *unicode_str);
 178 char *python_string_to_target_string (PyObject *obj);
 179 PyObject *python_string_to_target_python_string (PyObject *obj);
 180 char *python_string_to_host_string (PyObject *obj);
 181 PyObject *target_string_to_unicode (const gdb_byte *str, int length);
 182 int gdbpy_is_string (PyObject *obj);
 183 char *gdbpy_obj_to_string (PyObject *obj);
 184 char *gdbpy_exception_to_string (PyObject *ptype, PyObject *pvalue);
 185
 186 int gdbpy_is_lazy_string (PyObject *result);
 187 gdb_byte *gdbpy_extract_lazy_string (PyObject *string,
 188                                      struct type **str_type,
 189                                      long *length, char **encoding);
 190
 191 /* Note that these are declared here, and not in python.h with the
 192    other pretty-printer functions, because they refer to PyObject.  */
 193 PyObject *apply_varobj_pretty_printer (PyObject *print_obj,
 194                                        struct value **replacement);
 195 PyObject *gdbpy_get_varobj_pretty_printer (struct value *value);
 196 char *gdbpy_get_display_hint (PyObject *printer);
 197 PyObject *gdbpy_default_visualizer (PyObject *self, PyObject *args);
 198
 199 extern PyObject *gdbpy_doc_cst;
 200 extern PyObject *gdbpy_children_cst;
 201 extern PyObject *gdbpy_to_string_cst;
 202 extern PyObject *gdbpy_display_hint_cst;
 203
 204 extern PyObject *gdbpy_gdberror_exc;
 205
 206 #endif /* GDB_PYTHON_INTERNAL_H */