fpm_environment Module

This module contains procedures that interact with the programming environment.

  • [get_os_type] – Determine the OS type
  • [get_env] – return the value of an environment variable

Uses


Variables

Type Visibility Attributes Name Initial
integer, public, parameter :: OS_ALL = -1
integer, public, parameter :: OS_CYGWIN = 4
integer, public, parameter :: OS_FREEBSD = 6
integer, public, parameter :: OS_LINUX = 1
integer, public, parameter :: OS_MACOS = 2
integer, public, parameter :: OS_OPENBSD = 7
integer, public, parameter :: OS_SOLARIS = 5
integer, public, parameter :: OS_UNKNOWN = 0
integer, public, parameter :: OS_WINDOWS = 3

Functions

public pure function OS_NAME(os)

Return string describing the OS type flag

Arguments

Type IntentOptional Attributes Name
integer, intent(in) :: os

Return Value character(len=:), allocatable

public function delete_env(name) result(success)

Deletes an environment variable for the current environment using the C standard library Returns an error if the variable did not exist in the first place

Read more…

Arguments

Type IntentOptional Attributes Name
character(len=*), intent(in) :: name

Variable name

Return Value logical

public function get_command_arguments_quoted() result(args)

Arguments

None

Return Value character(len=:), allocatable

public function get_env(NAME, DEFAULT) result(VALUE)

get named environment variable value. It it is blank or not set return the optional default value !print , NAME, ” is not defined in the environment. Strange…” !print , “This processor doesn’t support environment variables. Boooh!”

Arguments

Type IntentOptional Attributes Name
character(len=*), intent(in) :: NAME

name of environment variable to get the value of
character(len=*), intent(in), optional :: DEFAULT

default value to return if the requested value is undefined or blank

Return Value character(len=:), allocatable

the returned value

public function get_os_type() result(r)

Determine the OS type

Read more…

Arguments

None

Return Value integer

public pure function library_filename(package_name, shared, import, target_os) result(name)

Utility function: return library filename

Arguments

Type IntentOptional Attributes Name
character(len=*), intent(in) :: package_name
logical, intent(in) :: shared

Whether it’s a shared library
logical, intent(in) :: import

Whether it’s for linking (import library) or actual library
integer, intent(in) :: target_os

Build target OS: one of OS_WINDOWS, OS_MACOS, …

Return Value character(len=:), allocatable

public function match_os_type(os_name) result(os_type)

Match os_name to os_type enum (similar to profiles.f90)

Arguments

Type IntentOptional Attributes Name
character(len=*), intent(in) :: os_name

Return Value integer

public function os_is_unix(os)

Compare the output of get_os_type or the optional passed INTEGER value to the value for OS_WINDOWS and return .TRUE. if they match and .FALSE. otherwise

Arguments

Type IntentOptional Attributes Name
integer, intent(in), optional :: os

Return Value logical

public function separator() result(sep)

sample usage

Read more…

Arguments

None

Return Value character(len=1)

ifort_bug*!character(len=1),save :: sep_cache=’ ‘

public function set_env(name, value, overwrite)

Set an environment variable for the current environment using the C standard library

Read more…

Arguments

Type IntentOptional Attributes Name
character(len=*), intent(in) :: name

Variable name
character(len=*), intent(in) :: value

Variable value
logical, intent(in), optional :: overwrite

Should a former value be overwritten? default = .true.

Return Value logical


Subroutines

public pure elemental subroutine validate_os_name(os_name, is_valid)

Check if os_name is a valid name of a supported OS

Arguments

Type IntentOptional Attributes Name
character(len=*), intent(in) :: os_name

Name of an operating system
logical, intent(out) :: is_valid

Boolean value of whether os_name is valid or not