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 3693 of file markdown.cpp.

3693 : p(std::make_unique<Private>())
3694{
3695}
std::unique_ptr< Private > p
Definition markdown.h:60

References p.

◆ ~MarkdownOutlineParser()

MarkdownOutlineParser::~MarkdownOutlineParser ( )
override

Definition at line 3697 of file markdown.cpp.

3698{
3699}

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 3701 of file markdown.cpp.

3705{
3706 std::shared_ptr<Entry> current = std::make_shared<Entry>();
3707 int prepend = 0; // number of empty lines in front
3708 current->lang = SrcLangExt::Markdown;
3709 current->fileName = fileName;
3710 current->docFile = fileName;
3711 current->docLine = 1;
3712 QCString docs = stripIndentation(fileBuf);
3713 if (!docs.stripWhiteSpace().size()) return;
3714 Debug::print(Debug::Markdown,0,"======== Markdown =========\n---- input ------- \n{}\n",fileBuf);
3715 QCString id;
3716 Markdown markdown(fileName,1,0);
3717 bool isIdGenerated = false;
3718 QCString title = markdown.extractPageTitle(docs, id, prepend, isIdGenerated).stripWhiteSpace();
3719 QCString generatedId;
3720 if (isIdGenerated)
3721 {
3722 generatedId = id;
3723 id = "";
3724 }
3725 int indentLevel=title.isEmpty() ? 0 : -1;
3726 markdown.setIndentLevel(indentLevel);
3727 FileInfo fi(fileName.str());
3728 QCString fn = fi.fileName();
3729 QCString titleFn = stripExtensionGeneral(fn,getFileNameExtension(fn));
3730 QCString mdfileAsMainPage = Config_getString(USE_MDFILE_AS_MAINPAGE);
3731 QCString mdFileNameId = markdownFileNameToId(fileName);
3732 bool wasEmpty = id.isEmpty();
3733 if (wasEmpty) id = mdFileNameId;
3734 QCString relFileName = stripFromPath(fileName);
3735 bool isSubdirDocs = Config_getBool(IMPLICIT_DIR_DOCS) && relFileName.lower().endsWith("/readme.md");
3736 switch (isExplicitPage(docs))
3737 {
3739 if (!mdfileAsMainPage.isEmpty() &&
3740 (fi.absFilePath()==FileInfo(mdfileAsMainPage.str()).absFilePath()) // file reference with path
3741 )
3742 {
3743 docs.prepend("@ianchor{" + title + "} " + id + "\\ilinebr ");
3744 docs.prepend("@mainpage "+title+"\\ilinebr ");
3745 }
3746 else if (id=="mainpage" || id=="index")
3747 {
3748 if (title.isEmpty()) title = titleFn;
3749 docs.prepend("@ianchor{" + title + "} " + id + "\\ilinebr ");
3750 docs.prepend("@mainpage "+title+"\\ilinebr ");
3751 }
3752 else if (isSubdirDocs)
3753 {
3754 if (!generatedId.isEmpty() && !title.isEmpty())
3755 {
3756 docs.prepend("@section " + generatedId + " " + title + "\\ilinebr ");
3757 }
3758 docs.prepend("@dir\\ilinebr ");
3759 }
3760 else
3761 {
3762 if (title.isEmpty())
3763 {
3764 title = titleFn;
3765 prepend = 0;
3766 }
3767 if (!wasEmpty)
3768 {
3769 docs.prepend("@ianchor{" + title + "} " + id + "\\ilinebr @ianchor{" + relFileName + "} " + mdFileNameId + "\\ilinebr ");
3770 }
3771 else if (!generatedId.isEmpty())
3772 {
3773 docs.prepend("@ianchor " + generatedId + "\\ilinebr ");
3774 }
3775 else if (Config_getEnum(MARKDOWN_ID_STYLE)==MARKDOWN_ID_STYLE_t::GITHUB)
3776 {
3777 QCString autoId = AnchorGenerator::instance().generate(title.str());
3778 docs.prepend("@ianchor{" + title + "} " + autoId + "\\ilinebr ");
3779 }
3780 docs.prepend("@page "+id+" "+title+"\\ilinebr ");
3781 }
3782 for (int i = 0; i < prepend; i++) docs.prepend("\n");
3783 break;
3785 {
3786 // look for `@page label My Title\n` and capture `label` (match[1]) and ` My Title` (match[2])
3787 static const reg::Ex re(R"([ ]*[\\@]page\s+(\a[\w-]*)(\s*[^\n]*)\n)");
3788 reg::Match match;
3789 std::string s = docs.str();
3790 if (reg::search(s,match,re))
3791 {
3792 QCString orgLabel = match[1].str();
3793 QCString orgTitle = match[2].str();
3794 orgTitle = orgTitle.stripWhiteSpace();
3795 QCString newLabel = markdownFileNameToId(fileName);
3796 docs = docs.left(match[1].position())+ // part before label
3797 newLabel+ // new label
3798 match[2].str()+ // part between orgLabel and \n
3799 "\\ilinebr @ianchor{" + orgTitle + "} "+orgLabel+"\n"+ // add original anchor plus \n of above
3800 docs.right(docs.length()-match.length()); // add remainder of docs
3801 }
3802 }
3803 break;
3805 break;
3807 break;
3808 }
3809 int lineNr=1;
3810
3811 p->commentScanner.enterFile(fileName,lineNr);
3812 Protection prot = Protection::Public;
3813 bool needsEntry = false;
3814 int position=0;
3815 GuardedSectionStack guards;
3816 QCString processedDocs = markdown.process(docs,lineNr,true);
3817 while (p->commentScanner.parseCommentBlock(
3818 this,
3819 current.get(),
3820 processedDocs,
3821 fileName,
3822 lineNr,
3823 FALSE, // isBrief
3824 FALSE, // javadoc autobrief
3825 FALSE, // inBodyDocs
3826 prot, // protection
3827 position,
3828 needsEntry,
3829 true,
3830 &guards
3831 ))
3832 {
3833 if (needsEntry)
3834 {
3835 QCString docFile = current->docFile;
3836 root->moveToSubEntryAndRefresh(current);
3837 current->lang = SrcLangExt::Markdown;
3838 current->docFile = docFile;
3839 current->docLine = lineNr;
3840 }
3841 }
3842 if (needsEntry)
3843 {
3844 root->moveToSubEntryAndKeep(current);
3845 }
3846 p->commentScanner.leaveFile(fileName,lineNr);
3847}
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:422
size_t length() const
Returns the length of the string, not counting the 0-terminator.
Definition qcstring.h:166
QCString lower() const
Definition qcstring.h:249
bool endsWith(const char *s) const
Definition qcstring.h:524
bool isEmpty() const
Returns TRUE iff the string is empty.
Definition qcstring.h:163
QCString stripWhiteSpace() const
returns a copy of this string with leading and trailing whitespace removed
Definition qcstring.h:260
const std::string & str() const
Definition qcstring.h:552
QCString right(size_t len) const
Definition qcstring.h:234
size_t size() const
Returns the length of the string, not counting the 0-terminator.
Definition qcstring.h:169
QCString left(size_t len) const
Definition qcstring.h:229
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
@ 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:5861
QCString stripExtensionGeneral(const QCString &fName, const QCString &ext)
Definition util.cpp:4835
static QCString stripFromPath(const QCString &p, const StringVector &l)
Definition util.cpp:307
QCString getFileNameExtension(const QCString &fn)
Definition util.cpp:5149

References FileInfo::absFilePath(), Config_getBool, Config_getEnum, Config_getString, QCString::endsWith(), explicitMainPage, explicitOtherPage, explicitPage, Markdown::extractPageTitle(), FALSE, FileInfo::fileName(), AnchorGenerator::generate(), getFileNameExtension(), AnchorGenerator::instance(), QCString::isEmpty(), isExplicitPage(), QCString::left(), QCString::length(), QCString::lower(), Debug::Markdown, markdownFileNameToId(), notExplicit, p, QCString::prepend(), Debug::print(), Markdown::process(), QCString::right(), 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 3849 of file markdown.cpp.

3850{
3851 Doxygen::parserManager->getOutlineParser("*.cpp")->parsePrototype(text);
3852}
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: