caisin/typst
1
0
Fork 0
mirror of https://github.com/typst/typst synced 2025-08-15 07:28:32 +08:00
Code Issues Packages Projects Releases Wiki Activity

First version of better error support

Browse Source
This commit is contained in:
Laurenz Stampfl 2025-03-11 10:49:13 +01:00
parent 84dcaaeae2
commit ccec0dedbf
7 changed files with 147 additions and 116 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
Cargo.lock generated
View File

@ -1345,7 +1345,6 @@ dependencies = [
[[package]]
name = "krilla"
version = "0.3.0"
source = "git+https://github.com/LaurenzV/krilla?rev=e7006f2#e7006f2f0ba598bbe426e8d63306fb2e007c4988"
dependencies = [
"base64",
"bumpalo",

2
Cargo.toml
View File

@ -70,7 +70,7 @@ if_chain = "1"
image = { version = "0.25.5", default-features = false, features = ["png", "jpeg", "gif"] }
indexmap = { version = "2", features = ["serde"] }
kamadak-exif = "0.6"
krilla = { git = "https://github.com/LaurenzV/krilla", rev="e7006f2", features = ["svg", "raster-images", "comemo", "rayon"] }
krilla = { path = "../krilla/crates/krilla", features = ["svg", "raster-images", "comemo", "rayon"] }
kurbo = "0.11"
libfuzzer-sys = "0.4"
lipsum = "0.9"

233
crates/typst-pdf/src/convert.rs
View File

@ -1,5 +1,4 @@
use std::collections::{BTreeMap, HashMap, HashSet};
use ecow::EcoVec;
use krilla::annotation::Annotation;
use krilla::destination::{NamedDestination, XyzDestination};
use krilla::error::KrillaError;
@ -7,7 +6,9 @@ use krilla::page::PageLabel;
use krilla::path::PathBuilder;
use krilla::surface::Surface;
use krilla::{Configuration, Document, PageSettings, SerializeSettings, ValidationError};
use typst_library::diag::{bail, SourceResult};
use std::collections::{BTreeMap, HashMap, HashSet};
use std::num::NonZeroU64;
use typst_library::diag::{bail, error, SourceResult};
use typst_library::foundations::NativeElement;
use typst_library::introspection::Location;
use typst_library::layout::{
@ -209,7 +210,8 @@ pub(crate) struct GlobalContext<'a> {
// Note: In theory, the same image can have multiple spans
// if it appears in the document multiple times. We just store the
// first appearance, though.
pub(crate) image_spans: HashMap<krilla::image::Image, Span>,
pub(crate) image_to_spans: HashMap<krilla::image::Image, Span>,
pub(crate) image_spans: HashSet<Span>,
pub(crate) document: &'a PagedDocument,
pub(crate) options: &'a PdfOptions<'a>,
/// Mapping between locations in the document and named destinations.
@ -230,7 +232,8 @@ impl<'a> GlobalContext<'a> {
document,
options,
loc_to_named,
image_spans: HashMap::new(),
image_to_spans: HashMap::new(),
image_spans: HashSet::new(),
languages: BTreeMap::new(),
}
}
@ -258,7 +261,7 @@ pub(crate) fn handle_frame(
if let Some(fill) = fill {
let shape = Geometry::Rect(frame.size()).filled(fill);
handle_shape(fc, &shape, surface, gc)?;
handle_shape(fc, &shape, surface, gc, Span::detached())?;
}
for (point, item) in frame.items() {
@ -268,7 +271,7 @@ pub(crate) fn handle_frame(
match item {
FrameItem::Group(g) => handle_group(fc, g, surface, gc)?,
FrameItem::Text(t) => handle_text(fc, t, surface, gc)?,
FrameItem::Shape(s, _) => handle_shape(fc, s, surface, gc)?,
FrameItem::Shape(s, span) => handle_shape(fc, s, surface, gc, *span)?,
FrameItem::Image(image, size, span) => {
handle_image(gc, fc, image, *size, surface, *span)?
}
@ -331,7 +334,10 @@ fn finish(document: Document, gc: GlobalContext) -> SourceResult<Vec<u8>> {
Err(e) => match e {
KrillaError::FontError(f, s) => {
let font_str = display_font(gc.fonts_backward.get(&f).unwrap());
bail!(Span::detached(), "failed to process font {font_str} ({s})");
bail!(Span::detached(), "failed to process font {font_str} ({s})";
hint: "make sure the font is valid";
hint: "this could also be a bug in the Typst compiler"
);
}
KrillaError::UserError(u) => {
// This is an error which indicates misuse on the typst-pdf side.
@ -340,125 +346,142 @@ fn finish(document: Document, gc: GlobalContext) -> SourceResult<Vec<u8>> {
KrillaError::ValidationError(ve) => {
// We can only produce 1 error, so just take the first one.
let prefix =
format!("validated export for {} failed:", validator.as_str());
format!("validated export with {} failed:", validator.as_str());
match &ve[0] {
ValidationError::TooLongString => {
bail!(Span::detached(), "{prefix} a PDF string longer \
let get_span = |loc: Option<krilla::surface::Location>| {
loc.map(|l| Span::from_raw(NonZeroU64::new(l).unwrap()))
.unwrap_or(Span::detached())
};
let mut errors = ve.iter().map(|e| {
match e {
ValidationError::TooLongString => {
error!(Span::detached(), "{prefix} a PDF string is longer \
than 32767 characters";
hint: "make sure title and author names are short enough");
}
// Should in theory never occur, as krilla always trims font names
ValidationError::TooLongName => {
bail!(Span::detached(), "{prefix} a PDF name longer than 127 characters";
hint: "perhaps a font name is too long");
}
ValidationError::TooLongArray => {
bail!(Span::detached(), "{prefix} a PDF array longer than 8191 elements";
hint: "this can happen if you have a very long text in a single line");
}
ValidationError::TooLongDictionary => {
bail!(Span::detached(), "{prefix} a PDF dictionary had \
hint: "ensure title and author names are short enough")
}
// Should in theory never occur, as krilla always trims font names
ValidationError::TooLongName => {
error!(Span::detached(), "{prefix} a PDF name is longer than 127 characters";
hint: "perhaps a font name is too long")
}
ValidationError::TooLongArray => {
error!(Span::detached(), "{prefix} a PDF array is longer than 8191 elements";
hint: "this can happen if you have a very long text in a single line")
}
ValidationError::TooLongDictionary => {
error!(Span::detached(), "{prefix} a PDF dictionary has \
more than 4095 entries";
hint: "try reducing the complexity of your document");
}
ValidationError::TooLargeFloat => {
bail!(Span::detached(), "{prefix} a PDF float was larger than \
hint: "try reducing the complexity of your document")
}
ValidationError::TooLargeFloat => {
error!(Span::detached(), "{prefix} a PDF float number is larger than \
the allowed limit";
hint: "try exporting using a higher PDF version");
}
ValidationError::TooManyIndirectObjects => {
bail!(Span::detached(), "{prefix} the PDF has too many indirect objects";
hint: "reduce the size of your document");
}
// Can only occur if we have 27+ nested clip paths
ValidationError::TooHighQNestingLevel => {
bail!(Span::detached(), "{prefix} the PDF has too high q nesting";
hint: "reduce the number of nested containers");
}
ValidationError::ContainsPostScript => {
bail!(Span::detached(), "{prefix} the PDF contains PostScript code";
hint: "sweep gradients are not supported in this PDF standard");
}
ValidationError::MissingCMYKProfile => {
bail!(Span::detached(), "{prefix} the PDF is missing a CMYK profile";
hint: "CMYK colors are not yet supported in this export mode");
}
ValidationError::ContainsNotDefGlyph => {
bail!(Span::detached(), "{prefix} the PDF contains the .notdef glyph";
hint: "ensure all text can be displayed using an available font");
}
ValidationError::InvalidCodepointMapping(_, _) => {
bail!(Span::detached(), "{prefix} the PDF contains \
hint: "try exporting using a higher PDF version")
}
ValidationError::TooManyIndirectObjects => {
error!(Span::detached(), "{prefix} the PDF has too many indirect objects";
hint: "reduce the size of your document")
}
// Can only occur if we have 27+ nested clip paths
ValidationError::TooHighQNestingLevel => {
error!(Span::detached(), "{prefix} the PDF has too high q nesting";
hint: "reduce the number of nested containers")
}
ValidationError::ContainsPostScript(loc) => {
error!(get_span(*loc), "{prefix} the PDF contains PostScript code";
hint: "conic gradients are not supported in this PDF standard")
}
ValidationError::MissingCMYKProfile => {
error!(Span::detached(), "{prefix} the PDF is missing a CMYK profile";
hint: "CMYK colors are not yet supported in this export mode")
}
ValidationError::ContainsNotDefGlyph(f, loc, text) => {
let span = get_span(*loc);
let font_str = display_font(gc.fonts_backward.get(&f).unwrap());
error!(span, "{prefix} the text '{text}' cannot be displayed using {font_str}";
hint: "try using a different font"
)
}
ValidationError::InvalidCodepointMapping(_, _, _, loc) => {
error!(get_span(*loc), "{prefix} the PDF contains \
disallowed codepoints or is missing codepoint mappings";
hint: "make sure to not use the unicode characters 0x0, \
0xFEFF or 0xFFFE";
hint: "for complex scripts like indic or arabic, it might \
not be possible to produce a compliant document");
}
ValidationError::UnicodePrivateArea(_, _) => {
bail!(Span::detached(), "{prefix} the PDF contains characters from the \
not be possible to produce a compliant document")
}
ValidationError::UnicodePrivateArea(_, _, _, loc) => {
error!(get_span(*loc), "{prefix} the PDF contains characters from the \
Unicode private area";
hint: "remove the text containing codepoints \
from the Unicode private area");
}
ValidationError::Transparency => {
bail!(Span::detached(), "{prefix} document contains transparency";
from the Unicode private area")
}
ValidationError::Transparency(loc) => {
error!(get_span(*loc), "{prefix} document contains transparency";
hint: "remove any transparency from your \
document (e.g. fills with opacity)";
hint: "you might have to convert certain SVGs into a bitmap image if \
they contain transparency";
hint: "export using a different standard that supports transparency"
);
}
ValidationError::ImageInterpolation => {
bail!(Span::detached(), "{prefix} document contains an image with smooth interpolation";
)
}
ValidationError::ImageInterpolation(loc) => {
error!(get_span(*loc), "{prefix} the image has smooth interpolation";
hint: "such images are not supported in this export mode"
);
}
ValidationError::EmbeddedFile(_) => {
bail!(Span::detached(), "{prefix} document contains an embedded file";
)
}
ValidationError::EmbeddedFile(_) => {
error!(Span::detached(), "{prefix} document contains an embedded file";
hint: "embedded files are not supported in this export mode"
);
}
)
}
// The below errors cannot occur yet, only once Typst supports full PDF/A
// and PDF/UA.
// But let's still add a message just to be on the safe side.
ValidationError::MissingAnnotationAltText => {
bail!(Span::detached(), "{prefix} missing annotation alt text";
hint: "please report this as a bug");
}
ValidationError::MissingAltText => {
bail!(Span::detached(), "{prefix} missing alt text";
hint: "make sure your images and formulas have alt text");
}
ValidationError::NoDocumentLanguage => {
bail!(Span::detached(), "{prefix} missing document language";
hint: "set the language of the document");
// The below errors cannot occur yet, only once Typst supports full PDF/A
// and PDF/UA.
// But let's still add a message just to be on the safe side.
ValidationError::MissingAnnotationAltText => {
error!(Span::detached(), "{prefix} missing annotation alt text";
hint: "please report this as a bug")
}
ValidationError::MissingAltText => {
error!(Span::detached(), "{prefix} missing alt text";
hint: "make sure your images and formulas have alt text")
}
ValidationError::NoDocumentLanguage => {
error!(Span::detached(), "{prefix} missing document language";
hint: "set the language of the document")
}
// Needs to be set by typst-pdf.
ValidationError::MissingHeadingTitle => {
error!(Span::detached(), "{prefix} missing heading title";
hint: "please report this as a bug")
}
ValidationError::MissingDocumentOutline => {
error!(Span::detached(), "{prefix} missing document outline";
hint: "please report this as a bug")
}
ValidationError::MissingTagging => {
error!(Span::detached(), "{prefix} missing document tags";
hint: "please report this as a bug")
}
ValidationError::NoDocumentTitle => {
error!(Span::detached(), "{prefix} missing document title";
hint: "set the title of the document")
}
}
})
.collect::<Vec<_>>();
// Needs to be set by typst-pdf.
ValidationError::MissingHeadingTitle => {
bail!(Span::detached(), "{prefix} missing heading title";
hint: "please report this as a bug");
}
ValidationError::MissingDocumentOutline => {
bail!(Span::detached(), "{prefix} missing document outline";
hint: "please report this as a bug");
}
ValidationError::MissingTagging => {
bail!(Span::detached(), "{prefix} missing document tags";
hint: "please report this as a bug");
}
ValidationError::NoDocumentTitle => {
bail!(Span::detached(), "{prefix} missing document title";
hint: "set the title of the document");
}
}
// Deduplicate errors with unspanned tags.
errors.dedup();
Err(errors.into_iter().collect::<EcoVec<_>>())
}
KrillaError::ImageError(i) => {
let span = gc.image_spans.get(&i).unwrap();
let span = gc.image_to_spans.get(&i).unwrap();
bail!(*span, "failed to process image");
}
},

7
crates/typst-pdf/src/image.rs
View File

@ -25,6 +25,7 @@ pub(crate) fn handle_image(
span: Span,
) -> SourceResult<()> {
surface.push_transform(&fc.state().transform().to_krilla());
surface.set_location(span.into_raw().get());
let interpolate = image.scaling() == Smart::Custom(ImageScaling::Smooth);
@ -35,8 +36,9 @@ pub(crate) fn handle_image(
Some(i) => i,
};
if gc.image_spans.contains_key(&image) {
gc.image_spans.insert(image.clone(), span);
if !gc.image_to_spans.contains_key(&image) {
gc.image_to_spans.insert(image.clone(), span);
gc.image_spans.insert(span);
}
surface.draw_image(image, size.to_krilla());
@ -51,6 +53,7 @@ pub(crate) fn handle_image(
}
surface.pop();
surface.reset_location();
Ok(())
}

11
crates/typst-pdf/src/shape.rs
View File

@ -1,19 +1,21 @@
use crate::convert::{FrameContext, GlobalContext};
use crate::paint;
use crate::util::{convert_path, AbsExt, TransformExt};
use krilla::geom::Rect;
use krilla::path::{Path, PathBuilder};
use krilla::surface::Surface;
use typst_library::diag::SourceResult;
use typst_library::visualize::{Geometry, Shape};
use crate::convert::{FrameContext, GlobalContext};
use crate::paint;
use crate::util::{convert_path, AbsExt, TransformExt};
use typst_syntax::Span;
pub(crate) fn handle_shape(
fc: &mut FrameContext,
shape: &Shape,
surface: &mut Surface,
gc: &mut GlobalContext,
span: Span,
) -> SourceResult<()> {
surface.set_location(span.into_raw().get());
surface.push_transform(&fc.state().transform().to_krilla());
if let Some(path) = convert_geometry(&shape.geometry) {
@ -54,6 +56,7 @@ pub(crate) fn handle_shape(
}
surface.pop();
surface.reset_location();
Ok(())
}

6
crates/typst-pdf/src/text.rs
View File

@ -3,7 +3,7 @@ use std::sync::Arc;
use bytemuck::TransparentWrapper;
use krilla::font::{GlyphId, GlyphUnits};
use krilla::surface::Surface;
use krilla::surface::{Location, Surface};
use typst_library::diag::{bail, SourceResult};
use typst_library::layout::Size;
use typst_library::text::{Font, Glyph, TextItem};
@ -125,4 +125,8 @@ impl krilla::font::Glyph for PdfGlyph {
fn y_advance(&self) -> f32 {
0.0
}
fn location(&self) -> Option<Location> {
Some(self.0.span.0.into_raw().get())
}
}

3
crates/typst-pdf/src/util.rs
View File

@ -113,8 +113,7 @@ impl ColorExt for Color {
/// Display the font family and variant of a font.
pub(crate) fn display_font(font: &Font) -> String {
let font_family = &font.info().family;
let font_variant = font.info().variant;
format!("{font_family} ({font_variant:?})")
format!("{font_family}")
}
/// Build a typst path using a path builder.