kworship/bible/KwBibleModule.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 _KwBibleModule_h_
  21 #define _KwBibleModule_h_
  22
  23 /**
  24  * @file KwBibleModule.h
  25  * @brief An abstract bible module (analagous to a SWORD module).
  26  * @author James Hogan <james@albanarts.com>
  27  */
  28
  29 #include <QString>
  30 #include <QStringList>
  31
  32 class KwBiblePassage;
  33
  34 /// A bible module (analagous to a SWORD module).
  35 class KwBibleModule
  36 {
  37   public:
  38
  39     /*
  40      * Types
  41      */
  42
  43     /// Verse key.
  44     struct VerseKey
  45     {
  46       /// Book of the bible.
  47       int book;
  48       /// Chapter of the book (-1 for entire book).
  49       int chapter;
  50       /// Verse of the chapter (-1 for entire chapter).
  51       int verse;
  52     };
  53
  54     /// Range of verse keys.
  55     struct Key
  56     {
  57       /// Start key of range.
  58       VerseKey start;
  59       /// End key of range.
  60       VerseKey end;
  61     };
  62
  63     /*
  64      * Constructors + destructor
  65      */
  66
  67     /// Default constructor.
  68     KwBibleModule();
  69
  70     /// Destructor.
  71     virtual ~KwBibleModule();
  72
  73     /*
  74      * Main interface
  75      */
  76
  77     /// Create a key from a string.
  78     Key createKey(const QString& text, bool* valid = 0);
  79
  80     /// Create a key from a string relative to another key.
  81     Key createKey(const Key& other, const QString& text, bool* valid = 0);
  82
  83     /// Create a key from individual values.
  84     Key createKey(int book, int chapter, int verse = -1);
  85
  86     /// Create a key from individual values.
  87     Key createKey(const QString& book, int chapter, int verse = -1);
  88
  89     /// Create a range key between two verses in the same chapter.
  90     Key createKey(const QString& book, int chapter, int verseStart,
  91                                                     int verseEnd);
  92
  93     /// Create a range key between two verses in different chapters.
  94     Key createKey(const QString& book, int chapterStart, int verseStart,
  95                                        int chapterEnd,   int verseEnd);
  96
  97     /// Create a range key between two verses in different books.
  98     Key createKey(const QString& bookStart, int chapterStart, int verseStart,
  99                   const QString& bookEnd,   int chapterEnd,   int verseEnd);
 100
 101     /// Get the name of the module.
 102     virtual QString name() = 0;
 103
 104     /// Get the description of the module.
 105     virtual QString description() = 0;
 106
 107     /// List the books in this module.
 108     const QStringList& books();
 109
 110     /** Get the index of a book from it's name.
 111      * @param name Name of the book to look for.
 112      * @return Index of the book in this module or -1 if it does not exist.
 113      */
 114     int bookIndex(const QString& name);
 115
 116     /// Get the name of a book from it's index.
 117     QString bookName(int book);
 118
 119     /// Get the number of chapters in this book.
 120     virtual int numChapters(int book) = 0;
 121
 122     /// Get the number of verses in a chapter of a book.
 123     virtual int numVerses(int book, int chapter) = 0;
 124
 125     /// Fill a passage object.
 126     bool fillPassage(const Key& key, KwBiblePassage* outPassage);
 127
 128     /// Fill a single verse with data.
 129     virtual bool fillPassageVerse(int bookIndex, int chapterIndex, int verseIndex, KwBiblePassage* outPassage) = 0;
 130
 131     /// Get rendered text for a given passage.
 132     virtual QString renderText(const Key& key) = 0;
 133
 134   protected:
 135
 136     /*
 137      * Protected virtual interface
 138      */
 139
 140     /// Ensure that the book list is up to date.
 141     virtual void obtainBooks();
 142
 143     /*
 144      * Protected interface
 145      */
 146
 147     /// Update the list of books.
 148     void setBooks(const QStringList& books);
 149
 150   private:
 151
 152     /*
 153      * Variables
 154      */
 155
 156     /// List of book names.
 157     QStringList m_books;
 158
 159 };
 160
 161 #endif // _KwBibleModule_h_
 162