Module: HDLRuby::High::HBlock

Includes:
HScope_missing, Hmux
Included in:
Block, TimeBlock
Defined in:
lib/HDLRuby/hruby_high.rb

Overview

Module giving the properties of a high-level block.

Constant Summary collapse

High =
HDLRuby::High

Constants included from Hmissing

HDLRuby::High::Hmissing::NAMES

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Hmux

#mux

Methods included from HScope_missing

#h_missing, #method_missing

Methods included from Hmissing

#method_missing

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class HDLRuby::High::HScope_missing

Instance Attribute Details

#namespaceObject (readonly)

The namespace



3846
3847
3848
# File 'lib/HDLRuby/hruby_high.rb', line 3846

def namespace
  @namespace
end

#return_valueObject (readonly)

The return value when building the scope.



3849
3850
3851
# File 'lib/HDLRuby/hruby_high.rb', line 3849

def return_value
  @return_value
end

Instance Method Details

#add_block(mode = nil, name = :"", &ruby_block) ⇒ Object

Creates and adds a new block executed in +mode+, with possible +name+ and built by executing +ruby_block+.



3880
3881
3882
3883
3884
3885
3886
3887
# File 'lib/HDLRuby/hruby_high.rb', line 3880

def add_block(mode = nil, name = :"", &ruby_block)
    # Creates the block.
    block = High.make_block(mode,name,&ruby_block)
    # Adds it as a statement.
    self.add_statement(block)
    # Use its return value.
    return block.return_value
end

#build(&ruby_block) ⇒ Object Also known as: open

Build the block by executing +ruby_block+.



3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
# File 'lib/HDLRuby/hruby_high.rb', line 3852

def build(&ruby_block)
    High.space_push(@namespace)
    @return_value = High.top_user.instance_eval(&ruby_block)
    High.space_pop
    # if @return_value.is_a?(HExpression) then
    #     res = @return_value
    #     High.space_push(@namespace)
    #     @return_value = res.type.inner(HDLRuby.uniq_name)
    #     puts "@return_value name=#{@return_value.name}"
    #     @return_value <= res
    #     High.space_pop
    #     @return_value = RefObject.new(self,@return_value)
    # end
    @return_value
end

#cur_behaviorObject

Gets the current behavior.



3934
3935
3936
# File 'lib/HDLRuby/hruby_high.rb', line 3934

def cur_behavior
    return HDLRuby::High.cur_behavior
end

#cur_blockObject

Gets the current block.



3924
3925
3926
# File 'lib/HDLRuby/hruby_high.rb', line 3924

def cur_block
    return HDLRuby::High.cur_block
end

#cur_scopeObject

Gets the current scope.



3939
3940
3941
# File 'lib/HDLRuby/hruby_high.rb', line 3939

def cur_scope
    return HDLRuby::High.cur_scope
end

#cur_systemObject

Gets the current system.



3944
3945
3946
# File 'lib/HDLRuby/hruby_high.rb', line 3944

def cur_system
    return HDLRuby::High.cur_system
end

#hcase(value) ⇒ Object

Creates a new case statement with a +value+ used for deciding which block to execute.

NOTE: the when part is defined through the hwhen method.



4005
4006
4007
4008
# File 'lib/HDLRuby/hruby_high.rb', line 4005

def hcase(value)
    # Creates the case statement.
    self.add_statement(Case.new(value))
end

#helse(mode = nil, &ruby_block) ⇒ Object

Sets the block executed when the condition is not met to the block in +mode+ generated by the execution of +ruby_block+.

Can only be used once.



3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
# File 'lib/HDLRuby/hruby_high.rb', line 3969

def helse(mode = nil, &ruby_block)
    # Ensure there is a block.
    ruby_block = proc {} unless block_given?
    # There is a ruby_block: the helse is assumed to be with
    # the hif in the same block.
    # Completes the hif or the hcase statement.
    statement = @statements.last
    unless statement.is_a?(If) or statement.is_a?(Case) then
        raise AnyError, "Error: helse statement without hif nor hcase (#{statement.class})."
    end
    statement.helse(mode, &ruby_block)
end

#helsif(condition, mode = nil, &ruby_block) ⇒ Object

Sets the condition check when the condition is not met to the block, with a +condition+ that when met lead to the execution of the block in +mode+ generated by the +ruby_block+.



3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
# File 'lib/HDLRuby/hruby_high.rb', line 3985

def helsif(condition, mode = nil, &ruby_block)
    # Ensure there is a block.
    ruby_block = proc {} unless block_given?
    # There is a ruby_block: the helse is assumed to be with
    # the hif in the same block.
    # Completes the hif statement.
    statement = @statements.last
    unless statement.is_a?(If) then
        raise AnyError,
             "Error: helsif statement without hif (#{statement.class})."
    end
    statement.helsif(condition, mode, &ruby_block)
end

#hif(condition, mode = nil, &ruby_block) ⇒ Object

Creates a new if statement with a +condition+ that when met lead to the execution of the block in +mode+ generated by the +ruby_block+.

NOTE: the else part is defined through the helse method.



3958
3959
3960
3961
3962
3963
# File 'lib/HDLRuby/hruby_high.rb', line 3958

def hif(condition, mode = nil, &ruby_block)
    # Ensure there is a block.
    ruby_block = proc {} unless block_given?
    # Creates the if statement.
    self.add_statement(If.new(condition,mode,&ruby_block))
end

#hprint(*args) ⇒ Object

Prints.



4030
4031
4032
# File 'lib/HDLRuby/hruby_high.rb', line 4030

def hprint(*args)
    self.add_statement(Print.new(*args))
end

#hwhen(match, mode = nil, &ruby_block) ⇒ Object

Sets the block of a case structure executed when the +match+ is met to the block in +mode+ generated by the execution of +ruby_block+.

Can only be used once.



4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
# File 'lib/HDLRuby/hruby_high.rb', line 4014

def hwhen(match, mode = nil, &ruby_block)
    # Ensure there is a block.
    ruby_block = proc {} unless block_given?
    # There is a ruby_block: the helse is assumed to be with
    # the hif in the same block.
    # Completes the hcase statement.
    statement = @statements.last
    unless statement.is_a?(Case) then
        raise AnyError,
            "Error: hwhen statement without hcase (#{statement.class})."
    end
    statement.hwhen(match, mode, &ruby_block)
end

#par(name = :"", &ruby_block) ⇒ Object

Creates a new parallel block with possible +name+ and built from +ruby_block+.



3891
3892
3893
3894
# File 'lib/HDLRuby/hruby_high.rb', line 3891

def par(name = :"", &ruby_block)
    return :par unless ruby_block
    self.add_block(:par,name,&ruby_block)
end

#seq(name = :"", &ruby_block) ⇒ Object

Creates a new sequential block with possible +name+ and built from +ruby_block+.



3898
3899
3900
3901
# File 'lib/HDLRuby/hruby_high.rb', line 3898

def seq(name = :"", &ruby_block)
    return :seq unless ruby_block
    self.add_block(:seq,name,&ruby_block)
end

#sub(name = :"", &ruby_block) ⇒ Object

Creates a new block with the current mode with possible +name+ and built from +ruby_block+.



3905
3906
3907
3908
3909
# File 'lib/HDLRuby/hruby_high.rb', line 3905

def sub(name = :"", &ruby_block)
    # Ensure there is a block.
    ruby_block = proc {} unless block_given?
    self.add_block(self.mode,name,&ruby_block)
end

#terminateObject

Terminate the simulation.



4035
4036
4037
# File 'lib/HDLRuby/hruby_high.rb', line 4035

def terminate
    self.add_statement(TimeTerminate.new)
end

#to_refObject

Converts to a new reference.



3872
3873
3874
# File 'lib/HDLRuby/hruby_high.rb', line 3872

def to_ref
    return RefObject.new(this,self)
end

#top_blockObject

Gets the top block of the current behavior.



3929
3930
3931
# File 'lib/HDLRuby/hruby_high.rb', line 3929

def top_block
    return HDLRuby::High.top_block
end

#unshift(&ruby_block) ⇒ Object

Adds statements at the top of the block.



3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
# File 'lib/HDLRuby/hruby_high.rb', line 3912

def unshift(&ruby_block)
    # Ensure there is a block.
    ruby_block = proc {} unless block_given?
    # Create a sub block for the statements.
    block = High.make_block(self.mode,:"",&ruby_block)
    # Unshifts it.
    self.unshift_statement(block)
    # Use its return value.
    return block.return_value
end