Compare commits

...

6 Commits

Author SHA1 Message Date
Malo
d752f6f1e7
Merge 44bb2da4624b2d0114c049bb2bd2394e2ca0399e into 9a6268050fb769e18c4889fa5f59d4150e8878d6 2025-07-15 19:06:49 +03:00
Laurenz
9a6268050f
HTML frame improvements (#6605) 2025-07-15 14:48:31 +00:00
Malo
44bb2da462 Improve target documentations 2025-06-26 20:06:16 +01:00
Malo
54809020bf Make --target optional 2025-06-26 20:04:46 +01:00
Malo
fee95dd0b0 Merge branch 'main' into query-html-export
# Conflicts:
#	crates/typst-cli/src/query.rs
#	crates/typst-library/src/diag.rs
2025-06-24 19:44:59 +01:00
Malo
8684daa17c Add --target argument for typst query 2025-06-07 19:33:12 +01:00
9 changed files with 107 additions and 28 deletions

View File

@ -155,6 +155,10 @@ pub struct QueryCommand {
#[clap(long)] #[clap(long)]
pub pretty: bool, pub pretty: bool,
/// The target to compile for.
#[clap(long, default_value_t)]
pub target: Target,
/// World arguments. /// World arguments.
#[clap(flatten)] #[clap(flatten)]
pub world: WorldArgs, pub world: WorldArgs,
@ -457,6 +461,18 @@ pub enum OutputFormat {
display_possible_values!(OutputFormat); display_possible_values!(OutputFormat);
/// The target to compile for.
#[derive(Debug, Default, Copy, Clone, Eq, PartialEq, Ord, PartialOrd, ValueEnum)]
pub enum Target {
/// PDF and image formats.
#[default]
Paged,
/// HTML.
Html,
}
display_possible_values!(Target);
/// Which format to use for diagnostics. /// Which format to use for diagnostics.
#[derive(Debug, Default, Copy, Clone, Eq, PartialEq, Ord, PartialOrd, ValueEnum)] #[derive(Debug, Default, Copy, Clone, Eq, PartialEq, Ord, PartialOrd, ValueEnum)]
pub enum DiagnosticFormat { pub enum DiagnosticFormat {

View File

@ -4,12 +4,13 @@ use serde::Serialize;
use typst::diag::{bail, HintedStrResult, StrResult, Warned}; use typst::diag::{bail, HintedStrResult, StrResult, Warned};
use typst::engine::Sink; use typst::engine::Sink;
use typst::foundations::{Content, IntoValue, LocatableSelector, Scope}; use typst::foundations::{Content, IntoValue, LocatableSelector, Scope};
use typst::html::HtmlDocument;
use typst::layout::PagedDocument; use typst::layout::PagedDocument;
use typst::syntax::{Span, SyntaxMode}; use typst::syntax::{Span, SyntaxMode};
use typst::World; use typst::{Document, World};
use typst_eval::eval_string; use typst_eval::eval_string;
use crate::args::{QueryCommand, SerializationFormat}; use crate::args::{QueryCommand, SerializationFormat, Target};
use crate::compile::print_diagnostics; use crate::compile::print_diagnostics;
use crate::set_failed; use crate::set_failed;
use crate::world::SystemWorld; use crate::world::SystemWorld;
@ -22,12 +23,17 @@ pub fn query(command: &QueryCommand) -> HintedStrResult<()> {
world.reset(); world.reset();
world.source(world.main()).map_err(|err| err.to_string())?; world.source(world.main()).map_err(|err| err.to_string())?;
let Warned { output, warnings } = typst::compile(&world); let Warned { output, warnings } = match command.target {
Target::Paged => typst::compile::<PagedDocument>(&world)
.map(|output| output.map(|document| retrieve(&world, command, &document))),
Target::Html => typst::compile::<HtmlDocument>(&world)
.map(|output| output.map(|document| retrieve(&world, command, &document))),
};
match output { match output {
// Retrieve and print query results. // Retrieve and print query results.
Ok(document) => { Ok(data) => {
let data = retrieve(&world, command, &document)?; let data = data?;
let serialized = format(data, command)?; let serialized = format(data, command)?;
println!("{serialized}"); println!("{serialized}");
print_diagnostics(&world, &[], &warnings, command.process.diagnostic_format) print_diagnostics(&world, &[], &warnings, command.process.diagnostic_format)
@ -51,10 +57,10 @@ pub fn query(command: &QueryCommand) -> HintedStrResult<()> {
} }
/// Retrieve the matches for the selector. /// Retrieve the matches for the selector.
fn retrieve( fn retrieve<D: Document>(
world: &dyn World, world: &dyn World,
command: &QueryCommand, command: &QueryCommand,
document: &PagedDocument, document: &D,
) -> HintedStrResult<Vec<Content>> { ) -> HintedStrResult<Vec<Content>> {
let selector = eval_string( let selector = eval_string(
&typst::ROUTINES, &typst::ROUTINES,
@ -77,7 +83,7 @@ fn retrieve(
.cast::<LocatableSelector>()?; .cast::<LocatableSelector>()?;
Ok(document Ok(document
.introspector .introspector()
.query(&selector.0) .query(&selector.0)
.into_iter() .into_iter()
.collect::<Vec<_>>()) .collect::<Vec<_>>())

View File

@ -109,10 +109,7 @@ fn handle(
styles.chain(&style), styles.chain(&style),
Region::new(Size::splat(Abs::inf()), Axes::splat(false)), Region::new(Size::splat(Abs::inf()), Axes::splat(false)),
)?; )?;
output.push(HtmlNode::Frame(HtmlFrame { output.push(HtmlNode::Frame(HtmlFrame::new(frame, styles)));
inner: frame,
text_size: styles.resolve(TextElem::size),
}));
} else { } else {
engine.sink.warn(warning!( engine.sink.warn(warning!(
child.span(), child.span(),

View File

@ -2,10 +2,11 @@ use std::fmt::{self, Debug, Display, Formatter};
use ecow::{EcoString, EcoVec}; use ecow::{EcoString, EcoVec};
use typst_library::diag::{bail, HintedStrResult, StrResult}; use typst_library::diag::{bail, HintedStrResult, StrResult};
use typst_library::foundations::{cast, Dict, Repr, Str}; use typst_library::foundations::{cast, Dict, Repr, Str, StyleChain};
use typst_library::introspection::{Introspector, Tag}; use typst_library::introspection::{Introspector, Tag};
use typst_library::layout::{Abs, Frame}; use typst_library::layout::{Abs, Frame};
use typst_library::model::DocumentInfo; use typst_library::model::DocumentInfo;
use typst_library::text::TextElem;
use typst_syntax::Span; use typst_syntax::Span;
use typst_utils::{PicoStr, ResolvedPicoStr}; use typst_utils::{PicoStr, ResolvedPicoStr};
@ -279,3 +280,10 @@ pub struct HtmlFrame {
/// consistently. /// consistently.
pub text_size: Abs, pub text_size: Abs,
} }
impl HtmlFrame {
/// Wraps a laid-out frame.
pub fn new(inner: Frame, styles: StyleChain) -> Self {
Self { inner, text_size: styles.resolve(TextElem::size) }
}
}

View File

@ -121,6 +121,7 @@ fn write_children(w: &mut Writer, element: &HtmlElement) -> SourceResult<()> {
let pretty_inside = allows_pretty_inside(element.tag) let pretty_inside = allows_pretty_inside(element.tag)
&& element.children.iter().any(|node| match node { && element.children.iter().any(|node| match node {
HtmlNode::Element(child) => wants_pretty_around(child.tag), HtmlNode::Element(child) => wants_pretty_around(child.tag),
HtmlNode::Frame(_) => true,
_ => false, _ => false,
}); });
@ -305,14 +306,6 @@ fn write_escape(w: &mut Writer, c: char) -> StrResult<()> {
/// Encode a laid out frame into the writer. /// Encode a laid out frame into the writer.
fn write_frame(w: &mut Writer, frame: &HtmlFrame) { fn write_frame(w: &mut Writer, frame: &HtmlFrame) {
// FIXME: This string replacement is obviously a hack. let svg = typst_svg::svg_html_frame(&frame.inner, frame.text_size);
let svg = typst_svg::svg_frame(&frame.inner).replace(
"<svg class",
&format!(
"<svg style=\"overflow: visible; width: {}em; height: {}em;\" class",
frame.inner.width() / frame.text_size,
frame.inner.height() / frame.text_size,
),
);
w.buf.push_str(&svg); w.buf.push_str(&svg);
} }

View File

@ -151,6 +151,13 @@ pub struct Warned<T> {
pub warnings: EcoVec<SourceDiagnostic>, pub warnings: EcoVec<SourceDiagnostic>,
} }
impl<T> Warned<T> {
/// Maps the output, keeping the same warnings.
pub fn map<R, F: FnOnce(T) -> R>(self, f: F) -> Warned<R> {
Warned { output: f(self.output), warnings: self.warnings }
}
}
/// An error or warning in a source or text file. /// An error or warning in a source or text file.
/// ///
/// The contained spans will only be detached if any of the input source files /// The contained spans will only be detached if any of the input source files

View File

@ -45,6 +45,30 @@ pub fn svg_frame(frame: &Frame) -> String {
renderer.finalize() renderer.finalize()
} }
/// Export a frame into an SVG suitable for embedding into HTML.
#[typst_macros::time(name = "svg html frame")]
pub fn svg_html_frame(frame: &Frame, text_size: Abs) -> String {
let mut renderer = SVGRenderer::with_options(xmlwriter::Options {
indent: xmlwriter::Indent::None,
..Default::default()
});
renderer.write_header_with_custom_attrs(frame.size(), |xml| {
xml.write_attribute("class", "typst-frame");
xml.write_attribute_fmt(
"style",
format_args!(
"overflow: visible; width: {}em; height: {}em;",
frame.width() / text_size,
frame.height() / text_size,
),
);
});
let state = State::new(frame.size(), Transform::identity());
renderer.render_frame(state, Transform::identity(), frame);
renderer.finalize()
}
/// Export a document with potentially multiple pages into a single SVG file. /// Export a document with potentially multiple pages into a single SVG file.
/// ///
/// The padding will be added around and between the individual frames. /// The padding will be added around and between the individual frames.
@ -158,8 +182,13 @@ impl State {
impl SVGRenderer { impl SVGRenderer {
/// Create a new SVG renderer with empty glyph and clip path. /// Create a new SVG renderer with empty glyph and clip path.
fn new() -> Self { fn new() -> Self {
Self::with_options(Default::default())
}
/// Create a new SVG renderer with the given configuration.
fn with_options(options: xmlwriter::Options) -> Self {
SVGRenderer { SVGRenderer {
xml: XmlWriter::new(xmlwriter::Options::default()), xml: XmlWriter::new(options),
glyphs: Deduplicator::new('g'), glyphs: Deduplicator::new('g'),
clip_paths: Deduplicator::new('c'), clip_paths: Deduplicator::new('c'),
gradient_refs: Deduplicator::new('g'), gradient_refs: Deduplicator::new('g'),
@ -170,11 +199,22 @@ impl SVGRenderer {
} }
} }
/// Write the SVG header, including the `viewBox` and `width` and `height` /// Write the default SVG header, including a `typst-doc` class, the
/// attributes. /// `viewBox` and `width` and `height` attributes.
fn write_header(&mut self, size: Size) { fn write_header(&mut self, size: Size) {
self.write_header_with_custom_attrs(size, |xml| {
xml.write_attribute("class", "typst-doc");
});
}
/// Write the SVG header with additional attributes and standard attributes.
fn write_header_with_custom_attrs(
&mut self,
size: Size,
write_custom_attrs: impl FnOnce(&mut XmlWriter),
) {
self.xml.start_element("svg"); self.xml.start_element("svg");
self.xml.write_attribute("class", "typst-doc"); write_custom_attrs(&mut self.xml);
self.xml.write_attribute_fmt( self.xml.write_attribute_fmt(
"viewBox", "viewBox",
format_args!("0 0 {} {}", size.x.to_pt(), size.y.to_pt()), format_args!("0 0 {} {}", size.x.to_pt(), size.y.to_pt()),

View File

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
</head>
<body>
<p>A rectangle:</p>
<svg class="typst-frame" style="overflow: visible; width: 4.5em; height: 3em;" viewBox="0 0 45 30" width="45pt" height="30pt" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:h5="http://www.w3.org/1999/xhtml"><g><g transform="translate(-0 -0)"><path class="typst-shape" fill="none" stroke="#000000" stroke-width="1" stroke-linecap="butt" stroke-linejoin="miter" stroke-miterlimit="4" d="M 0 0 L 0 30 L 45 30 L 45 0 Z "/></g></g></svg>
</body>
</html>

View File

@ -1,5 +1,6 @@
// No proper HTML tests here yet because we don't want to test SVG export just --- html-frame html ---
// yet. We'll definitely add tests at some point. A rectangle:
#html.frame(rect())
--- html-frame-in-layout --- --- html-frame-in-layout ---
// Ensure that HTML frames are transparent in layout. This is less important for // Ensure that HTML frames are transparent in layout. This is less important for