mangen.cpp 15.5 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
 *
Dimitri van Heesch's avatar
Dimitri van Heesch committed
5
 * Copyright (C) 1997-2013 by Dimitri van Heesch.
Dimitri van Heesch's avatar
Dimitri van Heesch committed
6 7 8 9 10 11 12
 *
 * Permission to use, copy, modify, and distribute this software and its
 * documentation under the terms of the GNU General Public License is hereby 
 * granted. No representations are made about the suitability of this software 
 * 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
13 14
 * 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
15 16 17
 *
 */

Dimitri van Heesch's avatar
Dimitri van Heesch committed
18 19 20
/* http://www.cubic.org/source/archive/fileform/txt/man/ has some
   nice introductions to groff and man pages. */

Dimitri van Heesch's avatar
Dimitri van Heesch committed
21
#include <stdlib.h>
22 23

#include <qdir.h>
Dimitri van Heesch's avatar
Dimitri van Heesch committed
24 25 26 27 28
#include "message.h"
#include "mangen.h"
#include "config.h"
#include "util.h"
#include "doxygen.h"
29
#include <string.h>
30
#include "docparser.h"
31
#include "mandocvisitor.h"
32
#include "language.h"
Dimitri van Heesch's avatar
Dimitri van Heesch committed
33

Dimitri van Heesch's avatar
Dimitri van Heesch committed
34 35
static QCString getExtension()
{
36 37 38 39 40
  /*
   * [.][nuber][rest]
   * in case of . missing, just ignore it
   * in case number missing, just place a 3 in front of it
   */
Dimitri van Heesch's avatar
Dimitri van Heesch committed
41
  QCString ext = Config_getString("MAN_EXTENSION");
42
  if (ext.isEmpty())
Dimitri van Heesch's avatar
Dimitri van Heesch committed
43
  {
44
    ext = "3"; 
Dimitri van Heesch's avatar
Dimitri van Heesch committed
45 46 47
  }
  else
  {
48 49 50 51 52 53 54 55 56 57 58 59 60 61 62
    if (ext.at(0)=='.')
    {
      if (ext.length()==1)
      {
        ext = "3"; 
      }
      else // strip .
      {
        ext = ext.mid(1);
      }
    }
    if (ext.at(0)<='0' || ext.at(0)>='9')
    {
      ext.prepend("3");
    }
Dimitri van Heesch's avatar
Dimitri van Heesch committed
63 64 65 66
  }
  return ext;
}

Dimitri van Heesch's avatar
Dimitri van Heesch committed
67 68
ManGenerator::ManGenerator() : OutputGenerator()
{
Dimitri van Heesch's avatar
Dimitri van Heesch committed
69
  dir=Config_getString("MAN_OUTPUT")+"/man" + getExtension();
Dimitri van Heesch's avatar
Dimitri van Heesch committed
70
  firstCol=TRUE;
71
  paragraph=TRUE;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
72 73
  col=0;
  upperCase=FALSE;
74
  insideTabbing=FALSE;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
75
  inHeader=FALSE;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
76 77 78 79 80 81
}

ManGenerator::~ManGenerator()
{
}

82 83 84 85 86 87 88 89 90 91 92 93 94 95 96
//void ManGenerator::append(const OutputGenerator *g)
//{
//  QCString r=g->getContents();
//  if (upperCase)
//    t << r.upper();
//  else
//    t << r;
//  if (!r.isEmpty())
//    firstCol = r.at(r.length()-1)=='\n';
//  else
//    firstCol = ((ManGenerator *)g)->firstCol;
//  col+=((ManGenerator *)g)->col;
//  inHeader=((ManGenerator *)g)->inHeader;
//  paragraph=FALSE;
//}
Dimitri van Heesch's avatar
Dimitri van Heesch committed
97 98 99

void ManGenerator::init()
{
Dimitri van Heesch's avatar
Dimitri van Heesch committed
100 101 102 103 104
  QCString ext = getExtension();
  QCString &manOutput = Config_getString("MAN_OUTPUT");
  
  QDir d(manOutput);
  if (!d.exists() && !d.mkdir(manOutput))
Dimitri van Heesch's avatar
Dimitri van Heesch committed
105
  {
Dimitri van Heesch's avatar
Dimitri van Heesch committed
106
    err("Could not create output directory %s\n",manOutput.data());
Dimitri van Heesch's avatar
Dimitri van Heesch committed
107 108
    exit(1);
  }
Dimitri van Heesch's avatar
Dimitri van Heesch committed
109 110
  d.setPath(manOutput+"/man"+ext);
  if (!d.exists() && !d.mkdir(manOutput+"/man"+ext))
Dimitri van Heesch's avatar
Dimitri van Heesch committed
111
  {
Dimitri van Heesch's avatar
Dimitri van Heesch committed
112
    err("Could not create output directory %s/man%s\n",manOutput.data(),ext.data());
Dimitri van Heesch's avatar
Dimitri van Heesch committed
113 114
    exit(1);
  }
115
  createSubDirs(d);
Dimitri van Heesch's avatar
Dimitri van Heesch committed
116 117
}

118
static QCString buildFileName(const char *name)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
119
{
Dimitri van Heesch's avatar
Dimitri van Heesch committed
120
  QCString fileName;
121
  if (name==0) return "noname";
122

Dimitri van Heesch's avatar
Dimitri van Heesch committed
123 124 125
  const char *p=name;
  char c;
  while ((c=*p++))
Dimitri van Heesch's avatar
Dimitri van Heesch committed
126
  {
Dimitri van Heesch's avatar
Dimitri van Heesch committed
127 128 129 130 131 132 133 134 135 136 137 138 139 140 141
    switch (c)
    {
      case ':':
        fileName+="_";
        if (*p==':') p++;
        break;
      case '<':
      case '>':
      case '&':
      case '*':
      case '!':
      case '^':
      case '~':
      case '%':
      case '+':
Dimitri van Heesch's avatar
Dimitri van Heesch committed
142
      case '/':
Dimitri van Heesch's avatar
Dimitri van Heesch committed
143 144 145 146 147
        fileName+="_";
        break;
      default:
        fileName+=c;
    }
Dimitri van Heesch's avatar
Dimitri van Heesch committed
148
  }
149

150 151
  QCString manExtension = "." + getExtension();
  if (fileName.right(manExtension.length())!=manExtension) 
152
  {
Dimitri van Heesch's avatar
Dimitri van Heesch committed
153
    fileName+=manExtension;
154
  }
155 156 157 158

  return fileName;
}

159
void ManGenerator::startFile(const char *,const char *manName,const char *)
160 161
{
  startPlainFile( buildFileName( manName ) );
Dimitri van Heesch's avatar
Dimitri van Heesch committed
162 163 164 165 166
  firstCol=TRUE;
}

void ManGenerator::endFile()
{
Dimitri van Heesch's avatar
Dimitri van Heesch committed
167
  t << endl;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
168 169 170
  endPlainFile();
}

171
void ManGenerator::endTitleHead(const char *,const char *name)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
172
{
Dimitri van Heesch's avatar
Dimitri van Heesch committed
173 174
  t << ".TH \"" << name << "\" " << getExtension() << " \"" 
    << dateToString(FALSE) << "\" \"";
175 176
  if (!Config_getString("PROJECT_NUMBER").isEmpty())
    t << "Version " << Config_getString("PROJECT_NUMBER") << "\" \"";
177
  if (Config_getString("PROJECT_NAME").isEmpty()) 
Dimitri van Heesch's avatar
Dimitri van Heesch committed
178 179
    t << "Doxygen";
  else
180
    t << Config_getString("PROJECT_NAME");
Dimitri van Heesch's avatar
Dimitri van Heesch committed
181 182 183 184 185 186
  t << "\" \\\" -*- nroff -*-" << endl;
  t << ".ad l" << endl;
  t << ".nh" << endl;
  t << ".SH NAME" << endl;
  t << name << " \\- ";
  firstCol=FALSE;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
187
  inHeader=TRUE;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
188 189 190 191 192 193 194 195 196 197 198 199 200
}

void ManGenerator::newParagraph()
{
  if (!paragraph)
  {
    if (!firstCol) t << endl;
    t << ".PP" << endl;
    firstCol=TRUE;
  }
  paragraph=TRUE;
}

201 202 203 204 205 206 207 208 209 210 211 212 213 214 215
void ManGenerator::startParagraph()
{
  if (!paragraph)
  {
    if (!firstCol) t << endl;
    t << ".PP" << endl;
    firstCol=TRUE;
  }
  paragraph=TRUE;
}

void ManGenerator::endParagraph()
{
}

Dimitri van Heesch's avatar
Dimitri van Heesch committed
216 217 218 219 220
void ManGenerator::writeString(const char *text)
{
  docify(text);
}

221 222 223 224 225
void ManGenerator::startIndexItem(const char *,const char *)
{
}

void ManGenerator::endIndexItem(const char *,const char *)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240
{
}

void ManGenerator::writeStartAnnoItem(const char *,const char *,
                                       const char *,const char *)
{
}

void ManGenerator::writeObjectLink(const char *,const char *,
                                    const char *, const char *name)
{
  startBold(); docify(name); endBold();
}

void ManGenerator::writeCodeLink(const char *,const char *,
241 242
                                 const char *, const char *name,
                                 const char *)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
243 244 245 246
{
  docify(name);
}

Dimitri van Heesch's avatar
Dimitri van Heesch committed
247 248 249 250 251
void ManGenerator::startHtmlLink(const char *)
{
}

void ManGenerator::endHtmlLink()
Dimitri van Heesch's avatar
Dimitri van Heesch committed
252 253 254
{
}

255 256 257 258
//void ManGenerator::writeMailLink(const char *url)
//{
//  docify(url);
//}
259

Dimitri van Heesch's avatar
Dimitri van Heesch committed
260
void ManGenerator::startGroupHeader(int)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
261 262
{
  if (!firstCol) t << endl;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
263
  t << ".SH \"";
Dimitri van Heesch's avatar
Dimitri van Heesch committed
264 265 266 267
  upperCase=TRUE;
  firstCol=FALSE;
}

Dimitri van Heesch's avatar
Dimitri van Heesch committed
268
void ManGenerator::endGroupHeader(int)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
269
{
Dimitri van Heesch's avatar
Dimitri van Heesch committed
270
  t << "\"\n.PP " << endl;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
271 272 273 274 275
  firstCol=TRUE;
  paragraph=TRUE;
  upperCase=FALSE;
}

276
void ManGenerator::startMemberHeader(const char *)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
277 278
{
  if (!firstCol) t << endl;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
279
  t << ".SS \"";
Dimitri van Heesch's avatar
Dimitri van Heesch committed
280 281 282 283
}

void ManGenerator::endMemberHeader()
{
Dimitri van Heesch's avatar
Dimitri van Heesch committed
284
  t << "\"\n";
Dimitri van Heesch's avatar
Dimitri van Heesch committed
285 286 287 288 289 290 291 292 293 294 295 296 297 298
  firstCol=TRUE;
  paragraph=FALSE;
}

void ManGenerator::docify(const char *str)
{
  if (str)
  {
    const char *p=str;
    char c=0;
    while ((c=*p++)) 
    {
      switch(c)
      {
Dimitri van Heesch's avatar
Dimitri van Heesch committed
299
        case '.':  t << "\\&."; break; // see  bug652277
Dimitri van Heesch's avatar
Dimitri van Heesch committed
300 301
        case '\\': t << "\\\\"; col++; break;
        case '\n': t << "\n"; col=0; break;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
302
        case '\"':  c = '\''; // no break!
Dimitri van Heesch's avatar
Dimitri van Heesch committed
303 304 305 306 307 308 309 310 311 312 313
        default: t << c; col++; break;
      }
    }
    firstCol=(c=='\n');
    //printf("%s",str);fflush(stdout);
  }
  paragraph=FALSE;
}

void ManGenerator::codify(const char *str)
{
314
  //static char spaces[]="        ";
Dimitri van Heesch's avatar
Dimitri van Heesch committed
315 316 317 318
  if (str)
  {
    const char *p=str;
    char c;
319
    int spacesToNextTabStop;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
320 321 322 323 324
    while (*p)
    {
      c=*p++;
      switch(c)
      {
Dimitri van Heesch's avatar
Dimitri van Heesch committed
325
        case '.':   t << "\\&."; break; // see  bug652277
326
        case '\t':  spacesToNextTabStop =
327
                          Config_getInt("TAB_SIZE") - (col%Config_getInt("TAB_SIZE"));
328
                    t << Doxygen::spaces.left(spacesToNextTabStop); 
329 330
                    col+=spacesToNextTabStop; 
                    break;
331 332
        case '\n':  t << "\n"; firstCol=TRUE; col=0; break;
        case '\\':  t << "\\"; col++; break;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
333
        case '\"':  c = '\''; // no break!
334
        default:    p=writeUtf8Char(t,p-1); firstCol=FALSE; col++; break;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
335 336 337 338 339 340 341 342 343 344 345 346 347 348
      }
    }
    //printf("%s",str);fflush(stdout);
  }
  paragraph=FALSE;
}

void ManGenerator::writeChar(char c)
{
  firstCol=(c=='\n');
  if (firstCol) col=0; else col++;
  switch (c)
  {
    case '\\': t << "\\\\"; break;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
349
  case '\"': c = '\''; // no break!
Dimitri van Heesch's avatar
Dimitri van Heesch committed
350 351 352 353 354 355
    default:   t << c; break;
  }
  //printf("%c",c);fflush(stdout);
  paragraph=FALSE;
}

356 357 358 359 360 361 362 363
void ManGenerator::startDescList(SectionTypes)      
{
  if (!firstCol) 
  { t << endl << ".PP" << endl; 
    firstCol=TRUE; paragraph=TRUE; 
    col=0;
  }
  paragraph=FALSE;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
364
  startBold();
365 366
}

Dimitri van Heesch's avatar
Dimitri van Heesch committed
367 368 369
void ManGenerator::startTitle() 
{ 
  if (!firstCol) t << endl; 
Dimitri van Heesch's avatar
Dimitri van Heesch committed
370
  t << ".SH \""; 
Dimitri van Heesch's avatar
Dimitri van Heesch committed
371 372 373 374
  firstCol=FALSE;
  paragraph=FALSE;
}

Dimitri van Heesch's avatar
Dimitri van Heesch committed
375 376 377 378 379
void ManGenerator::endTitle()
{
    t << "\"";
}

380
void ManGenerator::startItemListItem() 
Dimitri van Heesch's avatar
Dimitri van Heesch committed
381 382 383 384 385 386 387 388
{ 
  if (!firstCol) t << endl; 
  t << ".TP" << endl; 
  firstCol=TRUE;
  paragraph=FALSE;
  col=0;
} 

389 390 391 392
void ManGenerator::endItemListItem()
{
}

Dimitri van Heesch's avatar
Dimitri van Heesch committed
393 394 395
void ManGenerator::startCodeFragment() 
{ 
  newParagraph();
Dimitri van Heesch's avatar
Dimitri van Heesch committed
396 397
  t << ".nf" << endl; 
  firstCol=TRUE;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
398 399 400 401 402 403 404 405 406 407 408 409
  paragraph=FALSE;
}

void ManGenerator::endCodeFragment()   
{ 
  if (!firstCol) t << endl;
  t << ".fi" << endl; 
  firstCol=TRUE;
  paragraph=FALSE;
  col=0;
}

Dimitri van Heesch's avatar
Dimitri van Heesch committed
410
void ManGenerator::startMemberDoc(const char *,const char *,const char *,const char *,bool) 
Dimitri van Heesch's avatar
Dimitri van Heesch committed
411 412
{ 
  if (!firstCol) t << endl;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
413
  t << ".SS \""; 
Dimitri van Heesch's avatar
Dimitri van Heesch committed
414 415 416 417
  firstCol=FALSE;
  paragraph=FALSE;
}

Dimitri van Heesch's avatar
Dimitri van Heesch committed
418
void ManGenerator::startDoxyAnchor(const char *,const char *manName,
419 420
                                   const char *, const char *name,
                                   const char *)
421 422 423 424 425 426 427
{
    // something to be done?
    if( !Config_getBool("MAN_LINKS") ) 
    {
	return; // no
    }

428 429 430
    // the name of the link file is derived from the name of the anchor:
    // - truncate after an (optional) ::
    QCString baseName = name;
431
    int i=baseName.findRev("::");
432 433 434 435
    if (i!=-1) baseName=baseName.right(baseName.length()-i-2);

    //printf("Converting man link '%s'->'%s'->'%s'\n",
    //       name,baseName.data(),buildFileName(baseName).data());
436 437 438
    
    // - remove dangerous characters and append suffix, then add dir prefix
    QCString fileName=dir+"/"+buildFileName( baseName );
439
    QFile linkfile( fileName );
440
    // - only create file if it doesn't exist already
441 442 443 444
    if ( !linkfile.open( IO_ReadOnly ) ) 
    {
	if ( linkfile.open( IO_WriteOnly ) ) 
        {
445
	      FTextStream linkstream;
446
	      linkstream.setDevice(&linkfile);
447
	      //linkstream.setEncoding(QTextStream::UnicodeUTF8);
Dimitri van Heesch's avatar
Dimitri van Heesch committed
448
	      linkstream << ".so man" << getExtension() << "/" << buildFileName( manName ) << endl;
449 450 451 452 453
	}
    }
    linkfile.close();
}

454
void ManGenerator::endMemberDoc(bool)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
455
{
456
    t << "\"\n";
Dimitri van Heesch's avatar
Dimitri van Heesch committed
457 458
}

Dimitri van Heesch's avatar
Dimitri van Heesch committed
459 460 461
void ManGenerator::startSubsection()    
{ 
  if (!firstCol) t << endl;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
462
  t << ".SS \""; 
Dimitri van Heesch's avatar
Dimitri van Heesch committed
463 464 465 466
  firstCol=FALSE;
  paragraph=FALSE;
}

Dimitri van Heesch's avatar
Dimitri van Heesch committed
467 468 469 470 471 472
void ManGenerator::endSubsection()
{
  t << "\"";
}


Dimitri van Heesch's avatar
Dimitri van Heesch committed
473 474 475
void ManGenerator::startSubsubsection() 
{ 
  if (!firstCol) t << endl;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
476
  t << "\n.SS \""; 
Dimitri van Heesch's avatar
Dimitri van Heesch committed
477 478 479 480
  firstCol=FALSE;
  paragraph=FALSE;
}

Dimitri van Heesch's avatar
Dimitri van Heesch committed
481 482 483 484 485
void ManGenerator::endSubsubsection()
{
  t << "\"";
}

Dimitri van Heesch's avatar
Dimitri van Heesch committed
486 487 488 489 490 491 492 493 494 495 496 497 498 499 500
void ManGenerator::writeSynopsis()      
{ 
  if (!firstCol) t << endl;
  t << ".SH SYNOPSIS\n.br\n.PP\n"; 
  firstCol=TRUE;
  paragraph=FALSE;
}

void ManGenerator::startDescItem()
{
  if (!firstCol) t << endl;
  t << ".IP \"";
  firstCol=FALSE;
}

501 502 503 504 505
//void ManGenerator::endDescTitle()
//{
//  endBold();
//  paragraph=TRUE;
//}
Dimitri van Heesch's avatar
Dimitri van Heesch committed
506

507
void ManGenerator::startDescForItem()
Dimitri van Heesch's avatar
Dimitri van Heesch committed
508 509 510 511 512 513 514 515 516
{
  if (!firstCol) t << endl;
  if (!paragraph) t << ".in -1c" << endl;
  t << ".in +1c" << endl;
  firstCol=TRUE;
  paragraph=FALSE;
  col=0;
}

517 518 519 520
void ManGenerator::endDescForItem()
{
}

Dimitri van Heesch's avatar
Dimitri van Heesch committed
521 522 523 524 525
void ManGenerator::endDescItem()
{
  t << "\" 1c" << endl;
  firstCol=TRUE;
}
526

527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543
void ManGenerator::startAnonTypeScope(int indentLevel)
{
  if (indentLevel==0)
  {
    insideTabbing=TRUE;
  }
}

void ManGenerator::endAnonTypeScope(int indentLevel)
{
  if (indentLevel==0)
  {
    insideTabbing=FALSE;
  }
}


544
void ManGenerator::startMemberItem(const char *,int,const char *) 
545 546 547 548 549 550
{ 
  if (firstCol && !insideTabbing) t << ".in +1c\n";
  t << "\n.ti -1c\n.RI \""; 
  firstCol=FALSE;
}

551
void ManGenerator::endMemberItem() 
552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571
{ 
  t << "\"\n.br"; 
}

void ManGenerator::startMemberList() 
{ 
  if (!insideTabbing)
  {
    t << "\n.in +1c"; firstCol=FALSE; 
  }
}

void ManGenerator::endMemberList() 
{ 
  if (!insideTabbing)
  {
    t << "\n.in -1c"; firstCol=FALSE; 
  }
}

Dimitri van Heesch's avatar
Dimitri van Heesch committed
572
void ManGenerator::startMemberGroupHeader(bool)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
573 574 575 576 577 578
{
  t << "\n.PP\n.RI \"\\fB";
}

void ManGenerator::endMemberGroupHeader()
{
Dimitri van Heesch's avatar
Dimitri van Heesch committed
579
  t << "\\fP\"\n.br\n";
Dimitri van Heesch's avatar
Dimitri van Heesch committed
580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601
  firstCol=TRUE;
}

void ManGenerator::startMemberGroupDocs()
{
}

void ManGenerator::endMemberGroupDocs()
{
  t << "\n.PP";
}

void ManGenerator::startMemberGroup()
{
  t << "\n.in +1c";
}

void ManGenerator::endMemberGroup(bool)
{
  t << "\n.in -1c";
  firstCol=FALSE;
}
Dimitri van Heesch's avatar
Dimitri van Heesch committed
602

603
void ManGenerator::startSection(const char *,const char *,SectionInfo::SectionType type)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
604 605 606
{
  if( !inHeader ) 
  {
607
    switch(type)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
608
    {
Dimitri van Heesch's avatar
Dimitri van Heesch committed
609 610
      case SectionInfo::Page:          startGroupHeader(FALSE); break;
      case SectionInfo::Section:       startGroupHeader(FALSE); break;
611 612 613
      case SectionInfo::Subsection:    startMemberHeader(0); break;
      case SectionInfo::Subsubsection: startMemberHeader(0); break;
      case SectionInfo::Paragraph:     startMemberHeader(0); break;
614
      default: ASSERT(0); break;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
615 616 617 618
    }
  }
}

619
void ManGenerator::endSection(const char *,SectionInfo::SectionType type)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
620 621 622
{
  if( !inHeader )
  {
623
    switch(type)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
624
    {
Dimitri van Heesch's avatar
Dimitri van Heesch committed
625 626
      case SectionInfo::Page:          endGroupHeader(0); break;
      case SectionInfo::Section:       endGroupHeader(0); break;
627 628 629
      case SectionInfo::Subsection:    endMemberHeader(); break;
      case SectionInfo::Subsubsection: endMemberHeader(); break;
      case SectionInfo::Paragraph:     endMemberHeader(); break;
630
      default: ASSERT(0); break;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
631 632 633 634 635 636 637 638 639 640 641
    }
  }
  else
  {
    t << "\n";
    firstCol=TRUE;
    paragraph=FALSE;
    inHeader=FALSE;
  }
}

642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677
void ManGenerator::startSimpleSect(SectionTypes,const char *,
                                   const char *,const char *title)
{
  if (!firstCol) 
  { t << endl << ".PP" << endl; 
    firstCol=TRUE; paragraph=TRUE; 
    col=0;
  }
  paragraph=FALSE;
  startBold();
  docify(title);
  endBold();
  paragraph=TRUE;
}

void ManGenerator::endSimpleSect()
{
}

void ManGenerator::startParamList(ParamListTypes,const char *title)
{
  if (!firstCol) 
  { t << endl << ".PP" << endl; 
    firstCol=TRUE; paragraph=TRUE; 
    col=0;
  }
  paragraph=FALSE;
  startBold();
  docify(title);
  endBold();
  paragraph=TRUE;
}

void ManGenerator::endParamList()
{
}
Dimitri van Heesch's avatar
Dimitri van Heesch committed
678

Dimitri van Heesch's avatar
Dimitri van Heesch committed
679
void ManGenerator::writeDoc(DocNode *n,Definition *ctx,MemberDef *)
680
{
Dimitri van Heesch's avatar
Dimitri van Heesch committed
681
  ManDocVisitor *visitor = new ManDocVisitor(t,*this,ctx?ctx->getDefFileExtension():QCString(""));
682 683
  n->accept(visitor);
  delete visitor; 
684
  firstCol=FALSE;
685
  paragraph = FALSE;
686 687
}

688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703
void ManGenerator::startConstraintList(const char *header)
{
  if (!firstCol) 
  { t << endl << ".PP" << endl; 
    firstCol=TRUE; paragraph=TRUE; 
    col=0;
  }
  paragraph=FALSE;
  startBold();
  docify(header);
  endBold();
  paragraph=TRUE;
}

void ManGenerator::startConstraintParam()
{
704
  startItemListItem();
705 706 707 708 709 710
  startEmphasis();
}

void ManGenerator::endConstraintParam()
{
  endEmphasis();
711
  endItemListItem();
712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737
  t << " : ";
}

void ManGenerator::startConstraintType()
{
  startEmphasis();
}

void ManGenerator::endConstraintType()
{
  endEmphasis();
}

void ManGenerator::startConstraintDocs()
{
}

void ManGenerator::endConstraintDocs()
{
  t << endl; firstCol=TRUE;
}

void ManGenerator::endConstraintList()
{
}

Dimitri van Heesch's avatar
Dimitri van Heesch committed
738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753

void ManGenerator::startInlineHeader() 
{
  if (!firstCol) 
  {
    t << endl << ".PP" << endl << ".in -1c" << endl;
  }
  t << ".RI \"\\fB"; 
}

void ManGenerator::endInlineHeader() 
{
  t << "\\fP\"" << endl << ".in +1c" << endl;
  firstCol = FALSE;
}

754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781
void ManGenerator::startMemberDocSimple()
{
  if (!firstCol) 
  {
    t << endl << ".PP" << endl;
  }
  t << "\\fB";
  docify(theTranslator->trCompoundMembers());
  t << ":\\fP" << endl;
  t << ".RS 4" << endl;
}

void ManGenerator::endMemberDocSimple()
{
  if (!firstCol) t << endl;
  t << ".RE" << endl;
  t << ".PP" << endl;
  firstCol=TRUE;
}

void ManGenerator::startInlineMemberType()
{
}

void ManGenerator::endInlineMemberType()
{
  t << " ";
}
782

783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803
void ManGenerator::startInlineMemberName()
{
  t << "\\fI";
}

void ManGenerator::endInlineMemberName()
{
  t << "\\fP ";
}

void ManGenerator::startInlineMemberDoc()
{
}

void ManGenerator::endInlineMemberDoc()
{
  if (!firstCol) t << endl;
  t << ".br" << endl;
  t << ".PP" << endl;
  firstCol=TRUE;
}
804

805 806 807 808 809 810 811 812 813 814 815 816 817 818
void ManGenerator::startLabels()
{
}

void ManGenerator::writeLabel(const char *l,bool isLast)
{
  t << "\\fC [" << l << "]\\fP";
  if (!isLast) t << ", ";
}

void ManGenerator::endLabels()
{
}

819 820 821 822 823 824 825 826
void ManGenerator::endHeaderSection()
{
  if (!firstCol) 
  { 
    t<< endl; firstCol=TRUE; 
  }
}

827