Add node_{width,height}{s,_default} and fixed_size

CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## unreleased
+
+* Support `node_width_default` in `GraphvizAttrs`.
+* Support `node_widths` in `GraphvizAttrs`.
+* Support `node_height_default` in `GraphvizAttrs`.
+* Support `node_heights` in `GraphvizAttrs`.
+* Support `fixed_size` in `GraphvizAttrs`.
+
+
 ## 0.8.1 (2024-09-27)
 
 * Support inline images ([#33]).

crate/model/src/common/graphviz_attrs.rs

@@ -2,13 +2,17 @@
 
 pub use self::{
     edge_constraints::EdgeConstraints, edge_dir::EdgeDir, edge_dirs::EdgeDirs,
-    edge_minlens::EdgeMinlens, pack_mode::PackMode, pack_mode_flag::PackModeFlag, splines::Splines,
+    edge_minlens::EdgeMinlens, fixed_size::FixedSize, node_heights::NodeHeights,
+    node_widths::NodeWidths, pack_mode::PackMode, pack_mode_flag::PackModeFlag, splines::Splines,
 };
 
 mod edge_constraints;
 mod edge_dir;
 mod edge_dirs;
 mod edge_minlens;
+mod fixed_size;
+mod node_heights;
+mod node_widths;
 mod pack_mode;
 mod pack_mode_flag;
 mod splines;
@@ -65,6 +69,40 @@
     ///
     /// [`minlen`]: https://graphviz.org/docs/attrs/minlen/
     pub edge_minlens: EdgeMinlens,
+    /// Minimum / initial [`width`] for nodes, defaults to `0.3`.
+    ///
+    /// If `fixedsize` is true, this will be the exact / maximum width for
+    /// nodes.
+    ///
+    /// [`width`]: https://graphviz.org/docs/attrs/width/
+    pub node_width_default: f64,
+    /// Each node's [`width`].
+    ///
+    /// If `fixedsize` is true, this will be the exact / maximum width for
+    /// nodes.
+    ///
+    /// [`width`]: https://graphviz.org/docs/attrs/width/
+    pub node_widths: NodeWidths,
+    /// Minimum / initial [`height`] for nodes, defaults to `0.1`.
+    ///
+    /// If `fixedsize` is true, this will be the exact / maximum height for
+    /// nodes.
+    ///
+    /// [`height`]: https://graphviz.org/docs/attrs/height/
+    pub node_height_default: f64,
+    /// Each node's [`height`].
+    ///
+    /// If `fixedsize` is true, this will be the exact / maximum height for
+    /// nodes.
+    ///
+    /// [`height`]: https://graphviz.org/docs/attrs/height/
+    pub node_heights: NodeHeights,
+    /// Whether a node's `width` and `height` are fixed dimensions.
+    ///
+    /// See [`fixedsize`].
+    ///
+    /// [`fixedsize`]: https://graphviz.org/docs/attrs/fixedsize/
+    pub fixed_size: FixedSize,
     /// How closely to pack together graph components.
     pub pack_mode: PackMode,
 }
@@ -159,6 +197,60 @@
         self
     }
 
+    /// Sets the minimum / initial [`width`] for nodes, defaults to `0.3`.
+    ///
+    /// If `fixedsize` is true, this will be the exact / maximum width for
+    /// nodes.
+    ///
+    /// [`width`]: https://graphviz.org/docs/attrs/width/
+    pub fn with_node_width_default(mut self, node_width_default: f64) -> Self {
+        self.node_width_default = node_width_default;
+        self
+    }
+
+    /// Sets each node's [`width`].
+    ///
+    /// If `fixedsize` is true, this will be the exact / maximum width for
+    /// nodes.
+    ///
+    /// [`width`]: https://graphviz.org/docs/attrs/width/
+    pub fn with_node_widths(mut self, node_widths: NodeWidths) -> Self {
+        self.node_widths = node_widths;
+        self
+    }
+
+    /// Sets the minimum / initial [`height`] for nodes, defaults to `0.1`.
+    ///
+    /// If `fixedsize` is true, this will be the exact / maximum height for
+    /// nodes.
+    ///
+    /// [`height`]: https://graphviz.org/docs/attrs/height/
+    pub fn with_node_height_default(mut self, node_height_default: f64) -> Self {
+        self.node_height_default = node_height_default;
+        self
+    }
+
+    /// Sets each node's [`height`].
+    ///
+    /// If `fixedsize` is true, this will be the exact / maximum height for
+    /// nodes.
+    ///
+    /// [`height`]: https://graphviz.org/docs/attrs/height/
+    pub fn with_node_heights(mut self, node_heights: NodeHeights) -> Self {
+        self.node_heights = node_heights;
+        self
+    }
+
+    /// Sets whether a node's `width` and `height` are fixed dimensions.
+    ///
+    /// See [`fixedsize`].
+    ///
+    /// [`fixedsize`]: https://graphviz.org/docs/attrs/fixedsize/
+    pub fn with_fixed_size(mut self, fixed_size: FixedSize) -> Self {
+        self.fixed_size = fixed_size;
+        self
+    }
+
     /// Returns the minimum space between two adjacent nodes in the same rank,
     /// in inches. Also controls the spacing between multiple edges between
     /// the same pair of nodes.
@@ -230,6 +322,55 @@
     pub fn edge_minlens(&self) -> &EdgeMinlens {
         &self.edge_minlens
     }
+
+    /// Returns the minimum / initial [`width`] for nodes.
+    ///
+    /// If `fixedsize` is true, this will be the exact / maximum width for
+    /// nodes.
+    ///
+    /// [`width`]: https://graphviz.org/docs/attrs/width/
+    pub fn node_width_default(&self) -> f64 {
+        self.node_width_default
+    }
+
+    /// Returns each node's [`width`].
+    ///
+    /// If `fixedsize` is true, this will be the exact / maximum width for
+    /// nodes.
+    ///
+    /// [`width`]: https://graphviz.org/docs/attrs/width/
+    pub fn node_widths(&self) -> &NodeWidths {
+        &self.node_widths
+    }
+
+    /// Returns the minimum / initial [`height`] for nodes.
+    ///
+    /// If `fixedsize` is true, this will be the exact / maximum height for
+    /// nodes.
+    ///
+    /// [`height`]: https://graphviz.org/docs/attrs/height/
+    pub fn node_height_default(&self) -> f64 {
+        self.node_height_default
+    }
+
+    /// Returns each node's [`height`].
+    ///
+    /// If `fixedsize` is true, this will be the exact / maximum height for
+    /// nodes.
+    ///
+    /// [`height`]: https://graphviz.org/docs/attrs/height/
+    pub fn node_heights(&self) -> &NodeHeights {
+        &self.node_heights
+    }
+
+    /// Returns whether a node's `width` and `height` are fixed dimensions.
+    ///
+    /// See [`fixedsize`].
+    ///
+    /// [`fixedsize`]: https://graphviz.org/docs/attrs/fixedsize/
+    pub fn fixed_size(&self) -> FixedSize {
+        self.fixed_size
+    }
 }
 
 impl Default for GraphvizAttrs {
@@ -244,6 +385,11 @@
             edge_dirs: EdgeDirs::default(),
             edge_minlen_default: 2,
             edge_minlens: EdgeMinlens::default(),
+            node_width_default: 0.3,
+            node_widths: NodeWidths::default(),
+            node_height_default: 0.1,
+            node_heights: NodeHeights::default(),
+            fixed_size: FixedSize::default(),
             pack_mode: PackMode::default(),
         }
     }

crate/model/src/common/graphviz_attrs/fixed_size.rs

@@ -0,0 +1,33 @@
+use std::fmt;
+
+use serde::{Deserialize, Serialize};
+
+/// Whether a node's `width` and `height` are fixed dimensions.
+///
+/// See [`fixedsize`].
+///
+/// [`fixedsize`]: https://graphviz.org/docs/attrs/fixedsize/
+#[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Serialize, Deserialize)]
+#[serde(rename_all = "snake_case")]
+pub enum FixedSize {
+    /// Nodes are not fixed size, and `width`/`height` indicate their minimum
+    /// dimensions.
+    #[default]
+    False,
+    /// Nodes are fixed size, and `width`/`height` indicate their maximum
+    /// dimensions.
+    True,
+    /// `width` and `height` determine the dimensions of the node's shape, but
+    /// not its label.
+    Shape,
+}
+
+impl fmt::Display for FixedSize {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+        match self {
+            FixedSize::False => write!(f, "false"),
+            FixedSize::True => write!(f, "true"),
+            FixedSize::Shape => write!(f, "shape"),
+        }
+    }
+}

crate/model/src/common/graphviz_attrs/node_heights.rs

@@ -0,0 +1,59 @@
+use std::ops::{Deref, DerefMut};
+
+use indexmap::IndexMap;
+use serde::{Deserialize, Serialize};
+
+use crate::common::NodeId;
+
+/// GraphViz node height. `IndexMap<NodeId, f64>` newtype.
+///
+/// This is only used for GraphViz dot graphs, which sets the [`height`]
+/// attribute for the node.
+///
+/// [`height`]: https://graphviz.org/docs/attrs/height/
+#[derive(Clone, Debug, Default, PartialEq, Deserialize, Serialize)]
+pub struct NodeHeights(IndexMap<NodeId, f64>);
+
+impl NodeHeights {
+    /// Returns a new `NodeHeights` map.
+    pub fn new() -> Self {
+        Self::default()
+    }
+
+    /// Returns a new `NodeHeights` map with the given preallocated
+    /// capacity.
+    pub fn with_capacity(capacity: usize) -> Self {
+        Self(IndexMap::with_capacity(capacity))
+    }
+
+    /// Returns the underlying map.
+    pub fn into_inner(self) -> IndexMap<NodeId, f64> {
+        self.0
+    }
+}
+
+impl Deref for NodeHeights {
+    type Target = IndexMap<NodeId, f64>;
+
+    fn deref(&self) -> &Self::Target {
+        &self.0
+    }
+}
+
+impl DerefMut for NodeHeights {
+    fn deref_mut(&mut self) -> &mut Self::Target {
+        &mut self.0
+    }
+}
+
+impl From<IndexMap<NodeId, f64>> for NodeHeights {
+    fn from(inner: IndexMap<NodeId, f64>) -> Self {
+        Self(inner)
+    }
+}
+
+impl FromIterator<(NodeId, f64)> for NodeHeights {
+    fn from_iter<I: IntoIterator<Item = (NodeId, f64)>>(iter: I) -> Self {
+        Self(IndexMap::from_iter(iter))
+    }
+}

crate/model/src/common/graphviz_attrs/node_widths.rs

@@ -0,0 +1,59 @@
+use std::ops::{Deref, DerefMut};
+
+use indexmap::IndexMap;
+use serde::{Deserialize, Serialize};
+
+use crate::common::NodeId;
+
+/// GraphViz node width. `IndexMap<NodeId, f64>` newtype.
+///
+/// This is only used for GraphViz dot graphs, which sets the [`width`]
+/// attribute for the node.
+///
+/// [`width`]: https://graphviz.org/docs/attrs/width/
+#[derive(Clone, Debug, Default, PartialEq, Deserialize, Serialize)]
+pub struct NodeWidths(IndexMap<NodeId, f64>);
+
+impl NodeWidths {
+    /// Returns a new `NodeWidths` map.
+    pub fn new() -> Self {
+        Self::default()
+    }
+
+    /// Returns a new `NodeWidths` map with the given preallocated
+    /// capacity.
+    pub fn with_capacity(capacity: usize) -> Self {
+        Self(IndexMap::with_capacity(capacity))
+    }
+
+    /// Returns the underlying map.
+    pub fn into_inner(self) -> IndexMap<NodeId, f64> {
+        self.0
+    }
+}
+
+impl Deref for NodeWidths {
+    type Target = IndexMap<NodeId, f64>;
+
+    fn deref(&self) -> &Self::Target {
+        &self.0
+    }
+}
+
+impl DerefMut for NodeWidths {
+    fn deref_mut(&mut self) -> &mut Self::Target {
+        &mut self.0
+    }
+}
+
+impl From<IndexMap<NodeId, f64>> for NodeWidths {
+    fn from(inner: IndexMap<NodeId, f64>) -> Self {
+        Self(inner)
+    }
+}
+
+impl FromIterator<(NodeId, f64)> for NodeWidths {
+    fn from_iter<I: IntoIterator<Item = (NodeId, f64)>>(iter: I) -> Self {
+        Self(IndexMap::from_iter(iter))
+    }
+}