valence_schema_dsl/lib.rs
1//! Shared syn-based parser for `valence_schema!` and `valence_trait_schema!`.
2//!
3//! Used by:
4//! - [`valence-macros`](../valence_macros) — proc-macro expansion
5//! - [`valence-codegen`](../valence_codegen) — build-time model generation from schema files
6//!
7//! This crate depends only on `syn` / `quote` / `proc-macro2` (no `valence-core` or public crate).
8//!
9//! # Examples
10//!
11//! Parse macro tokens:
12//!
13//! ```
14//! use valence_schema_dsl::{parse_schema, SchemaSpec};
15//!
16//! let tokens: proc_macro2::TokenStream = syn::parse_str(
17//! r#"
18//! Counter {
19//! table: "counter",
20//! version: "0.1.0",
21//! fields: [
22//! id: { r#type: FieldType::String, primary_key: true, required: true },
23//! ],
24//! }
25//! "#,
26//! )
27//! .expect("tokens");
28//! let parsed = parse_schema(tokens).expect("parse");
29//! assert_eq!(parsed.table_name, "counter");
30//! let _ = std::any::type_name::<SchemaSpec>();
31//! ```
32//!
33//! Parse a host schema file:
34//!
35//! ```
36//! use valence_schema_dsl::parse_schema_file;
37//!
38//! let src = r#"
39//! valence_schema! {
40//! Widget {
41//! table: "widget",
42//! version: "0.1.0",
43//! fields: [
44//! id: { r#type: FieldType::String, primary_key: true, required: true },
45//! ],
46//! }
47//! }
48//! "#;
49//! let parsed = parse_schema_file(src).expect("parse");
50//! assert_eq!(parsed.table_name, "widget");
51//! ```
52
53mod extract;
54mod file;
55pub mod parse;
56mod trait_schema;
57
58#[cfg(test)]
59mod parse_tests;
60
61pub use extract::{
62 extract_default_string, extract_field_type, extract_field_type_string,
63 extract_validator_string, ExtractedFieldType,
64};
65pub use file::{parse_schema_file, parse_trait_file, FileParseError};
66pub use parse::*;
67pub use trait_schema::{ParsedTraitSchema, TraitSchemaItem, TraitSchemaSpec};
68
69use proc_macro2::TokenStream;
70
71/// Parse `valence_schema!` body tokens into a [`ParsedSchema`].
72///
73/// # Errors
74///
75/// Returns a [`syn::Error`] when the DSL is invalid.
76pub fn parse_schema(tokens: TokenStream) -> syn::Result<ParsedSchema> {
77 let spec: SchemaSpec = syn::parse2(tokens)?;
78 spec.to_schema()
79}
80
81/// Parse `valence_trait_schema!` body tokens into a [`ParsedTraitSchema`].
82///
83/// # Errors
84///
85/// Returns a [`syn::Error`] when the DSL is invalid.
86pub fn parse_trait_schema(tokens: TokenStream) -> syn::Result<ParsedTraitSchema> {
87 let spec: TraitSchemaSpec = syn::parse2(tokens)?;
88 spec.to_parsed()
89}