runtime/khelpcenter/searchengine.h

   1 #ifndef SEARCHENGINE_H
   2 #define SEARCHENGINE_H
   3
   4 #include <QObject>
   5
   6
   7 #include <KProcess>
   8 #include <kio/job.h>
   9
  10 #include "docentrytraverser.h"
  11
  12
  13 namespace KHC {
  14
  15 class Formatter;
  16 class SearchEngine;
  17 class View;
  18 class SearchHandler;
  19
  20 class SearchTraverser : public QObject, public DocEntryTraverser
  21 {
  22     Q_OBJECT
  23   public:
  24     SearchTraverser( SearchEngine *engine, int level );
  25     ~SearchTraverser();
  26
  27     void process( DocEntry * );
  28
  29     void startProcess( DocEntry * );
  30
  31     DocEntryTraverser *createChild( DocEntry * );
  32
  33     DocEntryTraverser *parentTraverser();
  34
  35     void deleteTraverser();
  36
  37     void finishTraversal();
  38
  39   protected:
  40     void connectHandler( SearchHandler *handler );
  41     void disconnectHandler( SearchHandler *handler );
  42
  43   protected Q_SLOTS:
  44     void showSearchResult( SearchHandler *, DocEntry *, const QString &result );
  45     void showSearchError( SearchHandler *, DocEntry *, const QString &error );
  46
  47   private:
  48     const int mMaxLevel;
  49
  50     SearchEngine *mEngine;
  51     int mLevel;
  52
  53     DocEntry *mEntry;
  54     QString mJobData;
  55
  56     QString mResult;
  57
  58     QMap<SearchHandler *, int> mConnectCount;
  59 };
  60
  61
  62 class SearchEngine : public QObject
  63 {
  64     Q_OBJECT
  65   public:
  66     enum Operation { And, Or };
  67
  68     SearchEngine( View * );
  69     ~SearchEngine();
  70
  71     bool initSearchHandlers();
  72
  73     bool search( const QString & words, const QString & method = "and", int matches = 5,
  74                  const QString & scope = "" );
  75
  76     Formatter *formatter() const;
  77     View *view() const;
  78
  79     QString substituteSearchQuery( const QString &query );
  80
  81     static QString substituteSearchQuery( const QString &query,
  82       const QString &identifier, const QStringList &words, int maxResults,
  83       Operation operation, const QString &lang );
  84
  85     void finishSearch();
  86
  87     /**
  88       Append error message to error log.
  89     */
  90     void logError( DocEntry *entry, const QString &msg );
  91
  92     /**
  93       Return error log.
  94     */
  95     QString errorLog() const;
  96
  97     bool isRunning() const;
  98
  99     SearchHandler *handler( const QString &documentType ) const;
 100
 101     QStringList words() const;
 102     int maxResults() const;
 103     Operation operation() const;
 104
 105     bool canSearch( DocEntry * );
 106     bool needsIndex( DocEntry * );
 107
 108   Q_SIGNALS:
 109     void searchFinished();
 110
 111   protected Q_SLOTS:
 112     void searchExited(int, QProcess::ExitStatus);
 113
 114   protected:
 115     void processSearchQueue();
 116
 117   private:
 118     KProcess *mProc;
 119     bool mSearchRunning;
 120     QString mSearchResult;
 121
 122     QString mStderr;
 123
 124     View *mView;
 125
 126     QString mWords;
 127     int mMatches;
 128     QString mMethod;
 129     QString mLang;
 130     QString mScope;
 131
 132     QStringList mWordList;
 133     int mMaxResults;
 134     Operation mOperation;
 135
 136     DocEntryTraverser *mRootTraverser;
 137
 138     QMap<QString, SearchHandler *> mHandlers;
 139 };
 140
 141 }
 142
 143 #endif
 144 // vim:ts=2:sw=2:et