The Algebraic Metalanguage
 
 
 
 
 
 
Go to file
Mike Gerwitz ab181670b5 tamer: xir::reader: Initial introduction of spans
This is a large change, and was a bit of a tedious one, given the
comprehensive tests.

This introduces proper offsets and lengths for spans, with the exception of
some quick-xml errors that still need proper mapping.  Further, this still
uses `UNKNOWN_CONTEXT`, which will be resolved shortly.

This also introduces `SpanlessError`, which `Error` explicitly _does not_
implement `From<SpanlessError>` for---this forces the caller to provide a
span before the error is compatable with the return value, ensuring that
spans will actually be available rather than forgotten for errors.  This is
important, given that errors are generally less tested than the happy path,
and errors are when users need us the most (so, need span information).

Further, I had to use pointer arithmetic in order to calculate many of the
spans, because quick-xml does not provide enough information.  There's no
safety considerations here, and the comprehensive unit test will ensure
correct behavior if the implementation changes in the future.

I would like to introduce typed spans at some point---I made some
opinionated choices when it comes to what the spans ought to
represent.  Specifically, whether to include the `<` or `>` with the open
span (depends), whether to include quotes with attribute values (no),
and some other details highlighted in the test cases.  If we provide typed
spans, then we could, knowing the type of span, calculate other spans on
request, e.g. to include or omit quotes for attributes.  Different such
spans may be useful in different situations when presenting information to
the user.

This also highlights gaps in the tokens emitted by XIR, such as whitespace
between attributes, the `=` between name and value, and so on.  These are
important when it comes to code formatting, so that we can reliably
reconstruct the XML tree, but it's not important right now.  I anticipate
future changes would allow the XIR reader to be configured (perhaps via
generics, like a strategy-type pattern) to optionally omit these tokens if
desired.

Anyway, more to come.

DEV-10934
2022-04-08 13:59:37 -04:00
bin bin/tame: Fix runner output line clearing 2022-01-28 09:21:34 -05:00
build-aux tame: build-aux/{csv2xml,tdat2xml}: Remove xml-stylesheet XML PI 2022-04-07 09:32:00 -04:00
core [DEV-11788] Add upper & lower abbreviation for states 2022-03-31 16:33:45 -04:00
design/tpl design/tpl (Matches): Refine matrix visualization figure 2021-05-27 10:59:52 -04:00
doc doc: Give @mdash macro an argument 2021-08-30 10:41:49 -04:00
progtest Copyright year update 2021 2021-07-22 15:00:15 -04:00
rater Clean up extclass remenants 2019-05-22 12:57:35 -04:00
src map: Force param/@default in translation to be numeric 2022-03-07 12:22:18 -05:00
tamer tamer: xir::reader: Initial introduction of spans 2022-04-08 13:59:37 -04:00
test Copyright year update 2021 2021-07-22 15:00:15 -04:00
tools Copyright year update 2021 2021-07-22 15:00:15 -04:00
.gitignore design/tpl: The Tame Programming Language initial concept 2021-05-10 13:46:49 -04:00
.gitlab-ci.yml .gitlab-ci.yml: Skip main build after stage build 2021-10-07 15:55:22 -04:00
.gitmodules Documentation and testing scaffolding 2015-04-16 13:21:22 -04:00
.rev-xmle TAMER: Separate static xmle section 2020-02-26 10:49:01 -05:00
.rev-xmlo Remove :map: sym-dep generation 2021-07-22 14:27:15 -04:00
COPYING Initial repository setup 2015-04-14 05:35:36 -04:00
COPYING.FDL Initial repository setup 2015-04-14 05:35:36 -04:00
HACKING Copyright year simplification and update to Ryan Specialty Group 2019-02-07 13:23:09 -05:00
Makefile.am Copyright year update 2021 2021-07-22 15:00:15 -04:00
README.md README.md: Mention Rust in upper paragraph alongside XSLT 2021-06-22 12:17:33 -04:00
RELEASES.md RELEASES.md: Update for v19.0.3 2022-04-01 15:06:07 -04:00
VERSION.in Add generated VERSION 2016-08-23 11:33:51 -04:00
bootstrap tamer: cargo --frozen --offline 2021-12-02 11:49:51 -05:00
c1map.xsd c1map.xsd: Add schema 2017-07-05 13:51:28 -04:00
configure.ac Copyright year update 2021 2021-07-22 15:00:15 -04:00
package-lock.json package{,-lock}.json additions 2020-08-19 15:39:50 -04:00

README.md

TAME

TAME is The Algebraic Metalanguage, a programming language and system of tools designed to aid in the development, understanding, and maintenance of systems performing numerous calculations on a complex graph of dependencies, conditions, and a large number of inputs.

This system was developed at Ryan Specialty Group (formerly LoVullo Associates) to handle the complexity of comparative insurance rating systems. It is a domain-specific language (DSL) that itself encourages, through the use of templates, the creation of sub-DSLs. TAME itself is at heart a calculator—processing only numerical input and output—driven by quantifiers as predicates. Calculations and quantifiers are written declaratively without concern for order of execution.

The system has powerful dependency resolution and data flow capabilities.

TAME consists of a macro processor (implementing a metalanguage), numerous compilers for various targets (JavaScript, HTML documentation and debugging environment, LaTeX, and others), linkers, and supporting tools. The input grammar is XML, and the majority of the project (including the macro processor, compilers, and linkers) is written in a combination of XSLT and Rust.

TAMER

Due to performance requirements, this project is currently being reimplemented in Rust. That project can be found in the tamer/ directory.

Documentation

Compiled documentation for the latest release is available via our GitLab mirror, which uses the same build pipeline as we do on our internal GitLab instance. Available formats are:

Getting Started

To get started, make sure Saxon version 9 or later is available and its path set as SAXON_CP; that the path to hoxsl is set via HOXSL; and then run the bootstrap script:

$ export SAXON_CP=/path/to/saxon9he.jar
$ export HOXSL=/path/to/hoxsl/root

$ ./boostrap

Running Test Cases

To run the test cases, invoke make check (or its alias, make test).

Testing Core Features

In order to run tests located at core/test/core/**, a supporting environment is required. (e.g. mega rater). Inside a supporting rater, either check out a submodule containing the core tests, or temporarily add them into the submodule.

Build the core test suite summary page using:

$ make rater/core/test/core/suite.html

Visit the summary page in a web browser and click the Calculate Premium button. If all test cases pass, it will yield a value of $1.

Hacking

Information for TAME developers can be found in the file HACKING.

License

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.