stdlib_string_class – stdlib

Abstract base class (ABC) specification of an extendible string type to hold an arbitrary character sequence.

A minimal implementation of the string class has to provide only a setter function in form of an assignment from a fixed length character variable and getter functions for returning the whole string, a character at a certain index and a range of characters within the bounds of the character sequence.

The ABC takes care of providing the implementations for all functionality that is intrinsic to character variables in Fortran, therefore an implementation should reexport all overloaded generic interfaces from the ABC. Any string class implementation will be compatibile with the non-extendible string_type and fixed length and deferred length character variables by those means.

Implementations of the string class that are encouraged to overwrite the type bound procedures providing those functionality in the ABC with optimized algorithms suitable for their respective representation of the character sequence.

The specification of this module is available here.

Uses

- stdlib_string_type

Interfaces

adjustl adjustr char iachar ichar index len len_trim lge lgt lle llt repeat scan trim verify

Derived Types

string_class

Interfaces

public interface adjustl

Left-adjust the character sequence represented by the string. The length of the character sequence remains unchanged.

Type	Intent	Optional	Attributes		Name
class(string_class),	intent(in)			::	string
integer,	intent(in)			::	pos

Type	Intent	Optional		Name
type(string_type),	intent(in)		::	string
class(string_class),	intent(in)		::	substring
logical,	intent(in),	optional	::	back

Type	Intent	Optional		Name
character(len=*),	intent(in)		::	string
class(string_class),	intent(in)		::	substring
logical,	intent(in),	optional	::	back

Type	Intent	Optional	Attributes		Name
class(string_class),	intent(in)			::	lhs
class(string_class),	intent(in)			::	rhs

procedure(assign_object_char_interface), public :: assign_object_char
generic, public :: assignment(=) => assign_object_char	Assign a character sequence to a string object.
generic, public :: assignment(=) => assign_object_string	Assign a string type to a string object.
generic, public :: assignment(=) => assign_object_object	Assign a string type to a string object.
procedure(get_char_interface), public :: get_char	Return the character sequence represented by the string.
procedure(get_char_pos_interface), public :: get_char_pos	Return the character sequence represented by the string.
procedure(get_char_range_interface), public :: get_char_range	Return the character sequence represented by the string.
procedure(get_int_interface), public :: get_len	Returns the length of the character sequence represented by the string.
procedure(get_int_interface), public :: get_len_trim	Returns the length of the character sequence without trailing spaces represented by the string.
generic, public :: operator(//) => concat_object_object, concat_object_string, concat_string_object, concat_object_char, concat_char_object	Compare two character sequences for inequality.
generic, public :: operator(/=) => ne_object_object, ne_object_string, ne_string_object, ne_object_char, ne_char_object	Compare two character sequences for inequality.
generic, public :: operator(<) => lt_object_object, lt_object_string, lt_string_object, lt_object_char, lt_char_object	Compare two character sequences for being less.
generic, public :: operator(<=) => le_object_object, le_object_string, le_string_object, le_object_char, le_char_object	Compare two character sequences for being less or equal.
generic, public :: operator(==) => eq_object_object, eq_object_string, eq_string_object, eq_object_char, eq_char_object	Compare two character sequences for equality.
generic, public :: operator(>) => gt_object_object, gt_object_string, gt_string_object, gt_object_char, gt_char_object	Compare two character sequences for being greater.
generic, public :: operator(>=) => ge_object_object, ge_object_string, ge_string_object, ge_object_char, ge_char_object	Compare two character sequences for being greater or equal.
generic, public :: read(formatted) => read_formatted	Read a character sequence from a connected formatted unit into the string.
generic, public :: read(unformatted) => read_unformatted	Read a character sequence from a connected unformatted unit into the string.
generic, public :: write(formatted) => write_formatted	Write the character sequence hold by the string to a connected formatted unit.
generic, public :: write(unformatted) => write_unformatted	Write the character sequence hold by the string to a connected unformatted unit.

stdlib_string_class Module

Contents

Interfaces

Derived Types

Uses

Contents

Interfaces

Derived Types

Interfaces

public interface adjustl

private elemental function adjustl_object(string) result(adjusted_string)

Arguments

Return Value type(string_type)

public interface adjustr

private elemental function adjustr_object(string) result(adjusted_string)

Arguments

Return Value type(string_type)

public interface char

private pure function char_object(string) result(character_string)

Arguments

Return Value character(len=:), allocatable

private elemental function char_object_pos(string, pos) result(character_string)

Arguments

Return Value character(len=1)

private pure function char_object_range(string, start, last) result(character_string)

Arguments

Return Value character(len=last-start+1)

public interface iachar

private elemental function iachar_object(string) result(ich)

Arguments

Return Value integer

public interface ichar

private elemental function ichar_object(string) result(ich)

Arguments

Return Value integer

public interface index

private elemental function index_object_object(string, substring, back) result(pos)

Arguments

Return Value integer

private elemental function index_object_string(string, substring, back) result(pos)

Arguments

Return Value integer

private elemental function index_object_char(string, substring, back) result(pos)

Arguments

Return Value integer

private elemental function index_string_object(string, substring, back) result(pos)

Arguments

Return Value integer

private elemental function index_char_object(string, substring, back) result(pos)

Arguments

Return Value integer

public interface len

private elemental function len_object(string) result(length)

Arguments

Return Value integer

public interface len_trim

private elemental function len_trim_object(string) result(length)

Arguments

Return Value integer

public interface lge

private elemental function lge_object_object(lhs, rhs) result(is_lge)

Arguments

Return Value logical

private elemental function lge_object_string(lhs, rhs) result(is_lge)

Arguments

Return Value logical

private elemental function lge_string_object(lhs, rhs) result(is_lge)

Arguments

Return Value logical

private elemental function lge_object_char(lhs, rhs) result(is_lge)

Arguments

Return Value logical

private elemental function lge_char_object(lhs, rhs) result(is_lge)

Arguments

Return Value logical

public interface lgt

private elemental function lgt_object_object(lhs, rhs) result(is_lgt)

Arguments

Return Value logical

private elemental function lgt_object_string(lhs, rhs) result(is_lgt)