Skip to content

DesignCraft: An open-source page and layout design editor written by scratch in pure Rust

M7: Numbering & Section Options (continue/restart numbering, styles, prefixes), layer reorder, select on layer

Brandon Thomas27ad9eb24a08
diff --git a/crates/doc/src/lib.rs b/crates/doc/src/lib.rs
index 8d91fc002..e8daf17b2 100644
--- a/crates/doc/src/lib.rs
+++ b/crates/doc/src/lib.rs
@@ -313,30 +313,27 @@ impl Document {
self.spreads.iter().enumerate().flat_map(|(si, s)| s.pages.iter().map(move |p| (si, p))).enumerate().map(|(i, (si, p))| (i, si, p))
}
- /// The displayed page name ("1", "iv", "A-3"…) for an absolute page index, per sections.
- pub fn page_name(&self, abs: usize) -> String {
- let mut sec: Option<&Section> = None;
- for s in &self.sections {
- if s.start <= abs && sec.is_none_or(|c| s.start >= c.start) {
- sec = Some(s);
- }
- }
- let Some(sec) = sec else { return (abs + 1).to_string() };
- // Numbers continue from the previous section when start_number is None.
- let start_number = match sec.start_number {
+ /// The section containing absolute page `abs`.
+ pub fn section_of(&self, abs: usize) -> Option<&Section> {
+ self.sections.iter().filter(|s| s.start <= abs).max_by_key(|s| s.start)
+ }
+
+ /// The page number (before formatting) of absolute page `abs`, per sections. A section without
+ /// a start number continues from the previous section.
+ pub fn page_number(&self, abs: usize) -> u32 {
+ let Some(sec) = self.section_of(abs) else { return abs as u32 + 1 };
+ let start = match sec.start_number {
Some(n) => n,
- None => {
- let prev: Vec<&Section> = self.sections.iter().filter(|s| s.start < sec.start).collect();
- if prev.is_empty() {
- sec.start as u32 + 1
- } else {
- // Approximate continuation: absolute position + 1.
- sec.start as u32 + 1
- }
- }
+ None if sec.start == 0 => 1,
+ None => self.page_number(sec.start - 1) + 1,
};
- let n = start_number + (abs - sec.start) as u32;
- let num = sec.style.format(n);
+ start + (abs - sec.start) as u32
+ }
+
+ /// The displayed page name ("1", "iv", "A-3"…) for an absolute page index, per sections.
+ pub fn page_name(&self, abs: usize) -> String {
+ let Some(sec) = self.section_of(abs) else { return (abs + 1).to_string() };
+ let num = sec.style.format(self.page_number(abs));
if sec.include_prefix { format!("{}{}", sec.prefix, num) } else { num }
}
diff --git a/crates/doc/src/tests.rs b/crates/doc/src/tests.rs
index c4c7a4666..98dee2acd 100644
--- a/crates/doc/src/tests.rs
+++ b/crates/doc/src/tests.rs
@@ -78,6 +78,16 @@ fn page_names_follow_sections() {
assert_eq!(d.page_name(1), "2");
assert_eq!(d.page_name(2), "A-i");
assert_eq!(d.page_name(4), "A-iii");
+ // A section that continues numbering.
+ d.sections.push(Section {
+ start: 5,
+ start_number: None,
+ style: NumberStyle::Arabic,
+ prefix: String::new(),
+ marker: String::new(),
+ include_prefix: false,
+ });
+ assert_eq!(d.page_name(5), "4");
}
#[test]
diff --git a/crates/engine/src/cmd/layout.rs b/crates/engine/src/cmd/layout.rs
index 1c689fcad..678cb4960 100644
--- a/crates/engine/src/cmd/layout.rs
+++ b/crates/engine/src/cmd/layout.rs
@@ -170,6 +170,79 @@ pub fn specs() -> Vec<CommandSpec> {
})
}
),
+ cmd!(
+ "layout.section",
+ "Numbering & Section Options…",
+ ["Layout"],
+ None,
+ "{page (1-based; starts a section there), startNumber?: n|null (continue), style?: arabic|upperRoman|lowerRoman|upperLetters|lowerLetters, prefix?, includePrefix?, marker?, remove?: bool}",
+ has_doc,
+ |s, p| {
+ let page = p.get("page").and_then(Value::as_u64).ok_or_else(|| bad("layout.section", "missing page"))? as usize;
+ let n = s.doc()?.doc.page_count();
+ if page == 0 || page > n {
+ return Err(bad("layout.section", format!("no page {page}")));
+ }
+ let start = page - 1;
+ let p = p.clone();
+ s.edit(|d, _| {
+ d.sections.retain(|x| x.start != start || start == 0);
+ if p.get("remove").and_then(Value::as_bool).unwrap_or(false) {
+ if start != 0 {
+ return ok();
+ }
+ }
+ let mut sec = d.sections.iter().find(|x| x.start == start).cloned().unwrap_or(designcraft_doc::Section {
+ start,
+ start_number: None,
+ style: Default::default(),
+ prefix: String::new(),
+ marker: String::new(),
+ include_prefix: false,
+ });
+ match p.get("startNumber") {
+ Some(Value::Null) => sec.start_number = None,
+ Some(v) => sec.start_number = v.as_u64().map(|v| v.max(1) as u32),
+ None => {}
+ }
+ if let Some(v) = p.get("style") {
+ sec.style = serde_json::from_value(v.clone()).map_err(|e| bad("layout.section", e.to_string()))?;
+ }
+ if let Some(v) = p.get("prefix").and_then(Value::as_str) {
+ sec.prefix = v.into();
+ }
+ if let Some(v) = p.get("includePrefix").and_then(Value::as_bool) {
+ sec.include_prefix = v;
+ }
+ if let Some(v) = p.get("marker").and_then(Value::as_str) {
+ sec.marker = v.into();
+ }
+ d.sections.retain(|x| x.start != start);
+ d.sections.push(sec);
+ d.sections.sort_by_key(|x| x.start);
+ Ok(json!({"names": (0..d.page_count()).map(|i| d.page_name(i)).collect::<Vec<_>>()}))
+ })
+ }
+ ),
+ cmd!("layer.move", "Move Layer", [], None, "{id, to: index (0 = top/frontmost)}", has_doc, |s, p| {
+ let id = LayerId(p.get("id").and_then(Value::as_u64).unwrap_or(0));
+ let to = p.get("to").and_then(Value::as_u64).unwrap_or(0) as usize;
+ s.edit(|d, _| {
+ let i = d.layers.iter().position(|l| l.id == id).ok_or_else(|| bad("layer.move", "no such layer"))?;
+ let l = d.layers.remove(i);
+ let to = to.min(d.layers.len());
+ d.layers.insert(to, l);
+ ok()
+ })
+ }),
+ cmd!(noundo "layer.selectItems", "Select All on Layer", [], None, "{id}", has_doc, |s, p| {
+ let id = LayerId(p.get("id").and_then(Value::as_u64).unwrap_or(0));
+ let st = s.doc_mut()?;
+ let ids: Vec<_> = st.doc.spreads.iter().flat_map(|sp| sp.items.iter().filter(|i| i.layer == id && !i.locked).map(|i| i.id)).collect();
+ st.selection = designcraft_doc::Selection::items(ids);
+ st.revision += 1;
+ ok()
+ }),
cmd!("layer.new", "New Layer…", [], None, "{name?}", has_doc, |s, p| {
let name = str_param(p, "name").map(str::to_string);
let r = s.edit(|d, _| {