object
xml
¶
Bi-directional XML parser.
static, context_switching_calls
(no dependencies on other entities)
Public interface¶
parse/2
¶
Parses Chars to/from a data structure of the form xml(<atts>, <content>).
static
parse(Chars,Document)
parse(+nonvar,?nonvar)
- zero_or_one
parse(?nonvar,+nonvar)
- zero_or_one
parse/3
¶
Parses Chars to/from a data structure of the form xml(<atts>, <content>).
static
parse(Controls,Chars,Document)
parse(+nonvar,+nonvar,?nonvar)
- zero_or_one
parse(+nonvar,?nonvar,+nonvar)
- zero_or_one
subterm/2
¶
Unifies Subterm with a sub-term of XMLTerm. Note that XMLTerm is a sub-term of itself.
static
subterm(XMLTerm,Subterm)
subterm(+nonvar,?nonvar)
- zero_or_one
pp/1
¶
Pretty prints a XML document on the current output stream.
static
pp(XMLDocument)
pp(+nonvar)
- zero_or_one
Protected interface¶
(none)
Private predicates¶
xml_to_document/3
¶
Translates the list of character codes XML into the Prolog term Document. Controls is a list of terms controlling the treatment of layout characters and character entities.
static
xml_to_document(Controls,XML,Document)
xml_to_document(+nonvar,+nonvar,?nonvar)
- zero_or_one
empty_map/1
¶
True if Map is a null map.
static
empty_map(Map)
empty_map(?nonvar)
- zero_or_one
map_member/3
¶
True if Map is a ordered map structure which records the pair Key-Data. Key must be ground.
static
map_member(Key,Map,Data)
map_member(+nonvar,+nonvar,?nonvar)
- zero_or_one
map_store/4
¶
True if Map0 is an ordered map structure, Key must be ground, and Map1 is identical to Map0 except that the pair Key-Data is recorded by Map1.
static
map_store(Map0,Key,Data,Map1)
map_store(+nonvar,+nonvar,+nonvar,?nonvar)
- zero_or_one
pp_string/1
¶
Prints String onto the current output stream. If String contains only 7-bit chars it is printed in shorthand quoted format, otherwise it is written as a list.
static
pp_string(String)
pp_string(+nonvar)
- zero_or_one
fault/5
¶
Identifies SubTerm as a sub-term of Term which cannot be serialized after Indentation. Message is an atom naming the type of error; Path is a string encoding a list of SubTerm’s ancestor elements in the form <tag>{(id)}* where <tag> is the element tag and <id> is the value of any attribute _named_ id.
static
fault(Term,Indentation,SubTerm,Path,Message)
fault(+nonvar,+nonvar,?nonvar,?nonvar,?nonvar)
- zero_or_one
exception/4
¶
Hook to raise an exception to be raised in respect of a fault in the XML Term: Document.
static
exception(Message,Document,Culprit,Path)
exception(+atom,+nonvar,+nonvar,+nonvar)
- one
document_generation//2
¶
DCG generating Document as a list of character codes. Format is true|false defining whether layouts, to provide indentation, should be added between the element content of the resultant “string”. Note that formatting is disabled for elements that are interspersed with pcdata/1 terms, such as XHTML’s ‘inline’ elements. Also, Format is over-ridden, for an individual element, by an explicit ‘xml:space’=”preserve” attribute.
static
document_generation(Format,Document)
pcdata_7bit//1
¶
Represents the ascii character set in its simplest format, using the character entities & " < and > which are common to both XML and HTML. The numeric entity ' is used in place of ', because browsers don’t recognize it in HTML.
static
pcdata_7bit(Char)
character_data_format/3
¶
Holds when Format0 and Format1 are the statuses of XML formatting before and after Chars - which may be null.
static
character_data_format(Chars,Format0,Format1)
character_data_format(+nonvar,+nonvar,?nonvar)
- zero_or_one
cdata_generation//1
¶
Holds when Format0 and Format1 are the statuses of XML formatting before and after Chars - which may be null.
static
cdata_generation(Chars)
Operators¶
(none)
Remarks¶
- On-line documentation: https://binding-time.co.uk/index.php/Parsing_XML_with_Prolog
- Compliance: This XML parser supports a subset of XML suitable for XML Data and Worldwide Web applications. It is neither as strict nor as comprehensive as the XML 1.0 Specification mandates.
- Compliance-strictness: It is not as strict, because, while the specification must eliminate ambiguities, not all errors need to be regarded as faults, and some reasonable examples of real XML usage would have to be rejected if they were.
- Compliance-comprehensive: It is not as comprehensive, because, where the XML specification makes provision for more or less complete DTDs to be provided as part of a document, xml.pl actions the local definition of ENTITIES only. Other DTD extensions are treated as commentary.
- Bi-directional conversions: The conversions are not completely symmetrical, in that weaker XML is accepted than can be generated. Specifically, in-bound (Chars -> Document) parsing does not require strictly well-formed XML. If Chars does not represent well-formed XML, Document is instantiated to the term malformed(<attributes>, <content>).