ParaMonte Fortran 2.0.0
Parallel Monte Carlo and Machine Learning Library
See the latest version documentation.
pm_sysShell::isShellCMD Interface Reference

Generate and return .true. if the runtime system shell is Windows CMD. More...

Detailed Description

Generate and return .true. if the runtime system shell is Windows CMD.

Refer to the documentation details of shell_type for information on what system shells are available on what operating systems.
The procedures of this generic interface serve as a shortcut to the cmd component of shellis_type.

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 type.
(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. If missing, no error message will be output. Its presence is relevant only if failed is also present.)
Returns
shellIsCMD : The output scalar logical of default kind LK. It is .true. if and only if the runtime system shell is Windows-based (e.g., CMD, PowerShell).


Possible calling interfaces

use pm_kind, only: LK
logical(LK) :: failed
logical(LK) :: shellIsCMD
character(255, SK) :: errmsg = SK_""
shellIsCMD = isShellCMD()
shellIsCMD = isShellCMD(failed)
shellIsCMD = isShellCMD(failed, errmsg)
Generate and return .true. if the runtime system shell is Windows CMD.
This module defines the relevant Fortran kind type-parameters frequently used in the ParaMonte librar...
Definition: pm_kind.F90:268
integer, parameter LK
The default logical kind in the ParaMonte library: kind(.true.) in Fortran, kind(....
Definition: pm_kind.F90:541
This module contains procedures and generic interfaces for inferring the runtime system shell type an...
Definition: pm_sysShell.F90:38
Remarks
The procedures under discussion are impure.
See also
shell_type
isShellWindows


Example usage

1program example
2
3 use pm_kind, only: LK, IK, SK
4 use pm_io, only: display_type
5 use pm_sysShell, only: isShellCMD
6
7 implicit none
8
9 character(255, SK) :: errmsg = SK_""
10 logical(LK) :: failed
11
12 type(display_type) :: disp
13 disp = display_type(file = "main.out.F90")
14
15 call disp%skip()
16 call disp%show("isShellCMD()")
17 call disp%show( isShellCMD() )
18 call disp%skip()
19
20 call disp%skip()
21 call disp%show("isShellCMD(failed)")
22 call disp%show( isShellCMD(failed) )
23 call disp%show("failed")
24 call disp%show( failed )
25 call disp%skip()
26
27 call disp%skip()
28 call disp%show("isShellCMD(failed, errmsg)")
29 call disp%show( isShellCMD(failed, errmsg) )
30 call disp%show("failed")
31 call disp%show( failed )
32 call disp%show("trim(errmsg)")
33 call disp%show( trim(errmsg) , deliml = SK_"""" )
34 call disp%skip()
35
36end program example
This is a generic method of the derived type display_type with pass attribute.
Definition: pm_io.F90:11726
This is a generic method of the derived type display_type with pass attribute.
Definition: pm_io.F90:11508
This module contains classes and procedures for input/output (IO) or generic display operations on st...
Definition: pm_io.F90:252
type(display_type) disp
This is a scalar module variable an object of type display_type for general display.
Definition: pm_io.F90:11393
integer, parameter IK
The default integer kind in the ParaMonte library: int32 in Fortran, c_int32_t in C-Fortran Interoper...
Definition: pm_kind.F90:540
integer, parameter SK
The default character kind in the ParaMonte library: kind("a") in Fortran, c_char in C-Fortran Intero...
Definition: pm_kind.F90:539
Generate and return an object of type display_type.
Definition: pm_io.F90:10282

Example Unix compile command via Intel ifort compiler
1#!/usr/bin/env sh
2rm main.exe
3ifort -fpp -standard-semantics -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
4./main.exe

Example Windows Batch compile command via Intel ifort compiler
1del main.exe
2set PATH=..\..\..\lib;%PATH%
3ifort /fpp /standard-semantics /O3 /I:..\..\..\include main.F90 ..\..\..\lib\libparamonte*.lib /exe:main.exe
4main.exe

Example Unix / MinGW compile command via GNU gfortran compiler
1#!/usr/bin/env sh
2rm main.exe
3gfortran -cpp -ffree-line-length-none -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
4./main.exe

Example output
1
3F
4
5
6isShellCMD(failed)
7F
8failed
9F
10
11
12isShellCMD(failed, errmsg)
13F
14failed
15F
16trim(errmsg)
17""
18
19
Test:
test_pm_sysShell


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.

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


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