mirror of
https://github.com/cuberite/SQLiteCpp.git
synced 2025-08-05 02:06:02 -04:00
136 lines
4.1 KiB
C++
136 lines
4.1 KiB
C++
/**
|
|
* @file Exception.h
|
|
* @ingroup SQLiteCpp
|
|
* @brief Encapsulation of the error message from SQLite3 on a std::runtime_error.
|
|
*
|
|
* Copyright (c) 2012-2013 Sebastien Rombauts (sebastien.rombauts@gmail.com)
|
|
*
|
|
* Distributed under the MIT License (MIT) (See accompanying file LICENSE.txt
|
|
* or copy at http://opensource.org/licenses/MIT)
|
|
*/
|
|
#pragma once
|
|
|
|
#include <stdexcept>
|
|
#include <string>
|
|
#include <sstream>
|
|
#include <sqlite3.h>
|
|
|
|
|
|
/// Compatibility with non-clang compilers.
|
|
#ifndef __has_feature
|
|
#define __has_feature(x) 0
|
|
#endif
|
|
|
|
// Detect whether the compiler supports C++11 noexcept exception specifications.
|
|
#if ( defined(__GNUC__) && ((__GNUC__ == 4 && __GNUC_MINOR__ >= 7) || (__GNUC__ > 4)) \
|
|
&& defined(__GXX_EXPERIMENTAL_CXX0X__))
|
|
// GCC 4.7 and following have noexcept
|
|
#elif defined(__clang__) && __has_feature(cxx_noexcept)
|
|
// Clang 3.0 and above have noexcept
|
|
#elif defined(_MSC_VER) && _MSC_VER > 1800
|
|
// Visual Studio 2015 and above have noexcept
|
|
#else
|
|
// Visual Studio 2013 does not support noexcept, and "throw()" is deprecated by C++11
|
|
#define noexcept
|
|
#endif
|
|
|
|
|
|
namespace SQLite
|
|
{
|
|
|
|
|
|
/**
|
|
* @brief Encapsulation of the error message from SQLite3, based on std::runtime_error.
|
|
*/
|
|
class Exception : public std::runtime_error
|
|
{
|
|
public:
|
|
/**
|
|
* @brief Encapsulation of the error message from SQLite3, based on std::runtime_error.
|
|
*
|
|
* @param[in] aErrorMessage The string message describing the SQLite error
|
|
*/
|
|
explicit Exception(const std::string& aErrorMessage) :
|
|
std::runtime_error(aErrorMessage),
|
|
mErrcode(-1), // 0 would be SQLITE_OK, which doesn't make sense
|
|
mExtendedErrcode(-1)
|
|
{
|
|
}
|
|
|
|
/**
|
|
* @brief Encapsulation of the error message from SQLite3, based on std::runtime_error.
|
|
*
|
|
* @param[in] aErrorMessage The string message describing the SQLite error
|
|
*/
|
|
explicit Exception(const std::string& aErrorMessage, int ret) :
|
|
std::runtime_error(aErrorMessage),
|
|
mErrcode(ret),
|
|
mExtendedErrcode(-1)
|
|
{
|
|
}
|
|
|
|
/**
|
|
* @brief Encapsulation of the error message from SQLite3, based on std::runtime_error.
|
|
*
|
|
* @param[in] apSQLite The SQLite object, to obtain detailed error messages from.
|
|
*/
|
|
explicit Exception(sqlite3* apSQLite) :
|
|
std::runtime_error(sqlite3_errmsg(apSQLite)),
|
|
mErrcode(sqlite3_errcode(apSQLite)),
|
|
mExtendedErrcode(sqlite3_extended_errcode(apSQLite))
|
|
{
|
|
}
|
|
|
|
/**
|
|
* @brief Encapsulation of the error message from SQLite3, based on std::runtime_error.
|
|
*
|
|
* @param[in] apSQLite The SQLite object, to obtain detailed error messages from.
|
|
* @param[in] ret Return value from function call that failed.
|
|
*/
|
|
explicit Exception(sqlite3* apSQLite, int ret) :
|
|
std::runtime_error(sqlite3_errmsg(apSQLite)),
|
|
mErrcode(ret),
|
|
mExtendedErrcode(sqlite3_extended_errcode(apSQLite))
|
|
{
|
|
}
|
|
|
|
/**
|
|
* @brief Encapsulation of the error message from SQLite3, based on std::runtime_error.
|
|
*
|
|
* @param[in] apSQLite The SQLite object, to obtain detailed error messages from.
|
|
* @param[in] ret Return value from function call that failed.
|
|
* @param[in] aErrorMessage String providing more context, added to the SQLite errmsg
|
|
*/
|
|
explicit Exception(sqlite3* apSQLite, int ret, const std::string &aErrorMessage) :
|
|
std::runtime_error(aErrorMessage + ": " + sqlite3_errmsg(apSQLite)),
|
|
mErrcode(ret),
|
|
mExtendedErrcode(sqlite3_extended_errcode(apSQLite))
|
|
{
|
|
}
|
|
|
|
/// @brief Return the result code (if any, otherwise -1).
|
|
inline int getErrorCode() const noexcept // nothrow
|
|
{
|
|
return mErrcode;
|
|
}
|
|
|
|
/// @brief Return the extended numeric result code (if any, otherwise -1).
|
|
inline int getExtendedErrorCode() const noexcept // nothrow
|
|
{
|
|
return mExtendedErrcode;
|
|
}
|
|
|
|
/// @brief Return a string, solely based on the error code
|
|
inline const char *getErrStr() const noexcept // nothrow
|
|
{
|
|
return sqlite3_errstr(mErrcode);
|
|
}
|
|
|
|
private:
|
|
const int mErrcode;
|
|
const int mExtendedErrcode;
|
|
};
|
|
|
|
|
|
} // namespace SQLite
|