keyvaluelistmodule Module Reference

Data Types
type	keyvaluelisttype
	A list that stores items as a key-value pair. More...

Functions/Subroutines
class(iteratortype) function, allocatable	iterator (this)
subroutine	add (this, key, val)
	Add a key-value pair to the list. More...
class(*) function, pointer	get (this, key)
	Get a value using a key. More...
integer(i4b) function	count (this)
	The nummer of items in the list. More...
subroutine	clear (this)
	Clears the list. More...
recursive subroutine	clear_node (node)
	Clears the node. More...

Function/Subroutine Documentation

add()

subroutine keyvaluelistmodule::add ( class(keyvaluelisttype)  this, character(len=*), intent(in)  key, class(*), intent(in), pointer  val  )

private

The list uses an 'append to end' approach for adding items

Definition at line 42 of file KeyValueList.f90.

    class(KeyValueListType) :: this
    character(len=*), intent(in) :: key
    class(*), pointer, intent(in) :: val
    ! -- local
 
    if (.not. associated(this%first)) then
      allocate (this%first)
      this%last => this%first
    else
      allocate (this%last%next)
      this%last => this%last%next
    end if
 
    allocate (this%last%key)
    this%last%key = key
    this%last%value => val
    this%last%next => null()
 
    this%cnt = this%cnt + 1
 

clear()

subroutine keyvaluelistmodule::clear ( class(keyvaluelisttype)  this )

private

clears all the nodes of the list

Definition at line 103 of file KeyValueList.f90.

    class(KeyValueListType) :: this
 
    if (associated(this%first)) call clear_node(this%first)
    this%first => null()
    this%last => null()
    this%cnt = 0
 

Here is the call graph for this function:

clear_node()

recursive subroutine keyvaluelistmodule::clear_node ( type(keyvaluenodetype), pointer  node )

private

Recursive method that clears the next node before clearing itself

Definition at line 117 of file KeyValueList.f90.

    type(KeyValueNodeType), pointer :: node
 
    if (associated(node)) then
      call clear_node(node%next)
 
      deallocate (node%key)
 
      nullify (node%key)
      nullify (node%value)
      nullify (node%next)
 
      deallocate (node)
    end if
 

Here is the caller graph for this function:

count()

integer(i4b) function keyvaluelistmodule::count ( class(keyvaluelisttype)  this )

private

Definition at line 92 of file KeyValueList.f90.

    class(KeyValueListType) :: this
    integer(I4B) :: val
 
    val = this%cnt

get()

class(*) function, pointer keyvaluelistmodule::get ( class(keyvaluelisttype)  this, character(len=*), intent(in)  key  )

private

If the key can't be found the return value will be a null pointer

Definition at line 69 of file KeyValueList.f90.

    class(KeyValueListType) :: this
    character(len=*), intent(in) :: key
    class(*), pointer :: val
    ! -- local
    type(KeyValueNodeType), pointer :: node !< current node in the list
 
    val => null()
    node => this%first
 
    do while (associated(node))
      if (node%key == key) then
        val => node%value
        exit
      end if
      node => node%next
    end do
 

iterator()

class(iteratortype) function, allocatable keyvaluelistmodule::iterator ( class(keyvaluelisttype)  this )

private

Definition at line 31 of file KeyValueList.f90.

    class(KeyValueListType) :: this
    class(IteratorType), allocatable :: itr
 
    itr = keyvaluelistiteratortype(this%first)