ddata.h

/**

	File:		ddata.h

	Project:	DCPU-16 Toolchain
	Component:	LibDCPU-CI-DbgFmt

	Authors:	James Rhodes
			José Manuel Díez

	Description:	Defines the API for reading and writing to debugging
			symbol formats.

**/

#ifndef __DCPU_DBG_DDATA_H
#define __DCPU_DBG_DDATA_H

#include <stdint.h>
#include <string.h>
#include <stdio.h>
#include <stdlib.h>
#include <bstring.h>
#include <simclist.h>

#define DBGFMT_MAGIC		0xC0DEBEAF
#define DBGFMT_UNDETERMINED	0xFFFF

#define DBGFMT_SYMBOL_LINE	0x1
#define DBGFMT_SYMBOL_STRING	0x2
#define DBGFMT_SYMBOL_LABEL	0x3
#define DBGFMT_SYMBOL_CFUNC	0x4
#define DBGFMT_SYMBOL_CVAR	0x5

struct dbg_sym_file
{
	uint32_t magic;
	uint32_t num_symbols;
	struct dbg_sym* symbols;
};

struct dbg_sym
{
	uint16_t length;
	uint8_t type;
	void* payload;
};

struct dbg_sym_payload_line
{
	bstring path;
	uint16_t lineno;
	uint16_t address;
};

struct dbg_sym_payload_string
{
	bstring data;
	uint16_t address;
};

struct dbg_sym_payload_label
{
	bstring label;
	uint16_t address;
};

struct dbgfmt_serialization_result
{
	uint8_t* bytestream;
	uint16_t length;
};

list_t* dbgfmt_create_list();
int dbgfmt_write(bstring path, list_t* symbols);
list_t* dbgfmt_read(bstring path, uint8_t null_on_read_failure);
void dbgfmt_free(list_t* symbols);

size_t dbgsym_meter(const void* el);
int dbgsym_comparator(const void* a, const void* b);

uint16_t dbgfmt_get_symbol_address(struct dbg_sym* symbol);
void dbgfmt_update_symbol(struct dbg_sym* symbol, uint16_t address);
void dbgfmt_update_symbol_list(list_t* symbols, uint16_t address);
void dbgfmt_finalize_symbol(struct dbg_sym* symbol, uint16_t address);

struct dbg_sym* dbgfmt_create_symbol(uint8_t type, void* payload);
struct dbg_sym* dbgfmt_copy_symbol(struct dbg_sym* other);
void dbgfmt_free_symbol(struct dbg_sym* symbol);
struct dbg_sym_payload_line* dbgfmt_create_symbol_line(bstring path, uint16_t lineno, uint16_t address);
struct dbg_sym_payload_string* dbgfmt_create_symbol_string(bstring data, uint16_t address);
struct dbg_sym_payload_label* dbgfmt_create_symbol_label(bstring data, uint16_t address);

struct dbg_sym_payload_line* dbgfmt_get_symbol_line(struct dbg_sym* bytes);
struct dbg_sym_payload_string* dbgfmt_get_symbol_string(struct dbg_sym* bytes);
struct dbg_sym_payload_label* dbgfmt_get_symbol_label(struct dbg_sym* bytes);

#endif