stringlist_type – Fortran-lang/stdlib

type, public :: stringlist_type

Inherits

Help

Constructor

public interface stringlist_type

Constructor for stringlist Returns an instance of type stringlist_type Specifications

private pure function new_stringlist()
Constructor with no argument Returns a new instance of type stringlist

Arguments
None
Return Value type(stringlist_type)
private pure function new_stringlist_carray(array)
Constructor to convert chararray to stringlist Returns a new instance of type stringlist

Arguments

Type Intent Optional Attributes Name

character(len=*), intent(in), dimension(:) :: array

Return Value type(stringlist_type)
private pure function new_stringlist_sarray(array)
Constructor to convert stringarray to stringlist Returns a new instance of type stringlist

Arguments

Type Intent Optional Attributes Name

type(string_type), intent(in), dimension(:) :: array

Return Value type(stringlist_type)

Type	Intent	Optional	Attributes		Name
character(len=*),	intent(in),		dimension(:)	::	array

Type	Intent	Optional	Attributes		Name
type(string_type),	intent(in),		dimension(:)	::	array

Type-Bound Procedures

procedure, public :: clear => clear_list

private subroutine clear_list(list)
Resets stringlist 'list' to an empy stringlist of len 0 Modifies the input stringlist 'list'

Arguments

Type Intent Optional Attributes Name

class(stringlist_type), intent(inout) :: list

generic, public :: get => get_string_idx

private pure function get_string_idx_wrap(list, idx)
Returns the string present at stringlist_index 'idx' in stringlist 'list' Returns string_type instance

Arguments

Type Intent Optional Attributes Name

class(stringlist_type), intent(in) :: list

type(stringlist_index_type), intent(in) :: idx

Return Value type(string_type)

Type	Intent	Optional	Attributes		Name
class(stringlist_type),	intent(in)			::	list
type(stringlist_index_type),	intent(in)			::	idx

procedure, public :: get_string_idx => get_string_idx_wrap

private pure function get_string_idx_wrap(list, idx)
Returns the string present at stringlist_index 'idx' in stringlist 'list' Returns string_type instance

Arguments

Type Intent Optional Attributes Name

class(stringlist_type), intent(in) :: list

type(stringlist_index_type), intent(in) :: idx

Return Value type(string_type)

Type	Intent	Optional	Attributes		Name
class(stringlist_type),	intent(in)			::	list
type(stringlist_index_type),	intent(in)			::	idx

generic, public :: insert_at => insert_at_char_idx, insert_at_string_idx, insert_at_stringlist_idx, insert_at_chararray_idx, insert_at_stringarray_idx

private subroutine insert_at_char_idx_wrap(list, idx, string)
Inserts character scalar 'string' AT stringlist_index 'idx' in stringlist 'list' Modifies the input stringlist 'list'

Arguments

Type Intent Optional Attributes Name

class(stringlist_type), intent(inout) :: list

type(stringlist_index_type), intent(in) :: idx

character(len=*), intent(in) :: string
private subroutine insert_at_string_idx_wrap(list, idx, string)
Inserts string 'string' AT stringlist_index 'idx' in stringlist 'list' Modifies the input stringlist 'list'

Arguments

Type Intent Optional Attributes Name

class(stringlist_type), intent(inout) :: list

type(stringlist_index_type), intent(in) :: idx

type(string_type), intent(in) :: string

private subroutine insert_at_stringlist_idx_wrap(list, idx, slist)

Inserts stringlist 'slist' AT stringlist_index 'idx' in stringlist 'list' Modifies the input stringlist 'list'

Arguments

Type	Intent		Name
class(stringlist_type),	intent(inout)	::	list
type(stringlist_index_type),	intent(in)	::	idx
type(stringlist_type),	intent(in)	::	slist

private subroutine insert_at_chararray_idx_wrap(list, idx, carray)

Inserts chararray 'carray' AT stringlist_index 'idx' in stringlist 'list' Modifies the input stringlist 'list'

Arguments

Type	Intent	Attributes		Name
class(stringlist_type),	intent(inout)		::	list
type(stringlist_index_type),	intent(in)		::	idx
character(len=*),	intent(in),	dimension(:)	::	carray

private subroutine insert_at_stringarray_idx_wrap(list, idx, sarray)

Inserts stringarray 'sarray' AT stringlist_index 'idx' in stringlist 'list' Modifies the input stringlist 'list'

Arguments

Type	Intent	Attributes		Name
class(stringlist_type),	intent(inout)		::	list
type(stringlist_index_type),	intent(in)		::	idx
type(string_type),	intent(in),	dimension(:)	::	sarray

procedure, public :: insert_at_char_idx => insert_at_char_idx_wrap

private subroutine insert_at_char_idx_wrap(list, idx, string)
Inserts character scalar 'string' AT stringlist_index 'idx' in stringlist 'list' Modifies the input stringlist 'list'

Arguments

Type Intent Optional Attributes Name

class(stringlist_type), intent(inout) :: list

type(stringlist_index_type), intent(in) :: idx

character(len=*), intent(in) :: string

procedure, public :: insert_at_chararray_idx => insert_at_chararray_idx_wrap

private subroutine insert_at_chararray_idx_wrap(list, idx, carray)

Inserts chararray 'carray' AT stringlist_index 'idx' in stringlist 'list' Modifies the input stringlist 'list'

Arguments

Type	Intent	Attributes		Name
class(stringlist_type),	intent(inout)		::	list
type(stringlist_index_type),	intent(in)		::	idx
character(len=*),	intent(in),	dimension(:)	::	carray

procedure, public :: insert_at_string_idx => insert_at_string_idx_wrap

private subroutine insert_at_string_idx_wrap(list, idx, string)
Inserts string 'string' AT stringlist_index 'idx' in stringlist 'list' Modifies the input stringlist 'list'

Arguments

Type Intent Optional Attributes Name

class(stringlist_type), intent(inout) :: list

type(stringlist_index_type), intent(in) :: idx

type(string_type), intent(in) :: string

procedure, public :: insert_at_stringarray_idx => insert_at_stringarray_idx_wrap

private subroutine insert_at_stringarray_idx_wrap(list, idx, sarray)

Inserts stringarray 'sarray' AT stringlist_index 'idx' in stringlist 'list' Modifies the input stringlist 'list'

Arguments

Type	Intent	Attributes		Name
class(stringlist_type),	intent(inout)		::	list
type(stringlist_index_type),	intent(in)		::	idx
type(string_type),	intent(in),	dimension(:)	::	sarray

procedure, public :: insert_at_stringlist_idx => insert_at_stringlist_idx_wrap

private subroutine insert_at_stringlist_idx_wrap(list, idx, slist)

Inserts stringlist 'slist' AT stringlist_index 'idx' in stringlist 'list' Modifies the input stringlist 'list'

Arguments

Type	Intent		Name
class(stringlist_type),	intent(inout)	::	list
type(stringlist_index_type),	intent(in)	::	idx
type(stringlist_type),	intent(in)	::	slist

generic, public :: insert_before => insert_before_string_int, insert_before_stringlist_int, insert_before_chararray_int, insert_before_stringarray_int

private subroutine insert_before_string_int_impl(list, idxn, string)

Inserts string 'string' BEFORE integer index 'idxn' in the underlying stringarray Modifies the input stringlist 'list'

Arguments

Type	Intent		Name
class(stringlist_type),	intent(inout)	::	list	Not a part of public API
integer,	intent(in)	::	idxn
type(string_type),	intent(in)	::	string

private subroutine insert_before_stringlist_int_impl(list, idxn, slist)

Inserts stringlist 'slist' BEFORE integer index 'idxn' in the underlying stringarray Modifies the input stringlist 'list'

Arguments

Type	Intent		Name
class(stringlist_type),	intent(inout)	::	list	Not a part of public API
integer,	intent(in)	::	idxn
type(stringlist_type),	intent(in)	::	slist

private subroutine insert_before_chararray_int_impl(list, idxn, carray)

Inserts chararray 'carray' BEFORE integer index 'idxn' in the underlying stringarray Modifies the input stringlist 'list'

Arguments

Type	Intent	Attributes		Name
class(stringlist_type),	intent(inout)		::	list	Not a part of public API
integer,	intent(in)		::	idxn
character(len=*),	intent(in),	dimension(:)	::	carray

private subroutine insert_before_stringarray_int_impl(list, idxn, sarray)

Inserts stringarray 'sarray' BEFORE integer index 'idxn' in the underlying stringarray Modifies the input stringlist 'list'

Arguments

Type	Intent	Attributes		Name
class(stringlist_type),	intent(inout)		::	list	Not a part of public API
integer,	intent(in)		::	idxn
type(string_type),	intent(in),	dimension(:)	::	sarray

procedure, public :: insert_before_chararray_int => insert_before_chararray_int_impl

private subroutine insert_before_chararray_int_impl(list, idxn, carray)

Inserts chararray 'carray' BEFORE integer index 'idxn' in the underlying stringarray Modifies the input stringlist 'list'

Arguments

Type	Intent	Attributes		Name
class(stringlist_type),	intent(inout)		::	list	Not a part of public API
integer,	intent(in)		::	idxn
character(len=*),	intent(in),	dimension(:)	::	carray

procedure, public :: insert_before_string_int => insert_before_string_int_impl

private subroutine insert_before_string_int_impl(list, idxn, string)

Inserts string 'string' BEFORE integer index 'idxn' in the underlying stringarray Modifies the input stringlist 'list'

Arguments

Type	Intent		Name
class(stringlist_type),	intent(inout)	::	list	Not a part of public API
integer,	intent(in)	::	idxn
type(string_type),	intent(in)	::	string

procedure, public :: insert_before_stringarray_int => insert_before_stringarray_int_impl

private subroutine insert_before_stringarray_int_impl(list, idxn, sarray)

Inserts stringarray 'sarray' BEFORE integer index 'idxn' in the underlying stringarray Modifies the input stringlist 'list'

Arguments

Type	Intent	Attributes		Name
class(stringlist_type),	intent(inout)		::	list	Not a part of public API
integer,	intent(in)		::	idxn
type(string_type),	intent(in),	dimension(:)	::	sarray

procedure, public :: insert_before_stringlist_int => insert_before_stringlist_int_impl

private subroutine insert_before_stringlist_int_impl(list, idxn, slist)

Inserts stringlist 'slist' BEFORE integer index 'idxn' in the underlying stringarray Modifies the input stringlist 'list'

Arguments

Type	Intent		Name
class(stringlist_type),	intent(inout)	::	list	Not a part of public API
integer,	intent(in)	::	idxn
type(stringlist_type),	intent(in)	::	slist

procedure, public :: len => length_list

private pure function length_list(list)
Returns the len (length) of the list Returns an integer

Arguments

Type Intent Optional Attributes Name

class(stringlist_type), intent(in) :: list

Return Value integer

Type	Intent	Optional	Attributes		Name
class(stringlist_type),	intent(in)			::	list

procedure, public :: to_current_idxn => convert_to_current_idxn

private pure function convert_to_current_idxn(list, idx)
Converts a forward index OR backward index to its equivalent integer index idxn Returns an integer

Arguments

Type Intent Optional Attributes Name

class(stringlist_type), intent(in) :: list
Not a part of public API

type(stringlist_index_type), intent(in) :: idx

Return Value integer

Type	Intent	Optional	Attributes		Name
class(stringlist_type),	intent(in)			::	list	Not a part of public API
type(stringlist_index_type),	intent(in)			::	idx

procedure, public :: to_future_at_idxn => convert_to_future_at_idxn

private pure function convert_to_future_at_idxn(list, idx)
Converts a forward index OR a backward index to an integer index at which the new element will be present post insertion (i.e. in future) Returns an integer

Arguments

Type Intent Optional Attributes Name

class(stringlist_type), intent(in) :: list
Not a part of public API

type(stringlist_index_type), intent(in) :: idx

Return Value integer

Type	Intent	Optional	Attributes		Name
class(stringlist_type),	intent(in)			::	list	Not a part of public API
type(stringlist_index_type),	intent(in)			::	idx

Source Code

    type stringlist_type
        private
        type(string_type), dimension(:), allocatable :: stringarray
    
    contains
        private

        procedure, public :: clear                          =>  clear_list

        procedure, public :: len                            =>  length_list

        procedure         :: to_future_at_idxn              =>  convert_to_future_at_idxn

        procedure         :: to_current_idxn                =>  convert_to_current_idxn

        procedure         :: insert_at_char_idx             =>  insert_at_char_idx_wrap
        procedure         :: insert_at_string_idx           =>  insert_at_string_idx_wrap
        procedure         :: insert_at_stringlist_idx       =>  insert_at_stringlist_idx_wrap
        procedure         :: insert_at_chararray_idx        =>  insert_at_chararray_idx_wrap
        procedure         :: insert_at_stringarray_idx      =>  insert_at_stringarray_idx_wrap
        generic, public   :: insert_at                      =>  insert_at_char_idx,         &
                                                                insert_at_string_idx,       &
                                                                insert_at_stringlist_idx,   &
                                                                insert_at_chararray_idx,    &
                                                                insert_at_stringarray_idx

        procedure         :: insert_before_string_int       =>  insert_before_string_int_impl
        procedure         :: insert_before_stringlist_int   =>  insert_before_stringlist_int_impl
        procedure         :: insert_before_chararray_int    =>  insert_before_chararray_int_impl
        procedure         :: insert_before_stringarray_int  =>  insert_before_stringarray_int_impl
        generic           :: insert_before                  =>  insert_before_string_int,       &
                                                                insert_before_stringlist_int,   &
                                                                insert_before_chararray_int,    &
                                                                insert_before_stringarray_int

        procedure         :: get_string_idx         => get_string_idx_wrap
        generic, public   :: get                    => get_string_idx

    end type stringlist_type

stringlist_type Derived Type

Contents

Constructor

Type-Bound Procedures

Source Code

type, public :: stringlist_type

Inherits

Contents

Constructor

Type-Bound Procedures

Source Code

Constructor

public interface stringlist_type

private pure function new_stringlist()

Arguments

Return Value type(stringlist_type)

private pure function new_stringlist_carray(array)

Arguments

Return Value type(stringlist_type)

private pure function new_stringlist_sarray(array)

Arguments

Return Value type(stringlist_type)

Type-Bound Procedures

procedure, public :: clear => clear_list

private subroutine clear_list(list)

Arguments

generic, public :: get => get_string_idx

private pure function get_string_idx_wrap(list, idx)

Arguments

Return Value type(string_type)

procedure, public :: get_string_idx => get_string_idx_wrap

private pure function get_string_idx_wrap(list, idx)

Arguments

Return Value type(string_type)

generic, public :: insert_at => insert_at_char_idx, insert_at_string_idx, insert_at_stringlist_idx, insert_at_chararray_idx, insert_at_stringarray_idx

private subroutine insert_at_char_idx_wrap(list, idx, string)

Arguments

private subroutine insert_at_string_idx_wrap(list, idx, string)

Arguments

private subroutine insert_at_stringlist_idx_wrap(list, idx, slist)

Arguments

private subroutine insert_at_chararray_idx_wrap(list, idx, carray)

Arguments

private subroutine insert_at_stringarray_idx_wrap(list, idx, sarray)

Arguments

procedure, public :: insert_at_char_idx => insert_at_char_idx_wrap

private subroutine insert_at_char_idx_wrap(list, idx, string)

Arguments

procedure, public :: insert_at_chararray_idx => insert_at_chararray_idx_wrap

private subroutine insert_at_chararray_idx_wrap(list, idx, carray)

Arguments

procedure, public :: insert_at_string_idx => insert_at_string_idx_wrap

private subroutine insert_at_string_idx_wrap(list, idx, string)

Arguments

procedure, public :: insert_at_stringarray_idx => insert_at_stringarray_idx_wrap

private subroutine insert_at_stringarray_idx_wrap(list, idx, sarray)

Arguments

procedure, public :: insert_at_stringlist_idx => insert_at_stringlist_idx_wrap

private subroutine insert_at_stringlist_idx_wrap(list, idx, slist)

Arguments

generic, public :: insert_before => insert_before_string_int, insert_before_stringlist_int, insert_before_chararray_int, insert_before_stringarray_int

private subroutine insert_before_string_int_impl(list, idxn, string)

Arguments

private subroutine insert_before_stringlist_int_impl(list, idxn, slist)

Arguments

private subroutine insert_before_chararray_int_impl(list, idxn, carray)

Arguments

private subroutine insert_before_stringarray_int_impl(list, idxn, sarray)

Arguments

procedure, public :: insert_before_chararray_int => insert_before_chararray_int_impl

private subroutine insert_before_chararray_int_impl(list, idxn, carray)

Arguments

procedure, public :: insert_before_string_int => insert_before_string_int_impl

private subroutine insert_before_string_int_impl(list, idxn, string)

Arguments

procedure, public :: insert_before_stringarray_int => insert_before_stringarray_int_impl

private subroutine insert_before_stringarray_int_impl(list, idxn, sarray)

Arguments

procedure, public :: insert_before_stringlist_int => insert_before_stringlist_int_impl

private subroutine insert_before_stringlist_int_impl(list, idxn, slist)