libsqlite/include/sirikata/sqlite/SQLite.hpp

Go to the documentation of this file.

/*  Sirikata -- SQLite plugin
 *  SQLite.hpp
 *
 *  Copyright (c) 2008, Stanford University
 *  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are
 *  met:
 *  * Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *  * Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *  * Neither the name of Sirikata nor the names of its contributors may
 *    be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
 * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef _SQLITE_HPP_
#define _SQLITE_HPP_

#include <sirikata/sqlite/Platform.hpp>
#include <boost/thread/shared_mutex.hpp>
#include <boost/thread/tss.hpp>
#include <boost/thread/locks.hpp>
#include <sqlite3.h>

namespace Sirikata {

class SIRIKATA_SQLITE_EXPORT SQLiteDB {
public:
    SQLiteDB(const String& name);
    ~SQLiteDB();

    sqlite3* db() const;
private:
    sqlite3* mObjectDB;
};

typedef std::tr1::shared_ptr<SQLiteDB> SQLiteDBPtr;
typedef std::tr1::weak_ptr<SQLiteDB> WeakSQLiteDBPtr;

class SIRIKATA_SQLITE_EXPORT SQLite : public AutoSingleton<SQLite> {
public:
    SQLite();
    ~SQLite();

    SQLiteDBPtr open(const String& name);
    // Check and report errors in SQLite. Returns true if there was an error,
    // false otherwise.
    static std::pair<bool, String> check_sql_error(sqlite3* db, int rc, char** sql_error_msg, const String& msg);
    // Get a string description of a result code
    static const String& resultAsString(int rc);

    static SQLite& getSingleton();
    static void destroy();
private:
    typedef boost::thread_specific_ptr<WeakSQLiteDBPtr> ThreadDBPtr;
    typedef std::map<String, std::tr1::shared_ptr<ThreadDBPtr> > DBMap;

    typedef boost::shared_mutex SharedMutex;
    typedef boost::shared_lock<SharedMutex> SharedLock;
    typedef boost::upgrade_lock<SharedMutex> UpgradeLock;
    typedef boost::upgrade_to_unique_lock<SharedMutex> UpgradedLock;
    typedef boost::unique_lock<SharedMutex> ExclusiveLock;

    DBMap mDBs;
    SharedMutex mDBMutex;
};

} // namespace Sirikata

#endif //_SQLITE_HPP_