pm_sysShell::isFailedGetShellShape Interface Reference

Generate and return failed = .false. if the attempt to fetch the shape (height and width) of the current shell terminal is successful.
Otherwise, return failed = .true. indicating the occurrence of an error.
More...

Detailed Description

Generate and return failed = .false. if the attempt to fetch the shape (height and width) of the current shell terminal is successful.
Otherwise, return failed = .true. indicating the occurrence of an error.

This procedure utilizes shell-specific commands and environment variables to get the properties of the current terminal window.

Parameters

[in]	width	: The output scalar integer of default kind IK containing the width (in characters) of the current terminal windows, if and only if the width retrieval is successful.
[in]	height	: The output scalar integer of default kind IK containing the height (in characters) of the current terminal windows, if and only if the width retrieval is successful.

Returns

failed : The output scalar logical of default kind LK. It is .true. if and only if an error occurs while fetching the requested property.

Possible calling interfaces ⛓

use pm_sysShell, only: isFailedGetShellShape
use pm_kind, only: LK, IK
logical(LK) :: failed
integer(IK) :: width
 
failed = isFailedGetShellShape(width, height)

Remarks

The procedures under discussion are impure.

See also

shell_type
display_type
getStrWrapped
isFailedGetShellHeight

Example usage ⛓

program example
 
    use pm_kind, only: LK, IK, SK
    use pm_io, only: display_type
    use pm_sysShell, only: isFailedGetShellShape
 
    implicit none
 
    logical(LK) :: failed
    integer(IK) :: width, height
 
    type(display_type) :: disp
    disp = display_type(file = "main.out.F90")
 
    call disp%skip()
    call disp%show(.not.'if ( isFailedGetShellShape(width, height)) call disp%show([width, height])')
                    if (.not. isFailedGetShellShape(width, height)) call disp%show([width, height])
    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 (.not. isFailedGetShellShape(width, height)) call disp%show([width, height])
+316, +88
 
 

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

---

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

• src/fortran/main/pm_sysShell.F90