messagemodule Module Reference

Store and issue logging messages to output units.

Data Types
type	messagestype
	Container for related messages. More...

Functions/Subroutines
subroutine	init (this)
	Initialize message storage. More...
integer(i4b) function	count (this)
	Return the number of messages currently stored. More...
subroutine	set_max (this, imax)
	Set the maximum number of messages. More...
subroutine	store (this, msg, substring)
	Add a message to storage. More...
subroutine	write_all (this, title, kind, iunit)
	Write all stored messages to standard output. More...
subroutine	deallocate (this)
	@ brief Deallocate message storage. More...
subroutine, public	write_message (text, iunit, fmt, skipbefore, skipafter, advance)
	Write a message to an output unit. More...
subroutine, public	write_message_counter (text, iunit, icount, iwidth, skipbefore, skipafter)
	Write a message with configurable indentation and numbering. More...
subroutine, public	write_message_centered (text, linelen, iunit)
	Write horizontally centered text, left-padding as needed. More...

Function/Subroutine Documentation

count()

integer(i4b) function messagemodule::count

(

class(messagestype)

this

)

Parameters

this	MessageType object

Definition at line 49 of file Message.f90.

    class(MessagesType) :: this !< MessageType object
    integer(I4B) :: nmessage
 
    if (allocated(this%messages)) then
      nmessage = this%num_messages
    else
      nmessage = 0
    end if

deallocate()

subroutine messagemodule::deallocate

(

class(messagestype)

this

)

Definition at line 198 of file Message.f90.

    class(MessagesType) :: this
    if (allocated(this%messages)) deallocate (this%messages)
    this%num_messages = 0
    this%max_exceeded = 0

init()

subroutine messagemodule::init

(

class(messagestype)

this

)

Parameters

this	MessageType object

Definition at line 39 of file Message.f90.

    class(MessagesType) :: this !< MessageType object
 
    this%num_messages = 0
    this%max_messages = 1000
    this%max_exceeded = 0
    this%exp_messages = 100

set_max()

subroutine messagemodule::set_max	(	class(messagestype)	this,
		integer(i4b), intent(in)	imax
	)

Parameters

	this	MessageType object
[in]	imax	maximum number of messages that will be stored

Definition at line 61 of file Message.f90.

    class(MessagesType) :: this !< MessageType object
    integer(I4B), intent(in) :: imax !< maximum number of messages that will be stored
 
    this%max_messages = imax

store()

subroutine messagemodule::store	(	class(messagestype)	this,
		character(len=*), intent(in)	msg,
		character(len=*), intent(in), optional	substring
	)

An optional string may be provided to filter out duplicate messages. If any stored messages contain the string the message is not stored.

Parameters

	this	MessageType object
[in]	msg	message
[in]	substring	duplicate pattern

Definition at line 73 of file Message.f90.

    ! -- dummy variables
    class(MessagesType) :: this !< MessageType object
    character(len=*), intent(in) :: msg !< message
    character(len=*), intent(in), optional :: substring !< duplicate pattern
    ! -- local variables
    logical(LGP) :: inc_array
    integer(I4B) :: i, n
 
    ! -- resize message array if needed
    inc_array = .true.
    if (allocated(this%messages)) then
      if (this%num_messages < size(this%messages)) then
        inc_array = .false.
      end if
    end if
    if (inc_array) then
      call expandarray(this%messages, increment=this%exp_messages)
      this%exp_messages = int(this%exp_messages * 1.1)
    end if
 
    ! -- don't store duplicate messages
    if (present(substring)) then
      do i = 1, this%num_messages
        if (index(this%messages(i), substring) > 0) return
      end do
    end if
 
    ! -- store message and update count unless
    !    at capacity, then update excess count
    n = this%num_messages + 1
    if (n <= this%max_messages) then
      this%num_messages = n
      this%messages(n) = msg
    else
      this%max_exceeded = this%max_exceeded + 1
    end if

write_all()

subroutine messagemodule::write_all	(	class(messagestype)	this,
		character(len=*), intent(in), optional	title,
		character(len=*), intent(in), optional	kind,
		integer(i4b), intent(in), optional	iunit
	)

An optional title to precede the messages may be provided. The title is printed on a separate line. An arbitrary kind may be specified, e.g. 'note', 'warning' or 'error. A file unit can also be specified to write in addition to stdout.

Parameters

	this	MessageType object
[in]	title	message title
[in]	kind	message kind
[in]	iunit	file unit

Definition at line 119 of file Message.f90.

    ! -- dummy variables
    class(MessagesType) :: this !< MessageType object
    character(len=*), intent(in), optional :: title !< message title
    character(len=*), intent(in), optional :: kind !< message kind
    integer(I4B), intent(in), optional :: iunit !< file unit
    ! -- local
    character(len=LINELENGTH) :: ltitle
    character(len=LINELENGTH) :: lkind
    character(len=LINELENGTH) :: errmsg
    character(len=LINELENGTH) :: cerr
    integer(I4B) :: iu
    integer(I4B) :: i
    integer(I4B) :: isize
    integer(I4B) :: iwidth
    ! -- formats
    character(len=*), parameter :: stdfmt = "(/,A,/)"
 
    ! -- process optional variables
    if (present(title)) then
      ltitle = title
    else
      ltitle = ''
    end if
    if (present(kind)) then
      lkind = kind
    else
      lkind = ''
    end if
    if (present(iunit)) then
      iu = iunit
    else
      iu = 0
    end if
 
    ! -- write messages, if any
    if (allocated(this%messages)) then
      isize = this%num_messages
      if (isize > 0) then
        ! -- calculate the maximum width of the prepended string
        !    for the counter
        write (cerr, '(i0)') isize
        iwidth = len_trim(cerr) + 1
 
        ! -- write title for message
        if (trim(ltitle) /= '') then
          if (iu > 0) &
            call write_message(iunit=iu, text=ltitle, fmt=stdfmt)
          call write_message(text=ltitle, fmt=stdfmt)
        end if
 
        ! -- write each message
        do i = 1, isize
          if (iu > 0) &
            call write_message_counter( &
            iunit=iu, &
            text=this%messages(i), &
            icount=i, &
            iwidth=iwidth)
          call write_message_counter( &
            text=this%messages(i), &
            icount=i, &
            iwidth=iwidth)
        end do
 
        ! -- write the number of additional messages
        if (this%max_exceeded > 0) then
          write (errmsg, '(i0,3(1x,a))') &
            this%max_exceeded, 'additional', trim(kind), &
            'detected but not printed.'
          if (iu > 0) &
            call write_message(iunit=iu, text=trim(errmsg), fmt='(/,1x,a)')
          call write_message(text=trim(errmsg), fmt='(/,1x,a)')
        end if
      end if
    end if

Here is the call graph for this function:

write_message()

subroutine, public messagemodule::write_message	(	character(len=*), intent(in)	text,
		integer(i4b), intent(in), optional	iunit,
		character(len=*), intent(in), optional	fmt,
		integer(i4b), intent(in), optional	skipbefore,
		integer(i4b), intent(in), optional	skipafter,
		logical(lgp), intent(in), optional	advance
	)

Use advance to toggle advancing output. Use skipbefore/after to configure the number of whitespace lines before/after the message.

Parameters

[in]	text	message to write
[in]	iunit	output unit to write the message to
[in]	fmt	format to write the message (default='(a)')
[in]	skipbefore	number of empty lines before message (default=0)
[in]	skipafter	number of empty lines after message (default=0)
[in]	advance	whether to use advancing output (default is .true.)

Definition at line 210 of file Message.f90.

    ! -- dummy
    character(len=*), intent(in) :: text !< message to write
    integer(I4B), intent(in), optional :: iunit !< output unit to write the message to
    character(len=*), intent(in), optional :: fmt !< format to write the message (default='(a)')
    integer(I4B), intent(in), optional :: skipbefore !< number of empty lines before message (default=0)
    integer(I4B), intent(in), optional :: skipafter !< number of empty lines after message (default=0)
    logical(LGP), intent(in), optional :: advance !< whether to use advancing output (default is .true.)
    ! -- local
    character(len=3) :: cadvance
    integer(I4B) :: i
    integer(I4B) :: ilen
    integer(I4B) :: iu
    character(len=LENHUGELINE) :: simfmt
    character(len=*), parameter :: stdfmt = '(a)'
    character(len=*), parameter :: emptyfmt = '()'
 
    if (present(iunit)) then
      iu = iunit
    else
      iu = istdout
    end if
 
    ! -- get message length
    ilen = len_trim(text)
 
    ! -- process optional arguments
    if (present(fmt)) then
      simfmt = fmt
    else
      if (ilen > 0) then
        simfmt = stdfmt
      else
        simfmt = emptyfmt
      end if
    end if
    if (present(advance)) then
      if (advance) then
        cadvance = 'YES'
      else
        cadvance = 'NO'
      end if
    else
      cadvance = 'YES'
    end if
 
    ! -- write empty line before message, if enabled
    if (present(skipbefore)) then
      do i = 1, skipbefore
        write (iu, *)
      end do
    end if
 
    ! -- write message if it isn't empty
    if (ilen > 0) then
      write (iu, trim(simfmt), advance=cadvance) text(1:ilen)
    else
      write (iu, trim(simfmt), advance=cadvance)
    end if
 
    ! -- write empty line after message, if enabled
    if (present(skipafter)) then
      do i = 1, skipafter
        write (iu, *)
      end do
    end if

Here is the caller graph for this function:

write_message_centered()

subroutine, public messagemodule::write_message_centered	(	character(len=*), intent(in)	text,
		integer(i4b), intent(in)	linelen,
		integer(i4b), intent(in), optional	iunit
	)

Parameters

[in]	text	message to write to iunit
[in]	linelen	length of line to center text in
[in]	iunit	output unit to write text

Definition at line 427 of file Message.f90.

    ! -- dummy
    character(len=*), intent(in) :: text !< message to write to iunit
    integer(I4B), intent(in) :: linelen !< length of line to center text in
    integer(I4B), intent(in), optional :: iunit !< output unit to write text
    ! -- local
    character(len=linelen) :: line
    character(len=linelen) :: blank
    integer(I4B) :: iu
    integer(I4B) :: len_message
    integer(I4B) :: jend
    integer(I4B) :: ipad
    integer(I4B) :: i
    integer(I4B) :: j
 
    if (present(iunit)) then
      iu = iunit
    else
      iu = istdout
    end if
 
    ! -- initialize local variables
    blank = ''
    len_message = len_trim(adjustl(text))
    j = 0
 
    ! -- parse the amessage into multiple lines
    outer: do while (.true.)
      jend = j + linelen
 
      ! last line
      if (jend >= len_message) then
        jend = len_message
        line = text(j + 1:jend)
        ipad = ((linelen - len_trim(line)) / 2)
        call write_message(text=blank(1:ipad)//line, iunit=iunit)
        exit outer
      end if
 
      do i = jend, j + 1, -1
        if (text(i:i) .eq. ' ') then
          line = text(j + 1:i)
          ipad = ((linelen - len_trim(line)) / 2)
          call write_message(text=blank(1:ipad)//line, iunit=iunit)
          j = i
          cycle outer
        end if
      end do
 
      line = text(j + 1:jend)
      ipad = ((linelen - len_trim(line)) / 2)
      call write_message(text=blank(1:ipad)//line, iunit=iunit)
      j = jend
    end do outer

Here is the call graph for this function:

Here is the caller graph for this function:

write_message_counter()

subroutine, public messagemodule::write_message_counter	(	character(len=*), intent(in)	text,
		integer(i4b), intent(in), optional	iunit,
		integer(i4b), intent(in), optional	icount,
		integer(i4b), intent(in), optional	iwidth,
		integer(i4b), intent(in), optional	skipbefore,
		integer(i4b), intent(in), optional	skipafter
	)

The message may exceed 78 characters in length. Messages longer than 78 characters are written across multiple lines. After icount lines, subsequent lines are indented and numbered. Use skipbefore/after to configure the number of empty lines before/after the message.

Parameters

[in]	text	message to be written
[in]	iunit	the unit number to which the message is written
[in]	icount	counter to prepended to the message
[in]	iwidth	maximum width of the prepended counter
[in]	skipbefore	optional number of empty lines before message (default=0)
[in]	skipafter	optional number of empty lines after message (default=0)

Definition at line 286 of file Message.f90.

    ! -- dummy
    character(len=*), intent(in) :: text !< message to be written
    integer(I4B), intent(in), optional :: iunit !< the unit number to which the message is written
    integer(I4B), intent(in), optional :: icount !< counter to prepended to the message
    integer(I4B), intent(in), optional :: iwidth !< maximum width of the prepended counter
    integer(I4B), intent(in), optional :: skipbefore !< optional number of empty lines before message (default=0)
    integer(I4B), intent(in), optional :: skipafter !< optional number of empty lines after message (default=0)
    ! -- local
    integer(I4B), parameter :: len_line = 78
    character(len=LENHUGELINE) :: amessage
    character(len=len_line) :: line
    character(len=16) :: cfmt
    character(len=10) :: counter
    character(len=5) :: fmt_first
    character(len=20) :: fmt_cont
    logical(LGP) :: include_counter
    integer(I4B) :: isb
    integer(I4B) :: isa
    integer(I4B) :: jend
    integer(I4B) :: len_str1
    integer(I4B) :: len_str2
    integer(I4B) :: len_message
    integer(I4B) :: i
    integer(I4B) :: j
    integer(I4B) :: iu
 
    if (present(iunit)) then
      iu = iunit
    else
      iu = istdout
    end if
 
    ! -- abort if message is empty
    if (len_trim(text) < 1) return
 
    ! -- initialize local variables
    amessage = text
    counter = ''
    fmt_first = '(A)'
    fmt_cont = '(A)'
    len_str1 = 0
    len_str2 = len_line
    include_counter = .false.
    j = 0
 
    ! -- process optional arguments
    if (present(skipbefore)) then
      isb = skipbefore
    else
      isb = 0
    end if
    if (present(skipafter)) then
      isa = skipafter
    else
      isa = 0
    end if
 
    ! -- create the counter to prepend to the start of the message,
    !    formats, and variables used to create strings
    if (present(iwidth) .and. present(icount)) then
      include_counter = .true.
 
      ! -- write counter
      write (cfmt, '(A,I0,A)') '(1x,i', iwidth, ',".",1x)'
      write (counter, cfmt) icount
 
      ! -- calculate the length of the first and second string on a line
      len_str1 = len(trim(counter)) + 1
      len_str2 = len_line - len_str1
 
      ! -- write format for the continuation lines
      write (fmt_cont, '(a,i0,a)') &
        '(', len(trim(counter)) + 1, 'x,a)'
    end if
 
    ! -- calculate the length of the message
    len_message = len_trim(amessage)
 
    ! -- parse the message into multiple lines
5   continue
    jend = j + len_str2
    if (jend >= len_message) go to 100
    do i = jend, j + 1, -1
    if (amessage(i:i) .eq. ' ') then
      if (j == 0) then
        if (include_counter) then
          line = counter(1:len_str1)//amessage(j + 1:i)
        else
          line = amessage(j + 1:i)
        end if
        call write_message(text=line, iunit=iu, &
                           fmt=fmt_first, &
                           skipbefore=isb)
      else
        line = adjustl(amessage(j + 1:i))
        call write_message(text=line, iunit=iu, &
                           fmt=fmt_cont)
      end if
      j = i
      go to 5
    end if
    end do
    if (j == 0) then
    if (include_counter) then
      line = counter(1:len_str1)//amessage(j + 1:jend)
    else
      line = amessage(j + 1:jend)
    end if
    call write_message(text=line, iunit=iu, &
                       fmt=fmt_first, &
                       skipbefore=isb)
    else
    line = amessage(j + 1:jend)
    call write_message(text=line, iunit=iu, &
                       fmt=fmt_cont)
    end if
    j = jend
    go to 5
 
    ! -- last piece of amessage to write to a line
100 continue
    jend = len_message
    if (j == 0) then
      if (include_counter) then
        line = counter(1:len_str1)//amessage(j + 1:jend)
      else
        line = amessage(j + 1:jend)
      end if
      call write_message(text=line, iunit=iu, &
                         fmt=fmt_first, &
                         skipbefore=isb, skipafter=isa)
    else
      line = amessage(j + 1:jend)
      call write_message(text=line, iunit=iu, fmt=fmt_cont, &
                         skipafter=isa)
    end if

Here is the call graph for this function:

Here is the caller graph for this function: