docparser.h 文件参考

#include <stdio.h>
#include <vector>
#include <memory>
#include "qcstring.h"
#include "docvisitor.h"
#include "htmlattrib.h"

docparser.h 的引用(Include)关系图:

此图展示该文件直接或间接的被哪些文件引用了:

浏览源代码.

类
class	IDocParser
class	DocNode
	Abstract node interface with type information. 更多...
class	CompAccept< T >
	Default accept implementation for compound nodes in the abstract syntax tree. 更多...
class	DocWord
	Node representing a word 更多...
class	DocLinkedWord
	Node representing a word that can be linked to something 更多...
class	DocURL
	Node representing a URL (or email address) 更多...
class	DocLineBreak
	Node representing a line break 更多...
class	DocHorRuler
	Node representing a horizontal ruler 更多...
class	DocAnchor
	Node representing an anchor 更多...
class	DocCite
	Node representing a citation of some bibliographic reference 更多...
class	DocStyleChange
	Node representing a style change 更多...
class	DocSymbol
	Node representing a special symbol 更多...
struct	DocSymbol::PerlSymb
class	DocEmoji
	Node representing a n emoji 更多...
class	DocWhiteSpace
	Node representing some amount of white space 更多...
class	DocSeparator
	Node representing a separator 更多...
class	DocVerbatim
	Node representing a verbatim, unparsed text fragment 更多...
class	DocInclude
	Node representing an included text block from file 更多...
class	DocIncOperator
	Node representing a include/dontinclude operator block 更多...
class	DocFormula
	Node representing an item of a cross-referenced list 更多...
class	DocIndexEntry
	Node representing an entry in the index. 更多...
class	DocAutoList
	Node representing an auto List 更多...
class	DocAutoListItem
	Node representing an item of a auto list 更多...
class	DocTitle
	Node representing a simple section title 更多...
class	DocXRefItem
	Node representing an item of a cross-referenced list 更多...
class	DocImage
	Node representing an image 更多...
class	DocDiagramFileBase< T >
class	DocDotFile
	Node representing a dot file 更多...
class	DocMscFile
	Node representing a msc file 更多...
class	DocDiaFile
	Node representing a dia file 更多...
class	DocVhdlFlow
	Node representing a VHDL flow chart 更多...
class	DocLink
	Node representing a link to some item 更多...
class	DocRef
	Node representing a reference to some item 更多...
class	DocInternalRef
	Node representing an internal reference to some item 更多...
class	DocHRef
	Node representing a Hypertext reference 更多...
class	DocHtmlHeader
	Node Html heading 更多...
class	DocHtmlDescTitle
	Node representing a Html description item 更多...
class	DocHtmlDescList
	Node representing a Html description list 更多...
class	DocSection
	Node representing a normal section 更多...
class	DocSecRefItem
	Node representing a reference to a section 更多...
class	DocSecRefList
	Node representing a list of section references 更多...
class	DocInternal
	Node representing an internal section of documentation 更多...
class	DocParBlock
	Node representing an block of paragraphs 更多...
class	DocSimpleList
	Node representing a simple list 更多...
class	DocHtmlList
	Node representing a Html list 更多...
class	DocSimpleSect
	Node representing a simple section 更多...
class	DocSimpleSectSep
	Node representing a separator between two simple sections of the same type. 更多...
class	DocParamSect
	Node representing a parameter section 更多...
class	DocPara
	Node representing a paragraph in the documentation tree 更多...
class	DocParamList
	Node representing a parameter list. 更多...
class	DocSimpleListItem
	Node representing a simple list item 更多...
class	DocHtmlListItem
	Node representing a HTML list item 更多...
class	DocHtmlDescData
	Node representing a HTML description data 更多...
class	DocHtmlCell
	Node representing a HTML table cell 更多...
class	DocHtmlCaption
	Node representing a HTML table caption 更多...
class	DocHtmlRow
	Node representing a HTML table row 更多...
class	DocHtmlTable
	Node representing a HTML table 更多...
class	DocHtmlBlockQuote
	Node representing an HTML blockquote 更多...
class	DocText
	Root node of a text fragment 更多...
class	DocRoot
	Root node of documentation tree 更多...

类型定义
using	DocNodeList = std::vector< std::unique_ptr< DocNode > >
using	DocParaList = std::vector< std::unique_ptr< DocPara > >

函数
std::unique_ptr< IDocParser >	createDocParser ()
DocRoot *	validatingParseDoc (IDocParser &parser, const QCString &fileName, int startLine, const Definition *context, const MemberDef *md, const QCString &input, bool indexWords, bool isExample, const QCString &exampleName, bool singleLine, bool linkFromIndex, bool markdownSupport)
DocText *	validatingParseText (IDocParser &parser, const QCString &input)
void	docFindSections (const QCString &input, const Definition *d, const QCString &fileName)
DocRef *	createRef (IDocParser &parser, const QCString &target, const QCString &context)

类型定义说明

DocNodeList

using DocNodeList = std::vector< std::unique_ptr<DocNode> >

在文件 docparser.h 第 190 行定义.

DocParaList

using DocParaList = std::vector< std::unique_ptr<DocPara> >

在文件 docparser.h 第 1225 行定义.

函数说明

createDocParser()

std::unique_ptr<IDocParser> createDocParser

(

)

在文件 docparser.cpp 第 179 行定义.

{
  return std::make_unique<DocParser>();
}

被这些函数引用 addPerlModDocBlock(), convertMapFile(), RTFGenerator::endIndexSection(), generateBriefDoc(), OutputList::generateDoc(), parseCommentAsText(), parseDoc(), OutputList::parseText(), replaceRef(), ConceptDefImpl::writeBriefDescription(), DirDefImpl::writeBriefDescription(), NamespaceDefImpl::writeBriefDescription(), GroupDefImpl::writeBriefDescription(), FileDefImpl::writeBriefDescription(), MemberDefImpl::writeDeclaration(), ConceptDefImpl::writeDeclarationLink(), ClassDefImpl::writeDeclarationLink(), MemberList::writePlainDeclarations() , 以及 writeXMLDocBlock().

createRef()

DocRef* createRef	(	IDocParser &	parser,
		const QCString &	target,
		const QCString &	context
	)

在文件 docparser.cpp 第 7675 行定义.

{
  DocParser &parser = dynamic_cast<DocParser&>(parserIntf);
  return new DocRef(parser,0,target,context);
}

被这些函数引用 convertMapFile() , 以及 replaceRef().

docFindSections()

void docFindSections	(	const QCString &	input,
		const Definition *	d,
		const QCString &	fileName
	)

Searches for section and anchor commands in the input

在文件 docparser.cpp 第 7681 行定义.

{
  DocParser parser;
  parser.tokenizer.findSections(input,d,fileName);
}

引用了 DocTokenizer::findSections() , 以及 DocParser::tokenizer.

被这些函数引用 PageDefImpl::findSectionsInDocumentation(), MemberGroup::findSectionsInDocumentation(), ConceptDefImpl::findSectionsInDocumentation(), NamespaceDefImpl::findSectionsInDocumentation(), GroupDefImpl::findSectionsInDocumentation(), FileDefImpl::findSectionsInDocumentation(), ClassDefImpl::findSectionsInDocumentation() , 以及 MemberDefImpl::findSectionsInDocumentation().

validatingParseDoc()

DocRoot* validatingParseDoc	(	IDocParser &	parser,
		const QCString &	fileName,
		int	startLine,
		const Definition *	context,
		const MemberDef *	md,
		const QCString &	input,
		bool	indexWords,
		bool	isExample,
		const QCString &	exampleName,
		bool	singleLine,
		bool	linkFromIndex,
		bool	markdownSupport
	)

Main entry point for the documentation parser.

参数

parser	The parser object created via createDocParser()
fileName	File in which the documentation block is found (or the name of the example file in case isExample is TRUE).
startLine	Line at which the documentation block is found.
context	Class or namespace to which this block belongs.
md	Member definition to which the documentation belongs. Can be 0.
input	String representation of the documentation block.
indexWords	Indicates whether or not words should be put in the search index.
isExample	TRUE if the documentation belongs to an example.
exampleName	Base name of the example file (0 if isExample is FALSE).
singleLine	Output should be presented on a single line, so without starting a new paragraph at the end.
linkFromIndex	TRUE if the documentation is generated from an index page. In this case context is not used to determine the relative path when making a link.
markdownSupport	TRUE if the input needs to take markdown markup into account.

返回

Root node of the abstract syntax tree. Ownership of the pointer is handed over to the caller.

在文件 docparser.cpp 第 7495 行定义.

{
  DocParser &parser = dynamic_cast<DocParser&>(parserIntf);
  //printf("validatingParseDoc(%s,%s)=[%s]\n",ctx?qPrint(ctx->name()):"<none>",
  //                                     md?qPrint(md->name()):"<none>",
  //                                     input);
  //printf("========== validating %s at line %d\n",qPrint(fileName),startLine);
  //printf("---------------- input --------------------\n%s\n----------- end input -------------------\n",qPrint(input));
  //parser.context.token = new TokenInfo;
 
  // store parser state so we can re-enter this function if needed
  //bool fortranOpt = Config_getBool(OPTIMIZE_FOR_FORTRAN);
  parser.pushContext();
 
  if (ctx && ctx!=Doxygen::globalScope &&
      (ctx->definitionType()==Definition::TypeClass ||
       ctx->definitionType()==Definition::TypeNamespace
      )
     )
  {
    parser.context.context = ctx->name();
  }
  else if (ctx && ctx->definitionType()==Definition::TypePage)
  {
    const Definition *scope = (toPageDef(ctx))->getPageScope();
    if (scope && scope!=Doxygen::globalScope) parser.context.context = scope->name();
  }
  else if (ctx && ctx->definitionType()==Definition::TypeGroup)
  {
    const Definition *scope = (toGroupDef(ctx))->getGroupScope();
    if (scope && scope!=Doxygen::globalScope) parser.context.context = scope->name();
  }
  else
  {
    parser.context.context = "";
  }
  parser.context.scope = ctx;
 
  if (indexWords && Doxygen::searchIndex)
  {
    if (md)
    {
      parser.context.searchUrl=md->getOutputFileBase();
      Doxygen::searchIndex->setCurrentDoc(md,md->anchor(),FALSE);
    }
    else if (ctx)
    {
      parser.context.searchUrl=ctx->getOutputFileBase();
      Doxygen::searchIndex->setCurrentDoc(ctx,ctx->anchor(),FALSE);
    }
  }
  else
  {
    parser.context.searchUrl="";
  }
 
  parser.context.fileName = fileName;
  parser.context.relPath = (!linkFromIndex && ctx) ?
               QCString(relativePathToRoot(ctx->getOutputFileBase())) :
               QCString("");
  //printf("ctx->name=%s relPath=%s\n",qPrint(ctx->name()),qPrint(parser.context.relPath));
  parser.context.memberDef = md;
  while (!parser.context.nodeStack.empty()) parser.context.nodeStack.pop();
  while (!parser.context.styleStack.empty()) parser.context.styleStack.pop();
  while (!parser.context.initialStyleStack.empty()) parser.context.initialStyleStack.pop();
  parser.context.inSeeBlock = FALSE;
  parser.context.xmlComment = FALSE;
  parser.context.insideHtmlLink = FALSE;
  parser.context.includeFileText = "";
  parser.context.includeFileOffset = 0;
  parser.context.includeFileLength = 0;
  parser.context.isExample = isExample;
  parser.context.exampleName = exampleName;
  parser.context.hasParamCommand = FALSE;
  parser.context.hasReturnCommand = FALSE;
  parser.context.retvalsFound.clear();
  parser.context.paramsFound.clear();
  parser.context.markdownSupport = markdownSupport;
 
  //printf("Starting comment block at %s:%d\n",qPrint(parser.context.fileName),startLine);
  parser.tokenizer.setLineNr(startLine);
  uint ioLen = input.length();
  QCString inpStr = parser.processCopyDoc(input.data(),ioLen);
  if (inpStr.isEmpty() || inpStr.at(inpStr.length()-1)!='\n')
  {
    inpStr+='\n';
  }
  //printf("processCopyDoc(in='%s' out='%s')\n",input,qPrint(inpStr));
  parser.tokenizer.init(inpStr.data(),parser.context.fileName,markdownSupport);
 
  // build abstract syntax tree
  DocRoot *root = new DocRoot(parser,md!=0,singleLine);
  root->parse();
 
 
  if (Debug::isFlagSet(Debug::PrintTree))
  {
    // pretty print the result
    PrintDocVisitor *v = new PrintDocVisitor;
    root->accept(v);
    delete v;
  }
 
  parser.checkUnOrMultipleDocumentedParams();
  if (parser.context.memberDef) parser.context.memberDef->detectUndocumentedParams(parser.context.hasParamCommand,parser.context.hasReturnCommand);
 
  // TODO: These should be called at the end of the program.
  //parser.tokenizer.cleanup();
  //Mappers::cmdMapper->freeInstance();
  //Mappers::htmlTagMapper->freeInstance();
 
  // restore original parser state
  parser.popContext();
 
  //printf(">>>>>> end validatingParseDoc(%s,%s)\n",ctx?qPrint(ctx->name()):"<none>",
  //                                     md?qPrint(md->name()):"<none>");
 
  return root;
}

引用了 CompAccept< T >::accept(), MemberDef::anchor(), Definition::anchor(), QCString::at(), DocParser::checkUnOrMultipleDocumentedParams(), DocParserContext::context, DocParser::context, QCString::data(), Definition::definitionType(), MemberDef::detectUndocumentedParams(), DocParserContext::exampleName, FALSE, DocParserContext::fileName, MemberDef::getOutputFileBase(), Definition::getOutputFileBase(), Doxygen::globalScope, DocParserContext::hasParamCommand, DocParserContext::hasReturnCommand, DocParserContext::includeFileLength, DocParserContext::includeFileOffset, DocParserContext::includeFileText, DocTokenizer::init(), DocParserContext::initialStyleStack, DocParserContext::inSeeBlock, DocParserContext::insideHtmlLink, QCString::isEmpty(), DocParserContext::isExample, Debug::isFlagSet(), QCString::length(), DocParserContext::markdownSupport, DocParserContext::memberDef, Definition::name(), DocParserContext::nodeStack, DocParserContext::paramsFound, DocRoot::parse(), DocParser::popContext(), Debug::PrintTree, DocParser::processCopyDoc(), DocParser::pushContext(), relativePathToRoot(), DocParserContext::relPath, DocParserContext::retvalsFound, DocParserContext::scope, Doxygen::searchIndex, DocParserContext::searchUrl, SearchIndexIntf::setCurrentDoc(), DocTokenizer::setLineNr(), DocParserContext::styleStack, toGroupDef(), DocParser::tokenizer, toPageDef(), Definition::TypeClass, Definition::TypeGroup, Definition::TypeNamespace, Definition::TypePage , 以及 DocParserContext::xmlComment.

被这些函数引用 addPerlModDocBlock(), generateBriefDoc(), OutputList::generateDoc(), parseCommentAsText(), parseDoc(), ConceptDefImpl::writeBriefDescription(), DirDefImpl::writeBriefDescription(), NamespaceDefImpl::writeBriefDescription(), GroupDefImpl::writeBriefDescription(), FileDefImpl::writeBriefDescription(), MemberDefImpl::writeDeclaration(), ConceptDefImpl::writeDeclarationLink(), ClassDefImpl::writeDeclarationLink(), MemberList::writePlainDeclarations() , 以及 writeXMLDocBlock().

validatingParseText()

DocText* validatingParseText	(	IDocParser &	parser,
		const QCString &	input
	)

Main entry point for parsing simple text fragments. These fragments are limited to words, whitespace and symbols.

在文件 docparser.cpp 第 7621 行定义.

{
  DocParser &parser = dynamic_cast<DocParser&>(parserIntf);
  // store parser state so we can re-enter this function if needed
  parser.pushContext();
 
  //printf("------------ input ---------\n%s\n"
  //       "------------ end input -----\n",input);
  //parser.context.token = new TokenInfo;
  parser.context.context = "";
  parser.context.fileName = "<parseText>";
  parser.context.relPath = "";
  parser.context.memberDef = 0;
  while (!parser.context.nodeStack.empty()) parser.context.nodeStack.pop();
  while (!parser.context.styleStack.empty()) parser.context.styleStack.pop();
  while (!parser.context.initialStyleStack.empty()) parser.context.initialStyleStack.pop();
  parser.context.inSeeBlock = FALSE;
  parser.context.xmlComment = FALSE;
  parser.context.insideHtmlLink = FALSE;
  parser.context.includeFileText = "";
  parser.context.includeFileOffset = 0;
  parser.context.includeFileLength = 0;
  parser.context.isExample = FALSE;
  parser.context.exampleName = "";
  parser.context.hasParamCommand = FALSE;
  parser.context.hasReturnCommand = FALSE;
  parser.context.retvalsFound.clear();
  parser.context.paramsFound.clear();
  parser.context.searchUrl="";
 
  DocText *txt = new DocText(parser);
 
  if (!input.isEmpty())
  {
    parser.tokenizer.setLineNr(1);
    parser.tokenizer.init(input.data(),parser.context.fileName,Config_getBool(MARKDOWN_SUPPORT));
 
    // build abstract syntax tree
    txt->parse();
 
    if (Debug::isFlagSet(Debug::PrintTree))
    {
      // pretty print the result
      PrintDocVisitor *v = new PrintDocVisitor;
      txt->accept(v);
      delete v;
    }
  }
 
  // restore original parser state
  parser.popContext();
  return txt;
}

引用了 CompAccept< T >::accept(), Config_getBool, DocParserContext::context, DocParser::context, QCString::data(), DocParserContext::exampleName, FALSE, DocParserContext::fileName, DocParserContext::hasParamCommand, DocParserContext::hasReturnCommand, DocParserContext::includeFileLength, DocParserContext::includeFileOffset, DocParserContext::includeFileText, DocTokenizer::init(), DocParserContext::initialStyleStack, DocParserContext::inSeeBlock, DocParserContext::insideHtmlLink, QCString::isEmpty(), DocParserContext::isExample, Debug::isFlagSet(), DocParserContext::memberDef, DocParserContext::nodeStack, DocParserContext::paramsFound, DocText::parse(), DocParser::popContext(), Debug::PrintTree, DocParser::pushContext(), DocParserContext::relPath, DocParserContext::retvalsFound, DocParserContext::searchUrl, DocTokenizer::setLineNr(), DocParserContext::styleStack, DocParser::tokenizer , 以及 DocParserContext::xmlComment.

被这些函数引用 RTFGenerator::endIndexSection() , 以及 OutputList::parseText().