--- a/src/eric7/Documentation/Source/eric7.SystemUtilities.FileSystemUtilities.html Wed Dec 06 14:20:35 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.SystemUtilities.FileSystemUtilities.html Wed Dec 06 14:23:36 2023 +0100
@@ -14,7 +14,7 @@
<h3>Global Attributes</h3>
<table>
-<tr><td>None</td></tr>
+<tr><td>_DeviceFileMarker</td></tr><tr><td>_RemoteFileMarker</td></tr>
</table>
<h3>Classes</h3>
@@ -38,6 +38,10 @@
<td>Function to return a compacted path fitting inside the given width.</td>
</tr>
<tr>
+<td><a href="#deviceFileName">deviceFileName</a></td>
+<td>Function to create a device (MicroPython) file name given a plain file name.</td>
+</tr>
+<tr>
<td><a href="#direntries">direntries</a></td>
<td>Function returning a list of all files and directories.</td>
</tr>
@@ -74,6 +78,10 @@
<td>Function to build the full path of an executable file from the environment on Windows platforms.</td>
</tr>
<tr>
+<td><a href="#isDeviceFileName">isDeviceFileName</a></td>
+<td>Function to check, if the given file name is a device file name.</td>
+</tr>
+<tr>
<td><a href="#isDrive">isDrive</a></td>
<td>Function to check, if a path is a Windows drive.</td>
</tr>
@@ -82,6 +90,14 @@
<td>Function to check, if a file is executable.</td>
</tr>
<tr>
+<td><a href="#isPlainFileName">isPlainFileName</a></td>
+<td>Function to check, if the given file name is a plain (i.e.</td>
+</tr>
+<tr>
+<td><a href="#isRemoteFileName">isRemoteFileName</a></td>
+<td>Function to check, if the given file name is a remote file name.</td>
+</tr>
+<tr>
<td><a href="#isinpath">isinpath</a></td>
<td>Function to check for an executable file.</td>
</tr>
@@ -106,10 +122,18 @@
<td>Function returning a normalized path of the joined parts passed into it.</td>
</tr>
<tr>
+<td><a href="#plainFileName">plainFileName</a></td>
+<td>Function to create a plain file name given a device or remote file name.</td>
+</tr>
+<tr>
<td><a href="#relativeUniversalPath">relativeUniversalPath</a></td>
<td>Function to convert a file path to a path relative to a start path with universal separators.</td>
</tr>
<tr>
+<td><a href="#remoteFileName">remoteFileName</a></td>
+<td>Function to create a remote file name given a plain file name.</td>
+</tr>
+<tr>
<td><a href="#samefilepath">samefilepath</a></td>
<td>Function to compare two paths.</td>
</tr>
@@ -220,6 +244,35 @@
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
+<a NAME="deviceFileName" ID="deviceFileName"></a>
+<h2>deviceFileName</h2>
+<b>deviceFileName</b>(<i>fileName</i>)
+
+<p>
+ Function to create a device (MicroPython) file name given a plain file name.
+</p>
+<dl>
+
+<dt><i>fileName</i> (str)</dt>
+<dd>
+plain file name
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+device file name
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
<a NAME="direntries" ID="direntries"></a>
<h2>direntries</h2>
<b>direntries</b>(<i>path, filesonly=False, pattern=None, followsymlinks=True, checkStop=None, ignore=None, </i>)
@@ -487,6 +540,35 @@
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
+<a NAME="isDeviceFileName" ID="isDeviceFileName"></a>
+<h2>isDeviceFileName</h2>
+<b>isDeviceFileName</b>(<i>fileName</i>)
+
+<p>
+ Function to check, if the given file name is a device file name.
+</p>
+<dl>
+
+<dt><i>fileName</i> (str)</dt>
+<dd>
+file name to be checked
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+flag indicating a device file name
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
<a NAME="isDrive" ID="isDrive"></a>
<h2>isDrive</h2>
<b>isDrive</b>(<i>path</i>)
@@ -539,6 +621,64 @@
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
+<a NAME="isPlainFileName" ID="isPlainFileName"></a>
+<h2>isPlainFileName</h2>
+<b>isPlainFileName</b>(<i>fileName</i>)
+
+<p>
+ Function to check, if the given file name is a plain (i.e. local) file name.
+</p>
+<dl>
+
+<dt><i>fileName</i> (str)</dt>
+<dd>
+file name to be checked
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+flag indicating a local file name
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="isRemoteFileName" ID="isRemoteFileName"></a>
+<h2>isRemoteFileName</h2>
+<b>isRemoteFileName</b>(<i>fileName</i>)
+
+<p>
+ Function to check, if the given file name is a remote file name.
+</p>
+<dl>
+
+<dt><i>fileName</i> (str)</dt>
+<dd>
+file name to be checked
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+flag indicating a remote file name
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
<a NAME="isinpath" ID="isinpath"></a>
<h2>isinpath</h2>
<b>isinpath</b>(<i>file</i>)
@@ -697,6 +837,35 @@
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
+<a NAME="plainFileName" ID="plainFileName"></a>
+<h2>plainFileName</h2>
+<b>plainFileName</b>(<i>fileName</i>)
+
+<p>
+ Function to create a plain file name given a device or remote file name.
+</p>
+<dl>
+
+<dt><i>fileName</i> (str)</dt>
+<dd>
+device or remote file name
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+plain file name
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
<a NAME="relativeUniversalPath" ID="relativeUniversalPath"></a>
<h2>relativeUniversalPath</h2>
<b>relativeUniversalPath</b>(<i>path, start</i>)
@@ -726,6 +895,35 @@
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
+<a NAME="remoteFileName" ID="remoteFileName"></a>
+<h2>remoteFileName</h2>
+<b>remoteFileName</b>(<i>fileName</i>)
+
+<p>
+ Function to create a remote file name given a plain file name.
+</p>
+<dl>
+
+<dt><i>fileName</i> (str)</dt>
+<dd>
+plain file name
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+remote file name
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
<a NAME="samefilepath" ID="samefilepath"></a>
<h2>samefilepath</h2>
<b>samefilepath</b>(<i>f1, f2</i>)
