gdb/python/python-internal.h

   1 /* Gdb/Python header for private use by Python module.
   2
   3    Copyright (C) 2008-2017 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 "extension.h"
  24 #include "extension-priv.h"
  25
  26 /* These WITH_* macros are defined by the CPython API checker that
  27    comes with the Python plugin for GCC.  See:
  28    https://gcc-python-plugin.readthedocs.org/en/latest/cpychecker.html
  29    The checker defines a WITH_ macro for each attribute it
  30    exposes.  */
  31
  32 #ifdef WITH_CPYCHECKER_RETURNS_BORROWED_REF_ATTRIBUTE
  33 #define CPYCHECKER_RETURNS_BORROWED_REF                 \
  34   __attribute__ ((cpychecker_returns_borrowed_ref))
  35 #else
  36 #define CPYCHECKER_RETURNS_BORROWED_REF
  37 #endif
  38
  39 #ifdef WITH_CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF_ATTRIBUTE
  40 #define CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF(ARG)         \
  41   __attribute__ ((cpychecker_type_object_for_typedef (ARG)))
  42 #else
  43 #define CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF(ARG)
  44 #endif
  45
  46 #ifdef WITH_CPYCHECKER_STEALS_REFERENCE_TO_ARG_ATTRIBUTE
  47 #define CPYCHECKER_STEALS_REFERENCE_TO_ARG(n) \
  48    __attribute__ ((cpychecker_steals_reference_to_arg (n)))
  49 #else
  50 #define CPYCHECKER_STEALS_REFERENCE_TO_ARG(n)
  51 #endif
  52
  53 #ifdef WITH_CPYCHECKER_SETS_EXCEPTION_ATTRIBUTE
  54 #define CPYCHECKER_SETS_EXCEPTION __attribute__ ((cpychecker_sets_exception))
  55 #else
  56 #define CPYCHECKER_SETS_EXCEPTION
  57 #endif
  58
  59 #ifdef WITH_CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION_ATTRIBUTE
  60 #define CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION               \
  61   __attribute__ ((cpychecker_negative_result_sets_exception))
  62 #else
  63 #define CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION
  64 #endif
  65
  66 /* Python 2.4 doesn't include stdint.h soon enough to get {u,}intptr_t
  67    needed by pyport.h.  */
  68 /* /usr/include/features.h on linux systems will define _POSIX_C_SOURCE
  69    if it sees _GNU_SOURCE (which config.h will define).
  70    pyconfig.h defines _POSIX_C_SOURCE to a different value than
  71    /usr/include/features.h does causing compilation to fail.
  72    To work around this, undef _POSIX_C_SOURCE before we include Python.h.
  73
  74    Same problem with _XOPEN_SOURCE.  */
  75 #undef _POSIX_C_SOURCE
  76 #undef _XOPEN_SOURCE
  77
  78 /* On sparc-solaris, /usr/include/sys/feature_tests.h defines
  79    _FILE_OFFSET_BITS, which pyconfig.h also defines.  Same work
  80    around technique as above.  */
  81 #undef _FILE_OFFSET_BITS
  82
  83 /* A kludge to avoid redefinition of snprintf on Windows by pyerrors.h.  */
  84 #if defined(_WIN32) && defined(HAVE_DECL_SNPRINTF)
  85 #define HAVE_SNPRINTF 1
  86 #endif
  87
  88 /* Request clean size types from Python.  */
  89 #define PY_SSIZE_T_CLEAN
  90
  91 /* Include the Python header files using angle brackets rather than
  92    double quotes.  On case-insensitive filesystems, this prevents us
  93    from including our python/python.h header file.  */
  94 #include <Python.h>
  95 #include <frameobject.h>
  96
  97 #if PY_MAJOR_VERSION >= 3
  98 #define IS_PY3K 1
  99 #endif
 100
 101 #ifdef IS_PY3K
 102 #define Py_TPFLAGS_HAVE_ITER 0
 103 #define Py_TPFLAGS_CHECKTYPES 0
 104
 105 #define PyInt_Check PyLong_Check
 106 #define PyInt_FromLong PyLong_FromLong
 107 #define PyInt_FromSsize_t PyLong_FromSsize_t
 108 #define PyInt_AsLong PyLong_AsLong
 109 #define PyInt_AsSsize_t PyLong_AsSsize_t
 110
 111 #define PyString_FromString PyUnicode_FromString
 112 #define PyString_Decode PyUnicode_Decode
 113 #define PyString_FromFormat PyUnicode_FromFormat
 114 #define PyString_Check PyUnicode_Check
 115 #endif
 116
 117 #if HAVE_LIBPYTHON2_4
 118 /* Py_ssize_t is not defined until 2.5.
 119    Logical type for Py_ssize_t is Py_intptr_t, but that fails in 64-bit
 120    compilation due to several apparent mistakes in python2.4 API, so we
 121    use 'int' instead.  */
 122 typedef int Py_ssize_t;
 123 #endif
 124
 125 #ifndef PyVarObject_HEAD_INIT
 126 /* Python 2.4 does not define PyVarObject_HEAD_INIT.  */
 127 #define PyVarObject_HEAD_INIT(type, size)       \
 128     PyObject_HEAD_INIT(type) size,
 129
 130 #endif
 131
 132 #ifndef Py_TYPE
 133 /* Python 2.4 does not define Py_TYPE.  */
 134 #define Py_TYPE(ob)             (((PyObject*)(ob))->ob_type)
 135 #endif
 136
 137 /* If Python.h does not define WITH_THREAD, then the various
 138    GIL-related functions will not be defined.  However,
 139    PyGILState_STATE will be.  */
 140 #ifndef WITH_THREAD
 141 #define PyGILState_Ensure() ((PyGILState_STATE) 0)
 142 #define PyGILState_Release(ARG) ((void)(ARG))
 143 #define PyEval_InitThreads()
 144 #define PyThreadState_Swap(ARG) ((void)(ARG))
 145 #define PyEval_ReleaseLock()
 146 #endif
 147
 148 /* Python supplies HAVE_LONG_LONG and some `long long' support when it
 149    is available.  These defines let us handle the differences more
 150    cleanly.  */
 151 #ifdef HAVE_LONG_LONG
 152
 153 #define GDB_PY_LL_ARG "L"
 154 #define GDB_PY_LLU_ARG "K"
 155 typedef PY_LONG_LONG gdb_py_longest;
 156 typedef unsigned PY_LONG_LONG gdb_py_ulongest;
 157 #define gdb_py_long_from_longest PyLong_FromLongLong
 158 #define gdb_py_long_from_ulongest PyLong_FromUnsignedLongLong
 159 #define gdb_py_long_as_ulongest PyLong_AsUnsignedLongLong
 160
 161 #else /* HAVE_LONG_LONG */
 162
 163 #define GDB_PY_LL_ARG "L"
 164 #define GDB_PY_LLU_ARG "K"
 165 typedef long gdb_py_longest;
 166 typedef unsigned long gdb_py_ulongest;
 167 #define gdb_py_long_from_longest PyLong_FromLong
 168 #define gdb_py_long_from_ulongest PyLong_FromUnsignedLong
 169 #define gdb_py_long_as_ulongest PyLong_AsUnsignedLong
 170
 171 #endif /* HAVE_LONG_LONG */
 172
 173 #if PY_VERSION_HEX < 0x03020000
 174 typedef long Py_hash_t;
 175 #endif
 176
 177 /* PyMem_RawMalloc appeared in Python 3.4.  For earlier versions, we can just
 178    fall back to PyMem_Malloc.  */
 179
 180 #if PY_VERSION_HEX < 0x03040000
 181 #define PyMem_RawMalloc PyMem_Malloc
 182 #endif
 183
 184 /* Python 2.6 did not wrap Py_DECREF in 'do {...} while (0)', leading
 185    to 'suggest explicit braces to avoid ambiguous ‘else’' gcc errors.
 186    Wrap it ourselves, so that callers don't need to care.  */
 187
 188 static inline void
 189 gdb_Py_DECREF (void *op) /* ARI: editCase function */
 190 {
 191   /* ... and Python 2.4 didn't cast OP to PyObject pointer on the
 192      '(op)->ob_refcnt' references within the macro.  Cast it ourselves
 193      too.  */
 194   Py_DECREF ((PyObject *) op);
 195 }
 196
 197 #undef Py_DECREF
 198 #define Py_DECREF(op) gdb_Py_DECREF (op)
 199
 200 /* The second argument to PyObject_GetAttrString was missing the 'const'
 201    qualifier in Python-2.4.  Hence, we wrap it in a function to avoid errors
 202    when compiled with -Werror.  */
 203
 204 static inline PyObject *
 205 gdb_PyObject_GetAttrString (PyObject *obj,
 206                             const char *attr) /* ARI: editCase function */
 207 {
 208   return PyObject_GetAttrString (obj, (char *) attr);
 209 }
 210
 211 #define PyObject_GetAttrString(obj, attr) gdb_PyObject_GetAttrString (obj, attr)
 212
 213 /* The second argument to PyObject_HasAttrString was also missing the 'const'
 214    qualifier in Python-2.4.  Hence, we wrap it also in a function to avoid
 215    errors when compiled with -Werror.  */
 216
 217 static inline int
 218 gdb_PyObject_HasAttrString (PyObject *obj,
 219                             const char *attr)  /* ARI: editCase function */
 220 {
 221   return PyObject_HasAttrString (obj, (char *) attr);
 222 }
 223
 224 #define PyObject_HasAttrString(obj, attr) gdb_PyObject_HasAttrString (obj, attr)
 225
 226 /* In order to be able to parse symtab_and_line_to_sal_object function
 227    a real symtab_and_line structure is needed.  */
 228 #include "symtab.h"
 229
 230 /* Also needed to parse enum var_types. */
 231 #include "command.h"
 232 #include "breakpoint.h"
 233
 234 enum gdbpy_iter_kind { iter_keys, iter_values, iter_items };
 235
 236 struct block;
 237 struct value;
 238 struct language_defn;
 239 struct program_space;
 240 struct bpstats;
 241 struct inferior;
 242
 243 extern int gdb_python_initialized;
 244
 245 extern PyObject *gdb_module;
 246 extern PyObject *gdb_python_module;
 247 extern PyTypeObject value_object_type
 248     CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF ("value_object");
 249 extern PyTypeObject block_object_type
 250     CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF("block_object");
 251 extern PyTypeObject symbol_object_type
 252     CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF ("symbol_object");
 253 extern PyTypeObject event_object_type
 254     CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF ("event_object");
 255 extern PyTypeObject stop_event_object_type
 256     CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF ("event_object");
 257 extern PyTypeObject breakpoint_object_type
 258     CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF ("breakpoint_object");
 259 extern PyTypeObject frame_object_type
 260     CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF ("frame_object");
 261
 262 typedef struct gdbpy_breakpoint_object
 263 {
 264   PyObject_HEAD
 265
 266   /* The breakpoint number according to gdb.  */
 267   int number;
 268
 269   /* The gdb breakpoint object, or NULL if the breakpoint has been
 270      deleted.  */
 271   struct breakpoint *bp;
 272
 273   /* 1 is this is a FinishBreakpoint object, 0 otherwise.  */
 274   int is_finish_bp;
 275 } gdbpy_breakpoint_object;
 276
 277 /* Require that BREAKPOINT be a valid breakpoint ID; throw a Python
 278    exception if it is invalid.  */
 279 #define BPPY_REQUIRE_VALID(Breakpoint)                                  \
 280     do {                                                                \
 281       if ((Breakpoint)->bp == NULL)                                     \
 282         return PyErr_Format (PyExc_RuntimeError,                        \
 283                              _("Breakpoint %d is invalid."),            \
 284                              (Breakpoint)->number);                     \
 285     } while (0)
 286
 287 /* Require that BREAKPOINT be a valid breakpoint ID; throw a Python
 288    exception if it is invalid.  This macro is for use in setter functions.  */
 289 #define BPPY_SET_REQUIRE_VALID(Breakpoint)                              \
 290     do {                                                                \
 291       if ((Breakpoint)->bp == NULL)                                     \
 292         {                                                               \
 293           PyErr_Format (PyExc_RuntimeError, _("Breakpoint %d is invalid."), \
 294                         (Breakpoint)->number);                          \
 295           return -1;                                                    \
 296         }                                                               \
 297     } while (0)
 298
 299
 300 /* Variables used to pass information between the Breakpoint
 301    constructor and the breakpoint-created hook function.  */
 302 extern gdbpy_breakpoint_object *bppy_pending_object;
 303
 304
 305 typedef struct
 306 {
 307   PyObject_HEAD
 308
 309   /* The thread we represent.  */
 310   struct thread_info *thread;
 311
 312   /* The Inferior object to which this thread belongs.  */
 313   PyObject *inf_obj;
 314 } thread_object;
 315
 316 extern struct cmd_list_element *set_python_list;
 317 extern struct cmd_list_element *show_python_list;
 318 \f
 319 /* extension_language_script_ops "methods".  */
 320
 321 extern int gdbpy_auto_load_enabled (const struct extension_language_defn *);
 322
 323 /* extension_language_ops "methods".  */
 324
 325 extern enum ext_lang_rc gdbpy_apply_val_pretty_printer
 326   (const struct extension_language_defn *,
 327    struct type *type,
 328    LONGEST embedded_offset, CORE_ADDR address,
 329    struct ui_file *stream, int recurse,
 330    struct value *val,
 331    const struct value_print_options *options,
 332    const struct language_defn *language);
 333 extern enum ext_lang_bt_status gdbpy_apply_frame_filter
 334   (const struct extension_language_defn *,
 335    struct frame_info *frame, int flags, enum ext_lang_frame_args args_type,
 336    struct ui_out *out, int frame_low, int frame_high);
 337 extern void gdbpy_preserve_values (const struct extension_language_defn *,
 338                                    struct objfile *objfile,
 339                                    htab_t copied_types);
 340 extern enum ext_lang_bp_stop gdbpy_breakpoint_cond_says_stop
 341   (const struct extension_language_defn *, struct breakpoint *);
 342 extern int gdbpy_breakpoint_has_cond (const struct extension_language_defn *,
 343                                       struct breakpoint *b);
 344
 345 extern void *gdbpy_clone_xmethod_worker_data
 346   (const struct extension_language_defn *extlang, void *data);
 347 extern void gdbpy_free_xmethod_worker_data
 348   (const struct extension_language_defn *extlang, void *data);
 349 extern enum ext_lang_rc gdbpy_get_matching_xmethod_workers
 350   (const struct extension_language_defn *extlang,
 351    struct type *obj_type, const char *method_name,
 352    xmethod_worker_vec **dm_vec);
 353 extern enum ext_lang_rc gdbpy_get_xmethod_arg_types
 354   (const struct extension_language_defn *extlang,
 355    struct xmethod_worker *worker,
 356    int *nargs,
 357    struct type ***arg_types);
 358 extern enum ext_lang_rc gdbpy_get_xmethod_result_type
 359   (const struct extension_language_defn *extlang,
 360    struct xmethod_worker *worker,
 361    struct value *object, struct value **args, int nargs,
 362    struct type **result_type);
 363 extern struct value *gdbpy_invoke_xmethod
 364   (const struct extension_language_defn *extlang,
 365    struct xmethod_worker *worker,
 366    struct value *obj, struct value **args, int nargs);
 367 \f
 368 PyObject *gdbpy_history (PyObject *self, PyObject *args);
 369 PyObject *gdbpy_breakpoints (PyObject *, PyObject *);
 370 PyObject *gdbpy_frame_stop_reason_string (PyObject *, PyObject *);
 371 PyObject *gdbpy_lookup_symbol (PyObject *self, PyObject *args, PyObject *kw);
 372 PyObject *gdbpy_lookup_global_symbol (PyObject *self, PyObject *args,
 373                                       PyObject *kw);
 374 PyObject *gdbpy_start_recording (PyObject *self, PyObject *args);
 375 PyObject *gdbpy_current_recording (PyObject *self, PyObject *args);
 376 PyObject *gdbpy_stop_recording (PyObject *self, PyObject *args);
 377 PyObject *gdbpy_newest_frame (PyObject *self, PyObject *args);
 378 PyObject *gdbpy_selected_frame (PyObject *self, PyObject *args);
 379 PyObject *gdbpy_block_for_pc (PyObject *self, PyObject *args);
 380 PyObject *gdbpy_lookup_type (PyObject *self, PyObject *args, PyObject *kw);
 381 int gdbpy_is_field (PyObject *obj);
 382 PyObject *gdbpy_create_lazy_string_object (CORE_ADDR address, long length,
 383                                            const char *encoding,
 384                                            struct type *type);
 385 PyObject *gdbpy_inferiors (PyObject *unused, PyObject *unused2);
 386 PyObject *gdbpy_create_ptid_object (ptid_t ptid);
 387 PyObject *gdbpy_selected_thread (PyObject *self, PyObject *args);
 388 PyObject *gdbpy_selected_inferior (PyObject *self, PyObject *args);
 389 PyObject *gdbpy_string_to_argv (PyObject *self, PyObject *args);
 390 PyObject *gdbpy_parameter_value (enum var_types type, void *var);
 391 char *gdbpy_parse_command_name (const char *name,
 392                                 struct cmd_list_element ***base_list,
 393                                 struct cmd_list_element **start_list);
 394
 395 PyObject *symtab_and_line_to_sal_object (struct symtab_and_line sal);
 396 PyObject *symtab_to_symtab_object (struct symtab *symtab);
 397 PyObject *symbol_to_symbol_object (struct symbol *sym);
 398 PyObject *block_to_block_object (const struct block *block,
 399                                  struct objfile *objfile);
 400 PyObject *value_to_value_object (struct value *v);
 401 PyObject *type_to_type_object (struct type *);
 402 PyObject *frame_info_to_frame_object (struct frame_info *frame);
 403 PyObject *symtab_to_linetable_object (PyObject *symtab);
 404 PyObject *pspace_to_pspace_object (struct program_space *)
 405     CPYCHECKER_RETURNS_BORROWED_REF;
 406 PyObject *pspy_get_printers (PyObject *, void *);
 407 PyObject *pspy_get_frame_filters (PyObject *, void *);
 408 PyObject *pspy_get_frame_unwinders (PyObject *, void *);
 409 PyObject *pspy_get_xmethods (PyObject *, void *);
 410
 411 PyObject *objfile_to_objfile_object (struct objfile *)
 412     CPYCHECKER_RETURNS_BORROWED_REF;
 413 PyObject *objfpy_get_printers (PyObject *, void *);
 414 PyObject *objfpy_get_frame_filters (PyObject *, void *);
 415 PyObject *objfpy_get_frame_unwinders (PyObject *, void *);
 416 PyObject *objfpy_get_xmethods (PyObject *, void *);
 417 PyObject *gdbpy_lookup_objfile (PyObject *self, PyObject *args, PyObject *kw);
 418
 419 PyObject *gdbarch_to_arch_object (struct gdbarch *gdbarch);
 420
 421 thread_object *create_thread_object (struct thread_info *tp);
 422 thread_object *find_thread_object (ptid_t ptid)
 423     CPYCHECKER_RETURNS_BORROWED_REF;
 424 PyObject *find_inferior_object (int pid);
 425 PyObject *inferior_to_inferior_object (struct inferior *inferior);
 426
 427 const struct block *block_object_to_block (PyObject *obj);
 428 struct symbol *symbol_object_to_symbol (PyObject *obj);
 429 struct value *value_object_to_value (PyObject *self);
 430 struct value *convert_value_from_python (PyObject *obj);
 431 struct type *type_object_to_type (PyObject *obj);
 432 struct symtab *symtab_object_to_symtab (PyObject *obj);
 433 struct symtab_and_line *sal_object_to_symtab_and_line (PyObject *obj);
 434 struct frame_info *frame_object_to_frame_info (PyObject *frame_obj);
 435 struct gdbarch *arch_object_to_gdbarch (PyObject *obj);
 436
 437 void gdbpy_initialize_gdb_readline (void);
 438 int gdbpy_initialize_auto_load (void)
 439   CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
 440 int gdbpy_initialize_values (void)
 441   CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
 442 int gdbpy_initialize_frames (void)
 443   CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
 444 int gdbpy_initialize_btrace (void)
 445   CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
 446 int gdbpy_initialize_record (void)
 447   CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
 448 int gdbpy_initialize_symtabs (void)
 449   CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
 450 int gdbpy_initialize_commands (void)
 451   CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
 452 int gdbpy_initialize_symbols (void)
 453   CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
 454 int gdbpy_initialize_symtabs (void)
 455   CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
 456 int gdbpy_initialize_blocks (void)
 457   CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
 458 int gdbpy_initialize_types (void)
 459   CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
 460 int gdbpy_initialize_functions (void)
 461   CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
 462 int gdbpy_initialize_pspace (void)
 463   CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
 464 int gdbpy_initialize_objfile (void)
 465   CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
 466 int gdbpy_initialize_breakpoints (void)
 467   CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
 468 int gdbpy_initialize_finishbreakpoints (void)
 469   CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
 470 int gdbpy_initialize_lazy_string (void)
 471   CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
 472 int gdbpy_initialize_linetable (void)
 473   CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
 474 int gdbpy_initialize_parameters (void)
 475   CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
 476 int gdbpy_initialize_thread (void)
 477   CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
 478 int gdbpy_initialize_inferior (void)
 479   CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
 480 int gdbpy_initialize_eventregistry (void)
 481   CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
 482 int gdbpy_initialize_event (void)
 483   CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
 484 int gdbpy_initialize_py_events (void)
 485   CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
 486 int gdbpy_initialize_stop_event (void)
 487   CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
 488 int gdbpy_initialize_signal_event (void)
 489   CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
 490 int gdbpy_initialize_breakpoint_event (void)
 491   CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
 492 int gdbpy_initialize_continue_event (void)
 493   CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
 494 int gdbpy_initialize_inferior_call_pre_event (void)
 495   CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
 496 int gdbpy_initialize_inferior_call_post_event (void)
 497   CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
 498 int gdbpy_initialize_register_changed_event (void)
 499   CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
 500 int gdbpy_initialize_memory_changed_event (void)
 501   CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
 502 int gdbpy_initialize_exited_event (void)
 503   CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
 504 int gdbpy_initialize_thread_event (void)
 505   CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
 506 int gdbpy_initialize_new_objfile_event (void)
 507   CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
 508 int gdbpy_initialize_clear_objfiles_event (void)
 509   CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
 510 int gdbpy_initialize_arch (void)
 511   CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
 512 int gdbpy_initialize_xmethods (void)
 513   CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
 514 int gdbpy_initialize_unwind (void)
 515   CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
 516
 517 /* Called before entering the Python interpreter to install the
 518    current language and architecture to be used for Python values.
 519    Also set the active extension language for GDB so that SIGINT's
 520    are directed our way, and if necessary install the right SIGINT
 521    handler.  */
 522 class gdbpy_enter
 523 {
 524  public:
 525
 526   gdbpy_enter (struct gdbarch *gdbarch, const struct language_defn *language);
 527
 528   ~gdbpy_enter ();
 529
 530   gdbpy_enter (const gdbpy_enter &) = delete;
 531   gdbpy_enter &operator= (const gdbpy_enter &) = delete;
 532
 533  private:
 534
 535   struct active_ext_lang_state *m_previous_active;
 536   PyGILState_STATE m_state;
 537   struct gdbarch *m_gdbarch;
 538   const struct language_defn *m_language;
 539   PyObject *m_error_type, *m_error_value, *m_error_traceback;
 540 };
 541
 542 /* Like gdbpy_enter, but takes a varobj.  This is a subclass just to
 543    make constructor delegation a little nicer.  */
 544 class gdbpy_enter_varobj : public gdbpy_enter
 545 {
 546  public:
 547
 548   /* This is defined in varobj.c, where it can access varobj
 549      internals.  */
 550   gdbpy_enter_varobj (const struct varobj *var);
 551
 552 };
 553
 554 extern struct gdbarch *python_gdbarch;
 555 extern const struct language_defn *python_language;
 556
 557 /* Use this after a TRY_EXCEPT to throw the appropriate Python
 558    exception.  */
 559 #define GDB_PY_HANDLE_EXCEPTION(Exception)      \
 560   do {                                          \
 561     if (Exception.reason < 0)                   \
 562       {                                         \
 563         gdbpy_convert_exception (Exception);    \
 564         return NULL;                            \
 565       }                                         \
 566   } while (0)
 567
 568 /* Use this after a TRY_EXCEPT to throw the appropriate Python
 569    exception.  This macro is for use inside setter functions.  */
 570 #define GDB_PY_SET_HANDLE_EXCEPTION(Exception)                          \
 571     do {                                                                \
 572       if (Exception.reason < 0)                                         \
 573         {                                                               \
 574           gdbpy_convert_exception (Exception);                          \
 575           return -1;                                                    \
 576         }                                                               \
 577     } while (0)
 578
 579 int gdbpy_print_python_errors_p (void);
 580 void gdbpy_print_stack (void);
 581
 582 PyObject *python_string_to_unicode (PyObject *obj);
 583 gdb::unique_xmalloc_ptr<char> unicode_to_target_string (PyObject *unicode_str);
 584 gdb::unique_xmalloc_ptr<char> python_string_to_target_string (PyObject *obj);
 585 PyObject *python_string_to_target_python_string (PyObject *obj);
 586 gdb::unique_xmalloc_ptr<char> python_string_to_host_string (PyObject *obj);
 587 PyObject *host_string_to_python_string (const char *str);
 588 int gdbpy_is_string (PyObject *obj);
 589 gdb::unique_xmalloc_ptr<char> gdbpy_obj_to_string (PyObject *obj);
 590 gdb::unique_xmalloc_ptr<char> gdbpy_exception_to_string (PyObject *ptype,
 591                                                          PyObject *pvalue);
 592
 593 int gdbpy_is_lazy_string (PyObject *result);
 594 void gdbpy_extract_lazy_string (PyObject *string, CORE_ADDR *addr,
 595                                 struct type **str_type,
 596                                 long *length,
 597                                 gdb::unique_xmalloc_ptr<char> *encoding);
 598
 599 int gdbpy_is_value_object (PyObject *obj);
 600
 601 /* Note that these are declared here, and not in python.h with the
 602    other pretty-printer functions, because they refer to PyObject.  */
 603 PyObject *apply_varobj_pretty_printer (PyObject *print_obj,
 604                                        struct value **replacement,
 605                                        struct ui_file *stream);
 606 PyObject *gdbpy_get_varobj_pretty_printer (struct value *value);
 607 gdb::unique_xmalloc_ptr<char> gdbpy_get_display_hint (PyObject *printer);
 608 PyObject *gdbpy_default_visualizer (PyObject *self, PyObject *args);
 609
 610 void bpfinishpy_pre_stop_hook (struct gdbpy_breakpoint_object *bp_obj);
 611 void bpfinishpy_post_stop_hook (struct gdbpy_breakpoint_object *bp_obj);
 612
 613 extern PyObject *gdbpy_doc_cst;
 614 extern PyObject *gdbpy_children_cst;
 615 extern PyObject *gdbpy_to_string_cst;
 616 extern PyObject *gdbpy_display_hint_cst;
 617 extern PyObject *gdbpy_enabled_cst;
 618 extern PyObject *gdbpy_value_cst;
 619
 620 /* Exception types.  */
 621 extern PyObject *gdbpy_gdb_error;
 622 extern PyObject *gdbpy_gdb_memory_error;
 623 extern PyObject *gdbpy_gdberror_exc;
 624
 625 extern void gdbpy_convert_exception (struct gdb_exception)
 626     CPYCHECKER_SETS_EXCEPTION;
 627
 628 int get_addr_from_python (PyObject *obj, CORE_ADDR *addr)
 629     CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
 630
 631 PyObject *gdb_py_object_from_longest (LONGEST l);
 632 PyObject *gdb_py_object_from_ulongest (ULONGEST l);
 633 int gdb_py_int_as_long (PyObject *, long *);
 634
 635 PyObject *gdb_py_generic_dict (PyObject *self, void *closure);
 636
 637 int gdb_pymodule_addobject (PyObject *module, const char *name,
 638                             PyObject *object)
 639   CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
 640
 641 struct varobj_iter;
 642 struct varobj;
 643 struct varobj_iter *py_varobj_get_iterator (struct varobj *var,
 644                                             PyObject *printer);
 645
 646 #endif /* GDB_PYTHON_INTERNAL_H */