Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add XML custom loader overrides #44

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,8 @@ endif()

include(FindLibXml2)
find_package(LibXml2 REQUIRED)
target_link_libraries(tmx LibXml2::LibXml2)
include_directories(${LIBXML2_INCLUDE_DIR})
list(APPEND libs ${LIBXML2_LIBRARIES})

# -- Build

Expand Down
47 changes: 38 additions & 9 deletions src/tmx_xml.c
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,21 @@
#include "tmx.h"
#include "tmx_utils.h"

/*
- Loaders -
This functions override the default XML loaders if you want to use an external filesystem instead.
*/

xmlTextReaderPtr (*tmx_xml_reader_load_func) (const char *path, const char *encoding, int options) = NULL;
void (*tmx_xml_reader_free_func) (xmlTextReaderPtr reader) = NULL;

static void
set_xml_functions(void)
{
if (!tmx_xml_reader_load_func) { tmx_xml_reader_load_func = xmlReaderForFile; }
if (!tmx_xml_reader_free_func) { tmx_xml_reader_free_func = xmlFreeTextReader; }
}

/*
- Parsers -
Each function is called when the XML reader is on an element
Expand Down Expand Up @@ -239,6 +254,8 @@ static int parse_object(xmlTextReaderPtr reader, tmx_object *obj, int is_on_map,
resource_holder *tmpl;
xmlTextReaderPtr sub_reader;

set_xml_functions();

/* parses each attribute */
if ((value = (char*)xmlTextReaderGetAttribute(reader, (xmlChar*)"id"))) { /* id */
obj->id = atoi(value);
Expand Down Expand Up @@ -273,7 +290,7 @@ static int parse_object(xmlTextReaderPtr reader, tmx_object *obj, int is_on_map,
}
if (!(obj->template_ref)) {
if (!(ab_path = mk_absolute_path(filename, value))) return 0;
if (!(sub_reader = xmlReaderForFile(ab_path, NULL, 0))) { /* opens */
if (!(sub_reader = tmx_xml_reader_load_func(ab_path, NULL, 0))) { /* opens */
tmx_err(E_XDATA, "xml parser: cannot open object template file '%s'", ab_path);
tmx_free_func(ab_path);
tmx_free_func(value);
Expand Down Expand Up @@ -836,6 +853,8 @@ static int parse_tileset_list(xmlTextReaderPtr reader, tmx_tileset_list **ts_hea
char *value, *ab_path;
xmlTextReaderPtr sub_reader;

set_xml_functions();

if (!(res_list = alloc_tileset_list())) return 0;
res_list->next = *ts_headadr;
*ts_headadr = res_list;
Expand Down Expand Up @@ -873,13 +892,14 @@ static int parse_tileset_list(xmlTextReaderPtr reader, tmx_tileset_list **ts_hea
res_list->is_embedded = 1;
}
if (!(ab_path = mk_absolute_path(filename, value))) return 0;
if (!(sub_reader = xmlReaderForFile(ab_path, NULL, 0)) || !check_reader(sub_reader)) { /* opens */
tmx_free_func(value);
if (!(sub_reader = tmx_xml_reader_load_func(ab_path, NULL, 0)) || !check_reader(sub_reader)) { /* opens */
tmx_err(E_XDATA, "xml parser: cannot open extern tileset '%s'", ab_path);
tmx_free_func(ab_path);
return 0;
}
ret = parse_tileset(sub_reader, res, rc_mgr, ab_path); /* and parses the tsx file */
xmlFreeTextReader(sub_reader);
tmx_xml_reader_free_func(sub_reader);
tmx_free_func(ab_path);
return ret;
}
Expand Down Expand Up @@ -1037,6 +1057,8 @@ static tmx_map* parse_map_document(xmlTextReaderPtr reader, tmx_resource_manager
tmx_map *res = NULL;
char *name;

set_xml_functions();

if (check_reader(reader)) {
/* DTD before root element */
if (xmlTextReaderNodeType(reader) == XML_READER_TYPE_DOCUMENT_TYPE)
Expand All @@ -1056,14 +1078,16 @@ static tmx_map* parse_map_document(xmlTextReaderPtr reader, tmx_resource_manager
}
}
cleanup:
xmlFreeTextReader(reader);
tmx_xml_reader_free_func(reader);
return res;
}

static tmx_tileset* parse_tileset_document(xmlTextReaderPtr reader, const char *filename) {
tmx_tileset *res = NULL;
char *name;

set_xml_functions();

if (check_reader(reader)) {
name = (char*) xmlTextReaderConstName(reader);
if (strcmp(name, "tileset")) {
Expand All @@ -1077,14 +1101,16 @@ static tmx_tileset* parse_tileset_document(xmlTextReaderPtr reader, const char *
}
}
}
xmlFreeTextReader(reader);
tmx_xml_reader_free_func(reader);
return res;
}

static tmx_template* parse_template_document(xmlTextReaderPtr reader, tmx_resource_manager *rc_mgr, const char *filename) {
tmx_template *res = NULL;
char *name;

set_xml_functions();

if (check_reader(reader)) {
name = (char*) xmlTextReaderConstName(reader);
if (strcmp(name, "template")) {
Expand All @@ -1098,7 +1124,7 @@ static tmx_template* parse_template_document(xmlTextReaderPtr reader, tmx_resour
}
}
}
xmlFreeTextReader(reader);
tmx_xml_reader_free_func(reader);
return res;
}

Expand All @@ -1111,8 +1137,9 @@ tmx_map *parse_xml(tmx_resource_manager *rc_mgr, const char *filename) {
tmx_map *res = NULL;

setup_libxml_mem();
set_xml_functions();

if ((reader = xmlReaderForFile(filename, NULL, 0))) {
if ((reader = tmx_xml_reader_load_func(filename, NULL, 0))) {
res = parse_map_document(reader, rc_mgr, filename);
} else {
tmx_err(E_UNKN, "xml parser: unable to open %s", filename);
Expand Down Expand Up @@ -1175,8 +1202,9 @@ tmx_tileset* parse_tsx_xml(const char *filename) {
tmx_tileset *res = NULL;

setup_libxml_mem();
set_xml_functions();

if ((reader = xmlReaderForFile(filename, NULL, 0))) {
if ((reader = tmx_xml_reader_load_func(filename, NULL, 0))) {
res = parse_tileset_document(reader, filename);
} else {
tmx_err(E_UNKN, "xml parser: unable to open %s", filename);
Expand Down Expand Up @@ -1239,8 +1267,9 @@ tmx_template* parse_tx_xml(tmx_resource_manager *rc_mgr, const char *filename) {
tmx_template *res = NULL;

setup_libxml_mem();
set_xml_functions();

if ((reader = xmlReaderForFile(filename, NULL, 0))) {
if ((reader = tmx_xml_reader_load_func(filename, NULL, 0))) {
res = parse_template_document(reader, rc_mgr, filename);
} else {
tmx_err(E_UNKN, "xml parser: unable to open %s", filename);
Expand Down
23 changes: 23 additions & 0 deletions src/tmx_xml.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
#ifndef TMX_XML_H
#define TMX_XML_H

#ifdef __cplusplus
extern "C" {
#endif

#include "tmx.h"

#include <libxml/xmlreader.h>

/*
- Loaders -
This functions override the default XML loaders if you want to use an external filesystem instead.
*/
TMXEXPORT extern xmlTextReaderPtr (*tmx_xml_reader_load_func) (const char *path, const char *encoding, int options);
TMXEXPORT extern void (*tmx_xml_reader_free_func) (xmlTextReaderPtr reader);

#ifdef __cplusplus
}
#endif

#endif