HDLRuby 2.11.12 → 3.1.0

data/lib/HDLRuby/hruby_low_mutable.rb

@@ -1,6 +1,7 @@
 require "HDLRuby/hruby_error"
 
 
+module HDLRuby::Low
 
 ##
 # Make HDLRuby::Low objects mutable trough "!" methods.
@@ -10,13 +11,10 @@ require "HDLRuby/hruby_error"
 #       * this is a work in progress.
 #
 ########################################################################
-module HDLRuby::Low
-    
-    ##
-    # Describes a system type.
-    #
-    # NOTE: delegates its content-related methods to its Scope object.
+
+
     class SystemT
+        ## Makes SystemT mutable.
 
         # Sets the +name+.
         def set_name!(name)
@@ -97,9 +95,8 @@ module HDLRuby::Low
     end
 
 
-    ## 
-    # Describes scopes of system types.
     class Scope
+        ## Makes Scope mutable.
 
         # Maps on the local types.
         def map_types!(&ruby_block)
@@ -272,9 +269,8 @@ module HDLRuby::Low
     end
 
     
-    ##
-    # Describes a data type.
     class Type
+        ## Makes Type mutable.
 
         # Sets the +name+.
         def set_name!(name)
@@ -283,12 +279,8 @@ module HDLRuby::Low
     end
 
 
-    ##
-    # Describes a high-level type definition.
-    #
-    # NOTE: type definition are actually type with a name refering to another
-    #       type (and equivalent to it).
     class TypeDef
+        ## Makes TypeDef mutable.
 
         # Sets the type definition to +type+.
         def set_def!(type)
@@ -302,10 +294,8 @@ module HDLRuby::Low
     end
 
 
-
-    ##
-    # Describes a vector type.
     class TypeVector
+        ## Makes TypeVector mutable.
         
         # Sets the +base+ type.
         def set_base!(type)
@@ -333,9 +323,8 @@ module HDLRuby::Low
     end
 
 
-    ##
-    # Describes a tuple type.
     class TypeTuple
+        ## Makes TypeTuple mutable.
 
         # Maps on the sub types.
         def map_types!(&ruby_block)
@@ -355,9 +344,8 @@ module HDLRuby::Low
     end
 
 
-    ##
-    # Describes a structure type.
     class TypeStruct
+        ## Makes TypeStruct mutable.
 
         # Maps on the sub types.
         def map_types!(&ruby_block)
@@ -377,10 +365,8 @@ module HDLRuby::Low
     end
 
 
-
-    ##
-    # Describes a behavior.
     class Behavior
+        ## Makes Behavior mutable.
 
         # Sets the block.
         def set_block!(block)
@@ -409,13 +395,8 @@ module HDLRuby::Low
     end
 
 
-    ##
-    # Describes a timed behavior.
-    #
-    # NOTE: 
-    # * this is the only kind of behavior that can include time statements. 
-    # * this kind of behavior is not synthesizable!
     class TimeBehavior
+        ## Makes TimeBehavior mutable.
 
         # Sets the block.
         def set_block!(block)
@@ -430,9 +411,9 @@ module HDLRuby::Low
     end
 
 
-    ## 
-    # Describes an event.
     class Event
+        ## Makes Event mutable.
+
         # Sets the type.
         def set_type!(type)
             # Check and set the type.
@@ -482,9 +463,8 @@ module HDLRuby::Low
     end
 
 
-    ##
-    # Describes a signal.
     class SignalI
+        ## Makes SignalI mutable.
 
         # Sets the name.
         def set_name!(name)
@@ -515,9 +495,8 @@ module HDLRuby::Low
     end
 
 
-    ## 
-    # Describes a system instance.
     class SystemI
+        ## Makes SystemI mutable.
 
         # Sets the name.
         def set_name!(name)
@@ -537,12 +516,9 @@ module HDLRuby::Low
     end
 
 
-
-    ## 
-    # Describes a statement.
-    #
-    # NOTE: this is an abstract class which is not to be used directly.
     class Statement
+        ## Makes Statement mutable.
+
         # Replaces sub expressions using +node2rep+ table indicating the
         # node to replace and the corresponding replacement.
         # Returns the actually replaced nodes and their corresponding
@@ -564,11 +540,9 @@ module HDLRuby::Low
     end
 
 
-
-
-    ## 
-    # Decribes a transmission statement.
     class Transmit
+        ## Makes Transmit mutable.
+
         # Sets the left.
         def set_left!(left)
             # Check and set the left reference.
@@ -641,9 +615,8 @@ module HDLRuby::Low
     end
 
 
-    ## 
-    # Decribes a print statement.
     class Print
+        ## Makes Print mutable.
 
         # Maps on the arguments.
         def map_args!(&ruby_block)
@@ -699,9 +672,8 @@ module HDLRuby::Low
     end
 
 
-    ## 
-    # Describes an if statement.
     class If
+        ## Makes If mutable.
 
         # Sets the condition.
         def set_condition!(condition)
@@ -819,9 +791,10 @@ module HDLRuby::Low
         end
     end
 
-    ##
-    # Describes a when for a case statement.
+
     class When
+        ## Makes When mutable.
+
         # Sets the match.
         def set_match!(match)
             # Checks the match.
@@ -893,9 +866,8 @@ module HDLRuby::Low
     end
 
 
-    ## 
-    # Describes a case statement.
     class Case
+        ## Makes Case mutable.
 
         # Sets the value.
         def set_value!(value)
@@ -984,9 +956,8 @@ module HDLRuby::Low
     end
 
 
-    ##
-    # Describes a delay: not synthesizable.
     class Delay
+        ## Makes Delay mutable.
 
         # Sets the value.
         def set_value!(value)
@@ -1030,9 +1001,8 @@ module HDLRuby::Low
     end
 
 
-    ## 
-    # Describes a wait statement: not synthesizable!
     class TimeWait
+        ## Makes TimeWait mutable.
         
         # Sets the delay.
         def set_delay!(delay)
@@ -1052,9 +1022,8 @@ module HDLRuby::Low
     end
 
 
-    ## 
-    # Describes a timed loop statement: not synthesizable!
     class TimeRepeat
+        ## Makes TimeRepeat mutable.
         
         # Sets the statement.
         def set_statement!(statement)
@@ -1102,9 +1071,8 @@ module HDLRuby::Low
     end
 
 
-    ## 
-    # Describes a block.
     class Block
+        ## Makes Block mutable.
 
         # Sets the mode.
         def set_mode!(mode)
@@ -1274,18 +1242,14 @@ module HDLRuby::Low
     end
 
 
-    # Describes a timed block.
-    #
-    # NOTE: 
-    # * this is the only kind of block that can include time statements. 
-    # * this kind of block is not synthesizable!
     class TimeBlock
+        ## Makes TimeBlock mutable.
     end
 
 
-    ##
-    # Decribes a piece of software code.
     class Code
+        ## Makes Code mutable.
+
         # Sets the type.
         def set_type!(type)
             # Check and set type.
@@ -1301,13 +1265,8 @@ module HDLRuby::Low
     end
 
 
-    ## 
-    # Describes a connection.
-    #
-    # NOTE: eventhough a connection is semantically different from a
-    # transmission, it has a common structure. Therefore, it is described
-    # as a subclass of a transmit.
     class Connection
+        ## Makes Connection mutable.
 
         # Replace node by corresponding replacement from +node2reassign+ that
         # is a table whose entries are:
@@ -1345,12 +1304,8 @@ module HDLRuby::Low
     end
 
 
-
-    ## 
-    # Describes an expression.
-    #
-    # NOTE: this is an abstract class which is not to be used directly.
     class Expression
+        ## Makes Expression mutable.
 
         # Sets the type.
         def set_type!(type)
@@ -1382,9 +1337,8 @@ module HDLRuby::Low
     end
 
     
-    ##
-    # Describes a value.
     class Value
+        ## Makes Value mutable.
 
         # Sets the content.
         def set_content!(content)
@@ -1440,18 +1394,15 @@ module HDLRuby::Low
         end
     end
 
-    ##
-    # Describes a cast.
+
     class Cast
+        ## Makes Cast mutable.
         include OneChildMutable
     end
 
 
-    ##
-    # Describes an operation.
-    #
-    # NOTE: this is an abstract class which is not to be used directly.
     class Operation
+        ## Makes Operation mutable.
 
         # Sets the operator.
         def set_operator!(operator)
@@ -1461,9 +1412,8 @@ module HDLRuby::Low
     end
 
 
-    ## 
-    # Describes an unary operation.
     class Unary
+        ## Makes Unary mutable.
         include OneChildMutable
 
         # Moved to OneChildMutable
@@ -1486,9 +1436,8 @@ module HDLRuby::Low
     end
 
 
-    ##
-    # Describes an binary operation.
     class Binary
+        ## Makes Binary mutable.
 
         # Sets the left.
         def set_left!(left)
@@ -1560,11 +1509,8 @@ module HDLRuby::Low
     end
 
 
-    ##
-    # Describes a section operation (generalization of the ternary operator).
-    #
-    # NOTE: choice is using the value of +select+ as an index.
     class Select
+        ## Makes Select mutable.
 
         # Sets the select.
         def set_select!(select)
@@ -1685,9 +1631,8 @@ module HDLRuby::Low
     end
 
 
-    ## 
-    # Describes a concatenation expression.
     class Concat
+        ## Makes Concat mutable.
         include MutableConcat
 
         # Maps on the expression.
@@ -1715,11 +1660,9 @@ module HDLRuby::Low
     end
 
 
-    ## 
-    # Describes a reference expression.
-    #
-    # NOTE: this is an abstract class which is not to be used directly.
     class Ref
+        ## Makes Ref mutable.
+
         # Maps on the children.
         def map_nodes!(&ruby_block)
             # Nothing to do.
@@ -1729,9 +1672,8 @@ module HDLRuby::Low
     end
 
 
-    ##
-    # Describes concatenation reference.
     class RefConcat
+        ## Makes RefConcat mutable.
         include MutableConcat
 
         # Maps on the references.
@@ -1759,9 +1701,8 @@ module HDLRuby::Low
     end
 
 
-    ## 
-    # Describes a index reference.
     class RefIndex
+        ## Makes RefIndex mutable.
         
         # Sets the base reference.
         def set_ref!(ref)
@@ -1835,9 +1776,8 @@ module HDLRuby::Low
     end
 
 
-    ## 
-    # Describes a range reference.
     class RefRange
+        ## Makes RefRange mutable.
         
         # Sets the base reference.
         def set_ref!(ref)
@@ -1931,9 +1871,9 @@ module HDLRuby::Low
     end
 
 
-    ##
-    # Describes a name reference.
     class RefName
+        # Makes RefName mutable.
+
         # Sets the base reference.
         def set_ref!(ref)
             # Check and set the accessed reference.
@@ -1985,11 +1925,8 @@ module HDLRuby::Low
     end
 
 
-    ## 
-    # Describe a this reference.
-    #
-    # This is the current system.
     class RefThis
+        ## Makes RefThis mutable.
 
         # Maps on the children.
         def map_nodes!(&ruby_block)
@@ -1999,11 +1936,9 @@ module HDLRuby::Low
         alias_method :map_expressions!, :map_nodes!
     end
 
-    ##
-    # Describes a string.
-    #
-    # NOTE: This is not synthesizable!
+
     class StringE
+        ## Makes StringE mutable.
         
         # Maps on the arguments.
         def map_args!(&ruby_block)

data/lib/HDLRuby/hruby_low_resolve.rb

@@ -1,6 +1,8 @@
 require "HDLRuby/hruby_error"
 
 
+module HDLRuby::Low
+
 
 ##
 # Adds methods for finding objects through names.
@@ -8,12 +10,11 @@ require "HDLRuby/hruby_error"
 # NOTE: For now only resolve name reference.
 #
 ########################################################################
-module HDLRuby::Low
 
-    ##
-    #  Extends SystemT with the capability of finding one of its inner object
-    #  by name.
+
     class SystemT
+        ## Extends SystemT with the capability of finding one of its inner
+        #  object by name.
         
         ## Find an inner object by +name+.
         #  NOTE: return nil if not found.
@@ -31,10 +32,9 @@ module HDLRuby::Low
     end
 
 
-    ##
-    #  Extends Scope with the capability of finding one of its inner object
-    #  by name.
     class Scope
+        ## Extends Scope with the capability of finding one of its inner object
+        #  by name.
         
         ## Find an inner object by +name+.
         #  NOTE: return nil if not found.
@@ -55,10 +55,10 @@ module HDLRuby::Low
         end
     end
 
-    ##
-    #  Extends Behavior with the capability of finding one of its inner object
-    #  by name.
+
     class Behavior
+        ## Extends Behavior with the capability of finding one of its inner
+        #  object by name.
         
         ## Find an inner object by +name+.
         #  NOTE: return nil if not found.
@@ -70,10 +70,10 @@ module HDLRuby::Low
         end
     end
 
-    ##
-    #  Extends SystemI with the capability of finding one of its inner object
-    #  by name.
+    
     class SystemI
+        ## Extends SystemI with the capability of finding one of its inner object
+        #  by name.
         
         ## Find an inner object by +name+.
         #  NOTE: return nil if not found.
@@ -84,10 +84,9 @@ module HDLRuby::Low
     end
 
 
-    ##
-    #  Extends Block with the capability of finding one of its inner object
-    #  by name.
     class Block
+        ## Extends Block with the capability of finding one of its inner object
+        #  by name.
         
         ## Find an inner object by +name+.
         #  NOTE: return nil if not found.
@@ -109,10 +108,9 @@ module HDLRuby::Low
     end
 
 
-    ##
-    #  Extends SignalI with the capability of finding one of its inner object
-    #  by name.
     class SignalI
+        ## Extends SignalI with the capability of finding one of its inner object
+        #  by name.
         
         ## Find an inner object by +name+.
         #  NOTE: return nil if not found.
@@ -123,10 +121,10 @@ module HDLRuby::Low
 
 
 
-    ##
-    #  Extends RefIndex with the capability of finding the object it
-    #  refered to.
     class Ref
+        ## Extends RefIndex with the capability of finding the object it
+        #  refered to.
+
         ## Resolves the name of the reference (if any) and return the
         #  corresponding object.
         #  NOTE: return nil if could not resolve.
@@ -137,10 +135,9 @@ module HDLRuby::Low
     end
 
 
-    ##
-    #  Extends RefIndex with the capability of finding the object it
-    #  refered to.
     class RefIndex
+        ## Extends RefIndex with the capability of finding the object it
+        #  refered to.
 
         ## Tells if it is a reference to a systemI signal.
         def from_systemI?
@@ -156,10 +153,9 @@ module HDLRuby::Low
     end
 
 
-    ##
-    #  Extends RefRange with the capability of finding the object it
-    #  refered to.
     class RefRange
+        ## Extends RefRange with the capability of finding the object it
+        #  refered to.
 
         ## Tells if it is a reference to a systemI signal.
         def from_systemI?
@@ -175,10 +171,9 @@ module HDLRuby::Low
     end
 
     
-    ##
-    #  Extends RefName with the capability of finding the object it
-    #  refered to.
     class RefName
+        ## Extends RefName with the capability of finding the object it
+        #  refered to.
 
         ## Tells if it is a reference to a systemI signal.
         def from_systemI?