runtime/khelpcenter/searchhandler.h

   1 /*
   2     This file is part of KHelpCenter.
   3
   4     Copyright (c) 2005 Cornelius Schumacher <schumacher@kde.org>
   5
   6     This program is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     This program is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with this program; if not, write to the Free Software
  18     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  19 */
  20 #ifndef KHC_SEARCHHANDLER_H
  21 #define KHC_SEARCHHANDLER_H
  22
  23 #include "searchengine.h"
  24
  25 #include <QObject>
  26 #include <KProcess>
  27
  28 class KConfigGroup;
  29 namespace KIO {
  30 class Job;
  31 }
  32
  33 namespace KHC {
  34
  35 class SearchJob : public QObject {
  36     Q_OBJECT
  37   public:
  38     SearchJob(DocEntry *entry);
  39     ~SearchJob();
  40
  41     bool startLocal(const QString &cmdString);
  42     bool startRemote(const QString &url);
  43
  44   Q_SIGNALS:
  45     void searchFinished( SearchJob *, DocEntry *, const QString & );
  46     void searchError( SearchJob *, DocEntry *, const QString & );
  47
  48   protected Q_SLOTS:
  49     void searchExited( int exitCode, QProcess::ExitStatus );
  50     void slotJobResult( KJob *job );
  51     void slotJobData( KIO::Job *, const QByteArray &data );
  52
  53   protected:
  54     DocEntry *mEntry;
  55     KProcess *mProcess;
  56     KIO::Job *mKioJob;
  57     QString mCmd;
  58     QString mResult;
  59     QString mError;
  60 };
  61
  62 class SearchHandler : public QObject
  63 {
  64     Q_OBJECT
  65   public:
  66     static SearchHandler *initFromFile( const QString &filename );
  67
  68     virtual ~SearchHandler();
  69
  70     virtual void search( DocEntry *, const QStringList &words,
  71       int maxResults = 10,
  72       SearchEngine::Operation operation = SearchEngine::And ) = 0;
  73
  74     virtual QString indexCommand( const QString &identifier ) = 0;
  75
  76     QStringList documentTypes() const;
  77
  78     virtual bool checkPaths() const = 0;
  79
  80   Q_SIGNALS:
  81     void searchFinished( SearchHandler *, DocEntry *, const QString & );
  82     void searchError( SearchHandler *, DocEntry *, const QString & );
  83
  84   protected:
  85     SearchHandler( const KConfigGroup &cg );
  86
  87     QString mLang;
  88     QStringList mDocumentTypes;
  89 };
  90
  91 class ExternalProcessSearchHandler : public SearchHandler
  92 {
  93     Q_OBJECT
  94   public:
  95     ExternalProcessSearchHandler( const KConfigGroup &cg );
  96
  97     void search( DocEntry *, const QStringList &words,
  98       int maxResults = 10,
  99       SearchEngine::Operation operation = SearchEngine::And );
 100
 101     QString indexCommand( const QString &identifier );
 102
 103     bool checkPaths() const;
 104
 105   private:
 106     bool checkBinary( const QString &cmd ) const;
 107
 108   private slots:
 109     void slotSearchFinished( SearchJob *, DocEntry *, const QString & );
 110     void slotSearchError( SearchJob *, DocEntry *, const QString & );
 111
 112   private:
 113     QString mSearchCommand;
 114     QString mSearchUrl;
 115     QString mIndexCommand;
 116 };
 117
 118 }
 119
 120 #endif