Sophie

Sophie

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

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: iutil/cmdline.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>iutil/cmdline.h</h1><a href="iutil_2cmdline_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">    Copyright (C) 1998,1999,2000 by Jorrit Tyberghein</span>
<a name="l00003"></a>00003 <span class="comment"></span>
<a name="l00004"></a>00004 <span class="comment">    This library is free software; you can redistribute it and/or</span>
<a name="l00005"></a>00005 <span class="comment">    modify it under the terms of the GNU Library General Public</span>
<a name="l00006"></a>00006 <span class="comment">    License as published by the Free Software Foundation; either</span>
<a name="l00007"></a>00007 <span class="comment">    version 2 of the License, or (at your option) any later version.</span>
<a name="l00008"></a>00008 <span class="comment"></span>
<a name="l00009"></a>00009 <span class="comment">    This library is distributed in the hope that it will be useful,</span>
<a name="l00010"></a>00010 <span class="comment">    but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00011"></a>00011 <span class="comment">    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU</span>
<a name="l00012"></a>00012 <span class="comment">    Library General Public License for more details.</span>
<a name="l00013"></a>00013 <span class="comment"></span>
<a name="l00014"></a>00014 <span class="comment">    You should have received a copy of the GNU Library General Public</span>
<a name="l00015"></a>00015 <span class="comment">    License along with this library; if not, write to the Free</span>
<a name="l00016"></a>00016 <span class="comment">    Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.</span>
<a name="l00017"></a>00017 <span class="comment">*/</span>
<a name="l00018"></a>00018 
<a name="l00019"></a>00019 <span class="preprocessor">#ifndef __CS_IUTIL_CMDLINE_H__</span>
<a name="l00020"></a>00020 <span class="preprocessor"></span><span class="preprocessor">#define __CS_IUTIL_CMDLINE_H__</span>
<a name="l00021"></a>00021 <span class="preprocessor"></span>
<a name="l00027"></a>00027 <span class="preprocessor">#include "<a class="code" href="scf__interface_8h.html" title="Crystal Space Shared Class Facility (SCF) - interface creation support.">csutil/scf_interface.h</a>"</span>
<a name="l00028"></a>00028 
<a name="l00029"></a>00029 
<a name="l00030"></a>00030 
<a name="l00041"></a><a class="code" href="structiCommandLineParser.html">00041</a> <span class="keyword">struct </span><a class="code" href="structiCommandLineParser.html" title="A utility class that makes it easier to parse the command line.">iCommandLineParser</a> : <span class="keyword">public</span> <span class="keyword">virtual</span> <a class="code" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one...">iBase</a>
<a name="l00042"></a>00042 {
<a name="l00043"></a>00043   SCF_INTERFACE(<a class="code" href="structiCommandLineParser.html" title="A utility class that makes it easier to parse the command line.">iCommandLineParser</a>, 2,2,0);
<a name="l00049"></a>00049   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiCommandLineParser.html#8d25bc427fec78a269dde101db5531ab" title="Initialize for the given command line.">Initialize</a> (<span class="keywordtype">int</span> argc, <span class="keyword">const</span> <span class="keywordtype">char</span>* <span class="keyword">const</span> argv[]) = 0;
<a name="l00051"></a>00051   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiCommandLineParser.html#bed5ba8c694e129505b6d6174cd58344" title="Clear all options and names.">Reset</a> () = 0;
<a name="l00053"></a>00053   <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="structiCommandLineParser.html#d52917eda5e7f77ef3289840d68e5de2" title="Query specific commandline option (you can query second etc. such option).">GetOption</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> *iName, <span class="keywordtype">size_t</span> iIndex = 0)
<a name="l00054"></a>00054     <span class="keyword">const</span> = 0;
<a name="l00056"></a>00056   <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="structiCommandLineParser.html#59cf7c820eafbe300ede2d1838a13026" title="Query filename specified on commandline (that is, without leading &amp;#39;-&amp;#39;).">GetName</a> (<span class="keywordtype">size_t</span> iIndex = 0) <span class="keyword">const</span> = 0;
<a name="l00058"></a>00058   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiCommandLineParser.html#6a9dc0c50b8b749a811baf25b5bdaaad" title="Add a command-line option to the command-line option array.">AddOption</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> *iName, <span class="keyword">const</span> <span class="keywordtype">char</span> *iValue) = 0;
<a name="l00060"></a>00060   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiCommandLineParser.html#b1c68ce1437771485a37afbeabb8fa16" title="Add a command-line name to the command-line names array.">AddName</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> *iName) = 0;
<a name="l00062"></a>00062   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structiCommandLineParser.html#772e8cdddbe4f7c4bddf824c0ef67995" title="Replace the Nth command-line option with a new value.">ReplaceOption</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> *iName, <span class="keyword">const</span> <span class="keywordtype">char</span> *iValue,
<a name="l00063"></a>00063     <span class="keywordtype">size_t</span> iIndex = 0) = 0;
<a name="l00065"></a>00065   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structiCommandLineParser.html#c7ae0c3765b857d094b42331af2c6932" title="Replace the Nth command-line name with a new value.">ReplaceName</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> *iValue, <span class="keywordtype">size_t</span> iIndex = 0) = 0;
<a name="l00079"></a>00079   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structiCommandLineParser.html#2c5724a88f108f20c67bf0665e958871" title="Check for a -[no]option toggle.">GetBoolOption</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> *iName, 
<a name="l00080"></a>00080     <span class="keywordtype">bool</span> defaultValue = <span class="keyword">false</span>) = 0;
<a name="l00081"></a>00081     
<a name="l00088"></a>00088   <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="structiCommandLineParser.html#d1c6d069c77096ff2fd1309b9b4aa549" title="Returns the directory in which the application&amp;#39;s resources resides.">GetResourceDir</a> () = 0;
<a name="l00089"></a>00089 
<a name="l00094"></a>00094   <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="structiCommandLineParser.html#5acb76c6b6fa5d8341484419f746cf85" title="Returns the directory in which the application executable resides; or the directory...">GetAppDir</a> () = 0;
<a name="l00095"></a>00095 
<a name="l00099"></a>00099   <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="structiCommandLineParser.html#9cdab73efb60f1717cdef1063117263d" title="Returns the full path to the application executable.">GetAppPath</a> () = 0;
<a name="l00100"></a>00100 
<a name="l00102"></a>00102   <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="structiCommandLineParser.html#2fe876b28e464730c8de6ed3fe4c07e6" title="Query the name of the Nth command line option.">GetOptionName</a> (<span class="keywordtype">size_t</span> iIndex) <span class="keyword">const</span> = 0;
<a name="l00103"></a>00103 
<a name="l00105"></a>00105   <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="structiCommandLineParser.html#d52917eda5e7f77ef3289840d68e5de2" title="Query specific commandline option (you can query second etc. such option).">GetOption</a> (<span class="keywordtype">size_t</span> iIndex = 0) <span class="keyword">const</span> = 0;
<a name="l00106"></a>00106 };
<a name="l00107"></a>00107 
<a name="l00110"></a>00110 <span class="preprocessor">#endif // __CS_IUTIL_CMDLINE_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>