rtfstyle.h File Reference

#include <map>
#include <string>
#include <cstdint>
#include "qcstring.h"

Include dependency graph for rtfstyle.h:

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

Go to the source code of this file.

Classes
struct	Rtf_Style_Default
struct	Rtf_Table_Default
struct	StyleData

Typedefs
using	StyleDataMap = std::map<std::string,StyleData>

Functions
void	loadExtensions (const QCString &name)
void	loadStylesheet (const QCString &name, StyleDataMap &map)

Variables
const int	rtf_pageWidth = 8748
QCString	rtf_title
QCString	rtf_subject
QCString	rtf_comments
QCString	rtf_company
QCString	rtf_logoFilename
QCString	rtf_author
QCString	rtf_manager
QCString	rtf_documentType
QCString	rtf_documentId
QCString	rtf_keywords
char	rtf_Style_Reset []
Rtf_Style_Default	rtf_Style_Default []
Rtf_Table_Default	rtf_Table_Default []
StyleDataMap	rtf_Style

Typedef Documentation

StyleDataMap

using StyleDataMap = std::map<std::string,StyleData>

Definition at line 79 of file rtfstyle.h.

Function Documentation

loadExtensions()

void loadExtensions

(

const QCString &

name

)

Definition at line 364 of file rtfstyle.cpp.

{
  std::ifstream file(name.str());
  if (!file.is_open())
  {
    err("Can't open RTF extensions file {}. Using defaults.\n",name);
    return;
  }
  msg("Loading RTF extensions {}...\n",name);
 
  uint32_t lineNr=1;
 
  for (std::string line ; getline(file,line) ; ) // for each line
  {
    if (line.empty() || line[0]=='#') continue; // skip blanks & comments
    static const reg::Ex assignment_splitter(R"(\s*=\s*)");
    reg::Match match;
    if (reg::search(line,match,assignment_splitter))
    {
      std::string key   = match.prefix().str();
      std::string value = match.suffix().str();
      auto it = g_styleMap.find(key);
      if (it!=g_styleMap.end())
      {
        it->second = value;
      }
      else
      {
        warn(name,lineNr,"Ignoring unknown extension key '{}'...",key);
      }
    }
    else
    {
      warn(name,lineNr,"Assignment of style sheet name expected!");
    }
    lineNr++;
  }
}

References err, g_styleMap, msg, reg::search(), QCString::str(), and warn.

Referenced by RTFGenerator::init().

loadStylesheet()

void loadStylesheet	(	const QCString &	name,
		StyleDataMap &	map )

Definition at line 322 of file rtfstyle.cpp.

{
  std::ifstream file(name.str());
  if (!file.is_open())
  {
    err("Can't open RTF style sheet file {}. Using defaults.\n",name);
    return;
  }
  msg("Loading RTF style sheet {}...\n",name);
 
  uint32_t lineNr=1;
 
  for (std::string line ; getline(file,line) ; ) // for each line
  {
    if (line.empty() || line[0]=='#') continue; // skip blanks & comments
    static const reg::Ex assignment_splitter(R"(\s*=\s*)");
    reg::Match match;
    if (reg::search(line,match,assignment_splitter))
    {
      QCString key   = match.prefix().str();
      QCString value = match.suffix().str();
      auto it = map.find(key.str());
      if (it!=map.end())
      {
        StyleData& styleData = it->second;
        styleData.setStyle(value,key);
      }
      else
      {
        warn(name,lineNr,"Unknown style sheet name {} ignored.",key);
      }
    }
    else
    {
      warn(name,lineNr,"Assignment of style sheet name expected line='{}'!",line);
    }
    lineNr++;
  }
}

References err, msg, reg::search(), StyleData::setStyle(), QCString::str(), and warn.

Referenced by RTFGenerator::init().

Variable Documentation

rtf_author

QCString rtf_author

extern

Definition at line 28 of file rtfstyle.cpp.

Referenced by RTFGenerator::endIndexSection(), and RTFGenerator::startIndexSection().

rtf_comments

QCString rtf_comments

extern

Definition at line 25 of file rtfstyle.cpp.

Referenced by RTFGenerator::startIndexSection().

rtf_company

QCString rtf_company

extern

Definition at line 26 of file rtfstyle.cpp.

Referenced by RTFGenerator::endIndexSection(), and RTFGenerator::startIndexSection().

rtf_documentId

QCString rtf_documentId

extern

Definition at line 31 of file rtfstyle.cpp.

Referenced by RTFGenerator::endIndexSection().

rtf_documentType

QCString rtf_documentType

extern

Definition at line 30 of file rtfstyle.cpp.

Referenced by RTFGenerator::endIndexSection(), and RTFGenerator::startIndexSection().

rtf_keywords

QCString rtf_keywords

extern

Definition at line 32 of file rtfstyle.cpp.

Referenced by RTFGenerator::startIndexSection().

rtf_logoFilename

QCString rtf_logoFilename

extern

Definition at line 27 of file rtfstyle.cpp.

Referenced by RTFGenerator::endIndexSection(), and RTFGenerator::init().

rtf_manager

QCString rtf_manager

extern

Definition at line 29 of file rtfstyle.cpp.

Referenced by RTFGenerator::startIndexSection().

rtf_pageWidth

const int rtf_pageWidth = 8748

Definition at line 26 of file rtfstyle.h.

Referenced by RTFDocVisitor::operator()(), RTFDocVisitor::operator()(), RTFGenerator::startDescTable(), and RTFGenerator::startMemberDocSimple().

rtf_Style

StyleDataMap rtf_Style

extern

Definition at line 362 of file rtfstyle.cpp.

Referenced by RTFGenerator::beginRTFChapter(), RTFGenerator::beginRTFDocument(), RTFGenerator::beginRTFSection(), RTFGenerator::endIndexSection(), RTFDocVisitor::getStyle(), RTFGenerator::init(), RTFGenerator::lastIndexPage(), RTFDocVisitor::operator()(), RTFDocVisitor::operator()(), RTFDocVisitor::operator()(), RTFDocVisitor::operator()(), RTFDocVisitor::operator()(), RTFDocVisitor::operator()(), RTFDocVisitor::operator()(), RTFGenerator::rtf_BList_DepthStyle(), RTFGenerator::rtf_CList_DepthStyle(), RTFCodeGenerator::rtf_Code_DepthStyle(), RTFGenerator::rtf_DList_DepthStyle(), RTFGenerator::rtf_EList_DepthStyle(), RTFGenerator::rtf_LCList_DepthStyle(), RTFGenerator::startCompoundTemplateParams(), RTFGenerator::startDescTable(), RTFGenerator::startDescTableInit(), RTFGenerator::startDescTableTitle(), RTFGenerator::startGroupHeader(), RTFGenerator::startInlineHeader(), RTFGenerator::startMemberDoc(), RTFGenerator::startMemberDocSimple(), RTFGenerator::startMemberGroupHeader(), RTFGenerator::startSection(), RTFGenerator::startTextBlock(), RTFGenerator::startTitleHead(), and RTFGenerator::writeInheritedSectionTitle().

rtf_Style_Default

Rtf_Style_Default rtf_Style_Default[]

extern

Definition at line 88 of file rtfstyle.cpp.

                                      {
  { "Heading1",
    "\\s1\\sb240\\sa60\\keepn\\widctlpar\\adjustright \\b\\f1\\fs36\\kerning36\\cgrid ",
    "\\sbasedon0 \\snext0 heading 1"
  },
  { "Heading2",
    "\\s2\\sb240\\sa60\\keepn\\widctlpar\\adjustright \\b\\f1\\fs28\\kerning28\\cgrid ",
    "\\sbasedon0 \\snext0 heading 2"
  },
  { "Heading3",
    "\\s3\\sb240\\sa60\\keepn\\widctlpar\\adjustright \\b\\f1\\cgrid ",
    "\\sbasedon0 \\snext0 heading 3"
  },
  { "Heading4",
    "\\s4\\sb240\\sa60\\keepn\\widctlpar\\adjustright \\b\\f1\\fs20\\cgrid ",
    "\\sbasedon0 \\snext0 heading 4;}{\\*\\cs10 \\additive Default Paragraph Font"
  },
  { "Heading5",
    "\\s5\\sb90\\sa30\\keepn\\widctlpar\\adjustright \\b\\f1\\fs16\\cgrid ",
    "\\sbasedon0 \\snext0 heading 5;}{\\*\\cs10 \\additive Default Paragraph Font"
  },
  { "Heading6",
    "\\s6\\sb90\\sa30\\keepn\\widctlpar\\adjustright \\b\\f1\\fs12\\cgrid ",
    "\\sbasedon0 \\snext0 heading 6;}{\\*\\cs10 \\additive Default Paragraph Font"
  },
  { "Title",
    "\\s15\\qc\\sb240\\sa60\\widctlpar\\outlinelevel0\\adjustright \\b\\f1\\fs32\\kerning28\\cgrid ",
    "\\sbasedon0 \\snext15 Title"
  },
  { "SubTitle",
    "\\s16\\qc\\sa60\\widctlpar\\outlinelevel1\\adjustright \\f1\\cgrid ",
    "\\sbasedon0 \\snext16 Subtitle"
  },
  { "BodyText",
    "\\s17\\sa60\\sb30\\widctlpar\\qj \\fs22\\cgrid ",
    "\\sbasedon0 \\snext17 BodyText"
  },
  { "DenseText",
    "\\s18\\widctlpar\\fs22\\cgrid ",
    "\\sbasedon0 \\snext18 DenseText"
  },
  { "Header",
    "\\s28\\widctlpar\\tqc\\tx4320\\tqr\\tx8640\\adjustright \\fs20\\cgrid ",
    "\\sbasedon0 \\snext28 header"
  },
  { "Footer",
    "\\s29\\widctlpar\\tqc\\tx4320\\tqr\\tx8640\\qr\\adjustright \\fs20\\cgrid ",
    "\\sbasedon0 \\snext29 footer"
  },
  { "GroupHeader",
    "\\s30\\li360\\sa60\\sb120\\keepn\\widctlpar\\adjustright \\b\\f1\\fs20\\cgrid ",
    "\\sbasedon0 \\snext30 GroupHeader"
  },
 
  RTF_CodeExample( 0, 40, 41,   0),
  RTF_CodeExample( 1, 41, 42, 360),
  RTF_CodeExample( 2, 42, 43, 720),
  RTF_CodeExample( 3, 43, 44,1080),
  RTF_CodeExample( 4, 44, 45,1440),
  RTF_CodeExample( 5, 45, 46,1800),
  RTF_CodeExample( 6, 46, 47,2160),
  RTF_CodeExample( 7, 47, 48,2520),
  RTF_CodeExample( 8, 48, 49,2880),
  RTF_CodeExample( 9, 49, 50,3240),
  RTF_CodeExample(10, 50, 51,3600),
  RTF_CodeExample(11, 51, 52,3960),
  RTF_CodeExample(12, 52, 53,4320),
  RTF_CodeExample(13, 53, 53,4680),
 
  RTF_ListContinue( 0, 60, 61,   0),
  RTF_ListContinue( 1, 61, 62, 360),
  RTF_ListContinue( 2, 62, 63, 720),
  RTF_ListContinue( 3, 63, 64,1080),
  RTF_ListContinue( 4, 64, 65,1440),
  RTF_ListContinue( 5, 65, 66,1800),
  RTF_ListContinue( 6, 66, 67,2160),
  RTF_ListContinue( 7, 67, 68,2520),
  RTF_ListContinue( 8, 68, 69,2880),
  RTF_ListContinue( 9, 69, 70,3240),
  RTF_ListContinue(10, 70, 71,3600),
  RTF_ListContinue(11, 71, 72,3960),
  RTF_ListContinue(12, 72, 73,4320),
  RTF_ListContinue(13, 73, 73,4680),
 
  RTF_DescContinue( 0, 80, 81,   0),
  RTF_DescContinue( 1, 81, 82, 360),
  RTF_DescContinue( 2, 82, 83, 720),
  RTF_DescContinue( 3, 83, 84,1080),
  RTF_DescContinue( 4, 84, 85,1440),
  RTF_DescContinue( 5, 85, 86,1800),
  RTF_DescContinue( 6, 86, 87,2160),
  RTF_DescContinue( 7, 87, 88,2520),
  RTF_DescContinue( 8, 88, 89,2880),
  RTF_DescContinue( 9, 89, 90,3240),
  RTF_DescContinue(10, 90, 91,3600),
  RTF_DescContinue(11, 91, 92,3960),
  RTF_DescContinue(12, 92, 93,4320),
  RTF_DescContinue(13, 93, 93,4680),
 
  RTF_LatexToc( 0,100,101,   0,30),
  RTF_LatexToc( 1,101,102, 360,27),
  RTF_LatexToc( 2,102,103, 720,24),
  RTF_LatexToc( 3,103,104,1080,21),
  RTF_LatexToc( 4,104,105,1440,18),
  RTF_LatexToc( 5,105,106,1800,15),
  RTF_LatexToc( 6,106,107,2160,12),
  RTF_LatexToc( 7,107,108,2520, 9),
  RTF_LatexToc( 8,108,109,2880, 6),
  RTF_LatexToc( 9,109,110,3240, 3),
  RTF_LatexToc(10,110,111,3600, 3),
  RTF_LatexToc(11,111,112,3960, 3),
  RTF_LatexToc(12,112,113,4320, 3),
  RTF_LatexToc(13,113,113,4680, 3),
 
  RTF_ListBullet( 0,120,121, 360, 1),
  RTF_ListBullet( 1,121,122, 720, 2),
  RTF_ListBullet( 2,122,123,1080, 3),
  RTF_ListBullet( 3,123,124,1440, 4),
  RTF_ListBullet( 4,124,125,1800, 5),
  RTF_ListBullet( 5,125,126,2160, 6),
  RTF_ListBullet( 6,126,127,2520, 7),
  RTF_ListBullet( 7,127,128,2880, 8),
  RTF_ListBullet( 8,128,129,3240, 9),
  RTF_ListBullet( 9,129,130,3600,10),
  RTF_ListBullet(10,130,131,3960,11),
  RTF_ListBullet(11,131,132,4320,12),
  RTF_ListBullet(12,132,133,4680,13),
  RTF_ListBullet(13,133,133,5040,14),
 
  RTF_ListEnum( 0,140,141, 360),
  RTF_ListEnum( 1,141,142, 720),
  RTF_ListEnum( 2,142,143,1080),
  RTF_ListEnum( 3,143,144,1440),
  RTF_ListEnum( 4,144,145,1800),
  RTF_ListEnum( 5,145,146,2160),
  RTF_ListEnum( 6,146,147,2520),
  RTF_ListEnum( 7,147,148,2880),
  RTF_ListEnum( 8,148,149,3240),
  RTF_ListEnum( 9,149,150,3600),
  RTF_ListEnum(10,150,151,3960),
  RTF_ListEnum(11,151,152,4320),
  RTF_ListEnum(12,152,153,4680),
  RTF_ListEnum(13,153,153,5040),
 
  { nullptr,
    nullptr,
    nullptr
  }
};

Referenced by RTFGenerator::init(), and RTFGenerator::writeStyleSheetFile().

rtf_Style_Reset

char rtf_Style_Reset[]

extern

Definition at line 49 of file rtfstyle.cpp.

Referenced by RTFGenerator::beginRTFChapter(), RTFGenerator::beginRTFSection(), RTFGenerator::endCallGraph(), RTFGenerator::endClassDiagram(), RTFGenerator::endDirDepGraph(), RTFGenerator::endDotGraph(), RTFGenerator::endGroupHeader(), RTFGenerator::endInclDepGraph(), RTFGenerator::endIndexSection(), RTFGenerator::endMemberGroupHeader(), RTFGenerator::endTitleHead(), RTFDocVisitor::includePicturePreRTF(), RTFDocVisitor::operator()(), RTFDocVisitor::operator()(), RTFDocVisitor::operator()(), RTFDocVisitor::operator()(), RTFDocVisitor::operator()(), RTFDocVisitor::operator()(), RTFDocVisitor::operator()(), RTFDocVisitor::operator()(), RTFDocVisitor::operator()(), RTFDocVisitor::operator()(), RTFDocVisitor::operator()(), RTFDocVisitor::operator()(), RTFDocVisitor::operator()(), RTFDocVisitor::operator()(), RTFDocVisitor::operator()(), RTFDocVisitor::operator()(), RTFCodeGenerator::startCodeFragment(), RTFGenerator::startCompoundTemplateParams(), RTFGenerator::startConstraintList(), RTFGenerator::startDescTable(), RTFGenerator::startExamples(), RTFGenerator::startGroupHeader(), RTFGenerator::startIndent(), RTFGenerator::startIndexList(), RTFGenerator::startInlineHeader(), RTFGenerator::startItemListItem(), RTFGenerator::startMemberDescription(), RTFGenerator::startMemberDoc(), RTFGenerator::startMemberDocSimple(), RTFGenerator::startMemberGroup(), RTFGenerator::startMemberGroupHeader(), RTFGenerator::startMemberItem(), RTFGenerator::startMemberSubtitle(), RTFGenerator::startSection(), RTFGenerator::startTextBlock(), RTFGenerator::startTitleHead(), RTFGenerator::writeInheritedSectionTitle(), and RTFGenerator::writePageLink().

rtf_subject

QCString rtf_subject

extern

Definition at line 24 of file rtfstyle.cpp.

Referenced by RTFGenerator::startIndexSection().

rtf_Table_Default

Rtf_Table_Default rtf_Table_Default[]

extern

Definition at line 245 of file rtfstyle.cpp.

                                      {
  RTF_ListElement( 1,0, 360, 8226),
  RTF_ListElement( 1,1, 720, 9702),
  RTF_ListElement( 1,2,1080, 9642),
  RTF_ListElement( 1,3,1440, 8226),
  RTF_ListElement( 1,4,1800, 9702),
  RTF_ListElement( 1,5,2160, 9642),
  RTF_ListElement( 1,6,2520, 8662),
  RTF_ListElement( 1,7,2880, 9702),
  RTF_ListElement( 1,8,3600, 9642),
 
  RTF_ListElement( 2,0, 360, 9744),
  RTF_ListElement( 2,1, 720, 9744),
  RTF_ListElement( 2,2,1080, 9744),
  RTF_ListElement( 2,3,1440, 9744),
  RTF_ListElement( 2,4,1800, 9744),
  RTF_ListElement( 2,5,2160, 9744),
  RTF_ListElement( 2,6,2520, 9744),
  RTF_ListElement( 2,7,2880, 9744),
  RTF_ListElement( 2,8,3600, 9744),
 
  RTF_ListElement( 3,0, 360, 9746),
  RTF_ListElement( 3,1, 720, 9746),
  RTF_ListElement( 3,2,1080, 9746),
  RTF_ListElement( 3,3,1440, 9746),
  RTF_ListElement( 3,4,1800, 9746),
  RTF_ListElement( 3,5,2160, 9746),
  RTF_ListElement( 3,6,2520, 9746),
  RTF_ListElement( 3,7,2880, 9746),
  RTF_ListElement( 3,8,3600, 9746),
 
  { 0,
    0,
    nullptr,
    nullptr
  }
};

Referenced by RTFGenerator::beginRTFDocument(), and RTFDocVisitor::getListTable().

rtf_title

QCString rtf_title

extern

Definition at line 23 of file rtfstyle.cpp.

Referenced by RTFGenerator::endIndexSection().