2 Copyright (C) 2001-2006, William Joseph.
5 This file is part of GtkRadiant.
7 GtkRadiant is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2 of the License, or
10 (at your option) any later version.
12 GtkRadiant is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GtkRadiant; if not, write to the Free Software
19 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
22 #include "skincache.h"
24 #include "ifilesystem.h"
25 #include "iscriplib.h"
27 #include "modelskin.h"
31 #include "stream/stringstream.h"
32 #include "generic/callback.h"
33 #include "container/cache.h"
34 #include "container/hashfunc.h"
36 #include "moduleobservers.h"
37 #include "modulesystem/singletonmodule.h"
40 void parseShaderName(CopiedString &name, const char *token)
42 StringOutputStream cleaned(256);
43 cleaned << PathCleaned(token);
44 name = cleaned.c_str();
47 class Doom3ModelSkin {
48 typedef std::map<CopiedString, CopiedString> Remaps;
51 bool parseTokens(Tokeniser &tokeniser)
53 RETURN_FALSE_IF_FAIL(Tokeniser_parseToken(tokeniser, "{"));
56 const char *token = tokeniser.getToken();
60 if (string_equal(token, "}")) {
63 } else if (string_equal(token, "model")) {
67 CopiedString from, to;
68 parseShaderName(from, token);
70 tokeniser.nextLine(); // hack to handle badly formed skins
72 parseShaderName(to, tokeniser.getToken());
74 if (!string_equal(from.c_str(), to.c_str())) {
75 m_remaps.insert(Remaps::value_type(from, to));
82 const char *getRemap(const char *name) const
84 Remaps::const_iterator i = m_remaps.find(name);
85 if (i != m_remaps.end()) {
86 return (*i).second.c_str();
91 void forEachRemap(const SkinRemapCallback &callback) const
93 for (Remaps::const_iterator i = m_remaps.begin(); i != m_remaps.end(); ++i) {
94 callback(SkinRemap((*i).first.c_str(), (*i).second.c_str()));
101 typedef std::map<CopiedString, Doom3ModelSkin> SkinMap;
103 Doom3ModelSkin g_nullSkin;
105 Doom3ModelSkin &getSkin(const char *name)
107 SkinMap::iterator i = m_skins.find(name);
108 if (i != m_skins.end()) {
115 bool parseTokens(Tokeniser &tokeniser)
117 tokeniser.nextLine();
119 const char *token = tokeniser.getToken();
121 // end of token stream
124 if (!string_equal(token, "skin")) {
125 Tokeniser_unexpectedError(tokeniser, token, "skin");
128 const char *other = tokeniser.getToken();
130 Tokeniser_unexpectedError(tokeniser, token, "#string");
134 parseShaderName(name, other);
135 Doom3ModelSkin &skin = m_skins[name];
136 RETURN_FALSE_IF_FAIL(skin.parseTokens(tokeniser));
140 void parseFile(const char *name)
142 StringOutputStream relativeName(64);
143 relativeName << "skins/" << name;
144 ArchiveTextFile *file = GlobalFileSystem().openTextFile(relativeName.c_str());
146 globalOutputStream() << "parsing skins from " << makeQuoted(name) << "\n";
148 Tokeniser &tokeniser = GlobalScriptLibrary().m_pfnNewSimpleTokeniser(file->getInputStream());
149 parseTokens(tokeniser);
154 globalErrorStream() << "failed to open " << makeQuoted(name) << "\n";
158 typedef MemberCaller<GlobalSkins, void(const char *), &GlobalSkins::parseFile> ParseFileCaller;
162 GlobalFileSystem().forEachFile("skins/", "skin", ParseFileCaller(*this));
184 class Doom3ModelSkinCacheElement : public ModelSkin {
185 ModuleObservers m_observers;
186 Doom3ModelSkin *m_skin;
188 Doom3ModelSkinCacheElement() : m_skin(0)
192 void attach(ModuleObserver &observer)
194 m_observers.attach(observer);
200 void detach(ModuleObserver &observer)
203 observer.unrealise();
205 m_observers.detach(observer);
208 bool realised() const
213 void realise(const char *name)
215 ASSERT_MESSAGE(!realised(), "Doom3ModelSkinCacheElement::realise: already realised");
216 m_skin = &g_skins.getSkin(name);
217 m_observers.realise();
222 ASSERT_MESSAGE(realised(), "Doom3ModelSkinCacheElement::unrealise: not realised");
223 m_observers.unrealise();
227 const char *getRemap(const char *name) const
229 ASSERT_MESSAGE(realised(), "Doom3ModelSkinCacheElement::getRemap: not realised");
230 return m_skin->getRemap(name);
233 void forEachRemap(const SkinRemapCallback &callback) const
235 ASSERT_MESSAGE(realised(), "Doom3ModelSkinCacheElement::forEachRemap: not realised");
236 m_skin->forEachRemap(callback);
240 class Doom3ModelSkinCache : public ModelSkinCache, public ModuleObserver {
241 class CreateDoom3ModelSkin {
242 Doom3ModelSkinCache &m_cache;
244 explicit CreateDoom3ModelSkin(Doom3ModelSkinCache &cache)
249 Doom3ModelSkinCacheElement *construct(const CopiedString &name)
251 Doom3ModelSkinCacheElement *skin = new Doom3ModelSkinCacheElement;
252 if (m_cache.realised()) {
253 skin->realise(name.c_str());
258 void destroy(Doom3ModelSkinCacheElement *skin)
260 if (m_cache.realised()) {
267 typedef HashedCache<CopiedString, Doom3ModelSkinCacheElement, HashString, std::equal_to<CopiedString>, CreateDoom3ModelSkin> Cache;
272 typedef ModelSkinCache Type;
274 STRING_CONSTANT(Name, "*");
276 ModelSkinCache *getTable()
281 Doom3ModelSkinCache() : m_cache(CreateDoom3ModelSkin(*this)), m_realised(false)
283 GlobalFileSystem().attach(*this);
286 ~Doom3ModelSkinCache()
288 GlobalFileSystem().detach(*this);
291 ModelSkin &capture(const char *name)
293 return *m_cache.capture(name);
296 void release(const char *name)
298 m_cache.release(name);
301 bool realised() const
310 for (Cache::iterator i = m_cache.begin(); i != m_cache.end(); ++i) {
311 (*i).value->realise((*i).key.c_str());
318 for (Cache::iterator i = m_cache.begin(); i != m_cache.end(); ++i) {
319 (*i).value->unrealise();
325 class Doom3ModelSkinCacheDependencies : public GlobalFileSystemModuleRef, public GlobalScripLibModuleRef {
328 typedef SingletonModule<Doom3ModelSkinCache, Doom3ModelSkinCacheDependencies> Doom3ModelSkinCacheModule;
330 Doom3ModelSkinCacheModule g_Doom3ModelSkinCacheModule;
332 void Doom3ModelSkinCacheModule_selfRegister(ModuleServer &server)
334 g_Doom3ModelSkinCacheModule.selfRegister();