memoryaliasmodule Module Reference

Previous variable names checked in as deprecated aliases. More...

Data Types
interface	mem_alias_deprecated

Functions/Subroutines
subroutine	alias_int (sclr, name, mem_path, name2, mem_path2, version)
	Check in a deprecated name for an integer scalar. More...
subroutine	alias_logical1d (alog, name, mem_path, name2, mem_path2, version)
	Check in a deprecated name for a 1d logical array. More...
subroutine	alias_int1d (aint, name, mem_path, name2, mem_path2, version)
	Check in a deprecated name for a 1d integer array. More...
subroutine	alias_int2d (aint, name, mem_path, name2, mem_path2, version)
	Check in a deprecated name for a 2d integer array. More...
subroutine	alias_dbl1d (adbl, name, mem_path, name2, mem_path2, version)
	Check in a deprecated name for a 1d double precision array. More...
subroutine	alias_dbl2d (adbl, name, mem_path, name2, mem_path2, version)
	Check in a deprecated name for a 2d double precision array. More...
subroutine	alias_charstr1d (acharstr1d, ilen, name, mem_path, name2, mem_path2, version)
	Check in a deprecated name for a 1d character string array. More...
subroutine	record_alias (name, mem_path, name2, mem_path2, version)
	Record the replacement and version of a deprecated name. More...
subroutine, public	get_deprecated_alias (name, mem_path, found, replacement, version)
	Get the replacement and version of a deprecated name. More...
subroutine, public	mem_alias_da ()
	Clear the recorded aliases. More...

Variables
integer(i4b), parameter	lenversion = 16
	maximum length of a version string More...
type(hashtabletype), pointer	alias_index => null()
	alias address to record number More...
integer(i4b)	nalias = 0
	number of recorded aliases More...
character(len=lenmemaddress), dimension(:), allocatable	replacements
	address of the replacement variable More...
character(len=lenversion), dimension(:), allocatable	versions
	version the alias was deprecated in More...

Detailed Description

A package that renames or moves a variable checks in the previous name as an alias of the variable, so a program that addresses it through the API still resolves, and records the replacement for the API to report.

Function/Subroutine Documentation

alias_charstr1d()

subroutine memoryaliasmodule::alias_charstr1d ( type(characterstringtype), dimension(:), intent(inout), pointer, contiguous  acharstr1d, integer(i4b), intent(in)  ilen, character(len=*), intent(in)  name, character(len=*), intent(in)  mem_path, character(len=*), intent(in)  name2, character(len=*), intent(in)  mem_path2, character(len=*), intent(in)  version  )

private

Parameters

[in,out]	acharstr1d	the replacement variable
[in]	ilen	string length
[in]	name	deprecated variable name
[in]	mem_path	path of the deprecated name
[in]	name2	replacement variable name
[in]	mem_path2	path of the replacement variable
[in]	version	version the name was deprecated in

Definition at line 140 of file MemoryAlias.f90.

    type(CharacterStringType), dimension(:), &
      pointer, contiguous, intent(inout) :: acharstr1d !< the replacement variable
    integer(I4B), intent(in) :: ilen !< string length
    character(len=*), intent(in) :: name !< deprecated variable name
    character(len=*), intent(in) :: mem_path !< path of the deprecated name
    character(len=*), intent(in) :: name2 !< replacement variable name
    character(len=*), intent(in) :: mem_path2 !< path of the replacement variable
    character(len=*), intent(in) :: version !< version the name was deprecated in
    !
    if (.not. associated(acharstr1d)) return
    call mem_checkin(acharstr1d, ilen, name, mem_path, name2, mem_path2)
    call record_alias(name, mem_path, name2, mem_path2, version)

alias_dbl1d()

subroutine memoryaliasmodule::alias_dbl1d ( real(dp), dimension(:), intent(inout), pointer, contiguous  adbl, character(len=*), intent(in)  name, character(len=*), intent(in)  mem_path, character(len=*), intent(in)  name2, character(len=*), intent(in)  mem_path2, character(len=*), intent(in)  version  )

private

Parameters

[in,out]	adbl	the replacement variable
[in]	name	deprecated variable name
[in]	mem_path	path of the deprecated name
[in]	name2	replacement variable name
[in]	mem_path2	path of the replacement variable
[in]	version	version the name was deprecated in

Definition at line 110 of file MemoryAlias.f90.

    real(DP), dimension(:), pointer, contiguous, intent(inout) :: adbl !< the replacement variable
    character(len=*), intent(in) :: name !< deprecated variable name
    character(len=*), intent(in) :: mem_path !< path of the deprecated name
    character(len=*), intent(in) :: name2 !< replacement variable name
    character(len=*), intent(in) :: mem_path2 !< path of the replacement variable
    character(len=*), intent(in) :: version !< version the name was deprecated in
    !
    if (.not. associated(adbl)) return
    call mem_checkin(adbl, name, mem_path, name2, mem_path2)
    call record_alias(name, mem_path, name2, mem_path2, version)

alias_dbl2d()

subroutine memoryaliasmodule::alias_dbl2d ( real(dp), dimension(:, :), intent(inout), pointer, contiguous  adbl, character(len=*), intent(in)  name, character(len=*), intent(in)  mem_path, character(len=*), intent(in)  name2, character(len=*), intent(in)  mem_path2, character(len=*), intent(in)  version  )

private

Parameters

[in,out]	adbl	the replacement variable
[in]	name	deprecated variable name
[in]	mem_path	path of the deprecated name
[in]	name2	replacement variable name
[in]	mem_path2	path of the replacement variable
[in]	version	version the name was deprecated in

Definition at line 125 of file MemoryAlias.f90.

    real(DP), dimension(:, :), pointer, contiguous, intent(inout) :: adbl !< the replacement variable
    character(len=*), intent(in) :: name !< deprecated variable name
    character(len=*), intent(in) :: mem_path !< path of the deprecated name
    character(len=*), intent(in) :: name2 !< replacement variable name
    character(len=*), intent(in) :: mem_path2 !< path of the replacement variable
    character(len=*), intent(in) :: version !< version the name was deprecated in
    !
    if (.not. associated(adbl)) return
    call mem_checkin(adbl, name, mem_path, name2, mem_path2)
    call record_alias(name, mem_path, name2, mem_path2, version)

alias_int()

subroutine memoryaliasmodule::alias_int ( integer(i4b), intent(in), pointer  sclr, character(len=*), intent(in)  name, character(len=*), intent(in)  mem_path, character(len=*), intent(in)  name2, character(len=*), intent(in)  mem_path2, character(len=*), intent(in)  version  )

private

Parameters

[in]	sclr	the replacement variable
[in]	name	deprecated variable name
[in]	mem_path	path of the deprecated name
[in]	name2	replacement variable name
[in]	mem_path2	path of the replacement variable
[in]	version	version the name was deprecated in

Definition at line 45 of file MemoryAlias.f90.

    integer(I4B), pointer, intent(in) :: sclr !< the replacement variable
    character(len=*), intent(in) :: name !< deprecated variable name
    character(len=*), intent(in) :: mem_path !< path of the deprecated name
    character(len=*), intent(in) :: name2 !< replacement variable name
    character(len=*), intent(in) :: mem_path2 !< path of the replacement variable
    character(len=*), intent(in) :: version !< version the name was deprecated in
    ! -- local
    integer(I4B), pointer :: alias => null()
    !
    if (.not. associated(sclr)) return
    !
    ! -- a scalar has no checkin, so point a new entry at the replacement
    call mem_allocate(alias, name, mem_path)
    call mem_reassignptr(alias, name, mem_path, name2, mem_path2)
    call record_alias(name, mem_path, name2, mem_path2, version)

alias_int1d()

subroutine memoryaliasmodule::alias_int1d ( integer(i4b), dimension(:), intent(inout), pointer, contiguous  aint, character(len=*), intent(in)  name, character(len=*), intent(in)  mem_path, character(len=*), intent(in)  name2, character(len=*), intent(in)  mem_path2, character(len=*), intent(in)  version  )

private

Parameters

[in,out]	aint	the replacement variable
[in]	name	deprecated variable name
[in]	mem_path	path of the deprecated name
[in]	name2	replacement variable name
[in]	mem_path2	path of the replacement variable
[in]	version	version the name was deprecated in

Definition at line 80 of file MemoryAlias.f90.

    integer(I4B), dimension(:), pointer, contiguous, intent(inout) :: aint !< the replacement variable
    character(len=*), intent(in) :: name !< deprecated variable name
    character(len=*), intent(in) :: mem_path !< path of the deprecated name
    character(len=*), intent(in) :: name2 !< replacement variable name
    character(len=*), intent(in) :: mem_path2 !< path of the replacement variable
    character(len=*), intent(in) :: version !< version the name was deprecated in
    !
    if (.not. associated(aint)) return
    call mem_checkin(aint, name, mem_path, name2, mem_path2)
    call record_alias(name, mem_path, name2, mem_path2, version)

alias_int2d()

subroutine memoryaliasmodule::alias_int2d ( integer(i4b), dimension(:, :), intent(inout), pointer, contiguous  aint, character(len=*), intent(in)  name, character(len=*), intent(in)  mem_path, character(len=*), intent(in)  name2, character(len=*), intent(in)  mem_path2, character(len=*), intent(in)  version  )

private

Parameters

[in,out]	aint	the replacement variable
[in]	name	deprecated variable name
[in]	mem_path	path of the deprecated name
[in]	name2	replacement variable name
[in]	mem_path2	path of the replacement variable
[in]	version	version the name was deprecated in

Definition at line 95 of file MemoryAlias.f90.

    integer(I4B), dimension(:, :), pointer, contiguous, intent(inout) :: aint !< the replacement variable
    character(len=*), intent(in) :: name !< deprecated variable name
    character(len=*), intent(in) :: mem_path !< path of the deprecated name
    character(len=*), intent(in) :: name2 !< replacement variable name
    character(len=*), intent(in) :: mem_path2 !< path of the replacement variable
    character(len=*), intent(in) :: version !< version the name was deprecated in
    !
    if (.not. associated(aint)) return
    call mem_checkin(aint, name, mem_path, name2, mem_path2)
    call record_alias(name, mem_path, name2, mem_path2, version)

alias_logical1d()

subroutine memoryaliasmodule::alias_logical1d ( logical(lgp), dimension(:), intent(in), pointer, contiguous  alog, character(len=*), intent(in)  name, character(len=*), intent(in)  mem_path, character(len=*), intent(in)  name2, character(len=*), intent(in)  mem_path2, character(len=*), intent(in)  version  )

private

Parameters

[in]	alog	the replacement variable
[in]	name	deprecated variable name
[in]	mem_path	path of the deprecated name
[in]	name2	replacement variable name
[in]	mem_path2	path of the replacement variable
[in]	version	version the name was deprecated in

Definition at line 65 of file MemoryAlias.f90.

    logical(LGP), dimension(:), pointer, contiguous, intent(in) :: alog !< the replacement variable
    character(len=*), intent(in) :: name !< deprecated variable name
    character(len=*), intent(in) :: mem_path !< path of the deprecated name
    character(len=*), intent(in) :: name2 !< replacement variable name
    character(len=*), intent(in) :: mem_path2 !< path of the replacement variable
    character(len=*), intent(in) :: version !< version the name was deprecated in
    !
    if (.not. associated(alog)) return
    call mem_checkin(alog, name, mem_path, name2, mem_path2)
    call record_alias(name, mem_path, name2, mem_path2, version)

get_deprecated_alias()

subroutine, public memoryaliasmodule::get_deprecated_alias	(	character(len=*), intent(in)	name,
		character(len=*), intent(in)	mem_path,
		logical(lgp), intent(out)	found,
		character(len=lenmemaddress), intent(out)	replacement,
		character(len=*), intent(out)	version
	)

Parameters

[in]	name	variable name
[in]	mem_path	path of the variable
[out]	found	true when the name is deprecated
[out]	replacement	address of the replacement variable
[out]	version	version the name was deprecated in

Definition at line 176 of file MemoryAlias.f90.

    character(len=*), intent(in) :: name !< variable name
    character(len=*), intent(in) :: mem_path !< path of the variable
    logical(LGP), intent(out) :: found !< true when the name is deprecated
    character(len=LENMEMADDRESS), intent(out) :: replacement !< address of the replacement variable
    character(len=*), intent(out) :: version !< version the name was deprecated in
    ! -- local
    integer(I4B) :: i
    !
    found = .false.
    replacement = ''
    version = ''
    if (.not. associated(alias_index)) return
    i = alias_index%get(create_mem_address(mem_path, name))
    if (i == 0) return
    found = .true.
    replacement = replacements(i)
    version = versions(i)

Here is the call graph for this function:

Here is the caller graph for this function:

mem_alias_da()

subroutine, public memoryaliasmodule::mem_alias_da

The alias entries themselves are deallocated with the memory manager.

Definition at line 200 of file MemoryAlias.f90.

    if (associated(alias_index)) call hash_table_da(alias_index)
    if (allocated(replacements)) deallocate (replacements)
    if (allocated(versions)) deallocate (versions)
    nalias = 0

Here is the call graph for this function:

Here is the caller graph for this function:

record_alias()

subroutine memoryaliasmodule::record_alias ( character(len=*), intent(in)  name, character(len=*), intent(in)  mem_path, character(len=*), intent(in)  name2, character(len=*), intent(in)  mem_path2, character(len=*), intent(in)  version  )

private

Parameters

[in]	name	deprecated variable name
[in]	mem_path	path of the deprecated name
[in]	name2	replacement variable name
[in]	mem_path2	path of the replacement variable
[in]	version	version the name was deprecated in

Definition at line 158 of file MemoryAlias.f90.

    character(len=*), intent(in) :: name !< deprecated variable name
    character(len=*), intent(in) :: mem_path !< path of the deprecated name
    character(len=*), intent(in) :: name2 !< replacement variable name
    character(len=*), intent(in) :: mem_path2 !< path of the replacement variable
    character(len=*), intent(in) :: version !< version the name was deprecated in
    !
    if (.not. associated(alias_index)) call hash_table_cr(alias_index)
    nalias = nalias + 1
    call expandarray(replacements)
    call expandarray(versions)
    replacements(nalias) = create_mem_address(mem_path2, name2)
    versions(nalias) = version
    call alias_index%add(create_mem_address(mem_path, name), nalias)

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

alias_index

type(hashtabletype), pointer memoryaliasmodule::alias_index => null()

private

Definition at line 36 of file MemoryAlias.f90.

  type(HashTableType), pointer :: alias_index => null() !< alias address to record number

lenversion

integer(i4b), parameter memoryaliasmodule::lenversion = 16

private

Definition at line 23 of file MemoryAlias.f90.

  integer(I4B), parameter :: LENVERSION = 16 !< maximum length of a version string

nalias

integer(i4b) memoryaliasmodule::nalias = 0

private

Definition at line 37 of file MemoryAlias.f90.

  integer(I4B) :: nalias = 0 !< number of recorded aliases

replacements

character(len=lenmemaddress), dimension(:), allocatable memoryaliasmodule::replacements

private

Definition at line 38 of file MemoryAlias.f90.

  character(len=LENMEMADDRESS), dimension(:), allocatable :: replacements !< address of the replacement variable

versions

character(len=lenversion), dimension(:), allocatable memoryaliasmodule::versions

private

Definition at line 39 of file MemoryAlias.f90.

  character(len=LENVERSION), dimension(:), allocatable :: versions !< version the alias was deprecated in