<!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 class Reference</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 Class Reference</h1>A filter providing commonly used functionality.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="swbasicfilter_8h-source.html">swbasicfilter.h</a>></code>
<p>
Inheritance diagram for SWBasicFilter:<p><center><img src="class_s_w_basic_filter__inherit__graph.png" border="0" usemap="#_s_w_basic_filter__inherit__map" alt="Inheritance graph"></center>
<map name="_s_w_basic_filter__inherit__map">
<area href="class_g_b_f_h_t_m_l_h_r_e_f.html" shape="rect" coords="14,84,121,103" alt="">
<area href="class_th_m_l_h_t_m_l.html" shape="rect" coords="145,84,225,103" alt="">
<area href="class_th_m_l_h_t_m_l_h_r_e_f.html" shape="rect" coords="249,84,363,103" alt="">
<area href="class_th_m_l_r_t_f.html" shape="rect" coords="387,84,457,103" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for SWBasicFilter:<p><center><img src="class_s_w_basic_filter__coll__graph.png" border="0" usemap="#_s_w_basic_filter__coll__map" alt="Collaboration graph"></center>
<map name="_s_w_basic_filter__coll__map">
<area href="class_s_w_key.html" shape="rect" coords="150,196,206,215" alt="">
<area href="class_s_w_module.html" shape="rect" coords="179,391,254,409" alt="">
<area href="class_list_key.html" shape="rect" coords="75,293,129,312" alt="">
<area href="class_s_w_object.html" shape="rect" coords="226,105,298,124" alt="">
<area href="class_s_w_display.html" shape="rect" coords="309,196,383,215" alt="">
<area href="class_s_w_class.html" shape="rect" coords="151,15,215,33" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="class_s_w_basic_filter-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top><a name="a0" doxytag="SWBasicFilter::SWBasicFilter"></a>
</td><td valign=bottom><b>SWBasicFilter</b> ()</td></tr>
<tr><td nowrap align=right valign=top><a name="a1" doxytag="SWBasicFilter::ProcessText"></a>
virtual char </td><td valign=bottom><b>ProcessText</b> (char *text, int maxlen, const <a class="el" href="class_s_w_key.html">SWKey</a> *, const <a class="el" href="class_s_w_module.html">SWModule</a> *=0)</td></tr>
<tr><td nowrap align=right valign=top><a name="a2" doxytag="SWBasicFilter::~SWBasicFilter"></a>
virtual </td><td valign=bottom><b>~SWBasicFilter</b> ()</td></tr>
<tr><td colspan=2><br><h2>Protected Types</h2></td></tr>
<tr><td nowrap align=right valign=top><a name="t0" doxytag="SWBasicFilter::DualStringMap"></a>
typedef map< string, string > </td><td valign=bottom><b>DualStringMap</b></td></tr>
<tr><td colspan=2><br><h2>Protected Methods</h2></td></tr>
<tr><td nowrap align=right valign=top><a name="b0" doxytag="SWBasicFilter::setEscapeStart"></a>
void </td><td valign=bottom><a class="el" href="class_s_w_basic_filter.html#b0">setEscapeStart</a> (const char *escStart)</td></tr>
<tr><td> </td><td><font size=-1><em>Sets the beginning of escape sequence (by default "&").</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="b1" doxytag="SWBasicFilter::setEscapeEnd"></a>
void </td><td valign=bottom><a class="el" href="class_s_w_basic_filter.html#b1">setEscapeEnd</a> (const char *escEnd)</td></tr>
<tr><td> </td><td><font size=-1><em>Sets the end of escape sequence (by default ";").</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="b2" doxytag="SWBasicFilter::setTokenStart"></a>
void </td><td valign=bottom><a class="el" href="class_s_w_basic_filter.html#b2">setTokenStart</a> (const char *tokenStart)</td></tr>
<tr><td> </td><td><font size=-1><em>Sets the beginning of token start sequence (by default "<").</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="b3" doxytag="SWBasicFilter::setTokenEnd"></a>
void </td><td valign=bottom><a class="el" href="class_s_w_basic_filter.html#b3">setTokenEnd</a> (const char *tokenEnd)</td></tr>
<tr><td> </td><td><font size=-1><em>Sets the end of token start sequence (by default ">").</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="class_s_w_basic_filter.html#b4">setPassThruUnknownToken</a> (bool val)</td></tr>
<tr><td> </td><td><font size=-1><em>Sets whether pass thru unknown tokens unchanged or just ignore (remove) them.</em> <a href="#b4">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="class_s_w_basic_filter.html#b5">setPassThruUnknownEscapeString</a> (bool val)</td></tr>
<tr><td> </td><td><font size=-1><em>Sets whether pass thru unknown escape sequences unchanged or just ignore (remove) them.</em> <a href="#b5">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="b6" doxytag="SWBasicFilter::setTokenCaseSensitive"></a>
void </td><td valign=bottom><b>setTokenCaseSensitive</b> (bool val)</td></tr>
<tr><td nowrap align=right valign=top><a name="b7" doxytag="SWBasicFilter::setEscapeStringCaseSensitive"></a>
void </td><td valign=bottom><b>setEscapeStringCaseSensitive</b> (bool val)</td></tr>
<tr><td nowrap align=right valign=top><a name="b8" doxytag="SWBasicFilter::addTokenSubstitute"></a>
void </td><td valign=bottom><b>addTokenSubstitute</b> (const char *findString, const char *replaceString)</td></tr>
<tr><td nowrap align=right valign=top><a name="b9" doxytag="SWBasicFilter::addEscapeStringSubstitute"></a>
void </td><td valign=bottom><b>addEscapeStringSubstitute</b> (const char *findString, const char *replaceString)</td></tr>
<tr><td nowrap align=right valign=top><a name="b10" doxytag="SWBasicFilter::substituteToken"></a>
bool </td><td valign=bottom><b>substituteToken</b> (char **buf, const char *token)</td></tr>
<tr><td nowrap align=right valign=top><a name="b11" doxytag="SWBasicFilter::substituteEscapeString"></a>
bool </td><td valign=bottom><b>substituteEscapeString</b> (char **buf, const char *escString)</td></tr>
<tr><td nowrap align=right valign=top><a name="b12" doxytag="SWBasicFilter::pushString"></a>
void </td><td valign=bottom><a class="el" href="class_s_w_basic_filter.html#b12">pushString</a> (char **buf, const char *format,...)</td></tr>
<tr><td> </td><td><font size=-1><em>Like sprintf.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual bool </td><td valign=bottom><a class="el" href="class_s_w_basic_filter.html#b13">handleToken</a> (char **buf, const char *token, DualStringMap &userData)</td></tr>
<tr><td> </td><td><font size=-1><em>This function is called for every token encountered in the input text.</em> <a href="#b13">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual bool </td><td valign=bottom><a class="el" href="class_s_w_basic_filter.html#b14">handleEscapeString</a> (char **buf, const char *escString, DualStringMap &userData)</td></tr>
<tr><td> </td><td><font size=-1><em>This function is called for every escape sequence encountered in the input text.</em> <a href="#b14">More...</a><em></em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
<tr><td nowrap align=right valign=top><a name="n0" doxytag="SWBasicFilter::module"></a>
const <a class="el" href="class_s_w_module.html">SWModule</a> * </td><td valign=bottom><b>module</b></td></tr>
<tr><td nowrap align=right valign=top><a name="n1" doxytag="SWBasicFilter::key"></a>
const <a class="el" href="class_s_w_key.html">SWKey</a> * </td><td valign=bottom><b>key</b></td></tr>
<tr><td nowrap align=right valign=top><a name="n2" doxytag="SWBasicFilter::resultBuffer"></a>
char * </td><td valign=bottom><b>resultBuffer</b></td></tr>
<tr><td nowrap align=right valign=top><a name="n3" doxytag="SWBasicFilter::tokenSubMap"></a>
DualStringMap </td><td valign=bottom><b>tokenSubMap</b></td></tr>
<tr><td nowrap align=right valign=top><a name="n4" doxytag="SWBasicFilter::escSubMap"></a>
DualStringMap </td><td valign=bottom><b>escSubMap</b></td></tr>
<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr>
<tr><td nowrap align=right valign=top><a name="o0" doxytag="SWBasicFilter::tokenStart"></a>
char * </td><td valign=bottom><b>tokenStart</b></td></tr>
<tr><td nowrap align=right valign=top><a name="o1" doxytag="SWBasicFilter::tokenEnd"></a>
char * </td><td valign=bottom><b>tokenEnd</b></td></tr>
<tr><td nowrap align=right valign=top><a name="o2" doxytag="SWBasicFilter::escStart"></a>
char * </td><td valign=bottom><b>escStart</b></td></tr>
<tr><td nowrap align=right valign=top><a name="o3" doxytag="SWBasicFilter::escEnd"></a>
char * </td><td valign=bottom><b>escEnd</b></td></tr>
<tr><td nowrap align=right valign=top><a name="o4" doxytag="SWBasicFilter::escStringCaseSensitive"></a>
bool </td><td valign=bottom><b>escStringCaseSensitive</b></td></tr>
<tr><td nowrap align=right valign=top><a name="o5" doxytag="SWBasicFilter::tokenCaseSensitive"></a>
bool </td><td valign=bottom><b>tokenCaseSensitive</b></td></tr>
<tr><td nowrap align=right valign=top><a name="o6" doxytag="SWBasicFilter::passThruUnknownToken"></a>
bool </td><td valign=bottom><b>passThruUnknownToken</b></td></tr>
<tr><td nowrap align=right valign=top><a name="o7" doxytag="SWBasicFilter::passThruUnknownEsc"></a>
bool </td><td valign=bottom><b>passThruUnknownEsc</b></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A filter providing commonly used functionality.
<p>
This filter has facilities for handling SGML/HTML/XML like tokens and escape strings (like SGML entities). It has the facility for just substituting the given tokens and escape strings to other strings and for "manual" custom token handling.
<p>
In this class the functions with arguments looking as <code>char **buf</code> write a character sequnce at address specified by <code>*buf</code> address and change <code>*buf</code> to point past the last char of the written sequence.
<p>
<p>
Definition at line <a class="el" href="swbasicfilter_8h-source.html#l00045">45</a> of file <a class="el" href="swbasicfilter_8h-source.html">swbasicfilter.h</a>.<hr><h2>Member Function Documentation</h2>
<a name="b14" doxytag="SWBasicFilter::handleEscapeString"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool SWBasicFilter::handleEscapeString </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">char ** </td>
<td class="mdname" nowrap> <em>buf</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>const char * </td>
<td class="mdname" nowrap> <em>escString</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>DualStringMap & </td>
<td class="mdname" nowrap> <em>userData</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [protected, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
This function is called for every escape sequence encountered in the input text.
<p>
<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>buf</em> </td><td>
the output buffer (FIXME: what is its size?) </td></tr>
<tr><td valign=top><em>escString</em> </td><td>
the escape sequence (e.g. <code>"amp"</code> for &amp;) </td></tr>
<tr><td valign=top><em>userData</em> </td><td>
FIXME: document this </td></tr>
</table>
</dl><dl compact><dt><b>
Returns: </b><dd>
<code>false</code> if was not handled and should be handled in the default way (by just substituting). </dl>
<p>
Definition at line <a class="el" href="swbasicfilter_8cpp-source.html#l00166">166</a> of file <a class="el" href="swbasicfilter_8cpp-source.html">swbasicfilter.cpp</a>.
<p>
<div class="fragment"><pre>00166 {
00167 <font class="keywordflow">return</font> substituteEscapeString(buf, escString);
00168 }
</pre></div> </td>
</tr>
</table>
<a name="b13" doxytag="SWBasicFilter::handleToken"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool SWBasicFilter::handleToken </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">char ** </td>
<td class="mdname" nowrap> <em>buf</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>const char * </td>
<td class="mdname" nowrap> <em>token</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>DualStringMap & </td>
<td class="mdname" nowrap> <em>userData</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [protected, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
This function is called for every token encountered in the input text.
<p>
<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>buf</em> </td><td>
the output buffer (FIXME: what is its size?) </td></tr>
<tr><td valign=top><em>token</em> </td><td>
the token (e.g. <code>"p align='left'"</code> </td></tr>
<tr><td valign=top><em>userData</em> </td><td>
FIXME: document this </td></tr>
</table>
</dl><dl compact><dt><b>
Returns: </b><dd>
<code>false</code> if was not handled and should be handled in the default way (by just substituting). </dl>
<p>
Reimplemented in <a class="el" href="class_g_b_f_h_t_m_l_h_r_e_f.html#b0">GBFHTMLHREF</a>, <a class="el" href="class_th_m_l_h_t_m_l.html#b0">ThMLHTML</a>, <a class="el" href="class_th_m_l_h_t_m_l_h_r_e_f.html#b0">ThMLHTMLHREF</a>, and <a class="el" href="class_th_m_l_r_t_f.html#b0">ThMLRTF</a>.
<p>
Definition at line <a class="el" href="swbasicfilter_8cpp-source.html#l00161">161</a> of file <a class="el" href="swbasicfilter_8cpp-source.html">swbasicfilter.cpp</a>.
<p>
<div class="fragment"><pre>00161 {
00162 <font class="keywordflow">return</font> substituteToken(buf, token);
00163 }
</pre></div> </td>
</tr>
</table>
<a name="b5" doxytag="SWBasicFilter::setPassThruUnknownEscapeString"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void SWBasicFilter::setPassThruUnknownEscapeString </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">bool </td>
<td class="mdname1" valign="top" nowrap> <em>val</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap><code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Sets whether pass thru unknown escape sequences unchanged or just ignore (remove) them.
<p>
Default is false.
<p>
Definition at line <a class="el" href="swbasicfilter_8cpp-source.html#l00054">54</a> of file <a class="el" href="swbasicfilter_8cpp-source.html">swbasicfilter.cpp</a>.
<p>
<div class="fragment"><pre>00054 {
00055 passThruUnknownEsc = val;
00056 }
</pre></div> </td>
</tr>
</table>
<a name="b4" doxytag="SWBasicFilter::setPassThruUnknownToken"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void SWBasicFilter::setPassThruUnknownToken </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">bool </td>
<td class="mdname1" valign="top" nowrap> <em>val</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap><code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Sets whether pass thru unknown tokens unchanged or just ignore (remove) them.
<p>
Default is false.
<p>
Definition at line <a class="el" href="swbasicfilter_8cpp-source.html#l00049">49</a> of file <a class="el" href="swbasicfilter_8cpp-source.html">swbasicfilter.cpp</a>.
<p>
<div class="fragment"><pre>00049 {
00050 passThruUnknownToken = val;
00051 }
</pre></div> </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="swbasicfilter_8h-source.html">swbasicfilter.h</a><li><a class="el" href="swbasicfilter_8cpp-source.html">swbasicfilter.cpp</a></ul>
<hr><address align="right"><small>Generated on Thu Jun 20 22:13:02 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>
