pm_sysPath::getDirCurrent Interface Reference

Generate and return the Current Working Directory (CWD) of the runtime shell.
More...

Detailed Description

Generate and return the Current Working Directory (CWD) of the runtime shell.

The name of this interface is intentionally chosen to be different from getcwd which is an Intel IFPORT and GNU Fortran extension procedure name.

The implementation of this procedure is compiler-dependent depending on whether the output argument errmsg is present or missing.

1. If errmsg is missing, then the appropriate runtime system shell command pwd is called to generate the CWD.
   
2. If errmsg is present, then,
   
   1. If the library is built with either GNU or Intel Fortran compilers, then the compiler intrinsic procedure getcwd() is called to generate the CWD.
      
   2. If the library is built with other compilers, then the appropriate runtime system shell command pwd is called to generate the CWD.
      
   This behavior is enforced by the Intel and GNU interfaces for getcwd() which does not return error message for failures.
   

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 working 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. It can be present only if failed is also present.)

Returns

dirCurrent : The output allocatable scalar character of default kind SK containing the path to the current working directory (including drive letter on windows OS).
The default value for dirCurrent is "." if the procedure fails to infer the full path to the current working directory.

Possible calling interfaces ⛓

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

Remarks

The procedures under discussion are impure.

See also

getPathNew
getPathPosix
setPathPosix
getPathWindows
setPathWindows
isFailedGetDirTemp
getPathHostNameIndex

Example usage ⛓

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

 
cpath = getDirCurrent() ! get the current working directory.
cpath
"/home/amir/git/paramonte/external/paramonted/doxygen/bld/linux/amd64/gnu/13.1.0/native/lib/mem/serial/fortran/checking/pkg/example/pm_sysPath/getDirCurrent"
isDir(cpath)
T
 
 
cpath = getDirCurrent(failed) ! Gracefully capture any runtime error while retrieving the current working directory.
failed
F
if (.not. failed) call disp%show(cpath)
"/home/amir/git/paramonte/external/paramonted/doxygen/bld/linux/amd64/gnu/13.1.0/native/lib/mem/serial/fortran/checking/pkg/example/pm_sysPath/getDirCurrent"
 
 
cpath = getDirCurrent(failed, 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(cpath, deliml = SK_''''); end if )
'/home/amir/git/paramonte/external/paramonted/doxygen/bld/linux/amd64/gnu/13.1.0/native/lib/mem/serial/fortran/checking/pkg/example/pm_sysPath/getDirCurrent'
 
 

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 at Austin

Definition at line 2759 of file pm_sysPath.F90.

---

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

• src/fortran/main/pm_sysPath.F90