Skip to main content

oak_xml/
lib.rs

1#![doc = include_str!("readme.md")]
2#![feature(new_range_api)]
3#![warn(missing_docs)]
4#![doc(html_logo_url = "https://raw.githubusercontent.com/ygg-lang/oaks/refs/heads/dev/documents/logo.svg")]
5#![doc(html_favicon_url = "https://raw.githubusercontent.com/ygg-lang/oaks/refs/heads/dev/documents/logo.svg")]
6//! Xml support for the Oak language framework.
7
8/// AST module.
9pub mod ast;
10/// Builder module.
11pub mod builder;
12
13// pub mod formatter;
14// pub mod highlighter;
15/// Type definitions module.
16/// Language configuration module.
17pub mod language;
18/// Lexer module.
19pub mod lexer;
20/// LSP module.
21#[cfg(any(feature = "lsp", feature = "oak-highlight", feature = "oak-pretty-print"))]
22pub mod lsp;
23
24// pub mod mcp;
25/// Parser module.
26pub mod parser;
27
28pub use crate::{
29    ast::{XmlNode, XmlValue},
30    language::XmlLanguage,
31    lexer::{XmlLexer, token_type::XmlTokenType},
32    parser::XmlParser,
33};
34
35// #[cfg(feature = "oak-highlight")]
36// pub use crate::lsp::highlighter::XmlHighlighter;
37
38// /// LSP implementation.
39#[cfg(feature = "lsp")]
40pub use crate::lsp::XmlLanguageService;
41// #[cfg(feature = "lsp")]
42// pub use crate::lsp::formatter::XmlFormatter;
43
44#[cfg(feature = "serde")]
45pub use crate::language::serde::{from_value, to_value};
46
47/// Serializes a value to an XML string.
48#[cfg(feature = "serde")]
49pub fn to_string<T: ::serde::Serialize>(value: &T) -> Result<String, String> {
50    let xml_value = to_value(value).map_err(String::from)?;
51    Ok(xml_value.to_string())
52}
53
54/// Deserializes a value from an XML string.
55#[cfg(feature = "serde")]
56pub fn from_str<T: ::serde::de::DeserializeOwned>(s: &str) -> Result<T, String> {
57    let xml_value = parse(s)?;
58    from_value(xml_value).map_err(String::from)
59}
60
61/// Parses an XML string into an `XmlValue`.
62pub fn parse(xml: &str) -> Result<XmlValue, String> {
63    use crate::builder::XmlBuilder;
64    use oak_core::{Builder, parser::session::ParseSession, source::SourceText};
65    let builder = XmlBuilder::new();
66    let source = SourceText::new(xml.to_string());
67    let mut cache = ParseSession::default();
68    let result = builder.build(&source, &[], &mut cache);
69    result.result.map(|root| root.value).map_err(|e| format!("Parse failed: {:?}, diagnostics: {:?}", e, result.diagnostics))
70}
71
72pub use parser::element_type::XmlElementType;