kworship/bible/sword/KwBibleModuleSword.cpp

   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 /**
  21  * @file KwBibleModuleSword.cpp
  22  * @brief A SWORD bible module.
  23  * @author James Hogan <james@albanarts.com>
  24  */
  25
  26 #include "KwBibleModuleSword.h"
  27 #include "KwBiblePassage.h"
  28
  29 #include <QStringList>
  30
  31 #include <swmodule.h>
  32 #include <swtext.h>
  33 #include <versekey.h>
  34
  35 /*
  36  * Constructors + destructor
  37  */
  38
  39 /// Default constructor.
  40 KwBibleModuleSword::KwBibleModuleSword(sword::SWText* module)
  41 : KwBibleModule()
  42 , m_module(module)
  43 {
  44   // Get the range of books.
  45   bool oldSCL = module->getSkipConsecutiveLinks();
  46   module->setSkipConsecutiveLinks(true);
  47
  48   {
  49     module->setPosition(sword::TOP);
  50     sword::VerseKey key = module->KeyText();
  51     m_firstBibleBookIndex = testamentBookToBible(key.Testament()-1, key.Book()-1);
  52   }
  53
  54   {
  55     module->setPosition(sword::BOTTOM);
  56     sword::VerseKey key = module->KeyText();
  57     m_lastBibleBookIndex = testamentBookToBible(key.Testament()-1, key.Book()-1);
  58   }
  59
  60   module->setSkipConsecutiveLinks(oldSCL);
  61 }
  62
  63 /// Destructor.
  64 KwBibleModuleSword::~KwBibleModuleSword()
  65 {
  66 }
  67
  68 /*
  69  * Main interface
  70  */
  71
  72 QString KwBibleModuleSword::name()
  73 {
  74   return m_module->Name();
  75 }
  76
  77 QString KwBibleModuleSword::description()
  78 {
  79   return m_module->Description();
  80 }
  81
  82 QString KwBibleModuleSword::managerId()
  83 {
  84   return "SWORD";
  85 }
  86
  87 int KwBibleModuleSword::numChapters(int book)
  88 {
  89   int testamentBook;
  90   int testament = localToTestamentBook(book, &testamentBook);
  91   if (testament >= 0)
  92   {
  93     sword::VerseKey key = m_module->getKey();
  94     key.Testament(1+testament);
  95     key.Book(1+testamentBook);
  96     return key.getChapterMax();
  97   }
  98   return 0;
  99 }
 100
 101 int KwBibleModuleSword::numVerses(int book, int chapter)
 102 {
 103   if (book >= 0 && chapter >= 0)
 104   {
 105     int testamentBook;
 106     int testament = localToTestamentBook(book, &testamentBook);
 107     if (testament >= 0)
 108     {
 109       sword::VerseKey key = m_module->getKey();
 110       key.Testament(1+testament);
 111       key.Book(1+testamentBook);
 112       if (chapter < key.getChapterMax())
 113       {
 114         key.Chapter(1+chapter);
 115         return key.getVerseMax();
 116       }
 117     }
 118   }
 119   return 0;
 120 }
 121
 122 bool KwBibleModuleSword::fillPassageVerse(int bookIndex, int chapterIndex, int verseIndex, KwBiblePassage* outPassage)
 123 {
 124   int bookInTestament = -1;
 125   int testament = localToTestamentBook(bookIndex, &bookInTestament);
 126   if (testament >= 0)
 127   {
 128     sword::VerseKey verse;
 129     verse.Headings(0);
 130     verse.Testament(1+testament);
 131     verse.Book(1+bookInTestament);
 132     verse.Chapter(1+chapterIndex);
 133     verse.Verse(1+verseIndex);
 134
 135     m_module->setKey(&verse);
 136     const char* text = m_module->RenderText();
 137     const char* preverse = m_module->getEntryAttributes()["Heading"]["Preverse"]["0"];
 138     QString headings;
 139     if (preverse[0] != '\0')
 140     {
 141       headings = QString("<h4>%1</h4>").arg(QString::fromUtf8(preverse));
 142     }
 143     outPassage->initVerse(bookIndex, 1+chapterIndex, 1+verseIndex,
 144                           headings,
 145                           QString::fromUtf8(text));
 146     return true;
 147   }
 148   return false;
 149 }
 150
 151 /*
 152  * Protected virtual interface
 153  */
 154
 155 void KwBibleModuleSword::obtainBooks()
 156 {
 157   // List books
 158   QStringList books;
 159   sword::VerseKey key = m_module->getKey();
 160   for (int bibleIndex = m_firstBibleBookIndex; bibleIndex <= m_lastBibleBookIndex; ++bibleIndex)
 161   {
 162     int testamentBook;
 163     int testament = bibleToTestamentBook(bibleIndex, &testamentBook);
 164     Q_ASSERT(testament >= 0);
 165     key.Testament(1+testament);
 166     key.Book(1+testamentBook);
 167     books << QString::fromUtf8(key.getBookName());
 168   }
 169   setBooks(books);
 170 }
 171
 172 /*
 173  * Internal functions
 174  */
 175
 176 /// Convert a local book index to a bible book index.
 177 int KwBibleModuleSword::localToBible(int localIndex) const
 178 {
 179   int result = -1;
 180   if (localIndex >= 0 && m_firstBibleBookIndex + localIndex <= m_lastBibleBookIndex)
 181   {
 182     result = m_firstBibleBookIndex + localIndex;
 183   }
 184   return result;
 185 }
 186
 187 /// Convert a bible book index to a local book index.
 188 int KwBibleModuleSword::bibleToLocal(int bibleIndex) const
 189 {
 190   int result = -1;
 191   if (bibleIndex >= m_firstBibleBookIndex && bibleIndex <= m_lastBibleBookIndex)
 192   {
 193     result = bibleIndex - m_firstBibleBookIndex;
 194   }
 195   return result;
 196 }
 197
 198 /// Convert a testament & book number to a bible book index.
 199 int KwBibleModuleSword::testamentBookToBible(int testament, int book) const
 200 {
 201   if (testament >= 0 && book >= 0)
 202   {
 203     sword::VerseKey key = m_module->getKey();
 204     if (book < key.BMAX[testament])
 205     {
 206       if (testament == 0)
 207       {
 208         return book;
 209       }
 210       else if (testament == 1)
 211       {
 212         return key.BMAX[0] + book;
 213       }
 214     }
 215   }
 216   return -1;
 217 }
 218
 219 /// Convert a bible book index into a testament and book number.
 220 int KwBibleModuleSword::bibleToTestamentBook(int bibleIndex, int* book) const
 221 {
 222   if (bibleIndex >= 0)
 223   {
 224     sword::VerseKey key = m_module->getKey();
 225     // Old testament?
 226     if (bibleIndex < key.BMAX[0])
 227     {
 228       *book = bibleIndex;
 229       return 0;
 230     }
 231     // New testament?
 232     else if (bibleIndex < key.BMAX[0] + key.BMAX[1])
 233     {
 234       *book = bibleIndex - key.BMAX[0];
 235       return 1;
 236     }
 237   }
 238   return -1;
 239 }
 240
 241 /// Convert a testament & book number to a local book index.
 242 int KwBibleModuleSword::testamentBookToLocal(int testament, int book) const
 243 {
 244   return bibleToLocal(testamentBookToBible(testament, book));
 245 }
 246
 247 /// Convert a local book index into a testament and book number.
 248 int KwBibleModuleSword::localToTestamentBook(int localIndex, int* book) const
 249 {
 250   return bibleToTestamentBook(localToBible(localIndex), book);
 251 }
 252