logging.F90

Go to the documentation of this file.

module logging_mod
  implicit none

#ifndef TEST_MODE
  private
#endif

  integer, parameter, private :: master_process = 0

  integer, parameter, public :: log_error = 1
  integer, parameter, public :: log_warn = 2
  integer, parameter, public :: log_info = 3
  integer, parameter, public :: log_debug = 4

  character(len=*), parameter ::  error_preamble = "[ERROR]",&  !< Error message preamble
                                  warn_preamble = "[WARN]",& 
                                  info_preamble = "[INFO]",&    
                                  debug_preamble = "[DEBUG]"    

  integer :: current_log_level=log_info
  logical, parameter :: error_is_fatal=.true.
  logical, save :: i_am_master=.true.

  public initialise_logging, log_log, log_newline, log_master_log, log_master_newline, log_is_master, &
       log_set_logging_level, log_get_logging_level

contains

  subroutine initialise_logging(pid)
    integer, intent(in) :: pid

    i_am_master=pid==master_process
  end subroutine initialise_logging  

  subroutine log_master_log(level, message)
    integer, intent(in) :: level
    character(len=*), intent(in) :: message

    if (i_am_master) then
      call log_log(level, message)
    else
      if (error_is_fatal .and. level .eq. log_error) call abort()
    end if
  end subroutine log_master_log
  
  subroutine log_master_newline()
    if (i_am_master) write(*,*) ""
  end subroutine log_master_newline

  logical function log_is_master()
    log_is_master = i_am_master
  end function log_is_master  

  subroutine log_log(level, message, str)
    integer, intent(in) :: level
    character(len=*), intent(in) :: message
    character(len=*), intent(out), optional :: str

    if (level .le. current_log_level) then
      if (present(str)) then
        write(str,"(A,A,A)") trim(get_logging_preamble(level)), " ",message
      else
        write(*,"(A,A,A)") trim(get_logging_preamble(level)), " ", message
      end if
    end if
    if (error_is_fatal .and. level .eq. log_error) call abort()
  end subroutine log_log

  subroutine log_newline()
    write(*,*) ""
  end subroutine log_newline  

  character(len=7) function get_logging_preamble(level)
    integer, intent(in) :: level

    if (level .eq. log_error) then
      get_logging_preamble = error_preamble
    else if (level .eq. log_warn) then
      get_logging_preamble = warn_preamble
    else if (level .eq. log_info) then
      get_logging_preamble = info_preamble
    else
      get_logging_preamble = debug_preamble
    end if
  end function get_logging_preamble

  subroutine log_set_logging_level(level)
    integer, intent(in) :: level

    current_log_level = level
  end subroutine log_set_logging_level

  integer function log_get_logging_level()
    log_get_logging_level = current_log_level
  end function log_get_logging_level
end module logging_mod