database.h

Go to the documentation of this file.

/*******************************************************************************
 * Copyright © 2014 The DTVKit Open Software Foundation Ltd (www.dtvkit.org)
 * Copyright © 2013 Ocean Blue Software Ltd
 *
 * This file is part of a DTVKit Software Component
 * You are permitted to copy, modify or distribute this file subject to the terms
 * of the DTVKit 1.0 Licence which can be found in licence.txt or at www.dtvkit.org
 *
 * THIS CODE AND INFORMATION ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
 * EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.
 *
 * If you or your organisation is not a member of DTVKit then you have access
 * to this source code outside of the terms of the licence agreement
 * and you are expected to delete this and any associated files immediately.
 * Further information on DTVKit, membership and terms can be found at www.dtvkit.org
 *******************************************************************************/
#ifndef DBA_DATABASE_H
#define DBA_DATABASE_H

#include <sqlite3.h>

#include "stbllist.h"

#define ARRAY_LENGTH(X) (sizeof(X)/sizeof(*X))
#define INITIAL_VERSION 0

typedef enum
{
   OPERATION_NONE,
   OPERATION_UPDATE,
   OPERATION_CREATE,
   OPERATION_DELETE
} OPERATION_TYPE;

typedef struct
{
   U32BIT sqlite;
   const char *sql;
} S_DATA_TYPE;

typedef struct
{
   U32BIT field_type;
   const S_DATA_TYPE *data_type;
} S_COLUMN;

typedef struct
{
   U32BIT record_type;
   const S_COLUMN *columns;
   U32BIT length;
} S_TABLE;

typedef struct
{
   union
   {
      U32BIT uint;
      char *text;
      void *blob;
   } value;
   U32BIT size;
} S_FIELD;

typedef struct s_record
{
   LINK_LIST_PTR_BLK ptrs;
   const S_TABLE *table;
   sqlite3_int64 id;
   struct s_record *parent;
   struct s_record *sibling;
   struct s_record *child;
   OPERATION_TYPE operation;
   S_FIELD fields[];
} S_RECORD;

extern const S32BIT database_layout_version;
extern const S_DATA_TYPE database_type_uint;
extern const S_DATA_TYPE database_type_text;
extern const S_DATA_TYPE database_type_blob;
extern const S_TABLE database_layout[];
extern const U32BIT database_layout_length;

BOOLEAN Database_Initialise(void);

void Database_Uninitialise(void);

void Database_Clear(void);

const S_TABLE * Database_GetTable(U32BIT record_type);

const S_COLUMN * Database_GetColumn(const S_TABLE *table, U32BIT field_type);

S_RECORD * Database_GetRecord(const S_TABLE *table, const S_RECORD *prev, BOOLEAN exclude_deleted);

S_RECORD * Database_FindRecord(const S_TABLE *table, sqlite3_int64 id);

S_FIELD * Database_GetField(S_RECORD *record, const S_COLUMN *column);

S_RECORD * Database_CreateRecord(const S_TABLE *table, S_RECORD *parent);

BOOLEAN Database_DeleteRecord(S_RECORD *record);

void Database_DestroyRecord(S_RECORD *record);

void Database_AddRecordOperation(S_RECORD *record, OPERATION_TYPE operation);

void Database_ClearRecordOperation(S_RECORD *record);

S_RECORD * Database_GetRecordParent(S_RECORD *record);

void Database_SetRecordParent(S_RECORD *record, S_RECORD *parent);

U32BIT Database_GetRecordFieldUInt(S_FIELD *field);

void Database_SetRecordFieldUInt(S_FIELD *field, U32BIT value);

const char * Database_GetRecordFieldText(S_FIELD *field, U32BIT *size);

void Database_SetRecordFieldText(S_FIELD *field, const unsigned char *value, U32BIT size);

const void * Database_GetRecordFieldBlob(S_FIELD *field, U32BIT *size);

void Database_SetRecordFieldBlob(S_FIELD *field, const void *value, U32BIT size);

#endif