diff options
Diffstat (limited to 'doc/api-documentation/man/man3/SWModule.3')
| -rw-r--r-- | doc/api-documentation/man/man3/SWModule.3 | 1131 |
1 files changed, 1131 insertions, 0 deletions
diff --git a/doc/api-documentation/man/man3/SWModule.3 b/doc/api-documentation/man/man3/SWModule.3 new file mode 100644 index 0000000..65580e3 --- /dev/null +++ b/doc/api-documentation/man/man3/SWModule.3 @@ -0,0 +1,1131 @@ +.TH "SWModule" 3 "22 Jan 2002" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +SWModule \- The class SWModule is the base class for all modules used in Sword. +.SH SYNOPSIS +.br +.PP +\fC#include <swmodule.h>\fP +.PP +Inherited by \fBSWCom\fP, \fBSWLD\fP, and \fBSWText\fP. +.PP +.SS "Public Methods" + +.in +1c +.ti -1c +.RI "\fBSWModule\fP (const char *imodname=0, const char *imoddesc=0, \fBSWDisplay\fP *idisp=0, char *imodtype=0, SWTextEncoding encoding=ENC_UNKNOWN, SWTextDirection dir=DIRECTION_LTR, SWTextMarkup markup=FMT_UNKNOWN, const char *modlang=0)" +.br +.RI "\fIInitializes data for instance of SWModule.\fP" +.ti -1c +.RI "virtual \fB~SWModule\fP ()" +.br +.RI "\fICleans up instance of SWModule.\fP" +.ti -1c +.RI "virtual char \fBError\fP ()" +.br +.RI "\fIGets and clears error status.\fP" +.ti -1c +.RI "virtual const bool \fBisUnicode\fP () const" +.br +.ti -1c +.RI "virtual const int \fBgetEntrySize\fP () const" +.br +.ti -1c +.RI "virtual char \fBSetKey\fP (const \fBSWKey\fP *ikey)" +.br +.RI "\fISets a key to this module for position to a particular record or set of records.\fP" +.ti -1c +.RI "virtual char \fBSetKey\fP (const \fBSWKey\fP &ikey)" +.br +.RI "\fISets the key of this module.\fP" +.ti -1c +.RI "virtual \fBSWKey\fP & \fBKey\fP () const" +.br +.RI "\fIGets the current module key.\fP" +.ti -1c +.RI "virtual char \fBKey\fP (const \fBSWKey\fP &ikey)" +.br +.RI "\fISets the current key of the module to ikey, and returns the keytext.\fP" +.ti -1c +.RI "virtual const char * \fBKeyText\fP (const char *imodtype=0)" +.br +.RI "\fISets/gets module KeyText.\fP" +.ti -1c +.RI "virtual char \fBDisplay\fP ()" +.br +.RI "\fICalls this modules display object and passes itself.\fP" +.ti -1c +.RI "virtual \fBSWDisplay\fP * \fBDisp\fP (\fBSWDisplay\fP *idisp=0)" +.br +.RI "\fISets/gets display driver.\fP" +.ti -1c +.RI "virtual char * \fBName\fP (const char *imodname=0)" +.br +.RI "\fISets/gets module name.\fP" +.ti -1c +.RI "virtual char * \fBDescription\fP (const char *imoddesc=0)" +.br +.RI "\fISets/gets module description.\fP" +.ti -1c +.RI "virtual char * \fBType\fP (const char *imodtype=0)" +.br +.RI "\fISets/gets module type.\fP" +.ti -1c +.RI "virtual char \fBDirection\fP (signed char newdir=-1)" +.br +.RI "\fISets/gets module direction.\fP" +.ti -1c +.RI "virtual char \fBEncoding\fP (signed char enc=-1)" +.br +.RI "\fISets/gets module encoding.\fP" +.ti -1c +.RI "virtual char \fBMarkup\fP (signed char enc=-1)" +.br +.RI "\fISets/gets module markup.\fP" +.ti -1c +.RI "virtual char * \fBLang\fP (const char *imodlang=0)" +.br +.RI "\fISets/gets module language.\fP" +.ti -1c +.RI "virtual \fBListKey\fP & \fBSearch\fP (const char *istr, int searchType=0, int flags=0, \fBSWKey\fP *scope=0, bool *justCheckIfSupported=0, void(*percent)(char, void *)=&nullPercent, void *percentUserData=0)" +.br +.RI "\fISearches a module for a string.\fP" +.ti -1c +.RI "virtual signed char \fBcreateSearchFramework\fP ()" +.br +.ti -1c +.RI "virtual bool \fBhasSearchFramework\fP ()" +.br +.ti -1c +.RI "virtual bool \fBisSearchOptimallySupported\fP (const char *istr, int searchType, int flags, \fBSWKey\fP *scope)" +.br +.RI "\fICheck if the search is optimally supported (e.g.\fP" +.ti -1c +.RI "virtual \fBSWKey\fP * \fBCreateKey\fP ()" +.br +.RI "\fIAllocates a key of specific type for module The different reimplementatiosn of SWModule (e.g.\fP" +.ti -1c +.RI "virtual \fBoperator char *\fP ()" +.br +.RI "\fIRenders and returns the current module text.\fP" +.ti -1c +.RI "virtual char * \fBgetRawEntry\fP ()=0" +.br +.RI "\fIThis function is reimplemented by the different kinds of module objects.\fP" +.ti -1c +.RI "virtual \fBoperator SWKey &\fP ()" +.br +.RI "\fICast operator to cast to a \fBSWKey\fP reference.\fP" +.ti -1c +.RI "virtual \fBoperator SWKey *\fP ()" +.br +.RI "\fIOperator to cast to an \fBSWKey\fP pointer.\fP" +.ti -1c +.RI "virtual bool \fBisWritable\fP ()" +.br +.RI "\fIIs the module writable? :).\fP" +.ti -1c +.RI "virtual SWModule & \fBsetentry\fP (const char *inbuf, long len)" +.br +.RI "\fIModify the current module entry text only if module \fBisWritable\fP.\fP" +.ti -1c +.RI "virtual SWModule & \fBoperator<<\fP (const char *)" +.br +.RI "\fIModify the current module entry text only if module \fBisWritable\fP.\fP" +.ti -1c +.RI "virtual SWModule & \fBoperator<<\fP (const \fBSWKey\fP *)" +.br +.RI "\fILink the current module entry to another module entry only if module \fBisWritable\fP.\fP" +.ti -1c +.RI "virtual void \fBdeleteEntry\fP ()" +.br +.RI "\fIDelete current module entry - only if module \fBisWritable\fP.\fP" +.ti -1c +.RI "virtual SWModule & \fBoperator-=\fP (int decrement)" +.br +.RI "\fIDecrements module key a number of entries.\fP" +.ti -1c +.RI "virtual SWModule & \fBoperator+=\fP (int increment)" +.br +.RI "\fIIncrements module key a number of entries.\fP" +.ti -1c +.RI "virtual SWModule & \fBoperator++\fP (int)" +.br +.RI "\fIIncrements module key by 1 entry.\fP" +.ti -1c +.RI "virtual SWModule & \fBoperator--\fP (int)" +.br +.RI "\fIDecrements module key by 1 entry.\fP" +.ti -1c +.RI "virtual SWModule & \fBoperator=\fP (SW_POSITION p)" +.br +.RI "\fIPositions this modules to an entry.\fP" +.ti -1c +.RI "virtual SWModule & \fBAddRenderFilter\fP (SWFilter *newfilter)" +.br +.RI "\fIAdds a RenderFilter to this module's.\fP" +.ti -1c +.RI "virtual SWModule & \fBRemoveRenderFilter\fP (SWFilter *oldfilter)" +.br +.RI "\fIRemoves a RenderFilter from this module's.\fP" +.ti -1c +.RI "virtual SWModule & \fBReplaceRenderFilter\fP (SWFilter *oldfilter, SWFilter *newfilter)" +.br +.RI "\fIReplaces a RenderFilter in this module's.\fP" +.ti -1c +.RI "virtual void \fBrenderFilter\fP (char *buf, long size, \fBSWKey\fP *\fBkey\fP)" +.br +.RI "\fIRenderFilter a text buffer.\fP" +.ti -1c +.RI "virtual SWModule & \fBAddEncodingFilter\fP (SWFilter *newfilter)" +.br +.RI "\fIAdds an EncodingFilter to this module's.\fP" +.ti -1c +.RI "virtual SWModule & \fBRemoveEncodingFilter\fP (SWFilter *oldfilter)" +.br +.RI "\fIRemoves an EncodingFilter from this module's.\fP" +.ti -1c +.RI "virtual SWModule & \fBReplaceEncodingFilter\fP (SWFilter *oldfilter, SWFilter *newfilter)" +.br +.RI "\fIReplaces an EncodingFilter in this module's.\fP" +.ti -1c +.RI "virtual void \fBencodingFilter\fP (char *buf, long size, \fBSWKey\fP *\fBkey\fP)" +.br +.RI "\fIencodingFilter a text buffer.\fP" +.ti -1c +.RI "virtual SWModule & \fBAddStripFilter\fP (SWFilter *newfilter)" +.br +.RI "\fIAdds a StripFilter to this module's stripfilters queue.\fP" +.ti -1c +.RI "virtual void \fBstripFilter\fP (char *buf, long size, \fBSWKey\fP *\fBkey\fP)" +.br +.RI "\fIStripFilter a text buffer.\fP" +.ti -1c +.RI "virtual SWModule & \fBAddRawFilter\fP (SWFilter *newfilter)" +.br +.RI "\fIAdds a RawFilter to this module's rawfilters queue.\fP" +.ti -1c +.RI "virtual void \fBfilterBuffer\fP (FilterList *filters, char *buf, long size, \fBSWKey\fP *\fBkey\fP)" +.br +.RI "\fIFilterBuffer a text buffer.\fP" +.ti -1c +.RI "virtual void \fBrawFilter\fP (char *buf, long size, \fBSWKey\fP *\fBkey\fP)" +.br +.RI "\fIRawFilter a text buffer.\fP" +.ti -1c +.RI "virtual SWModule & \fBAddOptionFilter\fP (SWFilter *newfilter)" +.br +.RI "\fIAdds an OptionFilter to this module's optionfilters queue.\fP" +.ti -1c +.RI "virtual void \fBoptionFilter\fP (char *buf, long size, \fBSWKey\fP *\fBkey\fP)" +.br +.RI "\fIOptionFilter a text buffer.\fP" +.ti -1c +.RI "virtual const char * \fBStripText\fP (char *buf=0, int len=-1)" +.br +.RI "\fIcalls all StripFilters on buffer or current text.\fP" +.ti -1c +.RI "virtual const char * \fBRenderText\fP (char *buf=0, int len=-1)" +.br +.RI "\fIcalls all RenderFilters on buffer or current text.\fP" +.ti -1c +.RI "virtual const char * \fBStripText\fP (\fBSWKey\fP *tmpKey)" +.br +.RI "\fIcalls all StripFilters on current text.\fP" +.ti -1c +.RI "virtual const char * \fBRenderText\fP (\fBSWKey\fP *tmpKey)" +.br +.RI "\fIcalls all RenderFilters on current text.\fP" +.in -1c +.SS "Static Public Methods" + +.in +1c +.ti -1c +.RI "void \fBnullPercent\fP (char percent, void *userData)" +.br +.RI "\fIThis is the default callback function for searching.\fP" +.ti -1c +.RI "signed char \fBcreateModule\fP (const char *)" +.br +.RI "\fICreates a new module.\fP" +.in -1c +.SS "Public Attributes" + +.in +1c +.ti -1c +.RI "bool \fBterminateSearch\fP" +.br +.RI "\fISet this bool to false to terminate the search which is executed by this module (\fBSearch\fP).\fP" +.in -1c +.SS "Protected Attributes" + +.in +1c +.ti -1c +.RI "char \fBerror\fP" +.br +.ti -1c +.RI "\fBSWKey\fP * \fBkey\fP" +.br +.RI "\fIthe current key.\fP" +.ti -1c +.RI "\fBListKey\fP \fBlistkey\fP" +.br +.ti -1c +.RI "char * \fBmodname\fP" +.br +.ti -1c +.RI "char * \fBmoddesc\fP" +.br +.ti -1c +.RI "char * \fBmodtype\fP" +.br +.ti -1c +.RI "char * \fBmodlang\fP" +.br +.ti -1c +.RI "char \fBdirection\fP" +.br +.ti -1c +.RI "char \fBmarkup\fP" +.br +.ti -1c +.RI "char \fBencoding\fP" +.br +.ti -1c +.RI "\fBSWDisplay\fP * \fBdisp\fP" +.br +.RI "\fIthis module's display object.\fP" +.ti -1c +.RI "char * \fBentrybuf\fP" +.br +.ti -1c +.RI "FilterList * \fBstripFilters\fP" +.br +.RI "\fIexecuted to remove all markup (for searches).\fP" +.ti -1c +.RI "FilterList * \fBrawFilters\fP" +.br +.RI "\fIexecuted immediately upon fileread.\fP" +.ti -1c +.RI "FilterList * \fBrenderFilters\fP" +.br +.RI "\fIexecuted to format for display.\fP" +.ti -1c +.RI "FilterList * \fBoptionFilters\fP" +.br +.RI "\fIexecuted to change markup to user prefs.\fP" +.ti -1c +.RI "FilterList * \fBencodingFilters\fP" +.br +.RI "\fIexecuted to decode text for display.\fP" +.ti -1c +.RI "bool \fBrender\fP" +.br +.ti -1c +.RI "int \fBentrySize\fP" +.br +.in -1c +.SS "Static Protected Attributes" + +.in +1c +.ti -1c +.RI "\fBSWDisplay\fP \fBrawdisp\fP" +.br +.in -1c +.SH "DETAILED DESCRIPTION" +.PP +The class SWModule is the base class for all modules used in Sword. +.PP +It provides functions to look up a text passage, to search in the module, to switch on/off the state of optional things like Strong's numbers or footnotes. +.PP +SWModule has also functions to write to the data files. This might be useful in future for frontend authors to support user-created modules. +.PP +Definition at line 57 of file swmodule.h. +.SH "CONSTRUCTOR & DESTRUCTOR DOCUMENTATION" +.PP +.SS "SWModule::SWModule (const char * imodname = 0, const char * imoddesc = 0, \fBSWDisplay\fP * idisp = 0, char * imodtype = 0, SWTextEncoding encoding = ENC_UNKNOWN, SWTextDirection dir = DIRECTION_LTR, SWTextMarkup markup = FMT_UNKNOWN, const char * modlang = 0)" +.PP +Initializes data for instance of SWModule. +.PP +Parameters: +.in +1c +.TP +\fB\fIimodname\fP\fP +Internal name for module; see also \fBName\fP +.TP +\fB\fIimoddesc\fP\fP +Name to display to user for module; see also \fBDescription\fP +.TP +\fB\fIidisp\fP\fP +Display object to use for displaying see also \fBDisp\fP +.TP +\fB\fIimodtype\fP\fP +Type of Module (All modules will be displayed with others of same type under their modtype heading) see also \fBType\fP +.SH "MEMBER FUNCTION DOCUMENTATION" +.PP +.SS "virtual SWModule& SWModule::AddEncodingFilter (SWFilter * newfilter)\fC [inline, virtual]\fP" +.PP +Adds an EncodingFilter to this module's. +.PP +\fBSee also: \fP +.in +1c +encodingfilters queue +.PP +Parameters: +.in +1c +.TP +\fB\fInewfilter\fP\fP +the filter to add +.PP +\fBReturns: \fP +.in +1c +*this +.PP +Definition at line 430 of file swmodule.h. +.SS "virtual SWModule& SWModule::AddOptionFilter (SWFilter * newfilter)\fC [inline, virtual]\fP" +.PP +Adds an OptionFilter to this module's optionfilters queue. +.PP +Parameters: +.in +1c +.TP +\fB\fInewfilter\fP\fP +the filter to add +.PP +\fBReturns: \fP +.in +1c +*this +.PP +Definition at line 515 of file swmodule.h. +.SS "virtual SWModule& SWModule::AddRawFilter (SWFilter * newfilter)\fC [inline, virtual]\fP" +.PP +Adds a RawFilter to this module's rawfilters queue. +.PP +Parameters: +.in +1c +.TP +\fB\fInewfilter\fP\fP +the filter to add +.PP +\fBReturns: \fP +.in +1c +*this +.PP +Definition at line 484 of file swmodule.h. +.SS "virtual SWModule& SWModule::AddRenderFilter (SWFilter * newfilter)\fC [inline, virtual]\fP" +.PP +Adds a RenderFilter to this module's. +.PP +\fBSee also: \fP +.in +1c +renderfilters queue +.PP +Parameters: +.in +1c +.TP +\fB\fInewfilter\fP\fP +the filter to add +.PP +\fBReturns: \fP +.in +1c +*this +.PP +Definition at line 393 of file swmodule.h. +.SS "virtual SWModule& SWModule::AddStripFilter (SWFilter * newfilter)\fC [inline, virtual]\fP" +.PP +Adds a StripFilter to this module's stripfilters queue. +.PP +Parameters: +.in +1c +.TP +\fB\fInewfilter\fP\fP +the filter to add +.PP +\fBReturns: \fP +.in +1c +*this +.PP +Definition at line 467 of file swmodule.h. +.SS "virtual \fBSWKey\fP* SWModule::CreateKey ()\fC [virtual]\fP" +.PP +Allocates a key of specific type for module The different reimplementatiosn of SWModule (e.g. +.PP +\fBSWText\fP) support \fBSWKey\fP implementations, which support special. This functions returns a \fBSWKey\fP object which works with the current implementation of SWModule. For example for the \fBSWText\fP class it returns a \fBVerseKey\fP object. +.PP +\fBSee also: \fP +.in +1c +\fBVerseKey\fP, \fBListKey\fP, \fBSWText\fP, \fBSWLD\fP, \fBSWCom\fP +.PP +\fBReturns: \fP +.in +1c +pointer to allocated key +.PP +Reimplemented in \fBSWCom\fP, \fBSWLD\fP, and \fBSWText\fP. +.SS "virtual char* SWModule::Description (const char * imoddesc = 0)\fC [virtual]\fP" +.PP +Sets/gets module description. +.PP +Parameters: +.in +1c +.TP +\fB\fIimoddesc\fP\fP +value which to set moddesc; [0] - only get +.PP +\fBReturns: \fP +.in +1c +pointer to moddesc +.SS "virtual char SWModule::Direction (signed char newdir = -1)\fC [virtual]\fP" +.PP +Sets/gets module direction. +.PP +Parameters: +.in +1c +.TP +\fB\fInewdir\fP\fP +value which to set direction; [-1] - only get +.PP +\fBReturns: \fP +.in +1c +char direction +.SS "virtual \fBSWDisplay\fP* SWModule::Disp (\fBSWDisplay\fP * idisp = 0)\fC [virtual]\fP" +.PP +Sets/gets display driver. +.PP +Parameters: +.in +1c +.TP +\fB\fIidisp\fP\fP +value which to set disp; [0] - only get +.PP +\fBReturns: \fP +.in +1c +pointer to disp +.SS "virtual char SWModule::Display ()\fC [virtual]\fP" +.PP +Calls this modules display object and passes itself. +.PP +\fBReturns: \fP +.in +1c +error status +.SS "virtual char SWModule::Encoding (signed char enc = -1)\fC [virtual]\fP" +.PP +Sets/gets module encoding. +.PP +Parameters: +.in +1c +.TP +\fB\fInewdir\fP\fP +value which to set encoding; [-1] - only get +.PP +\fBReturns: \fP +.in +1c +char encoding +.SS "virtual char SWModule::Error ()\fC [virtual]\fP" +.PP +Gets and clears error status. +.PP +\fBReturns: \fP +.in +1c +error status +.SS "virtual char SWModule::Key (const \fBSWKey\fP & ikey)\fC [inline, virtual]\fP" +.PP +Sets the current key of the module to ikey, and returns the keytext. +.PP +Parameters: +.in +1c +.TP +\fB\fIikey\fP\fP +new current key for the module +.PP +\fBReturns: \fP +.in +1c +the keytext of the current module key +.PP +Definition at line 168 of file swmodule.h. +.SS "virtual \fBSWKey\fP& SWModule::Key () const\fC [inline, virtual]\fP" +.PP +Gets the current module key. +.PP +\fBReturns: \fP +.in +1c +the current key of this module +.PP +Definition at line 159 of file swmodule.h. +.SS "virtual const char* SWModule::KeyText (const char * ikeytext = 0)\fC [virtual]\fP" +.PP +Sets/gets module KeyText. +.PP +Parameters: +.in +1c +.TP +\fB\fIikeytext\fP\fP +value which to set keytext; [0] - only get +.PP +\fBReturns: \fP +.in +1c +pointer to keytext +.PP +Reimplemented in \fBSWLD\fP. +.SS "virtual char* SWModule::Lang (const char * imodlang = 0)\fC [virtual]\fP" +.PP +Sets/gets module language. +.PP +Parameters: +.in +1c +.TP +\fB\fIimodlang\fP\fP +value which to set modlang; [0] - only get +.PP +\fBReturns: \fP +.in +1c +pointer to modlang +.SS "virtual char SWModule::Markup (signed char enc = -1)\fC [virtual]\fP" +.PP +Sets/gets module markup. +.PP +Parameters: +.in +1c +.TP +\fB\fInewdir\fP\fP +value which to set markup; [-1] - only get +.PP +\fBReturns: \fP +.in +1c +char markup +.SS "virtual char* SWModule::Name (const char * imodname = 0)\fC [virtual]\fP" +.PP +Sets/gets module name. +.PP +Parameters: +.in +1c +.TP +\fB\fIimodname\fP\fP +value which to set modname; [0] - only get +.PP +\fBReturns: \fP +.in +1c +pointer to modname +.SS "virtual SWModule& SWModule::RemoveEncodingFilter (SWFilter * oldfilter)\fC [inline, virtual]\fP" +.PP +Removes an EncodingFilter from this module's. +.PP +\fBSee also: \fP +.in +1c +encodingfilters queue +.PP +Parameters: +.in +1c +.TP +\fB\fIoldfilter\fP\fP +the filter to remove +.PP +\fBReturns: \fP +.in +1c +*this +.PP +Definition at line 438 of file swmodule.h. +.SS "virtual SWModule& SWModule::RemoveRenderFilter (SWFilter * oldfilter)\fC [inline, virtual]\fP" +.PP +Removes a RenderFilter from this module's. +.PP +\fBSee also: \fP +.in +1c +renderfilters queue +.PP +Parameters: +.in +1c +.TP +\fB\fIoldfilter\fP\fP +the filter to remove +.PP +\fBReturns: \fP +.in +1c +*this +.PP +Definition at line 401 of file swmodule.h. +.SS "virtual const char* SWModule::RenderText (\fBSWKey\fP * tmpKey)\fC [virtual]\fP" +.PP +calls all RenderFilters on current text. +.PP +Parameters: +.in +1c +.TP +\fB\fItmpKey\fP\fP +key to use to grab text +.PP +\fBReturns: \fP +.in +1c +this module's text at specified key location massaged by Render filters +.SS "virtual const char* SWModule::RenderText (char * buf = 0, int len = -1)\fC [virtual]\fP" +.PP +calls all RenderFilters on buffer or current text. +.PP +Parameters: +.in +1c +.TP +\fB\fIbuf\fP\fP +buffer to Render instead of current module position; if buf is NULL, the current text will be used +.TP +\fB\fIlen\fP\fP +max len of buf OR current text -- will be applied anyway +.PP +\fBReturns: \fP +.in +1c +this module's text at specified key location massaged by Render filters +.SS "virtual SWModule& SWModule::ReplaceEncodingFilter (SWFilter * oldfilter, SWFilter * newfilter)\fC [inline, virtual]\fP" +.PP +Replaces an EncodingFilter in this module's. +.PP +\fBSee also: \fP +.in +1c +encodingfilters queue +.PP +Parameters: +.in +1c +.TP +\fB\fIoldfilter\fP\fP +the filter to remove +.TP +\fB\fInewfilter\fP\fP +the filter to add in its place +.PP +\fBReturns: \fP +.in +1c +*this +.PP +Definition at line 447 of file swmodule.h. +.SS "virtual SWModule& SWModule::ReplaceRenderFilter (SWFilter * oldfilter, SWFilter * newfilter)\fC [inline, virtual]\fP" +.PP +Replaces a RenderFilter in this module's. +.PP +\fBSee also: \fP +.in +1c +renderfilters queue +.PP +Parameters: +.in +1c +.TP +\fB\fIoldfilter\fP\fP +the filter to remove +.TP +\fB\fInewfilter\fP\fP +the filter to add in its place +.PP +\fBReturns: \fP +.in +1c +*this +.PP +Definition at line 410 of file swmodule.h. +.SS "virtual \fBListKey\fP& SWModule::Search (const char * istr, int searchType = 0, int flags = 0, \fBSWKey\fP * scope = 0, bool * justCheckIfSupported = 0, void(* percent)(char, void *) = &nullPercent, void * percentUserData = 0)\fC [virtual]\fP" +.PP +Searches a module for a string. +.PP +Parameters: +.in +1c +.TP +\fB\fIistr\fP\fP +string for which to search +.TP +\fB\fIsearchType\fP\fP +type of search to perform <=0 ->regex; 1->phrase; 2->multiword; +.TP +\fB\fIflags\fP\fP +options flags for search +.TP +\fB\fIjustCheckIfSupported\fP\fP +if set, don't search, only tell if this function supports requested search. +.PP +\fBReturns: \fP +.in +1c +listkey set to verses that contain istr +.PP +Referenced by isSearchOptimallySupported(). +.PP +.SS "virtual char SWModule::SetKey (const \fBSWKey\fP & ikey)\fC [virtual]\fP" +.PP +Sets the key of this module. +.PP +Similair to +.PP +\fBSee also: \fP +.in +1c +\fBSetKey\fP(const SWKey*) . +.PP +Parameters: +.in +1c +.TP +\fB\fIikey\fP\fP +The \fBSWKey\fP which should be used as new key. +.PP +\fBReturns: \fP +.in +1c +Error status +.SS "virtual char SWModule::SetKey (const \fBSWKey\fP * ikey)\fC [virtual]\fP" +.PP +Sets a key to this module for position to a particular record or set of records. +.PP +Parameters: +.in +1c +.TP +\fB\fIikey\fP\fP +key with which to set this module +.PP +\fBReturns: \fP +.in +1c +error status +.PP +Referenced by Key(). +.PP +.SS "virtual const char* SWModule::StripText (\fBSWKey\fP * tmpKey)\fC [virtual]\fP" +.PP +calls all StripFilters on current text. +.PP +Parameters: +.in +1c +.TP +\fB\fItmpKey\fP\fP +key to use to grab text +.PP +\fBReturns: \fP +.in +1c +this module's text at specified key location massaged by Strip filters +.SS "virtual const char* SWModule::StripText (char * buf = 0, int len = -1)\fC [virtual]\fP" +.PP +calls all StripFilters on buffer or current text. +.PP +Parameters: +.in +1c +.TP +\fB\fIbuf\fP\fP +buf to massage instead of current module position; if buf is NULL, the current text will be used +.TP +\fB\fIlen\fP\fP +max len of buf OR current text -- will be applied anyway +.PP +\fBReturns: \fP +.in +1c +this module's text at specified key location massaged by Strip filters +.SS "virtual char* SWModule::Type (const char * imodtype = 0)\fC [virtual]\fP" +.PP +Sets/gets module type. +.PP +Parameters: +.in +1c +.TP +\fB\fIimodtype\fP\fP +value which to set modtype; [0] - only get +.PP +\fBReturns: \fP +.in +1c +pointer to modtype +.SS "signed char SWModule::createModule (const char * path)\fC [inline, static]\fP" +.PP +Creates a new module. +.PP +Parameters: +.in +1c +.TP +\fB\fIpath\fP\fP +The first parameter is path of the new module +.PP +\fBReturns: \fP +.in +1c +error +.PP +Definition at line 328 of file swmodule.h. +.SS "virtual void SWModule::encodingFilter (char * buf, long size, \fBSWKey\fP * key)\fC [inline, virtual]\fP" +.PP +encodingFilter a text buffer. +.PP +Parameters: +.in +1c +.TP +\fB\fIbuf\fP\fP +the buffer to filter +.TP +\fB\fIsize\fP\fP +the allocated size of the buffer +.TP +\fB\fIkey\fP\fP +key location from where this buffer was extracted +.PP +\fBReturns: \fP +.in +1c +*this +.PP +Definition at line 460 of file swmodule.h. +.SS "virtual void SWModule::filterBuffer (FilterList * filters, char * buf, long size, \fBSWKey\fP * key)\fC [inline, virtual]\fP" +.PP +FilterBuffer a text buffer. +.PP +Parameters: +.in +1c +.TP +\fB\fIfilters\fP\fP +the FilterList of filters to iterate +.TP +\fB\fIbuf\fP\fP +the buffer to filter +.TP +\fB\fIsize\fP\fP +the allocated size of the buffer +.TP +\fB\fIkey\fP\fP +key location from where this buffer was extracted +.PP +\fBReturns: \fP +.in +1c +*this +.PP +Definition at line 495 of file swmodule.h. +.PP +Referenced by encodingFilter(), optionFilter(), rawFilter(), renderFilter(), and stripFilter(). +.PP +.SS "virtual const int SWModule::getEntrySize () const\fC [inline, virtual]\fP" +.PP +\fBReturns: \fP +.in +1c +The size of the current entry. +.PP +Definition at line 141 of file swmodule.h. +.SS "virtual char* SWModule::getRawEntry ()\fC [pure virtual]\fP" +.PP +This function is reimplemented by the different kinds of module objects. +.PP +\fBReturns: \fP +.in +1c +the raw module text of the current entry +.SS "virtual bool SWModule::isSearchOptimallySupported (const char * istr, int searchType, int flags, \fBSWKey\fP * scope)\fC [inline, virtual]\fP" +.PP +Check if the search is optimally supported (e.g. +.PP +if index files are presnt and working) This function checks whether the search framework may work in the best way. +.PP +\fBReturns: \fP +.in +1c +True if the the search is optimally supported, false if it's not working in the best way. +.PP +Definition at line 274 of file swmodule.h. +.SS "virtual const bool SWModule::isUnicode () const\fC [inline, virtual]\fP" +.PP +\fBReturns: \fP +.in +1c +True if this module is encoded in Unicode, otherwise return false. +.PP +Definition at line 137 of file swmodule.h. +.SS "virtual bool SWModule::isWritable ()\fC [inline, virtual]\fP" +.PP +Is the module writable? :). +.PP +\fBReturns: \fP +.in +1c +yes or no +.PP +Definition at line 321 of file swmodule.h. +.SS "void SWModule::nullPercent (char percent, void * userData)\fC [static]\fP" +.PP +This is the default callback function for searching. +.PP +This function is a placeholder and does nothing. You can define your own function for search progress evaluation, and pass it over to \fBSearch\fP. +.SS "virtual SWModule::operator \fBSWKey\fP & ()\fC [inline, virtual]\fP" +.PP +Cast operator to cast to a \fBSWKey\fP reference. +.PP +This operator may be used to cast this module to a \fBSWKey\fP object. +.PP +\fBSee also: \fP +.in +1c +\fBSWKey\fP*() +.PP +Definition at line 301 of file swmodule.h. +.SS "virtual SWModule::operator \fBSWKey\fP * ()\fC [inline, virtual]\fP" +.PP +Operator to cast to an \fBSWKey\fP pointer. +.PP +This function may be used to cast this object to an \fBSWKey\fP pointer. +.PP +.nf + //we assume here that SWModule* module is already defined and valid. + SWKey* currentKey = (SWKey*)module; + // do something with currentKey (e.g. print out on screen) +.fi + +.PP +Definition at line 312 of file swmodule.h. +.SS "virtual SWModule::operator char * ()\fC [virtual]\fP" +.PP +Renders and returns the current module text. +.PP +\fBReturns: \fP +.in +1c +the rendered current module text +.SS "virtual SWModule& SWModule::operator+= (int increment)\fC [virtual]\fP" +.PP +Increments module key a number of entries. +.PP +Parameters: +.in +1c +.TP +\fB\fIincrement\fP\fP +Number of entries to jump forward +.PP +\fBReturns: \fP +.in +1c +*this +.SS "virtual SWModule& SWModule::operator-= (int decrement)\fC [virtual]\fP" +.PP +Decrements module key a number of entries. +.PP +Parameters: +.in +1c +.TP +\fB\fIdecrement\fP\fP +Number of entries to jump backward +.PP +\fBReturns: \fP +.in +1c +*this +.SS "virtual SWModule& SWModule::operator<< (const \fBSWKey\fP * linkKey)\fC [inline, virtual]\fP" +.PP +Link the current module entry to another module entry only if module \fBisWritable\fP. +.PP +.TP +\fBReturns: \fP +.in +1c +*this +.PP +.PP +Definition at line 349 of file swmodule.h. +.SS "virtual SWModule& SWModule::operator<< (const char * inbuf)\fC [inline, virtual]\fP" +.PP +Modify the current module entry text only if module \fBisWritable\fP. +.PP +.TP +\fBReturns: \fP +.in +1c +*this +.PP +.PP +Definition at line 342 of file swmodule.h. +.SS "virtual SWModule& SWModule::operator= (SW_POSITION pos)\fC [virtual]\fP" +.PP +Positions this modules to an entry. +.PP +Parameters: +.in +1c +.TP +\fB\fIp\fP\fP +position (e.g. TOP, BOTTOM) +.PP +\fBReturns: \fP +.in +1c +*this +.SS "virtual void SWModule::optionFilter (char * buf, long size, \fBSWKey\fP * key)\fC [inline, virtual]\fP" +.PP +OptionFilter a text buffer. +.PP +Parameters: +.in +1c +.TP +\fB\fIbuf\fP\fP +the buffer to filter +.TP +\fB\fIsize\fP\fP +the allocated size of the buffer +.TP +\fB\fIkey\fP\fP +key location from where this buffer was extracted +.PP +\fBReturns: \fP +.in +1c +*this +.PP +Definition at line 525 of file swmodule.h. +.SS "virtual void SWModule::rawFilter (char * buf, long size, \fBSWKey\fP * key)\fC [inline, virtual]\fP" +.PP +RawFilter a text buffer. +.PP +Parameters: +.in +1c +.TP +\fB\fIbuf\fP\fP +the buffer to filter +.TP +\fB\fIsize\fP\fP +the allocated size of the buffer +.TP +\fB\fIkey\fP\fP +key location from where this buffer was extracted +.PP +\fBReturns: \fP +.in +1c +*this +.PP +Definition at line 507 of file swmodule.h. +.SS "virtual void SWModule::renderFilter (char * buf, long size, \fBSWKey\fP * key)\fC [inline, virtual]\fP" +.PP +RenderFilter a text buffer. +.PP +Parameters: +.in +1c +.TP +\fB\fIbuf\fP\fP +the buffer to filter +.TP +\fB\fIsize\fP\fP +the allocated size of the buffer +.TP +\fB\fIkey\fP\fP +key location from where this buffer was extracted +.PP +\fBReturns: \fP +.in +1c +*this +.PP +Definition at line 423 of file swmodule.h. +.SS "virtual SWModule& SWModule::setentry (const char * inbuf, long len)\fC [inline, virtual]\fP" +.PP +Modify the current module entry text only if module \fBisWritable\fP. +.PP +.TP +\fBReturns: \fP +.in +1c +*this +.PP +.PP +Definition at line 335 of file swmodule.h. +.SS "virtual void SWModule::stripFilter (char * buf, long size, \fBSWKey\fP * key)\fC [inline, virtual]\fP" +.PP +StripFilter a text buffer. +.PP +Parameters: +.in +1c +.TP +\fB\fIbuf\fP\fP +the buffer to filter +.TP +\fB\fIsize\fP\fP +the allocated size of the buffer +.TP +\fB\fIkey\fP\fP +key location from where this buffer was extracted +.PP +\fBReturns: \fP +.in +1c +*this +.PP +Definition at line 477 of file swmodule.h. +.SH "MEMBER DATA DOCUMENTATION" +.PP +.SS "bool SWModule::terminateSearch" +.PP +Set this bool to false to terminate the search which is executed by this module (\fBSearch\fP). +.PP +This is useful for threaded applications to terminate the search in another thread. +.PP +Definition at line 112 of file swmodule.h. + +.SH "AUTHOR" +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file |