[sword-svn] r1697 - in trunk: include src/modules/filters

[mgruner at crosswire.org]

Author: mgruner
Date: 2005-01-28 05:09:08 -0700 (Fri, 28 Jan 2005)
New Revision: 1697

Modified:
   trunk/include/swbasicfilter.h
   trunk/src/modules/filters/swbasicfilter.cpp
Log:
Fixed BasicFilter functions logic for escapeStrings and tokenSubstitutes
addTS and addESS do replace in case the string is already there
replaceTS and replaceESS were changed to deleteTS and deleteESS as needed 
in frontend programs inheriting from sword classes

a few lines of doc added; please improve if you can =)


Modified: trunk/include/swbasicfilter.h
===================================================================
--- trunk/include/swbasicfilter.h	2005-01-27 16:22:37 UTC (rev 1696)
+++ trunk/include/swbasicfilter.h	2005-01-28 12:09:08 UTC (rev 1697)
@@ -113,17 +113,27 @@
 	 * Default is false.*/
 	void setPassThruUnknownEscapeString(bool val);
 
-	void setTokenCaseSensitive(bool val);
+	/** Are escapeStrings case sensitive or not? Call this
+	function before addEscapeStingSubstitute()*/
 	void setEscapeStringCaseSensitive(bool val);
+	/** Use this to add your own escapeString substitutes. It will replace them
+	if they already exist.*/
+	void addEscapeStringSubstitute(const char *findString, const char *replaceString);
+	/** Remove excapeStringSubstitutes from the list */
+	void deleteEscapeStringSubstitute(const char *findString);
+	/** This function performs the substitution of escapeStrings */
+	bool substituteEscapeString(SWBuf &buf, const char *escString);
 
+	/** Are tokens case sensitive (like in OSIS) or not? Call this
+	function before addTokenSubstitute()*/
+	void setTokenCaseSensitive(bool val);
+	/** Use this to add your own token substitutes. It will replace them
+	if they already exist.*/
 	void addTokenSubstitute(const char *findString, const char *replaceString);
-	void addEscapeStringSubstitute(const char *findString, const char *replaceString);
-	
-	void replaceTokenSubstitute(const char *findString, const char *replaceString);
-	void replaceEscapeStringSubstitute(const char *findString, const char *replaceString);
-	
+	/** Remove tokenSubstitutes from the list */
+	void deleteTokenSubstitute(const char *findString);
+	/** This function performs the substitution of tokens */
 	bool substituteToken(SWBuf &buf, const char *token);
-	bool substituteEscapeString(SWBuf &buf, const char *escString);
 
 	/** This function is called for every token encountered in the input text.
 	* @param buf the output buffer (FIXME: what is its size?)

Modified: trunk/src/modules/filters/swbasicfilter.cpp
===================================================================
--- trunk/src/modules/filters/swbasicfilter.cpp	2005-01-27 16:22:37 UTC (rev 1696)
+++ trunk/src/modules/filters/swbasicfilter.cpp	2005-01-28 12:09:08 UTC (rev 1697)
@@ -101,14 +101,12 @@
 }
 
 
-void SWBasicFilter::replaceTokenSubstitute(const char *findString, const char *replaceString) {
+void SWBasicFilter::deleteTokenSubstitute(const char *findString) {
 	if (tokenSubMap.find(findString) != tokenSubMap.end()) {
-		tokenSubMap.erase( tokenSubMap.find(findString) ); //erase entry
+		tokenSubMap.erase( tokenSubMap.find(findString) );
 	}
-	addTokenSubstitute(findString, replaceString);
 }
 
-
 void SWBasicFilter::addEscapeStringSubstitute(const char *findString, const char *replaceString) {
 	char *buf = 0;
 
@@ -121,14 +119,12 @@
 	else escSubMap.insert(DualStringMap::value_type(findString, replaceString));
 }
 
-void SWBasicFilter::replaceEscapeStringSubstitute(const char *findString, const char *replaceString) {
-        if (escSubMap.find(findString) != escSubMap.end()) {
-                escSubMap.erase( escSubMap.find(findString) ); //erase entry
-        }
-        addEscapeStringSubstitute(findString, replaceString);
+void SWBasicFilter::deleteEscapeStringSubstitute(const char *findString) {
+	if (escSubMap.find(findString) != escSubMap.end()) {
+		escSubMap.erase( escSubMap.find(findString) );
+	}
 }
 
-
 bool SWBasicFilter::substituteToken(SWBuf &buf, const char *token) {
 	DualStringMap::iterator it;
 
@@ -148,7 +144,6 @@
 	return false;
 }
 
-
 bool SWBasicFilter::substituteEscapeString(SWBuf &buf, const char *escString) {
 	DualStringMap::iterator it;