1 XML Document Representation

8.17.0.3

1 XML Document Representation🔗ℹ

class

class xml.Document(~prolog: prolog :: xml.Prolog = xml.Prolog(),

Represents an XML document, which always contains a single element. A document optionally contains a document-type descriptor in the prolog, and it may have miscellaneous comments and processing instructions after the element.

class

class xml.Element(~name: name :: String,

~attributes: attributes :: List.of(xml.Attribute) = [],

~content: content :: List.of(xml.Content) = [],

~srcloc: srcloc :: maybe(xml.SrclocRange) = #false)

class

class xml.Attribute(~name: name :: String,

~value: value :: String || xml.OtherPermitted,

~srcloc: srcloc :: maybe(xml.SrclocRange) = #false)

annotation

xml.Content

An xml.Element represents an XML term of them form <tag…>…</tag>, where name field corresponds to tag, attributes correspond to attributes within <tag…>, and content is the content between <tag…> and </tag>.

The xml.Content annotation recognizes allowed content values:

xml.Text: Text, potentially written with <![CDATA[…]]> or &…;, depending on xml.Text.write_mode.
xml.Entity: Entities written with &…;. See xml.Entity form information about when xml.read produces xml.Entity objects.
xml.Inject: Text, possibly non-conforming, that is written verbatim by xml.write. The xml.read function never produces this form of content.
xml.Comment: A comment written with , produced by xml.read only when xml.current_read_comments is #true.
xml.ProcessingInstruction: A processing instruction written with <?…?>, produced by xml.read only when xml.current_read_processing_instructions is #true.
xml.OtherPermitted: Any other value, but only when xml.current_permissive is #true.

class

class xml.Text(~text: text :: String,

~srcloc: srcloc :: maybe(xml.SrclocRange) = #false,

~write_mode: write_mode :: xml.Text.WriteMode = #'default)

enumeration

enum xml.Text.WriteMode:

default

cdata

entity

Represents text for the content of an xml.Element.

The write_mode field is used by xml.write to select an encoding of the text:

#'default: Text is written using predefined entities as necessary to escape special characters, verbatim otherwise.
#'cdata: Text is written using <![CDATA[…]]>. A xml.Text object can be created with this mode only with text that does not contain a ]]>.
#'cdata: Text is written using an integer entity form &#…;. A xml.Text object can be created with this mode only with text that contains a single character.

class

class xml.Entity(~text: text :: String || xml.EntityInt,

~srcloc: srcloc :: maybe(xml.SrclocRange) = #false)

annotation

xml.EntityInt

Represents entities written with &…; as the content of an xml.Element.

Reading with normalization (see xml.current_read_normalize) produces this form only for symbolic entities, and reading always uses xml.Text instead for the predefined entities &, <, >, ', and ".

class

class xml.Inject(~text: text :: String,

~srcloc: srcloc :: maybe(xml.SrclocRange) = #false)

Represents text as the content of an xml.Element that is written verbatim by xml.write. The text might not conform to XML syntax. A xml.read never produces this form of content.

class

class xml.Comment(~text: text :: String)

class

class xml.ProcessingInstruction(

~target_name: target_name :: String,

~instruction: instruction :: String,

~srcloc: srcloc :: maybe(xml.SrclocRange) = #false

)

annotation

xml.Misc

The xml.Misc annotation recognizes xml.Comment and xml.ProcessingInstruction instances. These values can appear with an xml.Element as content, or they can appear before or after the element of a xml.Document.

xml.Comment represents comment written with . Comments are discarded by xml.read unless xml.current_read_comments is #true.

xml.ProcessingInstruction represents a processing instruction written with <?…?>. Comments are discarded by xml.read unless xml.current_read_processing_instructions is #true.

annotation

xml.OtherPermitted

context parameter

Parameter.def xml.current_permissive :: Any.to_boolean:

#false

When xml.current_permissive is set to #true, then xml.Element content and xml.Attribute values can be anything. Such values can be converted to and from XML syntax objects, but not read or written as XML.

class

class xml.Prolog(~pre_misc: post_misc :: List.of(xml.Misc) = [],

~dtd: dtd :: maybe(xml.DTD) = #false,

~post_misc: pst_misc :: List.of(xml.Misc) = [])

class

class xml.DTD(~name: name :: String,

~system: system :: String,

~public: public :: maybe(String) = #false)

Represents metadata for an XML document.

class

class xml.SrclocRange(start :: Srcloc, end :: Srcloc)

Represents the source location of an element, attribute, or content in an XML document. The start source location has a Srcloc.span value to capture the difference between the start and end source locations for an XML component, but end provides additional information about the ending line and column.

1	XML Document Representation
2	Reading and Writing XML
3	XML Syntax Objects