maya-mel 0.1.1

Single-entry Autodesk Maya MEL parsing and analysis library.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110

#![forbid(unsafe_code)]
#![deny(rustdoc::bare_urls, rustdoc::broken_intra_doc_links)]
//! Parse and analyze Autodesk Maya MEL from a single crate.
//!
//! `maya-mel` is the public library entry point for this workspace. It keeps
//! the common MEL workflow available from one dependency while leaving
//! lower-level syntax, parsing, and Maya-specific layers available as public
//! modules when you need tighter control.
//!
//! # Quick Start
//!
//! ```rust
//! use maya_mel::{analyze, collect_top_level_facts, parse_source};
//!
//! let parsed = parse_source("global proc hello() {}");
//! let analysis = analyze(&parsed.syntax, parsed.source_view());
//! let facts = collect_top_level_facts(&parsed);
//!
//! assert!(analysis.diagnostics.is_empty());
//! assert!(!facts.items.is_empty());
//! ```
//!
//! ```rust
//! use maya_mel::{MayaCommandRegistry, collect_top_level_facts_with_registry, parse_source};
//!
//! let parsed = parse_source("createNode transform -n \"root\";");
//! let facts = collect_top_level_facts_with_registry(&parsed, &MayaCommandRegistry::new());
//!
//! assert_eq!(facts.items.len(), 1);
//! ```
//!
//! # Common Workflows
//!
//! - Use [`parse_source`] or [`parse_file`] to build a typed MEL syntax tree.
//! - Use [`analyze`] to resolve generic MEL semantics and collect diagnostics.
//! - Use [`collect_top_level_facts`] to gather Maya-specific command facts.
//! - Use [`MayaCommandRegistry`] with [`analyze_with_registry`] or
//!   [`collect_top_level_facts_with_registry`] when builtin Maya command metadata matters.
//! - Use [`parser`], [`sema`], or [`maya`] directly for advanced workflows.
//!
//! # Module Guide
//!
//! - [`parser`] exposes full and lightweight parse entry points.
//! - [`sema`] exposes generic semantic analysis and command contracts.
//! - [`maya`] exposes Maya-specific command registries and fact collection.
//! - [`ast`], [`syntax`], and [`mod@lexer`] expose lower-level structures.
//!
//! # Stability
//!
//! This crate is published as experimental `0.x`. Root-level APIs are intended
//! to cover the common workflow, while advanced surfaces may continue to move
//! between releases.

extern crate self as mel_ast;
extern crate self as mel_lexer;
extern crate self as mel_maya;
extern crate self as mel_parser;
extern crate self as mel_sema;
extern crate self as mel_syntax;

/// Typed MEL syntax tree structures returned by the parser.
pub mod ast;
/// MEL tokenization utilities and lexer entry points.
pub mod lexer;
/// Maya-specific metadata, registries, and top-level fact collection.
pub mod maya;
/// Full and lightweight MEL parsing entry points.
pub mod parser;
/// Generic semantic analysis and command normalization.
pub mod sema;
/// Shared spans, tokens, and source mapping primitives.
pub mod syntax;

pub(crate) use maya::{model, normalize, registry, specialize, validate};
pub(crate) use parser::decode;
pub(crate) use sema::{command_norm, command_schema, scope};

#[doc(hidden)]
pub use ast::*;
#[doc(hidden)]
pub use lexer::*;
#[doc(hidden)]
pub use maya::*;
#[doc(hidden)]
pub use parser::*;
#[doc(hidden)]
pub use sema::*;
#[doc(hidden)]
pub use syntax::*;

#[doc(inline)]
pub use maya::{
    MayaCommandRegistry, MayaSpecializedCommand, MayaTopLevelCommand, MayaTopLevelFacts,
    MayaTopLevelItem, collect_top_level_facts, collect_top_level_facts_shared,
    collect_top_level_facts_shared_with_registry, collect_top_level_facts_with_registry,
};
#[doc(inline)]
pub use parser::{
    DecodeDiagnostic, Parse, ParseBudgets, ParseError, ParseMode, ParseOptions, SharedParse,
    SourceEncoding, parse_bytes, parse_bytes_with_encoding, parse_file, parse_file_with_encoding,
    parse_shared_bytes, parse_shared_bytes_with_encoding, parse_shared_file,
    parse_shared_file_with_encoding, parse_shared_source, parse_shared_source_with_options,
    parse_source, parse_source_with_options,
};
#[doc(inline)]
pub use sema::{
    Analysis, Diagnostic, DiagnosticFilter, DiagnosticLabel, DiagnosticSeverity, analyze,
    analyze_diagnostics_with_registry, analyze_diagnostics_with_registry_filtered,
    analyze_with_registry,
};