use std::str::FromStr; use super::ColumnsNode; use crate::prelude::*; /// # Page /// Layouts its child onto one or multiple pages. /// /// Although this function is primarily used in set rules to affect page /// properties, it can also be used to explicitly render its argument onto /// a set of pages of its own. /// /// Pages can be set to use `{auto}` as their width or height. In this case, /// the pages will grow to fit their content on the respective axis. /// /// ## Parameters /// - body: `Content` (positional, required) /// The contents of the page(s). /// /// Multiple pages will be created if the content does not fit on a single /// page. A new page with the page properties prior to the function invocation /// will be created after the body has been typeset. /// /// - paper: `Paper` (positional, settable) /// A standard paper size to set width and height. When this is not specified, /// Typst defaults to `{"a4"}` paper. /// /// ## Example /// ```example /// >>> #set page(margin: auto) /// #set page("us-letter") /// /// There you go, US friends! /// ``` /// /// ## Category /// layout #[func] #[capable] #[derive(Clone, Hash)] pub struct PageNode(pub Content); #[node] impl PageNode { /// The width of the page. /// /// ```example /// #set page( /// width: 3cm, /// margin: (x: 0cm), /// ) /// /// #for i in range(3) { /// box(square(width: 1cm)) /// } /// ``` #[property(resolve)] pub const WIDTH: Smart = Smart::Custom(Paper::A4.width().into()); /// The height of the page. /// /// If this is set to `{auto}`, page breaks can only be triggered manually /// by inserting a [page break]($func/pagebreak). Most examples throughout /// this documentation use `{auto}` for the height of the page to /// dynamically grow and shrink to fit their content. #[property(resolve)] pub const HEIGHT: Smart = Smart::Custom(Paper::A4.height().into()); /// Whether the page is flipped into landscape orientation. /// /// ```example /// #set page( /// "us-business-card", /// flipped: true, /// fill: rgb("f2e5dd"), /// ) /// /// #set align(bottom + end) /// #text(14pt)[*Sam H. Richards*] \ /// _Procurement Manager_ /// /// #set text(10pt) /// 17 Main Street \ /// New York, NY 10001 \ /// +1 555 555 5555 /// ``` pub const FLIPPED: bool = false; /// The page's margins. /// /// - A single length: The same margin on all sides. /// - `{auto}`: The margin is set to the default value for the page's size. /// - A dictionary: With a dictionary, the margins can be set individually. /// The dictionary can contain the following keys in order of precedence: /// - `top`: The top margin. /// - `right`: The right margin. /// - `bottom`: The bottom margin. /// - `left`: The left margin. /// - `x`: The horizontal margins. /// - `y`: The vertical margins. /// - `rest`: The margins on all sides except those for which the /// dictionary explicitly sets a size. /// /// ```example /// #set page( /// width: 3cm, /// height: 4cm, /// margin: (x: 8pt, y: 4pt), /// ) /// /// #rect( /// width: 100%, /// height: 100%, /// fill: aqua, /// ) /// ``` #[property(fold)] pub const MARGIN: Sides>>> = Sides::splat(Smart::Auto); /// How many columns the page has. /// /// ```example:single /// #set page(columns: 2, height: 4.8cm) /// Climate change is one of the most /// pressing issues of our time, with /// the potential to devastate /// communities, ecosystems, and /// economies around the world. It's /// clear that we need to take urgent /// action to reduce our carbon /// emissions and mitigate the impacts /// of a rapidly changing climate. /// ``` pub const COLUMNS: NonZeroUsize = NonZeroUsize::new(1).unwrap(); /// The page's background color. /// /// This instructs the printer to color the complete page with the given /// color. If you are considering larger production runs, it may be more /// environmentally friendly and cost-effective to source pre-dyed pages and /// not set this property. /// /// ```example /// #set page(fill: rgb("444352")) /// #set text(fill: rgb("fdfdfd")) /// *Dark mode enabled.* /// ``` pub const FILL: Option = None; /// The page's header. /// /// The header is placed at in the top margin of each page. /// /// - Content: The content will be placed in the header. /// - A function: The function will be called with the page number (starting /// at one) as its only argument. The content it returns will be placed in /// the header. /// - `{none}`: The header will be empty. /// /// ```example /// #set par(justify: true) /// #set page( /// margin: (x: 24pt, y: 32pt), /// header: align(horizon + right, text(8pt)[_Exercise Sheet 3_]), /// ) /// /// #lorem(18) /// ``` #[property(referenced)] pub const HEADER: Option = None; /// The page's footer. /// /// The footer is placed at in the bottom margin of each page. /// /// - Content: The content will be placed in the footer. /// - A function: The function will be called with the page number (starting /// at one) as its only argument. The content it returns will be placed in /// the footer. /// - `{none}`: The footer will be empty. /// /// ```example /// #set par(justify: true) /// #set page( /// margin: (x: 24pt, y: 32pt), /// footer: i => align(horizon + right, /// text(8pt, numbering("I", i)) /// ) /// ) /// /// #lorem(18) /// ``` #[property(referenced)] pub const FOOTER: Option = None; /// Content in the page's background. /// /// This content will be placed behind the page's body. It can be /// used to place a background image or a watermark. /// /// ```example /// #set page(background: align( /// center + horizon, /// rotate(24deg, /// text(18pt, fill: rgb("FFCBC4"))[*CONFIDENTIAL*] /// ), /// )) /// /// = Typst's secret plans /// /// In the year 2023, we plan to take over the world /// (of typesetting). /// ``` #[property(referenced)] pub const BACKGROUND: Option = None; /// Content in the page's foreground. /// /// This content will overlay the page's body. /// /// ```example /// #set page(foreground: align( /// center + horizon, /// text(24pt)[🥸], /// )) /// /// Reviewer 2 has marked our paper /// "Weak Reject" because they did /// not understand our approach... /// ``` #[property(referenced)] pub const FOREGROUND: Option = None; fn construct(_: &Vm, args: &mut Args) -> SourceResult { Ok(Self(args.expect("body")?).pack()) } fn set(...) { if let Some(paper) = args.named_or_find::("paper")? { styles.set(Self::WIDTH, Smart::Custom(paper.width().into())); styles.set(Self::HEIGHT, Smart::Custom(paper.height().into())); } } fn field(&self, name: &str) -> Option { match name { "body" => Some(Value::Content(self.0.clone())), _ => None, } } } impl PageNode { /// Layout the page run into a sequence of frames, one per page. pub fn layout( &self, vt: &mut Vt, mut page: usize, styles: StyleChain, ) -> SourceResult { // When one of the lengths is infinite the page fits its content along // that axis. let width = styles.get(Self::WIDTH).unwrap_or(Abs::inf()); let height = styles.get(Self::HEIGHT).unwrap_or(Abs::inf()); let mut size = Size::new(width, height); if styles.get(Self::FLIPPED) { std::mem::swap(&mut size.x, &mut size.y); } let mut min = width.min(height); if !min.is_finite() { min = Paper::A4.width(); } // Determine the margins. let default = Rel::from(0.1190 * min); let padding = styles.get(Self::MARGIN).map(|side| side.unwrap_or(default)); let mut child = self.0.clone(); // Realize columns. let columns = styles.get(Self::COLUMNS); if columns.get() > 1 { child = ColumnsNode { count: columns, body: self.0.clone() }.pack(); } // Realize margins. child = child.padded(padding); // Realize background fill. if let Some(fill) = styles.get(Self::FILL) { child = child.filled(fill); } // Layout the child. let regions = Regions::repeat(size, size.map(Abs::is_finite)); let mut fragment = child.layout(vt, styles, regions)?; let header = styles.get(Self::HEADER); let footer = styles.get(Self::FOOTER); let foreground = styles.get(Self::FOREGROUND); let background = styles.get(Self::BACKGROUND); // Realize overlays. for frame in &mut fragment { let size = frame.size(); let pad = padding.resolve(styles).relative_to(size); let pw = size.x - pad.left - pad.right; let py = size.y - pad.bottom; for (marginal, pos, area) in [ (header, Point::with_x(pad.left), Size::new(pw, pad.top)), (footer, Point::new(pad.left, py), Size::new(pw, pad.bottom)), (foreground, Point::zero(), size), (background, Point::zero(), size), ] { let in_background = std::ptr::eq(marginal, background); let Some(marginal) = marginal else { continue }; let content = marginal.resolve(vt, page)?; let pod = Regions::one(area, Axes::splat(true)); let sub = content.layout(vt, styles, pod)?.into_frame(); if in_background { frame.prepend_frame(pos, sub); } else { frame.push_frame(pos, sub); } } page += 1; } Ok(fragment) } } impl Debug for PageNode { fn fmt(&self, f: &mut Formatter) -> fmt::Result { f.write_str("Page(")?; self.0.fmt(f)?; f.write_str(")") } } /// # Page Break /// A manual page break. /// /// Must not be used inside any containers. /// /// ## Example /// ```example /// The next page contains /// more details on compound theory. /// #pagebreak() /// /// == Compound Theory /// In 1984, the first ... /// ``` /// /// ## Parameters /// - weak: `bool` (named) /// If `{true}`, the page break is skipped if the current page is already /// empty. /// /// ## Category /// layout #[func] #[capable] #[derive(Debug, Copy, Clone, Hash)] pub struct PagebreakNode { pub weak: bool, } #[node] impl PagebreakNode { fn construct(_: &Vm, args: &mut Args) -> SourceResult { let weak = args.named("weak")?.unwrap_or(false); Ok(Self { weak }.pack()) } } /// A header, footer, foreground or background definition. #[derive(Debug, Clone, Hash)] pub enum Marginal { /// Bare content. Content(Content), /// A closure mapping from a page number to content. Func(Func), } impl Marginal { /// Resolve the marginal based on the page number. pub fn resolve(&self, vt: &Vt, page: usize) -> SourceResult { Ok(match self { Self::Content(content) => content.clone(), Self::Func(func) => { let args = Args::new(func.span(), [Value::Int(page as i64)]); func.call_detached(vt.world(), args)?.display() } }) } } castable! { Marginal, v: Content => Self::Content(v), v: Func => Self::Func(v), } /// Specification of a paper. #[derive(Debug, Copy, Clone, Hash)] pub struct Paper { /// The width of the paper in millimeters. width: Scalar, /// The height of the paper in millimeters. height: Scalar, } impl Paper { /// The width of the paper. pub fn width(self) -> Abs { Abs::mm(self.width.0) } /// The height of the paper. pub fn height(self) -> Abs { Abs::mm(self.height.0) } } /// Defines paper constants and a paper parsing implementation. macro_rules! papers { ($(($var:ident: $width:expr, $height: expr, $pat:literal))*) => { /// Predefined papers. /// /// Each paper is parsable from its name in kebab-case. impl Paper { $(pub const $var: Self = Self { width: Scalar($width), height: Scalar($height), };)* } impl FromStr for Paper { type Err = &'static str; fn from_str(name: &str) -> Result { match name.to_lowercase().as_str() { $($pat => Ok(Self::$var),)* _ => Err("invalid paper name"), } } } castable! { Paper, $( /// Produces a paper of the respective size. $pat => Self::$var, )* } }; } // All paper sizes in mm. // // Resources: // - https://papersizes.io/ // - https://en.wikipedia.org/wiki/Paper_size // - https://www.theedkins.co.uk/jo/units/oldunits/print.htm // - https://vintagepaper.co/blogs/news/traditional-paper-sizes papers! { // ---------------------------------------------------------------------- // // ISO 216 A Series (A0: 841.0, 1189.0, "a0") (A1: 594.0, 841.0, "a1") (A2: 420.0, 594.0, "a2") (A3: 297.0, 420.0, "a3") (A4: 210.0, 297.0, "a4") (A5: 148.0, 210.0, "a5") (A6: 105.0, 148.0, "a6") (A7: 74.0, 105.0, "a7") (A8: 52.0, 74.0, "a8") (A9: 37.0, 52.0, "a9") (A10: 26.0, 37.0, "a10") (A11: 18.0, 26.0, "a11") // ISO 216 B Series (ISO_B1: 707.0, 1000.0, "iso-b1") (ISO_B2: 500.0, 707.0, "iso-b2") (ISO_B3: 353.0, 500.0, "iso-b3") (ISO_B4: 250.0, 353.0, "iso-b4") (ISO_B5: 176.0, 250.0, "iso-b5") (ISO_B6: 125.0, 176.0, "iso-b6") (ISO_B7: 88.0, 125.0, "iso-b7") (ISO_B8: 62.0, 88.0, "iso-b8") // ISO 216 C Series (ISO_C3: 324.0, 458.0, "iso-c3") (ISO_C4: 229.0, 324.0, "iso-c4") (ISO_C5: 162.0, 229.0, "iso-c5") (ISO_C6: 114.0, 162.0, "iso-c6") (ISO_C7: 81.0, 114.0, "iso-c7") (ISO_C8: 57.0, 81.0, "iso-c8") // DIN D Series (extension to ISO) (DIN_D3: 272.0, 385.0, "din-d3") (DIN_D4: 192.0, 272.0, "din-d4") (DIN_D5: 136.0, 192.0, "din-d5") (DIN_D6: 96.0, 136.0, "din-d6") (DIN_D7: 68.0, 96.0, "din-d7") (DIN_D8: 48.0, 68.0, "din-d8") // SIS (used in academia) (SIS_G5: 169.0, 239.0, "sis-g5") (SIS_E5: 115.0, 220.0, "sis-e5") // ANSI Extensions (ANSI_A: 216.0, 279.0, "ansi-a") (ANSI_B: 279.0, 432.0, "ansi-b") (ANSI_C: 432.0, 559.0, "ansi-c") (ANSI_D: 559.0, 864.0, "ansi-d") (ANSI_E: 864.0, 1118.0, "ansi-e") // ANSI Architectural Paper (ARCH_A: 229.0, 305.0, "arch-a") (ARCH_B: 305.0, 457.0, "arch-b") (ARCH_C: 457.0, 610.0, "arch-c") (ARCH_D: 610.0, 914.0, "arch-d") (ARCH_E1: 762.0, 1067.0, "arch-e1") (ARCH_E: 914.0, 1219.0, "arch-e") // JIS B Series (JIS_B0: 1030.0, 1456.0, "jis-b0") (JIS_B1: 728.0, 1030.0, "jis-b1") (JIS_B2: 515.0, 728.0, "jis-b2") (JIS_B3: 364.0, 515.0, "jis-b3") (JIS_B4: 257.0, 364.0, "jis-b4") (JIS_B5: 182.0, 257.0, "jis-b5") (JIS_B6: 128.0, 182.0, "jis-b6") (JIS_B7: 91.0, 128.0, "jis-b7") (JIS_B8: 64.0, 91.0, "jis-b8") (JIS_B9: 45.0, 64.0, "jis-b9") (JIS_B10: 32.0, 45.0, "jis-b10") (JIS_B11: 22.0, 32.0, "jis-b11") // SAC D Series (SAC_D0: 764.0, 1064.0, "sac-d0") (SAC_D1: 532.0, 760.0, "sac-d1") (SAC_D2: 380.0, 528.0, "sac-d2") (SAC_D3: 264.0, 376.0, "sac-d3") (SAC_D4: 188.0, 260.0, "sac-d4") (SAC_D5: 130.0, 184.0, "sac-d5") (SAC_D6: 92.0, 126.0, "sac-d6") // ISO 7810 ID (ISO_ID_1: 85.6, 53.98, "iso-id-1") (ISO_ID_2: 74.0, 105.0, "iso-id-2") (ISO_ID_3: 88.0, 125.0, "iso-id-3") // ---------------------------------------------------------------------- // // Asia (ASIA_F4: 210.0, 330.0, "asia-f4") // Japan (JP_SHIROKU_BAN_4: 264.0, 379.0, "jp-shiroku-ban-4") (JP_SHIROKU_BAN_5: 189.0, 262.0, "jp-shiroku-ban-5") (JP_SHIROKU_BAN_6: 127.0, 188.0, "jp-shiroku-ban-6") (JP_KIKU_4: 227.0, 306.0, "jp-kiku-4") (JP_KIKU_5: 151.0, 227.0, "jp-kiku-5") (JP_BUSINESS_CARD: 91.0, 55.0, "jp-business-card") // China (CN_BUSINESS_CARD: 90.0, 54.0, "cn-business-card") // Europe (EU_BUSINESS_CARD: 85.0, 55.0, "eu-business-card") // French Traditional (AFNOR) (FR_TELLIERE: 340.0, 440.0, "fr-tellière") (FR_COURONNE_ECRITURE: 360.0, 460.0, "fr-couronne-écriture") (FR_COURONNE_EDITION: 370.0, 470.0, "fr-couronne-édition") (FR_RAISIN: 500.0, 650.0, "fr-raisin") (FR_CARRE: 450.0, 560.0, "fr-carré") (FR_JESUS: 560.0, 760.0, "fr-jésus") // United Kingdom Imperial (UK_BRIEF: 406.4, 342.9, "uk-brief") (UK_DRAFT: 254.0, 406.4, "uk-draft") (UK_FOOLSCAP: 203.2, 330.2, "uk-foolscap") (UK_QUARTO: 203.2, 254.0, "uk-quarto") (UK_CROWN: 508.0, 381.0, "uk-crown") (UK_BOOK_A: 111.0, 178.0, "uk-book-a") (UK_BOOK_B: 129.0, 198.0, "uk-book-b") // Unites States (US_LETTER: 215.9, 279.4, "us-letter") (US_LEGAL: 215.9, 355.6, "us-legal") (US_TABLOID: 279.4, 431.8, "us-tabloid") (US_EXECUTIVE: 84.15, 266.7, "us-executive") (US_FOOLSCAP_FOLIO: 215.9, 342.9, "us-foolscap-folio") (US_STATEMENT: 139.7, 215.9, "us-statement") (US_LEDGER: 431.8, 279.4, "us-ledger") (US_OFICIO: 215.9, 340.36, "us-oficio") (US_GOV_LETTER: 203.2, 266.7, "us-gov-letter") (US_GOV_LEGAL: 215.9, 330.2, "us-gov-legal") (US_BUSINESS_CARD: 88.9, 50.8, "us-business-card") (US_DIGEST: 139.7, 215.9, "us-digest") (US_TRADE: 152.4, 228.6, "us-trade") // ---------------------------------------------------------------------- // // Other (NEWSPAPER_COMPACT: 280.0, 430.0, "newspaper-compact") (NEWSPAPER_BERLINER: 315.0, 470.0, "newspaper-berliner") (NEWSPAPER_BROADSHEET: 381.0, 578.0, "newspaper-broadsheet") (PRESENTATION_16_9: 297.0, 167.0625, "presentation-16-9") (PRESENTATION_4_3: 280.0, 210.0, "presentation-4-3") }