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 Types
using	Action_t = std::function<int(Private&,std::string_view,size_t)>
using	ActionTable_t = std::array<Action_t,256>

Static Private Member Functions
static ActionTable_t	fill_table ()

Private Attributes
std::unique_ptr< Private >	prv

Static Private Attributes
static ActionTable_t	actions = Markdown::fill_table()

Detailed Description

Helper class to process markdown formatted text.

Definition at line 31 of file markdown.h.

Member Typedef Documentation

Action_t

using Markdown::Action_t = std::function<int(Private&,std::string_view,size_t)>

private

Definition at line 44 of file markdown.h.

ActionTable_t

using Markdown::ActionTable_t = std::array<Action_t,256>

private

Definition at line 45 of file markdown.h.

Constructor & Destructor Documentation

Markdown()

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

Definition at line 201 of file markdown.cpp.

  : prv(std::make_unique<Private>(fileName,lineNr,indentLevel))
{
  using namespace std::placeholders;
  (void)lineNr; // not used yet
}

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

{
  AUTO_TRACE("docs={} prepend={}",Trace::trunc(docs),id,prepend);
  // first first non-empty line
  prepend = 0;
  QCString title;
  size_t i=0;
  QCString docs_org(docs);
  std::string_view data(docs_org.str());
  const size_t size = data.size();
  docs.clear();
  while (i<size && (data[i]==' ' || data[i]=='\n'))
  {
    if (data[i]=='\n') prepend++;
    i++;
  }
  if (i>=size) { return QCString(); }
  size_t end1=i+1;
  while (end1<size && data[end1-1]!='\n') end1++;
  //printf("i=%d end1=%d size=%d line='%s'\n",i,end1,size,docs.mid(i,end1-i).data());
  // first line from i..end1
  if (end1<size)
  {
    // second line form end1..end2
    size_t end2=end1+1;
    while (end2<size && data[end2-1]!='\n') end2++;
    if (prv->isHeaderline(data.substr(end1),FALSE))
    {
      title = data.substr(i,end1-i-1);
      docs+="\n\n"+docs_org.mid(end2);
      id = prv->extractTitleId(title, 0, &isIdGenerated);
      //printf("extractPageTitle(title='%s' docs='%s' id='%s')\n",title.data(),docs.data(),id.data());
      AUTO_TRACE_EXIT("result={} id={} isIdGenerated={}",Trace::trunc(title),id,isIdGenerated);
      return title;
    }
  }
  if (i<end1 && prv->isAtxHeader(data.substr(i,end1-i),title,id,FALSE,&isIdGenerated)>0)
  {
    docs+="\n";
    docs+=docs_org.mid(end1);
  }
  else
  {
    docs=docs_org;
    id = prv->extractTitleId(title, 0, &isIdGenerated);
  }
  AUTO_TRACE_EXIT("result={} id={} isIdGenerated={}",Trace::trunc(title),id,isIdGenerated);
  return title;
}

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

Referenced by MarkdownOutlineParser::parseInput().

fill_table()

Markdown::ActionTable_t Markdown::fill_table ( )

staticprivate

Definition at line 182 of file markdown.cpp.

{
  Markdown::ActionTable_t a{};
  a[static_cast<unsigned int>('_')] = [](Markdown::Private &obj,std::string_view data,size_t offset) { return obj.processEmphasis      (data,offset); };
  a[static_cast<unsigned int>('*')] = [](Markdown::Private &obj,std::string_view data,size_t offset) { return obj.processEmphasis      (data,offset); };
  a[static_cast<unsigned int>('~')] = [](Markdown::Private &obj,std::string_view data,size_t offset) { return obj.processEmphasis      (data,offset); };
  a[static_cast<unsigned int>('`')] = [](Markdown::Private &obj,std::string_view data,size_t offset) { return obj.processCodeSpan      (data,offset); };
  a[static_cast<unsigned int>('\\')]= [](Markdown::Private &obj,std::string_view data,size_t offset) { return obj.processSpecialCommand(data,offset); };
  a[static_cast<unsigned int>('@')] = [](Markdown::Private &obj,std::string_view data,size_t offset) { return obj.processSpecialCommand(data,offset); };
  a[static_cast<unsigned int>('[')] = [](Markdown::Private &obj,std::string_view data,size_t offset) { return obj.processLink          (data,offset); };
  a[static_cast<unsigned int>('!')] = [](Markdown::Private &obj,std::string_view data,size_t offset) { return obj.processLink          (data,offset); };
  a[static_cast<unsigned int>('<')] = [](Markdown::Private &obj,std::string_view data,size_t offset) { return obj.processHtmlTag       (data,offset); };
  a[static_cast<unsigned int>('-')] = [](Markdown::Private &obj,std::string_view data,size_t offset) { return obj.processNmdash        (data,offset); };
  a[static_cast<unsigned int>('"')] = [](Markdown::Private &obj,std::string_view data,size_t offset) { return obj.processQuoted        (data,offset); };
  return a;
}

References Markdown::Private::processCodeSpan(), Markdown::Private::processEmphasis(), Markdown::Private::processHtmlTag(), Markdown::Private::processLink(), Markdown::Private::processNmdash(), Markdown::Private::processQuoted(), and Markdown::Private::processSpecialCommand().

process()

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

Definition at line 3698 of file markdown.cpp.

{
  if (input.isEmpty()) return input;
  size_t refIndent=0;
 
  // for replace tabs by spaces
  QCString s = input;
  if (s.at(s.length()-1)!='\n') s += "\n"; // see PR #6766
  s = detab(s,refIndent);
  //printf("======== DeTab =========\n---- output -----\n%s\n---------\n",qPrint(s));
 
  // then process quotation blocks (as these may contain other blocks)
  s = prv->processQuotations(s.view(),refIndent);
  //printf("======== Quotations =========\n---- output -----\n%s\n---------\n",qPrint(s));
 
  // then process block items (headers, rules, and code blocks, references)
  s = prv->processBlocks(s.view(),refIndent);
  //printf("======== Blocks =========\n---- output -----\n%s\n---------\n",qPrint(s));
 
  // finally process the inline markup (links, emphasis and code spans)
  prv->out.clear();
  prv->out.reserve(s.length());
  prv->processInline(s.view());
  if (fromParseInput)
  {
    Debug::print(Debug::Markdown,0,"---- output -----\n{}\n=========\n",qPrint(prv->out));
  }
  else
  {
    Debug::print(Debug::Markdown,0,"======== Markdown =========\n---- input ------- \n{}\n---- output -----\n{}\n=========\n",input,prv->out);
  }
 
  // post processing
  QCString result = substitute(prv->out,g_doxy_nbsp," ");
  const char *p = result.data();
  if (p)
  {
    while (*p==' ')  p++; // skip over spaces
    while (*p=='\n') {startNewlines++;p++;}; // skip over newlines
    if (literal_at(p,"<br>")) p+=4; // skip over <br>
  }
  if (p>result.data())
  {
    // strip part of the input
    result = result.mid(static_cast<int>(p-result.data()));
  }
  return result;
}

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

{ prv->indentLevel = level; }

References prv.

Referenced by MarkdownOutlineParser::parseInput().

Member Data Documentation

actions

Markdown::ActionTable_t Markdown::actions = Markdown::fill_table()

staticprivate

Definition at line 47 of file markdown.h.

Referenced by Markdown::Private::processInline().

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:

• src/markdown.h
• src/markdown.cpp