#include <condparser.h>

CondParser 的协作图:

Public 成员函数
	CondParser ()

bool	parse (const QCString &fileName, int lineNr, const QCString &expr)
	Copyright (C) 1997-2015 by Dimitri van Heesch. 更多...

Private 类型
enum	TOKENTYPE { NOTHING = -1, DELIMITER, VARIABLE, UNKNOWN }

enum	OPERATOR_ID { UNKNOWN_OP = -1, AND = 1, OR, NOT }

Private 成员函数
void	getToken ()
	Get next token in the current string expr. 更多...

bool	parseLevel1 ()
	conditional operators AND and OR 更多...

bool	parseLevel2 ()
	NOT 更多...

bool	parseLevel3 ()
	parenthesized expression or variable 更多...

bool	parseVar ()

bool	evalOperator (const int opId, bool lhs, bool rhs)
	evaluate an operator for given values 更多...

bool	evalVariable (const QCString &varName)
	evaluate a variable 更多...

int	getOperatorId (const QCString &opName)
	returns the id of the given operator returns -1 if the operator is not recognized 更多...

Private 属性
QCString	m_err
	error state 更多...

QCString	m_expr
	holds the expression 更多...

const char *	m_e
	points to a character in expr 更多...

QCString	m_token
	holds the token 更多...

TOKENTYPE	m_tokenType
	type of the token 更多...

详细描述

Permission to use, copy, modify, and distribute this software and its documentation under the terms of the GNU General Public License is hereby granted. No representations are made about the suitability of this software for any purpose. It is provided "as is" without express or implied warranty. See the GNU General Public License for more details.

Documents produced by Doxygen are derivative works derived from the input used in their production; they are not affected by this license.

C++ Expression parser for ENABLED_SECTIONS in Doxygen

Features used: Operators: && AND operator || OR operator ! NOT operator

在文件 condparser.h 第 27 行定义.

成员枚举类型说明

◆ OPERATOR_ID

enum CondParser::OPERATOR_ID

private

枚举值
UNKNOWN_OP
AND
OR
NOT

在文件 condparser.h 第 43 行定义.

     {
       UNKNOWN_OP = -1,
       AND = 1,
       OR,
       NOT
     };

◆ TOKENTYPE

enum CondParser::TOKENTYPE

private

枚举值
NOTHING
DELIMITER
VARIABLE
UNKNOWN

在文件 condparser.h 第 36 行定义.

     {
       NOTHING = -1,
       DELIMITER,
       VARIABLE,
       UNKNOWN
     };

构造及析构函数说明

◆ CondParser()

CondParser::CondParser ( )

inline

在文件 condparser.h 第 31 行定义.

31 : m_e(0), m_tokenType(NOTHING) {}

成员函数说明

◆ evalOperator()

bool CondParser::evalOperator	(	const int	opId,
		bool	lhs,
		bool	rhs
	)

private

evaluate an operator for given values

在文件 condparser.cpp 第 267 行定义.

 {
   switch (opId)
   {
     // level 2
     case AND: return lhs && rhs;
     case OR:  return lhs || rhs;
   }
  
   m_err = "Internal error unknown operator: id="+QCString().setNum(opId);
   return FALSE;
 }

引用了 AND, FALSE, m_err, OR , 以及 QCString::setNum().

被这些函数引用 parseLevel1().

◆ evalVariable()

bool CondParser::evalVariable ( const QCString & varName )

private

evaluate a variable

在文件 condparser.cpp 第 283 行定义.

 {
   const StringVector &list = Config_getList(ENABLED_SECTIONS);
   return std::find(list.begin(),list.end(),varName.str())!=list.end();
 }

引用了 Config_getList , 以及 QCString::str().

被这些函数引用 parseVar().

◆ getOperatorId()

int CondParser::getOperatorId ( const QCString & opName )

private

returns the id of the given operator returns -1 if the operator is not recognized

在文件 condparser.cpp 第 91 行定义.

 {
   // level 2
   if (opName=="&&") { return AND; }
   if (opName=="||") { return OR;  }
  
   // not operator
   if (opName=="!")  { return NOT; }
  
   return UNKNOWN_OP;
 }

引用了 AND, NOT, OR , 以及 UNKNOWN_OP.

被这些函数引用 parseLevel1() , 以及 parseLevel2().

◆ getToken()

void CondParser::getToken ( )

private

Get next token in the current string expr.

Uses the data in m_expr pointed to by m_e to produce m_tokenType and m_token, set m_err in case of an error

在文件 condparser.cpp 第 108 行定义.

 {
   m_tokenType = NOTHING;
   m_token.resize(0);
  
   //printf("\tgetToken e:{%c}, ascii=%i, col=%i\n", *e, *e, e-expr);
  
   // skip over whitespaces
   while (*m_e == ' ' || *m_e == '\t' || *m_e == '\n')     // space or tab or newline
   {
     m_e++;
   }
  
   // check for end of expression
   if (*m_e=='\0')
   {
     // token is still empty
     m_tokenType = DELIMITER;
     return;
   }
  
   // check for parentheses
   if (*m_e == '(' || *m_e == ')')
   {
     m_tokenType = DELIMITER;
     m_token += *m_e++;
     return;
   }
  
   // check for operators (delimiters)
   if (isDelimiter(*m_e))
   {
     m_tokenType = DELIMITER;
     while (isDelimiter(*m_e))
     {
       m_token += *m_e++;
     }
     return;
   }
  
   // check for variables
   if (isAlpha(*m_e))
   {
     m_tokenType = VARIABLE;
     while (isAlphaNumSpec(*m_e))
     {
       m_token += *m_e++;
     }
     return;
   }
  
   // something unknown is found, wrong characters -> a syntax error
   m_tokenType = UNKNOWN;
   while (*m_e)
   {
     m_token += *m_e++;
   }
   m_err = QCString("Syntax error in part '")+m_token+"'";
   return;
 }

引用了 DELIMITER, isAlpha(), isAlphaNumSpec(), isDelimiter(), m_e, m_err, m_token, m_tokenType, NOTHING, QCString::resize(), UNKNOWN , 以及 VARIABLE.

被这些函数引用 parse(), parseLevel1(), parseLevel2(), parseLevel3() , 以及 parseVar().

◆ parse()

bool CondParser::parse	(	const QCString &	fileName,
		int	lineNr,
		const QCString &	expr
	)

Permission to use, copy, modify, and distribute this software and its documentation under the terms of the GNU General Public License is hereby granted. No representations are made about the suitability of this software for any purpose. It is provided "as is" without express or implied warranty. See the GNU General Public License for more details.

Documents produced by Doxygen are derivative works derived from the input used in their production; they are not affected by this license.

C++ Expression parser for ENABLED_SECTIONS in Doxygen

Features used: Operators: && AND operator || OR operator ! NOT operator parses and evaluates the given expression.

返回

On error, an error message is returned.
On success, the result of the expression is either "1" or "0".

在文件 condparser.cpp 第 36 行定义.

 {
   if (expr.isEmpty()) return false;
   m_expr      = expr;
   m_tokenType = NOTHING;
  
   // initialize all variables
   m_e = m_expr.data();    // let m_e point to the start of the expression
  
   bool answer=false;
   getToken();
   if (m_tokenType==DELIMITER && m_token.isEmpty())
   {
     // empty expression: answer==FALSE
   }
   else if (m_err.isEmpty())
   {
     answer = parseLevel1();
   }
   if (!m_err.isEmpty())
   {
     warn(fileName,lineNr,"problem evaluating expression '%s': %s",
         qPrint(expr),qPrint(m_err));
   }
   //printf("expr='%s' answer=%d\n",expr,answer);
   return answer;
 }

引用了 QCString::data(), DELIMITER, getToken(), QCString::isEmpty(), m_e, m_err, m_expr, m_token, m_tokenType, NOTHING, parseLevel1(), qPrint() , 以及 warn().

◆ parseLevel1()

bool CondParser::parseLevel1 ( )

private

conditional operators AND and OR

在文件 condparser.cpp 第 173 行定义.

 {
   bool ans = parseLevel2();
   int opId = getOperatorId(m_token);
  
   while (opId==AND || opId==OR)
   {
     getToken();
     ans = evalOperator(opId, ans, parseLevel2());
     opId = getOperatorId(m_token);
   }
  
   return ans;
 }

引用了 AND, evalOperator(), getOperatorId(), getToken(), m_token, OR , 以及 parseLevel2().

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

◆ parseLevel2()

bool CondParser::parseLevel2 ( )

private

NOT

在文件 condparser.cpp 第 191 行定义.

 {
   bool ans;
   int opId = getOperatorId(m_token);
   if (opId == NOT)
   {
     getToken();
     ans = !parseLevel3();
   }
   else
   {
     ans = parseLevel3();
   }
  
   return ans;
 }

引用了 getOperatorId(), getToken(), m_token, NOT , 以及 parseLevel3().

被这些函数引用 parseLevel1().

◆ parseLevel3()

bool CondParser::parseLevel3 ( )

private

parenthesized expression or variable

在文件 condparser.cpp 第 212 行定义.

 {
   // check if it is a parenthesized expression
   if (m_tokenType == DELIMITER)
   {
     if (m_token=="(")
     {
       getToken();
       int ans = parseLevel1();
       if (m_tokenType!=DELIMITER || m_token!=")")
       {
         m_err="Parenthesis ) missing";
         return FALSE;
       }
       getToken();
       return ans;
     }
   }
  
   // if not parenthesized then the expression is a variable
   return parseVar();
 }

引用了 DELIMITER, FALSE, getToken(), m_err, m_token, m_tokenType, parseLevel1() , 以及 parseVar().

被这些函数引用 parseLevel2().

◆ parseVar()

bool CondParser::parseVar ( )

private

在文件 condparser.cpp 第 236 行定义.

 {
   bool ans = false;
   switch (m_tokenType)
   {
     case VARIABLE:
       // this is a variable
       ans = evalVariable(m_token);
       getToken();
       break;
  
     default:
       // syntax error or unexpected end of expression
       if (m_token.isEmpty())
       {
         m_err="Unexpected end of expression";
         return FALSE;
       }
       else
       {
         m_err="Value expected";
         return FALSE;
       }
       break;
   }
   return ans;
 }

引用了 evalVariable(), FALSE, getToken(), QCString::isEmpty(), m_err, m_token, m_tokenType , 以及 VARIABLE.

被这些函数引用 parseLevel3().

类成员变量说明

◆ m_e

const char* CondParser::m_e

private

points to a character in expr

在文件 condparser.h 第 56 行定义.

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

◆ m_err

QCString CondParser::m_err

private

error state

在文件 condparser.h 第 54 行定义.

被这些函数引用 evalOperator(), getToken(), parse(), parseLevel3() , 以及 parseVar().

◆ m_expr

QCString CondParser::m_expr

private

holds the expression

在文件 condparser.h 第 55 行定义.

被这些函数引用 parse().

◆ m_token

QCString CondParser::m_token

private

holds the token

在文件 condparser.h 第 58 行定义.

被这些函数引用 getToken(), parse(), parseLevel1(), parseLevel2(), parseLevel3() , 以及 parseVar().

◆ m_tokenType

TOKENTYPE CondParser::m_tokenType

private

type of the token

在文件 condparser.h 第 59 行定义.

被这些函数引用 getToken(), parse(), parseLevel3() , 以及 parseVar().

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

src/condparser.h
src/condparser.cpp

Public 成员函数

Private 类型

Private 成员函数

Private 属性

详细描述

成员枚举类型说明

◆ OPERATOR_ID

◆ TOKENTYPE

构造及析构函数说明

◆ CondParser()

成员函数说明

◆ evalOperator()

◆ evalVariable()

◆ getOperatorId()

◆ getToken()

◆ parse()

◆ parseLevel1()

◆ parseLevel2()

◆ parseLevel3()

◆ parseVar()

类成员变量说明

◆ m_e

◆ m_err

◆ m_expr

◆ m_token

◆ m_tokenType