projects / babeltrace.git / blame
| Commit | Line | Data |
|---|---|---|
| 2d7aa9b6 PP |
1 | #ifndef BABELTRACE_PY_COMMON_INTERNAL_H |
| 2 | #define BABELTRACE_PY_COMMON_INTERNAL_H | |
| 3 | ||
| 4 | /* | |
| 5 | * Copyright (c) 2019 EfficiOS Inc. and Linux Foundation | |
| 6 | * Copyright (c) 2019 Philippe Proulx <pproulx@efficios.com> | |
| 7 | * Copyright (c) 2019 Simon Marchi <simon.marchi@efficios.com> | |
| 8 | * | |
| 9 | * Permission is hereby granted, free of charge, to any person obtaining a copy | |
| 10 | * of this software and associated documentation files (the "Software"), to deal | |
| 11 | * in the Software without restriction, including without limitation the rights | |
| 12 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
| 13 | * copies of the Software, and to permit persons to whom the Software is | |
| 14 | * furnished to do so, subject to the following conditions: | |
| 15 | * | |
| 16 | * The above copyright notice and this permission notice shall be included in | |
| 17 | * all copies or substantial portions of the Software. | |
| 18 | * | |
| 19 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
| 20 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
| 21 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
| 22 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
| 23 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
| 24 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
| 25 | * SOFTWARE. | |
| 26 | */ | |
| 27 | ||
| 28 | #include <glib.h> | |
| f33c35fb | 29 | #include <Python.h> |
| 109730d9 | 30 | #include <stdbool.h> |
| 2d7aa9b6 PP |
31 | |
| 32 | #include "common/macros.h" | |
| 33 | ||
| b53cd768 SM |
34 | /* |
| 35 | * Formats the Python traceback `py_exc_tb` using traceback.format_tb, from the | |
| 36 | * Python standard library, and return it as a Gstring. | |
| 37 | */ | |
| 38 | BT_HIDDEN | |
| 39 | GString *bt_py_common_format_tb(PyObject *py_exc_tb, int log_level); | |
| 40 | ||
| 2d7aa9b6 | 41 | /* |
| f33c35fb SM |
42 | * Formats the Python exception described by `py_exc_type`, `py_exc_value` |
| 43 | * and `py_exc_tb` and returns the formatted string, or `NULL` on error. The | |
| 44 | * returned string does NOT end with a newline. | |
| 45 | * | |
| 46 | * If `chain` is true, include all exceptions in the causality chain | |
| 47 | * (see parameter `chain` of Python's traceback.format_exception). | |
| 48 | */ | |
| 49 | BT_HIDDEN | |
| 50 | GString *bt_py_common_format_exception(PyObject *py_exc_type, | |
| 51 | PyObject *py_exc_value, PyObject *py_exc_tb, | |
| 52 | int log_level, bool chain); | |
| 53 | ||
| 54 | /* | |
| 55 | * Wrapper for `bt_py_common_format_exception` that passes the Python error | |
| 56 | * indicator (the exception currently being raised). Always include the | |
| 57 | * full exception chain. | |
| 2d7aa9b6 PP |
58 | * |
| 59 | * You must ensure that the error indicator is set with PyErr_Occurred() | |
| 60 | * before you call this function. | |
| 61 | * | |
| 62 | * This function does not modify the error indicator, that is, anything | |
| 63 | * that is fetched is always restored. | |
| 64 | */ | |
| 65 | BT_HIDDEN | |
| f33c35fb | 66 | GString *bt_py_common_format_current_exception(int log_level); |
| 2d7aa9b6 PP |
67 | |
| 68 | #endif /* BABELTRACE_PY_COMMON_INTERNAL_H */ |