TemplateNodeExtend类 参考

Class representing a 'extend' tag in a template 更多...

类 TemplateNodeExtend 继承关系图:

TemplateNodeExtend 的协作图:

Public 成员函数
	TemplateNodeExtend (TemplateParser *parser, TemplateNode *parent, int line, const QCString &data)
void	render (TextStream &ts, TemplateContext *c)
Public 成员函数 继承自 TemplateNodeCreator< TemplateNodeExtend >
	TemplateNodeCreator (TemplateParser *parser, TemplateNode *parent, int line)
TemplateImpl *	getTemplate ()
Public 成员函数 继承自 TemplateNode
	TemplateNode (TemplateNode *parent)
virtual	~TemplateNode ()
TemplateNode *	parent ()

Private 属性
ExprAstPtr	m_extendExpr
TemplateNodeList	m_nodes

额外继承的成员函数
静态 Public 成员函数 继承自 TemplateNodeCreator< TemplateNodeExtend >
static TemplateNodePtr	createInstance (TemplateParser *parser, TemplateNode *parent, int line, const QCString &data)
Protected 成员函数 继承自 TemplateNodeCreator< TemplateNodeExtend >
void	mkpath (const TemplateContextImpl *ci, const std::string &fileName)
Protected 属性 继承自 TemplateNodeCreator< TemplateNodeExtend >
QCString	m_templateName
int	m_line

详细描述

Class representing a 'extend' tag in a template

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

构造及析构函数说明

TemplateNodeExtend()

TemplateNodeExtend::TemplateNodeExtend ( TemplateParser *  parser, TemplateNode *  parent, int  line, const QCString &  data  )

inline

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

      : TemplateNodeCreator<TemplateNodeExtend>(parser,parent,line)
    {
      TRACE(("{TemplateNodeExtend(%s)\n",qPrint(data)));
      ExpressionParser ep(parser,line);
      if (data.isEmpty())
      {
        parser->warn(m_templateName,line,"extend tag is missing template file argument");
      }
      m_extendExpr = ep.parse(data);
      StringVector stopAt;
      parser->parse(this,line,stopAt,m_nodes);
      TRACE(("}TemplateNodeExtend(%s)\n",qPrint(data)));
    }

引用了 QCString::isEmpty(), m_extendExpr, m_nodes, TemplateNodeCreator< TemplateNodeExtend >::m_templateName, TemplateParser::parse(), ExpressionParser::parse(), qPrint(), TRACE , 以及 TemplateParser::warn().

成员函数说明

render()

void TemplateNodeExtend::render ( TextStream &  ts, TemplateContext *  c  )

inlinevirtual

实现了 TemplateNode.

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

    {
      TemplateContextImpl* ci = dynamic_cast<TemplateContextImpl*>(c);
      if (ci==0) return; // should not happen
      ci->setLocation(m_templateName,m_line);
      if (m_extendExpr==0) return;
 
      QCString extendFile = m_extendExpr->resolve(c).toString();
      if (extendFile.isEmpty())
      {
        ci->warn(m_templateName,m_line,"invalid parameter for extend command");
      }
 
      // goto root of tree (template node)
      TemplateImpl *t = getTemplate();
      if (t)
      {
        Template *bt = t->engine()->loadByName(extendFile,m_line);
        TemplateImpl *baseTemplate = bt ? dynamic_cast<TemplateImpl*>(bt) : 0;
        if (baseTemplate)
        {
          // fill block context
          TemplateBlockContext *bc = ci->blockContext();
 
          // add overruling blocks to the context
          for (const auto &n : m_nodes)
          {
            TemplateNodeBlock *nb = dynamic_cast<TemplateNodeBlock*>(n.get());
            if (nb)
            {
              bc->add(nb);
            }
            TemplateNodeMsg *msg = dynamic_cast<TemplateNodeMsg*>(n.get());
            if (msg)
            {
              msg->render(ts,c);
            }
          }
 
          // render the base template with the given context
          baseTemplate->render(ts,c);
 
          // clean up
          bc->clear();
        }
        else
        {
          ci->warn(m_templateName,m_line,"failed to load template %s for extend",qPrint(extendFile));
        }
        t->engine()->unload(bt);
      }
    }

引用了 TemplateBlockContext::add(), TemplateContextImpl::blockContext(), TemplateBlockContext::clear(), TemplateImpl::engine(), TemplateNodeCreator< TemplateNodeExtend >::getTemplate(), QCString::isEmpty(), TemplateEngine::loadByName(), m_extendExpr, TemplateNodeCreator< TemplateNodeExtend >::m_line, m_nodes, TemplateNodeCreator< TemplateNodeExtend >::m_templateName, msg(), qPrint(), TemplateImpl::render(), TemplateContextImpl::setLocation(), TemplateEngine::unload() , 以及 TemplateContextImpl::warn().

类成员变量说明

m_extendExpr

ExprAstPtr TemplateNodeExtend::m_extendExpr

private

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

被这些函数引用 render() , 以及 TemplateNodeExtend().

m_nodes

TemplateNodeList TemplateNodeExtend::m_nodes

private

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

被这些函数引用 render() , 以及 TemplateNodeExtend().

---

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

• src/template.cpp