TemplateLexer类 参考

Lexer class for turning a template into a list of tokens 更多...

TemplateLexer 的协作图:

Public 成员函数
	TemplateLexer (const TemplateEngine *engine, const QCString &fileName, const QCString &data)
void	tokenize (TemplateTokenStream &tokens)
void	setOpenCloseCharacters (char openChar, char closeChar)

Private 成员函数
void	addToken (TemplateTokenStream &tokens, const QCString &data, int line, int startPos, int endPos, TemplateToken::Type type)
void	reset ()

Private 属性
const TemplateEngine *	m_engine = 0
QCString	m_fileName
QCString	m_data
char	m_openChar = 0
char	m_closeChar = 0

详细描述

Lexer class for turning a template into a list of tokens

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

构造及析构函数说明

TemplateLexer()

TemplateLexer::TemplateLexer	(	const TemplateEngine *	engine,
		const QCString &	fileName,
		const QCString &	data
	)

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

                                                                                                       :
  m_engine(engine), m_fileName(fileName), m_data(data)
{
  m_openChar='{';
  m_closeChar='}';
}

引用了 m_closeChar , 以及 m_openChar.

成员函数说明

addToken()

void TemplateLexer::addToken ( TemplateTokenStream &  tokens, const QCString &  data, int  line, int  startPos, int  endPos, TemplateToken::Type  type  )

private

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

{
  if (startPos<endPos)
  {
    int len = endPos-startPos;
    QCString text = data.mid(startPos,len);
    if (type!=TemplateToken::Text) text = text.stripWhiteSpace();
    tokens.push_back(std::make_unique<TemplateToken>(type,text,line));
  }
}

引用了 QCString::mid(), QCString::stripWhiteSpace() , 以及 TemplateToken::Text.

被这些函数引用 tokenize().

reset()

void TemplateLexer::reset ( )

private

setOpenCloseCharacters()

void TemplateLexer::setOpenCloseCharacters ( char  openChar, char  closeChar  )

inline

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

    { m_openChar=openChar; m_closeChar=closeChar; }

引用了 m_closeChar , 以及 m_openChar.

被这些函数引用 TemplateImpl::TemplateImpl().

tokenize()

void TemplateLexer::tokenize

(

TemplateTokenStream &

tokens

)

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

{
  enum LexerStates
  {
    StateText,
    StateBeginTemplate,
    StateTag,
    StateEndTag,
    StateComment,
    StateEndComment,
    StateMaybeVar,
    StateVariable,
    StateEndVariable
  };
 
  if (m_data.isEmpty()) return;
  const char *p=m_data.data();
  int  state=StateText;
  int  pos=0;
  int  lastTokenPos=0;
  int  startLinePos=0;
  bool emptyOutputLine=TRUE;
  int  line=1;
  char c;
  int  markStartPos=-1;
  for (;(c=*p);p++,pos++)
  {
    switch (state)
    {
      case StateText:
        if (c==m_openChar) // {{ or {% or {# or something else
        {
          state=StateBeginTemplate;
        }
        else if (c!=' ' && c!='\t' && c!='\n') // non-whitespace text
        {
          emptyOutputLine=FALSE;
        }
        break;
      case StateBeginTemplate:
        switch (c)
        {
          case '%': // {%
            state=StateTag;
            markStartPos=pos-1;
            break;
          case '#': // {#
            state=StateComment;
            markStartPos=pos-1;
            break;
          case '{': // {{
            if (m_openChar=='{')
            {
              state=StateMaybeVar;
            }
            else
            {
              state=StateVariable;
            }
            markStartPos=pos-1;
            break;
          default:
            state=StateText;
            emptyOutputLine=FALSE;
            break;
        }
        break;
      case StateTag:
        if (c=='\n')
        {
          warn(m_fileName,line,"unexpected new line inside %c%%...%%%c block",m_openChar,m_closeChar);
          m_engine->printIncludeContext(m_fileName,line);
        }
        else if (c=='%') // %} or something else
        {
          state=StateEndTag;
        }
        break;
      case StateEndTag:
        if (c==m_closeChar) // %}
        {
          // found tag!
          state=StateText;
          addToken(tokens,m_data,line,lastTokenPos,
                   emptyOutputLine ? startLinePos : markStartPos,
                   TemplateToken::Text);
          addToken(tokens,m_data,line,markStartPos+2,
                   pos-1,TemplateToken::Block);
          lastTokenPos = pos+1;
        }
        else // something else
        {
          if (c=='\n')
          {
            warn(m_fileName,line,"unexpected new line inside %c%%...%%%c block",m_openChar,m_closeChar);
            m_engine->printIncludeContext(m_fileName,line);
          }
          state=StateTag;
        }
        break;
      case StateComment:
        if (c=='\n')
        {
          warn(m_fileName,line,"unexpected new line inside %c#...#%c block",m_openChar,m_closeChar);
          m_engine->printIncludeContext(m_fileName,line);
        }
        else if (c=='#') // #} or something else
        {
          state=StateEndComment;
        }
        break;
      case StateEndComment:
        if (c==m_closeChar) // #}
        {
          // found comment tag!
          state=StateText;
          addToken(tokens,m_data,line,lastTokenPos,
                   emptyOutputLine ? startLinePos : markStartPos,
                   TemplateToken::Text);
          lastTokenPos = pos+1;
        }
        else // something else
        {
          if (c=='\n')
          {
            warn(m_fileName,line,"unexpected new line inside %c#...#%c block",m_openChar,m_closeChar);
            m_engine->printIncludeContext(m_fileName,line);
          }
          state=StateComment;
        }
        break;
      case StateMaybeVar:
        switch (c)
        {
          case '#': // {{#
            state=StateComment;
            markStartPos=pos-1;
            break;
          case '%': // {{%
            state=StateTag;
            markStartPos=pos-1;
            break;
          default:  // {{
            state=StateVariable;
            break;
        }
        break;
      case StateVariable:
        emptyOutputLine=FALSE; // assume a variable expands to content
        if (c=='\n')
        {
          warn(m_fileName,line,"unexpected new line inside %c{...}%c block",m_openChar,m_closeChar);
          m_engine->printIncludeContext(m_fileName,line);
        }
        else if (c=='}') // }} or something else
        {
          state=StateEndVariable;
        }
        break;
      case StateEndVariable:
        if (c==m_closeChar) // }}
        {
          // found variable tag!
          state=StateText;
          addToken(tokens,m_data,line,lastTokenPos,
                   emptyOutputLine ? startLinePos : markStartPos,
                   TemplateToken::Text);
          addToken(tokens,m_data,line,markStartPos+2,
                   pos-1,TemplateToken::Variable);
          lastTokenPos = pos+1;
        }
        else // something else
        {
          if (c=='\n')
          {
            warn(m_fileName,line,"unexpected new line inside %c{...}%c block",m_openChar,m_closeChar);
            m_engine->printIncludeContext(m_fileName,line);
          }
          state=StateVariable;
        }
        break;
    }
    if (c=='\n') // new line
    {
      state=StateText;
      startLinePos=pos+1;
      // if the current line only contain commands and whitespace,
      // then skip it in the output by moving lastTokenPos
      if (markStartPos!=-1 && emptyOutputLine) lastTokenPos = startLinePos;
      // reset markers
      markStartPos=-1;
      line++;
      emptyOutputLine=TRUE;
    }
  }
  if (lastTokenPos<pos)
  {
    addToken(tokens,m_data,line,
             lastTokenPos,pos,
             TemplateToken::Text);
  }
}

引用了 addToken(), TemplateToken::Block, QCString::data(), FALSE, QCString::isEmpty(), m_closeChar, m_data, m_engine, m_fileName, m_openChar, TemplateEngine::printIncludeContext(), TemplateToken::Text, TRUE, TemplateToken::Variable , 以及 warn().

被这些函数引用 TemplateImpl::TemplateImpl().

类成员变量说明

m_closeChar

char TemplateLexer::m_closeChar = 0

private

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

被这些函数引用 setOpenCloseCharacters(), TemplateLexer() , 以及 tokenize().

m_data

QCString TemplateLexer::m_data

private

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

被这些函数引用 tokenize().

m_engine

const TemplateEngine* TemplateLexer::m_engine = 0

private

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

被这些函数引用 tokenize().

m_fileName

QCString TemplateLexer::m_fileName

private

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

被这些函数引用 tokenize().

m_openChar

char TemplateLexer::m_openChar = 0

private

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

被这些函数引用 setOpenCloseCharacters(), TemplateLexer() , 以及 tokenize().

---

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

• src/template.cpp