#include "docnode.h"
#include "docparser_p.h"
#include "htmlentity.h"
#include "configimpl.h"
#include "configoptions.h"
#include "emoji.h"
#include "message.h"
#include "doxygen.h"
#include "cite.h"
#include "util.h"
#include "formula.h"
#include "markdown.h"
#include "pagedef.h"
#include "namespacedef.h"
#include "groupdef.h"
#include "cmdmapper.h"
#include "config.h"
#include "vhdldocgen.h"
#include "doctokenizer.h"
#include "plantuml.h"
#include "mermaid.h"
#include "language.h"
#include "datetime.h"
#include "trace.h"
#include "anchor.h"
#include "aliases.h"
#include "requirement.h"

Include dependency graph for docnode.cpp:

Classes
struct	ActiveRowSpan
	Helper class to compute the grid for an HTML style table. More...

Macros
#define	AUTO_TRACE(...)
#define	AUTO_TRACE_ADD(...)
#define	AUTO_TRACE_EXIT(...)
#define	INTERNAL_ASSERT(x)

Typedefs
typedef std::vector< ActiveRowSpan >	RowSpanList
	List of ActiveRowSpan classes.

Functions
static void	unescapeCRef (QCString &s)
static QCString	stripKnownExtensions (const QCString &text)
static void	setParent (DocNodeVariant n, DocNodeVariant newParent)
static void	flattenParagraphs (DocNodeVariant *root, DocNodeList &children)
static Token	skipSpacesForTable (DocParser *parser)
static bool	findAttribute (const HtmlAttribList &tagHtmlAttribs, const char attrName, QCString result)
static bool	checkIfHtmlEndTagEndsAutoList (DocParser parser, const DocNodeVariant n)

Variables
static const char *	g_sectionLevelToName []
static const StringUnorderedSet	g_plantumlEngine

Macro Definition Documentation

◆ AUTO_TRACE

#define AUTO_TRACE ( ... )

Value:

(void)0

Definition at line 48 of file docnode.cpp.

◆ AUTO_TRACE_ADD

#define AUTO_TRACE_ADD ( ... )

Value:

(void)0

Definition at line 49 of file docnode.cpp.

◆ AUTO_TRACE_EXIT

#define AUTO_TRACE_EXIT ( ... )

Value:

(void)0

Definition at line 50 of file docnode.cpp.

◆ INTERNAL_ASSERT

#define INTERNAL_ASSERT ( x )

Value:

do {} while(0)

Definition at line 53 of file docnode.cpp.

Referenced by DocPara::handleCommand(), DocPara::parse(), and DocSection::parse().

Typedef Documentation

◆ RowSpanList

typedef std::vector<ActiveRowSpan> RowSpanList

List of ActiveRowSpan classes.

Definition at line 2414 of file docnode.cpp.

Function Documentation

◆ checkIfHtmlEndTagEndsAutoList()

bool checkIfHtmlEndTagEndsAutoList	(	DocParser *	parser,
		const DocNodeVariant *	n )

static

Definition at line 5732 of file docnode.cpp.

{
  // expected hierarchy:
  // 1.    DocAutoListItem <- n
  // 2.  DocAutoList       <- parent(n)
  // 3. DocPara            <- parent(parent(n))
 
  // step 1
  if (!std::get_if<DocAutoListItem>(n)) // not inside a auto list item
  {
    return false;
  }
 
  // step 2
  n = parent(n);
  int indent = 0;
  const auto docAutoList = std::get_if<DocAutoList>(n);
  if (docAutoList) // capture indent
  {
    indent = docAutoList->indent();
  }
  else
  {
    return false;
  }
 
  // step 3
  n = parent(n);
  const auto docPara = std::get_if<DocPara>(n);
  if (docPara)
  {
    QCString tagNameLower = QCString(parser->context.token->name).lower();
    auto topStyleChange = [](const DocStyleChangeStack &stack) -> const DocStyleChange &
    {
      return std::get<DocStyleChange>(*stack.top());
    };
 
    if (parser->context.styleStack.empty() ||                                                     // no style change
        (topStyleChange(parser->context.styleStack).tagName()==tagNameLower &&                    // correct style change
         topStyleChange(parser->context.styleStack).position()!=parser->context.nodeStack.size()) // wrong position, so normal close
       )
    {
      // insert an artificial 'end of autolist' marker and parse again
      QCString indentStr;
      indentStr.fill(' ',indent);
      parser->tokenizer.unputString("\\ilinebr "+indentStr+".\\ilinebr"+indentStr+"</"+parser->context.token->name+">");
      return true;
    }
  }
  return false;
}

References DocParser::context, QCString::fill(), QCString::lower(), TokenInfo::name, DocParserContext::nodeStack, parent(), DocParserContext::styleStack, DocParserContext::token, DocParser::tokenizer, and DocTokenizer::unputString().

Referenced by DocPara::parse().

◆ findAttribute()

bool findAttribute	(	const HtmlAttribList &	tagHtmlAttribs,
		const char *	attrName,
		QCString *	result )

static

Definition at line 5025 of file docnode.cpp.

{
 
  for (const auto &opt : tagHtmlAttribs)
  {
    if (opt.name==attrName)
    {
      *result = opt.value;
      return TRUE;
    }
  }
  return FALSE;
}

References FALSE, and TRUE.

Referenced by DocPara::handleHtmlStartTag().

◆ flattenParagraphs()

void flattenParagraphs	(	DocNodeVariant *	root,
		DocNodeList &	children )

static

Definition at line 859 of file docnode.cpp.

{
  DocNodeList newChildren;
  for (auto &dn : children)
  {
    DocPara *para = std::get_if<DocPara>(&dn);
    if (para)
    {
      //// move the children of the paragraph to the end of the newChildren list
      newChildren.move_append(para->children());
    }
  }
 
  // replace the children list by the newChildren list
  children.clear();
  children.move_append(newChildren);
  // reparent the children
  for (auto &cn : children)
  {
    setParent(&cn,root);
    // we also need to set the parent for each child of cn, as cn's address may have changed.
    auto opt_children = call_method_children(&cn);
    if (opt_children)
    {
      for (auto &ccn : *opt_children)
      {
        setParent(&ccn,&cn);
      }
    }
  }
}

References call_method_children(), DocCompoundNode::children(), GrowVector< T >::clear(), DocNodeList::move_append(), and setParent().

Referenced by DocRef::parse(), and DocTitle::parseFromString().

◆ setParent()

void setParent	(	DocNodeVariant *	n,
		DocNodeVariant *	newParent )

static

Definition at line 120 of file docnode.cpp.

{
  std::visit([&](auto &&x)->decltype(auto) { return x.setParent(newParent); }, *n);
}

Referenced by flattenParagraphs().

◆ skipSpacesForTable()

Token skipSpacesForTable ( DocParser * parser )

static

Definition at line 2017 of file docnode.cpp.

{
  AUTO_TRACE();
  // get next token
  Token tok=parser->tokenizer.lex();
  // skip whitespace and tbody, thead and tfoot tags
  while (tok.is_any_of(TokenRetval::TK_WHITESPACE,TokenRetval::TK_NEWPARA,TokenRetval::TK_HTMLTAG,
                       TokenRetval::TK_COMMAND_AT,TokenRetval::TK_COMMAND_BS))
  {
    if (tok.is(TokenRetval::TK_HTMLTAG))
    {
      AUTO_TRACE_ADD("html_tag={}",parser->context.token->name);
      HtmlTagType tagId=Mappers::htmlTagMapper->map(parser->context.token->name);
      // skip over tbody, thead, tfoot tags
      if (tagId==HtmlTagType::HTML_TBODY ||
          tagId==HtmlTagType::HTML_THEAD ||
          tagId==HtmlTagType::HTML_TFOOT)
      {
        tok=parser->tokenizer.lex();
      }
      else
      {
        break;
      }
    }
    else if (tok.is_any_of(TokenRetval::TK_COMMAND_AT, TokenRetval::TK_COMMAND_BS))
    {
      QCString cmdName=parser->context.token->name;
      AUTO_TRACE_ADD("command={}",cmdName);
      auto cmdType = Mappers::cmdMapper->map(cmdName);
      if (cmdType==CommandType::CMD_ILINE)
      {
        parser->tokenizer.pushState();
        parser->tokenizer.setStateILine();
        tok = parser->tokenizer.lex();
        if (!tok.is(TokenRetval::TK_WORD))
        {
          warn_doc_error(parser->context.fileName,parser->tokenizer.getLineNr(),"invalid argument for command '{:c}{}'",
              tok.command_to_char(),cmdName);
        }
        parser->tokenizer.popState();
        tok = parser->tokenizer.lex();
      }
      else
      {
        break;
      }
    }
    else
    {
      AUTO_TRACE_ADD("skip whitespace");
      tok=parser->tokenizer.lex();
    }
  }
  return tok;
}

References AUTO_TRACE, AUTO_TRACE_ADD, CMD_ILINE, Mappers::cmdMapper, Token::command_to_char(), DocParser::context, DocParserContext::fileName, DocTokenizer::getLineNr(), HTML_TBODY, HTML_TFOOT, HTML_THEAD, Mappers::htmlTagMapper, Token::is(), Token::is_any_of(), DocTokenizer::lex(), TokenInfo::name, DocTokenizer::popState(), DocTokenizer::pushState(), DocTokenizer::setStateILine(), DocParserContext::token, DocParser::tokenizer, and warn_doc_error.

Referenced by DocHtmlRow::parse(), and DocHtmlTable::parse().

◆ stripKnownExtensions()

QCString stripKnownExtensions ( const QCString & text )

static

Strips known html and tex extensions from text.

Definition at line 106 of file docnode.cpp.

{
  QCString result=text;
  if (result.endsWith(".tex"))
  {
    result=result.left(result.length()-4);
  }
  else if (result.right(Doxygen::htmlFileExtension.length())==Doxygen::htmlFileExtension)
  {
    result=result.left(result.length()-Doxygen::htmlFileExtension.length());
  }
  return result;
}

References QCString::endsWith(), Doxygen::htmlFileExtension, QCString::left(), QCString::length(), and QCString::right().

Referenced by DocLink::DocLink(), DocRef::DocRef(), and DocSecRefItem::parse().

◆ unescapeCRef()

void unescapeCRef ( QCString & s )

static

Definition at line 84 of file docnode.cpp.

{
  QCString result;
  const char *p = s.data();
  if (p)
  {
    char c = 0;
    while ((c=*p++))
    {
      if (c=='{') c='<'; else if (c=='}') c='>';
      result+=c;
    }
  }
 
  result=substitute(result,"&lt;","<");
  result=substitute(result,"&gt;",">");
  s = result;
}

References QCString::data(), and substitute().

Referenced by DocPara::handleHtmlStartTag().

Variable Documentation

◆ g_plantumlEngine

const StringUnorderedSet g_plantumlEngine

static

Initial value:

{
  "uml", "bpm", "wire", "dot", "ditaa",
  "salt", "math", "latex", "gantt", "mindmap",
  "wbs", "yaml", "creole", "json", "flow",
  "board", "git", "hcl", "regex", "ebnf",
  "files", "chen", "chronology", "chart", "nwdiag",
  "packetdiag", "project", "sprites"
}

Definition at line 71 of file docnode.cpp.

                                                 {
  "uml", "bpm", "wire", "dot", "ditaa",
  "salt", "math", "latex", "gantt", "mindmap",
  "wbs", "yaml", "creole", "json", "flow",
  "board", "git", "hcl", "regex", "ebnf",
  "files", "chen", "chronology", "chart", "nwdiag",
  "packetdiag", "project", "sprites"
};

Referenced by DocPara::handleCommand().

◆ g_sectionLevelToName

const char* g_sectionLevelToName[]

static

Initial value:

                                       =
{
  "page",
  "section",
  "subsection",
  "subsubsection",
  "paragraph",
  "subparagraph"
}

Definition at line 58 of file docnode.cpp.

                                          {
  "page",
  "section",
  "subsection",
  "subsubsection",
  "paragraph",
  "subparagraph"
};

Referenced by DocSection::parse().

Classes

Macros

Typedefs

Functions

Variables

Macro Definition Documentation

◆ AUTO_TRACE

◆ AUTO_TRACE_ADD

◆ AUTO_TRACE_EXIT

◆ INTERNAL_ASSERT

Typedef Documentation

◆ RowSpanList

Function Documentation

◆ checkIfHtmlEndTagEndsAutoList()

◆ findAttribute()

◆ flattenParagraphs()

◆ setParent()

◆ skipSpacesForTable()

◆ stripKnownExtensions()

◆ unescapeCRef()

Variable Documentation

◆ g_plantumlEngine

◆ g_sectionLevelToName