external/bsd/kyua-cli/dist/utils/sqlite/c_gate.cpp

   1 // Copyright 2011 Google Inc.
   2 // All rights reserved.
   3 //
   4 // Redistribution and use in source and binary forms, with or without
   5 // modification, are permitted provided that the following conditions are
   6 // met:
   7 //
   8 // * Redistributions of source code must retain the above copyright
   9 //   notice, this list of conditions and the following disclaimer.
  10 // * Redistributions in binary form must reproduce the above copyright
  11 //   notice, this list of conditions and the following disclaimer in the
  12 //   documentation and/or other materials provided with the distribution.
  13 // * Neither the name of Google Inc. nor the names of its contributors
  14 //   may be used to endorse or promote products derived from this software
  15 //   without specific prior written permission.
  16 //
  17 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  18 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  19 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  20 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  21 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  22 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  23 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  24 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  25 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  27 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28
  29 #include "utils/sqlite/c_gate.hpp"
  30
  31 #include "utils/sqlite/database.hpp"
  32
  33 namespace sqlite = utils::sqlite;
  34
  35
  36 /// Creates a new gateway to an existing C++ SQLite database.
  37 ///
  38 /// \param database_ The database to connect to.  This object must remain alive
  39 ///     while the newly-constructed database_c_gate is alive.
  40 sqlite::database_c_gate::database_c_gate(database& database_) :
  41     _database(database_)
  42 {
  43 }
  44
  45
  46 /// Destructor.
  47 ///
  48 /// Destroying this object has no implications on the life cycle of the SQLite
  49 /// database.  Only the corresponding database object controls when the SQLite 3
  50 /// database is closed.
  51 sqlite::database_c_gate::~database_c_gate(void)
  52 {
  53 }
  54
  55
  56 /// Creates a C++ database for a C SQLite 3 database.
  57 ///
  58 /// \warning The created database object does NOT own the C database.  You must
  59 /// take care to properly destroy the input sqlite3 when you are done with it to
  60 /// not leak resources.
  61 ///
  62 /// \param raw_database The raw database to wrap temporarily.
  63 ///
  64 /// \return The wrapped database without strong ownership on the input database.
  65 sqlite::database
  66 sqlite::database_c_gate::connect(::sqlite3* raw_database)
  67 {
  68     return database(static_cast< void* >(raw_database), false);
  69 }
  70
  71
  72 /// Returns the C native SQLite 3 database.
  73 ///
  74 /// \return A native sqlite3 object holding the SQLite 3 C API database.
  75 ::sqlite3*
  76 sqlite::database_c_gate::c_database(void)
  77 {
  78     return static_cast< ::sqlite3* >(_database.raw_database());
  79 }