Module: HDLRuby::High::Htype

Includes:
Tprocess
Included in:
Type, TypeDef, TypeStruct, TypeTuple, TypeVector
Defined in:
lib/HDLRuby/hruby_high.rb,
lib/HDLRuby/std/sequencer_sync.rb

Overview

Enhance the Htype module for creating a shared signal.

Constant Summary collapse

High = 
HDLRuby::High

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Tprocess

#&, #*, #+, #+@, #-@, #/, #<<, #==, #abs, #lr, #make, #resolve, #slice, #~

Class Method Details

.included(base) ⇒ Object

Ensures initialize registers the type name



1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
 
# File 'lib/HDLRuby/hruby_high.rb', line 1759

def self.included(base) # built-in Ruby hook for modules
    base.class_eval do    
        original_method = instance_method(:initialize)
        define_method(:initialize) do |*args, &block|
            original_method.bind(self).call(*args, &block)
            # Registers the name (if not empty).
            self.register(name) unless name.empty?
        end
    end
end

Instance Method Details

#[](rng) ⇒ Object

Creates a new vector type of range +rng+ and with current type as base.



1840
1841
1842
 
# File 'lib/HDLRuby/hruby_high.rb', line 1840

def [](rng)
    return TypeVector.new(:"",self,rng)
end

#binary(operator, expr0, expr1) ⇒ Object

Performs binary operation +operator+ on expressions +expr0+ and +expr1+.



1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
 
# File 'lib/HDLRuby/hruby_high.rb', line 1899

def binary(operator, expr0, expr1)
    # Look for a specific computation method.
    comp = comp_operator(operator)
    if self.respond_to?(comp) then
        # Found, use it.
        self.send(comp,expr0,expr1)
    else
        # Not found, back to default generation of binary expression.
        return Binary.new(self.send(operator,expr1.type),operator,
                          expr0,expr1)
    end
end

#comp_operator(op) ⇒ Object

Gets the computation method for +operator+.



1880
1881
1882
 
# File 'lib/HDLRuby/hruby_high.rb', line 1880

def comp_operator(op)
    return (op.to_s + ":C").to_sym
end

#constant(hsh) ⇒ Object

Declares high-level untyped constant signals by name and value given by +hsh+ of the current type.



1873
1874
1875
 
# File 'lib/HDLRuby/hruby_high.rb', line 1873

def constant(hsh)
    High.top_user.make_constants(self,hsh)
end

#define_operator(operator, &ruby_block) ⇒ Object

Redefinition of +operator+.



1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
 
# File 'lib/HDLRuby/hruby_high.rb', line 1913

def define_operator(operator,&ruby_block)
    # Ensure there is a block.
    ruby_block = proc {} unless block_given?
    # Register the operator as overloaded.
    @overloads ||= {}
    @overloads[operator] = ruby_block
    # Set the new method for the operator.
    self.define_singleton_method(comp_operator(operator)) do |*args|
        # puts "Top user=#{HDLRuby::High.top_user}"
        HDLRuby::High.top_user.sub(HDLRuby.uniq_name) do
            ruby_block.call(*args)
        end
    end
end

#define_operator_with_context(operator, &ruby_block) ⇒ Object

Redefinition of +operator+ when requiring the context to be passed as argument (normally only used internally).



1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
 
# File 'lib/HDLRuby/hruby_high.rb', line 1930

def define_operator_with_context(operator,&ruby_block)
    # Ensure there is a block.
    ruby_block = proc {} unless block_given?
    # Register the operator as overloaded.
    @overloads ||= {}
    @overloads[operator] = ruby_block
    # Set the new method for the operator.
    self.define_singleton_method(comp_operator(operator)) do |*args|
        # puts "Top user=#{HDLRuby::High.top_user}"
        HDLRuby::High.top_user.sub(HDLRuby.uniq_name) do
            # It is assumed that the first argument of the ruby_block
            # is the context in which it must be executed.
            ruby_block.call(self,*args)
        end
    end
end

#each_overload(&ruby_block) ⇒ Object

Interates over the overloaded operators.



1948
1949
1950
1951
1952
1953
 
# File 'lib/HDLRuby/hruby_high.rb', line 1948

def each_overload(&ruby_block)
    # No ruby block? Return an enumerator.
    return to_enum(:each_overload) unless ruby_block
    # A block? Apply it on each overload if any.
    @overloads.each(&ruby_block) if @overloads
end

#htype? ⇒ Boolean

Tells htype has been included.

Returns:

  • (Boolean) 


1771
1772
1773
 
# File 'lib/HDLRuby/hruby_high.rb', line 1771

def htype?
    return true
end

#inner(*names) ⇒ Object

Declares high-level untyped inner signals named +names+ of the current type.



1867
1868
1869
 
# File 'lib/HDLRuby/hruby_high.rb', line 1867

def inner(*names)
    High.top_user.make_inners(self,*names)
end

#inout(*names) ⇒ Object

Declares high-level untyped inout signals named +names+ of the current type.



1860
1861
1862
1863
 
# File 'lib/HDLRuby/hruby_high.rb', line 1860

def inout(*names)
    # High.top_user.make_inouts(self.instantiate,*names)
    High.top_user.make_inouts(self,*names)
end

#input(*names) ⇒ Object

Declares high-level input signals named +names+ of the current type.



1847
1848
1849
 
# File 'lib/HDLRuby/hruby_high.rb', line 1847

def input(*names)
    High.top_user.make_inputs(self,*names)
end

#left ⇒ Object

Gets the type as left value.

NOTE: used for asymetric types like TypeSystemI.



1813
1814
1815
1816
 
# File 'lib/HDLRuby/hruby_high.rb', line 1813

def left
    # By default self.
    self
end

#name=(name) ⇒ Object

Sets the +name+.

NOTE: can only be done if the name is not already set.



1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
 
# File 'lib/HDLRuby/hruby_high.rb', line 1784

def name=(name)
    unless @name.empty? then
        raise AnyError, "Name of type already set to: #{@name}."
    end
    # Checks and sets the name.
    name = name.to_sym
    if name.empty? then
        raise AnyError, "Cannot set an empty name."
    end
    @name = name
    # Registers the name.
    self.register(name)
end

#output(*names) ⇒ Object

Declares high-level untyped output signals named +names+ of the current type.



1853
1854
1855
1856
 
# File 'lib/HDLRuby/hruby_high.rb', line 1853

def output(*names)
    # High.top_user.make_outputs(self.instantiate,*names)
    High.top_user.make_outputs(self,*names)
end

#register(name) ⇒ Object

Register the +name+ of the type.



1799
1800
1801
1802
1803
1804
1805
1806
1807
 
# File 'lib/HDLRuby/hruby_high.rb', line 1799

def register(name)
    if self.name.empty? then
        raise AnyError, "Cannot register with empty name."
    else
        # Sets the hdl-like access to the type.
        obj = self # For using the right self within the proc
        High.space_reg(name) { obj }
    end
end

#right ⇒ Object

Gets the type as right value.

NOTE: used for asymetric types like TypeSystemI.



1821
1822
1823
1824
 
# File 'lib/HDLRuby/hruby_high.rb', line 1821

def right
    # By default self.
    self
end

#shared(*args) ⇒ Object

Create new shared signals from +args+. +args+ can be a name of list of names or a hash associating names to default values.



360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/HDLRuby/std/sequencer_sync.rb', line 360

def shared(*args)
    # # Process the arguments.
    # Create the shared signal.
    sig = nil
    args.each do |arg|
        if arg.is_a?(Hash) then
            arg.each do |k,v|
                sig = SharedSignalI.new(self,k,v)
            end
        else
            sig = SharedSignalI.new(self,arg)
        end
    end
    return sig
end

#to_type ⇒ Object

Converts to a type. Returns self since it is already a type.



1777
1778
1779
 
# File 'lib/HDLRuby/hruby_high.rb', line 1777

def to_type
    return self
end

#typedef(name) ⇒ Object

Declares a new type definition with +name+ equivalent to current one.



1829
1830
1831
1832
1833
1834
1835
1836
 
# File 'lib/HDLRuby/hruby_high.rb', line 1829

def typedef(name)
    # Create the new type.
    typ = TypeDef.new(name,self)
    # Register it.
    High.space_reg(name) { typ }
    # Return it.
    return typ
end

#unary(operator, expr) ⇒ Object

Performs unary operation +operator+ on expression +expr+.



1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
 
# File 'lib/HDLRuby/hruby_high.rb', line 1885

def unary(operator,expr)
    # Look for a specific computation method.
    comp = comp_operator(operator)
    if self.respond_to?(comp) then
        # Found, use it.
        self.send(comp,expr)
    else
        # Not found, back to default generation of unary expression.
        return Unary.new(self.send(operator),operator,expr)
    end
end