<!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: csPathsUtilities 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>csPathsUtilities Class Reference<br> <small> [<a class="el" href="group__util.html">Utilities</a>]</small> </h1><!-- doxytag: class="csPathsUtilities" -->A helper class with path-related utilities. <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="classcsPathsUtilities-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="classcsPathsList.html">csPathsList</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsPathsUtilities.html#880a69a61bf222ff6357bf7cc543bfd2">ExpandAll</a> (const <a class="el" href="classcsPathsList.html">csPathsList</a> &paths)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Expands all paths in a path list. <a href="#880a69a61bf222ff6357bf7cc543bfd2"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">static char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsPathsUtilities.html#8b0691377916e2a3948c523e47c0b1d7">ExpandPath</a> (const char *path)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Expand a native path relative to the current directory. <a href="#8b0691377916e2a3948c523e47c0b1d7"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsPathsUtilities.html#e1e21d183e514183b6a4e2789d743d59">FilterInvalid</a> (<a class="el" href="classcsPathsList.html">csPathsList</a> &paths)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Filter all non-existent items out of a paths list. <a href="#e1e21d183e514183b6a4e2789d743d59"></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="classcsPathsUtilities.html#6474f3af744d3a2af15dccfeb32d4719">LocateFile</a> (const <a class="el" href="classcsPathsList.html">csPathsList</a> &paths, const char *file, bool thorough=false)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Determine which path(s) of a given set contains a given file. <a href="#6474f3af744d3a2af15dccfeb32d4719"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsPathsUtilities.html#c6f0cd646a3127e1802ebbbadc8752e3">PathsIdentical</a> (const char *path1, const char *path2)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Check whether two native paths actually point to the same location. <a href="#c6f0cd646a3127e1802ebbbadc8752e3"></a><br></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> A helper class with path-related utilities. <p>Definition at line <a class="el" href="syspath_8h-source.html#l00231">231</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="880a69a61bf222ff6357bf7cc543bfd2"></a><!-- doxytag: member="csPathsUtilities::ExpandAll" ref="880a69a61bf222ff6357bf7cc543bfd2" args="(const csPathsList &paths)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static <a class="el" href="classcsPathsList.html">csPathsList</a> csPathsUtilities::ExpandAll </td> <td>(</td> <td class="paramtype">const <a class="el" href="classcsPathsList.html">csPathsList</a> & </td> <td class="paramname"> <em>paths</em> </td> <td> ) </td> <td width="100%"><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Expands all paths in a path list. <p> </div> </div><p> <a class="anchor" name="8b0691377916e2a3948c523e47c0b1d7"></a><!-- doxytag: member="csPathsUtilities::ExpandPath" ref="8b0691377916e2a3948c523e47c0b1d7" args="(const char *path)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static char* csPathsUtilities::ExpandPath </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"> <em>path</em> </td> <td> ) </td> <td width="100%"><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Expand a native path relative to the current directory. <p> <dl class="remark" compact><dt><b>Remarks:</b></dt><dd>The specified path must refer to a directory, rather than a file. <p> Caller is responsible to free the returned string with delete[] after using it. </dd></dl> </div> </div><p> <a class="anchor" name="e1e21d183e514183b6a4e2789d743d59"></a><!-- doxytag: member="csPathsUtilities::FilterInvalid" ref="e1e21d183e514183b6a4e2789d743d59" args="(csPathsList &paths)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static void csPathsUtilities::FilterInvalid </td> <td>(</td> <td class="paramtype"><a class="el" href="classcsPathsList.html">csPathsList</a> & </td> <td class="paramname"> <em>paths</em> </td> <td> ) </td> <td width="100%"><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Filter all non-existent items out of a paths list. <p> </div> </div><p> <a class="anchor" name="6474f3af744d3a2af15dccfeb32d4719"></a><!-- doxytag: member="csPathsUtilities::LocateFile" ref="6474f3af744d3a2af15dccfeb32d4719" args="(const csPathsList &paths, const char *file, bool thorough=false)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static <a class="el" href="classcsPathsList.html">csPathsList</a> csPathsUtilities::LocateFile </td> <td>(</td> <td class="paramtype">const <a class="el" href="classcsPathsList.html">csPathsList</a> & </td> <td class="paramname"> <em>paths</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"> <em>file</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"> <em>thorough</em> = <code>false</code></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Determine which path(s) of a given set contains a given file. <p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>paths</em> </td><td>List of (native) paths to check. </td></tr> <tr><td valign="top"></td><td valign="top"><em>file</em> </td><td>Filename to search. </td></tr> <tr><td valign="top"></td><td valign="top"><em>thorough</em> </td><td>Whether all paths should be checked. If <code>false</code>, at most only a single path, the first containing the file, is returned. </td></tr> </table> </dl> </div> </div><p> <a class="anchor" name="c6f0cd646a3127e1802ebbbadc8752e3"></a><!-- doxytag: member="csPathsUtilities::PathsIdentical" ref="c6f0cd646a3127e1802ebbbadc8752e3" args="(const char *path1, const char *path2)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static bool csPathsUtilities::PathsIdentical </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"> <em>path1</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"> <em>path2</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Check whether two native paths actually point to the same location. <p> Use this instead of strcmp() or the like, as it may not suffice in all cases (e.g. on Windows paths names are case-insensitive, but on Unix they aren't). <dl class="remark" compact><dt><b>Remarks:</b></dt><dd>Expects the paths to be fully qualified. Use csExpandPath() to ensure this. </dd></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>