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 <QHash>
  35
  36 class KwBibleModuleBibleGateway;
  37
  38 /// A bible manager for BibleGateway.com.
  39 class KwBibleManagerBibleGateway : public KwBibleManager
  40 {
  41     KW_BIBLE_MANAGER(KwBibleManagerBibleGateway, "BibleGateway.com")
  42
  43   public:
  44
  45     /*
  46      * Constructors + destructor
  47      */
  48
  49     /// Default constructor.
  50     KwBibleManagerBibleGateway(QObject* parent = 0, const QStringList& params = QStringList());
  51
  52     /// Destructor.
  53     virtual ~KwBibleManagerBibleGateway();
  54
  55     /*
  56      * Main interface
  57      */
  58
  59     // Reimplemented
  60     virtual QString name() const;
  61
  62     // Reimplemented
  63     virtual bool isRemote() const;
  64
  65     // Reimplemented
  66     virtual KwBibleModule* module(const QString& name);
  67
  68     // Reimplemented
  69     virtual QStringList moduleNames();
  70
  71     // Reimplemented
  72     virtual QStringList moduleNamesInLanguage(const QString& lang);
  73
  74     // Reimplemented
  75     virtual QStringList languages();
  76
  77   private:
  78
  79     /*
  80      * Private functions
  81      */
  82
  83     /// Ensure the version information is cached.
  84     void ensureCached();
  85
  86     /// Clear all modules.
  87     void clear();
  88
  89     /*
  90      * Variables
  91      */
  92
  93     /// Whether the versions have already been cached.
  94     bool m_cached;
  95
  96     /// Language names.
  97     QStringList m_languages;
  98
  99     /// Per version data.
 100     struct Version
 101     {
 102       QString name;
 103       int id;
 104       int lang;
 105       KwBibleModuleBibleGateway* module;
 106     };
 107
 108     /// Versions by id.
 109     QHash<int, Version*> m_versionsById;
 110
 111     /// Versions by name.
 112     QHash<QString, Version*> m_versionsByName;
 113
 114     /// Version ids by language id.
 115     QHash<int, QList<int> > m_versionsByLanguage;
 116 };
 117
 118 #endif // _KwBibleManagerBibleGateway_h_
 119