sword Namespace Reference

Title: Keyboard mapping for Michigan-Claremont Hebrew input Description: Copyright: Copyright (c) 2001 CrossWire Bible Society under the terms of the GNU GPL Company:. More...


Classes

class  CipherFilter
class  CURLFTPTransport_init
class  CURLFTPTransport
class  EchoMod
class  EncodingFilterMgr
 This class is like a normal SWMgr, but you can additonally specify which encoding you want to use. More...
class  EntriesBlock
struct  DirEntry
class  FileDesc
 This class represents one file. More...
class  FileMgr
 This class ist used make file access operations easier. More...
class  FTPLibFTPTransport_init
class  FTPLibFTPTransport
class  StatusReporter
 Class for reporting status. More...
class  FTPTransport
 TODO: document A base class to be used for reimplementation of network services. More...
class  GBFFootnotes
 This Filter shows/hides footnotes in a GBF text. More...
class  GBFHeadings
 This Filter shows/hides headings in a GBF text. More...
class  GBFHTML
 this filter converts GBF text to HTML text More...
class  GBFHTMLHREF
 this filter converts GBF text to HTML text with hrefs More...
class  GBFMorph
 This Filter shows/hides morph tags in a GBF text. More...
class  QuoteStack
class  GBFOSIS
 this filter converts GBF text to OSIS text More...
class  GBFPlain
 This filter converts GBF text to plain text. More...
class  GBFRedLetterWords
 This Filter shows/hides "red letter tags" (marking the words of Jesus) in a GBF text. More...
class  GBFRTF
 This filter converts GBF text into RTF text. More...
class  GBFStrongs
 This Filter shows/hides strong's numbers in a GBF text. More...
class  GBFThML
 this filter converts GBF text into ThML text More...
class  GBFWEBIF
 this filter converts GBF text to HTML text with hrefs More...
class  GBFWordJS
 This Filter shows/hides strong's numbers in a GBF text. More...
class  GreekLexAttribs
 this filter converts ThML text to plain text More...
class  HebrewMCIM
class  HREFCom
class  InstallSource
 TODO: document. More...
class  InstallMgr
 TODO: document. More...
class  Latin1UTF16
 This filter converts Latin-1 encoded text to UTF-16. More...
class  Latin1UTF8
 This filter converts Latin-1 encoded text to UTF-8. More...
class  ListKey
 ListKey is the basis for all types of keys that have lists of specified indexes (e.g. More...
class  LocaleMgr
 The LocaleMgr class handles all the different locales of Sword. More...
class  LZSSCompress
class  MarkupFilterMgr
 This class is like a normal SWEncodingMgr, but you can additonally specify which markup you want to use. More...
class  multimapwithdefault
class  NullIM
class  OSISFootnotes
 This Filter shows/hides headings in a OSIS text. More...
class  OSISHeadings
 This Filter shows/hides headings in a OSIS text. More...
class  OSISHTMLHREF
 this filter converts OSIS text to HTML text with hrefs More...
class  OSISLemma
 This Filter shows/hides headings in a OSIS text. More...
class  OSISMorph
 This Filter shows/hides morph tags in a OSIS text. More...
class  OSISMorphSegmentation
class  OSISOSIS
 this filter converts internal OSIS text to public OSIS text More...
class  OSISPlain
 this filter converts OSIS text to plain text More...
class  OSISRedLetterWords
 This Filter shows/hides headings in a OSIS text. More...
class  OSISRTF
 this filter converts OSIS text to RTF text More...
class  OSISScripref
 This Filter shows/hides headings in a OSIS text. More...
class  OSISStrongs
 This Filter shows/hides strong's numbers in a OSIS text. More...
class  OSISVariants
 This Filter shows/hides textual variants. More...
class  OSISWEBIF
 this filter converts OSIS text to HTML text with hrefs More...
class  OSISWordJS
 This Filter shows/hides strong's numbers in a OSIS text. More...
class  PapyriPlain
 This filter converts Papyri text to plain text. More...
class  PLAINFootnotes
 Shows or hides footnotes in plain text. More...
class  PLAINHTML
 this filter converts plain text to HTML text More...
class  RawCom
class  RawFiles
class  RawGenBook
class  RawLD
class  RawLD4
class  RawStr
class  RawStr4
class  RawText
class  RawVerse
class  RTFHTML
 this filter converts RTF text into HTML text More...
class  sapphire
class  SCSUUTF8
 This filter converts SCSU compressed (encoded) text to UTF-8. More...
class  StringMgr
 StringMgr is a way to provide UTf8 handling by the Sword frontend Each platform, if it's up-to-date, should provide functions to handle unicode and utf8. More...
class  StrKey
 a standard string key class (used for modules that index on single strings (eg. More...
class  BasicFilterUserData
class  SWBasicFilter
 A filter providing commonly used functionality. More...
class  SWBuf
 This class is used as a transport and utility for data buffers. More...
class  SWCacher
 used to provide an interface for objects that cache and want a standard interface for cleaning up. More...
class  SWCipher
class  SWCom
 The basis for all commentary modules. More...
class  SWCompress
class  SWConfig
 The class to read and save settings using a file on disk. More...
class  SWDisplay
 swdisp is the basis for all types of displays (e.g. More...
class  SWFilter
 Base class for all filters in sword. More...
class  SWFilterMgr
 Class to manage different kinds of filters. More...
class  SWGenBook
 The basis for all Book modules. More...
class  SWInputMethod
class  SW_POSITION
 For use with = operator to position key. More...
class  SWKey
 SWKey is used for positioning an SWModule to a specific entry. More...
class  SWLD
 the basis for all types of Lexicon and Dictionary modules (hence the 'LD'). More...
class  SWLocale
 SWLocale is used for the localisation of the booknames The SWLocale is a class which holds the information of one language. More...
class  SWLog
class  SWMgr
 SWMgr exposes an installed module set. More...
class  SWModule
 The class SWModule is the base class for all modules used in Sword. More...
class  SWClass
 Class used for SWDYNAMIC_CAST to save the inheritance order. More...
class  SWObject
 Base class for major Sword classes. More...
class  SWOptionFilter
 Base class for all option filters. More...
class  SWSearchable
 used to provide an interface for objects that be searched. More...
class  SWText
 The basis for all text modules. More...
class  SWVersion
 A basic tool class to handle program version numbers. More...
class  TEIPlain
 this filter converts TEI text to plain text More...
class  TEIRTF
 this filter converts TEI text to RTF text More...
class  ThMLFootnotes
 This Filter shows/hides footnotes in a ThML text. More...
class  ThMLGBF
 this filter converts ThML text to GBF text More...
class  ThMLHeadings
 This Filter shows/hides headings in a ThML text. More...
class  ThMLHTML
 this filter converts ThML text to HTML text More...
class  ThMLHTMLHREF
 this filter converts ThML text to HTML text with hrefs More...
class  ThMLLemma
 This Filter shows/hides lemmas in a ThML text. More...
class  ThMLMorph
 This Filter shows/hides morph tags in a ThML text. More...
class  ThMLOSIS
 this filter converts ThML text to OSIS text More...
class  ThMLPlain
 this filter converts ThML text to plain text More...
class  ThMLRTF
 this filter converts ThML text to RTF text More...
class  ThMLScripref
 This Filter shows/hides scripture references in a ThML text. More...
class  ThMLStrongs
 This Filter shows/hides strong's numbers in a ThML text. More...
class  ThMLVariants
 This Filter shows/hides textual variants. More...
class  ThMLWEBIF
 this filter converts ThML text to HTML text with hrefs More...
class  ThMLWordJS
 This Filter shows/hides strong's numbers in a ThML text. More...
class  TreeKey
 Class TreeKey The base class for all tree-based key implementations in Sword. More...
class  TreeKeyIdx
 Class TreeKeyIdx The TreeKey implementation used for all tree-based modules in Sword, such as GenBooks. More...
class  UnicodeRTF
 This filter converts UTF-8 text into RTF Unicode tags. More...
class  URL
 URL provides URL parsing The URL class provides an interface to work on the data of an URL like "http://www.crosswire.org/index.jsp?page=test&user=nobody". More...
class  UTF16UTF8
 This filter converts UTF-16 encoded text to UTF-8. More...
class  UTF8arShaping
 This Filter controls the arabic shaping of UTF-8 text FIXME: is that correct? how to control it? More...
class  UTF8BiDiReorder
 This Filter reorders UTF-8 text according to Unicode BiDi. More...
class  UTF8Cantillation
 This Filter shows/hides Hebrew cantillation marks in UTF8 text. More...
class  UTF8GreekAccents
 This Filter shows/hides Greek Accents marks in UTF8 text. More...
class  UTF8HebrewPoints
 This Filter shows/hides Hebrew vowel points in UTF8 text. More...
class  UTF8HTML
 This filter converts UTF-8 text into HTML escape sequences. More...
class  UTF8Latin1
 This filter converts UTF-8 encoded text to Latin-1. More...
class  UTF8NFC
class  UTF8NFKD
struct  SWTransData
class  UTF8Transliterator
 This Filter uses ICU for transliteration. More...
class  UTF8UTF16
 This filter converts UTF-8 encoded text to UTF-16. More...
class  XMLTag
 Simple XML helper class. More...
struct  sbook
struct  abbrev
class  VerseKey
 Class VerseKey The SWKey implementation used for verse based modules like Bibles or commentaries. More...
class  VerseTreeKey
 Class VerseKey The SWKey implementation used for verse based modules like Bibles or commentaries. More...
class  zCom
class  ZipCompress
class  zLD
class  zStr
class  zText
class  zVerse

Typedefs

typedef std::map< SWBuf, InstallSource * > InstallSourceMap
typedef std::list< SWBufStringList
typedef std::map< SWBuf, SWLocale *,
std::less< SWBuf > > 
LocaleMap
typedef multimapwithdefault<
SWBuf, SWBuf, std::less<
SWBuf > > 
ConfigEntMap
typedef std::map< SWBuf, ConfigEntMap,
std::less< SWBuf > > 
SectionMap
typedef std::map< SWBuf, SWModule *,
std::less< SWBuf > > 
ModMap
typedef std::map< SWBuf, SWFilter * > FilterMap
typedef std::map< SWBuf, SWOptionFilter * > OptionFilterMap
typedef std::list< SWBufStringList
typedef std::list< SWFilter * > FilterList
typedef std::list< SWOptionFilter * > OptionFilterList
typedef std::list< SWFilter * > FilterList
typedef std::list< SWOptionFilter * > OptionFilterList
typedef std::map< SWBuf, SWBuf,
std::less< SWBuf > > 
AttributeValue
typedef std::map< SWBuf, AttributeValue,
std::less< SWBuf > > 
AttributeList
typedef std::map< SWBuf, AttributeList,
std::less< SWBuf > > 
AttributeTypeList
typedef std::list< SWBufStringList
 The type definitoin for option types.
typedef std::map< const UnicodeString,
SWTransData
SWTransMap
typedef std::pair< UnicodeString,
SWTransData
SWTransPair
typedef std::map< SWBuf, SWBufStringPairMap
typedef std::list< SWBufStringList

Enumerations

enum  { DIRECTION_LTR = 0, DIRECTION_RTL, DIRECTION_BIDI }
enum  {
  FMT_UNKNOWN = 0, FMT_PLAIN, FMT_THML, FMT_GBF,
  FMT_HTML, FMT_HTMLHREF, FMT_RTF, FMT_OSIS,
  FMT_WEBIF, FMT_TEI
}
enum  {
  ENC_UNKNOWN = 0, ENC_LATIN1, ENC_UTF8, ENC_SCSU,
  ENC_UTF16, ENC_RTF, ENC_HTML
}
enum  bGreekChars {
  ALPHA = 65, BETA, CHI, DELTA,
  EPSILON, PHI, GAMMA, ETA,
  IOTA, KAPPA = 75, LAMBDA, MU,
  NU, OMICRON, PI, THETA,
  RHO, SIGMA, TAU, UPSILON,
  OMEGA = 'W', XI, PSI, ZETA,
  ROUGH = 104, IOTA_SUB
}
enum  GreekFontChars {
  gALPHA = 'a', gBETA, gCHI, gDELTA,
  gEPSILON, gPHI, gGAMMA, gETA,
  gIOTA, gSIGMA_END, gKAPPA, gLAMBDA,
  gMU, gNU, gOMICRON, gPI,
  gTHETA, gRHO, gSIGMA, gTAU,
  gUPSILON, gOMEGA = 'w', gXI, gPSI,
  gZETA, gROUGH_ALPHA = 161, gROUGH_EPSILON = 152, gROUGH_ETA = 185,
  gROUGH_IOTA = 131, gROUGH_OMICRON = 208, gROUGH_RHO = 183, gROUGH_UPSILON = 216,
  gROUGH_OMEGA = 230, gIOTA_ALPHA = 'v', gIOTA_ETA = 'V', gIOTA_OMEGA = 'J',
  gNON_ROUGH_ALPHA = 162, gNON_ROUGH_EPSILON = 153, gNON_ROUGH_ETA = 186, gNON_ROUGH_IOTA = 132,
  gNON_ROUGH_OMICRON = 209, gNON_ROUGH_RHO = 184, gNON_ROUGH_UPSILON = 217, gNON_ROUGH_OMEGA = 231
}
enum  bGreekPunct { COMMA = ',', STOP = '.', SEMI_COLON = ';', QUESTION = '?' }
enum  GreekPunct { gCOMMA = ',', gSTOP = '.', gSEMI_COLON = ':', gQUESTION = ';' }

Functions

unsigned char Greek2bGreek (unsigned char *sResult, unsigned char *sGreekText, int nMaxResultBuflen)
unsigned char bGreek2Greek (unsigned char *sResult, unsigned char *sGreekText, int nMaxResultBuflen)
int ParseGreek (unsigned char *sResult, unsigned char *sGreekText, int nMaxResultBuflen)
int ParsebGreek (unsigned char *sResult, unsigned char *sGreekText, int nMaxResultBuflen)
unsigned char char2Font (unsigned char letter, bool finalSigma, bool iota, bool breathing, bool rough)
unsigned char Font2char (unsigned char letter, bool &iota, bool &breathing, bool &rough)
bool getSpecialChar (unsigned char Font, unsigned char &letter)
bool SpecialGreek (unsigned char Font)
unsigned char getGreekPunct (unsigned char bGreek)
unsigned char getbGreekPunct (unsigned char Greek)
bool isPunctSpace (unsigned char c)
char isroman (const char *)
 Checks if a string is a roman numeral.
int from_rom (const char *s)
 Converts a roman numeral to a string.
char * toupperstr (char *t, unsigned int max=0)
char * toupperstr_utf8 (char *t, unsigned int max=0)
SWBuftoupperstr (SWBuf &b)
unsigned char * UTF32to8 (unsigned long utf32, unsigned char *utf8)
 Converts a 32-bit unsigned integer UTF-32 value into a UTF-8 encoded 1-6 byte array.
unsigned long UTF8to32 (unsigned char *utf8, unsigned long utf32)
 Converts a UTF-8 encoded 1-6 byte array into a 32-bit unsigned integer UTF-32 value.
char * stdstr (char **iistr, const char *istr, unsigned int memPadFactor=1)
 stdstr - clone a string
char * strstrip (char *istr)
const char * stristr (const char *s1, const char *s2)
int strnicmp (const char *s1, const char *s2, int len)
int stricmp (const char *s1, const char *s2)

Variables

static const int ENDOFABBREVS = -2
const unsigned char SW_toupper_array [256]


Detailed Description

Title: Keyboard mapping for Michigan-Claremont Hebrew input Description: Copyright: Copyright (c) 2001 CrossWire Bible Society under the terms of the GNU GPL Company:.

Author:
Troy A. Griffitts
Version:
1.0


Function Documentation

int sword::from_rom ( const char *  s  ) 

Converts a roman numeral to a string.

Parameters:
s Roman numeral to convert.

unsigned char* sword::UTF32to8 ( unsigned long  utf32,
unsigned char *  utf8 
)

Converts a 32-bit unsigned integer UTF-32 value into a UTF-8 encoded 1-6 byte array.

Parameters:
utf32 the UTF-32 Unicode code point value
utf8 pointer to an array of 6 unsigned chars to contain the UTF-8 value
Returns:
utf8

unsigned long sword::UTF8to32 ( unsigned char *  utf8,
unsigned long  utf32 
)

Converts a UTF-8 encoded 1-6 byte array into a 32-bit unsigned integer UTF-32 value.

Parameters:
utf8 pointer to an array of 6 unsigned chars containing the UTF-8 value, starting in the utf8[0]
utf32 the UTF-32 Unicode code point value
Returns:
utf32