logger_type Derived Type

type, public :: logger_type

custom logger data type


Components

Type Visibility Attributes Name Initial
integer(kind=default_int), public :: log_file_level = verbose_level

set default log file log level to verbose
integer(kind=default_int), public :: log_level = info_level

set default log level to info
logical, private :: hide_log_level_prefix = .true.

When true, omit level prefixes in rendered log lines.
logical, private :: log_file_open = .false.
integer(kind=default_int), private :: log_file_unit = -1

Type-Bound Procedures

procedure, public, pass(self), non_overridable :: close_log_file

Close the log file, needs to be called at the end of the program. Usage: call my_logger%close_log_file()

  • private subroutine close_log_file(self)

    Close the log file, needs to be called at the end of the program

    Read more…

    Arguments

    Type IntentOptional Attributes Name
    class(logger_type), intent(inout) :: self

procedure, public, pass(self), non_overridable :: configuration

Get the current logger verbosity configuration. Usage: call my_logger%configuration(level)

  • private pure subroutine configuration(self, level)

    Get the current logger verbosity configuration

    Read more…

    Arguments

    Type IntentOptional Attributes Name
    class(logger_type), intent(in) :: self
    integer(kind=default_int), intent(out), optional :: level

procedure, public, pass(self), non_overridable :: configure

Configure the logger to be a certain verbosity level. Usage: call my_logger%configure(level)

  • private pure subroutine configure(self, level)

    Configure the logger to be a certain verbosity level

    Read more…

    Arguments

    Type IntentOptional Attributes Name
    class(logger_type), intent(inout) :: self
    integer(kind=default_int), intent(in), optional :: level

procedure, public, pass(self), non_overridable :: configure_file_output

Configure the logger to file to be a certain verbosity level. Usage: call my_logger%configure_file_output(filename, level)

  • private subroutine configure_file_output(self, filename, level)

    Configure the logger to file to be a certain verbosity level

    Read more…

    Arguments

    Type IntentOptional Attributes Name
    class(logger_type), intent(inout) :: self
    character(len=*), intent(in) :: filename
    integer(kind=default_int), intent(in), optional :: level

procedure, public, pass(self), non_overridable :: debug

Log a message that will only be printed at the debug level of verbosity. Usage: call my_logger%debug(“MESSAGE”)

  • private subroutine debug(self, message, module, procedure)

    Log a message that will only be printed at the debug level of verbosity

    Read more…

    Arguments

    Type IntentOptional Attributes Name
    class(logger_type), intent(in) :: self
    character(len=*), intent(in) :: message
    character(len=*), intent(in), optional :: module
    character(len=*), intent(in), optional :: procedure

procedure, public, pass(self), non_overridable :: error

Log a message that will only be printed at the error level of verbosity. Usage: call my_logger%error(“MESSAGE”)

  • private subroutine error(self, message, module, procedure)

    Log a message that will only be printed at the error of verbosity

    Read more…

    Arguments

    Type IntentOptional Attributes Name
    class(logger_type), intent(in) :: self
    character(len=*), intent(in) :: message
    character(len=*), intent(in), optional :: module
    character(len=*), intent(in), optional :: procedure

procedure, public, pass(self), non_overridable :: info

Log a message that will only be printed at the info level of verbosity. Usage: call my_logger%info(“MESSAGE”)

  • private subroutine info(self, message, module, procedure)

    Log a message that will only be printed at the info level of verbosity

    Read more…

    Arguments

    Type IntentOptional Attributes Name
    class(logger_type), intent(in) :: self
    character(len=*), intent(in) :: message
    character(len=*), intent(in), optional :: module
    character(len=*), intent(in), optional :: procedure

procedure, public, pass(self), non_overridable :: knowledge

Log a message that will only be printed at the knowledge level of verbosity. Usage: call my_logger%knowledge(“MESSAGE”)

  • private subroutine knowledge(self, message, module, procedure)

    Log a message that will only be printed at the error of verbosity

    Read more…

    Arguments

    Type IntentOptional Attributes Name
    class(logger_type), intent(in) :: self
    character(len=*), intent(in) :: message
    character(len=*), intent(in), optional :: module
    character(len=*), intent(in), optional :: procedure

procedure, public, pass(self), non_overridable :: large_info

Log a message that will only be printed at the large_info level of verbosity. Usage: call my_logger%large_info(“MESSAGE”)

  • private subroutine large_info(self, message, module, procedure)

    Log a message that will only be printed at the large_info level of verbosity

    Read more…

    Arguments

    Type IntentOptional Attributes Name
    class(logger_type), intent(in) :: self
    character(len=*), intent(in) :: message
    character(len=*), intent(in), optional :: module
    character(len=*), intent(in), optional :: procedure

procedure, public, pass(self), non_overridable :: performance

Log a message that will only be printed at the performance level of verbosity. Usage: call my_logger%performance(“MESSAGE”)

  • private subroutine performance(self, message, module, procedure)

    Log a message that will only be printed at the performance of verbosity

    Read more…

    Arguments

    Type IntentOptional Attributes Name
    class(logger_type), intent(in) :: self
    character(len=*), intent(in) :: message
    character(len=*), intent(in), optional :: module
    character(len=*), intent(in), optional :: procedure

procedure, public, pass(self), non_overridable :: set_explicit_printing

Configure whether to print explicit level prefixes in log lines. Usage: call my_logger%set_explicit_printing(.true.)

  • private pure subroutine set_explicit_printing(self, explicit_printing)

    Configure whether logs should include explicit level prefixes.

    Read more…

    Arguments

    Type IntentOptional Attributes Name
    class(logger_type), intent(inout) :: self
    logical, intent(in) :: explicit_printing

procedure, public, pass(self), non_overridable :: verbose

Log a message that will only be printed at the verbose level of verbosity. Usage: call my_logger%verbose(“MESSAGE”)

  • private subroutine verbose(self, message, module, procedure)

    Log a message that will only be printed at the verbose level of verbosity

    Read more…

    Arguments

    Type IntentOptional Attributes Name
    class(logger_type), intent(in) :: self
    character(len=*), intent(in) :: message
    character(len=*), intent(in), optional :: module
    character(len=*), intent(in), optional :: procedure

procedure, public, pass(self), non_overridable :: warning

Log a message that will only be printed at the warning level of verbosity. Usage: call my_logger%warning(“MESSAGE”)

  • private subroutine warning(self, message, module, procedure)

    Log a message that will only be printed at the warning level of verbosity

    Read more…

    Arguments

    Type IntentOptional Attributes Name
    class(logger_type), intent(in) :: self
    character(len=*), intent(in) :: message
    character(len=*), intent(in), optional :: module
    character(len=*), intent(in), optional :: procedure

procedure, private, pass(self), non_overridable :: log

Processes the message and filters it according to the verbosity level set by the user or the default

  • private subroutine log(self, level, message, module, procedure)

    internal subroutines that processes the message and filters it according to the verbosity level set by the user or the default this is a private subroutine so it is not exposed to the user

    Arguments

    Type IntentOptional Attributes Name
    class(logger_type), intent(in) :: self
    character(len=*), intent(in) :: level
    character(len=*), intent(in) :: message
    character(len=*), intent(in), optional :: module
    character(len=*), intent(in), optional :: procedure

Source Code

   type :: logger_type
    !! custom logger data type

      private

      integer(default_int), public :: log_level = info_level
        !! set default log level to info
      integer(default_int), public :: log_file_level = verbose_level
        !! set default log file log level to verbose
      integer(default_int), private :: log_file_unit = -1
      logical, private :: log_file_open = .false.
      logical, private :: hide_log_level_prefix = .true.
        !! When true, omit level prefixes in rendered log lines.

   contains

      procedure, public, pass(self), non_overridable :: configuration
      !! Get the current logger verbosity configuration.
      !! Usage: call my_logger%configuration(level)
      procedure, public, pass(self), non_overridable :: configure
      !! Configure the logger to be a certain verbosity level.
      !! Usage: call my_logger%configure(level)
      procedure, public, pass(self), non_overridable :: set_explicit_printing
      !! Configure whether to print explicit level prefixes in log lines.
      !! Usage: call my_logger%set_explicit_printing(.true.)
      procedure, public, pass(self), non_overridable :: configure_file_output
      !! Configure the logger to file to be a certain verbosity level.
      !! Usage: call my_logger%configure_file_output(filename, level)
      procedure, public, pass(self), non_overridable :: close_log_file
      !! Close the log file, needs to be called at the end of the program.
      !! Usage: call my_logger%close_log_file()
      procedure, public, pass(self), non_overridable :: debug
      !! Log a message that will only be printed at the debug level of verbosity.
      !! Usage: call my_logger%debug("MESSAGE")
      procedure, public, pass(self), non_overridable :: verbose
      !! Log a message that will only be printed at the verbose level of verbosity.
      !! Usage: call my_logger%verbose("MESSAGE")
      procedure, public, pass(self), non_overridable :: large_info
      !! Log a message that will only be printed at the large_info level of verbosity.
      !! Usage: call my_logger%large_info("MESSAGE")
      procedure, public, pass(self), non_overridable :: info
      !! Log a message that will only be printed at the info level of verbosity.
      !! Usage: call my_logger%info("MESSAGE")
      procedure, public, pass(self), non_overridable :: performance
      !! Log a message that will only be printed at the performance level of verbosity.
      !! Usage: call my_logger%performance("MESSAGE")
      procedure, public, pass(self), non_overridable :: warning
      !! Log a message that will only be printed at the warning level of verbosity.
      !! Usage: call my_logger%warning("MESSAGE")
      procedure, public, pass(self), non_overridable :: error
      !! Log a message that will only be printed at the error level of verbosity.
      !! Usage: call my_logger%error("MESSAGE")
      procedure, public, pass(self), non_overridable :: knowledge
      !! Log a message that will only be printed at the knowledge level of verbosity.
      !! Usage: call my_logger%knowledge("MESSAGE")
      procedure, private, pass(self), non_overridable :: log
      !! Processes the message and filters it according to the verbosity level set by the user or the default

   end type logger_type