/*
 * The page values definition of an Extensible Storage Engine (ESE) Database File (EDB)
 *
 * Copyright (C) 2009-2023, Joachim Metz <joachim.metz@gmail.com>
 *
 * Refer to AUTHORS for acknowledgements.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

#if !defined( _ESEDB_PAGE_VALUES_H )
#define _ESEDB_PAGE_VALUES_H

#include <common.h>
#include <types.h>

#if defined( __cplusplus )
extern "C" {
#endif

typedef struct esedb_root_page_header esedb_root_page_header_t;

struct esedb_root_page_header
{
	/* The initial number of pages
	 * Consists of 4 bytes
	 */
	uint8_t initial_number_of_pages[ 4 ];

	/* The parent father page (FDP) number
	 * Consists of 4 bytes
	 */
	uint8_t parent_father_data_page_number[ 4 ];

	/* Extent space
	 * Consists of 4 bytes
	 */
	uint8_t extent_space[ 4 ];

	/* The space tree page number
	 * Consists of 4 bytes
	 */
	uint8_t space_tree_page_number[ 4 ];
};

typedef struct esedb_extended_root_page_header esedb_extended_root_page_header_t;

struct esedb_extended_root_page_header
{
	/* The initial number of pages
	 * Consists of 4 bytes
	 */
	uint8_t initial_number_of_pages[ 4 ];

	/* Unknonwn
	 * Consists of 1 byte
	 */
	uint8_t unknown1;

	/* The parent father page (FDP) number
	 * Consists of 4 bytes
	 */
	uint8_t parent_father_data_page_number[ 4 ];

	/* Extent space
	 * Consists of 4 bytes
	 */
	uint8_t extent_space[ 4 ];

	/* The space tree page number
	 * Consists of 4 bytes
	 */
	uint8_t space_tree_page_number[ 4 ];

	/* Unknonwn
	 * Consists of 4 bytes
	 */
	uint8_t unknown2[ 4 ];

	/* Unknonwn
	 * Consists of 4 bytes
	 */
	uint8_t unknown3[ 4 ];
};

typedef struct esedb_space_tree_page_entry esedb_space_tree_page_entry_t;

struct esedb_space_tree_page_entry
{
	/* Size of key entry
	 * Consists of 2 bytes
	 * Contains 4
	 */
	uint8_t key_size[ 2 ];

	/* The last page number
	 * Consists of 4 bytes
	 */
	uint8_t last_page_number[ 4 ];

	/* Amount of pages
	 * Consists of 4 bytes
	 */
	uint8_t number_of_pages[ 4 ];
};

typedef struct esedb_data_definition_header esedb_data_definition_header_t;

struct esedb_data_definition_header
{
	/* The last fixed size data type
	 * Consists of 1 byte
	 */
	uint8_t last_fixed_size_data_type;

	/* The last variable size data type
	 * Consists of 1 byte
	 */
	uint8_t last_variable_size_data_type;

	/* The variable size data types offset
	 * Consists of 2 bytes
	 */
	uint8_t variable_size_data_types_offset[ 2 ];
};

typedef struct esedb_data_definition esedb_data_definition_t;

struct esedb_data_definition
{
	/* Data type identifier: 1 (ObjidTable)
	 * The father data page (FDP) object identifier
	 * Consists of 4 bytes
	 */
	uint8_t father_data_page_object_identifier[ 4 ];

	/* Data type identifier: 2 (Type)
	 * The definition type
	 * Consists of 2 bytes
	 */
	uint8_t type[ 2 ];

	/* Data type identifier: 3 (Id)
	 * The indentifier
	 * Consists of 4 bytes
	 */
	uint8_t identifier[ 4 ];

	/* Data type identifier: 4 (ColtypOrPgnoFDP)
	 */
	union
	{
		/* The father data page (FDP) number
		 * Consists of 4 bytes
		 */
		uint8_t father_data_page_number[ 4 ];

		/* The column type
		 * Consists of 4 bytes
		 */
		uint8_t column_type[ 4 ];
	};

	/* Data type identifier: 5 (SpaceUsage)
	 * The space usage (density percentage)
	 * Consists of 4 bytes
	 */
	uint8_t space_usage[ 4 ];

	/* Data type identifier: 6 (Flags)
	 * Flags
	 * Consists of 4 bytes
	 */
	uint8_t flags[ 4 ];

	/* Data type identifier: 7 (PagesOrLocale)
	 */
	union
	{
		/* The (initial) number of pages
		 * Consists of 4 bytes
		 */
		uint8_t number_of_pages[ 4 ];

		/* The codepage
		 * Consists of 4 bytes
		 */
		uint8_t codepage[ 4 ];

		/* The locale identifier
		 * Consists of 4 bytes
		 */
		uint8_t locale_identifier[ 4 ];
	};

	/* Data type identifier: 8 (RootFlag)
	 * The root flag
	 * Consists of 1 byte
	 */
	uint8_t root_flag;

	/* Data type identifier: 9 (RecordOffset)
	 * The record offset
	 * Consists of 2 bytes
	 */
	uint8_t record_offset[ 2 ];

	/* Data type identifier: 10 (LCMapFlags)
	 * LC Map flags
	 * Consists of 4 bytes
	 */
	uint8_t lc_map_flags[ 4 ];

	/* Data type identifier: 11 (KeyMost)
	 * Key most
	 * Consists of 2 bytes
	 * Introduced in Windows Vista
	 */
	uint8_t key_most[ 2 ];

	/* Data type identifier: 128 (Name)
	 * The name
	 */

	/* Data type identifier: 129 (Stats)
	 */

	/* Data type identifier: 130 (TemplateTable)
	 */

	/* Data type identifier: 131 (DefaultValue)
	 */

	/* Data type identifier: 132 (KeyFldIDs)
	 */

	/* Data type identifier: 133 (VarSegMac)
	 */

	/* Data type identifier: 134 (ConditionalColumns)
	 */

	/* Data type identifier: 135 (TupleLimits)
	 */

	/* Data type identifier: 136 (Version)
	 * Introduced in Windows Vista
	 */

	/* Data type identifier: 256 (CallbackData)
	 */

	/* Data type identifier: 257 (CallbackDependencies)
	 */
};

#if defined( __cplusplus )
}
#endif

#endif /* !defined( _ESEDB_PAGE_VALUES_H ) */