SHS/pip
4
3
Fork 0
Code Issues 67 Pull Requests 1 Actions Releases Wiki Activity
Files
293a4cc322a93f54673977111a8c6792a438ed4f
pip/doc/html/class_p_i_dir.html

243 lines
17 KiB
HTML
Raw Blame History

<!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.14"/>
<meta name="viewport" content="width=device-width, initial-scale=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">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</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 id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">PIP
&#160;<span id="projectnumber">1.8.0</span>
</div>
<div id="projectbrief">Platform-Independent Primitives</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></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">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('class_p_i_dir.html','');});
/* @license-end */
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<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 id="a40a16114890e390a19a40a4d9c8c4428"></a>
&#160;</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> &amp;dir=<a class="el" href="class_p_i_string.html">PIString</a>())</td></tr>
<tr class="memdesc:a40a16114890e390a19a40a4d9c8c4428"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs directory with path "path". <br /></td></tr>
<tr class="separator:a40a16114890e390a19a40a4d9c8c4428"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5ccd50537e20c8b3e86407ad32063494"><td class="memItemLeft" align="right" valign="top"><a id="a5ccd50537e20c8b3e86407ad32063494"></a>
&#160;</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> &amp;file)</td></tr>
<tr class="memdesc:a5ccd50537e20c8b3e86407ad32063494"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs directory with "file" directory path "path". <br /></td></tr>
<tr class="separator:a5ccd50537e20c8b3e86407ad32063494"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a48400da4dd8e9ed153884381b78bb00b"><td class="memItemLeft" align="right" valign="top"><a id="a48400da4dd8e9ed153884381b78bb00b"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_dir.html#a48400da4dd8e9ed153884381b78bb00b">isExists</a> () const</td></tr>
<tr class="memdesc:a48400da4dd8e9ed153884381b78bb00b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns if this directory is exists. <br /></td></tr>
<tr class="separator:a48400da4dd8e9ed153884381b78bb00b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8b05b0ffe256a9653bc89ff3d0473b4c"><td class="memItemLeft" align="right" valign="top"><a id="a8b05b0ffe256a9653bc89ff3d0473b4c"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_dir.html#a8b05b0ffe256a9653bc89ff3d0473b4c">isAbsolute</a> () const</td></tr>
<tr class="memdesc:a8b05b0ffe256a9653bc89ff3d0473b4c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns if path of this directory is absolute. <br /></td></tr>
<tr class="separator:a8b05b0ffe256a9653bc89ff3d0473b4c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad12c45bfd71cd058a068fee86089327f"><td class="memItemLeft" align="right" valign="top"><a id="ad12c45bfd71cd058a068fee86089327f"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_dir.html#ad12c45bfd71cd058a068fee86089327f">isRelative</a> () const</td></tr>
<tr class="memdesc:ad12c45bfd71cd058a068fee86089327f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns if path of this directory is relative. <br /></td></tr>
<tr class="separator:ad12c45bfd71cd058a068fee86089327f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8a14aa78f3a0caf30a66303182b58170"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="class_p_i_string.html">PIString</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_dir.html#a8a14aa78f3a0caf30a66303182b58170">scanDir</a> () const</td></tr>
<tr class="separator:a8a14aa78f3a0caf30a66303182b58170"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4d3f43313804274d80f0ed049b8bf0fe"><td class="memItemLeft" align="right" valign="top"><a id="a4d3f43313804274d80f0ed049b8bf0fe"></a>
<a class="el" href="class_p_i_string.html">PIString</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_dir.html#a4d3f43313804274d80f0ed049b8bf0fe">path</a> () const</td></tr>
<tr class="memdesc:a4d3f43313804274d80f0ed049b8bf0fe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns path of this directory. <br /></td></tr>
<tr class="separator:a4d3f43313804274d80f0ed049b8bf0fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab4ca9ff260875c2cda03ce395cd8ee28"><td class="memItemLeft" align="right" valign="top"><a id="ab4ca9ff260875c2cda03ce395cd8ee28"></a>
<a class="el" href="class_p_i_string.html">PIString</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_dir.html#ab4ca9ff260875c2cda03ce395cd8ee28">absolutePath</a> () const</td></tr>
<tr class="memdesc:ab4ca9ff260875c2cda03ce395cd8ee28"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns absolute path of this directory. <br /></td></tr>
<tr class="separator:ab4ca9ff260875c2cda03ce395cd8ee28"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2bf75841e70d2bf31dbe5e9b45b5b210"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_p_i_dir.html">PIDir</a> &amp;&#160;</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">&#160;</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">&#160;</td></tr>
<tr class="memitem:aebf7a1584bfc3be5052f066746d12433"><td class="memItemLeft" align="right" valign="top"><a id="aebf7a1584bfc3be5052f066746d12433"></a>
<a class="el" href="class_p_i_dir.html">PIDir</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_dir.html#aebf7a1584bfc3be5052f066746d12433">cleanedPath</a> () const</td></tr>
<tr class="memdesc:aebf7a1584bfc3be5052f066746d12433"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns PIDir with simplified path of this directory. <br /></td></tr>
<tr class="separator:aebf7a1584bfc3be5052f066746d12433"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af65228bc3bda40f8fdc68c05ff496691"><td class="memItemLeft" align="right" valign="top"><a id="af65228bc3bda40f8fdc68c05ff496691"></a>
<a class="el" href="class_p_i_string.html">PIString</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_dir.html#af65228bc3bda40f8fdc68c05ff496691">relative</a> (const <a class="el" href="class_p_i_string.html">PIString</a> &amp;<a class="el" href="class_p_i_dir.html#a4d3f43313804274d80f0ed049b8bf0fe">path</a>) const</td></tr>
<tr class="memdesc:af65228bc3bda40f8fdc68c05ff496691"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns relative to this directory path "path". <br /></td></tr>
<tr class="separator:af65228bc3bda40f8fdc68c05ff496691"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a78be464ae68896e8c583cc2360985772"><td class="memItemLeft" align="right" valign="top"><a id="a78be464ae68896e8c583cc2360985772"></a>
<a class="el" href="class_p_i_dir.html">PIDir</a> &amp;&#160;</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> &amp;<a class="el" href="class_p_i_dir.html#a4d3f43313804274d80f0ed049b8bf0fe">path</a>)</td></tr>
<tr class="memdesc:a78be464ae68896e8c583cc2360985772"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set this directory path to simplified "path". <br /></td></tr>
<tr class="separator:a78be464ae68896e8c583cc2360985772"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4c376dd5074e5faa704f11ec6d32b888"><td class="memItemLeft" align="right" valign="top"><a id="a4c376dd5074e5faa704f11ec6d32b888"></a>
bool&#160;</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">&#160;</td><td class="mdescRight">Set this directory path as current for application. <br /></td></tr>
<tr class="separator:a4c376dd5074e5faa704f11ec6d32b888"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a536c11769adbf151f708a0549bf0b711"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_p_i_vector.html">PIVector</a>&lt; PIFile::FileInfo &gt;&#160;</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">&#160;</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">&#160;</td></tr>
<tr class="memitem:aff540a865fc5a6cb68934f605832722b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_p_i_vector.html">PIVector</a>&lt; PIFile::FileInfo &gt;&#160;</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">&#160;</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">&#160;</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 "&lt;&lt;" operators. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a8a14aa78f3a0caf30a66303182b58170"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8a14aa78f3a0caf30a66303182b58170">&#9670;&nbsp;</a></span>scanDir()</h2>
<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>&amp; 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 id="a2bf75841e70d2bf31dbe5e9b45b5b210"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2bf75841e70d2bf31dbe5e9b45b5b210">&#9670;&nbsp;</a></span>cleanPath()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_p_i_dir.html">PIDir</a> &amp; 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 id="a536c11769adbf151f708a0549bf0b711"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a536c11769adbf151f708a0549bf0b711">&#9670;&nbsp;</a></span>entries()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_p_i_vector.html">PIVector</a>&lt; PIFile::FileInfo &gt; 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 id="aff540a865fc5a6cb68934f605832722b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aff540a865fc5a6cb68934f605832722b">&#9670;&nbsp;</a></span>allEntries()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_p_i_vector.html">PIVector</a>&lt; PIFile::FileInfo &gt; 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 Fri Sep 28 2018 21:06:37 for PIP by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink