Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[fontbe] Validate FEA AST at parse time #706

Merged
merged 1 commit into from
Feb 7, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 30 additions & 17 deletions fontbe/src/features.rs
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ use ordered_float::OrderedFloat;
use fea_rs::{
compile::{error::CompilerError, Compilation, FeatureBuilder, FeatureProvider, VariationInfo},
parse::{FileSystemResolver, SourceLoadError, SourceResolver},
DiagnosticSet, Opts, ParseTree,
DiagnosticSet, GlyphMap, Opts, ParseTree,
};

use fontir::{
Expand Down Expand Up @@ -369,13 +369,7 @@ impl FeatureCompilationWork {
) -> Result<Compilation, Error> {
let var_info = FeaVariationInfo::new(static_metadata);
let feature_writer = FeatureWriter::new(kerns, marks);
// first do the validation pass
let diagnostics = fea_rs::compile::validate(&ast.ast, &marks.glyphmap, Some(&var_info));
if diagnostics.has_errors() {
return Err(CompilerError::ValidationFail(diagnostics).into());
}
log_fea_warnings("validation", &diagnostics);
// then we do the actual compilation pass:
// we've already validated the AST, so we only need to compile
match fea_rs::compile::compile(
&ast.ast,
&marks.glyphmap,
Expand Down Expand Up @@ -435,15 +429,24 @@ impl Work<Context, AnyWorkId, Error> for FeatureParsingWork {
fn exec(&self, context: &Context) -> Result<(), Error> {
let features = context.ir.features.get();
let glyph_order = context.ir.glyph_order.get();
let result = self.parse(&features, &glyph_order);
let static_metadata = context.ir.static_metadata.get();
let glyph_map = glyph_order.iter().map(|g| g.clone().into_inner()).collect();

let result = self.parse(&features, &glyph_map);

if context.flags.contains(Flags::EMIT_DEBUG) {
write_debug_glyph_order(context, &glyph_order);
}
if let FeaturesSource::Memory { fea_content, .. } = features.as_ref() {
write_debug_fea(context, result.is_err(), "compile failed", fea_content);
}
context.fea_ast.set(result?.into());

let ast = result?;
// after parsing we validate; we only need to do this once, and future
// work can trust the AST.
self.validate(&ast, &glyph_map, &static_metadata)?;

context.fea_ast.set(ast.into());
Ok(())
}
}
Expand All @@ -453,21 +456,31 @@ impl FeatureParsingWork {
Box::new(Self {})
}

fn parse(
&self,
features: &FeaturesSource,
glyph_order: &GlyphOrder,
) -> Result<ParseTree, Error> {
fn parse(&self, features: &FeaturesSource, glyph_map: &GlyphMap) -> Result<ParseTree, Error> {
let (resolver, root_path) = get_resolver_and_root_path(features);
let glyph_map = glyph_order.iter().map(|g| g.clone().into_inner()).collect();
let (tree, diagnostics) = fea_rs::parse::parse_root(root_path, Some(&glyph_map), resolver)
let (tree, diagnostics) = fea_rs::parse::parse_root(root_path, Some(glyph_map), resolver)
.map_err(CompilerError::SourceLoad)?;
if diagnostics.has_errors() {
return Err(CompilerError::ParseFail(diagnostics).into());
}
log_fea_warnings("parsing", &diagnostics);
Ok(tree)
}

fn validate(
&self,
ast: &ParseTree,
glyph_map: &GlyphMap,
static_metadata: &StaticMetadata,
) -> Result<(), Error> {
let var_info = FeaVariationInfo::new(static_metadata);
let diagnostics = fea_rs::compile::validate(ast, glyph_map, Some(&var_info));
if diagnostics.has_errors() {
return Err(CompilerError::ValidationFail(diagnostics).into());
}
log_fea_warnings("validation", &diagnostics);
Ok(())
}
}

fn get_resolver_and_root_path(features: &FeaturesSource) -> (Box<dyn SourceResolver>, OsString) {
Expand Down
6 changes: 4 additions & 2 deletions fontbe/src/orchestration.rs
Original file line number Diff line number Diff line change
Expand Up @@ -375,11 +375,13 @@ pub struct FeaRsKerns {
pub lookups: Vec<PairPosBuilder>,
}

/// The Ast for any user features.
/// The abstract syntax tree of any user FEA.
///
/// This is a newtype so that we can implement `Persistable`
/// Before storing the AST, ensure that it has been validated (via [`fea_rs::compile::validate`]).
/// This does not include features that are generated, such as for kerning or marks.
#[derive(Clone, Debug, Serialize, Deserialize, PartialEq)]
pub struct FeaAst {
/// A validated abstract syntax tree.
pub ast: ParseTree,
}

Expand Down
Loading