database.h File Reference

Exposes functions for working with the database. More...

#include "../../include/sqlite3.h"

Go to the source code of this file.

Data Structures
struct	db_connection_t
	This struct is used for the database connection in SQLite. More...

Macros
#define	DB_OPEN_STATUS_SUCCESS   0
#define	DB_OPEN_STATUS_FAILURE   1
#define	DB_BUILD_DIR_PATH(database)
#define	DB_RESOURCE_PATH(dir, database)
#define	DB_RESOURCE_PATH_UP(dir, database)

Typedefs
typedef enum db_type_t	db_type_t

Enumerations
enum	db_type_t { DB_GAME , DB_LOCAL }

Functions
int	db_open (db_connection_t *db_connection, const char *db_name)
	This function is for the opening of the database.
void	db_close (db_connection_t *db_connection)
	This function is for the closing of the database.
int	db_is_open (const db_connection_t *db_connection)
	This function is to check if the database is open.
int	db_open_multiple_access (db_connection_t *db_connection, db_type_t type)
	This function is for the opening of the database with multiple access.

Detailed Description

Exposes functions for working with the database.

Definition in file database.h.

Macro Definition Documentation

DB_BUILD_DIR_PATH

#define DB_BUILD_DIR_PATH

(

database

)

Value:

#database

Definition at line 14 of file database.h.

DB_OPEN_STATUS_FAILURE

#define DB_OPEN_STATUS_FAILURE   1

Definition at line 11 of file database.h.

DB_OPEN_STATUS_SUCCESS

#define DB_OPEN_STATUS_SUCCESS   0

Definition at line 10 of file database.h.

DB_RESOURCE_PATH

#define DB_RESOURCE_PATH	(		dir,
			database )

Value:

"resources/database/" #dir "/" #database

Definition at line 15 of file database.h.

DB_RESOURCE_PATH_UP

#define DB_RESOURCE_PATH_UP	(		dir,
			database )

Value:

"../" DB_RESOURCE_PATH(dir, database)

Definition at line 16 of file database.h.

Enumeration Type Documentation

db_type_t

enum db_type_t

Definition at line 28 of file database.h.

                       {
    DB_GAME,
    DB_LOCAL
} db_type_t;

Function Documentation

db_close()

void db_close

(

db_connection_t *

db_connection

)

This function is for the closing of the database.

Parameters

db_connection

the database conncetion

Definition at line 22 of file database.c.

                                              {
    sqlite3_close(db_connection->db);
    db_connection->db = NULL;
}

db_is_open()

int db_is_open

(

const db_connection_t *

db_connection

)

This function is to check if the database is open.

Parameters

db_connection

the database connection

Returns

1 if open, otherwise 0

Definition at line 27 of file database.c.

                                                     {
    if (db_connection->db == NULL) {
        return 0;
    }
    return 1;
}

db_open()

int db_open	(	db_connection_t *	db_connection,
		const char *	db_name )

This function is for the opening of the database.

Parameters

db_connection	the database connection
db_name	the path name of the database

Returns

0 for success

Definition at line 12 of file database.c.

                                                                 {
    int rc = sqlite3_open(db_name, &db_connection->db);
    if (rc) {
        log_msg(ERROR, "Database", "Can't open database: %s", sqlite3_errmsg(db_connection->db));
        return DB_OPEN_STATUS_FAILURE;
    }
    return DB_OPEN_STATUS_SUCCESS;
}

db_open_multiple_access()

int db_open_multiple_access	(	db_connection_t *	db_connection,
		db_type_t	type )

This function is for the opening of the database with multiple access.

Parameters

db_connection	the database connection
type	the type of the database

Returns

0 for success

Definition at line 34 of file database.c.

                                                                            {
    const char* potential_paths[3];
    switch (type) {
        case DB_GAME:
            potential_paths[0] = DB_BUILD_DIR_PATH(dungeoncrawl_game.db);
            potential_paths[1] = DB_RESOURCE_PATH(game, dungeoncrawl_game.db);
            potential_paths[2] = DB_RESOURCE_PATH_UP(game, dungeoncrawl_game.db);
            break;
        case DB_LOCAL:
            potential_paths[0] = DB_BUILD_DIR_PATH(dungeoncrawl_local.db);
            potential_paths[1] = DB_RESOURCE_PATH(local, dungeoncrawl_local.db);
            potential_paths[2] = DB_RESOURCE_PATH_UP(local, dungeoncrawl_local.db);
            break;
        default:
            log_msg(ERROR, "Database", "Invalid database type");
            return DB_OPEN_STATUS_FAILURE;
    }
 
    for (int i = 0; i < sizeof(potential_paths) / sizeof(char*); i++) {
        const int rc = sqlite3_open_v2(potential_paths[i], &db_connection->db, SQLITE_OPEN_READWRITE, NULL);
        if (rc == SQLITE_OK) {
            return DB_OPEN_STATUS_SUCCESS;
        }
        log_msg(WARNING, "Database", "Can't open database: %s", sqlite3_errmsg(db_connection->db));
    }
    return DB_OPEN_STATUS_FAILURE;
}