blob: e659e7115991e2186786b7d755801529ea7ac195 (
plain) (
tree)
|
|
<!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.17 -->
<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="namespacemembers.html">Namespace Members</a> <a class="qindex" href="functions.html">Compound Members</a> </center>
<hr><h1>swbasicfilter.h</h1><div class="fragment"><pre>00001 <span class="comment">/******************************************************************************</span>
00002 <span class="comment"> * swbasicfilter.h - definition of class SWBasicFilter. An SWFilter</span>
00003 <span class="comment"> * impl that provides some basic methods that</span>
00004 <span class="comment"> * many filter will need and can use as a starting</span>
00005 <span class="comment"> * point. </span>
00006 <span class="comment"> *</span>
00007 <span class="comment"> * $Id: swbasicfilter_8h-source.html,v 1.9 2002/10/31 11:30:16 joachim Exp $</span>
00008 <span class="comment"> *</span>
00009 <span class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</span>
00010 <span class="comment"> * CrossWire Bible Society</span>
00011 <span class="comment"> * P. O. Box 2528</span>
00012 <span class="comment"> * Tempe, AZ 85280-2528</span>
00013 <span class="comment"> *</span>
00014 <span class="comment"> * This program is free software; you can redistribute it and/or modify it</span>
00015 <span class="comment"> * under the terms of the GNU General Public License as published by the</span>
00016 <span class="comment"> * Free Software Foundation version 2.</span>
00017 <span class="comment"> *</span>
00018 <span class="comment"> * This program is distributed in the hope that it will be useful, but</span>
00019 <span class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</span>
00020 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span>
00021 <span class="comment"> * General Public License for more details.</span>
00022 <span class="comment"> *</span>
00023 <span class="comment"> */</span>
00024
00025 <span class="preprocessor">#ifndef SWBASICFILTER_H</span>
00026 <span class="preprocessor"></span><span class="preprocessor">#define SWBASICFILTER_H</span>
00027 <span class="preprocessor"></span>
00028 <span class="preprocessor">#include <swfilter.h></span>
00029
00030 <span class="preprocessor">#include <defs.h></span>
00031 <span class="preprocessor">#include <map></span>
00032
00033 SWORD_NAMESPACE_START
00034
<a name="l00046"></a><a class="code" href="classsword_1_1_s_w_basic_filter.html">00046</a> <span class="keyword">class </span>SWDLLEXPORT <a class="code" href="classsword_1_1_s_w_basic_filter.html">SWBasicFilter</a> : <span class="keyword">public</span> SWFilter {
00047
00048 <span class="keywordtype">char</span> *tokenStart;
00049 <span class="keywordtype">char</span> *tokenEnd;
00050 <span class="keywordtype">char</span> *escStart;
00051 <span class="keywordtype">char</span> *escEnd;
00052 <span class="keywordtype">bool</span> escStringCaseSensitive;
00053 <span class="keywordtype">bool</span> tokenCaseSensitive;
00054 <span class="keywordtype">bool</span> passThruUnknownToken;
00055 <span class="keywordtype">bool</span> passThruUnknownEsc;
00056
00057 <span class="keyword">public</span>:
00058 <a class="code" href="classsword_1_1_s_w_basic_filter.html">SWBasicFilter</a>();
00059 <span class="keyword">virtual</span> <span class="keywordtype">char</span> ProcessText(<span class="keywordtype">char</span> *text, <span class="keywordtype">int</span> maxlen, <span class="keyword">const</span> <a class="code" href="classsword_1_1_s_w_key.html">SWKey</a> *, <span class="keyword">const</span> <a class="code" href="classsword_1_1_s_w_module.html">SWModule</a> * = 0);
00060 <span class="keyword">virtual</span> ~<a class="code" href="classsword_1_1_s_w_basic_filter.html">SWBasicFilter</a>();
00061
00062 <span class="keyword">protected</span>:
00063 <span class="keyword">const</span> <a class="code" href="classsword_1_1_s_w_module.html">SWModule</a> *module;
00064 <span class="keyword">const</span> <a class="code" href="classsword_1_1_s_w_key.html">SWKey</a> *key;
00065 <span class="keywordtype">char</span> *resultBuffer;
00066 <span class="keyword">typedef</span> std::map<std::string, std::string> DualStringMap;
00067 DualStringMap tokenSubMap;
00068 DualStringMap escSubMap;
00069
00071 <span class="keywordtype">void</span> setEscapeStart(<span class="keyword">const</span> <span class="keywordtype">char</span> *escStart);
00072
00074 <span class="keywordtype">void</span> setEscapeEnd(<span class="keyword">const</span> <span class="keywordtype">char</span> *escEnd);
00075
00077 <span class="keywordtype">void</span> setTokenStart(<span class="keyword">const</span> <span class="keywordtype">char</span> *tokenStart);
00078
00080 <span class="keywordtype">void</span> setTokenEnd(<span class="keyword">const</span> <span class="keywordtype">char</span> *tokenEnd);
00081
00084 <span class="keywordtype">void</span> setPassThruUnknownToken(<span class="keywordtype">bool</span> val);
00085
00088 <span class="keywordtype">void</span> setPassThruUnknownEscapeString(<span class="keywordtype">bool</span> val);
00089
00090 <span class="keywordtype">void</span> setTokenCaseSensitive(<span class="keywordtype">bool</span> val);
00091 <span class="keywordtype">void</span> setEscapeStringCaseSensitive(<span class="keywordtype">bool</span> val);
00092
00093 <span class="keywordtype">void</span> addTokenSubstitute(<span class="keyword">const</span> <span class="keywordtype">char</span> *findString, <span class="keyword">const</span> <span class="keywordtype">char</span> *replaceString);
00094 <span class="keywordtype">void</span> addEscapeStringSubstitute(<span class="keyword">const</span> <span class="keywordtype">char</span> *findString, <span class="keyword">const</span> <span class="keywordtype">char</span> *replaceString);
00095 <span class="keywordtype">bool</span> substituteToken(<span class="keywordtype">char</span> **buf, <span class="keyword">const</span> <span class="keywordtype">char</span> *token);
00096 <span class="keywordtype">bool</span> substituteEscapeString(<span class="keywordtype">char</span> **buf, <span class="keyword">const</span> <span class="keywordtype">char</span> *escString);
00097
00099 <span class="keywordtype">void</span> pushString(<span class="keywordtype">char</span> **buf, <span class="keyword">const</span> <span class="keywordtype">char</span> *format, ...);
00100
00107 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> handleToken(<span class="keywordtype">char</span> **buf, <span class="keyword">const</span> <span class="keywordtype">char</span> *token, DualStringMap &userData);
00108
00115 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> handleEscapeString(<span class="keywordtype">char</span> **buf, <span class="keyword">const</span> <span class="keywordtype">char</span> *escString, DualStringMap &userData);
00116 };
00117
00118 SWORD_NAMESPACE_END
00119 <span class="preprocessor">#endif</span>
</pre></div><hr><address style="align: right;"><small>Generated on Thu Oct 31 12:11:28 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.17 </small></address>
</body>
</html>
|
