mangen.cpp 15.7 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-2014 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
    if (ext.at(0)=='.')
    {
      if (ext.length()==1)
      {
        ext = "3"; 
      }
      else // strip .
      {
        ext = ext.mid(1);
      }
    }
59
    if (ext.at(0)<'0' || ext.at(0)>'9')
60 61 62
    {
      ext.prepend("3");
    }
Dimitri van Heesch's avatar
Dimitri van Heesch committed
63 64 65 66
  }
  return ext;
}

67 68 69 70 71 72 73 74 75 76
static QCString getSubdir()
{
  QCString dir = Config_getString("MAN_SUBDIR");
  if (dir.isEmpty())
  {
    dir = "man" + getExtension();
  }
  return dir;
}

Dimitri van Heesch's avatar
Dimitri van Heesch committed
77 78
ManGenerator::ManGenerator() : OutputGenerator()
{
79
  dir=Config_getString("MAN_OUTPUT") + "/" + getSubdir();
Dimitri van Heesch's avatar
Dimitri van Heesch committed
80
  firstCol=TRUE;
81
  paragraph=TRUE;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
82 83
  col=0;
  upperCase=FALSE;
84
  insideTabbing=FALSE;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
85
  inHeader=FALSE;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
86 87 88 89 90 91
}

ManGenerator::~ManGenerator()
{
}

92 93 94 95 96 97 98 99 100 101 102 103 104 105 106
//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
107 108 109

void ManGenerator::init()
{
Dimitri van Heesch's avatar
Dimitri van Heesch committed
110 111 112 113 114
  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
115
  {
Dimitri van Heesch's avatar
Dimitri van Heesch committed
116
    err("Could not create output directory %s\n",manOutput.data());
Dimitri van Heesch's avatar
Dimitri van Heesch committed
117 118
    exit(1);
  }
119 120
  d.setPath(manOutput + "/" + getSubdir());
  if (!d.exists() && !d.mkdir(manOutput + "/" + getSubdir()))
Dimitri van Heesch's avatar
Dimitri van Heesch committed
121
  {
122
    err("Could not create output directory %s/%s\n",manOutput.data(), getSubdir().data());
Dimitri van Heesch's avatar
Dimitri van Heesch committed
123 124
    exit(1);
  }
125
  createSubDirs(d);
Dimitri van Heesch's avatar
Dimitri van Heesch committed
126 127
}

128
static QCString buildFileName(const char *name)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
129
{
Dimitri van Heesch's avatar
Dimitri van Heesch committed
130
  QCString fileName;
131
  if (name==0) return "noname";
132

Dimitri van Heesch's avatar
Dimitri van Heesch committed
133 134 135
  const char *p=name;
  char c;
  while ((c=*p++))
Dimitri van Heesch's avatar
Dimitri van Heesch committed
136
  {
Dimitri van Heesch's avatar
Dimitri van Heesch committed
137 138 139 140 141 142 143 144 145 146 147 148 149 150 151
    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
152
      case '/':
Dimitri van Heesch's avatar
Dimitri van Heesch committed
153 154 155 156 157
        fileName+="_";
        break;
      default:
        fileName+=c;
    }
Dimitri van Heesch's avatar
Dimitri van Heesch committed
158
  }
159

160 161
  QCString manExtension = "." + getExtension();
  if (fileName.right(manExtension.length())!=manExtension) 
162
  {
Dimitri van Heesch's avatar
Dimitri van Heesch committed
163
    fileName+=manExtension;
164
  }
165 166 167 168

  return fileName;
}

169
void ManGenerator::startFile(const char *,const char *manName,const char *)
170 171
{
  startPlainFile( buildFileName( manName ) );
Dimitri van Heesch's avatar
Dimitri van Heesch committed
172 173 174 175 176
  firstCol=TRUE;
}

void ManGenerator::endFile()
{
Dimitri van Heesch's avatar
Dimitri van Heesch committed
177
  t << endl;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
178 179 180
  endPlainFile();
}

181
void ManGenerator::endTitleHead(const char *,const char *name)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
182
{
Dimitri van Heesch's avatar
Dimitri van Heesch committed
183 184
  t << ".TH \"" << name << "\" " << getExtension() << " \"" 
    << dateToString(FALSE) << "\" \"";
185 186
  if (!Config_getString("PROJECT_NUMBER").isEmpty())
    t << "Version " << Config_getString("PROJECT_NUMBER") << "\" \"";
187
  if (Config_getString("PROJECT_NAME").isEmpty()) 
Dimitri van Heesch's avatar
Dimitri van Heesch committed
188 189
    t << "Doxygen";
  else
190
    t << Config_getString("PROJECT_NAME");
Dimitri van Heesch's avatar
Dimitri van Heesch committed
191 192 193 194 195 196
  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
197
  inHeader=TRUE;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
198 199 200 201 202 203 204 205 206 207 208 209 210
}

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

211 212 213 214 215 216 217 218 219 220 221 222 223 224 225
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
226 227 228 229 230
void ManGenerator::writeString(const char *text)
{
  docify(text);
}

231 232 233 234 235
void ManGenerator::startIndexItem(const char *,const char *)
{
}

void ManGenerator::endIndexItem(const char *,const char *)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250
{
}

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 *,
251 252
                                 const char *, const char *name,
                                 const char *)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
253 254 255 256
{
  docify(name);
}

Dimitri van Heesch's avatar
Dimitri van Heesch committed
257 258 259 260 261
void ManGenerator::startHtmlLink(const char *)
{
}

void ManGenerator::endHtmlLink()
Dimitri van Heesch's avatar
Dimitri van Heesch committed
262 263 264
{
}

265 266 267 268
//void ManGenerator::writeMailLink(const char *url)
//{
//  docify(url);
//}
269

Dimitri van Heesch's avatar
Dimitri van Heesch committed
270
void ManGenerator::startGroupHeader(int)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
271 272
{
  if (!firstCol) t << endl;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
273
  t << ".SH \"";
Dimitri van Heesch's avatar
Dimitri van Heesch committed
274 275 276 277
  upperCase=TRUE;
  firstCol=FALSE;
}

Dimitri van Heesch's avatar
Dimitri van Heesch committed
278
void ManGenerator::endGroupHeader(int)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
279
{
Dimitri van Heesch's avatar
Dimitri van Heesch committed
280
  t << "\"\n.PP " << endl;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
281 282 283 284 285
  firstCol=TRUE;
  paragraph=TRUE;
  upperCase=FALSE;
}

286
void ManGenerator::startMemberHeader(const char *)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
287 288
{
  if (!firstCol) t << endl;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
289
  t << ".SS \"";
Dimitri van Heesch's avatar
Dimitri van Heesch committed
290 291 292 293
}

void ManGenerator::endMemberHeader()
{
Dimitri van Heesch's avatar
Dimitri van Heesch committed
294
  t << "\"\n";
Dimitri van Heesch's avatar
Dimitri van Heesch committed
295 296 297 298 299 300 301 302 303 304 305 306 307 308
  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
309
        case '.':  t << "\\&."; break; // see  bug652277
Dimitri van Heesch's avatar
Dimitri van Heesch committed
310 311
        case '\\': t << "\\\\"; col++; break;
        case '\n': t << "\n"; col=0; break;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
312
        case '\"':  c = '\''; // no break!
Dimitri van Heesch's avatar
Dimitri van Heesch committed
313 314 315 316 317 318 319 320 321 322 323
        default: t << c; col++; break;
      }
    }
    firstCol=(c=='\n');
    //printf("%s",str);fflush(stdout);
  }
  paragraph=FALSE;
}

void ManGenerator::codify(const char *str)
{
324
  //static char spaces[]="        ";
Dimitri van Heesch's avatar
Dimitri van Heesch committed
325 326 327 328
  if (str)
  {
    const char *p=str;
    char c;
329
    int spacesToNextTabStop;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
330 331 332 333 334
    while (*p)
    {
      c=*p++;
      switch(c)
      {
Dimitri van Heesch's avatar
Dimitri van Heesch committed
335
        case '.':   t << "\\&."; break; // see  bug652277
336
        case '\t':  spacesToNextTabStop =
337
                          Config_getInt("TAB_SIZE") - (col%Config_getInt("TAB_SIZE"));
338
                    t << Doxygen::spaces.left(spacesToNextTabStop); 
339 340
                    col+=spacesToNextTabStop; 
                    break;
341 342
        case '\n':  t << "\n"; firstCol=TRUE; col=0; break;
        case '\\':  t << "\\"; col++; break;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
343
        case '\"':  c = '\''; // no break!
344
        default:    p=writeUtf8Char(t,p-1); firstCol=FALSE; col++; break;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
345 346 347 348 349 350 351 352 353 354 355 356 357 358
      }
    }
    //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
359
  case '\"': c = '\''; // no break!
Dimitri van Heesch's avatar
Dimitri van Heesch committed
360 361 362 363 364 365
    default:   t << c; break;
  }
  //printf("%c",c);fflush(stdout);
  paragraph=FALSE;
}

366 367 368 369 370 371 372 373
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
374
  startBold();
375 376
}

Dimitri van Heesch's avatar
Dimitri van Heesch committed
377 378 379
void ManGenerator::startTitle() 
{ 
  if (!firstCol) t << endl; 
Dimitri van Heesch's avatar
Dimitri van Heesch committed
380
  t << ".SH \""; 
Dimitri van Heesch's avatar
Dimitri van Heesch committed
381 382 383 384
  firstCol=FALSE;
  paragraph=FALSE;
}

Dimitri van Heesch's avatar
Dimitri van Heesch committed
385 386 387 388 389
void ManGenerator::endTitle()
{
    t << "\"";
}

390
void ManGenerator::startItemListItem() 
Dimitri van Heesch's avatar
Dimitri van Heesch committed
391 392 393 394 395 396 397 398
{ 
  if (!firstCol) t << endl; 
  t << ".TP" << endl; 
  firstCol=TRUE;
  paragraph=FALSE;
  col=0;
} 

399 400 401 402
void ManGenerator::endItemListItem()
{
}

Dimitri van Heesch's avatar
Dimitri van Heesch committed
403 404 405
void ManGenerator::startCodeFragment() 
{ 
  newParagraph();
Dimitri van Heesch's avatar
Dimitri van Heesch committed
406 407
  t << ".nf" << endl; 
  firstCol=TRUE;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
408 409 410 411 412 413 414 415 416 417 418 419
  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
420
void ManGenerator::startMemberDoc(const char *,const char *,const char *,const char *,bool) 
Dimitri van Heesch's avatar
Dimitri van Heesch committed
421 422
{ 
  if (!firstCol) t << endl;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
423
  t << ".SS \""; 
Dimitri van Heesch's avatar
Dimitri van Heesch committed
424 425 426 427
  firstCol=FALSE;
  paragraph=FALSE;
}

Dimitri van Heesch's avatar
Dimitri van Heesch committed
428
void ManGenerator::startDoxyAnchor(const char *,const char *manName,
429 430
                                   const char *, const char *name,
                                   const char *)
431 432 433 434 435 436 437
{
    // something to be done?
    if( !Config_getBool("MAN_LINKS") ) 
    {
	return; // no
    }

438 439 440
    // the name of the link file is derived from the name of the anchor:
    // - truncate after an (optional) ::
    QCString baseName = name;
441
    int i=baseName.findRev("::");
442 443 444 445
    if (i!=-1) baseName=baseName.right(baseName.length()-i-2);

    //printf("Converting man link '%s'->'%s'->'%s'\n",
    //       name,baseName.data(),buildFileName(baseName).data());
446 447 448
    
    // - remove dangerous characters and append suffix, then add dir prefix
    QCString fileName=dir+"/"+buildFileName( baseName );
449
    QFile linkfile( fileName );
450
    // - only create file if it doesn't exist already
451 452 453 454
    if ( !linkfile.open( IO_ReadOnly ) ) 
    {
	if ( linkfile.open( IO_WriteOnly ) ) 
        {
455
	      FTextStream linkstream;
456
	      linkstream.setDevice(&linkfile);
457
	      //linkstream.setEncoding(QTextStream::UnicodeUTF8);
458
	      linkstream << ".so " << getSubdir() << "/" << buildFileName( manName ) << endl;
459 460 461 462 463
	}
    }
    linkfile.close();
}

464
void ManGenerator::endMemberDoc(bool)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
465
{
466
    t << "\"\n";
Dimitri van Heesch's avatar
Dimitri van Heesch committed
467 468
}

Dimitri van Heesch's avatar
Dimitri van Heesch committed
469 470 471
void ManGenerator::startSubsection()    
{ 
  if (!firstCol) t << endl;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
472
  t << ".SS \""; 
Dimitri van Heesch's avatar
Dimitri van Heesch committed
473 474 475 476
  firstCol=FALSE;
  paragraph=FALSE;
}

Dimitri van Heesch's avatar
Dimitri van Heesch committed
477 478 479 480 481 482
void ManGenerator::endSubsection()
{
  t << "\"";
}


Dimitri van Heesch's avatar
Dimitri van Heesch committed
483 484 485
void ManGenerator::startSubsubsection() 
{ 
  if (!firstCol) t << endl;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
486
  t << "\n.SS \""; 
Dimitri van Heesch's avatar
Dimitri van Heesch committed
487 488 489 490
  firstCol=FALSE;
  paragraph=FALSE;
}

Dimitri van Heesch's avatar
Dimitri van Heesch committed
491 492 493 494 495
void ManGenerator::endSubsubsection()
{
  t << "\"";
}

Dimitri van Heesch's avatar
Dimitri van Heesch committed
496 497 498 499 500 501 502 503 504 505 506 507 508 509 510
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;
}

511 512 513 514 515
//void ManGenerator::endDescTitle()
//{
//  endBold();
//  paragraph=TRUE;
//}
Dimitri van Heesch's avatar
Dimitri van Heesch committed
516

517
void ManGenerator::startDescForItem()
Dimitri van Heesch's avatar
Dimitri van Heesch committed
518 519 520 521 522 523 524 525 526
{
  if (!firstCol) t << endl;
  if (!paragraph) t << ".in -1c" << endl;
  t << ".in +1c" << endl;
  firstCol=TRUE;
  paragraph=FALSE;
  col=0;
}

527 528 529 530
void ManGenerator::endDescForItem()
{
}

Dimitri van Heesch's avatar
Dimitri van Heesch committed
531 532 533 534 535
void ManGenerator::endDescItem()
{
  t << "\" 1c" << endl;
  firstCol=TRUE;
}
536

537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553
void ManGenerator::startAnonTypeScope(int indentLevel)
{
  if (indentLevel==0)
  {
    insideTabbing=TRUE;
  }
}

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


554
void ManGenerator::startMemberItem(const char *,int,const char *) 
555 556 557 558 559 560
{ 
  if (firstCol && !insideTabbing) t << ".in +1c\n";
  t << "\n.ti -1c\n.RI \""; 
  firstCol=FALSE;
}

561
void ManGenerator::endMemberItem() 
562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581
{ 
  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
582
void ManGenerator::startMemberGroupHeader(bool)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
583 584 585 586 587 588
{
  t << "\n.PP\n.RI \"\\fB";
}

void ManGenerator::endMemberGroupHeader()
{
Dimitri van Heesch's avatar
Dimitri van Heesch committed
589
  t << "\\fP\"\n.br\n";
Dimitri van Heesch's avatar
Dimitri van Heesch committed
590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611
  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
612

613
void ManGenerator::startSection(const char *,const char *,SectionInfo::SectionType type)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
614 615 616
{
  if( !inHeader ) 
  {
617
    switch(type)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
618
    {
Dimitri van Heesch's avatar
Dimitri van Heesch committed
619 620
      case SectionInfo::Page:          startGroupHeader(FALSE); break;
      case SectionInfo::Section:       startGroupHeader(FALSE); break;
621 622 623
      case SectionInfo::Subsection:    startMemberHeader(0); break;
      case SectionInfo::Subsubsection: startMemberHeader(0); break;
      case SectionInfo::Paragraph:     startMemberHeader(0); break;
624
      default: ASSERT(0); break;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
625 626 627 628
    }
  }
}

629
void ManGenerator::endSection(const char *,SectionInfo::SectionType type)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
630 631 632
{
  if( !inHeader )
  {
633
    switch(type)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
634
    {
Dimitri van Heesch's avatar
Dimitri van Heesch committed
635 636
      case SectionInfo::Page:          endGroupHeader(0); break;
      case SectionInfo::Section:       endGroupHeader(0); break;
637 638 639
      case SectionInfo::Subsection:    endMemberHeader(); break;
      case SectionInfo::Subsubsection: endMemberHeader(); break;
      case SectionInfo::Paragraph:     endMemberHeader(); break;
640
      default: ASSERT(0); break;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
641 642 643 644 645 646 647 648 649 650 651
    }
  }
  else
  {
    t << "\n";
    firstCol=TRUE;
    paragraph=FALSE;
    inHeader=FALSE;
  }
}

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 678 679 680 681 682 683 684 685 686 687
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
688

Dimitri van Heesch's avatar
Dimitri van Heesch committed
689
void ManGenerator::writeDoc(DocNode *n,Definition *ctx,MemberDef *)
690
{
Dimitri van Heesch's avatar
Dimitri van Heesch committed
691
  ManDocVisitor *visitor = new ManDocVisitor(t,*this,ctx?ctx->getDefFileExtension():QCString(""));
692 693
  n->accept(visitor);
  delete visitor; 
694
  firstCol=FALSE;
695
  paragraph = FALSE;
696 697
}

698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713
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()
{
714
  startItemListItem();
715 716 717 718 719 720
  startEmphasis();
}

void ManGenerator::endConstraintParam()
{
  endEmphasis();
721
  endItemListItem();
722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747
  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
748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763

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;
}

764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791
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 << " ";
}
792

793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813
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;
}
814

815 816 817 818 819 820 821 822 823 824 825 826 827 828
void ManGenerator::startLabels()
{
}

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

void ManGenerator::endLabels()
{
}

829 830 831 832 833 834 835 836
void ManGenerator::endHeaderSection()
{
  if (!firstCol) 
  { 
    t<< endl; firstCol=TRUE; 
  }
}

837