HDLRuby 3.7.1 → 3.7.3

data/lib/HDLRuby/version.rb

@@ -1,3 +1,3 @@
 module HDLRuby
-  VERSION = "3.7.1"
+  VERSION = "3.7.3"
 end

data/lib/rubyHDL.rb

@@ -6,6 +6,32 @@ require 'hruby_sim/hruby_sim'
 ########################################################################
 module RubyHDL
 
+    # Wrapper for array signal accesses.
+    class ArrayWrapper
+        # Create a new memory wrapper for signal +sig+
+        def initialize(sig)
+            @signal = sig 
+        end
+
+        # Read the array.
+        def [](idx)
+          return RCSim.rcsim_read_index_fixnum(@signal,idx)
+        end
+
+        # Write to the array.
+        def []=(idx,val)
+          return RCSim.rcsim_write_index_fixnum_seq(@signal,idx,val)
+        end
+    end
+
+    # Creates a new array port 'name' assigned to signal 'sig'.
+    def self.arrayport(name,sig)
+      # Creating the accessing method.
+      define_singleton_method(name.to_sym) do
+        ArrayWrapper.new(sig)
+      end
+    end
+
     # Creates a new port 'name' assigned to signal 'sig' for reading.
     def self.inport(name,sig)
         # Create the accessing methods.

data/tuto/tutorial_sw.html

@@ -131,6 +131,12 @@ To do this, you can use the following command:</p>
 </code></pre>
 <p><strong>Note</strong>: for the command above, it is assumed that 'adder.v' contains a simulation benchmark.</p>
 <p>And that's it! For details about all the actions that can be performed, how to write an input file, and what kind of output can be produced, let us see the remaining of the tutorial.</p>
+<h3>1.4. About the HDLRuby files.</h3>
+<p>The HDLRuby files, that include HDLRuby description of circuits, are text files (the default encoding is UTF-8), is file name's extension is by convension <code>.rb</code>. It is possible to include other HDLRuby file within the current one using the <code>require</code> (for HDLRuby standard files) or <code>require_relative</code> (for local HDLRuby files) methods as follows:</p>
+<pre><code class="language-ruby">require &quot;filename&quot;
+require_relative &quot;path_to_another_filename&quot;
+</code></pre>
+<p>As it will be seen later, software Ruby code can also be used for generic descriptions of circuits. It is also possible to include Ruby code from different files using respectively <code>require_ruby</code> for standard libraries and gems, and <code>require_relative_ruby</code> for local files.</p>
 <h2>2. How to represent a circuit in HDLRuby</h2>
 <p>In this section we will see:</p>
 <ul>

data/tuto/tutorial_sw.md

@@ -187,6 +187,18 @@ __Note__: for the command above, it is assumed that 'adder.v' contains a simulat
 
 And that's it! For details about all the actions that can be performed, how to write an input file, and what kind of output can be produced, let us see the remaining of the tutorial.
 
+### 1.4. About the HDLRuby files.
+
+The HDLRuby files, that include HDLRuby description of circuits, are text files (the default encoding is UTF-8), is file name's extension is by convension `.rb`. It is possible to include other HDLRuby file within the current one using the `require` (for HDLRuby standard files) or `require_relative` (for local HDLRuby files) methods as follows:
+
+```ruby
+require "filename"
+require_relative "path_to_another_filename"
+```
+
+As it will be seen later, software Ruby code can also be used for generic descriptions of circuits. It is also possible to include Ruby code from different files using respectively `require_ruby` for standard libraries and gems, and `require_relative_ruby` for local files.
+
+
 
 ## 2. How to represent a circuit in HDLRuby
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: HDLRuby
 version: !ruby/object:Gem::Version
-  version: 3.7.1
+  version: 3.7.3
 platform: ruby
 authors:
 - Lovic Gauthier
 bindir: exe
 cert_chain: []
-date: 2025-03-16 00:00:00.000000000 Z
+date: 2025-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -180,6 +180,7 @@ files:
 - lib/HDLRuby/hdr_samples/ruby_program/sw_inc_mem.rb
 - lib/HDLRuby/hdr_samples/ruby_program/sw_log.rb
 - lib/HDLRuby/hdr_samples/ruby_program/with_sw_hruby.rb
+- lib/HDLRuby/hdr_samples/ruby_program/with_sw_hruby_function.rb
 - lib/HDLRuby/hdr_samples/ruby_program/with_sw_hruby_hruby_test.rb
 - lib/HDLRuby/hdr_samples/seqpar_bench.rb
 - lib/HDLRuby/hdr_samples/simple_counter_bench.rb
@@ -226,9 +227,11 @@ files:
 - lib/HDLRuby/hdr_samples/with_of.rb
 - lib/HDLRuby/hdr_samples/with_program_c.rb
 - lib/HDLRuby/hdr_samples/with_program_ruby.rb
+- lib/HDLRuby/hdr_samples/with_program_ruby_array.rb
 - lib/HDLRuby/hdr_samples/with_program_ruby_cpu.rb
 - lib/HDLRuby/hdr_samples/with_program_ruby_io.rb
 - lib/HDLRuby/hdr_samples/with_program_ruby_mem.rb
+- lib/HDLRuby/hdr_samples/with_program_ruby_sequencer.rb
 - lib/HDLRuby/hdr_samples/with_program_ruby_threads.rb
 - lib/HDLRuby/hdr_samples/with_reconf.rb
 - lib/HDLRuby/hdr_samples/with_reduce.rb