stringifor_string_t – StringiFor

StringiFor, definition of string type.

Uses

- penf
- iso_fortran_env
- befor64
- face
Help

Graph Key

Nodes of different colours represent the following:

Solid arrows point from a submodule to the (sub)module which it is descended from. Dashed arrows point from a module or program unit to modules which it uses.

Variables

Type	Visibility	Attributes		Name		Initial
integer,	public,	parameter	::	CK	=	selected_char_kind('DEFAULT')	Default character kind.
character(kind=CK, len=26),	private,	parameter	::	UPPER_ALPHABET	=	'ABCDEFGHIJKLMNOPQRSTUVWXYZ'	Upper case alphabet.
character(kind=CK, len=26),	private,	parameter	::	LOWER_ALPHABET	=	'abcdefghijklmnopqrstuvwxyz'	Lower case alphabet.
character(kind=CK, len=1),	private,	parameter	::	SPACE	=	' '	Space character.
character(kind=CK, len=1),	private,	parameter	::	TAB	=	achar(9)	Tab character.
character(kind=CK, len=1),	private,	parameter	::	UIX_DIR_SEP	=	char(47)	Unix/Linux directories separator (/).
character(kind=CK, len=1),	private,	parameter	::	BACKSLASH	=	char(92)	Backslash character.

Interfaces

public interface glob

Overloading glob procedure.

 type(string)                  :: astring
 character(len=:), allocatable :: alist_chr(:)
 type(string),     allocatable :: alist_str(:)
 integer, parameter            :: Nf=5
 character(14)                 :: files(1:Nf)
 integer                       :: file_unit
 integer                       :: f
 integer                       :: ff
 logical                       :: test_passed
 do f=1, Nf
    files(f) = astring%tempname(prefix='foo-')
    open(newunit=file_unit, file=files(f))
    write(file_unit, *)f
    close(unit=file_unit)
 enddo
 call glob(self=astring, pattern='foo-*', list=alist_chr)
 call glob(self=astring, pattern='foo-*', list=alist_str)
 do f=1, Nf
    open(newunit=file_unit, file=files(f))
    close(unit=file_unit, status='delete')
 enddo
 test_passed = .false.
 outer_chr: do f=1, size(alist_chr, dim=1)
    do ff=1, Nf
       test_passed = alist_chr(f) == files(ff)
       if (test_passed) cycle outer_chr
    enddo
 enddo outer_chr
 if (test_passed) then
    test_passed = .false.
    outer_str: do f=1, size(alist_str, dim=1)
       do ff=1, Nf
          test_passed = alist_str(f) == files(ff)
          if (test_passed) cycle outer_str
       enddo
    enddo outer_str
 endif
 print '(L1)', test_passed

private subroutine glob_character(self, pattern, list)

Glob search (character output), finds all the pathnames matching a given pattern according to the rules used by the Unix shell.

@note Note Method not portable: works only on Unix/GNU Linux OS.

 type(string)                  :: astring
 character(len=:), allocatable :: alist_chr(:)
 integer, parameter            :: Nf=5
 character(14)                 :: files(1:Nf)
 integer                       :: file_unit
 integer                       :: f
 integer                       :: ff
 logical                       :: test_passed
 do f=1, Nf
    files(f) = astring%tempname(prefix='foo-')
    open(newunit=file_unit, file=files(f))
    write(file_unit, *)f
    close(unit=file_unit)
 enddo
 call astring%glob(pattern='foo-*', list=alist_chr)
 do f=1, Nf
    open(newunit=file_unit, file=files(f))
    close(unit=file_unit, status='delete')
 enddo
 test_passed = .false.
 outer_chr: do f=1, size(alist_chr, dim=1)
    do ff=1, Nf
       test_passed = alist_chr(f) == files(ff)
       if (test_passed) cycle outer_chr
    enddo
 enddo outer_chr
 print '(L1)', test_passed

Arguments

Type	Intent	Attributes		Name
class(string),	intent(in)		::	self	The string.
character(len=*),	intent(in)		::	pattern	Given pattern.
character(len=:),	intent(out),	allocatable	::	list(:)	List of matching pathnames.

private subroutine glob_string(self, pattern, list)

Glob search (string output), finds all the pathnames matching a given pattern according to the rules used by the Unix shell.

@note Note Method not portable: works only on Unix/GNU Linux OS.

 type(string)                  :: astring
 type(string),     allocatable :: alist_str(:)
 integer, parameter            :: Nf=5
 character(14)                 :: files(1:Nf)
 integer                       :: file_unit
 integer                       :: f
 integer                       :: ff
 logical                       :: test_passed

 do f=1, Nf
    files(f) = astring%tempname(prefix='foo-')
    open(newunit=file_unit, file=files(f))
    write(file_unit, *)f
    close(unit=file_unit)
 enddo
 call astring%glob(pattern='foo-*', list=alist_str)
 do f=1, Nf
    open(newunit=file_unit, file=files(f))
    close(unit=file_unit, status='delete')
 enddo
 test_passed = .false.
 outer_str: do f=1, size(alist_str, dim=1)
    do ff=1, Nf
       test_passed = alist_str(f) == files(ff)
       if (test_passed) cycle outer_str
    enddo
 enddo outer_str
 print '(L1)', test_passed

Arguments

Type	Intent	Attributes		Name
class(string),	intent(in)		::	self	The string.
character(len=*),	intent(in)		::	pattern	Given pattern.
type(string),	intent(out),	allocatable	::	list(:)	List of matching pathnames.

public interface strjoin

private pure function strjoin_strings(array, sep) result(join)

Return a string that is a join of an array of strings.

The join-separator is set equals to a null string ‘’ if custom separator isn’t specified.

 type(string)     :: strings(3)
 logical          :: test_passed(5)
 strings(1) = 'one'
 strings(2) = 'two'
 strings(3) = 'three'
 test_passed(1) = (strjoin(array=strings)//''==strings(1)//strings(2)//strings(3))
 test_passed(2) = (strjoin(array=strings, sep='-')//''==strings(1)//'-'//strings(2)//'-'//strings(3))
 call strings(1)%free
 strings(2) = 'two'
 strings(3) = 'three'
 test_passed(3) = (strjoin(array=strings, sep='-')//''==strings(2)//'-'//strings(3))
 strings(1) = 'one'
 strings(2) = 'two'
 call strings(3)%free
 test_passed(4) = (strjoin(array=strings, sep='-')//''==strings(1)//'-'//strings(2))
 strings(1) = 'one'
 call strings(2)%free
 strings(3) = 'three'
 test_passed(5) = (strjoin(array=strings, sep='-')//''==strings(1)//'-'//strings(3))
 print '(L1)', all(test_passed)

Arguments

Type	Intent	Optional	Attributes		Name
class(string),	intent(in)			::	array(1:)	Array to be joined.
character(kind=CK, len=*),	intent(in),	optional		::	sep	Separator.

Return Value type(string)

The join of array.

private pure function strjoin_characters(array, sep, is_trim) result(join)

Return a string that is a join of an array of characters.

The join-separator is set equals to a null string ‘’ if custom separator isn’t specified. The trim function is applied to array items if optional logical is_trim variable isn’t set to .false.

 character(5) :: characters(3)
 logical      :: test_passed(13)
 characters(1) = 'one'
 characters(2) = 'two'
 characters(3) = 'three'
 test_passed(1) = (strjoin(array=characters)//''==trim(characters(1))//trim(characters(2))//trim(characters(3)))
 test_passed(2) = (strjoin(array=characters, sep='-')//''==trim(characters(1))//'-'//trim(characters(2))//'-'//trim(characters(3)))
 test_passed(3) = ( strjoin(array=characters, is_trim=.false.)//''==characters(1)//characters(2)//characters(3))
 test_passed(4) = ( strjoin(array=characters, sep='-', is_trim=.false.)//''==characters(1)//'-'//characters(2)//'-'//characters(3))
 characters(1) = ''
 characters(2) = 'two'
 characters(3) = 'three'
 test_passed(5) = (strjoin(array=characters)//''==trim(characters(2))//trim(characters(3)))
 characters(1) = 'one'
 characters(2) = 'two'
 characters(3) = ''
 test_passed(6) = (strjoin(array=characters)//''==trim(characters(1))//trim(characters(2)))
 characters(1) = 'one'
 characters(2) = ''
 characters(3) = 'three'
 test_passed(7) = (strjoin(array=characters)//''==trim(characters(1))//trim(characters(3)))
 characters(1) = ''
 characters(2) = 'two'
 characters(3) = 'three'
 test_passed(8) = (strjoin(array=characters, sep='-')//''==trim(characters(2))//'-'//trim(characters(3)))
 characters(1) = 'one'
 characters(2) = 'two'
 characters(3) = ''
 test_passed(9) = (strjoin(array=characters, sep='-')//''==trim(characters(1))//'-'//trim(characters(2)))
 characters(1) = 'one'
 characters(2) = ''
 characters(3) = 'three'
 test_passed(10) = (strjoin(array=characters, sep='-')//''==trim(characters(1))//'-'//trim(characters(3)))
 characters(1) = ''
 characters(2) = 'two'
 characters(3) = 'three'
 test_passed(11) = (strjoin(array=characters, sep='-', is_trim=.false.)//''==characters(2)//'-'//characters(3))
 characters(1) = 'one'
 characters(2) = 'two'
 characters(3) = ''
 test_passed(12) = (strjoin(array=characters, sep='-', is_trim=.false.)//''==characters(1)//'-'//characters(2))
 characters(1) = 'one'
 characters(2) = ''
 characters(3) = 'three'
 test_passed(13) = (strjoin(array=characters, sep='-', is_trim=.false.)//''==characters(1)//'-'//characters(3))
 print '(L1)', all(test_passed)

Arguments

Type	Intent	Optional		Name
character(kind=CK, len=*),	intent(in)		::	array(1:)	Array to be joined.
character(kind=CK, len=*),	intent(in),	optional	::	sep	Separator.
logical,	intent(in),	optional	::	is_trim	Flag to setup trim character or not

Return Value type(string)

The join of array.

private pure function strjoin_strings_array(array, sep, is_col) result(join)

Return a string that is a join of columns or rows of an array of strings.

The join-separator is set equals to a null string ‘’ if custom separator isn’t specified. The is_col is setup the direction of join: within default columns (.true.) or rows(.false.).

 type(string), allocatable :: strings_arr(:, :)
 logical                   :: test_passed(5)

 strings_arr = reshape( source = &
                        [string('one'), string('two'), string('three'),  &
                         string('ONE'), string('TWO'), string('THREE')], &
                        shape = [3, 2] )

 test_passed(1) = all( strjoin(array=strings_arr) == &
                       reshape([string('onetwothree'), string('ONETWOTHREE')], &
                       shape = [2]) )

 test_passed(2) = all( strjoin(array=strings_arr, sep='_') == &
                       reshape([string('one_two_three'), string('ONE_TWO_THREE')], &
                       shape = [2]) )

  test_passed(3) = all( strjoin(array=strings_arr, is_col=.false.) == &
                        reshape([string('oneONE'), string('twoTWO'), string('threeTHREE')], &
                        shape = [3]) )

  test_passed(4) = all( strjoin(array=strings_arr, sep='_', is_col=.false.) == &
                        reshape([string('one_ONE'), string('two_TWO'), string('three_THREE')], &
                        shape = [3]) )

 call strings_arr(2, 1)%free
 test_passed(5) = all( strjoin(array=strings_arr, sep='_', is_col=.false.) == &
                  reshape([string('one_ONE'), string('TWO'), string('three_THREE')], &
                  shape = [3]) )

 print '(L1)', all(test_passed)

Arguments

Type	Intent	Optional		Name
class(string),	intent(in)		::	array(1:,1:)	Array to be joined.
character(kind=CK, len=*),	intent(in),	optional	::	sep	Separator.
logical,	intent(in),	optional	::	is_col	Direction: ‘columns’ if .true. or ‘rows’ if .false.

Return Value type(string), allocatable, (:)

The join of array.

private pure function strjoin_characters_array(array, sep, is_trim, is_col) result(join)

Return a string that is a join of columns or rows of an array of characters.

The join-separator is set equals to a null string ‘’ if custom separator isn’t specified. The trim function is applied to array items if optional logical is_trim variable isn’t set to .false. The is_col is setup the direction of join: within default columns (.true.) or rows(.false.).

 character(len=10)         :: chars_arr(3, 2)
 logical                   :: test_passed(9)
 chars_arr(:, 1) = ['one       ', 'two       ', 'three     ']
 chars_arr(:, 2) = ['ONE       ', 'TWO       ', 'THREE     ']

 test_passed(1) = all( strjoin(array=chars_arr) == &
                       reshape([string('onetwothree'), string('ONETWOTHREE')], &
                       shape = [2]) )

 test_passed(2) = all( strjoin(array=chars_arr, is_trim=.false.) ==  &
                       reshape([string('one       two       three     '),  &
                                string('ONE       TWO       THREE     ')], &
                       shape = [2]) )

 test_passed(3) = all( strjoin(array=chars_arr, sep='_') == &
                       reshape([string('one_two_three'), string('ONE_TWO_THREE')], &
                       shape = [2]) )

 test_passed(4) = all( strjoin(array=chars_arr, sep='_', is_trim=.false.) ==  &
                       reshape([string('one       _two       _three     '),  &
                                string('ONE       _TWO       _THREE     ')], &
                       shape = [2]) )

 test_passed(5) = all( strjoin(array=chars_arr, is_col=.false.) == &
                       reshape([string('oneONE'), string('twoTWO'), string('threeTHREE')], &
                       shape = [3]) )

 test_passed(6) = all( strjoin(array=chars_arr, is_trim=.false., is_col=.false.) ==  &
                       reshape([string('one       ONE       '),  &
                                string('two       TWO       '),  &
                                string('three     THREE     ')], &
                       shape = [3]) )

 test_passed(7) = all( strjoin(array=chars_arr, sep='_', is_col=.false.) == &
                       reshape([string('one_ONE'), string('two_TWO'), string('three_THREE')], &
                       shape = [3]) )

 test_passed(8) = all( strjoin(array=chars_arr, sep='_', is_trim=.false., is_col=.false.) ==  &
                       reshape([string('one       _ONE       '),  &
                                string('two       _TWO       '),  &
                                string('three     _THREE     ')], &
                       shape = [3]) )

 chars_arr(2,1) = ''
 test_passed(9) = all( strjoin(array=chars_arr, sep='_', is_col=.false.) ==  &
                       reshape([string('one_ONE'),  &
                                string('TWO'),  &
                                string('three_THREE')], &
                       shape = [3]) )

 print '(L1)', all(test_passed)

all items of character array have equal lengths

Arguments

Type	Intent	Optional		Name
character(kind=CK, len=*),	intent(in)		::	array(1:,1:)	Array to be joined.
character(kind=CK, len=*),	intent(in),	optional	::	sep	Separator.
logical,	intent(in),	optional	::	is_trim	Flag to setup trim character or not
logical,	intent(in),	optional	::	is_col	Direction: ‘columns’ if .true. or ‘rows’ if .false.

Return Value type(string), allocatable, (:)

The join of array.

public interface adjustl

Builtin adjustl overloading.

private pure function sadjustl_character(s) result(adjusted)

Left adjust a string by removing leading spaces (character output).

 type(string) :: astring
 astring = '   Hello World!'
 print "(L1)", adjustl(astring)=='Hello World!   '

Arguments

Type	Intent	Optional	Attributes		Name
class(string),	intent(in)			::	s	String.

Return Value character(kind=CK, len=:), allocatable

Adjusted string.

public interface adjustr

Builtin adjustr overloading.

private pure function sadjustr_character(s) result(adjusted)

Right adjust a string by removing leading spaces (character output).

 type(string) :: astring
 astring = 'Hello World!   '
 print "(L1)", adjustr(astring)=='   Hello World!'

Arguments

Type	Intent	Optional	Attributes		Name
class(string),	intent(in)			::	s	String.

Return Value character(kind=CK, len=:), allocatable

Adjusted string.

public interface count

Builtin count overloading.

private elemental function count_substring(s, substring) result(No)

Count the number of occurences of a substring into a string.

 print "(L1)", count('hello', substring='ll')==1

Arguments

Type	Intent	Optional	Attributes		Name
character(len=*),	intent(in)			::	s	String.
character(len=*),	intent(in)			::	substring	Substring.

Return Value integer(kind=I4P)

Number of occurrences.

public interface index

Builtin index overloading.

private elemental function sindex_string_string(self, substring, back) result(i)

Return the position of the start of the first occurrence of string substring as a substring in string, counting from one. If substring is not present in string, zero is returned. If the back argument is present and true, the return value is the start of the last occurrence rather than the first.

 type(string) :: string1
 type(string) :: string2
 logical      :: test_passed(2)
 string1 = 'Hello World Hello!'
 string2 = 'llo'
 test_passed(1) = string1%index(substring=string2)==index(string='Hello World Hello!', substring='llo')
 test_passed(2) = string1%index(substring=string2, back=.true.)==index(string='Hello World Hello!', substring='llo', &
                                                                       back=.true.)
 print '(L1)', all(test_passed)

Arguments

Type	Intent	Optional		Name
class(string),	intent(in)		::	self	The string.
type(string),	intent(in)		::	substring	Searched substring.
logical,	intent(in),	optional	::	back	Start of the last occurrence rather than the first.

Return Value integer

Result of the search.

private elemental function sindex_string_character(self, substring, back) result(i)

 type(string) :: string1
 logical      :: test_passed(2)
 string1 = 'Hello World Hello!'
 test_passed(1) = string1%index(substring='llo')==index(string='Hello World Hello!', substring='llo')
 test_passed(2) = string1%index(substring='llo', back=.true.)==index(string='Hello World Hello!', substring='llo', back=.true.)
 print '(L1)', all(test_passed)

Arguments

Type	Intent	Optional		Name
class(string),	intent(in)		::	self	The string.
character(kind=CK, len=*),	intent(in)		::	substring	Searched substring.
logical,	intent(in),	optional	::	back	Start of the last occurrence rather than the first.

Return Value integer

Result of the search.

private elemental function sindex_character_string(s, substring, back) result(i)

 type(string) :: string1
 logical      :: test_passed(2)
 string1 = 'llo'
 test_passed(1) = index(s='Hello World Hello!', substring=string1)==index(string='Hello World Hello!', substring='llo')
 test_passed(2) = index(s='Hello World Hello!', substring=string1, back=.true.)==index(string='Hello World Hello!', &
                                                                                       substring='llo', back=.true.)
 print '(L1)', all(test_passed)

Arguments

Type	Intent	Optional		Name
character(kind=CK, len=*),	intent(in)		::	s	String.
type(string),	intent(in)		::	substring	Searched substring.
logical,	intent(in),	optional	::	back	Start of the last occurrence rather than the first.

Return Value integer

Result of the search.

public interface len_trim

Builtin len_trim overloading.

private elemental function slen_trim(self) result(l)

Return the length of a string, ignoring any trailing blanks.

 type(string) :: astring
 astring = 'Hello World!   '
 print "(L1)", astring%len_trim()==len_trim('Hello World!   ')

Arguments

Type	Intent	Optional	Attributes		Name
class(string),	intent(in)			::	self	The string.

Return Value integer

String length.

public interface repeat

Builtin repeat overloading.

private elemental function srepeat_string_string(self, ncopies) result(repeated)

Concatenates several copies of an input string.

 type(string) :: astring
 astring = 'x'
 print "(L1)", astring%repeat(5)//''=='xxxxx'

Arguments

Type	Intent	Optional	Attributes		Name
class(string),	intent(in)			::	self	String to be repeated.
integer,	intent(in)			::	ncopies	Number of string copies.

Return Value type(string)

Repeated string.

public interface scan

Builtin scan overloading.

private elemental function sscan_string_string(self, set, back) result(i)

Return the leftmost (if back is either absent or equals false, otherwise the rightmost) character of string that is in set.

 type(string) :: string1
 type(string) :: string2
 logical      :: test_passed(2)
 string1 = 'Hello World Hello!'
 string2 = 'llo'
 test_passed(1) = string1%scan(set=string2)==scan(string='Hello World Hello!', set='llo')
 test_passed(2) = string1%scan(set=string2, back=.true.)==scan(string='Hello World Hello!', set='llo', back=.true.)
 print '(L1)', all(test_passed)

Arguments

Type	Intent	Optional		Name
class(string),	intent(in)		::	self	The string.
type(string),	intent(in)		::	set	Searched set.
logical,	intent(in),	optional	::	back	Start of the last occurrence rather than the first.

Return Value integer

Result of the search.

private elemental function sscan_string_character(self, set, back) result(i)

Return the leftmost (if back is either absent or equals false, otherwise the rightmost) character of string that is in set.

 type(string) :: string1
 logical      :: test_passed(2)
 string1 = 'Hello World Hello!'
 test_passed(1) = string1%scan(set='llo')==scan(string='Hello World Hello!', set='llo')
 test_passed(2) = string1%scan(set='llo', back=.true.)==scan(string='Hello World Hello!', set='llo', back=.true.)
 print '(L1)', all(test_passed)

Arguments

Type	Intent	Optional		Name
class(string),	intent(in)		::	self	The string.
character(kind=CK, len=*),	intent(in)		::	set	Searched set.
logical,	intent(in),	optional	::	back	Start of the last occurrence rather than the first.

Return Value integer

Result of the search.

private elemental function sscan_character_string(s, set, back) result(i)

Return the leftmost (if back is either absent or equals false, otherwise the rightmost) character of string that is in set.

 type(string) :: string1
 logical      :: test_passed(2)
 string1 = 'llo'
 test_passed(1) = scan(s='Hello World Hello!', set=string1)==scan(string='Hello World Hello!', set='llo')
 test_passed(2) = scan(s='Hello World Hello!', set=string1, back=.true.)==scan(string='Hello World Hello!', &
                                                                               set='llo', back=.true.)
 print '(L1)', all(test_passed)

Arguments

Type	Intent	Optional		Name
character(kind=CK, len=*),	intent(in)		::	s	String.
type(string),	intent(in)		::	set	Searched set.
logical,	intent(in),	optional	::	back	Start of the last occurrence rather than the first.

Return Value integer

Result of the search.

public interface trim

Builtin trim overloading.

private elemental function strim(self) result(trimmed)

Remove trailing spaces.

 type(string) :: astring
 astring = 'Hello World!   '
 print "(L1)", astring%trim()==trim('Hello World!   ')

Arguments

Type	Intent	Optional	Attributes		Name
class(string),	intent(in)			::	self	The string.

Return Value type(string)

Trimmed string.

public interface verify

Builtin verify overloading.

private elemental function sverify_string_string(self, set, back) result(i)

Return the leftmost (if back is either absent or equals false, otherwise the rightmost) character of string that is not in set. If all characters of string are found in set, the result is zero.

 type(string) :: string1
 type(string) :: string2
 logical      :: test_passed(2)
 string1 = 'Hello World Hello!'
 string2 = 'llo'
 test_passed(1) = string1%verify(set=string2)==verify(string='Hello World Hello!', set='llo')
 test_passed(2) = string1%verify(set=string2, back=.true.)==verify(string='Hello World Hello!', set='llo', back=.true.)
 print '(L1)', all(test_passed)

Arguments

Type	Intent	Optional		Name
class(string),	intent(in)		::	self	The string.
type(string),	intent(in)		::	set	Searched set.
logical,	intent(in),	optional	::	back	Start of the last occurrence rather than the first.

Return Value integer

Result of the search.

private elemental function sverify_string_character(self, set, back) result(i)

 type(string) :: string1
 logical      :: test_passed(2)
 string1 = 'Hello World Hello!'
 test_passed(1) = string1%verify(set='llo')==verify(string='Hello World Hello!', set='llo')
 test_passed(2) = string1%verify(set='llo', back=.true.)==verify(string='Hello World Hello!', set='llo', back=.true.)
 print '(L1)', all(test_passed)

Arguments

Type	Intent	Optional		Name
class(string),	intent(in)		::	self	The string.
character(kind=CK, len=*),	intent(in)		::	set	Searched set.
logical,	intent(in),	optional	::	back	Start of the last occurrence rather than the first.

Return Value integer

Result of the search.

private elemental function sverify_character_string(s, set, back) result(i)

 type(string) :: string1
 logical      :: test_passed(2)
 string1 = 'ell'
 test_passed(1) = verify(s='Hello World Hello!', set=string1)==verify(string='Hello World Hello!', set='llo')
 test_passed(2) = verify(s='Hello World Hello!', set=string1, back=.true.)==verify(string='Hello World Hello!', set='llo', &
                                                                                   back=.true.)
 print '(L1)', all(test_passed)

Arguments

Type	Intent	Optional		Name
character(kind=CK, len=*),	intent(in)		::	s	String.
type(string),	intent(in)		::	set	Searched set.
logical,	intent(in),	optional	::	back	Start of the last occurrence rather than the first.

Return Value integer

Result of the search.

Derived Types

type, public :: string

OOP designed string class.

Components

Type	Visibility	Attributes		Name		Initial
character(kind=CK, len=:),	public,	allocatable	::	raw			Raw data.

Type-Bound Procedures

procedure, public, pass(self) :: adjustl => sadjustl	../../../../ Adjustl replacement.
procedure, public, pass(self) :: adjustr => sadjustr	../../../../ Adjustr replacement.
procedure, public, pass(self) :: count => scount	../../../../ Count replacement.
generic, public :: index => sindex_string_string, sindex_string_character	../../../../ Index replacement.
procedure, public, pass(self) :: len => slen	../../../../ Len replacement.
procedure, public, pass(self) :: len_trim => slen_trim	../../../../ Len_trim replacement.
generic, public :: repeat => srepeat_string_string, srepeat_character_string	../../../../ Repeat replacement.
generic, public :: scan => sscan_string_string, sscan_string_character	../../../../ Scan replacement.
procedure, public, pass(self) :: trim => strim	../../../../ Trim replacement.
generic, public :: verify => sverify_string_string, sverify_string_character	../../../../ Verify replacement.
procedure, public, pass(self) :: basedir	../../../../ Return the base directory name of a string containing a file name.
procedure, public, pass(self) :: basename	../../../../ Return the base file name of a string containing a file name.
procedure, public, pass(self) :: camelcase	../../../../ Return a string with all words capitalized without spaces.
procedure, public, pass(self) :: capitalize	../../../../ Return a string with its first character capitalized and the rest lowercased.
procedure, public, pass(self) :: chars	../../../../ Return the raw characters data.
generic, public :: colorize => colorize_str	../../../../ Colorize and stylize strings.
procedure, public, pass(self) :: decode	../../../../ Decode string.
procedure, public, pass(self) :: encode	../../../../ Encode string.
procedure, public, pass(self) :: escape	../../../../ Escape backslashes (or custom escape character).
procedure, public, pass(self) :: extension	../../../../ Return the extension of a string containing a file name.
procedure, public, pass(self) :: fill	../../../../ Pad string on the left (or right) with zeros (or other char) to fill width.
procedure, public, pass(self) :: free	../../../../ Free dynamic memory.
generic, public :: glob => glob_character, glob_string	../../../../ Glob search, finds all the pathnames matching a given pattern.
generic, public :: insert => insert_string, insert_character	../../../../ Insert substring into string at a specified position.
generic, public :: join => join_strings, join_characters	../../../../ Return a string that is a join of an array of strings or characters.
generic, public :: strjoin => strjoin_strings, strjoin_characters, strjoin_strings_array, strjoin_characters_array	../../../../ Return a string that is a join of an array of strings or characters; Return join 1D string array of an 2D array of strings or characters in columns or rows.
procedure, public, pass(self) :: lower	../../../../ Return a string with all lowercase characters.
procedure, public, pass(self) :: partition	../../../../ Split string at separator and return the 3 parts (before, the separator and after).
procedure, public, pass(self) :: read_file	../../../../ Read a file a single string stream.
procedure, public, pass(self) :: read_line	../../../../ Read line (record) from a connected unit.
procedure, public, pass(self) :: read_lines	../../../../ Read (all) lines (records) from a connected unit as a single ascii stream.
procedure, public, pass(self) :: replace	../../../../ Return a string with all occurrences of substring old replaced by new.
procedure, public, pass(self) :: reverse	../../../../ Return a reversed string.
procedure, public, pass(self) :: search	../../../../ Search for tagged record into string.
procedure, public, pass(self) :: slice	../../../../ Return the raw characters data sliced.
procedure, public, pass(self) :: snakecase	../../../../ Return a string with all words lowercase separated by “_”.
procedure, public, pass(self) :: split	../../../../ Return a list of substring in the string, using sep as the delimiter string.
procedure, public, pass(self) :: split_chunked	../../../../ Return a list of substring in the string, using sep as the delimiter string.
procedure, public, pass(self) :: startcase	../../../../ Return a string with all words capitalized, e.g. title case.
procedure, public, pass(self) :: strip	../../../../ Return a string with the leading and trailing characters removed.
procedure, public, pass(self) :: swapcase	../../../../ Return a string with uppercase chars converted to lowercase and vice versa.
procedure, public, pass(self) :: tempname	../../../../ Return a safe temporary name suitable for temporary file or directories.
generic, public :: to_number => to_integer_I1P, to_integer_I2P, to_integer_I4P, to_integer_I8P, to_real_R8P, to_real_R4P	../../../../ Cast string to number.
procedure, public, pass(self) :: unescape	../../../../ Unescape double backslashes (or custom escaped character).
procedure, public, pass(self) :: unique	../../../../ Reduce to one (unique) multiple occurrences of a substring into a string.
procedure, public, pass(self) :: upper	../../../../ Return a string with all uppercase characters.
procedure, public, pass(self) :: write_file	../../../../ Write a single string stream into file.
procedure, public, pass(self) :: write_line	../../../../ Write line (record) to a connected unit.
procedure, public, pass(self) :: write_lines	../../../../ Write lines (records) to a connected unit.
procedure, public, pass(self) :: end_with	../../../../ Return true if a string ends with a specified suffix.
procedure, public, pass(self) :: is_allocated	../../../../ Return true if the string is allocated.
procedure, public, pass(self) :: is_digit	../../../../ Return true if all characters in the string are digits.
procedure, public, pass(self) :: is_integer	../../../../ Return true if the string contains an integer.
procedure, public, pass(self) :: is_lower	../../../../ Return true if all characters in the string are lowercase.
procedure, public, pass(self) :: is_number	../../../../ Return true if the string contains a number (real or integer).
procedure, public, pass(self) :: is_real	../../../../ Return true if the string contains an real.
procedure, public, pass(self) :: is_upper	../../../../ Return true if all characters in the string are uppercase.
procedure, public, pass(self) :: start_with	../../../../ Return true if a string starts with a specified prefix.
generic, public :: assignment(=) => string_assign_string, string_assign_character, string_assign_integer_I1P, string_assign_integer_I2P, string_assign_integer_I4P, string_assign_integer_I8P, string_assign_real_R8P, string_assign_real_R4P	../../../../ Assignment operator overloading.
generic, public :: operator(//) => string_concat_string, string_concat_character, character_concat_string	../../../../ Concatenation operator overloading.
generic, public :: operator(.cat.) => string_concat_string_string, string_concat_character_string, character_concat_string_string	../../../../ Concatenation operator (string output) overloading.
generic, public :: operator(==) => string_eq_string, string_eq_character, character_eq_string	../../../../ Equal operator overloading.
generic, public :: operator(/=) => string_ne_string, string_ne_character, character_ne_string	../../../../ Not equal operator overloading.
generic, public :: operator(<) => string_lt_string, string_lt_character, character_lt_string	../../../../ Lower than operator overloading.
generic, public :: operator(<=) => string_le_string, string_le_character, character_le_string	../../../../ Lower equal than operator overloading.
generic, public :: operator(>=) => string_ge_string, string_ge_character, character_ge_string	../../../../ Greater equal than operator overloading.
generic, public :: operator(>) => string_gt_string, string_gt_character, character_gt_string	../../../../ Greater than operator overloading.
generic, public :: read(formatted) => read_formatted	../../../../ Formatted input.
generic, public :: write(formatted) => write_formatted	../../../../ Formatted output.
generic, public :: read(unformatted) => read_unformatted	../../../../ Unformatted input.
generic, public :: write(unformatted) => write_unformatted	../../../../ Unformatted output.
procedure, private, pass(self) :: sindex_string_string	../../../../ Index replacement.
procedure, private, pass(self) :: sindex_string_character	../../../../ Index replacement.
procedure, private, pass(self) :: srepeat_string_string	../../../../ Repeat replacement.
procedure, private, nopass :: srepeat_character_string	../../../../ Repeat replacement.
procedure, private, pass(self) :: sscan_string_string	../../../../ Scan replacement.
procedure, private, pass(self) :: sscan_string_character	../../../../ Scan replacement.
procedure, private, pass(self) :: sverify_string_string	../../../../ Verify replacement.
procedure, private, pass(self) :: sverify_string_character	../../../../ Verify replacement.
procedure, private, pass(self) :: colorize_str	../../../../ Colorize and stylize strings.
procedure, private, pass(self) :: glob_character	../../../../ Glob search (character output).
procedure, private, pass(self) :: glob_string	../../../../ Glob search (string output).
procedure, private, pass(self) :: insert_string	../../../../ Insert substring into string at a specified position.
procedure, private, pass(self) :: insert_character	../../../../ Insert substring into string at a specified position.
procedure, private, pass(self) :: join_strings	../../../../ Return join string of an array of strings.
procedure, private, pass(self) :: join_characters	../../../../ Return join string of an array of characters.
procedure, private, nopass :: strjoin_strings	../../../../ Return join string of an array of strings.
procedure, private, nopass :: strjoin_characters	../../../../ Return join string of an array of strings.
procedure, private, nopass :: strjoin_strings_array	../../../../ Return join 1D string array of an 2D array of strings in columns or rows.
procedure, private, nopass :: strjoin_characters_array	../../../../ Return join 1D string array of an 2D array of characters in columns or rows.
procedure, private, pass(self) :: to_integer_I1P	../../../../ Cast string to integer.
procedure, private, pass(self) :: to_integer_I2P	../../../../ Cast string to integer.
procedure, private, pass(self) :: to_integer_I4P	../../../../ Cast string to integer.
procedure, private, pass(self) :: to_integer_I8P	../../../../ Cast string to integer.
procedure, private, pass(self) :: to_real_R4P	../../../../ Cast string to real.
procedure, private, pass(self) :: to_real_R8P	../../../../ Cast string to real.
procedure, private, pass(self) :: to_real_R16P	../../../../ Cast string to real.
procedure, private, pass(lhs) :: string_assign_string	../../../../ Assignment operator from string input.
procedure, private, pass(lhs) :: string_assign_character	../../../../ Assignment operator from character input.
procedure, private, pass(lhs) :: string_assign_integer_I1P	../../../../ Assignment operator from integer input.
procedure, private, pass(lhs) :: string_assign_integer_I2P	../../../../ Assignment operator from integer input.
procedure, private, pass(lhs) :: string_assign_integer_I4P	../../../../ Assignment operator from integer input.
procedure, private, pass(lhs) :: string_assign_integer_I8P	../../../../ Assignment operator from integer input.
procedure, private, pass(lhs) :: string_assign_real_R4P	../../../../ Assignment operator from real input.
procedure, private, pass(lhs) :: string_assign_real_R8P	../../../../ Assignment operator from real input.
procedure, private, pass(lhs) :: string_assign_real_R16P	../../../../ Assignment operator from real input.
procedure, private, pass(lhs) :: string_concat_string	../../../../ Concatenation with string.
procedure, private, pass(lhs) :: string_concat_character	../../../../ Concatenation with character.
procedure, private, pass(rhs) :: character_concat_string	../../../../ Concatenation with character (inverted).
procedure, private, pass(lhs) :: string_concat_string_string	../../../../ Concatenation with string (string output).
procedure, private, pass(lhs) :: string_concat_character_string	../../../../ Concatenation with character (string output).
procedure, private, pass(rhs) :: character_concat_string_string	../../../../ Concatenation with character (inverted, string output).
procedure, private, pass(lhs) :: string_eq_string	../../../../ Equal to string logical operator.
procedure, private, pass(lhs) :: string_eq_character	../../../../ Equal to character logical operator.
procedure, private, pass(rhs) :: character_eq_string	../../../../ Equal to character (inverted) logical operator.
procedure, private, pass(lhs) :: string_ne_string	../../../../ Not equal to string logical operator.
procedure, private, pass(lhs) :: string_ne_character	../../../../ Not equal to character logical operator.
procedure, private, pass(rhs) :: character_ne_string	../../../../ Not equal to character (inverted) logical operator.
procedure, private, pass(lhs) :: string_lt_string	../../../../ Lower than to string logical operator.
procedure, private, pass(lhs) :: string_lt_character	../../../../ Lower than to character logical operator.
procedure, private, pass(rhs) :: character_lt_string	../../../../ Lower than to character (inverted) logical operator.
procedure, private, pass(lhs) :: string_le_string	../../../../ Lower equal than to string logical operator.
procedure, private, pass(lhs) :: string_le_character	../../../../ Lower equal than to character logical operator.
procedure, private, pass(rhs) :: character_le_string	../../../../ Lower equal than to character (inverted) logical operator.
procedure, private, pass(lhs) :: string_ge_string	../../../../ Greater equal than to string logical operator.
procedure, private, pass(lhs) :: string_ge_character	../../../../ Greater equal than to character logical operator.
procedure, private, pass(rhs) :: character_ge_string	../../../../ Greater equal than to character (inverted) logical operator.
procedure, private, pass(lhs) :: string_gt_string	../../../../ Greater than to string logical operator.
procedure, private, pass(lhs) :: string_gt_character	../../../../ Greater than to character logical operator.
procedure, private, pass(rhs) :: character_gt_string	../../../../ Greater than to character (inverted) logical operator.
procedure, private, pass(dtv) :: read_formatted	../../../../ Formatted input.
procedure, private, pass(dtv) :: read_delimited	../../../../ Read a delimited input.
procedure, private, pass(dtv) :: read_undelimited	../../../../ Read an undelimited input.
procedure, private, pass(dtv) :: read_undelimited_listdirected	../../../../ Read an undelimited list directed input.
procedure, private, pass(dtv) :: write_formatted	../../../../ Formatted output.
procedure, private, pass(dtv) :: read_unformatted	../../../../ Unformatted input.
procedure, private, pass(dtv) :: write_unformatted	../../../../ Unformatted output.
procedure, private, pass(self) :: replace_one_occurrence	../../../../ Replace the first occurrence of substring old by new.

Functions

private pure function string_(c)

Return a string given a character input.

Type	Intent	Optional	Attributes		Name
character(kind=CK, len=*),	intent(in)			::	rstring	String to be repeated.
integer,	intent(in)			::	ncopies	Number of string copies.

Type	Intent	Optional	Attributes		Name
class(string),	intent(in)			::	lhs	Left hand side.
type(string),	intent(in)			::	rhs	Right hand side.

Type	Intent	Optional		Name
class(string),	intent(inout)		::	self	The string.
character(len=*),	intent(in)		::	file	File name.
logical,	intent(in),	optional	::	is_fast	Flag to enable (super) fast file reading.
character(len=*),	intent(in),	optional	::	form	Format of unit.
integer,	intent(out),	optional	::	iostat	IO status code.
character(len=*),	intent(inout),	optional	::	iomsg	IO status message.

Type	Intent		Name
class(string),	intent(inout)	::	dtv	The string.
integer,	intent(in)	::	unit	Logical unit.
character(len=*),	intent(in)	::	iotype	Edit descriptor.
integer,	intent(in)	::	v_list(:)	Edit descriptor list.
integer,	intent(out)	::	iostat	IO status code.
character(len=*),	intent(inout)	::	iomsg	IO status message.

stringifor_string_t Module

Contents

Variables

Interfaces

Derived Types

Functions

Subroutines

Uses

Used by

Variables

Interfaces

public interface glob

private subroutine glob_character(self, pattern, list)

Arguments

private subroutine glob_string(self, pattern, list)

Arguments

public interface strjoin

private pure function strjoin_strings(array, sep) result(join)

Arguments

Return Value type(string)

private pure function strjoin_characters(array, sep, is_trim) result(join)

Arguments

Return Value type(string)

private pure function strjoin_strings_array(array, sep, is_col) result(join)

Arguments

Return Value type(string), allocatable, (:)

private pure function strjoin_characters_array(array, sep, is_trim, is_col) result(join)

Arguments

Return Value type(string), allocatable, (:)

public interface adjustl

private pure function sadjustl_character(s) result(adjusted)

Arguments

Return Value character(kind=CK, len=:), allocatable

public interface adjustr

private pure function sadjustr_character(s) result(adjusted)

Arguments

Return Value character(kind=CK, len=:), allocatable

public interface count

private elemental function count_substring(s, substring) result(No)

Arguments

Return Value integer(kind=I4P)

public interface index

private elemental function sindex_string_string(self, substring, back) result(i)

Arguments

Return Value integer

private elemental function sindex_string_character(self, substring, back) result(i)

Arguments

Return Value integer

private elemental function sindex_character_string(s, substring, back) result(i)

Arguments

Return Value integer

public interface len_trim

private elemental function slen_trim(self) result(l)

Arguments

Return Value integer

public interface repeat

private elemental function srepeat_string_string(self, ncopies) result(repeated)

Arguments

Return Value type(string)

public interface scan

private elemental function sscan_string_string(self, set, back) result(i)

Arguments

Return Value integer

private elemental function sscan_string_character(self, set, back) result(i)

Arguments

Return Value integer

private elemental function sscan_character_string(s, set, back) result(i)

Arguments

Return Value integer

public interface trim

private elemental function strim(self) result(trimmed)

Arguments

Return Value type(string)

public interface verify

private elemental function sverify_string_string(self, set, back) result(i)

Arguments

Return Value integer

private elemental function sverify_string_character(self, set, back) result(i)

Arguments

Return Value integer