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

Helper class to process markdown formatted text. More...

#include <src/markdown.h>

Classes

struct  Private

Public Member Functions

 Markdown (const QCString &fileName, int lineNr, int indentLevel=0)
 ~Markdown ()
QCString process (const QCString &input, int &startNewlines, bool fromParseInput=false)
QCString extractPageTitle (QCString &docs, QCString &id, int &prepend, bool &isIdGenerated)
void setIndentLevel (int level)

Private Attributes

std::unique_ptr< Privateprv

Detailed Description

Helper class to process markdown formatted text.

Definition at line 31 of file markdown.h.

Constructor & Destructor Documentation

◆ Markdown()

Markdown::Markdown ( const QCString & fileName,
int lineNr,
int indentLevel = 0 )

Definition at line 190 of file markdown.cpp.

191 : prv(std::make_unique<Private>(fileName,lineNr,indentLevel))
192{
193 using namespace std::placeholders;
194 (void)lineNr; // not used yet
195}
std::unique_ptr< Private > prv
Definition markdown.h:43

References prv.

Referenced by ~Markdown().

◆ ~Markdown()

Markdown::~Markdown ( )
default

References Markdown().

Member Function Documentation

◆ extractPageTitle()

QCString Markdown::extractPageTitle ( QCString & docs,
QCString & id,
int & prepend,
bool & isIdGenerated )

Definition at line 3568 of file markdown.cpp.

3569{
3570 AUTO_TRACE("docs={} prepend={}",Trace::trunc(docs),id,prepend);
3571 // first first non-empty line
3572 prepend = 0;
3573 QCString title;
3574 size_t i=0;
3575 QCString docs_org(docs);
3576 std::string_view data(docs_org.str());
3577 const size_t size = data.size();
3578 docs.clear();
3579 while (i<size && (data[i]==' ' || data[i]=='\n'))
3580 {
3581 if (data[i]=='\n') prepend++;
3582 i++;
3583 }
3584 if (i>=size) { return QCString(); }
3585 size_t end1=i+1;
3586 while (end1<size && data[end1-1]!='\n') end1++;
3587 //printf("i=%d end1=%d size=%d line='%s'\n",i,end1,size,docs.mid(i,end1-i).data());
3588 // first line from i..end1
3589 if (end1<size)
3590 {
3591 // second line form end1..end2
3592 size_t end2=end1+1;
3593 while (end2<size && data[end2-1]!='\n') end2++;
3594 if (prv->isHeaderline(data.substr(end1),FALSE))
3595 {
3596 title = data.substr(i,end1-i-1);
3597 docs+="\n\n"+docs_org.mid(end2);
3598 id = prv->extractTitleId(title, 0, &isIdGenerated);
3599 //printf("extractPageTitle(title='%s' docs='%s' id='%s')\n",title.data(),docs.data(),id.data());
3600 AUTO_TRACE_EXIT("result={} id={} isIdGenerated={}",Trace::trunc(title),id,isIdGenerated);
3601 return title;
3602 }
3603 }
3604 if (i<end1 && prv->isAtxHeader(data.substr(i,end1-i),title,id,FALSE,&isIdGenerated)>0)
3605 {
3606 docs+="\n";
3607 docs+=docs_org.mid(end1);
3608 }
3609 else
3610 {
3611 docs=docs_org;
3612 id = prv->extractTitleId(title, 0, &isIdGenerated);
3613 }
3614 AUTO_TRACE_EXIT("result={} id={} isIdGenerated={}",Trace::trunc(title),id,isIdGenerated);
3615 return title;
3616}
QCString mid(size_t index, size_t len=static_cast< size_t >(-1)) const
Definition qcstring.h:241
void clear()
Definition qcstring.h:182
#define AUTO_TRACE(...)
Definition docnode.cpp:46
#define AUTO_TRACE_EXIT(...)
Definition docnode.cpp:48
QCString trunc(const QCString &s, size_t numChars=15)
Definition trace.h:56
#define FALSE
Definition qcstring.h:34

References AUTO_TRACE, AUTO_TRACE_EXIT, QCString::clear(), FALSE, QCString::mid(), prv, QCString::str(), and Trace::trunc().

Referenced by MarkdownOutlineParser::parseInput().

◆ process()

QCString Markdown::process ( const QCString & input,
int & startNewlines,
bool fromParseInput = false )

Definition at line 3621 of file markdown.cpp.

3622{
3623 if (input.isEmpty()) return input;
3624 size_t refIndent=0;
3625
3626 // for replace tabs by spaces
3627 QCString s = input;
3628 if (s.at(s.length()-1)!='\n') s += "\n"; // see PR #6766
3629 s = detab(s,refIndent);
3630 //printf("======== DeTab =========\n---- output -----\n%s\n---------\n",qPrint(s));
3631
3632 // then process quotation blocks (as these may contain other blocks)
3633 s = prv->processQuotations(s.view(),refIndent);
3634 //printf("======== Quotations =========\n---- output -----\n%s\n---------\n",qPrint(s));
3635
3636 // then process block items (headers, rules, and code blocks, references)
3637 s = prv->processBlocks(s.view(),refIndent);
3638 //printf("======== Blocks =========\n---- output -----\n%s\n---------\n",qPrint(s));
3639
3640 // finally process the inline markup (links, emphasis and code spans)
3641 prv->out.clear();
3642 prv->out.reserve(s.length());
3643 prv->processInline(s.view());
3644 if (fromParseInput)
3645 {
3646 Debug::print(Debug::Markdown,0,"---- output -----\n{}\n=========\n",qPrint(prv->out));
3647 }
3648 else
3649 {
3650 Debug::print(Debug::Markdown,0,"======== Markdown =========\n---- input ------- \n{}\n---- output -----\n{}\n=========\n",input,prv->out);
3651 }
3652
3653 // post processing
3654 QCString result = substitute(prv->out,g_doxy_nbsp,"&nbsp;");
3655 const char *p = result.data();
3656 if (p)
3657 {
3658 while (*p==' ') p++; // skip over spaces
3659 while (*p=='\n') {startNewlines++;p++;}; // skip over newlines
3660 if (literal_at(p,"<br>")) p+=4; // skip over <br>
3661 }
3662 if (p>result.data())
3663 {
3664 // strip part of the input
3665 result = result.mid(static_cast<int>(p-result.data()));
3666 }
3667 return result;
3668}
@ Markdown
Definition debug.h:37
static void print(DebugMask mask, int prio, fmt::format_string< Args... > fmt, Args &&... args)
Definition debug.h:76
size_t length() const
Returns the length of the string, not counting the 0-terminator.
Definition qcstring.h:166
char & at(size_t i)
Returns a reference to the character at index i.
Definition qcstring.h:593
bool isEmpty() const
Returns TRUE iff the string is empty.
Definition qcstring.h:163
const char * data() const
Returns a pointer to the contents of the string in the form of a 0-terminated C string.
Definition qcstring.h:172
std::string_view view() const
Definition qcstring.h:174
const char * g_doxy_nbsp
Definition markdown.cpp:208
QCString substitute(const QCString &s, const QCString &src, const QCString &dst)
substitute all occurrences of src in s by dst
Definition qcstring.cpp:482
const char * qPrint(const char *s)
Definition qcstring.h:687
bool literal_at(const char *data, const char(&str)[N])
returns TRUE iff data points to a substring that matches string literal str
Definition stringutil.h:98
QCString detab(const QCString &s, size_t &refIndent)
Definition util.cpp:6630

References QCString::at(), QCString::data(), detab(), g_doxy_nbsp, QCString::isEmpty(), QCString::length(), literal_at(), Debug::Markdown, QCString::mid(), Debug::print(), prv, qPrint(), substitute(), and QCString::view().

Referenced by generateHtmlForComment(), handleCommentBlock(), handleCommentBlock(), handleCommentBlock(), VHDLOutlineParser::handleCommentBlock(), handleParametersCommentBlocks(), and MarkdownOutlineParser::parseInput().

◆ setIndentLevel()

void Markdown::setIndentLevel ( int level)

Definition at line 199 of file markdown.cpp.

199{ prv->indentLevel = level; }

References prv.

Referenced by MarkdownOutlineParser::parseInput().

Member Data Documentation

◆ prv

std::unique_ptr<Private> Markdown::prv
private

Definition at line 43 of file markdown.h.

Referenced by extractPageTitle(), Markdown(), process(), and setIndentLevel().


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