blob: a30ab7bc4c716c75987f15bc695d229a5e0a72c9 (
plain)
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
|
// xmlo object files
//
// Copyright (C) 2014-2020 Ryan Specialty Group, LLC.
//
// This file is part of TAME.
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
//! `xmlo` object file construction and processing.
//!
//! This object file format exists for compatibility with the old compiler
//! written in XSLT;
//! it will be removed in the future.
//!
//!
//! `xmlo` Object Files
//! ===================
//! An `xmlo` object file is produced by the for each source file.
//! It is a terribly inefficient object format and will be eliminated in the
//! future.
//! The format is XML because the original compiler was written in XSLT.
//!
//! The general structure of an `xmlo` file consists of:
//! - Package metadata as attributes on the root node;
//! - A symbol table along with symbol metadata;
//! - Symbol dependencies (as [adjacency lists][]);
//! - Compiled JavaScript fragments for each applicable symbol; and
//! - Expanded source XML.
//!
//! [adjacency lists]: https://en.wikipedia.org/wiki/Adjacency_list
//!
//! For example (with some extra information omitted):
//!
//! ```xml
//! <package xmlns="http://www.lovullo.com/rater"
//! xmlns:preproc="http://www.lovullo.com/rater/preproc"
//! title="Example Package"
//! name="example/package"
//! __rootpath="../"
//! preproc:elig-class-yields="isEligexamplepackage">
//! <!-- Symbol table -->
//! <preproc:symtable>
//! <preproc:sym name=":class:some-sym" type="class" ... />
//! <!-- ... -->
//! </preproc:symtable>
//!
//! <!-- Dependency graph (adjacency lists) -->
//! <preproc:sym-deps>
//! <preproc:sym-dep name=":class:some-sym">
//! <preproc:sym-ref name="someOtherSym" />
//! <!-- ... -->
//! </preproc:sym-dep>
//! </preproc:sym-deps>
//!
//! <!-- Compiled JS fragments -->
//! <preproc:fragments>
//! <preproc:fragment id=":class:some-sym">
//! classes['some-sym'] = '...generated JS code...';
//! </preproc:fragment>
//! </preproc:fragments>
//!
//! <!-- Expanded src -->
//! </package>
//! ```
pub mod reader;
mod asg_builder;
pub use asg_builder::{AsgBuilder, AsgBuilderResult};
|