found."; + else + g_footer = footerDiv.innerHTML; + +} + + +function writeTop() +{ + document.write("

"); + document.write("

"); +} + +function writeHeader() +{ + + + document.write(""); + document.write("\n"); + + document.write(g_header); + + document.write(""); + + + +} + + +function writeFooter(){ + + document.write("

\n"); + +} + + +function searchForWord( searchWord, statsList) +{ + + hashIndex = computeIndex(searchWord); + + + indexEntry = theIndex[hashIndex]; + + + var start = statsList.length; + var count = start; + + var totalHi = 0; + var totalFreqHi = 0; + var totalFreqLo = 0; + + + if (indexEntry != null) + { //found words matching the hash key + + for (var i = 0; i< indexEntry.length; i++) + { + foundWord = indexEntry[i]; + if (null == foundWord) + continue; + if ( foundWord.indexOf(searchWord) != -1) + { + //look up the words array for the document list + var multiplier = 1; + + var statInfo = new Object(); + statInfo.word = searchWord; + statInfo.match = foundWord; + if (foundWord.length == searchWord.length) + multiplier = 2; + + statInfo.docs = words[("#" + foundWord)]; + + if (null == statInfo.docs) + continue; + + for (var j = 0; j < statInfo.docs.length; j++) + { + var matchingDoc = statInfo.docs[j]; + if (matchingDoc == null) + { + //document.write("matchingDoc is NULL

"); + continue; + } + + //lsb of freq records whether it is high priority + matchingDoc.hi = matchingDoc.f&1; + + matchingDoc.f = matchingDoc.f>>1; + var freq = matchingDoc.f; + + matchingDoc.rank = 0.0; + + if (matchingDoc.hi) // word occurs in high priority doc + { + totalHi++; + totalFreqHi += freq*multiplier; + } + else // word occurs in low priority doc + { + totalFreqLo += freq*multiplier; + } + + matchingDoc.docName = (urls[matchingDoc.x]).n; + matchingDoc.docUrl = (urls[matchingDoc.x]).u; + + } + + statsList[count++] = statInfo; + + } + } + + totalFreq=(totalHi+1)* totalFreqLo + totalFreqHi; + for (count = start; count < statsList.length; count++) + { + statInfo = statsList[count]; + multiplier = 1; + // whole word matches have a double weight + if (statInfo.full) + multiplier=2; + for (i=0; i < statInfo.docs.length;i++) + { + docInfo = statInfo.docs; + // compute frequency rank of the word in each doc + + if (docInfo[i] == null) + continue; + + freq = docInfo[i].f; + if (docInfo[i].hi > 0) + { + statInfo.docs[i].rank= + (freq*multiplier+totalFreqLo)/totalFreq; + } + else + { + statInfo.docs[i].rank= + (freq*multiplier)/totalFreq; + } + }//for (i=0.. + }//for (count=... + } //if (indexEntry != null) + +} //searchForWord + + + +function report_results(docs, query) +{ + + + writeHeader(); + document.write(""); + writeTop(); + + document.write(" "); + document.write("

"); + + document.write("\n"); + document.write(" \n"); + document.write(" \n"); + document.write(" \n"); + + var numDocs = 0; + for (docsKey in docs) + numDocs++; + + if (numDocs==0) + { + document.write(" \n"); + document.write(" \n"); + document.write(" \n"); + } + else + { + document.write(" \n"); + document.write(" \n"); + document.write(" \n"); + num=1; + for (var i = 0; i < numDocs; i++) + { + doc = docs[i]; + document.write(" \n"); + document.write(" "); + document.write( "\n"); + document.write(" \n"); + document.write(" \n"); + document.write(" \n"); + num++; + } + } + document.write("

" + search_results() + "
" + matches_text(0, query) + "
" + matches_text(numDocs, query)); + document.write("\n"); + document.write("
" + num + "	" + doc.docName + "
	" + report_matches() + " "); + + numWords = doc.words.length; + + for (var j =0; j< numWords; j++) + { + wordInfo = doc.words[j]; + word = wordInfo.word; + matchRight = wordInfo.match.substr(word.length, wordInfo.match.length); + document.write("" + word + "" + matchRight +"(" + wordInfo.freq + ") "); + } + document.write("

\n"); + + document.write("

"); //contents + + writeFooter(); + +} + + + +function compare_rank(a,b) +{ + if (a.rank == b.rank) + { + return 0; + } + return (a.rank > b.rank) ? -1 : 1; +} + +function sort_results(docs) +{ + + return docs.sort(compare_rank); + +} + + + + + +function combine_results(results,docs) +{ + + numResults = results.length; + + keyedDocs = new Array(); + + for (var i =0; i< numResults; i++) + { + wordInfo = results[i]; + docsList = wordInfo.docs; + numDocs = docsList.length; + for (var j = 0; j< numDocs; j++) + { + di = docsList[j]; + if (di == null) + continue; + docKey = di.docUrl; + rank = di.rank; + + if (keyedDocs[docKey] != null) + { + keyedDocs[docKey].rank += rank; + + }else + { + docInfo = new Object(); + docInfo.docUrl = docKey; + docInfo.docName = di.docName; + docInfo.rank = rank; + docInfo.words = new Array(); + + keyedDocs[docKey] = docInfo; + } + + wi = new Object(); + wi.word = wordInfo.word; + wi.match = wordInfo.match; + wi.freq = di.f; + + idx = keyedDocs[docKey].words.length; + keyedDocs[docKey].words[idx] = wi; + } + + } + + + var i = 0; + for (docKey in keyedDocs) + { + // document.write("docKey = " + docKey + "

"); + docs[i] = keyedDocs[docKey]; + i++; + } + return docs; + +} + + + + +function filter_results(docs, requiredWords, forbiddenWords) +{ + filteredDocs = new Array(); + var numPassed = 0; + + + for (var i = 0; i < docs.length; i++) + { + copyIt = true; + words = docs[i].words; + + + for (var j = 0; j< requiredWords.length; j++) + { + reqWord = requiredWords[j]; + found = false; + + for (var k = 0; k < words.length; k++) + { + found = (words[k].word == reqWord); + if (found) + break; + } + if (!found) + { + copyIt = false; // document fails to contain one of the + // required words. + break; + } + } + + if (copyIt) + { //don't bother checking for forbidden words + //if it has failed the required words test + + for (var j = 0; j< forbiddenWords.length; j++) + { + forbiddenWord = forbiddenWords[j]; + found = false; + for (var k = 0; k < words.length; k++) + { + found = (words[k].word == forbiddenWord); + if (found) + { + copyIt = false; + break; + } + } + } + } + + if (copyIt) + { + filteredDocs[numPassed] = docs[i]; + numPassed++; + } + + } + return filteredDocs; + +} + + + + + +function doSearch( theIndex, param) +{ + + saveHeader(); + saveTop(); + saveFooter(); + indexArray = theIndex; + + searchTerms = getParam(param); + + + + //indexText = document.getElementById("index").innerHTML; + //window.alert(indexText); + + var statsList = new Array(); + + requiredWords = new Array(); + forbiddenWords = new Array(); + searchWords = searchTerms.split("+"); + + foundWords = new Array(); + + for (var i = 0; i< searchWords.length; i++) + { + word = unescape(searchWords[i]); + word = word.toLowerCase(); + if (word[0] == '+') + { + word = word.substr(1); + requiredWords[requiredWords.length] = word; + // document.write("required = " + word + "

"); + } + if (word[0] == '-') + { + word = word.substr(1); + forbiddenWords[forbiddenWords.length] = word; + // document.write("forbidden = " + word + "

"); + } + + if (foundWords[word] == null) + { + searchForWord( word, statsList); + foundWords[word] = i; + } + + } + + + docs = new Array(); + combine_results(statsList, docs); + + filteredDocs = filter_results(docs, requiredWords, forbiddenWords); + + + + + filteredDocs = sort_results(filteredDocs); + + report_results(filteredDocs, unescape(searchWords.join(" "))); + + + + +} + + + +function fillSearchBox(param) +{ + searchTerms = getParam(param); + searchWords = searchTerms.split("+"); + searchQuery = searchWords.join(" "); + + queryElement = document.getElementById("query"); + if (null != queryElement) + queryElement.value = unescape(searchQuery); + else + window.alert("queryElement is null"); + +} + + + + Property changes on: src/local-search.js ___________________________________________________________________ Name: svn:executable + * Index: src/translator_cz.h =================================================================== --- src/translator_cz.h (revision 642) +++ src/translator_cz.h (working copy) @@ -77,7 +77,7 @@ // something else. It is difficult to find the general translation // for all kinds in the Czech language. -class TranslatorCzech : public Translator +class TranslatorCzech : public TranslatorAdapter_1_5_4 { public: // --- Language control methods ------------------- Index: src/translator_kr.h =================================================================== --- src/translator_kr.h (revision 642) +++ src/translator_kr.h (working copy) @@ -50,7 +50,7 @@ Translator class (by the local maintainer) when the localized translator is made up-to-date again. */ -class TranslatorKorean : public Translator +class TranslatorKorean : public TranslatorAdapter_1_5_4 { protected: friend class TranslatorAdapterBase; Index: src/translator_sr.h =================================================================== --- src/translator_sr.h (revision 642) +++ src/translator_sr.h (working copy) @@ -24,7 +24,7 @@ // UTF-8 patch by Nenad Bulatovic // translation update by Andrija M. Bosnjakovic -class TranslatorSerbian : public Translator +class TranslatorSerbian : public TranslatorAdapter_1_5_4 { private: QCString decode(const QCString& sInput) Index: src/translator_de.h =================================================================== --- src/translator_de.h (revision 642) +++ src/translator_de.h (working copy) @@ -120,7 +120,7 @@ #ifndef TRANSLATOR_DE_H #define TRANSLATOR_DE_H -class TranslatorGerman : public Translator +class TranslatorGerman : public TranslatorAdapter_1_5_4 { public: Index: src/choose-search.js =================================================================== --- src/choose-search.js (revision 0) +++ src/choose-search.js (revision 0) @@ -0,0 +1,27 @@ +/*! choose-search.js + * + * Choose whether to use PHP or JavaScript search. + * + * @author Mitchell Fraser + * + */ + +function usingServer() +{ + return (document.URL.indexOf("http") == 0); +} + + +function chooseSearch() +{ + if (usingServer() ) + { + document.searchForm.action = "search.php" + } + else + { + document.searchForm.action = "local-search.html" + } + + return true; +} Property changes on: src/choose-search.js ___________________________________________________________________ Name: svn:executable + * Index: src/translator_sc.h =================================================================== --- src/translator_sc.h (revision 642) +++ src/translator_sc.h (working copy) @@ -40,7 +40,7 @@ Translator class (by the local maintainer) when the localized translator is made up-to-date again. */ -class TranslatorSerbianCyrilic : public Translator +class TranslatorSerbianCyrilic : public TranslatorAdapter_1_5_4 { public: Index: src/doxygen.cpp =================================================================== --- src/doxygen.cpp (revision 642) +++ src/doxygen.cpp (working copy) @@ -10201,6 +10201,12 @@ msg("Generating search index\n"); HtmlGenerator::writeSearchPage(); Doxygen::searchIndex->write(Config_getString("HTML_OUTPUT")+"/search.idx"); + + if (Config_getBool("LOCALSEARCH")) + { + HtmlGenerator::writeLocalSearchPages(); + Doxygen::searchIndex->writeJavaScriptIndex(Config_getString("HTML_OUTPUT")+"/local-search-index.js"); + } } if (Debug::isFlagSet(Debug::Time)) { Index: src/config.l =================================================================== --- src/config.l (revision 642) +++ src/config.l (working copy) @@ -3177,6 +3177,18 @@ "used. If set to NO the values of all tags below this one will be ignored. \n", FALSE ); + cb = addBool( + "LOCALSEARCH", + "The LOCALSEARCH tag specifies whether or not Doxygen should \n" + "produce a search engine capable of searching the HTML output without an HTTP server.\n" + "It will use Javascript to allow searching for keywords using a normal browser." + "If set to NO, search will only be possible if the environment can run PHP scripts," + "which is typical of pages served from HTTP web sites, but not locally stored files." + "To use LOCALSEARCH, SEARCHENGINE must be set to YES.", + TRUE + ); + cb->addDependency("SEARCHENGINE"); + addObsolete("CGI_NAME"); addObsolete("CGI_URL"); addObsolete("DOC_URL"); @@ -3205,7 +3217,7 @@ while ((size=f.readBlock(contents.data()+totalSize,bSize))==bSize) { totalSize+=bSize; - contents.resize(totalSize+bSize); + contents.resize(totalSize+bSize); } totalSize+=size+2; contents.resize(totalSize); Index: src/translator_ru.h =================================================================== --- src/translator_ru.h (revision 642) +++ src/translator_ru.h (working copy) @@ -26,7 +26,7 @@ #ifndef TRANSLATOR_RU_H #define TRANSLATOR_RU_H -class TranslatorRussian : public Translator +class TranslatorRussian : public TranslatorAdapter_1_5_4 { public: /*! Used for identification of the language. */ Index: src/searchindex.cpp =================================================================== --- src/searchindex.cpp (revision 642) +++ src/searchindex.cpp (working copy) @@ -20,6 +20,7 @@ #include "config.h" #include #include +#include // file format: (all multi-byte values are stored in big endian format) @@ -136,6 +137,78 @@ f.putch(0); } + +static QCString escape(const QCString &input) +{ + QCString output(input); + output = output.replace(QRegExp("\\"), "\\\\"); // '\' -> '\\' + return output.replace(QRegExp("\""), "\\\""); // '"' -> '\"' +} + +void SearchIndex::writeJavaScriptIndex(const char *fileName) +{ + int i; + QFile f(fileName); + if (f.open(IO_WriteOnly)) + { + QTextStream stream( &f ); + for (i=0; i < numIndexEntries; i++) + { + QList *wlist = m_index[i]; + if (!wlist->isEmpty()) + { + stream << "x[" << i << "] = ["; + QListIterator iwi(*wlist); + IndexWord *iw; + for (iwi.toFirst();(iw=iwi.current());++iwi) + { + stream << "\"" << escape(iw->word()) << "\""; + stream << ","; + } + stream << "];"; + stream << "\n"; + } + } + + QDictIterator wordIter(m_words); + IndexWord *word; + + for (wordIter.toFirst(); (word=wordIter.current());++wordIter) + { + stream <<"w[\"#" << escape(word->word()) << "\"] = "; + QIntDictIterator urlIter = word->urls(); + URLInfo *url; + + stream << "["; + for (urlIter.toFirst(); (url=urlIter.current()); ++urlIter) + { + stream << "{x: " << url->urlIdx << "," << "f:" << url->freq << "},"; + + + } + stream << "];\n"; + + + + } + + + + + QIntDictIterator udi(m_urls); + URL *url; + int urlIdx = 0; + for (udi.toFirst();(url=udi.current());++udi) + { + stream << "u[" << udi.currentKey() << "] = { n: \"" << url->name << "\", u: \"" << url->url << "\"};\n"; + urlIdx++; + } + + } +} + + + void SearchIndex::write(const char *fileName) { int i; Index: src/htmlgen.cpp =================================================================== --- src/htmlgen.cpp (revision 642) +++ src/htmlgen.cpp (working copy) @@ -51,6 +51,27 @@ #include "search_php.h" ; +static const char local_search_globals[]= +#include "local-search-globals_js.h" +; + +static const char choose_search[]= +#include "choose-search_js.h" +; + + +static const char local_search_script[]= +#include "local-search_js.h" +; + + +static const char locals_search_script_elements[] = + "\n" + "" + "" + "\n"; + + static QCString g_header; static QCString g_footer; @@ -542,6 +563,9 @@ if (!Config_getString("HTML_FOOTER").isEmpty()) { g_footer=fileToString(Config_getString("HTML_FOOTER")); + + //to close off the the

+ g_footer=substitute(g_footer, ""; + +} + + + + static void writeDefaultHeaderFile(QTextStream &t, const char *title, - const char *relPath,bool usePathCmd) + const char *relPath,bool usePathCmd, + bool forLocalSearch) { QString relPathStr; if (usePathCmd) @@ -594,7 +631,17 @@ t << "\" rel=\"stylesheet\" type=\"text/css\">\n"; t << "\n"; - t << "\n"; + + if (forLocalSearch) + { + t << locals_search_script_elements; + t << "\n"; + t << "\n"; + } + else + { + t << "\n"; + } } @@ -602,7 +649,7 @@ { QTextStream t(&file); t.setEncoding(QTextStream::UnicodeUTF8); - writeDefaultHeaderFile(t,"$title",relativePathToRoot(0),TRUE); + writeDefaultHeaderFile(t,"$title",relativePathToRoot(0),TRUE, FALSE); } void HtmlGenerator::writeFooterFile(QFile &file) @@ -698,22 +745,30 @@ lastFile = fileName; if (g_header.isEmpty()) { - writeDefaultHeaderFile(t,dispTitle,relPath,FALSE); + writeDefaultHeaderFile(t,dispTitle,relPath,FALSE, FALSE); } else { t << substituteKeywords(g_header,convertToHtml(dispTitle),relPath); } - t << "" << endl; + + if (Config_getBool("SEARCHENGINE") && + Config_getBool("LOCALSEARCH")) + writeJsSearchIncludes(t); + generateDynamicSections(t,relPath); } static void writePageFooter(QTextStream &t,const QCString &lastTitle, const QCString relPath) { + + t << "\n"; t << "\n\n\n"; } else { t << substituteKeywords(g_footer,convertToHtml(lastTitle),relPath); } + } void HtmlGenerator::writeFooter() @@ -2000,13 +2057,18 @@ QCString searchFor = fixSpaces(theTranslator->trSearchForIndex()); if (searchFor.at(0)=='S') searchFor="S"+searchFor.mid(1); t << "

\n"; - t << " \n"; @@ -2079,6 +2141,127 @@ writeDefaultQuickLinks(t,compact,hli,relPath); } + +static void writeFile(QCString fileName, const char contents[]) +{ + QCString fullPath = Config_getString("HTML_OUTPUT") + "/" + fileName; + + QFile f(fullPath); + if (f.open(IO_WriteOnly)) + { + QTextStream t(&f); + t << contents; + } +} + +static void writeFileAndTranslationFns(QCString fileName, const char contents[]) +{ + QCString fullPath = Config_getString("HTML_OUTPUT") + "/" + fileName; + + QFile f(fullPath); + if (f.open(IO_WriteOnly)) + { + QTextStream t(&f); + t << contents; + t << "\n"; + t << "function search_results()\n"; + t << "{\n"; + t << " return \"" << theTranslator->trSearchResultsTitle() << "\";\n"; + t << "}\n"; + t << "\n"; + t << "function matches_text(num,query)\n"; + t << "{\n"; + t << " if (num==0)\n"; + t << " {\n"; + t << " return \"" << theTranslator->trLocalSearchResults(0) << "\";\n"; + t << " }\n"; + t << " else if (num==1)\n"; + t << " {\n"; + t << " return \"" << theTranslator->trLocalSearchResults(1) << "\";\n"; + t << " }\n"; + t << " else // num>1\n"; + t << " {\n"; + t << " return \"" << theTranslator->trLocalSearchResults(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 << "\n"; + + } +} + + +void HtmlGenerator::writeLocalSearchPages() +{ + if (Config_getBool("SEARCHENGINE") && + Config_getBool("LOCALSEARCH") && + Config_getBool("GENERATE_HTML")) + { + + writeFileAndTranslationFns("local-search-globals.js", local_search_globals); + writeFile("local-search.js", local_search_script); + writeFile("choose-search.js",choose_search); + + + QCString fileName = Config_getString("HTML_OUTPUT") + "/local-search.html"; + QFile f(fileName); + if (f.open(IO_WriteOnly)) + { + QTextStream t(&f); + if (g_header.isEmpty()) + { + writeDefaultHeaderFile(t,theTranslator->trSearch().data(),0,FALSE, TRUE); + } + else + { + QCString searchHeader = substitute(g_header, "

\n"; + t << " \n"; + t << "

\n"; + t << "

\n"; + + writePageFooter(t,"Search",""); + } + + } +} + + void HtmlGenerator::writeSearchPage() { if (Config_getBool("SEARCHENGINE") && Config_getBool("GENERATE_HTML")) @@ -2091,16 +2274,16 @@ t.setEncoding(QTextStream::UnicodeUTF8); if (g_header.isEmpty()) { - writeDefaultHeaderFile(t,theTranslator->trSearch().data(),0,FALSE); + writeDefaultHeaderFile(t,theTranslator->trSearch().data(),0,FALSE, FALSE); } else { t << substituteKeywords(g_header,"Search",""); } - t << "" << endl; - if (!Config_getBool("DISABLE_INDEX")) - { + if (!Config_getBool("DISABLE_INDEX")) + { writeDefaultQuickLinks(t,TRUE,HLI_Search,""); } else @@ -2110,7 +2293,29 @@ << "method=\"get\">\n"; } + + t << "\n \n"; + t << "# \n"; + t << "# \n"; + t << "# \n"; + t << "#

" + search_results() + "

" << theTranslator->trUseWebServer() << "

" << theTranslator->trDefineLocalSearch() << "