pm_sysInfo::kernel_type Type Reference

This is the kernel_type class for generating objects with logical components to determine the operating system (OS) kernel and its name. More...

Public Attributes
character(:, SK), allocatable	name
	The allocatable scalar of type character of default kind SK, containing the operating system name. More...
type(kernelis_type)	is
	The scalar object of type kernelis_type containing the logical components indicating the OS. More...

Detailed Description

This is the kernel_type class for generating objects with logical components to determine the operating system (OS) kernel and its name.

When an object of this type is generated, a single object component name corresponding to OS name is filled with,

1. "Windows" if the OS is Windows.
2. "Cygwin" if the OS is Cygwin.
3. "MinGW" if the OS is MinGW.
4. "MSYS" if the OS is MinGW.
5. "Linux" if the OS is Linux.
6. "Darwin" if the OS is Darwin.
7. "FreeBSD" if the OS is FreeBSD.

Otherwise, if the appropriate preprocessing macro is undefined, the type constructor will use the facilities of the runtime shell to infer the Operating System kernel name through either:

1. the Windows OS environmental variable in Windows-style runtime shells.
2. the UNIX OSTYPE environmental variable in UNIX-style runtime shells.
3. the UNIX uname command on unix-style runtime shells.

Warning

The environments "msys", "MinGW", "Cygwin" are not really standalone Operating System kernels, rather Linux compatibility environments within Windows platforms.
As such, when such environments are detected, the windows component of the is component of the object of type kernel_type is always set to .true..

Even though Cygwin and MinGW are considered operating systems independently of Windows

Parameters

[out]	failed	: The output scalar logical of default kind LK that is .true. if and only if an error occurs while inferring the operating system kernel. (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

kernel : The output scalar object of type kernel_type containing the specifics of the operating system kernel name.

Possible calling interfaces ⛓

use pm_kind, only: LK
use pm_sysInfo, only: kernel_type
character(255, SK) :: errmsg
type(kernel_type) :: kernel
logical(LK) :: failed
 
kernel = kernel_type()
kernel = kernel_type(failed)
kernel = kernel_type(failed, errmsg)

See also

getSysInfo
kernel_type
kernelis_type
shell_type
shellis_type
isShellWindows
isShellPosix
isKernelLinux
isKernelDarwin
isKernelWindows

Example usage ⛓

program example
 
    use pm_kind, only: LK, IK, SK
    use pm_io, only: display_type
    use pm_sysInfo, only: kernel_type
 
    implicit none
 
    logical(LK) :: failed
    character(255, SK) :: errmsg
    type(kernel_type) :: kernel
 
    type(display_type)  :: disp
    disp = display_type(file = "main.out.F90")
 
    call disp%skip()
    call disp%show("kernel = kernel_type()")
                    kernel = kernel_type()
    call dispkernel()
    call disp%skip()
 
    call disp%skip()
    call disp%show("kernel = kernel_type(failed)")
                    kernel = kernel_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 dispkernel()
    end if
    call disp%skip()
 
    call disp%skip()
    call disp%show("kernel = kernel_type(failed, errmsg)")
                    kernel = kernel_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 dispkernel()
    end if
    call disp%skip()
 
contains
 
    subroutine dispkernel()
#if     __INTEL_COMPILER
#undef  linux
#endif
        call disp%show("kernel%name")
        call disp%show( kernel%name , deliml = SK_"""" )
        call disp%show("kernel%is%windows")
        call disp%show( kernel%is%windows )
        call disp%show("kernel%is%cygwin")
        call disp%show( kernel%is%cygwin )
        call disp%show("kernel%is%mingw")
        call disp%show( kernel%is%mingw )
        call disp%show("kernel%is%msys")
        call disp%show( kernel%is%msys )
        call disp%show("kernel%is%linux")
        call disp%show( kernel%is%linux )
        call disp%show("kernel%is%darwin")
        call disp%show( kernel%is%darwin )
        call disp%show("kernel%is%freebsd")
        call disp%show( kernel%is%freebsd )
    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 ⛓

 
kernel = kernel_type()
kernel%name
"Linux"
kernel%is%windows
F
kernel%is%cygwin
F
kernel%is%mingw
F
kernel%is%msys
F
kernel%is%linux
T
kernel%is%darwin
F
kernel%is%freebsd
F
 
 
kernel = kernel_type(failed)
failed ! Check if any error has occurred.
F
kernel%name
"Linux"
kernel%is%windows
F
kernel%is%cygwin
F
kernel%is%mingw
F
kernel%is%msys
F
kernel%is%linux
T
kernel%is%darwin
F
kernel%is%freebsd
F
 
 
kernel = kernel_type(failed, errmsg)
failed ! Check if any error has occurred.
F
kernel%name
"Linux"
kernel%is%windows
F
kernel%is%cygwin
F
kernel%is%mingw
F
kernel%is%msys
F
kernel%is%linux
T
kernel%is%darwin
F
kernel%is%freebsd
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 Austin

Definition at line 244 of file pm_sysInfo.F90.

Member Data Documentation

is

type(kernelis_type) pm_sysInfo::kernel_type::is

The scalar object of type kernelis_type containing the logical components indicating the OS.

Definition at line 246 of file pm_sysInfo.F90.

name

character(:, SK), allocatable pm_sysInfo::kernel_type::name

The allocatable scalar of type character of default kind SK, containing the operating system name.

Definition at line 245 of file pm_sysInfo.F90.

---

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

• src/fortran/main/pm_sysInfo.F90