diff options
Diffstat (limited to 'doc/api-documentation/html/swbasicfilter_h-source.html')
-rw-r--r-- | doc/api-documentation/html/swbasicfilter_h-source.html | 89 |
1 files changed, 89 insertions, 0 deletions
diff --git a/doc/api-documentation/html/swbasicfilter_h-source.html b/doc/api-documentation/html/swbasicfilter_h-source.html new file mode 100644 index 0000000..32aeb1f --- /dev/null +++ b/doc/api-documentation/html/swbasicfilter_h-source.html @@ -0,0 +1,89 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>swbasicfilter.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>swbasicfilter.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * swbasicfilter.h - definition of class SWBasicFilter. An SWFilter</font> +00003 <font class="comment"> * impl that provides some basic methods that</font> +00004 <font class="comment"> * many filter will need and can use as a starting</font> +00005 <font class="comment"> * point. </font> +00006 <font class="comment"> *</font> +00007 <font class="comment"> * $Id: swbasicfilter_h-source.html,v 1.4 2001/10/05 20:45:21 mgruner Exp $</font> +00008 <font class="comment"> *</font> +00009 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00010 <font class="comment"> * CrossWire Bible Society</font> +00011 <font class="comment"> * P. O. Box 2528</font> +00012 <font class="comment"> * Tempe, AZ 85280-2528</font> +00013 <font class="comment"> *</font> +00014 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00015 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00016 <font class="comment"> * Free Software Foundation version 2.</font> +00017 <font class="comment"> *</font> +00018 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00019 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00020 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00021 <font class="comment"> * General Public License for more details.</font> +00022 <font class="comment"> *</font> +00023 <font class="comment"> */</font> +00024 +00025 <font class="preprocessor">#ifndef SWBASICFILTER_H</font> +00026 <font class="preprocessor"></font><font class="preprocessor">#define SWBASICFILTER_H</font> +00027 <font class="preprocessor"></font> +00028 <font class="preprocessor">#include <swfilter.h></font> +00029 +00030 <font class="preprocessor">#include <defs.h></font> +00031 <font class="preprocessor">#include <map></font> +00032 <font class="keyword">using</font> <font class="keyword">namespace </font>std; +00033 +00034 +00035 <font class="keyword">class </font>SWDLLEXPORT SWBasicFilter : <font class="keyword">public</font> <a class="code" href="class_swfilter.html">SWFilter</a> { +00036 +00037 <font class="keywordtype">char</font> *tokenStart; +00038 <font class="keywordtype">char</font> *tokenEnd; +00039 <font class="keywordtype">char</font> *escStart; +00040 <font class="keywordtype">char</font> *escEnd; +00041 <font class="keywordtype">bool</font> escStringCaseSensitive; +00042 <font class="keywordtype">bool</font> tokenCaseSensitive; +00043 <font class="keywordtype">bool</font> passThruUnknownToken; +00044 <font class="keywordtype">bool</font> passThruUnknownEsc; +00045 +00046 <font class="keyword">public</font>: +00047 SWBasicFilter(); +00048 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swfilter.html#a6">ProcessText</a>(<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen = -1); +00049 <font class="keyword">virtual</font> ~SWBasicFilter(); +00050 +00051 <font class="keyword">protected</font>: +00052 <font class="keyword">typedef</font> map<string, string> DualStringMap; +00053 DualStringMap tokenSubMap; +00054 DualStringMap escSubMap; +00055 <font class="keywordtype">void</font> setEscapeStart(<font class="keyword">const</font> <font class="keywordtype">char</font> *escStart); +00056 <font class="keywordtype">void</font> setEscapeEnd(<font class="keyword">const</font> <font class="keywordtype">char</font> *escEnd); +00057 <font class="keywordtype">void</font> setTokenStart(<font class="keyword">const</font> <font class="keywordtype">char</font> *tokenStart); +00058 <font class="keywordtype">void</font> setTokenEnd(<font class="keyword">const</font> <font class="keywordtype">char</font> *tokenEnd); +00059 <font class="keywordtype">void</font> setPassThruUnknownToken(<font class="keywordtype">bool</font> val); +00060 <font class="keywordtype">void</font> setPassThruUnknownEscapeString(<font class="keywordtype">bool</font> val); +00061 <font class="keywordtype">void</font> setTokenCaseSensitive(<font class="keywordtype">bool</font> val); +00062 <font class="keywordtype">void</font> setEscapeStringCaseSensitive(<font class="keywordtype">bool</font> val); +00063 <font class="keywordtype">void</font> addTokenSubstitute(<font class="keyword">const</font> <font class="keywordtype">char</font> *findString, <font class="keyword">const</font> <font class="keywordtype">char</font> *replaceString); +00064 <font class="keywordtype">void</font> addEscapeStringSubstitute(<font class="keyword">const</font> <font class="keywordtype">char</font> *findString, <font class="keyword">const</font> <font class="keywordtype">char</font> *replaceString); +00065 <font class="keywordtype">bool</font> substituteToken(<font class="keywordtype">char</font> **buf, <font class="keyword">const</font> <font class="keywordtype">char</font> *token); +00066 <font class="keywordtype">bool</font> substituteEscapeString(<font class="keywordtype">char</font> **buf, <font class="keyword">const</font> <font class="keywordtype">char</font> *escString); +00067 <font class="keywordtype">void</font> pushString(<font class="keywordtype">char</font> **buf, <font class="keyword">const</font> <font class="keywordtype">char</font> *fragToPush); +00068 +00069 <font class="keyword">virtual</font> <font class="keywordtype">bool</font> handleToken(<font class="keywordtype">char</font> **buf, <font class="keyword">const</font> <font class="keywordtype">char</font> *token, DualStringMap &userData); +00070 <font class="keyword">virtual</font> <font class="keywordtype">bool</font> handleEscapeString(<font class="keywordtype">char</font> **buf, <font class="keyword">const</font> <font class="keywordtype">char</font> *escString, DualStringMap &userData); +00071 }; +00072 +00073 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:33 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> |