HDLRuby 2.11.11 → 3.0.0

data/lib/HDLRuby/hruby_low.rb

@@ -850,6 +850,7 @@ module HDLRuby::Low
         
         # Adds inner signal +signal+.
         def add_inner(signal)
+            # puts "adding inner signal: #{signal.name}(#{signal})"
             # Check and add the signal.
             unless signal.is_a?(SignalI)
                 raise AnyError,
@@ -1632,6 +1633,112 @@ module HDLRuby::Low
 
         alias_method :each_deep, :each_type_deep
 
+        # Tells if the type signed.
+        def signed?
+            return @def.signed?
+        end
+
+        # Tells if the type is unsigned.
+        def unsigned?
+            return @def.unsigned?
+        end
+
+        # Tells if the type is fixed point.
+        def fixed?
+            return @def.fixed?
+        end
+
+        # Tells if the type is floating point.
+        def float?
+            return @def.float?
+        end
+
+        # Tells if the type is a leaf.
+        def leaf?
+            return @def.leaf?
+        end
+
+        # Tells if the type of of vector kind.
+        def vector?
+            return @def.vector?
+        end
+
+        # Gets the bitwidth of the type, by default 0.
+        # Bit, signed, unsigned and Float base have a width of 1.
+        def width
+            return @def.width
+        end
+
+        # Gets the type max value if any.
+        # Default: not defined.
+        def max
+            return @def.max
+        end
+
+        # Gets the type min value if any.
+        # Default: not defined.
+        def min
+            return @def.min
+        end
+
+        # Get the direction of the type, little or big endian.
+        def direction
+            return @def.direction
+        end
+
+        # Tells if the type has a range.
+        def range?
+            return @def.range?
+        end
+
+        # Gets the range of the type, by default range is not defined.
+        def range
+            return @def.range
+        end
+
+        # Tells if the type has a base.
+        def base?
+            return @def.base?
+        end
+
+        # Gets the base type, by default base type is not defined.
+        def base
+            return @def.base
+        end
+
+        # Tells if the type has sub types.
+        def types?
+            return @def.types?
+        end
+
+        # Tells if the type is regular (applies for tuples).
+        def regular?
+            return @def.regular?
+        end
+
+        # Tells if the type has named sub types.
+        def struct?
+            return @def.struct?
+        end
+
+        # Tells if the type is hierarchical.
+        def hierarchical?
+            return @def.hierarchical?
+        end
+
+        # Tell if +type+ is equivalent to current type.
+        #
+        # NOTE: type can be compatible while not being equivalent, please
+        #       refer to `hruby_types.rb` for type compatibility.
+        def equivalent?(type)
+            return @def.equivalent?(type)
+        end
+
+        # Converts to a bit vector.
+        def to_vector
+            return @def.to_vector
+        end
+
     end
 
 
@@ -1812,7 +1919,7 @@ module HDLRuby::Low
     end
 
     ##
-    # Describes a unsigned integer data type.
+    # Describes an unsigned integer data type.
     class TypeUnsigned < TypeVector
 
         # Creates a new vector type named +name+ from +base+ type and with
@@ -1925,7 +2032,7 @@ module HDLRuby::Low
         def each(&ruby_block)
             # No ruby block? Return an enumerator.
             return to_enum(:each) unless ruby_block
-            # A ruby block? Apply it on each input signal instance.
+            # A ruby block? Apply it on each sub name/type pair.
             @types.each(&ruby_block)
         end
 
@@ -1935,7 +2042,7 @@ module HDLRuby::Low
         def each_type(&ruby_block)
             # No ruby block? Return an enumerator.
             return to_enum(:each_type) unless ruby_block
-            # A ruby block? Apply it on each input signal instance.
+            # A ruby block? Apply it on each sub type.
             @types.each(&ruby_block)
         end
 
@@ -2021,16 +2128,18 @@ module HDLRuby::Low
     ##
     # Describes a structure type.
     class TypeStruct < Type
-        # Creates a new structure type named +name+ with +direction+ and 
+        attr_reader :direction
+
+        # Creates a new structure type named +name+ with direction +dir+ and 
         # whose hierachy is given by +content+.
-        def initialize(name,direction,content)
+        def initialize(name,dir,content)
             # Initialize the type.
             super(name)
 
             # Set the direction.
-            @direction = direction.to_sym
+            @direction = dir.to_sym
             unless [:little, :big].include?(@direction)
-                raise AnyError, "Invalid direction for a type: #{direction}"
+                raise AnyError, "Invalid direction for a type: #{dir}"
             end
 
             # Check and set the content.
@@ -2046,7 +2155,8 @@ module HDLRuby::Low
         # Comparison for hash: structural comparison.
         def eql?(obj)
             # General type comparison.
-            return false unless super(obj)
+            # return false unless super(obj)
+            return false unless obj.is_a?(TypeStruct)
             # Specific comparison.
             idx = 0
             obj.each_key do |name|
@@ -2078,8 +2188,13 @@ module HDLRuby::Low
         end
 
         # Gets a sub type by +name+.
+        # NOTE: +name+ can also be an index.
         def get_type(name)
-            return @types[name.to_sym]
+            if name.respond_to?(:to_sym) then
+                return @types[name.to_sym]
+            else
+                return @types.values[name.to_i]
+            end
         end
 
         # Iterates over the sub name/type pair.
@@ -2088,7 +2203,7 @@ module HDLRuby::Low
         def each(&ruby_block)
             # No ruby block? Return an enumerator.
             return to_enum(:each) unless ruby_block
-            # A ruby block? Apply it on each input signal instance.
+            # A ruby block? Apply it on each sub name/type pair.
             @types.each(&ruby_block)
         end
 
@@ -2098,17 +2213,27 @@ module HDLRuby::Low
         def each_type(&ruby_block)
             # No ruby block? Return an enumerator.
             return to_enum(:each_type) unless ruby_block
-            # A ruby block? Apply it on each input signal instance.
+            # A ruby block? Apply it on each sub type.
             @types.each_value(&ruby_block)
         end
 
+        # Iterates over the keys.
+        #
+        # Returns an enumerator if no ruby block is given.
+        def each_key(&ruby_block)
+            # No ruby block? Return an enumerator.
+            return to_enum(:each_key) unless ruby_block
+            # A ruby block? Apply it on each key.
+            @types.each_key(&ruby_block)
+        end
+
         # Iterates over the sub type names.
         #
         # Returns an enumerator if no ruby block is given.
         def each_name(&ruby_block)
             # No ruby block? Return an enumerator.
             return to_enum(:each_name) unless ruby_block
-            # A ruby block? Apply it on each input signal instance.
+            # A ruby block? Apply it on each name.
             @types.each_key(&ruby_block)
         end
 
@@ -2128,7 +2253,11 @@ module HDLRuby::Low
         #
         # NOTE: must be redefined for specific types.
         def width
-            return @types.reduce(0) {|sum,type| sum + type.width }
+            if @types.is_a?(Array) then
+                return @types.reduce(0) {|sum,type| sum + type.width }
+            else
+                return @types.each_value.reduce(0) {|sum,type| sum + type.width }
+            end
         end
 
         # # Checks the compatibility with +type+
@@ -2506,8 +2635,9 @@ module HDLRuby::Low
                 end
                 @value = val
                 val.parent = self
-            else
-                @value = nil
+            # For memory optimization: no  initialization if not used.
+            # else
+            #     @value = nil
             end
         end
 
@@ -2517,6 +2647,40 @@ module HDLRuby::Low
             false
         end
 
+        # Adds sub signal +sig+
+        def add_signal(sig)
+            # puts "add sub=#{sig.name} in signal=#{self}"
+            # Sets the hash of sub signals if none.
+            @signals = HashName.new unless @signals
+            # Check and add the signal.
+            unless sig.is_a?(SignalI)
+                raise AnyError,
+                      "Invalid class for a signal instance: #{sig.class}"
+            end
+            # if @signals.include?(sig) then
+            #     raise AnyError, "SignalI #{sig.name} already present."
+            # end
+            # Set its parent.
+            sig.parent = self
+            # And add it
+            @signals.add(sig)
+        end
+
+        # Gets a sub signal by name.
+        def get_signal(name)
+            return @signals ? @signals[name] : nil
+        end
+
+        # Iterates over the sub signals.
+        #
+        # Returns an enumerator if no ruby block is given.
+        def each_signal(&ruby_block)
+            # No ruby block? Return an enumerator.
+            return to_enum(:each_signal) unless ruby_block
+            # A ruby block? Apply it on each sub signal instance if any.
+            @signals.each(&ruby_block) if @signals
+        end
+
         # # Add decorator capability (modifies intialize to put after).
         # include Hdecorator
 
@@ -4717,8 +4881,15 @@ module HDLRuby::Low
                         content.is_a?(HDLRuby::BitString)
                     # content = HDLRuby::BitString.new(content.to_s)
                     content = content.to_s
-                    if self.type.unsigned? && content[0] != 0 then
-                        content = "0" + content.rjust(self.type.width,content[0])
+                    if self.type.unsigned? && content[0] != "0" then
+                        # content = "0" + content.rjust(self.type.width,content[0])
+                        if content[0] == "1" then
+                            # Do not extend the 1, but 0 instead.
+                            content = "0" + content.rjust(self.type.width,"0")
+                        else
+                            # But extend the other.
+                            content = "0" + content.rjust(self.type.width,content[0])
+                        end
                     end
                     content = HDLRuby::BitString.new(content)
                 end
@@ -5946,7 +6117,7 @@ module HDLRuby::Low
 
 
     ## 
-    # Describe a this reference.
+    # Describes a this reference.
     #
     # This is the current system.
     class RefThis < Ref