#include "template.h"
#include <vector>
#include <algorithm>
#include <unordered_map>
#include <deque>
#include <cstdio>
#include <fstream>
#include <sstream>
#include "message.h"
#include "util.h"
#include "resourcemgr.h"
#include "portable.h"
#include "regex.h"
#include "fileinfo.h"
#include "dir.h"
#include "utf8.h"

template.cpp 的引用(Include)关系图:

类
class	TemplateStruct
	Default implementation of a context value of type struct. 更多...

class	TemplateListGenericConstIterator< List >

class	TemplateList
	Default implementation of a context value of type list. 更多...

class	TemplateImmutableStruct::Private
	Private data of a template struct object 更多...

class	TemplateImmutableList::Private
	Private data of a template immutable list object 更多...

class	Operator
	Class representing operators that can appear in template expressions 更多...

class	TemplateBlockContext
	Class holding stacks of blocks available in the context 更多...

struct	TemplateKeyValue
	A container to store a key-value pair 更多...

class	TemplateContextImpl
	Internal class representing the implementation of a template context 更多...

class	FilterAdd
	The implementation of the "add" filter 更多...

class	FilterGet
	The implementation of the "get" filter 更多...

class	FilterRaw
	The implementation of the "raw" filter 更多...

class	FilterKeep
	The implementation of the "keep" filter 更多...

class	FilterList
	The implementation of the "list" filter 更多...

class	FilterTexLabel
	The implementation of the "texlabel" filter 更多...

class	FilterTexIndex
	The implementation of the "texindex" filter 更多...

class	FilterAppend
	The implementation of the "append" filter 更多...

class	FilterPrepend
	The implementation of the "prepend" filter 更多...

class	FilterLength
	The implementation of the "length" filter 更多...

class	FilterDefault
	The implementation of the "default" filter 更多...

class	FilterFlatten
	The implementation of the "flatten" filter 更多...

class	FilterListSort
	The implementation of the "listsort" filter 更多...

struct	FilterListSort::ListElem

class	FilterGroupBy
	The implementation of the "groupBy" filter 更多...

struct	FilterGroupBy::ListElem

class	FilterRelative
	The implementation of the "relative" filter 更多...

class	FilterPaginate
	The implementation of the "paginate" filter 更多...

class	FilterAlphaIndex
	The implementation of the "alphaIndex" filter 更多...

struct	FilterAlphaIndex::ListElem

class	FilterStripPath
	The implementation of the "default" filter 更多...

class	FilterNoWrap
	The implementation of the "default" filter 更多...

class	FilterDivisibleBy
	The implementation of the "divisibleby" filter 更多...

class	FilterIsRelativeURL
	The implementation of the "isRelativeURL" filter 更多...

class	FilterIsAbsoluteURL
	The implementation of the "isRelativeURL" filter 更多...

class	FilterLower
	The implementation of the "lower" filter 更多...

class	FilterUpper
	The implementation of the "upper" filter 更多...

class	FilterHex
	The implementation of the "upper" filter 更多...

class	FilterEscape
	The implementation of the "e" filter 更多...

class	FilterDecodeURL
	The implementation of the "decodeURL" filter The leading character is removed from the value in case it is a ^ or !. 更多...

class	TemplateFilterFactory
	Factory singleton for registering and creating filters 更多...

class	TemplateFilterFactory::AutoRegister< T >
	Helper class for registering a filter function 更多...

class	ExprAst
	Base class for all nodes in the abstract syntax tree of an expression. 更多...

class	ExprAstNumber
	Class representing a number in the AST 更多...

class	ExprAstVariable
	Class representing a variable in the AST 更多...

class	ExprAstFunctionVariable

class	ExprAstFilter
	Class representing a filter in the AST 更多...

class	ExprAstFilterAppl
	Class representing a filter applied to an expression in the AST 更多...

class	ExprAstLiteral
	Class representing a string literal in the AST 更多...

class	ExprAstNegate
	Class representing a negation (not) operator in the AST 更多...

class	ExprAstUnary

class	ExprAstBinary
	Class representing a binary operator in the AST 更多...

class	TemplateNode
	Base class of all nodes in a template's AST 更多...

class	TemplateToken
	Class representing a lexical token in a template 更多...

class	TemplateNodeList
	Class representing a list of AST nodes in a template 更多...

class	TemplateParser
	Parser for templates 更多...

class	ExpressionParser
	Recursive decent parser for Django style template expressions. 更多...

class	ExpressionParser::ExprToken
	Class representing a token within an expression. 更多...

class	TemplateImpl
	Internal class representing the implementation of a template 更多...

class	TemplateNodeText
	Class representing a piece of plain text in a template 更多...

class	TemplateNodeVariable
	Class representing a variable in a template 更多...

class	TemplateNodeCreator< T >
	Helper class for creating template AST tag nodes and returning the template for a given node. 更多...

class	TemplateNodeIf
	Class representing an 'if' tag in a template 更多...

struct	TemplateNodeIf::GuardedNodes

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

class	TemplateNodeRange
	Class representing a 'range' tag in a template 更多...

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

class	TemplateNodeMsg
	Class representing an 'markers' tag in a template 更多...

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

class	TemplateNodeExtend
	Class representing a 'extend' tag in a template 更多...

class	TemplateNodeInclude
	Class representing an 'include' tag in a template 更多...

class	TemplateNodeCreate
	Class representing an 'create' tag in a template 更多...

class	TemplateNodeTree
	Class representing an 'tree' tag in a template 更多...

struct	TemplateNodeTree::TreeContext

class	TemplateNodeIndexEntry
	Class representing an 'indexentry' tag in a template 更多...

struct	TemplateNodeIndexEntry::Mapping

class	TemplateNodeOpenSubIndex
	Class representing an 'opensubindex' tag in a template 更多...

class	TemplateNodeCloseSubIndex
	Class representing an 'closesubindex' tag in a template 更多...

class	TemplateNodeWith
	Class representing an 'with' tag in a template 更多...

struct	TemplateNodeWith::Mapping

class	TemplateNodeCycle
	Class representing an 'cycle' tag in a template 更多...

class	TemplateNodeSet
	Class representing an 'set' tag in a template 更多...

struct	TemplateNodeSet::Mapping

class	TemplateNodeSpaceless
	Class representing an 'spaceless' tag in a template 更多...

class	TemplateNodeMarkers
	Class representing an 'markers' tag in a template 更多...

class	TemplateNodeTabbing
	Class representing an 'tabbing' tag in a template 更多...

class	TemplateNodeResource
	Class representing an 'markers' tag in a template 更多...

class	TemplateNodeEncoding
	Class representing the 'encoding' tag in a template 更多...

class	TemplateNodeFactory
	Factory class for creating tag AST nodes found in a template 更多...

class	TemplateNodeFactory::AutoRegister< T >
	Helper class for registering a template AST node 更多...

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

class	TemplateEngine::Private
	Private data of the template engine 更多...

class	TemplateEngine::Private::IncludeEntry

宏定义
#define	ENABLE_TRACING 0

#define	TRACE(x)

类型定义
using	TemplateStructPtr = std::shared_ptr< TemplateStruct >

using	TemplateListPtr = std::shared_ptr< TemplateList >

using	ExprAstPtr = std::unique_ptr< ExprAst >

using	ExprAstList = std::vector< ExprAstPtr >

using	ExprAstFilterPtr = std::unique_ptr< ExprAstFilter >

using	TemplateNodePtr = std::unique_ptr< TemplateNode >

using	TemplateTokenPtr = std::unique_ptr< TemplateToken >

using	TemplateTokenStream = std::deque< TemplateTokenPtr >

函数
static std::vector< QCString >	split (const QCString &str, const QCString &sep, bool allowEmptyEntries=FALSE, bool cleanup=TRUE)

static void	removeSpacesAroundEquals (QCString &s)
	Strips spaces surrounding `=` from string in, so ‘foo = 10 bar=5 baz= 'hello’`will become`foo=10 bar=5 baz='hello'` 更多...

static void	getPathListFunc (const TemplateStructIntfPtr entry, TemplateListPtr list)

static TemplateVariant	getPathFunc (const TemplateStructIntfWeakPtr entryWeakRef)

static void	stripLeadingWhiteSpace (QCString &s)

变量
static TemplateFilterFactory::AutoRegister< FilterAdd >	fAdd ("add")

static TemplateFilterFactory::AutoRegister< FilterGet >	fGet ("get")

static TemplateFilterFactory::AutoRegister< FilterHex >	fHex ("hex")

static TemplateFilterFactory::AutoRegister< FilterRaw >	fRaw ("raw")

static TemplateFilterFactory::AutoRegister< FilterKeep >	fKeep ("keep")

static TemplateFilterFactory::AutoRegister< FilterList >	fList ("list")

static TemplateFilterFactory::AutoRegister< FilterLower >	fLower ("lower")

static TemplateFilterFactory::AutoRegister< FilterUpper >	fUpper ("upper")

static TemplateFilterFactory::AutoRegister< FilterAppend >	fAppend ("append")

static TemplateFilterFactory::AutoRegister< FilterEscape >	fEscape ("escape")

static TemplateFilterFactory::AutoRegister< FilterLength >	fLength ("length")

static TemplateFilterFactory::AutoRegister< FilterNoWrap >	fNoWrap ("nowrap")

static TemplateFilterFactory::AutoRegister< FilterFlatten >	fFlatten ("flatten")

static TemplateFilterFactory::AutoRegister< FilterDefault >	fDefault ("default")

static TemplateFilterFactory::AutoRegister< FilterPrepend >	fPrepend ("prepend")

static TemplateFilterFactory::AutoRegister< FilterGroupBy >	fGroupBy ("groupBy")

static TemplateFilterFactory::AutoRegister< FilterRelative >	fRelative ("relative")

static TemplateFilterFactory::AutoRegister< FilterListSort >	fListSort ("listsort")

static TemplateFilterFactory::AutoRegister< FilterTexLabel >	fTexLabel ("texLabel")

static TemplateFilterFactory::AutoRegister< FilterTexIndex >	fTexIndex ("texIndex")

static TemplateFilterFactory::AutoRegister< FilterPaginate >	fPaginate ("paginate")

static TemplateFilterFactory::AutoRegister< FilterStripPath >	fStripPath ("stripPath")

static TemplateFilterFactory::AutoRegister< FilterDecodeURL >	fDecodeURL ("decodeURL")

static TemplateFilterFactory::AutoRegister< FilterAlphaIndex >	fAlphaIndex ("alphaIndex")

static TemplateFilterFactory::AutoRegister< FilterDivisibleBy >	fDivisibleBy ("divisibleby")

static TemplateFilterFactory::AutoRegister< FilterIsRelativeURL >	fIsRelativeURL ("isRelativeURL")

static TemplateFilterFactory::AutoRegister< FilterIsAbsoluteURL >	fIsAbsoluteURL ("isAbsoluteURL")

static TemplateNodeFactory::AutoRegister< TemplateNodeIf >	autoRefIf ("if")

static TemplateNodeFactory::AutoRegister< TemplateNodeFor >	autoRefFor ("for")

static TemplateNodeFactory::AutoRegister< TemplateNodeMsg >	autoRefMsg ("msg")

static TemplateNodeFactory::AutoRegister< TemplateNodeSet >	autoRefSet ("set")

static TemplateNodeFactory::AutoRegister< TemplateNodeTree >	autoRefTree ("recursetree")

static TemplateNodeFactory::AutoRegister< TemplateNodeWith >	autoRefWith ("with")

static TemplateNodeFactory::AutoRegister< TemplateNodeBlock >	autoRefBlock ("block")

static TemplateNodeFactory::AutoRegister< TemplateNodeCycle >	autoRefCycle ("cycle")

static TemplateNodeFactory::AutoRegister< TemplateNodeRange >	autoRefRange ("range")

static TemplateNodeFactory::AutoRegister< TemplateNodeExtend >	autoRefExtend ("extend")

static TemplateNodeFactory::AutoRegister< TemplateNodeCreate >	autoRefCreate ("create")

static TemplateNodeFactory::AutoRegister< TemplateNodeRepeat >	autoRefRepeat ("repeat")

static TemplateNodeFactory::AutoRegister< TemplateNodeInclude >	autoRefInclude ("include")

static TemplateNodeFactory::AutoRegister< TemplateNodeMarkers >	autoRefMarkers ("markers")

static TemplateNodeFactory::AutoRegister< TemplateNodeTabbing >	autoRefTabbing ("tabbing")

static TemplateNodeFactory::AutoRegister< TemplateNodeResource >	autoRefResource ("resource")

static TemplateNodeFactory::AutoRegister< TemplateNodeEncoding >	autoRefEncoding ("encoding")

static TemplateNodeFactory::AutoRegister< TemplateNodeSpaceless >	autoRefSpaceless ("spaceless")

static TemplateNodeFactory::AutoRegister< TemplateNodeIndexEntry >	autoRefIndexEntry ("indexentry")

static TemplateNodeFactory::AutoRegister< TemplateNodeOpenSubIndex >	autoRefOpenSubIndex ("opensubindex")

static TemplateNodeFactory::AutoRegister< TemplateNodeCloseSubIndex >	autoRefCloseSubIndex ("closesubindex")

宏定义说明

◆ ENABLE_TRACING

#define ENABLE_TRACING 0

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

◆ TRACE

#define TRACE ( x )

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

类型定义说明

◆ ExprAstFilterPtr

using ExprAstFilterPtr = std::unique_ptr<ExprAstFilter>

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

◆ ExprAstList

using ExprAstList = std::vector< ExprAstPtr >

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

◆ ExprAstPtr

using ExprAstPtr = std::unique_ptr<ExprAst>

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

◆ TemplateListPtr

using TemplateListPtr = std::shared_ptr<TemplateList>

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

◆ TemplateNodePtr

using TemplateNodePtr = std::unique_ptr<TemplateNode>

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

◆ TemplateStructPtr

using TemplateStructPtr = std::shared_ptr<TemplateStruct>

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

◆ TemplateTokenPtr

using TemplateTokenPtr = std::unique_ptr<TemplateToken>

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

◆ TemplateTokenStream

using TemplateTokenStream = std::deque< TemplateTokenPtr >

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

函数说明

◆ getPathFunc()

static TemplateVariant getPathFunc ( const TemplateStructIntfWeakPtr entryWeakRef )

static

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

 {
   TemplateListPtr result = TemplateList::alloc();
   getPathListFunc(entryWeakRef.lock(),result);
   return std::static_pointer_cast<TemplateListIntf>(result);
 }

引用了 TemplateList::alloc() , 以及 getPathListFunc().

被这些函数引用 TemplateContextImpl::addIndexEntry().

◆ getPathListFunc()

static void getPathListFunc	(	const TemplateStructIntfPtr	entry,
		TemplateListPtr	list
	)

static

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

 {
   if (entry)
   {
     TemplateVariant parent = entry->get("parent");
     if (parent.isStruct() || parent.isWeakStruct())
     {
       getPathListFunc(parent.toStruct(),list);
     }
     list->append(entry);
   }
 }

引用了 TemplateVariant::isStruct(), TemplateVariant::isWeakStruct() , 以及 TemplateVariant::toStruct().

被这些函数引用 getPathFunc().

◆ removeSpacesAroundEquals()

static void removeSpacesAroundEquals ( QCString & s )

static

Strips spaces surrounding = from string in, so ‘foo = 10 bar=5 baz= 'hello’will becomefoo=10 bar=5 baz='hello'`

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

 {
   //printf(">removeSpacesAroundEquals(%s)\n",qPrint(s));
   uint i=0, dstIdx=0, l=s.length();
   while (i<l)
   {
     char c = s[i++];
     if (c==' ')
     {
       bool found=false;
       // look ahead for space or '='
       uint j=i;
       while (j<l && (s[j]==' '|| s[j]=='='))
       {
         if (s[j]=='=') found=true;
         j++;
       }
       if (found) // found a '=', write it without spaces
       {
         c = '=';
         i=j;
       }
     }
     s[dstIdx++]=c;
   }
   s.resize(dstIdx+1);
   //printf("<removeSpacesAroundEquals(%s)\n",qPrint(s));
 }

引用了 QCString::length() , 以及 QCString::resize().

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

◆ split()

static std::vector<QCString> split	(	const QCString &	str,
		const QCString &	sep,
		bool	allowEmptyEntries = `FALSE`,
		bool	cleanup = `TRUE`
	)

static

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

 {
   std::vector<QCString> lst;
  
   int j = 0;
   int i = str.find( sep, j );
  
   while (i!=-1)
   {
     if ( str.mid(j,i-j).length() > 0 )
     {
       if (cleanup)
       {
         lst.push_back(str.mid(j,i-j).stripWhiteSpace());
       }
       else
       {
         lst.push_back(str.mid(j,i-j));
       }
     }
     else if (allowEmptyEntries)
     {
       lst.push_back("");
     }
     j = i + sep.length();
     i = str.find(sep,j);
   }
  
   int l = str.length() - 1;
   if (str.mid(j,l-j+1).length()>0)
   {
     if (cleanup)
     {
       lst.push_back(str.mid(j,l-j+1).stripWhiteSpace());
     }
     else
     {
       lst.push_back(str.mid(j,l-j+1));
     }
   }
   else if (allowEmptyEntries)
   {
     lst.push_back("");
   }
  
   return lst;
 }

引用了 QCString::find(), QCString::length(), QCString::mid() , 以及 QCString::stripWhiteSpace().

被这些函数引用 VHDLOutlineParser::addProto(), VHDLOutlineParser::addVhdlType(), FlowChart::alignCommentNode(), VHDLOutlineParser::checkInlineCode(), VHDLOutlineParser::createFunction(), VhdlDocGen::findArchitecture(), formatBriefNote(), VhdlDocGen::getIndexWord(), DocPara::handleCommand(), DocPara::handleImage(), DocPara::handleInclude(), Qhp::initialize(), VhdlDocGen::parseForBinding(), VhdlDocGen::parseForConfig(), TemplateNodeCycle::TemplateNodeCycle(), TemplateNodeFor::TemplateNodeFor(), TemplateNodeIndexEntry::TemplateNodeIndexEntry(), TemplateNodeWith::TemplateNodeWith(), VhdlDocGen::writeInlineClassLink() , 以及 VhdlDocGen::writeRecUnitDocu().

◆ stripLeadingWhiteSpace()

static void stripLeadingWhiteSpace ( QCString & s )

static

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

 {
   bool skipSpaces=true;
   const char *src = s.data();
   char *dst = s.rawData();
   char c;
   while ((c=*src++))
   {
     if (c=='\n') { *dst++=c; skipSpaces=true; }
     else if (c==' ' && skipSpaces) {}
     else { *dst++ = c; skipSpaces=false; }
   }
   s.resize(dst-s.data()+1);
 }