ParaMonte Fortran 2.0.0
Parallel Monte Carlo and Machine Learning Library
See the latest version documentation.
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_kind, only: LK
character(:, SK), allocatable :: dirHome
character(2047, SK) :: errmsg
logical(LK) :: failed
dirHome = getDirHome(user = user, failed = failed, errmsg = errmsg)
Generate and return the Home Directory of the current user in the current runtime shell.
This module defines the relevant Fortran kind type-parameters frequently used in the ParaMonte librar...
Definition: pm_kind.F90:268
integer, parameter LK
The default logical kind in the ParaMonte library: kind(.true.) in Fortran, kind(....
Definition: pm_kind.F90:541
This module contains classes and procedures for manipulating system file/folder paths.
Definition: pm_sysPath.F90:274
Remarks
The procedures under discussion are impure.
See also
getPathNew
getPathPosix
setPathPosix
getPathWindows
setPathWindows
isFailedMakeDir
isFailedGetDirTemp
isFailedMakeDirTemp
getPathHostNameIndex


Example usage

1program example
2
3 use pm_kind, only: LK, IK, SK
4 use pm_io, only: display_type
5 use pm_sysPath, only: getDirHome, isDir
6
7 implicit none
8
9 character(:, SK), allocatable :: hpath
10 character(2047, SK) :: errmsg
11 logical(LK) :: failed
12
13 type(display_type) :: disp
14 disp = display_type(file = "main.out.F90")
15
16 call disp%skip()
17 call disp%show("hpath = getDirHome() ! get the current user home directory.")
18 hpath = getDirHome()
19 call disp%show("hpath")
20 call disp%show( hpath , deliml = SK_"""" )
21 call disp%show("isDir(hpath)")
22 call disp%show( isDir(hpath) )
23 call disp%skip()
24
25 call disp%skip()
26 call disp%show("hpath = getDirHome(user = SK_'') ! empty user returns the current user home.")
27 hpath = getDirHome(user = SK_'')
28 call disp%show("hpath")
29 call disp%show( hpath , deliml = SK_"""" )
30 call disp%show("isDir(hpath)")
31 call disp%show( isDir(hpath) )
32 call disp%skip()
33
34 call disp%skip()
35 call disp%show("hpath = getDirHome(user = SK_'paramonte') ! get the home directory of user `paramonte`.")
36 hpath = getDirHome(user = SK_'paramonte')
37 call disp%show("hpath")
38 call disp%show( hpath , deliml = SK_"""" )
39 call disp%show("isDir(hpath)")
40 call disp%show( isDir(hpath) )
41 call disp%skip()
42
43 call disp%skip()
44 call disp%show("hpath = getDirHome(failed = failed) ! Gracefully capture any runtime error while retrieving the home directory.")
45 hpath = getDirHome(failed = failed)
46 call disp%show("failed")
47 call disp%show( failed )
48 call disp%show(.not."if ( failed) call disp%show(hpath)")
49 if (.not. failed) call disp%show(hpath, deliml = SK_"""" )
50 call disp%skip()
51
52 call disp%skip()
53 call disp%show("hpath = getDirHome(failed = failed, errmsg = errmsg) ! Gracefully capture any runtime error while retrieving the home directory.")
54 hpath = getDirHome(failed = failed, errmsg = errmsg)
55 call disp%show("failed")
56 call disp%show( failed )
57 call disp%show("if (failed) then; call disp%show(trim(errmsg), deliml = SK_''''); else; call disp%show(hpath, deliml = SK_''''); end if )")
58 if (failed) then; call disp%show(trim(errmsg), deliml = SK_''''); else; call disp%show(hpath, deliml = SK_''''); end if
59 call disp%skip()
60
61end program example
This is a generic method of the derived type display_type with pass attribute.
Definition: pm_io.F90:11726
This is a generic method of the derived type display_type with pass attribute.
Definition: pm_io.F90:11508
Generate and return .true. is the input path is an extant system directory, otherwise return ....
This module contains classes and procedures for input/output (IO) or generic display operations on st...
Definition: pm_io.F90:252
type(display_type) disp
This is a scalar module variable an object of type display_type for general display.
Definition: pm_io.F90:11393
integer, parameter IK
The default integer kind in the ParaMonte library: int32 in Fortran, c_int32_t in C-Fortran Interoper...
Definition: pm_kind.F90:540
integer, parameter SK
The default character kind in the ParaMonte library: kind("a") in Fortran, c_char in C-Fortran Intero...
Definition: pm_kind.F90:539
Generate and return an object of type display_type.
Definition: pm_io.F90:10282

Example Unix compile command via Intel ifort compiler
1#!/usr/bin/env sh
2rm main.exe
3ifort -fpp -standard-semantics -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
4./main.exe

Example Windows Batch compile command via Intel ifort compiler
1del main.exe
2set PATH=..\..\..\lib;%PATH%
3ifort /fpp /standard-semantics /O3 /I:..\..\..\include main.F90 ..\..\..\lib\libparamonte*.lib /exe:main.exe
4main.exe

Example Unix / MinGW compile command via GNU gfortran compiler
1#!/usr/bin/env sh
2rm main.exe
3gfortran -cpp -ffree-line-length-none -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
4./main.exe

Example output
1
2hpath = getDirHome() ! get the current user home directory.
3hpath
4"/home/amir"
5isDir(hpath)
6T
7
8
9hpath = getDirHome(user = SK_'') ! empty user returns the current user home.
10hpath
11"/home/amir"
12isDir(hpath)
13T
14
15
16hpath = getDirHome(user = SK_'paramonte') ! get the home directory of user `paramonte`.
17hpath
18"/home/paramonte"
19isDir(hpath)
20F
21
22
23hpath = getDirHome(failed = failed) ! Gracefully capture any runtime error while retrieving the home directory.
24failed
25F
26if (.not. failed) call disp%show(hpath)
27"/home/amir"
28
29
30hpath = getDirHome(failed = failed, errmsg = errmsg) ! Gracefully capture any runtime error while retrieving the home directory.
31failed
32F
33if (failed) then; call disp%show(trim(errmsg), deliml = SK_''''); else; call disp%show(hpath, deliml = SK_''''); end if )
34'/home/amir'
35
36
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.

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

Definition at line 2879 of file pm_sysPath.F90.


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