pm_sysShell::isFailedExec Interface Reference

Generate and return failed = .false. if the attempt to run the requested shell command is successful.
Otherwise, return failed = .true. indicating the occurrence of an error. More...

Detailed Description

Generate and return failed = .false. if the attempt to run the requested shell command is successful.
Otherwise, return failed = .true. indicating the occurrence of an error.

This procedure provides a convenient functional interface to the Fortran intrinsic execute_command_line() by automatically interpreting the output error codes and reporting the failure as the function output if it occurs.

Parameters

[in]	command	: The input scalar character of default kind SK containing the system shell command to run.
[in]	wait	: The input scalar logical of default kind LK with the same functionality as the wait argument of the Fortran intrinsic execute_command_line(). If .true., the procedure will wait for the command to terminate before returning the control to the Fortran program. Otherwise, the process of running the requested shell command will be done asynchronously. (optional, default = .true.)
[in,out]	exitstat	: The input/output scalar integer of default kind IK with the same functionality as the exitstat argument of the Fortran intrinsic execute_command_line(). On output, it is assigned the process exit status from the command, only if wait = .true.. If wait = .false., the value of exitstat remains untouched. The value and meaning of this output argument is system dependent, but a non-zero value typically indicates the occurrence of an error within the execution of the specified command. (optional. If missing, no exit status will be returned.)
[out]	cmdstat	: The output scalar integer of default kind IK with the same functionality as the cmdstat argument of the Fortran intrinsic execute_command_line(). On output, it is assigned 0 if the process of running the requested shell command terminates without error, -1 if the processor does not support command execution, -2 if wait = .true. is specified but the processor does not support asynchronous command execution, a positive value if any other error occurs. (optional. If missing, no cmdstat will be returned.)
[in,out]	cmdmsg	: The input/output scalar character of default kind SK of arbitrary length type parameter the same functionality as the cmdmsg argument of the Fortran intrinsic execute_command_line(). If present and the output cmdstat is assigned a positive value, then cmdmsg will be assigned an explanatory message describing the nature of the error that has occurred. If the length of cmdstat is too short for the output error message, the message tail will be clipped as needed. A length of LEN_IOMSG characters for cmdmsg 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 running the command.
The failure is determined by checking for a non-zero value of cmdstat.
The specific value of exitstat depends on both the processor and the specified value for the input argument wait.
Moreover, the processor may execute the specified command without failure even though exitstat indicates the occurrence of an error within the command.
As such, the output value of exitstat has no impact on the value of the output failed.

Possible calling interfaces ⛓

use pm_sysShell, only: isFailedExec
use pm_kind, only: LK
logical(LK) :: failed
 
failed = isFailedExec(command, wait = wait, exitstat = exitstat, cmdstat = cmdstat, cmdmsg = cmdmsg)

Warning

This procedure is prone to abuse by requesting to run system commands with devastating consequences.

Remarks

The procedures under discussion are impure.

The procedures under discussion are elemental.

See also

shell_type

Example usage ⛓

program example
 
    use pm_kind, only: LK, IK, SK
    use pm_io, only: display_type
    use pm_sysShell, only: isFailedExec
    use pm_sysPath, only: isFile, getPathNew
 
    implicit none
 
    character(:, SK), allocatable  :: file
    character(255, SK)  :: cmdmsg = SK_""
    integer(IK)         :: cmdstat
    integer(IK)         :: exitstat = -huge(0_IK)
    logical(LK)         :: cmdExecFailed
 
    type(display_type) :: disp
    disp = display_type(file = "main.out.F90")
 
    call disp%skip()
    call disp%show("cmdExecFailed = isFailedExec(SK_'')")
                    cmdExecFailed = isFailedExec(SK_'')
    call disp%show("cmdExecFailed")
    call disp%show( cmdExecFailed )
    call disp%skip()
 
    call disp%skip()
    call disp%show("cmdExecFailed = isFailedExec(SK_'ls')")
                    cmdExecFailed = isFailedExec(SK_'ls')
    call disp%show("cmdExecFailed")
    call disp%show( cmdExecFailed )
    call disp%skip()
 
    call disp%skip()
    call disp%show("file = getPathNew() ! Create a file name unique in the current directory.")
                    file = getPathNew()
    call disp%show("file")
    call disp%show( file , deliml = SK_"""" )
    call disp%show("isFile(file)")
    call disp%show( isFile(file) )
    call disp%show("cmdExecFailed = isFailedExec(SK_'echo 2>'//file) ! Create an empty file in the current directory.")
                    cmdExecFailed = isFailedExec(SK_'echo 2>'//file)
    call disp%show("cmdExecFailed")
    call disp%show( cmdExecFailed )
    call disp%show("isFile(file)")
    call disp%show( isFile(file) )
    call disp%skip()
 
    call disp%skip()
    call disp%show("cmdExecFailed = isFailedExec(SK_'ls', wait = .false._LK) ! run the Bash command asynchronously.")
                    cmdExecFailed = isFailedExec(SK_'ls', wait = .false._LK)
    call disp%show("cmdExecFailed")
    call disp%show( cmdExecFailed )
    call disp%skip()
 
    call disp%skip()
    call disp%show("cmdExecFailed = isFailedExec(SK_'', exitstat = exitstat, cmdstat = cmdstat, cmdmsg = cmdmsg)")
                    cmdExecFailed = isFailedExec(SK_'', exitstat = exitstat, cmdstat = cmdstat, cmdmsg = cmdmsg)
    call disp%show("cmdExecFailed")
    call disp%show( cmdExecFailed )
    call disp%show("exitstat")
    call disp%show( exitstat )
    call disp%show("cmdstat")
    call disp%show( cmdstat )
    call disp%show("trim(cmdmsg)")
    call disp%show( trim(cmdmsg) , deliml = SK_"""" )
    call disp%skip()
 
    call disp%skip()
    call disp%show("cmdExecFailed = isFailedExec(SK_'dir', exitstat = exitstat, cmdstat = cmdstat, cmdmsg = cmdmsg)")
                    cmdExecFailed = isFailedExec(SK_'dir', exitstat = exitstat, cmdstat = cmdstat, cmdmsg = cmdmsg)
    call disp%show("cmdExecFailed")
    call disp%show( cmdExecFailed )
    call disp%show("exitstat")
    call disp%show( exitstat )
    call disp%show("cmdstat")
    call disp%show( cmdstat )
    call disp%show("trim(cmdmsg)")
    call disp%show( trim(cmdmsg) , deliml = SK_"""" )
    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 ⛓

 
cmdExecFailed = isFailedExec(SK_'')
cmdExecFailed
F
 
 
cmdExecFailed = isFailedExec(SK_'ls')
cmdExecFailed
F
 
 
file = getPathNew() ! Create a file name unique in the current directory.
file
"new_20241114_224808_081_pid_1"
isFile(file)
F
cmdExecFailed = isFailedExec(SK_'echo 2>'//file) ! Create an empty file in the current directory.
cmdExecFailed
F
isFile(file)
T
 
 
cmdExecFailed = isFailedExec(SK_'ls', wait = .false._LK) ! run the Bash command asynchronously.
cmdExecFailed
F
 
 
cmdExecFailed = isFailedExec(SK_'', exitstat = exitstat, cmdstat = cmdstat, cmdmsg = cmdmsg)
cmdExecFailed
F
exitstat
+0
cmdstat
+0
trim(cmdmsg)
""
 
 
cmdExecFailed = isFailedExec(SK_'dir', exitstat = exitstat, cmdstat = cmdstat, cmdmsg = cmdmsg)
cmdExecFailed
F
exitstat
+0
cmdstat
+0
trim(cmdmsg)
""
 
 

Test:

test_pm_sysShell

Todo:

Low Priority: The current Fortran standard 202x does not allow passing characters of non-default kind to Fortran intrinsic 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 1141 of file pm_sysShell.F90.

---

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

• src/fortran/main/pm_sysShell.F90