111 lines
3.8 KiB
C++
111 lines
3.8 KiB
C++
// Copyright (C) 2022 The Qt Company Ltd.
|
|
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
|
|
|
|
#ifndef SBKERRORS_H
|
|
#define SBKERRORS_H
|
|
|
|
#include "sbkpython.h"
|
|
#include "shibokenmacros.h"
|
|
|
|
#include <memory>
|
|
|
|
/// Craving for C++20 and std::source_location::current()
|
|
#if defined(_MSC_VER)
|
|
# define SBK_FUNC_INFO __FUNCSIG__
|
|
#elif defined(__GNUC__)
|
|
# define SBK_FUNC_INFO __PRETTY_FUNCTION__
|
|
#else
|
|
# define SBK_FUNC_INFO __FUNCTION__
|
|
#endif
|
|
|
|
namespace Shiboken
|
|
{
|
|
|
|
struct LIBSHIBOKEN_API PythonContextMarker
|
|
{
|
|
public:
|
|
PythonContextMarker(const PythonContextMarker &) = delete;
|
|
PythonContextMarker(PythonContextMarker &&) = delete;
|
|
PythonContextMarker &operator=(const PythonContextMarker &) = delete;
|
|
PythonContextMarker &operator=(PythonContextMarker &&) = delete;
|
|
|
|
explicit PythonContextMarker();
|
|
~PythonContextMarker();
|
|
void setBlocking();
|
|
};
|
|
|
|
namespace Errors
|
|
{
|
|
|
|
struct ErrorStore;
|
|
|
|
/// Temporarily stash an error set in Python
|
|
class Stash
|
|
{
|
|
public:
|
|
Stash(const Stash &) = delete;
|
|
Stash &operator=(const Stash &) = delete;
|
|
Stash(Stash &&) = delete;
|
|
Stash &operator=(Stash &&) = delete;
|
|
|
|
LIBSHIBOKEN_API Stash();
|
|
LIBSHIBOKEN_API ~Stash();
|
|
|
|
LIBSHIBOKEN_API operator bool() const { return getException() != nullptr; }
|
|
[[nodiscard]] LIBSHIBOKEN_API PyObject *getException() const;
|
|
|
|
/// Restore the stored error
|
|
LIBSHIBOKEN_API void restore();
|
|
/// Discard the stored error
|
|
LIBSHIBOKEN_API void release();
|
|
|
|
private:
|
|
std::unique_ptr<ErrorStore> m_store;
|
|
};
|
|
|
|
LIBSHIBOKEN_API void setIndexOutOfBounds(Py_ssize_t value, Py_ssize_t minValue,
|
|
Py_ssize_t maxValue);
|
|
LIBSHIBOKEN_API void setInstantiateAbstractClass(const char *name);
|
|
LIBSHIBOKEN_API void setInstantiateAbstractClassDisabledWrapper(const char *name);
|
|
LIBSHIBOKEN_API void setInstantiateNamespace(const char *name);
|
|
LIBSHIBOKEN_API void setInstantiateNonConstructible(const char *name);
|
|
LIBSHIBOKEN_API void setInvalidTypeDeletion(const char *name);
|
|
LIBSHIBOKEN_API void setOperatorNotImplemented();
|
|
LIBSHIBOKEN_API void setPureVirtualMethodError(const char *name);
|
|
LIBSHIBOKEN_API void setPrivateMethod(const char *name);
|
|
LIBSHIBOKEN_API void setReverseOperatorNotImplemented();
|
|
LIBSHIBOKEN_API void setSequenceTypeError(const char *expectedType);
|
|
LIBSHIBOKEN_API void setSetterTypeError(const char *name, const char *expectedType);
|
|
LIBSHIBOKEN_API void setWrongContainerType();
|
|
|
|
/// Report an error ASAP: Instead of printing, store for later re-raise.
|
|
/// This replaces `PyErr_Print`, which cannot report errors as exception.
|
|
/// To be used in contexts where raising errors is impossible.
|
|
LIBSHIBOKEN_API void storeErrorOrPrint();
|
|
|
|
/// Call storeErrorOrPrint() and print the context to report
|
|
/// errors when calling Python overrides of virtual functions.
|
|
LIBSHIBOKEN_API void storePythonOverrideErrorOrPrint(const char *className, const char *funcName);
|
|
|
|
/// Handle an error as in PyErr_Occurred(), but also check for errors which
|
|
/// were captured by `storeErrorOrPrint`.
|
|
/// To be used in normal error checks.
|
|
LIBSHIBOKEN_API PyObject *occurred();
|
|
|
|
} // namespace Errors
|
|
|
|
namespace Warnings
|
|
{
|
|
/// Warn about invalid return value of overwritten virtual
|
|
LIBSHIBOKEN_API void warnInvalidReturnValue(const char *className, const char *functionName,
|
|
const char *expectedType, const char *actualType);
|
|
LIBSHIBOKEN_API void warnDeprecated(const char *functionName);
|
|
LIBSHIBOKEN_API void warnDeprecated(const char *className, const char *functionName);
|
|
LIBSHIBOKEN_API void warnDeprecatedEnum(const char *enumName);
|
|
LIBSHIBOKEN_API void warnDeprecatedEnumValue(const char *enumName, const char *valueName);
|
|
} // namespace Warnings
|
|
|
|
} // namespace Shiboken
|
|
|
|
#endif // SBKERRORS_H
|