docbookgen.cpp File Reference

#include "docbookgen.h"
#include "classdef.h"
#include "classlist.h"
#include "conceptdef.h"
#include "config.h"
#include "diagram.h"
#include "dir.h"
#include "docbookvisitor.h"
#include "docparser.h"
#include "dotcallgraph.h"
#include "dotclassgraph.h"
#include "dotdirdeps.h"
#include "dotgroupcollaboration.h"
#include "dotincldepgraph.h"
#include "doxygen.h"
#include "filename.h"
#include "groupdef.h"
#include "language.h"
#include "message.h"
#include "moduledef.h"
#include "namespacedef.h"
#include "outputgen.h"
#include "outputlist.h"
#include "pagedef.h"
#include "parserintf.h"
#include "section.h"
#include "util.h"

Include dependency graph for docbookgen.cpp:

Go to the source code of this file.

Macros
#define	Docbook_DB(x)
#define	DB_GEN_C
#define	DB_GEN_C1(x)
#define	DB_GEN_C2(y)
#define	DB_GEN_C2a(x, y)

Functions
void	writeDocbookString (TextStream &t, const DString &s)
void	writeDocbookCodeString (bool hide, TextStream &t, const DString &str, size_t &col, size_t stripIndentAmount)
static void	addIndexTerm (TextStream &t, DString prim, DString sec="")
void	writeDocbookLink (TextStream &t, const DString &, const DString &compoundId, const DString &anchorId, const DString &text, const DString &)
static DString	objectLinkToString (const DString &, const DString &f, const DString &anchor, const DString &text)

Variables
static constexpr auto	hex ="0123456789ABCDEF"

Macro Definition Documentation

DB_GEN_C

#define DB_GEN_C

Definition at line 62 of file docbookgen.cpp.

Referenced by DocbookGenerator::addIndexItem(), DocbookGenerator::addLabel(), DocbookGenerator::DocbookGenerator(), DocbookGenerator::docify(), DocbookGenerator::endBold(), DocbookGenerator::endCallGraph(), DocbookGenerator::endClassDiagram(), DocbookGenerator::endCompoundTemplateParams(), DocbookGenerator::endConstraintDocs(), DocbookGenerator::endConstraintList(), DocbookGenerator::endConstraintParam(), DocbookGenerator::endConstraintType(), DocbookGenerator::endDescTable(), DocbookGenerator::endDescTableData(), DocbookGenerator::endDescTableInit(), DocbookGenerator::endDescTableRow(), DocbookGenerator::endDescTableTitle(), DocbookGenerator::endDirDepGraph(), DocbookGenerator::endDotGraph(), DocbookGenerator::endDoxyAnchor(), DocbookGenerator::endExamples(), DocbookGenerator::endFile(), DocbookGenerator::endGroupCollaboration(), DocbookGenerator::endGroupHeader(), DocbookGenerator::endInclDepGraph(), DocbookGenerator::endInlineMemberDoc(), DocbookGenerator::endInlineMemberName(), DocbookGenerator::endInlineMemberType(), DocbookGenerator::endLabels(), DocbookGenerator::endMemberDoc(), DocbookGenerator::endMemberDocList(), DocbookGenerator::endMemberDocName(), DocbookGenerator::endMemberDocPrefixItem(), DocbookGenerator::endMemberDocSimple(), DocbookGenerator::endMemberGroup(), DocbookGenerator::endMemberGroupHeader(), DocbookGenerator::endMemberHeader(), DocbookGenerator::endMemberItem(), DocbookGenerator::endMemberList(), DocbookGenerator::endMemberTemplateParams(), DocbookGenerator::endParagraph(), DocbookGenerator::endParameterDefVal(), DocbookGenerator::endParameterExtra(), DocbookGenerator::endParameterList(), DocbookGenerator::endParameterName(), DocbookGenerator::endSection(), DocbookGenerator::endTextBlock(), DocbookGenerator::endTitleHead(), DocbookGenerator::endTypewriter(), DocbookGenerator::exceptionEntry(), DocbookGenerator::lineBreak(), objectLinkToString(), DocbookGenerator::startBold(), DocbookGenerator::startCallGraph(), DocbookGenerator::startClassDiagram(), DocbookGenerator::startCompoundTemplateParams(), DocbookGenerator::startConstraintDocs(), DocbookGenerator::startConstraintList(), DocbookGenerator::startConstraintParam(), DocbookGenerator::startConstraintType(), DocbookGenerator::startDescTable(), DocbookGenerator::startDescTableData(), DocbookGenerator::startDescTableInit(), DocbookGenerator::startDescTableRow(), DocbookGenerator::startDescTableTitle(), DocbookGenerator::startDirDepGraph(), DocbookGenerator::startDotGraph(), DocbookGenerator::startDoxyAnchor(), DocbookGenerator::startExamples(), DocbookGenerator::startFile(), DocbookGenerator::startGroupCollaboration(), DocbookGenerator::startInclDepGraph(), DocbookGenerator::startInlineMemberDoc(), DocbookGenerator::startInlineMemberName(), DocbookGenerator::startInlineMemberType(), DocbookGenerator::startLabels(), DocbookGenerator::startMemberDocList(), DocbookGenerator::startMemberDocName(), DocbookGenerator::startMemberDocPrefixItem(), DocbookGenerator::startMemberDocSimple(), DocbookGenerator::startMemberGroup(), DocbookGenerator::startMemberGroupHeader(), DocbookGenerator::startMemberHeader(), DocbookGenerator::startMemberItem(), DocbookGenerator::startMemberList(), DocbookGenerator::startMemberTemplateParams(), DocbookGenerator::startParagraph(), DocbookGenerator::startParameterDefVal(), DocbookGenerator::startParameterExtra(), DocbookGenerator::startParameterList(), DocbookGenerator::startParameterName(), DocbookGenerator::startSection(), DocbookGenerator::startTextBlock(), DocbookGenerator::startTitleHead(), DocbookGenerator::startTypewriter(), DocbookGenerator::writeChar(), DocbookGenerator::writeDoc(), DocbookGenerator::writeInheritedSectionTitle(), DocbookGenerator::writeLabel(), DocbookGenerator::writeNonBreakableSpace(), DocbookGenerator::writeObjectLink(), DocbookGenerator::writePageLink(), and DocbookGenerator::writeString().

DB_GEN_C1

#define DB_GEN_C1

(

x

)

Definition at line 63 of file docbookgen.cpp.

Referenced by DocbookCodeGenerator::endCodeFragment(), and DocbookCodeGenerator::startCodeFragment().

DB_GEN_C2

#define DB_GEN_C2

(

y

)

Definition at line 64 of file docbookgen.cpp.

Referenced by DocbookGenerator::endIndexSection(), DocbookGenerator::startGroupHeader(), DocbookGenerator::startIndexSection(), DocbookGenerator::startMemberDoc(), and DocbookGenerator::writeRuler().

DB_GEN_C2a

#define DB_GEN_C2a	(		x,
			y )

Definition at line 65 of file docbookgen.cpp.

Docbook_DB

#define Docbook_DB

(

x

)

Value:

do {} while(0)

Definition at line 50 of file docbookgen.cpp.

Referenced by DocbookCodeGenerator::codify(), DocbookCodeGenerator::endCodeLine(), DocbookCodeGenerator::endFontClass(), DocbookCodeGenerator::startCodeLine(), DocbookCodeGenerator::startFontClass(), DocbookCodeGenerator::writeCodeAnchor(), DocbookCodeGenerator::writeCodeLink(), DocbookCodeGenerator::writeCodeLinkLine(), DocbookCodeGenerator::writeLineNumber(), and DocbookCodeGenerator::writeTooltip().

Function Documentation

addIndexTerm()

void addIndexTerm ( TextStream & t, DString prim, DString sec = "" )

static

Definition at line 130 of file docbookgen.cpp.

{
  t << "<indexterm><primary>";
  t << DocbookGenerator::convertToDocbook(prim);
  t << "</primary>";
  if (!sec.empty())
  {
    t << "<secondary>";
    t << DocbookGenerator::convertToDocbook(sec);
    t << "</secondary>";
  }
  t << "</indexterm>\n";
}

References DocbookGenerator::convertToDocbook().

Referenced by DocbookGenerator::addIndexItem(), DocbookGenerator::endTitleHead(), and DocbookGenerator::startMemberDoc().

objectLinkToString()

DString objectLinkToString ( const DString & , const DString & f, const DString & anchor, const DString & text )

static

Definition at line 766 of file docbookgen.cpp.

{
DB_GEN_C
  DString result;
  if (!anchor.empty())
  {
    if (!f.empty()) result += "<link linkend=\"_" + stripPath(f) + "_1" + anchor + "\">";
    else   result += "<link linkend=\"_" + anchor + "\">";
  }
  else
  {
    result += "<link linkend=\"_" + stripPath(f) + "\">";
  }
  result += DocbookGenerator::convertToDocbook(text);
  result += "</link>";
  return result;
}

References DocbookGenerator::convertToDocbook(), DB_GEN_C, DString::empty(), and stripPath().

Referenced by DocbookGenerator::writeInheritedSectionTitle(), and DocbookGenerator::writeObjectLink().

writeDocbookCodeString()

void writeDocbookCodeString ( bool hide, TextStream & t, const DString & str, size_t & col, size_t stripIndentAmount )

inline

Definition at line 75 of file docbookgen.cpp.

{
  if (str.empty()) return;
  const int tabSize = Config_getInt(TAB_SIZE);
  const char *s = str.data();
  char c=0;
  if (hide)
  {
    col = updateColumnCount(s,col);
  }
  else
  {
    while ((c=*s++))
    {
      switch(c)
      {
        case '\t':
          {
            int spacesToNextTabStop = tabSize - (col%tabSize);
            while (spacesToNextTabStop--)
            {
              if (col>=stripIndentAmount) t << "&#32;";
              col++;
            }
            break;
          }
        case ' ':
          if (col>=stripIndentAmount) t << "&#32;";
          col++;
          break;
        case '<':  t << "&lt;"; col++;   break;
        case '>':  t << "&gt;"; col++;   break;
        case '&':  t << "&amp;"; col++;  break;
        case '\'': t << "&apos;"; col++; break;
        case '"':  t << "&quot;"; col++; break;
        default:
                   {
                     uint8_t uc = static_cast<uint8_t>(c);
                     static const char *hex="0123456789ABCDEF";
                     if (uc<32)
                     {
                       t << "&#x24" << hex[uc>>4] << hex[uc&0xF] << ";";
                     }
                     else
                     {
                       t << c;
                     }
                     col++;
                   }
                   break;
      }
    }
  }
}

References Config_getInt, DString::data(), DString::empty(), hex, and updateColumnCount().

Referenced by DocbookCodeGenerator::codify().

writeDocbookLink()

void writeDocbookLink	(	TextStream &	t,
		const DString &	,
		const DString &	compoundId,
		const DString &	anchorId,
		const DString &	text,
		const DString &	)

Definition at line 143 of file docbookgen.cpp.

{
  t << "<link linkend=\"_" << stripPath(compoundId);
  if (!anchorId.empty()) t << "_1" << anchorId;
  t << "\"";
  t << ">";
  writeDocbookString(t,text);
  t << "</link>";
}

References DString::empty(), stripPath(), and writeDocbookString().

Referenced by DocbookCodeGenerator::writeCodeLink().

writeDocbookString()

void writeDocbookString ( TextStream & t, const DString & s )

inline

Definition at line 70 of file docbookgen.cpp.

{
  t << DocbookGenerator::convertToDocbook(s);
}

References DocbookGenerator::convertToDocbook().

Referenced by DocbookCodeGenerator::writeCodeLinkLine(), and writeDocbookLink().

Variable Documentation

hex

auto hex ="0123456789ABCDEF"

staticconstexpr

Definition at line 1474 of file docbookgen.cpp.

Referenced by DocbookGenerator::convertToDocbook(), convertToHtml(), convertToId(), escapeCharsInString(), letterToLabel(), replaceColorMarkers(), and writeDocbookCodeString().