searchindex.h 2.83 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 18 19 20 21 22 23
 *
 */

#ifndef _SEARCHINDEX_H
#define _SEARCHINDEX_H

#include <qintdict.h>
#include <qlist.h>
#include <qdict.h>
24 25
#include <qintdict.h>
#include <qvector.h>
Dimitri van Heesch's avatar
Dimitri van Heesch committed
26

27
class FTextStream;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
28 29 30 31 32 33 34
class Definition;
class MemberDef;

/*! Initialize the search indexer */
void initSearchIndexer();
/*! Cleanup the search indexer */
void finializeSearchIndexer();
35 36 37

//------- server side search index ----------------------

38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56
struct URL
{
  URL(const char *n,const char *u) : name(n), url(u) {} 
  QCString name;
  QCString url;
};


struct URLInfo
{
  URLInfo(int idx,int f) : urlIdx(idx), freq(f) {}
  int urlIdx;
  int freq;
};

class IndexWord
{
  public:
    IndexWord(const char *word);
57
    void addUrlIndex(int,bool);
58 59 60 61 62 63 64 65
    const QIntDict<URLInfo> &urls() const { return m_urls; }
    QCString word() const { return m_word; }

  private:
    QCString    m_word;
    QIntDict<URLInfo> m_urls;
};

Dimitri van Heesch's avatar
Dimitri van Heesch committed
66 67 68 69 70 71 72 73 74 75 76 77 78 79 80
class SearchIndexIntf
{
  public:
    enum Kind { Internal, External };
    SearchIndexIntf(Kind k) : m_kind(k) {}
    virtual ~SearchIndexIntf() {}
    virtual void setCurrentDoc(Definition *ctx,const char *anchor,bool isSourceFile) = 0;
    virtual void addWord(const char *word,bool hiPriority) = 0;
    virtual void write(const char *file) = 0;
    Kind kind() const { return m_kind; }
  private:
    Kind m_kind;
};

class SearchIndex : public SearchIndexIntf
81 82 83
{
  public:
    SearchIndex();
Dimitri van Heesch's avatar
Dimitri van Heesch committed
84 85
    void setCurrentDoc(Definition *ctx,const char *anchor,bool isSourceFile);
    void addWord(const char *word,bool hiPriority);
86 87
    void write(const char *file);
  private:
Dimitri van Heesch's avatar
Dimitri van Heesch committed
88
    void addWord(const char *word,bool hiPrio,bool recurse);
89 90
    QDict<IndexWord> m_words;
    QVector< QList<IndexWord> > m_index;
91 92
    QDict<int> m_url2IdMap;
    QIntDict<URL> m_urls;
93 94 95
    int m_urlIndex;
};

Dimitri van Heesch's avatar
Dimitri van Heesch committed
96 97 98 99 100 101 102 103 104 105 106 107 108 109

class SearchIndexExternal : public SearchIndexIntf
{
    struct Private;
  public:
    SearchIndexExternal();
   ~SearchIndexExternal();
    void setCurrentDoc(Definition *ctx,const char *anchor,bool isSourceFile);
    void addWord(const char *word,bool hiPriority);
    void write(const char *file);
  private:
    Private *p;
};

110 111 112 113
//------- client side search index ----------------------

void writeJavascriptSearchIndex();
void writeSearchCategories(FTextStream &t);
114

Dimitri van Heesch's avatar
Dimitri van Heesch committed
115
#endif