TemplateEngine::Private类 参考

Private data of the template engine 更多...

TemplateEngine::Private 的协作图:

类
class	IncludeEntry

Public 成员函数
	Private (TemplateEngine *engine)
	~Private ()
Template *	loadByName (const QCString &fileName, int line)
void	unload (Template *)
void	enterBlock (const QCString &fileName, const QCString &blockName, int line)
void	leaveBlock ()
void	printIncludeContext (const QCString &fileName, int line) const
void	setOutputExtension (const QCString &extension)
QCString	outputExtension () const
void	setTemplateDir (const QCString &dirName)

Private 属性
std::unordered_map< std::string, std::unique_ptr< Template > >	m_templateCache
TemplateEngine *	m_engine = 0
std::vector< IncludeEntry >	m_includeStack
QCString	m_extension
QCString	m_templateDirName

详细描述

Private data of the template engine

在文件 template.cpp 第 5226 行定义.

构造及析构函数说明

Private()

TemplateEngine::Private::Private ( TemplateEngine *  engine )

inline

在文件 template.cpp 第 5246 行定义.

                                    : m_engine(engine)
    {
      //printf("%p:TemplateEngine::Private::Private()\n",(void*)this);
    }

~Private()

TemplateEngine::Private::~Private ( )

inline

在文件 template.cpp 第 5250 行定义.

    {
      //printf("%p:TemplateEngine::Private::~Private()\n",(void*)this);
    }

成员函数说明

enterBlock()

void TemplateEngine::Private::enterBlock ( const QCString &  fileName, const QCString &  blockName, int  line  )

inline

在文件 template.cpp 第 5305 行定义.

    {
      //for (int i=0;i<m_indent;i++) printf("  ");
      //m_indent++;
      //printf("enterBlock(%s,%s,%d) {\n",qPrint(fileName),qPrint(blockName),line);
      m_includeStack.emplace_back(IncludeEntry::Block,fileName,blockName,line);
    }

引用了 TemplateEngine::Private::IncludeEntry::Block , 以及 m_includeStack.

leaveBlock()

void TemplateEngine::Private::leaveBlock ( )

inline

在文件 template.cpp 第 5313 行定义.

    {
      //m_indent--;
      //for (int i=0;i<m_indent;i++) printf("  ");
      //printf("}\n");
      m_includeStack.pop_back();
    }

引用了 m_includeStack.

loadByName()

Template* TemplateEngine::Private::loadByName ( const QCString &  fileName, int  line  )

inline

在文件 template.cpp 第 5254 行定义.

    {
      //for (int i=0;i<m_indent;i++) printf("  ");
      //m_indent++;
      //printf("loadByName(%s,%d) {\n",qPrint(fileName),line);
      m_includeStack.emplace_back(IncludeEntry::Template,fileName,QCString(),line);
      auto kv = m_templateCache.find(fileName.str());
      if (kv==m_templateCache.end()) // first time template is referenced
      {
        QCString filePath = m_templateDirName+"/"+fileName;
        std::ifstream f(filePath.str(),std::ifstream::in | std::ifstream::binary);
        if (f.is_open()) // read template from disk
        {
          FileInfo fi(filePath.str());
          int size=(int)fi.size();
          QCString data(size+1);
          f.read(data.rawData(),size);
          if (!f.fail())
          {
            kv = m_templateCache.insert(
                std::make_pair(fileName.str(),
                  std::make_unique<TemplateImpl>(m_engine,filePath,data,m_extension))).first;
          }
        }
        else // fallback to default built-in template
        {
          const QCString data = ResourceMgr::instance().getAsString(fileName);
          if (!data.isEmpty())
          {
            kv = m_templateCache.insert(
                std::make_pair(fileName.str(),
                  std::make_unique<TemplateImpl>(m_engine,fileName,data,m_extension))).first;
          }
          else
          {
            err("Could not open template file %s\n",qPrint(fileName));
          }
        }
      }
      return kv!=m_templateCache.end() ? kv->second.get() : 0;
    }

引用了 err(), ResourceMgr::getAsString(), ResourceMgr::instance(), QCString::isEmpty(), m_engine, m_extension, m_includeStack, m_templateCache, m_templateDirName, qPrint(), QCString::rawData(), FileInfo::size(), QCString::str() , 以及 TemplateEngine::Private::IncludeEntry::Template.

outputExtension()

QCString TemplateEngine::Private::outputExtension ( ) const

inline

在文件 template.cpp 第 5349 行定义.

    {
      return m_extension;
    }

引用了 m_extension.

printIncludeContext()

void TemplateEngine::Private::printIncludeContext ( const QCString &  fileName, int  line  ) const

inline

在文件 template.cpp 第 5321 行定义.

    {
      auto it = m_includeStack.rbegin();
      while (it!=m_includeStack.rend())
      {
        const IncludeEntry &ie = *it;
        ++it;
        const IncludeEntry *next = it!=m_includeStack.rend() ? &(*it) : 0;
        if (ie.type()==IncludeEntry::Template)
        {
          if (next)
          {
            warn(fileName,line,"  inside template '%s' included from template '%s' at line %d",qPrint(ie.fileName()),qPrint(next->fileName()),ie.line());
          }
        }
        else // ie.type()==IncludeEntry::Block
        {
          warn(fileName,line,"  included by block '%s' inside template '%s' at line %d",qPrint(ie.blockName()),
              qPrint(ie.fileName()),ie.line());
        }
      }
    }

引用了 TemplateEngine::Private::IncludeEntry::blockName(), TemplateEngine::Private::IncludeEntry::fileName(), TemplateEngine::Private::IncludeEntry::line(), m_includeStack, qPrint(), TemplateEngine::Private::IncludeEntry::Template, TemplateEngine::Private::IncludeEntry::type() , 以及 warn().

setOutputExtension()

void TemplateEngine::Private::setOutputExtension ( const QCString &  extension )

inline

在文件 template.cpp 第 5344 行定义.

    {
      m_extension = extension;
    }

引用了 m_extension.

setTemplateDir()

void TemplateEngine::Private::setTemplateDir ( const QCString &  dirName )

inline

在文件 template.cpp 第 5354 行定义.

    {
      m_templateDirName = dirName;
    }

引用了 m_templateDirName.

unload()

void TemplateEngine::Private::unload ( Template *  )

inline

在文件 template.cpp 第 5296 行定义.

    {
      //(void)t;
      //m_indent--;
      //for (int i=0;i<m_indent;i++) printf("  ");
      //printf("}\n");
      m_includeStack.pop_back();
    }

引用了 m_includeStack.

类成员变量说明

m_engine

TemplateEngine* TemplateEngine::Private::m_engine = 0

private

在文件 template.cpp 第 5362 行定义.

被这些函数引用 loadByName().

m_extension

QCString TemplateEngine::Private::m_extension

private

在文件 template.cpp 第 5364 行定义.

被这些函数引用 loadByName(), outputExtension() , 以及 setOutputExtension().

m_includeStack

std::vector<IncludeEntry> TemplateEngine::Private::m_includeStack

private

在文件 template.cpp 第 5363 行定义.

被这些函数引用 enterBlock(), leaveBlock(), loadByName(), printIncludeContext() , 以及 unload().

m_templateCache

std::unordered_map< std::string, std::unique_ptr<Template> > TemplateEngine::Private::m_templateCache

private

在文件 template.cpp 第 5360 行定义.

被这些函数引用 loadByName().

m_templateDirName

QCString TemplateEngine::Private::m_templateDirName

private

在文件 template.cpp 第 5365 行定义.

被这些函数引用 loadByName() , 以及 setTemplateDir().

---

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

• src/template.cpp