ResourceMgr Class Reference

Singleton for managing resources compiled into an executable. More...

#include <src/resourcemgr.h>

Classes
class	Private

Public Member Functions
void	registerResources (std::initializer_list< Resource > resources)
	Registers an array of resources.
bool	writeCategory (const QCString &categoryName, const QCString &targetDir) const
	Writes all resource belonging to a given category to a given target directory.
bool	copyResource (const QCString &name, const QCString &targetDir) const
	Copies a registered resource to a given target directory.
bool	copyResourceAs (const QCString &name, const QCString &targetDir, const QCString &targetName, bool append=false) const
	Copies a registered resource to a given target directory under a given target name.
QCString	getAsString (const QCString &name) const
	Gets the resource data as a C string.

Static Public Member Functions
static ResourceMgr &	instance ()
	Returns the one and only instance of this class.

Private Member Functions
const Resource *	get (const QCString &name) const
	Returns a pointer to the resource object with the given name.
	ResourceMgr ()
	~ResourceMgr ()

Private Attributes
std::unique_ptr< Private >	p

Detailed Description

Singleton for managing resources compiled into an executable.

Definition at line 36 of file resourcemgr.h.

Constructor & Destructor Documentation

ResourceMgr()

ResourceMgr::ResourceMgr ( )

private

Definition at line 39 of file resourcemgr.cpp.

                         : p(std::make_unique<Private>())
{
}

References p.

Referenced by instance().

~ResourceMgr()

ResourceMgr::~ResourceMgr ( )

private

Definition at line 43 of file resourcemgr.cpp.

{
}

Member Function Documentation

copyResource()

bool ResourceMgr::copyResource	(	const QCString &	name,
		const QCString &	targetDir ) const

Copies a registered resource to a given target directory.

Definition at line 122 of file resourcemgr.cpp.

{
  return copyResourceAs(name,targetDir,name);
}

References copyResourceAs().

Referenced by CitationManager::generatePage(), generateXML(), HtmlGenerator::init(), HtmlGenerator::writeSearchPage(), and HtmlGenerator::writeTabData().

copyResourceAs()

bool ResourceMgr::copyResourceAs	(	const QCString &	name,
		const QCString &	targetDir,
		const QCString &	targetName,
		bool	append = false ) const

Copies a registered resource to a given target directory under a given target name.

Definition at line 79 of file resourcemgr.cpp.

{
  QCString pathName = targetDir+"/"+targetName;
  const Resource *res = get(name);
  if (res)
  {
    switch (res->type)
    {
      case Resource::Verbatim:
        {
          std::ofstream f = Portable::openOutputStream(pathName,append);
          bool ok=false;
          if (f.is_open())
          {
            f.write(reinterpret_cast<const char *>(res->data),res->size);
            ok = !f.fail();
          }
          if (ok)
          {
            return TRUE;
          }
        }
        break;
      case Resource::SVG:
        {
          std::ofstream t = Portable::openOutputStream(pathName,append);
          if (t.is_open())
          {
            QCString buf(res->size, QCString::ExplicitSize);
            memcpy(buf.rawData(),res->data,res->size);
            t << replaceColorMarkers(buf);
            return TRUE;
          }
        }
    }
  }
  else
  {
    err("requested resource '{}' not compiled in!\n",name);
  }
  return FALSE;
}

References Resource::data, err, QCString::ExplicitSize, FALSE, get(), Portable::openOutputStream(), QCString::rawData(), replaceColorMarkers(), Resource::size, Resource::SVG, TRUE, Resource::type, and Resource::Verbatim.

Referenced by copyResource().

get()

const Resource * ResourceMgr::get ( const QCString & name ) const

private

Returns a pointer to the resource object with the given name.

Definition at line 127 of file resourcemgr.cpp.

{
  auto it = p->resources.find(name.str());
  if (it!=p->resources.end()) return &it->second;
  return nullptr;
}

References p, and QCString::str().

Referenced by copyResourceAs(), and getAsString().

getAsString()

QCString ResourceMgr::getAsString

(

const QCString &

name

)

const

Gets the resource data as a C string.

Definition at line 134 of file resourcemgr.cpp.

{
  const Resource *res = get(name);
  if (res)
  {
    QCString result(res->size, QCString::ExplicitSize);
    memcpy(result.rawData(),res->data,res->size);
    return result;
  }
  else
  {
    return QCString();
  }
}

References Resource::data, QCString::ExplicitSize, get(), QCString::rawData(), and Resource::size.

Referenced by fillColorStyleMaps(), generateXML(), HtmlGenerator::getNavTreeCss(), HtmlGenerator::init(), LatexGenerator::init(), LayoutDocManager::init(), writeDefaultLayoutFile(), writeDefaultStyleSheet(), writeDefaultStyleSheet(), HtmlGenerator::writeExternalSearchPage(), HtmlGenerator::writeFooterFile(), LatexGenerator::writeFooterFile(), HtmlGenerator::writeHeaderFile(), LatexGenerator::writeHeaderFile(), HtmlGenerator::writeSearchData(), HtmlGenerator::writeSearchPage(), and LatexGenerator::writeStyleInfo().

instance()

ResourceMgr & ResourceMgr::instance ( )

static

Returns the one and only instance of this class.

Definition at line 33 of file resourcemgr.cpp.

{
  static ResourceMgr theInstance;
  return theInstance;
}

References ResourceMgr().

Referenced by fillColorStyleMaps(), generateJSNavTree(), CitationManager::generatePage(), generateXML(), HtmlGenerator::getNavTreeCss(), HtmlGenerator::init(), LatexGenerator::init(), LayoutDocManager::init(), writeDefaultLayoutFile(), writeDefaultStyleSheet(), writeDefaultStyleSheet(), HtmlGenerator::writeExternalSearchPage(), HtmlGenerator::writeFooterFile(), LatexGenerator::writeFooterFile(), HtmlGenerator::writeHeaderFile(), LatexGenerator::writeHeaderFile(), writeJavaScriptSearchIndex(), HtmlGenerator::writeSearchData(), HtmlGenerator::writeSearchPage(), LatexGenerator::writeStyleInfo(), and HtmlGenerator::writeTabData().

registerResources()

void ResourceMgr::registerResources

(

std::initializer_list< Resource >

resources

)

Registers an array of resources.

Definition at line 47 of file resourcemgr.cpp.

{
  for (auto &res : resources)
  {
    p->resources.emplace(res.name,res);
  }
}

References p.

writeCategory()

bool ResourceMgr::writeCategory	(	const QCString &	categoryName,
		const QCString &	targetDir ) const

Writes all resource belonging to a given category to a given target directory.

Definition at line 55 of file resourcemgr.cpp.

{
  for (auto &[name,res] : p->resources)
  {
    if (res.category==categoryName)
    {
      QCString pathName = targetDir+"/"+res.name;
      std::ofstream f = Portable::openOutputStream(pathName);
      bool ok=false;
      if (f.is_open())
      {
        f.write(reinterpret_cast<const char *>(res.data),res.size);
        ok = !f.fail();
      }
      if (!ok)
      {
        err("Failed to write resource '{}' to directory '{}'\n",res.name,targetDir);
        return FALSE;
      }
    }
  }
  return TRUE;
}

References err, FALSE, Portable::openOutputStream(), p, and TRUE.

Member Data Documentation

p

std::unique_ptr<Private> ResourceMgr::p

private

Definition at line 66 of file resourcemgr.h.

Referenced by get(), registerResources(), ResourceMgr(), and writeCategory().

---

The documentation for this class was generated from the following files:

• src/resourcemgr.h
• src/resourcemgr.cpp