htmldocvisitor.cpp 44 KB
Newer Older
dimitri's avatar
dimitri committed
1 2
/******************************************************************************
 *
dimitri's avatar
dimitri committed
3
 * 
dimitri's avatar
dimitri committed
4 5
 *
 *
dimitri's avatar
dimitri committed
6
 * Copyright (C) 1997-2010 by Dimitri van Heesch.
dimitri's avatar
dimitri committed
7 8 9 10 11 12 13 14 15 16 17 18
 *
 * 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.
 *
 * Documents produced by Doxygen are derivative works derived from the
 * input used in their production; they are not affected by this license.
 *
 */

dimitri's avatar
dimitri committed
19
#include <qdir.h>
dimitri's avatar
dimitri committed
20
#include "htmldocvisitor.h"
dimitri's avatar
dimitri committed
21 22 23 24 25
#include "docparser.h"
#include "language.h"
#include "doxygen.h"
#include "outputgen.h"
#include "dot.h"
dimitri's avatar
dimitri committed
26
#include "message.h"
dimitri's avatar
dimitri committed
27
#include "config.h"
dimitri's avatar
dimitri committed
28
#include "htmlgen.h"
dimitri's avatar
dimitri committed
29
#include "parserintf.h"
dimitri's avatar
dimitri committed
30
#include "msc.h"
dimitri's avatar
dimitri committed
31
#include "util.h"
dimitri's avatar
dimitri committed
32

dimitri's avatar
dimitri committed
33

dimitri's avatar
dimitri committed
34 35 36
static const int NUM_HTML_LIST_TYPES = 4;
static const char types[][NUM_HTML_LIST_TYPES] = {"1", "a", "i", "A"};

dimitri's avatar
dimitri committed
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64
static QCString convertIndexWordToAnchor(const QString &word)
{
  static char hex[] = "0123456789abcdef";
  uint i;
  QCString result;
  for (i=0;i<word.length();i++)
  {
    int c = word.at(i);
    if (isId(c))
    {
      result+=c;
    }
    else if (isspace(c))
    {
      result+="_";
    }
    else
    {
      char cs[3];
      cs[0]=hex[c>>4];
      cs[1]=hex[c&0xf];
      cs[2]=0;
      result+=cs;
    }
  }
  return result;
}

dimitri's avatar
dimitri committed
65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82
static bool mustBeOutsideParagraph(DocNode *n)
{
  switch (n->kind())
  {
          /* <ul> */
        case DocNode::Kind_HtmlList:
        case DocNode::Kind_SimpleList:
        case DocNode::Kind_AutoList:
          /* <dl> */
        case DocNode::Kind_SimpleSect:
        case DocNode::Kind_ParamSect:
        case DocNode::Kind_HtmlDescList:
        case DocNode::Kind_XRefItem:
          /* <table> */
        case DocNode::Kind_HtmlTable:
          /* <h?> */
        case DocNode::Kind_Section:
        case DocNode::Kind_HtmlHeader:
dimitri's avatar
dimitri committed
83 84
          /* \internal */
        case DocNode::Kind_Internal:
dimitri's avatar
dimitri committed
85 86 87 88 89 90 91
          /* <div> */
        case DocNode::Kind_Verbatim:
        case DocNode::Kind_Include:
        case DocNode::Kind_Image:
        case DocNode::Kind_SecRefList:
          /* <hr> */
        case DocNode::Kind_HorRuler:
dimitri's avatar
dimitri committed
92 93 94 95 96
          /* CopyDoc gets paragraph markers from the wrapping DocPara node,
           * but needs to insert them for all documentation being copied to
           * preserve formatting.
           */
        case DocNode::Kind_Copy:
dimitri's avatar
dimitri committed
97 98 99 100 101 102 103 104 105 106 107 108 109 110
          return TRUE;
        case DocNode::Kind_StyleChange:
          return ((DocStyleChange*)n)->style()==DocStyleChange::Preformatted ||
                 ((DocStyleChange*)n)->style()==DocStyleChange::Div ||
                 ((DocStyleChange*)n)->style()==DocStyleChange::Center;
        case DocNode::Kind_Formula:
          return !((DocFormula*)n)->isInline();
        default:
          break;
  }
  return FALSE;
}


dimitri's avatar
dimitri committed
111

dimitri's avatar
dimitri committed
112 113 114 115 116 117 118
static QString htmlAttribsToString(const HtmlAttribList &attribs)
{
  QString result;
  HtmlAttribListIterator li(attribs);
  HtmlAttrib *att;
  for (li.toFirst();(att=li.current());++li)
  {
dimitri's avatar
dimitri committed
119 120 121 122 123 124 125
    if (!att->value.isEmpty())  // ignore attribute without values as they
                                // are not XHTML compliant
    {
      result+=" ";
      result+=att->name;
      result+="=\""+convertToXML(att->value)+"\"";
    }
dimitri's avatar
dimitri committed
126 127 128 129 130 131
  }
  return result;
}

//-------------------------------------------------------------------------

dimitri's avatar
dimitri committed
132
HtmlDocVisitor::HtmlDocVisitor(FTextStream &t,CodeOutputInterface &ci,
dimitri's avatar
dimitri committed
133 134 135
                               const char *langExt) 
  : DocVisitor(DocVisitor_Html), m_t(t), m_ci(ci), m_insidePre(FALSE), 
                                 m_hide(FALSE), m_langExt(langExt)
dimitri's avatar
dimitri committed
136 137 138 139 140 141 142
{
}

  //--------------------------------------
  // visitor functions for leaf nodes
  //--------------------------------------

dimitri's avatar
dimitri committed
143
void HtmlDocVisitor::visit(DocWord *w)
dimitri's avatar
dimitri committed
144 145 146 147 148
{
  if (m_hide) return;
  filter(w->word());
}

dimitri's avatar
dimitri committed
149
void HtmlDocVisitor::visit(DocLinkedWord *w)
dimitri's avatar
dimitri committed
150 151
{
  if (m_hide) return;
dimitri's avatar
dimitri committed
152
  startLink(w->ref(),w->file(),w->relPath(),w->anchor(),w->tooltip());
dimitri's avatar
dimitri committed
153 154 155 156
  filter(w->word());
  endLink();
}

dimitri's avatar
dimitri committed
157
void HtmlDocVisitor::visit(DocWhiteSpace *w)
dimitri's avatar
dimitri committed
158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181
{
  if (m_hide) return;
  if (m_insidePre)
  {
    m_t << w->chars();
  }
  else
  {
    m_t << " ";
  }
}

void HtmlDocVisitor::visit(DocSymbol *s)
{
  if (m_hide) return;
  switch(s->symbol())
  {
    case DocSymbol::BSlash:  m_t << "\\"; break;
    case DocSymbol::At:      m_t << "@"; break;
    case DocSymbol::Less:    m_t << "&lt;"; break;
    case DocSymbol::Greater: m_t << "&gt;"; break;
    case DocSymbol::Amp:     m_t << "&amp;"; break;
    case DocSymbol::Dollar:  m_t << "$"; break;
    case DocSymbol::Hash:    m_t << "#"; break;
dimitri's avatar
dimitri committed
182
    case DocSymbol::DoubleColon: m_t << "::"; break;
dimitri's avatar
dimitri committed
183 184
    case DocSymbol::Percent: m_t << "%"; break;
    case DocSymbol::Copy:    m_t << "&copy;"; break;
dimitri's avatar
dimitri committed
185
    case DocSymbol::Tm:      m_t << "&trade;"; break;
dimitri's avatar
dimitri committed
186
    case DocSymbol::Reg:     m_t << "&reg;"; break;
dimitri's avatar
dimitri committed
187 188
    case DocSymbol::Apos:    m_t << "'"; break;
    case DocSymbol::Quot:    m_t << "\""; break;
dimitri's avatar
dimitri committed
189 190 191 192 193 194
    case DocSymbol::Lsquo:   m_t << "&lsquo;"; break;
    case DocSymbol::Rsquo:   m_t << "&rsquo;"; break;
    case DocSymbol::Ldquo:   m_t << "&ldquo;"; break;
    case DocSymbol::Rdquo:   m_t << "&rdquo;"; break;
    case DocSymbol::Ndash:   m_t << "&ndash;"; break;
    case DocSymbol::Mdash:   m_t << "&mdash;"; break;
dimitri's avatar
dimitri committed
195 196 197 198
    case DocSymbol::Uml:     m_t << "&" << s->letter() << "uml;"; break;
    case DocSymbol::Acute:   m_t << "&" << s->letter() << "acute;"; break;
    case DocSymbol::Grave:   m_t << "&" << s->letter() << "grave;"; break;
    case DocSymbol::Circ:    m_t << "&" << s->letter() << "circ;"; break;
dimitri's avatar
dimitri committed
199
    case DocSymbol::Slash:   m_t << "&" << s->letter() << "slash;"; break;
dimitri's avatar
dimitri committed
200 201
    case DocSymbol::Tilde:   m_t << "&" << s->letter() << "tilde;"; break;
    case DocSymbol::Szlig:   m_t << "&szlig;"; break;
dimitri's avatar
dimitri committed
202
    case DocSymbol::Cedil:   m_t << "&" << s->letter() << "cedil;"; break;
dimitri's avatar
dimitri committed
203
    case DocSymbol::Ring:    m_t << "&" << s->letter() << "ring;"; break;
dimitri's avatar
dimitri committed
204
    case DocSymbol::Nbsp:    m_t << "&#160;"; break;
dimitri's avatar
dimitri committed
205 206
    case DocSymbol::AElig:   m_t << "&AElig;"; break;
    case DocSymbol::Aelig:   m_t << "&aelig;"; break;
dimitri's avatar
dimitri committed
207
    default:
dimitri's avatar
dimitri committed
208
                             err("error: unknown symbol found\n");
dimitri's avatar
dimitri committed
209 210 211 212 213 214
  }
}

void HtmlDocVisitor::visit(DocURL *u)
{
  if (m_hide) return;
dimitri's avatar
dimitri committed
215 216 217
  m_t << "<a href=\"";
  if (u->isEmail()) m_t << "mailto:";
  m_t << u->url() << "\">";
dimitri's avatar
dimitri committed
218 219
  filter(u->url());
  m_t << "</a>";
dimitri's avatar
dimitri committed
220 221 222 223 224
}

void HtmlDocVisitor::visit(DocLineBreak *)
{
  if (m_hide) return;
dimitri's avatar
dimitri committed
225
  m_t << "<br/>\n";
dimitri's avatar
dimitri committed
226 227 228 229 230
}

void HtmlDocVisitor::visit(DocHorRuler *)
{
  if (m_hide) return;
dimitri's avatar
dimitri committed
231
  m_t << "<hr/>\n";
dimitri's avatar
dimitri committed
232 233 234 235 236 237 238 239
}

void HtmlDocVisitor::visit(DocStyleChange *s)
{
  if (m_hide) return;
  switch (s->style())
  {
    case DocStyleChange::Bold:
dimitri's avatar
dimitri committed
240
      if (s->enable()) m_t << "<b" << htmlAttribsToString(s->attribs()) << ">";      else m_t << "</b>";
dimitri's avatar
dimitri committed
241 242
      break;
    case DocStyleChange::Italic:
dimitri's avatar
dimitri committed
243
      if (s->enable()) m_t << "<em" << htmlAttribsToString(s->attribs()) << ">";     else m_t << "</em>";
dimitri's avatar
dimitri committed
244 245
      break;
    case DocStyleChange::Code:
dimitri's avatar
dimitri committed
246
      if (s->enable()) m_t << "<code" << htmlAttribsToString(s->attribs()) << ">";   else m_t << "</code>";
dimitri's avatar
dimitri committed
247 248
      break;
    case DocStyleChange::Subscript:
dimitri's avatar
dimitri committed
249
      if (s->enable()) m_t << "<sub" << htmlAttribsToString(s->attribs()) << ">";    else m_t << "</sub>";
dimitri's avatar
dimitri committed
250 251
      break;
    case DocStyleChange::Superscript:
dimitri's avatar
dimitri committed
252
      if (s->enable()) m_t << "<sup" << htmlAttribsToString(s->attribs()) << ">";    else m_t << "</sup>";
dimitri's avatar
dimitri committed
253 254
      break;
    case DocStyleChange::Center:
dimitri's avatar
dimitri committed
255 256 257 258 259 260 261 262 263 264
      if (s->enable()) 
      {
        forceEndParagraph(s);
        m_t << "<center" << htmlAttribsToString(s->attribs()) << ">"; 
      }
      else 
      {
        m_t << "</center>";
        forceStartParagraph(s);
      }
dimitri's avatar
dimitri committed
265 266
      break;
    case DocStyleChange::Small:
dimitri's avatar
dimitri committed
267
      if (s->enable()) m_t << "<small" << htmlAttribsToString(s->attribs()) << ">";  else m_t << "</small>";
dimitri's avatar
dimitri committed
268
      break;
dimitri's avatar
dimitri committed
269 270 271
    case DocStyleChange::Preformatted:
      if (s->enable())
      {
dimitri's avatar
dimitri committed
272
        forceEndParagraph(s);
dimitri's avatar
dimitri committed
273
        m_t << "<pre" << htmlAttribsToString(s->attribs()) << ">";
dimitri's avatar
dimitri committed
274 275 276 277 278
        m_insidePre=TRUE;
      }
      else
      {
        m_insidePre=FALSE;
dimitri's avatar
dimitri committed
279
        m_t << "</pre>";
dimitri's avatar
dimitri committed
280
        forceStartParagraph(s);
dimitri's avatar
dimitri committed
281
      }
dimitri's avatar
dimitri committed
282
      break;
dimitri's avatar
dimitri committed
283
    case DocStyleChange::Div:
dimitri's avatar
dimitri committed
284 285 286 287 288 289 290 291 292 293
      if (s->enable()) 
      {
        forceEndParagraph(s);
        m_t << "<div" << htmlAttribsToString(s->attribs()) << ">";  
      }
      else 
      {
        m_t << "</div>";
        forceStartParagraph(s);
      }
dimitri's avatar
dimitri committed
294 295 296 297 298
      break;
    case DocStyleChange::Span:
      if (s->enable()) m_t << "<span" << htmlAttribsToString(s->attribs()) << ">";  else m_t << "</span>";
      break;

dimitri's avatar
dimitri committed
299 300 301
  }
}

dimitri's avatar
dimitri committed
302

dimitri's avatar
dimitri committed
303 304 305 306 307
void HtmlDocVisitor::visit(DocVerbatim *s)
{
  if (m_hide) return;
  switch(s->type())
  {
dimitri's avatar
dimitri committed
308
    case DocVerbatim::Code: 
dimitri's avatar
dimitri committed
309
      forceEndParagraph(s);
dimitri's avatar
dimitri committed
310
      m_t << PREFRAG_START;
dimitri's avatar
dimitri committed
311
      Doxygen::parserManager->getParser(m_langExt)
dimitri's avatar
dimitri committed
312
                            ->parseCode(m_ci,s->context(),s->text(),
dimitri's avatar
dimitri committed
313
                                        s->isExample(),s->exampleFile());
dimitri's avatar
dimitri committed
314
      m_t << PREFRAG_END;
dimitri's avatar
dimitri committed
315
      forceStartParagraph(s);
dimitri's avatar
dimitri committed
316 317
      break;
    case DocVerbatim::Verbatim: 
dimitri's avatar
dimitri committed
318
      forceEndParagraph(s);
dimitri's avatar
dimitri committed
319
      m_t << PREFRAG_START;
dimitri's avatar
dimitri committed
320
      filter(s->text());
dimitri's avatar
dimitri committed
321
      m_t << PREFRAG_END;
dimitri's avatar
dimitri committed
322
      forceStartParagraph(s);
dimitri's avatar
dimitri committed
323 324 325 326
      break;
    case DocVerbatim::HtmlOnly: 
      m_t << s->text(); 
      break;
dimitri's avatar
dimitri committed
327
    case DocVerbatim::ManOnly: 
dimitri's avatar
dimitri committed
328
    case DocVerbatim::LatexOnly: 
dimitri's avatar
dimitri committed
329
    case DocVerbatim::XmlOnly: 
dimitri's avatar
dimitri committed
330 331
      /* nothing */ 
      break;
dimitri's avatar
dimitri committed
332

dimitri's avatar
dimitri committed
333 334 335 336 337
    case DocVerbatim::Dot:
      {
        static int dotindex = 1;
        QCString fileName(4096);

dimitri's avatar
dimitri committed
338
        fileName.sprintf("%s%d%s", 
dimitri's avatar
dimitri committed
339
            (Config_getString("HTML_OUTPUT")+"/inline_dotgraph_").data(), 
dimitri's avatar
dimitri committed
340 341
            dotindex++,
            ".dot"
dimitri's avatar
dimitri committed
342 343 344 345 346 347 348 349 350
           );
        QFile file(fileName);
        if (!file.open(IO_WriteOnly))
        {
          err("Could not open file %s for writing\n",fileName.data());
        }
        file.writeBlock( s->text(), s->text().length() );
        file.close();

dimitri's avatar
dimitri committed
351
        forceEndParagraph(s);
dimitri's avatar
dimitri committed
352
        m_t << "<div align=\"center\">" << endl;
dimitri's avatar
dimitri committed
353
        writeDotFile(fileName,s->relPath(),s->context());
dimitri's avatar
dimitri committed
354
        m_t << "</div>" << endl;
dimitri's avatar
dimitri committed
355
        forceStartParagraph(s);
dimitri's avatar
dimitri committed
356

dimitri's avatar
dimitri committed
357
        if (Config_getBool("DOT_CLEANUP")) file.remove();
dimitri's avatar
dimitri committed
358 359
      }
      break;
dimitri's avatar
dimitri committed
360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379
    case DocVerbatim::Msc:
      {
        static int mscindex = 1;
        QCString baseName(4096);

        baseName.sprintf("%s%d", 
            (Config_getString("HTML_OUTPUT")+"/inline_mscgraph_").data(), 
            mscindex++
           );
        QFile file(baseName+".msc");
        if (!file.open(IO_WriteOnly))
        {
          err("Could not open file %s.msc for writing\n",baseName.data());
        }
        QCString text = "msc {";
        text+=s->text();
        text+="}";
        file.writeBlock( text, text.length() );
        file.close();

dimitri's avatar
dimitri committed
380
        forceEndParagraph(s);
dimitri's avatar
dimitri committed
381
        m_t << "<div align=\"center\">" << endl;
dimitri's avatar
dimitri committed
382
        writeMscFile(baseName,s->relPath(),s->context());
dimitri's avatar
dimitri committed
383
        m_t << "</div>" << endl;
dimitri's avatar
dimitri committed
384
        forceStartParagraph(s);
dimitri's avatar
dimitri committed
385 386 387 388

        if (Config_getBool("DOT_CLEANUP")) file.remove();
      }
      break;
dimitri's avatar
dimitri committed
389 390 391
  }
}

dimitri's avatar
dimitri committed
392
void HtmlDocVisitor::visit(DocAnchor *anc)
dimitri's avatar
dimitri committed
393 394
{
  if (m_hide) return;
dimitri's avatar
dimitri committed
395
  m_t << "<a class=\"anchor\" id=\"" << anc->anchor() << "\"></a>";
dimitri's avatar
dimitri committed
396 397 398 399 400 401 402 403
}

void HtmlDocVisitor::visit(DocInclude *inc)
{
  if (m_hide) return;
  switch(inc->type())
  {
    case DocInclude::Include: 
dimitri's avatar
dimitri committed
404
      forceEndParagraph(inc);
dimitri's avatar
dimitri committed
405
      m_t << PREFRAG_START;
dimitri's avatar
dimitri committed
406
      Doxygen::parserManager->getParser(inc->extension())
dimitri's avatar
dimitri committed
407 408
                            ->parseCode(m_ci,                 
                                        inc->context(),
dimitri's avatar
dimitri committed
409
                                        inc->text(),
dimitri's avatar
dimitri committed
410 411 412 413 414 415 416
                                        inc->isExample(),
                                        inc->exampleFile(),
                                        0,   // fd
                                        -1,  // startLine
                                        -1,  // endLine
                                        TRUE // inlineFragment
                                       );
dimitri's avatar
dimitri committed
417
      m_t << PREFRAG_END;
dimitri's avatar
dimitri committed
418
      forceStartParagraph(inc);
dimitri's avatar
dimitri committed
419
      break;
dimitri's avatar
dimitri committed
420 421
    case DocInclude::IncWithLines:
      { 
dimitri's avatar
dimitri committed
422
         forceEndParagraph(inc);
dimitri's avatar
dimitri committed
423
         m_t << PREFRAG_START;
dimitri's avatar
dimitri committed
424 425
         QFileInfo cfi( inc->file() );
         FileDef fd( cfi.dirPath(), cfi.fileName() );
dimitri's avatar
dimitri committed
426
         Doxygen::parserManager->getParser(inc->extension())
dimitri's avatar
dimitri committed
427 428
                               ->parseCode(m_ci,
                                           inc->context(),
dimitri's avatar
dimitri committed
429
                                           inc->text(),
dimitri's avatar
dimitri committed
430 431
                                           inc->isExample(),
                                           inc->exampleFile(), &fd);
dimitri's avatar
dimitri committed
432
         m_t << PREFRAG_END;
dimitri's avatar
dimitri committed
433
         forceStartParagraph(inc);
dimitri's avatar
dimitri committed
434 435
      }
      break;
dimitri's avatar
dimitri committed
436 437 438 439 440 441
    case DocInclude::DontInclude: 
      break;
    case DocInclude::HtmlInclude: 
      m_t << inc->text(); 
      break;
    case DocInclude::VerbInclude: 
dimitri's avatar
dimitri committed
442
      forceEndParagraph(inc);
dimitri's avatar
dimitri committed
443
      m_t << PREFRAG_START;
dimitri's avatar
dimitri committed
444
      filter(inc->text());
dimitri's avatar
dimitri committed
445
      m_t << PREFRAG_END;
dimitri's avatar
dimitri committed
446
      forceStartParagraph(inc);
dimitri's avatar
dimitri committed
447 448 449 450 451 452 453 454 455 456
      break;
  }
}

void HtmlDocVisitor::visit(DocIncOperator *op)
{
  //printf("DocIncOperator: type=%d first=%d, last=%d text=`%s'\n",
  //    op->type(),op->isFirst(),op->isLast(),op->text().data());
  if (op->isFirst()) 
  {
dimitri's avatar
dimitri committed
457
    if (!m_hide) m_t << PREFRAG_START;
dimitri's avatar
dimitri committed
458 459
    pushEnabled();
    m_hide=TRUE;
dimitri's avatar
dimitri committed
460 461 462
  }
  if (op->type()!=DocIncOperator::Skip) 
  {
dimitri's avatar
dimitri committed
463
    popEnabled();
dimitri's avatar
dimitri committed
464 465 466 467
    if (!m_hide) 
    {
      Doxygen::parserManager->getParser(m_langExt)
                            ->parseCode(m_ci,op->context(),
dimitri's avatar
dimitri committed
468
                                op->text(),op->isExample(),
dimitri's avatar
dimitri committed
469 470
                                op->exampleFile());
    }
dimitri's avatar
dimitri committed
471 472
    pushEnabled();
    m_hide=TRUE;
dimitri's avatar
dimitri committed
473 474 475
  }
  if (op->isLast())  
  {
dimitri's avatar
dimitri committed
476
    popEnabled();
dimitri's avatar
dimitri committed
477
    if (!m_hide) m_t << PREFRAG_END;
dimitri's avatar
dimitri committed
478 479 480
  }
  else
  {
dimitri's avatar
dimitri committed
481
    if (!m_hide) m_t << endl;
dimitri's avatar
dimitri committed
482 483 484 485 486 487
  }
}

void HtmlDocVisitor::visit(DocFormula *f)
{
  if (m_hide) return;
dimitri's avatar
dimitri committed
488 489 490 491 492 493
  bool bDisplay = !f->isInline();
  if (bDisplay) 
  {
    forceEndParagraph(f);
    m_t << "<p class=\"formulaDsp\">" << endl;
  }
dimitri's avatar
dimitri committed
494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514

  if (Config_getBool("USE_MATHJAX"))
  {
    QCString text = f->text();
    bool closeInline = FALSE;
    if (!bDisplay && !text.isEmpty() && text.at(0)=='$' && 
                      text.at(text.length()-1)=='$')
    {
      closeInline=TRUE;
      text = text.mid(1,text.length()-2);
      m_t << "\\(";
    }
    m_t << convertToHtml(text);
    if (closeInline)
    {
      m_t << "\\)";
    }
  }
  else
  {
    m_t << "<img class=\"formula" 
dimitri's avatar
dimitri committed
515
      << (bDisplay ? "Dsp" : "Inl");
dimitri's avatar
dimitri committed
516 517 518 519 520 521 522 523
    m_t << "\" alt=\"";
    filterQuotedCdataAttr(f->text());
    m_t << "\"";
    /// @todo cache image dimensions on formula generation and give height/width
    /// for faster preloading and better rendering of the page
    m_t << " src=\"" << f->relPath() << f->name() << ".png\"/>";

  }
dimitri's avatar
dimitri committed
524
  if (bDisplay)
dimitri's avatar
dimitri committed
525 526 527 528
  {
    m_t << endl << "</p>" << endl;
    forceStartParagraph(f);
  }
dimitri's avatar
dimitri committed
529 530
}

dimitri's avatar
dimitri committed
531
void HtmlDocVisitor::visit(DocIndexEntry *e)
dimitri's avatar
dimitri committed
532
{
dimitri's avatar
dimitri committed
533 534 535 536 537 538 539 540 541 542 543
  QCString anchor = convertIndexWordToAnchor(e->entry());
  if (e->member()) 
  {
    anchor.prepend(e->member()->anchor()+"_");
  }
  m_t << "<a name=\"" << anchor << "\"></a>";
  //printf("*** DocIndexEntry: word='%s' scope='%s' member='%s'\n",
  //       e->entry().data(),
  //       e->scope()  ? e->scope()->name().data()  : "<null>",
  //       e->member() ? e->member()->name().data() : "<null>"
  //      );
dimitri's avatar
dimitri committed
544
  Doxygen::indexList.addIndexItem(e->scope(),e->member(),e->entry());
dimitri's avatar
dimitri committed
545 546
}

dimitri's avatar
dimitri committed
547 548 549 550 551 552
void HtmlDocVisitor::visit(DocSimpleSectSep *)
{
  m_t << "</dd>" << endl;
  m_t << "<dd>" << endl;
}

dimitri's avatar
dimitri committed
553 554 555 556
//--------------------------------------
// visitor functions for compound nodes
//--------------------------------------

dimitri's avatar
dimitri committed
557

dimitri's avatar
dimitri committed
558 559
void HtmlDocVisitor::visitPre(DocAutoList *l)
{
dimitri's avatar
dimitri committed
560
  if (m_hide) return;
dimitri's avatar
dimitri committed
561
  forceEndParagraph(l);
dimitri's avatar
dimitri committed
562 563
  if (l->isEnumList())
  {
dimitri's avatar
dimitri committed
564 565 566 567 568 569 570 571
    //
    // Do list type based on depth:
    // 1.
    //   a.
    //     i.
    //       A. 
    //         1. (repeat)...
    //
dimitri's avatar
dimitri committed
572
    m_t << "<ol type=\"" << types[l->depth() % NUM_HTML_LIST_TYPES] << "\">";
dimitri's avatar
dimitri committed
573 574 575
  }
  else
  {
dimitri's avatar
dimitri committed
576
    m_t << "<ul>";
dimitri's avatar
dimitri committed
577
  }
dimitri's avatar
dimitri committed
578
  if (!l->isPreformatted()) m_t << "\n";
dimitri's avatar
dimitri committed
579 580 581 582
}

void HtmlDocVisitor::visitPost(DocAutoList *l)
{
dimitri's avatar
dimitri committed
583
  if (m_hide) return;
dimitri's avatar
dimitri committed
584 585
  if (l->isEnumList())
  {
dimitri's avatar
dimitri committed
586
    m_t << "</ol>";
dimitri's avatar
dimitri committed
587 588 589
  }
  else
  {
dimitri's avatar
dimitri committed
590
    m_t << "</ul>";
dimitri's avatar
dimitri committed
591
  }
dimitri's avatar
dimitri committed
592
  if (!l->isPreformatted()) m_t << "\n";
dimitri's avatar
dimitri committed
593
  forceStartParagraph(l);
dimitri's avatar
dimitri committed
594 595 596 597
}

void HtmlDocVisitor::visitPre(DocAutoListItem *)
{
dimitri's avatar
dimitri committed
598
  if (m_hide) return;
dimitri's avatar
dimitri committed
599 600 601
  m_t << "<li>";
}

dimitri's avatar
dimitri committed
602
void HtmlDocVisitor::visitPost(DocAutoListItem *li) 
dimitri's avatar
dimitri committed
603
{
dimitri's avatar
dimitri committed
604
  if (m_hide) return;
dimitri's avatar
dimitri committed
605
  m_t << "</li>";
dimitri's avatar
dimitri committed
606 607 608 609 610 611 612
  if (!li->isPreformatted()) m_t << "\n";
}

template<class T> 
bool isFirstChildNode(T *parent, DocNode *node)
{
   return parent->children().getFirst()==node;
dimitri's avatar
dimitri committed
613 614
}

dimitri's avatar
dimitri committed
615 616 617 618 619 620
template<class T> 
bool isLastChildNode(T *parent, DocNode *node)
{
   return parent->children().getLast()==node;
}

dimitri's avatar
dimitri committed
621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651
bool isSeparatedParagraph(DocSimpleSect *parent,DocPara *par)
{
  QList<DocNode> nodes = parent->children();
  int i = nodes.findRef(par);
  if (i==-1) return FALSE;
  int count = parent->children().count();
  if (count>1 && i==0)
  {
    if (nodes.at(i+1)->kind()==DocNode::Kind_SimpleSectSep)
    {
      return TRUE;
    }
  }
  else if (count>1 && i==count-1)
  {
    if (nodes.at(i-1)->kind()==DocNode::Kind_SimpleSectSep)
    {
      return TRUE;
    }
  }
  else if (count>2 && i>0 && i<count-1)
  {
    if (nodes.at(i-1)->kind()==DocNode::Kind_SimpleSectSep &&
        nodes.at(i+1)->kind()==DocNode::Kind_SimpleSectSep)
    {
      return TRUE;
    }
  }
  return FALSE;
}

dimitri's avatar
dimitri committed
652
static int getParagraphContext(DocPara *p,bool &isFirst,bool &isLast)
dimitri's avatar
dimitri committed
653 654 655 656 657 658 659 660 661 662 663
{
  int t=0;
  isFirst=FALSE;
  isLast=FALSE;
  if (p && p->parent())
  {
    switch (p->parent()->kind()) 
    {
      case DocNode::Kind_AutoListItem:
        isFirst=TRUE;
        isLast =TRUE;
dimitri's avatar
dimitri committed
664
        t=1; // not used
dimitri's avatar
dimitri committed
665 666 667 668
        break;
      case DocNode::Kind_SimpleListItem:
        isFirst=TRUE;
        isLast =TRUE;
dimitri's avatar
dimitri committed
669
        t=1; // not used
dimitri's avatar
dimitri committed
670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694
        break;
      case DocNode::Kind_HtmlListItem:
        isFirst=isFirstChildNode((DocHtmlListItem*)p->parent(),p);
        isLast =isLastChildNode ((DocHtmlListItem*)p->parent(),p);
        if (isFirst) t=1;
        if (isLast)  t=3;
        break;
      case DocNode::Kind_SecRefItem:
        isFirst=isFirstChildNode((DocSecRefItem*)p->parent(),p);
        isLast =isLastChildNode ((DocSecRefItem*)p->parent(),p);
        if (isFirst) t=1;
        if (isLast)  t=3;
        break;
      case DocNode::Kind_HtmlDescData:
        isFirst=isFirstChildNode((DocHtmlDescData*)p->parent(),p);
        isLast =isLastChildNode ((DocHtmlDescData*)p->parent(),p);
        if (isFirst) t=2;
        if (isLast)  t=4;
        break;
      case DocNode::Kind_XRefItem:
        isFirst=isFirstChildNode((DocXRefItem*)p->parent(),p);
        isLast =isLastChildNode ((DocXRefItem*)p->parent(),p);
        if (isFirst) t=2;
        if (isLast)  t=4;
        break;
dimitri's avatar
dimitri committed
695 696 697 698 699 700
      case DocNode::Kind_HtmlCell:
        isFirst=isFirstChildNode((DocHtmlCell*)p->parent(),p);
        isLast =isLastChildNode ((DocHtmlCell*)p->parent(),p);
        if (isFirst) t=5;
        if (isLast)  t=6;
        break;
dimitri's avatar
dimitri committed
701 702 703 704 705
      case DocNode::Kind_SimpleSect:
        isFirst=isFirstChildNode((DocSimpleSect*)p->parent(),p);
        isLast =isLastChildNode ((DocSimpleSect*)p->parent(),p);
        if (isFirst) t=2;
        if (isLast)  t=4;
dimitri's avatar
dimitri committed
706 707 708 709 710 711 712
        if (isSeparatedParagraph((DocSimpleSect*)p->parent(),p))
          // if the paragraph is enclosed with separators it will
          // be included in <dd>..</dd> so avoid addition paragraph
          // markers
        {
          isFirst=isLast=TRUE;
        }
dimitri's avatar
dimitri committed
713 714 715 716 717 718 719 720 721 722 723
        break;
      default:
        break;
    }
    //printf("para=%p parent()->kind=%d isFirst=%d isLast=%d t=%d\n",
    //    p,p->parent()->kind(),isFirst,isLast,t);
  }
  return t;
}

void HtmlDocVisitor::visitPre(DocPara *p) 
dimitri's avatar
dimitri committed
724
{
dimitri's avatar
dimitri committed
725 726
  if (m_hide) return;

dimitri's avatar
dimitri committed
727 728 729 730 731 732 733 734 735
  //printf("Processing docpara with parent of kind %d\n",
  //       p->parent() ? p->parent()->kind() : -1);

  bool needsTag = FALSE;
  if (p && p->parent()) 
  {
    switch (p->parent()->kind()) 
    {
      case DocNode::Kind_Section:
dimitri's avatar
dimitri committed
736
      case DocNode::Kind_Internal:
dimitri's avatar
dimitri committed
737 738 739 740 741 742
      case DocNode::Kind_HtmlListItem:
      case DocNode::Kind_HtmlDescData:
      case DocNode::Kind_HtmlCell:
      case DocNode::Kind_SimpleListItem:
      case DocNode::Kind_AutoListItem:
      case DocNode::Kind_SimpleSect:
dimitri's avatar
dimitri committed
743
      case DocNode::Kind_XRefItem:
dimitri's avatar
dimitri committed
744
      case DocNode::Kind_Copy:
dimitri's avatar
dimitri committed
745 746 747 748 749 750 751 752 753 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
        needsTag = TRUE;
        break;
      case DocNode::Kind_Root:
        needsTag = !((DocRoot*)p->parent())->singleLine();
        break;
      default:
        needsTag = FALSE;
    }
  }

  // if the first element of a paragraph is something that should be outside of
  // the paragraph (<ul>,<dl>,<table>,..) then that will already started the 
  // paragraph and we don't need to do it here
  uint nodeIndex = 0;
  if (p && nodeIndex<p->children().count())
  {
    while (nodeIndex<p->children().count() && 
           p->children().at(nodeIndex)->kind()==DocNode::Kind_WhiteSpace)
    {
      nodeIndex++;
    }
    if (nodeIndex<p->children().count())
    {
      DocNode *n = p->children().at(nodeIndex);
      if (mustBeOutsideParagraph(n))
      {
        needsTag = FALSE;
      }
    }
  }

  // check if this paragraph is the first or last child of a <li> or <dd>.
  // this allows us to mark the tag with a special class so we can
  // fix the otherwise ugly spacing.
  int t;
dimitri's avatar
dimitri committed
780 781 782 783 784 785 786 787
  static const char *contexts[7] = 
  { "",                     // 0
    " class=\"startli\"",   // 1
    " class=\"startdd\"",   // 2
    " class=\"endli\"",     // 3
    " class=\"enddd\"",     // 4
    " class=\"starttd\"",   // 5
    " class=\"endtd\""      // 6
dimitri's avatar
dimitri committed
788 789 790 791 792 793 794 795 796
  };
  bool isFirst;
  bool isLast;
  t = getParagraphContext(p,isFirst,isLast);
  //printf("startPara first=%d last=%d\n",isFirst,isLast);
  if (isFirst && isLast) needsTag=FALSE;

  // write the paragraph tag (if needed)
  if (needsTag) m_t << "<p" << contexts[t] << ">";
dimitri's avatar
dimitri committed
797 798 799 800
}

void HtmlDocVisitor::visitPost(DocPara *p)
{
dimitri's avatar
dimitri committed
801 802 803 804 805 806 807 808 809 810 811 812
//  if (m_hide) return;
//  if (!p->isLast() &&            // omit <p> for last paragraph
//      !(p->parent() &&           // and for parameter sections
//        p->parent()->kind()==DocNode::Kind_ParamSect
//       ) 
//     ) 
//  {
//    m_t << "<p>\n";
//  }

  bool needsTag = FALSE;
  if (p && p->parent()) 
dimitri's avatar
dimitri committed
813
  {
dimitri's avatar
dimitri committed
814 815 816
    switch (p->parent()->kind()) 
    {
      case DocNode::Kind_Section:
dimitri's avatar
dimitri committed
817
      case DocNode::Kind_Internal:
dimitri's avatar
dimitri committed
818 819 820 821 822 823
      case DocNode::Kind_HtmlListItem:
      case DocNode::Kind_HtmlDescData:
      case DocNode::Kind_HtmlCell:
      case DocNode::Kind_SimpleListItem:
      case DocNode::Kind_AutoListItem:
      case DocNode::Kind_SimpleSect:
dimitri's avatar
dimitri committed
824
      case DocNode::Kind_XRefItem:
dimitri's avatar
dimitri committed
825
      case DocNode::Kind_Copy:
dimitri's avatar
dimitri committed
826 827 828 829 830 831 832 833
        needsTag = TRUE;
        break;
      case DocNode::Kind_Root:
        needsTag = !((DocRoot*)p->parent())->singleLine();
        break;
      default:
        needsTag = FALSE;
    }
dimitri's avatar
dimitri committed
834
  }
dimitri's avatar
dimitri committed
835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864

  QCString context;
  // if the last element of a paragraph is something that should be outside of
  // the paragraph (<ul>,<dl>,<table>) then that will already have ended the 
  // paragraph and we don't need to do it here
  int nodeIndex = p->children().count()-1;
  if (p && nodeIndex>=0)
  {
    while (nodeIndex>=0 && p->children().at(nodeIndex)->kind()==DocNode::Kind_WhiteSpace)
    {
      nodeIndex--;
    }
    if (nodeIndex>=0)
    {
      DocNode *n = p->children().at(nodeIndex);
      if (mustBeOutsideParagraph(n))
      {
        needsTag = FALSE;
      }
    }
  }

  bool isFirst;
  bool isLast;
  getParagraphContext(p,isFirst,isLast);
  //printf("endPara first=%d last=%d\n",isFirst,isLast);
  if (isFirst && isLast) needsTag=FALSE;

  if (needsTag) m_t << "</p>\n";

dimitri's avatar
dimitri committed
865 866 867 868 869 870 871 872 873 874 875 876
}

void HtmlDocVisitor::visitPre(DocRoot *)
{
}

void HtmlDocVisitor::visitPost(DocRoot *)
{
}

void HtmlDocVisitor::visitPre(DocSimpleSect *s)
{
dimitri's avatar
dimitri committed
877
  if (m_hide) return;
dimitri's avatar
dimitri committed
878 879
  forceEndParagraph(s);
  m_t << "<dl class=\"" << s->typeString() << "\"><dt><b>";
dimitri's avatar
dimitri committed
880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910
  switch(s->type())
  {
    case DocSimpleSect::See: 
      m_t << theTranslator->trSeeAlso(); break;
    case DocSimpleSect::Return: 
      m_t << theTranslator->trReturns(); break;
    case DocSimpleSect::Author: 
      m_t << theTranslator->trAuthor(TRUE,TRUE); break;
    case DocSimpleSect::Authors: 
      m_t << theTranslator->trAuthor(TRUE,FALSE); break;
    case DocSimpleSect::Version: 
      m_t << theTranslator->trVersion(); break;
    case DocSimpleSect::Since: 
      m_t << theTranslator->trSince(); break;
    case DocSimpleSect::Date: 
      m_t << theTranslator->trDate(); break;
    case DocSimpleSect::Note: 
      m_t << theTranslator->trNote(); break;
    case DocSimpleSect::Warning:
      m_t << theTranslator->trWarning(); break;
    case DocSimpleSect::Pre:
      m_t << theTranslator->trPrecondition(); break;
    case DocSimpleSect::Post:
      m_t << theTranslator->trPostcondition(); break;
    case DocSimpleSect::Invar:
      m_t << theTranslator->trInvariant(); break;
    case DocSimpleSect::Remark:
      m_t << theTranslator->trRemarks(); break;
    case DocSimpleSect::Attention:
      m_t << theTranslator->trAttention(); break;
    case DocSimpleSect::User: break;
dimitri's avatar
dimitri committed
911
    case DocSimpleSect::Rcs: break;
dimitri's avatar
dimitri committed
912 913 914 915
    case DocSimpleSect::Unknown:  break;
  }

  // special case 1: user defined title
dimitri's avatar
dimitri committed
916
  if (s->type()!=DocSimpleSect::User && s->type()!=DocSimpleSect::Rcs)
dimitri's avatar
dimitri committed
917 918 919 920 921
  {
    m_t << ":</b></dt><dd>";
  }
}

dimitri's avatar
dimitri committed
922
void HtmlDocVisitor::visitPost(DocSimpleSect *s)
dimitri's avatar
dimitri committed
923
{
dimitri's avatar
dimitri committed
924
  if (m_hide) return;
dimitri's avatar
dimitri committed
925
  m_t << "</dd></dl>\n";
dimitri's avatar
dimitri committed
926
  forceStartParagraph(s);
dimitri's avatar
dimitri committed
927 928 929 930 931 932 933 934
}

void HtmlDocVisitor::visitPre(DocTitle *)
{
}

void HtmlDocVisitor::visitPost(DocTitle *)
{
dimitri's avatar
dimitri committed
935
  if (m_hide) return;
dimitri's avatar
dimitri committed
936 937 938
  m_t << "</b></dt><dd>";
}

dimitri's avatar
dimitri committed
939
void HtmlDocVisitor::visitPre(DocSimpleList *sl)
dimitri's avatar
dimitri committed
940
{
dimitri's avatar
dimitri committed
941
  if (m_hide) return;
dimitri's avatar
dimitri committed
942
  forceEndParagraph(sl);
dimitri's avatar
dimitri committed
943 944
  m_t << "<ul>";
  if (!sl->isPreformatted()) m_t << "\n";
dimitri's avatar
dimitri committed
945

dimitri's avatar
dimitri committed
946 947
}

dimitri's avatar
dimitri committed
948
void HtmlDocVisitor::visitPost(DocSimpleList *sl)
dimitri's avatar
dimitri committed
949
{
dimitri's avatar
dimitri committed
950
  if (m_hide) return;
dimitri's avatar
dimitri committed
951 952
  m_t << "</ul>";
  if (!sl->isPreformatted()) m_t << "\n";
dimitri's avatar
dimitri committed
953
  forceStartParagraph(sl);
dimitri's avatar
dimitri committed
954 955 956 957
}

void HtmlDocVisitor::visitPre(DocSimpleListItem *)
{
dimitri's avatar
dimitri committed
958
  if (m_hide) return;
dimitri's avatar
dimitri committed
959 960 961
  m_t << "<li>";
}

dimitri's avatar
dimitri committed
962
void HtmlDocVisitor::visitPost(DocSimpleListItem *li) 
dimitri's avatar
dimitri committed
963
{
dimitri's avatar
dimitri committed
964
  if (m_hide) return;
dimitri's avatar
dimitri committed
965 966
  m_t << "</li>";
  if (!li->isPreformatted()) m_t << "\n";
dimitri's avatar
dimitri committed
967 968 969 970
}

void HtmlDocVisitor::visitPre(DocSection *s)
{
dimitri's avatar
dimitri committed
971
  if (m_hide) return;
dimitri's avatar
dimitri committed
972
  forceEndParagraph(s);
dimitri's avatar
dimitri committed
973
  m_t << "<h" << s->level()+1 << ">";
dimitri's avatar
dimitri committed
974
  m_t << "<a class=\"anchor\" id=\"" << s->anchor();
dimitri's avatar
dimitri committed
975
  m_t << "\"></a>" << endl;
dimitri's avatar
dimitri committed
976
  filter(convertCharEntitiesToUTF8(s->title().data()));
dimitri's avatar
dimitri committed
977
  m_t << "</h" << s->level()+1 << ">\n";
dimitri's avatar
dimitri committed
978 979
}

dimitri's avatar
dimitri committed
980
void HtmlDocVisitor::visitPost(DocSection *s) 
dimitri's avatar
dimitri committed
981
{
dimitri's avatar
dimitri committed
982
  forceStartParagraph(s);
dimitri's avatar
dimitri committed
983 984 985 986
}

void HtmlDocVisitor::visitPre(DocHtmlList *s)
{
dimitri's avatar
dimitri committed
987
  if (m_hide) return;
dimitri's avatar
dimitri committed
988
  forceEndParagraph(s);
dimitri's avatar
dimitri committed
989
  if (s->type()==DocHtmlList::Ordered) 
dimitri's avatar
dimitri committed
990
  {
dimitri's avatar
dimitri committed
991
    m_t << "<ol" << htmlAttribsToString(s->attribs()) << ">\n"; 
dimitri's avatar
dimitri committed
992
  }
dimitri's avatar
dimitri committed
993
  else 
dimitri's avatar
dimitri committed
994
  {
dimitri's avatar
dimitri committed
995
    m_t << "<ul" << htmlAttribsToString(s->attribs()) << ">\n";
dimitri's avatar
dimitri committed
996
  }
dimitri's avatar
dimitri committed
997 998 999 1000
}

void HtmlDocVisitor::visitPost(DocHtmlList *s) 
{
dimitri's avatar
dimitri committed
1001
  if (m_hide) return;
dimitri's avatar
dimitri committed
1002
  if (s->type()==DocHtmlList::Ordered) 
dimitri's avatar
dimitri committed
1003
  {
dimitri's avatar
dimitri committed
1004
    m_t << "</ol>"; 
dimitri's avatar
dimitri committed
1005 1006 1007
  }
  else
  { 
dimitri's avatar
dimitri committed
1008
    m_t << "</ul>";
dimitri's avatar
dimitri committed
1009
  }
dimitri's avatar
dimitri committed
1010
  if (!s->isPreformatted()) m_t << "\n";
dimitri's avatar
dimitri committed
1011
  forceStartParagraph(s);
dimitri's avatar
dimitri committed
1012 1013
}

dimitri's avatar
dimitri committed
1014
void HtmlDocVisitor::visitPre(DocHtmlListItem *i)
dimitri's avatar
dimitri committed
1015
{
dimitri's avatar
dimitri committed
1016
  if (m_hide) return;
dimitri's avatar
dimitri committed
1017 1018
  m_t << "<li" << htmlAttribsToString(i->attribs()) << ">";
  if (!i->isPreformatted()) m_t << "\n";
dimitri's avatar
dimitri committed
1019 1020 1021 1022
}

void HtmlDocVisitor::visitPost(DocHtmlListItem *) 
{
dimitri's avatar
dimitri committed
1023
  if (m_hide) return;
dimitri's avatar
dimitri committed
1024 1025 1026
  m_t << "</li>\n";
}

dimitri's avatar
dimitri committed
1027
void HtmlDocVisitor::visitPre(DocHtmlDescList *dl)
dimitri's avatar
dimitri committed
1028
{
dimitri's avatar
dimitri committed
1029
  if (m_hide) return;
dimitri's avatar
dimitri committed
1030
  forceEndParagraph(dl);
dimitri's avatar
dimitri committed
1031
  m_t << "<dl" << htmlAttribsToString(dl->attribs()) << ">\n";
dimitri's avatar
dimitri committed
1032 1033
}

dimitri's avatar
dimitri committed
1034
void HtmlDocVisitor::visitPost(DocHtmlDescList *dl) 
dimitri's avatar
dimitri committed
1035
{
dimitri's avatar
dimitri committed
1036
  if (m_hide) return;
dimitri's avatar
dimitri committed
1037
  m_t << "</dl>\n";
dimitri's avatar
dimitri committed
1038
  forceStartParagraph(dl);
dimitri's avatar
dimitri committed
1039 1040
}

dimitri's avatar
dimitri committed
1041
void HtmlDocVisitor::visitPre(DocHtmlDescTitle *dt)
dimitri's avatar
dimitri committed
1042
{
dimitri's avatar
dimitri committed
1043
  if (m_hide) return;
dimitri's avatar
dimitri committed
1044
  m_t << "<dt" << htmlAttribsToString(dt->attribs()) << ">";
dimitri's avatar
dimitri committed
1045 1046 1047 1048
}

void HtmlDocVisitor::visitPost(DocHtmlDescTitle *) 
{
dimitri's avatar
dimitri committed
1049
  if (m_hide) return;
dimitri's avatar
dimitri committed
1050 1051 1052
  m_t << "</dt>\n";
}

dimitri's avatar
dimitri committed
1053
void HtmlDocVisitor::visitPre(DocHtmlDescData *dd)
dimitri's avatar
dimitri committed
1054
{
dimitri's avatar
dimitri committed
1055
  if (m_hide) return;
dimitri's avatar
dimitri committed
1056
  m_t << "<dd" << htmlAttribsToString(dd->attribs()) << ">";
dimitri's avatar
dimitri committed
1057 1058 1059 1060
}

void HtmlDocVisitor::visitPost(DocHtmlDescData *) 
{
dimitri's avatar
dimitri committed
1061
  if (m_hide) return;
dimitri's avatar
dimitri committed
1062 1063 1064
  m_t << "</dd>\n";
}

dimitri's avatar
dimitri committed
1065
void HtmlDocVisitor::visitPre(DocHtmlTable *t)
dimitri's avatar
dimitri committed
1066
{
dimitri's avatar
dimitri committed
1067
  if (m_hide) return;
dimitri's avatar
dimitri committed
1068

dimitri's avatar
dimitri committed
1069 1070
  forceEndParagraph(t);

dimitri's avatar
dimitri committed
1071 1072 1073 1074 1075 1076 1077 1078 1079
  QString attrs = htmlAttribsToString(t->attribs());
  if (attrs.isEmpty())
  {
    m_t << "<table class=\"doxtable\">\n";
  }
  else
  {
    m_t << "<table " << htmlAttribsToString(t->attribs()) << ">\n";
  }
dimitri's avatar
dimitri committed
1080 1081
}

dimitri's avatar
dimitri committed
1082
void HtmlDocVisitor::visitPost(DocHtmlTable *t) 
dimitri's avatar
dimitri committed
1083
{
dimitri's avatar
dimitri committed
1084
  if (m_hide) return;
dimitri's avatar
dimitri committed
1085
  m_t << "</table>\n";
dimitri's avatar
dimitri committed
1086
  forceStartParagraph(t);
dimitri's avatar
dimitri committed
1087 1088
}

dimitri's avatar
dimitri committed
1089
void HtmlDocVisitor::visitPre(DocHtmlRow *tr)
dimitri's avatar
dimitri committed
1090
{
dimitri's avatar
dimitri committed
1091
  if (m_hide) return;
dimitri's avatar
dimitri committed
1092
  m_t << "<tr" << htmlAttribsToString(tr->attribs()) << ">\n";
dimitri's avatar
dimitri committed
1093 1094 1095 1096
}

void HtmlDocVisitor::visitPost(DocHtmlRow *) 
{
dimitri's avatar
dimitri committed
1097
  if (m_hide) return;
dimitri's avatar
dimitri committed
1098 1099 1100 1101 1102
  m_t << "</tr>\n";
}

void HtmlDocVisitor::visitPre(DocHtmlCell *c)
{
dimitri's avatar
dimitri committed
1103
  if (m_hide) return;
dimitri's avatar
dimitri committed
1104 1105 1106 1107 1108 1109 1110 1111
  if (c->isHeading()) 
  {
    m_t << "<th" << htmlAttribsToString(c->attribs()) << ">"; 
  }
  else 
  {
    m_t << "<td" << htmlAttribsToString(c->attribs()) << ">";
  }
dimitri's avatar
dimitri committed
1112 1113 1114 1115
}

void HtmlDocVisitor::visitPost(DocHtmlCell *c) 
{
dimitri's avatar
dimitri committed
1116
  if (m_hide) return;
dimitri's avatar
dimitri committed
1117 1118 1119
  if (c->isHeading()) m_t << "</th>"; else m_t << "</td>";
}

dimitri's avatar
dimitri committed
1120
void HtmlDocVisitor::visitPre(DocHtmlCaption *c)
dimitri's avatar
dimitri committed
1121
{
dimitri's avatar
dimitri committed
1122
  if (m_hide) return;
dimitri's avatar
dimitri committed
1123 1124 1125 1126 1127 1128 1129 1130 1131 1132
  bool hasAlign      = FALSE;
  HtmlAttribListIterator li(c->attribs());
  HtmlAttrib *att;
  for (li.toFirst();(att=li.current());++li)
  {
    if (att->name=="align") hasAlign=TRUE;
  }
  m_t << "<caption" << htmlAttribsToString(c->attribs());
  if (!hasAlign) m_t << " align=\"bottom\"";
  m_t << ">";
dimitri's avatar
dimitri committed
1133 1134 1135 1136
}

void HtmlDocVisitor::visitPost(DocHtmlCaption *) 
{
dimitri's avatar
dimitri committed
1137
  if (m_hide) return;
dimitri's avatar
dimitri committed
1138 1139 1140
  m_t << "</caption>\n";
}

dimitri's avatar
dimitri committed
1141
void HtmlDocVisitor::visitPre(DocInternal *i)
dimitri's avatar
dimitri committed
1142
{
dimitri's avatar
dimitri committed
1143
  if (m_hide) return;
dimitri's avatar
dimitri committed
1144
  forceEndParagraph(i);
dimitri's avatar
dimitri committed
1145 1146 1147
  m_t << "<p><b>" << theTranslator->trForInternalUseOnly() << "</b></p>" << endl;
}

dimitri's avatar
dimitri committed
1148
void HtmlDocVisitor::visitPost(DocInternal *i) 
dimitri's avatar
dimitri committed
1149
{
dimitri's avatar
dimitri committed
1150
  if (m_hide) return;
dimitri's avatar
dimitri committed
1151
  forceStartParagraph(i);
dimitri's avatar
dimitri committed
1152 1153 1154 1155
}

void HtmlDocVisitor::visitPre(DocHRef *href)
{
dimitri's avatar
dimitri committed
1156
  if (m_hide) return;
dimitri's avatar
dimitri committed
1157
  m_t << "<a href=\"" << convertToXML(href->url())  << "\""
dimitri's avatar
dimitri committed
1158
      << htmlAttribsToString(href->attribs()) << ">";
dimitri's avatar
dimitri committed
1159 1160 1161 1162
}

void HtmlDocVisitor::visitPost(DocHRef *) 
{
dimitri's avatar
dimitri committed
1163
  if (m_hide) return;
dimitri's avatar
dimitri committed
1164 1165 1166 1167 1168
  m_t << "</a>";
}

void HtmlDocVisitor::visitPre(DocHtmlHeader *header)
{
dimitri's avatar
dimitri committed
1169
  if (m_hide) return;
dimitri's avatar
dimitri committed
1170
  forceEndParagraph(header);
dimitri's avatar
dimitri committed
1171 1172
  m_t << "<h" << header->level() 
      << htmlAttribsToString(header->attribs()) << ">";
dimitri's avatar
dimitri committed
1173 1174 1175 1176
}

void HtmlDocVisitor::visitPost(DocHtmlHeader *header) 
{
dimitri's avatar
dimitri committed
1177
  if (m_hide) return;
dimitri's avatar
dimitri committed
1178
  m_t << "</h" << header->level() << ">\n";
dimitri's avatar
dimitri committed
1179
  forceStartParagraph(header);
dimitri's avatar
dimitri committed
1180 1181 1182 1183 1184 1185
}

void HtmlDocVisitor::visitPre(DocImage *img)
{
  if (img->type()==DocImage::Html)
  {
dimitri's avatar
dimitri committed
1186
    forceEndParagraph(img);
dimitri's avatar
dimitri committed
1187
    if (m_hide) return;
dimitri's avatar
dimitri committed
1188
    QString baseName=img->name();
dimitri's avatar
dimitri committed
1189 1190 1191 1192 1193 1194
    int i;
    if ((i=baseName.findRev('/'))!=-1 || (i=baseName.findRev('\\'))!=-1)
    {
      baseName=baseName.right(baseName.length()-i-1);
    }
    m_t << "<div align=\"center\">" << endl;
dimitri's avatar
dimitri committed
1195
    m_t << "<img src=\"" << img->relPath() << img->name() << "\" alt=\"" 
dimitri's avatar
dimitri committed
1196 1197
        << baseName << "\"" << htmlAttribsToString(img->attribs()) 
        << "/>" << endl;
dimitri's avatar
dimitri committed
1198 1199 1200 1201 1202 1203 1204
    if (img->hasCaption())
    {
      m_t << "<p><strong>";
    }
  }
  else // other format -> skip
  {
dimitri's avatar
dimitri committed
1205
    pushEnabled();
dimitri's avatar
dimitri committed
1206 1207 1208 1209 1210 1211 1212 1213
    m_hide=TRUE;
  }
}

void HtmlDocVisitor::visitPost(DocImage *img) 
{
  if (img->type()==DocImage::Html)
  {
dimitri's avatar
dimitri committed
1214
    if (m_hide) return;
dimitri's avatar
dimitri committed
1215 1216 1217 1218 1219
    if (img->hasCaption())
    {
      m_t << "</strong></p>";
    }
    m_t << "</div>" << endl;
dimitri's avatar
dimitri committed
1220
    forceStartParagraph(img);
dimitri's avatar
dimitri committed
1221 1222 1223
  }
  else // other format
  {
dimitri's avatar
dimitri committed
1224
    popEnabled();
dimitri's avatar
dimitri committed
1225 1226 1227 1228 1229
  }
}

void HtmlDocVisitor::visitPre(DocDotFile *df)
{
dimitri's avatar
dimitri committed
1230
  if (m_hide) return;
dimitri's avatar
dimitri committed
1231
  writeDotFile(df->file(),df->relPath(),df->context());
dimitri's avatar
dimitri committed
1232 1233 1234 1235 1236 1237 1238 1239 1240
  m_t << "<div align=\"center\">" << endl;
  if (df->hasCaption())
  { 
    m_t << "<p><strong>";
  }
}

void HtmlDocVisitor::visitPost(DocDotFile *df) 
{
dimitri's avatar
dimitri committed
1241
  if (m_hide) return;
dimitri's avatar
dimitri committed
1242 1243 1244 1245 1246 1247 1248
  if (df->hasCaption())
  {
    m_t << "</strong></p>" << endl;
  }
  m_t << "</div>" << endl;
}

dimitri's avatar
dimitri committed
1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268
void HtmlDocVisitor::visitPre(DocMscFile *df)
{
  if (m_hide) return;
  writeMscFile(df->file(),df->relPath(),df->context());
  m_t << "<div align=\"center\">" << endl;
  if (df->hasCaption())
  { 
    m_t << "<p><strong>";
  }
}
void HtmlDocVisitor::visitPost(DocMscFile *df) 
{
  if (m_hide) return;
  if (df->hasCaption())
  {
    m_t << "</strong></p>" << endl;
  }
  m_t << "</div>" << endl;
}

dimitri's avatar
dimitri committed
1269 1270
void HtmlDocVisitor::visitPre(DocLink *lnk)
{
dimitri's avatar
dimitri committed
1271
  if (m_hide) return;
dimitri's avatar
dimitri committed
1272
  startLink(lnk->ref(),lnk->file(),lnk->relPath(),lnk->anchor());
dimitri's avatar
dimitri committed
1273 1274 1275 1276
}

void HtmlDocVisitor::visitPost(DocLink *) 
{
dimitri's avatar
dimitri committed
1277
  if (m_hide) return;
dimitri's avatar
dimitri committed
1278 1279 1280 1281 1282
  endLink();
}

void HtmlDocVisitor::visitPre(DocRef *ref)
{
dimitri's avatar
dimitri committed
1283
  if (m_hide) return;
dimitri's avatar
dimitri committed
1284 1285 1286 1287
  if (!ref->file().isEmpty()) 
  {
    startLink(ref->ref(),ref->file(),ref->relPath(),ref->anchor());
  }
dimitri's avatar
dimitri committed
1288 1289 1290
  if (!ref->hasLinkText()) filter(ref->targetTitle());
}

dimitri's avatar
dimitri committed
1291
void HtmlDocVisitor::visitPost(DocRef *ref) 
dimitri's avatar
dimitri committed
1292
{
dimitri's avatar
dimitri committed
1293
  if (m_hide) return;
dimitri's avatar
dimitri committed
1294
  if (!ref->file().isEmpty()) endLink();
dimitri's avatar
dimitri committed
1295
  //m_t << " ";
dimitri's avatar
dimitri committed
1296 1297 1298 1299
}

void HtmlDocVisitor::visitPre(DocSecRefItem *ref)
{
dimitri's avatar
dimitri committed
1300
  if (m_hide) return;
dimitri's avatar
dimitri committed
1301 1302 1303
  QString refName=ref->file();
  if (refName.right(Doxygen::htmlFileExtension.length())!=
      QString(Doxygen::htmlFileExtension))
dimitri's avatar
dimitri committed
1304 1305 1306 1307 1308 1309 1310 1311 1312
  {
    refName+=Doxygen::htmlFileExtension;
  }
  m_t << "<li><a href=\"" << refName << "#" << ref->anchor() << "\">";

}

void HtmlDocVisitor::visitPost(DocSecRefItem *) 
{
dimitri's avatar
dimitri committed
1313
  if (m_hide) return;
dimitri's avatar
dimitri committed
1314
  m_t << "</a></li>\n";
dimitri's avatar
dimitri committed
1315 1316
}

dimitri's avatar
dimitri committed
1317
void HtmlDocVisitor::visitPre(DocSecRefList *s)
dimitri's avatar
dimitri committed
1318
{
dimitri's avatar
dimitri committed
1319
  if (m_hide) return;
dimitri's avatar
dimitri committed
1320 1321
  forceEndParagraph(s);
  m_t << "<div class=\"multicol\">" << endl;
dimitri's avatar
dimitri committed
1322 1323 1324
  m_t << "<ul>" << endl;
}

dimitri's avatar
dimitri committed
1325
void HtmlDocVisitor::visitPost(DocSecRefList *s) 
dimitri's avatar
dimitri committed
1326
{
dimitri's avatar
dimitri committed
1327
  if (m_hide) return;
dimitri's avatar
dimitri committed
1328
  m_t << "</ul>" << endl;
dimitri's avatar
dimitri committed
1329 1330
  m_t << "</div>" << endl;
  forceStartParagraph(s);
dimitri's avatar
dimitri committed
1331 1332
}

dimitri's avatar
dimitri committed
1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350
//void HtmlDocVisitor::visitPre(DocLanguage *l)
//{
//  QString langId = Config_getEnum("OUTPUT_LANGUAGE");
//  if (l->id().lower()!=langId.lower())
//  {
//    pushEnabled();
//    m_hide = TRUE;
//  }
//}
//
//void HtmlDocVisitor::visitPost(DocLanguage *l) 
//{
//  QString langId = Config_getEnum("OUTPUT_LANGUAGE");
//  if (l->id().lower()!=langId.lower())
//  {
//    popEnabled();
//  }
//}
dimitri's avatar
dimitri committed
1351 1352 1353

void HtmlDocVisitor::visitPre(DocParamSect *s)
{
dimitri's avatar
dimitri committed
1354
  if (m_hide) return;
dimitri's avatar
dimitri committed
1355 1356
  forceEndParagraph(s);
  m_t << "<dl><dt><b>";
dimitri's avatar
dimitri committed
1357
  QCString className;
dimitri's avatar
dimitri committed
1358 1359 1360
  switch(s->type())
  {
    case DocParamSect::Param: 
dimitri's avatar
dimitri committed
1361 1362 1363
      m_t << theTranslator->trParameters(); 
      className="params";
      break;
dimitri's avatar
dimitri committed
1364
    case DocParamSect::RetVal: 
dimitri's avatar
dimitri committed
1365 1366 1367
      m_t << theTranslator->trReturnValues(); 
      className="retval";
      break;
dimitri's avatar
dimitri committed
1368
    case DocParamSect::Exception: 
dimitri's avatar
dimitri committed
1369 1370 1371
      m_t << theTranslator->trExceptions(); 
      className="exception";
      break;
dimitri's avatar
dimitri committed
1372 1373 1374 1375 1376
    case DocParamSect::TemplateParam: 
      /* TODO: add this 
      m_t << theTranslator->trTemplateParam(); break;
      */
      m_t << "Template Parameters"; break;
dimitri's avatar
dimitri committed
1377
      className="tparams";
dimitri's avatar
dimitri committed
1378 1379 1380 1381 1382
    default:
      ASSERT(0);
  }
  m_t << ":";
  m_t << "</b></dt><dd>" << endl;
dimitri's avatar
dimitri committed
1383
  m_t << "  <table class=\"" << className << "\">" << endl;
dimitri's avatar
dimitri committed
1384 1385
}

dimitri's avatar
dimitri committed
1386
void HtmlDocVisitor::visitPost(DocParamSect *s)
dimitri's avatar
dimitri committed
1387
{
dimitri's avatar
dimitri committed
1388
  if (m_hide) return;
dimitri's avatar
dimitri committed
1389
  m_t << "  </table>" << endl;
dimitri's avatar
dimitri committed
1390
  m_t << "  </dd>" << endl;
dimitri's avatar
dimitri committed
1391
  m_t << "</dl>" << endl;
dimitri's avatar
dimitri committed
1392
  forceStartParagraph(s);
dimitri's avatar
dimitri committed
1393 1394 1395 1396
}

void HtmlDocVisitor::visitPre(DocParamList *pl)
{
dimitri's avatar
dimitri committed
1397
  if (m_hide) return;
dimitri's avatar
dimitri committed
1398 1399 1400
  m_t << "    <tr>";
  DocParamSect *sect = 0;
  if (pl->parent()->kind()==DocNode::Kind_ParamSect)
dimitri's avatar
dimitri committed
1401
  {
dimitri's avatar
dimitri committed
1402 1403 1404 1405 1406 1407
    sect=(DocParamSect*)pl->parent();
  }
  if (sect && sect->hasInOutSpecifier())
  {
    m_t << "<td class=\"paramdir\">";
    if (pl->direction()!=DocParamSect::Unspecified)
dimitri's avatar
dimitri committed
1408
    {
dimitri's avatar
dimitri committed
1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422
      m_t << "[";
      if (pl->direction()==DocParamSect::In)
      {
        m_t << "in";
      }
      else if (pl->direction()==DocParamSect::Out)
      {
        m_t << "out";
      }
      else if (pl->direction()==DocParamSect::InOut)
      {
        m_t << "in,out";
      }
      m_t << "]";
dimitri's avatar
dimitri committed
1423
    }
dimitri's avatar
dimitri committed
1424 1425 1426 1427 1428 1429 1430 1431 1432
    m_t << "</td>";
  }
  if (sect && sect->hasTypeSpecifier())
  {
    m_t << "<td class=\"paramtype\">";
    QListIterator<DocNode> li(pl->paramTypes());
    DocNode *type;
    bool first=TRUE;
    for (li.toFirst();(type=li.current());++li)
dimitri's avatar
dimitri committed
1433
    {
dimitri's avatar
dimitri committed
1434 1435 1436 1437 1438 1439 1440 1441 1442
      if (!first) m_t << "&#160;|&#160;"; else first=FALSE;
      if (type->kind()==DocNode::Kind_Word)
      {
        visit((DocWord*)type); 
      }
      else if (type->kind()==DocNode::Kind_LinkedWord)
      {
        visit((DocLinkedWord*)type); 
      }
dimitri's avatar
dimitri committed
1443
    }
dimitri's avatar
dimitri committed
1444
    m_t << "</td>";
dimitri's avatar
dimitri committed
1445
  }
dimitri's avatar
dimitri committed
1446
  m_t << "<td class=\"paramname\">";
dimitri's avatar
dimitri committed
1447 1448 1449 1450
  //QStrListIterator li(pl->parameters());
  //const char *s;
  QListIterator<DocNode> li(pl->parameters());
  DocNode *param;
dimitri's avatar
dimitri committed
1451
  bool first=TRUE;
dimitri's avatar
dimitri committed
1452
  for (li.toFirst();(param=li.current());++li)
dimitri's avatar
dimitri committed
1453 1454
  {
    if (!first) m_t << ","; else first=FALSE;
dimitri's avatar
dimitri committed
1455 1456 1457 1458 1459 1460 1461 1462
    if (param->kind()==DocNode::Kind_Word)
    {
      visit((DocWord*)param); 
    }
    else if (param->kind()==DocNode::Kind_LinkedWord)
    {
      visit((DocLinkedWord*)param); 
    }
dimitri's avatar
dimitri committed
1463
  }
dimitri's avatar
dimitri committed
1464
  m_t << "</td><td>";
dimitri's avatar
dimitri committed
1465 1466 1467 1468
}

void HtmlDocVisitor::visitPost(DocParamList *)
{
dimitri's avatar
dimitri committed
1469
  if (m_hide) return;
dimitri's avatar
dimitri committed
1470 1471 1472 1473 1474
  m_t << "</td></tr>" << endl;
}

void HtmlDocVisitor::visitPre(DocXRefItem *x)
{
dimitri's avatar
dimitri committed
1475
  if (m_hide) return;
dimitri's avatar
dimitri committed
1476
  forceEndParagraph(x);
dimitri's avatar
dimitri committed
1477 1478 1479
  bool anonymousEnum = x->file()=="@";
  if (!anonymousEnum)
  {
dimitri's avatar
dimitri committed
1480
    m_t << "<dl class=\"" << x->key() << "\"><dt><b><a class=\"el\" href=\"" 
dimitri's avatar
dimitri committed
1481 1482 1483 1484 1485
        << x->relPath() << x->file() << Doxygen::htmlFileExtension 
        << "#" << x->anchor() << "\">";
  }
  else 
  {
dimitri's avatar
dimitri committed
1486
    m_t << "<dl class=\"" << x->key() << "\"><dt><b>";
dimitri's avatar
dimitri committed
1487
  }
dimitri's avatar
dimitri committed
1488
  filter(x->title());
dimitri's avatar
dimitri committed
1489 1490 1491
  m_t << ":";
  if (!anonymousEnum) m_t << "</a>";
  m_t << "</b></dt><dd>";
dimitri's avatar
dimitri committed
1492 1493
}

dimitri's avatar
dimitri committed
1494
void HtmlDocVisitor::visitPost(DocXRefItem *x)
dimitri's avatar
dimitri committed
1495
{
dimitri's avatar
dimitri committed
1496
  if (m_hide) return;
dimitri's avatar
dimitri committed
1497
  m_t << "</dd></dl>" << endl;
dimitri's avatar
dimitri committed
1498
  forceStartParagraph(x);
dimitri's avatar
dimitri committed
1499 1500 1501 1502
}

void HtmlDocVisitor::visitPre(DocInternalRef *ref)
{
dimitri's avatar
dimitri committed
1503
  if (m_hide) return;
dimitri's avatar
dimitri committed
1504
  startLink(0,ref->file(),ref->relPath(),ref->anchor());
dimitri's avatar
dimitri committed
1505 1506 1507 1508
}

void HtmlDocVisitor::visitPost(DocInternalRef *) 
{
dimitri's avatar
dimitri committed
1509
  if (m_hide) return;
dimitri's avatar
dimitri committed
1510 1511 1512 1513 1514 1515 1516 1517 1518
  endLink();
  m_t << " ";
}

void HtmlDocVisitor::visitPre(DocCopy *)
{
}

void HtmlDocVisitor::visitPost(DocCopy *)
dimitri's avatar
dimitri committed
1519 1520 1521 1522 1523 1524 1525 1526
{
}

void HtmlDocVisitor::visitPre(DocText *)
{
}

void HtmlDocVisitor::visitPost(DocText *)
dimitri's avatar
dimitri committed
1527 1528
{
}
dimitri's avatar
dimitri committed
1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547

void HtmlDocVisitor::filter(const char *str)
{ 
  if (str==0) return;
  const char *p=str;
  char c;
  while (*p)
  {
    c=*p++;
    switch(c)
    {
      case '<':  m_t << "&lt;"; break;
      case '>':  m_t << "&gt;"; break;
      case '&':  m_t << "&amp;"; break;
      default:   m_t << c;
    }
  }
}

dimitri's avatar
dimitri committed
1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584
/// Escape basic entities to produce a valid CDATA attribute value,
/// assume that the outer quoting will be using the double quote &quot;
void HtmlDocVisitor::filterQuotedCdataAttr(const char* str)
{
  if (str==0) return;
  const char *p=str;
  char c;
  while (*p)
  {
    c=*p++;
    switch(c)
    {
      case '&':  m_t << "&amp;"; break;
      case '"':  m_t << "&quot;"; break;
       // For SGML compliance, and given the SGML declaration for HTML syntax,
       // it's enough to replace these two, provided that the declaration
       // for the HTML version we generate (and as supported by the browser)
       // specifies that all the other symbols used in rawVal are
       // within the right charachter class (i.e., they're not
       // some multinational weird charachters not in the BASESET).
       // We assume that 1) the browser will support whatever is remaining
       // in the formula and 2) the TeX formulae are generally governed
       // by even stricter charachter restrictions so it should be enough.
       //
       // On some incompliant browsers, additional translation of
       // '>' and '<' into "&gt;" and "&lt;", respectively, might be needed;
       // but I'm unaware of particular modern (last 4 years) versions
       // with such problems, so let's not do it for performance.
       // Also, some brousers will (wrongly) not process the entity references
       // inside the attribute value and show the &...; form instead,  
       // so we won't create entites unless necessary to minimize clutter there.
       // --vassilii 
      default:   m_t << c;
    }
  }
}

dimitri's avatar
dimitri committed
1585 1586 1587
void HtmlDocVisitor::startLink(const QCString &ref,const QCString &file,
                               const QCString &relPath,const QCString &anchor,
                               const QCString &tooltip)
dimitri's avatar
dimitri committed
1588 1589 1590 1591
{
  if (!ref.isEmpty()) // link to entity imported via tag file
  {
    m_t << "<a class=\"elRef\" ";
dimitri's avatar
dimitri committed
1592
    m_t << externalLinkTarget() << externalRef(relPath,ref,FALSE);
dimitri's avatar
dimitri committed
1593 1594 1595 1596 1597 1598
  }
  else // local link
  {
    m_t << "<a class=\"el\" ";
  }
  m_t << "href=\"";
dimitri's avatar
dimitri committed
1599
  m_t << externalRef(relPath,ref,TRUE);
dimitri's avatar
dimitri committed
1600 1601
  if (!file.isEmpty()) m_t << file << Doxygen::htmlFileExtension;
  if (!anchor.isEmpty()) m_t << "#" << anchor;
dimitri's avatar
dimitri committed
1602 1603 1604
  m_t << "\"";
  if (!tooltip.isEmpty()) m_t << " title=\"" << tooltip << "\"";
  m_t << ">";
dimitri's avatar
dimitri committed
1605 1606 1607 1608 1609 1610 1611
}

void HtmlDocVisitor::endLink()
{
  m_t << "</a>";
}

dimitri's avatar
dimitri committed
1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624
void HtmlDocVisitor::pushEnabled()
{
  m_enabled.push(new bool(m_hide));
}

void HtmlDocVisitor::popEnabled()
{
  bool *v=m_enabled.pop();
  ASSERT(v!=0);
  m_hide = *v;
  delete v;
}

dimitri's avatar
dimitri committed
1625
void HtmlDocVisitor::writeDotFile(const QCString &fn,const QCString &relPath,
dimitri's avatar
dimitri committed
1626
                                  const QCString &context)
dimitri's avatar
dimitri committed
1627
{
dimitri's avatar
dimitri committed
1628
  QCString baseName=fn;
dimitri's avatar
dimitri committed
1629 1630 1631 1632
  int i;
  if ((i=baseName.findRev('/'))!=-1)
  {
    baseName=baseName.right(baseName.length()-i-1);
dimitri's avatar
dimitri committed
1633
  }
dimitri's avatar
dimitri committed
1634
  QCString outDir = Config_getString("HTML_OUTPUT");
dimitri's avatar
dimitri committed
1635
  writeDotGraphFromFile(fn,outDir,baseName,BITMAP);
dimitri's avatar
dimitri committed
1636
  QCString mapName = baseName+".map";
dimitri's avatar
dimitri committed
1637
  QCString mapFile = fn+".map";
dimitri's avatar
dimitri committed
1638 1639 1640 1641 1642 1643 1644 1645
  //m_t << "<img src=\"" << relPath << baseName << "." 
  //    << Config_getEnum("DOT_IMAGE_FORMAT") << "\" alt=\""
  //    << baseName << "\" border=\"0\" usemap=\"#" << mapName << "\">" 
  //    << endl;
  //QCString imap = getDotImageMapFromFile(m_t,fn,baseName,outDir,relPath,context);
  //m_t << "<map name=\"" << mapName << "\" id=\"" << mapName << "\">" 
  //    << imap << "</map>" << endl;
  writeDotImageMapFromFile(m_t,fn,outDir,relPath,context);
dimitri's avatar
dimitri committed
1646 1647
}

dimitri's avatar
dimitri committed
1648 1649
void HtmlDocVisitor::writeMscFile(const QCString &fileName,const QCString &relPath,
                                  const QCString &context)
dimitri's avatar
dimitri committed
1650
{
dimitri's avatar
dimitri committed
1651
  QCString baseName=fileName;
dimitri's avatar
dimitri committed
1652 1653 1654 1655
  int i;
  if ((i=baseName.findRev('/'))!=-1)
  {
    baseName=baseName.right(baseName.length()-i-1);
dimitri's avatar
dimitri committed
1656
  }
dimitri's avatar
dimitri committed
1657
  QCString outDir = Config_getString("HTML_OUTPUT");
dimitri's avatar
dimitri committed
1658
  writeMscGraphFromFile(fileName,outDir,baseName,MSC_BITMAP);
dimitri's avatar
dimitri committed
1659 1660
  QCString mapName = baseName+".map";
  QCString mapFile = fileName+".map";
dimitri's avatar
dimitri committed
1661 1662
  m_t << "<img src=\"" << relPath << baseName << ".png\" alt=\""
    << baseName << "\" border=\"0\" usemap=\"#" << mapName << "\">" << endl;
dimitri's avatar
dimitri committed
1663
  QCString imap = getMscImageMapFromFile(fileName,outDir,relPath,context);
dimitri's avatar
dimitri committed
1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681
  m_t << "<map name=\"" << mapName << "\" id=\"" << mapName << "\">" << imap << "</map>" << endl;
}

/** Used for items found inside a paragraph, which due to XHTML restrictions
 *  have to be outside of the paragraph. This method will forcefully end
 *  the current paragraph and forceStartParagraph() will restart it.
 */
void HtmlDocVisitor::forceEndParagraph(DocNode *n)
{
  //printf("forceEndParagraph(%p) %d\n",n,n->kind());
  if (n->parent() && n->parent()->kind()==DocNode::Kind_Para)
  {
    DocPara *para = (DocPara*)n->parent();
    int nodeIndex = para->children().findRef(n);
    nodeIndex--;
    if (nodeIndex<0) return; // first node
    while (nodeIndex>=0 && 
           para->children().at(nodeIndex)->kind()==DocNode::Kind_WhiteSpace
dimitri's avatar
dimitri committed
1682
          )
dimitri's avatar
dimitri committed
1683 1684 1685 1686 1687 1688 1689 1690 1691
    {
      nodeIndex--;
    }
    if (nodeIndex>=0)
    {
      DocNode *n = para->children().at(nodeIndex);
      //printf("n=%p kind=%d outside=%d\n",n,n->kind(),mustBeOutsideParagraph(n));
      if (mustBeOutsideParagraph(n)) return;
    }
dimitri's avatar
dimitri committed
1692

dimitri's avatar
dimitri committed
1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718
    bool isFirst;
    bool isLast;
    getParagraphContext(para,isFirst,isLast);
    //printf("forceEnd first=%d last=%d\n",isFirst,isLast);
    if (isFirst && isLast) return;

    m_t << "</p>" << endl;
  }
}

/** Used for items found inside a paragraph, which due to XHTML restrictions
 *  have to be outside of the paragraph. This method will forcefully start
 *  the paragraph, that was previously ended by forceEndParagraph().
 */
void HtmlDocVisitor::forceStartParagraph(DocNode *n)
{
  //printf("forceStartParagraph(%p) %d\n",n,n->kind());
  if (n->parent() && n->parent()->kind()==DocNode::Kind_Para) // if we are inside a paragraph
  {
    DocPara *para = (DocPara*)n->parent();
    int nodeIndex = para->children().findRef(n);
    int numNodes  = para->children().count();
    nodeIndex++;
    if (nodeIndex==numNodes) return; // last node
    while (nodeIndex<numNodes && 
           para->children().at(nodeIndex)->kind()==DocNode::Kind_WhiteSpace
dimitri's avatar
dimitri committed
1719
          )
dimitri's avatar
dimitri committed
1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737
    {
      nodeIndex++;
    }
    if (nodeIndex<numNodes)
    {
      DocNode *n = para->children().at(nodeIndex);
      if (mustBeOutsideParagraph(n)) return;
    }
    else
    {
      return; // only whitespace at the end!
    }

    bool isFirst;
    bool isLast;
    getParagraphContext(para,isFirst,isLast);
    //printf("forceStart first=%d last=%d\n",isFirst,isLast);
    if (isFirst && isLast) return;
dimitri's avatar
dimitri committed
1738

dimitri's avatar
dimitri committed
1739 1740
    m_t << "<p>";
  }
dimitri's avatar
dimitri committed
1741 1742
}