pm_sysPath::getDirSeps Interface Reference

Generate and return all the directory separator symbols supported by the current runtime operating system based on the runtime system shell.
More...

Detailed Description

Generate and return all the directory separator symbols supported by the current runtime operating system based on the runtime system shell.

The directory separators returned by this generic interface can be used for splitting paths to its components via for example, getDirName or the Fortran intrinsic execute_command_line().

1. The directory separators for Windows-based terminals such as CMD and PowerShell can be both the backslash character \ or the forward-slash character \.
   
2. The directory separators for POSIX-compliant terminals such as sh, bash, csh, zsh, ... is the forward slash /.
   

Parameters

[in]	mold	: The input scalar character of kind any supported by the processor (e.g., SK, SKA, SKD , or SKU) of length 1. The value of mold s ignored. However, its kind type parameter is used to to set the kind type parameter of the output dirseps. (optional, default = SK_" " where SK refers to the default character kind SK.) if and only if an error occurs while inferring the system shell directory separator. (optional. If missing and a runtime error occurs, the program will halt by calling error stop.)
[out]	failed	: The output scalar logical of default kind LK that is .true. if and only if an error occurs while inferring the system shell directory separator. (optional. If missing and a runtime error occurs, the program will halt by calling error stop.)
[in,out]	errmsg	: The input/output scalar character of default kind SK of arbitrary length type parameter. If an error occurs, errmsg will be set to a descriptive message about the nature of the runtime error. A length of LEN_IOMSG characters is likely sufficient to capture most error messages in full. (optional. If missing, no error message will be output. Its presence is relevant only if failed is also present.)

Returns

dirseps : The output allocatable scalar character of the same kind as the input mold of arbitrary length type parameter (typically 1 on Unix systems or 2 on Windows), representing the directory separator symbol based on the runtime system shell (\ or /).
If the procedure fails and the output argument failed is present, it is set to .true..
Also, dirseps is set to the default value of the dirseps component of shell_type.

Possible calling interfaces ⛓

use pm_kind, only: LK
use pm_sysPath, only: getDirSeps
character(:, SK) :: dirseps
logical(LK) :: failed
 
dirseps = getDirSeps(failed = failed, errmsg = errmsg)
dirseps = getDirSeps(mold, failed = failed, errmsg = errmsg)

Remarks

The procedures under discussion are impure.

See also

isDir
isFile
getDirSep
getDirSeps
getPathSep
getPathNew
getPathPosix
setPathPosix
getPathWindows
setPathWindows
getPathHostNameIndex
shellis_type
shell_type

Example usage ⛓

program example
 
    use pm_kind, only: LK
    use pm_kind, only: SK ! all processor types and kinds are supported.
    use pm_io, only: display_type
    use pm_sysPath, only: getDirSeps
 
    implicit none
 
    character(255, SK)  :: errmsg = SK_""
    logical(LK)         :: failed
 
    type(display_type)  :: disp
    disp = display_type(file = "main.out.F90")
 
    call disp%skip()
    call disp%show("getDirSeps()")
    call disp%show( getDirSeps() , deliml = """" )
    call disp%skip()
 
    call disp%skip()
    call disp%show("getDirSeps(mold = SK_'a')")
    call disp%show( getDirSeps(mold = SK_'a') , deliml = """" )
    call disp%skip()
 
    call disp%skip()
    call disp%show("getDirSeps(failed)")
    call disp%show( getDirSeps(failed) , deliml = """" )
    call disp%show("failed")
    call disp%show( failed )
    call disp%skip()
 
    call disp%skip()
    call disp%show("getDirSeps(failed, errmsg)")
    call disp%show( getDirSeps(failed, errmsg) , deliml = """" )
    call disp%show("failed")
    call disp%show( failed )
    call disp%show("trim(errmsg)")
    call disp%show( trim(errmsg) , deliml = SK_"""" )
    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 ⛓

 
getDirSeps()
"/"
 
 
getDirSeps(mold = SK_'a')
"/"
 
 
getDirSeps(failed)
"/"
failed
F
 
 
getDirSeps(failed, errmsg)
"/"
failed
F
trim(errmsg)
""
 
 

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.

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:09 AM, Institute for Computational Engineering and Sciences (ICES), The University of Texas Austin

Definition at line 4009 of file pm_sysPath.F90.

---

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

• src/fortran/main/pm_sysPath.F90