pm_sysPath::isFailedMakeDirTemp Interface Reference

Generate and return .true. if the attempt to create a temporary directory fails.
Otherwise return .false. and set the output path to the newly created temporary directory.
More...

Detailed Description

Generate and return .true. if the attempt to create a temporary directory fails.
Otherwise return .false. and set the output path to the newly created temporary directory.

The procedures of this generic interface attempt to create a unique temporary directory wihtin a parent directory that is either,

1. specified by the user as the input parent, or
2. the system-designated temporary directory returned by isFailedGetDirTemp, or
3. the current working directory.
   

Parameters

[out]	path	: The output allocatable scalar character of default kind SK containing a POSIX-style or Windows-style path to the temporary directory the procedure creates. If the procedure fails, the allocation status or contents of path will be undefined.
[in]	parent	: The input scalar character of default kind SK containing the parent directory within which the temporary directory should be created. (optional, default = either the system-specified temporary directory or the current working directory)
[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. If the length of errmsg is too short for the output error message, the message tail will be clipped as needed. A length of 2047 characters for errmsg is likely enough to capture most error messages in full. (optional. If missing, no error message will be output.)

Returns

failed : The output scalar logical of default kind LK. It is .true. if and only if an error occurs while creating the temporary directory.

Possible calling interfaces ⛓

use pm_sysPath, only: isFailedMakeDirTemp
use pm_kind, only: LK
logical(LK) :: failed
 
failed = isFailedMakeDirTemp(path, parent = parent, errmsg = errmsg)

Remarks

The procedures under discussion are impure.

See also

getPathNew
isFailedMakeDir
isFailedGetDirTemp

Example usage ⛓

program example
 
    use pm_kind, only: LK, IK, SK
    use pm_io, only: display_type
    use pm_sysPath, only: isFailedMakeDirTemp, isDir
 
    implicit none
 
    character(:, SK), allocatable :: tempdir
 
    type(display_type) :: disp
    disp = display_type(file = "main.out.F90")
 
    call disp%skip()
    call disp%show("isFailedMakeDirTemp(tempdir)")
    call disp%show( isFailedMakeDirTemp(tempdir) )
    call disp%show("tempdir")
    call disp%show( tempdir , deliml = SK_"""" )
    call disp%show("isDir(tempdir)")
    call disp%show( isDir(tempdir) )
    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 ⛓

 
isFailedMakeDirTemp(tempdir)
F
tempdir
"/tmp/temp_20241114_224738_436_pid_1"
isDir(tempdir)
T
 
 

Test:

test_pm_sysPath

Todo:

Normal Priority: The current Fortran standard 202x does not allow passing characters of non-default kind to the intrinsic Fortran statements and procedures.
This generic interface should be extended to in the future to support non-default character kinds when they fully supported by the Fortran intrinsic procedures.

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

---

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

• src/fortran/main/pm_sysPath.F90