docbookgen.h File Reference

#include <memory>
#include <array>
#include "config.h"
#include "outputgen.h"

Include dependency graph for docbookgen.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	DocbookCodeGenerator
class	DocbookGenerator
struct	DocbookGenerator::TocState

Macros
#define	DB_GEN_EMPTY
#define	DB_GEN_H
#define	DB_GEN_H1(x)
#define	DB_GEN_H2(y)
#define	DB_GEN_H2a(x, y)
#define	DB_GEN_NEW

Functions
QCString	convertToDocBook (const QCString &s, const bool retainNewline=false)

Macro Definition Documentation

DB_GEN_EMPTY

#define DB_GEN_EMPTY

Definition at line 26 of file docbookgen.h.

Referenced by DocbookGenerator::endAnonTypeScope(), DocbookGenerator::endContents(), DocbookGenerator::endDescForItem(), DocbookGenerator::endHeaderSection(), DocbookGenerator::endIndent(), DocbookGenerator::endItemList(), DocbookGenerator::endItemListItem(), DocbookGenerator::endMemberDeclaration(), DocbookGenerator::endMemberDescription(), DocbookGenerator::endMemberGroupDocs(), DocbookGenerator::endMemberSections(), DocbookGenerator::endMemberSubtitle(), DocbookGenerator::endPageDoc(), DocbookGenerator::endParameterType(), DocbookGenerator::endQuickIndices(), DocbookGenerator::insertMemberAlign(), DocbookGenerator::insertMemberAlignLeft(), DocbookGenerator::lastIndexPage(), DocbookGenerator::startAnonTypeScope(), DocbookGenerator::startContents(), DocbookGenerator::startDescForItem(), DocbookGenerator::startHeaderSection(), DocbookGenerator::startIndent(), DocbookGenerator::startItemList(), DocbookGenerator::startItemListItem(), DocbookGenerator::startMemberDeclaration(), DocbookGenerator::startMemberDescription(), DocbookGenerator::startMemberGroupDocs(), DocbookGenerator::startMemberSections(), DocbookGenerator::startMemberSubtitle(), DocbookGenerator::startPageDoc(), DocbookGenerator::startParameterType(), DocbookGenerator::startQuickIndices(), DocbookGenerator::writeAnchor(), DocbookGenerator::writeLatexSpacing(), DocbookGenerator::writePageOutline(), DocbookGenerator::writeQuickLinks(), DocbookGenerator::writeSearchInfo(), DocbookGenerator::writeSplitBar(), DocbookGenerator::writeStyleInfo(), DocbookGenerator::writeSummaryLink(), and DocbookGenerator::writeSynopsis().

DB_GEN_H

#define DB_GEN_H

Definition at line 38 of file docbookgen.h.

DB_GEN_H1

#define DB_GEN_H1

(

x

)

Definition at line 39 of file docbookgen.h.

DB_GEN_H2

#define DB_GEN_H2

(

y

)

Definition at line 40 of file docbookgen.h.

DB_GEN_H2a

#define DB_GEN_H2a	(		x,
			y )

Definition at line 41 of file docbookgen.h.

DB_GEN_NEW

#define DB_GEN_NEW

Definition at line 42 of file docbookgen.h.

Referenced by DocbookGenerator::endCenter(), DocbookGenerator::endEmphasis(), DocbookGenerator::endIndexItem(), DocbookGenerator::endIndexKey(), DocbookGenerator::endIndexList(), DocbookGenerator::endIndexListItem(), DocbookGenerator::endIndexValue(), DocbookGenerator::endInlineHeader(), DocbookGenerator::endPageRef(), DocbookGenerator::endProjectNumber(), DocbookGenerator::endSmall(), DocbookGenerator::endTextLink(), DocbookGenerator::startCenter(), DocbookGenerator::startEmphasis(), DocbookGenerator::startIndexItem(), DocbookGenerator::startIndexKey(), DocbookGenerator::startIndexList(), DocbookGenerator::startIndexListItem(), DocbookGenerator::startIndexValue(), DocbookGenerator::startInlineHeader(), DocbookGenerator::startPageRef(), DocbookGenerator::startProjectNumber(), DocbookGenerator::startSmall(), DocbookGenerator::startTextLink(), DocbookGenerator::writeFooter(), DocbookGenerator::writeGraphicalHierarchy(), DocbookGenerator::writeLogo(), DocbookGenerator::writeNavigationPath(), and DocbookGenerator::writeStartAnnoItem().

Function Documentation

convertToDocBook()

QCString convertToDocBook	(	const QCString &	s,
		const bool	retainNewline )

Converts a string to an DocBook-encoded string

Definition at line 1484 of file docbookgen.cpp.

{
  if (s.isEmpty()) return s;
  QCString result;
  result.reserve(s.length()+32);
  const char *p = s.data();
  const char *q = nullptr;
  int cnt = 0;
  char c = 0;
  while ((c=*p++))
  {
    switch (c)
    {
      case '\n':
        if (retainNewline) result+="<literallayout>&#160;&#xa;</literallayout>";
        result+=c;
        break;
      case '<':  result+="&lt;";   break;
      case '>':  result+="&gt;";   break;
      case '&':  // possibility to have a special symbol
        q = p;
        cnt = 2; // we have to count & and ; as well
        while ((*q >= 'a' && *q <= 'z') || (*q >= 'A' && *q <= 'Z') || (*q >= '0' && *q <= '9'))
        {
          cnt++;
          q++;
        }
        if (*q == ';')
        {
           --p; // we need & as well
           HtmlEntityMapper::SymType res = HtmlEntityMapper::instance().name2sym(QCString(p).left(cnt));
           if (res == HtmlEntityMapper::Sym_Unknown)
           {
             p++;
             result+="&amp;";
           }
           else
           {
             result+=HtmlEntityMapper::instance().docbook(res);
             q++;
             p = q;
           }
        }
        else
        {
          result+="&amp;";
        }
        break;
      case '\'': result+="&apos;"; break;
      case '"':  result+="&quot;"; break;
      case  1: case  2: case  3: case  4: case  5: case  6: case 7:  case  8:
      case 11: case 12: case 14: case 15: case 16: case 17: case 18:
      case 19: case 20: case 21: case 22: case 23: case 24: case 25: case 26:
      case 27: case 28: case 29: case 30: case 31:
        result+="&#x24";
        result+=hex[static_cast<uint8_t>(c)>>4];
        result+=hex[static_cast<uint8_t>(c)&0xF];
        result+=';';
        break;
      default:
        result+=c;
        break;
    }
  }
  return result;
}

References QCString::data(), HtmlEntityMapper::docbook(), hex, HtmlEntityMapper::instance(), QCString::isEmpty(), QCString::length(), HtmlEntityMapper::name2sym(), QCString::reserve(), and HtmlEntityMapper::Sym_Unknown.

Referenced by addIndexTerm(), DocbookGenerator::docify(), DocbookDocVisitor::filter(), objectLinkToString(), DocbookDocVisitor::operator()(), DocbookDocVisitor::operator()(), DocbookDocVisitor::operator()(), DocbookDocVisitor::operator()(), DocbookGenerator::startDescTable(), DocbookGenerator::startIndexSection(), DocbookGenerator::startMemberDoc(), DocbookGenerator::startMemberDocSimple(), DocbookGenerator::startTocEntry(), DocbookDocVisitor::visitPreStart(), writeDocbookString(), and DocbookGenerator::writeInheritedSectionTitle().