Merge pull request #225 from DFiantHDL/docsupdate7

Docsupdate7

Author: soronpo

.github/workflows/dfdocs.yml

@@ -35,7 +35,14 @@ jobs:
       - name: Setup Python
         uses: actions/setup-python@v4
         with: 
-          python-version: '3.x' 
+          python-version: '3.x'
+      - name: Install Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '22'
+      - name: Install npm packages
+        run: |
+          npm install elkjs @svgdotjs/svg.js svgdom
       - name: Build
         run: |
           python -m pip install --upgrade pip 

.gitignore

@@ -28,3 +28,6 @@ sandbox/
 .vscode/
 project/metals.sbt
 **/__pycache__/**
+node_modules/
+package.json
+package-lock.json

compiler/stages/src/main/scala/dfhdl/compiler/stages/vhdl/VHDLOwnerPrinter.scala

@@ -36,7 +36,12 @@ protected trait VHDLOwnerPrinter extends AbstractOwnerPrinter:
       }
       .mkString(";\n")
     val designParamList = designMembers.collect { case param: DesignParam =>
-      val defaultValue = if (design.isTop) s" := ${param.dfValRef.refCodeString}" else ""
+      val defaultValue =
+        if (design.isTop) s" := ${param.dfValRef.refCodeString}"
+        else
+          param.defaultRef.get match
+            case DFMember.Empty => ""
+            case _              => s" := ${param.defaultRef.refCodeString}"
       s"${param.getName} : ${printer.csDFType(param.dfType)}$defaultValue"
     }
     val genericBlock =

compiler/stages/src/test/scala/StagesSpec/PrintVHDLCodeSpec.scala

@@ -113,12 +113,12 @@ class PrintVHDLCodeSpec extends StageSpec:
     )
   }
   test("Basic hierarchy design with parameters") {
-    class ID(val width: Int <> CONST) extends DFDesign:
+    class ID(val width: Int <> CONST = 7) extends DFDesign:
       val x = SInt(width) <> IN
       val y = SInt(width) <> OUT
       y := x
 
-    class IDTop(val width: Int <> CONST) extends DFDesign:
+    class IDTop(val width: Int <> CONST = 9) extends DFDesign:
       val x   = SInt(width) <> IN
       val y   = SInt(width) <> OUT
       val id1 = ID(width)
@@ -137,7 +137,7 @@ class PrintVHDLCodeSpec extends StageSpec:
          |
          |entity ID is
          |generic (
-         |  width : integer
+         |  width : integer := 7
          |);
          |port (
          |  x : in signed(width - 1 downto 0);

docs/css/d2.css

@@ -1,3 +1,3 @@
-div svg * {
+div.d2 svg * {
   font-family: var(--md-code-font-family) !important;
 }

docs/getting-started/hello-world/scala-project/project.scala

@@ -1,4 +1,4 @@
 //> using scala 3.6.3
-//> using dep io.github.dfianthdl::dfhdl::0.9.1
-//> using plugin io.github.dfianthdl:::dfhdl-plugin:0.9.1
+//> using dep io.github.dfianthdl::dfhdl::0.9.2
+//> using plugin io.github.dfianthdl:::dfhdl-plugin:0.9.2
 //> using option -deprecation -language:implicitConversions

docs/getting-started/hello-world/scala-single-file/Counter8.scala

@@ -1,6 +1,6 @@
 //> using scala 3.6.3
-//> using dep io.github.dfianthdl::dfhdl::0.9.1
-//> using plugin io.github.dfianthdl:::dfhdl-plugin:0.9.1
+//> using dep io.github.dfianthdl::dfhdl::0.9.2
+//> using plugin io.github.dfianthdl:::dfhdl-plugin:0.9.2
 //> using option -deprecation -language:implicitConversions
 
 import dfhdl.* //import all the DFHDL goodness

docs/include/hdelk_hook.py

@@ -1,19 +1,40 @@
 import re
-from pyhocon import ConfigFactory
 import json
+import subprocess
+import tempfile
+import os
+from pyhocon import ConfigFactory
+
+CACHE_DIR = os.path.join('.cache', 'plugin', 'hdelk')
 
 def replace_hdelk(match):
     width = match.group(1) or "100%"  # Default to 100% if width is not specified
     diagram_json = json.dumps(ConfigFactory.parse_string(match.group(2)), indent=2)
     diagram_id = f"hdelk-diagram-{hash(diagram_json)}"  # Generate a unique ID
+    svg_file_path = os.path.join(CACHE_DIR, f"{diagram_id}.svg")
+
+    # Ensure the cache directory exists
+    os.makedirs(CACHE_DIR, exist_ok=True)
+
+    # Check if the cached SVG file already exists
+    if not os.path.exists(svg_file_path):
+        # Create a temporary file for the JSON input
+        with tempfile.NamedTemporaryFile(mode="w", delete=False, suffix='.json') as temp_json_file:
+            temp_json_file.write(diagram_json)
+            temp_json_file_path = temp_json_file.name
+            
+        # Run the Node.js script to generate the SVG
+        subprocess.run(['node', 'docs/javascripts/hdelk.js', temp_json_file_path, svg_file_path], check=True)
+        os.remove(temp_json_file_path)
+
+    # Read the generated SVG content
+    with open(svg_file_path, 'r') as f:
+        svg_content = f.read()
+
     return f"""
-<div id="{diagram_id}" class="hdelk-diagram" style="width: {width};"></div>
-<script type="text/javascript">
-    document.addEventListener("DOMContentLoaded", function() {{
-        var diagram = {diagram_json};
-        hdelk.layout(diagram, "{diagram_id}");
-    }});
-</script>
+<div id="{diagram_id}" class="hdelk-diagram" style="width: {width};">
+    {svg_content}
+</div>
 """
 
 def on_page_markdown(markdown, **kwargs):

docs/javascripts/hdelk.js

@@ -1,4 +1,13 @@
-var hdelk = (function(){
+const fs = require('fs');
+const { createSVGWindow } = require('svgdom');
+const { SVG, registerWindow } = require('@svgdotjs/svg.js');
+const ELK = require('elkjs/lib/elk.bundled.js');
+
+const window = createSVGWindow();
+const document = window.document;
+registerWindow(window, document);
+
+var hdelk = (function() {
 
     /**
      * HDElkJS Style Section
@@ -57,55 +66,29 @@ var hdelk = (function(){
     /**
      * Creates an SVG diagram from a JSON description.
      * @param {object} graph
-     * @param {string} divname
+     * @param {string} outputFilePath
      */
-    var layout = function( graph, divname  ) {
-        const elk = new ELK({
-          })
+    var layout = async function(graph, outputFilePath) {
+        const elk = new ELK();
 
         // create a dummy drawing just to get text sizes
-        var drawDummy = SVG().addTo('#' + divname).size(0, 0);
+        var drawDummy = SVG(document.documentElement).size(0, 0);
 
-        transformNode( drawDummy, graph );
+        transformNode(drawDummy, graph);
 
         drawDummy.clear();
 
-        var mp = document.getElementById( divname + "_message" );
-        if ( mp ) {
-            mp.style.display = "none";
-        }
-
         try {
-            var ep = elk.layout(graph);
-
-            ep.then(function(g) {
-                    var dp = document.getElementById( divname + "_preprocessed" );
-                    if ( dp )
-                        dp.innerHTML = "<pre style='font-size:10px'>" + JSON.stringify(graph, null, " ") + "</pre>";
+            var g = await elk.layout(graph);
 
-                    var d = document.getElementById( divname + "_elk" );
-                    if ( d )
-                        d.innerHTML = "<pre style='font-size:8px'>" + JSON.stringify(g, null, " ") + "</pre>";
+            var svgContent = diagram(g);
 
-                    diagram( divname, g );
-
-                    })
-
-            ep.catch( function(err){
-                var dp = document.getElementById( divname );
-                dp.innerHTML = "";
-                var mp = document.getElementById( divname + "_message" );
-                if ( mp ) {
-                    mp.innerHTML = err;
-                    mp.style.display = "block";
-                }
-            })
-        } catch( err ) {
-            var dp = document.getElementById( divname );
-            dp.innerHTML = "";
-            console.log( err );
+            fs.writeFileSync(outputFilePath, svgContent);
+            // console.log(`SVG file saved to ${outputFilePath}`);
+        } catch (err) {
+            console.error(err);
         }
-    }
+    };
 
     /**
      * Takes the child object and recursively transforms sub-objects into a form that Elk.JS can use
@@ -462,21 +445,18 @@ var hdelk = (function(){
 
     /**
      * Takes the output from ElkJS, renders it into SVG using SVG.js and returns the result
-     * @param {string} div_id
      * @param {elkObject} diagram_layout
      * @returns {string} svg
      */
-    var diagram = function( div_id, diagram_layout ) {
-
-        var diagramElement = document.getElementById(div_id);
-        diagramElement.innerHTML = "";
+    var diagram = function(diagram_layout) {
+        var draw = SVG(document.documentElement)
+            .viewbox(0, 0, diagram_layout.width, diagram_layout.height)
+            .size(diagram_layout.width, diagram_layout.height);
 
-        var draw = SVG().addTo('#' + div_id)
-                        .viewbox(0, 0, diagram_layout.width, diagram_layout.height)
-                        .size('100%', '100%');
+        node(draw, diagram_layout, 0, 0);
 
-        node( draw, diagram_layout, 0, 0 );
-    }
+        return draw.svg();
+    };
 
     var node = function( draw, child, offsetX, offsetY ) {
         var group = draw.group();
@@ -691,3 +671,9 @@ var hdelk = (function(){
     };
 })();
 
+const inputFilePath = process.argv[2];
+const outputFilePath = process.argv[3];
+
+const graph = JSON.parse(fs.readFileSync(inputFilePath, 'utf8'));
+
+hdelk.layout(graph, outputFilePath);

docs/javascripts/scastie.js

@@ -1,4 +1,4 @@
-let dfhdlVersion = "0.9.1";
+let dfhdlVersion = "0.9.2";
 let scalaVersion = "3.6.3";
 
 let sbtConfig = `