aboutsummaryrefslogtreecommitdiff
path: root/graphics/imageman.h
blob: f555b4c8442aedd6ce6078932a6dd6ffa1015fc8 (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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
/* 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.
 *
 * $URL$
 * $Id$
 */

#ifndef GRAPHICS_IMAGEMAN_H
#define GRAPHICS_IMAGEMAN_H

#include "common/scummsys.h"

#include "common/archive.h"
#include "common/singleton.h"
#include "common/str.h"
#include "common/list.h"

namespace Graphics {

struct Surface;

class ImageManager : public Common::Singleton<ImageManager> {
public:
	~ImageManager();

	/**
	 * adds an .zip archive to the pool where the ImageManager searches
	 * for image files
	 *
	 * @param name the name of the archive
	 * @return true on success and false on failure
	 */
	bool addArchive(const Common::String &name);

	/**
	 * deletes an .zip archive from the pool where the Image Manager searches
	 * for image files
	 *
	 * @param name the name of the archive
	 */
	void removeArchive(const Common::String &name);

	/**
	 * registers a surface to the ImageManager.
	 * surf->free(), also delete surf, will be called when the ImageManager will
	 * be destroyed or if ImageManager::unregisterSurface is called.
	 * if the parameter 'surf' is 0 the Manger will try to load an image with
	 * the filename 'name'
	 *
	 * @param name the name of the new handle
	 * @param surf the surface which should be associated to the given name
	 * @return returns true on success and false on failure
	 */
	bool registerSurface(const Common::String &name, Surface *surf);

	/**
	 * unregisters a surface, after this the returned surface from
	 * getSurface should NOT be used anymore
	 *
	 * @param name the handle
	 * @return true on success, false on failure
	 */
	bool unregisterSurface(const Common::String &name);

	/**
	 * gets a surface registered to a handle
	 *
	 * @param name the name of the handle
	 * @return returns an pointer to an Surface object or 0 on failure
	 */
	Surface *getSurface(const Common::String &name);
private:
	friend class Common::Singleton<SingletonBaseType>;
	ImageManager();

	struct Entry {
		Common::String name;
		Surface *surface;
	};
	typedef Common::List<Entry*>::iterator Iterator;

	Iterator searchHandle(const Common::String &name);

	Common::List<Entry*> _surfaces;
	Common::SearchSet _archives;
};

} // end of namespace Graphics

/** Shortcut for accessing the image manager. */
#define ImageMan		(Graphics::ImageManager::instance())

#endif