Sophie

Sophie

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

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/scfstringarray.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/scfstringarray.h</h1><a href="scfstringarray_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 Array SCF interface</span>
<a name="l00003"></a>00003 <span class="comment">    Copyright (C) 2003 by Jorrit Tyberghein</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_SCFSTRINGARRAY_H__</span>
<a name="l00021"></a>00021 <span class="preprocessor"></span><span class="preprocessor">#define __CS_SCFSTRINGARRAY_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 <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="l00029"></a>00029 <span class="preprocessor">#include "<a class="code" href="csutil_2stringarray_8h.html" title="Array of strings.">csutil/stringarray.h</a>"</span>
<a name="l00030"></a>00030 <span class="preprocessor">#include "<a class="code" href="iutil_2stringarray_8h.html" title="String Array interface.">iutil/stringarray.h</a>"</span>
<a name="l00031"></a>00031 
<a name="l00033"></a><a class="code" href="classscfStringArray.html">00033</a> <span class="keyword">class </span><a class="code" href="classscfStringArray.html" title="This class is a thin wrapper around csStringArray with SCF capability.">scfStringArray</a> : <span class="keyword">public</span> <a class="code" href="classscfImplementation1.html">scfImplementation1</a>&lt;scfStringArray, 
<a name="l00034"></a>00034                                                    iStringArray&gt;
<a name="l00035"></a>00035 {
<a name="l00036"></a>00036   <a class="code" href="classcsStringArray.html" title="An array of strings.">csStringArray</a> v;
<a name="l00037"></a>00037 
<a name="l00038"></a>00038 <span class="keyword">public</span>:
<a name="l00039"></a>00039 
<a name="l00041"></a><a class="code" href="classscfStringArray.html#7d134bf0b4c28f77d23ed415525a1ba5">00041</a>   <a class="code" href="classscfStringArray.html#7d134bf0b4c28f77d23ed415525a1ba5" title="Create a iStringArray from scratch.">scfStringArray</a> (<span class="keywordtype">int</span> limit = 16, <span class="keywordtype">int</span> delta = 16) 
<a name="l00042"></a>00042     : <a class="code" href="classscfImplementation1.html">scfImplementationType</a> (this), v (limit, delta)
<a name="l00043"></a>00043   { }
<a name="l00044"></a>00044 
<a name="l00046"></a><a class="code" href="classscfStringArray.html#66d1087f23b229406b60ee6b438f879f">00046</a>   <span class="keyword">virtual</span> <a class="code" href="classscfStringArray.html#66d1087f23b229406b60ee6b438f879f" title="Destructor - nothing to do.">~scfStringArray</a> ()
<a name="l00047"></a>00047   { }
<a name="l00048"></a>00048 
<a name="l00050"></a><a class="code" href="classscfStringArray.html#4ae1b4214e8b22c71d24fca965ee1969">00050</a>   <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> <a class="code" href="classscfStringArray.html#4ae1b4214e8b22c71d24fca965ee1969" title="Get array length.">GetSize</a> ()<span class="keyword"> const</span>
<a name="l00051"></a>00051 <span class="keyword">  </span>{
<a name="l00052"></a>00052     <span class="keywordflow">return</span> v.<a class="code" href="classcsArray.html#d9707ffab9a7c3f30f76189f6a1ac7c2" title="Return the number of elements in the array.">GetSize</a> ();
<a name="l00053"></a>00053   }
<a name="l00054"></a>00054 
<a name="l00059"></a>00059   <a class="code" href="cssysdef_8h.html#69b27a22db26f4a2bb7a26a85d2ab06b" title="A variant of CS_DEPRECATED_METHOD that also emits the message msg on compilers that...">CS_DEPRECATED_METHOD_MSG</a>(<span class="stringliteral">"Use GetSize() instead."</span>)
<a name="l00060"></a><a class="code" href="classscfStringArray.html#777146a7b59384c2143a13d1fe86dd61">00060</a>   virtual <span class="keywordtype">size_t</span> <a class="code" href="classscfStringArray.html#777146a7b59384c2143a13d1fe86dd61" title="Get array length.">Length</a> ()<span class="keyword"> const</span>
<a name="l00061"></a>00061 <span class="keyword">  </span>{
<a name="l00062"></a>00062     <span class="keywordflow">return</span> <a class="code" href="classscfStringArray.html#4ae1b4214e8b22c71d24fca965ee1969" title="Get array length.">GetSize</a> ();
<a name="l00063"></a>00063   }
<a name="l00064"></a>00064 
<a name="l00066"></a><a class="code" href="classscfStringArray.html#448d86dd33e51449b5a8222aaa5559cc">00066</a>   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classscfStringArray.html#448d86dd33e51449b5a8222aaa5559cc" title="Push a string onto the stack.">Push</a> (<span class="keywordtype">char</span> <span class="keyword">const</span> *value)
<a name="l00067"></a>00067   {
<a name="l00068"></a>00068     v.<a class="code" href="classcsArray.html#6c1acc9a8bdc9d19272f5236089c6b5b" title="Push a copy of an element onto the tail end of the array.">Push</a> ((<span class="keywordtype">char</span>*)value);
<a name="l00069"></a>00069   }
<a name="l00070"></a>00070 
<a name="l00076"></a><a class="code" href="classscfStringArray.html#bc404ef75ee8872f66eb6501bf5ddf4f">00076</a>   <span class="keyword">virtual</span> <span class="keywordtype">char</span> *<a class="code" href="classscfStringArray.html#bc404ef75ee8872f66eb6501bf5ddf4f" title="Pop an element from tail end of array.">Pop</a> ()
<a name="l00077"></a>00077   {
<a name="l00078"></a>00078     <span class="keywordflow">return</span> v.<a class="code" href="classcsStringArray.html#684775c584254b62620c486fbb6b36e3" title="Pop an element from tail end of array.">Pop</a> ();
<a name="l00079"></a>00079   }
<a name="l00080"></a>00080 
<a name="l00082"></a><a class="code" href="classscfStringArray.html#1cecb0cdce1491e25f05196b8f9d25f0">00082</a>   <span class="keyword">virtual</span> <span class="keywordtype">char</span> <span class="keyword">const</span> *<a class="code" href="classscfStringArray.html#1cecb0cdce1491e25f05196b8f9d25f0" title="Get a particular string from the array.">Get</a> (<span class="keywordtype">size_t</span> n)<span class="keyword"> const</span>
<a name="l00083"></a>00083 <span class="keyword">  </span>{
<a name="l00084"></a>00084     <span class="keywordflow">return</span> v.<a class="code" href="classcsArray.html#b4deb6da0262469c90355af478ed88a1" title="Get an element (non-const).">Get</a> (n);
<a name="l00085"></a>00085   }
<a name="l00086"></a>00086 
<a name="l00093"></a><a class="code" href="classscfStringArray.html#17a1300ee30f82291ce4503b30f9b582">00093</a>   <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> <a class="code" href="classscfStringArray.html#17a1300ee30f82291ce4503b30f9b582" title="Find a string, case-sensitive.">Find</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> *value)<span class="keyword"> const</span>
<a name="l00094"></a>00094 <span class="keyword">  </span>{
<a name="l00095"></a>00095     <span class="keywordflow">return</span> v.<a class="code" href="classcsStringArray.html#516fdf7ec599e20902d34682a4df3beb" title="Find a string, case-sensitive.">Find</a> (value);
<a name="l00096"></a>00096   }
<a name="l00097"></a>00097 
<a name="l00104"></a><a class="code" href="classscfStringArray.html#61d3f920a20538eff0591d012d348040">00104</a>   <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> <a class="code" href="classscfStringArray.html#61d3f920a20538eff0591d012d348040" title="Find a string, case-insensitive.">FindCaseInsensitive</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> *value)<span class="keyword"> const</span>
<a name="l00105"></a>00105 <span class="keyword">  </span>{
<a name="l00106"></a>00106     <span class="keywordflow">return</span> v.<a class="code" href="classcsStringArray.html#e25a7fea82fb68943458c363398a682b" title="Find a string, case-insensitive.">FindCaseInsensitive</a> (value);
<a name="l00107"></a>00107   }
<a name="l00108"></a>00108 
<a name="l00114"></a><a class="code" href="classscfStringArray.html#930deb9c7bb378104c326498589d9447">00114</a>   <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> <a class="code" href="classscfStringArray.html#930deb9c7bb378104c326498589d9447" title="Find an element based on some key, using a comparison function.">FindSortedKey</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> *value)<span class="keyword"> const</span>
<a name="l00115"></a>00115 <span class="keyword">  </span>{
<a name="l00116"></a>00116     <span class="keywordflow">return</span> v.<a class="code" href="classcsStringArray.html#d9621a47fea0bb28dcc0372ed34bcf0c" title="Find an element based on some key, using a comparison function.">FindSortedKey</a> ((<span class="keywordtype">char</span>*)value);
<a name="l00117"></a>00117   }
<a name="l00118"></a>00118 
<a name="l00130"></a><a class="code" href="classscfStringArray.html#98b5c5e6327f8912ade8624a17e0c7c3">00130</a>   <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> <a class="code" href="classscfStringArray.html#98b5c5e6327f8912ade8624a17e0c7c3" title="Alias for Find() and FindCaseInsensitive().">Contains</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* str, <span class="keywordtype">bool</span> case_sensitive = <span class="keyword">true</span>)<span class="keyword"> const</span>
<a name="l00131"></a>00131 <span class="keyword">  </span>{
<a name="l00132"></a>00132     <span class="keywordflow">return</span> v.<a class="code" href="classcsStringArray.html#84d083bce94aa101eef0d13d6e21a5d7" title="Alias for Find() and FindCaseInsensitive().">Contains</a> (str, case_sensitive);
<a name="l00133"></a>00133   }
<a name="l00134"></a>00134 
<a name="l00140"></a><a class="code" href="classscfStringArray.html#9d9152ddf058d6cb254f4cf72db6dd68">00140</a>   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classscfStringArray.html#9d9152ddf058d6cb254f4cf72db6dd68" title="Sort array.">Sort</a> (<span class="keywordtype">bool</span> case_sensitive = <span class="keyword">true</span>)
<a name="l00141"></a>00141   {
<a name="l00142"></a>00142     v.<a class="code" href="classcsStringArray.html#668d83c5174cf71444631fa8888f9bea" title="Sort array based on comparison function.">Sort</a> (case_sensitive);
<a name="l00143"></a>00143   }
<a name="l00144"></a>00144 
<a name="l00146"></a><a class="code" href="classscfStringArray.html#a4e489ec1cce5bf6ffe063caa4f02ecd">00146</a>   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classscfStringArray.html#a4e489ec1cce5bf6ffe063caa4f02ecd" title="Delete string n from the array.">DeleteIndex</a> (<span class="keywordtype">size_t</span> n)
<a name="l00147"></a>00147   {
<a name="l00148"></a>00148     <span class="keywordflow">return</span> v.<a class="code" href="classcsArray.html#10a2afd5172c671fb32c70b4f6e538e8" title="Delete an element from the array.">DeleteIndex</a> (n);
<a name="l00149"></a>00149   }
<a name="l00150"></a>00150 
<a name="l00152"></a><a class="code" href="classscfStringArray.html#c6f085440cffaee49b2cb79e6b40fa70">00152</a>   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classscfStringArray.html#c6f085440cffaee49b2cb79e6b40fa70" title="Insert a string before entry n in the array.">Insert</a> (<span class="keywordtype">size_t</span> n, <span class="keywordtype">char</span> <span class="keyword">const</span> *value)
<a name="l00153"></a>00153   {
<a name="l00154"></a>00154     <span class="keywordflow">return</span> v.<a class="code" href="classcsArray.html#cb7c457a1f3c1f34be11ec3e1de7100c" title="Insert element item before element n.">Insert</a> (n, (<span class="keywordtype">char</span>*)value);
<a name="l00155"></a>00155   }
<a name="l00156"></a>00156 
<a name="l00158"></a><a class="code" href="classscfStringArray.html#ffc576367c3b02a7df273632c097c1c7">00158</a>   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classscfStringArray.html#ffc576367c3b02a7df273632c097c1c7" title="Remove all strings from array, releasing allocated memory.">Empty</a> ()
<a name="l00159"></a>00159   {
<a name="l00160"></a>00160     v.<a class="code" href="classcsArray.html#e602bfe2feb67cac781c27bf2bef3e91" title="Remove all elements.">Empty</a>();
<a name="l00161"></a>00161   }
<a name="l00162"></a>00162 
<a name="l00167"></a>00167   <a class="code" href="cssysdef_8h.html#69b27a22db26f4a2bb7a26a85d2ab06b" title="A variant of CS_DEPRECATED_METHOD that also emits the message msg on compilers that...">CS_DEPRECATED_METHOD_MSG</a>(<span class="stringliteral">"Use Empty() instead."</span>)
<a name="l00168"></a><a class="code" href="classscfStringArray.html#cf2af2abadb57e25e26dfa85906e5d0a">00168</a>   virtual <span class="keywordtype">void</span> <a class="code" href="classscfStringArray.html#cf2af2abadb57e25e26dfa85906e5d0a" title="Remove all strings from array.">DeleteAll</a> ()
<a name="l00169"></a>00169   {
<a name="l00170"></a>00170     <a class="code" href="classscfStringArray.html#ffc576367c3b02a7df273632c097c1c7" title="Remove all strings from array, releasing allocated memory.">Empty</a>();
<a name="l00171"></a>00171   }
<a name="l00172"></a>00172 
<a name="l00178"></a><a class="code" href="classscfStringArray.html#9611f532c3ac75c2e460ae9253f35e29">00178</a>   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classscfStringArray.html#9611f532c3ac75c2e460ae9253f35e29" title="Return true if the array is empty.">IsEmpty</a>()<span class="keyword"> const</span>
<a name="l00179"></a>00179 <span class="keyword">  </span>{
<a name="l00180"></a>00180     <span class="keywordflow">return</span> v.<a class="code" href="classcsArray.html#18b2ea2b0161b083a7ce1037738eb872" title="Return true if the array is empty.">IsEmpty</a>();
<a name="l00181"></a>00181   }
<a name="l00182"></a>00182 };
<a name="l00183"></a>00183 
<a name="l00184"></a>00184 <span class="preprocessor">#endif // __CS_SCFSTRINGARRAY_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