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