8d6d59cc7a
Comments preceding the first function are not associated with any specific entity in the file. Put them in a TestFile::preamble_comments field.
59 lines
2.1 KiB
Rust
59 lines
2.1 KiB
Rust
//! Data structures representing a parsed test file.
|
|
//!
|
|
//! A test file is a `.cton` file which contains test commands and settings for running a
|
|
//! file-based test case.
|
|
//!
|
|
|
|
use cretonne::ir::Function;
|
|
use cretonne::ir::entities::AnyEntity;
|
|
use testcommand::TestCommand;
|
|
use isaspec::IsaSpec;
|
|
use sourcemap::SourceMap;
|
|
use error::Location;
|
|
|
|
/// A parsed test case.
|
|
///
|
|
/// This is the result of parsing a `.cton` 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,
|
|
/// 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 source entity numbers to parsed entity numbers.
|
|
/// Source locations of parsed entities.
|
|
pub map: SourceMap,
|
|
}
|
|
|
|
/// A comment in a parsed function.
|
|
///
|
|
/// The comment belongs to the immediately preceeding 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,
|
|
}
|