logger::log_t Type Reference

Public Member Functions
procedure, pass(this)	init (this, env_prefix)
	Initialize a log.
procedure, pass(this)	free (this)
	Free a log.
procedure, pass(this)	begin (this)
	Increase indention level.
procedure, pass(this)	end (this)
	Decrease indention level.
procedure, pass(this)	indent (this)
	Indent a log.
procedure, pass(this)	newline (this, lvl)
	Write a new line to a log.
procedure, pass(this)	message (this, msg, lvl)
	Write a message to a log.
procedure, pass(this)	section (this, msg, lvl)
	Begin a new log section.
procedure, pass(this)	header (this, version, build_info)
	Write the Neko header to a log.
procedure, pass(this)	error (this, msg)
	Write an error message to a log.
procedure, pass(this)	warning (this, msg)
	Write a warning message to a log.
procedure, pass(this)	deprecated (this, feature, removal_version, extra_info)
	Write a deprecation warning to a log.
procedure, pass(this)	end_section (this, msg, lvl)
	End a log section.
procedure, pass(this)	flush (this)
	Flush the log stream, ensuring buffered output leaves the process.

Private Member Functions
procedure, pass(this), private	print_section_header (this, lvl)
	Print a section header.

Private Attributes
integer, private	indent_ = 0
integer, private	section_id_ = 0
integer, private	tab_size_ = 1
integer, private	level_ = NEKO_LOG_INFO
integer, private	unit_ = stdout
character(len=log_size), private	section_header = ""
character(len=50), dimension(:), allocatable, private	deprecated_list
	List of already logged deprecated features.

Detailed Description

Definition at line 58 of file log.f90.

Member Function/Subroutine Documentation

begin()

procedure, pass(this) logger::log_t::begin

(

class(log_t), intent(inout)

this

)

Definition at line 73 of file log.f90.

deprecated()

procedure, pass(this) logger::log_t::deprecated	(	class(log_t), intent(inout)	this,
		character(len=*), intent(in)	feature,
		character(len=*), intent(in)	removal_version,
		character(len=*), intent(in), optional	extra_info
	)

Parameters

feature	Name of the deprecated feature
removal_version	Optional version when the feature will be removed
extra_info	Optional additional message to print

Definition at line 82 of file log.f90.

end()

procedure, pass(this) logger::log_t::end

(

class(log_t), intent(inout)

this

)

Definition at line 74 of file log.f90.

end_section()

procedure, pass(this) logger::log_t::end_section	(	class(log_t), intent(inout)	this,
		character(len=*), intent(in), optional	msg,
		integer, optional	lvl
	)

Definition at line 83 of file log.f90.

error()

procedure, pass(this) logger::log_t::error	(	class(log_t), intent(in)	this,
		character(len=*), intent(in)	msg
	)

Definition at line 80 of file log.f90.

flush()

procedure, pass(this) logger::log_t::flush

(

class(log_t), intent(in)

this

)

Note

Flushing is local to rank 0 (the only writer) and never collective, so it is safe to call from any rank.

Definition at line 84 of file log.f90.

free()

procedure, pass(this) logger::log_t::free

(

class(log_t), intent(inout)

this

)

Definition at line 72 of file log.f90.

header()

procedure, pass(this) logger::log_t::header	(	class(log_t), intent(in)	this,
		character(len=*), intent(in)	version,
		character(len=*), intent(in)	build_info
	)

Definition at line 79 of file log.f90.

indent()

procedure, pass(this) logger::log_t::indent

(

class(log_t), intent(in)

this

)

Definition at line 75 of file log.f90.

init()

procedure, pass(this) logger::log_t::init	(	class(log_t), intent(inout)	this,
		character(len=*), intent(in), optional	env_prefix
	)

Parameters

env_prefix

Prefix of the environment variables to read the configuration from, defaulting to "NEKO", i.e. NEKO_LOG_TAB_SIZE, NEKO_LOG_LEVEL and NEKO_LOG_FILE. Passing a different prefix points this log_t instance at an independent set of environment variables.

Definition at line 71 of file log.f90.

message()

procedure, pass(this) logger::log_t::message	(	class(log_t), intent(inout)	this,
		character(len=*), intent(in)	msg,
		integer, optional	lvl
	)

Definition at line 77 of file log.f90.

newline()

procedure, pass(this) logger::log_t::newline	(	class(log_t), intent(in)	this,
		integer, optional	lvl
	)

Definition at line 76 of file log.f90.

print_section_header()

procedure, pass(this), private logger::log_t::print_section_header ( class(log_t), intent(inout)  this, integer, optional  lvl  )

private

Definition at line 86 of file log.f90.

section()

procedure, pass(this) logger::log_t::section	(	class(log_t), intent(inout)	this,
		character(len=*), intent(in)	msg,
		integer, optional	lvl
	)

Definition at line 78 of file log.f90.

warning()

procedure, pass(this) logger::log_t::warning	(	class(log_t), intent(in)	this,
		character(len=*), intent(in)	msg
	)

Definition at line 81 of file log.f90.

Member Data Documentation

deprecated_list

character(len=50), dimension(:), allocatable, private logger::log_t::deprecated_list

private

Definition at line 68 of file log.f90.

indent_

integer, private logger::log_t::indent_ = 0

private

Definition at line 59 of file log.f90.

level_

integer, private logger::log_t::level_ = NEKO_LOG_INFO

private

Definition at line 62 of file log.f90.

section_header

character(len=log_size), private logger::log_t::section_header = ""

private

Definition at line 65 of file log.f90.

section_id_

integer, private logger::log_t::section_id_ = 0

private

Definition at line 60 of file log.f90.

tab_size_

integer, private logger::log_t::tab_size_ = 1

private

Definition at line 61 of file log.f90.

unit_

integer, private logger::log_t::unit_ = stdout

private

Definition at line 63 of file log.f90.

---

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

• /home/runner/work/neko/neko/src/common/log.f90