Token Class Referenceabstract

#include <ArmarXGui/libraries/ArmarXGuiBase/widgets/cpp-markdown/markdown-tokens.h>

+ Inheritance diagram for Token:

Public Member Functions

virtual bool canContainMarkup () const
 
virtual bool inhibitParagraphs () const
 
virtual bool isBlankLine () const
 
virtual bool isContainer () const
 
virtual bool isMatchedCloseMarker () const
 
virtual bool isMatchedOpenMarker () const
 
virtual bool isUnmatchedCloseMarker () const
 
virtual bool isUnmatchedOpenMarker () const
 
virtual std::optional< TokenGroupprocessSpanElements (const LinkIds &idTable)
 
virtual std::optional< std::string > text () const
 
 Token ()
 
virtual void writeAsHtml (std::ostream &) const =0
 
virtual void writeAsOriginal (std::ostream &out) const
 
virtual void writeToken (size_t indent, std::ostream &out) const
 
virtual void writeToken (std::ostream &out) const =0
 

Protected Member Functions

virtual void postWrite (std::ostream &out) const
 
virtual void preWrite (std::ostream &out) const
 

Detailed Description

Definition at line 45 of file markdown-tokens.h.

Constructor & Destructor Documentation

◆ Token()

Token ( )
inline

Definition at line 48 of file markdown-tokens.h.

Member Function Documentation

◆ canContainMarkup()

virtual bool canContainMarkup ( ) const
inlinevirtual

Reimplemented in TextHolder.

Definition at line 72 of file markdown-tokens.h.

◆ inhibitParagraphs()

virtual bool inhibitParagraphs ( ) const
inlinevirtual

Reimplemented in ListItem, InlineHtmlBlock, and Header.

Definition at line 100 of file markdown-tokens.h.

◆ isBlankLine()

virtual bool isBlankLine ( ) const
inlinevirtual

Reimplemented in InlineHtmlBlock, and BlankLine.

Definition at line 76 of file markdown-tokens.h.

◆ isContainer()

virtual bool isContainer ( ) const
inlinevirtual

Reimplemented in Container.

Definition at line 80 of file markdown-tokens.h.

◆ isMatchedCloseMarker()

virtual bool isMatchedCloseMarker ( ) const
inlinevirtual

Reimplemented in BoldOrItalicMarker.

Definition at line 96 of file markdown-tokens.h.

◆ isMatchedOpenMarker()

virtual bool isMatchedOpenMarker ( ) const
inlinevirtual

Reimplemented in BoldOrItalicMarker.

Definition at line 92 of file markdown-tokens.h.

◆ isUnmatchedCloseMarker()

virtual bool isUnmatchedCloseMarker ( ) const
inlinevirtual

Reimplemented in BoldOrItalicMarker.

Definition at line 88 of file markdown-tokens.h.

◆ isUnmatchedOpenMarker()

virtual bool isUnmatchedOpenMarker ( ) const
inlinevirtual

Reimplemented in BoldOrItalicMarker.

Definition at line 84 of file markdown-tokens.h.

◆ postWrite()

virtual void postWrite ( std::ostream &  out) const
inlineprotectedvirtual

Reimplemented in Paragraph, BlockQuote, OrderedList, UnorderedList, ListItem, Header, and HtmlTag.

Definition at line 107 of file markdown-tokens.h.

+ Here is the caller graph for this function:

◆ preWrite()

virtual void preWrite ( std::ostream &  out) const
inlineprotectedvirtual

Reimplemented in Paragraph, BlockQuote, OrderedList, UnorderedList, ListItem, Header, and HtmlTag.

Definition at line 106 of file markdown-tokens.h.

+ Here is the caller graph for this function:

◆ processSpanElements()

virtual std::optional<TokenGroup> processSpanElements ( const LinkIds idTable)
inlinevirtual

Reimplemented in Container, and RawText.

Definition at line 62 of file markdown-tokens.h.

◆ text()

virtual std::optional<std::string> text ( ) const
inlinevirtual

Reimplemented in TextHolder.

Definition at line 67 of file markdown-tokens.h.

◆ writeAsHtml()

virtual void writeAsHtml ( std::ostream &  ) const
pure virtual

Implemented in Image, BoldOrItalicMarker, Container, EscapedCharacter, CodeSpan, CodeBlock, and TextHolder.

+ Here is the caller graph for this function:

◆ writeAsOriginal()

virtual void writeAsOriginal ( std::ostream &  out) const
inlinevirtual

Reimplemented in EscapedCharacter, and CodeSpan.

Definition at line 51 of file markdown-tokens.h.

+ Here is the call graph for this function:

◆ writeToken() [1/2]

virtual void writeToken ( size_t  indent,
std::ostream &  out 
) const
inlinevirtual

Reimplemented in Container.

Definition at line 56 of file markdown-tokens.h.

+ Here is the call graph for this function:

◆ writeToken() [2/2]

virtual void writeToken ( std::ostream &  out) const
pure virtual

Implemented in Image, BoldOrItalicMarker, Container, EscapedCharacter, BlankLine, Header, CodeSpan, CodeBlock, InlineHtmlComment, InlineHtmlContents, HtmlAnchorTag, HtmlTag, RawText, and TextHolder.

+ Here is the caller graph for this function:

The documentation for this class was generated from the following file: