searchindex.cpp 41 KB
Newer Older
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1 2
/******************************************************************************
 *
3
 * 
Dimitri van Heesch's avatar
Dimitri van Heesch committed
4
 *
Dimitri van Heesch's avatar
Dimitri van Heesch committed
5
 * Copyright (C) 1997-2013 by Dimitri van Heesch.
Dimitri van Heesch's avatar
Dimitri van Heesch committed
6 7 8 9 10 11 12
 *
 * Permission to use, copy, modify, and distribute this software and its
 * documentation under the terms of the GNU General Public License is hereby 
 * granted. No representations are made about the suitability of this software 
 * for any purpose. It is provided "as is" without express or implied warranty.
 * See the GNU General Public License for more details.
 *
Dimitri van Heesch's avatar
Dimitri van Heesch committed
13 14
 * Documents produced by Doxygen are derivative works derived from the
 * input used in their production; they are not affected by this license.
Dimitri van Heesch's avatar
Dimitri van Heesch committed
15 16 17
 *
 */

Dimitri van Heesch's avatar
Dimitri van Heesch committed
18 19 20 21 22 23
#include <ctype.h>
#include <assert.h>

#include <qfile.h>
#include <qregexp.h>

Dimitri van Heesch's avatar
Dimitri van Heesch committed
24
#include "searchindex.h"
25
#include "config.h"
26
#include "util.h"
Dimitri van Heesch's avatar
Dimitri van Heesch committed
27 28 29 30 31
#include "doxygen.h"
#include "language.h"
#include "pagedef.h"
#include "growbuf.h"
#include "message.h"
32
#include "version.h"
33 34 35 36 37 38
#include "groupdef.h"
#include "classlist.h"
#include "filedef.h"
#include "memberdef.h"
#include "filename.h"
#include "membername.h"
39

40
// file format: (all multi-byte values are stored in big endian format)
41
//   4 byte header
42
//   256*256*4 byte index (4 bytes)
43
//   for each index entry: a zero terminated list of words 
44
//   for each word: a \0 terminated string + 4 byte offset to the stats info
45
//   padding bytes to align at 4 byte boundary
46 47 48 49
//   for each word: the number of urls (4 bytes) 
//               + for each url containing the word 8 bytes statistics
//                 (4 bytes index to url string + 4 bytes frequency counter)
//   for each url: a \0 terminated string
50 51 52 53 54 55 56 57

const int numIndexEntries = 256*256;

//--------------------------------------------------------------------

IndexWord::IndexWord(const char *word) : m_word(word), m_urls(17)
{
  m_urls.setAutoDelete(TRUE);
58
  //printf("IndexWord::IndexWord(%s)\n",word);
59 60
}

61
void IndexWord::addUrlIndex(int idx,bool hiPriority)
62
{
63
  //printf("IndexWord::addUrlIndex(%d,%d)\n",idx,hiPriority);
64 65 66
  URLInfo *ui = m_urls.find(idx);
  if (ui==0)
  {
67
    //printf("URLInfo::URLInfo(%d)\n",idx);
68 69 70
    ui=new URLInfo(idx,0);
    m_urls.insert(idx,ui);
  }
71 72
  ui->freq+=2;
  if (hiPriority) ui->freq|=1; // mark as high priority document
73 74 75 76
}

//--------------------------------------------------------------------

Dimitri van Heesch's avatar
Dimitri van Heesch committed
77
SearchIndex::SearchIndex() : SearchIndexIntf(Internal), 
78
      m_words(328829), m_index(numIndexEntries), m_url2IdMap(10007), m_urls(10007), m_urlIndex(-1)
79 80 81
{
  int i;
  m_words.setAutoDelete(TRUE);
82
  m_url2IdMap.setAutoDelete(TRUE);
83
  m_urls.setAutoDelete(TRUE);
84
  m_index.setAutoDelete(TRUE);
85 86 87
  for (i=0;i<numIndexEntries;i++) m_index.insert(i,new QList<IndexWord>);
}

Dimitri van Heesch's avatar
Dimitri van Heesch committed
88
void SearchIndex::setCurrentDoc(Definition *ctx,const char *anchor,bool isSourceFile)
89
{
Dimitri van Heesch's avatar
Dimitri van Heesch committed
90 91
  if (ctx==0) return;
  assert(!isSourceFile || ctx->definitionType()==Definition::TypeFile);
92
  //printf("SearchIndex::setCurrentDoc(%s,%s,%s)\n",name,baseName,anchor);
Dimitri van Heesch's avatar
Dimitri van Heesch committed
93 94
  QCString url=isSourceFile ? ((FileDef*)ctx)->getSourceFileBase() : ctx->getOutputFileBase();
  url+=Config_getString("HTML_FILE_EXTENSION");
95
  QCString baseUrl = url;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
96
  if (anchor) url+=QCString("#")+anchor;  
97
  if (!isSourceFile) baseUrl=url;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168
  QCString name=ctx->qualifiedName();
  if (ctx->definitionType()==Definition::TypeMember)
  {
    MemberDef *md = (MemberDef *)ctx;
    name.prepend((md->getLanguage()==SrcLangExt_Fortran  ? 
                 theTranslator->trSubprogram(TRUE,TRUE) :
                 theTranslator->trMember(TRUE,TRUE))+" ");
  }
  else // compound type
  {
    SrcLangExt lang = ctx->getLanguage();
    QCString sep = getLanguageSpecificSeparator(lang);
    if (sep!="::")
    {
      name = substitute(name,"::",sep);
    }
    switch (ctx->definitionType())
    {
      case Definition::TypePage:
        {
          PageDef *pd = (PageDef *)ctx;
          if (!pd->title().isEmpty())
          {
            name = theTranslator->trPage(TRUE,TRUE)+" "+pd->title();
          }
          else
          {
            name = theTranslator->trPage(TRUE,TRUE)+" "+pd->name();
          }
        }
        break;
      case Definition::TypeClass:
        {
          ClassDef *cd = (ClassDef *)ctx;
          name.prepend(cd->compoundTypeString()+" ");
        }
        break;
      case Definition::TypeNamespace:
        {
          if (lang==SrcLangExt_Java || lang==SrcLangExt_CSharp)
          {
            name = theTranslator->trPackage(name);
          }
          else if (lang==SrcLangExt_Fortran)
          {
            name.prepend(theTranslator->trModule(TRUE,TRUE)+" ");
          }
          else
          {
            name.prepend(theTranslator->trNamespace(TRUE,TRUE)+" ");
          }
        }
        break;
      case Definition::TypeGroup:
        {
          GroupDef *gd = (GroupDef *)ctx;
          if (gd->groupTitle())
          {
            name = theTranslator->trGroup(TRUE,TRUE)+" "+gd->groupTitle();
          }
          else
          {
            name.prepend(theTranslator->trGroup(TRUE,TRUE)+" ");
          }
        }
        break;
      default:
        break;
    }
  }

169
  int *pIndex = m_url2IdMap.find(baseUrl);
170 171 172
  if (pIndex==0)
  {
    ++m_urlIndex;
173
    m_url2IdMap.insert(baseUrl,new int(m_urlIndex));
174 175 176 177 178 179
    m_urls.insert(m_urlIndex,new URL(name,url));
  }
  else
  {
    m_urls.insert(*pIndex,new URL(name,url));
  }
180 181 182 183 184
}

static int charsToIndex(const char *word)
{
  if (word==0) return -1;
185

186 187 188 189 190 191 192 193 194 195 196
  // 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
Dimitri van Heesch's avatar
Dimitri van Heesch committed
197
  uint c1=((uchar *)word)[0];
198
  if (c1==0) return -1;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
199
  uint c2=((uchar *)word)[1];
200 201
  if (c2==0) return -1;
  return c1*256+c2;
202 203
}

204
void SearchIndex::addWord(const char *word,bool hiPriority,bool recurse)
205
{
206
  static QRegExp nextPart("[_a-z:][A-Z]");
Dimitri van Heesch's avatar
Dimitri van Heesch committed
207 208
  if (word==0 || word[0]=='\0') return;
  QCString wStr = QCString(word).lower();
Dimitri van Heesch's avatar
Dimitri van Heesch committed
209
  //printf("SearchIndex::addWord(%s,%d) wStr=%s\n",word,hiPriority,wStr.data());
210
  IndexWord *w = m_words[wStr];
211 212
  if (w==0)
  {
213
    int idx=charsToIndex(wStr);
Dimitri van Heesch's avatar
Dimitri van Heesch committed
214
    //fprintf(stderr,"addWord(%s) at index %d\n",word,idx);
215
    if (idx<0) return;
216
    w = new IndexWord(wStr);
217
    m_index[idx]->append(w);
218
    m_words.insert(wStr,w);
219
  }
220
  w->addUrlIndex(m_urlIndex,hiPriority);
221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238
  int i;
  bool found=FALSE;
  if (!recurse) // the first time we check if we can strip the prefix
  {
    i=getPrefixIndex(word);
    if (i>0)
    {
      addWord(word+i,hiPriority,TRUE);
      found=TRUE;
    }
  }
  if (!found) // no prefix stripped
  {
    if ((i=nextPart.match(word))>=1)
    {
      addWord(word+i+1,hiPriority,TRUE);
    }
  }
239 240
}

Dimitri van Heesch's avatar
Dimitri van Heesch committed
241 242 243 244
void SearchIndex::addWord(const char *word,bool hiPriority)
{
  addWord(word,hiPriority,FALSE);
}
245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405

static void writeInt(QFile &f,int index)
{
  f.putch(((uint)index)>>24);
  f.putch((((uint)index)>>16)&0xff);
  f.putch((((uint)index)>>8)&0xff);
  f.putch(((uint)index)&0xff);
}

static void writeString(QFile &f,const char *s)
{
  const char *p = s;
  while (*p) f.putch(*p++);
  f.putch(0);
}

void SearchIndex::write(const char *fileName)
{
  int i;
  int size=4; // for the header
  size+=4*numIndexEntries; // for the index
  int wordsOffset = size;
  // first pass: compute the size of the wordlist
  for (i=0;i<numIndexEntries;i++)
  {
    QList<IndexWord> *wlist = m_index[i];
    if (!wlist->isEmpty())
    {
      QListIterator<IndexWord> iwi(*wlist);
      IndexWord *iw;
      for (iwi.toFirst();(iw=iwi.current());++iwi)
      {
        int ws = iw->word().length()+1; 
        size+=ws+4; // word + url info list offset
      }
      size+=1; // zero list terminator
    }
  }

  // second pass: compute the offsets in the index
  int indexOffsets[numIndexEntries];
  int offset=wordsOffset;
  for (i=0;i<numIndexEntries;i++)
  {
    QList<IndexWord> *wlist = m_index[i];
    if (!wlist->isEmpty())
    {
      indexOffsets[i]=offset;
      QListIterator<IndexWord> iwi(*wlist);
      IndexWord *iw;
      for (iwi.toFirst();(iw=iwi.current());++iwi)
      {
        offset+= iw->word().length()+1; 
        offset+=4; // word + offset to url info array 
      }
      offset+=1; // zero list terminator
    }
    else
    {
      indexOffsets[i]=0;
    }
  }
  int padding = size;
  size = (size+3)&~3; // round up to 4 byte boundary
  padding = size - padding;

  //int statsOffset = size;
  QDictIterator<IndexWord> wdi(m_words);
  //IndexWord *iw;
  int *wordStatOffsets = new int[m_words.count()];
  
  int count=0;

  // third pass: compute offset to stats info for each word
  for (i=0;i<numIndexEntries;i++)
  {
    QList<IndexWord> *wlist = m_index[i];
    if (!wlist->isEmpty())
    {
      QListIterator<IndexWord> iwi(*wlist);
      IndexWord *iw;
      for (iwi.toFirst();(iw=iwi.current());++iwi)
      {
        //printf("wordStatOffsets[%d]=%d\n",count,size);
        wordStatOffsets[count++] = size;
        size+=4+iw->urls().count()*8; // count + (url_index,freq) per url
      }
    }
  }
  int *urlOffsets = new int[m_urls.count()];
  //int urlsOffset = size;
  QIntDictIterator<URL> udi(m_urls);
  URL *url;
  for (udi.toFirst();(url=udi.current());++udi)
  {
    urlOffsets[udi.currentKey()]=size;
    size+=url->name.length()+1+
          url->url.length()+1;
  }
  //printf("Total size %x bytes (word=%x stats=%x urls=%x)\n",size,wordsOffset,statsOffset,urlsOffset);
  QFile f(fileName);
  if (f.open(IO_WriteOnly))
  {
    // write header
    f.putch('D'); f.putch('O'); f.putch('X'); f.putch('S');
    // write index
    for (i=0;i<numIndexEntries;i++)
    {
      writeInt(f,indexOffsets[i]);
    }
    // write word lists
    count=0;
    for (i=0;i<numIndexEntries;i++)
    {
      QList<IndexWord> *wlist = m_index[i];
      if (!wlist->isEmpty())
      {
        QListIterator<IndexWord> iwi(*wlist);
        IndexWord *iw;
        for (iwi.toFirst();(iw=iwi.current());++iwi)
        {
          writeString(f,iw->word());
          writeInt(f,wordStatOffsets[count++]);
        }
        f.putch(0);
      }
    }
    // write extra padding bytes
    for (i=0;i<padding;i++) f.putch(0);
    // write word statistics
    for (i=0;i<numIndexEntries;i++)
    {
      QList<IndexWord> *wlist = m_index[i];
      if (!wlist->isEmpty())
      {
        QListIterator<IndexWord> iwi(*wlist);
        IndexWord *iw;
        for (iwi.toFirst();(iw=iwi.current());++iwi)
        {
          int numUrls = iw->urls().count();
          writeInt(f,numUrls);
          QIntDictIterator<URLInfo> uli(iw->urls());
          URLInfo *ui;
          for (uli.toFirst();(ui=uli.current());++uli)
          {
            writeInt(f,urlOffsets[ui->urlIdx]);
            writeInt(f,ui->freq);
          }
        }
      }
    }
    // write urls
    QIntDictIterator<URL> udi(m_urls);
    URL *url;
    for (udi.toFirst();(url=udi.current());++udi)
    {
      writeString(f,url->name);
      writeString(f,url->url);
    }
  }

406 407
  delete[] urlOffsets;
  delete[] wordStatOffsets;
408 409
}

Dimitri van Heesch's avatar
Dimitri van Heesch committed
410 411 412 413 414 415 416 417

//---------------------------------------------------------------------------
// the following part is for writing an external search index

struct SearchDocEntry
{
  QCString type;
  QCString name;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
418
  QCString args;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
419
  QCString extId;
420
  QCString url; 
Dimitri van Heesch's avatar
Dimitri van Heesch committed
421 422 423 424 425 426
  GrowBuf  importantText;
  GrowBuf  normalText;
};

struct SearchIndexExternal::Private
{
427
  Private() : docEntries(12251) {}
Dimitri van Heesch's avatar
Dimitri van Heesch committed
428 429 430 431 432 433 434 435 436 437 438 439 440
  SDict<SearchDocEntry> docEntries;
  SearchDocEntry *current;
};

SearchIndexExternal::SearchIndexExternal() : SearchIndexIntf(External)
{
  p = new SearchIndexExternal::Private;
  p->docEntries.setAutoDelete(TRUE);
  p->current=0;
}

SearchIndexExternal::~SearchIndexExternal()
{
441
  //printf("p->docEntries.count()=%d\n",p->docEntries.count());
Dimitri van Heesch's avatar
Dimitri van Heesch committed
442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501
  delete p;
}

static QCString definitionToName(Definition *ctx)
{
  if (ctx->definitionType()==Definition::TypeMember)
  {
    MemberDef *md = (MemberDef*)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 ((ClassDef*)ctx)->compoundTypeString();
      case Definition::TypeFile:
        return "file";
      case Definition::TypeNamespace:
        return "namespace";
      case Definition::TypeGroup:
        return "group";
      case Definition::TypePackage:
        return "package";
      case Definition::TypePage:
        return "page";
      case Definition::TypeDir:
        return "dir";
      default:
        break;
    }
  }
  return "unknown";
}

void SearchIndexExternal::setCurrentDoc(Definition *ctx,const char *anchor,bool isSourceFile)
{
Dimitri van Heesch's avatar
Dimitri van Heesch committed
502
  QCString extId = stripPath(Config_getString("EXTERNAL_SEARCH_ID"));
503 504 505
  QCString baseName = isSourceFile ? ((FileDef*)ctx)->getSourceFileBase() : ctx->getOutputFileBase();
  QCString url = baseName + Doxygen::htmlFileExtension;
  if (anchor) url+=QCString("#")+anchor;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
506
  QCString key = extId+";"+url;
507 508

  p->current = p->docEntries.find(key);
509
  //printf("setCurrentDoc(url=%s,isSourceFile=%d) current=%p\n",url.data(),isSourceFile,p->current);
510 511
  if (!p->current)
  {
Dimitri van Heesch's avatar
Dimitri van Heesch committed
512
    SearchDocEntry *e = new SearchDocEntry;
513
    e->type = isSourceFile ? QCString("source") : definitionToName(ctx);
Dimitri van Heesch's avatar
Dimitri van Heesch committed
514
    e->name = ctx->qualifiedName();
Dimitri van Heesch's avatar
Dimitri van Heesch committed
515 516 517 518
    if (ctx->definitionType()==Definition::TypeMember)
    {
      e->args = ((MemberDef*)ctx)->argsString();
    }
Dimitri van Heesch's avatar
Dimitri van Heesch committed
519
    e->extId = extId;
520
    e->url  = url;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
521
    p->current = e;
522
    p->docEntries.append(key,e);
Dimitri van Heesch's avatar
Dimitri van Heesch committed
523
    //printf("searchIndexExt %s : %s\n",e->name.data(),e->url.data());
524
  }
Dimitri van Heesch's avatar
Dimitri van Heesch committed
525 526 527 528 529 530 531 532
}

void SearchIndexExternal::addWord(const char *word,bool hiPriority)
{
  if (word==0 || !isId(*word) || p->current==0) return;
  GrowBuf *pText = hiPriority ? &p->current->importantText : &p->current->normalText;
  if (pText->getPos()>0) pText->addChar(' ');
  pText->addStr(word);
Dimitri van Heesch's avatar
Dimitri van Heesch committed
533
  //printf("addWord %s\n",word);
Dimitri van Heesch's avatar
Dimitri van Heesch committed
534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550
}

void SearchIndexExternal::write(const char *fileName)
{
  QFile f(fileName);
  if (f.open(IO_WriteOnly))
  {
    FTextStream t(&f);
    t << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>" << endl;
    t << "<add>" << endl;
    SDict<SearchDocEntry>::Iterator it(p->docEntries);
    SearchDocEntry *doc;
    for (it.toFirst();(doc=it.current());++it)
    {
      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>" << endl;
551 552
      t << "    <field name=\"type\">"     << doc->type << "</field>" << endl;
      t << "    <field name=\"name\">"     << convertToXML(doc->name) << "</field>" << endl;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
553 554 555 556
      if (!doc->args.isEmpty())
      {
        t << "    <field name=\"args\">"     << convertToXML(doc->args) << "</field>" << endl;
      }
Dimitri van Heesch's avatar
Dimitri van Heesch committed
557
      if (!doc->extId.isEmpty())
Dimitri van Heesch's avatar
Dimitri van Heesch committed
558
      {
Dimitri van Heesch's avatar
Dimitri van Heesch committed
559
        t << "    <field name=\"tag\">"      << convertToXML(doc->extId)  << "</field>" << endl;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
560
      }
561
      t << "    <field name=\"url\">"      << convertToXML(doc->url)  << "</field>" << endl;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
562 563 564 565 566 567 568 569 570 571 572 573
      t << "    <field name=\"keywords\">" << convertToXML(doc->importantText.get())  << "</field>" << endl;
      t << "    <field name=\"text\">"     << convertToXML(doc->normalText.get())     << "</field>" << endl;
      t << "  </doc>" << endl;
    }
    t << "</add>" << endl;
  }
  else
  {
    err("Failed to open file %s for writing!\n",fileName);
  }
}

574 575 576 577 578
//---------------------------------------------------------------------------
// the following part is for the javascript based search engine

#include "memberdef.h"
#include "namespacedef.h"
Dimitri van Heesch's avatar
Dimitri van Heesch committed
579
#include "pagedef.h"
580 581 582 583 584 585 586
#include "classdef.h"
#include "filedef.h"
#include "language.h"
#include "doxygen.h"
#include "message.h"

static const char search_script[]=
587
#include "search.js.h"
588 589 590 591 592 593 594 595 596 597 598 599 600 601 602
;

#define SEARCH_INDEX_ALL         0
#define SEARCH_INDEX_CLASSES     1
#define SEARCH_INDEX_NAMESPACES  2
#define SEARCH_INDEX_FILES       3
#define SEARCH_INDEX_FUNCTIONS   4
#define SEARCH_INDEX_VARIABLES   5
#define SEARCH_INDEX_TYPEDEFS    6
#define SEARCH_INDEX_ENUMS       7
#define SEARCH_INDEX_ENUMVALUES  8
#define SEARCH_INDEX_PROPERTIES  9
#define SEARCH_INDEX_EVENTS     10
#define SEARCH_INDEX_RELATED    11
#define SEARCH_INDEX_DEFINES    12
Dimitri van Heesch's avatar
Dimitri van Heesch committed
603 604
#define SEARCH_INDEX_GROUPS     13
#define SEARCH_INDEX_PAGES      14
Dimitri van Heesch's avatar
Dimitri van Heesch committed
605
#define NUM_SEARCH_INDICES      15
606

607 608 609 610 611 612 613 614 615 616
class SearchDefinitionList : public QList<Definition>
{
  public:
    SearchDefinitionList(uint letter) : m_letter(letter) {}
    uint letter() const { return m_letter; }
  private:
    uint m_letter;
};

class SearchIndexList : public SDict< SearchDefinitionList >
617 618
{
  public:
619 620
    typedef Definition ElementType;
    SearchIndexList(uint letter) : SDict<SearchDefinitionList>(17,FALSE), m_letter(letter)
621 622 623 624 625 626
    {
      setAutoDelete(TRUE);
    }
   ~SearchIndexList() {}
    void append(Definition *d)
    {
627
      SearchDefinitionList *l = find(d->name());
628 629
      if (l==0)
      {
630 631
        l=new SearchDefinitionList(m_letter);
        SDict<SearchDefinitionList>::append(d->name(),l);
632 633 634
      }
      l->append(d);
    }
635 636 637
    uint letter() const { return m_letter; }
  private:
    int compareValues(const SearchDefinitionList *md1, const SearchDefinitionList *md2) const
638
    {
639 640
      QCString n1 = md1->getFirst()->localName();
      QCString n2 = md2->getFirst()->localName();
Dimitri van Heesch's avatar
Dimitri van Heesch committed
641
      return qstricmp(n1.data(),n2.data());
642
    }
643
    uint m_letter;
644 645 646
};

static void addMemberToSearchIndex(
647
         LetterToIndexMap<SearchIndexList> symbols[NUM_SEARCH_INDICES],
648 649 650 651 652 653 654 655
         int symbolCount[NUM_SEARCH_INDICES],
         MemberDef *md)
{
  static bool hideFriendCompounds = Config_getBool("HIDE_FRIEND_COMPOUNDS");
  bool isLinkable = md->isLinkable();
  ClassDef *cd=0;
  NamespaceDef *nd=0;
  FileDef *fd=0;
656
  GroupDef *gd=0;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
657
  if (isLinkable && 
658 659 660 661 662
      (
       ((cd=md->getClassDef()) && cd->isLinkable() && cd->templateMaster()==0) ||
       ((gd=md->getGroupDef()) && gd->isLinkable())
      )
     )
663 664 665 666
  {
    QCString n = md->name();
    if (!n.isEmpty()) 
    {
667
      uint letter = getUtf8CodeToLower(n,0);
668 669 670 671 672 673
      bool isFriendToHide = hideFriendCompounds &&
        (QCString(md->typeString())=="friend class" || 
         QCString(md->typeString())=="friend struct" ||
         QCString(md->typeString())=="friend union");
      if (!(md->isFriend() && isFriendToHide))
      {
674
        symbols[SEARCH_INDEX_ALL].append(letter,md);
675 676 677 678
        symbolCount[SEARCH_INDEX_ALL]++;
      }
      if (md->isFunction() || md->isSlot() || md->isSignal())
      {
679
        symbols[SEARCH_INDEX_FUNCTIONS].append(letter,md);
680 681 682 683
        symbolCount[SEARCH_INDEX_FUNCTIONS]++;
      } 
      else if (md->isVariable())
      {
684
        symbols[SEARCH_INDEX_VARIABLES].append(letter,md);
685 686 687 688
        symbolCount[SEARCH_INDEX_VARIABLES]++;
      }
      else if (md->isTypedef())
      {
689
        symbols[SEARCH_INDEX_TYPEDEFS].append(letter,md);
690 691 692 693
        symbolCount[SEARCH_INDEX_TYPEDEFS]++;
      }
      else if (md->isEnumerate())
      {
694
        symbols[SEARCH_INDEX_ENUMS].append(letter,md);
695 696 697 698
        symbolCount[SEARCH_INDEX_ENUMS]++;
      }
      else if (md->isEnumValue())
      {
699
        symbols[SEARCH_INDEX_ENUMVALUES].append(letter,md);
700 701 702 703
        symbolCount[SEARCH_INDEX_ENUMVALUES]++;
      }
      else if (md->isProperty())
      {
704
        symbols[SEARCH_INDEX_PROPERTIES].append(letter,md);
705 706 707 708
        symbolCount[SEARCH_INDEX_PROPERTIES]++;
      }
      else if (md->isEvent())
      {
709
        symbols[SEARCH_INDEX_EVENTS].append(letter,md);
710 711 712 713 714
        symbolCount[SEARCH_INDEX_EVENTS]++;
      }
      else if (md->isRelated() || md->isForeign() ||
               (md->isFriend() && !isFriendToHide))
      {
715
        symbols[SEARCH_INDEX_RELATED].append(letter,md);
716 717 718 719 720 721 722 723 724 725 726 727 728
        symbolCount[SEARCH_INDEX_RELATED]++;
      }
    }
  }
  else if (isLinkable && 
      (((nd=md->getNamespaceDef()) && nd->isLinkable()) || 
       ((fd=md->getFileDef())      && fd->isLinkable())
      )
     )
  {
    QCString n = md->name();
    if (!n.isEmpty()) 
    {
729 730
      uint letter = getUtf8CodeToLower(n,0);
      symbols[SEARCH_INDEX_ALL].append(letter,md);
731 732 733 734
      symbolCount[SEARCH_INDEX_ALL]++;

      if (md->isFunction()) 
      {
735
        symbols[SEARCH_INDEX_FUNCTIONS].append(letter,md);
736 737 738 739
        symbolCount[SEARCH_INDEX_FUNCTIONS]++;
      }
      else if (md->isVariable()) 
      {
740
        symbols[SEARCH_INDEX_VARIABLES].append(letter,md);
741 742 743 744
        symbolCount[SEARCH_INDEX_VARIABLES]++;
      }
      else if (md->isTypedef())
      {
745
        symbols[SEARCH_INDEX_TYPEDEFS].append(letter,md);
746 747 748 749
        symbolCount[SEARCH_INDEX_TYPEDEFS]++;
      }
      else if (md->isEnumerate())
      {
750
        symbols[SEARCH_INDEX_ENUMS].append(letter,md);
751 752 753 754
        symbolCount[SEARCH_INDEX_ENUMS]++;
      }
      else if (md->isEnumValue())
      {
755
        symbols[SEARCH_INDEX_ENUMVALUES].append(letter,md);
756 757 758 759
        symbolCount[SEARCH_INDEX_ENUMVALUES]++;
      }
      else if (md->isDefine())
      {
760
        symbols[SEARCH_INDEX_DEFINES].append(letter,md);
761 762 763 764 765 766
        symbolCount[SEARCH_INDEX_DEFINES]++;
      }
    }
  }
}

767 768
// see also function convertToId() in search.js, which should match in
// behaviour
769 770 771 772 773 774 775 776
static QCString searchId(const QCString &s)
{
  int c;
  uint i;
  QCString result;
  for (i=0;i<s.length();i++)
  {
    c=s.at(i);
777 778 779 780 781
    if (c>0x7f || c<0) // part of multibyte character
    {
      result+=(char)c;
    }
    else if (isalnum(c)) // simply alpha numerical character
782 783 784
    {
      result+=(char)tolower(c);
    }
785
    else // other 'unprintable' characters
786 787 788 789 790 791 792 793 794 795
    {
      char val[4];
      sprintf(val,"_%02x",(uchar)c);
      result+=val;
    }
  }
  return result;
}

static int g_searchIndexCount[NUM_SEARCH_INDICES];
796
static LetterToIndexMap<SearchIndexList> g_searchIndexSymbols[NUM_SEARCH_INDICES];
797 798 799 800 801 802 803 804 805 806 807 808 809 810
static const char *g_searchIndexName[NUM_SEARCH_INDICES] = 
{ 
    "all",
    "classes",
    "namespaces",
    "files",
    "functions",
    "variables",
    "typedefs", 
    "enums", 
    "enumvalues",
    "properties", 
    "events", 
    "related",
Dimitri van Heesch's avatar
Dimitri van Heesch committed
811 812 813
    "defines",
    "groups",
    "pages"
814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834
};


class SearchIndexCategoryMapping
{
  public:
    SearchIndexCategoryMapping()
    {
      categoryLabel[SEARCH_INDEX_ALL]        = theTranslator->trAll();
      categoryLabel[SEARCH_INDEX_CLASSES]    = theTranslator->trClasses();
      categoryLabel[SEARCH_INDEX_NAMESPACES] = theTranslator->trNamespace(TRUE,FALSE);
      categoryLabel[SEARCH_INDEX_FILES]      = theTranslator->trFile(TRUE,FALSE);
      categoryLabel[SEARCH_INDEX_FUNCTIONS]  = theTranslator->trFunctions();
      categoryLabel[SEARCH_INDEX_VARIABLES]  = theTranslator->trVariables();
      categoryLabel[SEARCH_INDEX_TYPEDEFS]   = theTranslator->trTypedefs();
      categoryLabel[SEARCH_INDEX_ENUMS]      = theTranslator->trEnumerations();
      categoryLabel[SEARCH_INDEX_ENUMVALUES] = theTranslator->trEnumerationValues();
      categoryLabel[SEARCH_INDEX_PROPERTIES] = theTranslator->trProperties();
      categoryLabel[SEARCH_INDEX_EVENTS]     = theTranslator->trEvents();
      categoryLabel[SEARCH_INDEX_RELATED]    = theTranslator->trFriends();
      categoryLabel[SEARCH_INDEX_DEFINES]    = theTranslator->trDefines();
Dimitri van Heesch's avatar
Dimitri van Heesch committed
835 836
      categoryLabel[SEARCH_INDEX_GROUPS]     = theTranslator->trGroup(TRUE,FALSE);
      categoryLabel[SEARCH_INDEX_PAGES]      = theTranslator->trPage(TRUE,FALSE);
837 838 839 840 841 842 843 844 845 846 847 848 849
    }
    QCString categoryLabel[NUM_SEARCH_INDICES];
};

void writeJavascriptSearchIndex()
{
  if (!Config_getBool("GENERATE_HTML")) return;

  // index classes
  ClassSDict::Iterator cli(*Doxygen::classSDict);
  ClassDef *cd;
  for (;(cd=cli.current());++cli)
  {
850
    uint letter = getUtf8CodeToLower(cd->localName(),0);
851 852
    if (cd->isLinkable() && isId(letter))
    {
853 854
      g_searchIndexSymbols[SEARCH_INDEX_ALL].append(letter,cd);
      g_searchIndexSymbols[SEARCH_INDEX_CLASSES].append(letter,cd);
855 856 857 858 859 860 861 862 863 864
      g_searchIndexCount[SEARCH_INDEX_ALL]++;
      g_searchIndexCount[SEARCH_INDEX_CLASSES]++;
    }
  }

  // index namespaces
  NamespaceSDict::Iterator nli(*Doxygen::namespaceSDict);
  NamespaceDef *nd;
  for (;(nd=nli.current());++nli)
  {
865
    uint letter = getUtf8CodeToLower(nd->name(),0);
866 867
    if (nd->isLinkable() && isId(letter))
    {
868 869
      g_searchIndexSymbols[SEARCH_INDEX_ALL].append(letter,nd);
      g_searchIndexSymbols[SEARCH_INDEX_NAMESPACES].append(letter,nd);
870 871 872 873 874 875 876 877 878 879 880 881 882 883
      g_searchIndexCount[SEARCH_INDEX_ALL]++;
      g_searchIndexCount[SEARCH_INDEX_NAMESPACES]++;
    }
  }

  // index files
  FileNameListIterator fnli(*Doxygen::inputNameList);
  FileName *fn;
  for (;(fn=fnli.current());++fnli)
  {
    FileNameIterator fni(*fn);
    FileDef *fd;
    for (;(fd=fni.current());++fni)
    {
884
      uint letter = getUtf8CodeToLower(fd->name(),0);
885 886
      if (fd->isLinkable() && isId(letter))
      {
887 888
        g_searchIndexSymbols[SEARCH_INDEX_ALL].append(letter,fd);
        g_searchIndexSymbols[SEARCH_INDEX_FILES].append(letter,fd);
889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927
        g_searchIndexCount[SEARCH_INDEX_ALL]++;
        g_searchIndexCount[SEARCH_INDEX_FILES]++;
      }
    }
  }

  // index class members
  {
    MemberNameSDict::Iterator mnli(*Doxygen::memberNameSDict);
    MemberName *mn;
    // for each member name
    for (mnli.toFirst();(mn=mnli.current());++mnli)
    {
      MemberDef *md;
      MemberNameIterator mni(*mn);
      // for each member definition
      for (mni.toFirst();(md=mni.current());++mni)
      {
        addMemberToSearchIndex(g_searchIndexSymbols,g_searchIndexCount,md);
      }
    }
  }

  // index file/namespace members
  {
    MemberNameSDict::Iterator fnli(*Doxygen::functionNameSDict);
    MemberName *mn;
    // for each member name
    for (fnli.toFirst();(mn=fnli.current());++fnli)
    {
      MemberDef *md;
      MemberNameIterator mni(*mn);
      // for each member definition
      for (mni.toFirst();(md=mni.current());++mni)
      {
        addMemberToSearchIndex(g_searchIndexSymbols,g_searchIndexCount,md);
      }
    }
  }
Dimitri van Heesch's avatar
Dimitri van Heesch committed
928 929 930 931 932 933 934 935 936 937 938 939 940 941 942

  // index groups
  GroupSDict::Iterator gli(*Doxygen::groupSDict);
  GroupDef *gd;
  for (gli.toFirst();(gd=gli.current());++gli)
  {
    if (gd->isLinkable())
    {
      QCString title = gd->groupTitle();
      if (!title.isEmpty()) // TODO: able searching for all word in the title
      {
        uchar charCode = title.at(0);
        uint letter = charCode<128 ? tolower(charCode) : charCode;
        if (isId(letter))
        {
943 944
          g_searchIndexSymbols[SEARCH_INDEX_ALL].append(letter,gd);
          g_searchIndexSymbols[SEARCH_INDEX_GROUPS].append(letter,gd);
Dimitri van Heesch's avatar
Dimitri van Heesch committed
945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965
          g_searchIndexCount[SEARCH_INDEX_ALL]++;
          g_searchIndexCount[SEARCH_INDEX_GROUPS]++;
        }
      }
    }
  }

  // index pages
  PageSDict::Iterator pdi(*Doxygen::pageSDict);
  PageDef *pd=0;
  for (pdi.toFirst();(pd=pdi.current());++pdi)
  {
    if (pd->isLinkable())
    {
      QCString title = pd->title();
      if (!title.isEmpty())
      {
        uchar charCode = title.at(0);
        uint letter = charCode<128 ? tolower(charCode) : charCode;
        if (isId(letter))
        {
966 967
          g_searchIndexSymbols[SEARCH_INDEX_ALL].append(letter,pd);
          g_searchIndexSymbols[SEARCH_INDEX_PAGES].append(letter,pd);
Dimitri van Heesch's avatar
Dimitri van Heesch committed
968 969 970 971 972 973 974 975 976 977 978 979 980 981 982
          g_searchIndexCount[SEARCH_INDEX_ALL]++;
          g_searchIndexCount[SEARCH_INDEX_PAGES]++;
        }
      }
    }
  }
  if (Doxygen::mainPage)
  {
    QCString title = Doxygen::mainPage->title();
    if (!title.isEmpty())
    {
      uchar charCode = title.at(0);
      uint letter = charCode<128 ? tolower(charCode) : charCode;
      if (isId(letter))
      {
983 984
        g_searchIndexSymbols[SEARCH_INDEX_ALL].append(letter,Doxygen::mainPage);
        g_searchIndexSymbols[SEARCH_INDEX_PAGES].append(letter,Doxygen::mainPage);
Dimitri van Heesch's avatar
Dimitri van Heesch committed
985 986 987 988 989
        g_searchIndexCount[SEARCH_INDEX_ALL]++;
        g_searchIndexCount[SEARCH_INDEX_PAGES]++;
      }
    }
  }
990 991
  
  // sort all lists
992
  int i;
993 994
  for (i=0;i<NUM_SEARCH_INDICES;i++)
  {
995 996 997
    SIntDict<SearchIndexList>::Iterator it(g_searchIndexSymbols[i]);
    SearchIndexList *sl;
    for (it.toFirst();(sl=it.current());++it)
998
    {
999
      sl->sort();
1000 1001 1002 1003 1004 1005
    }
  }

  // write index files
  QCString searchDirName = Config_getString("HTML_OUTPUT")+"/search";

1006
  for (i=0;i<NUM_SEARCH_INDICES;i++) // for each index
1007
  {
1008 1009 1010 1011
    SIntDict<SearchIndexList>::Iterator it(g_searchIndexSymbols[i]);
    SearchIndexList *sl;
    int p=0;
    for (it.toFirst();(sl=it.current());++it,++p) // for each letter
1012
    {
1013 1014
      QCString baseName;
      baseName.sprintf("%s_%x",g_searchIndexName[i],p);
1015

1016 1017
      QCString fileName = searchDirName + "/"+baseName+".html";
      QCString dataFileName = searchDirName + "/"+baseName+".js";
1018

1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076
      QFile outFile(fileName);
      QFile dataOutFile(dataFileName);
      if (outFile.open(IO_WriteOnly) && dataOutFile.open(IO_WriteOnly))
      {
        {
          FTextStream t(&outFile);

          t << "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\""
            " \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\">" << endl;
          t << "<html><head><title></title>" << endl;
          t << "<meta http-equiv=\"Content-Type\" content=\"text/xhtml;charset=UTF-8\"/>" << endl;
          t << "<meta name=\"generator\" content=\"Doxygen " << versionString << "\">" << endl;
          t << "<link rel=\"stylesheet\" type=\"text/css\" href=\"search.css\"/>" << endl;
          t << "<script type=\"text/javascript\" src=\"" << baseName << ".js\"></script>" << endl;
          t << "<script type=\"text/javascript\" src=\"search.js\"></script>" << endl;
          t << "</head>" << endl;
          t << "<body class=\"SRPage\">" << endl;
          t << "<div id=\"SRIndex\">" << endl;
          t << "<div class=\"SRStatus\" id=\"Loading\">" << theTranslator->trLoading() << "</div>" << endl;
          t << "<div id=\"SRResults\"></div>" << endl; // here the results will be inserted
          t << "<script type=\"text/javascript\"><!--" << endl;
          t << "createResults();" << endl; // this function will insert the results
          t << "--></script>" << endl;
          t << "<div class=\"SRStatus\" id=\"Searching\">" 
            << theTranslator->trSearching() << "</div>" << endl;
          t << "<div class=\"SRStatus\" id=\"NoMatches\">"
            << theTranslator->trNoMatches() << "</div>" << endl;

          t << "<script type=\"text/javascript\"><!--" << endl;
          t << "document.getElementById(\"Loading\").style.display=\"none\";" << endl;
          t << "document.getElementById(\"NoMatches\").style.display=\"none\";" << endl;
          t << "var searchResults = new SearchResults(\"searchResults\");" << endl;
          t << "searchResults.Search();" << endl;
          t << "--></script>" << endl;
          t << "</div>" << endl; // SRIndex
          t << "</body>" << endl;
          t << "</html>" << endl;
        }
        FTextStream ti(&dataOutFile);

        ti << "var searchData=" << endl;
        // 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 << "[" << endl;
        bool firstEntry=TRUE;

        SDict<SearchDefinitionList>::Iterator li(*sl);
        SearchDefinitionList *dl;
        int itemCount=0;
        for (li.toFirst();(dl=li.current());++li)
1077
        {
1078
          Definition *d = dl->getFirst();
1079 1080 1081 1082 1083 1084 1085 1086 1087 1088
          QCString id = d->localName();

          if (!firstEntry)
          {
            ti << "," << endl;
          }
          firstEntry=FALSE;

          QCString dispName = d->localName();
          if (d->definitionType()==Definition::TypeGroup)
1089
          {
1090
            dispName = ((GroupDef*)d)->groupTitle();
1091
          }
1092
          else if (d->definitionType()==Definition::TypePage)
1093
          {
1094 1095 1096 1097
            dispName = ((PageDef*)d)->title();
          }
          ti << "  ['" << searchId(dispName) << "',['" 
            << convertToXML(dispName) << "',[";
1098

1099 1100 1101 1102 1103 1104 1105 1106 1107 1108
          if (dl->count()==1) // item with a unique name
          {
            MemberDef  *md   = 0;
            bool isMemberDef = d->definitionType()==Definition::TypeMember;
            if (isMemberDef) md = (MemberDef*)d;
            QCString anchor = d->anchor();

            ti << "'" << externalRef("../",d->getReference(),TRUE)
              << d->getOutputFileBase() << Doxygen::htmlFileExtension;
            if (!anchor.isEmpty())
1109
            {
1110
              ti << "#" << anchor;
1111
            }
1112
            ti << "',";
1113

1114 1115
            static bool extLinksInWindow = Config_getBool("EXT_LINKS_IN_WINDOW");
            if (!extLinksInWindow || d->getReference().isEmpty())
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1116
            {
1117
              ti << "1,";
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1118
            }
1119
            else
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1120
            {
1121
              ti << "0,";
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1122
            }
1123

1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149
            if (d->getOuterScope()!=Doxygen::globalScope)
            {
              ti << "'" << convertToXML(d->getOuterScope()->name()) << "'";
            }
            else if (md)
            {
              FileDef *fd = md->getBodyDef();
              if (fd==0) fd = md->getFileDef();
              if (fd)
              {
                ti << "'" << convertToXML(fd->localName()) << "'";
              }
            }
            else
            {
              ti << "''";
            }
            ti << "]]";
          }
          else // multiple items with the same name
          {
            QListIterator<Definition> di(*dl);
            bool overloadedFunction = FALSE;
            Definition *prevScope = 0;
            int childCount=0;
            for (di.toFirst();(d=di.current());)
1150
            {
1151 1152 1153 1154 1155
              ++di;
              Definition *scope     = d->getOuterScope();
              Definition *next      = di.current();
              Definition *nextScope = 0;
              MemberDef  *md        = 0;
1156 1157
              bool isMemberDef = d->definitionType()==Definition::TypeMember;
              if (isMemberDef) md = (MemberDef*)d;
1158
              if (next) nextScope = next->getOuterScope();
1159 1160
              QCString anchor = d->anchor();

1161 1162 1163 1164
              if (childCount>0)
              {
                ti << "],[";
              }
1165
              ti << "'" << externalRef("../",d->getReference(),TRUE)
1166
                << d->getOutputFileBase() << Doxygen::htmlFileExtension;
1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181
              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,";
              }
1182 1183 1184 1185 1186 1187 1188 1189
              bool found=FALSE;
              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
1190
              {
1191 1192
                prefix+=convertToXML(md->argsString()); 
                // show argument list to disambiguate overloaded functions
1193
              }
1194
              else if (md) // unique member function
1195
              {
1196
                prefix+="()"; // only to show it is a function
1197
              }
1198 1199
              QCString name;
              if (d->definitionType()==Definition::TypeClass)
1200
              {
1201 1202
                name = convertToXML(((ClassDef*)d)->displayName());
                found = TRUE;
1203
              }
1204
              else if (d->definitionType()==Definition::TypeNamespace)
1205
              {
1206 1207 1208 1209 1210 1211
                name = convertToXML(((NamespaceDef*)d)->displayName());
                found = TRUE;
              }
              else if (scope==0 || scope==Doxygen::globalScope) // in global scope
              {
                if (md)
1212
                {
1213 1214 1215
                  FileDef *fd = md->getBodyDef();
                  if (fd==0) fd = md->getFileDef();
                  if (fd)
1216
                  {
1217 1218 1219
                    if (!prefix.isEmpty()) prefix+=":&#160;";
                    name = prefix + convertToXML(fd->localName());
                    found = TRUE;
1220 1221
                  }
                }
1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238
              }
              else if (md && (md->getClassDef() || md->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()+")";
1239 1240
              }

1241
              ti << "'" << name << "'";
1242

1243 1244 1245
              prevScope = scope;
              childCount++;
            }
1246

1247 1248 1249 1250
            ti << "]]";
          }
          ti << "]";
          itemCount++;
1251
        }
1252
        if (!firstEntry)
1253
        {
1254
          ti << endl;
1255
        }
1256 1257 1258 1259 1260 1261 1262

        ti << "];" << endl;

      }
      else
      {
        err("Failed to open file '%s' for writing...\n",fileName.data());
1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286
      }
    }
  }

  {
    QFile f(searchDirName+"/search.js");
    if (f.open(IO_WriteOnly))
    {
      FTextStream t(&f);
      t << "// Search script generated by doxygen" << endl;
      t << "// Copyright (C) 2009 by Dimitri van Heesch." << endl << endl;
      t << "// The code in this file is loosly based on main.js, part of Natural Docs," << endl;
      t << "// which is Copyright (C) 2003-2008 Greg Valure" << endl;
      t << "// Natural Docs is licensed under the GPL." << endl << endl;
      t << "var indexSectionsWithContent =" << endl;
      t << "{" << endl;
      bool first=TRUE;
      int j=0;
      for (i=0;i<NUM_SEARCH_INDICES;i++)
      {
        if (g_searchIndexCount[i]>0)
        {
          if (!first) t << "," << endl;
          t << "  " << j << ": \"";
1287 1288 1289 1290

          SIntDict<SearchIndexList>::Iterator it(g_searchIndexSymbols[i]);
          SearchIndexList *sl;
          for (it.toFirst();(sl=it.current());++it) // for each letter
1291
          {
1292
            t << QString( QChar( sl->letter() ) ).utf8();
1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340
          }
          t << "\"";
          first=FALSE;
          j++;
        }
      }
      if (!first) t << "\n";
      t << "};" << endl << endl;
      t << "var indexSectionNames =" << endl;
      t << "{" << endl;
      first=TRUE;
      j=0;
      for (i=0;i<NUM_SEARCH_INDICES;i++)
      {
        if (g_searchIndexCount[i]>0)
        {
          if (!first) t << "," << endl;
          t << "  " << j << ": \"" << g_searchIndexName[i] << "\"";
          first=FALSE;
          j++;
        }
      }
      if (!first) t << "\n";
      t << "};" << endl << endl;
      t << search_script;
    }
  }
  {
    QFile f(searchDirName+"/nomatches.html");
    if (f.open(IO_WriteOnly))
    {
      FTextStream t(&f);
      t << "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\" "
           "\"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\">" << endl;
      t << "<html><head><title></title>" << endl;
      t << "<meta http-equiv=\"Content-Type\" content=\"text/xhtml;charset=UTF-8\"/>" << endl;
      t << "<link rel=\"stylesheet\" type=\"text/css\" href=\"search.css\"/>" << endl;
      t << "<script type=\"text/javascript\" src=\"search.js\"></script>" << endl;
      t << "</head>" << endl;
      t << "<body class=\"SRPage\">" << endl;
      t << "<div id=\"SRIndex\">" << endl;
      t << "<div class=\"SRStatus\" id=\"NoMatches\">"
        << theTranslator->trNoMatches() << "</div>" << endl;
      t << "</div>" << endl;
      t << "</body>" << endl;
      t << "</html>" << endl;
    }
  }
1341
  Doxygen::indexList->addStyleSheetFile("search/search.js");
1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361
}

void writeSearchCategories(FTextStream &t)
{
  static SearchIndexCategoryMapping map;
  int i,j=0;
  for (i=0;i<NUM_SEARCH_INDICES;i++)
  {
    if (g_searchIndexCount[i]>0)
    {
      t << "<a class=\"SelectItem\" href=\"javascript:void(0)\" "
        << "onclick=\"searchBox.OnSelectItem(" << j << ")\">"
        << "<span class=\"SelectionMark\">&#160;</span>"
        << convertToXML(map.categoryLabel[i])
        << "</a>";
      j++;
    }
  }
}

Dimitri van Heesch's avatar
Dimitri van Heesch committed
1362 1363 1364 1365
//---------------------------------------------------------------------------------------------

void initSearchIndexer()
{
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1366
  static bool searchEngine      = Config_getBool("SEARCHENGINE");
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1367
  static bool serverBasedSearch = Config_getBool("SERVER_BASED_SEARCH");
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1368
  static bool externalSearch    = Config_getBool("EXTERNAL_SEARCH");
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1369 1370
  if (searchEngine && serverBasedSearch)
  {
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1371 1372 1373 1374 1375 1376 1377 1378
    if (externalSearch) // external tools produce search index and engine
    {
      Doxygen::searchIndex = new SearchIndexExternal;
    }
    else // doxygen produces search index and engine
    {
      Doxygen::searchIndex = new SearchIndex;
    }
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389
  }
  else // no search engine or pure javascript based search function
  {
    Doxygen::searchIndex = 0;
  }
}

void finializeSearchIndexer()
{
  delete Doxygen::searchIndex;
}
1390 1391