/****************************************************************************** * * * * * Copyright (C) 1997-2008 by Dimitri van Heesch. * * 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. * */ #include <qdir.h> #include "htmldocvisitor.h" #include "docparser.h" #include "language.h" #include "doxygen.h" #include "outputgen.h" #include "dot.h" #include "message.h" #include "config.h" #include "htmlgen.h" #include "parserintf.h" #include "msc.h" #include "util.h" static const int NUM_HTML_LIST_TYPES = 4; static const char types[][NUM_HTML_LIST_TYPES] = {"1", "a", "i", "A"}; 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: /* <div> */ case DocNode::Kind_Verbatim: case DocNode::Kind_Include: case DocNode::Kind_Image: case DocNode::Kind_SecRefList: /* <hr> */ case DocNode::Kind_HorRuler: 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; } static QString htmlAttribsToString(const HtmlAttribList &attribs) { QString result; HtmlAttribListIterator li(attribs); HtmlAttrib *att; for (li.toFirst();(att=li.current());++li) { if (!att->value.isEmpty()) // ignore attribute without values as they // are not XHTML compliant { result+=" "; result+=att->name; result+="=\""+convertToXML(att->value)+"\""; } } return result; } //------------------------------------------------------------------------- HtmlDocVisitor::HtmlDocVisitor(QTextStream &t,CodeOutputInterface &ci, const char *langExt) : DocVisitor(DocVisitor_Html), m_t(t), m_ci(ci), m_insidePre(FALSE), m_hide(FALSE), m_langExt(langExt) { } //-------------------------------------- // visitor functions for leaf nodes //-------------------------------------- void HtmlDocVisitor::visit(DocWord *w) { if (m_hide) return; filter(w->word()); } void HtmlDocVisitor::visit(DocLinkedWord *w) { if (m_hide) return; startLink(w->ref(),w->file(),w->relPath(),w->anchor(),w->tooltip()); filter(w->word()); endLink(); } void HtmlDocVisitor::visit(DocWhiteSpace *w) { 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 << "<"; break; case DocSymbol::Greater: m_t << ">"; break; case DocSymbol::Amp: m_t << "&"; break; case DocSymbol::Dollar: m_t << "$"; break; case DocSymbol::Hash: m_t << "#"; break; case DocSymbol::Percent: m_t << "%"; break; case DocSymbol::Copy: m_t << "©"; break; case DocSymbol::Tm: m_t << "™"; break; case DocSymbol::Reg: m_t << "®"; break; case DocSymbol::Apos: m_t << "'"; break; case DocSymbol::Quot: m_t << "\""; break; case DocSymbol::Lsquo: m_t << "‘"; break; case DocSymbol::Rsquo: m_t << "’"; break; case DocSymbol::Ldquo: m_t << "“"; break; case DocSymbol::Rdquo: m_t << "”"; break; case DocSymbol::Ndash: m_t << "–"; break; case DocSymbol::Mdash: m_t << "—"; break; 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; case DocSymbol::Slash: m_t << "&" << s->letter() << "slash;"; break; case DocSymbol::Tilde: m_t << "&" << s->letter() << "tilde;"; break; case DocSymbol::Szlig: m_t << "ß"; break; case DocSymbol::Cedil: m_t << "&" << s->letter() << "cedil;"; break; case DocSymbol::Ring: m_t << "&" << s->letter() << "ring;"; break; case DocSymbol::Nbsp: m_t << " "; break; case DocSymbol::AElig: m_t << "Æ"; break; case DocSymbol::Aelig: m_t << "æ"; break; default: err("Error: unknown symbol found\n"); } } void HtmlDocVisitor::visit(DocURL *u) { if (m_hide) return; m_t << "<a href=\""; if (u->isEmail()) m_t << "mailto:"; m_t << u->url() << "\">"; filter(u->url()); m_t << "</a>"; } void HtmlDocVisitor::visit(DocLineBreak *) { if (m_hide) return; m_t << "<br/>\n"; } void HtmlDocVisitor::visit(DocHorRuler *) { if (m_hide) return; m_t << "<hr/>\n"; } void HtmlDocVisitor::visit(DocStyleChange *s) { if (m_hide) return; switch (s->style()) { case DocStyleChange::Bold: if (s->enable()) m_t << "<b" << htmlAttribsToString(s->attribs()) << ">"; else m_t << "</b>"; break; case DocStyleChange::Italic: if (s->enable()) m_t << "<em" << htmlAttribsToString(s->attribs()) << ">"; else m_t << "</em>"; break; case DocStyleChange::Code: if (s->enable()) m_t << "<code" << htmlAttribsToString(s->attribs()) << ">"; else m_t << "</code>"; break; case DocStyleChange::Subscript: if (s->enable()) m_t << "<sub" << htmlAttribsToString(s->attribs()) << ">"; else m_t << "</sub>"; break; case DocStyleChange::Superscript: if (s->enable()) m_t << "<sup" << htmlAttribsToString(s->attribs()) << ">"; else m_t << "</sup>"; break; case DocStyleChange::Center: if (s->enable()) { forceEndParagraph(s); m_t << "<center" << htmlAttribsToString(s->attribs()) << ">"; } else { m_t << "</center>"; forceStartParagraph(s); } break; case DocStyleChange::Small: if (s->enable()) m_t << "<small" << htmlAttribsToString(s->attribs()) << ">"; else m_t << "</small>"; break; case DocStyleChange::Preformatted: if (s->enable()) { forceEndParagraph(s); m_t << "<pre" << htmlAttribsToString(s->attribs()) << ">"; m_insidePre=TRUE; } else { m_insidePre=FALSE; m_t << "</pre>"; forceStartParagraph(s); } break; case DocStyleChange::Div: if (s->enable()) { forceEndParagraph(s); m_t << "<div" << htmlAttribsToString(s->attribs()) << ">"; } else { m_t << "</div>"; forceStartParagraph(s); } break; case DocStyleChange::Span: if (s->enable()) m_t << "<span" << htmlAttribsToString(s->attribs()) << ">"; else m_t << "</span>"; break; } } void HtmlDocVisitor::visit(DocVerbatim *s) { if (m_hide) return; switch(s->type()) { case DocVerbatim::Code: // fall though forceEndParagraph(s); m_t << PREFRAG_START; Doxygen::parserManager->getParser(m_langExt) ->parseCode(m_ci,s->context(),s->text().latin1(), s->isExample(),s->exampleFile()); m_t << PREFRAG_END; forceStartParagraph(s); break; case DocVerbatim::Verbatim: forceEndParagraph(s); m_t << PREFRAG_START; filter(s->text()); m_t << PREFRAG_END; forceStartParagraph(s); break; case DocVerbatim::HtmlOnly: m_t << s->text(); break; case DocVerbatim::ManOnly: case DocVerbatim::LatexOnly: case DocVerbatim::XmlOnly: /* nothing */ break; case DocVerbatim::Dot: { static int dotindex = 1; QCString fileName(4096); fileName.sprintf("%s%d%s", (Config_getString("HTML_OUTPUT")+"/inline_dotgraph_").data(), dotindex++, ".dot" ); 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(); forceEndParagraph(s); m_t << "<div align=\"center\">" << endl; writeDotFile(fileName,s->relPath(),s->context()); m_t << "</div>" << endl; forceStartParagraph(s); if (Config_getBool("DOT_CLEANUP")) file.remove(); } break; 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(); forceEndParagraph(s); m_t << "<div align=\"center\">" << endl; writeMscFile(baseName,s->relPath(),s->context()); m_t << "</div>" << endl; forceStartParagraph(s); if (Config_getBool("DOT_CLEANUP")) file.remove(); } break; } } void HtmlDocVisitor::visit(DocAnchor *anc) { if (m_hide) return; m_t << "<a class=\"anchor\" id=\"" << anc->anchor() << "\"></a>"; } void HtmlDocVisitor::visit(DocInclude *inc) { if (m_hide) return; switch(inc->type()) { case DocInclude::Include: forceEndParagraph(inc); m_t << PREFRAG_START; Doxygen::parserManager->getParser(inc->extension()) ->parseCode(m_ci, inc->context(), inc->text().latin1(), inc->isExample(), inc->exampleFile(), 0, // fd -1, // startLine -1, // endLine TRUE // inlineFragment ); m_t << PREFRAG_END; forceStartParagraph(inc); break; case DocInclude::IncWithLines: { forceEndParagraph(inc); m_t << PREFRAG_START; QFileInfo cfi( inc->file() ); FileDef fd( cfi.dirPath(), cfi.fileName() ); Doxygen::parserManager->getParser(inc->extension()) ->parseCode(m_ci, inc->context(), inc->text().latin1(), inc->isExample(), inc->exampleFile(), &fd); m_t << PREFRAG_END; forceStartParagraph(inc); } break; case DocInclude::DontInclude: break; case DocInclude::HtmlInclude: m_t << inc->text(); break; case DocInclude::VerbInclude: forceEndParagraph(inc); m_t << PREFRAG_START; filter(inc->text()); m_t << PREFRAG_END; forceStartParagraph(inc); 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()) { if (!m_hide) m_t << PREFRAG_START; pushEnabled(); m_hide=TRUE; } if (op->type()!=DocIncOperator::Skip) { popEnabled(); if (!m_hide) { Doxygen::parserManager->getParser(m_langExt) ->parseCode(m_ci,op->context(), op->text().latin1(),op->isExample(), op->exampleFile()); } pushEnabled(); m_hide=TRUE; } if (op->isLast()) { popEnabled(); if (!m_hide) m_t << PREFRAG_END; } else { if (!m_hide) m_t << endl; } } void HtmlDocVisitor::visit(DocFormula *f) { if (m_hide) return; bool bDisplay = !f->isInline(); if (bDisplay) { forceEndParagraph(f); m_t << "<p class=\"formulaDsp\">" << endl; } m_t << "<img class=\"formula" << (bDisplay ? "Dsp" : "Inl"); 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\"/>"; if (bDisplay) { m_t << endl << "</p>" << endl; forceStartParagraph(f); } } void HtmlDocVisitor::visit(DocIndexEntry *) { } void HtmlDocVisitor::visit(DocSimpleSectSep *) { m_t << "</dd>" << endl; m_t << "<dd>" << endl; } //-------------------------------------- // visitor functions for compound nodes //-------------------------------------- void HtmlDocVisitor::visitPre(DocAutoList *l) { if (m_hide) return; forceEndParagraph(l); if (l->isEnumList()) { // // Do list type based on depth: // 1. // a. // i. // A. // 1. (repeat)... // m_t << "<ol type=\"" << types[l->depth() % NUM_HTML_LIST_TYPES] << "\">"; } else { m_t << "<ul>"; } if (!l->isPreformatted()) m_t << "\n"; } void HtmlDocVisitor::visitPost(DocAutoList *l) { if (m_hide) return; if (l->isEnumList()) { m_t << "</ol>"; } else { m_t << "</ul>"; } if (!l->isPreformatted()) m_t << "\n"; forceStartParagraph(l); } void HtmlDocVisitor::visitPre(DocAutoListItem *) { if (m_hide) return; m_t << "<li>"; } void HtmlDocVisitor::visitPost(DocAutoListItem *li) { if (m_hide) return; m_t << "</li>"; if (!li->isPreformatted()) m_t << "\n"; } template<class T> bool isFirstChildNode(T *parent, DocNode *node) { return parent->children().getFirst()==node; } template<class T> bool isLastChildNode(T *parent, DocNode *node) { return parent->children().getLast()==node; } 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; } int getParagraphContext(DocPara *p,bool &isFirst,bool &isLast) { int t=0; isFirst=FALSE; isLast=FALSE; if (p && p->parent()) { switch (p->parent()->kind()) { case DocNode::Kind_AutoListItem: isFirst=TRUE; isLast =TRUE; if (isFirst) t=1; if (isLast) t=3; break; case DocNode::Kind_SimpleListItem: isFirst=TRUE; isLast =TRUE; if (isFirst) t=1; if (isLast) t=3; 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; case DocNode::Kind_SimpleSect: isFirst=isFirstChildNode((DocSimpleSect*)p->parent(),p); isLast =isLastChildNode ((DocSimpleSect*)p->parent(),p); if (isFirst) t=2; if (isLast) t=4; 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; } 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) { if (m_hide) return; //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: case DocNode::Kind_HtmlListItem: case DocNode::Kind_HtmlDescData: case DocNode::Kind_HtmlCell: case DocNode::Kind_SimpleListItem: case DocNode::Kind_AutoListItem: case DocNode::Kind_SimpleSect: 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; static const char *contexts[5] = { "", " class=\"startli\"", " class=\"startdd\"", " class=\"endli\"", " class=\"enddd\"" }; 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] << ">"; } void HtmlDocVisitor::visitPost(DocPara *p) { // 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()) { switch (p->parent()->kind()) { case DocNode::Kind_Section: case DocNode::Kind_HtmlListItem: case DocNode::Kind_HtmlDescData: case DocNode::Kind_HtmlCell: case DocNode::Kind_SimpleListItem: case DocNode::Kind_AutoListItem: case DocNode::Kind_SimpleSect: needsTag = TRUE; break; case DocNode::Kind_Root: needsTag = !((DocRoot*)p->parent())->singleLine(); break; default: needsTag = FALSE; } } 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"; } void HtmlDocVisitor::visitPre(DocRoot *) { } void HtmlDocVisitor::visitPost(DocRoot *) { } void HtmlDocVisitor::visitPre(DocSimpleSect *s) { if (m_hide) return; forceEndParagraph(s); m_t << "<dl class=\"" << s->typeString() << "\"><dt><b>"; 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; case DocSimpleSect::Rcs: break; case DocSimpleSect::Unknown: break; } // special case 1: user defined title if (s->type()!=DocSimpleSect::User && s->type()!=DocSimpleSect::Rcs) { m_t << ":</b></dt><dd>"; } } void HtmlDocVisitor::visitPost(DocSimpleSect *s) { if (m_hide) return; m_t << "</dd></dl>\n"; forceStartParagraph(s); } void HtmlDocVisitor::visitPre(DocTitle *) { } void HtmlDocVisitor::visitPost(DocTitle *) { if (m_hide) return; m_t << "</b></dt><dd>"; } void HtmlDocVisitor::visitPre(DocSimpleList *sl) { if (m_hide) return; forceEndParagraph(sl); m_t << "<ul>"; if (!sl->isPreformatted()) m_t << "\n"; } void HtmlDocVisitor::visitPost(DocSimpleList *sl) { if (m_hide) return; m_t << "</ul>"; if (!sl->isPreformatted()) m_t << "\n"; forceStartParagraph(sl); } void HtmlDocVisitor::visitPre(DocSimpleListItem *) { if (m_hide) return; m_t << "<li>"; } void HtmlDocVisitor::visitPost(DocSimpleListItem *li) { if (m_hide) return; m_t << "</li>"; if (!li->isPreformatted()) m_t << "\n"; } void HtmlDocVisitor::visitPre(DocSection *s) { if (m_hide) return; forceEndParagraph(s); m_t << "<h" << s->level()+1 << ">"; m_t << "<a class=\"anchor\" id=\"" << s->anchor(); m_t << "\">" << endl; filter(convertCharEntitiesToUTF8(s->title().data())); m_t << "</a></h" << s->level()+1 << ">\n"; } void HtmlDocVisitor::visitPost(DocSection *s) { forceStartParagraph(s); } void HtmlDocVisitor::visitPre(DocHtmlList *s) { if (m_hide) return; forceEndParagraph(s); if (s->type()==DocHtmlList::Ordered) { m_t << "<ol" << htmlAttribsToString(s->attribs()) << ">\n"; } else { m_t << "<ul" << htmlAttribsToString(s->attribs()) << ">\n"; } } void HtmlDocVisitor::visitPost(DocHtmlList *s) { if (m_hide) return; if (s->type()==DocHtmlList::Ordered) { m_t << "</ol>"; } else { m_t << "</ul>"; } if (!s->isPreformatted()) m_t << "\n"; forceStartParagraph(s); } void HtmlDocVisitor::visitPre(DocHtmlListItem *i) { if (m_hide) return; m_t << "<li" << htmlAttribsToString(i->attribs()) << ">"; if (!i->isPreformatted()) m_t << "\n"; } void HtmlDocVisitor::visitPost(DocHtmlListItem *) { if (m_hide) return; m_t << "</li>\n"; } void HtmlDocVisitor::visitPre(DocHtmlDescList *dl) { if (m_hide) return; forceEndParagraph(dl); m_t << "<dl" << htmlAttribsToString(dl->attribs()) << ">\n"; } void HtmlDocVisitor::visitPost(DocHtmlDescList *dl) { if (m_hide) return; m_t << "</dl>\n"; forceStartParagraph(dl); } void HtmlDocVisitor::visitPre(DocHtmlDescTitle *dt) { if (m_hide) return; m_t << "<dt" << htmlAttribsToString(dt->attribs()) << ">"; } void HtmlDocVisitor::visitPost(DocHtmlDescTitle *) { if (m_hide) return; m_t << "</dt>\n"; } void HtmlDocVisitor::visitPre(DocHtmlDescData *dd) { if (m_hide) return; m_t << "<dd" << htmlAttribsToString(dd->attribs()) << ">"; } void HtmlDocVisitor::visitPost(DocHtmlDescData *) { if (m_hide) return; m_t << "</dd>\n"; } void HtmlDocVisitor::visitPre(DocHtmlTable *t) { if (m_hide) return; bool hasBorder = FALSE; bool hasCellSpacing = FALSE; bool hasCellPadding = FALSE; forceEndParagraph(t); HtmlAttribListIterator li(t->attribs()); HtmlAttrib *att; for (li.toFirst();(att=li.current());++li) { if (att->name=="border") hasBorder=TRUE; else if (att->name=="cellspacing") hasCellSpacing=TRUE; else if (att->name=="cellpadding") hasCellPadding=TRUE; } m_t << "<table" << htmlAttribsToString(t->attribs()); if (!hasBorder) m_t << " border=\"1\""; if (!hasCellSpacing) m_t << " cellspacing=\"3\""; if (!hasCellPadding) m_t << " cellpadding=\"3\""; m_t << ">\n"; } void HtmlDocVisitor::visitPost(DocHtmlTable *t) { if (m_hide) return; m_t << "</table>\n"; forceStartParagraph(t); } void HtmlDocVisitor::visitPre(DocHtmlRow *tr) { if (m_hide) return; m_t << "<tr" << htmlAttribsToString(tr->attribs()) << ">\n"; } void HtmlDocVisitor::visitPost(DocHtmlRow *) { if (m_hide) return; m_t << "</tr>\n"; } void HtmlDocVisitor::visitPre(DocHtmlCell *c) { if (m_hide) return; if (c->isHeading()) { m_t << "<th" << htmlAttribsToString(c->attribs()) << ">"; } else { m_t << "<td" << htmlAttribsToString(c->attribs()) << ">"; } } void HtmlDocVisitor::visitPost(DocHtmlCell *c) { if (m_hide) return; if (c->isHeading()) m_t << "</th>"; else m_t << "</td>"; } void HtmlDocVisitor::visitPre(DocHtmlCaption *c) { if (m_hide) return; 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 << ">"; } void HtmlDocVisitor::visitPost(DocHtmlCaption *) { if (m_hide) return; m_t << "</caption>\n"; } void HtmlDocVisitor::visitPre(DocInternal *) { if (m_hide) return; m_t << "<p><b>" << theTranslator->trForInternalUseOnly() << "</b></p>" << endl; m_t << "<p>" << endl; } void HtmlDocVisitor::visitPost(DocInternal *) { if (m_hide) return; m_t << "</p>" << endl; } void HtmlDocVisitor::visitPre(DocHRef *href) { if (m_hide) return; m_t << "<a href=\"" << convertToXML(href->url()) << "\"" << htmlAttribsToString(href->attribs()) << ">"; } void HtmlDocVisitor::visitPost(DocHRef *) { if (m_hide) return; m_t << "</a>"; } void HtmlDocVisitor::visitPre(DocHtmlHeader *header) { if (m_hide) return; forceEndParagraph(header); m_t << "<h" << header->level() << htmlAttribsToString(header->attribs()) << ">"; } void HtmlDocVisitor::visitPost(DocHtmlHeader *header) { if (m_hide) return; m_t << "</h" << header->level() << ">\n"; forceStartParagraph(header); } void HtmlDocVisitor::visitPre(DocImage *img) { if (img->type()==DocImage::Html) { forceEndParagraph(img); if (m_hide) return; QString baseName=img->name(); int i; if ((i=baseName.findRev('/'))!=-1 || (i=baseName.findRev('\\'))!=-1) { baseName=baseName.right(baseName.length()-i-1); } m_t << "<div align=\"center\">" << endl; m_t << "<img src=\"" << img->relPath() << img->name() << "\" alt=\"" << baseName << "\"" << "/>" << endl; if (img->hasCaption()) { m_t << "<p><strong>"; } } else // other format -> skip { pushEnabled(); m_hide=TRUE; } } void HtmlDocVisitor::visitPost(DocImage *img) { if (img->type()==DocImage::Html) { if (m_hide) return; if (img->hasCaption()) { m_t << "</strong></p>"; } m_t << "</div>" << endl; forceStartParagraph(img); } else // other format { popEnabled(); } } void HtmlDocVisitor::visitPre(DocDotFile *df) { if (m_hide) return; writeDotFile(df->file(),df->relPath(),df->context()); m_t << "<div align=\"center\">" << endl; if (df->hasCaption()) { m_t << "<p><strong>"; } } void HtmlDocVisitor::visitPost(DocDotFile *df) { if (m_hide) return; if (df->hasCaption()) { m_t << "</strong></p>" << endl; } m_t << "</div>" << endl; } void HtmlDocVisitor::visitPre(DocLink *lnk) { if (m_hide) return; startLink(lnk->ref(),lnk->file(),lnk->relPath(),lnk->anchor()); } void HtmlDocVisitor::visitPost(DocLink *) { if (m_hide) return; endLink(); } void HtmlDocVisitor::visitPre(DocRef *ref) { if (m_hide) return; if (!ref->file().isEmpty()) { startLink(ref->ref(),ref->file(),ref->relPath(),ref->anchor()); } if (!ref->hasLinkText()) filter(ref->targetTitle()); } void HtmlDocVisitor::visitPost(DocRef *ref) { if (m_hide) return; if (!ref->file().isEmpty()) endLink(); //m_t << " "; } void HtmlDocVisitor::visitPre(DocSecRefItem *ref) { if (m_hide) return; QString refName=ref->file(); if (refName.right(Doxygen::htmlFileExtension.length())!= QString(Doxygen::htmlFileExtension)) { refName+=Doxygen::htmlFileExtension; } m_t << "<li><a href=\"" << refName << "#" << ref->anchor() << "\">"; } void HtmlDocVisitor::visitPost(DocSecRefItem *) { if (m_hide) return; m_t << "</a></li>\n"; } void HtmlDocVisitor::visitPre(DocSecRefList *s) { if (m_hide) return; forceEndParagraph(s); m_t << "<div class=\"multicol\">" << endl; m_t << "<ul>" << endl; } void HtmlDocVisitor::visitPost(DocSecRefList *s) { if (m_hide) return; m_t << "</ul>" << endl; m_t << "</div>" << endl; forceStartParagraph(s); } //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(); // } //} void HtmlDocVisitor::visitPre(DocParamSect *s) { if (m_hide) return; forceEndParagraph(s); m_t << "<dl><dt><b>"; switch(s->type()) { case DocParamSect::Param: m_t << theTranslator->trParameters(); break; case DocParamSect::RetVal: m_t << theTranslator->trReturnValues(); break; case DocParamSect::Exception: m_t << theTranslator->trExceptions(); break; case DocParamSect::TemplateParam: /* TODO: add this m_t << theTranslator->trTemplateParam(); break; */ m_t << "Template Parameters"; break; default: ASSERT(0); } m_t << ":"; m_t << "</b></dt><dd>" << endl; m_t << " <table border=\"0\" cellspacing=\"2\" cellpadding=\"0\">" << endl; } void HtmlDocVisitor::visitPost(DocParamSect *s) { if (m_hide) return; m_t << " </table>" << endl; m_t << " </dd>" << endl; m_t << "</dl>" << endl; forceStartParagraph(s); } void HtmlDocVisitor::visitPre(DocParamList *pl) { if (m_hide) return; m_t << " <tr><td valign=\"top\">"; if (pl->direction()!=DocParamSect::Unspecified) { m_t << "<tt>["; 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 << "]</tt> "; } m_t << "</td><td valign=\"top\"><em>"; //QStrListIterator li(pl->parameters()); //const char *s; QListIterator<DocNode> li(pl->parameters()); DocNode *param; bool first=TRUE; for (li.toFirst();(param=li.current());++li) { if (!first) m_t << ","; else first=FALSE; if (param->kind()==DocNode::Kind_Word) { visit((DocWord*)param); } else if (param->kind()==DocNode::Kind_LinkedWord) { visit((DocLinkedWord*)param); } } m_t << "</em> </td><td>"; } void HtmlDocVisitor::visitPost(DocParamList *) { if (m_hide) return; m_t << "</td></tr>" << endl; } void HtmlDocVisitor::visitPre(DocXRefItem *x) { if (m_hide) return; forceEndParagraph(x); bool anonymousEnum = x->file()=="@"; if (!anonymousEnum) { m_t << "<dl class=\"" << x->key() << "\"><dt><b><a class=\"el\" href=\"" << x->relPath() << x->file() << Doxygen::htmlFileExtension << "#" << x->anchor() << "\">"; } else { m_t << "<dl class=\"" << x->key() << "\"><dt><b>"; } filter(x->title()); m_t << ":"; if (!anonymousEnum) m_t << "</a>"; m_t << "</b></dt><dd>"; } void HtmlDocVisitor::visitPost(DocXRefItem *x) { if (m_hide) return; m_t << "</dd></dl>" << endl; forceStartParagraph(x); } void HtmlDocVisitor::visitPre(DocInternalRef *ref) { if (m_hide) return; startLink(0,ref->file(),ref->relPath(),ref->anchor()); } void HtmlDocVisitor::visitPost(DocInternalRef *) { if (m_hide) return; endLink(); m_t << " "; } void HtmlDocVisitor::visitPre(DocCopy *) { } void HtmlDocVisitor::visitPost(DocCopy *) { } void HtmlDocVisitor::visitPre(DocText *) { } void HtmlDocVisitor::visitPost(DocText *) { } 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 << "<"; break; case '>': m_t << ">"; break; case '&': m_t << "&"; break; default: m_t << c; } } } /// Escape basic entities to produce a valid CDATA attribute value, /// assume that the outer quoting will be using the double quote " 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 << "&"; break; case '"': m_t << """; 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 ">" and "<", 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; } } } void HtmlDocVisitor::startLink(const QString &ref,const QString &file, const QString &relPath,const QString &anchor, const QString &tooltip) { QCString *dest; if (!ref.isEmpty()) // link to entity imported via tag file { m_t << "<a class=\"elRef\" "; m_t << "doxygen=\"" << ref << ":"; if ((dest=Doxygen::tagDestinationDict[ref])) m_t << *dest << "/"; m_t << "\" "; } else // local link { m_t << "<a class=\"el\" "; } m_t << "href=\""; if (!ref.isEmpty()) { if ((dest=Doxygen::tagDestinationDict[ref])) m_t << *dest << "/"; } else { m_t << relPath; } if (!file.isEmpty()) m_t << file << Doxygen::htmlFileExtension; if (!anchor.isEmpty()) m_t << "#" << anchor; m_t << "\""; if (!tooltip.isEmpty()) m_t << " title=\"" << tooltip << "\""; m_t << ">"; } void HtmlDocVisitor::endLink() { m_t << "</a>"; } 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; } void HtmlDocVisitor::writeDotFile(const QString &fileName,const QString &relPath, const QString &context) { QString baseName=fileName; int i; if ((i=baseName.findRev('/'))!=-1) { baseName=baseName.right(baseName.length()-i-1); } QString outDir = Config_getString("HTML_OUTPUT"); writeDotGraphFromFile(fileName,outDir,baseName,BITMAP); QString mapName = baseName+".map"; QString mapFile = fileName+".map"; m_t << "<img src=\"" << relPath << baseName << "." << Config_getEnum("DOT_IMAGE_FORMAT") << "\" alt=\"" << baseName << "\" border=\"0\" usemap=\"#" << mapName << "\">" << endl; QString imap = getDotImageMapFromFile(fileName,outDir,relPath.data(),context); m_t << "<map name=\"" << mapName << "\" id=\"" << mapName << "\">" << imap << "</map>" << endl; } void HtmlDocVisitor::writeMscFile(const QString &fileName,const QString &relPath, const QString &context) { QString baseName=fileName; int i; if ((i=baseName.findRev('/'))!=-1) { baseName=baseName.right(baseName.length()-i-1); } QString outDir = Config_getString("HTML_OUTPUT"); writeMscGraphFromFile(fileName,outDir,baseName,MSC_BITMAP); QString mapName = baseName+".map"; QString mapFile = fileName+".map"; m_t << "<img src=\"" << relPath << baseName << ".png\" alt=\"" << baseName << "\" border=\"0\" usemap=\"#" << mapName << "\">" << endl; QString imap = getMscImageMapFromFile(fileName,outDir,relPath.data(),context); 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 ) { 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; } 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 ) { 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; m_t << "<p>"; } }