use crate::core::binary::EncodeOptions; use crate::core::*; use crate::parser::{Parse, Parser, Result}; use crate::token::{Id, Index, NameAnnotation, Span}; use crate::{annotation, kw}; pub use crate::core::resolve::Names; /// A parsed WebAssembly core module. #[derive(Debug)] pub struct Module<'a> { /// Where this `module` was defined pub span: Span, /// An optional identifier this module is known by pub id: Option>, /// An optional `@name` annotation for this module pub name: Option>, /// What kind of module this was parsed as. pub kind: ModuleKind<'a>, } /// The different kinds of ways to define a module. #[derive(Debug)] pub enum ModuleKind<'a> { /// A module defined in the textual s-expression format. Text(Vec>), /// A module that had its raw binary bytes defined via the `binary` /// directive. Binary(Vec<&'a [u8]>), } impl<'a> Module<'a> { /// Performs a name resolution pass on this [`Module`], resolving all /// symbolic names to indices. /// /// The WAT format contains a number of shorthands to make it easier to /// write, such as inline exports, inline imports, inline type definitions, /// etc. Additionally it allows using symbolic names such as `$foo` instead /// of using indices. This module will postprocess an AST to remove all of /// this syntactic sugar, preparing the AST for binary emission. This is /// where expansion and name resolution happens. /// /// This function will mutate the AST of this [`Module`] and replace all /// [`Index`](crate::token::Index) arguments with `Index::Num`. This will /// also expand inline exports/imports listed on fields and handle various /// other shorthands of the text format. /// /// If successful the AST was modified to be ready for binary encoding. A /// [`Names`] structure is also returned so if you'd like to do your own /// name lookups on the result you can do so as well. /// /// # Errors /// /// If an error happens during resolution, such a name resolution error or /// items are found in the wrong order, then an error is returned. pub fn resolve(&mut self) -> std::result::Result, crate::Error> { let names = match &mut self.kind { ModuleKind::Text(fields) => crate::core::resolve::resolve(fields)?, ModuleKind::Binary(_blobs) => Default::default(), }; Ok(names) } /// Encodes this [`Module`] to its binary form. /// /// This function will take the textual representation in [`Module`] and /// perform all steps necessary to convert it to a binary WebAssembly /// module, suitable for writing to a `*.wasm` file. This function may /// internally modify the [`Module`], for example: /// /// * Name resolution is performed to ensure that `Index::Id` isn't present /// anywhere in the AST. /// /// * Inline shorthands such as imports/exports/types are all expanded to be /// dedicated fields of the module. /// /// * Module fields may be shuffled around to preserve index ordering from /// expansions. /// /// After all of this expansion has happened the module will be converted to /// its binary form and returned as a `Vec`. This is then suitable to /// hand off to other wasm runtimes and such. /// /// # Errors /// /// This function can return an error for name resolution errors and other /// expansion-related errors. pub fn encode(&mut self) -> std::result::Result, crate::Error> { EncodeOptions::default().encode_module(self) } pub(crate) fn validate(&self, parser: Parser<'_>) -> Result<()> { let mut starts = 0; if let ModuleKind::Text(fields) = &self.kind { for item in fields.iter() { if let ModuleField::Start(_) = item { starts += 1; } } } if starts > 1 { return Err(parser.error("multiple start sections found")); } Ok(()) } pub(crate) fn parse_without_module_keyword( module_keyword_span: Span, parser: Parser<'a>, ) -> Result { let id = parser.parse()?; let name = parser.parse()?; let kind = if parser.peek::()? { parser.parse::()?; let mut data = Vec::new(); while !parser.is_empty() { data.push(parser.parse()?); } ModuleKind::Binary(data) } else { ModuleKind::Text(ModuleField::parse_remaining(parser)?) }; Ok(Module { span: module_keyword_span, id, name, kind, }) } } impl<'a> Parse<'a> for Module<'a> { fn parse(parser: Parser<'a>) -> Result { parser.with_standard_annotations_registered(|parser| { let span = parser.parse::()?.0; Self::parse_without_module_keyword(span, parser) }) } } /// A listing of all possible fields that can make up a WebAssembly module. #[allow(missing_docs)] #[derive(Debug)] pub enum ModuleField<'a> { Type(Type<'a>), Rec(Rec<'a>), Import(Import<'a>), Func(Func<'a>), Table(Table<'a>), Memory(Memory<'a>), Global(Global<'a>), Export(Export<'a>), Start(Index<'a>), Elem(Elem<'a>), Data(Data<'a>), Tag(Tag<'a>), Custom(Custom<'a>), } impl<'a> ModuleField<'a> { pub(crate) fn parse_remaining(parser: Parser<'a>) -> Result>> { let mut fields = Vec::new(); while !parser.is_empty() { fields.push(parser.parens(ModuleField::parse)?); } Ok(fields) } } impl<'a> Parse<'a> for ModuleField<'a> { fn parse(parser: Parser<'a>) -> Result { if parser.peek::>()? { return Ok(ModuleField::Type(parser.parse()?)); } if parser.peek::()? { return Ok(ModuleField::Rec(parser.parse()?)); } if parser.peek::()? { return Ok(ModuleField::Import(parser.parse()?)); } if parser.peek::()? { return Ok(ModuleField::Func(parser.parse()?)); } if parser.peek::()? { return Ok(ModuleField::Table(parser.parse()?)); } if parser.peek::()? { return Ok(ModuleField::Memory(parser.parse()?)); } if parser.peek::()? { return Ok(ModuleField::Global(parser.parse()?)); } if parser.peek::()? { return Ok(ModuleField::Export(parser.parse()?)); } if parser.peek::()? { parser.parse::()?; return Ok(ModuleField::Start(parser.parse()?)); } if parser.peek::()? { return Ok(ModuleField::Elem(parser.parse()?)); } if parser.peek::()? { return Ok(ModuleField::Data(parser.parse()?)); } if parser.peek::()? { return Ok(ModuleField::Tag(parser.parse()?)); } if parser.peek::()? || parser.peek::()? || parser.peek::()? { return Ok(ModuleField::Custom(parser.parse()?)); } Err(parser.error("expected valid module field")) } }