stringifor_string_t

Uses:
befor64
penf

StringiFor, definition of string type.

Used By

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.

Derived Types

type, public :: string

Components

Type	Visibility	Attributes		Name		Initial
character(kind=CK,len=:),	private,	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.
procedure, public, pass(self) :: verify => sverify	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.
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 :: 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.
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) :: 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.
generic, public :: to_number => to_integer_I1P, to_integer_I2P, to_integer_I4P, to_integer_I8P, to_real_R4P, to_real_R8P	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_R4P, string_assign_real_R8P	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.
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, pass(self) :: 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) :: 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, 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.

Description

OOP designed string class.

Functions

private elemental function sadjustl(self) result(adjusted)

Arguments

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

Return Value type(string)

Adjusted string.

Description

Left adjust a string by removing leading spaces.

public pure function sadjustl_character(self) result(adjusted)

Arguments

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

Return Value character(kind=CK,len=len(self%raw))

Adjusted string.

Description

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

private elemental function sadjustr(self) result(adjusted)

Arguments

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

Return Value type(string)

Adjusted string.

Description

Right adjust a string by removing leading spaces.

public pure function sadjustr_character(self) result(adjusted)

Arguments

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

Return Value character(kind=CK,len=len(self%raw))

Adjusted string.

Description

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

private elemental function scount(self, substring, ignore_isolated) result(No)

Arguments

Type	Intent	Optional		Name
class(string),	intent(in)		::	self	The string.
character(len=*),	intent(in)		::	substring	Substring.
logical,	intent(in),	optional	::	ignore_isolated	Ignore "isolated" occurrences.

Return Value integer

Number of occurrences.

Description

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

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

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.

Description

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.

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

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.

Description

public elemental function sindex_character_string(string_, substring, back) result(i)

Arguments

Type	Intent	Optional		Name
character(kind=CK,len=*),	intent(in)		::	string_	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.

Description

public elemental function slen(self) result(l)

Arguments

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

Return Value integer

String length.

Description

Return the length of a string.

public elemental function slen_trim(self) result(l)

Arguments

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

Return Value integer

String length.

Description

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

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

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.

Description

Concatenates several copies of an input string.

private elemental function srepeat_character_string(self, rstring, ncopies) result(repeated)

Arguments

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

Return Value type(string)

Repeated string.

Description

Concatenates several copies of an input string.

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

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.

Description

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

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

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.

Description

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

public elemental function sscan_character_string(sstring, set, back) result(i)

Arguments

Type	Intent	Optional		Name
character(kind=CK,len=*),	intent(in)		::	sstring	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.

Description

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

public elemental function strim(self) result(trimmed)

Arguments

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

Return Value type(string)

Trimmed string.

Description

Remove leading spaces.

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

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.

Description

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.

private elemental function basedir(self, sep)

Arguments

Type	Intent	Optional	Attributes		Name
class(string),	intent(in)			::	self	The string.
character(kind=CK,len=*),	intent(in),	optional		::	sep	Directory separator.

Return Value type(string)

Base directory name.

Description

Return the base directory name of a string containing a file name.

private elemental function basename(self, sep, extension, strip_last_extension)

Arguments

Type	Intent	Optional		Name
class(string),	intent(in)		::	self	The string.
character(kind=CK,len=*),	intent(in),	optional	::	sep	Directory separator.
character(kind=CK,len=*),	intent(in),	optional	::	extension	File extension.
logical,	intent(in),	optional	::	strip_last_extension	Flag to enable the stripping of last extension.

Return Value type(string)

Base file name.

Description

Return the base file name of a string containing a file name.

private elemental function camelcase(self, sep)

Arguments

Type	Intent	Optional	Attributes		Name
class(string),	intent(in)			::	self	The string.
character(kind=CK,len=*),	intent(in),	optional		::	sep	Separator.

Return Value type(string)

Camel case string.

Description

Return a string with all words capitalized without spaces.

private elemental function capitalize(self) result(capitalized)

Arguments

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

Return Value type(string)

Upper case string.

Description

Return a string with its first character capitalized and the rest lowercased.

private pure function chars(self) result(raw)

Arguments

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

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

Raw characters data.

Description

Return the raw characters data.

private elemental function decode(self, codec) result(decoded)

Arguments

Type	Intent	Optional	Attributes		Name
class(string),	intent(in)			::	self	The string.
character(kind=CK,len=*),	intent(in)			::	codec	Encoding codec.

Return Value type(string)

Decoded string.

Description

Return a string decoded accordingly the codec.

private elemental function encode(self, codec) result(encoded)

Arguments

Type	Intent	Optional	Attributes		Name
class(string),	intent(in)			::	self	The string.
character(kind=CK,len=*),	intent(in)			::	codec	Encoding codec.

Return Value type(string)

Encoded string.

Description

Return a string encoded accordingly the codec.

private elemental function escape(self, to_escape, esc) result(escaped)

Arguments

Type	Intent	Optional		Name
class(string),	intent(in)		::	self	The string.
character(kind=CK,len=1),	intent(in)		::	to_escape	Character to be escaped.
character(kind=CK,len=*),	intent(in),	optional	::	esc	Character used to escape.

Return Value type(string)

Escaped string.

Description

Escape backslashes (or custom escape character).

private elemental function extension(self)

Arguments

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

Return Value type(string)

Extension file name.

Description

Return the extension of a string containing a file name.

private elemental function fill(self, width, right, filling_char) result(filled)

Arguments

Type	Intent	Optional		Name
class(string),	intent(in)		::	self	The string.
integer,	intent(in)		::	width	Final width of filled string.
logical,	intent(in),	optional	::	right	Fill on the right instead of left.
character(kind=CK,len=1),	intent(in),	optional	::	filling_char	Filling character (default "0").

Return Value type(string)

Filled string.

Description

Pad string on the left (or right) with zeros (or other char) to fill width.

private elemental function insert_character(self, substring, pos) result(inserted)

Arguments

Type	Intent		Name
class(string),	intent(in)	::	self	The string.
character(len=*),	intent(in)	::	substring	Substring.
integer,	intent(in)	::	pos	Position from which insert substring.

Return Value type(string)

Inserted string.

Description

Insert substring into string at a specified position.

private elemental function insert_string(self, substring, pos) result(inserted)

Arguments

Type	Intent		Name
class(string),	intent(in)	::	self	The string.
type(string),	intent(in)	::	substring	Substring.
integer,	intent(in)	::	pos	Position from which insert substring.

Return Value type(string)

Inserted string.

Description

Insert substring into string at a specified position.

private pure function join_strings(self, array, sep) result(join)

Arguments

Type	Intent	Optional		Name
class(string),	intent(in)		::	self	The string.
type(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.

Description

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

private pure function join_characters(self, array, sep) result(join)

Arguments

Type	Intent	Optional		Name
class(string),	intent(in)		::	self	The string.
character(kind=CK,len=*),	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.

Description

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

private elemental function lower(self)

Arguments

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

Return Value type(string)

Upper case string.

Description

Return a string with all lowercase characters.

private pure function partition(self, sep) result(partitions)

Arguments

Type	Intent	Optional	Attributes		Name
class(string),	intent(in)			::	self	The string.
character(kind=CK,len=*),	intent(in),	optional		::	sep	Separator.

Return Value type(string) (1:3)

after the separator.

Description

Split string at separator and return the 3 parts (before, the separator and after).

private elemental function replace(self, old, new, count) result(replaced)

Arguments

Type	Intent	Optional		Name
class(string),	intent(in)		::	self	The string.
character(kind=CK,len=*),	intent(in)		::	old	Old substring.
character(kind=CK,len=*),	intent(in)		::	new	New substring.
integer,	intent(in),	optional	::	count	Number of old occurences to be replaced.

Return Value type(string)

The string with old replaced by new.

Description

Return a string with all occurrences of substring old replaced by new.

private elemental function reverse(self) result(reversed)

Arguments

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

Return Value type(string)

The reversed string.

Description

Return a reversed string.

private function search(self, tag_start, tag_end, in_string, in_character, istart, iend) result(tag)

Arguments

Type	Intent	Optional		Name
class(string),	intent(in)		::	self	The string.
character(kind=CK,len=*),	intent(in)		::	tag_start	Start tag.
character(kind=CK,len=*),	intent(in)		::	tag_end	End tag.
type(string),	intent(in),	optional	::	in_string	Search into this string.
character(kind=CK,len=*),	intent(in),	optional	::	in_character	Search into this character string.
integer,	intent(out),	optional	::	istart	Starting index of tag inside the string.
integer,	intent(out),	optional	::	iend	Ending index of tag inside the string.

Return Value type(string)

First tag found.

Description

Search for tagged record into string, return the first record found (if any) matching the tags.

private pure function slice(self, istart, iend) result(raw)

Arguments

Type	Intent		Name
class(string),	intent(in)	::	self	The string.
integer,	intent(in)	::	istart	Slice start index.
integer,	intent(in)	::	iend	Slice end index.

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

Raw characters data.

Description

Return the raw characters data sliced.

private elemental function snakecase(self, sep)

Arguments

Type	Intent	Optional	Attributes		Name
class(string),	intent(in)			::	self	The string.
character(kind=CK,len=*),	intent(in),	optional		::	sep	Separator.

Return Value type(string)

Snake case string.

Description

Return a string with all words lowercase separated by "_".

private elemental function startcase(self, sep)

Arguments

Type	Intent	Optional	Attributes		Name
class(string),	intent(in)			::	self	The string.
character(kind=CK,len=*),	intent(in),	optional		::	sep	Separator.

Return Value type(string)

Start case string.

Description

Return a string with all words capitalized, e.g. title case.

private elemental function strip(self, remove_nulls)

Arguments

Type	Intent	Optional	Attributes		Name
class(string),	intent(in)			::	self	The string.
logical,	intent(in),	optional		::	remove_nulls	Remove null characters at the end.

Return Value type(string)

The stripped string.

Description

Return a copy of the string with the leading and trailing characters removed.

private elemental function swapcase(self)

Arguments

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

Return Value type(string)

Upper case string.

Description

Return a copy of the string with uppercase characters converted to lowercase and vice versa.

private elemental function to_integer_I1P(self, kind) result(to_number)

Arguments

Type	Intent	Optional	Attributes		Name
class(string),	intent(in)			::	self	The string.
integer(kind=I1P),	intent(in)			::	kind	Mold parameter for kind detection.

Return Value integer(kind=I1P)

The number into the string.

Description

Cast string to integer (I1P).

private elemental function to_integer_I2P(self, kind) result(to_number)

Arguments

Type	Intent	Optional	Attributes		Name
class(string),	intent(in)			::	self	The string.
integer(kind=I2P),	intent(in)			::	kind	Mold parameter for kind detection.

Return Value integer(kind=I2P)

The number into the string.

Description

Cast string to integer (I2P).

private elemental function to_integer_I4P(self, kind) result(to_number)

Arguments

Type	Intent	Optional	Attributes		Name
class(string),	intent(in)			::	self	The string.
integer(kind=I4P),	intent(in)			::	kind	Mold parameter for kind detection.

Return Value integer(kind=I4P)

The number into the string.

Description

Cast string to integer (I4P).

private elemental function to_integer_I8P(self, kind) result(to_number)

Arguments

Type	Intent	Optional	Attributes		Name
class(string),	intent(in)			::	self	The string.
integer(kind=I8P),	intent(in)			::	kind	Mold parameter for kind detection.

Return Value integer(kind=I8P)

The number into the string.

Description

Cast string to integer (I8P).

private elemental function to_real_R4P(self, kind) result(to_number)

Arguments

Type	Intent	Optional	Attributes		Name
class(string),	intent(in)			::	self	The string.
real(kind=R4P),	intent(in)			::	kind	Mold parameter for kind detection.

Return Value real(kind=R4P)

The number into the string.

Description

Cast string to real (R4P).

private elemental function to_real_R8P(self, kind) result(to_number)

Arguments

Type	Intent	Optional	Attributes		Name
class(string),	intent(in)			::	self	The string.
real(kind=R8P),	intent(in)			::	kind	Mold parameter for kind detection.

Return Value real(kind=R8P)

The number into the string.

Description

Cast string to real (R8P).

private elemental function to_real_R16P(self, kind) result(to_number)

Arguments

Type	Intent	Optional	Attributes		Name
class(string),	intent(in)			::	self	The string.
real(kind=R16P),	intent(in)			::	kind	Mold parameter for kind detection.

Return Value real(kind=R16P)

The number into the string.

Description

Cast string to real (R16P).

private elemental function unescape(self, to_unescape, unesc) result(unescaped)

Arguments

Type	Intent	Optional		Name
class(string),	intent(in)		::	self	The string.
character(kind=CK,len=1),	intent(in)		::	to_unescape	Character to be unescaped.
character(kind=CK,len=*),	intent(in),	optional	::	unesc	Character used to unescape.

Return Value type(string)

Escaped string.

Description

Unescape double backslashes (or custom escaped character).

private elemental function unique(self, substring) result(uniq)

Arguments

Type	Intent	Optional	Attributes		Name
class(string),	intent(in)			::	self	The string.
character(kind=CK,len=*),	intent(in),	optional		::	substring	Substring which multiple occurences must be reduced to one.

Return Value type(string)

String parsed.

Description

Reduce to one (unique) multiple (sequential) occurrences of a substring into a string.

private elemental function upper(self)

Arguments

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

Return Value type(string)

Upper case string.

Description

Return a string with all uppercase characters.

private elemental function end_with(self, suffix, start, end)

Arguments

Type	Intent	Optional		Name
class(string),	intent(in)		::	self	The string.
character(kind=CK,len=*),	intent(in)		::	suffix	Searched suffix.
integer,	intent(in),	optional	::	start	Start position into the string.
integer,	intent(in),	optional	::	end	End position into the string.

Return Value logical

Result of the test.

Description

Return true if a string ends with a specified suffix.

private elemental function is_allocated(self)

Arguments

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

Return Value logical

Result of the test.

Description

Return true if the string is allocated.

private elemental function is_digit(self)

Arguments

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

Return Value logical

Result of the test.

Description

Return true if all characters in the string are digits.

private elemental function is_integer(self, allow_spaces)

Arguments

Type	Intent	Optional	Attributes		Name
class(string),	intent(in)			::	self	The string.
logical,	intent(in),	optional		::	allow_spaces	Allow leading-trailing spaces.

Return Value logical

Result of the test.

Description

Return true if the string contains an integer.

private elemental function is_lower(self)

Arguments

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

Return Value logical

Result of the test.

Description

Return true if all characters in the string are lowercase.

private elemental function is_number(self, allow_spaces)

Arguments

Type	Intent	Optional	Attributes		Name
class(string),	intent(in)			::	self	The string.
logical,	intent(in),	optional		::	allow_spaces	Allow leading-trailing spaces.

Return Value logical

Result of the test.

Description

Return true if the string contains a number (real or integer).

private elemental function is_real(self, allow_spaces)

Arguments

Type	Intent	Optional	Attributes		Name
class(string),	intent(in)			::	self	The string.
logical,	intent(in),	optional		::	allow_spaces	Allow leading-trailing spaces.

Return Value logical

Result of the test.

Description

Return true if the string contains a real.

private elemental function is_upper(self)

Arguments

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

Return Value logical

Result of the test.

Description

Return true if all characters in the string are uppercase.

private elemental function start_with(self, prefix, start, end)

Arguments

Type	Intent	Optional		Name
class(string),	intent(in)		::	self	The string.
character(kind=CK,len=*),	intent(in)		::	prefix	Searched prefix.
integer,	intent(in),	optional	::	start	Start position into the string.
integer,	intent(in),	optional	::	end	End position into the string.

Return Value logical

Result of the test.

Description

Return true if a string starts with a specified prefix.

private pure function string_concat_string(lhs, rhs) result(concat)

Arguments

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

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

Concatenated string.

Description

Concatenation with string.

private pure function string_concat_character(lhs, rhs) result(concat)

Arguments

Type	Intent	Optional	Attributes		Name
class(string),	intent(in)			::	lhs	Left hand side.
character(kind=CK,len=*),	intent(in)			::	rhs	Right hand side.

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

Concatenated string.

Description

Concatenation with character.

private pure function character_concat_string(lhs, rhs) result(concat)

Arguments

Type	Intent	Optional	Attributes		Name
character(kind=CK,len=*),	intent(in)			::	lhs	Left hand side.
class(string),	intent(in)			::	rhs	Right hand side.

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

Concatenated string.

Description

Concatenation with character (inverted).

private elemental function string_concat_string_string(lhs, rhs) result(concat)

Arguments

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

Return Value type(string)

Concatenated string.

Description

Concatenation with string.

private elemental function string_concat_character_string(lhs, rhs) result(concat)

Arguments

Type	Intent	Optional	Attributes		Name
class(string),	intent(in)			::	lhs	Left hand side.
character(kind=CK,len=*),	intent(in)			::	rhs	Right hand side.

Return Value type(string)

Concatenated string.

Description

Concatenation with character.

private elemental function character_concat_string_string(lhs, rhs) result(concat)

Arguments

Type	Intent	Optional	Attributes		Name
character(kind=CK,len=*),	intent(in)			::	lhs	Left hand side.
class(string),	intent(in)			::	rhs	Right hand side.

Return Value type(string)

Concatenated string.

Description

Concatenation with character (inverted).

private elemental function string_eq_string(lhs, rhs) result(is_it)

Arguments

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

Return Value logical

Opreator test result.

Description

Equal to string logical operator.

private elemental function string_eq_character(lhs, rhs) result(is_it)

Arguments

Type	Intent	Optional	Attributes		Name
class(string),	intent(in)			::	lhs	Left hand side.
character(kind=CK,len=*),	intent(in)			::	rhs	Right hand side.

Return Value logical

Opreator test result.

Description

Equal to character logical operator.

private elemental function character_eq_string(lhs, rhs) result(is_it)

Arguments

Type	Intent	Optional	Attributes		Name
character(kind=CK,len=*),	intent(in)			::	lhs	Left hand side.
class(string),	intent(in)			::	rhs	Right hand side.

Return Value logical

Opreator test result.

Description

Equal to character (inverted) logical operator.

private elemental function string_ne_string(lhs, rhs) result(is_it)

Arguments

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

Return Value logical

Opreator test result.

Description

Not equal to string logical operator.

private elemental function string_ne_character(lhs, rhs) result(is_it)

Arguments

Type	Intent	Optional	Attributes		Name
class(string),	intent(in)			::	lhs	Left hand side.
character(kind=CK,len=*),	intent(in)			::	rhs	Right hand side.

Return Value logical

Opreator test result.

Description

Not equal to character logical operator.

private elemental function character_ne_string(lhs, rhs) result(is_it)

Arguments

Type	Intent	Optional	Attributes		Name
character(kind=CK,len=*),	intent(in)			::	lhs	Left hand side.
class(string),	intent(in)			::	rhs	Right hand side.

Return Value logical

Opreator test result.

Description

Not equal to character (inverted) logical operator.

private elemental function string_lt_string(lhs, rhs) result(is_it)

Arguments

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

Return Value logical

Opreator test result.

Description

Lower than to string logical operator.

private elemental function string_lt_character(lhs, rhs) result(is_it)

Arguments

Type	Intent	Optional	Attributes		Name
class(string),	intent(in)			::	lhs	Left hand side.
character(kind=CK,len=*),	intent(in)			::	rhs	Right hand side.

Return Value logical

Opreator test result.

Description

Lower than to character logical operator.

private elemental function character_lt_string(lhs, rhs) result(is_it)

Arguments

Type	Intent	Optional	Attributes		Name
character(kind=CK,len=*),	intent(in)			::	lhs	Left hand side.
class(string),	intent(in)			::	rhs	Right hand side.

Return Value logical

Opreator test result.

Description

Lower than to character (inverted) logical operator.

private elemental function string_le_string(lhs, rhs) result(is_it)

Arguments

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

Return Value logical

Opreator test result.

Description

Lower equal than to string logical operator.

private elemental function string_le_character(lhs, rhs) result(is_it)

Arguments

Type	Intent	Optional	Attributes		Name
class(string),	intent(in)			::	lhs	Left hand side.
character(kind=CK,len=*),	intent(in)			::	rhs	Right hand side.

Return Value logical

Opreator test result.

Description

Lower equal than to character logical operator.

private elemental function character_le_string(lhs, rhs) result(is_it)

Arguments

Type	Intent	Optional	Attributes		Name
character(kind=CK,len=*),	intent(in)			::	lhs	Left hand side.
class(string),	intent(in)			::	rhs	Right hand side.

Return Value logical

Opreator test result.

Description

Lower equal than to character (inverted) logical operator.

private elemental function string_ge_string(lhs, rhs) result(is_it)

Arguments

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

Return Value logical

Opreator test result.

Description

Greater equal than to string logical operator.

private elemental function string_ge_character(lhs, rhs) result(is_it)

Arguments

Type	Intent	Optional	Attributes		Name
class(string),	intent(in)			::	lhs	Left hand side.
character(kind=CK,len=*),	intent(in)			::	rhs	Right hand side.

Return Value logical

Opreator test result.

Description

Greater equal than to character logical operator.

private elemental function character_ge_string(lhs, rhs) result(is_it)

Arguments

Type	Intent	Optional	Attributes		Name
character(kind=CK,len=*),	intent(in)			::	lhs	Left hand side.
class(string),	intent(in)			::	rhs	Right hand side.

Return Value logical

Opreator test result.

Description

Greater equal than to character (inverted) logical operator.

private elemental function string_gt_string(lhs, rhs) result(is_it)

Arguments

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

Return Value logical

Opreator test result.

Description

Greater than to string logical operator.

private elemental function string_gt_character(lhs, rhs) result(is_it)

Arguments

Type	Intent	Optional	Attributes		Name
class(string),	intent(in)			::	lhs	Left hand side.
character(kind=CK,len=*),	intent(in)			::	rhs	Right hand side.

Return Value logical

Opreator test result.

Description

Greater than to character logical operator.

private elemental function character_gt_string(lhs, rhs) result(is_it)

Arguments

Type	Intent	Optional	Attributes		Name
character(kind=CK,len=*),	intent(in)			::	lhs	Left hand side.
class(string),	intent(in)			::	rhs	Right hand side.

Return Value logical

Opreator test result.

Description

Greater than to character (inverted) logical operator.

private elemental function replace_one_occurrence(self, old, new) result(replaced)

Arguments

Type	Intent		Name
class(string),	intent(in)	::	self	The string.
character(kind=CK,len=*),	intent(in)	::	old	Old substring.
character(kind=CK,len=*),	intent(in)	::	new	New substring.

Return Value type(string)

The string with old replaced by new.

Description

Return a string with the first occurrence of substring old replaced by new.

Subroutines

private elemental subroutine free(self)

Arguments

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

Description

Free dynamic memory.

private subroutine read_file(self, file, form, iostat, iomsg)

Arguments

Type	Intent	Optional		Name
class(string),	intent(inout)		::	self	The string.
character(len=*),	intent(in)		::	file	File name.
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.

Description

Read a file as a single string stream.

private subroutine read_line(self, unit, form, iostat, iomsg)

Arguments

Type	Intent	Optional		Name
class(string),	intent(inout)		::	self	The string.
integer,	intent(in)		::	unit	Logical unit.
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.

Description

Read line (record) from a connected unit.

private subroutine read_lines(self, unit, form, iostat, iomsg)

Arguments

Type	Intent	Optional		Name
class(string),	intent(inout)		::	self	The string.
integer,	intent(in)		::	unit	Logical unit.
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.

Description

Read (all) lines (records) from a connected unit as a single ascii stream.

private pure subroutine split(self, tokens, sep)

Arguments

Type	Intent	Optional	Attributes		Name
class(string),	intent(in)			::	self	The string.
type(string),	intent(out),		allocatable	::	tokens(:)	Tokens substring.
character(kind=CK,len=*),	intent(in),	optional		::	sep	Separator.

Description

Return a list of substring in the string, using sep as the delimiter string.

private subroutine write_file(self, file, form, iostat, iomsg)

Arguments

Type	Intent	Optional		Name
class(string),	intent(in)		::	self	The string.
character(len=*),	intent(in)		::	file	File name.
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.

Description

Write a single string stream into file.

private subroutine write_line(self, unit, form, iostat, iomsg)

Arguments

Type	Intent	Optional		Name
class(string),	intent(in)		::	self	The string.
integer,	intent(in)		::	unit	Logical unit.
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.

Description

Write line (record) to a connected unit.

private subroutine write_lines(self, unit, form, iostat, iomsg)

Arguments

Type	Intent	Optional		Name
class(string),	intent(in)		::	self	The string.
integer,	intent(in)		::	unit	Logical unit.
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.

Description

Write lines (records) to a connected unit.

private elemental subroutine string_assign_string(lhs, rhs)

Arguments

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

Description

Assignment operator from string input.

private elemental subroutine string_assign_character(lhs, rhs)

Arguments

Type	Intent	Optional	Attributes		Name
class(string),	intent(inout)			::	lhs	Left hand side.
character(kind=CK,len=*),	intent(in)			::	rhs	Right hand side.

Description

Assignment operator from character input.