kworship/bible/biblegateway/KwBibleManagerBibleGateway.h

   1 /***************************************************************************
   2  *   This file is part of KWorship.                                        *
   3  *   Copyright 2008 James Hogan <james@albanarts.com>                      *
   4  *                                                                         *
   5  *   KWorship is free software: you can redistribute it and/or modify      *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation, either version 2 of the License, or     *
   8  *   (at your option) any later version.                                   *
   9  *                                                                         *
  10  *   KWorship is distributed in the hope that it will be useful,           *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with KWorship.  If not, write to the Free Software Foundation,  *
  17  *   Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.   *
  18  ***************************************************************************/
  19
  20 #ifndef _KwBibleManagerBibleGateway_h_
  21 #define _KwBibleManagerBibleGateway_h_
  22
  23 /**
  24  * @file KwBibleManagerBibleGateway.h
  25  * @brief A bible manager for BibleGateway.com.
  26  * @author James Hogan <james@albanarts.com>
  27  */
  28
  29 #include "KwBibleManager.h"
  30
  31 #include <QString>
  32 #include <QStringList>
  33 #include <QList>
  34 #include <QVector>
  35 #include <QHash>
  36
  37 class KwBibleModuleBibleGateway;
  38
  39 /// A bible manager for BibleGateway.com.
  40 class KwBibleManagerBibleGateway : public KwBibleManager
  41 {
  42     KW_BIBLE_MANAGER(KwBibleManagerBibleGateway, "BibleGateway.com")
  43
  44   public:
  45
  46     /*
  47      * Constructors + destructor
  48      */
  49
  50     /// Default constructor.
  51     KwBibleManagerBibleGateway(QObject* parent = 0, const QStringList& params = QStringList());
  52
  53     /// Destructor.
  54     virtual ~KwBibleManagerBibleGateway();
  55
  56     /*
  57      * Main interface
  58      */
  59
  60     // Reimplemented
  61     virtual QString name() const;
  62
  63     // Reimplemented
  64     virtual bool isRemote() const;
  65
  66     // Reimplemented
  67     virtual KwBibleModule* module(const QString& name);
  68
  69     // Reimplemented
  70     virtual QStringList moduleNames();
  71
  72     // Reimplemented
  73     virtual QStringList moduleNamesInLanguage(const QString& lang);
  74
  75     // Reimplemented
  76     virtual QStringList languages();
  77
  78   private:
  79
  80     /*
  81      * Private functions
  82      */
  83
  84     /// Ensure the version information is cached.
  85     void ensureCached();
  86
  87     /// Clear all modules.
  88     void clear();
  89
  90     /*
  91      * Variables
  92      */
  93
  94     /// Whether the versions have already been cached.
  95     bool m_cached;
  96
  97     /// Language names.
  98     QStringList m_languages;
  99
 100     /// Per version data.
 101     struct Version
 102     {
 103       QString name;
 104       QString url;
 105       int id;
 106       int lang;
 107       KwBibleModuleBibleGateway* module;
 108     };
 109
 110     /// Versions by id.
 111     QVector<Version*> m_versions;
 112
 113     /// Versions by name.
 114     QHash<QString, Version*> m_versionsByName;
 115
 116     /// Version ids by language id.
 117     QHash<int, QList<int> > m_versionsByLanguage;
 118 };
 119
 120 #endif // _KwBibleManagerBibleGateway_h_
 121