HDLRuby 3.5.1 → 3.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ddf985a2c95d278dd5267350cb09cf3310d29a21ede26b0dea69381ae0cd8ed8
-  data.tar.gz: 0b38f0e98fdc47a7a0ba692777957a76cc239fc22d5ae4eb9c4b979df88fa186
+  metadata.gz: 86a98906417747050937e8547246ff7ac1cb06e78da82ae4c63385b26dbaa97e
+  data.tar.gz: 1096ee8f5bf5ec44409420e6fa60969bf9798f93cec7fa3dd862abc5ac18527f
 SHA512:
-  metadata.gz: fbe2f1ecba2cbd9fe06e1707479b5024a4b21a839f857a357b2ea4880ecb90dd1a48a91c8e32b45ea5f1b670d52b1e3fdb6297f71cd2dd05cc013447fd0151ad
-  data.tar.gz: 16cde53ba9e257f76c60f7ce1b75fda7b416433668d07fe0f696fcdeff000e921777e142cb09140930ccf65de48dea8f4565d0831c896bc7304d59d0bc64f5d2
+  metadata.gz: 824c3bf0f96d889913175fccef2d8b854c5da86221e2c70f633f91d104374c6456a1a4958eef0d68da1e3437da8b96b67558b7d563c0cf3c29a6681c8fa8fb1c
+  data.tar.gz: 05adeeaa6c1e7a3872d045ad876a295a58548abd610302a94d84f4ac317d84b3bc907adca05daa093cb0d9fa79163836b0d6c5269c9fbcfd83f9cca3dcc42635

data/README.md

@@ -17,6 +17,12 @@ hdrcc --get-tuto
 
 __What's new__
 
+For HDLRuby version 3.6.x:
+
+ * Added a new element for the GUI board that allows to assign an expression to a signal on the fly while simulating.
+
+ * Added a new slider element for the GUI board (from 3.6.1).
+
 For HDLRuby version 3.5.0:
 
  * Added direct support for Verilog HDL files as input to 'hdrcc'.
@@ -2220,6 +2226,12 @@ The list of possible elements is as follows:
 
  * `bt`: represents a set of push buttons, their number is set to match the bit-width of the attached signal.
 
+ * `slider`: represents an horizontal slider.
+
+ * `text`: represents a text input box whose content is interpreted as an expression. The syntax of the expression follows Ruby, and the available variables include the board's display objects. For example, if a set of LEDs is named `leds`, it will be accessible as a variable.
+
+ * `hook`: attaches a signal to the board without displaying. It can be used as a variable in `text` expressions, similar to display objects.
+
  * `led`: represents a set of LEDs, their number is set to match the bit-width of the attached signal.
 
  * `hexa`: represents a hexadecimal number display, its character width is set to match the width of the largest possible value of the attached signal.

data/lib/HDLRuby/hdr_samples/with_board.rb

@@ -10,20 +10,36 @@ system :with_board do
     inner rst: 0
     [8].inner :sw_a, :sw_b
     [9].inner :led_z
+    [8].inner :expr, :show
     [16].inner counter: 0
     [8].inner :counter8
     signed[8].inner :scounter8
 
+    bit[8][-256].inner :mem
+    [8].inner :addr, :din, :dout
+
+    mem[addr] <= din
+    dout <= mem[addr]
+
     # Description of the board.
     # It is updated at each rising edge of +clk2+.
     board(:some_board) do
         actport clk2.posedge
         bt  reset:    rst
+        hook sw_ai: sw_a
+        hook sw_bi: sw_b
         row
         sw  sw_a:     sw_a
-        sw  sw_b:     sw_b
+        slider sw_b:  sw_b
         led led_z:    led_z
         row
+        text expr:    expr
+        digit show:   show
+        row
+        text addr:    addr
+        hexa dout:    dout
+        text din:     din
+        row
         digit cnt_d:  counter
         hexa  cnt_h:  counter
         digit cnt_s:  scounter8
@@ -35,6 +51,9 @@ system :with_board do
     # The adder.
     led_z <= sw_a.as(bit[9]) + sw_b
 
+    # The text input and result.
+    show <= expr
+
     # The counters and the generation of +clk2+.
     counter8 <= counter[7..0]
     scounter8 <= counter[7..0]
@@ -52,7 +71,7 @@ system :with_board do
         clk <= 0
         clk2 <= 0
         !10.ns
-        repeat(1000) do
+        repeat(10000) do
             clk <= 1
             !10.ns
             clk <= 0

data/lib/HDLRuby/ui/hruby_board.rb

@@ -20,6 +20,9 @@ module HDLRuby::High::Std
     include Hmissing
 
     attr_reader :namespace
+
+    ## Suffix telling a text is an expression to compute.
+    TO_COMPUTE = "="
     
     ## Class describing a row of slide switches.
     SW = Struct.new(:id, :size, :hwrite) do
@@ -31,7 +34,7 @@ module HDLRuby::High::Std
              '<label class="sw"><input type="checkbox" data-bit="' + 
                      (self.size-i-1).to_s + '" ' +
                      'onchange="sw_change(this)">' +
-             '<span class="slider"></span></label>\n'
+             '<span class="sw_slider"></span></label>\n'
            end.join + "</div>\\n"
       end
     end
@@ -49,6 +52,43 @@ module HDLRuby::High::Std
            end.join + "</div>\\n"
       end
     end
+    
+    ## Class describing an "analog" slide switch.
+    SLIDER = Struct.new(:id, :min, :max, :hwrite) do
+      def to_html
+        # Prepare the min, max and blank strings.
+        min = self.min.to_s
+        max = self.max.to_s
+        return "<div class=\"sliderset\" id=\"#{self.id}\" data-value=\"0\">\\n" + 
+          '<span class="name">' + self.hwrite.to_s.chop + '</span>' +
+          '<span>&nbsp;&nbsp;</span>' +
+          '<input type="range" min="' + min + '" max="' + max + 
+            '" value="' + min + '" ' +
+            'class="slider" oninput="slider_change(this)">' +
+           "</div>\\n"
+      end
+    end
+
+    ## Class describing a text-based input.
+    TEXT = Struct.new(:id, :size, :hwrite) do
+      def to_html
+        return "<div class=\"textset\" id=\"#{self.id}\" data-value=\"0\">\\n" + 
+          '<form onSubmit="text_submit(this); return false">\\n' +
+          '<span class="name">' + self.hwrite.to_s.chop + '</span>' +
+          '<span>&nbsp;&nbsp;</span>' + 
+             '<input class="matrix_in" type="text" name="text" ' +
+               'placeholder="Enter an expression">' +
+          "</form>\\n" +
+        "</div>\\n"
+      end
+    end
+
+    ## Class describing a hook (invisible display element).
+    HOOK = Struct.new(:id, :size, :hread) do
+      def to_html
+        return "<div id=\"#{self.id}\" data-value=\"0\"/>\\n"
+      end
+    end
 
     ## Class describing a row of LEDs.
     LED = Struct.new(:id, :size, :hread) do
@@ -248,6 +288,16 @@ Content-Type: text/html
     height: 40px;
   }
 
+  .sliderset {
+    display: flex;
+    flex-direction: row;
+    justify-content: center;
+    align-items: center;
+    margin-left:  8px;
+    margin-right: 8px;
+    height: 40px;
+  }
+
   .ledset {
     display: flex;
     flex-direction: row;
@@ -430,7 +480,7 @@ Content-Type: text/html
     height: 0;
   }
   
-  .slider {
+  .sw_slider {
     position: absolute;
     cursor: pointer;
     top: 0;
@@ -443,7 +493,7 @@ Content-Type: text/html
     border: solid 2px #505050;  
   }
   
-  .slider:before {
+  .sw_slider:before {
     position: absolute;
     content: "";
     height: 16px;
@@ -455,16 +505,48 @@ Content-Type: text/html
     transition: .2s;
   }
   
-  input:checked + .slider {
+  input:checked + .sw_slider {
     background-color: yellow;
   }
   
-  input:checked + .slider:before {
+  input:checked + .sw_slider:before {
     -webkit-transform: translateY(-16px);
     -ms-transform: translateY(-16px);
     transform: translateY(-16px);
   }
 
+  .slider {
+    -webkit-appearance: none;
+    width: 100%;
+    height: 25px;
+    background-color: #ccc;
+    -webkit-transition: .2s;
+    transition: .2s;
+    border: solid 2px #505050;  
+    margin: 2px;
+    box-shadow: -1px -1px 1px white, 1px 1px 1px #101010;
+    -moz-box-shadow: -1px -1px 1px white, 1px 1px 1px #101010;
+    -webkit-shadow: -1px -1px 1px white, 1px 1px 1px #101010;
+  }
+
+  .slider::-webkit-slider-thumb {
+    -webkit-appearance: none;
+    appearance: none;
+    width: 25px;
+    height: 25px;
+    background: black;
+    border: solid 2px #505050;  
+    cursor: pointer;
+  }
+
+  .slider::-moz-range-thumb {
+    width: 25px;
+    height: 25px;
+    background: black;
+    border: solid 2px #505050;  
+    cursor: pointer;
+  }
+
   .matrix {
     font-size: 26px;
     font-family: "Lucida Console", "Courier New", monospace;
@@ -476,6 +558,17 @@ Content-Type: text/html
     -webkit-shadow: -1px -1px 1px white, 1px 1px 1px #101010;
   }
 
+  .matrix_in {
+    font-size: 26px;
+    font-family: "Lucida Console", "Courier New", monospace;
+    color: #0B190B;
+    background-color: #9BBC0F;
+    border: solid 2px #505050;
+    box-shadow: -1px -1px 1px white, 1px 1px 1px #101010;
+    -moz-box-shadow: -1px -1px 1px white, 1px 1px 1px #101010;
+    -webkit-shadow: -1px -1px 1px white, 1px 1px 1px #101010;
+  }
+
   .bt {
     background-color: #ccc;
     border: solid 2px #505050;
@@ -586,7 +679,9 @@ Content-Type: text/html
     const element = prow.lastElementChild;
     // Depending of the kind of element.
     if (element.classList.contains('swset') ||
-      element.classList.contains('btset')) {
+        element.classList.contains('btset') ||
+        element.classList.contains('sliderset') ||
+        element.classList.contains('textset') ) {
       // Input element.
       input_ids.push(element.id);
     } else {
@@ -628,6 +723,14 @@ Content-Type: text/html
     // console.log("sw value=" + swset.dataset.value);
   }
 
+  // Handler of slider change.
+  function slider_change(slider) {
+    // Get the set holding slider.
+    const sliderset = slider.parentElement;
+    sliderset.dataset.value = slider.value;
+    // console.log("slider value=" + sliderset.dataset.value);
+  }
+
   // Set the aspect of a button to clicked.
   function bt_on(bt) {
     bt.innerHTML = '<i class="bt_on"></i>';
@@ -660,6 +763,16 @@ Content-Type: text/html
     btset.dataset.value = btset.dataset.value & ~(1 << bit);
   }
 
+  
+  // Handler of the text submit
+  function text_submit(form) {
+     // Get the et holding the form.
+     const textset = form.parentElement;
+     // Update the value, suffixed with #{TO_COMPUTE} for telling it is a
+     // text expression to compute.
+     textset.dataset.value = form.elements.text.value + "#{TO_COMPUTE}"
+  }
+
 
   // Switch a led on.
   function led_on(led) {
@@ -916,7 +1029,7 @@ HTMLRESPONSE
       end
       # Create the HDLRuby program port.
       @program.outport(hport)
-      # Create the ui component.
+      # Create the UI component.
       hport = hport.first
       @elements << SW.new(@elements.size,hport[1].type.width,:"#{hport[0]}=")
     end
@@ -929,10 +1042,58 @@ HTMLRESPONSE
       # Create the HDLRuby program port.
       @program.outport(hport)
       hport = hport.first
-      # Create the ui component.
+      # Create the UI component.
       @elements << BT.new(@elements.size,hport[1].type.width,:"#{hport[0]}=")
     end
 
+    # Add a new slider element attached to HDLRuby port +hport+
+    def slider(hport)
+      if !hport.is_a?(Hash) or hport.size != 1 then
+        raise UIError.new("Malformed HDLRuby port declaration: #{hport}")
+      end
+      # Create the HDLRuby program port.
+      @program.outport(hport)
+      hport = hport.first
+      # Compute the min and max values.
+      width = hport[1].type.width
+      if hport[1].type.signed? then
+        min = -2**(width-1)
+        max = 2**(width-1) - 1
+      else
+        min = 0
+        max = 2**width - 1
+      end
+      # Create the UI component.
+      @elements << SLIDER.new(@elements.size,min,max,:"#{hport[0]}=")
+    end
+
+    # Add a new text input element attached to HDLRuby port +hport+
+    def text(hport)
+      if !hport.is_a?(Hash) or hport.size != 1 then
+        raise UIError.new("Malformed HDLRuby port declaration: #{hport}")
+      end
+      # Create the HDLRuby program port.
+      @program.outport(hport)
+      hport = hport.first
+      # Create the UI component.
+      @elements << TEXT.new(@elements.size,hport[1].type.width,:"#{hport[0]}=")
+    end
+
+    # Add a new hook element attached to HDLRuby port +hport+.
+    # NOTE: a hook element is not displayed on the board but can be used
+    # in the `text` expression.
+    def hook(hport)
+      if !hport.is_a?(Hash) or hport.size != 1 then
+        raise UIError.new("Malformed HDLRuby port declaration: #{hport}")
+      end
+      # Create the HDLRuby program port.
+      @program.inport(hport)
+      hport = hport.first
+      # Createthe UI component (invisible)
+      @elements << HOOK.new(@elements.size,hport[1].type.width,hport[0])
+      @out_elements << @elements[-1]
+    end
+
     # Add a new LED element attached to HDLRuby port +hport+.
     def led(hport)
       if !hport.is_a?(Hash) or hport.size != 1 then
@@ -941,7 +1102,7 @@ HTMLRESPONSE
       # Create the HDLRuby program port.
       @program.inport(hport)
       hport = hport.first
-      # Createthe ui component.
+      # Createthe UI component.
       @elements << LED.new(@elements.size,hport[1].type.width,hport[0])
       @out_elements << @elements[-1]
     end
@@ -1032,6 +1193,33 @@ HTMLRESPONSE
     end
 
 
+    # Compute a value.
+    def compute(val)
+      # Preprocess val to match Ruby syntax.
+      val = "0" unless val
+      val = val.gsub("%20"," ")
+      # Replace the names by the corresponding ports read result.
+      val = val.gsub(/([\._a-zA-Z0-9]+)/) do |str|
+        if str[0] >= "a" && str[0] <= "z" then
+          # Variable identifier, process it if recognized.
+          RubyHDL.send(Regexp.last_match[1]).to_s rescue str
+        else
+          # Other token leave it as is.
+          str
+        end
+      end
+      # Compute.
+      res = 0
+      safe = $SAFE
+      begin
+        $SAFE = 2
+        res = eval(val).to_i
+      rescue SyntaxError => se
+      rescue StandardError => se
+      end
+      $SAFE = safe
+      return res
+    end
 
     # Update port number +id+ with value +val+.
     def update_port(id,val)
@@ -1057,8 +1245,17 @@ HTMLRESPONSE
         # This should be an AJAX request, process it.
         commands = request.split(";")
         commands.each do |command|
-          next unless command.include?(":")
-          id, val = command.split(":").map {|t| t.to_i}
+          # next unless command.include?(":")
+          # id, val = command.split(":").map {|t| t.to_i}
+          id, val = command.split(":",2)
+          next unless val
+          id = id.to_i
+          if val[-1] == "=" then
+            # This is an expression to compute.
+            val = self.compute(val.chop)
+          else
+            val = val.to_i
+          end
           self.update_port(id,val)
         end
         # And generate the response: an update of each board output element.

data/lib/HDLRuby/version.rb

@@ -1,3 +1,3 @@
 module HDLRuby
-  VERSION = "3.5.1"
+  VERSION = "3.6.1"
 end

data/tuto/tutorial_sw.html

@@ -3047,6 +3047,12 @@ end
 </li>
 <li><p><code>led</code>: represents a set of LEDs, their number is set to match the bit-width of the attached signal.</p>
 </li>
+<li><p><code>slider</code>: represents an horizontal slider.</p>
+</li>
+<li><p><code>text</code>: represents a text input box whose content is interpreted as an expression. The syntax of the expression follows Ruby, and the available variables include the board's display objects. For example, if a set of LEDs is named <code>leds</code>, it will be accessible as a variable.</p>
+</li>
+<li><p><code>hook</code>: attaches a signal to the board without displaying. It can be used as a variable in <code>text</code> expressions, similar to display objects.</p>
+</li>
 <li><p><code>hexa</code>: represents a hexadecimal number display, its character width is set to match the width of the largest possible value of the attached signal.</p>
 </li>
 <li><p><code>digit</code>: represents a decimal number display, its character width is set to match the width of the largest possible positive or the smallest possible negative value of the attached signal.</p>

data/tuto/tutorial_sw.md

@@ -3750,6 +3750,12 @@ And the comprise the following:
 
  * `led`: represents a set of LEDs, their number is set to match the bit-width of the attached signal.
 
+ * `slider`: represents an horizontal slider.
+
+ * `text`: represents a text input box whose content is interpreted as an expression. The syntax of the expression follows Ruby, and the available variables include the board's display objects. For example, if a set of LEDs is named `leds`, it will be accessible as a variable.
+
+ * `hook`: attaches a signal to the board without displaying. It can be used as a variable in `text` expressions, similar to display objects.
+
  * `hexa`: represents a hexadecimal number display, its character width is set to match the width of the largest possible value of the attached signal.
 
  * `digit`: represents a decimal number display, its character width is set to match the width of the largest possible positive or the smallest possible negative value of the attached signal.

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: HDLRuby
 version: !ruby/object:Gem::Version
-  version: 3.5.1
+  version: 3.6.1
 platform: ruby
 authors:
 - Lovic Gauthier
 bindir: exe
 cert_chain: []
-date: 2024-12-25 00:00:00.000000000 Z
+date: 2025-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -488,7 +488,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.0
+rubygems_version: 3.6.2
 specification_version: 4
 summary: HDLRuby is a library for describing and simulating digital electronic systems.
 test_files: []