use crate::FillRule;
use crate::color::ColorSpace;
use crate::context::Context;
use crate::convert::{convert_line_cap, convert_line_join};
use crate::device::Device;
use crate::font::{Font, FontData, FontQuery, StandardFont};
use crate::interpret::path::{
close_path, fill_path, fill_path_impl, fill_stroke_path, stroke_path,
};
use crate::interpret::state::{TextStateFont, handle_gs};
use crate::interpret::text::TextRenderingMode;
use crate::pattern::{Pattern, ShadingPattern};
use crate::shading::Shading;
use crate::util::{OptionLog, RectExt};
use crate::x_object::{FormXObject, ImageXObject, XObject};
use hayro_syntax::content::TypedIter;
use hayro_syntax::content::ops::TypedInstruction;
use hayro_syntax::object::dict::keys::{ANNOTS, AP, AS, F, MCID, N, OC, RECT};
use hayro_syntax::object::{Array, Dict, Name, Object, Rect, Stream, dict_or_stream};
use hayro_syntax::page::{Page, Resources};
use kurbo::{Affine, Point, Shape};
use rustc_hash::FxHashMap;
use smallvec::smallvec;
use std::sync::Arc;
pub(crate) mod path;
pub(crate) mod state;
pub(crate) mod text;
pub use state::ActiveTransferFunction;
pub type FontResolverFn = Arc<dyn Fn(&FontQuery) -> Option<(FontData, u32)> + Send + Sync>;
pub type CMapResolverFn =
Arc<dyn Fn(hayro_cmap::CMapName<'_>) -> Option<&'static [u8]> + Send + Sync>;
pub type WarningSinkFn = Arc<dyn Fn(InterpreterWarning) + Send + Sync>;
#[derive(Clone)]
pub struct InterpreterSettings {
pub font_resolver: FontResolverFn,
pub cmap_resolver: CMapResolverFn,
pub warning_sink: WarningSinkFn,
pub render_annotations: bool,
}
impl Default for InterpreterSettings {
fn default() -> Self {
Self {
#[cfg(not(feature = "embed-fonts"))]
font_resolver: Arc::new(|_| None),
#[cfg(feature = "embed-fonts")]
font_resolver: Arc::new(|query| match query {
FontQuery::Standard(s) => Some(s.get_font_data()),
FontQuery::Fallback(f) => Some(f.pick_standard_font().get_font_data()),
}),
#[cfg(feature = "embed-cmaps")]
cmap_resolver: Arc::new(hayro_cmap::load_embedded),
#[cfg(not(feature = "embed-cmaps"))]
cmap_resolver: Arc::new(|_| None),
warning_sink: Arc::new(|_| {}),
render_annotations: true,
}
}
}
#[derive(Copy, Clone, Debug)]
#[non_exhaustive]
pub enum InterpreterWarning {
UnsupportedFont,
ImageDecodeFailure,
UnresolvedAnnotationAppearance,
}
pub fn interpret_page<'a>(
page: &Page<'a>,
context: &mut Context<'a>,
device: &mut impl Device<'a>,
) {
let resources = page.resources();
interpret(page.typed_operations(), resources, context, device);
if context.settings.render_annotations
&& let Some(annot_arr) = page.raw().get::<Array<'_>>(ANNOTS)
{
for annot in annot_arr.iter::<Dict<'_>>() {
let flags = annot.get::<u32>(F).unwrap_or(0);
if flags & 2 != 0 {
continue;
}
if let Some(apx) = appearance_stream(&annot).and_then(|o| FormXObject::new(&o)) {
let Some(rect) = annot.get::<Rect>(RECT) else {
continue;
};
let annot_rect = rect.to_kurbo();
let transformed_rect = (apx.matrix
* kurbo::Rect::new(
apx.bbox[0] as f64,
apx.bbox[1] as f64,
apx.bbox[2] as f64,
apx.bbox[3] as f64,
)
.to_path(0.1))
.bounding_box();
let affine = Affine::new([
annot_rect.width() / transformed_rect.width(),
0.0,
0.0,
annot_rect.height() / transformed_rect.height(),
annot_rect.x0 - transformed_rect.x0,
annot_rect.y0 - transformed_rect.y0,
]);
context.save_state();
context.pre_concat_affine(affine);
context.push_root_transform();
apx.draw(resources, context, device);
context.pop_root_transform();
context.restore_state(device);
} else if annot.get::<Dict<'_>>(AP).is_some() {
(context.settings.warning_sink)(InterpreterWarning::UnresolvedAnnotationAppearance);
}
}
}
}
fn appearance_stream<'a>(annot: &Dict<'a>) -> Option<Stream<'a>> {
match annot.get::<Dict<'_>>(AP)?.get::<Object<'_>>(N)? {
Object::Stream(stream) => Some(stream),
Object::Dict(states) => annot
.get::<Name<'_>>(AS)
.and_then(|state| states.get::<Stream<'_>>(state))
.or_else(|| states.get::<Stream<'_>>(b"Off")),
_ => None,
}
}
pub fn interpret<'a>(
mut ops: TypedIter<'_>,
resources: &Resources<'a>,
context: &mut Context<'a>,
device: &mut impl Device<'a>,
) {
let num_states = context.num_states();
let mut font_dict_cache = FxHashMap::<Name<'a>, Dict<'a>>::default();
context.save_state();
while let Some(op) = ops.next() {
match op {
TypedInstruction::SaveState(_) => context.save_state(),
TypedInstruction::StrokeColorDeviceRgb(s) => {
context.get_mut().graphics_state.stroke_cs = ColorSpace::device_rgb();
context.get_mut().graphics_state.stroke_color =
smallvec![s.0.as_f32(), s.1.as_f32(), s.2.as_f32()];
context.get_mut().graphics_state.stroke_pattern = None;
}
TypedInstruction::StrokeColorDeviceGray(s) => {
context.get_mut().graphics_state.stroke_cs = ColorSpace::device_gray();
context.get_mut().graphics_state.stroke_color = smallvec![s.0.as_f32()];
context.get_mut().graphics_state.stroke_pattern = None;
}
TypedInstruction::StrokeColorCmyk(s) => {
context.get_mut().graphics_state.stroke_cs = ColorSpace::device_cmyk();
context.get_mut().graphics_state.stroke_color =
smallvec![s.0.as_f32(), s.1.as_f32(), s.2.as_f32(), s.3.as_f32()];
context.get_mut().graphics_state.stroke_pattern = None;
}
TypedInstruction::LineWidth(w) => {
context.get_mut().graphics_state.stroke_props.line_width = w.0.as_f32();
}
TypedInstruction::LineCap(c) => {
context.get_mut().graphics_state.stroke_props.line_cap = convert_line_cap(c);
}
TypedInstruction::LineJoin(j) => {
context.get_mut().graphics_state.stroke_props.line_join = convert_line_join(j);
}
TypedInstruction::MiterLimit(l) => {
context.get_mut().graphics_state.stroke_props.miter_limit = l.0.as_f32();
}
TypedInstruction::Transform(t) => {
context.pre_concat_transform(t);
}
TypedInstruction::RectPath(r) => {
let rect = kurbo::Rect::new(
r.0.as_f64(),
r.1.as_f64(),
r.0.as_f64() + r.2.as_f64(),
r.1.as_f64() + r.3.as_f64(),
)
.to_path(0.1);
context.path_mut().extend(rect);
}
TypedInstruction::MoveTo(m) => {
let p = Point::new(m.0.as_f64(), m.1.as_f64());
*(context.last_point_mut()) = p;
*(context.sub_path_start_mut()) = p;
context.path_mut().move_to(p);
}
TypedInstruction::FillPathEvenOdd(_) => {
fill_path(context, device, FillRule::EvenOdd);
}
TypedInstruction::FillPathNonZero(_) => {
fill_path(context, device, FillRule::NonZero);
}
TypedInstruction::FillPathNonZeroCompatibility(_) => {
fill_path(context, device, FillRule::NonZero);
}
TypedInstruction::FillAndStrokeEvenOdd(_) => {
fill_stroke_path(context, device, FillRule::EvenOdd);
}
TypedInstruction::FillAndStrokeNonZero(_) => {
fill_stroke_path(context, device, FillRule::NonZero);
}
TypedInstruction::CloseAndStrokePath(_) => {
close_path(context);
stroke_path(context, device);
}
TypedInstruction::CloseFillAndStrokeEvenOdd(_) => {
close_path(context);
fill_stroke_path(context, device, FillRule::EvenOdd);
}
TypedInstruction::CloseFillAndStrokeNonZero(_) => {
close_path(context);
fill_stroke_path(context, device, FillRule::NonZero);
}
TypedInstruction::NonStrokeColorDeviceGray(s) => {
context.get_mut().graphics_state.none_stroke_cs = ColorSpace::device_gray();
context.get_mut().graphics_state.non_stroke_color = smallvec![s.0.as_f32()];
context.get_mut().graphics_state.non_stroke_pattern = None;
}
TypedInstruction::NonStrokeColorDeviceRgb(s) => {
context.get_mut().graphics_state.none_stroke_cs = ColorSpace::device_rgb();
context.get_mut().graphics_state.non_stroke_color =
smallvec![s.0.as_f32(), s.1.as_f32(), s.2.as_f32()];
context.get_mut().graphics_state.non_stroke_pattern = None;
}
TypedInstruction::NonStrokeColorCmyk(s) => {
context.get_mut().graphics_state.none_stroke_cs = ColorSpace::device_cmyk();
context.get_mut().graphics_state.non_stroke_color =
smallvec![s.0.as_f32(), s.1.as_f32(), s.2.as_f32(), s.3.as_f32()];
context.get_mut().graphics_state.non_stroke_pattern = None;
}
TypedInstruction::LineTo(m) => {
if !context.path().elements().is_empty() {
let last_point = *context.last_point();
let mut p = Point::new(m.0.as_f64(), m.1.as_f64());
*(context.last_point_mut()) = p;
if last_point == p {
p.x += 0.0001;
}
context.path_mut().line_to(p);
}
}
TypedInstruction::CubicTo(c) => {
if !context.path().elements().is_empty() {
let p1 = Point::new(c.0.as_f64(), c.1.as_f64());
let p2 = Point::new(c.2.as_f64(), c.3.as_f64());
let p3 = Point::new(c.4.as_f64(), c.5.as_f64());
*(context.last_point_mut()) = p3;
context.path_mut().curve_to(p1, p2, p3);
}
}
TypedInstruction::CubicStartTo(c) => {
if !context.path().elements().is_empty() {
let p1 = *context.last_point();
let p2 = Point::new(c.0.as_f64(), c.1.as_f64());
let p3 = Point::new(c.2.as_f64(), c.3.as_f64());
*(context.last_point_mut()) = p3;
context.path_mut().curve_to(p1, p2, p3);
}
}
TypedInstruction::CubicEndTo(c) => {
if !context.path().elements().is_empty() {
let p2 = Point::new(c.0.as_f64(), c.1.as_f64());
let p3 = Point::new(c.2.as_f64(), c.3.as_f64());
*(context.last_point_mut()) = p3;
context.path_mut().curve_to(p2, p3, p3);
}
}
TypedInstruction::ClosePath(_) => {
close_path(context);
}
TypedInstruction::SetGraphicsState(gs) => {
if let Some(gs) = resources
.get_ext_g_state(gs.0)
.warn_none(&format!("failed to get extgstate {}", gs.0.as_str()))
{
handle_gs(&gs, context, resources);
}
}
TypedInstruction::StrokePath(_) => {
stroke_path(context, device);
}
TypedInstruction::EndPath(_) => {
if let Some(clip) = *context.clip()
&& !context.path().elements().is_empty()
{
let clip_path = context.get().ctm * context.path().clone();
context.push_clip_path(clip_path, clip, device);
*(context.clip_mut()) = None;
}
context.path_mut().truncate(0);
}
TypedInstruction::NonStrokeColor(c) => {
let gs = &mut context.get_mut().graphics_state;
gs.non_stroke_color = c.0.into_iter().map(|n| n.as_f32()).collect();
gs.non_stroke_pattern = None;
}
TypedInstruction::StrokeColor(c) => {
let gs = &mut context.get_mut().graphics_state;
gs.stroke_color = c.0.into_iter().map(|n| n.as_f32()).collect();
gs.stroke_pattern = None;
}
TypedInstruction::ClipNonZero(_) => {
*(context.clip_mut()) = Some(FillRule::NonZero);
}
TypedInstruction::ClipEvenOdd(_) => {
*(context.clip_mut()) = Some(FillRule::EvenOdd);
}
TypedInstruction::RestoreState(_) => context.restore_state(device),
TypedInstruction::FlatnessTolerance(_) => {
}
TypedInstruction::ColorSpaceStroke(c) => {
let cs = if let Some(named) = ColorSpace::new_from_name(c.0) {
named
} else {
context
.get_color_space(resources, c.0)
.unwrap_or(ColorSpace::device_gray())
};
if !cs.is_pattern() {
context.get_mut().graphics_state.stroke_pattern = None;
}
context.get_mut().graphics_state.stroke_color = cs.initial_color();
context.get_mut().graphics_state.stroke_cs = cs;
}
TypedInstruction::ColorSpaceNonStroke(c) => {
let cs = if let Some(named) = ColorSpace::new_from_name(c.0) {
named
} else {
context
.get_color_space(resources, c.0)
.unwrap_or(ColorSpace::device_gray())
};
if !cs.is_pattern() {
context.get_mut().graphics_state.non_stroke_pattern = None;
}
context.get_mut().graphics_state.non_stroke_color = cs.initial_color();
context.get_mut().graphics_state.none_stroke_cs = cs;
}
TypedInstruction::DashPattern(p) => {
context.get_mut().graphics_state.stroke_props.dash_offset = p.1.as_f32();
context.get_mut().graphics_state.stroke_props.dash_array =
p.0.iter::<f32>()
.map(|n| if n == 0.0 { 0.01 } else { n })
.collect();
}
TypedInstruction::RenderingIntent(_) => {
}
TypedInstruction::NonStrokeColorNamed(n) => {
context.get_mut().graphics_state.non_stroke_color =
n.0.into_iter().map(|n| n.as_f32()).collect();
context.get_mut().graphics_state.non_stroke_pattern = n.1.and_then(|name| {
resources
.get_pattern(name)
.and_then(|d| Pattern::new(d, context))
});
}
TypedInstruction::StrokeColorNamed(n) => {
context.get_mut().graphics_state.stroke_color =
n.0.into_iter().map(|n| n.as_f32()).collect();
context.get_mut().graphics_state.stroke_pattern = n.1.and_then(|name| {
resources
.get_pattern(name)
.and_then(|d| Pattern::new(d, context))
});
}
TypedInstruction::BeginMarkedContentWithProperties(bdc) => {
let mcid = dict_or_stream(bdc.1).and_then(|(props, _)| props.get::<i32>(MCID));
let oc = bdc
.1
.clone()
.into_name()
.and_then(|name| {
let r = resources.properties.get_ref(name.as_ref())?;
let d = resources
.properties
.get::<Dict<'_>>(name)
.unwrap_or_default();
Some((d, r))
})
.or_else(|| {
let (props, _) = dict_or_stream(bdc.1)?;
let r = props.get_ref(OC)?;
let d = props.get::<Dict<'_>>(OC).unwrap_or_default();
Some((d, r))
});
if let Some((dict, oc_ref)) = oc {
context.ocg_state.begin_ocg(&dict, oc_ref.into());
} else {
context.ocg_state.begin_marked_content();
}
device.begin_marked_content(bdc.0, mcid);
}
TypedInstruction::MarkedContentPointWithProperties(_) => {}
TypedInstruction::EndMarkedContent(_) => {
context.ocg_state.end_marked_content();
device.end_marked_content();
}
TypedInstruction::MarkedContentPoint(_) => {}
TypedInstruction::BeginMarkedContent(bmc) => {
context.ocg_state.begin_marked_content();
device.begin_marked_content(bmc.0, None);
}
TypedInstruction::BeginText(_) => {
context.get_mut().text_state.text_matrix = Affine::IDENTITY;
context.get_mut().text_state.text_line_matrix = Affine::IDENTITY;
}
TypedInstruction::SetTextMatrix(m) => {
let m = Affine::new([
m.0.as_f64(),
m.1.as_f64(),
m.2.as_f64(),
m.3.as_f64(),
m.4.as_f64(),
m.5.as_f64(),
]);
context.get_mut().text_state.text_line_matrix = m;
context.get_mut().text_state.text_matrix = m;
}
TypedInstruction::EndText(_) => {
let has_outline = context
.get()
.text_state
.clip_paths
.segments()
.next()
.is_some();
if has_outline {
let clip_path = context.get().ctm * context.get().text_state.clip_paths.clone();
context.push_clip_path(clip_path, FillRule::NonZero, device);
}
context.get_mut().text_state.clip_paths.truncate(0);
}
TypedInstruction::TextFont(t) => {
let name = t.0;
let font = if let Some(font_dict) = font_dict_cache.get(name).cloned() {
context.resolve_font(&font_dict)
} else if let Some(font_dict) = resources.get_font(name) {
font_dict_cache.insert(name.clone(), font_dict.clone());
context.resolve_font(&font_dict)
} else {
Font::new_standard(StandardFont::Helvetica, &context.settings.font_resolver)
.map(TextStateFont::Fallback)
};
context.get_mut().text_state.font_size = t.1.as_f32();
context.get_mut().text_state.font = font;
}
TypedInstruction::ShowText(s) => {
if context.get().text_state.font.is_none() {
context.get_mut().text_state.font = Font::new_standard(
StandardFont::Helvetica,
&context.settings.font_resolver,
)
.map(TextStateFont::Fallback);
}
text::show_text_string(context, device, resources, s.0);
}
TypedInstruction::ShowTexts(s) => {
if context.get().text_state.font.is_none() {
context.get_mut().text_state.font = Font::new_standard(
StandardFont::Helvetica,
&context.settings.font_resolver,
)
.map(TextStateFont::Fallback);
}
text::begin_glyph_run(context);
for obj in s.0.iter::<Object<'_>>() {
match obj {
Object::Number(num) => {
text::apply_glyph_run_adjustment(context, num.as_f32());
}
Object::String(text) => {
text::append_text_string(context, resources, &text);
}
_ => {}
}
}
text::show_glyph_run(context, device);
}
TypedInstruction::HorizontalScaling(h) => {
context.get_mut().text_state.horizontal_scaling = h.0.as_f32();
}
TypedInstruction::TextLeading(tl) => {
context.get_mut().text_state.leading = tl.0.as_f32();
}
TypedInstruction::CharacterSpacing(c) => {
context.get_mut().text_state.char_space = c.0.as_f32();
}
TypedInstruction::WordSpacing(w) => {
context.get_mut().text_state.word_space = w.0.as_f32();
}
TypedInstruction::NextLine(n) => {
let (tx, ty) = (n.0.as_f64(), n.1.as_f64());
text::next_line(context, tx, ty);
}
TypedInstruction::NextLineUsingLeading(_) => {
text::next_line(context, 0.0, -context.get().text_state.leading as f64);
}
TypedInstruction::NextLineAndShowText(n) => {
text::next_line(context, 0.0, -context.get().text_state.leading as f64);
text::show_text_string(context, device, resources, n.0);
}
TypedInstruction::TextRenderingMode(r) => {
let mode = match r.0.as_i64() {
0 => TextRenderingMode::Fill,
1 => TextRenderingMode::Stroke,
2 => TextRenderingMode::FillStroke,
3 => TextRenderingMode::Invisible,
4 => TextRenderingMode::FillAndClip,
5 => TextRenderingMode::StrokeAndClip,
6 => TextRenderingMode::FillAndStrokeAndClip,
7 => TextRenderingMode::Clip,
_ => {
warn!("unknown text rendering mode {}", r.0.as_i64());
TextRenderingMode::Fill
}
};
context.get_mut().text_state.render_mode = mode;
}
TypedInstruction::NextLineAndSetLeading(n) => {
let (tx, ty) = (n.0.as_f64(), n.1.as_f64());
context.get_mut().text_state.leading = -ty as f32;
text::next_line(context, tx, ty);
}
TypedInstruction::ShapeGlyph(_) => {}
TypedInstruction::XObject(x) => {
let cache = context.interpreter_cache.object_cache.clone();
let warning_sink = context.settings.warning_sink.clone();
let transfer_function = context.get().graphics_state.transfer_function.clone();
if let Some(x_object) = resources.get_x_object(x.0).and_then(|s| {
XObject::new(
&s,
|name| context.get_color_space(resources, name),
&warning_sink,
&cache,
transfer_function.clone(),
)
}) {
x_object.draw(resources, context, device);
}
}
TypedInstruction::InlineImage(i) => {
let warning_sink = context.settings.warning_sink.clone();
let transfer_function = context.get().graphics_state.transfer_function.clone();
let cache = context.interpreter_cache.object_cache.clone();
if let Some(x_object) = ImageXObject::new(
i.0,
|name| context.get_color_space(resources, name),
&warning_sink,
&cache,
transfer_function,
) {
x_object.draw(context, device);
}
}
TypedInstruction::TextRise(t) => {
context.get_mut().text_state.rise = t.0.as_f32();
}
TypedInstruction::Shading(s) => {
if !context.ocg_state.is_visible() {
continue;
}
let transfer_function = context.get().graphics_state.transfer_function.clone();
if let Some(sp) = resources
.get_shading(s.0)
.and_then(|o| {
let (dict, stream) = dict_or_stream(&o)?;
Shading::new(dict, stream, &context.interpreter_cache.object_cache)
})
.map(|s| {
Pattern::Shading(ShadingPattern {
shading: Arc::new(s),
matrix: Affine::IDENTITY,
opacity: context.get().graphics_state.non_stroke_alpha,
transfer_function: transfer_function.clone(),
})
})
{
context.save_state();
context.push_root_transform();
let st = context.get_mut();
st.graphics_state.non_stroke_pattern = Some(sp);
st.graphics_state.none_stroke_cs = ColorSpace::pattern();
let bbox = context.bbox().to_path(0.1);
let inverted_bbox = context.get().ctm.inverse() * bbox;
fill_path_impl(context, device, FillRule::NonZero, Some(&inverted_bbox));
context.pop_root_transform();
context.restore_state(device);
} else {
warn!("failed to process shading");
}
}
TypedInstruction::BeginCompatibility(_) => {}
TypedInstruction::EndCompatibility(_) => {}
TypedInstruction::ColorGlyph(_) => {}
TypedInstruction::ShowTextWithParameters(t) => {
context.get_mut().text_state.word_space = t.0.as_f32();
context.get_mut().text_state.char_space = t.1.as_f32();
text::next_line(context, 0.0, -context.get().text_state.leading as f64);
text::show_text_string(context, device, resources, t.2);
}
_ => {
warn!("failed to read an operator");
}
}
}
while context.num_states() > num_states {
context.restore_state(device);
}
}