Files
wagic/JGE/src/JResourceManager.cpp
wagic.jeck d55fc91112 Jeck - [Requires JGE rebuild] Extensive cache improvements.
* Numerous cache fixes, reduced filesystem access.
 * Cache fails very gracefully. 
 * Cache is now a templated class, with individual caches per data-type.
 * Much easier to extend.
 * Extensively debugged. Try compiling with -DDEBUG_CACHE.
 * Caches limits can be set on a per-item basis.
 * hgeParticleSystemInfo are now cached, mana particles now fall back to defaults.
 * Samples are not cached, but track filesystem misses using the cache backbone. 
 * Avatars are cached. Default baka avatar is now baka.jpg, to prevent collision with player.

A note on the retrieval types: 
  RETRIEVE_MANAGE puts a resource into a seperate, managed resource list.
    Managed resources are guarenteed valid for the lifetime of the program. 
    Retrieving a managed quad promotes the associated texture to managed. Don't do that by mistake.
    Calls to Resources.Refresh() will attempt to reload managed resources in place.

  RETRIVE_LOCK (and by extension, RETRIEVE_VRAM), returns a resource after locking it.
    A resource may have many locks, and remains in cache until they are all released. 
    If the resource is managed, it returns it unmodified.

A note on quads:
Unlike all other RetrieveWhatever() functions, the default behavior for RetrieveQuad is RETRIEVE_LOCK. Worse, Release(JQuad*) is slow, and will /always/ release one lock from the associated texture.   

There's a long and complicated explanation for this, involving support for live relinking of textures to existing quads, but basically what it means is that we only use RetrieveQuad for quads we intend to store and later Release(). If a temporary quad is needed, the preferred method is to use NEW JQuad* and SAFE_DELETE with RetrieveTexture(). RetrieveTempQuad is also provided, but is only guaranteed until the next call to the cache.

Note that RetrieveCard has none of these problems.
2009-09-14 08:28:49 +00:00

438 lines
9.7 KiB
C++

//-------------------------------------------------------------------------------------
//
// JGE++ is a hardware accelerated 2D game SDK for PSP/Windows.
//
// Licensed under the BSD license, see LICENSE in JGE root for details.
//
// Copyright (c) 2007 James Hui (a.k.a. Dr.Watson) <jhkhui@gmail.com>
//
//-------------------------------------------------------------------------------------
#include "../include/JGE.h"
#include "../include/JRenderer.h"
#include "../include/JSoundSystem.h"
#include "../include/JResourceManager.h"
#include "../include/JFileSystem.h"
#include "../include/JLBFont.h"
#include "tinyxml/tinyxml.h"
#if defined (_DEBUG) && defined (WIN32)
#include "crtdbg.h"
#define NEW new(_NORMAL_BLOCK, __FILE__, __LINE__)
#else
#define NEW new
#endif
JResourceManager::JResourceManager()
{
//mResourceRoot = "Res/"; // default root folder
mTextureList.clear();
mTextureList.reserve(16);
mTextureMap.clear();
mQuadList.clear();
mQuadList.reserve(128);
mQuadMap.clear();
mFontList.clear();
mFontList.reserve(4);
mFontMap.clear();
// mParticleEffectList.clear();
// mParticleEffectList.reserve(8);
// mParticleEffectMap.clear();
//
// mMotionEmitterList.clear();
// mMotionEmitterList.reserve(16);
// mMotionEmitterMap.clear();
}
JResourceManager::~JResourceManager()
{
RemoveAll();
}
void JResourceManager::RemoveAll()
{
for (vector<JTexture *>::iterator tex = mTextureList.begin(); tex != mTextureList.end(); ++tex)
delete *tex;
mTextureList.clear();
mTextureMap.clear();
for (vector<JQuad *>::iterator quad = mQuadList.begin(); quad != mQuadList.end(); ++quad)
delete *quad;
mQuadList.clear();
mQuadMap.clear();
for (vector<JLBFont *>::iterator font = mFontList.begin(); font != mFontList.end(); ++font)
delete *font;
mFontList.clear();
mFontMap.clear();
}
bool JResourceManager::LoadResource(const string& resourceName)
{
string path = /*mResourceRoot + */resourceName;
// TiXmlDocument doc(path.c_str());
//
// if (!doc.LoadFile()) return false;
JGE *engine = JGE::GetInstance();
if (engine == NULL) return false;
JFileSystem *fileSystem = JFileSystem::GetInstance();
if (fileSystem == NULL) return false;
if (!fileSystem->OpenFile(path.c_str())) return false;
int size = fileSystem->GetFileSize();
char *xmlBuffer = new char[size];
fileSystem->ReadFile(xmlBuffer, size);
TiXmlDocument doc;
doc.Parse(xmlBuffer);
TiXmlNode* resource = 0;
TiXmlNode* node = 0;
TiXmlElement* element = 0;
resource = doc.FirstChild("resource");
if (resource)
{
element = resource->ToElement();
printf("---- Loading %s:%s\n", element->Value(), element->Attribute("name"));
for (node = resource->FirstChild(); node; node = node->NextSibling())
{
element = node->ToElement();
if (element != NULL)
{
if (strcmp(element->Value(), "texture")==0)
{
CreateTexture(element->Attribute("name"));
}
else if (strcmp(element->Value(), "quad")==0)
{
string quadName = element->Attribute("name");
string textureName = element->Attribute("texture");
float x = 0.0f;
float y = 0.0f;
float width = 16.0f;
float height = 16.0f;
float value;
float hotspotX = 0.0f;
float hotspotY = 0.0f;
if (element->QueryFloatAttribute("x", &value) == TIXML_SUCCESS)
x = value;
if (element->QueryFloatAttribute("y", &value) == TIXML_SUCCESS)
y = value;
if (element->QueryFloatAttribute("width", &value) == TIXML_SUCCESS)
width = value;
if (element->QueryFloatAttribute("height", &value) == TIXML_SUCCESS)
height = value;
if (element->QueryFloatAttribute("w", &value) == TIXML_SUCCESS)
width = value;
if (element->QueryFloatAttribute("h", &value) == TIXML_SUCCESS)
height = value;
if (element->QueryFloatAttribute("hotspot.x", &value) == TIXML_SUCCESS)
hotspotX = value;
else
hotspotX = width/2;
if (element->QueryFloatAttribute("hotspot.y", &value) == TIXML_SUCCESS)
hotspotY = value;
else
hotspotY = height/2;
// if (element->QueryFloatAttribute("regx", &value) == TIXML_SUCCESS)
// hotspotX = width/2;
//
// if (element->QueryFloatAttribute("regy", &value) == TIXML_SUCCESS)
// hotspotY = height/2;
int id = CreateQuad(quadName, textureName, x, y, width, height);
if (id != INVALID_ID)
{
GetQuad(id)->SetHotSpot(hotspotX, hotspotY);
}
}
else if (strcmp(element->Value(), "font")==0)
{
}
// else if (strcmp(element->Value(), "effect")==0)
// {
// RegisterParticleEffect(element->Attribute("name"));
// }
// else if (strcmp(element->Value(), "motion_emitter")==0)
// {
// RegisterMotionEmitter(element->Attribute("name"));
// }
}
}
}
fileSystem->CloseFile();
delete[] xmlBuffer;
// JGERelease();
return true;
}
int JResourceManager::CreateTexture(const string &textureName)
{
map<string, int>::iterator itr = mTextureMap.find(textureName);
if (itr == mTextureMap.end())
{
string path = /*mResourceRoot + */textureName;
printf("creating texture:%s\n", path.c_str());
JTexture *tex = JRenderer::GetInstance()->LoadTexture(path.c_str());
if (tex == NULL)
return INVALID_ID;
int id = mTextureList.size();
mTextureList.push_back(tex);
mTextureMap[textureName] = id;
return id;
}
else
return itr->second;
}
JTexture *JResourceManager::GetTexture(const string &textureName)
{
map<string, int>::iterator itr = mTextureMap.find(textureName);
if (itr == mTextureMap.end())
return NULL;
else
return mTextureList[itr->second];
}
JTexture *JResourceManager::GetTexture(int id)
{
if (id >=0 && id < (int)mTextureList.size())
return mTextureList[id];
else
return NULL;
}
int JResourceManager::CreateQuad(const string &quadName, const string &textureName, float x, float y, float width, float height)
{
map<string, int>::iterator itr = mQuadMap.find(quadName);
if (itr == mQuadMap.end())
{
JTexture *tex = GetTexture(textureName);
if (tex == NULL)
{
int texId = CreateTexture(textureName); // load texture if necessary
tex = GetTexture(texId);
}
if (tex == NULL) // no texture, no quad...
return INVALID_ID;
printf("creating quad:%s\n", quadName.c_str());
int id = mQuadList.size();
mQuadList.push_back(NEW JQuad(tex, x, y, width, height));
mQuadMap[quadName] = id;
return id;
}
else
return itr->second;
}
JQuad *JResourceManager::GetQuad(const string &quadName)
{
map<string, int>::iterator itr = mQuadMap.find(quadName);
if (itr == mQuadMap.end())
return NULL;
else
return mQuadList[itr->second];
}
JQuad *JResourceManager::GetQuad(int id)
{
if (id >=0 && id < (int)mQuadList.size())
return mQuadList[id];
else
return NULL;
}
int JResourceManager::LoadJLBFont(const string &fontName, int height)
{
map<string, int>::iterator itr = mFontMap.find(fontName);
if (itr == mFontMap.end())
{
string path = /*mResourceRoot + */fontName;
printf("creating font:%s\n", path.c_str());
int id = mFontList.size();
///////////////////////////////////////
mFontList.push_back(NEW JLBFont(path.c_str(), height, true));
mFontMap[fontName] = id;
return id;
}
else
return itr->second;
}
JLBFont *JResourceManager::GetJLBFont(const string &fontName)
{
map<string, int>::iterator itr = mFontMap.find(fontName);
if (itr == mFontMap.end())
return NULL;
else
return mFontList[itr->second];
}
JLBFont *JResourceManager::GetJLBFont(int id)
{
if (id >=0 && id < (int)mFontList.size())
return mFontList[id];
else
return NULL;
}
//
//
// int JResourceManager::RegisterParticleEffect(const string &effectName)
// {
// map<string, int>::iterator itr = mParticleEffectMap.find(effectName);
//
// if (itr == mParticleEffectMap.end())
// {
// string path = mResourceRoot + effectName;
// printf("creating effect:%s\n", path.c_str());
// JParticleEffect *effect = new JParticleEffect(path.c_str());
//
// if (effect == NULL)
// return INVALID_ID;
//
//
// int id = mParticleEffectList.size();
// mParticleEffectList.push_back(effect);
//
// mParticleEffectMap[effectName] = id;
//
// return id;
//
// }
// else
// return itr->second;
// }
//
//
// JParticleEffect *JResourceManager::GetParticleEffect(const string &effectName)
// {
// map<string, int>::iterator itr = mParticleEffectMap.find(effectName);
//
// if (itr == mParticleEffectMap.end())
// return NULL;
// else
// return mParticleEffectList[itr->second];
// }
//
//
// JParticleEffect *JResourceManager::GetParticleEffect(int id)
// {
// if (id >=0 && id < (int)mParticleEffectList.size())
// return mParticleEffectList[id];
// else
// return NULL;
// }
//
//
//
// int JResourceManager::RegisterMotionEmitter(const string &emitterName)
// {
// map<string, int>::iterator itr = mMotionEmitterMap.find(emitterName);
//
// if (itr == mMotionEmitterMap.end())
// {
// string path = mResourceRoot + emitterName;
// printf("creating effect:%s\n", path.c_str());
// JMotionEmitter *emitter = new JMotionEmitter();
//
// if (emitter == NULL)
// return INVALID_ID;
//
// emitter->LoadMotionML(path.c_str());
//
// int id = mMotionEmitterList.size();
// mMotionEmitterList.push_back(emitter);
//
// mMotionEmitterMap[emitterName] = id;
//
// return id;
//
// }
// else
// return itr->second;
// }
//
//
// JMotionEmitter *JResourceManager::GetMotionEmitter(const string &emitterName)
// {
// map<string, int>::iterator itr = mMotionEmitterMap.find(emitterName);
//
// if (itr == mMotionEmitterMap.end())
// return NULL;
// else
// return mMotionEmitterList[itr->second];
// }
//
//
// JMotionEmitter *JResourceManager::GetMotionEmitter(int id)
// {
// if (id >=0 && id < (int)mMotionEmitterList.size())
// return mMotionEmitterList[id];
// else
// return NULL;
// }