<!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: csInstallationPathsHelper Class Reference (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 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 class="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<h1>csInstallationPathsHelper Class Reference<br>
<small>
[<a class="el" href="group__util.html">Utilities</a>]</small>
</h1><!-- doxytag: class="csInstallationPathsHelper" -->A helper class containing a number of functions to deal with Crystal Space installation paths.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="syspath_8h-source.html">csutil/syspath.h</a>></code>
<p>
<p>
<a href="classcsInstallationPathsHelper-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classcsRef.html">csRef</a><br>
< <a class="el" href="structiStringArray.html">iStringArray</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsInstallationPathsHelper.html#8c0253deab2b0cbc5067cf01f632febb">FindSystemRoots</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the list of root directories. <a href="#8c0253deab2b0cbc5067cf01f632febb"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classcsString.html">csString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsInstallationPathsHelper.html#41065f68bfc0799e4511194510609001">GetAppDir</a> (const char *argv0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the directory in which the application executable resides. <a href="#41065f68bfc0799e4511194510609001"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classcsString.html">csString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsInstallationPathsHelper.html#097a0ef04fb4c4143542127d9951878a">GetAppFilename</a> (const char *basename)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructs an executable filename given a basename. <a href="#097a0ef04fb4c4143542127d9951878a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classcsString.html">csString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsInstallationPathsHelper.html#f4822a50a2c13ebaa666923f5b4bb903">GetAppPath</a> (const char *argv0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the absolute path of the executable. <a href="#f4822a50a2c13ebaa666923f5b4bb903"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classcsPathsList.html">csPathsList</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsInstallationPathsHelper.html#401c6f50340948d17d5886c17eaffae2">GetPlatformInstallationPaths</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return one or more paths which themselves or whose subdirectories can contain CrystalSpace-related resources, plugins as well as common data and configuration. <a href="#401c6f50340948d17d5886c17eaffae2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classcsPathsList.html">csPathsList</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsInstallationPathsHelper.html#0ddc0f46489f8f49607d7bafdda8e6b4">GetPluginPaths</a> (const char *argv0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a list of directories where plugins are installed. <a href="#0ddc0f46489f8f49607d7bafdda8e6b4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classcsString.html">csString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsInstallationPathsHelper.html#059d5c0c6d44e5915162f30e19cfdf40">GetResourceDir</a> (const char *argv0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the directory in which the application's resources reside. <a href="#059d5c0c6d44e5915162f30e19cfdf40"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A helper class containing a number of functions to deal with Crystal Space installation paths.
<p>Definition at line <a class="el" href="syspath_8h-source.html#l00273">273</a> of file <a class="el" href="syspath_8h-source.html">syspath.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="8c0253deab2b0cbc5067cf01f632febb"></a><!-- doxytag: member="csInstallationPathsHelper::FindSystemRoots" ref="8c0253deab2b0cbc5067cf01f632febb" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classcsRef.html">csRef</a><<a class="el" href="structiStringArray.html">iStringArray</a>> csInstallationPathsHelper::FindSystemRoots </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the list of root directories.
<p>
For instance in Unix it simply returns '/' but for Windows it may return a list of available drive letters.
</div>
</div><p>
<a class="anchor" name="41065f68bfc0799e4511194510609001"></a><!-- doxytag: member="csInstallationPathsHelper::GetAppDir" ref="41065f68bfc0799e4511194510609001" args="(const char *argv0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classcsString.html">csString</a> csInstallationPathsHelper::GetAppDir </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>argv0</em> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the directory in which the application executable resides.
<p>
For MacOS/X, returns the directory in which the Cocoa application wrapper resides. <dl class="remark" compact><dt><b>Remarks:</b></dt><dd>May return the empty string if some problem prevents determination of the application's directory. <p>
This function is primarily intended for very low-level use before or during the initialization of <a class="el" href="namespaceCS.html" title="Main namespace for CrystalSpace.">CS</a> core components. After initialization, it is often more convenient to invoke <a class="el" href="structiCommandLineParser.html#5acb76c6b6fa5d8341484419f746cf85" title="Returns the directory in which the application executable resides; or the directory...">iCommandLineParser::GetAppDir()</a>. </dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>argv0</em> </td><td>The first element of the argv[] array passed to main(). On many platforms, this is the only way to determine the actual location of the executable. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="097a0ef04fb4c4143542127d9951878a"></a><!-- doxytag: member="csInstallationPathsHelper::GetAppFilename" ref="097a0ef04fb4c4143542127d9951878a" args="(const char *basename)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classcsString.html">csString</a> csInstallationPathsHelper::GetAppFilename </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>basename</em> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructs an executable filename given a basename.
<p>
</div>
</div><p>
<a class="anchor" name="f4822a50a2c13ebaa666923f5b4bb903"></a><!-- doxytag: member="csInstallationPathsHelper::GetAppPath" ref="f4822a50a2c13ebaa666923f5b4bb903" args="(const char *argv0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classcsString.html">csString</a> csInstallationPathsHelper::GetAppPath </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>argv0</em> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the absolute path of the executable.
<p>
For MacOS/X, returns the absolute path of the executable within the Cocoa application wrapper. <dl class="remark" compact><dt><b>Remarks:</b></dt><dd>May return the empty string if some problem prevents determination of the application's path. <p>
This function is primarily intended for very low-level use before or during the initialization of <a class="el" href="namespaceCS.html" title="Main namespace for CrystalSpace.">CS</a> core components. After initialization, it is often more convenient to invoke <a class="el" href="structiCommandLineParser.html#9cdab73efb60f1717cdef1063117263d" title="Returns the full path to the application executable.">iCommandLineParser::GetAppPath()</a>. </dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>argv0</em> </td><td>The first element of the argv[] array passed to main(). On many platforms, this is the only way to determine the actual location of the executable. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="401c6f50340948d17d5886c17eaffae2"></a><!-- doxytag: member="csInstallationPathsHelper::GetPlatformInstallationPaths" ref="401c6f50340948d17d5886c17eaffae2" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classcsPathsList.html">csPathsList</a>* csInstallationPathsHelper::GetPlatformInstallationPaths </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return one or more paths which themselves or whose subdirectories can contain CrystalSpace-related resources, plugins as well as common data and configuration.
<p>
There's no guarantee that any entry actually contains some useable resource; it's up to the caller to check what resources are available and to pick the appropriate entries for some purpose. <dl class="remark" compact><dt><b>Remarks:</b></dt><dd>Caller is responsible to free the list with delete after using it. </dd></dl>
</div>
</div><p>
<a class="anchor" name="0ddc0f46489f8f49607d7bafdda8e6b4"></a><!-- doxytag: member="csInstallationPathsHelper::GetPluginPaths" ref="0ddc0f46489f8f49607d7bafdda8e6b4" args="(const char *argv0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classcsPathsList.html">csPathsList</a>* csInstallationPathsHelper::GetPluginPaths </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>argv0</em> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get a list of directories where plugins are installed.
<p>
<dl class="remark" compact><dt><b>Remarks:</b></dt><dd>Caller is responsible to free the list with delete after using it. </dd></dl>
</div>
</div><p>
<a class="anchor" name="059d5c0c6d44e5915162f30e19cfdf40"></a><!-- doxytag: member="csInstallationPathsHelper::GetResourceDir" ref="059d5c0c6d44e5915162f30e19cfdf40" args="(const char *argv0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classcsString.html">csString</a> csInstallationPathsHelper::GetResourceDir </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>argv0</em> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the directory in which the application's resources reside.
<p>
On many platforms, resources (such as plugin modules) reside in the same directory as the application itself. The default implementation returns the same value as csGetAppPath(), however platforms may want to override the default implementation if this behavior is unsuitable. For example, on MacOS/X, for GUI applications, resources reside in the "Resources" directory within the Cocoa application wrapper. <dl class="remark" compact><dt><b>Remarks:</b></dt><dd>May return the empty string if some problem prevents determination of the resource path. <p>
This function is primarily intended for very low-level use before or during the initialization of <a class="el" href="namespaceCS.html" title="Main namespace for CrystalSpace.">CS</a> core components. After initialization, it is often more convenient to invoke <a class="el" href="structiCommandLineParser.html#d1c6d069c77096ff2fd1309b9b4aa549" title="Returns the directory in which the application's resources resides.">iCommandLineParser::GetResourceDir()</a>. </dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>argv0</em> </td><td>The first element of the argv[] array passed to main(). On many platforms, this is the only way to determine the actual location of the resources. </td></tr>
</table>
</dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>csutil/<a class="el" href="syspath_8h-source.html">syspath.h</a></ul>
<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>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
bad97183153701b09df5fae1052b1c30
>
files
>
690
