Skip to content

foxy_xml_index ​

Source: src/third_party/FoXy/src/lib/foxy_xml_index.f90

Dependencies

Contents ​

Variables ​

NameTypeAttributesDescription
FILE_CHUNK_SIZEinteger(kind=I8P)parameter
INITIAL_CAPACITYinteger(kind=I4P)parameter

Derived Types ​

xml_index ​

Components ​

NameTypeAttributesDescription
tagtype(xml_tag)allocatable
lastinteger(kind=I8P)allocatable
ntinteger(kind=I4P)
filenamecharacter(len=:)allocatable
stop_posinteger(kind=I8P)

Type-Bound Procedures ​

NameAttributesDescription
attributepass(self)
attribute_namepass(self)
attributes_numberpass(self)
childrenpass(self)
contentpass(self)
content_rangepass(self)
findpass(self)
find_allpass(self)
selectpass(self)
freepass(self)
get_attribute
get_content
levelpass(self)
local_namepass(self)
matchingpass(self)
namepass(self)
namespacepass(self)
parentpass(self)
prefixpass(self)
scanpass(self)
stop_positionpass(self)
tags_numberpass(self)
text_rangepass(self)
attribute_textpass(self)
content_textpass(self)
get_attribute_I1Ppass(self)
get_attribute_I2Ppass(self)
get_attribute_I4Ppass(self)
get_attribute_I8Ppass(self)
get_attribute_R4Ppass(self)
get_attribute_R8Ppass(self)
get_attribute_logicalpass(self)
get_attribute_I1P_1pass(self)
get_attribute_I2P_1pass(self)
get_attribute_I4P_1pass(self)
get_attribute_I8P_1pass(self)
get_attribute_R4P_1pass(self)
get_attribute_R8P_1pass(self)
get_content_I1Ppass(self)
get_content_I2Ppass(self)
get_content_I4Ppass(self)
get_content_I8Ppass(self)
get_content_R4Ppass(self)
get_content_R8Ppass(self)
get_content_logicalpass(self)
get_content_I1P_1pass(self)
get_content_I2P_1pass(self)
get_content_I4P_1pass(self)
get_content_I8P_1pass(self)
get_content_R4P_1pass(self)
get_content_R8P_1pass(self)

index_builder ​

Inheritance

Extends: xml_builder

Components ​

NameTypeAttributesDescription
is_stoppedlogical
tagtype(xml_tag)allocatable
lastinteger(kind=I8P)allocatable
ntinteger(kind=I4P)
sanitizelogical
stop_atcharacter(len=:)allocatable
stop_posinteger(kind=I8P)
first_problemcharacter(len=:)allocatable
problem_posinteger(kind=I8P)

Type-Bound Procedures ​

NameAttributesDescription
start_tagpass(self)
attributepass(self)
start_tag_endpass(self)
end_tagpass(self)
datapass(self)
problempass(self)

Subroutines ​

content_range ​

Attributes: elemental

fortran
subroutine content_range(self, id, first, last)

Arguments

NameTypeIntentAttributesDescription
selfclass(xml_index)in
idinteger(kind=I4P)in
firstinteger(kind=I8P)out
lastinteger(kind=I8P)out

Call graph

free ​

Attributes: elemental

fortran
subroutine free(self)

Arguments

NameTypeIntentAttributesDescription
selfclass(xml_index)inout

scan_file ​

fortran
subroutine scan_file(self, filename, stop_at, chunk_size, iostat, iomsg, sanitize_attributes_value)

Arguments

NameTypeIntentAttributesDescription
selfclass(xml_index)inout
filenamecharacter(len=*)in
stop_atcharacter(len=*)inoptional
chunk_sizeinteger(kind=I8P)inoptional
iostatinteger(kind=I4P)outoptional
iomsgcharacter(len=*)inoutoptional
sanitize_attributes_valuelogicalinoptional

Call graph

text_range ​

Attributes: elemental

fortran
subroutine text_range(self, id, first, last)

Arguments

NameTypeIntentAttributesDescription
selfclass(xml_index)in
idinteger(kind=I4P)in
firstinteger(kind=I8P)out
lastinteger(kind=I8P)out

Call graph

attribute_text ​

fortran
subroutine attribute_text(self, id, name, text, iostat, iomsg)

Arguments

NameTypeIntentAttributesDescription
selfclass(xml_index)in
idinteger(kind=I4P)in
namecharacter(len=*)in
textcharacter(len=:)outallocatable
iostatinteger(kind=I4P)out
iomsgcharacter(len=:)outallocatable

Call graph

content_text ​

fortran
subroutine content_text(self, id, text, iostat, iomsg)

Arguments

NameTypeIntentAttributesDescription
selfclass(xml_index)in
idinteger(kind=I4P)in
textcharacter(len=:)outallocatable
iostatinteger(kind=I4P)out
iomsgcharacter(len=:)outallocatable

Call graph

get_attribute_I1P ​

fortran
subroutine get_attribute_I1P(self, id, name, value, iostat, iomsg)

Arguments

NameTypeIntentAttributesDescription
selfclass(xml_index)in
idinteger(kind=I4P)in
namecharacter(len=*)in
valueinteger(kind=I1P)inout
iostatinteger(kind=I4P)outoptional
iomsgcharacter(len=*)inoutoptional

Call graph

get_attribute_I2P ​

fortran
subroutine get_attribute_I2P(self, id, name, value, iostat, iomsg)

Arguments

NameTypeIntentAttributesDescription
selfclass(xml_index)in
idinteger(kind=I4P)in
namecharacter(len=*)in
valueinteger(kind=I2P)inout
iostatinteger(kind=I4P)outoptional
iomsgcharacter(len=*)inoutoptional

Call graph

get_attribute_I4P ​

fortran
subroutine get_attribute_I4P(self, id, name, value, iostat, iomsg)

Arguments

NameTypeIntentAttributesDescription
selfclass(xml_index)in
idinteger(kind=I4P)in
namecharacter(len=*)in
valueinteger(kind=I4P)inout
iostatinteger(kind=I4P)outoptional
iomsgcharacter(len=*)inoutoptional

Call graph

get_attribute_I8P ​

fortran
subroutine get_attribute_I8P(self, id, name, value, iostat, iomsg)

Arguments

NameTypeIntentAttributesDescription
selfclass(xml_index)in
idinteger(kind=I4P)in
namecharacter(len=*)in
valueinteger(kind=I8P)inout
iostatinteger(kind=I4P)outoptional
iomsgcharacter(len=*)inoutoptional

Call graph

get_attribute_R4P ​

fortran
subroutine get_attribute_R4P(self, id, name, value, iostat, iomsg)

Arguments

NameTypeIntentAttributesDescription
selfclass(xml_index)in
idinteger(kind=I4P)in
namecharacter(len=*)in
valuereal(kind=R4P)inout
iostatinteger(kind=I4P)outoptional
iomsgcharacter(len=*)inoutoptional

Call graph

get_attribute_R8P ​

fortran
subroutine get_attribute_R8P(self, id, name, value, iostat, iomsg)

Arguments

NameTypeIntentAttributesDescription
selfclass(xml_index)in
idinteger(kind=I4P)in
namecharacter(len=*)in
valuereal(kind=R8P)inout
iostatinteger(kind=I4P)outoptional
iomsgcharacter(len=*)inoutoptional

Call graph

get_attribute_logical ​

fortran
subroutine get_attribute_logical(self, id, name, value, iostat, iomsg)

Arguments

NameTypeIntentAttributesDescription
selfclass(xml_index)in
idinteger(kind=I4P)in
namecharacter(len=*)in
valuelogicalinout
iostatinteger(kind=I4P)outoptional
iomsgcharacter(len=*)inoutoptional

Call graph

get_attribute_I1P_1 ​

fortran
subroutine get_attribute_I1P_1(self, id, name, values, iostat, iomsg)

Arguments

NameTypeIntentAttributesDescription
selfclass(xml_index)in
idinteger(kind=I4P)in
namecharacter(len=*)in
valuesinteger(kind=I1P)outallocatable
iostatinteger(kind=I4P)outoptional
iomsgcharacter(len=*)inoutoptional

Call graph

get_attribute_I2P_1 ​

fortran
subroutine get_attribute_I2P_1(self, id, name, values, iostat, iomsg)

Arguments

NameTypeIntentAttributesDescription
selfclass(xml_index)in
idinteger(kind=I4P)in
namecharacter(len=*)in
valuesinteger(kind=I2P)outallocatable
iostatinteger(kind=I4P)outoptional
iomsgcharacter(len=*)inoutoptional

Call graph

get_attribute_I4P_1 ​

fortran
subroutine get_attribute_I4P_1(self, id, name, values, iostat, iomsg)

Arguments

NameTypeIntentAttributesDescription
selfclass(xml_index)in
idinteger(kind=I4P)in
namecharacter(len=*)in
valuesinteger(kind=I4P)outallocatable
iostatinteger(kind=I4P)outoptional
iomsgcharacter(len=*)inoutoptional

Call graph

get_attribute_I8P_1 ​

fortran
subroutine get_attribute_I8P_1(self, id, name, values, iostat, iomsg)

Arguments

NameTypeIntentAttributesDescription
selfclass(xml_index)in
idinteger(kind=I4P)in
namecharacter(len=*)in
valuesinteger(kind=I8P)outallocatable
iostatinteger(kind=I4P)outoptional
iomsgcharacter(len=*)inoutoptional

Call graph

get_attribute_R4P_1 ​

fortran
subroutine get_attribute_R4P_1(self, id, name, values, iostat, iomsg)

Arguments

NameTypeIntentAttributesDescription
selfclass(xml_index)in
idinteger(kind=I4P)in
namecharacter(len=*)in
valuesreal(kind=R4P)outallocatable
iostatinteger(kind=I4P)outoptional
iomsgcharacter(len=*)inoutoptional

Call graph

get_attribute_R8P_1 ​

fortran
subroutine get_attribute_R8P_1(self, id, name, values, iostat, iomsg)

Arguments

NameTypeIntentAttributesDescription
selfclass(xml_index)in
idinteger(kind=I4P)in
namecharacter(len=*)in
valuesreal(kind=R8P)outallocatable
iostatinteger(kind=I4P)outoptional
iomsgcharacter(len=*)inoutoptional

Call graph

get_content_I1P ​

fortran
subroutine get_content_I1P(self, id, value, iostat, iomsg)

Arguments

NameTypeIntentAttributesDescription
selfclass(xml_index)in
idinteger(kind=I4P)in
valueinteger(kind=I1P)inout
iostatinteger(kind=I4P)outoptional
iomsgcharacter(len=*)inoutoptional

Call graph

get_content_I2P ​

fortran
subroutine get_content_I2P(self, id, value, iostat, iomsg)

Arguments

NameTypeIntentAttributesDescription
selfclass(xml_index)in
idinteger(kind=I4P)in
valueinteger(kind=I2P)inout
iostatinteger(kind=I4P)outoptional
iomsgcharacter(len=*)inoutoptional

Call graph

get_content_I4P ​

fortran
subroutine get_content_I4P(self, id, value, iostat, iomsg)

Arguments

NameTypeIntentAttributesDescription
selfclass(xml_index)in
idinteger(kind=I4P)in
valueinteger(kind=I4P)inout
iostatinteger(kind=I4P)outoptional
iomsgcharacter(len=*)inoutoptional

Call graph

get_content_I8P ​

fortran
subroutine get_content_I8P(self, id, value, iostat, iomsg)

Arguments

NameTypeIntentAttributesDescription
selfclass(xml_index)in
idinteger(kind=I4P)in
valueinteger(kind=I8P)inout
iostatinteger(kind=I4P)outoptional
iomsgcharacter(len=*)inoutoptional

Call graph

get_content_R4P ​

fortran
subroutine get_content_R4P(self, id, value, iostat, iomsg)

Arguments

NameTypeIntentAttributesDescription
selfclass(xml_index)in
idinteger(kind=I4P)in
valuereal(kind=R4P)inout
iostatinteger(kind=I4P)outoptional
iomsgcharacter(len=*)inoutoptional

Call graph

get_content_R8P ​

fortran
subroutine get_content_R8P(self, id, value, iostat, iomsg)

Arguments

NameTypeIntentAttributesDescription
selfclass(xml_index)in
idinteger(kind=I4P)in
valuereal(kind=R8P)inout
iostatinteger(kind=I4P)outoptional
iomsgcharacter(len=*)inoutoptional

Call graph

get_content_logical ​

fortran
subroutine get_content_logical(self, id, value, iostat, iomsg)

Arguments

NameTypeIntentAttributesDescription
selfclass(xml_index)in
idinteger(kind=I4P)in
valuelogicalinout
iostatinteger(kind=I4P)outoptional
iomsgcharacter(len=*)inoutoptional

Call graph

get_content_I1P_1 ​

fortran
subroutine get_content_I1P_1(self, id, values, iostat, iomsg)

Arguments

NameTypeIntentAttributesDescription
selfclass(xml_index)in
idinteger(kind=I4P)in
valuesinteger(kind=I1P)outallocatable
iostatinteger(kind=I4P)outoptional
iomsgcharacter(len=*)inoutoptional

Call graph

get_content_I2P_1 ​

fortran
subroutine get_content_I2P_1(self, id, values, iostat, iomsg)

Arguments

NameTypeIntentAttributesDescription
selfclass(xml_index)in
idinteger(kind=I4P)in
valuesinteger(kind=I2P)outallocatable
iostatinteger(kind=I4P)outoptional
iomsgcharacter(len=*)inoutoptional

Call graph

get_content_I4P_1 ​

fortran
subroutine get_content_I4P_1(self, id, values, iostat, iomsg)

Arguments

NameTypeIntentAttributesDescription
selfclass(xml_index)in
idinteger(kind=I4P)in
valuesinteger(kind=I4P)outallocatable
iostatinteger(kind=I4P)outoptional
iomsgcharacter(len=*)inoutoptional

Call graph

get_content_I8P_1 ​

fortran
subroutine get_content_I8P_1(self, id, values, iostat, iomsg)

Arguments

NameTypeIntentAttributesDescription
selfclass(xml_index)in
idinteger(kind=I4P)in
valuesinteger(kind=I8P)outallocatable
iostatinteger(kind=I4P)outoptional
iomsgcharacter(len=*)inoutoptional

Call graph

get_content_R4P_1 ​

fortran
subroutine get_content_R4P_1(self, id, values, iostat, iomsg)

Arguments

NameTypeIntentAttributesDescription
selfclass(xml_index)in
idinteger(kind=I4P)in
valuesreal(kind=R4P)outallocatable
iostatinteger(kind=I4P)outoptional
iomsgcharacter(len=*)inoutoptional

Call graph

get_content_R8P_1 ​

fortran
subroutine get_content_R8P_1(self, id, values, iostat, iomsg)

Arguments

NameTypeIntentAttributesDescription
selfclass(xml_index)in
idinteger(kind=I4P)in
valuesreal(kind=R8P)outallocatable
iostatinteger(kind=I4P)outoptional
iomsgcharacter(len=*)inoutoptional

Call graph

index_start_tag ​

Attributes: pure

fortran
subroutine index_start_tag(self, id, parent_id, level, name, start)

Arguments

NameTypeIntentAttributesDescription
selfclass(index_builder)inout
idinteger(kind=I4P)in
parent_idinteger(kind=I4P)in
levelinteger(kind=I4P)in
namecharacter(len=*)in
startinteger(kind=I8P)in

Call graph

index_attribute ​

Attributes: pure

fortran
subroutine index_attribute(self, id, name, value)

Arguments

NameTypeIntentAttributesDescription
selfclass(index_builder)inout
idinteger(kind=I4P)in
namecharacter(len=*)in
valuecharacter(len=*)in

Call graph

index_start_tag_end ​

Attributes: pure

fortran
subroutine index_start_tag_end(self, id, start, open_end, is_self_closing)

Arguments

NameTypeIntentAttributesDescription
selfclass(index_builder)inout
idinteger(kind=I4P)in
startinteger(kind=I8P)in
open_endinteger(kind=I8P)in
is_self_closinglogicalin

Call graph

index_end_tag ​

Attributes: pure

fortran
subroutine index_end_tag(self, id, start, open_end, end_start, end_end)

Arguments

NameTypeIntentAttributesDescription
selfclass(index_builder)inout
idinteger(kind=I4P)in
startinteger(kind=I8P)in
open_endinteger(kind=I8P)in
end_startinteger(kind=I8P)in
end_endinteger(kind=I8P)in

Call graph

index_data ​

Attributes: pure

fortran
subroutine index_data(self, kind, chars, first)

Arguments

NameTypeIntentAttributesDescription
selfclass(index_builder)inout
kindinteger(kind=I4P)in
charscharacter(len=*)in
firstinteger(kind=I8P)in

index_problem ​

Attributes: pure

fortran
subroutine index_problem(self, pos, message)

Arguments

NameTypeIntentAttributesDescription
selfclass(index_builder)inout
posinteger(kind=I8P)in
messagecharacter(len=*)in

Functions ​

attribute_name ​

Attributes: pure

Returns: character(len=:)

fortran
function attribute_name(self, id, a) result(name)

Arguments

NameTypeIntentAttributesDescription
selfclass(xml_index)in
idinteger(kind=I4P)in
ainteger(kind=I4P)in

Call graph

attributes_number ​

Attributes: pure

Returns: integer(kind=I4P)

fortran
function attributes_number(self, id) result(number)

Arguments

NameTypeIntentAttributesDescription
selfclass(xml_index)in
idinteger(kind=I4P)in

Call graph

tags_number ​

Attributes: elemental

Returns: integer(kind=I4P)

fortran
function tags_number(self) result(number)

Arguments

NameTypeIntentAttributesDescription
selfclass(xml_index)in

attribute ​

Attributes: pure

Returns: character(len=:)

fortran
function attribute(self, id, name) result(value)

Arguments

NameTypeIntentAttributesDescription
selfclass(xml_index)in
idinteger(kind=I4P)in
namecharacter(len=*)in

Call graph

children ​

Attributes: pure

Returns: integer(kind=I4P)

fortran
function children(self, id) result(ids)

Arguments

NameTypeIntentAttributesDescription
selfclass(xml_index)in
idinteger(kind=I4P)in

Call graph

content ​

Returns: character(len=:)

fortran
function content(self, id, iostat, iomsg) result(value)

Arguments

NameTypeIntentAttributesDescription
selfclass(xml_index)in
idinteger(kind=I4P)in
iostatinteger(kind=I4P)outoptional
iomsgcharacter(len=*)inoutoptional

Call graph

find ​

Attributes: pure

Returns: integer(kind=I4P)

fortran
function find(self, name, path, parent, namespaces) result(id)

Arguments

NameTypeIntentAttributesDescription
selfclass(xml_index)in
namecharacter(len=*)inoptional
pathcharacter(len=*)inoptional
parentinteger(kind=I4P)inoptional
namespacescharacter(len=*)inoptional

Call graph

find_all ​

Attributes: pure

Returns: integer(kind=I4P)

fortran
function find_all(self, name, path, parent, namespaces) result(ids)

Arguments

NameTypeIntentAttributesDescription
selfclass(xml_index)in
namecharacter(len=*)inoptional
pathcharacter(len=*)inoptional
parentinteger(kind=I4P)inoptional
namespacescharacter(len=*)inoptional

Call graph

select ​

Returns: integer(kind=I4P)

fortran
function select(self, expression, namespaces, iostat, iomsg) result(ids)

Arguments

NameTypeIntentAttributesDescription
selfclass(xml_index)in
expressioncharacter(len=*)in
namespacescharacter(len=*)inoptional
iostatinteger(kind=I4P)outoptional
iomsgcharacter(len=*)inoutoptional

Call graph

level ​

Attributes: pure

Returns: integer(kind=I4P)

fortran
function level(self, id) result(level_)

Arguments

NameTypeIntentAttributesDescription
selfclass(xml_index)in
idinteger(kind=I4P)in

Call graph

local_name ​

Attributes: pure

Returns: character(len=:)

fortran
function local_name(self, id) result(local_name_)

Arguments

NameTypeIntentAttributesDescription
selfclass(xml_index)in
idinteger(kind=I4P)in

Call graph

matching ​

Attributes: pure

Returns: integer(kind=I4P)

fortran
function matching(self, re, ids, on, attribute, whole) result(matched)

Arguments

NameTypeIntentAttributesDescription
selfclass(xml_index)in
retype(regex)in
idsinteger(kind=I4P)inoptional
oncharacter(len=*)inoptional
attributecharacter(len=*)inoptional
wholelogicalinoptional

Call graph

name ​

Attributes: pure

Returns: character(len=:)

fortran
function name(self, id) result(name_)

Arguments

NameTypeIntentAttributesDescription
selfclass(xml_index)in
idinteger(kind=I4P)in

Call graph

namespace ​

Attributes: pure

Returns: character(len=:)

fortran
function namespace(self, id) result(namespace_)

Arguments

NameTypeIntentAttributesDescription
selfclass(xml_index)in
idinteger(kind=I4P)in

Call graph

parent ​

Attributes: pure

Returns: integer(kind=I4P)

fortran
function parent(self, id) result(parent_)

Arguments

NameTypeIntentAttributesDescription
selfclass(xml_index)in
idinteger(kind=I4P)in

Call graph

prefix ​

Attributes: pure

Returns: character(len=:)

fortran
function prefix(self, id) result(prefix_)

Arguments

NameTypeIntentAttributesDescription
selfclass(xml_index)in
idinteger(kind=I4P)in

Call graph

stop_position ​

Attributes: elemental

Returns: integer(kind=I8P)

fortran
function stop_position(self) result(pos)

Arguments

NameTypeIntentAttributesDescription
selfclass(xml_index)in

Call graph