pm_sysShell::isFailedGetDirTemp Interface Reference

Generate and return failed = .false. if the path to the shell-specified temporary directory is successfully returned in the output dirTemp argument.
Otherwise, return failed = .true. indicating the occurrence of an error. More...

Detailed Description

Generate and return failed = .false. if the path to the shell-specified temporary directory is successfully returned in the output dirTemp argument.
Otherwise, return failed = .true. indicating the occurrence of an error.

The shell-specified temporary directory returned by the procedures under this generic interface is suitable for storing the temporary files and folders.
The procedures under this generic interface return the path designated by the current runtime system shell as temporary folder.
Therefore, the temporary directory returned by the procedures under this generic interface is platform-dependent.

1. In POSIX shells, it is the directory specified in one of the following the environment variables TMPDIR, TMP, TEMP, TEMPDIR.
   If none of the environment variables exist, the default temporary directory "/tmp" is returned as the temporary directory only if it exists.
   Otherwise, the procedure returns failed = .true. and dirTemp variable remains unallocated.
   
2. In Windows shells, it is the directory stored in the environment variable TEMP or TMP.
   If none of the environment variables exist, the procedure returns failed = .true. and dirTemp variable remains unallocated.

Parameters

[out]	dirTemp	: The output allocatable scalar character of default kind SK containing the path to the temporary directory specified by the runtime system shell. The allocation status or the value of dirTemp is undefined if a runtime error occurs. Always check the returned value of failed before using dirTemp.
[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. If missing, no error message will be output. Its presence is relevant only if failed is also present.)

Returns

failed : The output scalar logical of default kind LK. It is .true. if and only if the process of retrieving the system shell temporary path fails at any point.

Possible calling interfaces ⛓

use pm_sysShell, only: isFailedGetDirTemp
use pm_kind, only: LK
character(:, SK), allocatable :: dirTemp
character(255, SK) :: errmsg
logical(LK) :: failed
 
failed = isFailedGetDirTemp(dirTemp)
failed = isFailedGetDirTemp(dirTemp, errmsg)

Warning

User must always verify the function output failed is .false. before using the output dirTemp.

Remarks

The procedures under discussion are impure.

See also

VARENV_DIRTEMP_UNIX
VARENV_DIRTEMP_WINDOWS
isFailedMakeDirTemp
isFailedGetDirTemp
isFailedGetEnvVar
isShellWindows
isShellPosix
isFailedExec
getPathTemp
getPathNew

Example usage ⛓

program example
 
    use pm_kind, only: LK, IK, SK
    use pm_io, only: display_type
    use pm_sysShell, only: isFailedGetDirTemp
 
    implicit none
 
    logical(LK) :: failed
    character(255, SK) :: errmsg = SK_""
    character(:, SK), allocatable :: dirTemp
 
    type(display_type) :: disp
    disp = display_type(file = "main.out.F90")
 
    call disp%skip()
    call disp%show("if (isFailedGetDirTemp(dirTemp)) then; call disp%show( 'Failed to fetch system shell temp. dir.' , deliml = SK_'''' ); else; call disp%show( dirTemp , deliml = SK_'''' ); end if")
                    if (isFailedGetDirTemp(dirTemp)) then; call disp%show( 'Failed to fetch system shell temp. dir.' , deliml = SK_'''' ); else; call disp%show( dirTemp , deliml = SK_'''' ); end if
    call disp%skip()
 
    call disp%skip()
    call disp%show("if (isFailedGetDirTemp(dirTemp, errmsg)) then; call disp%show( trim(errmsg) , deliml = SK_'''' ); else; call disp%show( dirTemp , deliml = SK_'''' ); end if")
                    if (isFailedGetDirTemp(dirTemp, errmsg)) then; call disp%show( trim(errmsg) , deliml = SK_'''' ); else; call disp%show( dirTemp , 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 ⛓

 
if (isFailedGetDirTemp(dirTemp)) then; call disp%show( 'Failed to fetch system shell temp. dir.' , deliml = SK_'''' ); else; call disp%show( dirTemp , deliml = SK_'''' ); end if
'/tmp'
 
 
if (isFailedGetDirTemp(dirTemp, errmsg)) then; call disp%show( trim(errmsg) , deliml = SK_'''' ); else; call disp%show( dirTemp , deliml = SK_'''' ); end if
'/tmp'
 
 

Test:

test_pm_sysShell

Todo:

Low Priority: A subroutine version of this functional interface could be implemented in the future to avoid allocations and allow for non-default character kinds (once the Fortran compilers fully support non-default characters).

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 690 of file pm_sysShell.F90.

---

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

• src/fortran/main/pm_sysShell.F90