pm_sysShell::shellis_type Type Reference

This is the shellis_type class for generating objects with logical components to determine the runtime shell type of the operating system. More...

Public Attributes
logical(LK)	ash = .false._LK
	The scalar logical value indicating whether the shell is Unix Almquist shell (dash). More...
logical(LK)	bash = .false._LK
	The scalar logical value indicating whether the shell is Unix GNU Bourne-Again shell (Bash). More...
logical(LK)	cmd = .false._LK
	The scalar logical value indicating whether the shell is Windows Command Prompt (CMD). More...
logical(LK)	csh = .false._LK
	The scalar logical value indicating whether the shell is Unix C shell (csh). More...
logical(LK)	dash = .false._LK
	The scalar logical value indicating whether the shell is Unix Debian Almquist shell (dash). More...
logical(LK)	fish = .false._LK
	The scalar logical value indicating whether the shell is Unix Friendly Interactive SHell (fish). More...
logical(LK)	ksh = .false._LK
	The scalar logical value indicating whether the shell is Unix Korn shell (ksh). More...
logical(LK)	posix = .false._LK
	The scalar logical value indicating whether the shell is POSIX-compliant (that is, Unix-like, partially or fully POSIX-compliant, e.g., pwsh (PowerShell Core), sh, bash, csh, zsh, fish, ...). More...
logical(LK)	powershell = .false._LK
	The scalar logical value indicating whether the shell is the Microsoft PowerShell (pwsh). More...
logical(LK)	sh = .false._LK
	The scalar logical value indicating whether the shell is Unix Bourne shell (sh). More...
logical(LK)	tcsh = .false._LK
	The scalar logical value indicating whether the shell is Unix tcsh shell (tcsh). More...
logical(LK)	windows = .false._LK
	The scalar logical value indicating whether the shell is Windows-compliant (e.g., pwsh on Windows (Windows PowerShell), CMD). More...
logical(LK)	zsh = .false._LK
	The scalar logical value indicating whether the shell is Unix Z shell (zsh). More...
logical(LK)	yash = .false._LK
	The scalar logical value indicating whether the shell is Unix Yet Another Shell (yash). More...

Detailed Description

This is the shellis_type class for generating objects with logical components to determine the runtime shell type of the operating system.

When an object of this type is generated, a single object component corresponding to runtime shell name is set to .true..
If the runtime shell name is determined to be sh, additional attempt will be made to resolve the actual runtime shell name.
This is because sh is frequently a symlink with an actual target (for example dash on Ubuntu).

POSIX-compliant shells

Additionally, the posix component of the object is set to .true. if the runtime shell name corresponds to,

1. ash
2. bash
3. csh
4. dash
5. ksh
6. pwsh (Microsoft PowerShell core)
7. sh
8. tcsh
9. zsh
10. yash

Normally (, but not necessarily), the runtime operating system for the above shells is Unix (either macOS or variants of linux).
As of July 2022, the above shells are known to have the highest level of compliance with the POSIX standard.

Windows-compliant shells

Alternatively, the windows component of the object is set to .true. if the runtime shell corresponds to,

1. CMD
2. Windows PowerShell

As of July 2022, the above shells are exclusively available on Windows operating systems.

Other shells

As of July 2022, shells that adhere to neither Windows nor POSIX conventions are the following,

1. fish

Parameters

[out]	failed	: The output scalar logical of default kind LK that is .true. if and only if an error occurs while inferring the system shell name. (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 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. It can be present only if failed is also present. If missing, no error message will be output.)

Returns

shell : The output scalar object of type shellis_type containing the specifics of the runtime system shell.

Possible calling interfaces ⛓

use pm_kind, only: LK
use pm_sysShell, only: shellis_type
character(255, SK) :: errmsg
type(shellis_type) :: shell
logical(LK) :: failed
 
shell = shellis_type()
shell = shellis_type(failed)
shell = shellis_type(failed, errmsg)

See also

shell_type
isShellPosix
isShellWindows
Comparison of command shells

Example usage ⛓

program example
 
    use pm_kind, only: LK, IK, SK
    use pm_io, only: display_type
    use pm_sysShell, only: shellis_type
 
    implicit none
 
    type(shellis_type)  :: shellis
    logical(LK)         :: failed
    character(255, SK)  :: errmsg
 
    type(display_type)  :: disp
    disp = display_type(file = "main.out.F90")
 
    call disp%skip()
    call disp%show("shellis = shellis_type()")
                    shellis = shellis_type()
    call dispShellIs()
    call disp%skip()
 
    call disp%skip()
    call disp%show("shellis = shellis_type(failed)")
                    shellis = shellis_type(failed)
    call disp%show("failed ! Check if any error has occurred.")
    call disp%show( failed )
    if (failed) then
    call disp%show("SK_'error occurred.'")
    call disp%show( SK_'error occurred.' , deliml = SK_"""" )
    else
    call dispShellIs()
    end if
    call disp%skip()
 
    call disp%skip()
    call disp%show("shellis = shellis_type(failed, errmsg)")
                    shellis = shellis_type(failed, errmsg)
    call disp%show("failed ! Check if any error has occurred.")
    call disp%show( failed )
    if (failed) then
    call disp%show("errmsg")
    call disp%show( errmsg , deliml = SK_"""" )
    else
    call dispShellIs()
    end if
    call disp%skip()
 
contains
 
    subroutine dispShellIs()
        call disp%show("shellis%ash         ")
        call disp%show( shellis%ash          )
        call disp%show("shellis%bash        ")
        call disp%show( shellis%bash         )
        call disp%show("shellis%csh         ")
        call disp%show( shellis%csh          )
        call disp%show("shellis%cmd         ")
        call disp%show( shellis%cmd          )
        call disp%show("shellis%dash        ")
        call disp%show( shellis%dash         )
        call disp%show("shellis%fish        ")
        call disp%show( shellis%fish         )
        call disp%show("shellis%ksh         ")
        call disp%show( shellis%ksh          )
        call disp%show("shellis%posix       ")
        call disp%show( shellis%posix        )
        call disp%show("shellis%powershell  ")
        call disp%show( shellis%powershell   )
        call disp%show("shellis%sh          ")
        call disp%show( shellis%sh           )
        call disp%show("shellis%tcsh        ")
        call disp%show( shellis%tcsh         )
        call disp%show("shellis%windows     ")
        call disp%show( shellis%windows      )
        call disp%show("shellis%zsh         ")
        call disp%show( shellis%zsh          )
        call disp%show("shellis%yash        ")
        call disp%show( shellis%yash         )
    end subroutine
 
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 ⛓

 
shellis = shellis_type()
shellis%ash         
F
shellis%bash        
F
shellis%csh         
F
shellis%cmd         
F
shellis%dash        
T
shellis%fish        
F
shellis%ksh         
F
shellis%posix       
T
shellis%powershell  
F
shellis%sh          
F
shellis%tcsh        
F
shellis%windows     
F
shellis%zsh         
F
shellis%yash        
F
 
 
shellis = shellis_type(failed)
failed ! Check if any error has occurred.
F
shellis%ash         
F
shellis%bash        
F
shellis%csh         
F
shellis%cmd         
F
shellis%dash        
T
shellis%fish        
F
shellis%ksh         
F
shellis%posix       
T
shellis%powershell  
F
shellis%sh          
F
shellis%tcsh        
F
shellis%windows     
F
shellis%zsh         
F
shellis%yash        
F
 
 
shellis = shellis_type(failed, errmsg)
failed ! Check if any error has occurred.
F
shellis%ash         
F
shellis%bash        
F
shellis%csh         
F
shellis%cmd         
F
shellis%dash        
T
shellis%fish        
F
shellis%ksh         
F
shellis%posix       
T
shellis%powershell  
F
shellis%sh          
F
shellis%tcsh        
F
shellis%windows     
F
shellis%zsh         
F
shellis%yash        
F
 
 

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:50 AM, Institute for Computational Engineering and Sciences (ICES), The University of Texas at Austin

Definition at line 196 of file pm_sysShell.F90.

Member Data Documentation

ash

logical(LK) pm_sysShell::shellis_type::ash = .false._LK

The scalar logical value indicating whether the shell is Unix Almquist shell (dash).

Definition at line 197 of file pm_sysShell.F90.

bash

logical(LK) pm_sysShell::shellis_type::bash = .false._LK

The scalar logical value indicating whether the shell is Unix GNU Bourne-Again shell (Bash).

Definition at line 198 of file pm_sysShell.F90.

cmd

logical(LK) pm_sysShell::shellis_type::cmd = .false._LK

The scalar logical value indicating whether the shell is Windows Command Prompt (CMD).

Definition at line 199 of file pm_sysShell.F90.

csh

logical(LK) pm_sysShell::shellis_type::csh = .false._LK

The scalar logical value indicating whether the shell is Unix C shell (csh).

Definition at line 200 of file pm_sysShell.F90.

dash

logical(LK) pm_sysShell::shellis_type::dash = .false._LK

The scalar logical value indicating whether the shell is Unix Debian Almquist shell (dash).

Definition at line 201 of file pm_sysShell.F90.

fish

logical(LK) pm_sysShell::shellis_type::fish = .false._LK

The scalar logical value indicating whether the shell is Unix Friendly Interactive SHell (fish).

Definition at line 202 of file pm_sysShell.F90.

ksh

logical(LK) pm_sysShell::shellis_type::ksh = .false._LK

The scalar logical value indicating whether the shell is Unix Korn shell (ksh).

Definition at line 203 of file pm_sysShell.F90.

posix

logical(LK) pm_sysShell::shellis_type::posix = .false._LK

The scalar logical value indicating whether the shell is POSIX-compliant (that is, Unix-like, partially or fully POSIX-compliant, e.g., pwsh (PowerShell Core), sh, bash, csh, zsh, fish, ...).

Definition at line 204 of file pm_sysShell.F90.

powershell

logical(LK) pm_sysShell::shellis_type::powershell = .false._LK

The scalar logical value indicating whether the shell is the Microsoft PowerShell (pwsh).

Definition at line 205 of file pm_sysShell.F90.

sh

logical(LK) pm_sysShell::shellis_type::sh = .false._LK

The scalar logical value indicating whether the shell is Unix Bourne shell (sh).

Note

The Shell Command Language (sh) is a programming language described by the POSIX standard.
Because sh is a specification, not an implementation, /bin/sh is a symlink (or a hard link) to an actual implementation on most POSIX systems.
The value sh = .true. implies that the runtime shell most likely points to a POSIX-compliant shell. To find out the target of sh, use the command file -h /bin/sh.

Definition at line 206 of file pm_sysShell.F90.

tcsh

logical(LK) pm_sysShell::shellis_type::tcsh = .false._LK

The scalar logical value indicating whether the shell is Unix tcsh shell (tcsh).

Definition at line 211 of file pm_sysShell.F90.

windows

logical(LK) pm_sysShell::shellis_type::windows = .false._LK

The scalar logical value indicating whether the shell is Windows-compliant (e.g., pwsh on Windows (Windows PowerShell), CMD).

Definition at line 212 of file pm_sysShell.F90.

yash

logical(LK) pm_sysShell::shellis_type::yash = .false._LK

The scalar logical value indicating whether the shell is Unix Yet Another Shell (yash).

Definition at line 214 of file pm_sysShell.F90.

zsh

logical(LK) pm_sysShell::shellis_type::zsh = .false._LK

The scalar logical value indicating whether the shell is Unix Z shell (zsh).

Definition at line 213 of file pm_sysShell.F90.

---

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

• src/fortran/main/pm_sysShell.F90