240 lines
17 KiB
HTML
240 lines
17 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.9.1"/>
|
|
<title>PIP: PIDir Class Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(initResizable);
|
|
$(window).load(resizeHeight);
|
|
</script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td style="padding-left: 0.5em;">
|
|
<div id="projectname">PIP
|
|
 <span id="projectnumber">0.5.0_alpha</span>
|
|
</div>
|
|
<div id="projectbrief">Platform-Independent Primitives</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.9.1 -->
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
|
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
|
|
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li><a href="files.html"><span>Files</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="annotated.html"><span>Class List</span></a></li>
|
|
<li><a href="classes.html"><span>Class Index</span></a></li>
|
|
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
|
|
<li><a href="functions.html"><span>Class Members</span></a></li>
|
|
</ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
$(document).ready(function(){initNavTree('class_p_i_dir.html','');});
|
|
</script>
|
|
<div id="doc-content">
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="class_p_i_dir-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">PIDir Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Local directory.
|
|
<a href="class_p_i_dir.html#details">More...</a></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a40a16114890e390a19a40a4d9c8c4428"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a40a16114890e390a19a40a4d9c8c4428"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_dir.html#a40a16114890e390a19a40a4d9c8c4428">PIDir</a> (const <a class="el" href="class_p_i_string.html">PIString</a> &dir=<a class="el" href="class_p_i_string.html">PIString</a>())</td></tr>
|
|
<tr class="memdesc:a40a16114890e390a19a40a4d9c8c4428"><td class="mdescLeft"> </td><td class="mdescRight">Constructs directory with path "path". <br /></td></tr>
|
|
<tr class="separator:a40a16114890e390a19a40a4d9c8c4428"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5ccd50537e20c8b3e86407ad32063494"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5ccd50537e20c8b3e86407ad32063494"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_dir.html#a5ccd50537e20c8b3e86407ad32063494">PIDir</a> (const <a class="el" href="class_p_i_file.html">PIFile</a> &file)</td></tr>
|
|
<tr class="memdesc:a5ccd50537e20c8b3e86407ad32063494"><td class="mdescLeft"> </td><td class="mdescRight">Constructs directory with "file" directory path "path". <br /></td></tr>
|
|
<tr class="separator:a5ccd50537e20c8b3e86407ad32063494"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a582a5fb50e299bcab339df8bd7e81bbe"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a582a5fb50e299bcab339df8bd7e81bbe"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_dir.html#a582a5fb50e299bcab339df8bd7e81bbe">isExists</a> () const </td></tr>
|
|
<tr class="memdesc:a582a5fb50e299bcab339df8bd7e81bbe"><td class="mdescLeft"> </td><td class="mdescRight">Returns if this directory is exists. <br /></td></tr>
|
|
<tr class="separator:a582a5fb50e299bcab339df8bd7e81bbe"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa22c2a06eb206b3d69af0feb62a67236"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa22c2a06eb206b3d69af0feb62a67236"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_dir.html#aa22c2a06eb206b3d69af0feb62a67236">isAbsolute</a> () const </td></tr>
|
|
<tr class="memdesc:aa22c2a06eb206b3d69af0feb62a67236"><td class="mdescLeft"> </td><td class="mdescRight">Returns if path of this directory is absolute. <br /></td></tr>
|
|
<tr class="separator:aa22c2a06eb206b3d69af0feb62a67236"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac43e095dd791c9b37b371a16a1fc29ba"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac43e095dd791c9b37b371a16a1fc29ba"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_dir.html#ac43e095dd791c9b37b371a16a1fc29ba">isRelative</a> () const </td></tr>
|
|
<tr class="memdesc:ac43e095dd791c9b37b371a16a1fc29ba"><td class="mdescLeft"> </td><td class="mdescRight">Returns if path of this directory is relative. <br /></td></tr>
|
|
<tr class="separator:ac43e095dd791c9b37b371a16a1fc29ba"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1a1a7c3120bbfc52d68d015838b8e54a"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="class_p_i_string.html">PIString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_dir.html#a1a1a7c3120bbfc52d68d015838b8e54a">scanDir</a> () const </td></tr>
|
|
<tr class="separator:a1a1a7c3120bbfc52d68d015838b8e54a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6a953d094f053af299a793f252b37fae"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6a953d094f053af299a793f252b37fae"></a>
|
|
<a class="el" href="class_p_i_string.html">PIString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_dir.html#a6a953d094f053af299a793f252b37fae">path</a> () const </td></tr>
|
|
<tr class="memdesc:a6a953d094f053af299a793f252b37fae"><td class="mdescLeft"> </td><td class="mdescRight">Returns path of this directory. <br /></td></tr>
|
|
<tr class="separator:a6a953d094f053af299a793f252b37fae"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5497ba859bc0bae75bb9cf5071c48171"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5497ba859bc0bae75bb9cf5071c48171"></a>
|
|
<a class="el" href="class_p_i_string.html">PIString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_dir.html#a5497ba859bc0bae75bb9cf5071c48171">absolutePath</a> () const </td></tr>
|
|
<tr class="memdesc:a5497ba859bc0bae75bb9cf5071c48171"><td class="mdescLeft"> </td><td class="mdescRight">Returns absolute path of this directory. <br /></td></tr>
|
|
<tr class="separator:a5497ba859bc0bae75bb9cf5071c48171"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2bf75841e70d2bf31dbe5e9b45b5b210"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_p_i_dir.html">PIDir</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_dir.html#a2bf75841e70d2bf31dbe5e9b45b5b210">cleanPath</a> ()</td></tr>
|
|
<tr class="memdesc:a2bf75841e70d2bf31dbe5e9b45b5b210"><td class="mdescLeft"> </td><td class="mdescRight">Simplify path of this directory. <a href="#a2bf75841e70d2bf31dbe5e9b45b5b210">More...</a><br /></td></tr>
|
|
<tr class="separator:a2bf75841e70d2bf31dbe5e9b45b5b210"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acfa3b5f2abd1bcb4542d0bf49c70e9c0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acfa3b5f2abd1bcb4542d0bf49c70e9c0"></a>
|
|
<a class="el" href="class_p_i_dir.html">PIDir</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_dir.html#acfa3b5f2abd1bcb4542d0bf49c70e9c0">cleanedPath</a> () const </td></tr>
|
|
<tr class="memdesc:acfa3b5f2abd1bcb4542d0bf49c70e9c0"><td class="mdescLeft"> </td><td class="mdescRight">Returns PIDir with simplified path of this directory. <br /></td></tr>
|
|
<tr class="separator:acfa3b5f2abd1bcb4542d0bf49c70e9c0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7a9ac7d226671eed935dee6f6ce76a58"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7a9ac7d226671eed935dee6f6ce76a58"></a>
|
|
<a class="el" href="class_p_i_string.html">PIString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_dir.html#a7a9ac7d226671eed935dee6f6ce76a58">relative</a> (const <a class="el" href="class_p_i_string.html">PIString</a> &<a class="el" href="class_p_i_dir.html#a6a953d094f053af299a793f252b37fae">path</a>) const </td></tr>
|
|
<tr class="memdesc:a7a9ac7d226671eed935dee6f6ce76a58"><td class="mdescLeft"> </td><td class="mdescRight">Returns relative to this directory path "path". <br /></td></tr>
|
|
<tr class="separator:a7a9ac7d226671eed935dee6f6ce76a58"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a78be464ae68896e8c583cc2360985772"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a78be464ae68896e8c583cc2360985772"></a>
|
|
<a class="el" href="class_p_i_dir.html">PIDir</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_dir.html#a78be464ae68896e8c583cc2360985772">setDir</a> (const <a class="el" href="class_p_i_string.html">PIString</a> &<a class="el" href="class_p_i_dir.html#a6a953d094f053af299a793f252b37fae">path</a>)</td></tr>
|
|
<tr class="memdesc:a78be464ae68896e8c583cc2360985772"><td class="mdescLeft"> </td><td class="mdescRight">Set this directory path to simplified "path". <br /></td></tr>
|
|
<tr class="separator:a78be464ae68896e8c583cc2360985772"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4c376dd5074e5faa704f11ec6d32b888"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4c376dd5074e5faa704f11ec6d32b888"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_dir.html#a4c376dd5074e5faa704f11ec6d32b888">setCurrent</a> ()</td></tr>
|
|
<tr class="memdesc:a4c376dd5074e5faa704f11ec6d32b888"><td class="mdescLeft"> </td><td class="mdescRight">Set this directory path as current for application. <br /></td></tr>
|
|
<tr class="separator:a4c376dd5074e5faa704f11ec6d32b888"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a536c11769adbf151f708a0549bf0b711"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_p_i_vector.html">PIVector</a>< PIFile::FileInfo > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_dir.html#a536c11769adbf151f708a0549bf0b711">entries</a> ()</td></tr>
|
|
<tr class="memdesc:a536c11769adbf151f708a0549bf0b711"><td class="mdescLeft"> </td><td class="mdescRight">Returns this directory content. <a href="#a536c11769adbf151f708a0549bf0b711">More...</a><br /></td></tr>
|
|
<tr class="separator:a536c11769adbf151f708a0549bf0b711"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aff540a865fc5a6cb68934f605832722b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_p_i_vector.html">PIVector</a>< PIFile::FileInfo > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_dir.html#aff540a865fc5a6cb68934f605832722b">allEntries</a> ()</td></tr>
|
|
<tr class="memdesc:aff540a865fc5a6cb68934f605832722b"><td class="mdescLeft"> </td><td class="mdescRight">Returns all this directory content. <a href="#aff540a865fc5a6cb68934f605832722b">More...</a><br /></td></tr>
|
|
<tr class="separator:aff540a865fc5a6cb68934f605832722b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Local directory. </p>
|
|
<h1><a class="anchor" id="PIDir_sec0"></a>
|
|
Synopsis</h1>
|
|
<p>This class provide access to local file. You can manipulate binary content or use this class as text stream. To binary access there are function <em>read()</em>, <em>write()</em>, and many <em>writeBinary()</em> functions. For write variables to file in their text representation threr are many "<<" operators. </p>
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
<a class="anchor" id="a1a1a7c3120bbfc52d68d015838b8e54a"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const <a class="el" href="class_p_i_string.html">PIString</a>& PIDir::scanDir </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Returns path of current reading directory. This path valid only while <em>allEntries</em> functions </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a2bf75841e70d2bf31dbe5e9b45b5b210"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="class_p_i_dir.html">PIDir</a> & PIDir::cleanPath </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Simplify path of this directory. </p>
|
|
<p>This function remove repeatedly separators and resolve ".." in path. E.g. "/home/.//peri4/src/../.." will become "/home" <br />
|
|
This function returns reference to this PIDir </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a536c11769adbf151f708a0549bf0b711"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="class_p_i_vector.html">PIVector</a>< PIFile::FileInfo > PIDir::entries </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns this directory content. </p>
|
|
<p>Scan this directory and returns all directories and files in one list, sorted alphabetically. This list contains also "." and ".." members. There are absolute pathes in returned list. </p><dl class="section attention"><dt>Attention</dt><dd>This function doesn`t scan content of inner directories! </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aff540a865fc5a6cb68934f605832722b"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="class_p_i_vector.html">PIVector</a>< PIFile::FileInfo > PIDir::allEntries </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns all this directory content. </p>
|
|
<p>Scan this directory recursively and returns all directories and files in one list, sorted alphabetically. This list doesn`t contains "." and ".." members. There are absolute pathes in returned list, and files placed after directories in this list </p>
|
|
<p>TODO: resolve symlinks </p>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="class_p_i_dir.html">PIDir</a></li>
|
|
<li class="footer">Generated on Sat Jan 30 2016 21:43:28 for PIP by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9.1 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|