pm_sysPath::getPathNew Interface Reference

Generate and return a unique (directory or file) path name in the specified directory or the default current working directory.
More...

Detailed Description

Generate and return a unique (directory or file) path name in the specified directory or the default current working directory.

The procedures under this generic interface return a full unique path that is,

1. optionally prefixed with the input user-specified directory dir,
   
2. optionally followed by the user-specified prefix,
   
3. optionally followed by the file extension ext, that can be either
   
   1. a string with pattern .*, if a file path is desired as the output, or
      
   2. a string that ends with an appropriate path-separator symbol of the platform, if a directory path is desired as the output.
      

The procedures under this generic interface use the current date and time and the process ID to generate new unique non-existing directory or file paths.
The general format of the output directory path is the following:

  <dir><prefix><ccyymmdd><sep><hhmmss><sep><sss><sep>pid<sep><pid><ext>

where,

1. <dir> is replaced with the contents of the input argument dir or its default value (followed by the path-separator symbol if needed),
2. <prefix> is replaced with the contents of the input argument prefix or its default value,
3. <sep> is replaced with the contents of the input argument sep or its default value,
4. <ccyymmdd> is replaced with the current century, year, month, and day, each represented by two characters,
5. <hhmmss> is replaced with the current hour hh, minute mm, second ss, in the specified ordered,
6. <sss> is replaced with the current millisecond mmm,
7. <pid> is replaced with the user-specified processor ID pid which can be the output of getImageID.
   
8. <ext> is replaced with the contents of the input argument ext or its default value.
   

If no unique path is found after 1000 attempts, the procedure returns and reports a failure.

Parameters

[in]	dir	: The input scalar character of default kind SK containing the directory where the new path should reside. If dir does not end with the proper system shell path-separator symbol, it will be suffixed with the proper symbol. However, it is recommended to pass an input dir that is already suffixed with the proper path-separator. The input dir is prefixed to the new path name that is to be constructed. (optional, default = "")
[in]	prefix	: The input scalar character of default kind SK containing the requested input prefix to the path that appears immediately after the input dir in the newly-constructed path. (optional, default = "new"//sep where sep is the other optional argument of the interface.)
[in]	sep	: The input scalar character of default kind SK containing the requested separator character to be inserted between the individual components of the new path to be constructed. This is different from the system shell directory separator. (optional, default = "_")
[in]	ext	: The input scalar character of default kind SK containing the requested input file extension or directory path-separator to appear at the end of the path. (optional, default = "")
[in]	pid	: The input scalar integer of default kind IK representing the processor ID (e.g., processor MPI rank or Coarray image ID). If present, it will be used in the generated path to make it processor-specific. The processor MPI rank or Coarray image ID can be for example obtained by calling getImageID. (optional, default = getImageID())
[out]	failed	: The output logical of default kind LK that is .true. if and only if the procedure fails to find a new unique (non-existent) path. (optional, if missing and the procedure fails, then the program will halt by calling error stop.)

Returns

pathNew : The output allocatable scalar of type character of default kind SK containing a new unique non-existent path.

Possible calling interfaces ⛓

use pm_sysPath, only: getPathNew
 
pathNew = getPathNew(dir = dir, prefix = prefix, sep = sep, ext = ext, failed = failed)

Warning

Avoid the use of Windows reserved (forbidden) characters WINDOWS_RESERVED_STR in path names.
Although such characters work fine on Unix systems, the Windows OS will not be able to gracefully handle such paths.
In particular, avoid the use of forward or backslash in path names (it is fine to use them as path-separator symbols).

The input ext argument, if it is present and contains a file extension, must the proper file extension separator symbol (e.g., .).
The file extension separator (.) will not be added to the input extension by this procedure.

Remarks

On Windows Operating Systems (OS), the choice of the path-separator depends on the processor runtime shell being used.
The Windows Batch terminal (CMD) can handle paths that are separated via either DIR_SEP_WINDOWS or DIR_SEP_POSIX or even both (although paths containing POSIX separators must be quoted).
However, Unix-like Shells like Git Bash, Cygwin, etc. only recognize DIR_SEP_POSIX even on Windows OS.
Therefore, to avoid the use of wrong path-separator for the input argument dir on Windows OS, the following steps are taken:

1. If the runtime shell is Windows-based and the input dir does not end with a directory separator recognized by Windows (DIR_SEP_WINDOWS_ALL), then dir will be suffixed with a Windows-style path-separator.
   
2. Otherwise, if the input dir does not end with a directory separator (DIR_SEP_POSIX_ALL) recognized by POSIX-style runtime shells (including Fish), then dir will be suffixed with a POSIX-style path-separator.
   

The procedures under discussion are impure.

See also

isFailedMakeDir
isFailedMakeDirTemp
getPathHostNameIndex

Example usage ⛓

program example
 
    use pm_kind, only: LK, IK
    use pm_kind, only: SK ! all processor types and kinds are supported.
    use pm_io, only: display_type
    use pm_sysPath, only: getPathNew
 
    implicit none
 
    logical(LK) :: failed
 
    type(display_type) :: disp
    disp = display_type(file = "main.out.F90")
 
    call disp%skip()
    call disp%show("getPathNew()")
    call disp%show( getPathNew() , deliml = SK_"""" )
    call disp%skip()
 
    call disp%skip()
    call disp%show("getPathNew(dir = SK_'foo/bar/', prefix = SK_'paramonte')")
    call disp%show( getPathNew(dir = SK_'foo/bar/', prefix = SK_'paramonte') , deliml = SK_"""" )
    call disp%skip()
 
    call disp%skip()
    call disp%show("getPathNew(dir = SK_'foo/bar', prefix = SK_'paramonte', ext = SK_'.txt')")
    call disp%show( getPathNew(dir = SK_'foo/bar', prefix = SK_'paramonte', ext = SK_'.txt') , deliml = SK_"""" )
    call disp%skip()
 
    call disp%skip()
    call disp%show("getPathNew(dir = SK_'foo/bar/', prefix = SK_'paramonte', ext = SK_'.txt', pid = 3_IK)")
    call disp%show( getPathNew(dir = SK_'foo/bar/', prefix = SK_'paramonte', ext = SK_'.txt', pid = 3_IK) , deliml = SK_"""" )
    call disp%skip()
 
    call disp%skip()
    call disp%show("getPathNew(dir = SK_'foo/bar/', prefix = SK_'paramonte', pid = 3_IK, failed = failed)")
    call disp%show( getPathNew(dir = SK_'foo/bar/', prefix = SK_'paramonte', pid = 3_IK, failed = failed) , deliml = SK_"""" )
    call disp%show("failed")
    call disp%show( failed )
    call disp%skip()
 
    call disp%skip()
    call disp%show("getPathNew(dir = SK_'foo/bar/', prefix = SK_'paramonte', sep = SK_'.', pid = 3_IK, failed = failed)")
    call disp%show( getPathNew(dir = SK_'foo/bar/', prefix = SK_'paramonte', sep = SK_'.', pid = 3_IK, failed = failed) , deliml = SK_"""" )
    call disp%show("failed")
    call disp%show( failed )
    call disp%skip()
 
end program example

Example Unix compile command via Intel ifort compiler ⛓

#!/usr/bin/env sh
rm main.exe
ifort -fpp -standard-semantics -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
./main.exe

Example Windows Batch compile command via Intel ifort compiler ⛓

del main.exe
set PATH=..\..\..\lib;%PATH%
ifort /fpp /standard-semantics /O3 /I:..\..\..\include main.F90 ..\..\..\lib\libparamonte*.lib /exe:main.exe
main.exe

Example Unix / MinGW compile command via GNU gfortran compiler ⛓

#!/usr/bin/env sh
rm main.exe
gfortran -cpp -ffree-line-length-none -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
./main.exe

Example output ⛓

 
getPathNew()
"new_20241114_224640_298_pid_1"
 
 
getPathNew(dir = SK_'foo/bar/', prefix = SK_'paramonte')
"foo/bar/paramonte20241114_224640_300_pid_1"
 
 
getPathNew(dir = SK_'foo/bar', prefix = SK_'paramonte', ext = SK_'.txt')
"foo/bar/paramonte20241114_224640_302_pid_1.txt"
 
 
getPathNew(dir = SK_'foo/bar/', prefix = SK_'paramonte', ext = SK_'.txt', pid = 3_IK)
"foo/bar/paramonte20241114_224640_304_pid_3.txt"
 
 
getPathNew(dir = SK_'foo/bar/', prefix = SK_'paramonte', pid = 3_IK, failed = failed)
"foo/bar/paramonte20241114_224640_306_pid_3"
failed
F
 
 
getPathNew(dir = SK_'foo/bar/', prefix = SK_'paramonte', sep = SK_'.', pid = 3_IK, failed = failed)
"foo/bar/paramonte20241114.224640.308.pid.3"
failed
F
 
 

Test:

test_pm_sysPath

Todo:

High Priority: The current Fortran standard 202x does not allow passing characters of non-default kind to the intrinsic Fortran statements and procedures.
As such, the implementation of this procedure for non-default character kinds leads to compile-time kind mismatch errors.
This procedure should be converted back to a generic interface in the future when non-default character kinds are also fully supported by the intrinsic functions.

Todo:

High Priority: An optional suffix argument can be added in the future. Currently, the path suffix is hard-coded in the procedure, unlike prefix.

Final Remarks ⛓

---

If you believe this algorithm or its documentation can be improved, we appreciate your contribution and help to edit this page's documentation and source file on GitHub.
For details on the naming abbreviations, see this page.
For details on the naming conventions, see this page.
This software is distributed under the MIT license with additional terms outlined below.

1. If you use any parts or concepts from this library to any extent, please acknowledge the usage by citing the relevant publications of the ParaMonte library.
   
2. If you regenerate any parts/ideas from this library in a programming environment other than those currently supported by this ParaMonte library (i.e., other than C, C++, Fortran, MATLAB, Python, R), please also ask the end users to cite this original ParaMonte library.
   

This software is available to the public under a highly permissive license.
Help us justify its continued development and maintenance by acknowledging its benefit to society, distributing it, and contributing to it.

Copyright

Computational Data Science Lab

Author:

Amir Shahmoradi, Tuesday March 7, 2017, 3:50 AM, Institute for Computational Engineering and Sciences (ICES), The University of Texas Austin

Definition at line 4367 of file pm_sysPath.F90.

---

The documentation for this interface was generated from the following file:

• src/fortran/main/pm_sysPath.F90