pm_sysPath::getPathJoined Interface Reference

Generate and return the path that results from joining the two input path parts, separated by the specified directory separator or the preferred directory separator of the runtime shell.
More...

Detailed Description

Generate and return the path that results from joining the two input path parts, separated by the specified directory separator or the preferred directory separator of the runtime shell.

Each part is inspected for being an absolute path before being joined to previous part.
If the second path part p2 is absolute or relative with respect to the current drive, then pathJoined = p2 on output, otherwise pathJoined = p1//getDirSep()//p2.

Parameters

[in]	p1	: The input scalar character of default kind SK containing the first part of the path to be constructed.
[in]	p2	: The input scalar character of default kind SK containing the second part of the path to be constructed.
[out]	failed	: The output logical of default kind LK that is .true. if the procedure fails while inferring the runtime shell type and directory separator. (optional. If missing and the procedure fails, then 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. It can be present if and only if failed is also present. If missing, no error message will be output.)

Returns

pathJoined : The output allocatable scalar of type character of default kind SK containing the joined path constructed from the input parts.
If the output argument failed is present, its value must be checked before using the output pathJoined.
In such a case, the output value of pathJoined is undefined and not guaranteed to be correct.

Possible calling interfaces ⛓

use pm_sysPath, only: getPathJoined
 
pathJoined = getPathJoined(p1, p2)
pathJoined = getPathJoined(p1, p2, failed, errmsg = errmsg)

Remarks

The procedures under discussion are impure.

See also

getDirSep
hasDriveLetter
getPathWindows
getPathPosixEscaped
getPathPosix

Example usage ⛓

program example
 
    use pm_kind, only: SK, LK
    use pm_io, only: display_type
    use pm_sysPath, only: getPathJoined
    use pm_sysShell, only: isShellWindows
    use pm_sysShell, only: isShellPosix
 
    implicit none
 
    character(:, SK), allocatable :: pathJoined
 
    type(display_type) :: disp
    disp = display_type(file = "main.out.F90")
 
    call disp%skip()
    call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
    call disp%show("!Note the runtime shell type below before checking the example outputs.")
    call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
    call disp%skip()
 
    call disp%skip()
    call disp%show("isShellPosix()")
    call disp%show( isShellPosix() )
    call disp%show("isShellWindows()")
    call disp%show( isShellWindows() )
    call disp%skip()
 
    call disp%skip()
    call disp%show("pathJoined = getPathJoined(SK_'', SK_'')")
                    pathJoined = getPathJoined(SK_'', SK_'')
    call disp%show("pathJoined")
    call disp%show( pathJoined , deliml = SK_'''' )
    call disp%skip()
 
    call disp%skip()
    call disp%show("pathJoined = getPathJoined(SK_'C:', SK_'\')")
                    pathJoined = getPathJoined(SK_'C:', SK_'\')
    call disp%show("pathJoined")
    call disp%show( pathJoined , deliml = SK_'''' )
    call disp%skip()
 
    call disp%skip()
    call disp%show("pathJoined = getPathJoined(SK_'C:', SK_'/')")
                    pathJoined = getPathJoined(SK_'C:', SK_'/')
    call disp%show("pathJoined")
    call disp%show( pathJoined , deliml = SK_'''' )
    call disp%skip()
 
    call disp%skip()
    call disp%show("pathJoined = getPathJoined(SK_'C:', SK_'./')")
                    pathJoined = getPathJoined(SK_'C:', SK_'./')
    call disp%show("pathJoined")
    call disp%show( pathJoined , deliml = SK_'''' )
    call disp%skip()
 
    call disp%skip()
    call disp%show("pathJoined = getPathJoined(SK_'C:', SK_'paramonte')")
                    pathJoined = getPathJoined(SK_'C:', SK_'paramonte')
    call disp%show("pathJoined")
    call disp%show( pathJoined , deliml = SK_'''' )
    call disp%skip()
 
    call disp%skip()
    call disp%show("pathJoined = getPathJoined(SK_'./', SK_'paramonte')")
                    pathJoined = getPathJoined(SK_'./', SK_'paramonte')
    call disp%show("pathJoined")
    call disp%show( pathJoined , 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 ⛓

 
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
!Note the runtime shell type below before checking the example outputs.
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 
isShellPosix()
T
isShellWindows()
F
 
 
pathJoined = getPathJoined(SK_'', SK_'')
pathJoined
''
 
 
pathJoined = getPathJoined(SK_'C:', SK_'\')
pathJoined
'C:/\'
 
 
pathJoined = getPathJoined(SK_'C:', SK_'/')
pathJoined
'/'
 
 
pathJoined = getPathJoined(SK_'C:', SK_'./')
pathJoined
'C:/./'
 
 
pathJoined = getPathJoined(SK_'C:', SK_'paramonte')
pathJoined
'C:/paramonte'
 
 
pathJoined = getPathJoined(SK_'./', SK_'paramonte')
pathJoined
'./paramonte'
 
 

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

Definition at line 4574 of file pm_sysPath.F90.

---

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

• src/fortran/main/pm_sysPath.F90