Location: PHPKode > scripts > strStream > strstream/manual.html
<!doctype html public "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<title> strStream page </title>
<meta name="Generator" content="EditPlus">
<meta name="Author" content="Gyozo Papp">
<meta name="Keywords" content="PHP class strStream stream file-handling">
<meta name="Description" content="This file contains basic information about class strStream written in PHP.">
<STYLE type=text/css>
BODY {
	FONT-SIZE: 12pt; MARGIN-LEFT: 1em; COLOR: #000000; MARGIN-RIGHT: 0px; FONT-FAMILY: Arial, Tahoma, Helvetica, sans-serif; BACKGROUND-COLOR: #f0f0f0
}
H1 {
	PADDING-LEFT: 5px; FONT-SIZE: 18pt; PADDING-BOTTOM: 5px; COLOR: black; PADDING-TOP: 5px; FONT-FAMILY: Verdana, Tahoma, Arial, Helvetica, sans-serif
}
H2 {
	MARGIN-TOP: 2em; FONT-SIZE: 16pt; COLOR: black; FONT-FAMILY: Verdana, Tahoma, Arial, Helvetica, sans-serif
}
H3 {
	MARGIN-TOP: 1em; FONT-SIZE: 14pt; COLOR: navy; FONT-FAMILY: Verdana, Tahoma, Arial, Helvetica, sans-serif
}
H4 {
	PADDING-LEFT: 2px; PADDING-TOP: 2px; FONT-SIZE: 12pt; COLOR: navy; FONT-FAMILY: Verdana, Tahoma, Arial, Helvetica, sans-serif; BACKGROUND-COLOR: #e6e6fa
}
DT {
	PADDING-LEFT: 1em; COLOR: darkslateblue;
}
DD {
	PADDING-LEFT: 1em; COLOR: antracit;
}
.note {
	FONT-SIZE: 9pt
}
P:first-letter { font-size: 120%; float: left }

A.local:link {
	FONT-WEIGHT: normal; COLOR: red; FONT-STYLE: normal; FONT-FAMILY: Verdana, Arial, Helvetica, sans-serif; FONT-VARIANT: normal; TEXT-DECORATION: none
}
A.local:visited {
	FONT-WEIGHT: normal; COLOR: brown; FONT-STYLE: normal; FONT-FAMILY: Verdana, Arial, Helvetica, sans-serif; FONT-VARIANT: normal; TEXT-DECORATION: none
}
A.local:active {
	COLOR: black; FONT-STYLE: normal; FONT-FAMILY: Verdana, Arial, Helvetica, sans-serif; FONT-VARIANT: normal; TEXT-DECORATION: none
}
A.local:hover {
	FONT-WEIGHT: normal; COLOR: #002040; FONT-STYLE: normal; FONT-FAMILY: Verdana, Arial, Helvetica, sans-serif; FONT-VARIANT: normal; TEXT-DECORATION: underline
}
</STYLE>
</head>

<body>
<h1>MANUAL of strStream class </h1>
<p>This is short but descriptive <a class='local' href="#manual">manual</a> &amp; <a class='local' href="#reference">reference</a> for strStream.
<br>It also describes the basic principles and considerations of developing class strStream. </p>
<h2>Copyright terms</h2>
<p>Each file related to my recent project begins with a HTML comment similar to following one.
The reason why it was not placed in the PHP scope is that this seemed more effective way to give them publicity. 
The first time the strStream has used only internally, so nobody could be able to get familiar with it.
Now, the class has been published, but the comment remains in the HTML scope for historical reason.<br>
If you would like to change scope of the comment, you are welcome - the trailing hashmarks ease your work. :)<br>
As you can realize the copyright terms are slightly modificated version of <a href="http://www.posgresql.org">PostgreSQL</a>'s ones. 
I hope much copy of copyright terms are not prohibited by any law or authority and I didn't break any rule.
If it does not hold where you apply this product or its pieces, you are kindly asked to remove the
<a class='local' href="#copyright">last two paragraph</a> and the reference to them from the preceding paragraph.</p>
<p>Bruce Momjiam is one of the PostgreSQL core developers and currently also the vice president of Great Bridge, 
a PostgreSQL support company, he said:
<blockquote><i></font>&quot;I personally find that the fewer restrictions, the easier things 
are to understand, the better. I think that a lot of people don't really 
understand the implications of, for example, the GPL license because it's a long 
document. It's very complicated, too, it really has a lot of things, it doesn't 
cover completely so you are left not understanding what's legal to do, or what's 
not legal to do. &quot;</i></blockquote>
I think he is absolutely right. That is why I dare to use their copyright for my own purpose.
<p>By the way, <a href="http://www.posgresql.org">PostgreSQL</a> is one of my favourite developing tool (not only among RDBMS'), you should try it if you have any spare time.
</p>
<pre>
&lt;!--#--------------------------------------------------------------------------
# This is the file where strStream class lives
# written by	: Gyozo Papp @: hide@address.com, hide@address.com
# last modified	: 2001.04.30
#--COPYRIGHT-------------------------------------------------------------------
# strStream is Copyright &copy; by all of us (created by Gyozo Papp) 
# Permission to use, copy, modify, and distribute this software and 
# its documentation for any purpose, without fee, and without a written 
# agreement is hereby granted, provided that the above copyright notice 
# and this paragraph and the following two paragraphs appear in all copies. 
# <a name="copyright">
# IN NO EVENT SHALL i BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT, SPECIAL, 
# INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS, 
# ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, 
# EVEN IF i HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
#
# i SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, BUT NOT LIMITED TO, 
# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 
# PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS ON AN "AS-IS" BASIS, 
# AND i HAS NO OBLIGATIONS TO PROVIDE MAINTAINANCE, SUPPORT, UPDATES, 
# ENHANCEMENTS, OR MODIFICATIONS.
# BUT i LIKE TO VERY MUCH.</a>
#--------------------------------------------------------------------------#--&gt;
</pre>
<h2><a name="manual">Manual</a></h2>
<p>The purpose of creating this class is that flat text files with arbitrary structure can be parsed easily. You must notice that this class supports stream reading rather than writing, because it is used to parse different flat text files.</p>
<p>First, you have to <a class='local' href="#put">put()</a> the string to be parsed (input) into the internal buffer of the class.<br>
<a name="buffer">The internal buffer </a>is currently a simple PHP string, but it may be changed in the future depending on that new features can be implemented with it.</p>
<p>After you load anything to it, you can retrieve classified information from the buffer. Several methods have been already implemented with which you can either get the leftmost word or parenthised block from the buffer. The names of these methods start with 'get' and listed below under '<a class='local' href="#getc"><b>Stream Reading</b></a>'.
<br>I tried to make this functions flexible enough in order that it can be used in various fields.
<p>There are two reading mode defined for this class: GET and FETCH. The former one means when you get a piece of the buffer then this  is removed from it transparently, while the latter one always leaves the buffer untouched and only makes copies of its return values.
<p>If you find that the block stripped from the buffer is superfluous, you are able to push it back by calling <a class='local' href='#unget'>unget()</a>. So you have nothing to worry about if you pull some items in mode GET, you can easily put it back. (Up to now, there is a very limited support to write in a stream, this class is mainly for reading, parsing and slicing its string content). 
</p>
<h3><a name="examples">Examples</a></h3>
Be posted soon! Please wait gently.
<hr>
<h2><a name="reference">Reference</a></h2>
<h3>Initializing & Reinitializing</h3>
<ul>
	<li>function <a class='local' href='#strStream'>strStream</a>(string)
	<li>function <a class='local' href="#put">put</a>(string)
	<li>function <a class='local' href='#done'>done()</a>
</ul>	        
<h3>Stream Length</h3>
<ul>	        
	<li>function <a class='local' href="#enough">enough</a>(int)
	<li>function <a class='local' href='#eos'>eos()</a>
</ul>	        
<h3>Stream Reading</h3>
<ul>	        
	<li>function <a class='local' href="#getc">getc</a>(int, int)
	<li>function <a class='local' href="#getw">getw</a>(string, int, bool)
	<li>function <a class='local' href="#getp">getp</a>(string, int, bool)
	<li>function <a class='local' href="#geta">geta</a>(string, int, bool)
	<li>function <a class='local' href="#getb">getb</a>(string, string, bool)
	<li>function <a class='local' href="#get">get</a>(int)
</ul>	        
<h3>Internal Buffer Manipulating</h3>
<p>This methods change the whole content of the buffer regardless the current retrieving mode since they have no mode argument.
<ul>	        
	<li>function <a class='local' href="#unget">unget</a>(string, bool)
	<li>function <a class='local' href='#normalize_space'>normalize_space</a>()
	<li>function <a class='local' href="#strip_S">strip_space</a>(string) 
</ul>
<h3>Private</h3>
<p>Note: These functions are intended to be used internally - from other methods of this class and derived classes.
<br>For any further details you might see the source code.</p>
<ul>	        
	<li>function _divide($count)
	<li>function _quotemeta($dlmtrs)
</ul>

<!-- strStream -->
<h4><a name='#strStream'>strStream</a>(string)</h4>
<dl>
	<dt>argument:<dd><ol><li><a name="#strStream.arg.1">&nbsp;<b>$str</b></a> <i>(string, default = '')</i></ol>
	<dt>returning value(s):<dd>-
	<dt>description:
	<dd  class='desc'>
		This function is the constructor of the class strStream. 
		If <a class='local' href="#strStream.arg.1">argument<sup>[1]</sup></a> is supplied then it is copied to the <a class='local' href="#buffer">internal buffer</a>.
		<br>Additional initialization is made here, nothing serious.
</dl>
<!-- put -->
<h4><a name='#put'>put</a>(string)</h4>
<dl>
	<dt>argument:<dd><ol>
		<li><a name="#put.arg.1">&nbsp;<b>$str</b></a> <i>(string, required)</i>
	</ol>
	<dt>returning value(s):<dd><ul>
		<li><b>(int)</b> = length of $str if specified,
		<li><b>(bool)</b> = <b>false</b> otherwise.
	</ul>
	<dt>description:
	<dd  class='desc'>
		This function append <a class='local' href="#put.arg.1">$str<sup>[1]</sup></a> to the end of <a class='local' href="#buffer">internal buffer</a> and clears the <a class='local' href="#stateflag">state flags</a>.
		<br>It is most commonly used to reinitialize an empty strStream.
</dl>

<!-- done -->
<h4><a name='#done'>done</a>()</h4>
<dl>
	<dt>argument:<dd>-
	<dt>returning value(s):<dd>-
	<dt>description:
	<dd  class='desc'>
		This function clears the <a class='local' href="#buffer">internal buffer</a> and the <a class='local' href="#stateflag">state flags</a>.
		<br>It is most commonly used to gain an empty stream before putting anything into it.
</dl>

<!-- enough -->
<h4><a name='#enough'>enough</a>(int)</h4>
<dl>
	<dt>argument:<dd><ol>
		<li><a name="#enough.arg.1">&nbsp;<b>$internal</b></a> <i>(int, default = 1)</i>
	</ol>
	<dt>returning value(s):<dd><ul>
		<li><b>(bool)</b> = <b>true</b> if there are enough characters in internal buffer, otherwise <b>false</b>.
	</ul>
	<dt>description:
	<dd  class='desc'>
		This function checks whether the <a class='local' href="#buffer">internal buffer</a> contains at least as many characters as specified in <a class='local' href="#enough.arg.1">$internal<sup>[1]</sup></a>.
</dl>

<!-- eos -->
<h4><a name='#eos'>eos(string)</a></h4>
<dl>
	<dt>argument:<dd><ol>
		<li><a name="#eos.arg.1">&nbsp;<b>$what</b></a> <i>(string, default = '')</i>
		<li><a name="#eos.arg.2">&nbsp;<b>$whole</b></a> <i>(bool, default = false)</i>
		</ol>
	<dt>returning value(s):<dd><ul>
		<li><b>(bool)</b> = <b>true</b> if internal buffer does not contain any characters from $what, otherwise <b>false</b>.
		</ul>
	<dt>description:<dd  class='desc'>
		This function checks any characters given in <a class='local' href="#eos.arg.1">$what<sup>[1]</sup></a> occur in the <a class='local' href="#buffer">internal buffer</a>. In other words, it checks whether the stream ends before ... If $what is empty, it returns whether the internal buffer is empty or not. 
</dl>

<!-- getc -->
<h4><a name='#getc'>getc(int, int)</a></h4>
<dl>
	<dt>argument:<dd><ol>
		<li><a name="#getc.arg.1">&nbsp;<b>$count</b></a> <i>(int, default = 1)</i>
		<li><a name="#getc.arg.2">&nbsp;<b>$mode</b></a> <i>(int, default = GET)</i>
	</ol>
	<dt>returning value(s):<dd><ul>
		<li><b>(string)</b> length of <a class='local' href='#getc.arg.1'>$count<sup>1</sup></a>, on success
		<li><b>(bool)</b> = <b>false</b>, on fail.
	</ul>
	<dt>description:<dd  class='desc'>It returns a substring (its length is specified by <a class='local' href="#getc.arg.1">$count<sup>[1]</sup></a>) from the begining of stream. Insufficient number of characters (see <a class='local' href="#enough">enough</a>()) cause that function fails and return false.
	<br>The <a class='local' href="#getc.arg.2">$mode<sup>[2]</sup></a>  specifies whether the substring would be removed from the buffer (GET) or just make a copy as return value and leave the buffer untouched (FETCH).
</dl>
<!-- getw -->
<h4><a name="#getw">getw</a>(string, int, bool)</h4>
<dl>
	<dt>argument:<dd><ol>
		<li><a name="#getw.arg.1">&nbsp;<b>$dlmtrs</b></a> <i>(string, default = <a class='local' href="#S">S</a>)</i>
		<li><a name="#getw.arg.2">&nbsp;<b>$mode</b></a> <i>(int, default = GET)</i>
		<li><a name="#getw.arg.3">&nbsp;<b>$skipquote</b></a> <i>(bool, default = true)</i> 
	</ol>		
	<dt>returning value(s):<dd><ul>
		<li><b>(string)</b> = on success<br>
		<li><b>(bool)</b> = <b>false</b>, on fail.
	</ul>
	<dt>description:<dd  class='desc'>It returns the leftmost word  from the <a class='local' href="#buffer">internal buffer</a>. The <a class='local' href="#getw.arg.1">$dlmtrs<sup>[1]</sup></a> contains the characters treated as word-delimiter ones, which means that the substring in the internal buffer before the firt occurence of any character of $dlmtrs would be the return value. If the buffer is already empty or contains just such characters as $dlmtrs, function fails and return false. <a class='local' href="#getw.arg.2">$mode<sup>[2]</sup></a> specifies whether the substring would be removed from the buffer (GET) or just make a copy as return value and leave the buffer untouched (FETCH).
	<dt>note:<dd class='note'>$skipquote is NOT implemented yet.</p>
</dl>
<!-- getp -->
<h4><a name="#getp">getp</a>(string, int, int)</h4>
<dl>
	<dt>argument:<dd><ol>
		<li><a name="#getp.arg.1">&nbsp;<b>$op</b></a>  <i>(one of the following character: opening parenthesis&nbsp;( bracket&nbsp;[ brace&nbsp;{ less-than&lt;, default = '(')</i>
		<li><a name="#getp.arg.2">&nbsp;<b>$mode</b></a> <i>(int, default = GET)</i>
		<li><a name="#getp.arg.3">&nbsp;<b></a> $skipquote</b> <i>(bool, default = true)</i>
	</ol>
	<dt>returning value(s):<dd><ul>
		<li><a name="#getp.ret.1"><b>(array)</b> = on success</a>
		<li><a name="#getp.ret.2"><b>(bool)</b> = <b>false</b>, if not found</a>
		<li><a name="#getp.ret.3"><b>(int)</b></a> = <b>-1</b>, <a class='local' href="#getp.arg.1">$op<sup>[1]</sup></a> is not an opening bracket or <br><b>-2</b> if brackets are not in balance in the <a class='local' href="#buffer">internal buffer</a>.
	</ul>
	<dt>description:<dd  class='desc'>This function searches for a character block enclosed by that pair of brackets  which  is specified by its opening tag in <a class='local' href="#getp.arg.1">$op<SUP>[1]</SUP></a>. In between there may be any characters, except that parentheses (( )), brackets ([ ]) and braces ({ }) must always occur in matching pairs and may be nested. Single (') and double quotes (&quot;) must also occur in matching pairs, and characters between them are parsed as a string. It may skip some characters at beginning of the buffer in order to find the first opening bracket.
	<br>The function keeps track of brackets, - in other words - it can handle nested blocks. On success, the returning value is an <a class='local' href="#getp.ret.1">array</a> of the largest block without opening and closing brackets (at index 0) and a string which precedes the block in the buffer (at index 1) - the skipped characters.
	<br> The <a class='local' href="#getp.arg.3">$skipquote<SUP>[3]</SUP></a> argument decides whether quotations (substrings between &quot;&nbsp;&quot;s or &#39;&nbsp;&#39;s) are skipped and not parsed for brackets. A single quotation mark is treated as a single character and not as the beginning of a quotation. Owing to the light implementation of this tricky behaviour the quotation mark itself must not appear inside the quotation even it is escaped by a &#39;\&#39;. The other quotation mark (for &quot; the &#39; and vice versa) may appear inside a quotation.
	<br>If brackets are not in balance in the buffer which means that more opening tags are found than closing ones, function fails and return <a class='local' href="#getp.ret.3">-2</a>. If  <a class='local' href="#getp.arg.1">$op<SUP>[1]</SUP></a> is not valid (values listed above), it also fails and return -1.
	<br>The <a class='local' href="#getp.arg.2">$mode<sup>[2]</sup></a> specifies whether the returning values would be removed from the buffer (GET) or just make a copy of them and leave the buffer untouched (FETCH).
</dl>
<!-- geta -->
<h4><a name="geta">geta</a>(string, int, bool)</h4>
<dl>
	<dt>argument:<dd><ol>
		<li><a name="#geta.arg.1">&nbsp;<b>$ops</a></b>  <i>(sequence of any opening brackets character such as &lt;&nbsp;(&nbsp;{&nbsp;[, default = '&lt;([{')</i>
		<li><a name="#geta.arg.2">&nbsp;<b>$mode</b></a> <i>(int, default = GET)</i>
		<li><a name="#geta.arg.3">&nbsp;<b>$skipquote</b></a> <i>(bool, default = true)</i>
	</ol><br>
		<br>
		
	<dt>returning value(s):<dd><ul>
		<li><a name="#geta.ret.1"><b>(array)</b> = on success</a>
		<li><a name="#geta.ret.2"><b>(bool)</b> = <b>false</b>, if not found</a>
		<li><a name="#geta.ret.3"><b>(int)</b></a> = <b>-1</b>, <a class='local' href="#geta.arg.1">$ops<sup>[1]</sup></a> is not an opening bracket.
	</ul>
	<dt>description:<dd  class='desc'>This function iterates on <a class='local' href="#geta.arg.1">$ops<SUP>[1]</SUP></a> and assumes its each character as an opening bracket parameter in calling <a class='local' href="#getp">getp()</a> untill getp() finds a block.  
	<dt>note:<dd class='note'>name <b>geta</b> stands for 'get a block that starts with < ( [ or {'.
</dl>
<!-- getb -->
<h4><a name="getb">getb</a>(string, string, bool)</h4>
<dl>
	<dt>argument:<dd><ol>
		<li><a name="#getb.arg.1">&nbsp;<b>$op</b> opening tag of block<i>(string, required)</i>
		<li><a name="#getb.arg.2">&nbsp;<b>$cl</b> closing tag of block<i>(string, required)</i>
		<li><a name="#getb.arg.3">&nbsp;<b>$mode</b> <i>(int, default = GET)</i>
	</ol>
	<dt>returning value(s):<dd><ul>
		<li><a name="#getb.ret.1"><b>(array)</b> = on success</a>
		<li><a name="#getb.ret.2"><b>(bool)</b> = <b>false</b>, if not found</a>
		<li><a name="#getb.ret.3"><b>(int)</b> = <b>-1</b>, if <a class='local' href="#getb.arg.1">$op</a> or <a class='local'  href="#getb.arg.2">$cl</a> is empty.</a>
	</ul>
	<dt>description:<dd  class='desc'>Briefly, This function is intended to strip out comments from the stream. (between ie.:'/*'&nbsp;'*/' or '//'&nbsp;'\n').<br>
	It searches a block of text in the  <a class='local' href="#buffer">internal buffer</a>
	starting with <a class='local' href="#getb.arg.1">$op<sup>[1]</sup></a> and ending with <a class='local' href="#getb.arg.2">$cl<sup>[2]</sup></a>. It is similiar to <a class='local' href="#getw">getw(...)</a>, but while the former treats its arguments ($op, $cl) as strings as a whole, the latter one as a set of delimiting characters, therefore if you want to get a block which starts a tag length of more than one character you have to use this method. 
	<br>It may skip some characters at beginning of the buffer in order to find the first opening tag. On success, the returning value is an <a class='local' href="#getb.ret.1">array</a> of the largest block without opening and closing tag (at index 0) and a string which precedes that block in the buffer (at index 1).
	<br>The <a class='local' href="#getb.arg.2">$mode<sup>[2]</sup></a> specifies whether the substring would be removed from the buffer (GET) or just make a copy as return value and leave the buffer untouched (FETCH).
</dl>

<!-- get -->
<h4><a name="get">get</a>(int)</h4>
<dl>
	<dt>argument:<dd><ol>
		<li><a name="#get.arg.1">&nbsp;<b>$mode</b> <i>(int, default = GET)</i>
	</ol>
	<dt>returning value(s):<dd><ul>
		<li><a name="#get.ret.1"><b>(string)</b> = on success</a>
		<li><a name="#get.ret.2"><b>(bool)</b> = <b>false</b>, if not found</a>
	</ul>
	<dt>description:<dd  class='desc'>Briefly, This function returns the whole content of <a class='local' href="#buffer">internal buffer</a><br>The <a class='local' href="#get.arg.2">$mode<sup>[2]</sup></a> specifies whether the buffer to be clear(GET) or just make a copy as return value and leave the buffer untouched (FETCH).
</dl>

<!-- unget -->
<h4><a name="unget">unget</a>(string, bool)</h4>
<dl>
	<dt>argument:<dd><ol>
		<li><a name="#unget.arg.1">&nbsp;<b>$str</b> string to put at the beginning of the stream<i>(string, required)</i>
		<li><a name="#unget.arg.2">&nbsp;<b>$trusted</b> state of $str<i>(bool, default = false)</i>
	</ol>
	<dt>returning value(s):<dd><ul>
		<li><a name="#unget.ret.2"><b>(bool)</b> = <b>true</b></a>
	</ul>
	<dt>description:<dd  class='desc'>This function places <a class='local' href='#unget.arg.1'>$str<sup>[1]</sup></a> in the beginning of <a class='local' href="#buffer">internal buffer</a><br>The most common usage of this method is its 'undo' functionality: if you realized after whatever get method - in GET mode - that its result is not what you expected, you are able to push back it into the buffer and reuse it.  The <a class='local' href="#unget.arg.2">$trusted<sup>[2]</sup></a> argument is for reporting the object that the string to be placed is in the same <a class='local' href="#state">state</a> as the buffer is in. (State of buffer is influenced by <a class='local' href="#normalize_space">normalize_space()</a> and <a class='local' href="#strip_S">strip_space()</a>, see below)
</dl>

<!-- normalize_space -->
<h4><a name="#normalize_space">normalize_space</a>()</h4>
<dl>
	<dt>argument:<dd>-
	<dt>returning value(s):<dd><ul>
		<li><a name="#normalize_space.ret.1"><b>(string)</b></a>
	</ul>
	<dt>description:<dd  class='desc'>This function returns the internal buffer whitespace normalized by stripping leading and trailing whitespace and replacing sequences of whitespace characters by a single space. Whitespace characters are the same as those allowed by the S production in XML. (namely: \r\n\t defined in S).
</dl>

<h4><a name="strip_S">strip_space</a>(string) </h4>
<dl>
	<dt>argument:<dd><ol>
		<li><a name="#strip_S.arg.1">&nbsp;<b>$dlmtrs</b><i>(string, default ='|,*?+()')</i>
	</ol>
	<dt>returning value(s):<dd><ul>
		<li><a name="#strip_S.ret.1"><b>(string)</b></a>
	</ul>
	<dt>description:<dd  class='desc'>This function returns the internal buffer by stripping whitespaces around the charcter given in <a class='local' href='#strip_s.arg.1'>$dlmtrs<sup>[1]</sup></a>. Whitespace characters are the same as those allowed by the S production in XML. (namely: \r\n\t defined in S)
</dl>

</body>
</html>
Return current item: strStream