Skip to content

D
dlib
Commit 8d1cf196 authored by Davis King's avatar Davis King
Browse files
Options

Added missing asserts and clarified spec.

parent 5370c778
Show whitespace changes
Inline Side-by-side
Showing with 159 additions and 1 deletion
dlib/sqlite/sqlite.h
View file @ 8d1cf196
...@@ -80,6 +80,13 @@ namespace dlib ...@@ -80,6 +80,13 @@ namespace dlib
const std::string& get_database_filename ( const std::string& get_database_filename (
) const ) const
{ {
// make sure requires clause is not broken
DLIB_ASSERT(is_open() == true,
"\t std::string sqlite::database::get_database_filename()"
<< "\n\t The database must be opened before calling this routine."
<< "\n\t this: " << this
);
return filename; return filename;
} }
...@@ -111,6 +118,13 @@ namespace dlib ...@@ -111,6 +118,13 @@ namespace dlib
stmt(0), stmt(0),
sql_string(sql_statement) sql_string(sql_statement)
{ {
// make sure requires clause is not broken
DLIB_ASSERT(db_.is_open() == true,
"\t sqlite::statement::statement()"
<< "\n\t The database must be opened before calling this routine."
<< "\n\t this: " << this
);
int status = sqlite3_prepare_v2(db.get(), int status = sqlite3_prepare_v2(db.get(),
sql_string.c_str(), sql_string.c_str(),
sql_string.size()+1, sql_string.size()+1,
...@@ -209,6 +223,14 @@ namespace dlib ...@@ -209,6 +223,14 @@ namespace dlib
unsigned long idx unsigned long idx
) const ) const
{ {
// make sure requires clause is not broken
DLIB_ASSERT(idx < get_num_columns(),
"\t std::vector<char> sqlite::statement::get_column_as_blob()"
<< "\n\t Invalid column index."
<< "\n\t idx: " << idx
<< "\n\t this: " << this
);
const char* data = static_cast<const char*>(sqlite3_column_blob(stmt, idx)); const char* data = static_cast<const char*>(sqlite3_column_blob(stmt, idx));
const int size = sqlite3_column_bytes(stmt, idx); const int size = sqlite3_column_bytes(stmt, idx);
...@@ -221,6 +243,14 @@ namespace dlib ...@@ -221,6 +243,14 @@ namespace dlib
T& item T& item
) const ) const
{ {
// make sure requires clause is not broken
DLIB_ASSERT(idx < get_num_columns(),
"\t void sqlite::statement::get_column_as_object()"
<< "\n\t Invalid column index."
<< "\n\t idx: " << idx
<< "\n\t this: " << this
);
const char* data = static_cast<const char*>(sqlite3_column_blob(stmt, idx)); const char* data = static_cast<const char*>(sqlite3_column_blob(stmt, idx));
const int size = sqlite3_column_bytes(stmt, idx); const int size = sqlite3_column_bytes(stmt, idx);
std::istringstream sin(std::string(data,size)); std::istringstream sin(std::string(data,size));
...@@ -231,6 +261,14 @@ namespace dlib ...@@ -231,6 +261,14 @@ namespace dlib
unsigned long idx unsigned long idx
) const ) const
{ {
// make sure requires clause is not broken
DLIB_ASSERT(idx < get_num_columns(),
"\t std::string sqlite::statement::get_column_as_text()"
<< "\n\t Invalid column index."
<< "\n\t idx: " << idx
<< "\n\t this: " << this
);
const char* data = reinterpret_cast<const char*>(sqlite3_column_text(stmt, idx)); const char* data = reinterpret_cast<const char*>(sqlite3_column_text(stmt, idx));
return std::string(data); return std::string(data);
} }
...@@ -239,6 +277,14 @@ namespace dlib ...@@ -239,6 +277,14 @@ namespace dlib
unsigned long idx unsigned long idx
) const ) const
{ {
// make sure requires clause is not broken
DLIB_ASSERT(idx < get_num_columns(),
"\t double sqlite::statement::get_column_as_double()"
<< "\n\t Invalid column index."
<< "\n\t idx: " << idx
<< "\n\t this: " << this
);
return sqlite3_column_double(stmt, idx); return sqlite3_column_double(stmt, idx);
} }
...@@ -246,6 +292,14 @@ namespace dlib ...@@ -246,6 +292,14 @@ namespace dlib
unsigned long idx unsigned long idx
) const ) const
{ {
// make sure requires clause is not broken
DLIB_ASSERT(idx < get_num_columns(),
"\t int sqlite::statement::get_column_as_int()"
<< "\n\t Invalid column index."
<< "\n\t idx: " << idx
<< "\n\t this: " << this
);
return sqlite3_column_int(stmt, idx); return sqlite3_column_int(stmt, idx);
} }
...@@ -253,6 +307,14 @@ namespace dlib ...@@ -253,6 +307,14 @@ namespace dlib
unsigned long idx unsigned long idx
) const ) const
{ {
// make sure requires clause is not broken
DLIB_ASSERT(idx < get_num_columns(),
"\t int64 sqlite::statement::get_column_as_int64()"
<< "\n\t Invalid column index."
<< "\n\t idx: " << idx
<< "\n\t this: " << this
);
return sqlite3_column_int64(stmt, idx); return sqlite3_column_int64(stmt, idx);
} }
...@@ -260,6 +322,14 @@ namespace dlib ...@@ -260,6 +322,14 @@ namespace dlib
unsigned long idx unsigned long idx
) const ) const
{ {
// make sure requires clause is not broken
DLIB_ASSERT(idx < get_num_columns(),
"\t std::string sqlite::statement::get_column_name()"
<< "\n\t Invalid column index."
<< "\n\t idx: " << idx
<< "\n\t this: " << this
);
return std::string(sqlite3_column_name(stmt,idx)); return std::string(sqlite3_column_name(stmt,idx));
} }
...@@ -281,6 +351,15 @@ namespace dlib ...@@ -281,6 +351,15 @@ namespace dlib
const std::vector<char>& item const std::vector<char>& item
) )
{ {
// make sure requires clause is not broken
DLIB_ASSERT(1 <= parameter_id && parameter_id <= get_max_parameter_id(),
"\t void sqlite::statement::bind_blob()"
<< "\n\t Invalid parameter id."
<< "\n\t parameter_id: " << parameter_id
<< "\n\t get_max_parameter_id(): " << get_max_parameter_id()
<< "\n\t this: " << this
);
reset(); reset();
int status = sqlite3_bind_blob(stmt, parameter_id, &item[0], item.size(), SQLITE_TRANSIENT); int status = sqlite3_bind_blob(stmt, parameter_id, &item[0], item.size(), SQLITE_TRANSIENT);
...@@ -296,6 +375,15 @@ namespace dlib ...@@ -296,6 +375,15 @@ namespace dlib
const T& item const T& item
) )
{ {
// make sure requires clause is not broken
DLIB_ASSERT(1 <= parameter_id && parameter_id <= get_max_parameter_id(),
"\t void sqlite::statement::bind_object()"
<< "\n\t Invalid parameter id."
<< "\n\t parameter_id: " << parameter_id
<< "\n\t get_max_parameter_id(): " << get_max_parameter_id()
<< "\n\t this: " << this
);
reset(); reset();
std::ostringstream sout; std::ostringstream sout;
serialize(item, sout); serialize(item, sout);
...@@ -313,6 +401,15 @@ namespace dlib ...@@ -313,6 +401,15 @@ namespace dlib
const double& item const double& item
) )
{ {
// make sure requires clause is not broken
DLIB_ASSERT(1 <= parameter_id && parameter_id <= get_max_parameter_id(),
"\t void sqlite::statement::bind_double()"
<< "\n\t Invalid parameter id."
<< "\n\t parameter_id: " << parameter_id
<< "\n\t get_max_parameter_id(): " << get_max_parameter_id()
<< "\n\t this: " << this
);
reset(); reset();
int status = sqlite3_bind_double(stmt, parameter_id, item); int status = sqlite3_bind_double(stmt, parameter_id, item);
...@@ -327,6 +424,15 @@ namespace dlib ...@@ -327,6 +424,15 @@ namespace dlib
const int& item const int& item
) )
{ {
// make sure requires clause is not broken
DLIB_ASSERT(1 <= parameter_id && parameter_id <= get_max_parameter_id(),
"\t void sqlite::statement::bind_int()"
<< "\n\t Invalid parameter id."
<< "\n\t parameter_id: " << parameter_id
<< "\n\t get_max_parameter_id(): " << get_max_parameter_id()
<< "\n\t this: " << this
);
reset(); reset();
int status = sqlite3_bind_int(stmt, parameter_id, item); int status = sqlite3_bind_int(stmt, parameter_id, item);
...@@ -341,6 +447,15 @@ namespace dlib ...@@ -341,6 +447,15 @@ namespace dlib
const int64& item const int64& item
) )
{ {
// make sure requires clause is not broken
DLIB_ASSERT(1 <= parameter_id && parameter_id <= get_max_parameter_id(),
"\t void sqlite::statement::bind_int64()"
<< "\n\t Invalid parameter id."
<< "\n\t parameter_id: " << parameter_id
<< "\n\t get_max_parameter_id(): " << get_max_parameter_id()
<< "\n\t this: " << this
);
reset(); reset();
int status = sqlite3_bind_int64(stmt, parameter_id, item); int status = sqlite3_bind_int64(stmt, parameter_id, item);
...@@ -354,6 +469,15 @@ namespace dlib ...@@ -354,6 +469,15 @@ namespace dlib
unsigned long parameter_id unsigned long parameter_id
) )
{ {
// make sure requires clause is not broken
DLIB_ASSERT(1 <= parameter_id && parameter_id <= get_max_parameter_id(),
"\t void sqlite::statement::bind_null()"
<< "\n\t Invalid parameter id."
<< "\n\t parameter_id: " << parameter_id
<< "\n\t get_max_parameter_id(): " << get_max_parameter_id()
<< "\n\t this: " << this
);
reset(); reset();
int status = sqlite3_bind_null(stmt, parameter_id); int status = sqlite3_bind_null(stmt, parameter_id);
...@@ -368,6 +492,15 @@ namespace dlib ...@@ -368,6 +492,15 @@ namespace dlib
const std::string& item const std::string& item
) )
{ {
// make sure requires clause is not broken
DLIB_ASSERT(1 <= parameter_id && parameter_id <= get_max_parameter_id(),
"\t void sqlite::statement::bind_text()"
<< "\n\t Invalid parameter id."
<< "\n\t parameter_id: " << parameter_id
<< "\n\t get_max_parameter_id(): " << get_max_parameter_id()
<< "\n\t this: " << this
);
reset(); reset();
int status = sqlite3_bind_text(stmt, parameter_id, item.c_str(), -1, SQLITE_TRANSIENT); int status = sqlite3_bind_text(stmt, parameter_id, item.c_str(), -1, SQLITE_TRANSIENT);
...@@ -410,6 +543,13 @@ namespace dlib ...@@ -410,6 +543,13 @@ namespace dlib
const std::string& sql_statement const std::string& sql_statement
) )
{ {
// make sure requires clause is not broken
DLIB_ASSERT(is_open() == true,
"\t void sqlite::database::exec()"
<< "\n\t The database must be opened before calling this routine."
<< "\n\t this: " << this
);
statement(*this, sql_statement).exec(); statement(*this, sql_statement).exec();
} }
......
dlib/sqlite/sqlite_abstract.h
View file @ 8d1cf196
...@@ -23,7 +23,7 @@ namespace dlib ...@@ -23,7 +23,7 @@ namespace dlib
{ {
/*! /*!
WHAT THIS OBJECT REPRESENTS WHAT THIS OBJECT REPRESENTS
This is the exception object used by the sqlite tools to indicate This is the exception object used by the SQLite tools to indicate
that an error has occurred. An of the functions defined in this that an error has occurred. An of the functions defined in this
file might throw this exception. file might throw this exception.
!*/ !*/
...@@ -37,6 +37,11 @@ namespace dlib ...@@ -37,6 +37,11 @@ namespace dlib
WHAT THIS OBJECT REPRESENTS WHAT THIS OBJECT REPRESENTS
This object is a C++ wrapper around a SQLite database connection This object is a C++ wrapper around a SQLite database connection
handle and therefore represents a SQLite database file. handle and therefore represents a SQLite database file.
Note that this wrapper is targeted at SQLite Version 3.
Note also that whenever SQLite indicates an error has occurred
this object will throw the sqlite_error exception.
!*/ !*/
public: public:
...@@ -52,6 +57,8 @@ namespace dlib ...@@ -52,6 +57,8 @@ namespace dlib
); );
/*! /*!
ensures ensures
- opens the indicated database file or creates a new
database with the given name if one doesn't already exist.
- #get_database_filename() == file - #get_database_filename() == file
- #is_open() == true - #is_open() == true
!*/ !*/
...@@ -72,8 +79,14 @@ namespace dlib ...@@ -72,8 +79,14 @@ namespace dlib
); );
/*! /*!
ensures ensures
- opens the indicated database file or creates a new
database with the given name if one doesn't already exist.
- #get_database_filename() == file - #get_database_filename() == file
- #is_open() == true - #is_open() == true
- safely disposes of any previous SQLite database connection. If
any statement objects still exist which reference this database
then the SQLite database connection won't be fully closed
until those statement objects are also destroyed.
!*/ !*/
bool is_open ( bool is_open (
...@@ -119,6 +132,9 @@ namespace dlib ...@@ -119,6 +132,9 @@ namespace dlib
C++ wrapper around a SQLite prepared statement. C++ wrapper around a SQLite prepared statement.
Note that whenever SQLite indicates an error has occurred this
object will throw the sqlite_error exception.
BINDABLE SQL PARAMETERS BINDABLE SQL PARAMETERS
Sometimes you want to execute a bunch of very similar SQL statements. Sometimes you want to execute a bunch of very similar SQL statements.
For example, you might need to execute many insert statements where each For example, you might need to execute many insert statements where each
...@@ -158,6 +174,8 @@ namespace dlib ...@@ -158,6 +174,8 @@ namespace dlib
const std::string sql_statement const std::string sql_statement
); );
/*! /*!
requires
- db.is_open() == true
ensures ensures
- The given SQL statement can be executed against the given - The given SQL statement can be executed against the given
database by calling exec(). database by calling exec().
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment