File XMLparserClass Documentation

Automatically generated with Code Structure Viewer (CS), Project Version: 3o4d 17-November-2020

Copyright © 2020, BAI Research. All Rights Reserved.

File Name: XMLparserClass.cpp/.hpp

File Description: XML parser class

File Function List


File Diagram (functions hierarchy)


Class XMLparserAttribute

Class Data
nametypedescription
namestringname
valuestringvalue
charCountintchar count
lineCountintline count
nextAttributeXMLparserAttribute*next attribute

Class XMLparserTag

Class Data
nametypedescription
namestringname
valuestringvalue
nextTagXMLparserTag*next tag
firstLowerLevelTagXMLparserTag*first lower level tag
charCountintchar count
lineCountintline count
firstAttributeXMLparserAttribute*first attribute
currentAttributeXMLparserAttribute*current attribute

Function XMLparserClassClass::parseTagDownALevel()

Function Summary
namereturn typedescription
parseTagDownALevelXMLparserTag*parse tag down AL evel

Function Arguments
nametypedescription
currentTagXMLparserTag* current tag
sectionTagName const string section tag name
result bool* result

Function Reference List
N/A


Function Trace
locationcurrent function being traced
CSexecflow.hppparseTagDownALevel
CSexecflow.hppinitialiseGrid
CSmain.hppgenerateCodeStructure
XMLrulesClass.hppparseTagDownALevel
XMLrulesClass.hppparseCSRulesTag

Trace Diagram (magenta)


Function XMLparserClassClass::readXMLfile()

Function Summary
namereturn typedescription
readXMLfileboolread XML file

Function Arguments
nametypedescription
xmlFileNameconst string xml file name
firstTagInXMLfile XMLparserTag* first tag in XML file

Function Reference List


Function Trace
locationcurrent function being traced
XMLrulesClass.hppreadXMLfile
CSmain.hppparseCSrulesXMLfile

Trace Diagram (magenta)


Function XMLparserClassClass::parseTagOpen()

Function Summary
namereturn typedescription
parseTagOpenboolparse tag open

Function Arguments
nametypedescription
parseFileObjectifstream* parse file object
currentTag XMLparserTag* current tag
parentTagName const string parent tag name
isSubTag const bool is sub tag
treeLayer int tree layer

Function Reference List


Function Trace
locationcurrent function being traced
XMLparserClass.hppparseTagOpen
XMLrulesClass.hppreadXMLfile
CSmain.hppparseCSrulesXMLfile
XMLparserClass.hppparseTagOpen
XMLparserClass.hppparseTagName
XMLparserClass.hppparseTagValueAssumingExistenceOfSubtagsAndClose
XMLparserClass.hppprocessTagClose
XMLparserClass.hppparseTagAttributeName

Trace Diagram (magenta)


Function XMLparserClassClass::parseTagName()

Function Summary
namereturn typedescription
parseTagNameboolparse tag name

Function Arguments
nametypedescription
parseFileObjectifstream* parse file object
currentTag XMLparserTag* current tag
parentTagName const string parent tag name
isSubTag const bool is sub tag
treeLayer int tree layer

Function Reference List


Function Trace
locationcurrent function being traced
XMLparserClass.hppparseTagName
XMLparserClass.hppparseTagOpen
XMLrulesClass.hppreadXMLfile
CSmain.hppparseCSrulesXMLfile
XMLparserClass.hppparseTagOpen
XMLparserClass.hppprocessTagClose
XMLparserClass.hppparseTagAttributeName
XMLparserClass.hppparseTagName

Trace Diagram (magenta)


Function XMLparserClassClass::parseTagAttributeName()

Function Summary
namereturn typedescription
parseTagAttributeNameboolparse tag attribute name

Function Arguments
nametypedescription
parseFileObjectifstream* parse file object
currentTag XMLparserTag* current tag
parentTagName const string parent tag name
isSubTag const bool is sub tag
treeLayer int tree layer

Function Reference List


Function Trace
locationcurrent function being traced
XMLparserClass.hppparseTagAttributeName
XMLparserClass.hppparseTagName
XMLparserClass.hppparseTagOpen
XMLrulesClass.hppreadXMLfile
CSmain.hppparseCSrulesXMLfile
XMLparserClass.hppparseTagOpen
XMLparserClass.hppparseTagName
XMLparserClass.hppparseTagAttributeName

Trace Diagram (magenta)


Function XMLparserClassClass::parseTagAttributeValue()

Function Summary
namereturn typedescription
parseTagAttributeValueboolparse tag attribute value

Function Arguments
nametypedescription
parseFileObjectifstream* parse file object
currentTag XMLparserTag* current tag
parentTagName const string parent tag name
isSubTag const bool is sub tag
treeLayer const int tree layer

Function Reference List


Function Trace
locationcurrent function being traced
XMLparserClass.hppparseTagAttributeValue
XMLparserClass.hppparseTagAttributeName
XMLparserClass.hppparseTagName
XMLparserClass.hppparseTagOpen
XMLrulesClass.hppreadXMLfile
CSmain.hppparseCSrulesXMLfile
XMLparserClass.hppparseTagOpen
XMLparserClass.hppparseTagName

Trace Diagram (magenta)


Function XMLparserClassClass::parseTagValueAssumingExistenceOfSubtagsAndClose()

Function Summary
namereturn typedescription
parseTagValueAssumingExistenceOfSubtagsAndCloseboolparse tag value assuming existence of subtags and close

Function Arguments
nametypedescription
parseFileObjectifstream* parse file object
currentTag XMLparserTag* current tag
treeLayer int tree layer

Function Reference List


Function Trace
locationcurrent function being traced
XMLparserClass.hppparseTagValueAssumingExistenceOfSubtagsAndClose
XMLparserClass.hppprocessTagClose
XMLparserClass.hppparseTagAttributeName
XMLparserClass.hppparseTagName
XMLparserClass.hppparseTagOpen
XMLrulesClass.hppreadXMLfile
CSmain.hppparseCSrulesXMLfile
XMLparserClass.hppparseTagAttributeName

Trace Diagram (magenta)


Function XMLparserClassClass::parseTagComment()

Function Summary
namereturn typedescription
parseTagCommentboolparse tag comment

Function Arguments
nametypedescription
parseFileObjectifstream* parse file object
type const char type

Function Reference List


Function Trace
locationcurrent function being traced
XMLparserClass.hppparseTagComment
XMLparserClass.hppparseTagName
XMLparserClass.hppparseTagOpen
XMLrulesClass.hppreadXMLfile
CSmain.hppparseCSrulesXMLfile
XMLparserClass.hppparseTagOpen
XMLparserClass.hppprocessTagClose
XMLparserClass.hppparseTagAttributeName
XMLparserClass.hppparseTagName

Trace Diagram (magenta)


Function XMLparserClassClass::processTagClose()

Function Summary
namereturn typedescription
processTagCloseboolprocess tag close

Function Arguments
nametypedescription
parseFileObjectifstream* parse file object
currentTag XMLparserTag** current tag
parentTagName const string parent tag name
isSubTag const bool is sub tag
treeLayer int tree layer
endTagFound const bool end tag found
parsingAttributeName const bool parsing attribute name
tagName const string tag name

Function Reference List


Function Trace
locationcurrent function being traced
XMLparserClass.hppprocessTagClose
XMLparserClass.hppparseTagAttributeName
XMLparserClass.hppparseTagName
XMLparserClass.hppparseTagOpen
XMLrulesClass.hppreadXMLfile
CSmain.hppparseCSrulesXMLfile
XMLparserClass.hppparseTagName
XMLparserClass.hppparseTagAttributeName

Trace Diagram (magenta)


Function XMLparserClassClass::createNewTag()

Function Summary
namereturn typedescription
createNewTagXMLparserTag*create new tag

Function Arguments
nametypedescription
currentTagXMLparserTag* current tag

Function Reference List
N/A


Function Trace
locationcurrent function being traced
XMLparserClass.hppcreateNewTag
XMLparserClass.hppprocessTagClose
XMLparserClass.hppparseTagAttributeName
XMLparserClass.hppparseTagName
XMLparserClass.hppparseTagOpen
XMLrulesClass.hppreadXMLfile
CSmain.hppparseCSrulesXMLfile
XMLparserClass.hppparseTagName
XMLparserClass.hppparseTagAttributeName

Trace Diagram (magenta)


Function XMLparserClassClass::isBlankChar()

Function Summary
namereturn typedescription
isBlankCharboolis blank char

Function Arguments
nametypedescription
parseFileObjectconst ifstream* parse file object
c const char c

Function Reference List
N/A


Function Trace
locationcurrent function being traced
XMLparserClass.hppisBlankChar
XMLparserClass.hppparseTagAttributeValue
XMLparserClass.hppparseTagAttributeName
XMLparserClass.hppparseTagName
XMLparserClass.hppparseTagOpen
XMLrulesClass.hppreadXMLfile
CSmain.hppparseCSrulesXMLfile
XMLparserClass.hppparseTagOpen
XMLparserClass.hppparseTagName

Trace Diagram (magenta)


Function XMLparserClassClass::isBlankCharTabOrNewLine()

Function Summary
namereturn typedescription
isBlankCharTabOrNewLineboolis blank char tab or new line

Function Arguments
nametypedescription
parseFileObjectconst ifstream* parse file object
c const char c

Function Reference List
N/A


Function Trace
locationcurrent function being traced
XMLparserClass.hppisBlankCharTabOrNewLine
XMLparserClass.hppparseTagValueAssumingExistenceOfSubtagsAndClose
XMLparserClass.hppprocessTagClose
XMLparserClass.hppparseTagAttributeName
XMLparserClass.hppparseTagName
XMLparserClass.hppparseTagOpen
XMLrulesClass.hppreadXMLfile
CSmain.hppparseCSrulesXMLfile
XMLparserClass.hppparseTagAttributeName

Trace Diagram (magenta)


Function XMLparserClassClass::throwGenericXMLParseError()

Function Summary
namereturn typedescription
throwGenericXMLParseErrorvoidthrow generic XMLP arse error

Function Reference List
N/A


Function Trace
locationcurrent function being traced
XMLparserClass.hppthrowGenericXMLParseError
XMLparserClass.hppparseTagAttributeValue
XMLparserClass.hppparseTagAttributeName
XMLparserClass.hppparseTagName
XMLparserClass.hppparseTagOpen
XMLrulesClass.hppreadXMLfile
CSmain.hppparseCSrulesXMLfile
XMLparserClass.hppparseTagOpen
XMLparserClass.hppparseTagName
XMLparserClass.hppthrowGenericXMLParseError

Trace Diagram (magenta)


Function XMLparserClassClass::addTagLayerToFileObject()

Function Summary
namereturn typedescription
addTagLayerToFileObjectbooladd tag layer to file object

Function Arguments
nametypedescription
firstTagInCurrentLayerconst XMLparserTag* first tag in current layer
writeFileString string* write file string
treeLayer const int tree layer

Function Reference List


Function Trace
locationcurrent function being traced
LDsvg.hppaddTagLayerToFileObject
CSexecflow.hppwriteSVGfile
CSmain.hppgenerateCodeStructure
CSgenerateHTMLdocumentation.hppwriteSVGfile
CSgenerateHTMLdocumentation.hppgenerateFileDiagramFunctionsHeirachy
CSgenerateHTMLdocumentation.hppgenerateHTMLdocumentationForAllFunctions

Trace Diagram (magenta)


Function XMLparserClassClass::incrementLineAndAddTabsToFileObject()

Function Summary
namereturn typedescription
incrementLineAndAddTabsToFileObjectvoidincrement line and add tabs to file object

Function Arguments
nametypedescription
writeFileStringstring* write file string
treeLayer const int tree layer

Function Reference List
N/A


Function Trace
locationcurrent function being traced
XMLparserClass.hppincrementLineAndAddTabsToFileObject
LDsvg.hppaddTagLayerToFileObject
CSexecflow.hppwriteSVGfile
CSmain.hppgenerateCodeStructure
CSgenerateHTMLdocumentation.hppwriteSVGfile
CSgenerateHTMLdocumentation.hppgenerateFileDiagramFunctionsHeirachy
CSgenerateHTMLdocumentation.hppgenerateHTMLdocumentationForAllFunctions

Trace Diagram (magenta)


Function XMLparserClassClass::addTabsToFileObject()

Function Summary
namereturn typedescription
addTabsToFileObjectvoidadd tabs to file object

Function Arguments
nametypedescription
writeFileStringstring* write file string
treeLayer const int tree layer

Function Reference List
N/A


Function Trace
locationcurrent function being traced
XMLparserClass.hppaddTabsToFileObject
LDsvg.hppaddTagLayerToFileObject
CSexecflow.hppwriteSVGfile
CSmain.hppgenerateCodeStructure
CSgenerateHTMLdocumentation.hppwriteSVGfile
CSgenerateHTMLdocumentation.hppgenerateFileDiagramFunctionsHeirachy
CSgenerateHTMLdocumentation.hppgenerateHTMLdocumentationForAllFunctions

Trace Diagram (magenta)