mirror of
https://github.com/storytold/cadcraft.git
synced 2026-11-19 20:30:42 -06:00
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
d1cb40332b | ||
|
|
b7d5ed3401 | ||
|
|
6b767073d8 | ||
|
|
7bcfe25938 | ||
|
|
3886fb952d | ||
|
|
6c9eedd7e1 | ||
|
|
6411c1a4ab | ||
|
|
6f203fb64b | ||
|
|
a2d209e10b | ||
|
|
cd226cdf0f | ||
|
|
8d2c9d1a26 | ||
|
|
0156fd9b9f | ||
|
|
df2a5131af | ||
|
|
5644c6c946 | ||
|
|
0fa45daf25 | ||
|
|
a92fb047d8 | ||
|
|
33dc795c5f | ||
|
|
4255108429 | ||
|
|
0b585fa8cb | ||
|
|
21d9627840 | ||
|
|
1c611d610d | ||
|
|
076b7761a3 | ||
|
|
71a0ef2260 | ||
|
|
4fadc54dbe | ||
|
|
9c2ebc0e12 | ||
|
|
98240d82d0 | ||
|
|
1e1cf10a1c | ||
|
|
af460caac6 | ||
|
|
ad072e6cb0 |
@@ -233,11 +233,38 @@ fn saved_window(app_ron: &str) -> bool {
|
||||
ron::from_str::<std::collections::HashMap<String, String>>(app_ron).is_ok_and(|kv| kv.contains_key(WINDOW_KEY))
|
||||
}
|
||||
|
||||
/// The window state from the last session is saved and will be restored (#2595).
|
||||
/// The window state from the last session is saved and will be restored (#2595). A saved size
|
||||
/// below the minimum (seen on Windows: 64×64 points, which eframe restores un-maximized and
|
||||
/// unusable) is dropped first, so the window opens at its default size.
|
||||
fn restores_window() -> bool {
|
||||
eframe::storage_dir(APP_ID).and_then(|dir| std::fs::read_to_string(dir.join("app.ron")).ok()).is_some_and(|ron| saved_window(&ron))
|
||||
let Some(path) = eframe::storage_dir(APP_ID).map(|dir| dir.join("app.ron")) else { return false };
|
||||
let Ok(mut ron) = std::fs::read_to_string(&path) else { return false };
|
||||
if let Some(fixed) = without_tiny_window(&ron)
|
||||
&& std::fs::write(&path, &fixed).is_ok()
|
||||
{
|
||||
ron = fixed;
|
||||
}
|
||||
saved_window(&ron)
|
||||
}
|
||||
|
||||
/// `app_ron` without its window entry when that entry's inner size is below `MIN_INNER_SIZE`;
|
||||
/// `None` when there is nothing to drop (no entry, a usable size, or an unreadable file).
|
||||
fn without_tiny_window(app_ron: &str) -> Option<String> {
|
||||
let mut kv = ron::from_str::<std::collections::BTreeMap<String, String>>(app_ron).ok()?;
|
||||
let w = kv.get(WINDOW_KEY)?;
|
||||
let size = &w[w.find("inner_size_points:")?..];
|
||||
let num = |k: &str| size[size.find(k)? + k.len()..].split([',', ')']).next()?.trim().parse::<f32>().ok();
|
||||
let (x, y) = (num("x:")?, num("y:")?);
|
||||
if x >= MIN_INNER_SIZE[0] && y >= MIN_INNER_SIZE[1] {
|
||||
return None;
|
||||
}
|
||||
kv.remove(WINDOW_KEY);
|
||||
ron::ser::to_string_pretty(&kv, ron::ser::PrettyConfig::default()).ok()
|
||||
}
|
||||
|
||||
/// The smallest main window, in points.
|
||||
const MIN_INNER_SIZE: [f32; 2] = [900.0, 560.0];
|
||||
|
||||
/// The main window: its size, title bar, placement and rendering needs. `restoring`: a window state
|
||||
/// saved by the last session is restored instead of opening centred.
|
||||
fn window_options(restoring: bool) -> eframe::NativeOptions {
|
||||
@@ -245,7 +272,7 @@ fn window_options(restoring: bool) -> eframe::NativeOptions {
|
||||
viewport: egui::ViewportBuilder::default()
|
||||
.with_title("CADCraft")
|
||||
.with_inner_size([1600.0, 1000.0])
|
||||
.with_min_inner_size([900.0, 560.0])
|
||||
.with_min_inner_size(MIN_INNER_SIZE)
|
||||
.with_drag_and_drop(true)
|
||||
.with_fullsize_content_view(true)
|
||||
.with_titlebar_shown(false)
|
||||
@@ -403,6 +430,9 @@ fn main() -> eframe::Result {
|
||||
app.ui = ui;
|
||||
}
|
||||
app.set_system_cursor_default(vars.system_cursor == Switch::On);
|
||||
// macOS: CADCRAFT_NO_NATIVE_MENU=1 keeps the menus inside the window.
|
||||
#[cfg(target_os = "macos")]
|
||||
app.set_native_menus(vars.no_native_menu != Switch::On);
|
||||
if let Some(error) = &workspace_error {
|
||||
eprintln!("CADCraft workspace: {error}");
|
||||
app.set_status(error);
|
||||
@@ -481,7 +511,7 @@ fn main() -> eframe::Result {
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::{filters_for_save, follow_desktop, saved_window, window_options};
|
||||
use super::{filters_for_save, follow_desktop, saved_window, window_options, without_tiny_window};
|
||||
|
||||
#[test]
|
||||
fn save_dialog_offers_dwg_with_the_drawing_format_first() {
|
||||
@@ -525,6 +555,17 @@ mod tests {
|
||||
assert!(!saved_window("not ron at all"));
|
||||
}
|
||||
|
||||
/// A saved 64×64 window (below the minimum) is dropped; a usable one is kept.
|
||||
#[test]
|
||||
fn a_tiny_saved_window_is_dropped() {
|
||||
let tiny = r#"{"window": "(normal_geometry:(outer_position_pixels:Some((x:0.0,y:0.0)),scale_factor:1.25,inner_size_points:(x:64.0,y:64.0)),fullscreen:false,maximized:true)", "cadcraft.prefs": "{}"}"#;
|
||||
let fixed = without_tiny_window(tiny).expect("dropped");
|
||||
assert!(!saved_window(&fixed) && fixed.contains("cadcraft.prefs"));
|
||||
let ok = tiny.replace("x:64.0,y:64.0)),", "x:1600.0,y:1000.0)),");
|
||||
assert_eq!(without_tiny_window(&ok), None);
|
||||
assert_eq!(without_tiny_window("not ron"), None);
|
||||
}
|
||||
|
||||
/// View ▸ Theme ▸ System on Linux: winit reports no theme, so the desktop's answer stands in;
|
||||
/// without one (or where winit answers and the desktop doesn't) the input is left alone.
|
||||
#[test]
|
||||
|
||||
+9
-76
@@ -44,11 +44,6 @@ pub use store::EntityStore;
|
||||
pub use tables::*;
|
||||
pub use xclip::{ClipBoundary, MAX_CLIP_VERTICES};
|
||||
|
||||
/// Handles at or above this are not followed: a file may name one (an object's handle, or its
|
||||
/// `$HANDSEED`), and the four billion handles above the limit stay free for the drawing's own
|
||||
/// growth. A file's handles keep their identity, however high they are (#913, #939).
|
||||
pub const HANDLE_LIMIT: u64 = u64::MAX - 0xFFFF_FFFF;
|
||||
|
||||
/// File data CADCraft doesn't model, kept for saving (#528).
|
||||
pub mod dynblock;
|
||||
pub mod foreign;
|
||||
@@ -132,10 +127,6 @@ pub struct Drawing {
|
||||
pub scales: Vec<AnnoScale>,
|
||||
/// Next free handle.
|
||||
pub handseed: u64,
|
||||
/// Handles a file's records hold in the reserved band, recorded while reading before the
|
||||
/// record is placed: [`Drawing::new_handle`] skips them meanwhile. [`Drawing::bump_handseed`]
|
||||
/// does not follow them (#913). Emptied once the file is read; never written to a file.
|
||||
pub reserved_handles: BTreeSet<u64>,
|
||||
/// Objects hidden for this session by ISOLATEOBJECTS / HIDEOBJECTS. Never written to a file:
|
||||
/// a drawing opens with everything shown again.
|
||||
pub hidden_objects: BTreeSet<Handle>,
|
||||
@@ -209,7 +200,6 @@ impl Drawing {
|
||||
parametric: Parametric::default(),
|
||||
scales: imperial_scales(),
|
||||
handseed: 0x100,
|
||||
reserved_handles: BTreeSet::new(),
|
||||
hidden_objects: BTreeSet::new(),
|
||||
read_notes: Vec::new(),
|
||||
refedit: None,
|
||||
@@ -219,83 +209,26 @@ impl Drawing {
|
||||
}
|
||||
}
|
||||
|
||||
/// Allocate a fresh handle: [`Drawing::next_handle`], with the seed moved past it. Past the
|
||||
/// top of the range the drawing goes on growing in the reserved band (#913).
|
||||
/// Allocate a fresh handle. It skips the handles the drawing's file gave the objects CADCraft
|
||||
/// writes itself ([`foreign::Foreign::handles`]): AutoLISP names those objects by them, and a
|
||||
/// file CADCraft wrote numbers them above its `$HANDSEED` (#495).
|
||||
pub fn new_handle(&mut self) -> Handle {
|
||||
let h = self.next_handle();
|
||||
self.handseed = h.0.checked_add(1).unwrap_or(HANDLE_LIMIT);
|
||||
self.handseed = h.0.saturating_add(1);
|
||||
h
|
||||
}
|
||||
/// The handle [`Drawing::new_handle`] gives out next (AutoCAD's `HANDSEED`), without taking it:
|
||||
/// the first one at or above the seed that nothing holds. It skips
|
||||
/// - the handles the drawing's file gave the objects CADCraft writes itself
|
||||
/// ([`foreign::Foreign::handles`]): AutoLISP names those objects by them, and a file
|
||||
/// CADCraft wrote numbers them above its `$HANDSEED` (#495);
|
||||
/// - handles an object or a file record being read holds in the reserved band above
|
||||
/// [`HANDLE_LIMIT`]. A hostile or damaged file may name a `$HANDSEED` there, and a file
|
||||
/// object may hold that same handle; the seed does not follow a file's handles in the band,
|
||||
/// so taking it as-is would hand the file's object's handle to a new object and
|
||||
/// `EntityStore` would replace it (#913, #1921);
|
||||
/// - handle 0, which a file reads as "no handle".
|
||||
///
|
||||
/// Off the top of the range it goes on at the bottom of the band.
|
||||
///
|
||||
/// Cost: below the band the reader and [`Drawing::bump_handseed`] keep the seed above every
|
||||
/// handle an object holds (AUDIT repairs a drawing where that fails), and reserved handles are
|
||||
/// all in the band, so there only `foreign.handles` is looked up. The scan of every space and
|
||||
/// block definition runs only for a candidate in the band. Every handle skipped is a distinct
|
||||
/// one something holds, so the walk ends within one step more than the count of held handles.
|
||||
/// The handle [`Drawing::new_handle`] gives out next (AutoCAD's `HANDSEED`), without taking it.
|
||||
pub fn next_handle(&self) -> Handle {
|
||||
let held = |h: u64| {
|
||||
h == 0
|
||||
|| self.foreign.handles.contains_key(&Handle(h))
|
||||
|| (h >= HANDLE_LIMIT && (self.reserved_handles.contains(&h) || self.handle_in_use(Handle(h))))
|
||||
};
|
||||
let mut h = self.handseed;
|
||||
// Counted only once a handle is skipped, so the usual first-try answer costs nothing.
|
||||
let mut steps_left: Option<usize> = None;
|
||||
while held(h) {
|
||||
let left = steps_left.get_or_insert_with(|| self.held_handle_count());
|
||||
let Some(rest) = left.checked_sub(1) else { break };
|
||||
*left = rest;
|
||||
h = h.checked_add(1).unwrap_or(HANDLE_LIMIT);
|
||||
while self.foreign.handles.contains_key(&Handle(h)) && h < u64::MAX {
|
||||
h = h.saturating_add(1);
|
||||
}
|
||||
Handle(h)
|
||||
}
|
||||
|
||||
/// Whether an object in any space or block definition already holds `h`.
|
||||
fn handle_in_use(&self, h: Handle) -> bool {
|
||||
self.model.contains(h) || self.layouts.iter().any(|l| l.entities.contains(h)) || self.blocks.values().any(|b| b.entities.contains(h))
|
||||
}
|
||||
/// An upper bound on how many handles [`Drawing::next_handle`] can find held, plus handle 0.
|
||||
fn held_handle_count(&self) -> usize {
|
||||
let spaces = self.layouts.iter().map(|l| l.entities.len()).chain(self.blocks.values().map(|b| b.entities.len()));
|
||||
spaces
|
||||
.fold(self.model.len(), usize::saturating_add)
|
||||
.saturating_add(self.foreign.handles.len())
|
||||
.saturating_add(self.reserved_handles.len())
|
||||
.saturating_add(1)
|
||||
}
|
||||
/// Record a handle a file's record holds in the reserved band, before the record is placed in
|
||||
/// the drawing, so [`Drawing::new_handle`] does not hand it to an object read earlier (#1276).
|
||||
///
|
||||
/// Only handles at or above [`HANDLE_LIMIT`] are recorded: below it [`Drawing::bump_handseed`]
|
||||
/// already moves the seed past them. The reservation stays separate from the seed because the
|
||||
/// writer's growth lives above the limit and a file's handles there are not followed (#913).
|
||||
pub fn reserve_handle(&mut self, h: Handle) {
|
||||
if h.0 >= HANDLE_LIMIT {
|
||||
self.reserved_handles.insert(h.0);
|
||||
}
|
||||
}
|
||||
|
||||
/// Make sure future handles don't collide with `h` (after loading a file).
|
||||
///
|
||||
/// A handle at or above [`HANDLE_LIMIT`] is the file's own and stays as it is: it is not
|
||||
/// followed, so a new object is never given the top handle and the file's object is never
|
||||
/// replaced (#913). The handles above the limit are the drawing's room to grow.
|
||||
pub fn bump_handseed(&mut self, h: Handle) {
|
||||
if h.0 >= self.handseed && h.0 < HANDLE_LIMIT {
|
||||
self.handseed = h.0 + 1;
|
||||
if h.0 >= self.handseed {
|
||||
self.handseed = h.0.saturating_add(1);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -726,34 +726,6 @@ fn new_handles_skip_the_files_object_handles() {
|
||||
assert_eq!(d.new_handle(), Handle(next + 3));
|
||||
}
|
||||
|
||||
/// In the reserved band a new handle skips the file's kept object handles (#2514) and the handles
|
||||
/// objects hold in model space, a layout and a block definition, or that a file record reserved
|
||||
/// (#913); off the top of the range it goes on at the bottom of the band. HANDSEED reports the
|
||||
/// handle `new_handle` takes.
|
||||
#[test]
|
||||
fn new_handles_in_the_reserved_band_skip_every_held_handle_and_wrap() {
|
||||
let mut d = Drawing::new_metric();
|
||||
let top = u64::MAX;
|
||||
d.model.push(Entity::new(Handle(top - 4), line((0.0, 0.0), (1.0, 0.0))));
|
||||
let mut sheet = Layout::new("Sheet", 1);
|
||||
sheet.entities.push(Entity::new(Handle(top - 3), line((0.0, 0.0), (1.0, 0.0))));
|
||||
d.layouts.push(sheet);
|
||||
let mut b = Block::new("B");
|
||||
b.entities.push(Entity::new(Handle(top - 2), line((0.0, 0.0), (1.0, 0.0))));
|
||||
d.blocks.insert("B".into(), std::sync::Arc::new(b));
|
||||
std::sync::Arc::make_mut(&mut d.foreign).handles.insert(Handle(top - 1), ("LAYER".into(), "0".into()));
|
||||
d.reserve_handle(Handle(top));
|
||||
d.model.push(Entity::new(Handle(HANDLE_LIMIT), line((0.0, 0.0), (1.0, 0.0))));
|
||||
d.handseed = top - 5;
|
||||
assert_eq!(d.new_handle(), Handle(top - 5));
|
||||
assert_eq!(d.next_handle(), Handle(HANDLE_LIMIT + 1), "a held handle was offered");
|
||||
assert_eq!(d.new_handle(), Handle(HANDLE_LIMIT + 1));
|
||||
assert_eq!(d.handseed, HANDLE_LIMIT + 2);
|
||||
// Handle 0 means "no handle" in a file; a seed there moves on.
|
||||
d.handseed = 0;
|
||||
assert_eq!(d.new_handle(), Handle(1));
|
||||
}
|
||||
|
||||
/// Several spellings of one DIM field apply once, the last in the map's order, and none is rejected.
|
||||
#[test]
|
||||
fn dim_style_spellings_of_one_field_apply_once() {
|
||||
|
||||
@@ -319,14 +319,8 @@ fn all_handles(d: &Drawing) -> HashSet<Handle> {
|
||||
}
|
||||
|
||||
/// The next handle is above every handle in use, so new objects never take an existing one.
|
||||
///
|
||||
/// A handle at or above [`cadcraft_doc::HANDLE_LIMIT`] is the file's own and is deliberately not
|
||||
/// followed: the seed never moves past it, and new objects take free handles in the band above
|
||||
/// the limit. Reporting it would repeat the same repair on every audit, so it is not an issue.
|
||||
/// Such a handle is left out of the maximum too, or the largest handle would hide every ordinary
|
||||
/// one behind it and the seed would never be repaired past them.
|
||||
fn handseed(d: &mut Drawing, out: &mut Vec<Issue>) {
|
||||
let Some(max) = each_entity(d).map(|e| e.handle).filter(|h| h.0 < cadcraft_doc::HANDLE_LIMIT).max() else { return };
|
||||
let Some(max) = each_entity(d).map(|e| e.handle).max() else { return };
|
||||
if max.0 >= d.handseed {
|
||||
out.push(issue(
|
||||
"handseed",
|
||||
|
||||
@@ -22,6 +22,7 @@ pub(crate) mod groups;
|
||||
pub(crate) mod hatch;
|
||||
mod image;
|
||||
mod inquiry;
|
||||
pub mod interface;
|
||||
mod layer;
|
||||
mod layout;
|
||||
mod lisp;
|
||||
@@ -212,6 +213,7 @@ pub fn command_specs() -> &'static [CommandSpec] {
|
||||
v.extend(inquiry::specs());
|
||||
v.extend(settings::specs());
|
||||
v.extend(options::specs());
|
||||
v.extend(interface::specs());
|
||||
v.extend(utility::specs());
|
||||
v.extend(table::specs());
|
||||
v.extend(tolerance::specs());
|
||||
|
||||
@@ -18,13 +18,8 @@ use crate::{Result, Session};
|
||||
/// Most image files loaded per drawing.
|
||||
const MAX_IMAGE_FILES: usize = 1000;
|
||||
/// Largest image file read (bytes).
|
||||
#[cfg(not(target_arch = "wasm32"))]
|
||||
const MAX_IMAGE_BYTES: u64 = 256 << 20;
|
||||
/// Longest base64 text taken for `data`: what a file of [`MAX_IMAGE_BYTES`] encodes to.
|
||||
const MAX_IMAGE_BASE64: u64 = MAX_IMAGE_BYTES.div_ceil(3) * 4;
|
||||
/// Longest `data` text with the line breaks and spaces base64 may carry (MIME breaks every 76
|
||||
/// characters, under 3% more): the characters past [`MAX_IMAGE_BASE64`] are counted only up to
|
||||
/// here, which also bounds what decoding sets aside.
|
||||
const MAX_IMAGE_TEXT: u64 = MAX_IMAGE_BASE64 + MAX_IMAGE_BASE64 / 16;
|
||||
/// Most decoded pixel bytes kept per drawing; images past it stay unloaded.
|
||||
const MAX_LOADED_BYTES: u64 = 2 << 30;
|
||||
/// Most image files decoded at the same time when a drawing opens.
|
||||
@@ -75,22 +70,11 @@ fn paths(d: &Drawing) -> Vec<String> {
|
||||
paths
|
||||
}
|
||||
|
||||
/// Whether `path` is a full path here, or on Windows where a drawing may have been written (a
|
||||
/// drive, `C:\maps\a.png`, or a share, `\\server\maps`), which other systems read as relative.
|
||||
#[cfg(not(target_arch = "wasm32"))]
|
||||
fn full_path(path: &str) -> bool {
|
||||
let b = path.trim().as_bytes();
|
||||
std::path::Path::new(path.trim()).is_absolute() || b.starts_with(b"\\\\") || matches!(b, [d, b':', b'\\' | b'/', ..] if d.is_ascii_alphabetic())
|
||||
}
|
||||
|
||||
/// The contents of the image file saved as `path` in a drawing at `host`.
|
||||
fn read_file(path: &str, host: Option<&str>) -> std::result::Result<Vec<u8>, String> {
|
||||
#[cfg(not(target_arch = "wasm32"))]
|
||||
{
|
||||
let file = super::blocks::xref::find_file(path, host).ok_or_else(|| {
|
||||
// An unsaved drawing has no folder for a relative path to be relative to.
|
||||
if host.is_none() && !full_path(path) { "file not found (save the drawing first, or give a full path)" } else { "file not found" }
|
||||
})?;
|
||||
let file = super::blocks::xref::find_file(path, host).ok_or("file not found")?;
|
||||
let len = std::fs::metadata(&file).map_err(|e| e.to_string())?.len();
|
||||
if len > MAX_IMAGE_BYTES {
|
||||
return Err(format!("the file is larger than {} MB", MAX_IMAGE_BYTES >> 20));
|
||||
@@ -320,19 +304,7 @@ fn pixels(s: &Session, p: &Value, path: &str) -> Result<Arc<Raster>> {
|
||||
let bytes = match p.get("data") {
|
||||
Some(data) => {
|
||||
let text = data.as_str().ok_or_else(|| bad(ID, "`data` must be base64 text"))?;
|
||||
// Refused before decoding, which would hold all of it in memory. Line breaks and
|
||||
// spaces, which decoding skips, don't count.
|
||||
let len = u64::try_from(text.len()).unwrap_or(u64::MAX);
|
||||
let digits = || u64::try_from(text.bytes().filter(|b| !matches!(b, b'\n' | b'\r' | b' ')).count()).unwrap_or(u64::MAX);
|
||||
if len > MAX_IMAGE_TEXT || (len > MAX_IMAGE_BASE64 && digits() > MAX_IMAGE_BASE64) {
|
||||
return Err(bad(ID, format!("`data` is larger than {} MB", MAX_IMAGE_BYTES >> 20)));
|
||||
}
|
||||
let bytes = base64_decode(text).ok_or_else(|| bad(ID, "`data` is not valid base64"))?;
|
||||
// The longest text allowed can still hold a byte or two more than the limit.
|
||||
if u64::try_from(bytes.len()).unwrap_or(u64::MAX) > MAX_IMAGE_BYTES {
|
||||
return Err(bad(ID, format!("`data` is larger than {} MB", MAX_IMAGE_BYTES >> 20)));
|
||||
}
|
||||
bytes
|
||||
base64_decode(text).ok_or_else(|| bad(ID, "`data` is not valid base64"))?
|
||||
}
|
||||
None => {
|
||||
if let Some(loaded) = s.doc()?.rasters.get(path) {
|
||||
|
||||
@@ -0,0 +1,134 @@
|
||||
//! MENUBAR and TOOLBAR: show or hide the window's menu bar and tool bar from the command line, as
|
||||
//! in AutoCAD. With the menu bar hidden on Windows and Linux (where it is the only menu), typing
|
||||
//! these is the way back.
|
||||
//!
|
||||
//! The UI owns the bars: it reports what it shows in [`Session::bars_shown`] and applies
|
||||
//! [`Session::bars_request`], which these commands set.
|
||||
|
||||
use serde_json::{Value, json};
|
||||
|
||||
use super::{CommandSpec, always, bad};
|
||||
use crate::{Accept, Input, Interactive, Prompt, Result, Session, Step};
|
||||
|
||||
/// The interface bars MENUBAR and TOOLBAR control.
|
||||
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
|
||||
pub struct InterfaceBars {
|
||||
pub menubar: bool,
|
||||
pub toolbar: bool,
|
||||
}
|
||||
|
||||
impl Default for InterfaceBars {
|
||||
fn default() -> Self {
|
||||
InterfaceBars { menubar: true, toolbar: true }
|
||||
}
|
||||
}
|
||||
|
||||
/// A change MENUBAR or TOOLBAR asked for: only the bars a command set, so the UI leaves the other
|
||||
/// as it is (it may have been changed since).
|
||||
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
|
||||
pub struct BarsRequest {
|
||||
pub menubar: Option<bool>,
|
||||
pub toolbar: Option<bool>,
|
||||
}
|
||||
|
||||
pub fn specs() -> Vec<CommandSpec> {
|
||||
vec![
|
||||
CommandSpec::new("menubar", "Menu Bar", run_menubar)
|
||||
.params("{value?: 0|1} (1 shows the in-window menu bar, 0 hides it; without it, reports it)")
|
||||
.enabled(always)
|
||||
.noundo()
|
||||
.interactive(|s| Ok(Box::new(MenubarM { current: s.bars_shown.menubar }))),
|
||||
CommandSpec::new("toolbar", "Tool Bar", run_toolbar)
|
||||
.alias(&["-toolbar"])
|
||||
.params("{show?: bool} (without it, reports it)")
|
||||
.enabled(always)
|
||||
.noundo()
|
||||
.interactive(|_| Ok(Box::new(ToolbarM))),
|
||||
]
|
||||
}
|
||||
|
||||
fn set_menubar(s: &mut Session, on: bool) {
|
||||
s.bars_shown.menubar = on;
|
||||
s.bars_request.menubar = Some(on);
|
||||
}
|
||||
|
||||
fn set_toolbar(s: &mut Session, show: bool) {
|
||||
s.bars_shown.toolbar = show;
|
||||
s.bars_request.toolbar = Some(show);
|
||||
}
|
||||
|
||||
fn run_menubar(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
let v = match p.get("value") {
|
||||
None | Some(Value::Null) => return Ok(json!({ "value": u8::from(s.bars_shown.menubar) })),
|
||||
Some(v) => v
|
||||
.as_u64()
|
||||
.or_else(|| v.as_str().and_then(|t| t.trim().parse().ok()))
|
||||
.filter(|v| *v <= 1)
|
||||
.ok_or_else(|| bad("menubar", "`value` must be 0 or 1"))?,
|
||||
};
|
||||
set_menubar(s, v == 1);
|
||||
Ok(json!({ "value": v }))
|
||||
}
|
||||
|
||||
fn run_toolbar(s: &mut Session, p: &Value) -> Result<Value> {
|
||||
let Some(show) = p.get("show").filter(|v| !v.is_null()) else { return Ok(json!({ "show": s.bars_shown.toolbar })) };
|
||||
let show = show.as_bool().ok_or_else(|| bad("toolbar", "`show` must be true or false"))?;
|
||||
set_toolbar(s, show);
|
||||
Ok(json!({ "show": show }))
|
||||
}
|
||||
|
||||
/// Typed MENUBAR: "Enter new value for MENUBAR <1>:".
|
||||
struct MenubarM {
|
||||
current: bool,
|
||||
}
|
||||
|
||||
impl Interactive for MenubarM {
|
||||
fn name(&self) -> &'static str {
|
||||
"MENUBAR"
|
||||
}
|
||||
fn prompt(&self, _s: &Session) -> Prompt {
|
||||
Prompt::new("Enter new value for MENUBAR", Accept::NUMBER).default(u8::from(self.current).to_string())
|
||||
}
|
||||
fn input(&mut self, s: &mut Session, i: Input) -> Result<Step> {
|
||||
match i {
|
||||
Input::Enter => Ok(Step::Done),
|
||||
Input::Text(t) => match run_menubar(s, &json!({ "value": t })) {
|
||||
Ok(_) => Ok(Step::Done),
|
||||
Err(_) => {
|
||||
s.echo("Requires 0 or 1.");
|
||||
Ok(Step::Continue)
|
||||
}
|
||||
},
|
||||
_ => Ok(Step::Continue),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// Typed TOOLBAR: "Enter tool bar option [Show/Hide] <Show>:" (CADCraft has one tool bar).
|
||||
struct ToolbarM;
|
||||
|
||||
impl Interactive for ToolbarM {
|
||||
fn name(&self) -> &'static str {
|
||||
"TOOLBAR"
|
||||
}
|
||||
fn prompt(&self, _s: &Session) -> Prompt {
|
||||
Prompt::new("Enter tool bar option", Accept::TEXT).kw(&["Show", "Hide"]).default("Show")
|
||||
}
|
||||
fn input(&mut self, s: &mut Session, i: Input) -> Result<Step> {
|
||||
let word = match &i {
|
||||
Input::Enter => "show".to_string(),
|
||||
Input::Keyword(k) | Input::Text(k) => k.trim().to_ascii_lowercase(),
|
||||
_ => return Ok(Step::Continue),
|
||||
};
|
||||
let show = if !word.is_empty() && "show".starts_with(&word) {
|
||||
true
|
||||
} else if !word.is_empty() && "hide".starts_with(&word) {
|
||||
false
|
||||
} else {
|
||||
s.echo("Invalid option keyword.");
|
||||
return Ok(Step::Continue);
|
||||
};
|
||||
run_toolbar(s, &json!({ "show": show }))?;
|
||||
Ok(Step::Done)
|
||||
}
|
||||
}
|
||||
@@ -156,6 +156,10 @@ pub struct Session {
|
||||
lisp_last: Option<std::result::Result<lisp::value::Value, String>>,
|
||||
/// What the last HATCHPICK kept (the Hatch and Gradient dialog's picks).
|
||||
pub hatch_picks: Option<cmd::hatch::HatchPicks>,
|
||||
/// The window's menu bar and tool bar as the UI shows them (it reports them every frame).
|
||||
pub bars_shown: cmd::interface::InterfaceBars,
|
||||
/// The bars MENUBAR or TOOLBAR asked to change, for the UI to apply.
|
||||
pub bars_request: cmd::interface::BarsRequest,
|
||||
/// The object named with a point for the input a prompt picking one object is taking
|
||||
/// ([`Session::input_object`]): a pick at exactly that point picks that object
|
||||
/// ([`Session::pick_object`]).
|
||||
@@ -215,6 +219,8 @@ impl Session {
|
||||
lisp: lisp::LispState::default(),
|
||||
lisp_last: None,
|
||||
hatch_picks: None,
|
||||
bars_shown: Default::default(),
|
||||
bars_request: Default::default(),
|
||||
pick_hint: None,
|
||||
}
|
||||
}
|
||||
|
||||
@@ -139,9 +139,6 @@ pub struct LispState {
|
||||
/// Interpreter steps all synchronous callbacks have run, nested ones included. A callback's
|
||||
/// allowance counts what ran since it started, so the callbacks it calls spend its steps.
|
||||
pub(crate) callback_used: u64,
|
||||
/// Work synchronous callbacks did inside the running step, already counted in `callback_used`:
|
||||
/// the step is charged it without charging the enclosing callback a second time.
|
||||
pub(crate) callback_work: u64,
|
||||
/// The `callback_used` value the callback running now (and so every one it calls) must not
|
||||
/// pass: the lowest of its own and its callers' allowances.
|
||||
pub(crate) callback_ceiling: Option<u64>,
|
||||
@@ -386,14 +383,6 @@ impl Session {
|
||||
let uid = run.uid;
|
||||
self.lisp_flush(&mut env, false);
|
||||
self.lisp_env_put(uid, env);
|
||||
// The work the slice did, which one step can take far past the slice. After a panic
|
||||
// `used` is still the previous slice's; the run ends with the error anyway.
|
||||
run.steps = run.steps.saturating_add(run.machine.used);
|
||||
if run.blocking && run.steps > BLOCKING_CAP && matches!(outcome, Outcome::Wait(_)) {
|
||||
self.lisp.run = Some(run);
|
||||
self.lisp_error(LispError::quit(format!("routine stopped after {BLOCKING_CAP} steps")));
|
||||
return;
|
||||
}
|
||||
match outcome {
|
||||
Outcome::Done(v) => {
|
||||
self.lisp.run = Some(run);
|
||||
@@ -406,7 +395,13 @@ impl Session {
|
||||
return;
|
||||
}
|
||||
Outcome::Wait(Need::Yield) => {
|
||||
run.steps = run.steps.saturating_add(SLICE);
|
||||
if run.blocking {
|
||||
if run.steps > BLOCKING_CAP {
|
||||
self.lisp.run = Some(run);
|
||||
self.lisp_error(LispError::quit(format!("routine stopped after {BLOCKING_CAP} steps")));
|
||||
return;
|
||||
}
|
||||
self.lisp.run = Some(run);
|
||||
continue;
|
||||
}
|
||||
|
||||
@@ -175,19 +175,17 @@ pub struct Machine {
|
||||
stack: Vec<Frame>,
|
||||
state: State,
|
||||
need: Option<Need>,
|
||||
/// Steps the last [`Machine::run`] took, with the work done inside them.
|
||||
pub(crate) used: u64,
|
||||
}
|
||||
|
||||
impl Machine {
|
||||
/// A machine evaluating `forms` in turn.
|
||||
pub fn forms(forms: Vec<Value>) -> Machine {
|
||||
Machine { stack: vec![Frame::Forms { rest: forms.into_iter().rev().collect() }], state: State::Ret(Value::Nil), need: None, used: 0 }
|
||||
Machine { stack: vec![Frame::Forms { rest: forms.into_iter().rev().collect() }], state: State::Ret(Value::Nil), need: None }
|
||||
}
|
||||
|
||||
/// A machine calling `f` with `args`.
|
||||
pub fn calling(f: Value, args: Vec<Value>) -> Machine {
|
||||
Machine { stack: Vec::new(), state: State::Call(f, args), need: None, used: 0 }
|
||||
Machine { stack: Vec::new(), state: State::Call(f, args), need: None }
|
||||
}
|
||||
|
||||
/// Give the value a [`Need`] waited for, and carry on.
|
||||
@@ -195,31 +193,12 @@ impl Machine {
|
||||
self.state = State::Ret(v);
|
||||
}
|
||||
|
||||
/// Run until done, waiting, or `budget` steps. A step that walks a long list (`length`) or
|
||||
/// runs a synchronous callback counts that work too, so one slice stays short.
|
||||
/// Run until done, waiting, or `budget` steps.
|
||||
pub fn run(&mut self, ctx: &mut Ctx<'_>, budget: u64) -> Outcome {
|
||||
let mut n = 0u64;
|
||||
let outcome = self.run_counted(ctx, budget, &mut n);
|
||||
// The last step's work too, so nothing is left for the next run.
|
||||
self.used = n.saturating_add(Machine::take_step_work(ctx));
|
||||
outcome
|
||||
}
|
||||
|
||||
/// The work the last step did besides itself: the lists it walked, which count against a
|
||||
/// callback's allowance too, and the callbacks it ran, which were counted there as they ran.
|
||||
fn take_step_work(ctx: &mut Ctx<'_>) -> u64 {
|
||||
let walked = super::value::take_work();
|
||||
let callbacks = std::mem::take(&mut ctx.s.lisp.callback_work);
|
||||
if ctx.depth > 0 {
|
||||
ctx.s.lisp.callback_used = ctx.s.lisp.callback_used.saturating_add(walked);
|
||||
}
|
||||
walked.saturating_add(callbacks)
|
||||
}
|
||||
|
||||
fn run_counted(&mut self, ctx: &mut Ctx<'_>, budget: u64, n: &mut u64) -> Outcome {
|
||||
loop {
|
||||
*n = n.saturating_add(1).saturating_add(Machine::take_step_work(ctx));
|
||||
if *n > budget {
|
||||
n += 1;
|
||||
if n > budget {
|
||||
return Outcome::Wait(Need::Yield);
|
||||
}
|
||||
// Charge a callback's step as it runs, so callbacks it calls see what it already spent.
|
||||
@@ -672,10 +651,6 @@ impl Ctx<'_> {
|
||||
return Ok(v);
|
||||
}
|
||||
let cap = self.s.lisp.limits.callback_steps;
|
||||
// Work the caller queued before this call (its list walks, earlier callbacks of the same
|
||||
// step) is not this callback's: set it aside and hand it back with this callback's.
|
||||
let pending = super::value::take_work();
|
||||
let pending_callbacks = std::mem::take(&mut self.s.lisp.callback_work);
|
||||
let start = self.s.lisp.callback_used;
|
||||
// This callback may run until `callback_used` reaches `ceiling`: `cap` steps from now, or
|
||||
// sooner where a caller's allowance ends, so callbacks nested in callbacks share one
|
||||
@@ -683,20 +658,13 @@ impl Ctx<'_> {
|
||||
let outer = self.s.lisp.callback_ceiling;
|
||||
let ceiling = start.saturating_add(cap).min(outer.unwrap_or(u64::MAX));
|
||||
self.s.lisp.callback_ceiling = Some(ceiling);
|
||||
let mut spent: u64 = 0;
|
||||
let r = self.drive_callback(f, args, ceiling, &mut spent);
|
||||
let r = self.drive_callback(f, args, ceiling);
|
||||
self.s.lisp.callback_ceiling = outer;
|
||||
super::value::charge_work(pending);
|
||||
// Its steps, nested callbacks' included, are work done inside the caller's one step: they
|
||||
// count against the caller's slice and every enclosing callback's. They are in
|
||||
// `callback_used` already, so they reach the caller apart from its list walks.
|
||||
self.s.lisp.callback_work = pending_callbacks.saturating_add(spent);
|
||||
r
|
||||
}
|
||||
|
||||
/// Run callback `f` in slices until it finishes or `callback_used` reaches `ceiling`, adding
|
||||
/// the work each slice did to `spent`.
|
||||
fn drive_callback(&mut self, f: &Value, args: Vec<Value>, ceiling: u64, spent: &mut u64) -> Result<Value, LispError> {
|
||||
/// Run callback `f` in slices until it finishes or `callback_used` reaches `ceiling`.
|
||||
fn drive_callback(&mut self, f: &Value, args: Vec<Value>, ceiling: u64) -> Result<Value, LispError> {
|
||||
let cap = self.s.lisp.limits.callback_steps;
|
||||
let mut m = Machine::calling(f.clone(), args);
|
||||
let mut sub = Ctx { s: &mut *self.s, env: &mut *self.env, depth: self.depth + 1 };
|
||||
@@ -712,7 +680,6 @@ impl Ctx<'_> {
|
||||
}
|
||||
let slice = remaining.min(SYNC_SLICE);
|
||||
let outcome = m.run(&mut sub, slice);
|
||||
*spent = spent.saturating_add(m.used);
|
||||
match outcome {
|
||||
// The steps were charged as they ran; finishing past the shared allowance is a failure too.
|
||||
Outcome::Done(_) if sub.s.lisp.callback_used > ceiling => {
|
||||
|
||||
@@ -247,112 +247,6 @@ fn synchronous_callback_loop_is_an_error_not_a_hang() {
|
||||
assert_eq!(ok(&mut s, "(vl-sort '(3 1 2) '<)"), "(1 2 3)");
|
||||
}
|
||||
|
||||
/// A step that walks a long list counts its work: one `length` of 32768 cells is past a 1000-step
|
||||
/// slice, so the slice yields after it.
|
||||
#[test]
|
||||
fn walking_a_long_list_counts_against_the_slice() {
|
||||
use super::eval::{Ctx, Machine, Need, Outcome};
|
||||
let _heavy = super::value::HEAVY_CELLS.lock().unwrap_or_else(|e| e.into_inner());
|
||||
let mut s = session();
|
||||
let mut env = super::Env::default();
|
||||
let mut ctx = Ctx { s: &mut s, env: &mut env, depth: 0 };
|
||||
// Built before the measured run, so only the `length` is counted.
|
||||
let mut build = Machine::forms(super::read::read_all("(setq l '(1)) (repeat 15 (setq l (append l l)))").unwrap());
|
||||
assert!(matches!(build.run(&mut ctx, u64::MAX), Outcome::Done(_)));
|
||||
let mut m = Machine::forms(super::read::read_all("(length l)").unwrap());
|
||||
// Counted as one step, the walk left the few steps of `(length l)` well inside the slice.
|
||||
assert!(matches!(m.run(&mut ctx, 1_000), Outcome::Wait(Need::Yield)), "the walk was not charged");
|
||||
assert!(m.used > 32_768, "{}", m.used);
|
||||
match m.run(&mut ctx, u64::MAX) {
|
||||
Outcome::Done(v) => assert_eq!(to_text(&v, true), "32768"),
|
||||
_ => panic!("the length did not finish"),
|
||||
}
|
||||
assert_eq!(super::value::take_work(), 0, "nothing is left for the next run");
|
||||
}
|
||||
|
||||
/// A routine is charged the work its slice did, not the slice's length: one `length` of 2^19
|
||||
/// cells is far past a 400000-step slice.
|
||||
#[test]
|
||||
fn a_routine_is_charged_the_work_of_its_slice() {
|
||||
let _heavy = super::value::HEAVY_CELLS.lock().unwrap_or_else(|e| e.into_inner());
|
||||
let mut s = session();
|
||||
ok(&mut s, "(setq l '(1)) (repeat 19 (setq l (append l l))) nil");
|
||||
let r = s.lisp_eval("(length l) (repeat 10 (setq x 1))", false, false, Vec::new()).unwrap();
|
||||
assert!(r.is_none(), "the routine gave the interface a frame");
|
||||
assert!(s.lisp_busy());
|
||||
let steps = s.lisp.run.as_ref().map(|r| r.steps).unwrap_or(0);
|
||||
assert!(steps >= 1 << 19, "{steps}");
|
||||
for _ in 0..100 {
|
||||
if !s.lisp_busy() {
|
||||
break;
|
||||
}
|
||||
s.lisp_tick();
|
||||
}
|
||||
assert!(!s.lisp_running());
|
||||
ok(&mut s, "(setq l nil)");
|
||||
}
|
||||
|
||||
/// A run's last step walking a long list is charged to that run, not left for the next one: here
|
||||
/// it fails after the walk (a list of numbers isn't a list of strings), so no step follows it.
|
||||
#[test]
|
||||
fn the_last_steps_list_walk_is_charged_to_its_run() {
|
||||
let _heavy = super::value::HEAVY_CELLS.lock().unwrap_or_else(|e| e.into_inner());
|
||||
let mut s = session();
|
||||
let mut env = super::Env::default();
|
||||
env.globals.insert(super::value::Sym::new("L"), Value::list(vec![Value::Int(1); 100_000]));
|
||||
let mut m = super::eval::Machine::forms(super::read::read_all("(acad_strlsort l)").unwrap());
|
||||
let mut ctx = super::eval::Ctx { s: &mut s, env: &mut env, depth: 0 };
|
||||
assert!(matches!(m.run(&mut ctx, u64::MAX), super::eval::Outcome::Error(_)));
|
||||
assert!(m.used > 100_000, "{}", m.used);
|
||||
assert_eq!(super::value::take_work(), 0, "nothing is left for the next run");
|
||||
}
|
||||
|
||||
/// Nested callbacks share one cap: an inner endless callback retried by an outer one stops.
|
||||
#[test]
|
||||
fn nested_callback_steps_count_against_the_outer_callback() {
|
||||
let mut s = session();
|
||||
s.lisp.limits.callback_steps = 10_000;
|
||||
// Each level retried the endless level inside it with a fresh cap: 10000^3 steps, a hang.
|
||||
let code = "(defun g (a b) (while t)) \
|
||||
(defun f (a b) (while t (vl-catch-all-apply 'vl-sort (list '(1 2) 'g)))) \
|
||||
(defun h (a b) (while t (vl-catch-all-apply 'vl-sort (list '(1 2) 'f)))) \
|
||||
(vl-sort '(1 2) 'h)";
|
||||
assert_eq!(eval(&mut s, code), Err("callback stopped after 10000 steps".into()));
|
||||
// A callback's own steps count once, however many slices it runs in: three slices do three
|
||||
// times the work of one.
|
||||
let counts: Vec<u64> = [400_000, 1_200_000]
|
||||
.into_iter()
|
||||
.map(|cap| {
|
||||
s.lisp.limits.callback_steps = cap;
|
||||
ok(&mut s, "(setq n 0)");
|
||||
assert!(eval(&mut s, "(vl-remove-if '(lambda (x) (while t (setq n (1+ n)))) '(1))").is_err());
|
||||
ok(&mut s, "n").parse().unwrap()
|
||||
})
|
||||
.collect();
|
||||
assert!(counts[1] * 10 >= counts[0] * 29, "{counts:?}");
|
||||
}
|
||||
|
||||
/// The callback cap holds for each callback: a sort's comparisons together take more steps than
|
||||
/// it, and all their work still reaches the enclosing run.
|
||||
#[test]
|
||||
fn each_callback_has_its_own_cap_and_its_work_reaches_the_caller() {
|
||||
let mut s = session();
|
||||
s.lisp.limits.callback_steps = 1_000;
|
||||
let mut env = super::Env::default();
|
||||
env.globals.insert(super::value::Sym::new("L"), Value::list((0..300).rev().map(Value::Int)));
|
||||
let mut m = super::eval::Machine::forms(super::read::read_all("(vl-sort l (function (lambda (a b) (< a b))))").unwrap());
|
||||
let mut ctx = super::eval::Ctx { s: &mut s, env: &mut env, depth: 0 };
|
||||
let v = match m.run(&mut ctx, u64::MAX) {
|
||||
super::eval::Outcome::Done(v) => v,
|
||||
super::eval::Outcome::Error(e) => panic!("the sort failed: {e:?}"),
|
||||
super::eval::Outcome::Wait(_) => panic!("the sort waited"),
|
||||
};
|
||||
assert_eq!(to_text(&v, true), to_text(&Value::list((0..300).map(Value::Int)), true));
|
||||
// Over a thousand comparisons of several steps each, together well past the cap.
|
||||
assert!(m.used > 3_000, "{}", m.used);
|
||||
assert_eq!(super::value::take_work(), 0, "nothing is left for the next run");
|
||||
}
|
||||
|
||||
/// A zero-step callback limit prevents even the first callback side effect.
|
||||
#[test]
|
||||
fn a_zero_callback_budget_does_not_run_the_callback() {
|
||||
|
||||
@@ -64,8 +64,6 @@ thread_local! {
|
||||
static STRING_BYTES: Cell<(u64, u64)> = const { Cell::new((0, STRING_BUDGET)) };
|
||||
/// The running slice's cap on live cons cells.
|
||||
static CELL_LIMIT: Cell<usize> = const { Cell::new(MAX_CELLS) };
|
||||
/// Work done inside the current machine step: list cells walked, steps of synchronous callbacks.
|
||||
static WORK: Cell<u64> = const { Cell::new(0) };
|
||||
}
|
||||
|
||||
/// Start a slice of a run on this thread: it fails when more than `limit` cells are alive.
|
||||
@@ -78,16 +76,6 @@ pub fn check_cells() -> Result<(), LispError> {
|
||||
if live_cells() > CELL_LIMIT.with(Cell::get) { Err(LispError::quit("out of memory: too many list cells")) } else { Ok(()) }
|
||||
}
|
||||
|
||||
/// Count `n` units of work done inside one machine step ([`super::eval::Machine::run`] charges them as steps).
|
||||
pub fn charge_work(n: u64) {
|
||||
WORK.with(|c| c.set(c.get().saturating_add(n)));
|
||||
}
|
||||
|
||||
/// The work counted since the last call.
|
||||
pub fn take_work() -> u64 {
|
||||
WORK.with(|c| c.replace(0))
|
||||
}
|
||||
|
||||
/// Start a slice of a run on this thread: it has made `used` bytes of its `budget`.
|
||||
pub fn set_string_budget(used: u64, budget: u64) {
|
||||
STRING_BYTES.with(|c| c.set((used, budget)));
|
||||
@@ -274,10 +262,7 @@ impl Value {
|
||||
loop {
|
||||
match v {
|
||||
Value::Nil => return true,
|
||||
Value::Cons(c) => {
|
||||
charge_work(1);
|
||||
v = c.cdr.clone();
|
||||
}
|
||||
Value::Cons(c) => v = c.cdr.clone(),
|
||||
_ => return false,
|
||||
}
|
||||
}
|
||||
@@ -333,7 +318,6 @@ impl Iterator for ListIter {
|
||||
fn next(&mut self) -> Option<Value> {
|
||||
match std::mem::take(&mut self.next) {
|
||||
Value::Cons(c) => {
|
||||
charge_work(1);
|
||||
self.next = c.cdr.clone();
|
||||
Some(c.car.clone())
|
||||
}
|
||||
|
||||
@@ -329,39 +329,3 @@ fn auditctl_generates_adt_report_file() {
|
||||
|
||||
let _ = std::fs::remove_dir_all(&dir);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_handle_in_the_reserved_band_is_not_repaired_on_every_audit() {
|
||||
// A file object above HANDLE_LIMIT keeps its handle, and the seed deliberately does not move
|
||||
// past it (#913). AUDIT must not report that policy as an error its own repair never fixes.
|
||||
let band = Handle(cadcraft_engine::doc::HANDLE_LIMIT);
|
||||
let mut d = Drawing::new_imperial();
|
||||
d.space_mut(&Space::Model).unwrap().push(Entity { handle: band, common: Common::default(), kind: line((0.0, 0.0), (1.0, 0.0)) });
|
||||
d.handseed = band.0;
|
||||
for _ in 0..3 {
|
||||
let r = cadcraft_engine::audit::check(&d);
|
||||
assert!(r.issues.iter().all(|i| i.kind != "handseed"), "{}", r.message());
|
||||
}
|
||||
let mut repaired = d.clone();
|
||||
let r = cadcraft_engine::audit::repair(&mut repaired);
|
||||
assert!(r.iter().all(|i| i.kind != "handseed"), "{r:?}");
|
||||
assert_eq!(repaired.handseed, band.0, "the seed moved past the file's own handle");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn an_ordinary_handle_behind_a_reserved_band_one_is_still_repaired() {
|
||||
// The largest handle is in the reserved band, which the seed deliberately does not follow.
|
||||
// An ordinary handle above the seed must still be found behind it: it is the one the seed
|
||||
// has to move past, and skipping the check would leave AUDIT reporting a clean drawing.
|
||||
let band = Handle(cadcraft_engine::doc::HANDLE_LIMIT);
|
||||
let mut d = Drawing::new_imperial();
|
||||
let store = d.space_mut(&Space::Model).unwrap();
|
||||
store.push(Entity { handle: Handle(20), common: Common::default(), kind: line((0.0, 0.0), (1.0, 0.0)) });
|
||||
store.push(Entity { handle: band, common: Common::default(), kind: line((2.0, 0.0), (3.0, 0.0)) });
|
||||
d.handseed = 10;
|
||||
let r = cadcraft_engine::audit::repair(&mut d);
|
||||
assert!(r.iter().any(|i| i.kind == "handseed" && i.message.contains("(14)")), "the ordinary handle was hidden: {r:?}");
|
||||
assert_eq!(d.handseed, 21, "the seed was not moved past the ordinary handle");
|
||||
let r = cadcraft_engine::audit::repair(&mut d.clone());
|
||||
assert!(r.iter().all(|i| i.kind != "handseed"), "the repair does not stick: {r:?}");
|
||||
}
|
||||
|
||||
@@ -142,51 +142,6 @@ fn bad_input_is_refused_and_changes_nothing() {
|
||||
assert_eq!(listed(&mut s), json!([]));
|
||||
}
|
||||
|
||||
/// `data` longer than the largest image file encodes to is refused before it is decoded.
|
||||
#[test]
|
||||
fn oversized_data_is_refused_before_decoding() {
|
||||
hooks();
|
||||
const LIMIT: u64 = 256 << 20;
|
||||
let mut s = Session::new();
|
||||
// Not base64 at all: only the check before decoding tells it is too long ("not valid base64"
|
||||
// otherwise), and nothing is decoded.
|
||||
let too_long = "!".repeat(usize::try_from(LIMIT.div_ceil(3) * 4 + 1).unwrap());
|
||||
let e = s.execute("imageattach", &json!({ "path": "a.png", "data": too_long })).unwrap_err().to_string();
|
||||
assert!(e.contains("`data` is larger than 256 MB"), "{e}");
|
||||
// Line breaks don't count: base64 wrapped as MIME writes it is taken.
|
||||
let wrapped: String = base64_encode(&png()).as_bytes().chunks(76).map(|c| format!("{}\r\n", String::from_utf8_lossy(c))).collect();
|
||||
s.execute("imageattach", &json!({ "path": "wrapped.png", "data": wrapped })).unwrap();
|
||||
s.execute("undo", &json!({})).unwrap();
|
||||
|
||||
// The longest text allowed, holding one byte more than the limit, is refused once decoded.
|
||||
let groups = usize::try_from(LIMIT / 3).unwrap();
|
||||
let one_over = format!("{}AAA=", "AAAA".repeat(groups));
|
||||
assert_eq!(u64::try_from(one_over.len()).unwrap(), LIMIT.div_ceil(3) * 4, "as long as the text for the limit itself");
|
||||
let e = s.execute("imageattach", &json!({ "path": "a.png", "data": one_over })).unwrap_err().to_string();
|
||||
assert!(e.contains("`data` is larger than 256 MB"), "{e}");
|
||||
assert!(images(&s).is_empty());
|
||||
}
|
||||
|
||||
/// A relative path in an unsaved drawing has nothing to be relative to, and the error says so.
|
||||
#[test]
|
||||
fn a_relative_path_in_an_unsaved_drawing_says_what_to_do() {
|
||||
hooks();
|
||||
let mut s = Session::new();
|
||||
let e = s.execute("imageattach", &json!({ "path": "missing.png" })).unwrap_err().to_string();
|
||||
assert!(e.contains("save the drawing first, or give a full path"), "{e}");
|
||||
|
||||
let dir = folder("unsaved");
|
||||
let full = dir.join("missing.png");
|
||||
let e = s.execute("imageattach", &json!({ "path": full.to_string_lossy() })).unwrap_err().to_string();
|
||||
assert!(e.contains("file not found") && !e.contains("save the drawing"), "{e}");
|
||||
// A full Windows path, read as relative elsewhere, is a full path all the same.
|
||||
for windows in [r"C:\nowhere\a.png", "D:/nowhere/a.png", r"\\server\maps\a.png"] {
|
||||
let e = s.execute("imageattach", &json!({ "path": windows })).unwrap_err().to_string();
|
||||
assert!(e.contains("file not found") && !e.contains("save the drawing"), "{windows}: {e}");
|
||||
}
|
||||
let _ = std::fs::remove_dir_all(&dir);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn an_image_among_many_objects_keeps_its_pixels() {
|
||||
// More objects than one build task takes: the display list is built in parts and joined,
|
||||
|
||||
@@ -56,17 +56,11 @@ pub struct ShxGlyph {
|
||||
pub advance: Vec2,
|
||||
}
|
||||
|
||||
/// Glyphs cached per font, keyed by (shape, vertical), and their points in all.
|
||||
#[derive(Default)]
|
||||
struct GlyphCache {
|
||||
glyphs: HashMap<(u16, bool), Option<Arc<ShxGlyph>>>,
|
||||
points: usize,
|
||||
}
|
||||
/// Glyphs cached per font, keyed by (shape, vertical).
|
||||
type GlyphCache = HashMap<(u16, bool), Option<Arc<ShxGlyph>>>;
|
||||
|
||||
/// Most glyphs cached per font (a big font has thousands; text uses a few hundred).
|
||||
const MAX_CACHED_GLYPHS: usize = 16_384;
|
||||
/// Most points cached per font (16 MB; a glyph may hold thousands of points).
|
||||
const MAX_CACHED_POINTS: usize = 1 << 20;
|
||||
|
||||
/// A parsed SHX file.
|
||||
pub struct ShxFont {
|
||||
@@ -209,22 +203,15 @@ impl ShxFont {
|
||||
}
|
||||
let vertical = vertical && self.dual;
|
||||
let key = (number, vertical);
|
||||
if let Some(g) = self.cache.read().unwrap_or_else(PoisonError::into_inner).glyphs.get(&key) {
|
||||
if let Some(g) = self.cache.read().unwrap_or_else(PoisonError::into_inner).get(&key) {
|
||||
return g.clone();
|
||||
}
|
||||
let g = program::outline(self, number, vertical).ok().map(Arc::new);
|
||||
let points = g.as_ref().map_or(0, |g| g.strokes.iter().map(Vec::len).sum::<usize>());
|
||||
let mut c = self.cache.write().unwrap_or_else(PoisonError::into_inner);
|
||||
// Another thread may have outlined it in the meantime: its points are counted already.
|
||||
if let Some(g) = c.glyphs.get(&key) {
|
||||
return g.clone();
|
||||
if c.len() >= MAX_CACHED_GLYPHS {
|
||||
c.clear();
|
||||
}
|
||||
if c.glyphs.len() >= MAX_CACHED_GLYPHS || c.points.saturating_add(points) > MAX_CACHED_POINTS {
|
||||
c.glyphs.clear();
|
||||
c.points = 0;
|
||||
}
|
||||
c.points = c.points.saturating_add(points);
|
||||
c.glyphs.insert(key, g.clone());
|
||||
c.insert(key, g.clone());
|
||||
g
|
||||
}
|
||||
}
|
||||
|
||||
@@ -309,22 +309,6 @@ fn hostile_files_never_panic() {
|
||||
assert!(compile("").is_err());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn the_glyph_cache_is_bounded_by_points() {
|
||||
// Hostile: every glyph at the point bound, so 16,384 cached glyphs would hold 2 GB.
|
||||
let mut src = format!("*2,1,HUNDRED\n{}0\n*3,3,V\n011,019,0\n", "7,3,".repeat(100));
|
||||
for n in 10..=200 {
|
||||
src.push_str(&format!("*{n},1,HEAVY\n{}0\n", "7,2,".repeat(40)));
|
||||
}
|
||||
let f = font(&src);
|
||||
for n in 10..=200 {
|
||||
assert!(f.glyph(n, false).is_some());
|
||||
}
|
||||
let c = f.cache.read().unwrap();
|
||||
let cached: usize = c.glyphs.values().flatten().map(|g| g.strokes.iter().map(Vec::len).sum::<usize>()).sum();
|
||||
assert!(cached <= MAX_CACHED_POINTS && cached == c.points, "{cached}");
|
||||
}
|
||||
|
||||
/// Register a compiled test font under `name` (each test its own names: the table is shared).
|
||||
fn reg(name: &str, src: &str) {
|
||||
register(name, &compile(src).unwrap()).unwrap();
|
||||
|
||||
@@ -1062,10 +1062,11 @@ pub(crate) fn finish(tags: &mut Vec<Tag>, d: &Drawing, reactors: &HashMap<Handle
|
||||
alive_memo
|
||||
});
|
||||
// New handles for the written kept objects, above every written handle and the seed.
|
||||
let mut fresh = Fresh::new(tags);
|
||||
let mut next = seed(tags).max(max_handle(tags).saturating_add(1));
|
||||
let mut alive: HashMap<String, String> = HashMap::new();
|
||||
for o in f.objects.iter().filter(|o| alive_memo.get(&o.handle.hex()) == Some(&true)) {
|
||||
alive.insert(o.handle.hex(), format!("{:X}", fresh.take()));
|
||||
alive.insert(o.handle.hex(), format!("{next:X}"));
|
||||
next = next.saturating_add(1);
|
||||
}
|
||||
let entities: HashSet<String> = all_entities(d).map(|e| e.handle.hex()).filter(|h| written.contains(h)).collect();
|
||||
let map = Map { f, alive, raw: objs.keys().cloned().collect(), roles, entities };
|
||||
@@ -1388,18 +1389,19 @@ fn add_appids(out: &mut Vec<Tag>) {
|
||||
return;
|
||||
}
|
||||
// New handles above the seed, which is then moved past them.
|
||||
let mut fresh = Fresh::new(out);
|
||||
let mut next = seed(out).max(max_handle(out).saturating_add(1));
|
||||
let mut add = Vec::new();
|
||||
for app in &missing {
|
||||
add.extend([
|
||||
Tag::s(0, "APPID"),
|
||||
Tag::s(5, format!("{:X}", fresh.take())),
|
||||
Tag::s(5, format!("{next:X}")),
|
||||
Tag::s(330, table_h.clone()),
|
||||
Tag::s(100, "AcDbSymbolTableRecord"),
|
||||
Tag::s(100, "AcDbRegAppTableRecord"),
|
||||
Tag::s(2, (*app).clone()),
|
||||
Tag::i(70, 0),
|
||||
]);
|
||||
next = next.saturating_add(1);
|
||||
}
|
||||
let end_at = end.start;
|
||||
if let Some(count) = out.get_mut(t.start + 1..t.end).and_then(|b| b.iter_mut().find(|x| x.code == 70)) {
|
||||
@@ -1418,36 +1420,6 @@ fn seed(tags: &[Tag]) -> u64 {
|
||||
seed_index(tags).and_then(|i| tags.get(i)).and_then(|t| Handle::parse_hex(&t.str())).map_or(0, |h| h.0)
|
||||
}
|
||||
|
||||
/// New handles for records added to written tags: above the seed and every handle written, and
|
||||
/// never one a record already holds. A file may hold the top handle (#913): then counting on from
|
||||
/// it would give every added record that same handle, so past the top of the range the numbering
|
||||
/// goes on in the reserved band above [`cadcraft_doc::HANDLE_LIMIT`], skipping the handles there.
|
||||
struct Fresh {
|
||||
next: u64,
|
||||
used: HashSet<u64>,
|
||||
}
|
||||
|
||||
impl Fresh {
|
||||
fn new(tags: &[Tag]) -> Self {
|
||||
let used: HashSet<u64> =
|
||||
tags.iter().filter(|t| t.code == 5 || t.code == 105).filter_map(|t| Handle::parse_hex(&t.str())).map(|h| h.0).collect();
|
||||
let above = used.iter().max().map_or(0, |h| h.checked_add(1).unwrap_or(cadcraft_doc::HANDLE_LIMIT));
|
||||
Fresh { next: seed(tags).max(above), used }
|
||||
}
|
||||
/// The next free handle. Each handle skipped is one a record holds, so the walk is bounded
|
||||
/// by their count (and handle 0, which means "none").
|
||||
fn take(&mut self) -> u64 {
|
||||
for _ in 0..self.used.len().saturating_add(2) {
|
||||
let h = self.next;
|
||||
self.next = h.checked_add(1).unwrap_or(cadcraft_doc::HANDLE_LIMIT);
|
||||
if h != 0 && self.used.insert(h) {
|
||||
return h;
|
||||
}
|
||||
}
|
||||
self.next
|
||||
}
|
||||
}
|
||||
|
||||
/// The largest handle of a record (groups 5 and 105).
|
||||
fn max_handle(tags: &[Tag]) -> u64 {
|
||||
tags.iter().filter(|t| t.code == 5 || t.code == 105).filter_map(|t| Handle::parse_hex(&t.str())).map(|h| h.0).max().unwrap_or(0)
|
||||
|
||||
@@ -102,36 +102,11 @@ fn read_budgeted(bytes: &[u8], mut table_cells_left: usize) -> Result<Drawing> {
|
||||
// its $HANDSEED can be lower than its handles, and entities made while reading (the faces of
|
||||
// a polygon mesh) would otherwise get handles that records further on still have. A file
|
||||
// CADCraft wrote names its own next handle, above which its rebuilt records are numbered
|
||||
// (#495), so for it only the entity records are reserved. Handles in the reserved band are
|
||||
// reserved for allocation rather than followed (#913): a handle-less entity read before the
|
||||
// section that names one is placed would otherwise be given it and replace the record (#1276).
|
||||
// (#495), so it is left to that.
|
||||
let ours = secs.iter().any(|s| s.name == "OBJECTS" && s.tags.iter().any(|t| t.code == 3 && t.str() == crate::dxf_ext::HANDSEED_KEY));
|
||||
if ours {
|
||||
// Its table and object records are numbered above its seed and rebuilt on save (#495),
|
||||
// so only its entities are reserved. Reading is section by section: an entity that has
|
||||
// no handle, or repeats one within its section, gets a fresh handle, and that must not
|
||||
// be one an entity of a later section still names. `BLOCK` and `ENDBLK` are structural
|
||||
// records, not entities, and are left out so they don't move the saved seed.
|
||||
for (kind, tags) in secs.iter().filter(|s| s.name == "BLOCKS" || s.name == "ENTITIES").flat_map(|s| records(&s.tags)) {
|
||||
if matches!(kind.as_str(), "BLOCK" | "ENDBLK") {
|
||||
continue;
|
||||
}
|
||||
if let Some(h) = tags.iter().find(|t| t.code == 5).and_then(|t| Handle::parse_hex(t.str().trim())) {
|
||||
d.bump_handseed(h);
|
||||
d.reserve_handle(h);
|
||||
}
|
||||
}
|
||||
} else {
|
||||
for s in &secs {
|
||||
let entity_section = s.name == "BLOCKS" || s.name == "ENTITIES";
|
||||
for t in s.tags.iter().filter(|t| t.code == 5 || t.code == 105) {
|
||||
if let Some(h) = Handle::parse_hex(t.str().trim()) {
|
||||
d.bump_handseed(h);
|
||||
if entity_section {
|
||||
d.reserve_handle(h);
|
||||
}
|
||||
}
|
||||
}
|
||||
for t in secs.iter().filter(|_| !ours).flat_map(|s| s.tags.iter()).filter(|t| t.code == 5 || t.code == 105) {
|
||||
if let Some(h) = Handle::parse_hex(t.str().trim()) {
|
||||
d.bump_handseed(h);
|
||||
}
|
||||
}
|
||||
let mut skipped = std::collections::BTreeMap::new();
|
||||
@@ -173,9 +148,6 @@ fn read_budgeted(bytes: &[u8], mut table_cells_left: usize) -> Result<Drawing> {
|
||||
crate::dxf_raw::read(&secs, &mut d);
|
||||
crate::dxf_clip::read(&mut d);
|
||||
d.skipped_records = skipped;
|
||||
// Every record is placed now, and an object holding a reserved handle keeps it from new
|
||||
// objects by itself. Kept, the set would be copied with every undo step of the drawing.
|
||||
d.reserved_handles.clear();
|
||||
Ok(d)
|
||||
}
|
||||
|
||||
|
||||
@@ -55,7 +55,6 @@ pub(super) fn parse_entities(
|
||||
}
|
||||
if let Some((c, mut k)) = kindent {
|
||||
let h = match handle {
|
||||
// A file's handles keep their identity, however high they are (#913, #939).
|
||||
Some(h) => {
|
||||
d.bump_handseed(h);
|
||||
h
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
//! the newer DIMSTYLE groups, and from 2007 in UTF-8 text (the caller picks the text encoding) and
|
||||
//! MULTILEADER entities (older files get LEADER + MTEXT).
|
||||
|
||||
use std::collections::{HashMap, HashSet};
|
||||
use std::collections::HashMap;
|
||||
|
||||
use cadcraft_color::Color;
|
||||
use cadcraft_doc::{
|
||||
@@ -39,9 +39,6 @@ use sections::tags_for;
|
||||
struct W {
|
||||
t: Vec<Tag>,
|
||||
next: u64,
|
||||
/// Handles the drawing's objects already hold: structural records skip them, so writing a
|
||||
/// file whose own handles sit near the top of the range never repeats a handle (#913).
|
||||
used: HashSet<u64>,
|
||||
/// Upper-case plot style name → its `ACDBPLACEHOLDER` handle (group 390 of layers and objects).
|
||||
pstyles: HashMap<String, String>,
|
||||
/// Upper-case layer name → its LAYER table record handle (group 331/341 of viewports).
|
||||
@@ -51,21 +48,6 @@ struct W {
|
||||
reactors: HashMap<Handle, Vec<String>>,
|
||||
}
|
||||
|
||||
/// Where the writer's own records (tables, objects, dictionaries) start numbering: above every
|
||||
/// object handle and the drawing's seed, with headroom for handles the drawing allocates next.
|
||||
fn structural_start(d: &Drawing) -> u64 {
|
||||
let highest = entity_handles(d).max().unwrap_or(0);
|
||||
d.handseed.max(0x100).max(highest.saturating_add(1)).saturating_add(0x1000)
|
||||
}
|
||||
|
||||
/// Every handle an object holds, plus the drawing's next one.
|
||||
fn entity_handles(d: &Drawing) -> impl Iterator<Item = u64> + '_ {
|
||||
let model = d.model.iter().map(|e| e.handle.0);
|
||||
let layouts = d.layouts.iter().flat_map(|l| l.entities.iter()).map(|e| e.handle.0);
|
||||
let blocks = d.blocks.values().flat_map(|b| b.entities.iter()).map(|e| e.handle.0);
|
||||
model.chain(layouts).chain(blocks).chain(std::iter::once(d.handseed))
|
||||
}
|
||||
|
||||
impl W {
|
||||
fn s(&mut self, c: i32, v: impl Into<String>) {
|
||||
self.t.push(Tag::s(c, v));
|
||||
@@ -89,20 +71,10 @@ impl W {
|
||||
format!("{:X}", self.next_handle())
|
||||
}
|
||||
/// A new handle for a record the drawing doesn't hold (as [`W::h`]).
|
||||
///
|
||||
/// Skips every handle in use, so a file object carrying a handle above the seed (the
|
||||
/// reserved band) is not handed out again, and wraps into that band if the writer runs off
|
||||
/// the top of the range. Each handle skipped is one in use, so the walk is bounded by their
|
||||
/// count.
|
||||
fn next_handle(&mut self) -> u64 {
|
||||
for _ in 0..self.used.len().saturating_add(1) {
|
||||
let h = self.next;
|
||||
self.next = h.checked_add(1).unwrap_or(cadcraft_doc::HANDLE_LIMIT);
|
||||
if self.used.insert(h) {
|
||||
return h;
|
||||
}
|
||||
}
|
||||
self.next
|
||||
let h = self.next;
|
||||
self.next = self.next.saturating_add(1);
|
||||
h
|
||||
}
|
||||
/// A `102 {NAME` … `102 }` group of handles.
|
||||
fn group(&mut self, name: &str, code: i32, handles: &[&str]) {
|
||||
@@ -180,8 +152,7 @@ fn bridge_markers(tags: &mut [Tag]) {
|
||||
pub fn entity_groups(d: &Drawing, e: &Entity) -> (String, Vec<Tag>) {
|
||||
let mut w = W {
|
||||
t: Vec::new(),
|
||||
next: structural_start(d),
|
||||
used: entity_handles(d).collect(),
|
||||
next: d.handseed.max(0x100).saturating_add(0x1000),
|
||||
pstyles: HashMap::new(),
|
||||
layers: HashMap::new(),
|
||||
reactors: HashMap::new(),
|
||||
|
||||
@@ -16,14 +16,7 @@ pub(super) fn annotative_xdata(w: &mut W) {
|
||||
|
||||
/// Override (`ACAD` DSTYLE) and associativity (`CADCRAFT` ASSOC) xdata of a dimension.
|
||||
pub(super) fn dim_xdata(w: &mut W, dm: &Dimension, cx: &Ctx) {
|
||||
let mut ov = W {
|
||||
t: Vec::new(),
|
||||
next: 0,
|
||||
used: std::collections::HashSet::new(),
|
||||
pstyles: HashMap::new(),
|
||||
layers: HashMap::new(),
|
||||
reactors: HashMap::new(),
|
||||
};
|
||||
let mut ov = W { t: Vec::new(), next: 0, pstyles: HashMap::new(), layers: HashMap::new(), reactors: HashMap::new() };
|
||||
let mut sah = false;
|
||||
for (k, v) in &dm.overrides {
|
||||
let Some(field) = DimStyle::field_name(k) else { continue };
|
||||
|
||||
@@ -7,10 +7,9 @@ use super::header::{code_page, header_vars};
|
||||
use super::layout::{paper_views, record_head, sheet_first, table_head, vport_table};
|
||||
use super::objects::{cadcraft_fonts_name, group_obj, mleader_style_obj, scale_list, table_style_obj};
|
||||
use super::{
|
||||
Block, Color, DimStyle, DimVal, Drawing, Entity, EntityKind, EntityStore, Group, HVal, Handle, HashMap, HashSet, Layout, MLeaderStyle, PageSetup,
|
||||
Space, TableStyle, Tag, Vec2, Vec3, Version, W, dxf_ext,
|
||||
Block, Color, DimStyle, DimVal, Drawing, Entity, EntityKind, EntityStore, Group, HVal, Handle, HashMap, Layout, MLeaderStyle, PageSetup, Space,
|
||||
TableStyle, Tag, Vec2, Vec3, Version, W, dxf_ext,
|
||||
};
|
||||
use super::{entity_handles, structural_start};
|
||||
|
||||
struct TableWritePlan<'a> {
|
||||
d: &'a Drawing,
|
||||
@@ -246,7 +245,7 @@ fn write_dimstyles(w: &mut W, d: &Drawing, cx: &mut Ctx, version: Version) {
|
||||
w.i(70, 0);
|
||||
let v = serde_json::to_value(s).unwrap_or_default();
|
||||
let defaults = serde_json::to_value(DimStyle::default()).unwrap_or_default();
|
||||
let mut newer = W { t: Vec::new(), next: 0, used: HashSet::new(), pstyles: HashMap::new(), layers: HashMap::new(), reactors: HashMap::new() };
|
||||
let mut newer = W { t: Vec::new(), next: 0, pstyles: HashMap::new(), layers: HashMap::new(), reactors: HashMap::new() };
|
||||
for (field, code, kind) in dxf_ext::DIM_CODES {
|
||||
let Some(enc) = v.get(*field).and_then(|x| cx.encode(*kind, x)) else { continue };
|
||||
// DIMPOST is written even when empty: a reader that defaults a missing one to "<>"
|
||||
@@ -917,8 +916,7 @@ pub(super) fn tags_for(d: &Drawing, version: Version, target: Version, frozen_34
|
||||
// Structural handles start above every entity handle.
|
||||
let mut w = W {
|
||||
t: Vec::new(),
|
||||
next: structural_start(d),
|
||||
used: entity_handles(d).collect(),
|
||||
next: d.handseed.max(0x100).saturating_add(0x1000),
|
||||
pstyles: HashMap::new(),
|
||||
layers: HashMap::new(),
|
||||
reactors: hatch_reactors(d),
|
||||
@@ -1095,11 +1093,11 @@ pub(super) fn tags_for(d: &Drawing, version: Version, target: Version, frozen_34
|
||||
for (n, h, b) in &user_blocks {
|
||||
block(&mut w, (n, &b.description), h, b.base, if b.anonymous { 1 } else { 0 }, &mut b.entities.iter().map(|e| e.as_ref()), false);
|
||||
}
|
||||
// Generated geometry entities (dimension, arrowhead and table blocks) need handles; take
|
||||
// them from the writer's allocator, which skips the drawing's own handles.
|
||||
// Generated geometry entities (dimension, arrowhead and table blocks) need handles.
|
||||
for (_, _, ents) in dim_defs.iter_mut().chain(arrow_defs.iter_mut()).chain(table_defs.iter_mut()) {
|
||||
for e in ents.iter_mut().filter(|e| e.handle.0 == 0) {
|
||||
e.handle = Handle(w.next_handle());
|
||||
e.handle = Handle(w.next);
|
||||
w.next = w.next.saturating_add(1);
|
||||
}
|
||||
}
|
||||
for (n, h, ents) in &dim_defs {
|
||||
|
||||
+16
-122
@@ -17,7 +17,7 @@ use std::collections::BTreeMap;
|
||||
|
||||
use cadcraft_color::Color;
|
||||
use cadcraft_doc::{Circle, Common, Drawing, Ellipse, EntityKind, Layer, Line, LwPolyline, Space};
|
||||
use cadcraft_geom::{Mat3, PolyVertex, Spline, Vec2, Vec3, bulge_to_arc};
|
||||
use cadcraft_geom::{Mat3, PolyVertex, Spline, Vec2, Vec3};
|
||||
|
||||
use crate::{IoError, Result};
|
||||
|
||||
@@ -70,8 +70,6 @@ struct Parser {
|
||||
verts_left: usize,
|
||||
/// What was left out, by kind ([`LeftOut`]).
|
||||
left_out: BTreeMap<LeftOut, usize>,
|
||||
/// Shapes left out because their coordinates or extents overflow: invalid, not unsupported.
|
||||
too_large: usize,
|
||||
}
|
||||
|
||||
/// Drawn content the reader leaves out, named in the drawing's read note.
|
||||
@@ -107,23 +105,16 @@ impl Parser {
|
||||
elements: 0,
|
||||
verts_left: MAX_TOTAL_VERTS,
|
||||
left_out: BTreeMap::new(),
|
||||
too_large: 0,
|
||||
}
|
||||
}
|
||||
|
||||
/// The read notes on what was left out: what isn't read yet, then what is invalid.
|
||||
fn notes(&self) -> Vec<String> {
|
||||
let mut notes = Vec::new();
|
||||
if !self.left_out.is_empty() {
|
||||
let list: Vec<String> = self.left_out.iter().map(|(k, n)| k.describe(*n)).collect();
|
||||
notes.push(format!("SVG: CADCraft doesn't read these yet, so they were left out: {}", list.join(", ")));
|
||||
/// The read note on what was left out, if anything was.
|
||||
fn note(&self) -> Option<String> {
|
||||
if self.left_out.is_empty() {
|
||||
return None;
|
||||
}
|
||||
match self.too_large {
|
||||
0 => {}
|
||||
1 => notes.push("SVG: 1 shape was left out as invalid: its coordinates or size are too large to represent".into()),
|
||||
n => notes.push(format!("SVG: {n} shapes were left out as invalid: their coordinates or size are too large to represent")),
|
||||
}
|
||||
notes
|
||||
let list: Vec<String> = self.left_out.iter().map(|(k, n)| k.describe(*n)).collect();
|
||||
Some(format!("SVG: CADCraft doesn't read these yet, so they were left out: {}", list.join(", ")))
|
||||
}
|
||||
|
||||
fn parse(&mut self, text: &str) -> Result<()> {
|
||||
@@ -159,7 +150,7 @@ impl Parser {
|
||||
};
|
||||
self.left_out.insert(kind, count);
|
||||
}
|
||||
self.drawing.read_notes.extend(self.notes());
|
||||
self.drawing.read_notes.extend(self.note());
|
||||
Ok(())
|
||||
}
|
||||
|
||||
@@ -227,18 +218,12 @@ impl Parser {
|
||||
}
|
||||
// Charge the vertices this entity retains against the shared document budget, so repeated
|
||||
// flattened arcs/curves cannot amplify a compact path into unbounded geometry (CWE-400).
|
||||
// A shape left out below was generated all the same, so it is charged too.
|
||||
let verts = match &kind {
|
||||
EntityKind::LwPolyline(p) => p.vertices.len(),
|
||||
EntityKind::Spline(s) => s.control.len(),
|
||||
_ => 1,
|
||||
};
|
||||
self.verts_left = self.verts_left.checked_sub(verts).ok_or_else(|| IoError::Format("SVG: too much generated geometry".into()))?;
|
||||
// Finite numbers can still overflow through transforms and relative steps (`l1e308 0` twice).
|
||||
if !finite(&kind) {
|
||||
self.too_large += 1;
|
||||
return Ok(());
|
||||
}
|
||||
let common = Common { layer: self.layer.clone(), ..Common::default() };
|
||||
self.drawing.add(&Space::Model, common, kind).map(|_| ()).map_err(parse_err)
|
||||
}
|
||||
@@ -246,10 +231,7 @@ impl Parser {
|
||||
/// A circle or ellipse through a transform. A circle stays a `CIRCLE` under rotations,
|
||||
/// uniform scales and reflections; anything else becomes an `ELLIPSE` holding the axes
|
||||
/// of the transformed shape — a linear map sends the unit circle to an ellipse whose
|
||||
/// semi-axes are the square roots of the eigenvalues of `A·Aᵀ`. With `B = [bx by]` the
|
||||
/// ellipse is `center + B·(cos t, sin t)`; `B·Bᵀ` lives in the drawing plane, so its leading
|
||||
/// eigenvector is the major axis's direction. `major` is that axis from the centre, as
|
||||
/// [`Ellipse::major`] is everywhere else.
|
||||
/// semi-axes are the square roots of the eigenvalues of `A·Aᵀ`.
|
||||
fn add_rounded(&mut self, center_user: Vec2, rx: f64, ry: f64) -> Result<()> {
|
||||
let center = self.map(center_user);
|
||||
let bx = self.map_vec(Vec2::new(rx, 0.0));
|
||||
@@ -271,15 +253,18 @@ impl Parser {
|
||||
if s_max <= f64::EPSILON {
|
||||
return Ok(());
|
||||
}
|
||||
let axis = if xy.abs() <= 1e-12 * trace {
|
||||
let axis = if xy.abs() <= 1e-12 * trace.max(1.0) {
|
||||
if yy > xx { Vec2::new(0.0, 1.0) } else { Vec2::new(1.0, 0.0) }
|
||||
} else {
|
||||
let v = Vec2::new(xy, l_max - xx);
|
||||
// |v| ≥ |xy| > 1e-12·trace ≥ 0 here, so the division is never by zero.
|
||||
v / len(v)
|
||||
let l = len(v);
|
||||
if l <= f64::EPSILON {
|
||||
return Ok(());
|
||||
}
|
||||
v / l
|
||||
};
|
||||
let ratio = (l_min.max(0.0).sqrt() / s_max).clamp(1e-9, 1.0);
|
||||
let major = axis * s_max;
|
||||
let major = center + axis * s_max;
|
||||
self.add(EntityKind::Ellipse(Ellipse { center: v3(center), major: v3(major), ratio, start: 0.0, end: std::f64::consts::TAU }))
|
||||
}
|
||||
|
||||
@@ -395,79 +380,6 @@ impl Parser {
|
||||
}
|
||||
}
|
||||
|
||||
/// Every coordinate of an entity the reader makes is finite, and so are its extents: a finite
|
||||
/// centre and radius can still reach past the largest number.
|
||||
fn finite(kind: &EntityKind) -> bool {
|
||||
match kind {
|
||||
EntityKind::Line(l) => l.a.is_finite() && l.b.is_finite(),
|
||||
EntityKind::Circle(c) => {
|
||||
c.center.is_finite()
|
||||
&& c.radius.is_finite()
|
||||
&& cadcraft_geom::Circle::new(c.center.xy(), c.radius).bounds().corners().iter().all(|p| p.is_finite())
|
||||
}
|
||||
EntityKind::Ellipse(e) => {
|
||||
// Half the box is `hypot` of the major axis and the minor axis (`ratio` times it, turned).
|
||||
let (m, r) = (e.major.xy(), e.ratio);
|
||||
e.center.is_finite() && e.major.is_finite() && e.ratio.is_finite() && box_finite(e.center.xy(), m.x.hypot(r * m.y), m.y.hypot(r * m.x))
|
||||
}
|
||||
EntityKind::LwPolyline(p) => p.vertices.iter().all(|v| v.p.is_finite() && v.bulge.is_finite()) && bulges_finite(p),
|
||||
EntityKind::Spline(s) => s.control.iter().all(|p| p.is_finite()),
|
||||
// The SVG reader doesn't make these.
|
||||
EntityKind::Point(_)
|
||||
| EntityKind::Arc(_)
|
||||
| EntityKind::Polyline3d(_)
|
||||
| EntityKind::Helix(_)
|
||||
| EntityKind::Ray(_)
|
||||
| EntityKind::XLine(_)
|
||||
| EntityKind::Text(_)
|
||||
| EntityKind::MText(_)
|
||||
| EntityKind::AttDef(_)
|
||||
| EntityKind::Insert(_)
|
||||
| EntityKind::Dimension(_)
|
||||
| EntityKind::MLine(_)
|
||||
| EntityKind::Leader(_)
|
||||
| EntityKind::MLeader(_)
|
||||
| EntityKind::Hatch(_)
|
||||
| EntityKind::Solid(_)
|
||||
| EntityKind::Trace(_)
|
||||
| EntityKind::Face3d(_)
|
||||
| EntityKind::PolyfaceMesh(_)
|
||||
| EntityKind::Region(_)
|
||||
| EntityKind::Viewport(_)
|
||||
| EntityKind::Image(_)
|
||||
| EntityKind::Wipeout(_)
|
||||
| EntityKind::Table(_)
|
||||
| EntityKind::Tolerance(_)
|
||||
| EntityKind::Unknown(_) => true,
|
||||
}
|
||||
}
|
||||
|
||||
/// The box `centre ± (hx, hy)` is finite.
|
||||
fn box_finite(c: Vec2, hx: f64, hy: f64) -> bool {
|
||||
[c.x - hx, c.x + hx, c.y - hy, c.y + hy].iter().all(|v| v.is_finite())
|
||||
}
|
||||
|
||||
/// Every arc segment of the polyline (a bulge between finite vertices) has a finite centre and
|
||||
/// radius, and the quadrant points it passes through are finite.
|
||||
fn bulges_finite(p: &LwPolyline) -> bool {
|
||||
let n = p.vertices.len();
|
||||
p.vertices.iter().enumerate().all(|(i, v)| {
|
||||
let next = if i + 1 < n {
|
||||
p.vertices.get(i + 1)
|
||||
} else if p.closed {
|
||||
p.vertices.first()
|
||||
} else {
|
||||
None
|
||||
};
|
||||
let Some((arc, _)) = next.and_then(|w| bulge_to_arc(v.p, w.p, v.bulge)) else { return true };
|
||||
arc.center.is_finite()
|
||||
&& arc.radius.is_finite()
|
||||
&& (0..4)
|
||||
.map(|k| f64::from(k) * std::f64::consts::FRAC_PI_2)
|
||||
.all(|a| !arc.contains_angle(a) || Vec2::polar(arc.center, arc.radius, a).is_finite())
|
||||
})
|
||||
}
|
||||
|
||||
/// One `M …` run of a `d` attribute.
|
||||
struct Subpath {
|
||||
start: Vec2,
|
||||
@@ -559,22 +471,4 @@ mod tests {
|
||||
assert_eq!(arc_of("M10 10 a20 20 0 1 0 20 20"), (true, false, spaced.2));
|
||||
assert!(arc_of("M10 10 a20 20 0 10-20 20").0);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn extents_past_the_largest_number_are_not_finite() {
|
||||
let ellipse = |c: Vec2, major: Vec2| EntityKind::Ellipse(Ellipse { center: v3(c), major: v3(major), ratio: 1.0, start: 0.0, end: 0.0 });
|
||||
assert!(!finite(&ellipse(Vec2::new(1e308, 0.0), Vec2::new(1e308, 0.0))));
|
||||
assert!(finite(&ellipse(Vec2::new(5e307, 0.0), Vec2::new(5e307, 0.0))));
|
||||
// Turned, its box is wider than its axis: `centre ± major` is finite, the box isn't.
|
||||
assert!(!finite(&ellipse(Vec2::new(6e307, 0.0), Vec2::new(9e307, 9e307))));
|
||||
assert!(finite(&ellipse(Vec2::ZERO, Vec2::new(9e307, 9e307))));
|
||||
// Half circles between the same finite points: bulging up passes 1.8e308, down doesn't.
|
||||
let half = |bulge: f64| {
|
||||
let (a, b) = (Vec2::new(0.0, 1.5e308), Vec2::new(1e308, 1.5e308));
|
||||
let vertices = vec![PolyVertex::with_bulge(a, bulge), PolyVertex::new(b)];
|
||||
EntityKind::LwPolyline(LwPolyline { vertices, closed: false, const_width: 0.0, elevation: 0.0, plinegen: false })
|
||||
};
|
||||
assert!(!finite(&half(-1.0)));
|
||||
assert!(finite(&half(1.0)));
|
||||
}
|
||||
}
|
||||
|
||||
+1
-117
@@ -2915,75 +2915,12 @@ fn svg_shapes_become_entities_in_millimetres() {
|
||||
let c = first(&d, |k| if let EntityKind::Circle(c) = k { Some(c.clone()) } else { None });
|
||||
assert!((c.radius - 2.0).abs() < 1e-9 && (c.center.x - 10.0).abs() < 1e-9 && (c.center.y - 5.0).abs() < 1e-9, "{c:?}");
|
||||
let e = first(&d, |k| if let EntityKind::Ellipse(e) = k { Some(e.clone()) } else { None });
|
||||
let major = Vec2::new(e.major.x, e.major.y);
|
||||
let major = Vec2::new(e.major.x - e.center.x, e.major.y - e.center.y);
|
||||
assert!((major.len() - 4.0).abs() < 1e-9 && (e.ratio - 0.5).abs() < 1e-9, "{e:?}");
|
||||
let l = first(&d, |k| if let EntityKind::Line(l) = k { Some(l.clone()) } else { None });
|
||||
assert!((l.a.y - 10.0).abs() < 1e-9 && (l.b.y).abs() < 1e-9, "{l:?}");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn svg_ellipse_major_axis_is_relative_to_its_centre() {
|
||||
// Away from the origin: the major axis was stored as the absolute point centre + axis.
|
||||
let svg = format!("{SVG_PAGE}<ellipse cx=\"15\" cy=\"2\" rx=\"2\" ry=\"1\"/><circle cx=\"15\" cy=\"2\" r=\"1\"/></svg>");
|
||||
let d = read(svg.as_bytes(), "ellipse.svg").unwrap();
|
||||
assert_eq!(kinds(&d), ["Ellipse", "Circle"]);
|
||||
let e = first(&d, |k| if let EntityKind::Ellipse(e) = k { Some(e.clone()) } else { None });
|
||||
assert!((e.center - Vec3::new(15.0, 8.0, 0.0)).len() < 1e-9, "{e:?}");
|
||||
assert!((e.major.x.abs() - 2.0).abs() < 1e-9 && e.major.y.abs() < 1e-9 && e.major.z == 0.0, "{e:?}");
|
||||
assert!((e.ratio - 0.5).abs() < 1e-9, "{e:?}");
|
||||
let c = first(&d, |k| if let EntityKind::Circle(c) = k { Some(c.clone()) } else { None });
|
||||
assert!((c.center - Vec3::new(15.0, 8.0, 0.0)).len() < 1e-9 && (c.radius - 1.0).abs() < 1e-9, "{c:?}");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn svg_rotated_ellipse_keeps_its_turn() {
|
||||
// The page maps SVG (x, y) to (x, 10 - y); undo that, then rotate by -30°, to get back to the ellipse's own frame.
|
||||
let svg = format!("{SVG_PAGE}<ellipse cx=\"0\" cy=\"0\" rx=\"20\" ry=\"10\" transform=\"rotate(30)\"/></svg>");
|
||||
let d = read(svg.as_bytes(), "rotated.svg").unwrap();
|
||||
assert_eq!(kinds(&d), ["Ellipse"]);
|
||||
let e = first(&d, |k| if let EntityKind::Ellipse(e) = k { Some(e.clone()) } else { None });
|
||||
let major = Vec2::new(e.major.x, e.major.y);
|
||||
assert!((major.len() - 20.0).abs() < 1e-9 && (e.ratio - 0.5).abs() < 1e-9, "{e:?}");
|
||||
let (s, c) = 30f64.to_radians().sin_cos();
|
||||
let want = Vec2::new(20.0 * c, -20.0 * s);
|
||||
assert!((major - want).len() < 1e-9 || (major + want).len() < 1e-9, "{e:?}");
|
||||
let (ux, uy) = (e.center.x + major.x, 10.0 - (e.center.y + major.y));
|
||||
let (x, y) = (c * ux + s * uy, -s * ux + c * uy);
|
||||
assert!(((x / 20.0).powi(2) + (y / 10.0).powi(2) - 1.0).abs() < 1e-9, "{e:?}");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn svg_sheared_circle_has_the_axes_of_its_image() {
|
||||
// matrix(1 0 1 1 0 0) is B = [[1, 1], [0, 1]]; the page then flips Y at one millimetre per unit.
|
||||
let svg = format!("{SVG_PAGE}<circle r=\"1\" transform=\"matrix(1 0 1 1 0 0)\"/></svg>");
|
||||
let d = read(svg.as_bytes(), "sheared.svg").unwrap();
|
||||
assert_eq!(kinds(&d), ["Ellipse"]);
|
||||
let e = first(&d, |k| if let EntityKind::Ellipse(e) = k { Some(e.clone()) } else { None });
|
||||
let major = Vec2::new(e.major.x, e.major.y);
|
||||
let s_max = ((3.0 + 5f64.sqrt()) / 2.0).sqrt();
|
||||
let s_min = ((3.0 - 5f64.sqrt()) / 2.0).sqrt();
|
||||
assert!((major.len() - s_max).abs() < 1e-9 * s_max, "{e:?}");
|
||||
assert!((e.ratio - s_min / s_max).abs() < 1e-9, "{e:?}");
|
||||
let (ux, uy) = (major.x, -major.y);
|
||||
let pre = Vec2::new(ux - uy, uy);
|
||||
assert!((pre.len() - 1.0).abs() < 1e-9, "B⁻¹·major = {pre:?}, {e:?}");
|
||||
assert!(major.x.abs() > 1e-3 && major.y.abs() > 1e-3, "{e:?}");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn svg_tiny_sheared_circle_has_the_axes_of_its_image() {
|
||||
// Columns (1, 0.5)·1e-6 and (1, -0.5)·1e-6: far from orthogonal, though their dot product is tiny.
|
||||
let svg = format!("{SVG_PAGE}<circle r=\"1\" transform=\"matrix(1e-6 0.5e-6 1e-6 -0.5e-6 0 0)\"/></svg>");
|
||||
let d = read(svg.as_bytes(), "tiny.svg").unwrap();
|
||||
assert_eq!(kinds(&d), ["Ellipse"]);
|
||||
let e = first(&d, |k| if let EntityKind::Ellipse(e) = k { Some(e.clone()) } else { None });
|
||||
let major = Vec2::new(e.major.x, e.major.y);
|
||||
assert!(major.y.abs() <= 1e-9 * major.x.abs(), "{e:?}");
|
||||
let want = 2f64.sqrt() * 1e-6;
|
||||
assert!((major.len() - want).abs() < 1e-9 * want, "{e:?}");
|
||||
assert!((e.ratio - 0.5).abs() < 1e-9, "{e:?}");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn svg_path_lines_curves_and_arcs() {
|
||||
let svg = format!("{SVG_PAGE}<path d=\"M1 1 L5 1 C6 1 7 2 8 3\"/><path d=\"M0 0 A5 5 0 0 1 10 0 Z\"/></svg>");
|
||||
@@ -3200,59 +3137,6 @@ fn svg_hostile_input_errors_without_panicking() {
|
||||
assert!(deep.is_err(), "200 nested groups are refused, not walked");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn svg_coordinates_that_overflow_are_left_out() {
|
||||
// Every number is finite; relative steps and transforms overflow them to infinity or NaN.
|
||||
let svg = format!(
|
||||
"{SVG_PAGE}<path d=\"M1e308 0 l1e308 0\"/><rect x=\"1e308\" width=\"1e308\" height=\"1\"/>\
|
||||
<g transform=\"scale(1e308)\"><line x1=\"1e308\" y1=\"0\" x2=\"1\" y2=\"1\"/><circle r=\"1e308\"/></g>\
|
||||
<g transform=\"scale(1e308,1)\"><ellipse rx=\"1e308\" ry=\"1\"/><path d=\"M0 0 C1e308 0 1 1 2 2\"/></g>\
|
||||
<line x1=\"0\" y1=\"0\" x2=\"1\" y2=\"1\"/></svg>"
|
||||
);
|
||||
let d = read(svg.as_bytes(), "huge.svg").unwrap();
|
||||
assert_eq!(kinds(&d), ["Line"]);
|
||||
assert_eq!(d.read_notes, ["SVG: 6 shapes were left out as invalid: their coordinates or size are too large to represent"]);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn svg_shapes_whose_extents_overflow_are_left_out() {
|
||||
// A finite centre and radius whose sum overflows; the same scale on smaller values stays
|
||||
// representable.
|
||||
let svg = format!("{SVG_PAGE}<g transform=\"scale(1e308)\"><circle cx=\"1\" cy=\"0\" r=\"1\"/><circle cx=\"0.5\" cy=\"0\" r=\"0.5\"/></g></svg>");
|
||||
let d = read(svg.as_bytes(), "huge.svg").unwrap();
|
||||
assert_eq!(kinds(&d), ["Circle"]);
|
||||
let c = first(&d, |k| if let EntityKind::Circle(c) = k { Some(c.clone()) } else { None });
|
||||
assert!((c.radius - 5e307).abs() < 1e293, "{}", c.radius);
|
||||
assert_eq!(d.read_notes, ["SVG: 1 shape was left out as invalid: its coordinates or size are too large to represent"]);
|
||||
}
|
||||
|
||||
/// A shape too large to represent is invalid, not something CADCraft doesn't read yet: it gets a
|
||||
/// note of its own.
|
||||
#[test]
|
||||
fn svg_too_large_shapes_are_noted_apart_from_unread_content() {
|
||||
let svg = format!("{SVG_PAGE}<text x=\"0\" y=\"5\">one</text><path d=\"M1e308 0 l1e308 0\"/><line x1=\"0\" y1=\"0\" x2=\"1\" y2=\"1\"/></svg>");
|
||||
let d = read(svg.as_bytes(), "huge.svg").unwrap();
|
||||
assert_eq!(kinds(&d), ["Line"]);
|
||||
assert_eq!(
|
||||
d.read_notes,
|
||||
[
|
||||
"SVG: CADCraft doesn't read these yet, so they were left out: 1 text",
|
||||
"SVG: 1 shape was left out as invalid: its coordinates or size are too large to represent"
|
||||
]
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn svg_shapes_left_out_still_count_against_the_vertex_budget() {
|
||||
// Each arc flattens to 10,000 chords under the non-uniform scale, and the doubled translation
|
||||
// overflows to infinity, so each is left out; 820 of them make more than the 8,000,000 vertices
|
||||
// a file may generate.
|
||||
let arcs = "A1e9 1e9 0 0 1 2e9 0 A1e9 1e9 0 0 1 0 0 ".repeat(410);
|
||||
let svg = format!("{SVG_PAGE}<g transform=\"translate(1e308 0) translate(1e308 0) scale(2 1)\"><path d=\"M0 0 {arcs}\"/></g></svg>");
|
||||
let err = read(svg.as_bytes(), "huge.svg").err().map(|e| e.to_string()).unwrap_or_default();
|
||||
assert!(err.contains("SVG: too much generated geometry"), "{err}");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn svg_no_geometry_yields_an_empty_drawing() {
|
||||
let svg = format!("{SVG_PAGE}</svg>");
|
||||
|
||||
@@ -1,360 +0,0 @@
|
||||
//! A hostile or damaged file can name a handle at the top of the range: an object's own handle,
|
||||
//! or its `$HANDSEED`. A file's handles keep their identity, so a new object must take a free
|
||||
//! handle instead of replacing the file's own object (#913).
|
||||
#![cfg(not(target_arch = "wasm32"))]
|
||||
|
||||
use cadcraft_doc::{Common, DimKind, Dimension, Drawing, Entity, EntityKind, Handle, Line, Space};
|
||||
use cadcraft_geom::Vec3;
|
||||
|
||||
const TOP: &str = "FFFFFFFFFFFFFFFF";
|
||||
const NEAR_TOP: &str = "FFFFFFFFFFFEFFFF";
|
||||
|
||||
fn read(text: &str) -> Drawing {
|
||||
cadcraft_io::read_dxf(text.as_bytes()).unwrap()
|
||||
}
|
||||
|
||||
fn line(x: f64, y: f64) -> EntityKind {
|
||||
EntityKind::Line(Line { a: Vec3::new(x, y, 0.0), b: Vec3::new(x + 1.0, y, 0.0) })
|
||||
}
|
||||
|
||||
/// One line, with `entity_handle` when given, under a `$HANDSEED` of `seed`.
|
||||
fn dxf(entity_handle: Option<&str>, seed: &str) -> String {
|
||||
let handle = entity_handle.map(|h| format!("5\n{h}\n")).unwrap_or_default();
|
||||
format!(
|
||||
"0\nSECTION\n2\nHEADER\n9\n$ACADVER\n1\nAC1032\n9\n$HANDSEED\n5\n{seed}\n0\nENDSEC\n\
|
||||
0\nSECTION\n2\nENTITIES\n0\nLINE\n{handle}8\n0\n10\n0.0\n20\n0.0\n30\n0.0\n11\n1.0\n21\n0.0\n31\n0.0\n0\nENDSEC\n0\nEOF\n"
|
||||
)
|
||||
}
|
||||
|
||||
fn distinct(d: &Drawing) -> Vec<Handle> {
|
||||
d.model.iter().map(|e| e.handle).collect()
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn an_object_at_the_top_of_the_handle_range_is_not_replaced_by_a_new_one() {
|
||||
let mut d = read(&dxf(Some(TOP), TOP));
|
||||
assert_eq!(d.model.len(), 1);
|
||||
// The file's handle is its own; the new object takes a free handle below it.
|
||||
assert!(d.entity(Handle::parse_hex(TOP).unwrap()).is_some(), "the file's handle was renumbered");
|
||||
d.add(&Space::Model, Common::default(), line(10.0, 10.0)).unwrap();
|
||||
assert_eq!(d.model.len(), 2, "the file's line was replaced by the new one");
|
||||
let handles = distinct(&d);
|
||||
let unique: std::collections::HashSet<Handle> = handles.iter().copied().collect();
|
||||
assert_eq!(unique.len(), handles.len(), "duplicate handles: {handles:?}");
|
||||
assert!(d.model.iter().any(|e| matches!(e.kind, EntityKind::Line(ref l) if l.a.x == 0.0)), "the file's line is gone");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_seed_at_the_top_of_the_handle_range_cannot_be_followed_twice() {
|
||||
let mut d = read(&dxf(None, TOP));
|
||||
let a = d.add(&Space::Model, Common::default(), line(0.0, 10.0)).unwrap();
|
||||
let b = d.add(&Space::Model, Common::default(), line(0.0, 20.0)).unwrap();
|
||||
assert_ne!(a, b, "two objects were given the same handle");
|
||||
assert_eq!(d.model.len(), 3, "the second line replaced the first");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn an_ordinary_high_handle_keeps_its_identity() {
|
||||
// Far below the top of the range a file's handles are its own: they stay as they are.
|
||||
let h = "FFFFFFFF";
|
||||
let mut d = read(&dxf(Some(h), h));
|
||||
assert!(d.entity(Handle::parse_hex(h).unwrap()).is_some(), "the file's handle was renumbered");
|
||||
let n = d.add(&Space::Model, Common::default(), line(0.0, 5.0)).unwrap();
|
||||
assert!(n.0 > Handle::parse_hex(h).unwrap().0, "a new handle below the file's own");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_handle_just_below_the_top_survives_a_save() {
|
||||
// Main keeps a file's handles exactly as written, even near the top of the range: handles
|
||||
// are how other objects and other programs refer to an entity (#939's round-trip tests).
|
||||
let mut d = read(&dxf(Some(NEAR_TOP), NEAR_TOP));
|
||||
let n = d.add(&Space::Model, Common::default(), line(0.0, 5.0)).unwrap();
|
||||
let bytes = cadcraft_io::write(&d, "near-top.dxf").unwrap();
|
||||
let r = cadcraft_io::read_dxf(&bytes).unwrap();
|
||||
assert!(r.entity(Handle::parse_hex(NEAR_TOP).unwrap()).is_some(), "the file's handle did not survive the save");
|
||||
assert!(r.entity(n).is_some(), "the new handle did not survive the save");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn nine_objects_drawn_after_a_saturated_seed_save_and_reopen_distinct() {
|
||||
// The nine-entity case from #2237: a saturated $HANDSEED, ordinary entity handles. Drawing
|
||||
// after the load gives every object its own handle, and a save/reopen keeps them apart.
|
||||
let mut d = read(&dxf(None, TOP));
|
||||
for i in 0..9 {
|
||||
d.add(&Space::Model, Common::default(), line(f64::from(i), 40.0)).unwrap();
|
||||
}
|
||||
let bytes = cadcraft_io::write(&d, "nine.dxf").unwrap();
|
||||
let r = cadcraft_io::read_dxf(&bytes).unwrap();
|
||||
assert_eq!(r.model.len(), 10, "the file's line and the nine drawn ones");
|
||||
let handles = distinct(&r);
|
||||
let unique: std::collections::HashSet<Handle> = handles.iter().copied().collect();
|
||||
assert_eq!(unique.len(), handles.len(), "repeated handles on reopen: {handles:?}");
|
||||
}
|
||||
|
||||
/// The first handle in the reserved band above [`HANDLE_LIMIT`].
|
||||
const BAND: &str = "FFFFFFFF00000000";
|
||||
|
||||
#[test]
|
||||
fn a_seed_in_the_reserved_band_does_not_hand_out_the_files_handle() {
|
||||
// #913's remaining case: a file says its next handle is FFFFFFFF00000000 and an object holds
|
||||
// that handle. Following the seed once would hand the object's handle to the new object, and
|
||||
// `EntityStore` would replace the file's line.
|
||||
let mut d = read(&dxf(Some(BAND), BAND));
|
||||
assert_eq!(d.model.len(), 1);
|
||||
let n = d.add(&Space::Model, Common::default(), line(10.0, 10.0)).unwrap();
|
||||
assert_ne!(n, Handle::parse_hex(BAND).unwrap(), "the new object took the file object's handle");
|
||||
assert_eq!(d.model.len(), 2, "the file's line was replaced");
|
||||
assert!(d.model.iter().any(|e| matches!(e.kind, EntityKind::Line(ref l) if l.a.x == 0.0)), "the file's line is gone");
|
||||
|
||||
let bytes = cadcraft_io::write(&d, "band-seed.dxf").unwrap();
|
||||
let r = cadcraft_io::read_dxf(&bytes).unwrap();
|
||||
let handles = distinct(&r);
|
||||
let unique: std::collections::HashSet<Handle> = handles.iter().copied().collect();
|
||||
assert_eq!(unique.len(), handles.len(), "repeated handles on reopen: {handles:?}");
|
||||
assert_eq!(r.model.len(), 2, "a line did not survive the save");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_save_does_not_give_a_structural_record_an_objects_handle() {
|
||||
// The writer numbers its own records from `seed + 0x1000`; with the seed at the bottom of the
|
||||
// reserved band that lands on the file's own handle. The file must keep one record per handle.
|
||||
let object = "FFFFFFFF00001000";
|
||||
let d = read(&dxf(Some(object), "FFFFFFFEFFFFFFFF"));
|
||||
let bytes = cadcraft_io::write(&d, "band-structural.dxf").unwrap();
|
||||
let tags = craft_dxf::parse(&bytes).unwrap();
|
||||
// Record handles start with the TABLES section; before it the HEADER's `$HANDSEED` is the
|
||||
// next free handle, not a record's.
|
||||
let after_header = tags.iter().position(|t| t.code == 2 && t.str() == "TABLES").unwrap();
|
||||
let written: Vec<String> = tags[after_header..].iter().filter(|t| t.code == 5 || t.code == 105).map(|t| t.str().to_string()).collect();
|
||||
let unique: std::collections::HashSet<&String> = written.iter().collect();
|
||||
assert_eq!(unique.len(), written.len(), "the save repeats a handle: {written:?}");
|
||||
assert_eq!(written.iter().filter(|h| h.as_str() == object).count(), 1, "the object's handle was not written exactly once");
|
||||
|
||||
let r = cadcraft_io::read_dxf(&bytes).unwrap();
|
||||
assert!(r.entity(Handle::parse_hex(object).unwrap()).is_some(), "the file's object is gone");
|
||||
}
|
||||
|
||||
/// A CADCraft-marked file with a handle-less block entity and an `ENTITIES` record that names
|
||||
/// the handle the reader would give it. The marker means the reader skips the handle pre-scan,
|
||||
/// so the two sections must still reserve against each other.
|
||||
fn marked_file_with_handle_less_block_entity() -> String {
|
||||
"0\nSECTION\n2\nHEADER\n9\n$ACADVER\n1\nAC1032\n9\n$HANDSEED\n5\n1000\n0\nENDSEC\n\
|
||||
0\nSECTION\n2\nBLOCKS\n\
|
||||
0\nBLOCK\n8\n0\n2\n*MODEL_SPACE\n70\n0\n10\n0.0\n20\n0.0\n30\n0.0\n3\n*MODEL_SPACE\n1\n\n\
|
||||
0\nLINE\n8\n0\n10\n0.0\n20\n0.0\n30\n0.0\n11\n1.0\n21\n0.0\n31\n0.0\n\
|
||||
0\nENDBLK\n8\n0\n\
|
||||
0\nENDSEC\n\
|
||||
0\nSECTION\n2\nENTITIES\n\
|
||||
0\nLINE\n5\n100\n8\n0\n10\n10.0\n20\n0.0\n30\n0.0\n11\n11.0\n21\n0.0\n31\n0.0\n\
|
||||
0\nENDSEC\n\
|
||||
0\nSECTION\n2\nOBJECTS\n\
|
||||
0\nXRECORD\n5\n300\n100\nAcDbXrecord\n3\nCADCRAFT_HANDSEED\n1\n1000\n\
|
||||
0\nENDSEC\n0\nEOF\n"
|
||||
.to_string()
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_marked_files_sections_reserve_handles_against_each_other() {
|
||||
// The block entity has no handle of its own, so the reader gives it one; a later ENTITIES
|
||||
// record must not be given the same handle, or one entity silently replaces the other.
|
||||
let d = read(&marked_file_with_handle_less_block_entity());
|
||||
assert_eq!(d.model.len(), 2, "one entity replaced the other");
|
||||
let handles = distinct(&d);
|
||||
let unique: std::collections::HashSet<Handle> = handles.iter().copied().collect();
|
||||
assert_eq!(unique.len(), handles.len(), "duplicate handles: {handles:?}");
|
||||
assert!(d.model.iter().any(|e| matches!(e.kind, EntityKind::Line(ref l) if l.a.x == 0.0)), "the block entity is gone");
|
||||
assert!(d.model.iter().any(|e| matches!(e.kind, EntityKind::Line(ref l) if l.a.x == 10.0)), "the ENTITIES line is gone");
|
||||
}
|
||||
|
||||
/// A file whose BLOCKS holds a handle-less model-space entity and whose ENTITIES names the
|
||||
/// last handle below the reserved band and the first handle in it. With `marked` the file names
|
||||
/// CADCraft's own seed record, which narrows the reader's handle pre-scan to the entity sections.
|
||||
fn file_with_reserved_band_entities(marked: bool) -> String {
|
||||
let below = format!("{:X}", cadcraft_doc::HANDLE_LIMIT - 1);
|
||||
let band = format!("{:X}", cadcraft_doc::HANDLE_LIMIT);
|
||||
let objects = if marked {
|
||||
"0\nSECTION\n2\nOBJECTS\n\
|
||||
0\nXRECORD\n5\n300\n100\nAcDbXrecord\n3\nCADCRAFT_HANDSEED\n1\n1000\n\
|
||||
0\nENDSEC\n"
|
||||
} else {
|
||||
""
|
||||
};
|
||||
format!(
|
||||
"0\nSECTION\n2\nHEADER\n9\n$ACADVER\n1\nAC1032\n9\n$HANDSEED\n5\n1000\n0\nENDSEC\n\
|
||||
0\nSECTION\n2\nBLOCKS\n\
|
||||
0\nBLOCK\n8\n0\n2\n*MODEL_SPACE\n70\n0\n10\n0.0\n20\n0.0\n30\n0.0\n3\n*MODEL_SPACE\n1\n\n\
|
||||
0\nLINE\n8\n0\n10\n0.0\n20\n0.0\n30\n0.0\n11\n1.0\n21\n0.0\n31\n0.0\n\
|
||||
0\nENDBLK\n8\n0\n\
|
||||
0\nENDSEC\n\
|
||||
0\nSECTION\n2\nENTITIES\n\
|
||||
0\nLINE\n5\n{below}\n8\n0\n10\n10.0\n20\n0.0\n30\n0.0\n11\n11.0\n21\n0.0\n31\n0.0\n\
|
||||
0\nLINE\n5\n{band}\n8\n0\n10\n20.0\n20\n0.0\n30\n0.0\n11\n21.0\n21\n0.0\n31\n0.0\n\
|
||||
0\nENDSEC\n{objects}0\nEOF\n"
|
||||
)
|
||||
}
|
||||
|
||||
/// All three lines survive with their own handles: the handle-less block entity could not take
|
||||
/// the reserved-band handle of the file's own ENTITIES record.
|
||||
fn assert_three_lines_survive(d: &Drawing) {
|
||||
assert_eq!(d.model.len(), 3, "one entity replaced another");
|
||||
let handles = distinct(d);
|
||||
let unique: std::collections::HashSet<Handle> = handles.iter().copied().collect();
|
||||
assert_eq!(unique.len(), handles.len(), "duplicate handles: {handles:?}");
|
||||
assert!(d.model.iter().any(|e| matches!(e.kind, EntityKind::Line(ref l) if l.a.x == 0.0)), "the block entity is gone");
|
||||
assert!(d.model.iter().any(|e| matches!(e.kind, EntityKind::Line(ref l) if l.a.x == 10.0)), "the line below the band is gone");
|
||||
assert!(d.model.iter().any(|e| matches!(e.kind, EntityKind::Line(ref l) if l.a.x == 20.0)), "the line in the band is gone");
|
||||
// The band's explicit handle stays with the record that names it.
|
||||
let band = Handle(cadcraft_doc::HANDLE_LIMIT);
|
||||
let owner = d.model.iter().find(|e| e.handle == band).expect("the band handle was renumbered");
|
||||
assert!(matches!(&owner.kind, EntityKind::Line(l) if l.a.x == 20.0), "the band handle moved to another line");
|
||||
// The handle just below the band is the file's too, and it stays with its own record.
|
||||
let below = Handle(cadcraft_doc::HANDLE_LIMIT - 1);
|
||||
let owner = d.model.iter().find(|e| e.handle == below).expect("the below-band handle was renumbered");
|
||||
assert!(matches!(&owner.kind, EntityKind::Line(l) if l.a.x == 10.0), "the below-band handle moved to another line");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn reserved_band_handles_in_entities_are_not_handed_to_a_handle_less_block_entity() {
|
||||
// The handle below the reserved band is the file's, so the reader's next handle is the first
|
||||
// handle in the band, which an ENTITIES record already owns. The seed cannot follow it
|
||||
// (#913), so the handle is reserved for allocation instead: the handle-less model-space
|
||||
// block entity must not take it and replace the file's line.
|
||||
assert_three_lines_survive(&read(&file_with_reserved_band_entities(true)));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn reserved_band_handles_are_reserved_without_the_cadcraft_seed_record() {
|
||||
// The same reservation holds when the pre-scan reads every section's handles: a handle in
|
||||
// the band is the file's own there too, and still must not be given away.
|
||||
assert_three_lines_survive(&read(&file_with_reserved_band_entities(false)));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn reservations_end_with_the_read_and_placed_objects_still_keep_their_handles() {
|
||||
// The reservations only bridge the gap until a record is placed; a drawing does not carry
|
||||
// them on (every undo step copies the drawing). The placed objects keep new ones off.
|
||||
let mut d = read(&file_with_reserved_band_entities(true));
|
||||
assert!(d.reserved_handles.is_empty(), "the reader's reservations outlived the read");
|
||||
for i in 0..3 {
|
||||
d.add(&Space::Model, Common::default(), line(f64::from(i), 50.0)).unwrap();
|
||||
}
|
||||
assert_eq!(d.model.len(), 6, "a new object replaced one of the file's");
|
||||
assert_three_lines_survive_among(&d);
|
||||
}
|
||||
|
||||
fn assert_three_lines_survive_among(d: &Drawing) {
|
||||
let band = Handle(cadcraft_doc::HANDLE_LIMIT);
|
||||
assert!(d.model.iter().any(|e| e.handle == band && matches!(&e.kind, EntityKind::Line(l) if l.a.x == 20.0)), "the band line lost its handle");
|
||||
let handles = distinct(d);
|
||||
let unique: std::collections::HashSet<Handle> = handles.iter().copied().collect();
|
||||
assert_eq!(unique.len(), handles.len(), "duplicate handles: {handles:?}");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn generated_geometry_never_takes_a_handle_an_object_holds() {
|
||||
// The drawing's own handles sit in the reserved band and the seed is at the top of the
|
||||
// range, so the writer's structural numbering wraps into the band. Every other band handle
|
||||
// is taken, so without a check the generated dimension block's entities land on an occupied
|
||||
// one: the saved file would repeat a handle.
|
||||
let mut d = Drawing::new_imperial();
|
||||
d.handseed = u64::MAX - 1;
|
||||
{
|
||||
let model = d.space_mut(&Space::Model).unwrap();
|
||||
for i in 0..200u64 {
|
||||
let handle = Handle(cadcraft_doc::HANDLE_LIMIT + 1 + 2 * i);
|
||||
model.push(Entity { handle, common: Common::default(), kind: line(i as f64, 0.0) });
|
||||
}
|
||||
model.push(Entity {
|
||||
handle: Handle(0x200),
|
||||
common: Common::default(),
|
||||
kind: EntityKind::Dimension(Dimension {
|
||||
kind: DimKind::Linear { rotation: 0.0 },
|
||||
defpt: Vec3::new(0.0, 1.0, 0.0),
|
||||
text_mid: Vec3::new(1.0, 1.0, 0.0),
|
||||
p13: Vec3::ZERO,
|
||||
p14: Vec3::new(2.0, 0.0, 0.0),
|
||||
p15: Vec3::ZERO,
|
||||
p16: Vec3::ZERO,
|
||||
text: String::new(),
|
||||
style: "Standard".into(),
|
||||
measurement: 2.0,
|
||||
text_rotation: 0.0,
|
||||
user_text_pos: false,
|
||||
block: None,
|
||||
insertion_point: Vec3::ZERO,
|
||||
overrides: serde_json::Map::new(),
|
||||
assoc: Vec::new(),
|
||||
marks: Default::default(),
|
||||
}),
|
||||
});
|
||||
}
|
||||
let bytes = cadcraft_io::write(&d, "generated.dxf").unwrap();
|
||||
let tags = craft_dxf::parse(&bytes).unwrap();
|
||||
let after_header = tags.iter().position(|t| t.code == 2 && t.str() == "TABLES").unwrap();
|
||||
let written: Vec<String> = tags[after_header..].iter().filter(|t| t.code == 5 || t.code == 105).map(|t| t.str().to_string()).collect();
|
||||
let unique: std::collections::HashSet<&String> = written.iter().collect();
|
||||
assert_eq!(unique.len(), written.len(), "the save repeats a handle");
|
||||
}
|
||||
|
||||
/// A line at the top handle with another application's xdata, and that application's object kept
|
||||
/// from the file: a dictionary in the named object dictionary holding an XRECORD.
|
||||
fn top_line_with_kept_objects() -> String {
|
||||
let groups: &[(i32, &str)] = &[
|
||||
(0, "SECTION"),
|
||||
(2, "ENTITIES"),
|
||||
(0, "LINE"),
|
||||
(5, TOP),
|
||||
(8, "0"),
|
||||
(10, "0"),
|
||||
(20, "0"),
|
||||
(11, "10"),
|
||||
(21, "0"),
|
||||
(1001, "OTHER_APP"),
|
||||
(1000, "tagged"),
|
||||
(0, "ENDSEC"),
|
||||
(0, "SECTION"),
|
||||
(2, "OBJECTS"),
|
||||
(0, "DICTIONARY"),
|
||||
(5, "C"),
|
||||
(330, "0"),
|
||||
(100, "AcDbDictionary"),
|
||||
(3, "OTHER_APP"),
|
||||
(350, "50"),
|
||||
(0, "DICTIONARY"),
|
||||
(5, "50"),
|
||||
(330, "C"),
|
||||
(100, "AcDbDictionary"),
|
||||
(281, "1"),
|
||||
(3, "DATA"),
|
||||
(360, "51"),
|
||||
(0, "XRECORD"),
|
||||
(5, "51"),
|
||||
(330, "50"),
|
||||
(100, "AcDbXrecord"),
|
||||
(280, "1"),
|
||||
(1, "kept"),
|
||||
(0, "ENDSEC"),
|
||||
(0, "EOF"),
|
||||
];
|
||||
groups.iter().map(|(c, v)| format!("{c}\n{v}\n")).collect()
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn records_added_on_save_after_the_top_handle_take_free_handles() {
|
||||
// The writer adds the kept objects (and any application id the xdata needs) after its own
|
||||
// records, numbered above the largest handle written. That is the file's line at the top of
|
||||
// the range: counting on from it would give every added record the line's handle.
|
||||
let d = read(&top_line_with_kept_objects());
|
||||
let bytes = cadcraft_io::write(&d, "kept-top.dxf").unwrap();
|
||||
let text = String::from_utf8_lossy(&bytes);
|
||||
assert!(text.contains("\nkept"), "the kept XRECORD was not written");
|
||||
let tags = craft_dxf::parse(&bytes).unwrap();
|
||||
let after_header = tags.iter().position(|t| t.code == 2 && t.str() == "TABLES").unwrap();
|
||||
let written: Vec<String> = tags[after_header..].iter().filter(|t| t.code == 5 || t.code == 105).map(|t| t.str().to_string()).collect();
|
||||
let unique: std::collections::HashSet<&String> = written.iter().collect();
|
||||
assert_eq!(unique.len(), written.len(), "the save repeats a handle: {written:?}");
|
||||
assert_eq!(written.iter().filter(|h| h.as_str() == TOP).count(), 1, "the line's handle was not written exactly once");
|
||||
|
||||
let r = read(&String::from_utf8_lossy(&bytes));
|
||||
assert!(r.entity(Handle::parse_hex(TOP).unwrap()).is_some(), "the file's line is gone");
|
||||
}
|
||||
@@ -26,6 +26,7 @@ fn preserves_or_refuses(path: &str, binary: bool) {
|
||||
}
|
||||
|
||||
#[test]
|
||||
#[ignore = "Confirmed DXF data loss: exhausted generated handles produce a successful save that reopens with no model entities"]
|
||||
fn dxf_exhausted_handles_are_preserved_or_refused() {
|
||||
for binary in [false, true] {
|
||||
preserves_or_refuses("memory.dxf", binary);
|
||||
|
||||
@@ -16,8 +16,8 @@ fn import(transform: &str) -> (f64, f64) {
|
||||
_ => None,
|
||||
})
|
||||
.unwrap();
|
||||
// `major` is the axis from the centre (#2821).
|
||||
(e.major.y.atan2(e.major.x), e.ratio)
|
||||
let (dx, dy) = (e.major.x - e.center.x, e.major.y - e.center.y);
|
||||
(dy.atan2(dx), e.ratio)
|
||||
}
|
||||
|
||||
/// Major-axis angle and ratio of the image of the ellipse under the 2x2 map `[a c; b d]`, with
|
||||
|
||||
@@ -308,6 +308,14 @@ fn key_from(name: &str) -> Option<egui::Key> {
|
||||
}
|
||||
|
||||
pub fn handle(app: &mut CadApp, ctx: &egui::Context, req: &ControlRequest) -> Outcome {
|
||||
let out = handle_request(app, ctx, req);
|
||||
// A command the request ran may have asked for a bar (MENUBAR, TOOLBAR): apply it before
|
||||
// the next request, so a later query or `ui.set` sees the bars as they are now.
|
||||
app.sync_bars();
|
||||
out
|
||||
}
|
||||
|
||||
fn handle_request(app: &mut CadApp, ctx: &egui::Context, req: &ControlRequest) -> Outcome {
|
||||
let p = &req.params;
|
||||
let s = |k: &str| p.get(k).and_then(Value::as_str);
|
||||
let f = |k: &str| p.get(k).and_then(Value::as_f64);
|
||||
|
||||
@@ -316,6 +316,10 @@ pub fn command(app: &mut crate::CadApp, reset: bool, params: &Value) -> Result<V
|
||||
}
|
||||
|
||||
/// Validate and repair the stored workspace, sync it with the app, and render the dock panels; a failed restore falls back to the default layout with a status message.
|
||||
/// Draw the docked workspace: restore or fall back from the persisted layout, render every
|
||||
/// panel body plus the header close buttons, and apply the resulting actions through
|
||||
/// [`command`]. Bodies may dispatch commands, so the canonical workspace is published before
|
||||
/// rendering while the layout snapshot stays immutable.
|
||||
pub fn show(app: &mut crate::CadApp, ui: &mut egui::Ui) {
|
||||
let t = crate::theme::Tokens::get();
|
||||
let mut workspace = app.ui.docking.clone();
|
||||
@@ -348,7 +352,33 @@ pub fn show(app: &mut crate::CadApp, ui: &mut egui::Ui) {
|
||||
if let Some(panel) = app.raise_panel.take() {
|
||||
area = area.raise_panel(panel);
|
||||
}
|
||||
let mut output = area.show_content(ui, &workspace.layout, &style, &mut Panels { app });
|
||||
let (mut output, header_close) = {
|
||||
let mut panels = Panels { app, close: None };
|
||||
let output = area.show_content(ui, &workspace.layout, &style, &mut panels);
|
||||
(output, panels.close)
|
||||
};
|
||||
// Accordion title bars are rendered by the shared surface without a header callback, so
|
||||
// place the same close button over their title bar, left of the stock collapse control.
|
||||
let mut close = header_close;
|
||||
for panel in stack_panels(&workspace.layout) {
|
||||
if !permissions(&panel).closable {
|
||||
continue;
|
||||
}
|
||||
let Some(title) = ui.ctx().read_response(egui::Id::unique("cadcraft-docking").with(("tab", panel))) else { continue };
|
||||
if !title.rect.is_positive() {
|
||||
continue;
|
||||
}
|
||||
let rect = egui::Rect::from_center_size(
|
||||
egui::pos2(title.rect.right() - 18.0 - CLOSE_BUTTON * 0.5 - 4.0, title.rect.center().y),
|
||||
egui::vec2(CLOSE_BUTTON, CLOSE_BUTTON),
|
||||
);
|
||||
if close_button(ui, panel, rect) {
|
||||
close = Some(panel);
|
||||
}
|
||||
}
|
||||
if let Some(panel) = close {
|
||||
output.actions.push(Action::Close { panel });
|
||||
}
|
||||
// Keys typed in a floating panel's own OS window run the main window's shortcuts and
|
||||
// command line; files dropped on one open like files dropped on the main window.
|
||||
app.forward_native_input(ui.ctx(), std::mem::take(&mut output.forwarded_events), output.forwarded_modifiers);
|
||||
@@ -393,9 +423,55 @@ pub fn native_input_blocked(app: &crate::CadApp, ctx: &egui::Context) -> bool {
|
||||
/// The panels' contents, names, size limits and icons for the dock area.
|
||||
pub struct Panels<'a> {
|
||||
pub app: &'a mut crate::CadApp,
|
||||
/// The panel whose header close button was clicked this frame.
|
||||
pub close: Option<Panel>,
|
||||
}
|
||||
|
||||
/// Size of a panel header's close button, in points.
|
||||
const CLOSE_BUTTON: f32 = 16.0;
|
||||
|
||||
/// The accessible name of a header's close button. One translated template carries both the
|
||||
/// verb and the panel name, so a catalog translates the whole name instead of leaving an
|
||||
/// English verb in front of a translated panel label.
|
||||
fn close_label(panel: Panel) -> String {
|
||||
crate::tf!("Close {panel}", panel = crate::i18n::t(panel.label()))
|
||||
}
|
||||
|
||||
/// A visible close button for a panel header. It runs the same action as the tab context
|
||||
/// menu's "Close panel"; the accessible name includes the panel so the headers stay distinct.
|
||||
fn close_button(ui: &mut egui::Ui, panel: Panel, rect: egui::Rect) -> bool {
|
||||
let t = crate::theme::Tokens::get();
|
||||
let response = ui.interact(rect, egui::Id::unique("cadcraft-docking").with(("close", panel.id())), egui::Sense::click());
|
||||
let label = close_label(panel);
|
||||
crate::icons::describe_control(ui, &response, &label, None, false);
|
||||
if response.hovered() {
|
||||
ui.painter().rect_filled(rect.expand(2.0), 2.0, t.control_hover.gamma_multiply(0.6));
|
||||
}
|
||||
crate::icons::paint(ui.painter(), rect, crate::icons::Icon::Close, false);
|
||||
response.on_hover_text(crate::tl!("Close panel")).clicked()
|
||||
}
|
||||
|
||||
/// Panels whose title bar is an accordion entry rather than a tab group header.
|
||||
fn stack_panels(layout: &Layout<Panel>) -> Vec<Panel> {
|
||||
let mut panels = Vec::new();
|
||||
let mut nodes: Vec<&Node<Panel>> = layout.root.iter().collect();
|
||||
while let Some(node) = nodes.pop() {
|
||||
match node {
|
||||
Node::Split { first, second, .. } => {
|
||||
nodes.push(first);
|
||||
nodes.push(second);
|
||||
}
|
||||
Node::Stack { entries } => panels.extend(entries.iter().map(|entry| entry.panel)),
|
||||
// Tab groups draw their own header; nothing else stacks an accordion entry.
|
||||
_ => {}
|
||||
}
|
||||
}
|
||||
panels
|
||||
}
|
||||
|
||||
impl DockContent<Panel> for Panels<'_> {
|
||||
/// Render `panel`'s existing view; Layers, Properties and External References scroll
|
||||
/// independently, and the drawing canvas paints its own background before the view.
|
||||
fn body(&mut self, ui: &mut egui::Ui, panel: &Panel) {
|
||||
let app = &mut *self.app;
|
||||
match panel {
|
||||
@@ -445,6 +521,23 @@ impl DockContent<Panel> for Panels<'_> {
|
||||
crate::icons::paint(painter, rect, icon, false);
|
||||
true
|
||||
}
|
||||
/// Reserve header space for the close button only when `active` may be closed, so the
|
||||
/// drawing view's title gets no empty gap.
|
||||
fn group_header_width(&self, _panels: &[Panel], active: &Panel, _floating: bool, _strip_width: f32) -> f32 {
|
||||
if permissions(active).closable { CLOSE_BUTTON + 8.0 } else { 0.0 }
|
||||
}
|
||||
/// Draw the close button at the right edge of a tab-group header and remember the panel
|
||||
/// to close once the docking surface has returned, so layout changes stay outside rendering.
|
||||
fn group_header(&mut self, ui: &mut egui::Ui, _panels: &[Panel], active: &Panel, _floating: bool) {
|
||||
let header = ui.max_rect();
|
||||
let rect = egui::Rect::from_center_size(
|
||||
egui::pos2(header.right() - CLOSE_BUTTON * 0.5 - 4.0, header.center().y),
|
||||
egui::vec2(CLOSE_BUTTON, CLOSE_BUTTON),
|
||||
);
|
||||
if close_button(ui, *active, rect) {
|
||||
self.close = Some(*active);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
fn panel_limits(panel: &Panel) -> PanelLimits {
|
||||
|
||||
@@ -139,11 +139,13 @@
|
||||
Clip Viewport Delimitar ventana gráfica
|
||||
Clipboard Portapapeles
|
||||
Close Cerrar
|
||||
Close {panel} Cerrar {panel}
|
||||
Close All Cerrar todo
|
||||
Close All Other Drawings Cerrar todos los demás dibujos
|
||||
Close Array Editing Cerrar la edición de matriz
|
||||
Close Comparison Cerrar comparación
|
||||
Export Comparison Exportar comparación
|
||||
Close panel Cerrar panel
|
||||
Closed Cerrada
|
||||
Coincident Coincidente
|
||||
Collapse Palettes Contraer paletas
|
||||
@@ -542,6 +544,7 @@
|
||||
Measure Medir
|
||||
Measure Distance Medir distancia
|
||||
Measure Geometry Medir geometría
|
||||
Menu Bar Barra de menús
|
||||
Merge Cells Combinar celdas
|
||||
Merged PRs PR integradas
|
||||
Mid Between 2 Points Punto medio entre 2 puntos
|
||||
|
||||
|
@@ -146,6 +146,7 @@ fn missing_marked_ui_literals(language: &str) -> BTreeSet<String> {
|
||||
"chrome",
|
||||
"cmdline",
|
||||
"credits",
|
||||
"docking",
|
||||
"dialogs",
|
||||
"hatchdlg",
|
||||
"aliasdlg",
|
||||
|
||||
@@ -143,11 +143,13 @@
|
||||
Xref Clip Frame Рамка обрізки зовнішнього посилання
|
||||
Clipboard Буфер обміну
|
||||
Close Закрити
|
||||
Close {panel} Закрити {panel}
|
||||
Close All Закрити всі
|
||||
Close All Other Drawings Закрити всі інші креслення
|
||||
Closed Замкнений
|
||||
Close Comparison Закрити порівняння
|
||||
Export Comparison Експортувати порівняння
|
||||
Close panel Закрити панель
|
||||
Coincident Збіг
|
||||
Collapse Palettes Згорнути палітри
|
||||
Collapse Tool Sets Згорнути набори інструментів
|
||||
@@ -534,6 +536,7 @@
|
||||
Measure Розмітити
|
||||
Measure Distance Виміряти відстань
|
||||
Measure Geometry Виміряти геометрію
|
||||
Menu Bar Рядок меню
|
||||
Merge Cells Об'єднати комірки
|
||||
Merged PRs Об'єднані PR
|
||||
Mid Between 2 Points Середина між 2 точками
|
||||
|
||||
|
@@ -928,6 +928,7 @@
|
||||
Time 时间
|
||||
To get started, create or open a drawing. 若要开始,请创建或打开一个图形。
|
||||
Tool Bar 工具栏
|
||||
Menu Bar 菜单栏
|
||||
Tool Sets 工具集
|
||||
Tools 工具
|
||||
Torus 圆环体
|
||||
|
||||
|
@@ -283,6 +283,9 @@ pub struct CadApp {
|
||||
pub system_animations: Option<bool>,
|
||||
/// What `ui.system_cursor` goes back to when the interface is reset ([`Self::set_system_cursor_default`]).
|
||||
pub system_cursor_default: bool,
|
||||
/// Whether the host has a native menu bar: off where the menus stay in the window
|
||||
/// ([`Self::set_native_menus`]).
|
||||
pub native_menus: bool,
|
||||
pub session: Session,
|
||||
pub ui: UiState,
|
||||
/// The interface's own preferences from the Options dialog ([`options`]).
|
||||
@@ -381,6 +384,7 @@ impl CadApp {
|
||||
system_languages: Vec::new(),
|
||||
system_animations: None,
|
||||
system_cursor_default: false,
|
||||
native_menus: cfg!(target_os = "macos"),
|
||||
session,
|
||||
ui: UiState::default(),
|
||||
options: options::UiOptions::default(),
|
||||
@@ -588,7 +592,11 @@ impl CadApp {
|
||||
if let Some(r) = menus::run_ui_command(self, id, ¶ms) {
|
||||
return r;
|
||||
}
|
||||
// The bars as the interface shows them now (a `ui.set` may have just changed one), and any
|
||||
// MENUBAR or TOOLBAR request applied at once.
|
||||
self.sync_bars();
|
||||
let r = self.session.execute(id, ¶ms).map_err(|e| e.to_string());
|
||||
self.sync_bars();
|
||||
if let Ok(v) = &r
|
||||
&& let Some(m) = v.get("message").and_then(Value::as_str)
|
||||
{
|
||||
@@ -607,6 +615,7 @@ impl CadApp {
|
||||
if menus::run_ui_command(self, name, &Value::Null).is_some() {
|
||||
return;
|
||||
}
|
||||
self.sync_bars();
|
||||
if let Err(e) = self.session.start(name) {
|
||||
self.session.echo(e.to_string());
|
||||
}
|
||||
@@ -622,6 +631,7 @@ impl CadApp {
|
||||
/// command or system variable) runs `fallback` instead: Enter on a partly typed name accepts
|
||||
/// the highlighted AutoComplete suggestion.
|
||||
pub fn cmdline_or(&mut self, text: &str, fallback: Option<&str>) -> Option<String> {
|
||||
self.sync_bars();
|
||||
if !self.session.prompting() {
|
||||
let first = text.split_whitespace().next().unwrap_or("");
|
||||
// `cmd {json}` is a programmatic call: the engine runs it with those parameters.
|
||||
@@ -636,7 +646,9 @@ impl CadApp {
|
||||
return None;
|
||||
}
|
||||
}
|
||||
let e = match (self.session.cmdline(text), fallback) {
|
||||
let r = self.session.cmdline(text);
|
||||
self.sync_bars();
|
||||
let e = match (r, fallback) {
|
||||
(Ok(()), _) => return None,
|
||||
(Err(cadcraft_engine::EngineError::UnknownCommand(_)), Some(f)) => return self.cmdline(f),
|
||||
(Err(e), _) => e.to_string(),
|
||||
@@ -645,6 +657,18 @@ impl CadApp {
|
||||
Some(e)
|
||||
}
|
||||
|
||||
/// Apply a menu bar / tool bar change MENUBAR or TOOLBAR asked for, and report the bars shown.
|
||||
fn sync_bars(&mut self) {
|
||||
let b = std::mem::take(&mut self.session.bars_request);
|
||||
if let Some(on) = b.menubar {
|
||||
self.ui.in_window_menu = on;
|
||||
}
|
||||
if let Some(show) = b.toolbar {
|
||||
self.ui.show_toolbar = show;
|
||||
}
|
||||
self.session.bars_shown = cadcraft_engine::cmd::interface::InterfaceBars { menubar: self.ui.in_window_menu, toolbar: self.ui.show_toolbar };
|
||||
}
|
||||
|
||||
/// The theme the interface shows now (the choice resolved against the OS appearance).
|
||||
pub fn shown_theme(&self) -> egui::Theme {
|
||||
self.shown_theme.unwrap_or_else(|| self.ui.theme.resolve(None))
|
||||
@@ -731,6 +755,15 @@ impl CadApp {
|
||||
}
|
||||
}
|
||||
|
||||
/// Tell the interface whether the host has a native menu bar. Where it has none, the
|
||||
/// in-window menu is the only menu, so it is shown and a reset keeps it.
|
||||
pub fn set_native_menus(&mut self, on: bool) {
|
||||
self.native_menus = on;
|
||||
if !on {
|
||||
self.ui.in_window_menu = true;
|
||||
}
|
||||
}
|
||||
|
||||
pub fn set_status(&mut self, s: impl Into<String>) {
|
||||
self.status = Some((s.into(), now_ms()));
|
||||
}
|
||||
@@ -1087,6 +1120,7 @@ impl CadApp {
|
||||
/// Draw one UI pass: title/toolbar, optional menu/status bar/file tabs, the standalone tool-set strip when a drawing is shown but Tool Sets is not docked, docking or the start page, and the floating overlays; record `frame_ms`. Runs on every pass, including one egui later discards.
|
||||
fn draw(&mut self, ui: &mut egui::Ui) {
|
||||
let t0 = now_ms();
|
||||
self.sync_bars();
|
||||
control::begin_frame(ui.ctx());
|
||||
let t = theme::Tokens::get();
|
||||
chrome::title_and_toolbar(self, ui);
|
||||
@@ -1408,4 +1442,54 @@ mod tests {
|
||||
let ui: UiState = serde_json::from_value(json!({ "saveFormat": "dwg" })).unwrap_or_default();
|
||||
assert_eq!(ui.save_format, SaveFormat::Dwg);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn options_reset_brings_the_interface_back() {
|
||||
// Hiding the interface (View/Window toggles) can leave no way back — on Windows the
|
||||
// in-window menu bar is the only menu there is. Options > Reset must restore it (#1240).
|
||||
let mut a = app();
|
||||
a.run("ui.toggle.toolbar", json!({ "on": false })).unwrap();
|
||||
a.run("ui.toggle.menubar", json!({ "on": cfg!(target_os = "macos") })).unwrap();
|
||||
a.start("ui.hidepalettes");
|
||||
assert!(!a.ui.show_toolbar && !a.ui.show_palettes && !a.ui.show_toolsets);
|
||||
assert_eq!(a.ui.in_window_menu, cfg!(target_os = "macos"), "the test did not hide the menu bar");
|
||||
a.run("options", json!({ "reset": true })).unwrap();
|
||||
assert!(a.ui.show_toolbar, "the tool bar is still hidden");
|
||||
assert!(a.ui.show_palettes, "the palettes are still hidden");
|
||||
assert!(a.ui.show_toolsets);
|
||||
assert_eq!(a.ui.in_window_menu, !cfg!(target_os = "macos"), "the menu bar did not come back");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn options_reset_keeps_the_menu_where_the_host_has_no_native_one() {
|
||||
// With CADCRAFT_NO_NATIVE_MENU=1 the menus stay in the window: the host reports no native
|
||||
// menu bar, so the in-window one is the only menu and the reset must leave it (#1240).
|
||||
let mut a = app();
|
||||
a.set_native_menus(false);
|
||||
assert!(a.ui.in_window_menu, "the host's setting did not show the in-window menu");
|
||||
a.run("ui.toggle.menubar", json!({ "on": false })).unwrap();
|
||||
a.run("options", json!({ "reset": true })).unwrap();
|
||||
assert!(a.ui.in_window_menu, "the only menu bar did not come back");
|
||||
// Beside a native menu bar, the reset returns to the platform default.
|
||||
a.set_native_menus(true);
|
||||
a.run("ui.toggle.menubar", json!({ "on": true })).unwrap();
|
||||
a.run("options", json!({ "reset": true })).unwrap();
|
||||
assert!(!a.ui.in_window_menu, "the in-window menu is not the default beside a native one");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn options_reset_keeps_the_users_shortcuts_and_folders() {
|
||||
// The reset brings hidden bars back (#1240); it must not also lose the user's own
|
||||
// keyboard shortcuts or the folders the file pickers remember.
|
||||
let mut a = app();
|
||||
a.ui.shortcuts.insert("line".into(), "Ctrl+Shift+L".into());
|
||||
a.ui.last_lisp_dir = Some("lisp-folder".into());
|
||||
a.ui.last_pgp_dir = Some("pgp-folder".into());
|
||||
a.run("ui.toggle.toolbar", json!({ "on": false })).unwrap();
|
||||
a.run("options", json!({ "reset": true })).unwrap();
|
||||
assert!(a.ui.show_toolbar, "the tool bar is still hidden");
|
||||
assert_eq!(a.ui.shortcuts.get("line").map(String::as_str), Some("Ctrl+Shift+L"), "the reset lost a user shortcut");
|
||||
assert_eq!(a.ui.last_lisp_dir.as_deref(), Some("lisp-folder"));
|
||||
assert_eq!(a.ui.last_pgp_dir.as_deref(), Some("pgp-folder"));
|
||||
}
|
||||
}
|
||||
|
||||
@@ -797,13 +797,20 @@ fn switch_on_hover(ctx: &egui::Context, titles: &[egui::Response]) {
|
||||
}
|
||||
}
|
||||
|
||||
/// Activate a menu command. QuickCalc toggles transparently; other items clear pending
|
||||
/// command-line text and start their command interactively.
|
||||
/// Activate a menu command. QuickCalc toggles transparently, and Reference Manager closes its
|
||||
/// palette when it is open (typed XREF only opens it); other items clear pending command-line
|
||||
/// text and start their command interactively.
|
||||
pub fn activate(app: &mut CadApp, id: &str) {
|
||||
if id == "ui.toggle.quickcalc" {
|
||||
run_transparent(app, id);
|
||||
return;
|
||||
}
|
||||
if id == "xref" && app.ui.docking.layout.contains(&crate::docking::Panel::ExternalRefs) {
|
||||
if let Err(e) = crate::xrefs::close_palette(app) {
|
||||
app.set_status(e);
|
||||
}
|
||||
return;
|
||||
}
|
||||
app.cmd.buffer.clear();
|
||||
app.start(id);
|
||||
}
|
||||
|
||||
@@ -434,13 +434,30 @@ fn apply_right_click(o: &mut UiOptions, c: &UiChanges) {
|
||||
|
||||
/// The interface preferences back to their defaults (the interface language stays).
|
||||
fn reset_ui(app: &mut CadApp) {
|
||||
let d = crate::UiState::default();
|
||||
app.ui.theme = d.theme;
|
||||
app.ui.animations = d.animations;
|
||||
app.ui.save_format = d.save_format;
|
||||
app.ui.save_version = d.save_version;
|
||||
// Everything interface, back to its defaults: a hidden menu bar, tool bar, palettes or
|
||||
// panels and a rearranged panel layout come back — once the menu bar is hidden there may be
|
||||
// no other way to reach the toggles (#1240). The interface language stays; the open dialog,
|
||||
// the start tab, the recent files and the remembered folders are state, not preferences, and
|
||||
// stay too. The user's keyboard shortcuts are their own customisation, which Window > Reset
|
||||
// Palettes keeps as well: a reset meant to bring a bar back must not lose them.
|
||||
let (language, dialog, start_tab) = (app.ui.interface_language, app.ui.dialog.take(), app.ui.start_tab);
|
||||
let recent_files = std::mem::take(&mut app.ui.recent_files);
|
||||
let shortcuts = std::mem::take(&mut app.ui.shortcuts);
|
||||
let (last_lisp_dir, last_pgp_dir) = (app.ui.last_lisp_dir.take(), app.ui.last_pgp_dir.take());
|
||||
app.ui = crate::UiState {
|
||||
interface_language: language,
|
||||
dialog,
|
||||
start_tab,
|
||||
recent_files,
|
||||
shortcuts,
|
||||
last_lisp_dir,
|
||||
last_pgp_dir,
|
||||
..Default::default()
|
||||
};
|
||||
// Where the host has no native menu bar the in-window one is the only menu: the reset must
|
||||
// leave it in place (#1240).
|
||||
app.ui.in_window_menu = !app.native_menus;
|
||||
app.ui.system_cursor = app.system_cursor_default;
|
||||
app.ui.history_lines = d.history_lines;
|
||||
app.options = UiOptions::default();
|
||||
}
|
||||
|
||||
|
||||
@@ -42,6 +42,12 @@ fn open_palette(app: &mut CadApp) -> Result<Value, String> {
|
||||
crate::docking::command(app, false, &json!({ "operation": "open", "panel": Panel::ExternalRefs.id() }))
|
||||
}
|
||||
|
||||
/// Close the palette: Window ▸ Reference Manager while it is open, as Window ▸ QuickCalc closes
|
||||
/// QuickCalc (#2273).
|
||||
pub(crate) fn close_palette(app: &mut CadApp) -> Result<Value, String> {
|
||||
crate::docking::command(app, false, &json!({ "operation": "close", "panel": Panel::ExternalRefs.id() }))
|
||||
}
|
||||
|
||||
/// A picked file inside the host drawing's folder is attached by its relative path, so the
|
||||
/// project folder can move.
|
||||
fn relative_to_host(app: &CadApp, picked: &str) -> String {
|
||||
|
||||
@@ -123,7 +123,7 @@ fn palette_icons_are_painted_in_code_and_shown_in_an_iconic_column() {
|
||||
let ctx = egui::Context::default();
|
||||
let mut paint = |panel: Panel| {
|
||||
let mut painted = false;
|
||||
let mut content = Panels { app: &mut app };
|
||||
let mut content = Panels { app: &mut app, close: None };
|
||||
let mut output = ctx.run_ui(egui::RawInput::default(), |ui| {
|
||||
let painter = ui.ctx().layer_painter(egui::LayerId::background());
|
||||
let rect = egui::Rect::from_min_size(egui::Pos2::ZERO, vec2(20.0, 20.0));
|
||||
@@ -593,3 +593,62 @@ fn group_drag_bar_moves_the_whole_group_into_the_other_dock() {
|
||||
assert_eq!(frames(layout), [[Panel::Canvas]]);
|
||||
assert_eq!(h.state().session.doc().unwrap(), &document);
|
||||
}
|
||||
|
||||
/// Guard that every closable panel header offers a visible close button: a docked tab group,
|
||||
/// the default accordion stack, and a floating group. Each click must remove the panel, the
|
||||
/// button must not cover the title, and the tab context menu must still close the same panel.
|
||||
#[test]
|
||||
fn every_panel_header_has_a_close_button_that_closes_like_the_context_menu() {
|
||||
let mut h = harness(None, 1280.0, 1.0);
|
||||
assert!(h.query_by_label("Close Tool Sets").is_some(), "docked tab headers show a close button");
|
||||
assert!(h.query_by_label("Close Drawing").is_none(), "the drawing view is not a closable panel");
|
||||
// External References opens as a tabbed pane; its button sits beside the title, not over it.
|
||||
h.state_mut().run("ui.dock", json!({"operation":"open","panel":"externalReferences"})).unwrap();
|
||||
h.run_steps(4);
|
||||
assert!(h.state().ui.docking.layout.contains(&Panel::ExternalRefs));
|
||||
let close = h.get_by_label("Close External References").rect();
|
||||
let title = h.get_by_role_and_label(egui::accesskit::Role::Tab, "External References").rect();
|
||||
assert!(!close.intersects(title), "the close button does not cover the panel title");
|
||||
h.get_by_label("Close External References").click();
|
||||
h.run_steps(4);
|
||||
assert!(!h.state().ui.docking.layout.contains(&Panel::ExternalRefs));
|
||||
|
||||
// Accordion headers (the default Layers/Properties stack) get one too.
|
||||
assert!(h.state().ui.docking.layout.contains(&Panel::Layers));
|
||||
h.get_by_label("Close Layers").click();
|
||||
h.run_steps(4);
|
||||
assert!(!h.state().ui.docking.layout.contains(&Panel::Layers));
|
||||
|
||||
// The context menu still closes the same panel after it is reopened.
|
||||
h.state_mut().run("ui.dock", json!({"operation":"open","panel":"layers"})).unwrap();
|
||||
h.run_steps(4);
|
||||
assert!(h.state().ui.docking.layout.contains(&Panel::Layers));
|
||||
h.get_by_role_and_label(egui::accesskit::Role::Tab, "Layers").click_button(PointerButton::Secondary);
|
||||
h.run_steps(3);
|
||||
// The docking surface's stock tab menu item ("Close Panel"), not our tooltip.
|
||||
h.get_by_label("Close Panel").click();
|
||||
h.run_steps(4);
|
||||
assert!(!h.state().ui.docking.layout.contains(&Panel::Layers));
|
||||
|
||||
// Floating panels get the same button in their group header.
|
||||
h.state_mut().run("ui.dock", json!({"operation":"float","panel":"properties","rect":[400,250,300,350]})).unwrap();
|
||||
h.run_steps(4);
|
||||
h.get_by_label("Close Properties").click();
|
||||
h.run_steps(4);
|
||||
assert!(!h.state().ui.docking.layout.contains(&Panel::Properties));
|
||||
}
|
||||
|
||||
/// The accessible name is one translated string, not an English verb glued to a translated
|
||||
/// panel label: Spanish readers must hear "Cerrar Capas", never "Close Capas".
|
||||
#[test]
|
||||
fn spanish_close_button_accessible_name_is_localized_as_a_whole() {
|
||||
let mut h = harness(None, 1280.0, 1.0);
|
||||
h.state_mut().run("ui.language", json!({"lang": "es"})).unwrap();
|
||||
h.run_steps(4);
|
||||
assert!(h.query_by_label("Cerrar Capas").is_some(), "the accordion close button is named in Spanish");
|
||||
assert!(h.query_by_label("Cerrar Propiedades").is_some(), "every panel's close button follows the language");
|
||||
assert!(h.query_by_label("Close Capas").is_none(), "no English verb survives the translation");
|
||||
h.get_by_label("Cerrar Capas").click();
|
||||
h.run_steps(4);
|
||||
assert!(!h.state().ui.docking.layout.contains(&Panel::Layers), "the localized name still closes its panel");
|
||||
}
|
||||
|
||||
@@ -252,3 +252,22 @@ fn selection_highlight_settings_set_save_and_show_in_the_selection_tab() {
|
||||
assert!(text.contains(label), "{label} missing from:\n{text}");
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn reset_brings_back_hidden_menu_bar_toolbar_and_status_bar() {
|
||||
// #1240: with the in-window menu bar, the toolbar and the status bar hidden, OPTIONS ▸ Reset
|
||||
// to Defaults (typed, or from the right-click menu) is the way back.
|
||||
let mut a = app();
|
||||
let d = cadcraft_ui_egui::UiState::default();
|
||||
a.ui.in_window_menu = !d.in_window_menu;
|
||||
a.ui.show_toolbar = false;
|
||||
a.ui.show_status_bar = false;
|
||||
a.ui.show_command_line = false;
|
||||
a.ui.show_palettes = false;
|
||||
a.run("options", json!({"reset": true})).unwrap();
|
||||
assert_eq!(a.ui.in_window_menu, d.in_window_menu);
|
||||
assert_eq!(a.ui.show_toolbar, d.show_toolbar);
|
||||
assert_eq!(a.ui.show_status_bar, d.show_status_bar);
|
||||
assert_eq!(a.ui.show_command_line, d.show_command_line);
|
||||
assert_eq!(a.ui.show_palettes, d.show_palettes);
|
||||
}
|
||||
|
||||
@@ -0,0 +1,107 @@
|
||||
//! MENUBAR and TOOLBAR at the command line bring a hidden menu bar and tool bar back (#1341):
|
||||
//! on Windows and Linux the in-window menu bar is the only menu, so with it hidden typing these
|
||||
//! is the way back, as in AutoCAD.
|
||||
|
||||
use cadcraft_engine::Session;
|
||||
use cadcraft_ui_egui::{CadApp, Services};
|
||||
use serde_json::json;
|
||||
|
||||
fn app() -> CadApp {
|
||||
CadApp::new(Session::new(), Services::default())
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn typed_menubar_shows_and_hides_the_menu_bar() {
|
||||
let mut app = app();
|
||||
app.ui.in_window_menu = false;
|
||||
app.cmdline("MENUBAR");
|
||||
assert_eq!(app.session.prompt_text(), "MENUBAR Enter new value for MENUBAR <0>:");
|
||||
app.cmdline("1");
|
||||
assert!(app.session.running.is_none());
|
||||
assert!(app.ui.in_window_menu);
|
||||
// 0 hides it again; anything else is refused and asked again.
|
||||
app.cmdline("MENUBAR");
|
||||
app.cmdline("2");
|
||||
assert!(app.session.running.is_some(), "still asking");
|
||||
app.cmdline("0");
|
||||
assert!(!app.ui.in_window_menu);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn typed_toolbar_shows_the_tool_bar_by_default() {
|
||||
let mut app = app();
|
||||
app.ui.show_toolbar = false;
|
||||
app.cmdline("TOOLBAR");
|
||||
assert_eq!(app.session.prompt_text(), "TOOLBAR Enter tool bar option or [Show/Hide] <Show>:");
|
||||
app.cmdline("");
|
||||
assert!(app.ui.show_toolbar);
|
||||
app.cmdline("TOOLBAR");
|
||||
app.cmdline("H");
|
||||
assert!(!app.ui.show_toolbar);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn the_json_forms_report_and_set_the_bars() {
|
||||
let mut app = app();
|
||||
app.ui.in_window_menu = true;
|
||||
app.ui.show_toolbar = false;
|
||||
app.cmdline("MENUBAR");
|
||||
app.cmdline("");
|
||||
assert_eq!(app.session.execute("menubar", &json!({})).unwrap(), json!({ "value": 1 }));
|
||||
assert_eq!(app.session.execute("toolbar", &json!({})).unwrap(), json!({ "show": false }));
|
||||
app.session.execute("toolbar", &json!({ "show": true })).unwrap();
|
||||
app.cmdline("MENUBAR");
|
||||
app.cmdline("");
|
||||
assert!(app.ui.show_toolbar && app.ui.in_window_menu);
|
||||
assert!(app.session.execute("menubar", &json!({ "value": 3 })).is_err());
|
||||
}
|
||||
|
||||
/// MENUBAR changes only the menu bar: a tool bar change made before the request is applied
|
||||
/// stays (a control-API `ui.set` can come between them).
|
||||
#[test]
|
||||
fn menubar_leaves_a_later_tool_bar_change() {
|
||||
let mut app = app();
|
||||
app.ui.in_window_menu = true;
|
||||
app.ui.show_toolbar = true;
|
||||
app.session.execute("menubar", &json!({ "value": 0 })).unwrap();
|
||||
app.ui.show_toolbar = false;
|
||||
app.cmdline("'REDRAW");
|
||||
assert!(!app.ui.in_window_menu, "MENUBAR applied");
|
||||
assert!(!app.ui.show_toolbar, "the tool bar keeps its later change");
|
||||
}
|
||||
|
||||
/// A bar query through `CadApp::run` reports the bars as the interface shows them now, even when
|
||||
/// a UI change came just before it with no frame drawn in between.
|
||||
#[test]
|
||||
fn a_bar_query_sees_a_ui_change_just_made() {
|
||||
let mut app = app();
|
||||
app.ui.show_toolbar = true;
|
||||
assert_eq!(app.run("toolbar", json!({})).unwrap(), json!({ "show": true }));
|
||||
app.ui.show_toolbar = false;
|
||||
assert_eq!(app.run("toolbar", json!({})).unwrap(), json!({ "show": false }));
|
||||
app.run("toolbar", json!({ "show": true })).unwrap();
|
||||
assert!(app.ui.show_toolbar, "the request is applied at once");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn menubar_started_from_the_ui_offers_the_bar_as_shown_now() {
|
||||
let mut app = app();
|
||||
app.ui.in_window_menu = true;
|
||||
app.cmdline("");
|
||||
app.ui.in_window_menu = false;
|
||||
app.start("menubar");
|
||||
let prompt = app.session.prompt_text();
|
||||
assert!(prompt.contains("<0>"), "{prompt}");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn enter_through_the_control_api_applies_the_bar_before_the_next_request() {
|
||||
let mut app = app();
|
||||
let ctx = egui::Context::default();
|
||||
app.ui.show_toolbar = false;
|
||||
app.start("toolbar");
|
||||
let (req, _pending) = cadcraft_ui_egui::control::ControlRequest::new("cmdline.key", serde_json::json!({ "key": "enter" }));
|
||||
cadcraft_ui_egui::control::handle(&mut app, &ctx, &req);
|
||||
assert!(app.session.running.is_none());
|
||||
assert!(app.ui.show_toolbar, "TOOLBAR's default Show is applied before the next request");
|
||||
}
|
||||
@@ -5,7 +5,7 @@ use cadcraft_engine::Session;
|
||||
use cadcraft_engine::cmd::file::{IoHooks, set_io};
|
||||
use cadcraft_engine::doc::geom::Vec3;
|
||||
use cadcraft_engine::doc::{Drawing, Entity, EntityKind, Handle, Layer, Line, XrefStatus};
|
||||
use cadcraft_ui_egui::{CadApp, Services, docking::Panel};
|
||||
use cadcraft_ui_egui::{CadApp, Services, docking::Panel, menus};
|
||||
use egui::vec2;
|
||||
use egui_kittest::Harness;
|
||||
use egui_kittest::kittest::Queryable;
|
||||
@@ -71,6 +71,23 @@ fn xref_opens_the_palette_and_its_buttons_manage_the_xref() {
|
||||
h.get_by_label("site");
|
||||
}
|
||||
|
||||
/// Window ▸ Reference Manager closes the palette when it is open, like Window ▸ QuickCalc; typed,
|
||||
/// XREF only ever opens it (#2273).
|
||||
#[test]
|
||||
fn the_window_menu_item_closes_an_open_palette() {
|
||||
let mut app = CadApp::new(Session::default(), Services::default());
|
||||
let open = |app: &CadApp| app.ui.docking.layout.contains(&Panel::ExternalRefs);
|
||||
menus::activate(&mut app, "xref");
|
||||
assert!(open(&app), "the menu item opens the palette");
|
||||
menus::activate(&mut app, "xref");
|
||||
assert!(!open(&app), "the menu item closes the open palette");
|
||||
menus::activate(&mut app, "xref");
|
||||
assert!(open(&app), "and opens it again");
|
||||
assert!(app.cmdline("XREF").is_none());
|
||||
assert!(app.cmdline("XR").is_none());
|
||||
assert!(open(&app), "typed XREF keeps it open");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn json_xref_lists_and_never_opens_the_palette() {
|
||||
let mut app = CadApp::new(Session::default(), Services::default());
|
||||
|
||||
@@ -144,6 +144,12 @@ The shortcut also works with text-field focus. Toggling preserves the running dr
|
||||
and pending command-line input. The expression, history and calculator variables survive
|
||||
closing/reopening within the same session; they are not saved across application restarts.
|
||||
|
||||
The External References palette (`externalReferences`) is not part of the default arrangement
|
||||
either. Typed `XREF`/`XR` opens and activates it. **Window > Reference Manager** (also
|
||||
`ui.menu.invoke` with `xref`) opens it too, but closes it when it is present, as Window >
|
||||
QuickCalc does; closing leaves the running command and command-line input alone. `xref` with
|
||||
JSON parameters lists the references and never opens or closes the palette.
|
||||
|
||||
Invoke these UI commands through `engine.execute`, for example `{"command":"ui.dock","params":{"operation":"float","panel":"layers","rect":[100,100,320,440]}}`.
|
||||
|
||||
Advanced `ui.dock` operations use the same validated transaction as pointer gestures:
|
||||
|
||||
Reference in New Issue
Block a user