2016-02-27 10:57:29 +01:00
|
|
|
#ifndef _SQSQLITE_COMMON_HPP_
|
|
|
|
#define _SQSQLITE_COMMON_HPP_
|
|
|
|
|
|
|
|
// ------------------------------------------------------------------------------------------------
|
2016-06-03 20:31:00 +02:00
|
|
|
#include "Base/Utility.hpp"
|
2016-02-27 10:57:29 +01:00
|
|
|
|
|
|
|
// ------------------------------------------------------------------------------------------------
|
|
|
|
#include <sqlite3.h>
|
|
|
|
|
|
|
|
// ------------------------------------------------------------------------------------------------
|
|
|
|
namespace SqMod {
|
|
|
|
|
|
|
|
/* ------------------------------------------------------------------------------------------------
|
|
|
|
* Forward declarations.
|
|
|
|
*/
|
|
|
|
class Connection;
|
|
|
|
class Statement;
|
|
|
|
class Column;
|
|
|
|
class Transaction;
|
|
|
|
|
|
|
|
/* ------------------------------------------------------------------------------------------------
|
|
|
|
* SOFTWARE INFORMATION
|
|
|
|
*/
|
|
|
|
#define SQSQLITE_NAME "Squirrel SQLite Module"
|
|
|
|
#define SQSQLITE_AUTHOR "Sandu Liviu Catalin (S.L.C)"
|
|
|
|
#define SQSQLITE_COPYRIGHT "Copyright (C) 2016 Sandu Liviu Catalin"
|
|
|
|
#define SQSQLITE_HOST_NAME "SqModSQLiteHost"
|
|
|
|
#define SQSQLITE_VERSION 001
|
|
|
|
#define SQSQLITE_VERSION_STR "0.0.1"
|
|
|
|
#define SQSQLITE_VERSION_MAJOR 0
|
|
|
|
#define SQSQLITE_VERSION_MINOR 0
|
|
|
|
#define SQSQLITE_VERSION_PATCH 1
|
|
|
|
|
|
|
|
/* ------------------------------------------------------------------------------------------------
|
|
|
|
* Generate a formatted query.
|
|
|
|
*/
|
|
|
|
CSStr QFmtStr(CSStr str, ...);
|
|
|
|
|
|
|
|
/* ------------------------------------------------------------------------------------------------
|
|
|
|
* Tests if a certain query string is empty.
|
|
|
|
*/
|
|
|
|
bool IsQueryEmpty(CSStr str);
|
|
|
|
|
|
|
|
/* ------------------------------------------------------------------------------------------------
|
2016-02-27 16:53:12 +01:00
|
|
|
* Retrieve the string representation of a certain status code.
|
|
|
|
*/
|
|
|
|
CSStr GetErrStr(Int32 status);
|
|
|
|
|
|
|
|
/* ------------------------------------------------------------------------------------------------
|
|
|
|
* Set a specific heap limit.
|
2016-02-27 10:57:29 +01:00
|
|
|
*/
|
|
|
|
void SetSoftHeapLimit(Int32 limit);
|
|
|
|
|
|
|
|
/* ------------------------------------------------------------------------------------------------
|
2016-02-27 16:53:12 +01:00
|
|
|
* Release the specified amount of memory.
|
2016-02-27 10:57:29 +01:00
|
|
|
*/
|
|
|
|
Int32 ReleaseMemory(Int32 bytes);
|
|
|
|
|
|
|
|
/* ------------------------------------------------------------------------------------------------
|
2016-02-27 16:53:12 +01:00
|
|
|
* Retrieve the current memory usage.
|
2016-02-27 10:57:29 +01:00
|
|
|
*/
|
|
|
|
Object GetMemoryUsage();
|
|
|
|
|
|
|
|
/* ------------------------------------------------------------------------------------------------
|
2016-02-27 16:53:12 +01:00
|
|
|
* Retrieve the memory high watermark.
|
2016-02-27 10:57:29 +01:00
|
|
|
*/
|
|
|
|
Object GetMemoryHighwaterMark(bool reset);
|
|
|
|
|
|
|
|
/* ------------------------------------------------------------------------------------------------
|
2016-02-27 16:53:12 +01:00
|
|
|
* Retrieve the escaped version of the specified string.
|
2016-02-27 10:57:29 +01:00
|
|
|
*/
|
|
|
|
CSStr EscapeString(CSStr str);
|
|
|
|
|
|
|
|
/* ------------------------------------------------------------------------------------------------
|
2016-02-27 16:53:12 +01:00
|
|
|
* Retrieve the escaped version of the specified string using the supplied format specifier.
|
2016-02-27 10:57:29 +01:00
|
|
|
*/
|
|
|
|
CCStr EscapeStringEx(SQChar spec, CCStr str);
|
|
|
|
|
|
|
|
/* ------------------------------------------------------------------------------------------------
|
2016-02-27 16:53:12 +01:00
|
|
|
* Convert the values from the specified array to a list of column names string.
|
2016-02-27 10:57:29 +01:00
|
|
|
*/
|
|
|
|
CCStr ArrayToQueryColumns(Array & arr);
|
|
|
|
|
|
|
|
/* ------------------------------------------------------------------------------------------------
|
2016-02-27 16:53:12 +01:00
|
|
|
* Convert the keys from the specified array to a list of column names string.
|
2016-02-27 10:57:29 +01:00
|
|
|
*/
|
|
|
|
CCStr TableToQueryColumns(Table & tbl);
|
|
|
|
|
|
|
|
} // Namespace:: SqMod
|
|
|
|
|
|
|
|
#endif // _SQSQLITE_COMMON_HPP_
|