Mike Gerwitz

Activist for User Freedom

aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat (limited to 'tamer/src/obj/xmle/mod.rs')
-rw-r--r--tamer/src/obj/xmle/mod.rs69
1 files changed, 69 insertions, 0 deletions
diff --git a/tamer/src/obj/xmle/mod.rs b/tamer/src/obj/xmle/mod.rs
new file mode 100644
index 0000000..1b1c360
--- /dev/null
+++ b/tamer/src/obj/xmle/mod.rs
@@ -0,0 +1,69 @@
+// xmle object files
+//
+// Copyright (C) 2014-2019 Ryan Specialty Group, LLC.
+//
+// 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/>.
+
+//! `xmle` file construction and processing.
+//!
+//! This file format exists for compatibility with the old compiler
+//! written in XSLT; it will be removed in the future.
+//!
+//!
+//! `xmle` Files
+//! ===================
+//! An `xmle` file is produced by the for each source file.
+//! The format is XML because the original compiler was written in XSLT.
+//!
+//! The general structure of an `xmle` file consists of different sections:
+//! - map
+//! - return map
+//! - statics
+//! - rater
+//!
+//! For example (with some extra information omitted):
+//!
+//! ```xml
+//! <package xmlns="http://www.lovullo.com/rater"
+//! xmlns:preproc="http://www.lovullo.com/rater/preproc"
+//! xmlns:l="http://www.lovullo.com/rater/linker"
+//! title="suppliers/tax"
+//! program="true"
+//! name="suppliers/tax"
+//! __rootpath="../">
+//! <l:dep>
+//! <preproc:sym type="func"
+//! dim="0"
+//! dtype="float"
+//! name="min"
+//! src="../rater/core/numeric/minmax"
+//! desc="Return the lesser value"/>
+//! </l:dep>
+//! <l:map-from>
+//! <l:from name="latest_operation_hour"/>
+//! </l:map-from>
+//! <l:map-exec>
+//! function( input, callback ) {)
+//! </l:map-exec>
+//! <l:retmap-exec>
+//! function( input, callback ) {)
+//! </l:retmap-exec>
+//! <l:static>
+//! function func_min( args , min1, min2) {return min1;}
+//! </l:static>
+//! <l:exec>consts[&apos;CMP_OP_EQ&apos;] = 1;</l:exec>
+//! </package>
+//! ```
+
+pub mod writer;