bdb_expt.hpp

ncbi源码

/*
 * ===========================================================================
 * PRODUCTION $Log: bdb_expt.hpp,v $
 * PRODUCTION Revision 1000.1  2004/04/12 17:13:23  gouriano
 * PRODUCTION PRODUCTION: UPGRADED [CATCHUP_003] Dev-tree R1.12
 * PRODUCTION
 * ===========================================================================
 */

#ifndef BDB_EXPT_HPP__
#define BDB_EXPT_HPP__

/* $Id: bdb_expt.hpp,v 1000.1 2004/04/12 17:13:23 gouriano Exp $
 * ===========================================================================
 *
 *                            PUBLIC DOMAIN NOTICE
 *               National Center for Biotechnology Information
 *
 *  This software/database is a "United States Government Work" under the
 *  terms of the United States Copyright Act.  It was written as part of
 *  the author's official duties as a United States Government employee and
 *  thus cannot be copyrighted.  This software/database is freely available
 *  to the public for use. The National Library of Medicine and the U.S.
 *  Government have not placed any restriction on its use or reproduction.
 *
 *  Although all reasonable efforts have been taken to ensure the accuracy
 *  and reliability of the software and data, the NLM and the U.S.
 *  Government do not and cannot warrant the performance or results that
 *  may be obtained by using this software or data. The NLM and the U.S.
 *  Government disclaim all warranties, express or implied, including
 *  warranties of performance, merchantability or fitness for any particular
 *  purpose.
 *
 *  Please cite the author in any work or product based on this material.
 *
 * ===========================================================================
 *
 * Author:  Anatoliy Kuznetsov
 *   
 * File Description: Berkeley DB support library. 
 *                   Exception specifications and routines.
 *
 */

/// @file bdb_expt.hpp
/// Exception specifications for BDB library.

#include <corelib/ncbiexpt.hpp>


BEGIN_NCBI_SCOPE

/** @addtogroup BDB
 *
 * @{
 */



/// Base BDB exception class

class NCBI_BDB_EXPORT CBDB_Exception : EXCEPTION_VIRTUAL_BASE public CException
{
    NCBI_EXCEPTION_DEFAULT(CBDB_Exception, CException);
};



/// Auxiliary exception class to wrap up Berkeley DB strerror function
/// 

class NCBI_BDB_EXPORT CBDB_StrErrAdapt
{
public:
    static const char* strerror(int errnum);
};




/// BDB errno exception class. 
///
/// Berkley DB can return two types of error codes:
///   0  - operation successfull
///  >0  - positive error code (errno) (file locked, no space on device, etc)
///  <0  - negative error code indicates Berkeley DB related problem.
///  db_strerror function provided by BerkeleyDB works as a superset of 
/// ::strerror function returning valid error messages for both errno and 
/// BDB error codes.

class NCBI_BDB_EXPORT CBDB_ErrnoException : 
    public CErrnoTemplExceptionEx<CBDB_Exception, CBDB_StrErrAdapt::strerror>
{
public:
    typedef CErrnoTemplExceptionEx<CBDB_Exception, CBDB_StrErrAdapt::strerror>
            CParent;

    /// Exception types
    enum EErrCode {
        eSystem,      //!< GetErrno() to return system lib specific error code
        eBerkeleyDB   //!< GetErrno() to return BerkeleyDB specific error code
    };

    virtual const char* GetErrCodeString(void) const
    {
        switch ( GetErrCode() ) {
        case eSystem:       return "eSystem";
        case eBerkeleyDB:   return "eBerkeleyDB";
        default:            return  CException::GetErrCodeString();
        }
    }

    /// Return Berkley DB related error code.
    int BDB_GetErrno() const
    {
        return GetErrno();
    }

    NCBI_EXCEPTION_DEFAULT2(CBDB_ErrnoException, CParent, int);
};



/// BDB library exception. 
/// Thrown if error is specific to the NCBI BDB C++ library.

class NCBI_BDB_EXPORT CBDB_LibException : public CBDB_Exception
{
public:
    enum EErrCode {
        eOverflow,
        eType,
        eIdxSearch,
        eInvalidValue,
        eInvalidOperation,
        eTransInProgress,
        eNull,
        eQueryError,
        eQuerySyntaxError
    };

    virtual const char* GetErrCodeString(void) const
    {
        switch (GetErrCode())
        {
        case eOverflow:          return "eOverflow";
        case eType:              return "eType";
        case eIdxSearch:         return "eIdxSearch";
        case eInvalidValue:      return "eInvalidValue";
        case eInvalidOperation:  return "eInvalidOperation";
        case eNull:              return "eNull";
        case eTransInProgress:   return "eTransInProgress";
        case eQueryError:        return "eQueryError";
        case eQuerySyntaxError:  return "eQuerySyntaxError";
        default:                 return  CException::GetErrCodeString();
        }
    }

    NCBI_EXCEPTION_DEFAULT(CBDB_LibException, CBDB_Exception);
};



#define BDB_THROW(errcode, message) \
    throw CBDB_LibException(__FILE__, __LINE__, 0, CBDB_LibException::errcode, \
                            (message))


#define BDB_ERRNO_THROW(errnum, message) \
    throw CBDB_ErrnoException(__FILE__, __LINE__, 0, \
         ((errnum > 0) ? CBDB_ErrnoException::eSystem : \
                         CBDB_ErrnoException::eBerkeleyDB), \
          (message), errnum)


#define BDB_CHECK(errnum, dbfile) \
    do { \
        if ( errnum ) { \
            std::string message = "BerkeleyDB error:"; \
            message.append(CBDB_StrErrAdapt::strerror(errnum)); \
            if (dbfile) { \
                message.append(" File:'"); \
                message.append(dbfile); \
                message.append("'"); \
            } \
            BDB_ERRNO_THROW(errnum, message); \
        } \
    } while (0)


/* @} */


END_NCBI_SCOPE


/*
 * ===========================================================================
 * $Log: bdb_expt.hpp,v $
 * Revision 1000.1  2004/04/12 17:13:23  gouriano
 * PRODUCTION: UPGRADED [CATCHUP_003] Dev-tree R1.12
 *
 * Revision 1.12  2004/02/24 19:24:48  kuznets
 * Syntax error fix
 *
 * Revision 1.11  2004/02/24 16:29:59  kuznets
 * Add error codes associated with queries (syntax, execution, etc.)
 *
 * Revision 1.10  2004/02/13 14:58:28  kuznets
 * + eQuery error code
 *
 * Revision 1.9  2003/12/10 19:13:18  kuznets
 * Added support of berkeley db transactions
 *
 * Revision 1.8  2003/09/29 14:30:22  kuznets
 * Comments doxygenification
 *
 * Revision 1.7  2003/09/26 19:51:00  kuznets
 * Comments clean up
 *
 * Revision 1.6  2003/07/22 19:20:29  kuznets
 * Added new error code: InvalidOperation.
 *
 * Revision 1.5  2003/06/27 18:57:16  dicuccio
 * Uninlined strerror() adaptor.  Changed to use #include<> instead of #include ""
 *
 * Revision 1.4  2003/06/03 18:50:09  kuznets
 * Added dll export/import specifications
 *
 * Revision 1.3  2003/04/30 19:04:06  kuznets
 * Error diagnostics improved
 *
 * Revision 1.2  2003/04/29 16:48:31  kuznets
 * Fixed minor warnings in Sun Workshop compiler
 *
 * Revision 1.1  2003/04/24 16:31:16  kuznets
 * Initial revision
 *
 *
 * ===========================================================================
 */

#endif