Mike Gerwitz
bdd98a5d92
This ensures that each metavariable defined within a template (a template parameter) has, by the time that the template definition is ended, at least one reference to each metavariable. This has practical benefits---ensuring that you haven't forgotten to use a metavariable; ensuring that you clean up when code is removed; and ensuring that you didn't accidentally delete some reference that you didn't intend to (at least in the case of _all_ references...)---but the rationale for it in this commit is a bit different. More on that below. This does introduce the negative effect of making it more difficult to consume inputs without utilizing them, acting more like a relevant type system (in terms of substructural type systems and with respect to metavariables, at least). You can for now reference them in contexts that would reasonably have no effect on the program or be optimized away, but in the future it'd be nice to explicitly state "hey this isn't intended to be used yet", especially if you're creating shells of templates, or trying to maintain BC in a particular situation. But more on that in the future. For now, the real reason for this change is because of how I intend for template expansion to work: by walking the body. Rather than having to check both the parameters of the template and then expand the body separately, we can simply trust that each parameter is referenced. Then, after rebinding metavariable references, we can perform the same check on the expansion template to see if there were arguments provided that do not correspond to parameters. This also adds flexibility with parameters that are used conditionally---we'll be able to have conditionally required parameters in error reporting. More information on this is coming, though; it'll be included in the docs of the commit that introduces the changes. DEV-13163 |
||
|---|---|---|
| .. | ||
| benches | ||
| build-aux | ||
| src | ||
| tests | ||
| .gitignore | ||
| Cargo.lock | ||
| Cargo.toml | ||
| Makefile.am | ||
| README.md | ||
| autogen.sh | ||
| bootstrap | ||
| conf.sh.in | ||
| configure.ac | ||
| rust-toolchain.toml | ||
| rustfmt.toml | ||
README.md
TAME in Rust (TAMER)
TAME was written to help tame the complexity of developing comparative insurance rating systems. This project aims to tame the complexity and performance issues of TAME itself. TAMER is therefore more tame than TAME.
TAME was originally written in XSLT. For more information about the
project, see the parent README.md.
Building
To bootstrap from the source repository, run ./bootstrap.
To configure the build for your system, run ./configure. To build, run
make. To run tests, run make check.
You may also invoke cargo directly, which make will do for you using
options provided to configure.
Note that the default development build results in terrible runtime performance! See [#Build Flags][] below for instructions on how to generate a release binary.
Build Flags
The environment variable CARGO_BUILD_FLAGS can be used to provide
additional arguments to cargo build when invoked via make. This can be
provided optionally during configure and can be overridden when invoking
make. For example:
# release build
$ ./configure && make CARGO_BUILD_FLAGS=--release
$ ./configure CARGO_BUILD_FLAGS=--release && make
# dev build
$ ./configure && make
$ ./configure CARGO_BUILD_FLAGS=--release && make CARGO_BUILD_FLAGS=
Hacking
This section contains advice for those developing TAMER.
Running Tests
Developers should be using test-driven development (TDD). make check will
run all necessary tests.
Code Format
Rust provides rustfmt that can automatically format code for you. This
project mandates its use and therefore eliminates personal preference in
code style (for better or worse).
Formatting checks are run during make check and, on failure, will output
the diff that would be applied if you ran make fmt (or make fix); this
will run cargo fmt for you (and will use the binaries configured via
configure).
Since developers should be doing test-driven development (TDD) and therefore
should be running make check frequently, the hope is that frequent
feedback on formatting issues will allow developers to quickly adjust their
habits to avoid triggering formatting errors at all.
If you want to automatically fix formatting errors and then run tests:
$ make fmt check
Benchmarking
Benchmarks serve two purposes: external integration tests (which are subject
to module visibility constraints) and actual benchmarking. To run
benchmarks, invoke make bench.
Note that link-time optimizations (LTO) are performed on the binary for benchmarking so that its performance reflects release builds that will be used in production.
The configure script will automatically detect whether the test feature
is unstable (as it was as of the time of writing) and, if so, will
automatically fall back to invoking nightly (by running cargo +nightly bench).
If you do not have nightly, run you install it via rustup install nightly.