diff options
| author | danglassey <danglassey> | 2002-08-14 09:57:17 +0000 |
|---|---|---|
| committer | danglassey <danglassey> | 2002-08-14 09:57:17 +0000 |
| commit | c9458897ebbb739d8db83c80e06512d8a612f743 (patch) | |
| tree | f8c5381045887e34388cc6b26cfccc254bf766dc /doc/api-documentation/html/swbasicfilter_8h-source.html | |
| download | sword-sf-cvs-c9458897ebbb739d8db83c80e06512d8a612f743.tar.gz | |
*** empty log message ***
Diffstat (limited to 'doc/api-documentation/html/swbasicfilter_8h-source.html')
| -rw-r--r-- | doc/api-documentation/html/swbasicfilter_8h-source.html | 99 |
1 files changed, 99 insertions, 0 deletions
diff --git a/doc/api-documentation/html/swbasicfilter_8h-source.html b/doc/api-documentation/html/swbasicfilter_8h-source.html new file mode 100644 index 0000000..6732ca5 --- /dev/null +++ b/doc/api-documentation/html/swbasicfilter_8h-source.html @@ -0,0 +1,99 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><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> +<!-- Generated by Doxygen 1.2.15 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</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_8h-source.html,v 1.7 2002/06/20 20:23:10 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 +<a name="l00045"></a><a class="code" href="class_s_w_basic_filter.html">00045</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_s_w_basic_filter.html">SWBasicFilter</a> : <font class="keyword">public</font> SWFilter { +00046 +00047 <font class="keywordtype">char</font> *tokenStart; +00048 <font class="keywordtype">char</font> *tokenEnd; +00049 <font class="keywordtype">char</font> *escStart; +00050 <font class="keywordtype">char</font> *escEnd; +00051 <font class="keywordtype">bool</font> escStringCaseSensitive; +00052 <font class="keywordtype">bool</font> tokenCaseSensitive; +00053 <font class="keywordtype">bool</font> passThruUnknownToken; +00054 <font class="keywordtype">bool</font> passThruUnknownEsc; +00055 +00056 <font class="keyword">public</font>: +00057 <a class="code" href="class_s_w_basic_filter.html">SWBasicFilter</a>(); +00058 <font class="keyword">virtual</font> <font class="keywordtype">char</font> ProcessText(<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen, <font class="keyword">const</font> <a class="code" href="class_s_w_key.html">SWKey</a> *, <font class="keyword">const</font> <a class="code" href="class_s_w_module.html">SWModule</a> * = 0); +00059 <font class="keyword">virtual</font> ~<a class="code" href="class_s_w_basic_filter.html">SWBasicFilter</a>(); +00060 +00061 <font class="keyword">protected</font>: +00062 <font class="keyword">const</font> <a class="code" href="class_s_w_module.html">SWModule</a> *module; +00063 <font class="keyword">const</font> <a class="code" href="class_s_w_key.html">SWKey</a> *key; +00064 <font class="keywordtype">char</font> *resultBuffer; +00065 <font class="keyword">typedef</font> map<string, string> DualStringMap; +00066 DualStringMap tokenSubMap; +00067 DualStringMap escSubMap; +00068 +00070 <font class="keywordtype">void</font> setEscapeStart(<font class="keyword">const</font> <font class="keywordtype">char</font> *escStart); +00071 +00073 <font class="keywordtype">void</font> setEscapeEnd(<font class="keyword">const</font> <font class="keywordtype">char</font> *escEnd); +00074 +00076 <font class="keywordtype">void</font> setTokenStart(<font class="keyword">const</font> <font class="keywordtype">char</font> *tokenStart); +00077 +00079 <font class="keywordtype">void</font> setTokenEnd(<font class="keyword">const</font> <font class="keywordtype">char</font> *tokenEnd); +00080 +00083 <font class="keywordtype">void</font> setPassThruUnknownToken(<font class="keywordtype">bool</font> val); +00084 +00087 <font class="keywordtype">void</font> setPassThruUnknownEscapeString(<font class="keywordtype">bool</font> val); +00088 +00089 <font class="keywordtype">void</font> setTokenCaseSensitive(<font class="keywordtype">bool</font> val); +00090 <font class="keywordtype">void</font> setEscapeStringCaseSensitive(<font class="keywordtype">bool</font> val); +00091 +00092 <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); +00093 <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); +00094 <font class="keywordtype">bool</font> substituteToken(<font class="keywordtype">char</font> **buf, <font class="keyword">const</font> <font class="keywordtype">char</font> *token); +00095 <font class="keywordtype">bool</font> substituteEscapeString(<font class="keywordtype">char</font> **buf, <font class="keyword">const</font> <font class="keywordtype">char</font> *escString); +00096 +00098 <font class="keywordtype">void</font> pushString(<font class="keywordtype">char</font> **buf, <font class="keyword">const</font> <font class="keywordtype">char</font> *format, ...); +00099 +00106 <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); +00107 +00114 <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); +00115 }; +00116 +00117 <font class="preprocessor">#endif</font> +</pre></div><hr><address align="right"><small>Generated on Thu Jun 20 22:13:00 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.15 </small></address> +</body> +</html> |