rtfgen.cpp 68.8 KB
Newer Older
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1 2
/******************************************************************************
 *
3
 * 
Dimitri van Heesch's avatar
Dimitri van Heesch committed
4
 *
5
 * Copyright (C) 1997-2010 by Parker Waechter & Dimitri van Heesch.
Dimitri van Heesch's avatar
Dimitri van Heesch committed
6
 *
Dimitri van Heesch's avatar
Dimitri van Heesch committed
7 8
 * Style sheet additions by Alexander Bartolich
 *
Dimitri van Heesch's avatar
Dimitri van Heesch committed
9
 * Permission to use, copy, modify, and distribute this software and its
10 11
 * documentation under the terms of the GNU General Public License is hereby
 * granted. No representations are made about the suitability of this software
Dimitri van Heesch's avatar
Dimitri van Heesch committed
12 13 14
 * for any purpose. It is provided "as is" without express or implied warranty.
 * See the GNU General Public License for more details.
 *
Dimitri van Heesch's avatar
Dimitri van Heesch committed
15 16
 * Documents produced by Doxygen are derivative works derived from the
 * input used in their production; they are not affected by this license.
Dimitri van Heesch's avatar
Dimitri van Heesch committed
17 18 19 20 21 22 23
 *
 */

#include <stdlib.h>

#include "qtbc.h"
#include <qdir.h>
Dimitri van Heesch's avatar
Dimitri van Heesch committed
24
#include <qregexp.h>
Dimitri van Heesch's avatar
Dimitri van Heesch committed
25 26 27 28 29 30 31 32 33

#include "rtfgen.h"
#include "config.h"
#include "message.h"
#include "doxygen.h"
#include "util.h"
#include "diagram.h"
#include "language.h"
#include "dot.h"
34
#include "version.h"
35
#include "pagedef.h"
36
#include "rtfstyle.h"
37 38
#include "rtfdocvisitor.h"
#include "docparser.h"
39
#include "dirdef.h"
40
#include "vhdldocgen.h"
41

42 43
//#define DBG_RTF(x) x;
#define DBG_RTF(x)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
44 45 46 47 48 49

static QCString dateToRTFDateString()
{
  const QDateTime &d = QDateTime::currentDateTime();
  QCString result;
  result.sprintf("\\yr%d\\mo%d\\dy%d\\hr%d\\min%d\\sec%d",
50
      d.date().year(), d.date().month(), d.date().day(),
Dimitri van Heesch's avatar
Dimitri van Heesch committed
51 52
      d.time().hour(),d.time().minute(),d.time().second());
  return result;
53
} 
Dimitri van Heesch's avatar
Dimitri van Heesch committed
54 55 56

RTFGenerator::RTFGenerator() : OutputGenerator()
{
57
  dir=Config_getString("RTF_OUTPUT");
Dimitri van Heesch's avatar
Dimitri van Heesch committed
58 59 60 61 62
  col=0;
  //insideTabbing=FALSE;
  m_listLevel = 0;
  m_bstartedBody = FALSE;
  m_omitParagraph = FALSE;
63
  m_numCols = 0;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
64 65 66 67 68 69
}

RTFGenerator::~RTFGenerator()
{
}

70 71 72 73 74 75 76 77 78 79
//void RTFGenerator::append(const OutputGenerator *g)
//{
//  t << g->getContents();
//  col+=((RTFGenerator *)g)->col;
//  //insideTabbing=insideTabbing || ((RTFGenerator *)g)->insideTabbing;
//  m_listLevel=((RTFGenerator *)g)->m_listLevel;
//  m_omitParagraph=((RTFGenerator *)g)->m_omitParagraph;
//  //printf("RTFGenerator::append(%s) insideTabbing=%s\n", g->getContents().data(),
//  //    insideTabbing ? "TRUE" : "FALSE" );
//}
Dimitri van Heesch's avatar
Dimitri van Heesch committed
80

81 82 83 84 85 86 87 88
//OutputGenerator *RTFGenerator::copy()
//{
//  RTFGenerator *result = new RTFGenerator;
//  //result->insideTabbing=insideTabbing;
//  result->m_listLevel=m_listLevel;
//  result->m_omitParagraph=m_omitParagraph;
//  return result;
//}
Dimitri van Heesch's avatar
Dimitri van Heesch committed
89

90 91 92 93 94 95
void RTFGenerator::writeStyleSheetFile(QFile &file)
{
  QTextStream t(&file);
  t << "# Generated by doxygen " << versionString << "\n\n";
  t << "# This file describes styles used for generating RTF output.\n";
  t << "# All text after a hash (#) is considered a comment and will be ignored.\n";
96
  t << "# Remove a hash to activate a line.\n\n";
97 98

  int i;
99
  for ( i=0 ; rtf_Style_Default[i].reference!=0 ; i++ )
100
  {
101 102 103
    t << "# " << rtf_Style_Default[i].name << " = "
              << rtf_Style_Default[i].reference
              << rtf_Style_Default[i].definition << endl;
104 105 106
  }
}

107 108 109 110 111 112
void RTFGenerator::writeExtensionsFile(QFile &file)
{
  QTextStream t(&file);
  t << "# Generated by doxygen " << versionString << "\n\n";
  t << "# This file describes extensions used for generating RTF output.\n";
  t << "# All text after a hash (#) is considered a comment and will be ignored.\n";
113
  t << "# Remove a hash to activate a line.\n\n";
114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159

  t << "# Overrides the project title.\n";

  t << "#Title           = \n\n";

  t << "# Name of the company that produced this document.\n";
  t << "#Company         = \n\n";

  t << "# Filename of a company or project logo.\n";
  t << "#LogoFilename    = \n\n";

  t << "# Author of the document.\n";
  t << "#Author          = \n\n";

  t << "# Type of document (e.g. Design Specification, User Manual, etc.).\n";
  t << "#DocumentType    = \n\n";

  t << "# Document tracking number.\n";
  t << "#DocumentId      = \n\n";

  t << "# Name of the author's manager.\n";
  t << "# This field is not displayed in the document itself, but it is \n";
  t << "# available in the information block of the rtf file.  In Microsoft \n";
  t << "# Word, it is available under File:Properties.\n";
  t << "#Manager         = \n\n";

  t << "# Subject of the document.\n";
  t << "# This field is not displayed in the document itself, but it is \n";
  t << "# available in the information block of the rtf file.  In Microsoft \n";
  t << "# Word, it is available under File:Properties.\n";
  t << "#Subject         = \n\n";

  t << "# Comments regarding the document.\n";
  t << "# This field is not displayed in the document itself, but it is \n";
  t << "# available in the information block of the rtf file.  In Microsoft \n";
  t << "# Word, it is available under File:Properties.\n";
  t << "#Comments        = \n\n";

  t << "# Keywords associated with the document.\n";
  t << "# This field is not displayed in the document itself, but it is \n";
  t << "# available in the information block of the rtf file.  In Microsoft \n";
  t << "# Word, it is available under File:Properties.\n";
  t << "#Keywords        = \n\n";
}


Dimitri van Heesch's avatar
Dimitri van Heesch committed
160 161
void RTFGenerator::init()
{
162
  QCString dir=Config_getString("RTF_OUTPUT");
Dimitri van Heesch's avatar
Dimitri van Heesch committed
163 164 165 166 167 168
  QDir d(dir);
  if (!d.exists() && !d.mkdir(dir))
  {
    err("Could not create output directory %s\n",dir.data());
    exit(1);
  }
169
  rtf_Style.setAutoDelete(TRUE);
Dimitri van Heesch's avatar
Dimitri van Heesch committed
170

171 172
  // first duplicate strings of rtf_Style_Default
  const struct Rtf_Style_Default* def = rtf_Style_Default;
173
  while(def->reference != 0)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
174
  {
175
    if (def->definition == 0)
176
      err("Internal error: rtf_Style_Default[%s] has no definition.\n", def->name);
177
    StyleData* styleData = new StyleData(def->reference, def->definition);
178
    rtf_Style.insert(def->name, styleData);
179
    def++;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
180 181
  }

182
  // overwrite some (or all) definitions from file
183
  QCString &rtfStyleSheetFile = Config_getString("RTF_STYLESHEET_FILE");
184 185
  if (!rtfStyleSheetFile.isEmpty())
  {
186
    loadStylesheet(rtfStyleSheetFile, rtf_Style);
187
  }
188 189

  // If user has defined an extension file, load its contents.
190
  QCString &rtfExtensionsFile = Config_getString("RTF_EXTENSIONS_FILE");
191
  if (!rtfExtensionsFile.isEmpty())
192
  {
193
    loadExtensions(rtfExtensionsFile);
194
  }
195 196

  createSubDirs(d);
Dimitri van Heesch's avatar
Dimitri van Heesch committed
197 198
}

Dimitri van Heesch's avatar
Dimitri van Heesch committed
199 200 201 202 203 204
static QCString makeIndexName(const char *s,int i)
{
  QCString result=s;
  result+=(char)(i+'0');
  return result;
}
Dimitri van Heesch's avatar
Dimitri van Heesch committed
205 206 207 208 209 210

void RTFGenerator::beginRTFDocument()
{
  /* all the included RTF files should begin with the
   * same header
   */
211 212
  t <<"{\\rtf1\\ansi\\ansicpg" << theTranslator->trRTFansicp();
  t <<"\\uc1 \\deff0\\deflang1033\\deflangfe1033\n";
Dimitri van Heesch's avatar
Dimitri van Heesch committed
213

214
  DBG_RTF(t <<"{\\comment Begining font list}\n")
Dimitri van Heesch's avatar
Dimitri van Heesch committed
215
  t <<"{\\fonttbl ";
216 217 218 219 220 221
  t <<"{\\f0\\froman\\fcharset" << theTranslator->trRTFCharSet();
  t <<"\\fprq2{\\*\\panose 02020603050405020304}Times New Roman;}\n";
  t <<"{\\f1\\fswiss\\fcharset" << theTranslator->trRTFCharSet();
  t <<"\\fprq2{\\*\\panose 020b0604020202020204}Arial;}\n";
  t <<"{\\f2\\fmodern\\fcharset" << theTranslator->trRTFCharSet();
  t <<"\\fprq1{\\*\\panose 02070309020205020404}Courier New;}\n";
Dimitri van Heesch's avatar
Dimitri van Heesch committed
222 223
  t <<"{\\f3\\froman\\fcharset2\\fprq2{\\*\\panose 05050102010706020507}Symbol;}\n";
  t <<"}\n";
224
  DBG_RTF(t <<"{\\comment begin colors}\n")
Dimitri van Heesch's avatar
Dimitri van Heesch committed
225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242
  t <<"{\\colortbl;";
  t <<"\\red0\\green0\\blue0;";
  t <<"\\red0\\green0\\blue255;";
  t <<"\\red0\\green255\\blue255;";
  t <<"\\red0\\green255\\blue0;";
  t <<"\\red255\\green0\\blue255;";
  t <<"\\red255\\green0\\blue0;";
  t <<"\\red255\\green255\\blue0;";
  t <<"\\red255\\green255\\blue255;";
  t <<"\\red0\\green0\\blue128;";
  t <<"\\red0\\green128\\blue128;";
  t <<"\\red0\\green128\\blue0;";
  t <<"\\red128\\green0\\blue128;";
  t <<"\\red128\\green0\\blue0;";
  t <<"\\red128\\green128\\blue0;";
  t <<"\\red128\\green128\\blue128;";
  t <<"\\red192\\green192\\blue192;}" << endl;

243
  DBG_RTF(t <<"{\\comment Beginning style list}\n")
Dimitri van Heesch's avatar
Dimitri van Heesch committed
244 245
  t <<"{\\stylesheet\n";
  t <<"{\\widctlpar\\adjustright \\fs20\\cgrid \\snext0 Normal;}\n";
246 247 248 249

  // sort styles ascending by \s-number via an intermediate QArray
  QArray<const StyleData*> array(128);
  array.fill(0);
250
  QDictIterator<StyleData> iter(rtf_Style);
251 252
  const StyleData* style;
  for(; (style = iter.current()); ++iter)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
253
  {
254
    unsigned index = style->index;
255
    unsigned size = array.size();
256
    if (index >= size)
257
    {
258 259 260 261
      // +1 to add at least one element, then align up to multiple of 8
      array.resize((index + 1 + 7) & ~7);
      array.fill(0, size);
      ASSERT(index < array.size());
262
    }
263
    if (array.at(index) != 0)
264
    {
265
      QCString key(convertToQCString(iter.currentKey()));
266 267
      msg("Style '%s' redefines \\s%d.\n", key.data(), index);
    }
268
    array.at(index) = style;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
269
  }
270 271 272 273

  // write array elements
  unsigned size = array.size();
  for(unsigned i = 0; i < size; i++)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
274
  {
275 276 277
    const StyleData* style = array.at(i);
    if (style != 0)
      t <<"{" << style->reference << style->definition << ";}\n";
Dimitri van Heesch's avatar
Dimitri van Heesch committed
278
  }
279

Dimitri van Heesch's avatar
Dimitri van Heesch committed
280
  t <<"}" << endl;
281
  // this comment is needed for postprocessing!
Dimitri van Heesch's avatar
Dimitri van Heesch committed
282 283 284 285 286 287
  t <<"{\\comment begin body}" << endl;

}

void RTFGenerator::beginRTFChapter()
{
288
  t <<"\n";
289
  DBG_RTF(t << "{\\comment BeginRTFChapter}\n")
290
  t << rtf_Style_Reset;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
291 292

  // if we are compact, no extra page breaks...
293
  if (Config_getBool("COMPACT_RTF"))
Dimitri van Heesch's avatar
Dimitri van Heesch committed
294
  {
295
    //      t <<"\\sect\\sectd\\sbknone\n";
Dimitri van Heesch's avatar
Dimitri van Heesch committed
296
    t <<"\\sect\\sbknone\n";
297
    rtfwriteRuler_thick();
Dimitri van Heesch's avatar
Dimitri van Heesch committed
298 299 300 301 302
  }
  else
    t <<"\\sect\\sbkpage\n";
  //t <<"\\sect\\sectd\\sbkpage\n";

303
  t << rtf_Style["Heading1"]->reference << "\n";
Dimitri van Heesch's avatar
Dimitri van Heesch committed
304 305 306 307
}

void RTFGenerator::beginRTFSection()
{
308
  t <<"\n";
309
  DBG_RTF(t << "{\\comment BeginRTFSection}\n")
310
  t << rtf_Style_Reset;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
311 312

  // if we are compact, no extra page breaks...
313
  if (Config_getBool("COMPACT_RTF"))
Dimitri van Heesch's avatar
Dimitri van Heesch committed
314
  {
315
    //      t <<"\\sect\\sectd\\sbknone\n";
Dimitri van Heesch's avatar
Dimitri van Heesch committed
316
    t <<"\\sect\\sbknone\n";
317
    rtfwriteRuler_emboss();
Dimitri van Heesch's avatar
Dimitri van Heesch committed
318 319 320 321 322
  }
  else
    t <<"\\sect\\sbkpage\n";
  //t <<"\\sect\\sectd\\sbkpage\n";

323
  t << rtf_Style["Heading2"]->reference << "\n";
Dimitri van Heesch's avatar
Dimitri van Heesch committed
324 325
}

326
void RTFGenerator::startFile(const char *name,const char *,const char *)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
327
{
328
  setEncoding(QCString().sprintf("CP%s",theTranslator->trRTFansicp().data()));
Dimitri van Heesch's avatar
Dimitri van Heesch committed
329
  QCString fileName=name;
330
  relPath = relativePathToRoot(fileName);
Dimitri van Heesch's avatar
Dimitri van Heesch committed
331 332 333 334 335 336 337 338

  if (fileName.right(4)!=".rtf" ) fileName+=".rtf";
  startPlainFile(fileName);
  beginRTFDocument();
}

void RTFGenerator::endFile()
{
339
  DBG_RTF(t << "{\\comment endFile}\n")
Dimitri van Heesch's avatar
Dimitri van Heesch committed
340 341 342 343 344 345 346
  t << "}";

  endPlainFile();
}

void RTFGenerator::startProjectNumber()
{
347
  DBG_RTF(t <<"{\\comment startProjectNumber }" << endl)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
348 349 350
  t << " ";
}

351
void RTFGenerator::endProjectNumber()
Dimitri van Heesch's avatar
Dimitri van Heesch committed
352
{
353
  DBG_RTF(t <<"{\\comment endProjectNumber }" << endl)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
354 355 356 357
}

void RTFGenerator::startIndexSection(IndexSections is)
{
358
  //QCString paperName;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
359 360 361 362 363 364 365 366

  m_listLevel = 0;

  switch (is)
  {
    case isTitlePageStart:
      // basic RTFstart
      // get readyfor author etc
367

Dimitri van Heesch's avatar
Dimitri van Heesch committed
368
      t << "{\\info \n";
369
      t << "{\\title {\\comment ";
Dimitri van Heesch's avatar
Dimitri van Heesch committed
370 371
      break;
    case isTitlePageAuthor:
372
      t << "}\n";
373 374 375 376 377 378 379
      if (rtf_subject)      t << "{\\subject "  << rtf_subject      << "}\n";
      if (rtf_comments)     t << "{\\comment "  << rtf_comments     << "}\n";
      if (rtf_company)      t << "{\\company "  << rtf_company      << "}\n";
      if (rtf_author)       t << "{\\author "   << rtf_author       << "}\n";
      if (rtf_manager)      t << "{\\manager "  << rtf_manager      << "}\n";
      if (rtf_documentType) t << "{\\category " << rtf_documentType << "}\n";
      if (rtf_keywords)     t << "{\\keywords " << rtf_keywords     << "}\n";
380
      t << "{\\comment ";
Dimitri van Heesch's avatar
Dimitri van Heesch committed
381 382 383 384 385
      break;
    case isMainPage:
      //Introduction
      beginRTFChapter();
      break;
386 387 388 389
    //case isPackageIndex:
    //  //Package Index
    //  beginRTFChapter();
    //  break;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
390 391 392 393
    case isModuleIndex:
      //Module Index
      beginRTFChapter();
      break;
394 395 396 397
    case isDirIndex:
      //Directory Index
      beginRTFChapter();
      break;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
398 399
    case isNamespaceIndex:
      //Namespace Index
400
      beginRTFChapter();
Dimitri van Heesch's avatar
Dimitri van Heesch committed
401 402 403
      break;
    case isClassHierarchyIndex:
      //Hierarchical Index
404
      DBG_RTF(t << "{\\comment start classhierarchy}\n")
Dimitri van Heesch's avatar
Dimitri van Heesch committed
405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421
      beginRTFChapter();
      break;
    case isCompoundIndex:
      //Annotated Compound Index
      beginRTFChapter();
      break;
    case isFileIndex:
      //Annotated File Index
      beginRTFChapter();
      break;
    case isPageIndex:
      //Related Page Index
      beginRTFChapter();
      break;
    case isModuleDocumentation:
      {
        //Module Documentation
422
        GroupSDict::Iterator gli(*Doxygen::groupSDict);
423
        GroupDef *gd;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
424
        bool found=FALSE;
425
        for (gli.toFirst();(gd=gli.current()) && !found;++gli)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
426
        {
427 428 429 430 431
          if (!gd->isReference())
          {
            beginRTFChapter();
            found=TRUE;
          }
Dimitri van Heesch's avatar
Dimitri van Heesch committed
432 433 434
        }
      }
      break;
435 436 437
    case isDirDocumentation:
      {
        //Directory Documentation
438
        SDict<DirDef>::Iterator dli(*Doxygen::directories);
439 440 441 442 443 444 445 446 447 448 449 450
        DirDef *dd;
        bool found=FALSE;
        for (dli.toFirst();(dd=dli.current()) && !found;++dli)
        {
          if (dd->isLinkableInProject())
          {
            beginRTFChapter();
            found=TRUE;
          }
        }
      }
      break;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
451 452 453
    case isNamespaceDocumentation:
      {
        // Namespace Documentation
454
        NamespaceSDict::Iterator nli(*Doxygen::namespaceSDict);
455
        NamespaceDef *nd;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
456
        bool found=FALSE;
457
        for (nli.toFirst();(nd=nli.current()) && !found;++nli)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
458
        {
459
          if (nd->isLinkableInProject())
Dimitri van Heesch's avatar
Dimitri van Heesch committed
460 461 462 463
          {
            beginRTFChapter();
            found=TRUE;
          }
464
        }
Dimitri van Heesch's avatar
Dimitri van Heesch committed
465 466 467 468 469
      }
      break;
    case isClassDocumentation:
      {
        //Compound Documentation
470
        ClassSDict::Iterator cli(*Doxygen::classSDict);
Dimitri van Heesch's avatar
Dimitri van Heesch committed
471
        ClassDef *cd=0;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
472
        bool found=FALSE;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
473
        for (cli.toFirst();(cd=cli.current()) && !found;++cli)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
474
        {
Dimitri van Heesch's avatar
Dimitri van Heesch committed
475
          if (cd->isLinkableInProject() && cd->templateMaster()==0)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
476 477 478 479 480 481 482 483 484 485 486
          {
            beginRTFChapter();
            found=TRUE;
          }
        }
      }
      break;
    case isFileDocumentation:
      {
        //File Documentation
        bool isFirst=TRUE;
487
        FileName *fn=Doxygen::inputNameList->first();
Dimitri van Heesch's avatar
Dimitri van Heesch committed
488 489 490 491 492 493 494 495 496
        while (fn)
        {
          FileDef *fd=fn->first();
          while (fd)
          {
            if (fd->isLinkableInProject())
            {
              if (isFirst)
              {
497
                beginRTFChapter();
Dimitri van Heesch's avatar
Dimitri van Heesch committed
498 499 500 501 502 503
                isFirst=FALSE;
                break;
              }
            }
            fd=fn->next();
          }
504
          fn=Doxygen::inputNameList->next();
Dimitri van Heesch's avatar
Dimitri van Heesch committed
505 506 507 508 509 510 511 512 513 514 515 516 517
        }
      }
      break;
    case isExampleDocumentation:
      {
        //Example Documentation
        beginRTFChapter();
      }
      break;
    case isPageDocumentation:
      {
        //Page Documentation
        beginRTFChapter();
518 519 520 521
      }
      break;
    case isPageDocumentation2:
      {
522
        t << "{\\tc \\v ";
Dimitri van Heesch's avatar
Dimitri van Heesch committed
523 524 525 526 527 528 529 530 531
      }
      break;
    case isEndIndex:
      break;
  }
}

void RTFGenerator::endIndexSection(IndexSections is)
{
532 533
  bool fortranOpt = Config_getBool("OPTIMIZE_FOR_FORTRAN");
  bool vhdlOpt    = Config_getBool("OPTIMIZE_OUTPUT_VHDL");  
Dimitri van Heesch's avatar
Dimitri van Heesch committed
534 535 536
  switch (is)
  {
    case isTitlePageStart:
537
      if (rtf_title)
538
        // User has overridden document title in extensions file
539
        t << "}" << rtf_title;
540
      else
541
        t << "}" << Config_getString("PROJECT_NAME");
Dimitri van Heesch's avatar
Dimitri van Heesch committed
542 543 544
      break;
    case isTitlePageAuthor:
      {
545 546 547
        t << "Doxgyen. }\n";
        t << "{\\creatim " << dateToRTFDateString() << "}\n}";
        DBG_RTF(t << "{\\comment end of infoblock}\n");
Dimitri van Heesch's avatar
Dimitri van Heesch committed
548
        // setup for this section
549
        t << rtf_Style_Reset <<"\n";
Dimitri van Heesch's avatar
Dimitri van Heesch committed
550
        t <<"\\sectd\\pgnlcrm\n";
551
        t <<"{\\footer "<<rtf_Style["Footer"]->reference << "{\\chpgn}}\n";
Dimitri van Heesch's avatar
Dimitri van Heesch committed
552
        // the title entry
553
        DBG_RTF(t << "{\\comment begin title page}\n")
554 555


556
        t << rtf_Style_Reset << rtf_Style["SubTitle"]->reference << endl; // set to title style
557

558
        t << "\\vertalc\\qc\\par\\par\\par\\par\\par\\par\\par\n";
559
        if (rtf_logoFilename)
560
        {
561 562
          t << "{\\field\\flddirty {\\*\\fldinst INCLUDEPICTURE \"" << rtf_logoFilename;
          t << "\" \\\\d \\\\*MERGEFORMAT} {\\fldrslt IMAGE }}\\par\\par\n";
563
        }
564
        if (rtf_company)
565
        {
566
          t << rtf_company << "\\par\\par\n";
567 568
        }

569
        t << rtf_Style_Reset << rtf_Style["Title"]->reference << endl; // set to title style
Dimitri van Heesch's avatar
Dimitri van Heesch committed
570
        t << "{\\field\\fldedit {\\*\\fldinst TITLE \\\\*MERGEFORMAT}{\\fldrslt TITLE}}\\par" << endl;
571

572
        t << rtf_Style_Reset << rtf_Style["SubTitle"]->reference << endl; // set to title style
573
        t << "\\par\n";
574
        if (rtf_documentType)
575
        {
576
          t << rtf_documentType << "\\par\n";
577
        }
578
        if (rtf_documentId)
579
        {
580
          t << rtf_documentId << "\\par\n";
581 582
        }
        t << "\\par\\par\\par\\par\\par\\par\\par\\par\\par\\par\\par\\par\n";
583

584
        t << rtf_Style_Reset << rtf_Style["SubTitle"]->reference << endl; // set to subtitle style
Dimitri van Heesch's avatar
Dimitri van Heesch committed
585
        t << "{\\field\\fldedit {\\*\\fldinst AUTHOR \\\\*MERGEFORMAT}{\\fldrslt AUTHOR}}\\par" << endl;
586
        t << "Version " << Config_getString("PROJECT_NUMBER") << "\\par";
Dimitri van Heesch's avatar
Dimitri van Heesch committed
587 588
        t << "{\\field\\fldedit {\\*\\fldinst CREATEDATE \\\\*MERGEFORMAT}"
          "{\\fldrslt CREATEDATE}}\\par"<<endl;
589
        t << "\\page\\page";
590
        DBG_RTF(t << "{\\comment End title page}" << endl)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
591 592

        // table of contents section
593
        DBG_RTF(t << "{\\comment Table of contents}\n")
594
        t << "\\vertalt\n";
595 596
        t << rtf_Style_Reset << endl;
        t << rtf_Style["Heading1"]->reference;
597
        t << theTranslator->trRTFTableOfContents() << "\\par"<< endl;
598
        t << rtf_Style_Reset << "\\par" << endl;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
599
        t << "{\\field\\fldedit {\\*\\fldinst TOC \\\\f \\\\*MERGEFORMAT}{\\fldrslt Table of contents}}\\par\n";
600
        t << rtf_Style_Reset << endl;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
601 602 603
      }
      break;
    case isMainPage:
604
      t << "\\par " << rtf_Style_Reset << endl;
605
      if (!Doxygen::mainPage || Doxygen::mainPage->title().isEmpty())
606 607 608 609 610
      {
        t << "{\\tc \\v " << theTranslator->trMainPage() << "}"<< endl;
      }
      else
      {
611
        t << "{\\tc \\v " << substitute(Doxygen::mainPage->title(),"%","") << "}"<< endl;
612
      }
613
      t << "{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"";
614
      if (Config_getBool("GENERATE_TREEVIEW")) t << "main"; else t << "index";
615
      t << ".rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";
Dimitri van Heesch's avatar
Dimitri van Heesch committed
616
      break;
617
    //case isPackageIndex:
618
    //  t << "\\par " << rtf_Style_Reset << endl;
619 620 621
    //  t << "{\\tc \\v " << theTranslator->trPackageList() << "}"<< endl;
    //  t << "{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"packages.rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";
    //  break;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
622
    case isModuleIndex:
623
      t << "\\par " << rtf_Style_Reset << endl;
624
      t << "{\\tc \\v " << theTranslator->trModuleIndex() << "}"<< endl;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
625 626
      t << "{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"modules.rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";
      break;
627 628 629 630 631
    case isDirIndex:
      t << "\\par " << rtf_Style_Reset << endl;
      t << "{\\tc \\v " << theTranslator->trDirIndex() << "}"<< endl;
      t << "{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"dirs.rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";
      break;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
632
    case isNamespaceIndex:
633
      t << "\\par " << rtf_Style_Reset << endl;
634 635
      if (fortranOpt)
      {
636
          t << "{\\tc \\v " << theTranslator->trModulesIndex() << "}" << endl;
637 638 639
      }
      else
      {
640
          t << "{\\tc \\v " << theTranslator->trNamespaceIndex() << "}" << endl;
641 642
      }
      
Dimitri van Heesch's avatar
Dimitri van Heesch committed
643 644 645
      t << "{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"namespaces.rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";
      break;
    case isClassHierarchyIndex:
646
      t << "\\par " << rtf_Style_Reset << endl;
647
      t << "{\\tc \\v " << theTranslator->trHierarchicalIndex() << "}"<< endl;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
648 649 650
      t << "{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"hierarchy.rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";
      break;
    case isCompoundIndex:
651
      t << "\\par " << rtf_Style_Reset << endl;
652 653 654 655 656 657 658 659 660 661 662 663
      if (fortranOpt)
      {
        t << "{\\tc \\v " << theTranslator->trCompoundIndexFortran() << "}"<< endl;
      }
      else if (vhdlOpt)
      {
        t << "{\\tc \\v " << VhdlDocGen::trDesignUnitIndex() << "}"<< endl;
      }
      else
      {
        t << "{\\tc \\v " << theTranslator->trCompoundIndex() << "}"<< endl;
      }
Dimitri van Heesch's avatar
Dimitri van Heesch committed
664 665 666
      t << "{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"annotated.rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";
      break;
    case isFileIndex:
667
      t << "\\par " << rtf_Style_Reset << endl;
668
      t << "{\\tc \\v " << theTranslator->trFileIndex() << "}"<< endl;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
669 670 671
      t << "{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"files.rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";
      break;
    case isPageIndex:
672
      t << "\\par " << rtf_Style_Reset << endl;
673
      t << "{\\tc \\v " << theTranslator->trPageIndex() << "}"<< endl;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
674 675 676 677
      t << "{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"pages.rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";
      break;
    case isModuleDocumentation:
      {
678
        GroupSDict::Iterator gli(*Doxygen::groupSDict);
679
        GroupDef *gd;
680
        t << "{\\tc \\v " << theTranslator->trModuleDocumentation() << "}"<< endl;
681
        for (gli.toFirst();(gd=gli.current());++gli)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
682
        {
683 684
          if (!gd->isReference())
          {
685
            t << "\\par " << rtf_Style_Reset << endl;
686 687 688 689
            t << "{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"";
            t << gd->getOutputFileBase();
            t << ".rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";
          }
Dimitri van Heesch's avatar
Dimitri van Heesch committed
690 691 692
        }
      }
      break;
693 694
    case isDirDocumentation:
      {
695
        SDict<DirDef>::Iterator dli(*Doxygen::directories);
696 697 698 699 700 701 702 703 704 705 706 707 708 709
        DirDef *dd;
        t << "{\\tc \\v " << theTranslator->trDirDocumentation() << "}"<< endl;
        for (dli.toFirst();(dd=dli.current());++dli)
        {
          if (dd->isLinkableInProject())
          {
            t << "\\par " << rtf_Style_Reset << endl;
            t << "{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"";
            t << dd->getOutputFileBase();
            t << ".rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";
          }
        }
      }
      break;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
710 711
    case isNamespaceDocumentation:
      {
712
        NamespaceSDict::Iterator nli(*Doxygen::namespaceSDict);
713
        NamespaceDef *nd;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
714
        bool found=FALSE;
715
        for (nli.toFirst();(nd=nli.current()) && !found;++nli)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
716
        {
717
          if (nd->isLinkableInProject())
Dimitri van Heesch's avatar
Dimitri van Heesch committed
718
          {
719
            t << "\\par " << rtf_Style_Reset << endl;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
720 721 722 723 724 725
            t << "{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"";
            t << nd->getOutputFileBase();
            t << ".rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";
            found=TRUE;
          }
        }
726
        while ((nd=nli.current()))
Dimitri van Heesch's avatar
Dimitri van Heesch committed
727
        {
728
          if (nd->isLinkableInProject())
Dimitri van Heesch's avatar
Dimitri van Heesch committed
729
          {
730
            t << "\\par " << rtf_Style_Reset << endl;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
731 732 733 734 735
            beginRTFSection();
            t << "{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"";
            t << nd->getOutputFileBase();
            t << ".rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";
          }
736
          ++nli;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
737 738 739 740 741
        }
      }
      break;
    case isClassDocumentation:
      {
742
        ClassSDict::Iterator cli(*Doxygen::classSDict);
Dimitri van Heesch's avatar
Dimitri van Heesch committed
743
        ClassDef *cd=0;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
744
        bool found=FALSE;
745 746 747 748 749 750 751 752
        if (fortranOpt)
        {
          t << "{\\tc \\v " << theTranslator->trTypeDocumentation() << "}"<< endl;
        }
        else
        {
          t << "{\\tc \\v " << theTranslator->trClassDocumentation() << "}"<< endl;
        }
Dimitri van Heesch's avatar
Dimitri van Heesch committed
753
        for (cli.toFirst();(cd=cli.current()) && !found;++cli)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
754
        {
Dimitri van Heesch's avatar
Dimitri van Heesch committed
755
          if (cd->isLinkableInProject() && cd->templateMaster()==0)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
756
          {
757
            t << "\\par " << rtf_Style_Reset << endl;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
758 759 760 761 762 763
            t << "{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"";
            t << cd->getOutputFileBase();
            t << ".rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";
            found=TRUE;
          }
        }
Dimitri van Heesch's avatar
Dimitri van Heesch committed
764
        for (;(cd=cli.current());++cli)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
765
        {
Dimitri van Heesch's avatar
Dimitri van Heesch committed
766
          if (cd->isLinkableInProject() && cd->templateMaster()==0)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
767
          {
768
            t << "\\par " << rtf_Style_Reset << endl;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
769 770 771 772
            beginRTFSection();
            t << "{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"";
            t << cd->getOutputFileBase();
            t << ".rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";
773
          }
Dimitri van Heesch's avatar
Dimitri van Heesch committed
774 775 776 777 778 779
        }
      }
      break;
    case isFileDocumentation:
      {
        bool isFirst=TRUE;
780
        FileName *fn=Doxygen::inputNameList->first();
Dimitri van Heesch's avatar
Dimitri van Heesch committed
781

782
        t << "{\\tc \\v " << theTranslator->trFileDocumentation() << "}"<< endl;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
783 784 785 786 787 788 789 790 791
        while (fn)
        {
          FileDef *fd=fn->first();
          while (fd)
          {
            if (fd->isLinkableInProject())
            {
              if (isFirst)
              {
792
                t << "\\par " << rtf_Style_Reset << endl;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
793 794 795 796 797 798 799
                t << "{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"";
                t << fd->getOutputFileBase();
                t << ".rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";
                isFirst=FALSE;
              }
              else
              {
800
                t << "\\par " << rtf_Style_Reset << endl;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
801 802 803 804 805 806 807 808
                beginRTFSection();
                t << "{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"";
                t << fd->getOutputFileBase();
                t << ".rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";
              }
            }
            fd=fn->next();
          }
809
          fn=Doxygen::inputNameList->next();
Dimitri van Heesch's avatar
Dimitri van Heesch committed
810 811 812 813 814 815
        }
      }
      break;
    case isExampleDocumentation:
      {
        //t << "}\n";
816
        t << "{\\tc \\v " << theTranslator->trExampleDocumentation() << "}"<< endl;
817
        PageSDict::Iterator pdi(*Doxygen::exampleSDict);
818 819
        PageDef *pd=pdi.toFirst();
        if (pd)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
820
        {
821
          t << "\\par " << rtf_Style_Reset << endl;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
822
          t << "{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"";
823
          t << pd->getOutputFileBase();
824
          t << ".rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";
Dimitri van Heesch's avatar
Dimitri van Heesch committed
825
        }
826
        for (++pdi;(pd=pdi.current());++pdi)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
827
        {
828
          t << "\\par " << rtf_Style_Reset << endl;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
829 830
          beginRTFSection();
          t << "{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"";
831
          t << pd->getOutputFileBase();
832
          t << ".rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";
Dimitri van Heesch's avatar
Dimitri van Heesch committed
833 834 835 836 837
        }
      }
      break;
    case isPageDocumentation:
      {
838 839
//#error "fix me in the same way as the latex index..."
        //t << "{\\tc \\v " << theTranslator->trPageDocumentation() << "}"<< endl;
840
        //t << "}"<< endl;
841 842 843 844 845 846 847 848 849 850 851 852 853 854
        //PageSDict::Iterator pdi(*Doxygen::pageSDict);
        //PageDef *pd=pdi.toFirst();
        //bool first=TRUE;
        //for (pdi.toFirst();(pd=pdi.current());++pdi)
        //{
        //  if (!pd->getGroupDef() && !pd->isReference())
        //  {
        //    if (first) t << "\\par " << rtf_Style_Reset << endl;
        //    t << "{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"";
        //    t << pd->getOutputFileBase();
        //    t << ".rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";
        //    first=FALSE;
        //  }
        //}
Dimitri van Heesch's avatar
Dimitri van Heesch committed
855 856
      }
      break;
857 858 859 860 861 862
    case isPageDocumentation2:
      {
        t << "}";
        t << "\\par " << rtf_Style_Reset << endl;
      }
      break;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
863
    case isEndIndex:
864
      beginRTFChapter();
865
      t << rtf_Style["Heading1"]->reference;
866
      t << theTranslator->trRTFGeneralIndex() << "\\par "<< endl;
867
      t << rtf_Style_Reset << endl;
868
      t << "{\\tc \\v " << theTranslator->trRTFGeneralIndex() << "}" << endl;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
869 870 871 872 873 874
      t << "{\\field\\fldedit {\\*\\fldinst INDEX \\\\c2 \\\\*MERGEFORMAT}{\\fldrslt INDEX}}\n";

      break;
   }
}

875 876 877 878 879 880 881 882
void RTFGenerator::writePageLink(const char *name,bool first)
{
   if (first) t << "\\par " << rtf_Style_Reset << endl;
   t << "{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"";
   t << name;
   t << ".rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";
}

Dimitri van Heesch's avatar
Dimitri van Heesch committed
883 884
void RTFGenerator::lastIndexPage()
{
885
  DBG_RTF(t <<"{\\comment Beginning Body of RTF Document}\n")
Dimitri van Heesch's avatar
Dimitri van Heesch committed
886
  // end page and setup for rest of document
887 888
  t <<"\\sect \\sbkpage \\pgndec \\pgnrestart\n";
  t <<"\\sect \\sectd \\sbknone\n";
Dimitri van Heesch's avatar
Dimitri van Heesch committed
889

890
  // set new footer with arabic numbers
891 892
  t <<"{\\footer "<< rtf_Style["Footer"]->reference << "{\\chpgn}}\n";
  //t << rtf_Style["Heading1"]->reference << "\n";
Dimitri van Heesch's avatar
Dimitri van Heesch committed
893 894 895 896 897 898 899

}

void RTFGenerator::writeStyleInfo(int)
{
}

Dimitri van Heesch's avatar
Dimitri van Heesch committed
900
void RTFGenerator::lineBreak(const char *)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
901
{
902
  DBG_RTF(t << "{\\comment (lineBreak)}"    << endl)
903
  t << "\\par" << endl;
904
  m_omitParagraph = TRUE;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
905 906 907 908 909 910 911
}

void RTFGenerator::writeString(const char *text)
{
  t << text;
}

912 913
void RTFGenerator::startIndexList()
{
914
  DBG_RTF(t << "{\\comment (startIndexList)}" << endl)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
915
  t << "{" << endl;
916
  t << "\\par" << endl;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
917
  incrementIndentLevel();
918
  t << rtf_Style_Reset << rtf_LCList_DepthStyle() << endl;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
919
  m_omitParagraph = TRUE;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
920 921 922
}

void RTFGenerator::endIndexList()
923
{
924
  DBG_RTF(t << "{\\comment (endIndexList)}" << endl)
925 926 927 928 929
  if (!m_omitParagraph)
  {
    t << "\\par";
    m_omitParagraph = TRUE;
  }
Dimitri van Heesch's avatar
Dimitri van Heesch committed
930 931 932 933 934
  t << "}";
  decrementIndentLevel();
}

/*! start bullet list */
935 936
void RTFGenerator::startItemList()
{
937
  newParagraph();
938
  DBG_RTF(t << "{\\comment (startItemList level=" << m_listLevel << ") }" << endl)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
939 940
  t << "{";
  incrementIndentLevel();
941
  rtf_listItemInfo[m_listLevel].isEnum = FALSE;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
942 943 944
}

/*! end bullet list */
945 946
void RTFGenerator::endItemList()
{
Dimitri van Heesch's avatar
Dimitri van Heesch committed
947
  newParagraph();
948
  DBG_RTF(t << "{\\comment (endItemList level=" << m_listLevel << ")}" << endl)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
949 950
  t << "}";
  decrementIndentLevel();
Dimitri van Heesch's avatar
Dimitri van Heesch committed
951
  m_omitParagraph = TRUE;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
952 953
}

954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972
///*! start enumeration list */
//void RTFGenerator::startEnumList()  // starts an enumeration list
//{
//  DBG_RTF(t << "{\\comment (startEnumList)}" << endl)
//  t << "{" << endl;
//  incrementIndentLevel();
//  rtf_listItemInfo[m_listLevel].isEnum = TRUE;
//  rtf_listItemInfo[m_listLevel].number = 1;
//}
//
///*! end enumeration list */
//void RTFGenerator::endEnumList()
//{
//  newParagraph();
//  DBG_RTF(t << "{\\comment (endEnumList)}" << endl)
//  t << "}";
//  decrementIndentLevel();
//  m_omitParagraph = TRUE;
//}
Dimitri van Heesch's avatar
Dimitri van Heesch committed
973 974

/*! write bullet or enum item */
975
void RTFGenerator::startItemListItem()
Dimitri van Heesch's avatar
Dimitri van Heesch committed
976
{
977
  DBG_RTF(t << "{\\comment (startItemListItem)}" << endl)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
978
  newParagraph();
979
  t << rtf_Style_Reset;
980
  if (rtf_listItemInfo[m_listLevel].isEnum)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
981
  {
982
    t << rtf_EList_DepthStyle() << endl;
983 984
    t << rtf_listItemInfo[m_listLevel].number << ".\\tab ";
    rtf_listItemInfo[m_listLevel].number++;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
985 986 987
  }
  else
  {
988
    t << rtf_BList_DepthStyle() << endl;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
989
  }
Dimitri van Heesch's avatar
Dimitri van Heesch committed
990
  m_omitParagraph = TRUE;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
991 992
}

993 994 995 996 997
void RTFGenerator::endItemListItem()
{
  DBG_RTF(t << "{\\comment (endItemListItem)}" << endl)
}

998
void RTFGenerator::startIndexItem(const char *,const char *)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
999
{
1000
  DBG_RTF(t << "{\\comment (startIndexItem)}" << endl)
1001 1002 1003 1004 1005 1006

  if (!m_omitParagraph)
  {
    t << "\\par" << endl;
    m_omitParagraph = TRUE;
  }
1007 1008 1009 1010 1011
}

void RTFGenerator::endIndexItem(const char *ref,const char *fn)
{
  DBG_RTF(t << "{\\comment (endIndexItem)}" << endl)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1012 1013 1014
  if (!ref && fn)
  {
    t << "\\tab ";
1015
    writeRTFReference(fn);
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1016 1017 1018 1019
    t << endl;
  }
  else
  {
1020
    t << endl;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1021
  }
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1022
  m_omitParagraph = TRUE;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1023 1024 1025 1026 1027 1028 1029 1030 1031
}

//void RTFGenerator::writeIndexFileItem(const char *,const char *text)
//{
//  t << "\\item\\contentsline{section}{";
//  docify(text);
//  t << "}{\\pageref{" << text << "}}" << endl;
//}

Dimitri van Heesch's avatar
Dimitri van Heesch committed
1032
void RTFGenerator::startHtmlLink(const char *url)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1033 1034
{

1035
  if (Config_getBool("RTF_HYPERLINKS"))
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1036 1037 1038 1039
  {
    t << "{\\field {\\*\\fldinst { HYPERLINK  \\\\l \"";
    t << url;
    t << "\" }{}";
1040
    t << "}{\\fldrslt {\\cs37\\ul\\cf2 ";
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1041 1042 1043 1044 1045 1046
  }
  else
  {
    startTypewriter();
  }
}
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1047

Dimitri van Heesch's avatar
Dimitri van Heesch committed
1048 1049
void RTFGenerator::endHtmlLink()
{
1050
  if (Config_getBool("RTF_HYPERLINKS"))
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1051
  {
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1052 1053 1054 1055 1056 1057 1058 1059
    t << "}}}" << endl;
  }
  else
  {
    endTypewriter();
  }
}

1060 1061 1062 1063 1064 1065
//void RTFGenerator::writeMailLink(const char *url)
//{
//  startTypewriter();
//  docify(url);
//  endTypewriter();
//}
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1066 1067 1068 1069

void RTFGenerator::writeStartAnnoItem(const char *,const char *f,
    const char *path,const char *name)
{
1070
  DBG_RTF(t << "{\\comment (writeStartAnnoItem)}" << endl)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1071 1072
  t << "{\\b ";
  if (path) docify(path);
1073
  if (f && Config_getBool("RTF_HYPERLINKS"))
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1074 1075
  {
    t << "{\\field {\\*\\fldinst { HYPERLINK  \\\\l \"";
1076
    t << rtfFormatBmkStr(f);
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1077
    t << "\" }{}";
1078
    t << "}{\\fldrslt {\\cs37\\ul\\cf2 ";
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1079 1080 1081 1082 1083 1084 1085

    docify(name);

    t << "}}}" << endl;
  }
  else
  {
1086
    docify(name);
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1087 1088 1089 1090 1091 1092
  }
  t << "} ";
}

void RTFGenerator::writeEndAnnoItem(const char *name)
{
1093
  DBG_RTF(t << "{\\comment (writeEndAnnoItem)}" << endl)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1094 1095 1096
  if (name)
  {
    t << "\\tab ";
1097
    writeRTFReference(name);
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1098 1099 1100 1101
    t << endl;
  }
  else
  {
1102
    t << endl;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1103 1104 1105 1106
  }
  newParagraph();
}

1107 1108
void RTFGenerator::startIndexKey()
{
1109 1110 1111 1112 1113 1114
  DBG_RTF(t << "{\\comment (startIndexKey)}" << endl)
  t << "{\\b ";
}

void RTFGenerator::endIndexKey()
{
1115
  DBG_RTF(t << "{\\comment (endIndexKey)}" << endl)
1116 1117
}

1118 1119
void RTFGenerator::startIndexValue(bool hasBrief)
{
1120
  DBG_RTF(t << "{\\comment (startIndexValue)}" << endl)
1121 1122
  t << " ";
  if (hasBrief) t << "(";
1123 1124
}

1125
void RTFGenerator::endIndexValue(const char *name,bool hasBrief)
1126
{
1127
  DBG_RTF(t << "{\\comment (endIndexValue)}" << endl)
1128
  if (hasBrief) t << ")";
1129 1130 1131 1132
  t << "} ";
  if (name)
  {
    t << "\\tab ";
1133
    writeRTFReference(name);
1134 1135 1136 1137
    t << endl;
  }
  else
  {
1138
    t << endl;
1139
  }
1140
  m_omitParagraph=FALSE;
1141 1142 1143
  newParagraph();
}

1144 1145
void RTFGenerator::startSubsection()
{
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1146
  //beginRTFSubSection();
1147 1148
  t <<"\n";
  DBG_RTF(t << "{\\comment Begin SubSection}\n")
1149 1150
  t << rtf_Style_Reset;
  t << rtf_Style["Heading3"]->reference << "\n";
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1151 1152
}

1153
void RTFGenerator::endSubsection()
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1154 1155
{
  newParagraph();
1156
  t << rtf_Style_Reset << endl;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1157 1158
}

1159
void RTFGenerator::startSubsubsection()
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1160 1161
{
  //beginRTFSubSubSection();
1162 1163
  t << "\n";
  DBG_RTF(t << "{\\comment Begin SubSubSection}\n")
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1164
  t << "{" << endl;
1165
  t << rtf_Style_Reset << rtf_Style["Heading4"]->reference << "\n";
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1166 1167
}

1168 1169
void RTFGenerator::endSubsubsection()
{
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1170 1171
  newParagraph();
  t << "}" << endl;
1172
}
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1173 1174 1175 1176 1177 1178 1179


//void RTFGenerator::writeClassLink(const char *,const char *,
//                                    const char *,const char *name)
//{
//  t << "{\\bf ";
//  docify(name);
1180
//  t << "}";
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1181 1182
//}

1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249
//void RTFGenerator::startTable(bool,int colNumbers) 
//{
//  DBG_RTF(t << "{\\comment startTable}\n";)
//  m_numCols=colNumbers;
//  t << "\\par\n";
//}
//
//void RTFGenerator::endTable(bool hasCaption) 
//{ 
//  DBG_RTF(t << "{\\comment endTable}\n";)
//  if (!hasCaption) 
//    t << "\n\\pard \\widctlpar\\intbl\\adjustright\n{\\row }\n"; 
//  t << "\\pard\n" << endl; 
//}
//
//void  RTFGenerator::startCaption() 
//{
//  DBG_RTF(t << "{\\comment startCaption}\n";)
//  endTableRow();
//  t << "\\trowd \\trgaph108\\trleft-108\\trbrdrt\\brdrs\\brdrw10 \\trbrdrl\\brdrs\\brdrw10 \\trbrdrb\\brdrs\\brdrw10 \\trbrdrr\\brdrs\\brdrw10 \\trbrdrh\\brdrs\\brdrw10 \\trbrdrv\\brdrs\\brdrw10" << endl;
//  t << "\\clvertalt\\clbrdrt\\brdrs\\brdrw10 \\clbrdrl\\brdrs\\brdrw10 \\clbrdrb\\brdrs\\brdrw10 \\clbrdrr \\brdrs\\brdrw10 \\cltxlrtb \\cellx"<<rtf_pageWidth<<"\\pard \\qc\\nowidctlpar\\widctlpar\\intbl\\adjustright " << endl;
//  nextTableColumn();
//}
//
//void  RTFGenerator::endCaption() 
//{
//  DBG_RTF(t << "{\\comment endCaption}\n";)
//  endTableColumn();
//  endTableRow();
//}
//
//void RTFGenerator::nextTableRow() 
//{  
//  DBG_RTF(t << "{\\comment nextTableRow}\n";)
//  ASSERT(m_numCols>0 && m_numCols<25);
//  uint columnWidth=rtf_pageWidth/m_numCols;
//  t << "\\trowd \\trgaph108\\trleft-108\\trbrdrt\\brdrs\\brdrw10 "
//       "\\trbrdrl\\brdrs\\brdrw10 \\trbrdrb\\brdrs\\brdrw10 "
//       "\\trbrdrr\\brdrs\\brdrw10 \\trbrdrh\\brdrs\\brdrw10 "
//       "\\trbrdrv\\brdrs\\brdrw10 "<<endl;
//  for (int i=0;i<m_numCols;i++) 
//  {
//    t << "\\clvertalt\\clbrdrt\\brdrs\\brdrw10 \\clbrdrl\\brdrs\\brdrw10 "
//         "\\clbrdrb\\brdrs\\brdrw10 \\clbrdrr \\brdrs\\brdrw10 \\cltxlrtb "
//         "\\cellx" << (i*columnWidth) << endl;
//  }
//  t << "\\pard \\widctlpar\\intbl\\adjustright\n{";
//}
// 
//void RTFGenerator::endTableRow() 
//{ 
//  DBG_RTF(t << "{\\comment endTableRow}\n";)
//  t << "\n\\pard \\widctlpar\\intbl\\adjustright\n{\\row }\n";
//}
// 
//void RTFGenerator::nextTableColumn() 
//{
//  DBG_RTF(t << "{\\comment nextTableColumn}\n";)
//  t << "{ ";
//}
//
//void RTFGenerator::endTableColumn() 
//{ 
//  DBG_RTF(t << "{\\comment endTableColumn}\n";)
//  t << " \\cell }";
//}
//
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1250 1251
void RTFGenerator::startTextLink(const char *f,const char *anchor)
{
1252
  if (Config_getBool("RTF_HYPERLINKS"))
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265
  {
    QCString ref;
    if (f)
    {
      ref+=f;
    }
    if (anchor)
    {
      ref+='_';
      ref+=anchor;
    }

    t << "{\\field {\\*\\fldinst { HYPERLINK  \\\\l \"";
1266
    t << rtfFormatBmkStr(ref);
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1267
    t << "\" }{}";
1268
    t << "}{\\fldrslt {\\cs37\\ul\\cf2 ";
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1269 1270 1271 1272 1273
  }
}

void RTFGenerator::endTextLink()
{
1274
  if (Config_getBool("RTF_HYPERLINKS"))
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1275 1276 1277 1278 1279 1280 1281 1282
  {
    t << "}}}" << endl;
  }
}

void RTFGenerator::writeObjectLink(const char *ref, const char *f,
    const char *anchor, const char *text)
{
1283
  if (!ref && Config_getBool("RTF_HYPERLINKS"))
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296
  {
    QCString refName;
    if (f)
    {
      refName+=f;
    }
    if (anchor)
    {
      refName+='_';
      refName+=anchor;
    }

    t << "{\\field {\\*\\fldinst { HYPERLINK  \\\\l \"";
1297
    t << rtfFormatBmkStr(refName);
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1298
    t << "\" }{}";
1299
    t << "}{\\fldrslt {\\cs37\\ul\\cf2 ";
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1300 1301 1302 1303 1304 1305 1306 1307 1308 1309

    docify(text);

    t << "}}}" << endl;
  }
  else
  {
    startBold();
    docify(text);
    endBold();
1310
  }
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330
}

void RTFGenerator::startPageRef()
{
  t << " (";
  startEmphasis();
}

void RTFGenerator::endPageRef(const char *clname, const char *anchor)
{
  QCString ref;
  if (clname)
  {
    ref+=clname;
  }
  if (anchor)
  {
    ref+='_';
    ref+=anchor;
  }
1331
  writeRTFReference(ref);
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1332 1333 1334 1335 1336
  endEmphasis();
  t << ")";
}

void RTFGenerator::writeCodeLink(const char *ref,const char *f,
1337 1338
                                 const char *anchor,const char *name,
                                 const char *)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1339
{
1340
  if (!ref && Config_getBool("RTF_HYPERLINKS"))
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353
  {
    QCString refName;
    if (f)
    {
      refName+=f;
    }
    if (anchor)
    {
      refName+='_';
      refName+=anchor;
    }

    t << "{\\field {\\*\\fldinst { HYPERLINK  \\\\l \"";
1354
    t << rtfFormatBmkStr(refName);
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1355
    t << "\" }{}";
1356
    t << "}{\\fldrslt {\\cs37\\ul\\cf2 ";
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369

    codify(name);

    t << "}}}" << endl;
  }
  else
  {
    codify(name);
  }
}

void RTFGenerator::startTitleHead(const char *)
{
1370
  DBG_RTF(t <<"{\\comment startTitleHead}" << endl)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1371

1372
  //    beginRTFSection();
1373
  t << rtf_Style_Reset << rtf_Style["Heading2"]->reference << endl;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1374 1375 1376 1377
}

void RTFGenerator::endTitleHead(const char *fileName,const char *name)
{
1378
  DBG_RTF(t <<"{\\comment endTitleHead}" << endl)
1379
  t << "\\par " << rtf_Style_Reset << endl;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1380 1381 1382 1383 1384 1385 1386 1387
  if (name)
  {
    // make table of contents entry
    t << "{\\tc\\tcl2 \\v ";
    docify(name);
    t << "}" << endl;

    // make an index entry
1388
    addIndexItem(name,0);
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1389

1390 1391 1392 1393 1394
    //if (name)
    //{
    //  writeAnchor(0,name);
    //}
    //
1395
    //if (Config_getBool("RTF_HYPERLINKS") && fileName)
1396
    //{
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1397
      writeAnchor(fileName,0);
1398
    //}
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1399 1400 1401 1402 1403
  }
}

void RTFGenerator::startTitle()
{
1404
  DBG_RTF(t <<"{\\comment startTitle}" << endl)
1405
  if (Config_getBool("COMPACT_RTF"))
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1406 1407 1408 1409 1410 1411 1412
    beginRTFSection();
  else
    beginRTFChapter();
}

void RTFGenerator::startGroupHeader()
{
1413
  DBG_RTF(t <<"{\\comment startGroupHeader}" << endl)
1414
  //newParagraph();
1415 1416
  t << rtf_Style_Reset;
  t << rtf_Style["Heading3"]->reference;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1417 1418 1419 1420 1421
  t << endl;
}

void RTFGenerator::endGroupHeader()
{
1422
  DBG_RTF(t <<"{\\comment endGroupHeader}" << endl)
1423
  t << "\\par" << endl;
1424
  t << rtf_Style_Reset << endl;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1425 1426 1427 1428 1429 1430 1431
}

void RTFGenerator::startMemberDoc(const char *clname,
    const char *memname,
    const char *,
    const char *)
{
1432
  DBG_RTF(t << "{\\comment startMemberDoc}" << endl)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1433 1434
  if (memname && memname[0]!='@')
  {
1435 1436
    addIndexItem(memname,clname);
    addIndexItem(clname,memname);
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1437
  }
1438 1439
  t << rtf_Style_Reset << rtf_Style["Heading4"]->reference;
  //styleStack.push(rtf_Style_Heading4);
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1440
  t << "{" << endl;
1441
  //printf("RTFGenerator::startMemberDoc() `%s'\n",rtf_Style["Heading4"]->reference);
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1442 1443 1444 1445
  startBold();
  t << endl;
}

1446
void RTFGenerator::endMemberDoc(bool)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1447
{
1448
  DBG_RTF(t << "{\\comment endMemberDoc}" << endl)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1449 1450 1451
  t << "}" << endl;
  //const char *style = styleStack.pop();
  //printf("RTFGenerator::endMemberDoc() `%s'\n",style);
1452
  //ASSERT(style==rtf_Style["Heading4"]->reference);
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1453 1454 1455 1456
  endBold();
  newParagraph();
}

Dimitri van Heesch's avatar
Dimitri van Heesch committed
1457
void RTFGenerator::startDoxyAnchor(const char *,const char *,
1458 1459 1460
                                   const char *,const char *,
                                   const char *
                                  )
1461
{
1462
  DBG_RTF(t << "{\\comment startDoxyAnchor}" << endl)
1463 1464 1465
}

void RTFGenerator::endDoxyAnchor(const char *fName,const char *anchor)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1466 1467
{
  QCString ref;
1468
  if (fName)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1469
  {
1470
    ref+=fName;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1471 1472 1473 1474 1475 1476
  }
  if (anchor)
  {
    ref+='_';
    ref+=anchor;
  }
1477

1478
  DBG_RTF(t << "{\\comment endDoxyAnchor}" << endl)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1479
  t << "{\\bkmkstart ";
1480
  t << rtfFormatBmkStr(ref);
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1481 1482
  t << "}" << endl;
  t << "{\\bkmkend ";
1483
  t << rtfFormatBmkStr(ref);
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1484 1485 1486 1487 1488 1489 1490 1491 1492
  t << "}" << endl;
}


//void RTFGenerator::writeLatexLabel(const char *clName,const char *anchor)
//{
//  writeDoxyAnchor(0,clName,anchor,0);
//}

1493
void RTFGenerator::addIndexItem(const char *s1,const char *s2)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510
{
  if (s1)
  {
    t << "{\\xe \\v ";
    docify(s1);
    if (s2)
    {
      t << "\\:";
      docify(s2);
    }
    t << "}" << endl;
  }
}

void RTFGenerator::startIndent()
{
  incrementIndentLevel();
1511
  DBG_RTF(t << "{\\comment (startIndent) }" << endl)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1512
  t << "{" << endl;
1513
  t << rtf_Style_Reset << rtf_CList_DepthStyle() << endl;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1514 1515 1516 1517 1518 1519 1520 1521 1522
}

void RTFGenerator::endIndent()
{
  t << "}" << endl;
  decrementIndentLevel();
}


1523 1524
void RTFGenerator::startDescription()
{
1525
  DBG_RTF(t << "{\\comment (startDescription)}"    << endl)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1526
  t << "{" << endl;
1527
  t << rtf_Style_Reset << rtf_DList_DepthStyle();
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1528 1529
}

1530 1531
void RTFGenerator::endDescription()
{
1532
  DBG_RTF(t << "{\\comment (endDescription)}"    << endl)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1533
  newParagraph();
1534
  t << "}";
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1535 1536 1537
}

void RTFGenerator::startDescItem()
1538
{
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1539
  newParagraph();
1540
  DBG_RTF(t << "{\\comment (startDescItem)}"    << endl)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1541 1542 1543 1544
  t << "{\\b ";
}

void RTFGenerator::endDescItem()
1545
{
1546
  DBG_RTF(t << "{\\comment (endDescItem)}"    << endl)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1547
  t << "}" << endl;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1548
  newParagraph();
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1549 1550
}

1551 1552
void RTFGenerator::startMemberDescription()
{
1553
  DBG_RTF(t << "{\\comment (startMemberDescription)}"    << endl)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1554 1555
  t << "{" << endl;
  incrementIndentLevel();
1556
  t << rtf_Style_Reset << rtf_CList_DepthStyle();
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1557 1558 1559 1560
  startEmphasis();
}

void RTFGenerator::endMemberDescription()
1561
{
1562
  DBG_RTF(t << "{\\comment (endMemberDescription)}"    << endl)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1563
  endEmphasis();
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1564 1565
  newParagraph();
  decrementIndentLevel();
1566 1567 1568
  //t << "\\par";
  t << "}" << endl;
  //m_omitParagraph = TRUE;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1569 1570
}

1571 1572
void RTFGenerator::startDescList(SectionTypes)
{
1573
  DBG_RTF(t << "{\\comment (startDescList)}"    << endl)
1574 1575
  t << "{"; // ends at endDescList
  t << "{"; // ends at endDescTitle
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1576
  startBold();
1577
  newParagraph();
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1578 1579
}

1580 1581 1582 1583 1584 1585 1586 1587 1588
//void RTFGenerator::endDescTitle()
//{
//  DBG_RTF(t << "{\\comment (endDescTitle) }"    << endl)
//  endBold();
//  t << "}";
//  newParagraph();
//  incrementIndentLevel();
//  t << rtf_Style_Reset << rtf_DList_DepthStyle();
//}
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1589

1590 1591 1592 1593 1594 1595
void RTFGenerator::startDescForItem()
{
  DBG_RTF(t << "{\\comment (startDescForItem) }"    << endl)
}

void RTFGenerator::endDescForItem()
1596
{
1597
  DBG_RTF(t << "{\\comment (endDescForItem) }"    << endl)
1598 1599
}

1600 1601 1602 1603 1604 1605 1606 1607
//void RTFGenerator::endDescList()
//{
//  DBG_RTF(t << "{\\comment (endDescList)}"    << endl)
//  newParagraph();
//  decrementIndentLevel();
//  m_omitParagraph = TRUE;
//  t << "}";
//}
1608

1609

1610
void RTFGenerator::startSection(const char *,const char *title,SectionInfo::SectionType type)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1611
{
1612
  DBG_RTF(t << "{\\comment (startSection)}"    << endl)
1613
  t << "{";
1614
  t<< rtf_Style_Reset;
1615 1616
  int num=4;
  switch(type)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1617
  {
1618 1619 1620 1621 1622
    case SectionInfo::Page:          num=2; break;
    case SectionInfo::Section:       num=3; break;
    case SectionInfo::Subsection:    num=4; break;
    case SectionInfo::Subsubsection: num=4; break;
    case SectionInfo::Paragraph:     num=4; break;
1623
    default: ASSERT(0); break;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1624
  }
1625 1626 1627
  QCString heading;
  heading.sprintf("Heading%d",num);
  // set style
1628
  t << rtf_Style[heading]->reference;
1629 1630 1631 1632
  // make table of contents entry
  t << "{\\tc\\tcl" << num << " \\v ";
  docify(title);
  t << "}" << endl;
1633
}
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1634

1635
void RTFGenerator::endSection(const char *lab,SectionInfo::SectionType)
1636
{
1637
  DBG_RTF(t << "{\\comment (endSection)}"    << endl)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1638
  // make bookmark
1639 1640
  m_omitParagraph=FALSE;
  newParagraph();
1641
  writeAnchor(0,lab);
1642
  t << "}";
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1643 1644
}

1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672
//void RTFGenerator::writeSectionRef(const char *ref,const char *,
//                                   const char *lab,const char *title)
//{
//  if (ref)
//  {
//    docify(title);
//  }
//  else
//  {
//    startBold();
//    docify(title);
//    endBold();
//    t << " (";
//    docify(theTranslator->trPageAbbreviation());
//    writeRTFReference(lab);
//    t << ")" << endl;
//  }
//}
//
//void RTFGenerator::writeSectionRefItem(const char *,const char *lab,
//    const char *title)
//{
//  docify(title);
//  t << "\\tab";
//  writeRTFReference(lab);
//  t << endl;
//}
//
1673 1674 1675 1676 1677
//void RTFGenerator::writeSectionRefAnchor(const char *name,const char *lab,
//    const char *title)
//{
//  writeSectionRef(name,lab,title);
//}
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1678

1679 1680 1681 1682 1683 1684 1685
//char* RTFGenerator::getMultiByte(int c)
//{
//    static char s[10];
//
//    sprintf(s,"\\'%X",c);
//    return s;
//}
1686

Dimitri van Heesch's avatar
Dimitri van Heesch committed
1687 1688 1689 1690 1691 1692 1693 1694 1695
void RTFGenerator::docify(const char *str)
{
  if (str)
  {
    const unsigned char *p=(const unsigned char *)str;
    unsigned char c;
    unsigned char pc='\0';
    while (*p)
    {
1696
      //static bool MultiByte = FALSE;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1697
      c=*p++;
1698

1699
#if 0
1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711
      if ( MultiByte )
      {
        t << getMultiByte( c );
        MultiByte = FALSE;
        continue;
      }
      if ( c >= 0x80 )
      {
        MultiByte = TRUE;
        t << getMultiByte( c );
        continue;
      }
1712
#endif
1713 1714

      switch (c)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1715 1716 1717
      {
        case '{':  t << "\\{";            break;
        case '}':  t << "\\}";            break;
1718 1719 1720
        case '\\': t << "\\\\";           break;
        default:
          {
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1721 1722
            // see if we can insert an hyphenation hint
            //if (isupper(c) && islower(pc) && !insideTabbing) t << "\\-";
1723
            t << (char)c;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737
          }
      }
      pc = c;
      m_omitParagraph = FALSE;
    }
  }
}

void RTFGenerator::codify(const char *str)
{
  // note that RTF does not have a "verbatim", so "\n" means
  // nothing... add a "newParagraph()";
  //static char spaces[]="        ";
  if (str)
1738 1739 1740
  {
    const unsigned char *p=(const unsigned char *)str;
    unsigned char c;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1741
    int spacesToNextTabStop;
1742

Dimitri van Heesch's avatar
Dimitri van Heesch committed
1743 1744
    while (*p)
    {
1745
      //static bool MultiByte = FALSE;
1746

Dimitri van Heesch's avatar
Dimitri van Heesch committed
1747
      c=*p++;
1748

1749
#if 0
1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761
      if( MultiByte )
      {
        t << getMultiByte( c );
        MultiByte = FALSE;
        continue;
      }
      if( c >= 0x80 )
      {
        MultiByte = TRUE;
        t << getMultiByte( c );
        continue;
      }
1762
#endif
1763

Dimitri van Heesch's avatar
Dimitri van Heesch committed
1764 1765
      switch(c)
      {
1766
        case '\t':  spacesToNextTabStop = Config_getInt("TAB_SIZE") - (col%Config_getInt("TAB_SIZE"));
1767
                    t << Doxygen::spaces.left(spacesToNextTabStop);
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1768
                    col+=spacesToNextTabStop;
1769
                    break;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1770 1771 1772 1773 1774 1775
        case '\n':  newParagraph();
                    t << '\n'; col=0;
                    break;
        case '{':   t << "\\{"; col++;          break;
        case '}':   t << "\\}"; col++;          break;
        case '\\':  t << "\\\\"; col++;         break;
1776
        default:    t << (char)c; col++;           break;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791
      }
    }
  }
}

void RTFGenerator::writeChar(char c)
{
  char cs[2];
  cs[0]=c;
  cs[1]=0;
  docify(cs);
}

void RTFGenerator::startClassDiagram()
{
1792
  DBG_RTF(t <<"{\\comment startClassDiagram }" << endl)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1793 1794
}

Dimitri van Heesch's avatar
Dimitri van Heesch committed
1795
void RTFGenerator::endClassDiagram(const ClassDiagram &d,
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1796 1797 1798 1799
    const char *fileName,const char *)
{
  newParagraph();

1800
  // create a png file
1801
  d.writeImage(t,dir,relPath,fileName,FALSE);
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1802 1803 1804

  // display the file
  t << "{" << endl;
1805
  t << rtf_Style_Reset << endl;
1806 1807
  t << "\\par\\pard \\qc {\\field\\flddirty {\\*\\fldinst INCLUDEPICTURE \"";
  t << fileName << ".png\"";
1808
  t << " \\\\d \\\\*MERGEFORMAT}{\\fldrslt IMAGE}}\\par" << endl;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1809 1810 1811
  t << "}" << endl;
}

1812 1813 1814 1815
//void RTFGenerator::writeFormula(const char *,const char *text)
//{
//  t << text;
//}
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1816

1817 1818
void RTFGenerator::startMemberItem(int)
{
1819
  DBG_RTF(t <<"{\\comment startMemberItem }" << endl)
1820
  t << rtf_Style_Reset << rtf_BList_DepthStyle() << endl; // set style to apropriate depth
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1821 1822
}

1823
void RTFGenerator::endMemberItem()
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1824
{
1825
  DBG_RTF(t <<"{\\comment endMemberItem }" << endl)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1826 1827 1828
  newParagraph();
}

1829 1830
void RTFGenerator::writeAnchor(const char *fileName,const char *name)
{
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844
  QCString anchor;
  if (fileName)
  {
    anchor+=fileName;
  }
  if (fileName && name)
  {
    anchor+='_';
  }
  if (name)
  {
    anchor+=name;
  }

1845
  DBG_RTF(t <<"{\\comment writeAnchor (" << anchor << ")}" << endl)
1846 1847
  t << "{\\bkmkstart " << rtfFormatBmkStr(anchor) << "}" << endl;
  t << "{\\bkmkend " << rtfFormatBmkStr(anchor) << "}" << endl;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1848 1849
}

1850
void RTFGenerator::writeRTFReference(const char *label)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1851 1852
{
  t << "{\\field\\fldedit {\\*\\fldinst PAGEREF ";
1853
  t << rtfFormatBmkStr(label);
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1854 1855 1856
  t << " \\\\*MERGEFORMAT}{\\fldrslt pagenum}}";
}

1857 1858
void RTFGenerator::startCodeFragment()
{
1859
  DBG_RTF(t << "{\\comment (startCodeFragment) }"    << endl)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1860
  t << "{" << endl;
1861
  //newParagraph();
1862 1863
  t << rtf_Style_Reset << rtf_Code_DepthStyle();
  //styleStack.push(rtf_Style_CodeExample);
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1864 1865 1866
}

void RTFGenerator::endCodeFragment()
1867
{
1868
  //newParagraph();
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1869 1870
  //styleStack.pop();
  //printf("RTFGenerator::endCodeFrament() top=%s\n",styleStack.top());
1871
  //t << rtf_Style_Reset << styleStack.top() << endl;
1872
  DBG_RTF(t << "{\\comment (endCodeFragment) }"    << endl)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1873
  t << "}" << endl;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1874
  m_omitParagraph = TRUE;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1875 1876
}

1877
void RTFGenerator::writeNonBreakableSpace(int)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1878 1879 1880 1881 1882
{
  t << "\\~ ";
}


1883
void RTFGenerator::startMemberList()
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1884 1885
{
  t << endl;
1886
  DBG_RTF(t << "{\\comment (startMemberList) }"    << endl)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1887
  t << "{" << endl;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1888 1889
#ifdef DELETEDCODE
  if (!insideTabbing)
1890
    t << "\\begin{CompactItemize}" << endl;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1891 1892 1893
#endif
}

1894
void RTFGenerator::endMemberList()
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1895
{
1896
  DBG_RTF(t << "{\\comment (endMemberList) }"    << endl)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1897
  t << "}" << endl;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1898 1899
#ifdef DELETEDCODE
  if (!insideTabbing)
1900
    t << "\\end{CompactItemize}"   << endl;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1901 1902 1903
#endif
}

1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943
//void RTFGenerator::startImage(const char *name,const char *,bool)
//{
//  newParagraph();
//  t << "{" << endl;
//  t << rtf_Style_Reset << endl;
//  t << "\\par\\pard \\qc {\\field\\flddirty {\\*\\fldinst INCLUDEPICTURE ";
//  t << name;
//  t << " \\\\d \\\\*MERGEFORMAT}{\\fldrslt IMAGE}}\\par" << endl;
//  t << "}" << endl;
//}
//
//void RTFGenerator::endImage(bool)
//{
//  // not yet implemented
//}
//
//void RTFGenerator::startDotFile(const char *name,bool)
//{
//  QCString baseName=name;
//  int i;
//  if ((i=baseName.findRev('/'))!=-1 || (i=baseName.findRev('\\'))!=-1)
//  {
//    baseName=baseName.right(baseName.length()-i-1);
//  }
//  QCString outDir = Config_getString("RTF_OUTPUT");
//  writeDotGraphFromFile(name,outDir,baseName,BITMAP);
//  newParagraph();
//  t << "{" << endl;
//  t << rtf_Style_Reset << endl;
//  t << "\\par\\pard \\qc {\\field\\flddirty {\\*\\fldinst INCLUDEPICTURE ";
//  t << outDir << "\\" << baseName;
//  t << " \\\\d \\\\*MERGEFORMAT}{\\fldrslt IMAGE}}\\par" << endl;
//  t << "}" << endl;
//}
//
//void RTFGenerator::endDotFile(bool)
//{
//  // not yet implemented
//}
//
1944 1945
void RTFGenerator::startDescTable()
{
1946
  DBG_RTF(t << "{\\comment (startDescTable) }"    << endl)
1947
  //t << "{" << endl;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1948
  //incrementIndentLevel();
1949
  //t << rtf_Style_Reset << rtf_CList_DepthStyle();
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1950 1951
}

1952 1953
void RTFGenerator::endDescTable()
{
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1954
  //decrementIndentLevel();
1955
  DBG_RTF(t << "{\\comment (endDescTable)}"      << endl)
1956
  //t << "}" << endl;
1957
  //t << rtf_Style_Reset << styleStack.top();
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1958 1959 1960 1961
}

void RTFGenerator::startDescTableTitle()
{
1962
  //t << rtf_BList_DepthStyle() << endl;
1963
  DBG_RTF(t << "{\\comment (startDescTableTitle) }"    << endl)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1964
  startBold();
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1965
  startEmphasis();
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1966 1967 1968 1969
}

void RTFGenerator::endDescTableTitle()
{
1970
  DBG_RTF(t << "{\\comment (endDescTableTitle) }"    << endl)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1971
  endEmphasis();
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1972 1973 1974 1975
  endBold();
  t << "  ";
}

1976
void RTFGenerator::startDescTableData()
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1977
{
1978
  DBG_RTF(t << "{\\comment (startDescTableData) }"    << endl)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1979
  m_omitParagraph = FALSE;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1980 1981
}

1982
void RTFGenerator::endDescTableData()
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1983
{
1984
  DBG_RTF(t << "{\\comment (endDescTableData) }"    << endl)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1985
  newParagraph();
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1986
  m_omitParagraph = TRUE;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1987 1988 1989 1990 1991 1992 1993
}

// a style for list formatted as a "bulleted list"

void RTFGenerator::incrementIndentLevel()
{
  m_listLevel++;
1994
  if (m_listLevel>rtf_maxIndentLevels-1)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1995
  {
1996 1997
    warn_cont("Warning: Maximum indent level (%d) exceeded while generating RTF output!\n",rtf_maxIndentLevels);
    m_listLevel=rtf_maxIndentLevels-1;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1998 1999 2000 2001 2002 2003
  }
}

void RTFGenerator::decrementIndentLevel()
{
  m_listLevel--;
2004
  if (m_listLevel<0)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
2005
  {
2006
    warn_cont("Warning: Negative indent level while generating RTF output!\n");
Dimitri van Heesch's avatar
Dimitri van Heesch committed
2007 2008 2009 2010 2011
    m_listLevel=0;
  }
}

// a style for list formatted with "list continue" style
2012
const char * RTFGenerator::rtf_CList_DepthStyle()
Dimitri van Heesch's avatar
Dimitri van Heesch committed
2013
{
Dimitri van Heesch's avatar
Dimitri van Heesch committed
2014
  QCString n=makeIndexName("ListContinue",m_listLevel);
2015
  return rtf_Style[n]->reference;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
2016 2017 2018
}

// a style for list formatted as a "latext style" table of contents
2019
const char * RTFGenerator::rtf_LCList_DepthStyle()
Dimitri van Heesch's avatar
Dimitri van Heesch committed
2020
{
Dimitri van Heesch's avatar
Dimitri van Heesch committed
2021
  QCString n=makeIndexName("LatexTOC",m_listLevel);
2022
  return rtf_Style[n]->reference;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
2023 2024
}

2025
// a style for list formatted as a "bullet" style
2026
const char * RTFGenerator::rtf_BList_DepthStyle()
Dimitri van Heesch's avatar
Dimitri van Heesch committed
2027
{
Dimitri van Heesch's avatar
Dimitri van Heesch committed
2028
  QCString n=makeIndexName("ListBullet",m_listLevel);
2029
  return rtf_Style[n]->reference;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
2030 2031
}

2032
// a style for list formatted as a "enumeration" style
2033
const char * RTFGenerator::rtf_EList_DepthStyle()
Dimitri van Heesch's avatar
Dimitri van Heesch committed
2034
{
Dimitri van Heesch's avatar
Dimitri van Heesch committed
2035
  QCString n=makeIndexName("ListEnum",m_listLevel);
2036
  return rtf_Style[n]->reference;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
2037 2038
}

2039
const char * RTFGenerator::rtf_DList_DepthStyle()
Dimitri van Heesch's avatar
Dimitri van Heesch committed
2040
{
Dimitri van Heesch's avatar
Dimitri van Heesch committed
2041
  QCString n=makeIndexName("DescContinue",m_listLevel);
2042
  return rtf_Style[n]->reference;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
2043 2044
}

2045
const char * RTFGenerator::rtf_Code_DepthStyle()
Dimitri van Heesch's avatar
Dimitri van Heesch committed
2046
{
Dimitri van Heesch's avatar
Dimitri van Heesch committed
2047
  QCString n=makeIndexName("CodeExample",m_listLevel);
2048
  return rtf_Style[n]->reference;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
2049 2050 2051 2052
}

void RTFGenerator::startTextBlock(bool dense)
{
2053
  DBG_RTF(t << "{\\comment startTextBlock}" << endl)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
2054
  t << "{" << endl;
2055
  t << rtf_Style_Reset;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
2056 2057
  if (dense) // no spacing between "paragraphs"
  {
2058
    t << rtf_Style["DenseText"]->reference;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
2059 2060 2061
  }
  else // some spacing
  {
2062
    t << rtf_Style["BodyText"]->reference;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
2063 2064 2065
  }
}

2066
void RTFGenerator::endTextBlock(bool /*paraBreak*/)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
2067
{
2068
  newParagraph();
2069
  DBG_RTF(t << "{\\comment endTextBlock}" << endl)
2070
  t << "}" << endl;
2071
  //m_omitParagraph = TRUE;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
2072 2073 2074 2075
}

void RTFGenerator::newParagraph()
{
2076 2077
  if (!m_omitParagraph)
  {
2078
    DBG_RTF(t << "{\\comment (newParagraph)}"    << endl)
2079 2080
    t << "\\par" << endl;
  }
Dimitri van Heesch's avatar
Dimitri van Heesch committed
2081
  m_omitParagraph = FALSE;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
2082 2083
}

2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097
void RTFGenerator::startParagraph()
{
  DBG_RTF(t << "{\\comment startParagraph}" << endl)
  newParagraph();
  t << "{" << endl;
}

void RTFGenerator::endParagraph()
{
  DBG_RTF(t << "{\\comment endParagraph}" << endl)
  t << "}\\par" << endl;
  m_omitParagraph = TRUE;
}

Dimitri van Heesch's avatar
Dimitri van Heesch committed
2098 2099
void RTFGenerator::startMemberSubtitle()
{
2100
  DBG_RTF(t << "{\\comment startMemberSubtitle}" << endl)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
2101
  t << "{" << endl;
2102
  t << rtf_Style_Reset << rtf_CList_DepthStyle() << endl;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
2103 2104 2105 2106
}

void RTFGenerator::endMemberSubtitle()
{
2107
  DBG_RTF(t << "{\\comment endMemberSubtitle}" << endl)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
2108 2109 2110 2111
  newParagraph();
  t << "}" << endl;
}

2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221
//void RTFGenerator::writeUmlaut(char c)
//{
//  switch(c)
//  {
//    case 'A' : t << '\304'; break;
//    case 'E' : t << '\313'; break;
//    case 'I' : t << '\317'; break;
//    case 'O' : t << '\326'; break;
//    case 'U' : t << '\334'; break;
//    case 'Y' : t << 'Y';    break;
//    case 'a' : t << '\344'; break;
//    case 'e' : t << '\353'; break;
//    case 'i' : t << '\357'; break;
//    case 'o' : t << '\366'; break;
//    case 'u' : t << '\374'; break;
//    case 'y' : t << '\377'; break;
//    default: t << '?'; break;
//  }
//}
//
//void RTFGenerator::writeAcute(char c)
//{
//  switch(c)
//  {
//    case 'A' : t << '\301'; break;
//    case 'E' : t << '\311'; break;
//    case 'I' : t << '\315'; break;
//    case 'O' : t << '\323'; break;
//    case 'U' : t << '\332'; break;
//    case 'Y' : t << '\335'; break;
//    case 'a' : t << '\341'; break;
//    case 'e' : t << '\351'; break;
//    case 'i' : t << '\355'; break;
//    case 'o' : t << '\363'; break;
//    case 'u' : t << '\372'; break;
//    case 'y' : t << '\375'; break;
//    default: t << '?'; break;
//  }
//}
//
//void RTFGenerator::writeGrave(char c)
//{
//  switch(c)
//  {
//    case 'A' : t << '\300'; break;
//    case 'E' : t << '\310'; break;
//    case 'I' : t << '\314'; break;
//    case 'O' : t << '\322'; break;
//    case 'U' : t << '\331'; break;
//    case 'a' : t << '\340'; break;
//    case 'e' : t << '\350'; break;
//    case 'i' : t << '\354'; break;
//    case 'o' : t << '\362'; break;
//    case 'u' : t << '\371'; break;
//    default: t << '?'; break;
//  }
//}
//
//void RTFGenerator::writeCirc(char c)
//{
//  switch(c)
//  {
//    case 'A' : t << '\302'; break;
//    case 'E' : t << '\312'; break;
//    case 'I' : t << '\316'; break;
//    case 'O' : t << '\324'; break;
//    case 'U' : t << '\333'; break;
//    case 'a' : t << '\342'; break;
//    case 'e' : t << '\352'; break;
//    case 'i' : t << '\356'; break;
//    case 'o' : t << '\364'; break;
//    case 'u' : t << '\373'; break;
//    default: t << '?'; break;
//  }
//}
//
//void RTFGenerator::writeTilde(char c)
//{
//  switch(c)
//  {
//    case 'A' : t << '\303'; break;
//    case 'N' : t << '\321'; break;
//    case 'O' : t << '\325'; break;
//    case 'a' : t << '\343'; break;
//    case 'n' : t << '\361'; break;
//    case 'o' : t << '\365'; break;
//    default: t << '?'; break;
//  }
//}
//
//void RTFGenerator::writeRing(char c)
//{
//  switch(c)
//  {
//    case 'A' : t << '\305'; break;
//    case 'a' : t << '\345'; break;
//    default: t << '?'; break;
//  }
//}
//
//void RTFGenerator::writeCCedil(char c)
//{
//  switch(c)
//  {
//    case 'C' : t << '\307'; break;
//    case 'c' : t << '\347'; break;
//    default: t << '?'; break;
//  }
//}
//
Dimitri van Heesch's avatar
Dimitri van Heesch committed
2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234
/**
 * VERY brittle routine inline RTF's included by other RTF's.
 * it is recursive and ugly.
 */
static bool PreProcessFile(QDir &d,QCString &infName, QTextStream &t, bool bIncludeHeader=TRUE)
{
  QFile f(infName);
  if (!f.open(IO_ReadOnly))
  {
    err("Error opening rtf file %s for reading\n",infName.data());
    return FALSE;
  }

2235
  const int maxLineLength = 10240;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261
  static QCString lineBuf(maxLineLength);

  // scan until find end of header
  // this is EXTREEEEEEEMLY brittle.  It works on OUR rtf
  // files because the first line before the body
  // ALWAYS contains "{\comment begin body}"
  do
  {
    if (f.readLine(lineBuf.data(),maxLineLength)==-1)
    {
      err("ERROR - read error in %s before end of RTF header!\n",infName.data());
      return FALSE;
    }
    if (bIncludeHeader) t << lineBuf;
  } while (lineBuf.find("\\comment begin body")==-1);


  //while (fgets(buffer,sizeof(buffer),infp) != NULL)
  while (f.readLine(lineBuf.data(),maxLineLength)!=-1)
  {
    int pos;
    if ((pos=lineBuf.find("INCLUDETEXT"))!=-1)
    {
      int startNamePos  = lineBuf.find('"',pos)+1;
      int endNamePos    = lineBuf.find('"',startNamePos);
      QCString fileName = lineBuf.mid(startNamePos,endNamePos-startNamePos);
2262
      DBG_RTF(t << "{\\comment begin include " << fileName << "}" << endl)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
2263
      if (!PreProcessFile(d,fileName,t,FALSE)) return FALSE;
2264
      DBG_RTF(t << "{\\comment end include " << fileName << "}" << endl)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293
    }
    else
    {
      // elaborate hoopla to skip  the final "}" if we didn't include the
      // headers
      if (!f.atEnd() || bIncludeHeader)
      {
        t << lineBuf;
      }
      else
      {
        // null terminate at the last '}'
        //char *str = strrchr(buffer,'}');
        int pos = lineBuf.findRev('}');

        if (pos != -1)
          lineBuf.at(pos) = '\0';
        else
          err("Strange, the last char was not a '}'\n");
        t << lineBuf;
      }
    }
  }
  f.close();
  // remove temporary file
  d.remove(infName);
  return TRUE;
}

2294
void RTFGenerator::startDotGraph()
Dimitri van Heesch's avatar
Dimitri van Heesch committed
2295
{
2296
  DBG_RTF(t << "{\\comment (startDotGraph)}"    << endl)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
2297 2298
}

Dimitri van Heesch's avatar
Dimitri van Heesch committed
2299
void RTFGenerator::endDotGraph(const DotClassGraph &g)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
2300 2301 2302
{
  newParagraph();

2303
  QCString fileName =
2304
    g.writeGraph(t,BITMAP,Config_getString("RTF_OUTPUT"),relPath,TRUE,FALSE);
Dimitri van Heesch's avatar
Dimitri van Heesch committed
2305 2306 2307

  // display the file
  t << "{" << endl;
2308
  t << rtf_Style_Reset << endl;
2309
  t << "\\par\\pard \\qc {\\field\\flddirty {\\*\\fldinst INCLUDEPICTURE \"";
Dimitri van Heesch's avatar
Dimitri van Heesch committed
2310
  t << fileName << "." << Config_getEnum("DOT_IMAGE_FORMAT");
2311
  t << "\" \\\\d \\\\*MERGEFORMAT}{\\fldrslt IMAGE}}\\par" << endl;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
2312
  t << "}" << endl;
2313 2314
  newParagraph();
  DBG_RTF(t << "{\\comment (endDotGraph)}"    << endl)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
2315 2316
}

2317
void RTFGenerator::startInclDepGraph()
Dimitri van Heesch's avatar
Dimitri van Heesch committed
2318
{
2319
  DBG_RTF(t << "{\\comment (startInclDepGraph)}"    << endl)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
2320 2321
}

Dimitri van Heesch's avatar
Dimitri van Heesch committed
2322
void RTFGenerator::endInclDepGraph(const DotInclDepGraph &g)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
2323 2324 2325
{
  newParagraph();

2326 2327
  QCString fileName = g.writeGraph(t,BITMAP,Config_getString("RTF_OUTPUT"),
                         relPath,FALSE);
Dimitri van Heesch's avatar
Dimitri van Heesch committed
2328 2329 2330

  // display the file
  t << "{" << endl;
2331
  t << rtf_Style_Reset << endl;
2332
  t << "\\par\\pard \\qc {\\field\\flddirty {\\*\\fldinst INCLUDEPICTURE \"";
Dimitri van Heesch's avatar
Dimitri van Heesch committed
2333
  t << fileName << "." << Config_getEnum("DOT_IMAGE_FORMAT");
2334
  t << "\" \\\\d \\\\*MERGEFORMAT}{\\fldrslt IMAGE}}\\par" << endl;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
2335
  t << "}" << endl;
2336
  DBG_RTF(t << "{\\comment (endInclDepGraph)}"    << endl)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
2337 2338
}

2339 2340 2341 2342
void RTFGenerator::startGroupCollaboration()
{
}

Dimitri van Heesch's avatar
Dimitri van Heesch committed
2343
void RTFGenerator::endGroupCollaboration(const DotGroupCollaboration &)
2344 2345 2346
{
}

2347 2348 2349 2350 2351
void RTFGenerator::startCallGraph()
{
  DBG_RTF(t << "{\\comment (startCallGraph)}"    << endl)
}

Dimitri van Heesch's avatar
Dimitri van Heesch committed
2352
void RTFGenerator::endCallGraph(const DotCallGraph &g)
2353 2354 2355
{
  newParagraph();

2356 2357
  QCString fileName = g.writeGraph(t,BITMAP,Config_getString("RTF_OUTPUT"),
                        relPath,FALSE);
2358 2359 2360 2361

  // display the file
  t << "{" << endl;
  t << rtf_Style_Reset << endl;
2362
  t << "\\par\\pard \\qc {\\field\\flddirty {\\*\\fldinst INCLUDEPICTURE \"";
2363
  t << fileName << "." << Config_getEnum("DOT_IMAGE_FORMAT");
2364
  t << "\" \\\\d \\\\*MERGEFORMAT}{\\fldrslt IMAGE}}\\par" << endl;
2365 2366 2367 2368
  t << "}" << endl;
  DBG_RTF(t << "{\\comment (endCallGraph)}"    << endl)
}

2369 2370 2371 2372 2373
void RTFGenerator::startDirDepGraph()
{
  DBG_RTF(t << "{\\comment (startDirDepGraph)}"    << endl)
}

Dimitri van Heesch's avatar
Dimitri van Heesch committed
2374
void RTFGenerator::endDirDepGraph(const DotDirDeps &g)
2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390
{
  newParagraph();

  QCString fileName = g.writeGraph(t,BITMAP,Config_getString("RTF_OUTPUT"),
                        relPath,FALSE);

  // display the file
  t << "{" << endl;
  t << rtf_Style_Reset << endl;
  t << "\\par\\pard \\qc {\\field\\flddirty {\\*\\fldinst INCLUDEPICTURE \"";
  t << fileName << "." << Config_getEnum("DOT_IMAGE_FORMAT");
  t << "\" \\\\d \\\\*MERGEFORMAT}{\\fldrslt IMAGE}}\\par" << endl;
  t << "}" << endl;
  DBG_RTF(t << "{\\comment (endDirDepGraph)}"    << endl)
}

2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407
/** Tests the integrity of the result by counting brackets.
 *
 */
void testRTFOutput(const char *name)
{
  int bcount=0;
  int line=1;
  int c;
  QFile f(name);
  if (f.open(IO_ReadOnly))
  {
    while ((c=f.getch())!=-1)
    {
      if (c=='\\') // escape char
      {
        c=f.getch();
        if (c==-1) break;
2408
      }
2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434
      else if (c=='{') // open bracket
      {
        bcount++;
      }
      else if (c=='}') // close bracket
      {
        bcount--;
        if (bcount<0)
        {
          goto err;
          break;
        }
      }
      else if (c=='\n') // newline
      {
        line++;
      }
    }
  }
  if (bcount==0) return; // file is OK.
err:
  err("Error: RTF integrity test failed at line %d of %s due to a bracket mismatch.\n",line,name);
  err("       Please try to create a small code example that produces this error \n"
      "       and send that to dimitri@stack.nl.\n");
}

Dimitri van Heesch's avatar
Dimitri van Heesch committed
2435 2436
/**
 * This is an API to a VERY brittle RTF preprocessor that combines nested
2437
 * RTF files.  This version replaces the infile with the new file
Dimitri van Heesch's avatar
Dimitri van Heesch committed
2438 2439 2440 2441 2442
 */
bool RTFGenerator::preProcessFileInplace(const char *path,const char *name)
{
  QDir d(path);
  // store the original directory
2443 2444 2445
  if (!d.exists())
  {
    err("Error: Output dir %s does not exist!\n",path);
Dimitri van Heesch's avatar
Dimitri van Heesch committed
2446 2447 2448 2449
    return FALSE;
  }
  QCString oldDir = convertToQCString(QDir::currentDirPath());

Dimitri van Heesch's avatar
Dimitri van Heesch committed
2450
  // go to the html output directory (i.e. path)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463
  QDir::setCurrent(d.absPath());
  QDir thisDir;

  QCString combinedName = (QCString)path+"/combined.rtf";
  QCString mainRTFName  = (QCString)path+"/"+name;

  QFile outf(combinedName);
  if (!outf.open(IO_WriteOnly))
  {
    err("Failed to open %s for writing!\n",combinedName.data());
    return FALSE;
  }
  QTextStream outt(&outf);
2464
  outt.setEncoding(QTextStream::UnicodeUTF8);
Dimitri van Heesch's avatar
Dimitri van Heesch committed
2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479

  if (!PreProcessFile(thisDir,mainRTFName,outt))
  {
    // it failed, remove the temp file
    outf.close();
    thisDir.remove(combinedName);
    QDir::setCurrent(oldDir);
    return FALSE;
  }

  // everything worked, move the files
  outf.close();
  thisDir.remove(mainRTFName);
  thisDir.rename(combinedName,mainRTFName);

2480 2481
  testRTFOutput(mainRTFName);

Dimitri van Heesch's avatar
Dimitri van Heesch committed
2482 2483 2484
  QDir::setCurrent(oldDir);
  return TRUE;
}
Dimitri van Heesch's avatar
Dimitri van Heesch committed
2485

Dimitri van Heesch's avatar
Dimitri van Heesch committed
2486
void RTFGenerator::startMemberGroupHeader(bool hasHeader)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
2487
{
2488
  DBG_RTF(t << "{\\comment startMemberGroupHeader}" << endl)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
2489
  t << "{" << endl;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
2490
  if (hasHeader) incrementIndentLevel();
2491
  t << rtf_Style_Reset << rtf_Style["GroupHeader"]->reference;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
2492 2493 2494 2495
}

void RTFGenerator::endMemberGroupHeader()
{
2496
  DBG_RTF(t << "{\\comment endMemberGroupHeader}" << endl)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
2497
  newParagraph();
2498
  t << rtf_Style_Reset << rtf_CList_DepthStyle();
Dimitri van Heesch's avatar
Dimitri van Heesch committed
2499 2500 2501 2502
}

void RTFGenerator::startMemberGroupDocs()
{
2503
  DBG_RTF(t << "{\\comment startMemberGroupDocs}" << endl)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
2504 2505 2506 2507 2508
  startEmphasis();
}

void RTFGenerator::endMemberGroupDocs()
{
2509
  DBG_RTF(t << "{\\comment endMemberGroupDocs}" << endl)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
2510 2511 2512 2513 2514 2515
  endEmphasis();
  newParagraph();
}

void RTFGenerator::startMemberGroup()
{
2516
  DBG_RTF(t << "{\\comment startMemberGroup}" << endl)
2517
  t << rtf_Style_Reset << rtf_BList_DepthStyle() << endl;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
2518 2519
}

Dimitri van Heesch's avatar
Dimitri van Heesch committed
2520
void RTFGenerator::endMemberGroup(bool hasHeader)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
2521
{
2522
  DBG_RTF(t << "{\\comment endMemberGroup}" << endl)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
2523
  if (hasHeader) decrementIndentLevel();
Dimitri van Heesch's avatar
Dimitri van Heesch committed
2524 2525 2526
  t << "}";
}

2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545
void RTFGenerator::startSimpleSect(SectionTypes,const char *file,const char *anchor,const char *title)
{
  DBG_RTF(t << "{\\comment (startSimpleSect)}"    << endl)
  t << "{"; // ends at endDescList
  t << "{"; // ends at endDescTitle
  startBold();
  newParagraph();
  if (file)
  {
    writeObjectLink(0,file,anchor,title);
  }
  else
  {
    docify(title);
  }
  endBold();
  t << "}";
  newParagraph();
  incrementIndentLevel();
2546
  t << rtf_Style_Reset << rtf_DList_DepthStyle();
2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569
}

void RTFGenerator::endSimpleSect()
{
  DBG_RTF(t << "{\\comment (endSimpleSect)}"    << endl)
  newParagraph();
  decrementIndentLevel();
  m_omitParagraph = TRUE;
  t << "}";
}

void RTFGenerator::startParamList(ParamListTypes,const char *title)
{
  DBG_RTF(t << "{\\comment (startParamList)}"    << endl)
  t << "{"; // ends at endParamList
  t << "{"; // ends at endDescTitle
  startBold();
  newParagraph();
  docify(title);
  endBold();
  t << "}";
  newParagraph();
  incrementIndentLevel();
2570
  t << rtf_Style_Reset << rtf_DList_DepthStyle();
2571 2572 2573 2574 2575 2576 2577
}

void RTFGenerator::endParamList()
{
  DBG_RTF(t << "{\\comment (endParamList)}"    << endl)
  newParagraph();
  decrementIndentLevel();
Dimitri van Heesch's avatar
Dimitri van Heesch committed
2578
  m_omitParagraph = TRUE;
2579 2580 2581
  t << "}";
}

2582 2583 2584 2585 2586 2587 2588 2589 2590
void RTFGenerator::startParameterType(bool first,const char *key)
{
  DBG_RTF(t << "{\\comment (startParameterList)}"    << endl)
  if (!first)
  {
    t << " " << key << " ";
  }
}

2591
void RTFGenerator::printDoc(DocNode *n,const char *langExt)
2592
{
2593
  RTFDocVisitor *visitor = new RTFDocVisitor(t,*this,langExt);
2594 2595
  n->accept(visitor);
  delete visitor; 
2596
  m_omitParagraph = TRUE;
2597 2598
}

2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622
void RTFGenerator::rtfwriteRuler_doubleline() 
{ 
  DBG_RTF(t << "{\\comment (rtfwriteRuler_doubleline)}"    << endl)
  t << "{\\pard\\widctlpar\\brdrb\\brdrdb\\brdrw15\\brsp20 \\adjustright \\par}" << endl; 
}

void RTFGenerator::rtfwriteRuler_emboss() 
{ 
  DBG_RTF(t << "{\\comment (rtfwriteRuler_emboss)}"    << endl)
  t << "{\\pard\\widctlpar\\brdrb\\brdremboss\\brdrw15\\brsp20 \\adjustright \\par}" << endl; 
}

void RTFGenerator::rtfwriteRuler_thick() 
{ 
  DBG_RTF(t << "{\\comment (rtfwriteRuler_thick)}"    << endl)
  t << "{\\pard\\widctlpar\\brdrb\\brdrs\\brdrw75\\brsp20 \\adjustright \\par}" << endl; 
}

void RTFGenerator::rtfwriteRuler_thin() 
{ 
  DBG_RTF(t << "{\\comment (rtfwriteRuler_thin)}"    << endl)
  t << "{\\pard\\widctlpar\\brdrb\\brdrs\\brdrw5\\brsp20 \\adjustright \\par}" << endl; 
}

2623 2624 2625 2626 2627
void RTFGenerator::postProcess(QByteArray &a)
{
  QByteArray enc(a.size()*4); // worst case
  int off=0;
  uint i;
2628
  bool mbFlag=FALSE;
2629 2630 2631
  for (i=0;i<a.size();i++)
  {
    unsigned char c = (unsigned char)a.at(i);
2632 2633 2634 2635
    
    // treat characters > 0x80 as multibyte characters, except when they
    // are control characters 
    if (c>0x80 || (mbFlag && c!='\\' && c!='{' && c!='}'))
2636 2637 2638 2639 2640
    {
      char s[10];
      sprintf(s,"\\'%X",c);
      qstrcpy(enc.data()+off,s);
      off+=qstrlen(s);
2641
      mbFlag=c>0x80;
2642 2643 2644 2645 2646 2647 2648 2649 2650
    }
    else
    {
      enc.at(off++)=c;
    }
  }
  enc.resize(off);
  a = enc;
}
2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712

void RTFGenerator::startConstraintList(const char *header)
{
  DBG_RTF(t << "{\\comment (startConstraintList)}"    << endl)
  t << "{"; // ends at endConstraintList
  t << "{"; 
  startBold();
  newParagraph();
  docify(header);
  endBold();
  t << "}";
  newParagraph();
  incrementIndentLevel();
  t << rtf_Style_Reset << rtf_DList_DepthStyle();
}

void RTFGenerator::startConstraintParam()
{
  DBG_RTF(t << "{\\comment (startConstraintParam)}"    << endl)
  startEmphasis();
}

void RTFGenerator::endConstraintParam()
{
  DBG_RTF(t << "{\\comment (endConstraintParam)}"    << endl)
  endEmphasis();
  t << " : ";
}

void RTFGenerator::startConstraintType()
{
  DBG_RTF(t << "{\\comment (startConstraintType)}"    << endl)
  startEmphasis();
}

void RTFGenerator::endConstraintType()
{
  DBG_RTF(t << "{\\comment (endConstraintType)}"    << endl)
  endEmphasis();
  t << " ";
}

void RTFGenerator::startConstraintDocs()
{
  DBG_RTF(t << "{\\comment (startConstraintDocs)}"    << endl)
}

void RTFGenerator::endConstraintDocs()
{
  DBG_RTF(t << "{\\comment (endConstraintDocs)}"    << endl)
  newParagraph();
}

void RTFGenerator::endConstraintList()
{
  DBG_RTF(t << "{\\comment (endConstraintList)}"    << endl)
  newParagraph();
  decrementIndentLevel();
  m_omitParagraph = TRUE;
  t << "}";
}

2713 2714 2715 2716
void RTFGenerator::startIndexListItem()
{
  DBG_RTF(t << "{\\comment (startIndexListItem)}"    << endl)
}
2717

2718 2719 2720 2721 2722
void RTFGenerator::endIndexListItem()
{
  DBG_RTF(t << "{\\comment (endIndexListItem)}"    << endl)
  t << "\\par" << endl;
}
2723 2724