DevTools:Code Examples

From CrossWire Bible Society
Revision as of 17:08, 5 December 2009 by Underlined (talk | contribs) (C++)

Jump to: navigation, search

This page was started to provoke developers who know how the SWORD API works to post simple, everyday code examples that anyone can use. By "simple", I mean something that can work within a static function if possible.



Get Modules Example(s)

The following example is for obtaining modules that are installed in the user's SWORD repository. This example also makes slight use of the Qt4 GUI library. The following function takes one parameter, the type of the modules you want to retrieve. Unless stated otherwise, there are up to 4 different types to choose from:

  • "Biblical Texts"
  • "Commentaries"
  • "Lexicons / Dictionaries"
  • "Generic Books"
#include <QStringList>
#include <swmgr.h>
#include <swmodule.h>

QStringList getModules(const char* modType)
		QStringList modules;
		SWMgr library;
		ModMap::iterator it;

		for (it = library.Modules.begin(); it != library.Modules.end(); it++)
			SWModule *module = (*it).second;
			if (!strcmp(module->Type(), modType))
				modules << module->Name();

		return modules;
Example Usage
QStringList bibles = getModules("Biblical Texts");

Note: Map and image modules may potentially employ any of the basic module types (Genbook, LD, Com, or Text). The most consistent way to differentiate between a map or image module and the basic module types is to look for the configuration entry "Feature":

if (QString(module->getConfigEntry("Feature")) == "Images")
	// do something ...

Get Biblical Book Names Example(s)

Obtaining a list of the canonical books of the Bible doesn't necessarily require any SWORD classes (though in the following example we'll be using SWConfig). A default SWORD installation installs the file abbr.conf at /usr/share/sword/locales.d on a Unix-like system (on Windows it may be located at C:\Program Files\CrossWire\The SWORD Project\locales.d). The syntax of the file is the same as any INI file. Therefore we just need to parse the file for the canonical books; so technically any configuration file parser that can parse INI files will do. The section we want to obtain from abbr.conf is called Text. (Again, the example uses a Qt4 class, QStringList.)

Code #1
#include <QStringList>
#include <swconfig.h>

QStringList getBiblicalBooks()
		QStringList books;
		SWConfig config("/usr/share/sword/locales.d/abbr.conf");
		ConfigEntMap::iterator it;
		for (it = config["Text"].begin(); it != config["Text"].end(); it++)
			books << (*it).first.c_str();

		return books;

After obtaining all the Bible book names, you can obtain their abbreviations with SWConfig, again:

SWConfig config("/usr/share/sword/locales.d/abbr.conf");
const char *GenAbbr = config["Text"]["Genesis"];

But, of course, since it's not necessarily safe to assume that you would have an abbr.conf file lying around, the above example isn't necessarily practical. Nevertheless, hopefully, its existence provided some insight on SWConfig. The more proper way to obtain a list of Biblical, canonical book names is through the use of VerseKey. VerseKey has a public member that stores the number of books for each testament—BMAX. BMAX[0] has the number of Old Testament books, and BMAX[1] has the number of New Testament books, which will be useful for use in a for loop.

Code #2
QStringList getBiblicalBooks()
		QStringList books;
		VerseKey vk;
		for (int b = 0; b < 2; b++)
			// Set the Testament number to retrieve book names from that Testament.
			// Add 1 to b since the Testament numbers don't start at 0.
			for (int i = 0; i < vk.BMAX[b]; i++)
				// Add 1 to i since the book numbers don't start at 0.
				books << vk.getBookName();
		return books;

Getting Generic Book Table of Contents

TreeKey is necessary for traversing the generic book's tree. I am going to let the comments and function names speak for themselves here. Assume that module points to a SWModule object.

void getGenBookTOC(sword::TreeKey *tk, Class *parent)
		// if no TreeKey, then obtain one from the module
		if (!tk)
			tk = dynamic_cast<sword::TreeKey*>(module->getKey());

		// Move onto the first child if any
		if (tk->firstChild())
			// Get the first child's information before moving onto the next
				// Retrieve the name so we can use it to get
				//  the GenBook's content later
				QString text = tk->getText();
				// Keep track of the information for custom implementation
				Class *item = storeItemInfoForLaterUse(parent, text);

				// If it has children, dive into it
				if (tk->hasChildren())
					getGenBookTOC(tk, item);
			// Move onto the next child if any
			while (tk->nextSibling());
			// Move up one level in case one of the children had children

How you go about in implementing this is up to you.