TemplateNodeFor类 参考

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

类 TemplateNodeFor 继承关系图:

TemplateNodeFor 的协作图:

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

Private 属性
bool	m_reversed = false
ExprAstPtr	m_expr
std::vector< QCString >	m_vars
TemplateNodeList	m_loopNodes
TemplateNodeList	m_emptyNodes

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

详细描述

Class representing a 'for' tag in a template

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

构造及析构函数说明

TemplateNodeFor()

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

inline

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

      : TemplateNodeCreator<TemplateNodeFor>(parser,parent,line), m_reversed(FALSE)
    {
      TRACE(("{TemplateNodeFor(%s)\n",qPrint(data)));
      QCString exprStr;
      int i = data.find(" in ");
      if (i==-1)
      {
        if (data.endsWith(" in"))
        {
          parser->warn(m_templateName,line,"for is missing container after 'in' keyword");
        }
        else if (data=="in")
        {
          parser->warn(m_templateName,line,"for needs at least one iterator variable");
        }
        else
        {
          parser->warn(m_templateName,line,"for is missing 'in' keyword");
        }
      }
      else
      {
        m_vars = split(data.left(i),",");
        if (m_vars.size()==0)
        {
          parser->warn(m_templateName,line,"for needs at least one iterator variable");
        }
 
        int j = data.find(" reversed",i);
        m_reversed = (j!=-1);
 
        if (j==-1) j=data.length();
        if (j>i+4)
        {
          exprStr = data.mid(i+4,j-i-4); // skip over " in " part
        }
        if (exprStr.isEmpty())
        {
          parser->warn(m_templateName,line,"for is missing container after 'in' keyword");
        }
      }
      ExpressionParser expParser(parser,line);
      m_expr = expParser.parse(exprStr);
 
      StringVector stopAt = { "endfor", "empty" };
      parser->parse(this,line,stopAt,m_loopNodes);
      auto tok = parser->takeNextToken();
      if (tok && tok->data=="empty")
      {
        stopAt.pop_back();
        parser->parse(this,line,stopAt,m_emptyNodes);
        parser->removeNextToken(); // skip over endfor
      }
      TRACE(("}TemplateNodeFor(%s)\n",qPrint(data)));
    }

引用了 QCString::endsWith(), QCString::find(), QCString::isEmpty(), QCString::left(), QCString::length(), m_emptyNodes, m_expr, m_loopNodes, m_reversed, TemplateNodeCreator< TemplateNodeFor >::m_templateName, m_vars, QCString::mid(), TemplateParser::parse(), ExpressionParser::parse(), qPrint(), TemplateParser::removeNextToken(), split(), TemplateParser::takeNextToken(), TRACE , 以及 TemplateParser::warn().

成员函数说明

render()

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

inlinevirtual

实现了 TemplateNode.

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

    {
      TemplateContextImpl* ci = dynamic_cast<TemplateContextImpl*>(c);
      if (ci==0) return; // should not happen
      ci->setLocation(m_templateName,m_line);
      //printf("TemplateNodeFor::render #loopNodes=%d #emptyNodes=%d\n",
      //    m_loopNodes.count(),m_emptyNodes.count());
      if (m_expr)
      {
        TemplateVariant v = m_expr->resolve(c);
        if (v.isFunction())
        {
          v = v.call();
        }
        const TemplateListIntfPtr list = v.toList();
        if (list)
        {
          uint listSize = list->count();
          if (listSize==0) // empty for loop
          {
            m_emptyNodes.render(ts,c);
            return;
          }
          c->push();
          //int index = m_reversed ? list.count() : 0;
          //TemplateVariant v;
          const TemplateVariant *parentLoop = c->getRef("forloop");
          uint index = m_reversed ? listSize-1 : 0;
          TemplateListIntf::ConstIteratorPtr it = list->createIterator();
          TemplateVariant ve;
          for (m_reversed ? it->toLast() : it->toFirst();
              (it->current(ve));
              m_reversed ? it->toPrev() : it->toNext())
          {
            TemplateStructPtr s = TemplateStruct::alloc();
            s->set("counter0",    (int)index);
            s->set("counter",     (int)(index+1));
            s->set("revcounter",  (int)(listSize-index));
            s->set("revcounter0", (int)(listSize-index-1));
            s->set("first",index==0);
            s->set("last", index==listSize-1);
            s->set("parentloop",parentLoop ? *parentLoop : TemplateVariant());
            c->set("forloop",std::static_pointer_cast<TemplateStructIntf>(s));
 
            // add variables for this loop to the context
            //obj->addVariableToContext(index,m_vars,c);
            uint vi=0;
            if (m_vars.size()==1) // loop variable represents an item
            {
              c->set(m_vars[vi++],ve);
            }
            else if (m_vars.size()>1 && (ve.isStruct() || ve.isWeakStruct()))
              // loop variables represent elements in a list item
            {
              TemplateStructIntfPtr vs = ve.toStruct();
              if (vs)
              {
                for (uint i=0;i<m_vars.size();i++,vi++)
                {
                  c->set(m_vars[vi],vs->get(m_vars[vi]));
                }
              }
            }
            for (;vi<m_vars.size();vi++)
            {
              c->set(m_vars[vi],TemplateVariant());
            }
 
            // render all items for this iteration of the loop
            m_loopNodes.render(ts,c);
 
            if (m_reversed) index--; else index++;
          }
          c->pop();
        }
        else // simple type...
        {
          ci->warn(m_templateName,m_line,"for requires a variable of list type, got type '%s'!",qPrint(v.typeAsString()));
        }
      }
    }

引用了 TemplateStruct::alloc(), TemplateVariant::call(), TemplateContext::getRef(), TemplateVariant::isFunction(), TemplateVariant::isStruct(), TemplateVariant::isWeakStruct(), m_emptyNodes, m_expr, TemplateNodeCreator< TemplateNodeFor >::m_line, m_loopNodes, m_reversed, TemplateNodeCreator< TemplateNodeFor >::m_templateName, m_vars, TemplateContext::pop(), TemplateContext::push(), qPrint(), TemplateNodeList::render(), TemplateContext::set(), TemplateContextImpl::setLocation(), TemplateVariant::toList(), TemplateVariant::toStruct(), TemplateVariant::typeAsString() , 以及 TemplateContextImpl::warn().

类成员变量说明

m_emptyNodes

TemplateNodeList TemplateNodeFor::m_emptyNodes

private

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

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

m_expr

ExprAstPtr TemplateNodeFor::m_expr

private

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

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

m_loopNodes

TemplateNodeList TemplateNodeFor::m_loopNodes

private

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

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

m_reversed

bool TemplateNodeFor::m_reversed = false

private

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

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

m_vars

std::vector<QCString> TemplateNodeFor::m_vars

private

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

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

---

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

• src/template.cpp