pm_sysPath::getDirHome Interface Reference

Generate and return the Home Directory of the current user in the current runtime shell.
More...

Detailed Description

Generate and return the Home Directory of the current user in the current runtime shell.

The home directory identification is platform-dependent:

1. On Unix platforms:
   1. The home directory is retrieved from the envrinment variable HOME.
      If the attempt fails, the home directory will is looked up directly in the password directory.
      
2. On Windows platforms:
   1. The home directory is retrieved from the envrinment variable USERPROFILE of if not available, from the concatenation of the contents of HOMEDRIVE and HOMEPATH envrinment variables.
      
3. If user is specified, the corresponding user home directory will be returned. See examples below.
   
4. If an error occurs the returned home directory is an empty string.
   

Parameters

[out]	failed	: The output scalar logical of default kind LK. It is .true. if and only if an error occurs while inferring the current home directory. (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 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. If missing and an error occurs, then no error will be reported.)
[in]	user	: The input scalar character of default kind SK containing the username whose home directory is to be returned. (optional. If missing, the home directory of the current user is returned.)

Returns

dirHome : The output allocatable scalar character of default kind SK containing the path to the home directory (or empty if an error occurs).

Possible calling interfaces ⛓

use pm_sysPath, only: getDirHome
use pm_kind, only: LK
character(:, SK), allocatable :: dirHome
character(2047, SK) :: errmsg
logical(LK) :: failed
 
dirHome = getDirHome(user = user, failed = failed, errmsg = errmsg)

Remarks

The procedures under discussion are impure.

See also

getPathNew
getPathPosix
setPathPosix
getPathWindows
setPathWindows
isFailedMakeDir
isFailedGetDirTemp
isFailedMakeDirTemp
getPathHostNameIndex

Example usage ⛓

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

 
hpath = getDirHome() ! get the current user home directory.
hpath
"/home/amir"
isDir(hpath)
T
 
 
hpath = getDirHome(user = SK_'') ! empty user returns the current user home.
hpath
"/home/amir"
isDir(hpath)
T
 
 
hpath = getDirHome(user = SK_'paramonte') ! get the home directory of user `paramonte`.
hpath
"/home/paramonte"
isDir(hpath)
F
 
 
hpath = getDirHome(failed = failed) ! Gracefully capture any runtime error while retrieving the home directory.
failed
F
if (.not. failed) call disp%show(hpath)
"/home/amir"
 
 
hpath = getDirHome(failed = failed, errmsg = errmsg) ! Gracefully capture any runtime error while retrieving the home directory.
failed
F
if (failed) then; call disp%show(trim(errmsg), deliml = SK_''''); else; call disp%show(hpath, deliml = SK_''''); end if )
'/home/amir'
 
 

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

---

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

• src/fortran/main/pm_sysPath.F90