04b10b3fde
Cranelift can be compiled with feature flags which can change its output. To accomodate changes of output related to feature flags, test file can now include `feature "..."` and `feature ! "..."` directives in the preamble of the test file. The test runner would skip the test if the flag does not match the expectation of the test case.
74 lines
2.7 KiB
Rust
74 lines
2.7 KiB
Rust
//! Data structures representing a parsed test file.
|
|
//!
|
|
//! A test file is a `.clif` file which contains test commands and settings for running a
|
|
//! file-based test case.
|
|
//!
|
|
|
|
use crate::error::Location;
|
|
use crate::isaspec::IsaSpec;
|
|
use crate::sourcemap::SourceMap;
|
|
use crate::testcommand::TestCommand;
|
|
use cranelift_codegen::ir::entities::AnyEntity;
|
|
use cranelift_codegen::ir::Function;
|
|
|
|
/// A parsed test case.
|
|
///
|
|
/// This is the result of parsing a `.clif` file which contains a number of test commands and ISA
|
|
/// specs followed by the functions that should be tested.
|
|
pub struct TestFile<'a> {
|
|
/// `test foo ...` lines.
|
|
pub commands: Vec<TestCommand<'a>>,
|
|
/// `isa bar ...` lines.
|
|
pub isa_spec: IsaSpec,
|
|
/// `feature ...` lines
|
|
pub features: Vec<Feature<'a>>,
|
|
/// Comments appearing before the first function.
|
|
/// These are all tagged as 'Function' scope for lack of a better entity.
|
|
pub preamble_comments: Vec<Comment<'a>>,
|
|
/// Parsed functions and additional details about each function.
|
|
pub functions: Vec<(Function, Details<'a>)>,
|
|
}
|
|
|
|
/// Additional details about a function parsed from a text string.
|
|
/// These are useful for detecting test commands embedded in comments etc.
|
|
/// The details to not affect the semantics of the function.
|
|
#[derive(Debug)]
|
|
pub struct Details<'a> {
|
|
/// Location of the `function` keyword that begins this function.
|
|
pub location: Location,
|
|
/// Annotation comments that appeared inside or after the function.
|
|
pub comments: Vec<Comment<'a>>,
|
|
/// Mapping of entity numbers to source locations.
|
|
pub map: SourceMap,
|
|
}
|
|
|
|
/// A comment in a parsed function.
|
|
///
|
|
/// The comment belongs to the immediately preceding entity, whether that is an EBB header, and
|
|
/// instruction, or one of the preamble declarations.
|
|
///
|
|
/// Comments appearing inside the function but before the preamble, as well as comments appearing
|
|
/// after the function are tagged as `AnyEntity::Function`.
|
|
#[derive(Clone, PartialEq, Eq, Debug)]
|
|
pub struct Comment<'a> {
|
|
/// The entity this comment is attached to.
|
|
/// Comments always follow their entity.
|
|
pub entity: AnyEntity,
|
|
/// Text of the comment, including the leading `;`.
|
|
pub text: &'a str,
|
|
}
|
|
|
|
/// A cranelift feature in a test file preamble.
|
|
///
|
|
/// This represents the expectation of the test case. Before running any of the
|
|
/// functions of the test file, the feature set should be compared with the
|
|
/// feature set used to compile Cranelift. If there is any differences, then the
|
|
/// test file should be skipped.
|
|
#[derive(PartialEq, Eq, Debug)]
|
|
pub enum Feature<'a> {
|
|
/// `feature "..."` lines
|
|
With(&'a str),
|
|
/// `feature ! "..."` lines.
|
|
Without(&'a str),
|
|
}
|