searchindex_js.cpp File Reference

#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"
#include "docparser.h"
#include "conceptdef.h"

Include dependency graph for searchindex_js.cpp:

Go to the source code of this file.

Macros
#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
static void	splitSearchTokens (DString &title, SizeVector &indices)
static void	addMemberToSearchIndex (const MemberDef *md)
void	createJavaScriptSearchIndex ()
static void	writeJavascriptSearchData (const DString &searchDirName)
static void	writeJavasScriptSearchDataPage (const DString &baseName, const DString &dataFileName, const SearchIndexList &list)
void	writeJavaScriptSearchIndex ()
const std::array< SearchIndexInfo, NUM_SEARCH_INDICES > &	getSearchIndices ()

Variables
static std::array< SearchIndexInfo, NUM_SEARCH_INDICES >	g_searchIndexInfo

Macro Definition Documentation

SEARCH_INDEX_ALL

#define SEARCH_INDEX_ALL   0

Definition at line 160 of file searchindex_js.cpp.

Referenced by addMemberToSearchIndex(), and createJavaScriptSearchIndex().

SEARCH_INDEX_CLASSES

#define SEARCH_INDEX_CLASSES   1

Definition at line 161 of file searchindex_js.cpp.

Referenced by createJavaScriptSearchIndex().

SEARCH_INDEX_CONCEPTS

#define SEARCH_INDEX_CONCEPTS   20

Definition at line 180 of file searchindex_js.cpp.

Referenced by createJavaScriptSearchIndex().

SEARCH_INDEX_DEFINES

#define SEARCH_INDEX_DEFINES   17

Definition at line 177 of file searchindex_js.cpp.

Referenced by addMemberToSearchIndex().

SEARCH_INDEX_DICTIONARIES

#define SEARCH_INDEX_DICTIONARIES   11

Definition at line 171 of file searchindex_js.cpp.

Referenced by addMemberToSearchIndex().

SEARCH_INDEX_ENUMS

#define SEARCH_INDEX_ENUMS   12

Definition at line 172 of file searchindex_js.cpp.

Referenced by addMemberToSearchIndex().

SEARCH_INDEX_ENUMVALUES

#define SEARCH_INDEX_ENUMVALUES   13

Definition at line 173 of file searchindex_js.cpp.

Referenced by addMemberToSearchIndex().

SEARCH_INDEX_EVENTS

#define SEARCH_INDEX_EVENTS   15

Definition at line 175 of file searchindex_js.cpp.

Referenced by addMemberToSearchIndex().

SEARCH_INDEX_EXCEPTIONS

#define SEARCH_INDEX_EXCEPTIONS   4

Definition at line 164 of file searchindex_js.cpp.

Referenced by createJavaScriptSearchIndex().

SEARCH_INDEX_FILES

#define SEARCH_INDEX_FILES   6

Definition at line 166 of file searchindex_js.cpp.

Referenced by createJavaScriptSearchIndex().

SEARCH_INDEX_FUNCTIONS

#define SEARCH_INDEX_FUNCTIONS   7

Definition at line 167 of file searchindex_js.cpp.

Referenced by addMemberToSearchIndex().

SEARCH_INDEX_GROUPS

#define SEARCH_INDEX_GROUPS   18

Definition at line 178 of file searchindex_js.cpp.

Referenced by createJavaScriptSearchIndex().

SEARCH_INDEX_INTERFACES

#define SEARCH_INDEX_INTERFACES   2

Definition at line 162 of file searchindex_js.cpp.

Referenced by createJavaScriptSearchIndex().

SEARCH_INDEX_MODULES

#define SEARCH_INDEX_MODULES   21

Definition at line 181 of file searchindex_js.cpp.

Referenced by createJavaScriptSearchIndex().

SEARCH_INDEX_NAMESPACES

#define SEARCH_INDEX_NAMESPACES   5

Definition at line 165 of file searchindex_js.cpp.

Referenced by createJavaScriptSearchIndex().

SEARCH_INDEX_PAGES

#define SEARCH_INDEX_PAGES   19

Definition at line 179 of file searchindex_js.cpp.

Referenced by createJavaScriptSearchIndex().

SEARCH_INDEX_PROPERTIES

#define SEARCH_INDEX_PROPERTIES   14

Definition at line 174 of file searchindex_js.cpp.

Referenced by addMemberToSearchIndex().

SEARCH_INDEX_RELATED

#define SEARCH_INDEX_RELATED   16

Definition at line 176 of file searchindex_js.cpp.

Referenced by addMemberToSearchIndex().

SEARCH_INDEX_SEQUENCES

#define SEARCH_INDEX_SEQUENCES   10

Definition at line 170 of file searchindex_js.cpp.

Referenced by addMemberToSearchIndex().

SEARCH_INDEX_STRUCTS

#define SEARCH_INDEX_STRUCTS   3

Definition at line 163 of file searchindex_js.cpp.

Referenced by createJavaScriptSearchIndex().

SEARCH_INDEX_TYPEDEFS

#define SEARCH_INDEX_TYPEDEFS   9

Definition at line 169 of file searchindex_js.cpp.

Referenced by addMemberToSearchIndex().

SEARCH_INDEX_VARIABLES

#define SEARCH_INDEX_VARIABLES   8

Definition at line 168 of file searchindex_js.cpp.

Referenced by addMemberToSearchIndex().

Function Documentation

addMemberToSearchIndex()

void addMemberToSearchIndex ( const MemberDef * md )

static

Definition at line 216 of file searchindex_js.cpp.

{
  bool hideFriendCompounds = Config_getBool(HIDE_FRIEND_COMPOUNDS);
  bool isLinkable = md->isLinkable();
  const ClassDef *cd=nullptr;
  const NamespaceDef *nd=nullptr;
  const FileDef *fd=nullptr;
  const GroupDef *gd=nullptr;
  if (isLinkable &&
      (
       ((cd=md->getClassDef()) && cd->isLinkable() && !cd->isImplicitTemplateInstance()) ||
       ((gd=md->getGroupDef()) && gd->isLinkable())
      )
     )
  {
    const DString &n = md->name();
    if (!n.empty())
    {
      bool isFriendToHide = hideFriendCompounds &&
        (md->typeString()=="friend class" ||
         md->typeString()=="friend struct" ||
         md->typeString()=="friend union");
      if (!(md->isFriend() && isFriendToHide))
      {
        g_searchIndexInfo[SEARCH_INDEX_ALL].add(SearchTerm(n,md));
      }
      if (md->isFunction() || md->isSlot() || md->isSignal())
      {
        g_searchIndexInfo[SEARCH_INDEX_FUNCTIONS].add(SearchTerm(n,md));
      }
      else if (md->isVariable())
      {
        g_searchIndexInfo[SEARCH_INDEX_VARIABLES].add(SearchTerm(n,md));
      }
      else if (md->isSequence())
      {
        g_searchIndexInfo[SEARCH_INDEX_SEQUENCES].add(SearchTerm(n,md));
      }
      else if (md->isDictionary())
      {
        g_searchIndexInfo[SEARCH_INDEX_DICTIONARIES].add(SearchTerm(n,md));
      }
      else if (md->isTypedef())
      {
        g_searchIndexInfo[SEARCH_INDEX_TYPEDEFS].add(SearchTerm(n,md));
      }
      else if (md->isEnumerate())
      {
        g_searchIndexInfo[SEARCH_INDEX_ENUMS].add(SearchTerm(n,md));
      }
      else if (md->isEnumValue())
      {
        g_searchIndexInfo[SEARCH_INDEX_ENUMVALUES].add(SearchTerm(n,md));
      }
      else if (md->isProperty())
      {
        g_searchIndexInfo[SEARCH_INDEX_PROPERTIES].add(SearchTerm(n,md));
      }
      else if (md->isEvent())
      {
        g_searchIndexInfo[SEARCH_INDEX_EVENTS].add(SearchTerm(n,md));
      }
      else if (md->isRelated() || md->isForeign() ||
               (md->isFriend() && !isFriendToHide))
      {
        g_searchIndexInfo[SEARCH_INDEX_RELATED].add(SearchTerm(n,md));
      }
    }
  }
  else if (isLinkable &&
      (((nd=md->getNamespaceDef()) && nd->isLinkable()) ||
       ((fd=md->getFileDef())      && fd->isLinkable())
      )
     )
  {
    const DString &n = md->name();
    if (!n.empty())
    {
      g_searchIndexInfo[SEARCH_INDEX_ALL].add(SearchTerm(n,md));
 
      if (md->isFunction())
      {
        g_searchIndexInfo[SEARCH_INDEX_FUNCTIONS].add(SearchTerm(n,md));
      }
      else if (md->isVariable())
      {
        g_searchIndexInfo[SEARCH_INDEX_VARIABLES].add(SearchTerm(n,md));
      }
      else if (md->isSequence())
      {
        g_searchIndexInfo[SEARCH_INDEX_SEQUENCES].add(SearchTerm(n,md));
      }
      else if (md->isDictionary())
      {
        g_searchIndexInfo[SEARCH_INDEX_DICTIONARIES].add(SearchTerm(n,md));
      }
      else if (md->isTypedef())
      {
        g_searchIndexInfo[SEARCH_INDEX_TYPEDEFS].add(SearchTerm(n,md));
      }
      else if (md->isEnumerate())
      {
        g_searchIndexInfo[SEARCH_INDEX_ENUMS].add(SearchTerm(n,md));
      }
      else if (md->isEnumValue())
      {
        g_searchIndexInfo[SEARCH_INDEX_ENUMVALUES].add(SearchTerm(n,md));
      }
      else if (md->isDefine())
      {
        g_searchIndexInfo[SEARCH_INDEX_DEFINES].add(SearchTerm(n,md));
      }
    }
  }
}

References addMemberToSearchIndex(), Config_getBool, DString::empty(), g_searchIndexInfo, MemberDef::getClassDef(), MemberDef::getFileDef(), MemberDef::getGroupDef(), MemberDef::getNamespaceDef(), MemberDef::isDefine(), MemberDef::isDictionary(), 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, SearchTerm::SearchTerm(), and MemberDef::typeString().

Referenced by addMemberToSearchIndex(), and createJavaScriptSearchIndex().

createJavaScriptSearchIndex()

void createJavaScriptSearchIndex

(

)

Definition at line 334 of file searchindex_js.cpp.

{
  // index classes
  for (const auto &cd : *Doxygen::classLinkedMap)
  {
    if (cd->isLinkable())
    {
      DString n = cd->localName();
      g_searchIndexInfo[SEARCH_INDEX_ALL].add(SearchTerm(n,cd.get()));
      if (Config_getBool(OPTIMIZE_OUTPUT_SLICE))
      {
        if (cd->compoundType()==ClassDef::Interface)
        {
          g_searchIndexInfo[SEARCH_INDEX_INTERFACES].add(SearchTerm(n,cd.get()));
        }
        else if (cd->compoundType()==ClassDef::Struct)
        {
          g_searchIndexInfo[SEARCH_INDEX_STRUCTS].add(SearchTerm(n,cd.get()));
        }
        else if (cd->compoundType()==ClassDef::Exception)
        {
          g_searchIndexInfo[SEARCH_INDEX_EXCEPTIONS].add(SearchTerm(n,cd.get()));
        }
        else // cd->compoundType()==ClassDef::Class
        {
          g_searchIndexInfo[SEARCH_INDEX_CLASSES].add(SearchTerm(n,cd.get()));
        }
      }
      else // non slice optimization: group all types under classes
      {
        g_searchIndexInfo[SEARCH_INDEX_CLASSES].add(SearchTerm(n,cd.get()));
      }
    }
  }
 
  // index namespaces
  for (const auto &nd : *Doxygen::namespaceLinkedMap)
  {
    if (nd->isLinkable())
    {
      DString n = nd->name();
      g_searchIndexInfo[SEARCH_INDEX_ALL].add(SearchTerm(n,nd.get()));
      g_searchIndexInfo[SEARCH_INDEX_NAMESPACES].add(SearchTerm(n,nd.get()));
    }
  }
 
  // index concepts
  for (const auto &cd : *Doxygen::conceptLinkedMap)
  {
    if (cd->isLinkable())
    {
      DString n = cd->localName();
      g_searchIndexInfo[SEARCH_INDEX_ALL].add(SearchTerm(n,cd.get()));
      g_searchIndexInfo[SEARCH_INDEX_CONCEPTS].add(SearchTerm(n,cd.get()));
    }
  }
 
  // index modules
  for (const auto &mod : ModuleManager::instance().modules())
  {
    if (mod->isLinkable() && mod->isPrimaryInterface())
    {
      DString n = mod->name();
      g_searchIndexInfo[SEARCH_INDEX_ALL].add(SearchTerm(n,mod.get()));
      g_searchIndexInfo[SEARCH_INDEX_MODULES].add(SearchTerm(n,mod.get()));
    }
  }
 
  // index files
  for (const auto &fn : *Doxygen::inputNameLinkedMap)
  {
    for (const auto &fd : *fn)
    {
      DString n = fd->name();
      if (fd->isLinkable())
      {
        g_searchIndexInfo[SEARCH_INDEX_ALL].add(SearchTerm(n,fd.get()));
        g_searchIndexInfo[SEARCH_INDEX_FILES].add(SearchTerm(n,fd.get()));
      }
    }
  }
 
  // index class members
  {
    // for each member name
    for (const auto &mn : *Doxygen::memberNameLinkedMap)
    {
      // for each member definition
      for (const auto &md : *mn)
      {
        addMemberToSearchIndex(md.get());
      }
    }
  }
 
  // index file/namespace members
  {
    // for each member name
    for (const auto &mn : *Doxygen::functionNameLinkedMap)
    {
      // for each member definition
      for (const auto &md : *mn)
      {
        addMemberToSearchIndex(md.get());
      }
    }
  }
 
  // index groups
  for (const auto &gd : *Doxygen::groupLinkedMap)
  {
    if (gd->isLinkable())
    {
      DString title(filterTitle(gd->groupTitle()).str());
      SizeVector tokenIndices;
      splitSearchTokens(title,tokenIndices);
      for (size_t index : tokenIndices)
      {
        g_searchIndexInfo[SEARCH_INDEX_ALL].add(SearchTerm(title.mid(index),gd.get()));
        g_searchIndexInfo[SEARCH_INDEX_GROUPS].add(SearchTerm(title.mid(index),gd.get()));
      }
    }
  }
 
  // index pages
  for (const auto &pd : *Doxygen::pageLinkedMap)
  {
    if (pd->isLinkable())
    {
      DString title(filterTitle(pd->title()).str());
      SizeVector tokenIndices;
      splitSearchTokens(title,tokenIndices);
      for (size_t index : tokenIndices)
      {
        g_searchIndexInfo[SEARCH_INDEX_ALL].add(SearchTerm(title.mid(index),pd.get()));
        g_searchIndexInfo[SEARCH_INDEX_PAGES].add(SearchTerm(title.mid(index),pd.get()));
      }
    }
  }
 
  // main page
  if (Doxygen::mainPage)
  {
    DString title(filterTitle(Doxygen::mainPage->title()).str());
    SizeVector tokenIndices;
    splitSearchTokens(title,tokenIndices);
    for (size_t index : tokenIndices)
    {
      g_searchIndexInfo[SEARCH_INDEX_ALL].add(SearchTerm(title.mid(index),Doxygen::mainPage.get()));
      g_searchIndexInfo[SEARCH_INDEX_PAGES].add(SearchTerm(title.mid(index),Doxygen::mainPage.get()));
    }
  }
 
  // sections
  const auto &sm = SectionManager::instance();
  for (const auto &sectionInfo : sm)
  {
    if (sectionInfo->level()>0) // level 0 is for page titles
    {
      DString title = filterTitle(sectionInfo->title());
      SizeVector tokenIndices;
      splitSearchTokens(title,tokenIndices);
      //printf("split(%s)=(%s) %zu\n",qPrint(sectionInfo->title()),qPrint(title),tokenIndices.size());
      for (size_t index : tokenIndices)
      {
        g_searchIndexInfo[SEARCH_INDEX_ALL].add(SearchTerm(title.mid(index),sectionInfo.get()));
        g_searchIndexInfo[SEARCH_INDEX_PAGES].add(SearchTerm(title.mid(index),sectionInfo.get()));
      }
    }
  }
 
  // sort all lists
  for (auto &sii : g_searchIndexInfo) // for each index
  {
    for (auto &[name,symList] : sii.symbolMap) // for each symbol in the index
    {
      // sort the symbols (first on search term, and then on full name)
      //
      // `std::stable_sort` is used here due to reproducibility issues
      // on key collisions
      // https://github.com/doxygen/doxygen/issues/10445
      std::stable_sort(symList.begin(),
                symList.end(),
                [](const auto &t1,const auto &t2)
                {
                  int    eq =    dstricmp_sort(t1.word,t2.word);             // search term first
                  return eq==0 ? dstricmp_sort(t1.title,t2.title)<0 : eq<0;  // then full title
                });
    }
  }
}

References addMemberToSearchIndex(), Doxygen::classLinkedMap, Doxygen::conceptLinkedMap, Config_getBool, createJavaScriptSearchIndex(), ClassDef::Exception, filterTitle(), Doxygen::functionNameLinkedMap, g_searchIndexInfo, Doxygen::groupLinkedMap, Doxygen::inputNameLinkedMap, ModuleManager::instance(), SectionManager::instance(), ClassDef::Interface, Doxygen::mainPage, Doxygen::memberNameLinkedMap, DString::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, SearchTerm::SearchTerm(), splitSearchTokens(), DString::str(), and ClassDef::Struct.

Referenced by createJavaScriptSearchIndex(), and generateOutput().

getSearchIndices()

const std::array< SearchIndexInfo, NUM_SEARCH_INDICES > & getSearchIndices

(

)

Definition at line 870 of file searchindex_js.cpp.

{
  return g_searchIndexInfo;
}

References g_searchIndexInfo, and getSearchIndices().

Referenced by getSearchIndices().

splitSearchTokens()

void splitSearchTokens ( DString & title, SizeVector & indices )

static

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 92 of file searchindex_js.cpp.

{
  if (title.empty()) return;
 
  // simplify title to contain only words with single space as separator
  size_t di=0;
  bool lastIsSpace=true;
  for (size_t si=0; si<title.length(); si++)
  {
    char c = title.at(si);
    if (c=='@' || c=='\\') // skip over special commands
    {
      title.at(di)=' ';
      if (si<title.length()-1)
      {
        c = title.at(++si);
        while (si<title.length() && (isId(c) || c==':')) c = title.at(++si);
        --si;
      }
    }
    else if (c=='<') // skip over html tags
    {
      if (si<title.length()-1)
      {
        for (size_t tsi = si; tsi<title.length(); ++tsi)
        {
          if (title.at(tsi)=='>')
          {
            si=tsi;
            break;
          }
        }
      }
    }
    else if (isId(c) || c==':') // add "word" character
    {
      title.at(di)=c;
      di++;
      lastIsSpace=false;
    }
    else if (!lastIsSpace) // add one separator as space
    {
      title.at(di)=' ';
      di++;
      lastIsSpace=true;
    }
  }
  if (di>0 && title.at(di-1)==' ') di--; // strip trailing whitespace
  title.resize(di);
 
  // create a list of start positions within title for
  // each unique word in order of appearance
  size_t p=0,i=0;
  while ((i=title.find(' ',p))!=DString::npos)
  {
    std::string word = title.mid(p,i-p).str();
    indices.push_back(p);
    p = i+1;
  }
  if (p<title.length())
  {
    std::string word = title.mid(p).str();
    indices.push_back(p);
  }
}

References DString::at(), DString::empty(), DString::find(), isId(), DString::length(), DString::mid(), DString::npos, DString::resize(), splitSearchTokens(), and DString::str().

Referenced by createJavaScriptSearchIndex(), and splitSearchTokens().

writeJavascriptSearchData()

void writeJavascriptSearchData ( const DString & searchDirName )

static

Definition at line 526 of file searchindex_js.cpp.

{
  std::ofstream t = Portable::openOutputStream(searchDirName+"/searchdata.js");
  if (t.is_open())
  {
    t << "var indexSectionsWithContent =\n";
    t << "{\n";
    int j=0;
    for (const auto &sii : g_searchIndexInfo)
    {
      if (!sii.symbolMap.empty())
      {
        if (j>0) t << ",\n";
        t << "  " << j << ": \"";
 
        std::string previous_letter;  // start with value that does not exist in the map
        for (const auto &[letter,list] : sii.symbolMap)
        {
          if (letter != previous_letter)
          {
            if ( letter == "\"" ) t << "\\"; // add escape for backslash
            t << letter;
            previous_letter = letter;
          }
        }
        t << "\"";
        j++;
      }
    }
    if (j>0) t << "\n";
    t << "};\n\n";
    t << "var indexSectionNames =\n";
    t << "{\n";
    j=0;
    for (const auto &sii : g_searchIndexInfo)
    {
      if (!sii.symbolMap.empty())
      {
        if (j>0) t << ",\n";
        t << "  " << j << ": \"" << convertToJSString(sii.name,true,false) << "\"";
        j++;
      }
    }
    if (j>0) t << "\n";
    t << "};\n\n";
    t << "var indexSectionLabels =\n";
    t << "{\n";
    j=0;
    for (const auto &sii : g_searchIndexInfo)
    {
      if (!sii.symbolMap.empty())
      {
        if (j>0) t << ",\n";
        t << "  " << j << ": \"" << convertToJSString(convertToXML(sii.getText()),true,false) << "\"";
        j++;
      }
    }
    if (j>0) t << "\n";
    t << "};\n\n";
  }
}

References convertToJSString(), convertToXML(), g_searchIndexInfo, Portable::openOutputStream(), and writeJavascriptSearchData().

Referenced by writeJavascriptSearchData(), and writeJavaScriptSearchIndex().

writeJavaScriptSearchIndex()

void writeJavaScriptSearchIndex

(

)

Definition at line 799 of file searchindex_js.cpp.

{
  // write index files
  DString searchDirName = Config_getString(HTML_OUTPUT)+"/search";
 
  std::size_t numThreads = static_cast<std::size_t>(Config_getInt(NUM_PROC_THREADS));
  if (numThreads>1) // multi threaded version
  {
    ThreadPool threadPool(numThreads);
    std::vector< std::future<int> > results;
    for (auto &sii : g_searchIndexInfo)
    {
      int p=0;
      for (const auto &[letter,symList] : sii.symbolMap)
      {
        DString baseName;
        baseName.sprintf("%s_%x",sii.name.data(),p);
        DString dataFileName = searchDirName + "/"+baseName+".js";
        auto &list = symList;
        auto processFile = [p,baseName,dataFileName,&list]()
        {
          writeJavasScriptSearchDataPage(baseName,dataFileName,list);
          return p;
        };
        results.emplace_back(threadPool.queue(processFile));
        p++;
      }
    }
    // wait for the results
    for (auto &f : results) f.get();
  }
  else // single threaded version
  {
    for (auto &sii : g_searchIndexInfo)
    {
      int p=0;
      for (const auto &[letter,symList] : sii.symbolMap)
      {
        DString baseName;
        baseName.sprintf("%s_%x",sii.name.data(),p);
        DString dataFileName = searchDirName + "/"+baseName+".js";
        writeJavasScriptSearchDataPage(baseName,dataFileName,symList);
        p++;
      }
    }
  }
 
  writeJavascriptSearchData(searchDirName);
  auto &mgr = ResourceMgr::instance();
  {
    std::ofstream fn = Portable::openOutputStream(searchDirName+"/search.js");
    if (fn.is_open())
    {
      TextStream t(&fn);
      t << substitute(mgr.getAsString("search.js"),"$PROJECTID",getProjectId());
    }
  }
 
  Doxygen::indexList->addStyleSheetFile("search/searchdata.js");
  Doxygen::indexList->addStyleSheetFile("search/search.js");
}

References IndexList::addStyleSheetFile(), Config_getInt, Config_getString, g_searchIndexInfo, getProjectId(), Doxygen::indexList, ResourceMgr::instance(), Portable::openOutputStream(), ThreadPool::queue(), DString::sprintf(), substitute(), writeJavascriptSearchData(), writeJavaScriptSearchIndex(), and writeJavasScriptSearchDataPage().

Referenced by generateOutput(), and writeJavaScriptSearchIndex().

writeJavasScriptSearchDataPage()

void writeJavasScriptSearchDataPage ( const DString & baseName, const DString & dataFileName, const SearchIndexList & list )

static

Definition at line 588 of file searchindex_js.cpp.

{
  auto isDef = [](const SearchTerm::LinkInfo &info)
  {
    return std::holds_alternative<const Definition *>(info);
  };
  auto getDef = [&isDef](const SearchTerm::LinkInfo &info)
  {
    return isDef(info) ? std::get<const Definition *>(info) : nullptr;
  };
  auto isSection = [](const SearchTerm::LinkInfo &info)
  {
    return std::holds_alternative<const SectionInfo *>(info);
  };
  auto getSection = [&isSection](const SearchTerm::LinkInfo &info)
  {
    return isSection(info) ? std::get<const SectionInfo *>(info) : nullptr;
  };
 
  int cnt = 0;
  std::ofstream ti = Portable::openOutputStream(dataFileName);
  if (!ti.is_open())
  {
    err("Failed to open file '{}' for writing...\n",dataFileName);
    return;
  }
 
  ti << "var searchData=\n";
  // format
  // searchData[] = array of items
  // searchData[x][0] = id
  // searchData[x][1] = [ name + child1 + child2 + .. ]
  // searchData[x][1][0] = name as shown
  // searchData[x][1][y+1] = info for child y
  // searchData[x][1][y+1][0] = url
  // searchData[x][1][y+1][1] = 1 => target="_parent"
  // searchData[x][1][y+1][1] = 0 => target="_blank"
  // searchData[x][1][y+1][2] = scope
 
  ti << "[\n";
  bool firstEntry=true;
 
  int childCount=0;
  DString lastWord;
  const Definition *prevScope = nullptr;
  for (auto it = list.begin(); it!=list.end();)
  {
    const SearchTerm &term = *it;
    const SearchTerm::LinkInfo info = term.info;
    const Definition *d             = getDef(info);
    const SectionInfo *si           = getSection(info);
    assert(d || si); // either d or si should be valid
    DString word                   = term.word;
    DString id                     = term.termEncoded();
    ++it;
    const Definition *scope         = d ? d->getOuterScope() : nullptr;
    const SearchTerm::LinkInfo next = it!=list.end() ? it->info : SearchTerm::LinkInfo();
    const Definition *nextScope     = isDef(next) ? getDef(next)->getOuterScope() : nullptr;
    const MemberDef  *md            = toMemberDef(d);
    DString         anchor         = d ? d->anchor() : si ? si->label() : DString();
 
    if (word!=lastWord) // this item has a different search word
    {
      if (!firstEntry)
      {
        ti << "]]]";
        ti << ",\n";
      }
      firstEntry=false;
      ti << "  ['" << id << "_" << cnt++ << "',['";
      if (next==SearchTerm::LinkInfo() || it->word!=word) // unique result, show title
      {
        ti << convertToJSString(convertToXML(term.title),true,true);
      }
      else // multiple results, show matching word only, expanded list will show title
      {
        ti << convertToJSString(convertToXML(term.word),true,true);
      }
      ti << "',[";
      childCount=0;
      prevScope=nullptr;
    }
 
    if (childCount>0)
    {
      ti << "],[";
    }
    DString fn  = d ? d->getOutputFileBase() : si ? si->fileName() : DString();
    DString ref = d ? d->getReference()      : si ? si->ref()      : DString();
    addHtmlExtensionIfMissing(fn);
    DString extRef = externalRef("../",ref)+fn;
    if (!anchor.empty())
    {
      extRef+="#"+anchor;
    }
    ti << "'" << convertToJSString(extRef,true,true) << "',";
 
    bool extLinksInWindow = Config_getBool(EXT_LINKS_IN_WINDOW);
    if (!extLinksInWindow || ref.empty())
    {
      ti << "1,";
    }
    else
    {
      ti << "0,";
    }
 
    if (lastWord!=word && (next==SearchTerm::LinkInfo() || it->word!=word)) // unique search result
    {
      if (d && d->getOuterScope()!=Doxygen::globalScope)
      {
        ti << "'" << convertToJSString(convertToXML(d->getOuterScope()->name()),true,true) << "'";
      }
      else if (md)
      {
        const FileDef *fd = md->getBodyDef();
        if (fd==nullptr) fd = md->getFileDef();
        if (fd)
        {
          ti << "'" << convertToJSString(convertToXML(fd->localName()),true,true) << "'";
        }
      }
      else
      {
        ti << "''";
      }
    }
    else // multiple entries with the same name
    {
      bool found=false;
      bool overloadedFunction = ((prevScope!=nullptr && scope==prevScope) || (scope && scope==nextScope)) &&
                                 md && md->isCallable();
      DString prefix;
      if (md) prefix=convertToXML(md->localName());
      if (overloadedFunction) // overloaded member function
      {
        prefix+=convertToXML(md->argsString());
        // show argument list to disambiguate overloaded functions
      }
      else if (md && md->isCallable()) // unique member function
      {
        prefix+="()"; // only to show it is a callable symbol
      }
      DString name;
      if (d)
      {
        switch (d->definitionType())
        {
          case Definition::TypeClass:     name = convertToXML((toClassDef(d))->displayName());                    found=true; break;
          case Definition::TypeNamespace: name = convertToXML((toNamespaceDef(d))->displayName());                found=true; break;
          case Definition::TypeModule:    name = convertToXML(d->name()+" "+theTranslator->trModule(false,true)); found=true; break;
          case Definition::TypePage:      name = convertToXML(filterTitle(toPageDef(d)->title()));                found=true; break;
          case Definition::TypeGroup:     name = convertToXML(filterTitle(toGroupDef(d)->groupTitle()));          found=true; break;
          default:
            if (scope==nullptr || scope==Doxygen::globalScope) // in global scope
            {
              if (md)
              {
                const FileDef *fd = md->getBodyDef();
                if (fd==nullptr) fd = md->resolveAlias()->getFileDef();
                if (fd)
                {
                  if (!prefix.empty()) prefix+=":&#160;";
                  name = prefix + convertToXML(fd->localName());
                  found = true;
                }
              }
            }
            else if (md && (md->resolveAlias()->getClassDef() || md->resolveAlias()->getNamespaceDef()))
              // member in class or namespace scope
            {
              SrcLangExt lang = md->getLanguage();
              DString sep = getLanguageSpecificSeparator(lang);
              name = convertToXML(d->getOuterScope()->qualifiedName()) + sep + prefix;
              found = true;
            }
            else if (scope) // some thing else? -> show scope
            {
              name = prefix + convertToXML(scope->name());
              found = true;
            }
            break;
        }
      }
      else if (si)
      {
        name = parseCommentAsHtml(si->definition(),nullptr,si->title(),si->fileName(),si->lineNr());
        name = convertToXML(name);
        found = true;
      }
      if (!found) // fallback
      {
        name = prefix + "("+theTranslator->trGlobalNamespace()+")";
      }
 
      ti << "'" << convertToJSString(name,true,true) << "'";
 
      prevScope = scope;
      childCount++;
    }
    lastWord = word;
  }
  if (!firstEntry)
  {
    ti << "]]]\n";
  }
  ti << "];\n";
  Doxygen::indexList->addStyleSheetFile(("search/"+baseName+".js").data());
}

References addHtmlExtensionIfMissing(), IndexList::addStyleSheetFile(), Definition::anchor(), MemberDef::argsString(), Config_getBool, convertToJSString(), convertToXML(), SectionInfo::definition(), Definition::definitionType(), DString::DString(), DString::empty(), err, externalRef(), 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(), 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(), Translator::trGlobalNamespace(), Translator::trModule(), Definition::TypeClass, Definition::TypeGroup, Definition::TypeModule, Definition::TypeNamespace, Definition::TypePage, and writeJavasScriptSearchDataPage().

Referenced by writeJavaScriptSearchIndex(), and writeJavasScriptSearchDataPage().

Variable Documentation

g_searchIndexInfo

std::array<SearchIndexInfo,NUM_SEARCH_INDICES> g_searchIndexInfo

static

Definition at line 183 of file searchindex_js.cpp.

Referenced by addMemberToSearchIndex(), createJavaScriptSearchIndex(), getSearchIndices(), writeJavascriptSearchData(), and writeJavaScriptSearchIndex().