ResourceMgr类 参考

Singleton for managing resources compiled into an executable 更多...

#include <resourcemgr.h>

类
class	Private

Public 成员函数
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 更多...

静态 Public 成员函数
static ResourceMgr &	instance ()
	Returns the one and only instance of this class 更多...

Private 成员函数
const Resource *	get (const QCString &name) const
	Returns a pointer to the resource object with the given name. 更多...
	ResourceMgr ()
	~ResourceMgr ()

Private 属性
std::unique_ptr< Private >	p

详细描述

Singleton for managing resources compiled into an executable

在文件 resourcemgr.h 第 35 行定义.

构造及析构函数说明

ResourceMgr()

ResourceMgr::ResourceMgr ( )

private

在文件 resourcemgr.cpp 第 38 行定义.

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

~ResourceMgr()

ResourceMgr::~ResourceMgr ( )

private

在文件 resourcemgr.cpp 第 42 行定义.

{
}

成员函数说明

copyResource()

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

Copies a registered resource to a given target directory

在文件 resourcemgr.cpp 第 180 行定义.

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

引用了 copyResourceAs().

被这些函数引用 generateJSNavTree(), CitationManager::generatePage(), FTVHelp::generateTreeViewImages(), FTVHelp::generateTreeViewScripts(), generateXML(), HtmlGenerator::init(), TemplateNodeResource::render(), writeJavaScriptSearchIndex(), HtmlGenerator::writeSearchData(), HtmlGenerator::writeSearchPage() , 以及 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

在文件 resourcemgr.cpp 第 79 行定义.

{
  std::string pathName = targetDir.str()+"/"+targetName.str();
  std::ios_base::openmode mode = std::ofstream::out | std::ofstream::binary;
  if (append) mode |= std::ofstream::app;
  const Resource *res = get(name);
  if (res)
  {
    switch (res->type)
    {
      case Resource::Verbatim:
        {
          std::ofstream f(pathName,mode);
          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::Luminance:
        {
          QCString n = name;
          n = n.left(n.length()-4)+".png"; // replace .lum by .png
          uchar *data = (uchar*)res->data;
          ushort width   = (data[0]<<8)+data[1];
          ushort height  = (data[2]<<8)+data[3];
          ColoredImgDataItem images[2];
          images[0].name    = n.data();
          images[0].width   = width;
          images[0].height  = height;
          images[0].content = &data[4];
          images[0].alpha   = 0;
          images[1].name    = 0; // terminator
          writeColoredImgData(targetDir,images);
          return TRUE;
        }
        break;
      case Resource::LumAlpha:
        {
          QCString n = name;
          n = n.left(n.length()-5)+".png"; // replace .luma by .png
          uchar *data = (uchar*)res->data;
          ushort width   = (data[0]<<8)+data[1];
          ushort height  = (data[2]<<8)+data[3];
          ColoredImgDataItem images[2];
          images[0].name    = n.data();
          images[0].width   = width;
          images[0].height  = height;
          images[0].content = &data[4];
          images[0].alpha   = &data[4+width*height];
          images[1].name    = 0; // terminator
          writeColoredImgData(targetDir,images);
          return TRUE;
        }
        break;
      case Resource::CSS:
        {
          std::ofstream t(pathName,mode);
          if (t.is_open())
          {
            QCString buf(res->size+1);
            memcpy(buf.rawData(),res->data,res->size);
            buf = replaceColorMarkers(buf);
            if (name=="navtree.css")
            {
              t << substitute(buf,"$width",QCString().setNum(Config_getInt(TREEVIEW_WIDTH))+"px");
            }
            else
            {
              t << substitute(buf,"$doxygenversion",getDoxygenVersion());
            }
            return TRUE;
          }
        }
        break;
      case Resource::SVG:
        {
          std::ofstream t(pathName,mode);
          if (t.is_open())
          {
            QCString buf(res->size+1);
            memcpy(buf.rawData(),res->data,res->size);
            t << replaceColorMarkers(buf);
            return TRUE;
          }
        }
    }
  }
  else
  {
    err("requested resource '%s' not compiled in!\n",qPrint(name));
  }
  return FALSE;
}

引用了 ColoredImgDataItem::alpha, Config_getInt, ColoredImgDataItem::content, Resource::CSS, Resource::data, QCString::data(), err(), FALSE, get(), ColoredImgDataItem::height, QCString::left(), QCString::length(), Resource::LumAlpha, Resource::Luminance, ColoredImgDataItem::name, qPrint(), QCString::rawData(), replaceColorMarkers(), Resource::size, QCString::str(), substitute(), Resource::SVG, TRUE, Resource::type, Resource::Verbatim, ColoredImgDataItem::width , 以及 writeColoredImgData().

被这些函数引用 copyResource(), HtmlGenerator::init() , 以及 TemplateNodeResource::render().

get()

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

private

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

在文件 resourcemgr.cpp 第 185 行定义.

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

引用了 p , 以及 QCString::str().

被这些函数引用 copyResourceAs() , 以及 getAsString().

getAsString()

QCString ResourceMgr::getAsString

(

const QCString &

name

)

const

Gets the resource data as a C string

在文件 resourcemgr.cpp 第 192 行定义.

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

引用了 Resource::data, get(), QCString::rawData() , 以及 Resource::size.

被这些函数引用 generateXML(), HtmlGenerator::init(), LatexGenerator::init(), LayoutDocManager::init(), TemplateEngine::Private::loadByName(), writeDefaultLayoutFile(), writeDefaultStyleSheet(), HtmlGenerator::writeExternalSearchPage(), HtmlGenerator::writeFooterFile(), LatexGenerator::writeFooterFile(), HtmlGenerator::writeHeaderFile(), LatexGenerator::writeHeaderFile(), HtmlGenerator::writeSearchData(), HtmlGenerator::writeSearchPage() , 以及 LatexGenerator::writeStyleInfo().

instance()

ResourceMgr & ResourceMgr::instance ( )

static

Returns the one and only instance of this class

在文件 resourcemgr.cpp 第 32 行定义.

{
  static ResourceMgr theInstance;
  return theInstance;
}

被这些函数引用 generateJSNavTree(), CitationManager::generatePage(), generateTemplateFiles(), FTVHelp::generateTreeViewImages(), FTVHelp::generateTreeViewScripts(), generateXML(), HtmlGenerator::init(), LatexGenerator::init(), LayoutDocManager::init(), TemplateEngine::Private::loadByName(), TemplateNodeResource::render(), writeDefaultLayoutFile(), writeDefaultStyleSheet(), HtmlGenerator::writeExternalSearchPage(), HtmlGenerator::writeFooterFile(), LatexGenerator::writeFooterFile(), HtmlGenerator::writeHeaderFile(), LatexGenerator::writeHeaderFile(), writeJavaScriptSearchIndex(), HtmlGenerator::writeSearchData(), HtmlGenerator::writeSearchPage(), HtmlGenerator::writeStyleInfo(), LatexGenerator::writeStyleInfo(), HtmlGenerator::writeStyleSheetFile() , 以及 HtmlGenerator::writeTabData().

registerResources()

void ResourceMgr::registerResources

(

std::initializer_list< Resource >

resources

)

Registers an array of resources

在文件 resourcemgr.cpp 第 46 行定义.

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

引用了 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

在文件 resourcemgr.cpp 第 54 行定义.

{
  for (auto &kv : p->resources)
  {
    Resource &res = kv.second;
    if (res.category==categoryName)
    {
      std::string pathName = targetDir.str()+"/"+res.name;
      std::ofstream f(pathName,std::ofstream::out | std::ofstream::binary);
      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 '%s' to directory '%s'\n",res.name,qPrint(targetDir));
        return FALSE;
      }
    }
  }
  return TRUE;
}

引用了 Resource::category, Resource::data, err(), FALSE, Resource::name, p, qPrint(), Resource::size, QCString::str() , 以及 TRUE.

被这些函数引用 generateTemplateFiles().

类成员变量说明

p

std::unique_ptr<Private> ResourceMgr::p

private

在文件 resourcemgr.h 第 62 行定义.

被这些函数引用 get(), registerResources() , 以及 writeCategory().

---

该类的文档由以下文件生成:

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