2020-04-08 16:18:18 -04:00
|
|
|
// TAME compiler
|
|
|
|
//
|
2022-05-03 14:14:29 -04:00
|
|
|
// Copyright (C) 2014-2022 Ryan Specialty Group, LLC.
|
2020-04-08 16:18:18 -04:00
|
|
|
//
|
|
|
|
// 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/>.
|
|
|
|
|
2022-04-13 15:11:29 -04:00
|
|
|
//! This is the TAME compiler.
|
|
|
|
//!
|
|
|
|
//! `tamec` compiles source code into object files that are later linked
|
|
|
|
//! into a final executable using [`tameld`](../tameld).
|
2020-04-08 16:18:18 -04:00
|
|
|
|
|
|
|
extern crate tamer;
|
|
|
|
|
|
|
|
use getopts::{Fail, Options};
|
2022-04-13 15:11:29 -04:00
|
|
|
use std::{
|
2022-10-20 15:38:59 -04:00
|
|
|
cell::RefCell,
|
2022-04-13 15:11:29 -04:00
|
|
|
env,
|
|
|
|
error::Error,
|
tamer: Introduce NIR (accepting only)
This introduces NIR, but only as an accepting grammar; it doesn't yet emit
the NIR IR, beyond TODOs.
This modifies `tamec` to, while copying XIR, also attempt to lower NIR to
produce parser errors, if any. It does not yet fail compilation, as I just
want to be cautious and observe that everything's working properly for a
little while as people use it, before I potentially break builds.
This is the culmination of months of supporting effort. The NIR grammar is
derived from our existing TAME sources internally, which I use for now as a
test case until I introduce test cases directly into TAMER later on (I'd do
it now, if I hadn't spent so much time on this; I'll start introducing tests
as I begin emitting NIR tokens). This is capable of fully parsing our
largest system with >900 packages, as well as `core`.
`tamec`'s lowering is a mess; that'll be cleaned up in future commits. The
same can be said about `tameld`.
NIR's grammar has some initial documentation, but this will improve over
time as well.
The generated docs still need some improvement, too, especially with
generated identifiers; I just want to get this out here for testing.
DEV-7145
2022-08-29 15:28:03 -04:00
|
|
|
fmt::{self, Display, Write},
|
2022-10-19 14:38:45 -04:00
|
|
|
fs::{self, File},
|
|
|
|
io::{self, BufReader, BufWriter},
|
2022-04-13 15:11:29 -04:00
|
|
|
path::Path,
|
|
|
|
};
|
|
|
|
use tamer::{
|
2022-04-20 12:08:46 -04:00
|
|
|
diagnose::{
|
|
|
|
AnnotatedSpan, Diagnostic, FsSpanResolver, Reporter, VisualReporter,
|
|
|
|
},
|
tamer: Introduce NIR (accepting only)
This introduces NIR, but only as an accepting grammar; it doesn't yet emit
the NIR IR, beyond TODOs.
This modifies `tamec` to, while copying XIR, also attempt to lower NIR to
produce parser errors, if any. It does not yet fail compilation, as I just
want to be cautious and observe that everything's working properly for a
little while as people use it, before I potentially break builds.
This is the culmination of months of supporting effort. The NIR grammar is
derived from our existing TAME sources internally, which I use for now as a
test case until I introduce test cases directly into TAMER later on (I'd do
it now, if I hadn't spent so much time on this; I'll start introducing tests
as I begin emitting NIR tokens). This is capable of fully parsing our
largest system with >900 packages, as well as `core`.
`tamec`'s lowering is a mess; that'll be cleaned up in future commits. The
same can be said about `tameld`.
NIR's grammar has some initial documentation, but this will improve over
time as well.
The generated docs still need some improvement, too, especially with
generated identifiers; I just want to get this out here for testing.
DEV-7145
2022-08-29 15:28:03 -04:00
|
|
|
nir::{XirfToNir, XirfToNirError},
|
2022-10-19 14:38:45 -04:00
|
|
|
parse::{
|
|
|
|
Lower, ParseError, Parsed, ParsedObject, ParsedResult, UnknownToken,
|
|
|
|
},
|
tamer: Introduce NIR (accepting only)
This introduces NIR, but only as an accepting grammar; it doesn't yet emit
the NIR IR, beyond TODOs.
This modifies `tamec` to, while copying XIR, also attempt to lower NIR to
produce parser errors, if any. It does not yet fail compilation, as I just
want to be cautious and observe that everything's working properly for a
little while as people use it, before I potentially break builds.
This is the culmination of months of supporting effort. The NIR grammar is
derived from our existing TAME sources internally, which I use for now as a
test case until I introduce test cases directly into TAMER later on (I'd do
it now, if I hadn't spent so much time on this; I'll start introducing tests
as I begin emitting NIR tokens). This is capable of fully parsing our
largest system with >900 packages, as well as `core`.
`tamec`'s lowering is a mess; that'll be cleaned up in future commits. The
same can be said about `tameld`.
NIR's grammar has some initial documentation, but this will improve over
time as well.
The generated docs still need some improvement, too, especially with
generated identifiers; I just want to get this out here for testing.
DEV-7145
2022-08-29 15:28:03 -04:00
|
|
|
xir::{
|
|
|
|
self,
|
|
|
|
flat::{RefinedText, XirToXirf, XirToXirfError, XirfToken},
|
2022-10-19 14:38:45 -04:00
|
|
|
reader::XmlXirReader,
|
tamer: Introduce NIR (accepting only)
This introduces NIR, but only as an accepting grammar; it doesn't yet emit
the NIR IR, beyond TODOs.
This modifies `tamec` to, while copying XIR, also attempt to lower NIR to
produce parser errors, if any. It does not yet fail compilation, as I just
want to be cautious and observe that everything's working properly for a
little while as people use it, before I potentially break builds.
This is the culmination of months of supporting effort. The NIR grammar is
derived from our existing TAME sources internally, which I use for now as a
test case until I introduce test cases directly into TAMER later on (I'd do
it now, if I hadn't spent so much time on this; I'll start introducing tests
as I begin emitting NIR tokens). This is capable of fully parsing our
largest system with >900 packages, as well as `core`.
`tamec`'s lowering is a mess; that'll be cleaned up in future commits. The
same can be said about `tameld`.
NIR's grammar has some initial documentation, but this will improve over
time as well.
The generated docs still need some improvement, too, especially with
generated identifiers; I just want to get this out here for testing.
DEV-7145
2022-08-29 15:28:03 -04:00
|
|
|
writer::XmlWriter,
|
2022-10-19 14:38:45 -04:00
|
|
|
DefaultEscaper, Error as XirError, Token as XirToken,
|
tamer: Introduce NIR (accepting only)
This introduces NIR, but only as an accepting grammar; it doesn't yet emit
the NIR IR, beyond TODOs.
This modifies `tamec` to, while copying XIR, also attempt to lower NIR to
produce parser errors, if any. It does not yet fail compilation, as I just
want to be cautious and observe that everything's working properly for a
little while as people use it, before I potentially break builds.
This is the culmination of months of supporting effort. The NIR grammar is
derived from our existing TAME sources internally, which I use for now as a
test case until I introduce test cases directly into TAMER later on (I'd do
it now, if I hadn't spent so much time on this; I'll start introducing tests
as I begin emitting NIR tokens). This is capable of fully parsing our
largest system with >900 packages, as well as `core`.
`tamec`'s lowering is a mess; that'll be cleaned up in future commits. The
same can be said about `tameld`.
NIR's grammar has some initial documentation, but this will improve over
time as well.
The generated docs still need some improvement, too, especially with
generated identifiers; I just want to get this out here for testing.
DEV-7145
2022-08-29 15:28:03 -04:00
|
|
|
},
|
2022-04-13 15:11:29 -04:00
|
|
|
};
|
tamer: Initial frontend concept
This introduces the beginnings of frontends for TAMER, gated behind a
`wip-features` flag.
This will be introduced in stages:
1. Replace the existing copy with a parser-based copy (echo back out the
tokens), when the flag is on.
2. Begin to parse portions of the source, augmenting the output xmlo (xmli
at the moment). The XSLT-based compiler will be modified to skip
compilation steps as necessary.
As portions of the compilation are implemented in TAMER, they'll be placed
behind their own feature flags and stabalized, which will incrementally
remove the compilation steps from the XSLT-based system. The result should
be substantial incremental performance improvements.
Short-term, the priorities are for loading identifiers into an IR
are (though the order may change):
1. Echo
2. Imports
3. Extern declarations.
4. Simple identifiers (e.g. param, const, template, etc).
5. Classifications.
6. Documentation expressions.
7. Calculation expressions.
8. Template applications.
9. Template definitions.
10. Inline templates.
After each of those are done, the resulting xmlo (xmli) will have fully
reconstructed the source document from the IR produced during parsing.
2021-07-23 22:24:08 -04:00
|
|
|
|
2020-04-08 16:18:18 -04:00
|
|
|
/// Types of commands
|
|
|
|
enum Command {
|
|
|
|
Compile(String, String, String),
|
|
|
|
Usage,
|
|
|
|
}
|
|
|
|
|
2022-10-19 14:38:45 -04:00
|
|
|
/// Create a [`XmlXirReader`] for a source file.
|
|
|
|
///
|
|
|
|
/// The provided escaper must be shared between all readers and writers in
|
|
|
|
/// order to benefit from its caching.
|
|
|
|
fn src_reader<'a>(
|
|
|
|
input: &'a String,
|
|
|
|
escaper: &'a DefaultEscaper,
|
|
|
|
) -> Result<XmlXirReader<'a, BufReader<File>>, TamecError> {
|
|
|
|
use tamer::fs::{File, PathFile};
|
|
|
|
|
|
|
|
let source = Path::new(input);
|
|
|
|
|
|
|
|
let PathFile(_, file, ctx): PathFile<BufReader<fs::File>> =
|
|
|
|
PathFile::open(source)?;
|
|
|
|
|
|
|
|
Ok(XmlXirReader::new(file, escaper, ctx))
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Write each parsed token to the provided buffer.
|
|
|
|
///
|
|
|
|
/// This is intended to be a temporary function that exists during a
|
|
|
|
/// transition period between the XSLT-based TAME and TAMER.
|
|
|
|
/// Writing XIR proves that the source file is being successfully parsed and
|
|
|
|
/// helps to evaluate system performance.
|
|
|
|
fn copy_xml_to<'e, W: io::Write + 'e>(
|
|
|
|
mut fout: W,
|
|
|
|
escaper: &'e DefaultEscaper,
|
|
|
|
) -> impl FnMut(&ParsedResult<ParsedObject<XirToken, XirError>>) + 'e {
|
|
|
|
let mut xmlwriter = Default::default();
|
|
|
|
|
|
|
|
move |tok_result| match tok_result {
|
|
|
|
Ok(Parsed::Object(tok)) => {
|
|
|
|
xmlwriter = tok.write(&mut fout, xmlwriter, escaper).unwrap();
|
|
|
|
}
|
|
|
|
_ => (),
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2022-10-19 14:58:05 -04:00
|
|
|
/// Compile a source file,
|
|
|
|
/// writing to the provided destination path.
|
|
|
|
///
|
|
|
|
/// NB: Output is presently a _copy_ of the input,
|
|
|
|
/// with formatting partially removed.
|
|
|
|
fn compile<R: Reporter>(
|
|
|
|
src_path: &String,
|
|
|
|
dest_path: &String,
|
2022-10-20 14:31:25 -04:00
|
|
|
reporter: &R,
|
2022-10-19 14:58:05 -04:00
|
|
|
) -> Result<(), TamecError> {
|
|
|
|
let dest = Path::new(&dest_path);
|
|
|
|
let fout = BufWriter::new(fs::File::create(dest)?);
|
|
|
|
|
|
|
|
let escaper = DefaultEscaper::default();
|
|
|
|
|
2022-10-20 15:38:59 -04:00
|
|
|
let ebuf = RefCell::new(String::new());
|
2022-10-19 14:58:05 -04:00
|
|
|
|
2022-10-20 15:38:59 -04:00
|
|
|
fn report_err<E: Diagnostic, R: Reporter>(
|
|
|
|
e: &E,
|
|
|
|
reporter: &R,
|
|
|
|
ebuf: &mut String,
|
|
|
|
) -> Result<(), TamecError> {
|
|
|
|
// See below note about buffering.
|
|
|
|
ebuf.clear();
|
|
|
|
writeln!(ebuf, "{}", reporter.render(e))?;
|
|
|
|
println!("{ebuf}");
|
|
|
|
|
|
|
|
Ok(())
|
|
|
|
}
|
|
|
|
|
|
|
|
// TODO: You have landed on a commit that is in the middle of
|
|
|
|
// refactoring this lowering pipline;
|
|
|
|
// congratulations!
|
|
|
|
// Specifically,
|
|
|
|
// this is beginning to derive what these lowering steps have in
|
|
|
|
// common so that they can be factored out,
|
|
|
|
// and committing this intermediate state helps with rationalizing
|
|
|
|
// and understanding the changes.
|
2022-10-19 14:58:05 -04:00
|
|
|
let _ = Lower::<
|
|
|
|
ParsedObject<XirToken, XirError>,
|
|
|
|
XirToXirf<64, RefinedText>,
|
|
|
|
>::lower::<_, TamecError>(
|
|
|
|
// TODO: We're just echoing back out XIR,
|
|
|
|
// which will be the same sans some formatting.
|
|
|
|
&mut src_reader(src_path, &escaper)?
|
|
|
|
.inspect(copy_xml_to(fout, &escaper)),
|
|
|
|
|toks| {
|
2022-10-20 15:38:59 -04:00
|
|
|
Lower::<XirToXirf<64, RefinedText>, XirfToNir>::lower(
|
|
|
|
&mut toks.filter_map(|result| match result {
|
|
|
|
Ok(x) => Some(Ok(x)),
|
2022-10-19 14:58:05 -04:00
|
|
|
Err(e) => {
|
2022-10-20 15:38:59 -04:00
|
|
|
// TODO: This should yield an error,
|
|
|
|
// but the types do not yet allow for it.
|
|
|
|
report_err(
|
|
|
|
&e,
|
|
|
|
reporter,
|
|
|
|
&mut ebuf.borrow_mut(),
|
|
|
|
)
|
|
|
|
.unwrap();
|
|
|
|
None
|
2022-10-19 14:58:05 -04:00
|
|
|
}
|
2022-10-20 15:38:59 -04:00
|
|
|
}),
|
|
|
|
|nir| {
|
|
|
|
nir.fold(Ok(()), |x, result| match result {
|
|
|
|
Ok(_) => x,
|
|
|
|
Err(e) => {
|
|
|
|
report_err(
|
|
|
|
&e,
|
|
|
|
reporter,
|
|
|
|
&mut ebuf.borrow_mut(),
|
|
|
|
)?;
|
|
|
|
x
|
|
|
|
}
|
|
|
|
})
|
|
|
|
},
|
|
|
|
)
|
2022-10-19 14:58:05 -04:00
|
|
|
},
|
|
|
|
)?;
|
|
|
|
|
2022-10-21 15:35:27 -04:00
|
|
|
// TODO: Proper error summary and exit in `main`.
|
|
|
|
if reporter.has_errors() {
|
|
|
|
println!(
|
|
|
|
"fatal: failed to compile `{}` due to previous {} error(s)",
|
|
|
|
dest_path,
|
|
|
|
reporter.error_count(),
|
|
|
|
);
|
|
|
|
std::process::exit(1);
|
2022-10-19 14:58:05 -04:00
|
|
|
}
|
2022-10-21 15:35:27 -04:00
|
|
|
|
|
|
|
Ok(())
|
2022-10-19 14:58:05 -04:00
|
|
|
}
|
|
|
|
|
2020-04-08 16:18:18 -04:00
|
|
|
/// Entrypoint for the compiler
|
2022-04-13 15:11:29 -04:00
|
|
|
pub fn main() -> Result<(), TamecError> {
|
2020-04-08 16:18:18 -04:00
|
|
|
let args: Vec<String> = env::args().collect();
|
|
|
|
let program = &args[0];
|
|
|
|
let opts = get_opts();
|
|
|
|
let usage = opts.usage(&format!("Usage: {} [OPTIONS] INPUT", program));
|
|
|
|
|
|
|
|
match parse_options(opts, args) {
|
2022-10-19 14:58:05 -04:00
|
|
|
Ok(Command::Compile(src_path, _, dest_path)) => {
|
2022-10-20 14:31:25 -04:00
|
|
|
let reporter = VisualReporter::new(FsSpanResolver);
|
2020-04-08 16:18:18 -04:00
|
|
|
|
2022-10-20 14:31:25 -04:00
|
|
|
compile(&src_path, &dest_path, &reporter).or_else(
|
2022-10-19 14:58:05 -04:00
|
|
|
|e: TamecError| {
|
2022-04-13 15:11:29 -04:00
|
|
|
// POC: Rendering to a string ensures buffering so that we don't
|
tamer: Introduce NIR (accepting only)
This introduces NIR, but only as an accepting grammar; it doesn't yet emit
the NIR IR, beyond TODOs.
This modifies `tamec` to, while copying XIR, also attempt to lower NIR to
produce parser errors, if any. It does not yet fail compilation, as I just
want to be cautious and observe that everything's working properly for a
little while as people use it, before I potentially break builds.
This is the culmination of months of supporting effort. The NIR grammar is
derived from our existing TAME sources internally, which I use for now as a
test case until I introduce test cases directly into TAMER later on (I'd do
it now, if I hadn't spent so much time on this; I'll start introducing tests
as I begin emitting NIR tokens). This is capable of fully parsing our
largest system with >900 packages, as well as `core`.
`tamec`'s lowering is a mess; that'll be cleaned up in future commits. The
same can be said about `tameld`.
NIR's grammar has some initial documentation, but this will improve over
time as well.
The generated docs still need some improvement, too, especially with
generated identifiers; I just want to get this out here for testing.
DEV-7145
2022-08-29 15:28:03 -04:00
|
|
|
// interleave output between processes.
|
2022-04-27 14:58:50 -04:00
|
|
|
let report = reporter.render(&e).to_string();
|
2022-10-19 14:58:05 -04:00
|
|
|
println!(
|
|
|
|
"{report}\nfatal: failed to compile `{}`",
|
|
|
|
dest_path
|
|
|
|
);
|
2022-04-13 15:11:29 -04:00
|
|
|
|
|
|
|
std::process::exit(1);
|
2022-10-19 14:58:05 -04:00
|
|
|
},
|
|
|
|
)
|
2020-04-08 16:18:18 -04:00
|
|
|
}
|
|
|
|
Ok(Command::Usage) => {
|
|
|
|
println!("{}", usage);
|
|
|
|
std::process::exit(exitcode::OK);
|
|
|
|
}
|
|
|
|
Err(e) => {
|
|
|
|
eprintln!("{}", e);
|
|
|
|
println!("{}", usage);
|
|
|
|
std::process::exit(exitcode::USAGE);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Get 'Options'
|
|
|
|
///
|
|
|
|
/// ```
|
|
|
|
/// use getopts::Options;
|
|
|
|
///
|
|
|
|
/// let opts = get_opts();
|
|
|
|
/// ```
|
|
|
|
fn get_opts() -> Options {
|
|
|
|
let mut opts = Options::new();
|
|
|
|
opts.optopt("o", "output", "set output file name", "NAME");
|
|
|
|
opts.optopt("", "emit", "set output type", "xmlo");
|
|
|
|
opts.optflag("h", "help", "print this help menu");
|
|
|
|
|
|
|
|
opts
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Option parser
|
|
|
|
fn parse_options(opts: Options, args: Vec<String>) -> Result<Command, Fail> {
|
|
|
|
let matches = match opts.parse(&args[1..]) {
|
|
|
|
Ok(m) => m,
|
|
|
|
Err(f) => {
|
|
|
|
return Err(f);
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
|
|
|
if matches.opt_present("h") {
|
|
|
|
return Ok(Command::Usage);
|
|
|
|
}
|
|
|
|
|
|
|
|
let input = match matches.free.len() {
|
|
|
|
0 => return Err(Fail::OptionMissing(String::from("INPUT"))),
|
|
|
|
1 => matches.free[0].clone(),
|
|
|
|
_ => return Err(Fail::UnrecognizedOption(matches.free[1].clone())),
|
|
|
|
};
|
|
|
|
|
|
|
|
let emit = match matches.opt_str("emit") {
|
|
|
|
Some(m) => match &m[..] {
|
|
|
|
"xmlo" => m,
|
|
|
|
_ => {
|
|
|
|
return Err(Fail::ArgumentMissing(String::from("--emit xmlo")))
|
|
|
|
}
|
|
|
|
},
|
|
|
|
None => {
|
|
|
|
return Err(Fail::OptionMissing(String::from("--emit xmlo")));
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
|
|
|
let output = match matches.opt_str("o") {
|
|
|
|
Some(m) => m,
|
|
|
|
// we check that the extension is "xml" later
|
|
|
|
None => format!("{}o", input),
|
|
|
|
};
|
|
|
|
|
|
|
|
Ok(Command::Compile(input, emit, output))
|
|
|
|
}
|
|
|
|
|
2022-04-13 15:11:29 -04:00
|
|
|
/// Compiler (`tamec`) error.
|
|
|
|
///
|
|
|
|
/// This represents the aggregation of all possible errors that can occur
|
|
|
|
/// during compile-time.
|
|
|
|
/// This cannot include panics,
|
|
|
|
/// but efforts have been made to reduce panics to situations that
|
|
|
|
/// represent the equivalent of assertions.
|
|
|
|
#[derive(Debug)]
|
|
|
|
pub enum TamecError {
|
|
|
|
Io(io::Error),
|
2022-06-02 10:30:44 -04:00
|
|
|
XirParseError(ParseError<UnknownToken, xir::Error>),
|
tamer: Introduce NIR (accepting only)
This introduces NIR, but only as an accepting grammar; it doesn't yet emit
the NIR IR, beyond TODOs.
This modifies `tamec` to, while copying XIR, also attempt to lower NIR to
produce parser errors, if any. It does not yet fail compilation, as I just
want to be cautious and observe that everything's working properly for a
little while as people use it, before I potentially break builds.
This is the culmination of months of supporting effort. The NIR grammar is
derived from our existing TAME sources internally, which I use for now as a
test case until I introduce test cases directly into TAMER later on (I'd do
it now, if I hadn't spent so much time on this; I'll start introducing tests
as I begin emitting NIR tokens). This is capable of fully parsing our
largest system with >900 packages, as well as `core`.
`tamec`'s lowering is a mess; that'll be cleaned up in future commits. The
same can be said about `tameld`.
NIR's grammar has some initial documentation, but this will improve over
time as well.
The generated docs still need some improvement, too, especially with
generated identifiers; I just want to get this out here for testing.
DEV-7145
2022-08-29 15:28:03 -04:00
|
|
|
XirfParseError(ParseError<XirToken, XirToXirfError>),
|
|
|
|
NirParseError(ParseError<XirfToken<RefinedText>, XirfToNirError>),
|
2022-04-13 15:11:29 -04:00
|
|
|
XirWriterError(xir::writer::Error),
|
|
|
|
Fmt(fmt::Error),
|
|
|
|
}
|
|
|
|
|
|
|
|
impl From<io::Error> for TamecError {
|
|
|
|
fn from(e: io::Error) -> Self {
|
|
|
|
Self::Io(e)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2022-06-02 10:30:44 -04:00
|
|
|
impl From<ParseError<UnknownToken, xir::Error>> for TamecError {
|
|
|
|
fn from(e: ParseError<UnknownToken, xir::Error>) -> Self {
|
|
|
|
Self::XirParseError(e)
|
2022-04-13 15:11:29 -04:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
tamer: Introduce NIR (accepting only)
This introduces NIR, but only as an accepting grammar; it doesn't yet emit
the NIR IR, beyond TODOs.
This modifies `tamec` to, while copying XIR, also attempt to lower NIR to
produce parser errors, if any. It does not yet fail compilation, as I just
want to be cautious and observe that everything's working properly for a
little while as people use it, before I potentially break builds.
This is the culmination of months of supporting effort. The NIR grammar is
derived from our existing TAME sources internally, which I use for now as a
test case until I introduce test cases directly into TAMER later on (I'd do
it now, if I hadn't spent so much time on this; I'll start introducing tests
as I begin emitting NIR tokens). This is capable of fully parsing our
largest system with >900 packages, as well as `core`.
`tamec`'s lowering is a mess; that'll be cleaned up in future commits. The
same can be said about `tameld`.
NIR's grammar has some initial documentation, but this will improve over
time as well.
The generated docs still need some improvement, too, especially with
generated identifiers; I just want to get this out here for testing.
DEV-7145
2022-08-29 15:28:03 -04:00
|
|
|
impl From<ParseError<XirToken, XirToXirfError>> for TamecError {
|
|
|
|
fn from(e: ParseError<XirToken, XirToXirfError>) -> Self {
|
|
|
|
Self::XirfParseError(e)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
impl From<ParseError<XirfToken<RefinedText>, XirfToNirError>> for TamecError {
|
|
|
|
fn from(e: ParseError<XirfToken<RefinedText>, XirfToNirError>) -> Self {
|
|
|
|
Self::NirParseError(e)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2022-04-13 15:11:29 -04:00
|
|
|
impl From<xir::writer::Error> for TamecError {
|
|
|
|
fn from(e: xir::writer::Error) -> Self {
|
|
|
|
Self::XirWriterError(e)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
impl From<fmt::Error> for TamecError {
|
|
|
|
fn from(e: fmt::Error) -> Self {
|
|
|
|
Self::Fmt(e)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
impl Display for TamecError {
|
|
|
|
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
|
|
|
|
match self {
|
|
|
|
Self::Io(e) => Display::fmt(e, f),
|
2022-06-02 10:30:44 -04:00
|
|
|
Self::XirParseError(e) => Display::fmt(e, f),
|
tamer: Introduce NIR (accepting only)
This introduces NIR, but only as an accepting grammar; it doesn't yet emit
the NIR IR, beyond TODOs.
This modifies `tamec` to, while copying XIR, also attempt to lower NIR to
produce parser errors, if any. It does not yet fail compilation, as I just
want to be cautious and observe that everything's working properly for a
little while as people use it, before I potentially break builds.
This is the culmination of months of supporting effort. The NIR grammar is
derived from our existing TAME sources internally, which I use for now as a
test case until I introduce test cases directly into TAMER later on (I'd do
it now, if I hadn't spent so much time on this; I'll start introducing tests
as I begin emitting NIR tokens). This is capable of fully parsing our
largest system with >900 packages, as well as `core`.
`tamec`'s lowering is a mess; that'll be cleaned up in future commits. The
same can be said about `tameld`.
NIR's grammar has some initial documentation, but this will improve over
time as well.
The generated docs still need some improvement, too, especially with
generated identifiers; I just want to get this out here for testing.
DEV-7145
2022-08-29 15:28:03 -04:00
|
|
|
Self::XirfParseError(e) => Display::fmt(e, f),
|
|
|
|
Self::NirParseError(e) => Display::fmt(e, f),
|
2022-04-13 15:11:29 -04:00
|
|
|
Self::XirWriterError(e) => Display::fmt(e, f),
|
|
|
|
Self::Fmt(e) => Display::fmt(e, f),
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
impl Error for TamecError {
|
|
|
|
fn source(&self) -> Option<&(dyn Error + 'static)> {
|
|
|
|
match self {
|
|
|
|
Self::Io(e) => Some(e),
|
2022-06-02 10:30:44 -04:00
|
|
|
Self::XirParseError(e) => Some(e),
|
tamer: Introduce NIR (accepting only)
This introduces NIR, but only as an accepting grammar; it doesn't yet emit
the NIR IR, beyond TODOs.
This modifies `tamec` to, while copying XIR, also attempt to lower NIR to
produce parser errors, if any. It does not yet fail compilation, as I just
want to be cautious and observe that everything's working properly for a
little while as people use it, before I potentially break builds.
This is the culmination of months of supporting effort. The NIR grammar is
derived from our existing TAME sources internally, which I use for now as a
test case until I introduce test cases directly into TAMER later on (I'd do
it now, if I hadn't spent so much time on this; I'll start introducing tests
as I begin emitting NIR tokens). This is capable of fully parsing our
largest system with >900 packages, as well as `core`.
`tamec`'s lowering is a mess; that'll be cleaned up in future commits. The
same can be said about `tameld`.
NIR's grammar has some initial documentation, but this will improve over
time as well.
The generated docs still need some improvement, too, especially with
generated identifiers; I just want to get this out here for testing.
DEV-7145
2022-08-29 15:28:03 -04:00
|
|
|
Self::XirfParseError(e) => Some(e),
|
|
|
|
Self::NirParseError(e) => Some(e),
|
2022-04-13 15:11:29 -04:00
|
|
|
Self::XirWriterError(e) => Some(e),
|
|
|
|
Self::Fmt(e) => Some(e),
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
impl Diagnostic for TamecError {
|
|
|
|
fn describe(&self) -> Vec<AnnotatedSpan> {
|
|
|
|
match self {
|
2022-06-02 10:30:44 -04:00
|
|
|
Self::XirParseError(e) => e.describe(),
|
tamer: Introduce NIR (accepting only)
This introduces NIR, but only as an accepting grammar; it doesn't yet emit
the NIR IR, beyond TODOs.
This modifies `tamec` to, while copying XIR, also attempt to lower NIR to
produce parser errors, if any. It does not yet fail compilation, as I just
want to be cautious and observe that everything's working properly for a
little while as people use it, before I potentially break builds.
This is the culmination of months of supporting effort. The NIR grammar is
derived from our existing TAME sources internally, which I use for now as a
test case until I introduce test cases directly into TAMER later on (I'd do
it now, if I hadn't spent so much time on this; I'll start introducing tests
as I begin emitting NIR tokens). This is capable of fully parsing our
largest system with >900 packages, as well as `core`.
`tamec`'s lowering is a mess; that'll be cleaned up in future commits. The
same can be said about `tameld`.
NIR's grammar has some initial documentation, but this will improve over
time as well.
The generated docs still need some improvement, too, especially with
generated identifiers; I just want to get this out here for testing.
DEV-7145
2022-08-29 15:28:03 -04:00
|
|
|
Self::XirfParseError(e) => e.describe(),
|
|
|
|
Self::NirParseError(e) => e.describe(),
|
2022-04-13 15:11:29 -04:00
|
|
|
|
|
|
|
// TODO (will fall back to rendering just the error `Display`)
|
|
|
|
_ => vec![],
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2020-04-08 16:18:18 -04:00
|
|
|
#[cfg(test)]
|
|
|
|
mod test {
|
|
|
|
use super::*;
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn parse_options_help() {
|
|
|
|
let opts = get_opts();
|
|
|
|
let result = parse_options(
|
|
|
|
opts,
|
|
|
|
vec![String::from("program"), String::from("-h")],
|
|
|
|
);
|
|
|
|
|
|
|
|
match result {
|
|
|
|
Ok(Command::Usage) => {}
|
|
|
|
_ => panic!("Long help option did not parse"),
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn parse_options_help_long() {
|
|
|
|
let opts = get_opts();
|
|
|
|
let result = parse_options(
|
|
|
|
opts,
|
|
|
|
vec![String::from("program"), String::from("--help")],
|
|
|
|
);
|
|
|
|
|
|
|
|
match result {
|
|
|
|
Ok(Command::Usage) => {}
|
|
|
|
_ => panic!("Help option did not parse"),
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn parse_options_invalid() {
|
|
|
|
let opts = get_opts();
|
|
|
|
let result = parse_options(
|
|
|
|
opts,
|
|
|
|
vec![String::from("program"), String::from("-q")],
|
|
|
|
);
|
|
|
|
|
|
|
|
match result {
|
|
|
|
Err(Fail::UnrecognizedOption(_)) => {}
|
|
|
|
_ => panic!("Invalid option not caught"),
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn parse_options_missing_input() {
|
|
|
|
let opts = get_opts();
|
|
|
|
let result = parse_options(opts, vec![String::from("program")]);
|
|
|
|
|
|
|
|
match result {
|
|
|
|
Err(Fail::OptionMissing(message)) => {
|
|
|
|
assert_eq!("INPUT", message);
|
|
|
|
}
|
|
|
|
_ => panic!("Missing input not caught"),
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn parse_options_missing_emit() {
|
|
|
|
let opts = get_opts();
|
|
|
|
let result = parse_options(
|
|
|
|
opts,
|
|
|
|
vec![String::from("program"), String::from("filename")],
|
|
|
|
);
|
|
|
|
|
|
|
|
match result {
|
|
|
|
Err(Fail::OptionMissing(message)) => {
|
|
|
|
assert_eq!("--emit xmlo", message);
|
|
|
|
}
|
|
|
|
_ => panic!("Missing emit not caught"),
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn parse_options_invalid_emit() {
|
|
|
|
let opts = get_opts();
|
|
|
|
let result = parse_options(
|
|
|
|
opts,
|
|
|
|
vec![
|
|
|
|
String::from("program"),
|
|
|
|
String::from("filename.xml"),
|
|
|
|
String::from("--emit"),
|
|
|
|
String::from("foo"),
|
|
|
|
],
|
|
|
|
);
|
|
|
|
|
|
|
|
match result {
|
|
|
|
Err(Fail::ArgumentMissing(message)) => {
|
|
|
|
assert_eq!("--emit xmlo", message);
|
|
|
|
}
|
|
|
|
_ => panic!("Invalid emit not caught"),
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn parse_options_too_many_args() {
|
|
|
|
let opts = get_opts();
|
|
|
|
let result = parse_options(
|
|
|
|
opts,
|
|
|
|
vec![
|
|
|
|
String::from("program"),
|
|
|
|
String::from("foo"),
|
|
|
|
String::from("--emit"),
|
|
|
|
String::from("bar"),
|
|
|
|
String::from("baz"),
|
|
|
|
],
|
|
|
|
);
|
|
|
|
|
|
|
|
match result {
|
|
|
|
Err(Fail::UnrecognizedOption(message)) => {
|
|
|
|
assert_eq!("baz", message);
|
|
|
|
}
|
|
|
|
_ => panic!("Extra option not caught"),
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn parse_options_valid() {
|
|
|
|
let opts = get_opts();
|
|
|
|
let xmlo = String::from("xmlo");
|
|
|
|
let result = parse_options(
|
|
|
|
opts,
|
|
|
|
vec![
|
|
|
|
String::from("program"),
|
|
|
|
String::from("foo.xml"),
|
|
|
|
String::from("--emit"),
|
|
|
|
xmlo,
|
|
|
|
],
|
|
|
|
);
|
|
|
|
|
|
|
|
match result {
|
|
|
|
Ok(Command::Compile(infile, xmlo, outfile)) => {
|
|
|
|
assert_eq!("foo.xml", infile);
|
|
|
|
assert_eq!("foo.xmlo", outfile);
|
|
|
|
assert_eq!("xmlo", xmlo);
|
|
|
|
}
|
|
|
|
_ => panic!("Unexpected result"),
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn parse_options_valid_custom_out() {
|
|
|
|
let opts = get_opts();
|
|
|
|
let xmlo = String::from("xmlo");
|
|
|
|
let result = parse_options(
|
|
|
|
opts,
|
|
|
|
vec![
|
|
|
|
String::from("program"),
|
|
|
|
String::from("foo.xml"),
|
|
|
|
String::from("--emit"),
|
|
|
|
xmlo,
|
|
|
|
String::from("-o"),
|
|
|
|
String::from("foo.xmli"),
|
|
|
|
],
|
|
|
|
);
|
|
|
|
|
|
|
|
match result {
|
|
|
|
Ok(Command::Compile(infile, xmlo, outfile)) => {
|
|
|
|
assert_eq!("foo.xml", infile);
|
|
|
|
assert_eq!("foo.xmli", outfile);
|
|
|
|
assert_eq!("xmlo", xmlo);
|
|
|
|
}
|
|
|
|
_ => panic!("Unexpected result"),
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn parse_options_valid_custom_out_long() {
|
|
|
|
let opts = get_opts();
|
|
|
|
let xmlo = String::from("xmlo");
|
|
|
|
let result = parse_options(
|
|
|
|
opts,
|
|
|
|
vec![
|
|
|
|
String::from("program"),
|
|
|
|
String::from("foo.xml"),
|
|
|
|
String::from("--emit"),
|
|
|
|
xmlo,
|
|
|
|
String::from("--output"),
|
|
|
|
String::from("foo.xmli"),
|
|
|
|
],
|
|
|
|
);
|
|
|
|
|
|
|
|
match result {
|
|
|
|
Ok(Command::Compile(infile, xmlo, outfile)) => {
|
|
|
|
assert_eq!("foo.xml", infile);
|
|
|
|
assert_eq!("foo.xmli", outfile);
|
|
|
|
assert_eq!("xmlo", xmlo);
|
|
|
|
}
|
|
|
|
_ => panic!("Unexpected result"),
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|