Home | History | Annotate | Line # | Download | only in sqlite 
      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 /// \file c_gate.hpp
     30 /// Provides direct access to the C state of the SQLite wrappers.
     31 
     32 #if !defined(UTILS_SQLITE_C_GATE_HPP)
     33 #define UTILS_SQLITE_C_GATE_HPP
     34 
     35 extern "C" {
     36 #include <sqlite3.h>
     37 }
     38 
     39 namespace utils {
     40 namespace sqlite {
     41 
     42 
     43 class database;
     44 
     45 
     46 /// Gateway to the raw C database of SQLite 3.
     47 ///
     48 /// This class provides a mechanism to muck with the internals of the database
     49 /// wrapper class.
     50 ///
     51 /// \warning The use of this class is discouraged.  By using this class, you are
     52 /// entering the world of unsafety.  Anything you do through the objects exposed
     53 /// through this class will not be controlled by RAII patterns not validated in
     54 /// any other way, so you can end up corrupting the SQLite 3 state and later get
     55 /// crashes on otherwise perfectly-valid C++ code.
     56 class database_c_gate {
     57     /// The C++ database that this class wraps.
     58     database& _database;
     59 
     60 public:
     61     database_c_gate(database&);
     62     ~database_c_gate(void);
     63 
     64     static database connect(::sqlite3*);
     65 
     66     ::sqlite3* c_database(void);
     67 };
     68 
     69 
     70 }  // namespace sqlite
     71 }  // namespace utils
     72 
     73 #endif  // !defined(UTILS_SQLITE_C_GATE_HPP)
     74