searchindex.cpp 文件参考

#include <ctype.h>
#include <assert.h>
#include <sstream>
#include "searchindex.h"
#include "config.h"
#include "util.h"
#include "doxygen.h"
#include "language.h"
#include "pagedef.h"
#include "growbuf.h"
#include "message.h"
#include "version.h"
#include "groupdef.h"
#include "filedef.h"
#include "memberdef.h"
#include "filename.h"
#include "membername.h"
#include "resourcemgr.h"
#include "namespacedef.h"
#include "classdef.h"
#include "utf8.h"
#include "classlist.h"

searchindex.cpp 的引用(Include)关系图:

浏览源代码.

类
struct	SearchDocEntry
struct	SearchIndexExternal::Private

宏定义
#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

函数
static int	charsToIndex (const QCString &word)
static void	writeInt (std::ostream &f, size_t index)
static void	writeString (std::ostream &f, const QCString &s)
static QCString	definitionToName (const Definition *ctx)
QCString	searchName (const Definition *d)
QCString	searchId (const Definition *d)
static void	addMemberToSearchIndex (const MemberDef *md)
void	createJavaScriptSearchIndex ()
void	writeJavaScriptSearchIndex ()
const std::array< SearchIndexInfo, NUM_SEARCH_INDICES > &	getSearchIndices ()
void	initSearchIndexer ()
void	finalizeSearchIndexer ()

变量
const size_t	numIndexEntries = 256*256
static std::array< SearchIndexInfo, NUM_SEARCH_INDICES >	g_searchIndexInfo

宏定义说明

SEARCH_INDEX_ALL

#define SEARCH_INDEX_ALL   0

在文件 searchindex.cpp 第 577 行定义.

SEARCH_INDEX_CLASSES

#define SEARCH_INDEX_CLASSES   1

在文件 searchindex.cpp 第 578 行定义.

SEARCH_INDEX_CONCEPTS

#define SEARCH_INDEX_CONCEPTS   20

在文件 searchindex.cpp 第 597 行定义.

SEARCH_INDEX_DEFINES

#define SEARCH_INDEX_DEFINES   17

在文件 searchindex.cpp 第 594 行定义.

SEARCH_INDEX_DICTIONARIES

#define SEARCH_INDEX_DICTIONARIES   11

在文件 searchindex.cpp 第 588 行定义.

SEARCH_INDEX_ENUMS

#define SEARCH_INDEX_ENUMS   12

在文件 searchindex.cpp 第 589 行定义.

SEARCH_INDEX_ENUMVALUES

#define SEARCH_INDEX_ENUMVALUES   13

在文件 searchindex.cpp 第 590 行定义.

SEARCH_INDEX_EVENTS

#define SEARCH_INDEX_EVENTS   15

在文件 searchindex.cpp 第 592 行定义.

SEARCH_INDEX_EXCEPTIONS

#define SEARCH_INDEX_EXCEPTIONS   4

在文件 searchindex.cpp 第 581 行定义.

SEARCH_INDEX_FILES

#define SEARCH_INDEX_FILES   6

在文件 searchindex.cpp 第 583 行定义.

SEARCH_INDEX_FUNCTIONS

#define SEARCH_INDEX_FUNCTIONS   7

在文件 searchindex.cpp 第 584 行定义.

SEARCH_INDEX_GROUPS

#define SEARCH_INDEX_GROUPS   18

在文件 searchindex.cpp 第 595 行定义.

SEARCH_INDEX_INTERFACES

#define SEARCH_INDEX_INTERFACES   2

在文件 searchindex.cpp 第 579 行定义.

SEARCH_INDEX_NAMESPACES

#define SEARCH_INDEX_NAMESPACES   5

在文件 searchindex.cpp 第 582 行定义.

SEARCH_INDEX_PAGES

#define SEARCH_INDEX_PAGES   19

在文件 searchindex.cpp 第 596 行定义.

SEARCH_INDEX_PROPERTIES

#define SEARCH_INDEX_PROPERTIES   14

在文件 searchindex.cpp 第 591 行定义.

SEARCH_INDEX_RELATED

#define SEARCH_INDEX_RELATED   16

在文件 searchindex.cpp 第 593 行定义.

SEARCH_INDEX_SEQUENCES

#define SEARCH_INDEX_SEQUENCES   10

在文件 searchindex.cpp 第 587 行定义.

SEARCH_INDEX_STRUCTS

#define SEARCH_INDEX_STRUCTS   3

在文件 searchindex.cpp 第 580 行定义.

SEARCH_INDEX_TYPEDEFS

#define SEARCH_INDEX_TYPEDEFS   9

在文件 searchindex.cpp 第 586 行定义.

SEARCH_INDEX_VARIABLES

#define SEARCH_INDEX_VARIABLES   8

在文件 searchindex.cpp 第 585 行定义.

函数说明

addMemberToSearchIndex()

static void addMemberToSearchIndex ( const MemberDef *  md )

static

在文件 searchindex.cpp 第 631 行定义.

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

引用了 Config_getBool, convertUTF8ToLower(), g_searchIndexInfo, MemberDef::getClassDef(), MemberDef::getFileDef(), MemberDef::getGroupDef(), MemberDef::getNamespaceDef(), getUTF8CharAt(), MemberDef::isDefine(), MemberDef::isDictionary(), MemberDef::isEnumerate(), MemberDef::isEnumValue(), MemberDef::isEvent(), MemberDef::isForeign(), MemberDef::isFriend(), MemberDef::isFunction(), NamespaceDef::isLinkable(), GroupDef::isLinkable(), FileDef::isLinkable(), MemberDef::isLinkable(), ClassDef::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, QCString::str(), ClassDef::templateMaster() , 以及 MemberDef::typeString().

被这些函数引用 addToIndices() , 以及 createJavaScriptSearchIndex().

charsToIndex()

static int charsToIndex ( const QCString &  word )

static

在文件 searchindex.cpp 第 179 行定义.

{
  if (word.length()<2) return -1;
 
  // Fast string hashing algorithm
  //register ushort h=0;
  //const char *k = word;
  //ushort mask=0xfc00;
  //while ( *k )
  //{
  //  h = (h&mask)^(h<<6)^(*k++);
  //}
  //return h;
 
  // Simple hashing that allows for substring searching
  uint c1=(uchar)word[0];
  uint c2=(uchar)word[1];
  return c1*256+c2;
}

引用了 QCString::length().

被这些函数引用 SearchIndex::addWord().

createJavaScriptSearchIndex()

void createJavaScriptSearchIndex

(

)

在文件 searchindex.cpp 第 751 行定义.

{
  // index classes
  for (const auto &cd : *Doxygen::classLinkedMap)
  {
    std::string letter = convertUTF8ToLower(getUTF8CharAt(cd->localName().str(),0));
    if (cd->isLinkable())
    {
      g_searchIndexInfo[SEARCH_INDEX_ALL].add(letter,cd.get());
      if (Config_getBool(OPTIMIZE_OUTPUT_SLICE))
      {
        if (cd->compoundType()==ClassDef::Interface)
        {
          g_searchIndexInfo[SEARCH_INDEX_INTERFACES].add(letter,cd.get());
        }
        else if (cd->compoundType()==ClassDef::Struct)
        {
          g_searchIndexInfo[SEARCH_INDEX_STRUCTS].add(letter,cd.get());
        }
        else if (cd->compoundType()==ClassDef::Exception)
        {
          g_searchIndexInfo[SEARCH_INDEX_EXCEPTIONS].add(letter,cd.get());
        }
        else // cd->compoundType()==ClassDef::Class
        {
          g_searchIndexInfo[SEARCH_INDEX_CLASSES].add(letter,cd.get());
        }
      }
      else // non slice optimisation: group all types under classes
      {
        g_searchIndexInfo[SEARCH_INDEX_CLASSES].add(letter,cd.get());
      }
    }
  }
 
  // index namespaces
  for (const auto &nd : *Doxygen::namespaceLinkedMap)
  {
    std::string letter = convertUTF8ToLower(getUTF8CharAt(nd->name().str(),0));
    if (nd->isLinkable())
    {
      g_searchIndexInfo[SEARCH_INDEX_ALL].add(letter,nd.get());
      g_searchIndexInfo[SEARCH_INDEX_NAMESPACES].add(letter,nd.get());
    }
  }
 
  // index concepts
  for (const auto &cd : *Doxygen::conceptLinkedMap)
  {
    std::string letter = convertUTF8ToLower(getUTF8CharAt(cd->name().str(),0));
    if (cd->isLinkable())
    {
      g_searchIndexInfo[SEARCH_INDEX_ALL].add(letter,cd.get());
      g_searchIndexInfo[SEARCH_INDEX_CONCEPTS].add(letter,cd.get());
    }
  }
 
  // index files
  for (const auto &fn : *Doxygen::inputNameLinkedMap)
  {
    for (const auto &fd : *fn)
    {
      std::string letter = convertUTF8ToLower(getUTF8CharAt(fd->name().str(),0));
      if (fd->isLinkable())
      {
        g_searchIndexInfo[SEARCH_INDEX_ALL].add(letter,fd.get());
        g_searchIndexInfo[SEARCH_INDEX_FILES].add(letter,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())
    {
      std::string title = gd->groupTitle().str();
      if (!title.empty()) // TODO: able searching for all word in the title
      {
        std::string letter = convertUTF8ToLower(getUTF8CharAt(title,0));
        g_searchIndexInfo[SEARCH_INDEX_ALL].add(letter,gd.get());
        g_searchIndexInfo[SEARCH_INDEX_GROUPS].add(letter,gd.get());
      }
    }
  }
 
  // index pages
  for (const auto &pd : *Doxygen::pageLinkedMap)
  {
    if (pd->isLinkable())
    {
      std::string title = pd->title().str();
      if (!title.empty())
      {
        std::string letter = convertUTF8ToLower(getUTF8CharAt(title,0));
        g_searchIndexInfo[SEARCH_INDEX_ALL].add(letter,pd.get());
        g_searchIndexInfo[SEARCH_INDEX_PAGES].add(letter,pd.get());
      }
    }
  }
  if (Doxygen::mainPage)
  {
    std::string title = Doxygen::mainPage->title().str();
    if (!title.empty())
    {
      std::string letter = convertUTF8ToLower(getUTF8CharAt(title,0));
      g_searchIndexInfo[SEARCH_INDEX_ALL].add(letter,Doxygen::mainPage.get());
      g_searchIndexInfo[SEARCH_INDEX_PAGES].add(letter,Doxygen::mainPage.get());
    }
  }
 
  // sort all lists
  for (auto &sii : g_searchIndexInfo) // for each index
  {
    for (auto &kv : sii.symbolMap) // for each symbol in the index
    {
      // sort the symbols (first on "search" name, and then on full name)
      std::sort(kv.second.begin(),
                kv.second.end(),
                [](const Definition *d1,const Definition *d2)
                {
                  int eq = qstricmp(searchName(d1),searchName(d2));         // search name first
                  return eq==0 ? qstricmp(d1->name(),d2->name())<0 : eq<0;  // then full name
                });
    }
  }
}

引用了 addMemberToSearchIndex(), Doxygen::classLinkedMap, Doxygen::conceptLinkedMap, Config_getBool, convertUTF8ToLower(), ClassDef::Exception, Doxygen::functionNameLinkedMap, g_searchIndexInfo, getUTF8CharAt(), Doxygen::groupLinkedMap, Doxygen::inputNameLinkedMap, ClassDef::Interface, Doxygen::mainPage, Doxygen::memberNameLinkedMap, 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_NAMESPACES, SEARCH_INDEX_PAGES, SEARCH_INDEX_STRUCTS , 以及 ClassDef::Struct.

被这些函数引用 generateOutput().

definitionToName()

static QCString definitionToName ( const Definition *  ctx )

static

在文件 searchindex.cpp 第 414 行定义.

{
  if (ctx && ctx->definitionType()==Definition::TypeMember)
  {
    const MemberDef *md = toMemberDef(ctx);
    if (md->isFunction())
      return "function";
    else if (md->isSlot())
      return "slot";
    else if (md->isSignal())
      return "signal";
    else if (md->isVariable())
      return "variable";
    else if (md->isTypedef())
      return "typedef";
    else if (md->isEnumerate())
      return "enum";
    else if (md->isEnumValue())
      return "enumvalue";
    else if (md->isProperty())
      return "property";
    else if (md->isEvent())
      return "event";
    else if (md->isRelated() || md->isForeign())
      return "related";
    else if (md->isFriend())
      return "friend";
    else if (md->isDefine())
      return "define";
  }
  else if (ctx)
  {
    switch(ctx->definitionType())
    {
      case Definition::TypeClass:
        return (toClassDef(ctx))->compoundTypeString();
      case Definition::TypeFile:
        return "file";
      case Definition::TypeNamespace:
        return "namespace";
      case Definition::TypeConcept:
        return "concept";
      case Definition::TypeGroup:
        return "group";
      case Definition::TypePackage:
        return "package";
      case Definition::TypePage:
        return "page";
      case Definition::TypeDir:
        return "dir";
      default:
        break;
    }
  }
  return "unknown";
}

引用了 Definition::definitionType(), MemberDef::isDefine(), MemberDef::isEnumerate(), MemberDef::isEnumValue(), MemberDef::isEvent(), MemberDef::isForeign(), MemberDef::isFriend(), MemberDef::isFunction(), MemberDef::isProperty(), MemberDef::isRelated(), MemberDef::isSignal(), MemberDef::isSlot(), MemberDef::isTypedef(), MemberDef::isVariable(), toClassDef(), toMemberDef(), Definition::TypeClass, Definition::TypeConcept, Definition::TypeDir, Definition::TypeFile, Definition::TypeGroup, Definition::TypeMember, Definition::TypeNamespace, Definition::TypePackage , 以及 Definition::TypePage.

被这些函数引用 SearchIndexExternal::setCurrentDoc().

finalizeSearchIndexer()

void finalizeSearchIndexer

(

)

Cleanup the search indexer

在文件 searchindex.cpp 第 1264 行定义.

{
  delete Doxygen::searchIndex;
}

引用了 Doxygen::searchIndex.

被这些函数引用 generateOutput().

getSearchIndices()

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

(

)

在文件 searchindex.cpp 第 1235 行定义.

{
  return g_searchIndexInfo;
}

引用了 g_searchIndexInfo.

被这些函数引用 SearchIndicesContext::Private::Private().

initSearchIndexer()

void initSearchIndexer

(

)

Initialize the search indexer

在文件 searchindex.cpp 第 1242 行定义.

{
  static bool searchEngine      = Config_getBool(SEARCHENGINE);
  static bool serverBasedSearch = Config_getBool(SERVER_BASED_SEARCH);
  static bool externalSearch    = Config_getBool(EXTERNAL_SEARCH);
  if (searchEngine && serverBasedSearch)
  {
    if (externalSearch) // external tools produce search index and engine
    {
      Doxygen::searchIndex = new SearchIndexExternal;
    }
    else // doxygen produces search index and engine
    {
      Doxygen::searchIndex = new SearchIndex;
    }
  }
  else // no search engine or pure javascript based search function
  {
    Doxygen::searchIndex = 0;
  }
}

引用了 Config_getBool , 以及 Doxygen::searchIndex.

被这些函数引用 generateOutput().

searchId()

QCString searchId

(

const Definition *

d

)

在文件 searchindex.cpp 第 553 行定义.

{
  std::string s = searchName(d).str();
  TextStream t;
  for (size_t i=0;i<s.length();i++)
  {
    if (isIdJS(s[i]))
    {
      t << s[i];
    }
    else // escape non-identifier characters
    {
      static const char *hex = "0123456789ABCDEF";
      unsigned char uc = static_cast<unsigned char>(s[i]);
      t << '_';
      t << hex[uc>>4];
      t << hex[uc&0xF];
    }
  }
 
  return convertUTF8ToLower(t.str());
}

引用了 convertUTF8ToLower(), hex, isIdJS(), searchName(), TextStream::str() , 以及 QCString::str().

被这些函数引用 SymbolGroupContext::Private::id() , 以及 writeJavaScriptSearchIndex().

searchName()

QCString searchName

(

const Definition *

d

)

在文件 searchindex.cpp 第 546 行定义.

{
  return d->definitionType()==Definition::TypeGroup ?  QCString(toGroupDef(d)->groupTitle()) :
         d->definitionType()==Definition::TypePage  ?  toPageDef(d)->title() :
                                                       d->localName();
}

引用了 Definition::definitionType(), Definition::localName(), PageDef::title(), toGroupDef(), toPageDef(), Definition::TypeGroup , 以及 Definition::TypePage.

被这些函数引用 SymbolGroupContext::Private::name(), SymbolGroupListContext::Private::Private(), searchId() , 以及 writeJavaScriptSearchIndex().

writeInt()

static void writeInt ( std::ostream &  f, size_t  index  )

static

在文件 searchindex.cpp 第 246 行定义.

{
  f.put(static_cast<int>(index>>24));
  f.put(static_cast<int>((index>>16)&0xff));
  f.put(static_cast<int>((index>>8)&0xff));
  f.put(static_cast<int>(index&0xff));
}

被这些函数引用 SearchIndex::write().

writeJavaScriptSearchIndex()

void writeJavaScriptSearchIndex

(

)

在文件 searchindex.cpp 第 905 行定义.

{
  // write index files
  QCString searchDirName = Config_getString(HTML_OUTPUT)+"/search";
 
  for (auto &sii : g_searchIndexInfo)
  {
    int p=0;
    for (const auto &kv : sii.symbolMap)
    {
      int cnt = 0;
      QCString baseName;
      baseName.sprintf("%s_%x",sii.name.data(),p);
 
      QCString fileName = searchDirName + "/"+baseName+Doxygen::htmlFileExtension;
      QCString dataFileName = searchDirName + "/"+baseName+".js";
 
      std::ofstream t(fileName.str(), std::ofstream::out | std::ofstream::binary);
      std::ofstream ti(dataFileName.str(), std::ofstream::out | std::ofstream::binary);
      if (t.is_open() && ti.is_open())
      {
        {
          t << "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\""
            " \"https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\">\n";
          t << "<html xmlns=\"http://www.w3.org/1999/xhtml\">\n";
          t << "<head><title></title>\n";
          t << "<meta http-equiv=\"Content-Type\" content=\"text/xhtml;charset=UTF-8\"/>\n";
          t << "<meta name=\"generator\" content=\"Doxygen " << getDoxygenVersion() << "\"/>\n";
          t << "<link rel=\"stylesheet\" type=\"text/css\" href=\"search.css\"/>\n";
          t << "<script type=\"text/javascript\" src=\"" << baseName << ".js\"></script>\n";
          t << "<script type=\"text/javascript\" src=\"search.js\"></script>\n";
          t << "</head>\n";
          t << "<body class=\"SRPage\">\n";
          t << "<div id=\"SRIndex\">\n";
          t << "<div class=\"SRStatus\" id=\"Loading\">" << theTranslator->trLoading() << "</div>\n";
          t << "<div id=\"SRResults\"></div>\n"; // here the results will be inserted
          t << "<script type=\"text/javascript\">\n";
          t << "/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */\n";
          t << "createResults();\n"; // this function will insert the results
          t << "/* @license-end */\n";
          t << "</script>\n";
          t << "<div class=\"SRStatus\" id=\"Searching\">"
            << theTranslator->trSearching() << "</div>\n";
          t << "<div class=\"SRStatus\" id=\"NoMatches\">"
            << theTranslator->trNoMatches() << "</div>\n";
 
          t << "<script type=\"text/javascript\">\n";
          t << "/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */\n";
          t << "document.getElementById(\"Loading\").style.display=\"none\";\n";
          t << "document.getElementById(\"NoMatches\").style.display=\"none\";\n";
          t << "var searchResults = new SearchResults(\"searchResults\");\n";
          t << "searchResults.Search();\n";
          t << "window.addEventListener(\"message\", function(event) {\n";
          t << "  if (event.data == \"take_focus\") {\n";
          t << "    var elem = searchResults.NavNext(0);\n";
          t << "    if (elem) elem.focus();\n";
          t << "  }\n";
          t << "});\n";
          t << "/* @license-end */\n";
          t << "</script>\n";
          t << "</div>\n"; // SRIndex
          t << "</body>\n";
          t << "</html>\n";
        }
 
        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][2] = scope
 
        ti << "[\n";
        bool firstEntry=TRUE;
 
        int childCount=0;
        QCString lastName;
        const Definition *prevScope = 0;
        for (auto it = kv.second.begin(); it!=kv.second.end();)
        {
          const Definition *d = *it;
          QCString sname = searchName(d);
          QCString id    = searchId(d);
 
          if (sname!=lastName) // this item has a different search word
          {
            if (!firstEntry)
            {
              ti << "]]]";
              ti << ",\n";
            }
            firstEntry=FALSE;
 
            ti << "  ['" << id << "_" << cnt++ << "',['" << convertToXML(sname) << "',[";
            childCount=0;
            prevScope=0;
          }
 
          ++it;
          const Definition *scope     = d->getOuterScope();
          const Definition *next      = it!=kv.second.end() ? *it : 0;
          const Definition *nextScope = 0;
          const MemberDef  *md        = toMemberDef(d);
          if (next) nextScope = next->getOuterScope();
          QCString anchor = d->anchor();
 
          if (childCount>0)
          {
            ti << "],[";
          }
          ti << "'" << externalRef("../",d->getReference(),TRUE)
            << addHtmlExtensionIfMissing(d->getOutputFileBase());
          if (!anchor.isEmpty())
          {
            ti << "#" << anchor;
          }
          ti << "',";
 
          static bool extLinksInWindow = Config_getBool(EXT_LINKS_IN_WINDOW);
          if (!extLinksInWindow || d->getReference().isEmpty())
          {
            ti << "1,";
          }
          else
          {
            ti << "0,";
          }
 
          if (lastName!=sname && (next==0 || searchName(next)!=sname)) // unique name
          {
            if (d->getOuterScope()!=Doxygen::globalScope)
            {
              ti << "'" << convertToXML(d->getOuterScope()->name()) << "'";
            }
            else if (md)
            {
              const FileDef *fd = md->getBodyDef();
              if (fd==0) fd = md->getFileDef();
              if (fd)
              {
                ti << "'" << convertToXML(fd->localName()) << "'";
              }
            }
            else
            {
              ti << "''";
            }
          }
          else // multiple entries with the same name
          {
            bool found=FALSE;
            bool overloadedFunction = ((prevScope!=0 && scope==prevScope) ||
                (scope && scope==nextScope)) && md && (md->isFunction() || md->isSlot());
            QCString 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) // unique member function
            {
              prefix+="()"; // only to show it is a function
            }
            QCString name;
            if (d->definitionType()==Definition::TypeClass)
            {
              name = convertToXML((toClassDef(d))->displayName());
              found = TRUE;
            }
            else if (d->definitionType()==Definition::TypeNamespace)
            {
              name = convertToXML((toNamespaceDef(d))->displayName());
              found = TRUE;
            }
            else if (scope==0 || scope==Doxygen::globalScope) // in global scope
            {
              if (md)
              {
                const FileDef *fd = md->getBodyDef();
                if (fd==0) fd = md->resolveAlias()->getFileDef();
                if (fd)
                {
                  if (!prefix.isEmpty()) 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();
              name = convertToXML(d->getOuterScope()->qualifiedName())
                + getLanguageSpecificSeparator(lang) + prefix;
              found = TRUE;
            }
            else if (scope) // some thing else? -> show scope
            {
              name = prefix + convertToXML(scope->name());
              found = TRUE;
            }
            if (!found) // fallback
            {
              name = prefix + "("+theTranslator->trGlobalNamespace()+")";
            }
 
            ti << "'" << name << "'";
 
            prevScope = scope;
            childCount++;
          }
          lastName = sname;
        }
        if (!firstEntry)
        {
          ti << "]]]\n";
        }
        ti << "];\n";
      }
      else
      {
        err("Failed to open file '%s' for writing...\n",qPrint(fileName));
      }
      p++;
    }
  }
 
  {
    std::ofstream t(searchDirName.str()+"/searchdata.js",
                    std::ofstream::out | std::ofstream::binary);
    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 << ": \"";
 
          for (const auto &kv : sii.symbolMap)
          {
            if ( kv.first == "\"" ) t << "\\";
            t << kv.first;
          }
          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 << ": \"" << sii.name << "\"";
          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 << ": \"" << convertToXML(sii.getText()) << "\"";
          j++;
        }
      }
      if (j>0) t << "\n";
      t << "};\n\n";
    }
    ResourceMgr::instance().copyResource("search.js",searchDirName);
  }
 
  {
    QCString noMatchesFileName =searchDirName+"/nomatches"+Doxygen::htmlFileExtension;
    std::ofstream t(noMatchesFileName.str(), std::ofstream::out | std::ofstream::binary);
    if (t.is_open())
    {
      t << "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\" "
           "\"https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\">\n";
      t << "<html xmlns=\"http://www.w3.org/1999/xhtml\">\n";
      t << "<head><title></title>\n";
      t << "<meta http-equiv=\"Content-Type\" content=\"text/xhtml;charset=UTF-8\"/>\n";
      t << "<link rel=\"stylesheet\" type=\"text/css\" href=\"search.css\"/>\n";
      t << "<script type=\"text/javascript\" src=\"search.js\"></script>\n";
      t << "</head>\n";
      t << "<body class=\"SRPage\">\n";
      t << "<div id=\"SRIndex\">\n";
      t << "<div class=\"SRStatus\" id=\"NoMatches\">"
        << theTranslator->trNoMatches() << "</div>\n";
      t << "</div>\n";
      t << "</body>\n";
      t << "</html>\n";
    }
  }
 
  Doxygen::indexList->addStyleSheetFile("search/search.js");
}

引用了 addHtmlExtensionIfMissing(), IndexList::addStyleSheetFile(), Definition::anchor(), MemberDef::argsString(), Config_getBool, Config_getString, convertToXML(), ResourceMgr::copyResource(), Definition::definitionType(), err(), externalRef(), FALSE, g_searchIndexInfo, Definition::getBodyDef(), MemberDef::getClassDef(), MemberDef::getFileDef(), Definition::getLanguage(), getLanguageSpecificSeparator(), MemberDef::getNamespaceDef(), Definition::getOuterScope(), Definition::getOutputFileBase(), Definition::getReference(), Doxygen::globalScope, Doxygen::htmlFileExtension, Doxygen::indexList, ResourceMgr::instance(), QCString::isEmpty(), MemberDef::isFunction(), MemberDef::isSlot(), Definition::localName(), Definition::name(), qPrint(), Definition::qualifiedName(), MemberDef::resolveAlias(), searchId(), searchName(), QCString::sprintf(), QCString::str(), theTranslator, toClassDef(), toMemberDef(), toNamespaceDef(), Translator::trGlobalNamespace(), Translator::trLoading(), Translator::trNoMatches(), Translator::trSearching(), TRUE, Definition::TypeClass , 以及 Definition::TypeNamespace.

被这些函数引用 generateOutput().

writeString()

static void writeString ( std::ostream &  f, const QCString &  s  )

static

在文件 searchindex.cpp 第 254 行定义.

{
  uint l = s.length();
  for (uint i=0;i<l;i++) f.put(s[i]);
  f.put(0);
}

引用了 QCString::length().

被这些函数引用 SearchIndex::write().

变量说明

g_searchIndexInfo

std::array<SearchIndexInfo,NUM_SEARCH_INDICES> g_searchIndexInfo

static

在文件 searchindex.cpp 第 599 行定义.

被这些函数引用 addMemberToSearchIndex(), createJavaScriptSearchIndex(), getSearchIndices() , 以及 writeJavaScriptSearchIndex().

numIndexEntries

const size_t numIndexEntries = 256*256

在文件 searchindex.cpp 第 56 行定义.

被这些函数引用 SearchIndex::SearchIndex() , 以及 SearchIndex::write().