1 /******************************************************************************

     2  *

     3  * 

     4  *

     5  *

     6  * Copyright (C) 1997-2008 by Dimitri van Heesch.

     7  *

     8  * Permission to use, copy, modify, and distribute this software and its

     9  * documentation under the terms of the GNU General Public License is hereby 

    10  * granted. No representations are made about the suitability of this software 

    11  * for any purpose. It is provided "as is" without express or implied warranty.

    12  * See the GNU General Public License for more details.

    13  *

    14  * Documents produced by Doxygen are derivative works derived from the

    15  * input used in their production; they are not affected by this license.

    16  *

    17  */

    18 

    19 #include <qdir.h>

    20 #include "htmldocvisitor.h"

    21 #include "docparser.h"

    22 #include "language.h"

    23 #include "doxygen.h"

    24 #include "outputgen.h"

    25 #include "dot.h"

    26 #include "message.h"

    27 #include "config.h"

    28 #include "htmlgen.h"

    29 #include "parserintf.h"

    30 #include "msc.h"

    31 #include "util.h"

    32 

    33 

    34 static const int NUM_HTML_LIST_TYPES = 4;

    35 static const char types[][NUM_HTML_LIST_TYPES] = {"1", "a", "i", "A"};

    36 

    37 static QCString convertIndexWordToAnchor(const QString &word)

    38 {

    39   static char hex[] = "0123456789abcdef";

    40   uint i;

    41   QCString result;

    42   for (i=0;i<word.length();i++)

    43   {

    44     int c = word.at(i);

    45     if (isId(c))

    46     {

    47       result+=c;

    48     }

    49     else if (isspace(c))

    50     {

    51       result+="_";

    52     }

    53     else

    54     {

    55       char cs[3];

    56       cs[0]=hex[c>>4];

    57       cs[1]=hex[c&0xf];

    58       cs[2]=0;

    59       result+=cs;

    60     }

    61   }

    62   return result;

    63 }

    64 

    65 static bool mustBeOutsideParagraph(DocNode *n)

    66 {

    67   switch (n->kind())

    68   {

    69           /* <ul> */

    70         case DocNode::Kind_HtmlList:

    71         case DocNode::Kind_SimpleList:

    72         case DocNode::Kind_AutoList:

    73           /* <dl> */

    74         case DocNode::Kind_SimpleSect:

    75         case DocNode::Kind_ParamSect:

    76         case DocNode::Kind_HtmlDescList:

    77         case DocNode::Kind_XRefItem:

    78           /* <table> */

    79         case DocNode::Kind_HtmlTable:

    80           /* <h?> */

    81         case DocNode::Kind_Section:

    82         case DocNode::Kind_HtmlHeader:

    83           /* <div> */

    84         case DocNode::Kind_Verbatim:

    85         case DocNode::Kind_Include:

    86         case DocNode::Kind_Image:

    87         case DocNode::Kind_SecRefList:

    88           /* <hr> */

    89         case DocNode::Kind_HorRuler:

    90           return TRUE;

    91         case DocNode::Kind_StyleChange:

    92           return ((DocStyleChange*)n)->style()==DocStyleChange::Preformatted ||

    93                  ((DocStyleChange*)n)->style()==DocStyleChange::Div ||

    94                  ((DocStyleChange*)n)->style()==DocStyleChange::Center;

    95         case DocNode::Kind_Formula:

    96           return !((DocFormula*)n)->isInline();

    97         default:

    98           break;

    99   }

   100   return FALSE;

   101 }

   102 

   103 

   104 

   105 static QString htmlAttribsToString(const HtmlAttribList &attribs)

   106 {

   107   QString result;

   108   HtmlAttribListIterator li(attribs);

   109   HtmlAttrib *att;

   110   for (li.toFirst();(att=li.current());++li)

   111   {

   112     if (!att->value.isEmpty())  // ignore attribute without values as they

   113                                 // are not XHTML compliant

   114     {

   115       result+=" ";

   116       result+=att->name;

   117       result+="=\""+convertToXML(att->value)+"\"";

   118     }

   119   }

   120   return result;

   121 }

   122 

   123 //-------------------------------------------------------------------------

   124 

   125 HtmlDocVisitor::HtmlDocVisitor(QTextStream &t,CodeOutputInterface &ci,

   126                                const char *langExt) 

   127   : DocVisitor(DocVisitor_Html), m_t(t), m_ci(ci), m_insidePre(FALSE), 

   128                                  m_hide(FALSE), m_langExt(langExt)

   129 {

   130 }

   131 

   132   //--------------------------------------

   133   // visitor functions for leaf nodes

   134   //--------------------------------------

   135 

   136 void HtmlDocVisitor::visit(DocWord *w)

   137 {

   138   if (m_hide) return;

   139   filter(w->word());

   140 }

   141 

   142 void HtmlDocVisitor::visit(DocLinkedWord *w)

   143 {

   144   if (m_hide) return;

   145   startLink(w->ref(),w->file(),w->relPath(),w->anchor(),w->tooltip());

   146   filter(w->word());

   147   endLink();

   148 }

   149 

   150 void HtmlDocVisitor::visit(DocWhiteSpace *w)

   151 {

   152   if (m_hide) return;

   153   if (m_insidePre)

   154   {

   155     m_t << w->chars();

   156   }

   157   else

   158   {

   159     m_t << " ";

   160   }

   161 }

   162 

   163 void HtmlDocVisitor::visit(DocSymbol *s)

   164 {

   165   if (m_hide) return;

   166   switch(s->symbol())

   167   {

   168     case DocSymbol::BSlash:  m_t << "\\"; break;

   169     case DocSymbol::At:      m_t << "@"; break;

   170     case DocSymbol::Less:    m_t << "&lt;"; break;

   171     case DocSymbol::Greater: m_t << "&gt;"; break;

   172     case DocSymbol::Amp:     m_t << "&amp;"; break;

   173     case DocSymbol::Dollar:  m_t << "$"; break;

   174     case DocSymbol::Hash:    m_t << "#"; break;

   175     case DocSymbol::Percent: m_t << "%"; break;

   176     case DocSymbol::Copy:    m_t << "&copy;"; break;

   177     case DocSymbol::Tm:      m_t << "&trade;"; break;

   178     case DocSymbol::Reg:     m_t << "&reg;"; break;

   179     case DocSymbol::Apos:    m_t << "'"; break;

   180     case DocSymbol::Quot:    m_t << "\""; break;

   181     case DocSymbol::Lsquo:   m_t << "&lsquo;"; break;

   182     case DocSymbol::Rsquo:   m_t << "&rsquo;"; break;

   183     case DocSymbol::Ldquo:   m_t << "&ldquo;"; break;

   184     case DocSymbol::Rdquo:   m_t << "&rdquo;"; break;

   185     case DocSymbol::Ndash:   m_t << "&ndash;"; break;

   186     case DocSymbol::Mdash:   m_t << "&mdash;"; break;

   187     case DocSymbol::Uml:     m_t << "&" << s->letter() << "uml;"; break;

   188     case DocSymbol::Acute:   m_t << "&" << s->letter() << "acute;"; break;

   189     case DocSymbol::Grave:   m_t << "&" << s->letter() << "grave;"; break;

   190     case DocSymbol::Circ:    m_t << "&" << s->letter() << "circ;"; break;

   191     case DocSymbol::Slash:   m_t << "&" << s->letter() << "slash;"; break;

   192     case DocSymbol::Tilde:   m_t << "&" << s->letter() << "tilde;"; break;

   193     case DocSymbol::Szlig:   m_t << "&szlig;"; break;

   194     case DocSymbol::Cedil:   m_t << "&" << s->letter() << "cedil;"; break;

   195     case DocSymbol::Ring:    m_t << "&" << s->letter() << "ring;"; break;

   196     case DocSymbol::Nbsp:    m_t << "&nbsp;"; break;

   197     case DocSymbol::AElig:   m_t << "&AElig;"; break;

   198     case DocSymbol::Aelig:   m_t << "&aelig;"; break;

   199     default:

   200                              err("Error: unknown symbol found\n");

   201   }

   202 }

   203 

   204 void HtmlDocVisitor::visit(DocURL *u)

   205 {

   206   if (m_hide) return;

   207   m_t << "<a href=\"";

   208   if (u->isEmail()) m_t << "mailto:";

   209   m_t << u->url() << "\">";

   210   filter(u->url());

   211   m_t << "</a>";

   212 }

   213 

   214 void HtmlDocVisitor::visit(DocLineBreak *)

   215 {

   216   if (m_hide) return;

   217   m_t << "<br/>\n";

   218 }

   219 

   220 void HtmlDocVisitor::visit(DocHorRuler *)

   221 {

   222   if (m_hide) return;

   223   m_t << "<hr/>\n";

   224 }

   225 

   226 void HtmlDocVisitor::visit(DocStyleChange *s)

   227 {

   228   if (m_hide) return;

   229   switch (s->style())

   230   {

   231     case DocStyleChange::Bold:

   232       if (s->enable()) m_t << "<b" << htmlAttribsToString(s->attribs()) << ">";      else m_t << "</b>";

   233       break;

   234     case DocStyleChange::Italic:

   235       if (s->enable()) m_t << "<em" << htmlAttribsToString(s->attribs()) << ">";     else m_t << "</em>";

   236       break;

   237     case DocStyleChange::Code:

   238       if (s->enable()) m_t << "<code" << htmlAttribsToString(s->attribs()) << ">";   else m_t << "</code>";

   239       break;

   240     case DocStyleChange::Subscript:

   241       if (s->enable()) m_t << "<sub" << htmlAttribsToString(s->attribs()) << ">";    else m_t << "</sub>";

   242       break;

   243     case DocStyleChange::Superscript:

   244       if (s->enable()) m_t << "<sup" << htmlAttribsToString(s->attribs()) << ">";    else m_t << "</sup>";

   245       break;

   246     case DocStyleChange::Center:

   247       if (s->enable()) 

   248       {

   249         forceEndParagraph(s);

   250         m_t << "<center" << htmlAttribsToString(s->attribs()) << ">"; 

   251       }

   252       else 

   253       {

   254         m_t << "</center>";

   255         forceStartParagraph(s);

   256       }

   257       break;

   258     case DocStyleChange::Small:

   259       if (s->enable()) m_t << "<small" << htmlAttribsToString(s->attribs()) << ">";  else m_t << "</small>";

   260       break;

   261     case DocStyleChange::Preformatted:

   262       if (s->enable())

   263       {

   264         forceEndParagraph(s);

   265         m_t << "<pre" << htmlAttribsToString(s->attribs()) << ">";

   266         m_insidePre=TRUE;

   267       }

   268       else

   269       {

   270         m_insidePre=FALSE;

   271         m_t << "</pre>";

   272         forceStartParagraph(s);

   273       }

   274       break;

   275     case DocStyleChange::Div:

   276       if (s->enable()) 

   277       {

   278         forceEndParagraph(s);

   279         m_t << "<div" << htmlAttribsToString(s->attribs()) << ">";  

   280       }

   281       else 

   282       {

   283         m_t << "</div>";

   284         forceStartParagraph(s);

   285       }

   286       break;

   287     case DocStyleChange::Span:

   288       if (s->enable()) m_t << "<span" << htmlAttribsToString(s->attribs()) << ">";  else m_t << "</span>";

   289       break;

   290 

   291   }

   292 }

   293 

   294 

   295 void HtmlDocVisitor::visit(DocVerbatim *s)

   296 {

   297   if (m_hide) return;

   298   switch(s->type())

   299   {

   300     case DocVerbatim::Code: // fall though

   301       forceEndParagraph(s);

   302       m_t << PREFRAG_START;

   303       Doxygen::parserManager->getParser(m_langExt)

   304                             ->parseCode(m_ci,s->context(),s->text().latin1(),

   305                                         s->isExample(),s->exampleFile());

   306       m_t << PREFRAG_END;

   307       forceStartParagraph(s);

   308       break;

   309     case DocVerbatim::Verbatim: 

   310       forceEndParagraph(s);

   311       m_t << PREFRAG_START;

   312       filter(s->text());

   313       m_t << PREFRAG_END;

   314       forceStartParagraph(s);

   315       break;

   316     case DocVerbatim::HtmlOnly: 

   317       m_t << s->text(); 

   318       break;

   319     case DocVerbatim::ManOnly: 

   320     case DocVerbatim::LatexOnly: 

   321     case DocVerbatim::XmlOnly: 

   322       /* nothing */ 

   323       break;

   324 

   325     case DocVerbatim::Dot:

   326       {

   327         static int dotindex = 1;

   328         QCString fileName(4096);

   329 

   330         fileName.sprintf("%s%d%s", 

   331             (Config_getString("HTML_OUTPUT")+"/inline_dotgraph_").data(), 

   332             dotindex++,

   333             ".dot"

   334            );

   335         QFile file(fileName);

   336         if (!file.open(IO_WriteOnly))

   337         {

   338           err("Could not open file %s for writing\n",fileName.data());

   339         }

   340         file.writeBlock( s->text(), s->text().length() );

   341         file.close();

   342 

   343         forceEndParagraph(s);

   344         m_t << "<div align=\"center\">" << endl;

   345         writeDotFile(fileName,s->relPath(),s->context());

   346         m_t << "</div>" << endl;

   347         forceStartParagraph(s);

   348 

   349         if (Config_getBool("DOT_CLEANUP")) file.remove();

   350       }

   351       break;

   352     case DocVerbatim::Msc:

   353       {

   354         static int mscindex = 1;

   355         QCString baseName(4096);

   356 

   357         baseName.sprintf("%s%d", 

   358             (Config_getString("HTML_OUTPUT")+"/inline_mscgraph_").data(), 

   359             mscindex++

   360            );

   361         QFile file(baseName+".msc");

   362         if (!file.open(IO_WriteOnly))

   363         {

   364           err("Could not open file %s.msc for writing\n",baseName.data());

   365         }

   366         QCString text = "msc {";

   367         text+=s->text();

   368         text+="}";

   369         file.writeBlock( text, text.length() );

   370         file.close();

   371 

   372         forceEndParagraph(s);

   373         m_t << "<div align=\"center\">" << endl;

   374         writeMscFile(baseName,s->relPath(),s->context());

   375         m_t << "</div>" << endl;

   376         forceStartParagraph(s);

   377 

   378         if (Config_getBool("DOT_CLEANUP")) file.remove();

   379       }

   380       break;

   381   }

   382 }

   383 

   384 void HtmlDocVisitor::visit(DocAnchor *anc)

   385 {

   386   if (m_hide) return;

   387   m_t << "<a class=\"anchor\" id=\"" << anc->anchor() << "\"></a>";

   388 }

   389 

   390 void HtmlDocVisitor::visit(DocInclude *inc)

   391 {

   392   if (m_hide) return;

   393   switch(inc->type())

   394   {

   395     case DocInclude::Include: 

   396       forceEndParagraph(inc);

   397       m_t << PREFRAG_START;

   398       Doxygen::parserManager->getParser(inc->extension())

   399                             ->parseCode(m_ci,                 

   400                                         inc->context(),

   401                                         inc->text().latin1(),

   402                                         inc->isExample(),

   403                                         inc->exampleFile(),

   404                                         0,   // fd

   405                                         -1,  // startLine

   406                                         -1,  // endLine

   407                                         TRUE // inlineFragment

   408                                        );

   409       m_t << PREFRAG_END;

   410       forceStartParagraph(inc);

   411       break;

   412     case DocInclude::IncWithLines:

   413       { 

   414          forceEndParagraph(inc);

   415          m_t << PREFRAG_START;

   416          QFileInfo cfi( inc->file() );

   417          FileDef fd( cfi.dirPath(), cfi.fileName() );

   418          Doxygen::parserManager->getParser(inc->extension())

   419                                ->parseCode(m_ci,

   420                                            inc->context(),

   421                                            inc->text().latin1(),

   422                                            inc->isExample(),

   423                                            inc->exampleFile(), &fd);

   424          m_t << PREFRAG_END;

   425          forceStartParagraph(inc);

   426       }

   427       break;

   428     case DocInclude::DontInclude: 

   429       break;

   430     case DocInclude::HtmlInclude: 

   431       m_t << inc->text(); 

   432       break;

   433     case DocInclude::VerbInclude: 

   434       forceEndParagraph(inc);

   435       m_t << PREFRAG_START;

   436       filter(inc->text());

   437       m_t << PREFRAG_END;

   438       forceStartParagraph(inc);

   439       break;

   440   }

   441 }

   442 

   443 void HtmlDocVisitor::visit(DocIncOperator *op)

   444 {

   445   //printf("DocIncOperator: type=%d first=%d, last=%d text=`%s'\n",

   446   //    op->type(),op->isFirst(),op->isLast(),op->text().data());

   447   if (op->isFirst()) 

   448   {

   449     if (!m_hide) m_t << PREFRAG_START;

   450     pushEnabled();

   451     m_hide=TRUE;

   452   }

   453   if (op->type()!=DocIncOperator::Skip) 

   454   {

   455     popEnabled();

   456     if (!m_hide) 

   457     {

   458       Doxygen::parserManager->getParser(m_langExt)

   459                             ->parseCode(m_ci,op->context(),

   460                                 op->text().latin1(),op->isExample(),

   461                                 op->exampleFile());

   462     }

   463     pushEnabled();

   464     m_hide=TRUE;

   465   }

   466   if (op->isLast())  

   467   {

   468     popEnabled();

   469     if (!m_hide) m_t << PREFRAG_END;

   470   }

   471   else

   472   {

   473     if (!m_hide) m_t << endl;

   474   }

   475 }

   476 

   477 void HtmlDocVisitor::visit(DocFormula *f)

   478 {

   479   if (m_hide) return;

   480   bool bDisplay = !f->isInline();

   481   if (bDisplay) 

   482   {

   483     forceEndParagraph(f);

   484     m_t << "<p class=\"formulaDsp\">" << endl;

   485   }

   486   m_t << "<img class=\"formula" 

   487       << (bDisplay ? "Dsp" : "Inl");

   488   m_t << "\" alt=\"";

   489   filterQuotedCdataAttr(f->text());

   490   m_t << "\"";

   491   /// @todo cache image dimensions on formula generation and give height/width

   492   /// for faster preloading and better rendering of the page

   493   m_t << " src=\"" << f->relPath() << f->name() << ".png\"/>";

   494   if (bDisplay)

   495   {

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

   497     forceStartParagraph(f);

   498   }

   499 }

   500 

   501 void HtmlDocVisitor::visit(DocIndexEntry *e)

   502 {

   503   QCString anchor = convertIndexWordToAnchor(e->entry());

   504   if (e->member()) 

   505   {

   506     anchor.prepend(e->member()->anchor()+"_");

   507   }

   508   m_t << "<a name=\"" << anchor << "\"></a>";

   509   //printf("*** DocIndexEntry: word='%s' scope='%s' member='%s'\n",

   510   //       e->entry().data(),

   511   //       e->scope()  ? e->scope()->name().data()  : "<null>",

   512   //       e->member() ? e->member()->name().data() : "<null>"

   513   //      );

   514   Doxygen::indexList.addIndexItem(e->scope(),e->member(),anchor,e->entry());

   515 }

   516 

   517 void HtmlDocVisitor::visit(DocSimpleSectSep *)

   518 {

   519   m_t << "</dd>" << endl;

   520   m_t << "<dd>" << endl;

   521 }

   522 

   523 //--------------------------------------

   524 // visitor functions for compound nodes

   525 //--------------------------------------

   526 

   527 

   528 void HtmlDocVisitor::visitPre(DocAutoList *l)

   529 {

   530   if (m_hide) return;

   531   forceEndParagraph(l);

   532   if (l->isEnumList())

   533   {

   534     //

   535     // Do list type based on depth:

   536     // 1.

   537     //   a.

   538     //     i.

   539     //       A. 

   540     //         1. (repeat)...

   541     //

   542     m_t << "<ol type=\"" << types[l->depth() % NUM_HTML_LIST_TYPES] << "\">";

   543   }

   544   else

   545   {

   546     m_t << "<ul>";

   547   }

   548   if (!l->isPreformatted()) m_t << "\n";

   549 }

   550 

   551 void HtmlDocVisitor::visitPost(DocAutoList *l)

   552 {

   553   if (m_hide) return;

   554   if (l->isEnumList())

   555   {

   556     m_t << "</ol>";

   557   }

   558   else

   559   {

   560     m_t << "</ul>";

   561   }

   562   if (!l->isPreformatted()) m_t << "\n";

   563   forceStartParagraph(l);

   564 }

   565 

   566 void HtmlDocVisitor::visitPre(DocAutoListItem *)

   567 {

   568   if (m_hide) return;

   569   m_t << "<li>";

   570 }

   571 

   572 void HtmlDocVisitor::visitPost(DocAutoListItem *li) 

   573 {

   574   if (m_hide) return;

   575   m_t << "</li>";

   576   if (!li->isPreformatted()) m_t << "\n";

   577 }

   578 

   579 template<class T> 

   580 bool isFirstChildNode(T *parent, DocNode *node)

   581 {

   582    return parent->children().getFirst()==node;

   583 }

   584 

   585 template<class T> 

   586 bool isLastChildNode(T *parent, DocNode *node)

   587 {

   588    return parent->children().getLast()==node;

   589 }

   590 

   591 bool isSeparatedParagraph(DocSimpleSect *parent,DocPara *par)

   592 {

   593   QList<DocNode> nodes = parent->children();

   594   int i = nodes.findRef(par);

   595   if (i==-1) return FALSE;

   596   int count = parent->children().count();

   597   if (count>1 && i==0)

   598   {

   599     if (nodes.at(i+1)->kind()==DocNode::Kind_SimpleSectSep)

   600     {

   601       return TRUE;

   602     }

   603   }

   604   else if (count>1 && i==count-1)

   605   {

   606     if (nodes.at(i-1)->kind()==DocNode::Kind_SimpleSectSep)

   607     {

   608       return TRUE;

   609     }

   610   }

   611   else if (count>2 && i>0 && i<count-1)

   612   {

   613     if (nodes.at(i-1)->kind()==DocNode::Kind_SimpleSectSep &&

   614         nodes.at(i+1)->kind()==DocNode::Kind_SimpleSectSep)

   615     {

   616       return TRUE;

   617     }

   618   }

   619   return FALSE;

   620 }

   621 

   622 static int getParagraphContext(DocPara *p,bool &isFirst,bool &isLast)

   623 {

   624   int t=0;

   625   isFirst=FALSE;

   626   isLast=FALSE;

   627   if (p && p->parent())

   628   {

   629     switch (p->parent()->kind()) 

   630     {

   631       case DocNode::Kind_AutoListItem:

   632         isFirst=TRUE;

   633         isLast =TRUE;

   634         if (isFirst) t=1;

   635         if (isLast)  t=3;

   636         break;

   637       case DocNode::Kind_SimpleListItem:

   638         isFirst=TRUE;

   639         isLast =TRUE;

   640         if (isFirst) t=1;

   641         if (isLast)  t=3;

   642         break;

   643       case DocNode::Kind_HtmlListItem:

   644         isFirst=isFirstChildNode((DocHtmlListItem*)p->parent(),p);

   645         isLast =isLastChildNode ((DocHtmlListItem*)p->parent(),p);

   646         if (isFirst) t=1;

   647         if (isLast)  t=3;

   648         break;

   649       case DocNode::Kind_SecRefItem:

   650         isFirst=isFirstChildNode((DocSecRefItem*)p->parent(),p);

   651         isLast =isLastChildNode ((DocSecRefItem*)p->parent(),p);

   652         if (isFirst) t=1;

   653         if (isLast)  t=3;

   654         break;

   655       case DocNode::Kind_HtmlDescData:

   656         isFirst=isFirstChildNode((DocHtmlDescData*)p->parent(),p);

   657         isLast =isLastChildNode ((DocHtmlDescData*)p->parent(),p);

   658         if (isFirst) t=2;

   659         if (isLast)  t=4;

   660         break;

   661       case DocNode::Kind_XRefItem:

   662         isFirst=isFirstChildNode((DocXRefItem*)p->parent(),p);

   663         isLast =isLastChildNode ((DocXRefItem*)p->parent(),p);

   664         if (isFirst) t=2;

   665         if (isLast)  t=4;

   666         break;

   667       case DocNode::Kind_HtmlCell:

   668         isFirst=isFirstChildNode((DocHtmlCell*)p->parent(),p);

   669         isLast =isLastChildNode ((DocHtmlCell*)p->parent(),p);

   670         if (isFirst) t=5;

   671         if (isLast)  t=6;

   672         break;

   673       case DocNode::Kind_SimpleSect:

   674         isFirst=isFirstChildNode((DocSimpleSect*)p->parent(),p);

   675         isLast =isLastChildNode ((DocSimpleSect*)p->parent(),p);

   676         if (isFirst) t=2;

   677         if (isLast)  t=4;

   678         if (isSeparatedParagraph((DocSimpleSect*)p->parent(),p))

   679           // if the paragraph is enclosed with separators it will

   680           // be included in <dd>..</dd> so avoid addition paragraph

   681           // markers

   682         {

   683           isFirst=isLast=TRUE;

   684         }

   685         break;

   686       default:

   687         break;

   688     }

   689     //printf("para=%p parent()->kind=%d isFirst=%d isLast=%d t=%d\n",

   690     //    p,p->parent()->kind(),isFirst,isLast,t);

   691   }

   692   return t;

   693 }

   694 

   695 void HtmlDocVisitor::visitPre(DocPara *p) 

   696 {

   697   if (m_hide) return;

   698 

   699   //printf("Processing docpara with parent of kind %d\n",

   700   //       p->parent() ? p->parent()->kind() : -1);

   701 

   702   bool needsTag = FALSE;

   703   if (p && p->parent()) 

   704   {

   705     switch (p->parent()->kind()) 

   706     {

   707       case DocNode::Kind_Section:

   708       case DocNode::Kind_HtmlListItem:

   709       case DocNode::Kind_HtmlDescData:

   710       case DocNode::Kind_HtmlCell:

   711       case DocNode::Kind_SimpleListItem:

   712       case DocNode::Kind_AutoListItem:

   713       case DocNode::Kind_SimpleSect:

   714       case DocNode::Kind_XRefItem:

   715         needsTag = TRUE;

   716         break;

   717       case DocNode::Kind_Root:

   718         needsTag = !((DocRoot*)p->parent())->singleLine();

   719         break;

   720       default:

   721         needsTag = FALSE;

   722     }

   723   }

   724 

   725   // if the first element of a paragraph is something that should be outside of

   726   // the paragraph (<ul>,<dl>,<table>,..) then that will already started the 

   727   // paragraph and we don't need to do it here

   728   uint nodeIndex = 0;

   729   if (p && nodeIndex<p->children().count())

   730   {

   731     while (nodeIndex<p->children().count() && 

   732            p->children().at(nodeIndex)->kind()==DocNode::Kind_WhiteSpace)

   733     {

   734       nodeIndex++;

   735     }

   736     if (nodeIndex<p->children().count())

   737     {

   738       DocNode *n = p->children().at(nodeIndex);

   739       if (mustBeOutsideParagraph(n))

   740       {

   741         needsTag = FALSE;

   742       }

   743     }

   744   }

   745 

   746   // check if this paragraph is the first or last child of a <li> or <dd>.

   747   // this allows us to mark the tag with a special class so we can

   748   // fix the otherwise ugly spacing.

   749   int t;

   750   static const char *contexts[7] = 

   751   { "",                     // 0

   752     " class=\"startli\"",   // 1

   753     " class=\"startdd\"",   // 2

   754     " class=\"endli\"",     // 3

   755     " class=\"enddd\"",     // 4

   756     " class=\"starttd\"",   // 5

   757     " class=\"endtd\""      // 6

   758   };

   759   bool isFirst;

   760   bool isLast;

   761   t = getParagraphContext(p,isFirst,isLast);

   762   //printf("startPara first=%d last=%d\n",isFirst,isLast);

   763   if (isFirst && isLast) needsTag=FALSE;

   764 

   765   // write the paragraph tag (if needed)

   766   if (needsTag) m_t << "<p" << contexts[t] << ">";

   767 }

   768 

   769 void HtmlDocVisitor::visitPost(DocPara *p)

   770 {

   771 //  if (m_hide) return;

   772 //  if (!p->isLast() &&            // omit <p> for last paragraph

   773 //      !(p->parent() &&           // and for parameter sections

   774 //        p->parent()->kind()==DocNode::Kind_ParamSect

   775 //       ) 

   776 //     ) 

   777 //  {

   778 //    m_t << "<p>\n";

   779 //  }

   780 

   781   bool needsTag = FALSE;

   782   if (p && p->parent()) 

   783   {

   784     switch (p->parent()->kind()) 

   785     {

   786       case DocNode::Kind_Section:

   787       case DocNode::Kind_HtmlListItem:

   788       case DocNode::Kind_HtmlDescData:

   789       case DocNode::Kind_HtmlCell:

   790       case DocNode::Kind_SimpleListItem:

   791       case DocNode::Kind_AutoListItem:

   792       case DocNode::Kind_SimpleSect:

   793       case DocNode::Kind_XRefItem:

   794         needsTag = TRUE;

   795         break;

   796       case DocNode::Kind_Root:

   797         needsTag = !((DocRoot*)p->parent())->singleLine();

   798         break;

   799       default:

   800         needsTag = FALSE;

   801     }

   802   }

   803 

   804   QCString context;

   805   // if the last element of a paragraph is something that should be outside of

   806   // the paragraph (<ul>,<dl>,<table>) then that will already have ended the 

   807   // paragraph and we don't need to do it here

   808   int nodeIndex = p->children().count()-1;

   809   if (p && nodeIndex>=0)

   810   {

   811     while (nodeIndex>=0 && p->children().at(nodeIndex)->kind()==DocNode::Kind_WhiteSpace)

   812     {

   813       nodeIndex--;

   814     }

   815     if (nodeIndex>=0)

   816     {

   817       DocNode *n = p->children().at(nodeIndex);

   818       if (mustBeOutsideParagraph(n))

   819       {

   820         needsTag = FALSE;

   821       }

   822     }

   823   }

   824 

   825   bool isFirst;

   826   bool isLast;

   827   getParagraphContext(p,isFirst,isLast);

   828   //printf("endPara first=%d last=%d\n",isFirst,isLast);

   829   if (isFirst && isLast) needsTag=FALSE;

   830 

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

   832 

   833 }

   834 

   835 void HtmlDocVisitor::visitPre(DocRoot *)

   836 {

   837 }

   838 

   839 void HtmlDocVisitor::visitPost(DocRoot *)

   840 {

   841 }

   842 

   843 void HtmlDocVisitor::visitPre(DocSimpleSect *s)

   844 {

   845   if (m_hide) return;

   846   forceEndParagraph(s);

   847   m_t << "<dl class=\"" << s->typeString() << "\"><dt><b>";

   848   switch(s->type())

   849   {

   850     case DocSimpleSect::See: 

   851       m_t << theTranslator->trSeeAlso(); break;

   852     case DocSimpleSect::Return: 

   853       m_t << theTranslator->trReturns(); break;

   854     case DocSimpleSect::Author: 

   855       m_t << theTranslator->trAuthor(TRUE,TRUE); break;

   856     case DocSimpleSect::Authors: 

   857       m_t << theTranslator->trAuthor(TRUE,FALSE); break;

   858     case DocSimpleSect::Version: 

   859       m_t << theTranslator->trVersion(); break;

   860     case DocSimpleSect::Since: 

   861       m_t << theTranslator->trSince(); break;

   862     case DocSimpleSect::Date: 

   863       m_t << theTranslator->trDate(); break;

   864     case DocSimpleSect::Note: 

   865       m_t << theTranslator->trNote(); break;

   866     case DocSimpleSect::Warning:

   867       m_t << theTranslator->trWarning(); break;

   868     case DocSimpleSect::Pre:

   869       m_t << theTranslator->trPrecondition(); break;

   870     case DocSimpleSect::Post:

   871       m_t << theTranslator->trPostcondition(); break;

   872     case DocSimpleSect::Invar:

   873       m_t << theTranslator->trInvariant(); break;

   874     case DocSimpleSect::Remark:

   875       m_t << theTranslator->trRemarks(); break;

   876     case DocSimpleSect::Attention:

   877       m_t << theTranslator->trAttention(); break;

   878     case DocSimpleSect::User: break;

   879     case DocSimpleSect::Rcs: break;

   880     case DocSimpleSect::Unknown:  break;

   881   }

   882 

   883   // special case 1: user defined title

   884   if (s->type()!=DocSimpleSect::User && s->type()!=DocSimpleSect::Rcs)

   885   {

   886     m_t << ":</b></dt><dd>";

   887   }

   888 }

   889 

   890 void HtmlDocVisitor::visitPost(DocSimpleSect *s)

   891 {

   892   if (m_hide) return;

   893   m_t << "</dd></dl>\n";

   894   forceStartParagraph(s);

   895 }

   896 

   897 void HtmlDocVisitor::visitPre(DocTitle *)

   898 {

   899 }

   900 

   901 void HtmlDocVisitor::visitPost(DocTitle *)

   902 {

   903   if (m_hide) return;

   904   m_t << "</b></dt><dd>";

   905 }

   906 

   907 void HtmlDocVisitor::visitPre(DocSimpleList *sl)

   908 {

   909   if (m_hide) return;

   910   forceEndParagraph(sl);

   911   m_t << "<ul>";

   912   if (!sl->isPreformatted()) m_t << "\n";

   913 

   914 }

   915 

   916 void HtmlDocVisitor::visitPost(DocSimpleList *sl)

   917 {

   918   if (m_hide) return;

   919   m_t << "</ul>";

   920   if (!sl->isPreformatted()) m_t << "\n";

   921   forceStartParagraph(sl);

   922 }

   923 

   924 void HtmlDocVisitor::visitPre(DocSimpleListItem *)

   925 {

   926   if (m_hide) return;

   927   m_t << "<li>";

   928 }

   929 

   930 void HtmlDocVisitor::visitPost(DocSimpleListItem *li) 

   931 {

   932   if (m_hide) return;

   933   m_t << "</li>";

   934   if (!li->isPreformatted()) m_t << "\n";

   935 }

   936 

   937 void HtmlDocVisitor::visitPre(DocSection *s)

   938 {

   939   if (m_hide) return;

   940   forceEndParagraph(s);

   941   m_t << "<h" << s->level()+1 << ">";

   942   m_t << "<a class=\"anchor\" id=\"" << s->anchor();

   943   m_t << "\">" << endl;

   944   filter(convertCharEntitiesToUTF8(s->title().data()));

   945   m_t << "</a></h" << s->level()+1 << ">\n";

   946 }

   947 

   948 void HtmlDocVisitor::visitPost(DocSection *s) 

   949 {

   950   forceStartParagraph(s);

   951 }

   952 

   953 void HtmlDocVisitor::visitPre(DocHtmlList *s)

   954 {

   955   if (m_hide) return;

   956   forceEndParagraph(s);

   957   if (s->type()==DocHtmlList::Ordered) 

   958   {

   959     m_t << "<ol" << htmlAttribsToString(s->attribs()) << ">\n"; 

   960   }

   961   else 

   962   {

   963     m_t << "<ul" << htmlAttribsToString(s->attribs()) << ">\n";

   964   }

   965 }

   966 

   967 void HtmlDocVisitor::visitPost(DocHtmlList *s) 

   968 {

   969   if (m_hide) return;

   970   if (s->type()==DocHtmlList::Ordered) 

   971   {

   972     m_t << "</ol>"; 

   973   }

   974   else

   975   { 

   976     m_t << "</ul>";

   977   }

   978   if (!s->isPreformatted()) m_t << "\n";

   979   forceStartParagraph(s);

   980 }

   981 

   982 void HtmlDocVisitor::visitPre(DocHtmlListItem *i)

   983 {

   984   if (m_hide) return;

   985   m_t << "<li" << htmlAttribsToString(i->attribs()) << ">";

   986   if (!i->isPreformatted()) m_t << "\n";

   987 }

   988 

   989 void HtmlDocVisitor::visitPost(DocHtmlListItem *) 

   990 {

   991   if (m_hide) return;

   992   m_t << "</li>\n";

   993 }

   994 

   995 void HtmlDocVisitor::visitPre(DocHtmlDescList *dl)

   996 {

   997   if (m_hide) return;

   998   forceEndParagraph(dl);

   999   m_t << "<dl" << htmlAttribsToString(dl->attribs()) << ">\n";

  1000 }

  1001 

  1002 void HtmlDocVisitor::visitPost(DocHtmlDescList *dl) 

  1003 {

  1004   if (m_hide) return;

  1005   m_t << "</dl>\n";

  1006   forceStartParagraph(dl);

  1007 }

  1008 

  1009 void HtmlDocVisitor::visitPre(DocHtmlDescTitle *dt)

  1010 {

  1011   if (m_hide) return;

  1012   m_t << "<dt" << htmlAttribsToString(dt->attribs()) << ">";

  1013 }

  1014 

  1015 void HtmlDocVisitor::visitPost(DocHtmlDescTitle *) 

  1016 {

  1017   if (m_hide) return;

  1018   m_t << "</dt>\n";

  1019 }

  1020 

  1021 void HtmlDocVisitor::visitPre(DocHtmlDescData *dd)

  1022 {

  1023   if (m_hide) return;

  1024   m_t << "<dd" << htmlAttribsToString(dd->attribs()) << ">";

  1025 }

  1026 

  1027 void HtmlDocVisitor::visitPost(DocHtmlDescData *) 

  1028 {

  1029   if (m_hide) return;

  1030   m_t << "</dd>\n";

  1031 }

  1032 

  1033 void HtmlDocVisitor::visitPre(DocHtmlTable *t)

  1034 {

  1035   if (m_hide) return;

  1036   //bool hasBorder      = FALSE;

  1037   //bool hasCellSpacing = FALSE;

  1038   //bool hasCellPadding = FALSE;

  1039 

  1040   forceEndParagraph(t);

  1041 

  1042   //HtmlAttribListIterator li(t->attribs());

  1043   //HtmlAttrib *att;

  1044   //for (li.toFirst();(att=li.current());++li)

  1045   //{

  1046   // if      (att->name=="border")      hasBorder=TRUE;

  1047   //  else if (att->name=="cellspacing") hasCellSpacing=TRUE;

  1048   //  else if (att->name=="cellpadding") hasCellPadding=TRUE;

  1049   //}

  1050   m_t << "<table class=\"doxtable\"" << htmlAttribsToString(t->attribs());

  1051   //if (!hasBorder)      m_t << " border=\"1\"";

  1052   //if (!hasCellSpacing) m_t << " cellspacing=\"3\"";

  1053   //if (!hasCellPadding) m_t << " cellpadding=\"3\"";

  1054   m_t << ">\n";

  1055 }

  1056 

  1057 void HtmlDocVisitor::visitPost(DocHtmlTable *t) 

  1058 {

  1059   if (m_hide) return;

  1060   m_t << "</table>\n";

  1061   forceStartParagraph(t);

  1062 }

  1063 

  1064 void HtmlDocVisitor::visitPre(DocHtmlRow *tr)

  1065 {

  1066   if (m_hide) return;

  1067   m_t << "<tr" << htmlAttribsToString(tr->attribs()) << ">\n";

  1068 }

  1069 

  1070 void HtmlDocVisitor::visitPost(DocHtmlRow *) 

  1071 {

  1072   if (m_hide) return;

  1073   m_t << "</tr>\n";

  1074 }

  1075 

  1076 void HtmlDocVisitor::visitPre(DocHtmlCell *c)

  1077 {

  1078   if (m_hide) return;

  1079   if (c->isHeading()) 

  1080   {

  1081     m_t << "<th" << htmlAttribsToString(c->attribs()) << ">"; 

  1082   }

  1083   else 

  1084   {

  1085     m_t << "<td" << htmlAttribsToString(c->attribs()) << ">";

  1086   }

  1087 }

  1088 

  1089 void HtmlDocVisitor::visitPost(DocHtmlCell *c) 

  1090 {

  1091   if (m_hide) return;

  1092   if (c->isHeading()) m_t << "</th>"; else m_t << "</td>";

  1093 }

  1094 

  1095 void HtmlDocVisitor::visitPre(DocHtmlCaption *c)

  1096 {

  1097   if (m_hide) return;

  1098   bool hasAlign      = FALSE;

  1099   HtmlAttribListIterator li(c->attribs());

  1100   HtmlAttrib *att;

  1101   for (li.toFirst();(att=li.current());++li)

  1102   {

  1103     if (att->name=="align") hasAlign=TRUE;

  1104   }

  1105   m_t << "<caption" << htmlAttribsToString(c->attribs());

  1106   if (!hasAlign) m_t << " align=\"bottom\"";

  1107   m_t << ">";

  1108 }

  1109 

  1110 void HtmlDocVisitor::visitPost(DocHtmlCaption *) 

  1111 {

  1112   if (m_hide) return;

  1113   m_t << "</caption>\n";

  1114 }

  1115 

  1116 void HtmlDocVisitor::visitPre(DocInternal *)

  1117 {

  1118   if (m_hide) return;

  1119   m_t << "<p><b>" << theTranslator->trForInternalUseOnly() << "</b></p>" << endl;

  1120   m_t << "<p>" << endl;

  1121 }

  1122 

  1123 void HtmlDocVisitor::visitPost(DocInternal *) 

  1124 {

  1125   if (m_hide) return;

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

  1127 }

  1128 

  1129 void HtmlDocVisitor::visitPre(DocHRef *href)

  1130 {

  1131   if (m_hide) return;

  1132   m_t << "<a href=\"" << convertToXML(href->url())  << "\""

  1133       << htmlAttribsToString(href->attribs()) << ">";

  1134 }