rockbox/apps/plugins/xworld/serializer.h
Franklin Wei 33cb13dee5 Xworld - Another World interpreter for Rockbox
Co-conspirators: Franklin Wei, Benjamin Brown

--------------------------------------------------------------------
This work is based on:
- Fabien Sanglard's "Fabother World" based on
- Piotr Padkowski's newRaw interpreter which was based on
- Gregory Montoir's reverse engineering of
- Eric Chahi's assembly code

--------------------------------------------------------------------
Progress:

* The plugin runs pretty nicely (with sound!) on most color targets
* Keymaps for color LCD targets are complete
* The manual entry is finished
* Grayscale/monochrome support is NOT PLANNED
  - the game looks horrible in grayscale! :p

--------------------------------------------------------------------
Notes:

* The original game strings were built-in to the executable, and
  were copyrighted and could not be used.
* This port ships with an alternate set of strings by default, but
  can load the "official" strings from a file at runtime.

--------------------------------------------------------------------
To be done (in descending order of importance):

* vertical stride compatibility                          <30% done>
* optimization                                           <10% done>

Change-Id: I3155b0d97c2ac470cb8a2040f40d4139ddcebfa5
Reviewed-on: http://gerrit.rockbox.org/1077
Reviewed-by: Michael Giacomelli <giac2000@hotmail.com>
2014-12-23 23:48:12 +01:00

84 lines
2.2 KiB
C

/***************************************************************************
* __________ __ ___.
* Open \______ \ ____ ____ | | _\_ |__ _______ ___
* Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
* Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
* Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
* \/ \/ \/ \/ \/
* $Id$
*
* Copyright (C) 2014 Franklin Wei, Benjamin Brown
* Copyright (C) 2004 Gregory Montoir
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
* KIND, either express or implied.
*
***************************************************************************/
#ifndef __SERIALIZER_H__
#define __SERIALIZER_H__
#include "intern.h"
#define CUR_VER 2
#define VER(x) x
enum EntryType {
SET_INT,
SET_ARRAY,
SET_PTR,
SET_END
};
#define SE_INT(i,sz,ver) { SET_INT, sz, 1, i, ver, CUR_VER }
#define SE_ARRAY(a,n,sz,ver) { SET_ARRAY, sz, n, a, ver, CUR_VER }
#define SE_PTR(p,ver) { SET_PTR, 0, 0, p, ver, CUR_VER }
#define SE_END() { SET_END, 0, 0, 0, 0, 0 }
struct File;
enum {
SES_BOOL = 1,
SES_INT8 = 1,
SES_INT16 = 2,
SES_INT32 = 4
};
enum Mode {
SM_SAVE,
SM_LOAD
};
struct Entry {
enum EntryType type;
uint8_t size;
uint16_t n;
void *data;
uint16_t minVer;
uint16_t maxVer;
};
struct Serializer {
File *_stream;
enum Mode _mode;
uint8_t *_ptrBlock;
uint16_t _saveVer;
uint32_t _bytesCount;
};
void ser_create(struct Serializer*, File *stream, enum Mode mode, uint8_t *ptrBlock, uint16_t saveVer);
void ser_saveOrLoadEntries(struct Serializer*, struct Entry *entry);
void ser_saveEntries(struct Serializer*, struct Entry *entry);
void ser_loadEntries(struct Serializer*, struct Entry *entry);
void ser_saveInt(struct Serializer*, uint8_t es, void *p);
void ser_loadInt(struct Serializer*, uint8_t es, void *p);
#endif