TemplateParser类 参考

Parser for templates 更多...

TemplateParser 的协作图:

Public 成员函数
	TemplateParser (const TemplateEngine *engine, const QCString &templateName, TemplateTokenStream &tokens)
void	parse (TemplateNode *parent, int line, const StringVector &stopAt, TemplateNodeList &nodes)
bool	hasNextToken () const
TemplateTokenPtr	takeNextToken ()
void	removeNextToken ()
void	prependToken (TemplateTokenPtr &&token)
const TemplateToken *	currentToken () const
QCString	templateName () const
void	warn (const QCString &fileName, int line, const char *fmt,...) const

Private 属性
const TemplateEngine *	m_engine = 0
QCString	m_templateName
TemplateTokenStream &	m_tokens

详细描述

Parser for templates

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

构造及析构函数说明

TemplateParser()

TemplateParser::TemplateParser	(	const TemplateEngine *	engine,
		const QCString &	templateName,
		TemplateTokenStream &	tokens
	)

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

                                                            :
   m_engine(engine), m_templateName(templateName), m_tokens(tokens)
{
}

成员函数说明

currentToken()

const TemplateToken * TemplateParser::currentToken

(

)

const

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

{
  return m_tokens.front().get();
}

引用了 m_tokens.

hasNextToken()

bool TemplateParser::hasNextToken

(

)

const

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

{
  return !m_tokens.empty();
}

引用了 m_tokens.

被这些函数引用 parse().

parse()

void TemplateParser::parse	(	TemplateNode *	parent,
		int	line,
		const StringVector &	stopAt,
		TemplateNodeList &	nodes
	)

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

{
  TRACE(("{TemplateParser::parse\n"));
  // process the tokens. Build node list
  while (hasNextToken())
  {
    auto tok = takeNextToken();
    TRACE(("%p:Token type=%d data='%s' line=%d\n",
           (void*)parent,tok->type,qPrint(tok->data),tok->line));
    switch(tok->type)
    {
      case TemplateToken::Text:
        nodes.push_back(std::make_unique<TemplateNodeText>(this,parent,tok->line,tok->data));
        break;
      case TemplateToken::Variable: // {{ var }}
        nodes.push_back(std::make_unique<TemplateNodeVariable>(this,parent,tok->line,tok->data));
        break;
      case TemplateToken::Block:    // {% tag %}
        {
          QCString command = tok->data;
          int sep = command.find(' ');
          if (sep!=-1)
          {
            command=command.left(sep);
          }
          TemplateToken *tok_ptr = tok.get();
          if (std::find(stopAt.begin(),stopAt.end(),command.str())!=stopAt.end())
          {
            prependToken(std::move(tok));
            TRACE(("}TemplateParser::parse: stop\n"));
            return;
          }
          QCString arg;
          if (sep!=-1)
          {
            arg = tok_ptr->data.mid(sep+1);
          }
          TemplateNodePtr node = TemplateNodeFactory::instance().create(
                                 command,this,parent,tok_ptr->line,arg);
          if (node)
          {
            nodes.push_back(std::move(node));
          }
          else if (command=="empty"          || command=="else"         ||
                   command=="endif"          || command=="endfor"       ||
                   command=="endblock"       || command=="endwith"      ||
                   command=="endrecursetree" || command=="endspaceless" ||
                   command=="endmarkers"     || command=="endmsg"       ||
                   command=="endrepeat"      || command=="elif"         ||
                   command=="endrange"       || command=="endtabbing"   ||
                   command=="endencoding")
          {
            warn(m_templateName,tok_ptr->line,"Found tag '%s' without matching start tag",qPrint(command));
          }
          else
          {
            warn(m_templateName,tok_ptr->line,"Unknown tag '%s'",qPrint(command));
          }
        }
        break;
    }
  }
  if (!stopAt.empty())
  {
    QCString options;
    for (const auto &s : stopAt)
    {
      if (!options.isEmpty()) options+=", ";
      options+=s.c_str();
    }
    warn(m_templateName,line,"Unclosed tag in template, expected one of: %s",
        qPrint(options));
  }
  TRACE(("}TemplateParser::parse: last token\n"));
}

引用了 TemplateToken::Block, TemplateNodeFactory::create(), QCString::data(), TemplateToken::data, QCString::find(), hasNextToken(), TemplateNodeFactory::instance(), QCString::isEmpty(), QCString::left(), TemplateToken::line, m_templateName, QCString::mid(), prependToken(), qPrint(), QCString::str(), takeNextToken(), TemplateToken::Text, TRACE, TemplateToken::Variable , 以及 warn().

被这些函数引用 TemplateImpl::TemplateImpl(), TemplateNodeBlock::TemplateNodeBlock(), TemplateNodeEncoding::TemplateNodeEncoding(), TemplateNodeExtend::TemplateNodeExtend(), TemplateNodeFor::TemplateNodeFor(), TemplateNodeIf::TemplateNodeIf(), TemplateNodeMarkers::TemplateNodeMarkers(), TemplateNodeMsg::TemplateNodeMsg(), TemplateNodeRange::TemplateNodeRange(), TemplateNodeRepeat::TemplateNodeRepeat(), TemplateNodeSpaceless::TemplateNodeSpaceless(), TemplateNodeTabbing::TemplateNodeTabbing(), TemplateNodeTree::TemplateNodeTree() , 以及 TemplateNodeWith::TemplateNodeWith().

prependToken()

void TemplateParser::prependToken

(

TemplateTokenPtr &&

token

)

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

{
  m_tokens.push_front(std::move(token));
}

引用了 m_tokens.

被这些函数引用 parse().

removeNextToken()

void TemplateParser::removeNextToken

(

)

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

{
  m_tokens.pop_front();
}

引用了 m_tokens.

被这些函数引用 TemplateNodeBlock::TemplateNodeBlock(), TemplateNodeEncoding::TemplateNodeEncoding(), TemplateNodeFor::TemplateNodeFor(), TemplateNodeIf::TemplateNodeIf(), TemplateNodeMarkers::TemplateNodeMarkers(), TemplateNodeMsg::TemplateNodeMsg(), TemplateNodeRange::TemplateNodeRange(), TemplateNodeRepeat::TemplateNodeRepeat(), TemplateNodeSpaceless::TemplateNodeSpaceless(), TemplateNodeTabbing::TemplateNodeTabbing(), TemplateNodeTree::TemplateNodeTree() , 以及 TemplateNodeWith::TemplateNodeWith().

takeNextToken()

TemplateTokenPtr TemplateParser::takeNextToken

(

)

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

{
  if (m_tokens.empty()) return TemplateTokenPtr();
  auto tok = std::move(m_tokens.front());
  m_tokens.pop_front();
  return tok;
}

引用了 m_tokens.

被这些函数引用 parse(), TemplateNodeFor::TemplateNodeFor() , 以及 TemplateNodeIf::TemplateNodeIf().

templateName()

QCString TemplateParser::templateName ( ) const

inline

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

{ return m_templateName; }

引用了 m_templateName.

被这些函数引用 ExpressionParser::getNextToken(), ExpressionParser::parseNotExpression(), ExpressionParser::parsePrimaryExpression(), TemplateNodeBlock::TemplateNodeBlock(), TemplateNodeCloseSubIndex::TemplateNodeCloseSubIndex(), TemplateNodeCycle::TemplateNodeCycle(), TemplateNodeIndexEntry::TemplateNodeIndexEntry(), TemplateNodeOpenSubIndex::TemplateNodeOpenSubIndex() , 以及 TemplateNodeWith::TemplateNodeWith().

warn()

void TemplateParser::warn	(	const QCString &	fileName,
		int	line,
		const char *	fmt,
			...
	)		const

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

{
  va_list args;
  va_start(args,fmt);
  va_warn(fileName,line,fmt,args);
  va_end(args);
  m_engine->printIncludeContext(fileName,line);
}

引用了 m_engine, TemplateEngine::printIncludeContext() , 以及 va_warn().

被这些函数引用 parse(), TemplateNodeBlock::TemplateNodeBlock(), TemplateNodeCloseSubIndex::TemplateNodeCloseSubIndex(), TemplateNodeCreate::TemplateNodeCreate(), TemplateNodeCycle::TemplateNodeCycle(), TemplateNodeEncoding::TemplateNodeEncoding(), TemplateNodeExtend::TemplateNodeExtend(), TemplateNodeFor::TemplateNodeFor(), TemplateNodeIf::TemplateNodeIf(), TemplateNodeInclude::TemplateNodeInclude(), TemplateNodeIndexEntry::TemplateNodeIndexEntry(), TemplateNodeMarkers::TemplateNodeMarkers(), TemplateNodeOpenSubIndex::TemplateNodeOpenSubIndex(), TemplateNodeRange::TemplateNodeRange(), TemplateNodeResource::TemplateNodeResource(), TemplateNodeTree::TemplateNodeTree(), TemplateNodeVariable::TemplateNodeVariable() , 以及 TemplateNodeWith::TemplateNodeWith().

类成员变量说明

m_engine

const TemplateEngine* TemplateParser::m_engine = 0

private

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

被这些函数引用 warn().

m_templateName

QCString TemplateParser::m_templateName

private

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

被这些函数引用 parse() , 以及 templateName().

m_tokens

TemplateTokenStream& TemplateParser::m_tokens

private

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

被这些函数引用 currentToken(), hasNextToken(), prependToken(), removeNextToken() , 以及 takeNextToken().

---

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

• src/template.cpp