SearchIndexExternal类 参考

#include <searchindex.h>

类 SearchIndexExternal 继承关系图:

SearchIndexExternal 的协作图:

类
struct	Private

Public 成员函数
	SearchIndexExternal ()
void	setCurrentDoc (const Definition *ctx, const QCString &anchor, bool isSourceFile)
void	addWord (const QCString &word, bool hiPriority)
void	write (const QCString &file)
Public 成员函数 继承自 SearchIndexIntf
	SearchIndexIntf (Kind k)
virtual	~SearchIndexIntf ()
Kind	kind () const

Private 属性
std::unique_ptr< Private >	p

额外继承的成员函数
Public 类型 继承自 SearchIndexIntf
enum	Kind { Internal, External }

详细描述

在文件 searchindex.h 第 98 行定义.

构造及析构函数说明

SearchIndexExternal()

SearchIndexExternal::SearchIndexExternal

(

)

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

                                         : SearchIndexIntf(External), p(std::make_unique<Private>())
{
}

成员函数说明

addWord()

void SearchIndexExternal::addWord ( const QCString &  word, bool  hiPriority  )

virtual

实现了 SearchIndexIntf.

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

{
  if (word.isEmpty() || !isId(word[0]) || p->current==0) return;
  GrowBuf *pText = hiPriority ? &p->current->importantText : &p->current->normalText;
  if (pText->getPos()>0) pText->addChar(' ');
  pText->addStr(word);
  //printf("addWord %s\n",word);
}

引用了 GrowBuf::addChar(), GrowBuf::addStr(), GrowBuf::getPos(), QCString::isEmpty(), isId() , 以及 p.

setCurrentDoc()

void SearchIndexExternal::setCurrentDoc ( const Definition *  ctx, const QCString &  anchor, bool  isSourceFile  )

virtual

实现了 SearchIndexIntf.

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

{
  static QCString extId = stripPath(Config_getString(EXTERNAL_SEARCH_ID));
  QCString baseName = isSourceFile ? (toFileDef(ctx))->getSourceFileBase() : ctx->getOutputFileBase();
  QCString url = addHtmlExtensionIfMissing(baseName);
  if (!anchor.isEmpty()) url+=QCString("#")+anchor;
  QCString key = extId+";"+url;
 
  auto it = p->docEntries.find(key.str());
  if (it == p->docEntries.end())
  {
    SearchDocEntry e;
    e.type = isSourceFile ? QCString("source") : definitionToName(ctx);
    e.name = ctx->qualifiedName();
    if (ctx->definitionType()==Definition::TypeMember)
    {
      e.args = (toMemberDef(ctx))->argsString();
    }
    e.extId = extId;
    e.url  = url;
    it = p->docEntries.insert({key.str(),e}).first;
    //printf("searchIndexExt %s : %s\n",qPrint(e->name),qPrint(e->url));
  }
  p->current = &it->second;
}

引用了 addHtmlExtensionIfMissing(), SearchDocEntry::args, Config_getString, definitionToName(), Definition::definitionType(), SearchDocEntry::extId, Definition::getOutputFileBase(), QCString::isEmpty(), SearchDocEntry::name, p, Definition::qualifiedName(), QCString::str(), stripPath(), toFileDef(), toMemberDef(), SearchDocEntry::type, Definition::TypeMember , 以及 SearchDocEntry::url.

write()

void SearchIndexExternal::write ( const QCString &  file )

virtual

实现了 SearchIndexIntf.

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

{
  std::ofstream t(fileName.str(),std::ofstream::out | std::ofstream::binary);
  if (t.is_open())
  {
    t << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
    t << "<add>\n";
    for (auto &kv : p->docEntries)
    {
      SearchDocEntry &doc = kv.second;
      doc.normalText.addChar(0);    // make sure buffer ends with a 0 terminator
      doc.importantText.addChar(0); // make sure buffer ends with a 0 terminator
      t << "  <doc>\n";
      t << "    <field name=\"type\">"     << doc.type << "</field>\n";
      t << "    <field name=\"name\">"     << convertToXML(doc.name) << "</field>\n";
      if (!doc.args.isEmpty())
      {
        t << "    <field name=\"args\">"     << convertToXML(doc.args) << "</field>\n";
      }
      if (!doc.extId.isEmpty())
      {
        t << "    <field name=\"tag\">"      << convertToXML(doc.extId)  << "</field>\n";
      }
      t << "    <field name=\"url\">"      << convertToXML(doc.url)  << "</field>\n";
      t << "    <field name=\"keywords\">" << convertToXML(doc.importantText.get())  << "</field>\n";
      t << "    <field name=\"text\">"     << convertToXML(doc.normalText.get())     << "</field>\n";
      t << "  </doc>\n";
    }
    t << "</add>\n";
  }
  else
  {
    err("Failed to open file %s for writing!\n",qPrint(fileName));
  }
}

引用了 GrowBuf::addChar(), SearchDocEntry::args, convertToXML(), err(), SearchDocEntry::extId, GrowBuf::get(), SearchDocEntry::importantText, QCString::isEmpty(), SearchDocEntry::name, SearchDocEntry::normalText, p, qPrint(), QCString::str(), SearchDocEntry::type , 以及 SearchDocEntry::url.

类成员变量说明

p

std::unique_ptr<Private> SearchIndexExternal::p

private

在文件 searchindex.h 第 107 行定义.

被这些函数引用 addWord(), setCurrentDoc() , 以及 write().

---

该类的文档由以下文件生成:

• src/searchindex.h
• src/searchindex.cpp