#include <resource.h>

Inheritance diagram for Resource:

Public Member Functions
	Resource ()

	~Resource ()

virtual void	incRef ()

virtual void	decRef ()

int	calcMemoryLocal () const

std::string	getCounterName () const

Public Member Functions inherited from MemoryCounter
	MemoryCounter ()

virtual	~MemoryCounter ()

int	calcMemory (const int level) const

virtual int	calcMemoryChilds (const int level) const

Data Fields
time_t	mTimeStamp

std::string	mIdPath

std::string	mSource

unsigned int	mRefCount

bool	mProtected

bool	mNotCount

Detailed Description

A generic reference counted resource object.

Definition at line 34 of file resource.h.

Constructor & Destructor Documentation

◆ Resource()

Resource::Resource ( )

inline

Constructor

Definition at line 40 of file resource.h.

                    :
             MemoryCounter(),
             mTimeStamp(0),
             mIdPath(),
             mSource(),
             mRefCount(0),
             mProtected(false),
 #ifdef DEBUG_DUMP_LEAKS
             mNotCount(false),
             mDumped(false)
 #else  // DEBUG_DUMP_LEAKS
             mNotCount(false)
 #endif  // DEBUG_DUMP_LEAKS
         {
         }

◆ ~Resource()

Resource::~Resource ( )

Destructor.

Definition at line 34 of file resource.cpp.

35 {

36 }

Member Function Documentation

◆ calcMemoryLocal()

int Resource::calcMemoryLocal ( ) const

virtual

Reimplemented from MemoryCounter.

Reimplemented in SpriteDef, SoundEffect, and SDLMusic.

Definition at line 76 of file resource.cpp.

 {
     return CAST_S32(sizeof(Resource)) +
         CAST_S32(mIdPath.size()) +
         CAST_S32(mSource.size());
 }

References CAST_S32, mIdPath, and mSource.

Referenced by AtlasResource::calcMemoryLocal(), ImageSet::calcMemoryLocal(), WalkLayer::calcMemoryLocal(), SDLMusic::calcMemoryLocal(), SoundEffect::calcMemoryLocal(), and SpriteDef::calcMemoryLocal().

◆ decRef()

void Resource::decRef ( )

virtual

Decrements the reference count and deletes the object if no references are left.

Returns: true if the object was deleted false otherwise.

Reimplemented in AtlasResource.

Definition at line 50 of file resource.cpp.

 {
 #ifdef DEBUG_IMAGES
     logger->log("before decRef for: %p", static_cast<void*>(this));
 #endif  // DEBUG_IMAGES
  
     // Reference may not already have reached zero
     if (mRefCount == 0)
     {
         logger->log("Warning: mRefCount already zero for %s", mIdPath.c_str());
         return;
     }
  
     mRefCount--;
  
 #ifdef DEBUG_IMAGES
     logger->log("after decRef: %p, %u", static_cast<void*>(this), mRefCount);
 #endif  // DEBUG_IMAGES
  
     if (mRefCount == 0 && !mNotCount)
     {
         // Warn the manager that this resource is no longer used.
         ResourceManager::release(this);
     }
 }

References Logger::log(), logger, mIdPath, mNotCount, mRefCount, and ResourceManager::release().

Referenced by Particle::addEffect(), ParticleEngine::addEffect(), ResourceManager::cleanProtected(), ShadersManager::createProgram(), AtlasResource::decRef(), SubImage::decRef(), ResourceManager::decRefDelete(), EquipmentWindow::fillBoxes(), EquipmentWindow::fillDefault(), SoundManager::haltMusic(), SpriteDef::includeSprite(), SpriteDef::load(), Theme::loadColors(), Button::loadImage(), Button::loadImageSet(), Theme::loadInfo(), SoundManager::logic(), ResourceManager::moveToDeleted(), SoundManager::playGuiSfx(), SoundManager::playSfx(), ProgressIndicator::ProgressIndicator(), Theme::readSkin(), Button::setImage(), Gui::setUseCustomCursor(), MapReader::unloadEmptyAtlas(), AnimatedSprite::~AnimatedSprite(), BrowserBox::~BrowserBox(), Button::~Button(), EmotePage::~EmotePage(), EmoteWindow::~EmoteWindow(), EquipmentWindow::~EquipmentWindow(), Gui::~Gui(), Map::~Map(), ShaderProgram::~ShaderProgram(), SimpleAnimation::~SimpleAnimation(), StaticBrowserBox::~StaticBrowserBox(), and WindowMenu::~WindowMenu().

◆ getCounterName()

std::string Resource::getCounterName ( ) const

inlinevirtual

Reimplemented from MemoryCounter.

Reimplemented in SoundEffect, and SDLMusic.

Definition at line 79 of file resource.h.

80 { return mIdPath + "-" + mSource; }

References mIdPath, and mSource.

◆ incRef()

void Resource::incRef ( )

virtual

Increments the internal reference count.

Reimplemented in AtlasResource.

Definition at line 38 of file resource.cpp.

 {
 #ifdef DEBUG_IMAGES
     logger->log("before incRef for: %p", static_cast<void*>(this));
     mRefCount++;
     logger->log("after incRef: %p, %u", static_cast<void*>(this), mRefCount);
 #else  // DEBUG_IMAGES
  
     mRefCount++;
 #endif  // DEBUG_IMAGES
 }