konevsa/typst
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Ensure synthesized field access never panics (#3310)

Browse Source
This commit is contained in:
Laurenz 2024-01-31 14:56:57 +01:00 committed by GitHub
parent 6999be9ab0
commit 426445edfc
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
6 changed files with 61 additions and 64 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

82
crates/typst-macros/src/elem.rs
View File

@ -82,13 +82,13 @@ impl Elem {
/// Fields that can be configured with set rules.
fn set_fields(&self) -> impl Iterator<Item = &Field> + Clone {
self.construct_fields().filter(|field| !field.inherent())
self.construct_fields().filter(|field| !field.required)
}
/// Fields that can be accessed from the style chain.
fn style_fields(&self) -> impl Iterator<Item = &Field> + Clone {
self.real_fields()
.filter(|field| !field.inherent() && !field.synthesized)
.filter(|field| !field.required && !field.synthesized)
}
/// Fields that are visible to the user.
@ -124,13 +124,6 @@ struct Field {
default: Option<syn::Expr>,
}
impl Field {
/// Whether the field is present on every instance of the element.
fn inherent(&self) -> bool {
self.required || (self.synthesized && self.default.is_some())
}
}
/// The `..` in `#[elem(..)]`.
struct Meta {
scope: bool,
@ -174,7 +167,10 @@ fn parse(stream: TokenStream, body: &syn::ItemStruct) -> Result<Elem> {
if fields.iter().any(|field| field.ghost && !field.internal)
&& meta.capabilities.iter().all(|capability| capability != "Construct")
{
bail!(body.ident, "cannot have ghost fields and have `Construct` auto generated");
bail!(
body.ident,
"cannot have public ghost fields and an auto-generated constructor"
);
}
Ok(Elem {
@ -231,15 +227,17 @@ fn parse_field(field: &syn::Field) -> Result<Field> {
default: parse_attr::<syn::Expr>(&mut attrs, "default")?.flatten(),
};
if field.required || field.variadic {
if !field.positional {
bail!(ident, "inherent fields must be positional");
} else if field.fold || field.resolve || field.ghost || field.synthesized {
bail!(
ident,
"inherent fields cannot be fold, resolve, ghost, or synthesized"
);
}
if field.required && field.synthesized {
bail!(ident, "required fields cannot be synthesized");
}
if (field.required || field.synthesized)
&& (field.default.is_some() || field.fold || field.resolve || field.ghost)
{
bail!(
ident,
"required and synthesized fields cannot be default, fold, resolve, or ghost"
);
}
if field.resolve {
@ -322,7 +320,7 @@ fn create_struct(element: &Elem) -> TokenStream {
/// Create a field declaration for the struct.
fn create_field(field: &Field) -> TokenStream {
let Field { ident, ty, .. } = field;
if field.inherent() {
if field.required {
quote! { #ident: #ty }
} else {
quote! { #ident: ::std::option::Option<#ty> }
@ -425,18 +423,12 @@ fn create_inherent_impl(element: &Elem) -> TokenStream {
fn create_new_func(element: &Elem) -> TokenStream {
let params = element
.struct_fields()
.filter(|field| field.inherent() && !field.synthesized)
.filter(|field| field.required)
.map(|Field { ident, ty, .. }| quote! { #ident: #ty });
let fields = element.struct_fields().map(|field| {
let Field { ident, default, .. } = field;
if field.synthesized {
if let Some(expr) = default {
quote! { #ident: #expr }
} else {
quote! { #ident: None }
}
} else if field.inherent() {
let ident = &field.ident;
if field.required {
quote! { #ident }
} else {
quote! { #ident: None }
@ -469,7 +461,7 @@ fn create_push_field_method(field: &Field) -> TokenStream {
let Field { vis, ident, push_ident, name, ty, .. } = field;
let doc = format!("Setter for the [`{name}`](Self::{ident}) field.");
let expr = if field.inherent() {
let expr = if field.required {
quote! { #ident }
} else {
quote! { Some(#ident) }
@ -487,7 +479,7 @@ fn create_push_field_method(field: &Field) -> TokenStream {
fn create_field_method(field: &Field) -> TokenStream {
let Field { vis, docs, ident, output, .. } = field;
if field.inherent() {
if field.required {
quote! {
#[doc = #docs]
#vis fn #ident(&self) -> &#output {
@ -498,8 +490,8 @@ fn create_field_method(field: &Field) -> TokenStream {
quote! {
#[doc = #docs]
#[track_caller]
#vis fn #ident(&self) -> &#output {
self.#ident.as_ref().unwrap()
#vis fn #ident(&self) -> ::std::option::Option<&#output> {
self.#ident.as_ref()
}
}
} else {
@ -655,7 +647,7 @@ fn create_param_info(field: &Field) -> TokenStream {
} = field;
let named = !positional;
let settable = !field.inherent();
let settable = !field.required;
let default = if settable {
let default = default
@ -718,13 +710,9 @@ fn create_construct_impl(element: &Elem) -> TokenStream {
});
let fields = element.struct_fields().map(|field| {
let Field { ident, default, .. } = field;
let ident = &field.ident;
if field.synthesized {
if let Some(expr) = default {
quote! { #ident: #expr }
} else {
quote! { #ident: None }
}
quote! { #ident: None }
} else {
quote! { #ident }
}
@ -835,7 +823,7 @@ fn create_fields_impl(element: &Elem) -> TokenStream {
let has_arms = visible_non_ghost().map(|field| {
let Field { enum_ident, ident, .. } = field;
let expr = if field.inherent() {
let expr = if field.required {
quote! { true }
} else {
quote! { self.#ident.is_some() }
@ -845,10 +833,10 @@ fn create_fields_impl(element: &Elem) -> TokenStream {
});
// Fields that can be accessed using the `field` method.
let field_arms = visible_non_ghost().filter(|field| !field.ghost).map(|field| {
let field_arms = visible_non_ghost().map(|field| {
let Field { enum_ident, ident, .. } = field;
let expr = if field.inherent() {
let expr = if field.required {
quote! { Some(#into_value(self.#ident.clone())) }
} else {
quote! { self.#ident.clone().map(#into_value) }
@ -861,9 +849,9 @@ fn create_fields_impl(element: &Elem) -> TokenStream {
let field_with_styles_arms = element.visible_fields().map(|field| {
let Field { enum_ident, ident, .. } = field;
let expr = if field.inherent() {
let expr = if field.required {
quote! { Some(#into_value(self.#ident.clone())) }
} else if field.synthesized && field.default.is_none() {
} else if field.synthesized {
quote! { self.#ident.clone().map(#into_value) }
} else {
let value = create_style_chain_access(
@ -883,9 +871,9 @@ fn create_fields_impl(element: &Elem) -> TokenStream {
let Field { ident, name, .. } = field;
let string = quote! { #name.into() };
if field.inherent() {
if field.required {
quote! {
fields.insert( #string, #into_value(self.#ident.clone()));
fields.insert(#string, #into_value(self.#ident.clone()));
}
} else {
quote! {

1
crates/typst/src/layout/page.rs
View File

@ -331,7 +331,6 @@ pub struct PageElem {
/// Whether the page should be aligned to an even or odd page.
#[internal]
#[synthesized]
#[default(None)]
pub clear_to: Option<Parity>,
}

10
crates/typst/src/model/bibliography.rs
View File

@ -741,13 +741,19 @@ impl<'a> Generator<'a> {
driver.citation(CitationRequest::new(
items,
style,
Some(locale(*first.lang(), *first.region())),
Some(locale(
first.lang().copied().unwrap_or(Lang::ENGLISH),
first.region().copied().flatten(),
)),
&LOCALES,
None,
));
}
let locale = locale(*self.bibliography.lang(), *self.bibliography.region());
let locale = locale(
self.bibliography.lang().copied().unwrap_or(Lang::ENGLISH),
self.bibliography.region().copied().flatten(),
);
// Add hidden items for everything if we should print the whole
// bibliography.

2
crates/typst/src/model/document.rs
View File

@ -93,7 +93,7 @@ impl LayoutRoot for Packed<DocumentElem> {
.to_styled()
.map_or(next, |(elem, _)| elem)
.to_packed::<PageElem>()?
.clear_to()
.clear_to()?
});
let run = page.layout(engine, styles, &mut page_counter, extend_to)?;
pages.extend(run);

18
crates/typst/src/model/figure.rs
View File

@ -371,7 +371,8 @@ impl Refable for Packed<FigureElem> {
fn counter(&self) -> Counter {
(**self)
.counter()
.clone()
.cloned()
.flatten()
.unwrap_or_else(|| Counter::of(FigureElem::elem()))
}
@ -393,7 +394,7 @@ impl Outlinable for Packed<FigureElem> {
let mut realized = caption.body().clone();
if let (
Smart::Custom(Some(Supplement::Content(mut supplement))),
Some(counter),
Some(Some(counter)),
Some(numbering),
) = (
(**self).supplement(StyleChain::default()).clone(),
@ -512,23 +513,19 @@ pub struct FigureCaption {
/// The figure's supplement.
#[synthesized]
#[default(None)]
pub supplement: Option<Content>,
/// How to number the figure.
#[synthesized]
#[default(None)]
pub numbering: Option<Numbering>,
/// The counter for the figure.
#[synthesized]
#[default(None)]
pub counter: Option<Counter>,
/// The figure's location.
#[internal]
#[synthesized]
#[default(None)]
pub figure_location: Option<Location>,
}
@ -568,8 +565,13 @@ impl Show for Packed<FigureCaption> {
fn show(&self, engine: &mut Engine, styles: StyleChain) -> SourceResult<Content> {
let mut realized = self.body().clone();
if let (Some(mut supplement), Some(numbering), Some(counter), Some(location)) = (
self.supplement().clone(),
if let (
Some(Some(mut supplement)),
Some(Some(numbering)),
Some(Some(counter)),
Some(Some(location)),
) = (
self.supplement().cloned(),
self.numbering(),
self.counter(),
self.figure_location(),

12
crates/typst/src/text/raw.rs
View File

@ -398,16 +398,18 @@ impl Synthesize for Packed<RawElem> {
impl Show for Packed<RawElem> {
#[typst_macros::time(name = "raw", span = self.span())]
fn show(&self, _: &mut Engine, styles: StyleChain) -> SourceResult<Content> {
let mut lines = EcoVec::with_capacity((2 * self.lines().len()).saturating_sub(1));
for (i, line) in self.lines().iter().enumerate() {
let lines = self.lines().map(|v| v.as_slice()).unwrap_or_default();
let mut seq = EcoVec::with_capacity((2 * lines.len()).saturating_sub(1));
for (i, line) in lines.iter().enumerate() {
if i != 0 {
lines.push(LinebreakElem::new().pack());
seq.push(LinebreakElem::new().pack());
}
lines.push(line.clone().pack());
seq.push(line.clone().pack());
}
let mut realized = Content::sequence(lines);
let mut realized = Content::sequence(seq);
if self.block(styles) {
// Align the text before inserting it into the block.
realized = realized.aligned(self.align(styles).into());