gdb/python/python-internal.h

   1 /* Gdb/Python header for private use by Python module.
   2
   3    Copyright (C) 2008, 2009, 2010, 2011 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
  35    Same problem with _XOPEN_SOURCE.  */
  36 #undef _POSIX_C_SOURCE
  37 #undef _XOPEN_SOURCE
  38
  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
  43
  44 #if HAVE_LIBPYTHON2_4
  45 #include "python2.4/Python.h"
  46 #include "python2.4/frameobject.h"
  47 /* Py_ssize_t is not defined until 2.5.
  48    Logical type for Py_ssize_t is Py_intptr_t, but that fails in 64-bit
  49    compilation due to several apparent mistakes in python2.4 API, so we
  50    use 'int' instead.  */
  51 typedef int Py_ssize_t;
  52 #elif HAVE_LIBPYTHON2_5
  53 #include "python2.5/Python.h"
  54 #include "python2.5/frameobject.h"
  55 #elif HAVE_LIBPYTHON2_6
  56 #include "python2.6/Python.h"
  57 #include "python2.6/frameobject.h"
  58 #elif HAVE_LIBPYTHON2_7
  59 #include "python2.7/Python.h"
  60 #include "python2.7/frameobject.h"
  61 #else
  62 #error "Unable to find usable Python.h"
  63 #endif
  64
  65 /* If Python.h does not define WITH_THREAD, then the various
  66    GIL-related functions will not be defined.  However,
  67    PyGILState_STATE will be.  */
  68 #ifndef WITH_THREAD
  69 #define PyGILState_Ensure() ((PyGILState_STATE) 0)
  70 #define PyGILState_Release(ARG) ((void)(ARG))
  71 #define PyEval_InitThreads()
  72 #define PyThreadState_Swap(ARG) ((void)(ARG))
  73 #define PyEval_ReleaseLock()
  74 #endif
  75
  76 /* Python supplies HAVE_LONG_LONG and some `long long' support when it
  77    is available.  These defines let us handle the differences more
  78    cleanly.  */
  79 #ifdef HAVE_LONG_LONG
  80
  81 #define GDB_PY_LL_ARG "L"
  82 #define GDB_PY_LLU_ARG "K"
  83 typedef PY_LONG_LONG gdb_py_longest;
  84 typedef unsigned PY_LONG_LONG gdb_py_ulongest;
  85 #define gdb_py_long_from_longest PyLong_FromLongLong
  86 #define gdb_py_long_from_ulongest PyLong_FromUnsignedLongLong
  87 #define gdb_py_long_as_ulongest PyLong_AsUnsignedLongLong
  88
  89 #else /* HAVE_LONG_LONG */
  90
  91 #define GDB_PY_LL_ARG "L"
  92 #define GDB_PY_LLU_ARG "K"
  93 typedef long gdb_py_longest;
  94 typedef unsigned long gdb_py_ulongest;
  95 #define gdb_py_long_from_longest PyLong_FromLong
  96 #define gdb_py_long_from_ulongest PyLong_FromUnsignedLong
  97 #define gdb_py_long_as_ulongest PyLong_AsUnsignedLong
  98
  99 #endif /* HAVE_LONG_LONG */
 100
 101
 102 /* In order to be able to parse symtab_and_line_to_sal_object function
 103    a real symtab_and_line structure is needed.  */
 104 #include "symtab.h"
 105
 106 /* Also needed to parse enum var_types. */
 107 #include "command.h"
 108
 109 #include "exceptions.h"
 110
 111 struct block;
 112 struct value;
 113 struct language_defn;
 114 struct program_space;
 115
 116 extern PyObject *gdb_module;
 117 extern PyTypeObject value_object_type;
 118 extern PyTypeObject block_object_type;
 119 extern PyTypeObject symbol_object_type;
 120
 121 typedef struct
 122 {
 123   PyObject_HEAD
 124
 125   /* The thread we represent.  */
 126   struct thread_info *thread;
 127
 128   /* The Inferior object to which this thread belongs.  */
 129   PyObject *inf_obj;
 130 } thread_object;
 131
 132 extern struct cmd_list_element *set_python_list;
 133 extern struct cmd_list_element *show_python_list;
 134
 135 PyObject *gdbpy_history (PyObject *self, PyObject *args);
 136 PyObject *gdbpy_breakpoints (PyObject *, PyObject *);
 137 PyObject *gdbpy_frame_stop_reason_string (PyObject *, PyObject *);
 138 PyObject *gdbpy_lookup_symbol (PyObject *self, PyObject *args, PyObject *kw);
 139 PyObject *gdbpy_newest_frame (PyObject *self, PyObject *args);
 140 PyObject *gdbpy_selected_frame (PyObject *self, PyObject *args);
 141 PyObject *gdbpy_block_for_pc (PyObject *self, PyObject *args);
 142 PyObject *gdbpy_lookup_type (PyObject *self, PyObject *args, PyObject *kw);
 143 PyObject *gdbpy_create_lazy_string_object (CORE_ADDR address, long length,
 144                                            const char *encoding,
 145                                            struct type *type);
 146 PyObject *gdbpy_inferiors (PyObject *unused, PyObject *unused2);
 147 PyObject *gdbpy_selected_thread (PyObject *self, PyObject *args);
 148 PyObject *gdbpy_string_to_argv (PyObject *self, PyObject *args);
 149 PyObject *gdbpy_parameter (PyObject *self, PyObject *args);
 150 PyObject *gdbpy_parameter_value (enum var_types type, void *var);
 151 char *gdbpy_parse_command_name (char *text,
 152                                 struct cmd_list_element ***base_list,
 153                                 struct cmd_list_element **start_list);
 154
 155 PyObject *symtab_and_line_to_sal_object (struct symtab_and_line sal);
 156 PyObject *symtab_to_symtab_object (struct symtab *symtab);
 157 PyObject *symbol_to_symbol_object (struct symbol *sym);
 158 PyObject *block_to_block_object (struct block *block, struct objfile *objfile);
 159 PyObject *value_to_value_object (struct value *v);
 160 PyObject *type_to_type_object (struct type *);
 161 PyObject *frame_info_to_frame_object (struct frame_info *frame);
 162
 163 PyObject *pspace_to_pspace_object (struct program_space *);
 164 PyObject *pspy_get_printers (PyObject *, void *);
 165
 166 PyObject *objfile_to_objfile_object (struct objfile *);
 167 PyObject *objfpy_get_printers (PyObject *, void *);
 168
 169 thread_object *create_thread_object (struct thread_info *tp);
 170 thread_object *find_thread_object (ptid_t ptid);
 171 PyObject *find_inferior_object (int pid);
 172
 173 struct block *block_object_to_block (PyObject *obj);
 174 struct symbol *symbol_object_to_symbol (PyObject *obj);
 175 struct value *value_object_to_value (PyObject *self);
 176 struct value *convert_value_from_python (PyObject *obj);
 177 struct type *type_object_to_type (PyObject *obj);
 178 struct symtab *symtab_object_to_symtab (PyObject *obj);
 179 struct symtab_and_line *sal_object_to_symtab_and_line (PyObject *obj);
 180
 181 void gdbpy_initialize_auto_load (void);
 182 void gdbpy_initialize_values (void);
 183 void gdbpy_initialize_frames (void);
 184 void gdbpy_initialize_symtabs (void);
 185 void gdbpy_initialize_commands (void);
 186 void gdbpy_initialize_symbols (void);
 187 void gdbpy_initialize_symtabs (void);
 188 void gdbpy_initialize_blocks (void);
 189 void gdbpy_initialize_types (void);
 190 void gdbpy_initialize_functions (void);
 191 void gdbpy_initialize_pspace (void);
 192 void gdbpy_initialize_objfile (void);
 193 void gdbpy_initialize_breakpoints (void);
 194 void gdbpy_initialize_lazy_string (void);
 195 void gdbpy_initialize_parameters (void);
 196 void gdbpy_initialize_thread (void);
 197 void gdbpy_initialize_inferior (void);
 198
 199 struct cleanup *make_cleanup_py_decref (PyObject *py);
 200
 201 struct cleanup *ensure_python_env (struct gdbarch *gdbarch,
 202                                    const struct language_defn *language);
 203
 204 extern struct gdbarch *python_gdbarch;
 205 extern const struct language_defn *python_language;
 206
 207 /* Use this after a TRY_EXCEPT to throw the appropriate Python
 208    exception.  */
 209 #define GDB_PY_HANDLE_EXCEPTION(Exception)                              \
 210     do {                                                                \
 211       if (Exception.reason < 0)                                         \
 212         return gdbpy_convert_exception (Exception);                     \
 213     } while (0)
 214
 215 /* Use this after a TRY_EXCEPT to throw the appropriate Python
 216    exception.  This macro is for use inside setter functions.  */
 217 #define GDB_PY_SET_HANDLE_EXCEPTION(Exception)                          \
 218     do {                                                                \
 219       if (Exception.reason < 0)                                         \
 220         {                                                               \
 221           gdbpy_convert_exception (Exception);                          \
 222           return -1;                                                    \
 223         }                                                               \
 224     } while (0)
 225
 226 void gdbpy_print_stack (void);
 227
 228 void source_python_script_for_objfile (struct objfile *objfile,
 229                                        FILE *stream, const char *file);
 230
 231 PyObject *python_string_to_unicode (PyObject *obj);
 232 char *unicode_to_target_string (PyObject *unicode_str);
 233 char *python_string_to_target_string (PyObject *obj);
 234 PyObject *python_string_to_target_python_string (PyObject *obj);
 235 char *python_string_to_host_string (PyObject *obj);
 236 PyObject *target_string_to_unicode (const gdb_byte *str, int length);
 237 int gdbpy_is_string (PyObject *obj);
 238 char *gdbpy_obj_to_string (PyObject *obj);
 239 char *gdbpy_exception_to_string (PyObject *ptype, PyObject *pvalue);
 240
 241 int gdbpy_is_lazy_string (PyObject *result);
 242 void gdbpy_extract_lazy_string (PyObject *string, CORE_ADDR *addr,
 243                                 struct type **str_type,
 244                                 long *length, char **encoding);
 245
 246 int gdbpy_is_value_object (PyObject *obj);
 247
 248 /* Note that these are declared here, and not in python.h with the
 249    other pretty-printer functions, because they refer to PyObject.  */
 250 PyObject *apply_varobj_pretty_printer (PyObject *print_obj,
 251                                        struct value **replacement,
 252                                        struct ui_file *stream);
 253 PyObject *gdbpy_get_varobj_pretty_printer (struct value *value);
 254 char *gdbpy_get_display_hint (PyObject *printer);
 255 PyObject *gdbpy_default_visualizer (PyObject *self, PyObject *args);
 256
 257 extern PyObject *gdbpy_doc_cst;
 258 extern PyObject *gdbpy_children_cst;
 259 extern PyObject *gdbpy_to_string_cst;
 260 extern PyObject *gdbpy_display_hint_cst;
 261 extern PyObject *gdbpy_enabled_cst;
 262
 263 /* Exception types.  */
 264 extern PyObject *gdbpy_gdb_error;
 265 extern PyObject *gdbpy_gdb_memory_error;
 266 extern PyObject *gdbpy_gdberror_exc;
 267
 268 extern PyObject *gdbpy_convert_exception (struct gdb_exception);
 269
 270 int get_addr_from_python (PyObject *obj, CORE_ADDR *addr);
 271
 272 PyObject *gdb_py_object_from_longest (LONGEST l);
 273 PyObject *gdb_py_object_from_ulongest (ULONGEST l);
 274 int gdb_py_int_as_long (PyObject *, long *);
 275
 276 #endif /* GDB_PYTHON_INTERNAL_H */