Module `Xml_parser`Source

Xml Light Parser

While basic parsing functions can be used in the Xml module, this module is providing a way to create, configure and run an Xml parser.

Sourcetype xml = Xml_datatype.xml

An Xml node is either Element (tag-name, attributes, children) or PCData text

Sourcetype t

Abstract type for an Xml parser.

Xml Exceptions

Several exceptions can be raised when parsing an Xml document :

Xml.Error is raised when an xml parsing error occurs. the Xml.error_msg tells you which error occurred during parsing and the Xml.error_pos can be used to retrieve the document location where the error occurred at.
Xml.File_not_found is raised when an error occurred while opening a file with the Xml.parse_file function.

Sourcetype error_pos

Sourcetype error_msg =

| UnterminatedComment
| UnterminatedString
| UnterminatedEntity
| IdentExpected
| CloseExpected
| NodeExpected
| AttributeNameExpected
| AttributeValueExpected
| EndOfTagExpected of string
| EOFExpected
| Empty

Sourcetype error = error_msg * error_pos

Sourceexception Error of error

Sourceexception File_not_found of string

Sourceval error : error -> string

Get a full error message from an Xml error.

Sourceval error_msg : error_msg -> string

Get the Xml error message as a string.

Sourceval line : error_pos -> int

Get the line the error occurred at.

Sourceval range : error_pos -> int * int

Get the relative character range (in current line) the error occurred at.

Sourceval abs_range : error_pos -> int * int

Get the absolute character range the error occurred at.

Sourceval pos : Lexing.lexbuf -> error_pos

Sourcetype source =

| SChannel of in_channel
| SString of string
| SLexbuf of Lexing.lexbuf

Several kind of resources can contain Xml documents.

Sourceval make : source -> t

This function returns a new parser with default options.

Sourceval check_eof : t -> bool -> unit

When a Xml document is parsed, the parser may check that the end of the document is reached, so for example parsing "<A/><B/>" will fail instead of returning only the A element. You can turn on this check by setting check_eof to true (by default, check_eof is false, unlike in the original Xmllight).

Sourceval parse : ?canonicalize:bool -> t -> xml

Once the parser is configured, you can run the parser on a any kind of xml document source to parse its contents into an Xml data structure.

When canonicalize is set, the parser tries to remove blank PCDATA elements.

Install

Dune Dependency

Authors

Maintainers

Sources

doc/coqide-server.protocol/Xml_parser/index.html

Module `Xml_parser`Source

Xml Exceptions

package coqide-server

Install

Dune Dependency

Authors

Maintainers

Sources

doc/coqide-server.protocol/Xml_parser/index.html

Module Xml_parserSource

Xml Exceptions

Module `Xml_parser`Source