Doxygen
Loading...
Searching...
No Matches
MarkdownOutlineParser Class Reference

#include <src/markdown.h>

Inheritance diagram for MarkdownOutlineParser:
Collaboration diagram for MarkdownOutlineParser:

Classes

struct  Private

Public Member Functions

 MarkdownOutlineParser ()
 ~MarkdownOutlineParser () override
void parseInput (const QCString &fileName, const char *fileBuf, const std::shared_ptr< Entry > &root, ClangTUParser *clangParser) override
 Parses a single input file with the goal to build an Entry tree.
bool needsPreprocessing (const QCString &) const override
 Returns TRUE if the language identified by extension needs the C preprocessor to be run before feed the result to the input parser.
void parsePrototype (const QCString &text) override
 Callback function called by the comment block scanner.

Private Attributes

std::unique_ptr< Privatep

Detailed Description

Definition at line 46 of file markdown.h.

Constructor & Destructor Documentation

◆ MarkdownOutlineParser()

MarkdownOutlineParser::MarkdownOutlineParser ( )

Definition at line 3674 of file markdown.cpp.

3674 : p(std::make_unique<Private>())
3675{
3676}
std::unique_ptr< Private > p
Definition markdown.h:60

References p.

◆ ~MarkdownOutlineParser()

MarkdownOutlineParser::~MarkdownOutlineParser ( )
override

Definition at line 3678 of file markdown.cpp.

3679{
3680}

Member Function Documentation

◆ needsPreprocessing()

bool MarkdownOutlineParser::needsPreprocessing ( const QCString & extension) const
inlineoverridevirtual

Returns TRUE if the language identified by extension needs the C preprocessor to be run before feed the result to the input parser.

See also
parseInput()

Implements OutlineParserInterface.

Definition at line 56 of file markdown.h.

56{ return FALSE; }
#define FALSE
Definition qcstring.h:34

References FALSE.

◆ parseInput()

void MarkdownOutlineParser::parseInput ( const QCString & fileName,
const char * fileBuf,
const std::shared_ptr< Entry > & root,
ClangTUParser * clangParser )
overridevirtual

Parses a single input file with the goal to build an Entry tree.

Parameters
[in]fileNameThe full name of the file.
[in]fileBufThe contents of the file (zero terminated).
[in,out]rootThe root of the tree of Entry *nodes representing the information extracted from the file.
[in]clangParserThe clang translation unit parser object or nullptr if disabled.

Implements OutlineParserInterface.

Definition at line 3682 of file markdown.cpp.

3686{
3687 std::shared_ptr<Entry> current = std::make_shared<Entry>();
3688 int prepend = 0; // number of empty lines in front
3689 current->lang = SrcLangExt::Markdown;
3690 current->fileName = fileName;
3691 current->docFile = fileName;
3692 current->docLine = 1;
3693 QCString docs = stripIndentation(fileBuf);
3694 if (!docs.stripWhiteSpace().size()) return;
3695 Debug::print(Debug::Markdown,0,"======== Markdown =========\n---- input ------- \n{}\n",fileBuf);
3696 QCString id;
3697 Markdown markdown(fileName,1,0);
3698 bool isIdGenerated = false;
3699 QCString title = markdown.extractPageTitle(docs, id, prepend, isIdGenerated).stripWhiteSpace();
3700 QCString generatedId;
3701 if (isIdGenerated)
3702 {
3703 generatedId = id;
3704 id = "";
3705 }
3706 int indentLevel=title.isEmpty() ? 0 : -1;
3707 markdown.setIndentLevel(indentLevel);
3708 FileInfo fi(fileName.str());
3709 QCString fn = fi.fileName();
3710 QCString titleFn = stripExtensionGeneral(fn,getFileNameExtension(fn));
3711 QCString mdfileAsMainPage = Config_getString(USE_MDFILE_AS_MAINPAGE);
3712 QCString mdFileNameId = markdownFileNameToId(fileName);
3713 bool wasEmpty = id.isEmpty();
3714 if (wasEmpty) id = mdFileNameId;
3715 QCString relFileName = stripFromPath(fileName);
3716 bool isSubdirDocs = Config_getBool(IMPLICIT_DIR_DOCS) && relFileName.lower().endsWith("/readme.md");
3717 switch (isExplicitPage(docs))
3718 {
3720 if (!mdfileAsMainPage.isEmpty() &&
3721 (fi.absFilePath()==FileInfo(mdfileAsMainPage.str()).absFilePath()) // file reference with path
3722 )
3723 {
3724 docs.prepend("@ianchor{" + title + "} " + id + "\\ilinebr ");
3725 docs.prepend("@mainpage "+title+"\\ilinebr ");
3726 }
3727 else if (id=="mainpage" || id=="index")
3728 {
3729 if (title.isEmpty()) title = titleFn;
3730 docs.prepend("@ianchor{" + title + "} " + id + "\\ilinebr ");
3731 docs.prepend("@mainpage "+title+"\\ilinebr ");
3732 }
3733 else if (isSubdirDocs)
3734 {
3735 if (!generatedId.isEmpty() && !title.isEmpty())
3736 {
3737 docs.prepend("@section " + generatedId + " " + title + "\\ilinebr ");
3738 }
3739 docs.prepend("@dir\\ilinebr ");
3740 }
3741 else
3742 {
3743 if (title.isEmpty())
3744 {
3745 title = titleFn;
3746 prepend = 0;
3747 }
3748 if (!wasEmpty)
3749 {
3750 docs.prepend("@ianchor{" + title + "} " + id + "\\ilinebr @ianchor{" + relFileName + "} " + mdFileNameId + "\\ilinebr ");
3751 }
3752 else if (!generatedId.isEmpty())
3753 {
3754 docs.prepend("@ianchor " + generatedId + "\\ilinebr ");
3755 }
3756 else if (Config_getEnum(MARKDOWN_ID_STYLE)==MARKDOWN_ID_STYLE_t::GITHUB)
3757 {
3758 QCString autoId = AnchorGenerator::instance().generate(title.str());
3759 docs.prepend("@ianchor{" + title + "} " + autoId + "\\ilinebr ");
3760 }
3761 docs.prepend("@page "+id+" "+title+"\\ilinebr ");
3762 }
3763 for (int i = 0; i < prepend; i++) docs.prepend("\n");
3764 break;
3766 {
3767 // look for `@page label My Title\n` and capture `label` (match[1]) and ` My Title` (match[2])
3768 static const reg::Ex re(R"([ ]*[\\@]page\s+(\a[\w-]*)(\s*[^\n]*)\n)");
3769 reg::Match match;
3770 std::string s = docs.str();
3771 if (reg::search(s,match,re))
3772 {
3773 QCString orgLabel = match[1].str();
3774 QCString orgTitle = match[2].str();
3775 orgTitle = orgTitle.stripWhiteSpace();
3776 QCString newLabel = markdownFileNameToId(fileName);
3777 docs = docs.left(match[1].position())+ // part before label
3778 newLabel+ // new label
3779 match[2].str()+ // part between orgLabel and \n
3780 "\\ilinebr @ianchor{" + orgTitle + "} "+orgLabel+"\n"+ // add original anchor plus \n of above
3781 docs.right(docs.length()-match.length()); // add remainder of docs
3782 }
3783 }
3784 break;
3786 break;
3788 break;
3789 }
3790 int lineNr=1;
3791
3792 p->commentScanner.enterFile(fileName,lineNr);
3793 Protection prot = Protection::Public;
3794 bool needsEntry = false;
3795 int position=0;
3796 GuardedSectionStack guards;
3797 QCString processedDocs = markdown.process(docs,lineNr,true);
3798 while (p->commentScanner.parseCommentBlock(
3799 this,
3800 current.get(),
3801 processedDocs,
3802 fileName,
3803 lineNr,
3804 FALSE, // isBrief
3805 FALSE, // javadoc autobrief
3806 FALSE, // inBodyDocs
3807 prot, // protection
3808 position,
3809 needsEntry,
3810 true,
3811 &guards
3812 ))
3813 {
3814 if (needsEntry)
3815 {
3816 QCString docFile = current->docFile;
3817 root->moveToSubEntryAndRefresh(current);
3818 current->lang = SrcLangExt::Markdown;
3819 current->docFile = docFile;
3820 current->docLine = lineNr;
3821 }
3822 }
3823 if (needsEntry)
3824 {
3825 root->moveToSubEntryAndKeep(current);
3826 }
3827 p->commentScanner.leaveFile(fileName,lineNr);
3828}
static AnchorGenerator & instance()
Returns the singleton instance.
Definition anchor.cpp:38
std::string generate(const std::string &title)
generates an anchor for a section with title.
Definition anchor.cpp:59
@ Markdown
Definition debug.h:37
static void print(DebugMask mask, int prio, fmt::format_string< Args... > fmt, Args &&... args)
Definition debug.h:76
QCString & prepend(const char *s)
Definition qcstring.h:407
size_t length() const
Returns the length of the string, not counting the 0-terminator.
Definition qcstring.h:153
QCString lower() const
Definition qcstring.h:234
bool endsWith(const char *s) const
Definition qcstring.h:509
bool isEmpty() const
Returns TRUE iff the string is empty.
Definition qcstring.h:150
QCString stripWhiteSpace() const
returns a copy of this string with leading and trailing whitespace removed
Definition qcstring.h:245
const std::string & str() const
Definition qcstring.h:537
QCString right(size_t len) const
Definition qcstring.h:219
size_t size() const
Returns the length of the string, not counting the 0-terminator.
Definition qcstring.h:156
QCString left(size_t len) const
Definition qcstring.h:214
std::stack< GuardedSection > GuardedSectionStack
Definition commentscan.h:48
#define Config_getBool(name)
Definition config.h:33
#define Config_getString(name)
Definition config.h:32
#define Config_getEnum(name)
Definition config.h:35
QCString s
Definition htmlgen.cpp:154
size_t i
Definition htmlgen.cpp:161
@ explicitMainPage
docs start with a mainpage command
Definition markdown.cpp:69
@ explicitPage
docs start with a page command
Definition markdown.cpp:68
@ notExplicit
docs doesn't start with either page or mainpage
Definition markdown.cpp:71
@ explicitOtherPage
docs start with a dir / defgroup / addtogroup command
Definition markdown.cpp:70
static ExplicitPageResult isExplicitPage(const QCString &docs)
QCString markdownFileNameToId(const QCString &fileName)
processes string s and converts markdown into doxygen/html commands.
bool search(std::string_view str, Match &match, const Ex &re, size_t pos)
Search in a given string str starting at position pos for a match against regular expression re.
Definition regex.cpp:748
bool match(std::string_view str, Match &match, const Ex &re)
Matches a given string str for a match against regular expression re.
Definition regex.cpp:759
Protection
Definition types.h:32
QCString stripIndentation(const QCString &s, bool skipFirstLine)
Definition util.cpp:6466
QCString stripExtensionGeneral(const QCString &fName, const QCString &ext)
Definition util.cpp:5428
static QCString stripFromPath(const QCString &p, const StringVector &l)
Definition util.cpp:310
QCString getFileNameExtension(const QCString &fn)
Definition util.cpp:5764

References FileInfo::absFilePath(), Config_getBool, Config_getEnum, Config_getString, QCString::endsWith(), explicitMainPage, explicitOtherPage, explicitPage, Markdown::extractPageTitle(), FALSE, FileInfo::fileName(), AnchorGenerator::generate(), getFileNameExtension(), i, AnchorGenerator::instance(), QCString::isEmpty(), isExplicitPage(), QCString::left(), QCString::length(), QCString::lower(), Debug::Markdown, markdownFileNameToId(), notExplicit, p, QCString::prepend(), Debug::print(), Markdown::process(), QCString::right(), s, reg::search(), Markdown::setIndentLevel(), QCString::size(), QCString::str(), stripExtensionGeneral(), stripFromPath(), stripIndentation(), and QCString::stripWhiteSpace().

◆ parsePrototype()

void MarkdownOutlineParser::parsePrototype ( const QCString & text)
overridevirtual

Callback function called by the comment block scanner.

It provides a string text containing the prototype of a function or variable. The parser should parse this and store the information in the Entry node that corresponds with the node for which the comment block parser was invoked.

Implements OutlineParserInterface.

Definition at line 3830 of file markdown.cpp.

3831{
3832 Doxygen::parserManager->getOutlineParser("*.cpp")->parsePrototype(text);
3833}
static ParserManager * parserManager
Definition doxygen.h:131
std::unique_ptr< OutlineParserInterface > getOutlineParser(const QCString &extension)
Gets the interface to the parser associated with a given extension.
Definition parserintf.h:209

References Doxygen::parserManager.

Member Data Documentation

◆ p

std::unique_ptr<Private> MarkdownOutlineParser::p
private

Definition at line 60 of file markdown.h.

Referenced by MarkdownOutlineParser(), and parseInput().


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