Merge pull request #34 from azriel91/feature/33/support-images

Author: azriel91

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## unreleased
+
+* Support inline images ([#33]).
+
+
+[#33]: https://github.com/azriel91/dot_ix/issues/33
+
+
 ## 0.8.0 (2024-08-08)
 
 * Add `TextEditor` in playground which uses [monaco][monaco] / [rust-monaco][rust-monaco].

crate/model/src/common.rs

@@ -9,10 +9,13 @@ pub use self::{
     edges::Edges,
     graphviz_attrs::GraphvizAttrs,
     graphviz_dot_theme::GraphvizDotTheme,
+    image_id::{ImageId, ImageIdInvalidFmt},
+    images::Images,
     node_descs::NodeDescs,
     node_emojis::NodeEmojis,
     node_hierarchy::NodeHierarchy,
     node_id::{NodeId, NodeIdInvalidFmt},
+    node_images::NodeImages,
     node_names::NodeNames,
     node_tags_set::NodeTagsSet,
     tag_id::{TagId, TagIdInvalidFmt},
@@ -21,21 +24,24 @@ pub use self::{
     tag_styles::TagStyles,
 };
 
+pub mod dot_src_and_styles;
 pub mod graphviz_attrs;
 pub mod graphviz_dot_theme;
 
 mod any_id;
-mod dot_src_and_styles;
 mod edge;
 mod edge_descs;
 mod edge_id;
 mod edge_tags_set;
 mod edges;
 mod id_newtype;
+mod image_id;
+mod images;
 mod node_descs;
 mod node_emojis;
 mod node_hierarchy;
 mod node_id;
+mod node_images;
 mod node_names;
 mod node_tags_set;
 mod tag_id;

crate/model/src/common/dot_src_and_styles.rs

@@ -2,23 +2,36 @@ use serde::{Deserialize, Serialize};
 
 use crate::theme::ThemeWarnings;
 
+pub use self::{graphviz_image::GraphvizImage, graphviz_opts::GraphvizOpts};
+
+mod graphviz_image;
+mod graphviz_opts;
+
 /// Graphviz dot source and CSS styles.
 #[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
 pub struct DotSrcAndStyles {
     /// Graphviz dot source to run in `dot`.
     pub dot_src: String,
     /// Tailwind CSS styles to put into `<styles>..</styles>`.
     pub styles: String,
+    /// Options to pass to graphviz when rendering.
+    pub opts: GraphvizOpts,
     /// Warnings detected while computing CSS utility classes.
     pub theme_warnings: ThemeWarnings,
 }
 
 impl DotSrcAndStyles {
     /// Returns a new `DotSrcAndStyles` object.
-    pub fn new(dot_src: String, styles: String, theme_warnings: ThemeWarnings) -> Self {
+    pub fn new(
+        dot_src: String,
+        styles: String,
+        opts: GraphvizOpts,
+        theme_warnings: ThemeWarnings,
+    ) -> Self {
         Self {
             dot_src,
             styles,
+            opts,
             theme_warnings,
         }
     }
@@ -33,6 +46,11 @@ impl DotSrcAndStyles {
         &self.styles
     }
 
+    /// Returns the options to pass to graphviz when rendering.
+    pub fn opts(&self) -> &GraphvizOpts {
+        &self.opts
+    }
+
     /// Returns the warnings detected while computing CSS utility classes.
     pub fn theme_warnings(&self) -> &ThemeWarnings {
         &self.theme_warnings

crate/model/src/common/dot_src_and_styles/graphviz_image.rs

@@ -0,0 +1,72 @@
+use serde::{Deserialize, Serialize};
+
+/// Defines the path, width, and height of an image for GraphViz.
+///
+/// Without this, the `<image>` element is not rendered for a node.
+///
+/// See [`Image`].
+///
+/// [`Image`]: https://hpcc-systems.github.io/hpcc-js-wasm/graphviz/interfaces/Image.html
+#[derive(Clone, Debug, PartialEq, Eq, Deserialize, Serialize)]
+pub struct GraphvizImage {
+    /// URL to the image. This may be a data URL.
+    ///
+    /// # Examples
+    ///
+    /// Hyperlinked image:
+    ///
+    /// ```text
+    /// https://example.com/image.png
+    /// ```
+    ///
+    /// Inline image:
+    ///
+    /// ```text
+    /// data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABkAAAAZBAMAAAA2x5hQAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAADUExURUeK/z7BOdMAAAAJcEhZcwAADsIAAA7CARUoSoAAAAAOSURBVCjPYxgFNAMMDAABXgABAvs87wAAAABJRU5ErkJggg==
+    /// ```
+    pub path: String,
+    /// Width that GraphViz scales the image, e.g. `"50px"`.
+    pub width: String,
+    /// Height that GraphViz scales the image, e.g. `"50px"`.
+    pub height: String,
+}
+
+impl GraphvizImage {
+    /// Returns a new `GraphvizImage`.
+    pub fn new(path: String, width: String, height: String) -> Self {
+        Self {
+            path,
+            width,
+            height,
+        }
+    }
+
+    /// Returns the URL to the image. This may be a data URL.
+    ///
+    /// # Examples
+    ///
+    /// Hyperlinked image:
+    ///
+    /// ```text
+    /// https://example.com/image.png
+    /// ```
+    ///
+    /// Inline image:
+    ///
+    /// ```text
+    /// data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABkAAAAZBAMAAAA2x5hQAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAADUExURUeK/z7BOdMAAAAJcEhZcwAADsIAAA7CARUoSoAAAAAOSURBVCjPYxgFNAMMDAABXgABAvs87wAAAABJRU5ErkJggg==
+    /// ```
+    pub fn path(&self) -> &str {
+        &self.path
+    }
+
+    /// Returns the width that GraphViz scales the image, e.g. `"50px"`.
+    pub fn width(&self) -> &str {
+        &self.width
+    }
+
+    /// Returns the height that GraphViz scales the image, e.g. `"50px"`.
+    pub fn height(&self) -> &str {
+        &self.height
+    }
+}

crate/model/src/common/dot_src_and_styles/graphviz_opts.rs

@@ -0,0 +1,33 @@
+use serde::{Deserialize, Serialize};
+
+use crate::common::dot_src_and_styles::GraphvizImage;
+
+/// Options to pass to graphviz when rendering.
+///
+/// Currently this is used to pass inline images.
+///
+/// See [`Options`].
+///
+/// [`Options`]: https://hpcc-systems.github.io/hpcc-js-wasm/graphviz/interfaces/Options.html
+#[derive(Clone, Debug, Default, PartialEq, Eq, Deserialize, Serialize)]
+#[serde(default)]
+pub struct GraphvizOpts {
+    /// The list of [`images`] to pass to `graphviz.layout`.
+    ///
+    /// [`images`]: https://hpcc-systems.github.io/hpcc-js-wasm/graphviz/interfaces/Image.html
+    pub images: Vec<GraphvizImage>,
+}
+
+impl GraphvizOpts {
+    /// Returns a new `GraphvizOpts` object.
+    pub fn new(images: Vec<GraphvizImage>) -> Self {
+        Self { images }
+    }
+
+    /// Returns the list of [`images`] to pass to `graphviz.layout`.
+    ///
+    /// [`images`]: https://hpcc-systems.github.io/hpcc-js-wasm/graphviz/interfaces/Image.html
+    pub fn images(&self) -> &[GraphvizImage] {
+        &self.images
+    }
+}

crate/model/src/common/image_id.rs

@@ -0,0 +1,34 @@
+use std::borrow::Cow;
+
+use serde::{Deserialize, Serialize};
+
+use crate::common::AnyId;
+
+/// Unique identifier for an image, `Cow<'static, str>` newtype.
+///
+/// Must begin with a letter or underscore, and contain only letters, numbers,
+/// and underscores.
+///
+/// # Examples
+///
+/// The following are all examples of valid `ImageId`s:
+///
+/// ```rust
+/// # use dot_ix::model::{image_id, ImageId};
+/// #
+/// let _snake = image_id!("snake_case");
+/// let _camel = image_id!("camelCase");
+/// let _pascal = image_id!("PascalCase");
+/// ```
+#[derive(Clone, Debug, Hash, PartialEq, Eq, Deserialize, Serialize)]
+pub struct ImageId(Cow<'static, str>);
+
+crate::common::id_newtype!(ImageId, ImageIdInvalidFmt, image_id);
+
+impl From<AnyId> for ImageId {
+    fn from(any_id: AnyId) -> Self {
+        let id = any_id.into_inner();
+
+        Self(id)
+    }
+}

crate/model/src/common/images.rs

@@ -0,0 +1,83 @@
+use std::ops::{Deref, DerefMut};
+
+use indexmap::IndexMap;
+use serde::{Deserialize, Serialize};
+
+use crate::common::{dot_src_and_styles::GraphvizImage, ImageId};
+
+/// Images available for . `IndexMap<ImageId, GraphvizImage>` newtype.
+///
+/// # Examples
+///
+/// Each URL should either be a hyperlink to an image, or a base64 encoded
+/// data URL:
+///
+/// ```yaml
+/// hierarchy:
+///   dove: {}
+///   blue: {}
+///
+/// images:
+///   dove_svg:
+///     path: "https://peace.mk/img/dove.svg"
+///     width: "50px"
+///     height: "50px"
+///
+///   blue_inline:
+///     path: >-
+///       data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABkAAAAZBAMAAAA2x5hQAAAAAX
+///       NSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAADUExURUeK/z7BOdMAAAAJcEhZcwAADsIAAA
+///       7CARUoSoAAAAAOSURBVCjPYxgFNAMMDAABXgABAvs87wAAAABJRU5ErkJggg==
+///     width: "50px"
+///     height: "50px"
+///
+/// node_images:
+///   dove: dove_svg
+///   blue: blue_inline
+/// ```
+#[derive(Clone, Debug, Default, PartialEq, Eq, Deserialize, Serialize)]
+pub struct Images(IndexMap<ImageId, GraphvizImage>);
+
+impl Images {
+    /// Returns a new `Images` map.
+    pub fn new() -> Self {
+        Self::default()
+    }
+
+    /// Returns a new `Images` 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<ImageId, GraphvizImage> {
+        self.0
+    }
+}
+
+impl Deref for Images {
+    type Target = IndexMap<ImageId, GraphvizImage>;
+
+    fn deref(&self) -> &Self::Target {
+        &self.0
+    }
+}
+
+impl DerefMut for Images {
+    fn deref_mut(&mut self) -> &mut Self::Target {
+        &mut self.0
+    }
+}
+
+impl From<IndexMap<ImageId, GraphvizImage>> for Images {
+    fn from(inner: IndexMap<ImageId, GraphvizImage>) -> Self {
+        Self(inner)
+    }
+}
+
+impl FromIterator<(ImageId, GraphvizImage)> for Images {
+    fn from_iter<I: IntoIterator<Item = (ImageId, GraphvizImage)>>(iter: I) -> Self {
+        Self(IndexMap::from_iter(iter))
+    }
+}