gbl::Exception Class Reference

Inheritance diagram for gbl::Exception:

Collaboration diagram for gbl::Exception:

Data Structures
class	TryBlock

Public Member Functions
	Exception (const CallRecord &record) noexcept
	Exception (CallRecord &&record) noexcept
virtual const char *	what (void) const noexcept
virtual const std::exception &	asStdException (void) const =0
virtual std::exception &	asStdException (void)=0
template<typename R> requires (std::is_constructible_v<Result, R> && !std::same_as<Result, R>)
	CallRecord (R resultValue, const char *pMessage=nullptr, GblObject *pObject=nullptr, SourceLocation srcLoc={}) noexcept
	CallRecord (Result result, const char *pMessage=nullptr, GblObject *pObject=nullptr, SourceLocation srcLoc={}) noexcept
	CallRecord (const GblCallRecord &other)
Public Member Functions inherited from gbl::CallRecord
template<typename R> requires (std::is_constructible_v<Result, R> && !std::same_as<Result, R>)
	CallRecord (R resultValue, const char *pMessage=nullptr, GblObject *pObject=nullptr, SourceLocation srcLoc={}) noexcept
	CallRecord (Result result, const char *pMessage=nullptr, GblObject *pObject=nullptr, SourceLocation srcLoc={}) noexcept
	CallRecord (const GblCallRecord &other)
Handle *	getHandle (void) const
Result	getResult (void) const
const SourceLocation &	getSource (void) const
const char *	getMessage (void) const
std::string	getSourceString (void) const
std::string	toString (void) const
Public Member Functions inherited from GblCallRecord
	GBL_ALIGNAS (8) char message[GBL_CTX_RESULT_MSG_BUFFER_SIZE]

Static Public Member Functions
static const CallRecord &	throwException (const CallRecord &record)
static const CallRecord &	checkThrow (const CallRecord &record)
static const CallRecord &	checkThrow (std::invocable auto fn)
static CallRecord	tryCatchRecord (std::invocable auto fn, SourceLocation loc=SourceLocation(SRC_FILE, nullptr, SRC_LN, SRC_COL)) noexcept

Additional Inherited Members
Data Fields inherited from GblCallRecord
GblSourceLocation	srcLocation
GBL_RESULT	result

Detailed Description

Definition at line 13 of file gimbal_exception.hpp.

Constructor & Destructor Documentation

Exception() [1/2]

gbl::Exception::Exception ( const CallRecord & record )

inlinenoexcept

Definition at line 18 of file gimbal_exception.hpp.

                                                :
        CallRecord(record) {}

Exception() [2/2]

gbl::Exception::Exception ( CallRecord && record )

inlinenoexcept

Definition at line 20 of file gimbal_exception.hpp.

                                           :
        CallRecord(std::move(record)) {}

Member Function Documentation

what()

virtual const char * gbl::Exception::what ( void ) const

inlinevirtualnoexcept

Definition at line 23 of file gimbal_exception.hpp.

                                                  {
        return getMessage();
    }

throwException()

const CallRecord & gbl::Exception::throwException ( const CallRecord & record )

inlinestatic

Definition at line 135 of file gimbal_exception.hpp.

                                                                           {
    switch(record.getResult().getValue()) {
    case Result::ErrorUnderflow:    throw StdException<std::underflow_error>(record);
    case Result::ErrorOverflow:     throw StdException<std::overflow_error>(record);
    case Result::ErrorOutOfRange:   throw StdException<std::out_of_range>(record);
    case Result::ErrorInvalidArg:   throw StdException<std::invalid_argument>(record);
    case Result::ErrorMemAlloc:
    case Result::ErrorMemRealloc:   throw StdException<std::bad_alloc>(record);
    default:                        throw StdException<std::exception>(record);
    }
    return record;
}

checkThrow() [1/2]

static const CallRecord & gbl::Exception::checkThrow ( const CallRecord & record )

inlinestatic

Definition at line 32 of file gimbal_exception.hpp.

                                                                  {
        if(record.getResult().isError()) {
            GBL_API_CLEAR_LAST_RECORD();
            return throwException(record);
        }
        return record;
    }

checkThrow() [2/2]

static const CallRecord & gbl::Exception::checkThrow ( std::invocable auto fn )

inlinestatic

Definition at line 40 of file gimbal_exception.hpp.

                                                              {
        const GblCallRecord* pRecord = nullptr;
        GblThread_callRecordSet(NULL, NULL);
        fn();
        pRecord = GblThread_callRecord(NULL);
        return Exception::checkThrow(*pRecord);
    }

tryCatchRecord()

CallRecord gbl::Exception::tryCatchRecord ( std::invocable auto fn, SourceLocation loc = SourceLocation(SRC_FILE, nullptr, SRC_LN, SRC_COL) )

inlinestaticnoexcept

Definition at line 112 of file gimbal_exception.hpp.

                                                                                             {
    try {
        fn();
    } catch(const Exception& gblExcept) {
        return gblExcept;
    } catch(const std::underflow_error& ex) {
        return { Result::ErrorUnderflow, ex.what() };
    } catch(const std::overflow_error& ex) {
        return { Result::ErrorOverflow, ex.what() };
    } catch(const std::out_of_range& ex) {
        return { Result::ErrorOutOfRange, ex.what() };
    } catch(const std::invalid_argument& ex) {
        return { Result::ErrorInvalidArg, ex.what() };
    } catch(const std::bad_alloc& ex) {
        return { Result::ErrorMemAlloc, ex.what() };
    } catch(const std::exception& stdEx) {
        return { Result::ErrorUnhandledException, stdEx.what() };
    } catch(...) {
        return { Result::ErrorUnhandledException, "Unknown Exception Type!" };
    }
    return Result::Success;
}

CallRecord() [1/3]

template<typename R>
requires (std::is_constructible_v<Result, R> && !std::same_as<Result, R>)

gbl::CallRecord::CallRecord ( R resultValue, const char * pMessage = nullptr, GblObject * pObject = nullptr, SourceLocation srcLoc = {} )

inlinenoexcept

Definition at line 46 of file gimbal_call_stack.hpp.

                                                                                                              {}) noexcept:
        CallRecord(Result(resultValue), pMessage, pObject, std::move(srcLoc)) {}

CallRecord() [2/3]

gbl::CallRecord::CallRecord ( Result result, const char * pMessage = nullptr, GblObject * pObject = nullptr, SourceLocation srcLoc = {} )

inlinenoexcept

Definition at line 49 of file gimbal_call_stack.hpp.

                                                                                                                     {
    GBL_CALL_RECORD_CONSTRUCT(this, pObject, result.getCode(), srcLoc, "%s", pMessage? pMessage : result.toString());
}

CallRecord() [3/3]

gbl::CallRecord::CallRecord ( const GblCallRecord & other )

inline

Definition at line 51 of file gimbal_call_stack.hpp.

                                           {
        memcpy(this, &other, sizeof(GblCallRecord));
    }

---

The documentation for this class was generated from the following file:

• gimbal_exception.hpp