The searchindex_js.cpp File Reference
Included Headers
#include <utility>
#include <algorithm>
#include <cassert>
#include "searchindex_js.h"
#include "doxygen.h"
#include "groupdef.h"
#include "pagedef.h"
#include "namespacedef.h"
#include "classdef.h"
#include "classlist.h"
#include "membername.h"
#include "filename.h"
#include "language.h"
#include "textstream.h"
#include "util.h"
#include "version.h"
#include "message.h"
#include "resourcemgr.h"
#include "indexlist.h"
#include "portable.h"
#include "threadpool.h"
#include "moduledef.h"
#include "section.h"
Functions Index
| static void | splitSearchTokens (QCString &title, IntVector &indices) |
| static void | addMemberToSearchIndex (const MemberDef *md) |
| void | createJavaScriptSearchIndex () |
| static void | writeJavascriptSearchData (const QCString &searchDirName) |
| static void | writeJavasScriptSearchDataPage (const QCString &baseName, const QCString &dataFileName, const SearchIndexList &list) |
| void | writeJavaScriptSearchIndex () |
| const std::array< SearchIndexInfo, NUM_SEARCH_INDICES > & | getSearchIndices () |
Variables Index
| static std::array< SearchIndexInfo, NUM_SEARCH_INDICES > | g_searchIndexInfo |
Macro Definitions Index
| #define | SEARCH_INDEX_ALL 0 |
| #define | SEARCH_INDEX_CLASSES 1 |
| #define | SEARCH_INDEX_INTERFACES 2 |
| #define | SEARCH_INDEX_STRUCTS 3 |
| #define | SEARCH_INDEX_EXCEPTIONS 4 |
| #define | SEARCH_INDEX_NAMESPACES 5 |
| #define | SEARCH_INDEX_FILES 6 |
| #define | SEARCH_INDEX_FUNCTIONS 7 |
| #define | SEARCH_INDEX_VARIABLES 8 |
| #define | SEARCH_INDEX_TYPEDEFS 9 |
| #define | SEARCH_INDEX_SEQUENCES 10 |
| #define | SEARCH_INDEX_DICTIONARIES 11 |
| #define | SEARCH_INDEX_ENUMS 12 |
| #define | SEARCH_INDEX_ENUMVALUES 13 |
| #define | SEARCH_INDEX_PROPERTIES 14 |
| #define | SEARCH_INDEX_EVENTS 15 |
| #define | SEARCH_INDEX_RELATED 16 |
| #define | SEARCH_INDEX_DEFINES 17 |
| #define | SEARCH_INDEX_GROUPS 18 |
| #define | SEARCH_INDEX_PAGES 19 |
| #define | SEARCH_INDEX_CONCEPTS 20 |
| #define | SEARCH_INDEX_MODULES 21 |
Functions
addMemberToSearchIndex()
| static |
Definition at line 212 of file searchindex_js.cpp.
212static void addMemberToSearchIndex(const MemberDef *md)
213{
214 bool hideFriendCompounds = Config_getBool(HIDE_FRIEND_COMPOUNDS);
215 bool isLinkable = md->isLinkable();
216 const ClassDef *cd=nullptr;
217 const NamespaceDef *nd=nullptr;
218 const FileDef *fd=nullptr;
219 const GroupDef *gd=nullptr;
220 if (isLinkable &&
221 (
222 ((cd=md->getClassDef()) && cd->isLinkable() && !cd->isImplicitTemplateInstance()) ||
223 ((gd=md->getGroupDef()) && gd->isLinkable())
224 )
225 )
226 {
228 if (!n.isEmpty())
229 {
230 bool isFriendToHide = hideFriendCompounds &&
231 (QCString(md->typeString())=="friend class" ||
232 QCString(md->typeString())=="friend struct" ||
233 QCString(md->typeString())=="friend union");
234 if (!(md->isFriend() && isFriendToHide))
235 {
236 g_searchIndexInfo[SEARCH_INDEX_ALL].add(SearchTerm(n,md));
237 }
238 if (md->isFunction() || md->isSlot() || md->isSignal())
239 {
240 g_searchIndexInfo[SEARCH_INDEX_FUNCTIONS].add(SearchTerm(n,md));
241 }
242 else if (md->isVariable())
243 {
244 g_searchIndexInfo[SEARCH_INDEX_VARIABLES].add(SearchTerm(n,md));
245 }
246 else if (md->isSequence())
247 {
248 g_searchIndexInfo[SEARCH_INDEX_SEQUENCES].add(SearchTerm(n,md));
249 }
250 else if (md->isDictionary())
251 {
252 g_searchIndexInfo[SEARCH_INDEX_DICTIONARIES].add(SearchTerm(n,md));
253 }
254 else if (md->isTypedef())
255 {
256 g_searchIndexInfo[SEARCH_INDEX_TYPEDEFS].add(SearchTerm(n,md));
257 }
258 else if (md->isEnumerate())
259 {
260 g_searchIndexInfo[SEARCH_INDEX_ENUMS].add(SearchTerm(n,md));
261 }
262 else if (md->isEnumValue())
263 {
264 g_searchIndexInfo[SEARCH_INDEX_ENUMVALUES].add(SearchTerm(n,md));
265 }
266 else if (md->isProperty())
267 {
268 g_searchIndexInfo[SEARCH_INDEX_PROPERTIES].add(SearchTerm(n,md));
269 }
270 else if (md->isEvent())
271 {
272 g_searchIndexInfo[SEARCH_INDEX_EVENTS].add(SearchTerm(n,md));
273 }
275 (md->isFriend() && !isFriendToHide))
276 {
277 g_searchIndexInfo[SEARCH_INDEX_RELATED].add(SearchTerm(n,md));
278 }
279 }
280 }
281 else if (isLinkable &&
282 (((nd=md->getNamespaceDef()) && nd->isLinkable()) ||
283 ((fd=md->getFileDef()) && fd->isLinkable())
284 )
285 )
286 {
288 if (!n.isEmpty())
289 {
290 g_searchIndexInfo[SEARCH_INDEX_ALL].add(SearchTerm(n,md));
291
292 if (md->isFunction())
293 {
294 g_searchIndexInfo[SEARCH_INDEX_FUNCTIONS].add(SearchTerm(n,md));
295 }
296 else if (md->isVariable())
297 {
298 g_searchIndexInfo[SEARCH_INDEX_VARIABLES].add(SearchTerm(n,md));
299 }
300 else if (md->isSequence())
301 {
302 g_searchIndexInfo[SEARCH_INDEX_SEQUENCES].add(SearchTerm(n,md));
303 }
304 else if (md->isDictionary())
305 {
306 g_searchIndexInfo[SEARCH_INDEX_DICTIONARIES].add(SearchTerm(n,md));
307 }
308 else if (md->isTypedef())
309 {
310 g_searchIndexInfo[SEARCH_INDEX_TYPEDEFS].add(SearchTerm(n,md));
311 }
312 else if (md->isEnumerate())
313 {
314 g_searchIndexInfo[SEARCH_INDEX_ENUMS].add(SearchTerm(n,md));
315 }
316 else if (md->isEnumValue())
317 {
318 g_searchIndexInfo[SEARCH_INDEX_ENUMVALUES].add(SearchTerm(n,md));
319 }
320 else if (md->isDefine())
321 {
322 g_searchIndexInfo[SEARCH_INDEX_DEFINES].add(SearchTerm(n,md));
323 }
324 }
325 }
326}
References Config_getBool, g_searchIndexInfo, MemberDef::getClassDef, MemberDef::getFileDef, MemberDef::getGroupDef, MemberDef::getNamespaceDef, MemberDef::isDefine, MemberDef::isDictionary, QCString::isEmpty, MemberDef::isEnumerate, MemberDef::isEnumValue, MemberDef::isEvent, MemberDef::isForeign, MemberDef::isFriend, MemberDef::isFunction, ClassDef::isImplicitTemplateInstance, Definition::isLinkable, MemberDef::isProperty, MemberDef::isRelated, MemberDef::isSequence, MemberDef::isSignal, MemberDef::isSlot, MemberDef::isTypedef, MemberDef::isVariable, Definition::name, SEARCH_INDEX_ALL, SEARCH_INDEX_DEFINES, SEARCH_INDEX_DICTIONARIES, SEARCH_INDEX_ENUMS, SEARCH_INDEX_ENUMVALUES, SEARCH_INDEX_EVENTS, SEARCH_INDEX_FUNCTIONS, SEARCH_INDEX_PROPERTIES, SEARCH_INDEX_RELATED, SEARCH_INDEX_SEQUENCES, SEARCH_INDEX_TYPEDEFS, SEARCH_INDEX_VARIABLES and MemberDef::typeString.
Referenced by addToIndices and createJavaScriptSearchIndex.
createJavaScriptSearchIndex()
|
Definition at line 330 of file searchindex_js.cpp.
331{
332 // index classes
333 for (const auto &cd : *Doxygen::classLinkedMap)
334 {
335 if (cd->isLinkable())
336 {
337 QCString n = cd->localName();
338 g_searchIndexInfo[SEARCH_INDEX_ALL].add(SearchTerm(n,cd.get()));
339 if (Config_getBool(OPTIMIZE_OUTPUT_SLICE))
340 {
341 if (cd->compoundType()==ClassDef::Interface)
342 {
343 g_searchIndexInfo[SEARCH_INDEX_INTERFACES].add(SearchTerm(n,cd.get()));
344 }
345 else if (cd->compoundType()==ClassDef::Struct)
346 {
347 g_searchIndexInfo[SEARCH_INDEX_STRUCTS].add(SearchTerm(n,cd.get()));
348 }
349 else if (cd->compoundType()==ClassDef::Exception)
350 {
351 g_searchIndexInfo[SEARCH_INDEX_EXCEPTIONS].add(SearchTerm(n,cd.get()));
352 }
353 else // cd->compoundType()==ClassDef::Class
354 {
355 g_searchIndexInfo[SEARCH_INDEX_CLASSES].add(SearchTerm(n,cd.get()));
356 }
357 }
358 else // non slice optimization: group all types under classes
359 {
360 g_searchIndexInfo[SEARCH_INDEX_CLASSES].add(SearchTerm(n,cd.get()));
361 }
362 }
363 }
364
365 // index namespaces
366 for (const auto &nd : *Doxygen::namespaceLinkedMap)
367 {
368 if (nd->isLinkable())
369 {
370 QCString n = nd->name();
371 g_searchIndexInfo[SEARCH_INDEX_ALL].add(SearchTerm(n,nd.get()));
372 g_searchIndexInfo[SEARCH_INDEX_NAMESPACES].add(SearchTerm(n,nd.get()));
373 }
374 }
375
376 // index concepts
377 for (const auto &cd : *Doxygen::conceptLinkedMap)
378 {
379 if (cd->isLinkable())
380 {
381 QCString n = cd->localName();
382 g_searchIndexInfo[SEARCH_INDEX_ALL].add(SearchTerm(n,cd.get()));
383 g_searchIndexInfo[SEARCH_INDEX_CONCEPTS].add(SearchTerm(n,cd.get()));
384 }
385 }
386
387 // index modules
388 for (const auto &mod : ModuleManager::instance().modules())
389 {
390 if (mod->isLinkable() && mod->isPrimaryInterface())
391 {
392 QCString n = mod->name();
393 g_searchIndexInfo[SEARCH_INDEX_ALL].add(SearchTerm(n,mod.get()));
394 g_searchIndexInfo[SEARCH_INDEX_MODULES].add(SearchTerm(n,mod.get()));
395 }
396 }
397
398 // index files
399 for (const auto &fn : *Doxygen::inputNameLinkedMap)
400 {
401 for (const auto &fd : *fn)
402 {
403 QCString n = fd->name();
404 if (fd->isLinkable())
405 {
406 g_searchIndexInfo[SEARCH_INDEX_ALL].add(SearchTerm(n,fd.get()));
407 g_searchIndexInfo[SEARCH_INDEX_FILES].add(SearchTerm(n,fd.get()));
408 }
409 }
410 }
411
412 // index class members
413 {
414 // for each member name
415 for (const auto &mn : *Doxygen::memberNameLinkedMap)
416 {
417 // for each member definition
418 for (const auto &md : *mn)
419 {
420 addMemberToSearchIndex(md.get());
421 }
422 }
423 }
424
425 // index file/namespace members
426 {
427 // for each member name
428 for (const auto &mn : *Doxygen::functionNameLinkedMap)
429 {
430 // for each member definition
431 for (const auto &md : *mn)
432 {
433 addMemberToSearchIndex(md.get());
434 }
435 }
436 }
437
438 // index groups
439 for (const auto &gd : *Doxygen::groupLinkedMap)
440 {
441 if (gd->isLinkable())
442 {
443 QCString title(filterTitle(gd->groupTitle()).str());
444 IntVector tokenIndices;
445 splitSearchTokens(title,tokenIndices);
446 for (int index : tokenIndices)
447 {
448 g_searchIndexInfo[SEARCH_INDEX_ALL].add(SearchTerm(title.mid(index),gd.get()));
449 g_searchIndexInfo[SEARCH_INDEX_GROUPS].add(SearchTerm(title.mid(index),gd.get()));
450 }
451 }
452 }
453
454 // index pages
455 for (const auto &pd : *Doxygen::pageLinkedMap)
456 {
457 if (pd->isLinkable())
458 {
459 QCString title(filterTitle(pd->title()).str());
460 IntVector tokenIndices;
461 splitSearchTokens(title,tokenIndices);
462 for (int index : tokenIndices)
463 {
464 g_searchIndexInfo[SEARCH_INDEX_ALL].add(SearchTerm(title.mid(index),pd.get()));
465 g_searchIndexInfo[SEARCH_INDEX_PAGES].add(SearchTerm(title.mid(index),pd.get()));
466 }
467 }
468 }
469
470 // main page
471 if (Doxygen::mainPage)
472 {
473 QCString title(filterTitle(Doxygen::mainPage->title()).str());
474 IntVector tokenIndices;
475 splitSearchTokens(title,tokenIndices);
476 for (int index : tokenIndices)
477 {
478 g_searchIndexInfo[SEARCH_INDEX_ALL].add(SearchTerm(title.mid(index),Doxygen::mainPage.get()));
479 g_searchIndexInfo[SEARCH_INDEX_PAGES].add(SearchTerm(title.mid(index),Doxygen::mainPage.get()));
480 }
481 }
482
483 // sections
484 const auto &sm = SectionManager::instance();
485 for (const auto §ionInfo : sm)
486 {
487 if (sectionInfo->level()>0) // level 0 is for page titles
488 {
489 QCString title = filterTitle(sectionInfo->title());
490 IntVector tokenIndices;
491 splitSearchTokens(title,tokenIndices);
492 //printf("split(%s)=(%s) %zu\n",qPrint(sectionInfo->title()),qPrint(title),tokenIndices.size());
493 for (int index : tokenIndices)
494 {
495 g_searchIndexInfo[SEARCH_INDEX_ALL].add(SearchTerm(title.mid(index),sectionInfo.get()));
496 g_searchIndexInfo[SEARCH_INDEX_PAGES].add(SearchTerm(title.mid(index),sectionInfo.get()));
497 }
498 }
499 }
500
501 // sort all lists
502 for (auto &sii : g_searchIndexInfo) // for each index
503 {
504 for (auto &[name,symList] : sii.symbolMap) // for each symbol in the index
505 {
506 // sort the symbols (first on search term, and then on full name)
507 //
508 // `std::stable_sort` is used here due to reproducibility issues
509 // on key collisions
510 // https://github.com/doxygen/doxygen/issues/10445
511 std::stable_sort(symList.begin(),
512 symList.end(),
513 [](const auto &t1,const auto &t2)
514 {
515 int eq = qstricmp_sort(t1.word,t2.word); // search term first
516 return eq==0 ? qstricmp_sort(t1.title,t2.title)<0 : eq<0; // then full title
517 });
518 }
519 }
520}
References addMemberToSearchIndex, Doxygen::classLinkedMap, Doxygen::conceptLinkedMap, Config_getBool, ClassDef::Exception, filterTitle, Doxygen::functionNameLinkedMap, g_searchIndexInfo, Doxygen::groupLinkedMap, Doxygen::inputNameLinkedMap, ModuleManager::instance, SectionManager::instance, ClassDef::Interface, Doxygen::mainPage, Doxygen::memberNameLinkedMap, QCString::mid, Doxygen::namespaceLinkedMap, Doxygen::pageLinkedMap, SEARCH_INDEX_ALL, SEARCH_INDEX_CLASSES, SEARCH_INDEX_CONCEPTS, SEARCH_INDEX_EXCEPTIONS, SEARCH_INDEX_FILES, SEARCH_INDEX_GROUPS, SEARCH_INDEX_INTERFACES, SEARCH_INDEX_MODULES, SEARCH_INDEX_NAMESPACES, SEARCH_INDEX_PAGES, SEARCH_INDEX_STRUCTS, splitSearchTokens, QCString::str and ClassDef::Struct.
Referenced by generateOutput.
getSearchIndices()
|
Definition at line 864 of file searchindex_js.cpp.
864const std::array<SearchIndexInfo,NUM_SEARCH_INDICES> &getSearchIndices()
865{
866 return g_searchIndexInfo;
867}
Reference g_searchIndexInfo.
splitSearchTokens()
helper function to simplify the given title string, and fill a list of start positions for the start of each word in the simplified title string.
Definition at line 88 of file searchindex_js.cpp.
88static void splitSearchTokens(QCString &title,IntVector &indices)
89{
90 if (title.isEmpty()) return;
91
92 // simplify title to contain only words with single space as separator
93 size_t di=0;
94 bool lastIsSpace=true;
95 for (size_t si=0; si<title.length(); si++)
96 {
97 char c = title.at(si);
98 if (c=='@' || c=='\\') // skip over special commands
99 {
100 title.at(di)=' ';
101 if (si<title.length()-1)
102 {
103 c = title.at(++si);
105 --si;
106 }
107 }
108 else if (c=='<') // skip over html tags
109 {
110 if (si<title.length()-1)
111 {
112 for (size_t tsi = si; tsi<title.length(); ++tsi)
113 {
114 if (title.at(tsi)=='>')
115 {
116 si=tsi;
117 break;
118 }
119 }
120 }
121 }
122 else if (isId(c) || c==':') // add "word" character
123 {
124 title.at(di)=c;
125 di++;
126 lastIsSpace=false;
127 }
128 else if (!lastIsSpace) // add one separator as space
129 {
130 title.at(di)=' ';
131 di++;
132 lastIsSpace=true;
133 }
134 }
135 if (di>0 && title.at(di-1)==' ') di--; // strip trailing whitespace
136 title.resize(di);
137
138 // create a list of start positions within title for
139 // each unique word in order of appearance
140 int p=0,i=0;
141 while ((i=title.find(' ',p))!=-1)
142 {
144 indices.push_back(p);
145 p = i+1;
146 }
147 if (p<static_cast<int>(title.length()))
148 {
150 indices.push_back(p);
151 }
152}
References QCString::at, QCString::find, QCString::isEmpty, isId, QCString::length, QCString::mid, QCString::resize and QCString::str.
Referenced by createJavaScriptSearchIndex.
writeJavascriptSearchData()
| static |
Definition at line 522 of file searchindex_js.cpp.
522static void writeJavascriptSearchData(const QCString &searchDirName)
523{
524 std::ofstream t = Portable::openOutputStream(searchDirName+"/searchdata.js");
525 if (t.is_open())
526 {
527 t << "var indexSectionsWithContent =\n";
528 t << "{\n";
529 int j=0;
530 for (const auto &sii : g_searchIndexInfo)
531 {
532 if (!sii.symbolMap.empty())
533 {
534 if (j>0) t << ",\n";
535 t << " " << j << ": \"";
536
537 std::string previous_letter; // start with value that does not exist in the map
538 for (const auto &[letter,list] : sii.symbolMap)
539 {
540 if (letter != previous_letter)
541 {
542 if ( letter == "\"" ) t << "\\"; // add escape for backslash
543 t << letter;
544 previous_letter = letter;
545 }
546 }
547 t << "\"";
548 j++;
549 }
550 }
551 if (j>0) t << "\n";
552 t << "};\n\n";
553 t << "var indexSectionNames =\n";
554 t << "{\n";
555 j=0;
556 for (const auto &sii : g_searchIndexInfo)
557 {
558 if (!sii.symbolMap.empty())
559 {
560 if (j>0) t << ",\n";
561 t << " " << j << ": \"" << sii.name << "\"";
562 j++;
563 }
564 }
565 if (j>0) t << "\n";
566 t << "};\n\n";
567 t << "var indexSectionLabels =\n";
568 t << "{\n";
569 j=0;
570 for (const auto &sii : g_searchIndexInfo)
571 {
572 if (!sii.symbolMap.empty())
573 {
574 if (j>0) t << ",\n";
575 t << " " << j << ": \"" << convertToXML(sii.getText()) << "\"";
576 j++;
577 }
578 }
579 if (j>0) t << "\n";
580 t << "};\n\n";
581 }
582}
References convertToXML, g_searchIndexInfo and Portable::openOutputStream.
Referenced by writeJavaScriptSearchIndex.
writeJavaScriptSearchIndex()
|
Definition at line 793 of file searchindex_js.cpp.
794{
795 // write index files
796 QCString searchDirName = Config_getString(HTML_OUTPUT)+"/search";
797
798 std::size_t numThreads = static_cast<std::size_t>(Config_getInt(NUM_PROC_THREADS));
799 if (numThreads>1) // multi threaded version
800 {
801 ThreadPool threadPool(numThreads);
802 std::vector< std::future<int> > results;
803 for (auto &sii : g_searchIndexInfo)
804 {
805 int p=0;
806 for (const auto &[letter,symList] : sii.symbolMap)
807 {
808 QCString baseName;
809 baseName.sprintf("%s_%x",sii.name.data(),p);
810 QCString dataFileName = searchDirName + "/"+baseName+".js";
811 auto &list = symList;
812 auto processFile = [p,baseName,dataFileName,&list]()
813 {
814 writeJavasScriptSearchDataPage(baseName,dataFileName,list);
815 return p;
816 };
817 results.emplace_back(threadPool.queue(processFile));
818 p++;
819 }
820 }
821 // wait for the results
822 for (auto &f : results) f.get();
823 }
824 else // single threaded version
825 {
826 for (auto &sii : g_searchIndexInfo)
827 {
828 int p=0;
829 for (const auto &[letter,symList] : sii.symbolMap)
830 {
831 QCString baseName;
832 baseName.sprintf("%s_%x",sii.name.data(),p);
833 QCString dataFileName = searchDirName + "/"+baseName+".js";
834 writeJavasScriptSearchDataPage(baseName,dataFileName,symList);
835 p++;
836 }
837 }
838 }
839
840 writeJavascriptSearchData(searchDirName);
841 auto &mgr = ResourceMgr::instance();
842 {
843 std::ofstream fn = Portable::openOutputStream(searchDirName+"/search.js");
844 if (fn.is_open())
845 {
846 TextStream t(&fn);
847 t << substitute(mgr.getAsString("search.js"),"$PROJECTID",getProjectId());
848 }
849 }
850
851 Doxygen::indexList->addStyleSheetFile("search/searchdata.js");
852 Doxygen::indexList->addStyleSheetFile("search/search.js");
853}
References Config_getInt, Config_getString, g_searchIndexInfo, getProjectId, Doxygen::indexList, ResourceMgr::instance, Portable::openOutputStream, ThreadPool::queue, QCString::sprintf, substitute, writeJavascriptSearchData and writeJavasScriptSearchDataPage.
Referenced by generateOutput.
writeJavasScriptSearchDataPage()
| static |
Definition at line 584 of file searchindex_js.cpp.
584static void writeJavasScriptSearchDataPage(const QCString &baseName,const QCString &dataFileName,const SearchIndexList &list)
585{
586 auto isDef = [](const SearchTerm::LinkInfo &info)
587 {
588 return std::holds_alternative<const Definition *>(info);
589 };
590 auto getDef = [&isDef](const SearchTerm::LinkInfo &info)
591 {
592 return isDef(info) ? std::get<const Definition *>(info) : nullptr;
593 };
594 auto isSection = [](const SearchTerm::LinkInfo &info)
595 {
596 return std::holds_alternative<const SectionInfo *>(info);
597 };
598 auto getSection = [&isSection](const SearchTerm::LinkInfo &info)
599 {
600 return isSection(info) ? std::get<const SectionInfo *>(info) : nullptr;
601 };
602
603 int cnt = 0;
604 std::ofstream ti = Portable::openOutputStream(dataFileName);
605 if (!ti.is_open())
606 {
607 err("Failed to open file '{}' for writing...\n",dataFileName);
608 return;
609 }
610
611 ti << "var searchData=\n";
612 // format
613 // searchData[] = array of items
614 // searchData[x][0] = id
615 // searchData[x][1] = [ name + child1 + child2 + .. ]
616 // searchData[x][1][0] = name as shown
617 // searchData[x][1][y+1] = info for child y
618 // searchData[x][1][y+1][0] = url
619 // searchData[x][1][y+1][1] = 1 => target="_parent"
620 // searchData[x][1][y+1][1] = 0 => target="_blank"
621 // searchData[x][1][y+1][2] = scope
622
623 ti << "[\n";
624 bool firstEntry=TRUE;
625
626 int childCount=0;
627 QCString lastWord;
628 const Definition *prevScope = nullptr;
629 for (auto it = list.begin(); it!=list.end();)
630 {
631 const SearchTerm &term = *it;
632 const SearchTerm::LinkInfo info = term.info;
633 const Definition *d = getDef(info);
634 const SectionInfo *si = getSection(info);
635 assert(d || si); // either d or si should be valid
638 ++it;
639 const Definition *scope = d ? d->getOuterScope() : nullptr;
640 const SearchTerm::LinkInfo next = it!=list.end() ? it->info : SearchTerm::LinkInfo();
641 const Definition *nextScope = isDef(next) ? getDef(next)->getOuterScope() : nullptr;
642 const MemberDef *md = toMemberDef(d);
644
645 if (word!=lastWord) // this item has a different search word
646 {
647 if (!firstEntry)
648 {
649 ti << "]]]";
650 ti << ",\n";
651 }
652 firstEntry=FALSE;
653 ti << " ['" << id << "_" << cnt++ << "',['";
654 if (next==SearchTerm::LinkInfo() || it->word!=word) // unique result, show title
655 {
656 ti << convertToXML(term.title);
657 }
658 else // multiple results, show matching word only, expanded list will show title
659 {
660 ti << convertToXML(term.word);
661 }
662 ti << "',[";
663 childCount=0;
664 prevScope=nullptr;
665 }
666
667 if (childCount>0)
668 {
669 ti << "],[";
670 }
671 QCString fn = d ? d->getOutputFileBase() : si ? si->fileName() : QCString();
672 QCString ref = d ? d->getReference() : si ? si->ref() : QCString();
673 addHtmlExtensionIfMissing(fn);
674 ti << "'" << externalRef("../",ref,TRUE) << fn;
675 if (!anchor.isEmpty())
676 {
677 ti << "#" << anchor;
678 }
679 ti << "',";
680
681 bool extLinksInWindow = Config_getBool(EXT_LINKS_IN_WINDOW);
682 if (!extLinksInWindow || ref.isEmpty())
683 {
684 ti << "1,";
685 }
686 else
687 {
688 ti << "0,";
689 }
690
691 if (lastWord!=word && (next==SearchTerm::LinkInfo() || it->word!=word)) // unique search result
692 {
693 if (d && d->getOuterScope()!=Doxygen::globalScope)
694 {
695 ti << "'" << convertToXML(d->getOuterScope()->name()) << "'";
696 }
697 else if (md)
698 {
699 const FileDef *fd = md->getBodyDef();
700 if (fd==nullptr) fd = md->getFileDef();
701 if (fd)
702 {
703 ti << "'" << convertToXML(fd->localName()) << "'";
704 }
705 }
706 else
707 {
708 ti << "''";
709 }
710 }
711 else // multiple entries with the same name
712 {
713 bool found=FALSE;
714 bool overloadedFunction = ((prevScope!=nullptr && scope==prevScope) || (scope && scope==nextScope)) &&
715 md && md->isCallable();
717 if (md) prefix=convertToXML(md->localName());
718 if (overloadedFunction) // overloaded member function
719 {
720 prefix+=convertToXML(md->argsString());
721 // show argument list to disambiguate overloaded functions
722 }
723 else if (md && md->isCallable()) // unique member function
724 {
725 prefix+="()"; // only to show it is a callable symbol
726 }
727 QCString name;
728 if (d)
729 {
730 switch (d->definitionType())
731 {
732 case Definition::TypeClass: name = convertToXML((toClassDef(d))->displayName()); found=true; break;
733 case Definition::TypeNamespace: name = convertToXML((toNamespaceDef(d))->displayName()); found=true; break;
734 case Definition::TypeModule: name = convertToXML(d->name()+" "+theTranslator->trModule(false,true)); found=true; break;
735 case Definition::TypePage: name = convertToXML(filterTitle(toPageDef(d)->title())); found=true; break;
736 case Definition::TypeGroup: name = convertToXML(filterTitle(toGroupDef(d)->groupTitle())); found=true; break;
737 default:
738 if (scope==nullptr || scope==Doxygen::globalScope) // in global scope
739 {
740 if (md)
741 {
742 const FileDef *fd = md->getBodyDef();
743 if (fd==nullptr) fd = md->resolveAlias()->getFileDef();
744 if (fd)
745 {
747 name = prefix + convertToXML(fd->localName());
748 found = true;
749 }
750 }
751 }
752 else if (md && (md->resolveAlias()->getClassDef() || md->resolveAlias()->getNamespaceDef()))
753 // member in class or namespace scope
754 {
755 SrcLangExt lang = md->getLanguage();
756 name = convertToXML(d->getOuterScope()->qualifiedName()) + getLanguageSpecificSeparator(lang) + prefix;
757 found = true;
758 }
759 else if (scope) // some thing else? -> show scope
760 {
761 name = prefix + convertToXML(scope->name());
762 found = true;
763 }
764 break;
765 }
766 }
767 else if (si)
768 {
769 name = parseCommentAsHtml(si->definition(),nullptr,si->title(),si->fileName(),si->lineNr());
770 found = true;
771 }
772 if (!found) // fallback
773 {
774 name = prefix + "("+theTranslator->trGlobalNamespace()+")";
775 }
776
777 ti << "'" << name << "'";
778
779 prevScope = scope;
780 childCount++;
781 }
782 lastWord = word;
783 }
784 if (!firstEntry)
785 {
786 ti << "]]]\n";
787 }
788 ti << "];\n";
789 Doxygen::indexList->addStyleSheetFile(("search/"+baseName+".js").data());
790}
References addHtmlExtensionIfMissing, Definition::anchor, MemberDef::argsString, Config_getBool, convertToXML, SectionInfo::definition, Definition::definitionType, err, externalRef, FALSE, SectionInfo::fileName, filterTitle, Definition::getBodyDef, MemberDef::getClassDef, MemberDef::getFileDef, Definition::getLanguage, getLanguageSpecificSeparator, MemberDef::getNamespaceDef, Definition::getOuterScope, Definition::getOutputFileBase, Definition::getReference, Doxygen::globalScope, Doxygen::indexList, MemberDef::isCallable, QCString::isEmpty, SectionInfo::label, SectionInfo::lineNr, Definition::localName, Definition::name, Portable::openOutputStream, parseCommentAsHtml, prefix, Definition::qualifiedName, SectionInfo::ref, MemberDef::resolveAlias, term, theTranslator, SectionInfo::title, toClassDef, toGroupDef, toMemberDef, toNamespaceDef, toPageDef, TRUE, Definition::TypeClass, Definition::TypeGroup, Definition::TypeModule, Definition::TypeNamespace and Definition::TypePage.
Referenced by writeJavaScriptSearchIndex.
Variables
g_searchIndexInfo
| static |
Definition at line 179 of file searchindex_js.cpp.
179static std::array<SearchIndexInfo,NUM_SEARCH_INDICES> g_searchIndexInfo =
180{ {
181 // index name getText symbolList
182 { /* SEARCH_INDEX_ALL */ "all" , []() { return theTranslator->trAll(); }, {} },
183 { /* SEARCH_INDEX_CLASSES */ "classes" , []() { return theTranslator->trClasses(); }, {} },
184 { /* SEARCH_INDEX_INTERFACES */ "interfaces" , []() { return theTranslator->trSliceInterfaces(); }, {} },
185 { /* SEARCH_INDEX_STRUCTS */ "structs" , []() { return theTranslator->trStructs(); }, {} },
186 { /* SEARCH_INDEX_EXCEPTIONS */ "exceptions" , []() { return theTranslator->trExceptions(); }, {} },
187 { /* SEARCH_INDEX_NAMESPACES */ "namespaces" , []() { return Config_getBool(OPTIMIZE_OUTPUT_SLICE) ?
188 theTranslator->trModules() :
189 theTranslator->trNamespace(TRUE,FALSE); }, {} },
190 { /* SEARCH_INDEX_FILES */ "files" , []() { return theTranslator->trFile(TRUE,FALSE); }, {} },
191 { /* SEARCH_INDEX_FUNCTIONS */ "functions" , []() { return Config_getBool(OPTIMIZE_OUTPUT_SLICE) ?
192 theTranslator->trOperations() :
193 theTranslator->trFunctions(); }, {} },
194 { /* SEARCH_INDEX_VARIABLES */ "variables" , []() { return Config_getBool(OPTIMIZE_OUTPUT_SLICE) ?
195 theTranslator->trConstants() :
196 theTranslator->trVariables(); }, {} },
197 { /* SEARCH_INDEX_TYPEDEFS */ "typedefs" , []() { return theTranslator->trTypedefs(); }, {} },
198 { /* SEARCH_INDEX_SEQUENCES */ "sequences" , []() { return theTranslator->trSequences(); }, {} },
199 { /* SEARCH_INDEX_DICTIONARIES */ "dictionaries", []() { return theTranslator->trDictionaries(); }, {} },
200 { /* SEARCH_INDEX_ENUMS */ "enums" , []() { return theTranslator->trEnumerations(); }, {} },
201 { /* SEARCH_INDEX_ENUMVALUES */ "enumvalues" , []() { return theTranslator->trEnumerationValues(); }, {} },
202 { /* SEARCH_INDEX_PROPERTIES */ "properties" , []() { return theTranslator->trProperties(); }, {} },
203 { /* SEARCH_INDEX_EVENTS */ "events" , []() { return theTranslator->trEvents(); }, {} },
204 { /* SEARCH_INDEX_RELATED */ "related" , []() { return theTranslator->trFriends(); }, {} },
205 { /* SEARCH_INDEX_DEFINES */ "defines" , []() { return theTranslator->trDefines(); }, {} },
206 { /* SEARCH_INDEX_GROUPS */ "groups" , []() { return theTranslator->trGroup(TRUE,FALSE); }, {} },
207 { /* SEARCH_INDEX_PAGES */ "pages" , []() { return theTranslator->trPage(TRUE,FALSE); }, {} },
208 { /* SEARCH_INDEX_CONCEPTS */ "concepts" , []() { return theTranslator->trConcept(true,false); }, {} },
209 { /* SEARCH_INDEX_MODULES */ "modules" , []() { return theTranslator->trModule(true,false); }, {} }
210} };
Referenced by addMemberToSearchIndex, createJavaScriptSearchIndex, getSearchIndices, writeJavascriptSearchData and writeJavaScriptSearchIndex.
Macro Definitions
SEARCH_INDEX_ALL
|
Definition at line 156 of file searchindex_js.cpp.
156#define SEARCH_INDEX_ALL 0
Referenced by addMemberToSearchIndex and createJavaScriptSearchIndex.
SEARCH_INDEX_CLASSES
|
Definition at line 157 of file searchindex_js.cpp.
157#define SEARCH_INDEX_CLASSES 1
Referenced by createJavaScriptSearchIndex.
SEARCH_INDEX_CONCEPTS
|
Definition at line 176 of file searchindex_js.cpp.
176#define SEARCH_INDEX_CONCEPTS 20
Referenced by createJavaScriptSearchIndex.
SEARCH_INDEX_DEFINES
|
Definition at line 173 of file searchindex_js.cpp.
173#define SEARCH_INDEX_DEFINES 17
Referenced by addMemberToSearchIndex.
SEARCH_INDEX_DICTIONARIES
|
Definition at line 167 of file searchindex_js.cpp.
167#define SEARCH_INDEX_DICTIONARIES 11
Referenced by addMemberToSearchIndex.
SEARCH_INDEX_ENUMS
|
Definition at line 168 of file searchindex_js.cpp.
168#define SEARCH_INDEX_ENUMS 12
Referenced by addMemberToSearchIndex.
SEARCH_INDEX_ENUMVALUES
|
Definition at line 169 of file searchindex_js.cpp.
169#define SEARCH_INDEX_ENUMVALUES 13
Referenced by addMemberToSearchIndex.
SEARCH_INDEX_EVENTS
|
Definition at line 171 of file searchindex_js.cpp.
171#define SEARCH_INDEX_EVENTS 15
Referenced by addMemberToSearchIndex.
SEARCH_INDEX_EXCEPTIONS
|
Definition at line 160 of file searchindex_js.cpp.
160#define SEARCH_INDEX_EXCEPTIONS 4
Referenced by createJavaScriptSearchIndex.
SEARCH_INDEX_FILES
|
Definition at line 162 of file searchindex_js.cpp.
162#define SEARCH_INDEX_FILES 6
Referenced by createJavaScriptSearchIndex.
SEARCH_INDEX_FUNCTIONS
|
Definition at line 163 of file searchindex_js.cpp.
163#define SEARCH_INDEX_FUNCTIONS 7
Referenced by addMemberToSearchIndex.
SEARCH_INDEX_GROUPS
|
Definition at line 174 of file searchindex_js.cpp.
174#define SEARCH_INDEX_GROUPS 18
Referenced by createJavaScriptSearchIndex.
SEARCH_INDEX_INTERFACES
|
Definition at line 158 of file searchindex_js.cpp.
158#define SEARCH_INDEX_INTERFACES 2
Referenced by createJavaScriptSearchIndex.
SEARCH_INDEX_MODULES
|
Definition at line 177 of file searchindex_js.cpp.
177#define SEARCH_INDEX_MODULES 21
Referenced by createJavaScriptSearchIndex.
SEARCH_INDEX_NAMESPACES
|
Definition at line 161 of file searchindex_js.cpp.
161#define SEARCH_INDEX_NAMESPACES 5
Referenced by createJavaScriptSearchIndex.
SEARCH_INDEX_PAGES
|
Definition at line 175 of file searchindex_js.cpp.
175#define SEARCH_INDEX_PAGES 19
Referenced by createJavaScriptSearchIndex.
SEARCH_INDEX_PROPERTIES
|
Definition at line 170 of file searchindex_js.cpp.
170#define SEARCH_INDEX_PROPERTIES 14
Referenced by addMemberToSearchIndex.
SEARCH_INDEX_RELATED
|
Definition at line 172 of file searchindex_js.cpp.
172#define SEARCH_INDEX_RELATED 16
Referenced by addMemberToSearchIndex.
SEARCH_INDEX_SEQUENCES
|
Definition at line 166 of file searchindex_js.cpp.
166#define SEARCH_INDEX_SEQUENCES 10
Referenced by addMemberToSearchIndex.
SEARCH_INDEX_STRUCTS
|
Definition at line 159 of file searchindex_js.cpp.
159#define SEARCH_INDEX_STRUCTS 3
Referenced by createJavaScriptSearchIndex.
SEARCH_INDEX_TYPEDEFS
|
Definition at line 165 of file searchindex_js.cpp.
165#define SEARCH_INDEX_TYPEDEFS 9
Referenced by addMemberToSearchIndex.
SEARCH_INDEX_VARIABLES
|
Definition at line 164 of file searchindex_js.cpp.
164#define SEARCH_INDEX_VARIABLES 8
Referenced by addMemberToSearchIndex.
Generated via doxygen2docusaurus by Doxygen 1.14.0.