HDLRuby 2.11.12 → 3.1.0

data/lib/HDLRuby/hruby_low_with_bool.rb

@@ -2,6 +2,9 @@ require "HDLRuby/hruby_error"
 require "HDLRuby/hruby_low_mutable"
 
 
+module HDLRuby::Low
+
+
 ##
 # Provides a new boolean type and converts the comparison and operations
 # on it to this new type.
@@ -12,10 +15,11 @@ require "HDLRuby/hruby_low_mutable"
 #       * Boolean is weak in type promotion, e.g.: boolean & bit = bit
 #
 ########################################################################
-module HDLRuby::Low
 
-    # Extend Type with check telling if it is a boolean type.
+
     class Type
+        ## Extend Type with check telling if it is a boolean type.
+
         # Tells if it is a boolean type.
         def boolean?
             return false
@@ -50,9 +54,10 @@ module HDLRuby::Low
     end
 
 
-    ## Extends the SystemT class for converting types of comparison and
-    #  operations on it to boolean type.
     class SystemT
+        ## Extends the SystemT class for converting types of comparison and
+        #  operations on it to boolean type.
+
         # Converts to a variable-compatible system.
         #
         # NOTE: the result is the same systemT.
@@ -65,9 +70,11 @@ module HDLRuby::Low
         end
     end
 
-    ## Extends the Behaviour class for converting types of comparison and
-    #  operations on it to boolean type.
+
     class Behavior
+        ## Extends the Behaviour class for converting types of comparison and
+        #  operations on it to boolean type.
+
         # Converts to a variable-compatible system.
         #
         # NOTE: the result is the same Behaviour.
@@ -76,9 +83,11 @@ module HDLRuby::Low
         end
     end
 
-    ## Extends the Statement class for converting types of comparison and
-    #  operations on it to boolean type.
+
     class Statement
+        ## Extends the Statement class for converting types of comparison and
+        #  operations on it to boolean type.
+
         # Converts to a variable-compatible system.
         #
         # NOTE: the result is the same Behaviour.
@@ -91,27 +100,33 @@ module HDLRuby::Low
         end
     end
 
-    ## Extends the Expression class for checking if it a boolean expression
-    #  or not.
+
     class Expression
+        ## Extends the Expression class for checking if it a boolean expression
+        #  or not.
+
         # Tells if the expression is boolean.
         def boolean?
             return false
         end
     end
 
-    ## Extends the Unary class for checking if it is a boolean expression
-    #  or not.
+
     class Unary
+        ## Extends the Unary class for checking if it is a boolean expression
+        #  or not.
+
         # Tells if the expression is boolean.
         def boolean?
             return self.child.boolean?
         end
     end
 
-    ## Extends the Binary class for checking if it is a boolean expression
-    #  or not.
+
     class Binary
+        ## Extends the Binary class for checking if it is a boolean expression
+        #  or not.
+
         # Tells if the expression is boolean.
         def boolean?
             case(self.operator)
@@ -128,9 +143,11 @@ module HDLRuby::Low
         end
     end
 
-    ## Extends the Select class for checking if it a boolean epression
-    #  or not.
+
     class Select
+        ## Extends the Select class for checking if it a boolean epression
+        #  or not.
+
         # Tells if the expression is boolean.
         def boolean?
             # Boolean if all the choices are boolean.

data/lib/HDLRuby/hruby_low_with_port.rb

@@ -20,8 +20,8 @@ module HDLRuby::Low
 
     
 
-    ## Extends SystemT with generation of port wires.
     class SystemT
+        ## Extends SystemT with generation of port wires.
 
         # Converts to a port-compatible system.
         #
@@ -33,8 +33,8 @@ module HDLRuby::Low
     end
 
 
-    ## Extends the Scope class with retrival conversion to symbol.
     class Scope
+        ## Extends the Scope class with retrival conversion to symbol.
 
         # Converts a port wire to a reference to it.
         def portw2ref(portw)
@@ -170,8 +170,8 @@ module HDLRuby::Low
 
 
 
-    ## Extends SystemT with generation of port wires.
     class SystemI
+        ## Extends SystemT with generation of port wires.
 
         def with_port!
             self.systemT.with_port!

data/lib/HDLRuby/hruby_low_with_var.rb

@@ -4,6 +4,8 @@ require "HDLRuby/hruby_low2sym"
 require "HDLRuby/hruby_low2seq"
 
 
+module HDLRuby::Low
+
 ##
 # Explicitely seperate variables from signals in an HDLRuby::Low
 # description.
@@ -11,10 +13,12 @@ require "HDLRuby/hruby_low2seq"
 # NOTE: variable and signal are to be taken in the VHDL meaning.
 #
 ########################################################################
-module HDLRuby::Low
 
-    ## Extends the SystemT class with separation between signals and variables.
+
     class SystemT
+        ## Extends the SystemT class with separation between signals and
+        #  variables.
+
         # Converts to a variable-compatible system.
         #
         # NOTE: the result is the same systemT.
@@ -25,8 +29,10 @@ module HDLRuby::Low
     end
 
 
-    ## Extends the SystemI class with separation between signals and variables.
     class SystemI
+        ## Extends the SystemI class with separation between signals and
+        #  variables.
+
         # Converts to a variable-compatible system.
         #
         # NOTE: the result is the same systemT.
@@ -37,8 +43,10 @@ module HDLRuby::Low
     end
 
 
-    ## Extends the Behavior class with separation between signals and variables.
     class Behavior
+        ## Extends the Behavior class with separation between signals and
+        #  variables.
+
         # Converts to a variable-compatible behavior.
         #
         # NOTE: the result is the same systemT.
@@ -50,8 +58,9 @@ module HDLRuby::Low
     end
 
 
-    ## Extends the Block class with separation between signals and variables.
     class Block
+        ## Extends the Block class with separation between signals and variables.
+
 
         # Converts a variable to a reference to it.
         def var2ref(var)
@@ -248,8 +257,10 @@ module HDLRuby::Low
     end
 
 
-    ## Extends the TimeBlock class with separation between signals and variables.
     class TimeBlock
+        ## Extends the TimeBlock class with separation between signals and
+        #  variables.
+
         # Converts to a variable-compatible block where +upper+ is
         # the upper block if any.
         #
@@ -262,8 +273,9 @@ module HDLRuby::Low
     end
 
 
-    ## Extends the If class with separation between signals and variables.
     class If
+        ## Extends the If class with separation between signals and variables.
+
         # Converts to a variable-compatible if where +upper+ is
         # the upper block if any.
         #
@@ -290,8 +302,9 @@ module HDLRuby::Low
     end
 
 
-    ## Extends the When class with separation between signals and variables.
     class When
+        ## Extends the When class with separation between signals and variables.
+
         # Converts to a variable-compatible case where +upper+ is
         # the upper block if any.
         #
@@ -302,8 +315,9 @@ module HDLRuby::Low
     end
 
 
-    ## Extends the Case class with separation between signals and variables.
     class Case
+        ## Extends the Case class with separation between signals and variables.
+
         # Converts to a variable-compatible case where +upper+ is
         # the upper block if any.
         #

data/lib/HDLRuby/hruby_low_without_concat.rb

@@ -7,15 +7,15 @@ module HDLRuby::Low
 
 
 ##
-# Breaks the concat assigments.
+# Breaks the concat assignments.
 # Makes handling by some synthesis tools easier.
 #
 ########################################################################
     
 
-    ## Extends the SystemT class with functionality for breaking assingments
-    #  to concats.
     class SystemT
+        ## Extends the SystemT class with functionality for breaking assignments
+        #  to concats.
 
         # Breaks the assignments to concats.
         def break_concat_assigns!
@@ -34,9 +34,10 @@ module HDLRuby::Low
     end
 
 
-    ## Extends the Scope class with functionality for breaking assingments
-    #  to concats.
     class Scope
+        ## Extends the Scope class with functionality for breaking assignments
+        #  to concats.
+
         # Breaks the assignments to concats.
         def break_concat_assigns!
             # Recruse on the sub scopes.
@@ -102,9 +103,11 @@ module HDLRuby::Low
         end
     end
 
-    ## Extends the Behavior class with functionality for breaking assingments
-    #  to concats.
+
     class Behavior
+        ## Extends the Behavior class with functionality for breaking assignments
+        #  to concats.
+
         # Breaks the assignments to concats.
         def break_concat_assigns!
             # Recruse on the block.
@@ -114,9 +117,10 @@ module HDLRuby::Low
 
 
 
-    ## Extends the Block class with functionality for breaking assingments
-    #  to concats.
     class Block
+        ## Extends the Block class with functionality for breaking assignments
+        #  to concats.
+
         # Breaks the assignments to concats.
         #
         # NOTE: work on the direct sub statement only, not deeply.
@@ -142,9 +146,10 @@ module HDLRuby::Low
     end
 
 
-    ## Extends the Transmit class with functionality for breaking assingments
-    #  to concats.
     class Transmit
+        ## Extends the Transmit class with functionality for breaking assignments
+        #  to concats.
+
         # Break the assignments to concats.
         #
         # NOTE: when breaking generates a new Block containing the broken
@@ -235,9 +240,10 @@ module HDLRuby::Low
     end
 
 
-    ## Extends the Connection class with functionality for breaking assingments
-    #  to concats.
     class Connection
+        ## Extends the Connection class with functionality for breaking
+        #  assignments to concats.
+
         # Break the assignments to concats.
         #
         # NOTE: when breaking generates a new Block containing the broken

data/lib/HDLRuby/hruby_low_without_namespace.rb

@@ -27,9 +27,10 @@ module HDLRuby::Low
         end
     end
 
-    ## Extends the SystemT class with functionality for moving the declarations
-    #  to the upper namespace.
+
     class SystemT
+        ## Extends the SystemT class with functionality for moving the
+        #  declarations to the upper namespace.
 
         include ForceName
 
@@ -78,9 +79,10 @@ module HDLRuby::Low
         end
     end
 
-    ## Extends the Scope class with functionality for moving the declarations
-    #  to the upper namespace.
+
     class Scope
+        ## Extends the Scope class with functionality for moving the declarations
+        #  to the upper namespace.
 
         include ForceName
 
@@ -280,9 +282,10 @@ module HDLRuby::Low
         end
     end
 
-    ## Extends the Type class with functionality for breaking hierarchical
-    #  types.
+
     class Type
+        ## Extends the Type class with functionality for breaking hierarchical
+        #  types.
 
         # Breaks the hierarchical types into sequences of type definitions.
         # Assumes to_upper_space! has been called before.
@@ -293,9 +296,10 @@ module HDLRuby::Low
         end
     end
 
-    ## Extends the TypeVector class with functionality for breaking hierarchical
-    #  types.
+
     class TypeVector
+        ## Extends the TypeVector class with functionality for breaking hierarchical
+        #  types.
 
         # Breaks the hierarchical types into sequences of type definitions.
         # Assumes to_upper_space! has been called before.
@@ -333,9 +337,10 @@ module HDLRuby::Low
         end
     end
 
-    ## Extends the TypeTuple class with functionality for breaking hierarchical
-    #  types.
+
     class TypeTuple
+        ## Extends the TypeTuple class with functionality for breaking
+        #  hierarchical types.
 
         # Breaks the hierarchical types into sequences of type definitions.
         # Assumes to_upper_space! has been called before.
@@ -365,9 +370,10 @@ module HDLRuby::Low
         end
     end
 
-    ## Extends the TypeStruct class with functionality for breaking hierarchical
-    #  types.
+
     class TypeStruct
+        ## Extends the TypeStruct class with functionality for breaking
+        #  hierarchical types.
 
         # Breaks the hierarchical types into sequences of type definitions.
         # Assumes to_upper_space! has been called before.
@@ -397,9 +403,10 @@ module HDLRuby::Low
         end
     end
 
-    ## Extends the SignalI class with functionality for moving the declarations
-    #  to the upper namespace.
+
     class SignalI
+        ## Extends the SignalI class with functionality for moving the
+        #  declarations to the upper namespace.
 
         # Replaces recursively +former+ name by +nname+ until it is redeclared.
         def replace_names!(former,nname)
@@ -412,9 +419,10 @@ module HDLRuby::Low
         end
     end
 
-    ## Extends the SystemI class with functionality for moving the declarations
-    #  to the upper namespace.
+
     class SystemI
+        ## Extends the SystemI class with functionality for moving the
+        #  declarations to the upper namespace.
 
         # Replaces recursively +former+ name by +nname+ until it is redeclared.
         def replace_names!(former,nname)
@@ -429,9 +437,9 @@ module HDLRuby::Low
     end
 
 
-    ## Extends the Behavior class with functionality for moving the declarations
-    #  to the upper namespace.
     class Behavior
+        ## Extends the Behavior class with functionality for moving the
+        #  declarations to the upper namespace.
 
         # Moves the declarations to the upper namespace.
         def to_upper_space!
@@ -454,9 +462,10 @@ module HDLRuby::Low
         end
     end
 
-    ## Extends the Statement class with functionality for moving the
-    #  declarations to the upper namespace.
+
     class Statement
+        ## Extends the Statement class with functionality for moving the
+        #  declarations to the upper namespace.
 
         # Moves the declarations to the upper namespace.
         def to_upper_space!
@@ -491,9 +500,10 @@ module HDLRuby::Low
         end
     end
 
-    ## Extends the Expression class with functionality for moving the
-    #  declarations  to the upper namespace.
+
     class Expression
+        ## Extends the Expression class with functionality for moving the
+        #  declarations to the upper namespace.
 
         # Replaces recursively +former+ name by +nname+ until it is redeclared.
         def replace_names!(former,nname)
@@ -518,10 +528,11 @@ module HDLRuby::Low
             end
         end
     end
+
     
-    ## Extends the If class with functionality for moving the declarations
-    #  to the upper namespace.
     class If
+        ## Extends the If class with functionality for moving the declarations
+        #  to the upper namespace.
 
         # Moves the declarations to the upper namespace.
         def to_upper_space!
@@ -569,9 +580,10 @@ module HDLRuby::Low
         end
     end
 
-    ## Extends the When class with functionality for moving the declarations
-    #  to the upper namespace.
+
     class When
+        ## Extends the When class with functionality for moving the declarations
+        #  to the upper namespace.
 
         # Moves the declarations to the upper namespace.
         def to_upper_space!
@@ -608,9 +620,10 @@ module HDLRuby::Low
         end
     end
 
-    ## Extends the When class with functionality for moving the declarations
-    #  to the upper namespace.
+
     class Case
+        ## Extends the When class with functionality for moving the declarations
+        #  to the upper namespace.
 
         # Moves the declarations to the upper namespace.
         def to_upper_space!
@@ -644,9 +657,10 @@ module HDLRuby::Low
         end
     end
 
-    ## Extends the When class with functionality for moving the declarations
-    #  to the upper namespace.
+
     class TimeRepeat
+        ## Extends the When class with functionality for moving the declarations
+        #  to the upper namespace.
 
         # Moves the declarations to the upper namespace.
         def to_upper_space!
@@ -669,9 +683,10 @@ module HDLRuby::Low
         end
     end
 
-    ## Extends the When class with functionality for moving the declarations
-    #  to the upper namespace.
+
     class Block
+        ## Extends the When class with functionality for moving the declarations
+        #  to the upper namespace.
 
         include ForceName
 

data/lib/HDLRuby/hruby_low_without_parinseq.rb

@@ -13,9 +13,9 @@ module HDLRuby::Low
 ########################################################################
     
 
-    ## Extends the SystemT class with functionality for converting par blocks
-    #  within seq blocks to seq blocks.
     class SystemT
+        ## Extends the SystemT class with functionality for converting par blocks
+        #  within seq blocks to seq blocks.
 
         # Converts par blocks within seq blocks to seq blocks.
         def par_in_seq2seq!
@@ -23,9 +23,11 @@ module HDLRuby::Low
         end
     end
 
-    ## Extends the Scope class with functionality for breaking assingments
-    #  to concats.
+
     class Scope
+        ## Extends the Scope class with functionality for converting par blocks
+        #  within seq blocks to seq blocks.
+
         # Converts par blocks within seq blocks to seq blocks.
         def par_in_seq2seq!
             # Recruse on the sub scopes.
@@ -38,9 +40,10 @@ module HDLRuby::Low
     end
 
 
-    ## Extends the Statement class with functionality for breaking assingments
-    #  to concats.
     class Statement
+        ## Extends the Statement class with functionality for converting par 
+        #  blocks within seq blocks to seq blocks.
+ 
         # Converts par blocks within seq blocks to seq blocks.
         def par_in_seq2seq!
             # By default nothing to do.
@@ -55,9 +58,10 @@ module HDLRuby::Low
     end
 
 
-    ## Extends the If class with functionality for breaking assingments
-    #  to concats.
     class If
+        ## Extends the If class with functionality for converting par blocks
+        #  within seq blocks to seq blocks.
+
         # Converts par blocks within seq blocks to seq blocks.
         def par_in_seq2seq!
             self.yes.par_in_seq2seq!
@@ -78,9 +82,10 @@ module HDLRuby::Low
     end
 
 
-    ## Extends the Case class with functionality for breaking assingments
-    #  to concats.
     class Case
+        ## Extends the Case class with functionality for converting par blocks
+        #  within seq blocks to seq blocks.
+
         # Converts par blocks within seq blocks to seq blocks.
         def par_in_seq2seq!
             self.each_when do |w|
@@ -99,9 +104,10 @@ module HDLRuby::Low
     end
 
 
-    ## Extends the Block class with functionality for breaking assingments
-    #  to concats.
     class Block
+        ## Extends the Block class with functionality for converting par blocks
+        #  within seq blocks to seq blocks.
+
         # Converts par blocks within seq blocks to seq blocks.
         def par_in_seq2seq!
             # Recurse on the sub blocks.