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();
49 typedef std::map<CopiedString, CopiedString> Remaps;
52 bool parseTokens(Tokeniser& tokeniser)
54 RETURN_FALSE_IF_FAIL(Tokeniser_parseToken(tokeniser, "{"));
58 const char* token = tokeniser.getToken();
63 if(string_equal(token, "}"))
68 else if(string_equal(token, "model"))
75 CopiedString from, to;
76 parseShaderName(from, token);
78 tokeniser.nextLine(); // hack to handle badly formed skins
80 parseShaderName(to, tokeniser.getToken());
82 if(!string_equal(from.c_str(), to.c_str()))
84 m_remaps.insert(Remaps::value_type(from, to));
90 const char* getRemap(const char* name) const
92 Remaps::const_iterator i = m_remaps.find(name);
93 if(i != m_remaps.end())
95 return (*i).second.c_str();
99 void forEachRemap(const SkinRemapCallback& callback) const
101 for(Remaps::const_iterator i = m_remaps.begin(); i != m_remaps.end(); ++i)
103 callback(SkinRemap((*i).first.c_str(), (*i).second.c_str()));
111 typedef std::map<CopiedString, Doom3ModelSkin> SkinMap;
113 Doom3ModelSkin g_nullSkin;
115 Doom3ModelSkin& getSkin(const char* name)
117 SkinMap::iterator i = m_skins.find(name);
118 if(i != m_skins.end())
126 bool parseTokens(Tokeniser& tokeniser)
128 tokeniser.nextLine();
131 const char* token = tokeniser.getToken();
134 // end of token stream
137 if(!string_equal(token, "skin"))
139 Tokeniser_unexpectedError(tokeniser, token, "skin");
142 const char* other = tokeniser.getToken();
145 Tokeniser_unexpectedError(tokeniser, token, "#string");
149 parseShaderName(name, other);
150 Doom3ModelSkin& skin = m_skins[name];
151 RETURN_FALSE_IF_FAIL(skin.parseTokens(tokeniser));
155 void parseFile(const char* name)
157 StringOutputStream relativeName(64);
158 relativeName << "skins/" << name;
159 ArchiveTextFile* file = GlobalFileSystem().openTextFile(relativeName.c_str());
162 globalOutputStream() << "parsing skins from " << makeQuoted(name) << "\n";
164 Tokeniser& tokeniser = GlobalScriptLibrary().m_pfnNewSimpleTokeniser(file->getInputStream());
165 parseTokens(tokeniser);
172 globalErrorStream() << "failed to open " << makeQuoted(name) << "\n";
176 typedef MemberCaller1<GlobalSkins, const char*, &GlobalSkins::parseFile> ParseFileCaller;
180 GlobalFileSystem().forEachFile("skins/", "skin", ParseFileCaller(*this));
201 class Doom3ModelSkinCacheElement : public ModelSkin
203 ModuleObservers m_observers;
204 Doom3ModelSkin* m_skin;
206 Doom3ModelSkinCacheElement() : m_skin(0)
209 void attach(ModuleObserver& observer)
211 m_observers.attach(observer);
217 void detach(ModuleObserver& observer)
221 observer.unrealise();
223 m_observers.detach(observer);
225 bool realised() const
229 void realise(const char* name)
231 ASSERT_MESSAGE(!realised(), "Doom3ModelSkinCacheElement::realise: already realised");
232 m_skin = &g_skins.getSkin(name);
233 m_observers.realise();
237 ASSERT_MESSAGE(realised(), "Doom3ModelSkinCacheElement::unrealise: not realised");
238 m_observers.unrealise();
241 const char* getRemap(const char* name) const
243 ASSERT_MESSAGE(realised(), "Doom3ModelSkinCacheElement::getRemap: not realised");
244 return m_skin->getRemap(name);
246 void forEachRemap(const SkinRemapCallback& callback) const
248 ASSERT_MESSAGE(realised(), "Doom3ModelSkinCacheElement::forEachRemap: not realised");
249 m_skin->forEachRemap(callback);
253 class Doom3ModelSkinCache : public ModelSkinCache, public ModuleObserver
255 class CreateDoom3ModelSkin
257 Doom3ModelSkinCache& m_cache;
259 explicit CreateDoom3ModelSkin(Doom3ModelSkinCache& cache)
263 Doom3ModelSkinCacheElement* construct(const CopiedString& name)
265 Doom3ModelSkinCacheElement* skin = new Doom3ModelSkinCacheElement;
266 if(m_cache.realised())
268 skin->realise(name.c_str());
272 void destroy(Doom3ModelSkinCacheElement* skin)
274 if(m_cache.realised())
282 typedef HashedCache<CopiedString, Doom3ModelSkinCacheElement, HashString, std::equal_to<CopiedString>, CreateDoom3ModelSkin> Cache;
287 typedef ModelSkinCache Type;
288 STRING_CONSTANT(Name, "*");
289 ModelSkinCache* getTable()
294 Doom3ModelSkinCache() : m_cache(CreateDoom3ModelSkin(*this)), m_realised(false)
296 GlobalFileSystem().attach(*this);
298 ~Doom3ModelSkinCache()
300 GlobalFileSystem().detach(*this);
303 ModelSkin& capture(const char* name)
305 return *m_cache.capture(name);
307 void release(const char* name)
309 m_cache.release(name);
312 bool realised() const
320 for(Cache::iterator i = m_cache.begin(); i != m_cache.end(); ++i)
322 (*i).value->realise((*i).key.c_str());
328 for(Cache::iterator i = m_cache.begin(); i != m_cache.end(); ++i)
330 (*i).value->unrealise();
336 class Doom3ModelSkinCacheDependencies : public GlobalFileSystemModuleRef, public GlobalScripLibModuleRef
340 typedef SingletonModule<Doom3ModelSkinCache, Doom3ModelSkinCacheDependencies> Doom3ModelSkinCacheModule;
342 Doom3ModelSkinCacheModule g_Doom3ModelSkinCacheModule;
344 void Doom3ModelSkinCacheModule_selfRegister(ModuleServer& server)
346 g_Doom3ModelSkinCacheModule.selfRegister();