xref: /freebsd/contrib/kyua/utils/sqlite/c_gate.cpp (revision 911f0260390e18cf85f3dbf2c719b593efdc1e3c)
1 // Copyright 2011 The Kyua Authors.
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/fs/path.hpp"
32 #include "utils/optional.ipp"
33 #include "utils/sqlite/database.hpp"
34 
35 namespace sqlite = utils::sqlite;
36 
37 using utils::none;
38 
39 
40 /// Creates a new gateway to an existing C++ SQLite database.
41 ///
42 /// \param database_ The database to connect to.  This object must remain alive
43 ///     while the newly-constructed database_c_gate is alive.
44 sqlite::database_c_gate::database_c_gate(database& database_) :
45     _database(database_)
46 {
47 }
48 
49 
50 /// Destructor.
51 ///
52 /// Destroying this object has no implications on the life cycle of the SQLite
53 /// database.  Only the corresponding database object controls when the SQLite 3
54 /// database is closed.
55 sqlite::database_c_gate::~database_c_gate(void)
56 {
57 }
58 
59 
60 /// Creates a C++ database for a C SQLite 3 database.
61 ///
62 /// \warning The created database object does NOT own the C database.  You must
63 /// take care to properly destroy the input sqlite3 when you are done with it to
64 /// not leak resources.
65 ///
66 /// \param raw_database The raw database to wrap temporarily.
67 ///
68 /// \return The wrapped database without strong ownership on the input database.
69 sqlite::database
70 sqlite::database_c_gate::connect(::sqlite3* raw_database)
71 {
72     return database(none, static_cast< void* >(raw_database), false);
73 }
74 
75 
76 /// Returns the C native SQLite 3 database.
77 ///
78 /// \return A native sqlite3 object holding the SQLite 3 C API database.
79 ::sqlite3*
80 sqlite::database_c_gate::c_database(void)
81 {
82     return static_cast< ::sqlite3* >(_database.raw_database());
83 }
84