Contents

MD::ATXHeadingParser Class

class MD::ATXHeadingParser

ATX heading parser. More...

Header: #include <md4qt/atx_heading_parser.h>
CMake: find_package(md4qt REQUIRED COMPONENTS md4qt)
target_link_libraries(mytarget PRIVATE md4qt::md4qt)
Inherits: MD::BlockParser

Reimplemented Public Functions

virtual MD::BlockState check(MD::Line &currentLine, MD::TextStream &stream, QSharedPointer<MD::Document> doc, MD::Context &ctx, const QString &path, const QString &fileName, bool checkWithoutProcessing = false) override
virtual MD::BlockState continueCheck(MD::Line &currentLine, MD::TextStream &stream, QSharedPointer<MD::Document> doc, MD::Context &ctx, const QString &path, const QString &fileName) override
virtual bool mayBreakParagraph(MD::Line &line, MD::TextStream &stream, QSharedPointer<MD::Document> doc, MD::Context &ctx) const override
virtual MD::BlockState process(MD::Line &currentLine, MD::TextStream &stream, QSharedPointer<MD::Document> doc, QSharedPointer<MD::Block> parent, MD::Context &ctx, const QString &path, const QString &fileName, QStringList &linksToParse) override
virtual void reset(MD::Context &ctx) override
virtual void resetOnAllContexts() override

Static Public Members

void processLabel(QSharedPointer<MD::Paragraph> paragraph, const QString &path, const QString &fileName, QSharedPointer<MD::Heading> heading, QSharedPointer<MD::Document> doc)

Detailed Description

ATX heading parser.

Member Function Documentation

[override virtual] MD::BlockState ATXHeadingParser::check(MD::Line &currentLine, MD::TextStream &stream, QSharedPointer<MD::Document> doc, MD::Context &ctx, const QString &path, const QString &fileName, bool checkWithoutProcessing = false)

Reimplements: BlockParser::check(MD::Line &currentLine, MD::TextStream &stream, QSharedPointer<MD::Document> doc, MD::Context &ctx, const QString &path, const QString &fileName, bool checkWithoutProcessing).

Returns check state for the current line and block type. This method should return BlockState::None if this string is not handled by him. This method should not return BlockState::Stop ever. If this block parser knows how to handle the current line it should return BlockState::Continue.

currentLine Current processing line.

stream Stream of the lines.

doc Current document.

ctx Current parsing context.

path Path to Markdown file.

fileName File name of the Markdown file.

checkWithoutProcessing Flags to don't do real processing, just check this parser handles this line.

[override virtual] MD::BlockState ATXHeadingParser::continueCheck(MD::Line &currentLine, MD::TextStream &stream, QSharedPointer<MD::Document> doc, MD::Context &ctx, const QString &path, const QString &fileName)

Reimplements: BlockParser::continueCheck(MD::Line &currentLine, MD::TextStream &stream, QSharedPointer<MD::Document> doc, MD::Context &ctx, const QString &path, const QString &fileName).

Continue check. If checking knows that block is finished it should return BlockState::Stop.

currentLine Current processing line.

stream Stream of the lines.

doc Current document.

ctx Current parsing context.

path Path to Markdown file.

fileName File name of the Markdown file.

[override virtual] bool ATXHeadingParser::mayBreakParagraph(MD::Line &line, MD::TextStream &stream, QSharedPointer<MD::Document> doc, MD::Context &ctx) const

Reimplements: BlockParser::mayBreakParagraph(MD::Line &line, MD::TextStream &stream, QSharedPointer<MD::Document> doc, MD::Context &ctx) const.

Return whether this kind of block may break a paragraph.

line Line.

stream Stream.

doc Document.

ctx Context.

[override virtual] MD::BlockState ATXHeadingParser::process(MD::Line &currentLine, MD::TextStream &stream, QSharedPointer<MD::Document> doc, QSharedPointer<MD::Block> parent, MD::Context &ctx, const QString &path, const QString &fileName, QStringList &linksToParse)

Reimplements: BlockParser::process(MD::Line &currentLine, MD::TextStream &stream, QSharedPointer<MD::Document> doc, QSharedPointer<MD::Block> parent, MD::Context &ctx, const QString &path, const QString &fileName, QStringList &linksToParse).

Process block - do actual parsing and populating MD::Document. If starting empty line is not a subject for work for this kind of block this method should just skip the line. When parsing of a block is finished this method should return BlockState::Stop.

This method should call himself on all children contexts till block finish.

currentLine Current processing line.

stream Stream of the lines.

doc Document.

parent Parent of this block.

ctx Current parsing context.

path Path to Markdown file.

fileName File name of the Markdown file.

linksToParse List of links for further parsing.

[static] void ATXHeadingParser::processLabel(QSharedPointer<MD::Paragraph> paragraph, const QString &path, const QString &fileName, QSharedPointer<MD::Heading> heading, QSharedPointer<MD::Document> doc)

Make a label for heading, append heading to the document.

paragraph Heading's paragraph.

path Path.

fileName File name.

heading Heading.

doc Document.

[override virtual] void ATXHeadingParser::reset(MD::Context &ctx)

Reimplements: BlockParser::reset(MD::Context &ctx).

Reset state of the block parser for further reuse.

ctx Context.

[override virtual] void ATXHeadingParser::resetOnAllContexts()

Reimplements: BlockParser::resetOnAllContexts().

Reset state of the block parser for further reuse.