pm_sysPath::getPathExpandedUser Interface Reference

Generate and return the input path wherein the initial tilde character (~) is expanded to the home directory of current user.
More...

Detailed Description

Generate and return the input path wherein the initial tilde character (~) is expanded to the home directory of current user.

On Unix and Windows, return the argument with an initial component of ~ or ~user replaced by that user’s home directory.

1. On Unix platforms:
   1. If the character appearing immediately after ~ is a shell directory separator (i.e., forward slash on Unix platforms, backslash or forward slash on Windows) then ~ is replaced with the current home directory of the user. See examples below.
      
   2. If the character appearing immediately after ~ is not a shell directory separator (i.e., forward slash on Unix platforms, backslash or forward slash on Windows) then ~ along with the trailing token (until before the first directory separator) is looked up directly in the password directory as ~user. See examples below.
      
2. On Windows platforms:
   1. If the character appearing immediately after ~ is a shell directory separator (i.e., forward slash on Unix platforms, backslash or forward slash on Windows) then ~ is replaced with the current home directory of the user. See examples below.
      
   2. If the character appearing immediately after ~ is not a shell directory separator (i.e., forward slash on Unix platforms, backslash or forward slash on Windows) then ~ along with the trailing token (until before the first directory separator) is handled by stripping the last directory component from the user home path.
      
3. If an error occurs or the first character of path is not a ~, then the original path is returned unchanged.
   

Parameters

[in]	path	: The input scalar character of default kind SK containing the path whose leading ~ or ~user is to be expanded.
[out]	failed	: The output scalar logical of default kind LK. It is .true. if and only if an error occurs while expanding the user home directory. (optional. If missing, the program will return the original input path unchanged.)
[in,out]	errmsg	: The input/output scalar character of default kind SK of arbitrary length type parameter. If present and an error occurs, it is assigned an explanatory message describing the nature of the error that has occurred. A length of 2047 characters for errmsg is likely enough to capture most error messages in full. (optional. It can be present only if failed is also present.)

Returns

pathExpandedUser : The output allocatable scalar character of default kind SK containing the input path where ~ or ~user is expanded to the specific user home directory.

Possible calling interfaces ⛓

use pm_sysPath, only: getPathExpandedUser
use pm_kind, only: LK
character(:, SK), allocatable :: pathExpandedUser
character(2047, SK) :: errmsg
logical(LK) :: failed
 
pathExpandedUser = getPathExpandedUser()
pathExpandedUser = getPathExpandedUser(failed)
pathExpandedUser = getPathExpandedUser(failed, errmsg)

Remarks

The procedures under discussion are impure.

See also

getPathNew
getPathPosix
setPathPosix
getPathWindows
setPathWindows
isFailedGetDirTemp
isFailedMakeDirTemp
getPathHostNameIndex

Example usage ⛓

program example
 
    use pm_kind, only: LK, IK, SK
    use pm_io, only: display_type
    use pm_sysPath, only: getPathExpandedUser
    use pm_sysPath, only: getDirHome
 
    implicit none
 
    character(:, SK), allocatable   :: epath
    character(2047, SK)             :: errmsg
    logical(LK)                     :: failed
 
    type(display_type) :: disp
    disp = display_type(file = "main.out.F90")
 
    call disp%skip()
    call disp%show("epath = getPathExpandedUser(SK_'~')")
                    epath = getPathExpandedUser(SK_'~')
    call disp%show("epath")
    call disp%show( epath , deliml = SK_"""" )
    call disp%show("getDirHome()")
    call disp%show( getDirHome() , deliml = SK_"""" )
    call disp%skip()
 
    call disp%skip()
    call disp%show("epath = getPathExpandedUser(SK_'~paramonte')")
                    epath = getPathExpandedUser(SK_'~paramonte')
    call disp%show("epath")
    call disp%show( epath , deliml = SK_"""" )
    call disp%skip()
 
    call disp%skip()
    call disp%show("epath = getPathExpandedUser(SK_'~/paramonte')")
                    epath = getPathExpandedUser(SK_'~/paramonte')
    call disp%show("epath")
    call disp%show( epath , deliml = SK_"""" )
    call disp%skip()
 
    call disp%skip()
    call disp%show("epath = getPathExpandedUser(SK_'./~/paramonte', failed = failed) ! Gracefully capture any runtime error while retrieving the current working directory.")
                    epath = getPathExpandedUser(SK_'./~/paramonte', failed = failed)
    call disp%show("failed")
    call disp%show( failed )
    call disp%show(.not."if ( failed) call disp%show(epath)")
                    if (.not. failed) call disp%show(epath, deliml = SK_"""" )
    call disp%skip()
 
    call disp%skip()
    call disp%show("epath = getPathExpandedUser(SK_'', failed = failed) ! Gracefully capture any runtime error while retrieving the current working directory.")
                    epath = getPathExpandedUser(SK_'', failed = failed)
    call disp%show("failed")
    call disp%show( failed )
    call disp%show(.not."if ( failed) call disp%show(epath)")
                    if (.not. failed) call disp%show(epath, deliml = SK_"""" )
    call disp%skip()
 
    call disp%skip()
    call disp%show("epath = getPathExpandedUser(SK_'~~/paramonte', failed = failed, errmsg = errmsg) ! Gracefully capture any runtime error while retrieving the current working directory.")
                    epath = getPathExpandedUser(SK_'~~/paramonte', failed = failed, errmsg = errmsg)
    call disp%show("failed")
    call disp%show( failed )
    call disp%show("if (failed) then; call disp%show(trim(errmsg), deliml = SK_''''); else; call disp%show(epath, deliml = SK_''''); end if )")
                    if (failed) then; call disp%show(trim(errmsg), deliml = SK_''''); else; call disp%show(epath, deliml = SK_''''); end if
    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 ⛓

 
epath = getPathExpandedUser(SK_'~')
epath
"/home/amir"
getDirHome()
"/home/amir"
 
 
epath = getPathExpandedUser(SK_'~paramonte')
epath
"/home/paramonte"
 
 
epath = getPathExpandedUser(SK_'~/paramonte')
epath
"/home/amir/paramonte"
 
 
epath = getPathExpandedUser(SK_'./~/paramonte', failed = failed) ! Gracefully capture any runtime error while retrieving the current working directory.
failed
F
if (.not. failed) call disp%show(epath)
"./~/paramonte"
 
 
epath = getPathExpandedUser(SK_'', failed = failed) ! Gracefully capture any runtime error while retrieving the current working directory.
failed
F
if (.not. failed) call disp%show(epath)
""
 
 
epath = getPathExpandedUser(SK_'~~/paramonte', failed = failed, errmsg = errmsg) ! Gracefully capture any runtime error while retrieving the current working directory.
failed
F
if (failed) then; call disp%show(trim(errmsg), deliml = SK_''''); else; call disp%show(epath, deliml = SK_''''); end if )
'/home/~/paramonte'
 
 

Test:

test_pm_sysPath

Todo:

Low Priority: A subroutine version of this functional interface could be implemented in future to avoid allocations and allow for non-default character kinds.

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 2987 of file pm_sysPath.F90.

---

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

• src/fortran/main/pm_sysPath.F90