aboutsummaryrefslogtreecommitdiff
path: root/engines/titanic/objects/saveable_object.h
blob: 4e7d949191516766b221d2c40211e87503eba005 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * 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 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 General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 */

#ifndef TITANIC_SAVEABLE_OBJECT_H
#define TITANIC_SAVEABLE_OBJECT_H

#include "common/scummsys.h"
#include "common/array.h"
#include "common/hash-str.h"
#include "titanic/simple_file.h"

namespace Titanic {

class CSaveableObject {
	typedef CSaveableObject *(*CreateFunction)();
private:
	static Common::HashMap<Common::String, CreateFunction> *_classList;
public:
	/**
	 * Sets up the list of saveable object classes
	 */
	static void initClassList();

	/**
	 * Free the list of saveable object classes
	 */
	static void freeClassList();

	/**
	 * Creates a new instance of a saveable object class
	 */
	static CSaveableObject *createInstance(const Common::String &name);
public:
	/**
	 * Return the class name
	 */
	virtual const char *getClassName() const { return "CSaveableObject"; }

	/**
	 * Save the data for the class to file
	 */
	virtual void save(SimpleFile *file, int indent) const;

	/**
	 * Load the data for the class from file
	 */
	virtual void load(SimpleFile *file);
	
	/**
	 * Write out a header definition for the class to file
	 * prior to saving the actual data for the class
	 */
	virtual void saveHeader(SimpleFile *file, int indent) const;
	
	/**
	 * Writes out a footer for the class after it's data has
	 * been written to file
	 */
	virtual void saveFooter(SimpleFile *file, int indent) const;
};

} // End of namespace Titanic

#endif /* TITANIC_SAVEABLE_OBJECT_H */