/****************************************************************************** * * * * Copyright (C) 1997-2005 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 #include "qtbc.h" #include #include "message.h" #include "htmlgen.h" #include "config.h" #include "util.h" #include "doxygen.h" #include "logos.h" #include "diagram.h" #include "version.h" #include "dot.h" #include "language.h" #include "htmlhelp.h" #include "docparser.h" #include "htmldocvisitor.h" #include "index.h" #include "pagedef.h" #include "debug.h" #include "dirdef.h" // #define GROUP_COLOR "#ff8080" //#define DBG_HTML(x) x; #define DBG_HTML(x) static const char *defaultStyleSheet = "BODY,H1,H2,H3,H4,H5,H6,P,CENTER,TD,TH,UL,DL,DIV {\n" " font-family: Geneva, Arial, Helvetica, sans-serif;\n" "}\n" "BODY,TD {\n" " font-size: 90%;\n" "}\n" "H1 {\n" " text-align: center;\n" " font-size: 160%;\n" "}\n" "H2 {\n" " font-size: 120%;\n" "}\n" "H3 {\n" " font-size: 110%;\n" "}\n" "CAPTION { font-weight: bold }\n" "DIV.qindex {\n" " width: 100%;\n" " background-color: #eeeeff;\n" " border: 1px solid #b0b0b0;\n" " text-align: center;\n" " margin: 2px;\n" " padding: 2px;\n" " line-height: 140%;\n" "}\n" "DIV.nav {\n" " width: 100%;\n" " background-color: #eeeeff;\n" " border: 1px solid #b0b0b0;\n" " text-align: center;\n" " margin: 2px;\n" " padding: 2px;\n" " line-height: 140%;\n" "}\n" "A.qindex {\n" " text-decoration: none;\n" " font-weight: bold;\n" " color: #1A419D;\n" "}\n" "A.qindex:visited {\n" " text-decoration: none;\n" " font-weight: bold;\n" " color: #1A419D\n" "}\n" "A.qindex:hover {\n" " text-decoration: none;\n" " background-color: #ddddff;\n" "}\n" "A.qindexHL {\n" " text-decoration: none;\n" " font-weight: bold;\n" " background-color: #6666cc;\n" " color: #ffffff;\n" " border: 1px double #9295C2;\n" "}\n" "A.qindexHL:hover {\n" " text-decoration: none;\n" " background-color: #6666cc;\n" " color: #ffffff;\n" "}\n" "A.qindexHL:visited { text-decoration: none; background-color: #6666cc; color: #ffffff }\n" "A.el { text-decoration: none; font-weight: bold }\n" "A.elRef { font-weight: bold }\n" "A.code:link { text-decoration: none; font-weight: normal; color: #0000FF}\n" "A.code:visited { text-decoration: none; font-weight: normal; color: #0000FF}\n" "A.codeRef:link { font-weight: normal; color: #0000FF}\n" "A.codeRef:visited { font-weight: normal; color: #0000FF}\n" "A:hover { text-decoration: none; background-color: #f2f2ff }\n" "DL.el { margin-left: -1cm }\n" ".fragment {\n" " font-family: monospace\n" "}\n" "PRE.fragment {\n" " border: 1px solid #CCCCCC;\n" " background-color: #f5f5f5;\n" " margin-top: 4px;\n" " margin-bottom: 4px;\n" " margin-left: 2px;\n" " margin-right: 8px;\n" " padding-left: 6px;\n" " padding-right: 6px;\n" " padding-top: 4px;\n" " padding-bottom: 4px;\n" "}\n" //"DIV.fragment {\n" //" font-family: monospace\n" //" border: 1px solid #CCCCCC;\n" //" background-color: #f5f5f5;\n" //" padding: 6px;\n" //"}\n" "DIV.ah { background-color: black; font-weight: bold; color: #ffffff; margin-bottom: 3px; margin-top: 3px }\n" "TD.md { background-color: #F4F4FB; font-weight: bold; }\n" "TD.mdPrefix {\n" " background-color: #F4F4FB;\n" " color: #606060;\n" " font-size: 80%;\n" "}\n" "TD.mdname1 { background-color: #F4F4FB; font-weight: bold; color: #602020; }\n" "TD.mdname { background-color: #F4F4FB; font-weight: bold; color: #602020; width: 600px; }\n" "DIV.groupHeader {\n" " margin-left: 16px;\n" " margin-top: 12px;\n" " margin-bottom: 6px;\n" " font-weight: bold;\n" "}\n" "DIV.groupText { margin-left: 16px; font-style: italic; font-size: 90% }\n" "BODY {\n" " background: white;\n" " color: black;\n" " margin-right: 20px;\n" " margin-left: 20px;\n" "}\n" "TD.indexkey {\n" " background-color: #eeeeff;\n" " font-weight: bold;\n" " padding-right : 10px;\n" " padding-top : 2px;\n" " padding-left : 10px;\n" " padding-bottom : 2px;\n" " margin-left : 0px;\n" " margin-right : 0px;\n" " margin-top : 2px;\n" " margin-bottom : 2px;\n" " border: 1px solid #CCCCCC;\n" "}\n" "TD.indexvalue {\n" " background-color: #eeeeff;\n" " font-style: italic;\n" " padding-right : 10px;\n" " padding-top : 2px;\n" " padding-left : 10px;\n" " padding-bottom : 2px;\n" " margin-left : 0px;\n" " margin-right : 0px;\n" " margin-top : 2px;\n" " margin-bottom : 2px;\n" " border: 1px solid #CCCCCC;\n" "}\n" "TR.memlist {\n" " background-color: #f0f0f0; \n" "}\n" "P.formulaDsp { text-align: center; }\n" "IMG.formulaDsp { }\n" "IMG.formulaInl { vertical-align: middle; }\n" "SPAN.keyword { color: #008000 }\n" "SPAN.keywordtype { color: #604020 }\n" "SPAN.keywordflow { color: #e08000 }\n" "SPAN.comment { color: #800000 }\n" "SPAN.preprocessor { color: #806020 }\n" "SPAN.stringliteral { color: #002080 }\n" "SPAN.charliteral { color: #008080 }\n" ".mdTable {\n" " border: 1px solid #868686;\n" " background-color: #F4F4FB;\n" "}\n" ".mdRow {\n" " padding: 8px 10px;\n" "}\n" ".mdescLeft {\n" " padding: 0px 8px 4px 8px;\n" " font-size: 80%;\n" " font-style: italic;\n" " background-color: #FAFAFA;\n" " border-top: 1px none #E0E0E0;\n" " border-right: 1px none #E0E0E0;\n" " border-bottom: 1px none #E0E0E0;\n" " border-left: 1px none #E0E0E0;\n" " margin: 0px;\n" "}\n" ".mdescRight {\n" " padding: 0px 8px 4px 8px;\n" " font-size: 80%;\n" " font-style: italic;\n" " background-color: #FAFAFA;\n" " border-top: 1px none #E0E0E0;\n" " border-right: 1px none #E0E0E0;\n" " border-bottom: 1px none #E0E0E0;\n" " border-left: 1px none #E0E0E0;\n" " margin: 0px;\n" "}\n" ".memItemLeft {\n" " padding: 1px 0px 0px 8px;\n" " margin: 4px;\n" " border-top-width: 1px;\n" " border-right-width: 1px;\n" " border-bottom-width: 1px;\n" " border-left-width: 1px;\n" " border-top-color: #E0E0E0;\n" " border-right-color: #E0E0E0;\n" " border-bottom-color: #E0E0E0;\n" " border-left-color: #E0E0E0;\n" " border-top-style: solid;\n" " border-right-style: none;\n" " border-bottom-style: none;\n" " border-left-style: none;\n" " background-color: #FAFAFA;\n" " font-size: 80%;\n" "}\n" ".memItemRight {\n" " padding: 1px 8px 0px 8px;\n" " margin: 4px;\n" " border-top-width: 1px;\n" " border-right-width: 1px;\n" " border-bottom-width: 1px;\n" " border-left-width: 1px;\n" " border-top-color: #E0E0E0;\n" " border-right-color: #E0E0E0;\n" " border-bottom-color: #E0E0E0;\n" " border-left-color: #E0E0E0;\n" " border-top-style: solid;\n" " border-right-style: none;\n" " border-bottom-style: none;\n" " border-left-style: none;\n" " background-color: #FAFAFA;\n" " font-size: 80%;\n" "}\n" ".memTemplItemLeft {\n" " padding: 1px 0px 0px 8px;\n" " margin: 4px;\n" " border-top-width: 1px;\n" " border-right-width: 1px;\n" " border-bottom-width: 1px;\n" " border-left-width: 1px;\n" " border-top-color: #E0E0E0;\n" " border-right-color: #E0E0E0;\n" " border-bottom-color: #E0E0E0;\n" " border-left-color: #E0E0E0;\n" " border-top-style: none;\n" " border-right-style: none;\n" " border-bottom-style: none;\n" " border-left-style: none;\n" " background-color: #FAFAFA;\n" " font-size: 80%;\n" "}\n" ".memTemplItemRight {\n" " padding: 1px 8px 0px 8px;\n" " margin: 4px;\n" " border-top-width: 1px;\n" " border-right-width: 1px;\n" " border-bottom-width: 1px;\n" " border-left-width: 1px;\n" " border-top-color: #E0E0E0;\n" " border-right-color: #E0E0E0;\n" " border-bottom-color: #E0E0E0;\n" " border-left-color: #E0E0E0;\n" " border-top-style: none;\n" " border-right-style: none;\n" " border-bottom-style: none;\n" " border-left-style: none;\n" " background-color: #FAFAFA;\n" " font-size: 80%;\n" "}\n" ".memTemplParams {\n" " padding: 1px 0px 0px 8px;\n" " margin: 4px;\n" " border-top-width: 1px;\n" " border-right-width: 1px;\n" " border-bottom-width: 1px;\n" " border-left-width: 1px;\n" " border-top-color: #E0E0E0;\n" " border-right-color: #E0E0E0;\n" " border-bottom-color: #E0E0E0;\n" " border-left-color: #E0E0E0;\n" " border-top-style: solid;\n" " border-right-style: none;\n" " border-bottom-style: none;\n" " border-left-style: none;\n" " color: #606060;\n" " background-color: #FAFAFA;\n" " font-size: 80%;\n" "}\n" ".search { color: #003399;\n" " font-weight: bold;\n" "}\n" "FORM.search {\n" " margin-bottom: 0px;\n" " margin-top: 0px;\n" "}\n" "INPUT.search { font-size: 75%;\n" " color: #000080;\n" " font-weight: normal;\n" " background-color: #eeeeff;\n" "}\n" "TD.tiny { font-size: 75%;\n" "}\n" "a {\n" " color: #252E78;\n" "}\n" "a:visited {\n" " color: #3D2185;\n" "}\n" ".dirtab { padding: 4px;\n" " border-collapse: collapse;\n" " border: 1px solid #b0b0b0;\n" "}\n" "TH.dirtab { background: #eeeeff;\n" " font-weight: bold;\n" "}\n" "HR { height: 1px;\n" " border: none;\n" " border-top: 1px solid black;\n" "}\n"; static QCString g_header; static QCString g_footer; const char search_script[]= #include "search_php.h" ; HtmlGenerator::HtmlGenerator() : OutputGenerator() { dir=Config_getString("HTML_OUTPUT"); col=0; } HtmlGenerator::~HtmlGenerator() { //printf("HtmlGenerator::~HtmlGenerator()\n"); } void HtmlGenerator::init() { QCString dname=Config_getString("HTML_OUTPUT"); QDir d(dname); if (!d.exists() && !d.mkdir(dname)) { err("Could not create output directory %s\n",dname.data()); exit(1); } writeLogo(dname); if (!Config_getString("HTML_HEADER").isEmpty()) { g_header=fileToString(Config_getString("HTML_HEADER")); //printf("g_header='%s'\n",g_header.data()); } if (!Config_getString("HTML_FOOTER").isEmpty()) { g_footer=fileToString(Config_getString("HTML_FOOTER")); //printf("g_footer='%s'\n",g_footer.data()); } createSubDirs(d); } void HtmlGenerator::writeStyleSheetFile(QFile &file) { QTextStream t(&file); t << defaultStyleSheet; } static void writeDefaultHeaderFile(QTextStream &t, const char *title, const char *relPath,bool usePathCmd) { QString relPathStr; if (usePathCmd) relPathStr="$relpath$"; else relPathStr=relPath; t << "\n" "" "idLanguageCharset() << "\">\n" ""; t << convertToHtml(title); t << "\n"; t << "\n" "\n"; } void HtmlGenerator::writeHeaderFile(QFile &file) { QTextStream t(&file); #if QT_VERSION >= 200 t.setEncoding(QTextStream::Latin1); #endif writeDefaultHeaderFile(t,"$title",relativePathToRoot(0),TRUE); } void HtmlGenerator::writeFooterFile(QFile &file) { QTextStream t(&file); t << "
\n"; t << theTranslator->trGeneratedAt( "$datetime", "$projectname" ); t << " " << "\"doxygen\"" << " $doxygenversion"; t << "
\n" << "\n" << "\n"; } void HtmlGenerator::startFile(const char *name,const char *, const char *title) { //printf("HtmlGenerator::startFile(%s)\n",name); QCString fileName=name; lastTitle=title; relPath = relativePathToRoot(fileName); if (fileName.right(Doxygen::htmlFileExtension.length())!=Doxygen::htmlFileExtension) { fileName+=Doxygen::htmlFileExtension; } startPlainFile(fileName); if (Config_getBool("GENERATE_HTMLHELP")) { HtmlHelp::getInstance()->addIndexFile(fileName); } QCString dispTitle = title; QCString projName = Config_getString("PROJECT_NAME"); if (!projName.isEmpty()) { dispTitle.prepend(projName+": "); } lastFile = fileName; if (g_header.isEmpty()) { writeDefaultHeaderFile(t,dispTitle,relPath,FALSE); } else { t << substituteKeywords(g_header,convertToHtml(dispTitle),relPath); } t << "" << endl; } //void HtmlGenerator::startQuickIndexItem(const char *s,const char *l) //{ // QCString *dest; // if (s) // { // t << ""; //} // //void HtmlGenerator::endQuickIndexItem() //{ // t << "   "; //} static void writePageFooter(QTextStream &t,const QCString &lastTitle, const QCString relPath) { if (g_footer.isEmpty()) { t << "
"; t << theTranslator->trGeneratedAt( dateToString(TRUE), Config_getString("PROJECT_NAME") ); t << " " << endl << ""; t << endl << "\"doxygen\"" << " " << versionString << " "; t << "
"; if (Debug::isFlagSet(Debug::Validate)) { t << "

" "\"This" "

"; } t << "\n\n\n"; } else { t << substituteKeywords(g_footer,convertToHtml(lastTitle),relPath); } } void HtmlGenerator::writeFooter() { writePageFooter(t,lastTitle,relPath); } void HtmlGenerator::endFile() { endPlainFile(); } void HtmlGenerator::startProjectNumber() { t << "

"; } void HtmlGenerator::endProjectNumber() { t << "

"; } void HtmlGenerator::writeStyleInfo(int part) { //printf("writeStyleInfo(%d)\n",part); if (part==0) { if (Config_getString("HTML_STYLESHEET").isEmpty()) // write default style sheet { //printf("write doxygen.css\n"); startPlainFile("doxygen.css"); // alternative, cooler looking titles //t << "H1 { text-align: center; border-width: thin none thin none;" << endl; //t << " border-style : double; border-color : blue; padding-left : 1em; padding-right : 1em }" << endl; t << defaultStyleSheet; endPlainFile(); } else // write user defined style sheet { QCString cssname=Config_getString("HTML_STYLESHEET"); QFileInfo cssfi(cssname); if (!cssfi.exists() || !cssfi.isFile() || !cssfi.isReadable()) { err("Error: style sheet %s does not exist or is not readable!", Config_getString("HTML_STYLESHEET").data()); } else { // convert style sheet to string QCString fileStr = fileToString(cssname); // write the string into the output dir startPlainFile(cssfi.fileName()); t << fileStr; endPlainFile(); } } } } void HtmlGenerator::startDoxyAnchor(const char *,const char *, const char *anchor, const char *name) { t << ""; } void HtmlGenerator::endDoxyAnchor(const char *,const char *) { } void HtmlGenerator::newParagraph() { t << endl << "

" << endl; } void HtmlGenerator::writeString(const char *text) { t << text; } void HtmlGenerator::writeIndexItem(const char *ref,const char *f, const char *name) { //printf("HtmlGenerator::writeIndexItem(%s,%s,%s)\n",ref,f,name); QCString *dest; t << "

  • "; if (ref || f) { if (ref) { t << ""; } else { t << ""; } docify(name); if (ref || f) { t << "" << endl; } else { t << ""; } } void HtmlGenerator::writeStartAnnoItem(const char *,const char *f, const char *path,const char *name) { t << "
  • "; if (path) docify(path); t << ""; docify(name); t << " "; } void HtmlGenerator::writeObjectLink(const char *ref,const char *f, const char *anchor, const char *name) { QCString *dest; if (ref) { t << ""; docify(name); t << ""; } void HtmlGenerator::writeCodeLink(const char *ref,const char *f, const char *anchor, const char *name) { QCString *dest; if (ref) { t << ""; docify(name); t << ""; col+=strlen(name); } void HtmlGenerator::startTextLink(const char *f,const char *anchor) { t << ""; } void HtmlGenerator::endTextLink() { t << ""; } void HtmlGenerator::startHtmlLink(const char *url) { t << ""; } void HtmlGenerator::endHtmlLink() { t << ""; } void HtmlGenerator::startGroupHeader() { t << "

    "; } void HtmlGenerator::endGroupHeader() { t << "

    " << endl; } void HtmlGenerator::startSection(const char *lab,const char *,SectionInfo::SectionType type) { switch(type) { case SectionInfo::Page: t << "

    "; break; case SectionInfo::Section: t << "

    "; break; case SectionInfo::Subsection: t << "

    "; break; case SectionInfo::Subsubsection: t << "

    "; break; case SectionInfo::Paragraph: t << "

    "; break; default: ASSERT(0); break; } t << ""; } void HtmlGenerator::endSection(const char *,SectionInfo::SectionType type) { t << ""; switch(type) { case SectionInfo::Page: t << "
    "; break; case SectionInfo::Section: t << ""; break; case SectionInfo::Subsection: t << ""; break; case SectionInfo::Subsubsection: t << ""; break; case SectionInfo::Paragraph: t << ""; break; default: ASSERT(0); break; } } void HtmlGenerator::docify(const char *str) { if (str) { const char *p=str; char c; while (*p) { c=*p++; switch(c) { case '<': t << "<"; break; case '>': t << ">"; break; case '&': t << "&"; break; case '\\': if (*p=='<') { t << "<"; p++; } else if (*p=='>') { t << ">"; p++; } else t << "\\"; break; default: t << c; } } } } void HtmlGenerator::codify(const char *str) { //docify(str); //static char spaces[]=" "; if (str) { const char *p=str; char c; int spacesToNextTabStop; while (*p) { c=*p++; switch(c) { case '\t': spacesToNextTabStop = Config_getInt("TAB_SIZE") - (col%Config_getInt("TAB_SIZE")); t << spaces.left(spacesToNextTabStop); col+=spacesToNextTabStop; break; case '\n': t << '\n'; col=0; break; case '\r': break; case '<': t << "<"; col++; break; case '>': t << ">"; col++; break; case '&': t << "&"; col++; break; case '\\': if (*p=='<') { t << "<"; p++; } else if (*p=='>') { t << ">"; p++; } else t << "\\"; col++; break; default: t << c; col++; break; } } } } void HtmlGenerator::writeChar(char c) { char cs[2]; cs[0]=c; cs[1]=0; docify(cs); } void HtmlGenerator::startClassDiagram() { t << "

    "; } void HtmlGenerator::endClassDiagram(ClassDiagram &d, const char *fileName,const char *name) { t << "\n

    \"\"
    " << endl << "" << endl; d.writeImage(t,dir,relPath,fileName); } void HtmlGenerator::startMemberList() { DBG_HTML(t << "" << endl) if (Config_getBool("HTML_ALIGN_MEMBERS")) { } else { t << "
      " << endl; } } void HtmlGenerator::endMemberList() { DBG_HTML(t << "" << endl) if (Config_getBool("HTML_ALIGN_MEMBERS")) { } else { t << "
    " << endl; } } // annonymous type: // 0 = single column right aligned // 1 = double column left aligned // 2 = single column left aligned void HtmlGenerator::startMemberItem(int annoType) { DBG_HTML(t << "" << endl) if (Config_getBool("HTML_ALIGN_MEMBERS")) { t << ""; switch(annoType) { case 0: t << ""; break; case 1: t << ""; break; case 2: t << ""; break; default: t << ""; break; } } else { t << "
  • "; } } void HtmlGenerator::endMemberItem() { //DBG_HTML(t << "" << endl) if (Config_getBool("HTML_ALIGN_MEMBERS")) { t << "\n"; } t << endl; } void HtmlGenerator::startMemberTemplateParams() { } void HtmlGenerator::endMemberTemplateParams() { if (Config_getBool("HTML_ALIGN_MEMBERS")) { t << "" << endl; t << ""; } } void HtmlGenerator::insertMemberAlign(bool templ) { DBG_HTML(t << "" << endl) if (Config_getBool("HTML_ALIGN_MEMBERS")) { QCString className = templ ? "memTemplItemRight" : "memItemRight"; t << " "; } } void HtmlGenerator::startMemberDescription() { DBG_HTML(t << "" << endl) if (Config_getBool("HTML_ALIGN_MEMBERS")) { t << " "; } else { t << "
    "; } } void HtmlGenerator::endMemberDescription() { DBG_HTML(t << "" << endl) if (Config_getBool("HTML_ALIGN_MEMBERS")) { t << "
    " << endl; } else { t << "
    "; } } void HtmlGenerator::startMemberSections() { DBG_HTML(t << "" << endl) if (Config_getBool("HTML_ALIGN_MEMBERS")) { t << "" << endl; // HTML is not recursively decomposable, sorry t << "" << endl; } } void HtmlGenerator::endMemberSections() { DBG_HTML(t << "" << endl) if (Config_getBool("HTML_ALIGN_MEMBERS")) { t << "
    " << endl; } } void HtmlGenerator::startMemberHeader() { DBG_HTML(t << "" << endl) if (Config_getBool("HTML_ALIGN_MEMBERS")) { t << "

    "; } else { startGroupHeader(); } } void HtmlGenerator::endMemberHeader() { DBG_HTML(t << "" << endl) if (Config_getBool("HTML_ALIGN_MEMBERS")) { t << "

    " << endl; } else { endGroupHeader(); } } void HtmlGenerator::startMemberSubtitle() { DBG_HTML(t << "" << endl) if (Config_getBool("HTML_ALIGN_MEMBERS")) t << ""; } void HtmlGenerator::endMemberSubtitle() { DBG_HTML(t << "" << endl) if (Config_getBool("HTML_ALIGN_MEMBERS")) t << "

    " << endl; } void HtmlGenerator::startIndexList() { t << "" << endl; } void HtmlGenerator::endIndexList() { t << "
    " << endl; } void HtmlGenerator::startIndexKey() { // inserted 'class = ...', 02 jan 2002, jh t << " "; } void HtmlGenerator::endIndexKey() { t << ""; } void HtmlGenerator::startIndexValue(bool) { // inserted 'class = ...', 02 jan 2002, jh t << ""; } void HtmlGenerator::endIndexValue(const char *,bool) { t << "" << endl; } void HtmlGenerator::startMemberDoc(const char *,const char *,const char *,const char *) { DBG_HTML(t << "" << endl;) t << "

    " << endl; t << "" << endl; t << " " << endl; t << " " << endl; t << " " << endl; t << "
    " << endl; t << " " << endl; } void HtmlGenerator::startMemberDocPrefixItem() { DBG_HTML(t << "" << endl;) t << " " << endl; t << " " << endl; t << " " << endl; } void HtmlGenerator::startMemberDocName(bool align) { DBG_HTML(t << "" << endl;) t << " " << endl; t << " " << endl; } void HtmlGenerator::startParameterList(bool openBracket) { DBG_HTML(t << "" << endl;) t << " " << endl; } void HtmlGenerator::startParameterType(bool first,const char *key) { if (first) { DBG_HTML(t << "" << endl;) t << " " << endl; t << " " << endl; t << " " << endl; t << " " << endl; } void HtmlGenerator::startParameterName(bool oneArgOnly) { DBG_HTML(t << "" << endl;) t << " " << endl; t << " " << endl; t << " " << endl; t << " " << endl; t << " " << endl; t << " " << endl; t << " " << endl; t << " " << endl; t << " " << endl; } } void HtmlGenerator::endParameterList() { DBG_HTML(t << "" << endl;) t << "" << endl; t << " " << endl; } void HtmlGenerator::endMemberDoc(bool hasArgs) { DBG_HTML(t << "" << endl;) if (!hasArgs) { t << " " << endl; } t << "
    " << endl; } void HtmlGenerator::endMemberDocPrefixItem() { DBG_HTML(t << "" << endl;) t << "
    "; } void HtmlGenerator::endMemberDocName() { DBG_HTML(t << "" << endl;) t << " "; if (openBracket) { t << "( "; } t << ""; } else { DBG_HTML(t << "" << endl;) t << "
    "; if (key) t << key; t << ""; } } void HtmlGenerator::endParameterType() { DBG_HTML(t << "" << endl;) t << " "; // "; } void HtmlGenerator::endParameterName(bool last,bool emptyList,bool closeBracket) { DBG_HTML(t << "" << endl;) if (last) { if (emptyList) { t << " "; if (closeBracket) t << " )"; t << " "; } else { t << "
    "; if (closeBracket) t << ")"; t << " "; } } else { t << "
    " << endl; t << "
    " << endl; } void HtmlGenerator::startDotGraph() { } void HtmlGenerator::endDotGraph(DotClassGraph &g) { g.writeGraph(t,BITMAP,dir,relPath); } void HtmlGenerator::startInclDepGraph() { } void HtmlGenerator::endInclDepGraph(DotInclDepGraph &g) { g.writeGraph(t,BITMAP,dir,relPath); } void HtmlGenerator::startGroupCollaboration() { } void HtmlGenerator::endGroupCollaboration(DotGroupCollaboration &g) { g.writeGraph(t,BITMAP,dir,relPath); } void HtmlGenerator::startCallGraph() { } void HtmlGenerator::endCallGraph(DotCallGraph &g) { g.writeGraph(t,BITMAP,dir,relPath); } void HtmlGenerator::startDirDepGraph() { } void HtmlGenerator::endDirDepGraph(DotDirDeps &g) { g.writeGraph(t,BITMAP,dir,relPath); } void HtmlGenerator::writeGraphicalHierarchy(DotGfxHierarchyTable &g) { g.writeGraph(t,dir); } void HtmlGenerator::startMemberGroupHeader(bool) { t << "

    "; } void HtmlGenerator::endMemberGroupHeader() { t << "
    " << endl; } void HtmlGenerator::startMemberGroupDocs() { t << "
    "; } void HtmlGenerator::endMemberGroupDocs() { t << "

    " << endl; } void HtmlGenerator::startMemberGroup() { } void HtmlGenerator::endMemberGroup(bool) { } void HtmlGenerator::startIndent() { // I really wanted to use CSS here to provide an indented section, but // alas, Netscape is buggy enough to sometimes "forget" to end the // indent cause a staircase effect where the indent continuously increases. // It's back to abusing tables :-( //t << "
    " << endl; t << "\n" " \n" " \n" " \n" " \n" "
    \n" "  \n" " \n"; } void HtmlGenerator::endIndent() { t << "
    \n"; //t << "
    " << endl; } void HtmlGenerator::addIndexItem(const char *,const char *) { } void HtmlGenerator::writeNonBreakableSpace(int n) { int i; for (i=0;i
    "; if (file) { writeObjectLink(0,file,anchor,title); } else { docify(title); } t << "
    "; } void HtmlGenerator::endSimpleSect() { t << ""; } void HtmlGenerator::startParamList(ParamListTypes, const char *title) { t << "
    "; docify(title); t << "
    "; } void HtmlGenerator::endParamList() { t << "
    "; } void HtmlGenerator::printDoc(DocNode *n) { HtmlDocVisitor *visitor = new HtmlDocVisitor(t,*this); n->accept(visitor); delete visitor; } static void startQuickIndexItem(QTextStream &t,const char *l, bool hl,bool compact,bool &first, const QCString &relPath) { if (!first && compact) t << " | "; first=FALSE; if (!compact) t << "
  • "; if (hl && compact) { t << ""; } static void endQuickIndexItem(QTextStream &t) { t << ""; } static QCString fixSpaces(const QCString &s) { return substitute(s," "," "); } static void writeDefaultQuickLinks(QTextStream &t,bool compact, HighlightedItem hli,const QCString &relPath) { bool first=TRUE; if (compact) { t << "
    "; } else { t << "
      "; } if (Config_getBool("SEARCHENGINE")) { t << "
      \n"; } if (Config_getBool("GENERATE_TREEVIEW")) { startQuickIndexItem(t,"main"+Doxygen::htmlFileExtension, hli==HLI_Main,compact,first,relPath); } else { startQuickIndexItem(t,"index"+Doxygen::htmlFileExtension, hli==HLI_Main,compact,first,relPath); } t << fixSpaces(theTranslator->trMainPage()); endQuickIndexItem(t); if (documentedGroups>0) { startQuickIndexItem(t,"modules"+Doxygen::htmlFileExtension, hli==HLI_Modules,compact,first,relPath); t << fixSpaces(theTranslator->trModules()); endQuickIndexItem(t); } if (documentedNamespaces>0) { startQuickIndexItem(t,"namespaces"+Doxygen::htmlFileExtension, hli==HLI_Namespaces,compact,first,relPath); if (Config_getBool("OPTIMIZE_OUTPUT_JAVA")) { t << fixSpaces(theTranslator->trPackages()); } else { t << theTranslator->trNamespaceList(); } endQuickIndexItem(t); } if (hierarchyClasses>0) { startQuickIndexItem(t,"hierarchy"+Doxygen::htmlFileExtension, hli==HLI_Hierarchy,compact,first,relPath); t << fixSpaces(theTranslator->trClassHierarchy()); endQuickIndexItem(t); } if (annotatedClasses>0) { if (Config_getBool("ALPHABETICAL_INDEX")) { startQuickIndexItem(t,"classes"+Doxygen::htmlFileExtension, hli==HLI_Classes,compact,first,relPath); t << fixSpaces(theTranslator->trAlphabeticalList()); endQuickIndexItem(t); } startQuickIndexItem(t,"annotated"+Doxygen::htmlFileExtension, hli==HLI_Annotated,compact,first,relPath); t << fixSpaces(theTranslator->trCompoundList()); endQuickIndexItem(t); } if (Config_getBool("SHOW_DIRECTORIES") && documentedDirs>0) { startQuickIndexItem(t,"dirs"+Doxygen::htmlFileExtension, hli==HLI_Directories,compact,first,relPath); t << fixSpaces(theTranslator->trDirectories()); endQuickIndexItem(t); } if (documentedHtmlFiles>0) { startQuickIndexItem(t,"files"+Doxygen::htmlFileExtension, hli==HLI_Files,compact,first,relPath); t << fixSpaces(theTranslator->trFileList()); endQuickIndexItem(t); } if (documentedNamespaceMembers[NMHL_All]>0) { startQuickIndexItem(t,"namespacemembers"+Doxygen::htmlFileExtension, hli==HLI_NamespaceMembers,compact,first,relPath); t << fixSpaces(theTranslator->trNamespaceMembers()); endQuickIndexItem(t); } if (documentedClassMembers[CMHL_All]>0) { startQuickIndexItem(t,"functions"+Doxygen::htmlFileExtension, hli==HLI_Functions,compact,first,relPath); t << fixSpaces(theTranslator->trCompoundMembers()); endQuickIndexItem(t); } if (documentedFileMembers[FMHL_All]>0) { startQuickIndexItem(t,"globals"+Doxygen::htmlFileExtension, hli==HLI_Globals,compact,first,relPath); t << fixSpaces(theTranslator->trFileMembers()); endQuickIndexItem(t); } if (indexedPages>0) { startQuickIndexItem(t,"pages"+Doxygen::htmlFileExtension, hli==HLI_Pages,compact,first,relPath); t << fixSpaces(theTranslator->trRelatedPages()); endQuickIndexItem(t); } if (Doxygen::exampleSDict->count()>0) { startQuickIndexItem(t,"examples"+Doxygen::htmlFileExtension, hli==HLI_Examples,compact,first,relPath); t << fixSpaces(theTranslator->trExamples()); endQuickIndexItem(t); } if (Config_getBool("SEARCHENGINE")) { if (compact) { t << " | "; } else { t << "
    • "; } t << "trSearchForIndex()); if (searchFor.at(0)=='S') searchFor="S"+searchFor.mid(1); t << "\">" << searchFor << " "; if (hli!=HLI_Search) { t << "" "
      • "; } } if (hli!=HLI_Search) { if (compact) { t << "
    \n"; } else { t << "\n"; } } } void HtmlGenerator::writeQuickLinks(bool compact,HighlightedItem hli) { writeDefaultQuickLinks(t,compact,hli,relPath); } void HtmlGenerator::writeSearchPage() { if (Config_getBool("SEARCHENGINE") && Config_getBool("GENERATE_HTML")) { QCString fileName = Config_getString("HTML_OUTPUT")+"/search.php"; QFile f(fileName); if (f.open(IO_WriteOnly)) { QTextStream t(&f); #if QT_VERSION >= 200 t.setEncoding(QTextStream::Latin1); #endif if (g_header.isEmpty()) { writeDefaultHeaderFile(t,theTranslator->trSearch().data(),0,FALSE); } else { t << substituteKeywords(g_header,"Search",""); } t << "" << endl; if (!Config_getBool("DISABLE_INDEX")) { writeDefaultQuickLinks(t,TRUE,HLI_Search,""); } t << "\ntrSearchResultsTitle() << "\";\n"; t << "}\n"; t << "\n"; t << "function matches_text($num)\n"; t << "{\n"; t << " if ($num==0)\n"; t << " {\n"; t << " return \"" << theTranslator->trSearchResults(0) << "\";\n"; t << " }\n"; t << " else if ($num==1)\n"; t << " {\n"; t << " return \"" << theTranslator->trSearchResults(1) << "\";\n"; t << " }\n"; t << " else // $num>1\n"; t << " {\n"; t << " return \"" << theTranslator->trSearchResults(2) << "\";\n"; t << " }\n"; t << "}\n"; t << "\n"; t << "function report_matches()\n"; t << "{\n"; t << " return \"" << theTranslator->trSearchMatches() << " \";\n"; t << "}\n"; t << "\n"; t << search_script; t << "\n"; t << "?>\n"; writePageFooter(t,"Search",""); } } }