TemplateNodeBlock类 参考

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

类 TemplateNodeBlock 继承关系图:

TemplateNodeBlock 的协作图:

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

Private 属性
QCString	m_blockName
TemplateNodeList	m_nodes

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

详细描述

Class representing a 'block' tag in a template

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

构造及析构函数说明

TemplateNodeBlock()

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

inline

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

      : TemplateNodeCreator<TemplateNodeBlock>(parser,parent,line)
    {
      TRACE(("{TemplateNodeBlock(%s)\n",qPrint(data)));
      m_blockName = data;
      if (m_blockName.isEmpty())
      {
        parser->warn(parser->templateName(),line,"block tag without name");
      }
      StringVector stopAt = { "endblock" };
      parser->parse(this,line,stopAt,m_nodes);
      parser->removeNextToken(); // skip over endblock
      TRACE(("}TemplateNodeBlock(%s)\n",qPrint(data)));
    }

引用了 QCString::isEmpty(), m_blockName, m_nodes, TemplateParser::parse(), qPrint(), TemplateParser::removeNextToken(), TemplateParser::templateName(), TRACE , 以及 TemplateParser::warn().

成员函数说明

name()

QCString TemplateNodeBlock::name ( ) const

inline

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

    {
      return m_blockName;
    }

引用了 m_blockName.

被这些函数引用 TemplateBlockContext::add() , 以及 TemplateBlockContext::push().

render()

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

inlinevirtual

实现了 TemplateNode.

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

    {
      TemplateContextImpl *ci = dynamic_cast<TemplateContextImpl*>(c);
      if (ci==0) return; // should not happen
      ci->setLocation(m_templateName,m_line);
      TemplateImpl *t = getTemplate();
      if (t)
      {
        // remove block from the context, so block.super can work
        TemplateNodeBlock *nb = ci->blockContext()->pop(m_blockName);
        if (nb) // block is overruled
        {
          ci->push();
          TextStream ss;
          // get super block of block nb
          TemplateNodeBlock *sb = ci->blockContext()->get(m_blockName);
          if (sb && sb!=nb && sb!=this) // nb and sb both overrule this block
          {
            sb->render(ss,c); // render parent of nb to string
          }
          else if (nb!=this) // only nb overrules this block
          {
            m_nodes.render(ss,c); // render parent of nb to string
          }
          QCString super = ss.str();
          // add 'block.super' variable to allow access to parent block content
          TemplateStructPtr superBlock = TemplateStruct::alloc();
          superBlock->set("super",TemplateVariant(super.data(),TRUE));
          ci->set("block",std::static_pointer_cast<TemplateStructIntf>(superBlock));
          // render the overruled block contents
          t->engine()->enterBlock(nb->m_templateName,nb->m_blockName,nb->m_line);
          nb->m_nodes.render(ts,c);
          t->engine()->leaveBlock();
          ci->pop();
          // re-add block to the context
          ci->blockContext()->push(nb);
        }
        else // block has no overrule
        {
          t->engine()->enterBlock(m_templateName,m_blockName,m_line);
          m_nodes.render(ts,c);
          t->engine()->leaveBlock();
        }
      }
    }

引用了 TemplateStruct::alloc(), TemplateContextImpl::blockContext(), QCString::data(), TemplateImpl::engine(), TemplateEngine::enterBlock(), TemplateBlockContext::get(), TemplateNodeCreator< TemplateNodeBlock >::getTemplate(), TemplateEngine::leaveBlock(), m_blockName, TemplateNodeCreator< T >::m_line, TemplateNodeCreator< TemplateNodeBlock >::m_line, m_nodes, TemplateNodeCreator< T >::m_templateName, TemplateNodeCreator< TemplateNodeBlock >::m_templateName, TemplateBlockContext::pop(), TemplateContextImpl::pop(), TemplateBlockContext::push(), TemplateContextImpl::push(), TemplateNodeList::render(), render(), TemplateContextImpl::set(), TemplateContextImpl::setLocation(), TextStream::str() , 以及 TRUE.

被这些函数引用 render().

类成员变量说明

m_blockName

QCString TemplateNodeBlock::m_blockName

private

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

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

m_nodes

TemplateNodeList TemplateNodeBlock::m_nodes

private

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

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

---

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

• src/template.cpp