mirror of
https://github.com/typst/typst
synced 2025-08-24 19:54:14 +08:00
Getter methods for previously non-#[internal]
#[synthesized]
fields
This commit is contained in:
parent
7576d3bc61
commit
d084926ffc
@ -7,6 +7,7 @@ use typst_utils::NonZeroExt;
|
|||||||
|
|
||||||
use crate::diag::{bail, SourceResult};
|
use crate::diag::{bail, SourceResult};
|
||||||
use crate::engine::Engine;
|
use crate::engine::Engine;
|
||||||
|
use crate::foundations::func;
|
||||||
use crate::foundations::{
|
use crate::foundations::{
|
||||||
cast, elem, scope, select_where, Content, Element, NativeElement, Packed, Selector,
|
cast, elem, scope, select_where, Content, Element, NativeElement, Packed, Selector,
|
||||||
Show, ShowSet, Smart, StyleChain, Styles, Synthesize, TargetElem,
|
Show, ShowSet, Smart, StyleChain, Styles, Synthesize, TargetElem,
|
||||||
@ -238,7 +239,7 @@ pub struct FigureElem {
|
|||||||
/// These are the counters you'll need to modify if you want to skip a
|
/// These are the counters you'll need to modify if you want to skip a
|
||||||
/// number or reset the counter.
|
/// number or reset the counter.
|
||||||
#[synthesized]
|
#[synthesized]
|
||||||
pub counter: Option<Counter>,
|
pub counter: Counter,
|
||||||
}
|
}
|
||||||
|
|
||||||
#[scope]
|
#[scope]
|
||||||
@ -312,15 +313,21 @@ impl Synthesize for Packed<FigureElem> {
|
|||||||
if let Some(caption) = &mut caption {
|
if let Some(caption) = &mut caption {
|
||||||
caption.synthesize(engine, styles)?;
|
caption.synthesize(engine, styles)?;
|
||||||
caption.push_kind(kind.clone());
|
caption.push_kind(kind.clone());
|
||||||
caption.push_supplement(supplement.clone());
|
if let Some(supplement) = supplement.clone() {
|
||||||
caption.push_numbering(numbering.clone());
|
caption.push_supplement(supplement);
|
||||||
caption.push_counter(Some(counter.clone()));
|
}
|
||||||
caption.push_figure_location(location);
|
if let Some(numbering) = numbering.clone() {
|
||||||
|
caption.push_numbering(numbering);
|
||||||
|
}
|
||||||
|
caption.push_counter(counter.clone());
|
||||||
|
if let Some(location) = location {
|
||||||
|
caption.push_figure_location(location);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
elem.push_kind(Smart::Custom(kind));
|
elem.push_kind(Smart::Custom(kind));
|
||||||
elem.push_supplement(Smart::Custom(supplement.map(Supplement::Content)));
|
elem.push_supplement(Smart::Custom(supplement.map(Supplement::Content)));
|
||||||
elem.push_counter(Some(counter));
|
elem.push_counter(counter);
|
||||||
elem.push_caption(caption);
|
elem.push_caption(caption);
|
||||||
|
|
||||||
Ok(())
|
Ok(())
|
||||||
@ -420,7 +427,6 @@ impl Refable for Packed<FigureElem> {
|
|||||||
(**self)
|
(**self)
|
||||||
.counter()
|
.counter()
|
||||||
.cloned()
|
.cloned()
|
||||||
.flatten()
|
|
||||||
.unwrap_or_else(|| Counter::of(FigureElem::elem()))
|
.unwrap_or_else(|| Counter::of(FigureElem::elem()))
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -470,7 +476,7 @@ impl Outlinable for Packed<FigureElem> {
|
|||||||
/// caption: [A rectangle],
|
/// caption: [A rectangle],
|
||||||
/// )
|
/// )
|
||||||
/// ```
|
/// ```
|
||||||
#[elem(name = "caption", Synthesize, Show)]
|
#[elem(scope, name = "caption", Synthesize, Show)]
|
||||||
pub struct FigureCaption {
|
pub struct FigureCaption {
|
||||||
/// The caption's position in the figure. Either `{top}` or `{bottom}`.
|
/// The caption's position in the figure. Either `{top}` or `{bottom}`.
|
||||||
///
|
///
|
||||||
@ -541,20 +547,72 @@ pub struct FigureCaption {
|
|||||||
|
|
||||||
/// The figure's supplement.
|
/// The figure's supplement.
|
||||||
#[synthesized]
|
#[synthesized]
|
||||||
pub supplement: Option<Content>,
|
pub supplement: Content,
|
||||||
|
|
||||||
/// How to number the figure.
|
/// How to number the figure.
|
||||||
#[synthesized]
|
#[synthesized]
|
||||||
pub numbering: Option<Numbering>,
|
pub numbering: Numbering,
|
||||||
|
|
||||||
/// The counter for the figure.
|
/// The counter for the figure.
|
||||||
#[synthesized]
|
#[synthesized]
|
||||||
pub counter: Option<Counter>,
|
pub counter: Counter,
|
||||||
|
|
||||||
/// The figure's location.
|
/// The figure's location.
|
||||||
#[internal]
|
#[internal]
|
||||||
#[synthesized]
|
#[synthesized]
|
||||||
pub figure_location: Option<Location>,
|
pub figure_location: Location,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[scope]
|
||||||
|
impl FigureCaption {
|
||||||
|
/// The kind of the corresponding figure.
|
||||||
|
///
|
||||||
|
/// This returns `{none}` in case the corresponding figure does not appear
|
||||||
|
/// in the document.
|
||||||
|
#[func]
|
||||||
|
pub fn kind_(self) -> Option<FigureKind> {
|
||||||
|
self.kind
|
||||||
|
}
|
||||||
|
|
||||||
|
/// The supplement of the corresponding figure.
|
||||||
|
///
|
||||||
|
/// This returns `{none}` in case the corresponding figure does not appear
|
||||||
|
/// in the document.
|
||||||
|
#[func]
|
||||||
|
pub fn supplement_(self) -> Option<Content> {
|
||||||
|
self.supplement
|
||||||
|
}
|
||||||
|
|
||||||
|
/// The numbering of the corresponding figure.
|
||||||
|
///
|
||||||
|
/// This returns `{none}` in case the corresponding figure does not appear
|
||||||
|
/// in the document.
|
||||||
|
#[func]
|
||||||
|
pub fn numbering_(self) -> Option<Numbering> {
|
||||||
|
self.numbering
|
||||||
|
}
|
||||||
|
|
||||||
|
/// The counter for the corresponding figure:
|
||||||
|
/// `{counter(figure.where(kind: kind))}` for a figure of kind `{kind}`.
|
||||||
|
///
|
||||||
|
/// For example, for a table figure, this returns
|
||||||
|
/// `{counter(figure.where(kind: table))}`.
|
||||||
|
///
|
||||||
|
/// This returns `{none}` in case the corresponding figure does not appear
|
||||||
|
/// in the document, or it is not numbered.
|
||||||
|
#[func]
|
||||||
|
pub fn counter_(self) -> Option<Counter> {
|
||||||
|
self.counter
|
||||||
|
}
|
||||||
|
|
||||||
|
/// The location of the corresponding figure.
|
||||||
|
///
|
||||||
|
/// This returns `{none}` in case the corresponding figure does not appear
|
||||||
|
/// in the document.
|
||||||
|
#[func]
|
||||||
|
pub fn figure_location_(self) -> Option<Location> {
|
||||||
|
self.figure_location
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl FigureCaption {
|
impl FigureCaption {
|
||||||
@ -592,12 +650,7 @@ impl Show for Packed<FigureCaption> {
|
|||||||
fn show(&self, engine: &mut Engine, styles: StyleChain) -> SourceResult<Content> {
|
fn show(&self, engine: &mut Engine, styles: StyleChain) -> SourceResult<Content> {
|
||||||
let mut realized = self.body.clone();
|
let mut realized = self.body.clone();
|
||||||
|
|
||||||
if let (
|
if let (Some(mut supplement), Some(numbering), Some(counter), Some(location)) = (
|
||||||
Some(Some(mut supplement)),
|
|
||||||
Some(Some(numbering)),
|
|
||||||
Some(Some(counter)),
|
|
||||||
Some(Some(location)),
|
|
||||||
) = (
|
|
||||||
self.supplement().cloned(),
|
self.supplement().cloned(),
|
||||||
self.numbering(),
|
self.numbering(),
|
||||||
self.counter(),
|
self.counter(),
|
||||||
|
@ -1,8 +1,9 @@
|
|||||||
use comemo::Track;
|
use comemo::Track;
|
||||||
use ecow::eco_format;
|
use ecow::eco_format;
|
||||||
|
|
||||||
use crate::diag::{bail, At, Hint, SourceResult};
|
use crate::diag::{bail, At, Hint, SourceResult, StrResult};
|
||||||
use crate::engine::Engine;
|
use crate::engine::Engine;
|
||||||
|
use crate::foundations::func;
|
||||||
use crate::foundations::{
|
use crate::foundations::{
|
||||||
cast, elem, Cast, Content, Context, Func, IntoValue, Label, NativeElement, Packed,
|
cast, elem, Cast, Content, Context, Func, IntoValue, Label, NativeElement, Packed,
|
||||||
Show, Smart, StyleChain, Synthesize,
|
Show, Smart, StyleChain, Synthesize,
|
||||||
@ -13,6 +14,7 @@ use crate::model::{
|
|||||||
BibliographyElem, CiteElem, Destination, Figurable, FootnoteElem, Numbering,
|
BibliographyElem, CiteElem, Destination, Figurable, FootnoteElem, Numbering,
|
||||||
};
|
};
|
||||||
use crate::text::TextElem;
|
use crate::text::TextElem;
|
||||||
|
use typst_macros::scope;
|
||||||
|
|
||||||
/// A reference to a label or bibliography.
|
/// A reference to a label or bibliography.
|
||||||
///
|
///
|
||||||
@ -107,7 +109,7 @@ use crate::text::TextElem;
|
|||||||
/// In @beginning we prove @pythagoras.
|
/// In @beginning we prove @pythagoras.
|
||||||
/// $ a^2 + b^2 = c^2 $ <pythagoras>
|
/// $ a^2 + b^2 = c^2 $ <pythagoras>
|
||||||
/// ```
|
/// ```
|
||||||
#[elem(title = "Reference", Synthesize, Locatable, Show)]
|
#[elem(scope, title = "Reference", Locatable, Show)]
|
||||||
pub struct RefElem {
|
pub struct RefElem {
|
||||||
/// The target label that should be referenced.
|
/// The target label that should be referenced.
|
||||||
///
|
///
|
||||||
@ -161,37 +163,6 @@ pub struct RefElem {
|
|||||||
/// ```
|
/// ```
|
||||||
#[default(RefForm::Normal)]
|
#[default(RefForm::Normal)]
|
||||||
pub form: RefForm,
|
pub form: RefForm,
|
||||||
|
|
||||||
/// A synthesized citation.
|
|
||||||
#[synthesized]
|
|
||||||
pub citation: Option<Packed<CiteElem>>,
|
|
||||||
|
|
||||||
/// The referenced element.
|
|
||||||
#[synthesized]
|
|
||||||
pub element: Option<Content>,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl Synthesize for Packed<RefElem> {
|
|
||||||
fn synthesize(
|
|
||||||
&mut self,
|
|
||||||
engine: &mut Engine,
|
|
||||||
styles: StyleChain,
|
|
||||||
) -> SourceResult<()> {
|
|
||||||
let citation = to_citation(self, engine, styles)?;
|
|
||||||
|
|
||||||
let elem = self.as_mut();
|
|
||||||
elem.push_citation(Some(citation));
|
|
||||||
elem.push_element(None);
|
|
||||||
|
|
||||||
if !BibliographyElem::has(engine, elem.target) {
|
|
||||||
if let Ok(found) = engine.introspector.query_label(elem.target).cloned() {
|
|
||||||
elem.push_element(Some(found));
|
|
||||||
return Ok(());
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
Ok(())
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
impl Show for Packed<RefElem> {
|
impl Show for Packed<RefElem> {
|
||||||
@ -334,6 +305,25 @@ fn to_citation(
|
|||||||
Ok(elem)
|
Ok(elem)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[scope]
|
||||||
|
impl RefElem {
|
||||||
|
/// The referenced element.
|
||||||
|
///
|
||||||
|
/// If this is a reference to a bibliography entry, this returns `{none}`.
|
||||||
|
#[func]
|
||||||
|
pub fn element(self, engine: &mut Engine) -> StrResult<Option<Content>> {
|
||||||
|
if BibliographyElem::has(engine, self.target) {
|
||||||
|
return Ok(None);
|
||||||
|
}
|
||||||
|
engine.introspector.query_label(self.target).cloned().map(Some)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
cast! {
|
||||||
|
RefElem,
|
||||||
|
v: Content => v.unpack::<Self>().map_err(|_| "expected reference")?
|
||||||
|
}
|
||||||
|
|
||||||
/// Additional content for a reference.
|
/// Additional content for a reference.
|
||||||
#[derive(Debug, Clone, PartialEq, Hash)]
|
#[derive(Debug, Clone, PartialEq, Hash)]
|
||||||
pub enum Supplement {
|
pub enum Supplement {
|
||||||
|
@ -6,6 +6,7 @@ use comemo::Tracked;
|
|||||||
use ecow::{eco_format, EcoString, EcoVec};
|
use ecow::{eco_format, EcoString, EcoVec};
|
||||||
use syntect::highlighting as synt;
|
use syntect::highlighting as synt;
|
||||||
use syntect::parsing::{SyntaxDefinition, SyntaxSet, SyntaxSetBuilder};
|
use syntect::parsing::{SyntaxDefinition, SyntaxSet, SyntaxSetBuilder};
|
||||||
|
use typst_macros::func;
|
||||||
use typst_syntax::{split_newlines, LinkedNode, Span, Spanned};
|
use typst_syntax::{split_newlines, LinkedNode, Span, Spanned};
|
||||||
use typst_utils::ManuallyHash;
|
use typst_utils::ManuallyHash;
|
||||||
use unicode_segmentation::UnicodeSegmentation;
|
use unicode_segmentation::UnicodeSegmentation;
|
||||||
@ -14,8 +15,8 @@ use super::Lang;
|
|||||||
use crate::diag::{At, FileError, SourceResult, StrResult};
|
use crate::diag::{At, FileError, SourceResult, StrResult};
|
||||||
use crate::engine::Engine;
|
use crate::engine::Engine;
|
||||||
use crate::foundations::{
|
use crate::foundations::{
|
||||||
cast, elem, scope, Bytes, Content, Derived, NativeElement, OneOrMultiple, Packed,
|
cast, elem, scope, Bytes, Content, Context, Derived, NativeElement, OneOrMultiple,
|
||||||
PlainText, Show, ShowSet, Smart, StyleChain, Styles, Synthesize, TargetElem,
|
Packed, PlainText, Show, ShowSet, Smart, StyleChain, Styles, TargetElem,
|
||||||
};
|
};
|
||||||
use crate::html::{tag, HtmlElem};
|
use crate::html::{tag, HtmlElem};
|
||||||
use crate::layout::{BlockBody, BlockElem, Em, HAlignment};
|
use crate::layout::{BlockBody, BlockElem, Em, HAlignment};
|
||||||
@ -72,16 +73,7 @@ use crate::World;
|
|||||||
/// needed, start the text with a single space (which will be trimmed) or use
|
/// needed, start the text with a single space (which will be trimmed) or use
|
||||||
/// the single backtick syntax. If your text should start or end with a
|
/// the single backtick syntax. If your text should start or end with a
|
||||||
/// backtick, put a space before or after it (it will be trimmed).
|
/// backtick, put a space before or after it (it will be trimmed).
|
||||||
#[elem(
|
#[elem(scope, title = "Raw Text / Code", Show, ShowSet, LocalName, Figurable, PlainText)]
|
||||||
scope,
|
|
||||||
title = "Raw Text / Code",
|
|
||||||
Synthesize,
|
|
||||||
Show,
|
|
||||||
ShowSet,
|
|
||||||
LocalName,
|
|
||||||
Figurable,
|
|
||||||
PlainText
|
|
||||||
)]
|
|
||||||
pub struct RawElem {
|
pub struct RawElem {
|
||||||
/// The raw text.
|
/// The raw text.
|
||||||
///
|
///
|
||||||
@ -265,19 +257,27 @@ pub struct RawElem {
|
|||||||
/// ````
|
/// ````
|
||||||
#[default(2)]
|
#[default(2)]
|
||||||
pub tab_size: usize,
|
pub tab_size: usize,
|
||||||
|
|
||||||
/// The stylized lines of raw text.
|
|
||||||
///
|
|
||||||
/// Made accessible for the [`raw.line` element]($raw.line).
|
|
||||||
/// Allows more styling control in `show` rules.
|
|
||||||
#[synthesized]
|
|
||||||
pub lines: Vec<Packed<RawLine>>,
|
|
||||||
}
|
}
|
||||||
|
|
||||||
#[scope]
|
#[scope]
|
||||||
impl RawElem {
|
impl RawElem {
|
||||||
#[elem]
|
#[elem]
|
||||||
type RawLine;
|
type RawLine;
|
||||||
|
|
||||||
|
/// The stylized lines of raw text.
|
||||||
|
#[func(contextual)]
|
||||||
|
pub fn lines(
|
||||||
|
self,
|
||||||
|
context: Tracked<Context>,
|
||||||
|
span: Span,
|
||||||
|
) -> SourceResult<Vec<Packed<RawLine>>> {
|
||||||
|
Ok(self.highlight(context.styles().at(span)?, span))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
cast! {
|
||||||
|
RawElem,
|
||||||
|
v: Content => v.unpack::<Self>().map_err(|_| "expected raw text / code")?
|
||||||
}
|
}
|
||||||
|
|
||||||
impl RawElem {
|
impl RawElem {
|
||||||
@ -299,24 +299,13 @@ impl RawElem {
|
|||||||
])
|
])
|
||||||
.collect()
|
.collect()
|
||||||
}
|
}
|
||||||
}
|
|
||||||
|
|
||||||
impl Synthesize for Packed<RawElem> {
|
|
||||||
fn synthesize(&mut self, _: &mut Engine, styles: StyleChain) -> SourceResult<()> {
|
|
||||||
let seq = self.highlight(styles);
|
|
||||||
self.push_lines(seq);
|
|
||||||
Ok(())
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl Packed<RawElem> {
|
|
||||||
#[comemo::memoize]
|
#[comemo::memoize]
|
||||||
fn highlight(&self, styles: StyleChain) -> Vec<Packed<RawLine>> {
|
fn highlight(&self, styles: StyleChain, span: Span) -> Vec<Packed<RawLine>> {
|
||||||
let elem = self.as_ref();
|
let lines = preprocess(&self.text, styles, span);
|
||||||
let lines = preprocess(&elem.text, styles, self.span());
|
|
||||||
|
|
||||||
let count = lines.len() as i64;
|
let count = lines.len() as i64;
|
||||||
let lang = elem
|
let lang = self
|
||||||
.lang(styles)
|
.lang(styles)
|
||||||
.as_ref()
|
.as_ref()
|
||||||
.as_ref()
|
.as_ref()
|
||||||
@ -335,8 +324,8 @@ impl Packed<RawElem> {
|
|||||||
})
|
})
|
||||||
};
|
};
|
||||||
|
|
||||||
let syntaxes = LazyCell::new(|| elem.syntaxes(styles));
|
let syntaxes = LazyCell::new(|| self.syntaxes(styles));
|
||||||
let theme: &synt::Theme = match elem.theme(styles) {
|
let theme: &synt::Theme = match self.theme(styles) {
|
||||||
Smart::Auto => &RAW_THEME,
|
Smart::Auto => &RAW_THEME,
|
||||||
Smart::Custom(Some(theme)) => theme.derived.get(),
|
Smart::Custom(Some(theme)) => theme.derived.get(),
|
||||||
Smart::Custom(None) => return non_highlighted_result(lines).collect(),
|
Smart::Custom(None) => return non_highlighted_result(lines).collect(),
|
||||||
@ -432,7 +421,7 @@ impl Packed<RawElem> {
|
|||||||
impl Show for Packed<RawElem> {
|
impl Show for Packed<RawElem> {
|
||||||
#[typst_macros::time(name = "raw", span = self.span())]
|
#[typst_macros::time(name = "raw", span = self.span())]
|
||||||
fn show(&self, _: &mut Engine, styles: StyleChain) -> SourceResult<Content> {
|
fn show(&self, _: &mut Engine, styles: StyleChain) -> SourceResult<Content> {
|
||||||
let lines = self.lines().map(|v| v.as_slice()).unwrap_or_default();
|
let lines = self.as_ref().highlight(styles, self.span());
|
||||||
|
|
||||||
let mut seq = EcoVec::with_capacity((2 * lines.len()).saturating_sub(1));
|
let mut seq = EcoVec::with_capacity((2 * lines.len()).saturating_sub(1));
|
||||||
for (i, line) in lines.iter().enumerate() {
|
for (i, line) in lines.iter().enumerate() {
|
||||||
|
Loading…
x
Reference in New Issue
Block a user