Slice 3 of #94. From the compiled schema, compute exactly what is allowed at an element, for autocomplete and "what's missing". - ContentNFA.follow(after:) returns the precise follow-set: the element-name labels the content automaton can accept next after the children already present, plus whether the content may legally end there. - Schema.Completions reports the allowed next elements, the complete flag (false means a required child is still expected), a wildcard flag, and each declared attribute with its required and present status. - CompletionEngine resolves an element's declared type along a coding path (the global declaration, then each parent's content model) and computes the completions; Schema.Document.completions(at:in:) is the entry over a ranged tree. Tests pin the follow-set as the children accumulate (name then qty then the optional note, complete flipping true), the attribute required/present status, and resolution for a nested element by its coding path.
77 lines
3.8 KiB
Swift
77 lines
3.8 KiB
Swift
public extension PureXML.Schema {
|
|
/// An error compiling or applying a schema.
|
|
enum SchemaError: Swift.Error, Equatable, Sendable, CustomStringConvertible {
|
|
case notASchema
|
|
|
|
public var description: String {
|
|
switch self {
|
|
case .notASchema: "the document is not an xs:schema"
|
|
}
|
|
}
|
|
}
|
|
|
|
/// A compiled XSD schema: its global element declarations and named-type
|
|
/// table, parsed from a schema document, used to validate instance documents.
|
|
struct Document: Sendable {
|
|
private let elements: [String: ElementType]
|
|
private let types: [String: ElementType]
|
|
private let constraints: [String: [IdentityConstraint]]
|
|
private let nillableElements: Set<String>
|
|
private let elementConstraints: [String: ValueConstraint]
|
|
|
|
/// Compiles a schema document. `schemaLoader` resolves the
|
|
/// `schemaLocation` of `xs:include`, `xs:import`, and `xs:redefine` to
|
|
/// schema source; it returns nil (the default) when external schemas are
|
|
/// not available, which keeps compilation from reaching the filesystem or
|
|
/// network by default.
|
|
public init(_ xsd: String, schemaLoader: @escaping (String) -> String? = { _ in nil }) throws {
|
|
let compiled = try XSDParser.parse(xsd, loader: schemaLoader)
|
|
elements = compiled.elements
|
|
types = compiled.types
|
|
constraints = compiled.constraints
|
|
nillableElements = compiled.nillableElements
|
|
elementConstraints = compiled.elementConstraints
|
|
}
|
|
|
|
/// Validates an instance document against the schema, returning one located
|
|
/// ``PureXML/Validation/ValidationError`` per violation. Reports an error
|
|
/// when the root element has no global declaration.
|
|
public func validate(_ xml: String) throws -> [PureXML.Validation.ValidationError] {
|
|
try validate(PureXML.parse(xml))
|
|
}
|
|
|
|
/// Validates an already-parsed node tree, so a caller can validate the same
|
|
/// (possibly recovered) tree it is editing. See ``validate(_:)-(String)``.
|
|
public func validate(_ node: PureXML.Model.Node) -> [PureXML.Validation.ValidationError] {
|
|
guard case let .document(children) = node, let root = children.compactMap(\.element).first else {
|
|
return [.init(reason: "the document has no root element", at: [])]
|
|
}
|
|
guard let declaration = elements[root.name.localName] else {
|
|
return [.init(reason: "no element declaration for '\(root.name.localName)'", at: [])]
|
|
}
|
|
let context = PureXML.Validation.XSDContext(
|
|
types: types,
|
|
constraints: constraints,
|
|
rootDeclaration: declaration,
|
|
nillableElements: nillableElements,
|
|
elementConstraints: elementConstraints,
|
|
)
|
|
return PureXML.Validation.XSD.validator().errors(for: .element(root), in: context)
|
|
}
|
|
|
|
/// What the schema allows at the element a coding `path` addresses in
|
|
/// `tree`: the next child elements (the content-model follow-set), whether
|
|
/// the content may end there, and the declared attributes with their
|
|
/// required/present status. For editor completions and "what's missing".
|
|
/// Returns nil when the path does not address a declared element.
|
|
public func completions(at path: [PureXML.Validation.PathKey], in tree: PureXML.Model.TreeNode) -> Completions? {
|
|
guard let node = tree.node(at: path), case let .element(element) = node.node,
|
|
let type = CompletionEngine.elementType(at: path, elements: elements, types: types)
|
|
else {
|
|
return nil
|
|
}
|
|
return CompletionEngine.completions(for: element, type: type, types: types)
|
|
}
|
|
}
|
|
}
|