Mihaela Mihaljevic
9168f990d6
Parse the XML declaration's pseudo-attributes instead of skipping the <?xml?> processing instruction: - version, encoding, and standalone are surfaced on a new XMLDeclaration, returned from parseWithDocumentType and via PureXML.xmlDeclaration(_:). - The pseudo-attributes are validated: fixed order (version, encoding, standalone), known names only, and standalone must be yes or no. A malformed declaration is rejected. - The declared version is now readable, a prerequisite for XML 1.1. parseWithDocumentType returns a ParsedDocument struct (node, documentType, declaration) rather than a 2-tuple; the member names are unchanged so existing call sites are unaffected. Closes #95
94 lines
4.6 KiB
Swift
94 lines
4.6 KiB
Swift
public extension PureXML.Parsing {
|
|
/// Parser error with source position information when available.
|
|
enum ParseError: Swift.Error, Equatable, Sendable, CustomStringConvertible {
|
|
case emptyDocument
|
|
case unexpectedEndOfInput(Mark)
|
|
case unexpectedCharacter(Character, Mark)
|
|
case unterminatedTag(Mark)
|
|
case unterminatedComment(Mark)
|
|
case unterminatedCDATA(Mark)
|
|
case mismatchedEndTag(expected: String, found: String, Mark)
|
|
case duplicateAttribute(name: String, Mark)
|
|
case expectedName(Mark)
|
|
case expectedEquals(Mark)
|
|
case unquotedAttributeValue(Mark)
|
|
case invalidReference(String, Mark)
|
|
case undefinedEntity(name: String, Mark)
|
|
case recursiveEntity(name: String, Mark)
|
|
case amplificationLimitExceeded(Mark)
|
|
case unexpectedEndTag(name: String, Mark)
|
|
case undefinedNamespacePrefix(prefix: String, Mark)
|
|
case junkAfterDocumentElement(Mark)
|
|
case nestingTooDeep(limit: Int, Mark)
|
|
case nameTooLong(limit: Int, Mark)
|
|
case contentTooLong(limit: Int, Mark)
|
|
/// A `<!DOCTYPE ...>` declaration was found. DTD processing is disabled by
|
|
/// default as a security posture (XXE, entity-expansion DoS); enabling it
|
|
/// is a deliberate future opt-in, not silent behavior.
|
|
case unsupportedDoctype(Mark)
|
|
/// Raised when raw bytes cannot be decoded in the detected encoding (for
|
|
/// example an odd-length UTF-16 stream).
|
|
case malformedEncoding
|
|
/// Raised by entry points whose parsing path is not implemented yet.
|
|
case notImplemented(String)
|
|
/// The XML declaration `<?xml ... ?>` is malformed: its pseudo-attributes
|
|
/// are out of order, unknown, or carry an illegal value.
|
|
case malformedDeclaration(Mark)
|
|
|
|
public var description: String {
|
|
switch self {
|
|
case .emptyDocument:
|
|
"document is empty"
|
|
case let .unexpectedEndOfInput(mark):
|
|
"unexpected end of input at \(mark)"
|
|
case let .unexpectedCharacter(character, mark):
|
|
"unexpected character '\(character)' at \(mark)"
|
|
case let .unterminatedTag(mark):
|
|
"unterminated tag starting at \(mark)"
|
|
case let .unterminatedComment(mark):
|
|
"unterminated comment starting at \(mark)"
|
|
case let .unterminatedCDATA(mark):
|
|
"unterminated CDATA section starting at \(mark)"
|
|
case let .mismatchedEndTag(expected, found, mark):
|
|
"expected </\(expected)> but found </\(found)> at \(mark)"
|
|
case let .duplicateAttribute(name, mark):
|
|
"duplicate attribute '\(name)' at \(mark)"
|
|
case let .expectedName(mark):
|
|
"expected a name at \(mark)"
|
|
case let .expectedEquals(mark):
|
|
"expected '=' after attribute name at \(mark)"
|
|
case let .unquotedAttributeValue(mark):
|
|
"attribute value must be quoted at \(mark)"
|
|
case let .invalidReference(reference, mark):
|
|
"invalid reference '\(reference)' at \(mark)"
|
|
case let .undefinedEntity(name, mark):
|
|
"entity '&\(name);' is not declared at \(mark)"
|
|
case let .recursiveEntity(name, mark):
|
|
"entity '&\(name);' refers to itself at \(mark)"
|
|
case let .amplificationLimitExceeded(mark):
|
|
"entity expansion exceeds the amplification limit at \(mark)"
|
|
case let .unexpectedEndTag(name, mark):
|
|
"unexpected end tag </\(name)> at \(mark)"
|
|
case let .undefinedNamespacePrefix(prefix, mark):
|
|
"namespace prefix '\(prefix)' is not bound at \(mark)"
|
|
case let .junkAfterDocumentElement(mark):
|
|
"content after the root element at \(mark)"
|
|
case let .nestingTooDeep(limit, mark):
|
|
"element nesting exceeds the limit of \(limit) at \(mark)"
|
|
case let .nameTooLong(limit, mark):
|
|
"name exceeds the length limit of \(limit) at \(mark)"
|
|
case let .contentTooLong(limit, mark):
|
|
"content exceeds the length limit of \(limit) at \(mark)"
|
|
case let .unsupportedDoctype(mark):
|
|
"DTD processing is disabled (DOCTYPE at \(mark))"
|
|
case .malformedEncoding:
|
|
"input bytes are malformed for the detected encoding"
|
|
case let .notImplemented(detail):
|
|
"not implemented: \(detail)"
|
|
case let .malformedDeclaration(mark):
|
|
"malformed XML declaration at \(mark)"
|
|
}
|
|
}
|
|
}
|
|
}
|