Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > bad97183153701b09df5fae1052b1c30 > files > 2259

crystalspace-doc-1.2.1-5mdv2010.0.i586.rpm

<!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>Crystal Space 1.2.1: csutil/scfstr.h Source File (Crystal Space 1.2.1 Public API Reference)</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<table border="0" cellpadding="0" cellspacing="0" width="100%" class="head">
 <tr height="59">
  <td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td>
  <td class="head"><h2>Public API Reference</h2></td>
 </tr>
 <tr height="11">
  <td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td>
 </tr>
</table>
<div class="content">
<!-- Generated by Doxygen 1.5.3 -->
<div class="tabs">
  <ul>
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
    <li><a href="modules.html"><span>Modules</span></a></li>
    <li><a href="namespaces.html"><span>Namespaces</span></a></li>
    <li><a href="classes.html"><span>Classes</span></a></li>
    <li class="current"><a href="files.html"><span>Files</span></a></li>
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  </ul>
</div>
<h1>csutil/scfstr.h</h1><a href="scfstr_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment">    Crystal Space String interface</span>
<a name="l00003"></a>00003 <span class="comment">    Copyright (C) 1999 by Brandon Ehle (Azverkan)</span>
<a name="l00004"></a>00004 <span class="comment"></span>
<a name="l00005"></a>00005 <span class="comment">    This library is free software; you can redistribute it and/or</span>
<a name="l00006"></a>00006 <span class="comment">    modify it under the terms of the GNU Library General Public</span>
<a name="l00007"></a>00007 <span class="comment">    License as published by the Free Software Foundation; either</span>
<a name="l00008"></a>00008 <span class="comment">    version 2 of the License, or (at your option) any later version.</span>
<a name="l00009"></a>00009 <span class="comment"></span>
<a name="l00010"></a>00010 <span class="comment">    This library is distributed in the hope that it will be useful,</span>
<a name="l00011"></a>00011 <span class="comment">    but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00012"></a>00012 <span class="comment">    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU</span>
<a name="l00013"></a>00013 <span class="comment">    Library General Public License for more details.</span>
<a name="l00014"></a>00014 <span class="comment"></span>
<a name="l00015"></a>00015 <span class="comment">    You should have received a copy of the GNU Library General Public</span>
<a name="l00016"></a>00016 <span class="comment">    License along with this library; if not, write to the Free</span>
<a name="l00017"></a>00017 <span class="comment">    Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.</span>
<a name="l00018"></a>00018 <span class="comment">*/</span>
<a name="l00019"></a>00019 
<a name="l00020"></a>00020 <span class="preprocessor">#ifndef __CS_SCFSTR_H__</span>
<a name="l00021"></a>00021 <span class="preprocessor"></span><span class="preprocessor">#define __CS_SCFSTR_H__</span>
<a name="l00022"></a>00022 <span class="preprocessor"></span>
<a name="l00027"></a>00027 <span class="preprocessor">#include "csextern.h"</span>
<a name="l00028"></a>00028 
<a name="l00029"></a>00029 <span class="preprocessor">#include "<a class="code" href="csstring_8h.html" title="String utility class.">csutil/csstring.h</a>"</span>
<a name="l00030"></a>00030 <span class="preprocessor">#include "<a class="code" href="scf__implementation_8h.html" title="Crystal Space Shared Class Facility (SCF) - implementation creation support.">csutil/scf_implementation.h</a>"</span>
<a name="l00031"></a>00031 <span class="preprocessor">#include "<a class="code" href="string_8h.html" title="String interface.">iutil/string.h</a>"</span>
<a name="l00032"></a>00032 
<a name="l00033"></a>00033 <span class="preprocessor">#include "<a class="code" href="msvc__deprecated__warn__off_8h.html" title="Disable MSVC deprecated warnings.">csutil/win32/msvc_deprecated_warn_off.h</a>"</span>
<a name="l00034"></a>00034 
<a name="l00036"></a><a class="code" href="classscfString.html">00036</a> <span class="keyword">class </span>CS_CRYSTALSPACE_EXPORT <a class="code" href="classscfString.html" title="This is a thin SCF wrapper around csString.">scfString</a> : 
<a name="l00037"></a>00037   <span class="keyword">public</span> <a class="code" href="classscfImplementation1.html">scfImplementation1</a>&lt;scfString, iString&gt;
<a name="l00038"></a>00038 {
<a name="l00039"></a>00039   <a class="code" href="classcsString.html" title="Thin wrapper around csStringFast&amp;lt;&amp;gt; with its default buffer size.">csString</a> s;
<a name="l00040"></a>00040 
<a name="l00041"></a>00041 <span class="keyword">public</span>:
<a name="l00042"></a>00042 
<a name="l00044"></a><a class="code" href="classscfString.html#fa5a85fdd83279fe7fa73ef30d8a57b4">00044</a>   <a class="code" href="classscfString.html" title="This is a thin SCF wrapper around csString.">scfString</a> ()
<a name="l00045"></a>00045     : <a class="code" href="classscfImplementation1.html">scfImplementationType</a> (this)
<a name="l00046"></a>00046   { }
<a name="l00047"></a>00047 
<a name="l00049"></a><a class="code" href="classscfString.html#e6463fd9f747355d0ace7b329a992c84">00049</a>   <a class="code" href="classscfString.html" title="This is a thin SCF wrapper around csString.">scfString</a> (<span class="keywordtype">size_t</span> iLength) 
<a name="l00050"></a>00050     : <a class="code" href="classscfImplementation1.html">scfImplementationType</a> (this), s(iLength)
<a name="l00051"></a>00051   { }
<a name="l00052"></a>00052 
<a name="l00054"></a><a class="code" href="classscfString.html#16a10f5477b78874f2bbaccdd0d78e35">00054</a>   <a class="code" href="classscfString.html" title="This is a thin SCF wrapper around csString.">scfString</a> (<span class="keyword">const</span> <a class="code" href="structiString.html" title="This is a SCF-compatible interface for csString.">iString</a> &amp;copy) 
<a name="l00055"></a>00055     : <a class="code" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one...">iBase</a>(), <a class="code" href="classscfImplementation1.html">scfImplementationType</a> (this), s(copy.GetData())
<a name="l00056"></a>00056   { }
<a name="l00057"></a>00057 
<a name="l00059"></a><a class="code" href="classscfString.html#0a52b9a714380dadf4676823b8ddaa10">00059</a>   <a class="code" href="classscfString.html" title="This is a thin SCF wrapper around csString.">scfString</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> *copy) 
<a name="l00060"></a>00060     : <a class="code" href="classscfImplementation1.html">scfImplementationType</a> (this), s(copy)
<a name="l00061"></a>00061   { }
<a name="l00062"></a>00062 
<a name="l00064"></a><a class="code" href="classscfString.html#26bbc5cf03859253969ca96d741701b4">00064</a>   <span class="keyword">virtual</span> ~<a class="code" href="classscfString.html" title="This is a thin SCF wrapper around csString.">scfString</a> ()
<a name="l00065"></a>00065   { }
<a name="l00066"></a>00066 
<a name="l00068"></a><a class="code" href="classscfString.html#7aa9826d1ac3e74f87e8cd70710c46a5">00068</a>   <span class="keyword">const</span> <a class="code" href="classcsString.html" title="Thin wrapper around csStringFast&amp;lt;&amp;gt; with its default buffer size.">csString</a>&amp; GetCsString ()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> s; }
<a name="l00069"></a>00069 
<a name="l00071"></a><a class="code" href="classscfString.html#75fd36838ac5e928483e268bd5ecab16">00071</a>   <a class="code" href="classcsString.html" title="Thin wrapper around csStringFast&amp;lt;&amp;gt; with its default buffer size.">csString</a>&amp; GetCsString () { <span class="keywordflow">return</span> s; }
<a name="l00072"></a>00072 
<a name="l00074"></a>00074   <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetCapacity (<span class="keywordtype">size_t</span> NewSize);
<a name="l00076"></a>00076   <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> GetCapacity() <span class="keyword">const</span>;
<a name="l00078"></a>00078   <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetGrowsBy(<span class="keywordtype">size_t</span>);
<a name="l00080"></a>00080   <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> GetGrowsBy() <span class="keyword">const</span>;
<a name="l00081"></a>00081 
<a name="l00083"></a>00083   <span class="keyword">virtual</span> <span class="keywordtype">void</span> Truncate (<span class="keywordtype">size_t</span> iPos);
<a name="l00084"></a>00084 
<a name="l00086"></a>00086   <span class="keyword">virtual</span> <span class="keywordtype">void</span> ShrinkBestFit ();
<a name="l00087"></a>00087 
<a name="l00088"></a>00088 
<a name="l00090"></a>00090   <span class="keyword">virtual</span> <span class="keywordtype">void</span> Empty ();
<a name="l00091"></a>00091 
<a name="l00096"></a>00096   <span class="comment">/* CS_DEPRECATED_METHOD_MSG("Use Empty() instead.") */</span> 
<a name="l00097"></a><a class="code" href="classscfString.html#c91dbdb12d4869daf2fface71ff0c23b">00097</a>   <span class="keyword">virtual</span> <span class="keywordtype">void</span> Clear ()
<a name="l00098"></a>00098   { Empty(); }
<a name="l00099"></a>00099 
<a name="l00101"></a>00101   <span class="keyword">virtual</span> <a class="code" href="classcsRef.html" title="A smart pointer.">csRef&lt;iString&gt;</a> Clone () <span class="keyword">const</span>;
<a name="l00102"></a>00102 
<a name="l00104"></a>00104   <span class="keyword">virtual</span> <span class="keywordtype">char</span> <span class="keyword">const</span>* GetData () <span class="keyword">const</span>;
<a name="l00105"></a>00105 
<a name="l00107"></a>00107   <span class="comment">/*CS_DEPRECATED_METHOD*/</span> 
<a name="l00108"></a>00108   <span class="comment">// @@@ GCC and VC always seem to prefer this GetData() and barf "deprecated".</span>
<a name="l00109"></a>00109   <span class="keyword">virtual</span> <span class="keywordtype">char</span>* GetData ();
<a name="l00110"></a>00110 
<a name="l00112"></a>00112   <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> Length () <span class="keyword">const</span>;
<a name="l00113"></a>00113 
<a name="l00115"></a>00115   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> IsEmpty () <span class="keyword">const</span>;
<a name="l00116"></a>00116 
<a name="l00118"></a>00118   <span class="keyword">virtual</span> <span class="keywordtype">char</span>&amp; operator [] (<span class="keywordtype">size_t</span> iPos);
<a name="l00119"></a>00119 
<a name="l00121"></a>00121   <span class="keyword">virtual</span> <span class="keywordtype">char</span> operator [] (<span class="keywordtype">size_t</span> iPos) <span class="keyword">const</span>;
<a name="l00122"></a>00122 
<a name="l00124"></a>00124   <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetAt (<span class="keywordtype">size_t</span> iPos, <span class="keywordtype">char</span> iChar);
<a name="l00125"></a>00125 
<a name="l00127"></a>00127   <span class="keyword">virtual</span> <span class="keywordtype">char</span> GetAt (<span class="keywordtype">size_t</span> iPos) <span class="keyword">const</span>;
<a name="l00128"></a>00128 
<a name="l00130"></a>00130   <span class="keyword">virtual</span> <span class="keywordtype">void</span> DeleteAt (<span class="keywordtype">size_t</span> iPos, <span class="keywordtype">size_t</span> iCount);
<a name="l00131"></a>00131 
<a name="l00133"></a>00133   <span class="keyword">virtual</span> <span class="keywordtype">void</span> Insert (<span class="keywordtype">size_t</span> iPos, <a class="code" href="structiString.html" title="This is a SCF-compatible interface for csString.">iString</a> <span class="keyword">const</span>* iStr);
<a name="l00134"></a>00134 
<a name="l00136"></a>00136   <span class="keyword">virtual</span> <span class="keywordtype">void</span> Overwrite (<span class="keywordtype">size_t</span> iPos, <a class="code" href="structiString.html" title="This is a SCF-compatible interface for csString.">iString</a> <span class="keyword">const</span>* iStr);
<a name="l00137"></a>00137 
<a name="l00139"></a>00139   <span class="keyword">virtual</span> <span class="keywordtype">void</span> Append (<span class="keyword">const</span> <span class="keywordtype">char</span>* iStr, <span class="keywordtype">size_t</span> iCount = (<span class="keywordtype">size_t</span>)-1);
<a name="l00140"></a>00140 
<a name="l00142"></a>00142   <span class="keyword">virtual</span> <span class="keywordtype">void</span> Append (<a class="code" href="structiString.html" title="This is a SCF-compatible interface for csString.">iString</a> <span class="keyword">const</span>* iStr, <span class="keywordtype">size_t</span> iCount = (<span class="keywordtype">size_t</span>)-1);
<a name="l00143"></a>00143 
<a name="l00145"></a>00145   <span class="keyword">virtual</span> <span class="keywordtype">void</span> Append (<span class="keywordtype">char</span> c);
<a name="l00146"></a>00146 
<a name="l00153"></a>00153   <span class="keyword">virtual</span> <a class="code" href="classcsRef.html" title="A smart pointer.">csRef&lt;iString&gt;</a> Slice (<span class="keywordtype">size_t</span> start=0, <span class="keywordtype">size_t</span> len=(<span class="keywordtype">size_t</span>)-1) <span class="keyword">const</span>;
<a name="l00154"></a>00154 
<a name="l00162"></a>00162   <span class="keyword">virtual</span> <a class="code" href="classcsRef.html" title="A smart pointer.">csRef&lt;iString&gt;</a> ReverseSlice (<span class="keywordtype">size_t</span> start,
<a name="l00163"></a>00163         <span class="keywordtype">size_t</span> len=(<span class="keywordtype">size_t</span>)-1) <span class="keyword">const</span>;
<a name="l00164"></a>00164 
<a name="l00171"></a>00171   <span class="keyword">virtual</span> <span class="keywordtype">void</span> SubString (<a class="code" href="structiString.html" title="This is a SCF-compatible interface for csString.">iString</a>* sub, <span class="keywordtype">size_t</span> start,
<a name="l00172"></a>00172         <span class="keywordtype">size_t</span> len=(<span class="keywordtype">size_t</span>)-1) <span class="keyword">const</span>;
<a name="l00173"></a>00173 
<a name="l00183"></a>00183   <span class="keyword">virtual</span> <span class="keywordtype">void</span> ReverseSubString (<a class="code" href="structiString.html" title="This is a SCF-compatible interface for csString.">iString</a>* sub, <span class="keywordtype">size_t</span> start=0,
<a name="l00184"></a>00184         <span class="keywordtype">size_t</span> len=(<span class="keywordtype">size_t</span>)-1) <span class="keyword">const</span>;
<a name="l00185"></a>00185 
<a name="l00190"></a>00190   <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> FindFirst (<span class="keyword">const</span> <span class="keywordtype">char</span> c, <span class="keywordtype">size_t</span> p = (<span class="keywordtype">size_t</span>)-1) <span class="keyword">const</span>;
<a name="l00196"></a>00196   <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> FindLast (<span class="keyword">const</span> <span class="keywordtype">char</span> c, <span class="keywordtype">size_t</span> p = (<span class="keywordtype">size_t</span>)-1) <span class="keyword">const</span>;
<a name="l00197"></a>00197 
<a name="l00204"></a>00204   <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> Find (<span class="keyword">const</span> <span class="keywordtype">char</span>* search, <span class="keywordtype">size_t</span> pos = 0) <span class="keyword">const</span>;
<a name="l00205"></a>00205 
<a name="l00210"></a>00210   <span class="keyword">virtual</span> <span class="keywordtype">void</span> ReplaceAll (<span class="keyword">const</span> <span class="keywordtype">char</span>* search, <span class="keyword">const</span> <span class="keywordtype">char</span>* replacement);
<a name="l00211"></a>00211 
<a name="l00216"></a>00216   <span class="keyword">virtual</span> <span class="keywordtype">void</span> Format (<span class="keyword">const</span> <span class="keywordtype">char</span>* format, ...) <a class="code" href="cssysdef_8h.html#8e48e51430e3babbaf943b676c17ec31">CS_GNUC_PRINTF</a> (2, 3);
<a name="l00221"></a>00221   virtual <span class="keywordtype">void</span> FormatV (const <span class="keywordtype">char</span>* format, va_list args);
<a name="l00222"></a>00222 
<a name="l00224"></a>00224   virtual <span class="keywordtype">void</span> Replace (const <a class="code" href="structiString.html" title="This is a SCF-compatible interface for csString.">iString</a>* iStr, <span class="keywordtype">size_t</span> iCount = (<span class="keywordtype">size_t</span>)-1);
<a name="l00225"></a>00225 
<a name="l00227"></a>00227   virtual <span class="keywordtype">void</span> Replace (const <span class="keywordtype">char</span>* iStr, <span class="keywordtype">size_t</span> iCount = (<span class="keywordtype">size_t</span>)-1);
<a name="l00228"></a>00228 
<a name="l00230"></a>00230   virtual <span class="keywordtype">bool</span> Compare (const <a class="code" href="structiString.html" title="This is a SCF-compatible interface for csString.">iString</a>* iStr) const;
<a name="l00231"></a>00231 
<a name="l00233"></a>00233   virtual <span class="keywordtype">bool</span> CompareNoCase (const <a class="code" href="structiString.html" title="This is a SCF-compatible interface for csString.">iString</a>* iStr) const;
<a name="l00234"></a>00234 
<a name="l00236"></a>00236   virtual <span class="keywordtype">bool</span> Compare (const <span class="keywordtype">char</span>* iStr) const;
<a name="l00237"></a>00237 
<a name="l00239"></a>00239   virtual <span class="keywordtype">bool</span> CompareNoCase (const <span class="keywordtype">char</span>* iStr) const;
<a name="l00240"></a>00240 
<a name="l00242"></a>00242   virtual <span class="keywordtype">bool</span> StartsWith (const <a class="code" href="structiString.html" title="This is a SCF-compatible interface for csString.">iString</a>* iStr, <span class="keywordtype">bool</span> ignore_case = false) const;
<a name="l00243"></a>00243 
<a name="l00245"></a>00245   virtual <span class="keywordtype">bool</span> StartsWith (const <span class="keywordtype">char</span>* iStr, <span class="keywordtype">bool</span> ignore_case = false) const;
<a name="l00246"></a>00246 
<a name="l00248"></a>00248   virtual <span class="keywordtype">void</span> operator += (const <a class="code" href="structiString.html" title="This is a SCF-compatible interface for csString.">iString</a>&amp; iStr);
<a name="l00249"></a>00249 
<a name="l00251"></a>00251   virtual <span class="keywordtype">void</span> operator += (const <span class="keywordtype">char</span>* iStr);
<a name="l00252"></a>00252 
<a name="l00254"></a>00254   virtual <span class="keywordtype">void</span> operator += (<span class="keywordtype">char</span> c);
<a name="l00255"></a>00255 
<a name="l00257"></a>00257   virtual <a class="code" href="classcsRef.html" title="A smart pointer.">csRef</a>&lt;<a class="code" href="structiString.html" title="This is a SCF-compatible interface for csString.">iString</a>&gt; operator + (const <a class="code" href="structiString.html" title="This is a SCF-compatible interface for csString.">iString</a> &amp;iStr) const;
<a name="l00258"></a>00258 
<a name="l00260"></a>00260   virtual operator <span class="keywordtype">char</span> const* () const;
<a name="l00261"></a>00261 
<a name="l00263"></a>00263   virtual <span class="keywordtype">bool</span> operator == (const <a class="code" href="structiString.html" title="This is a SCF-compatible interface for csString.">iString</a> &amp;iStr) const;
<a name="l00264"></a>00264 
<a name="l00266"></a>00266   virtual <span class="keywordtype">bool</span> operator != (const <a class="code" href="structiString.html" title="This is a SCF-compatible interface for csString.">iString</a> &amp;iStr) const;
<a name="l00267"></a>00267 
<a name="l00269"></a>00269   virtual <span class="keywordtype">void</span> Downcase();
<a name="l00270"></a>00270 
<a name="l00272"></a>00272   virtual <span class="keywordtype">void</span> Upcase();
<a name="l00273"></a>00273 };
<a name="l00274"></a>00274 
<a name="l00275"></a>00275 <span class="preprocessor">#include "csutil/win32/msvc_deprecated_warn_on.h"</span>
<a name="l00276"></a>00276 <span class="preprocessor"></span>
<a name="l00277"></a>00277 <span class="preprocessor">#endif // __CS_SCFSTR_H__</span>
</pre></div><hr size="1"><address><small>Generated for Crystal Space 1.2.1 by 
<a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3 
</small></address> </div></body> </html>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional