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

#namespace ⇒ Object (readonly)

The namespace


4235
4236
4237
 
# File 'lib/HDLRuby/hruby_high.rb', line 4235

def namespace
  @namespace
end

#return_value ⇒ Object (readonly)

The return value when building the scope.


4238
4239
4240
 
# File 'lib/HDLRuby/hruby_high.rb', line 4238

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+.


4269
4270
4271
4272
4273
4274
4275
4276
 
# File 'lib/HDLRuby/hruby_high.rb', line 4269

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+.


4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
 
# File 'lib/HDLRuby/hruby_high.rb', line 4241

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_behavior ⇒ Object

Gets the current behavior.


4323
4324
4325
 
# File 'lib/HDLRuby/hruby_high.rb', line 4323

def cur_behavior
    return HDLRuby::High.cur_behavior
end

#cur_block ⇒ Object

Gets the current block.


4313
4314
4315
 
# File 'lib/HDLRuby/hruby_high.rb', line 4313

def cur_block
    return HDLRuby::High.cur_block
end

#cur_scope ⇒ Object

Gets the current scope.


4328
4329
4330
 
# File 'lib/HDLRuby/hruby_high.rb', line 4328

def cur_scope
    return HDLRuby::High.cur_scope
end

#cur_system ⇒ Object

Gets the current system.


4333
4334
4335
 
# File 'lib/HDLRuby/hruby_high.rb', line 4333

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.


4395
4396
4397
4398
 
# File 'lib/HDLRuby/hruby_high.rb', line 4395

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.


4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
 
# File 'lib/HDLRuby/hruby_high.rb', line 4359

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+.


4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
 
# File 'lib/HDLRuby/hruby_high.rb', line 4375

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 = self.mode, &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. def hif(condition, mode = nil, &ruby_block)


4348
4349
4350
4351
4352
4353
 
# File 'lib/HDLRuby/hruby_high.rb', line 4348

def hif(condition, mode = self.mode, &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.


4420
4421
4422
 
# File 'lib/HDLRuby/hruby_high.rb', line 4420

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.


4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
 
# File 'lib/HDLRuby/hruby_high.rb', line 4404

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+.


4280
4281
4282
4283
 
# File 'lib/HDLRuby/hruby_high.rb', line 4280

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+.


4287
4288
4289
4290
 
# File 'lib/HDLRuby/hruby_high.rb', line 4287

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+.


4294
4295
4296
4297
4298
 
# File 'lib/HDLRuby/hruby_high.rb', line 4294

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

#terminate ⇒ Object

Terminate the simulation.


4425
4426
4427
 
# File 'lib/HDLRuby/hruby_high.rb', line 4425

def terminate
    self.add_statement(TimeTerminate.new)
end

#to_ref ⇒ Object

Converts to a new reference.


4261
4262
4263
 
# File 'lib/HDLRuby/hruby_high.rb', line 4261

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

#top_block ⇒ Object

Gets the top block of the current behavior.


4318
4319
4320
 
# File 'lib/HDLRuby/hruby_high.rb', line 4318

def top_block
    return HDLRuby::High.top_block
end

#unshift(&ruby_block) ⇒ Object

Adds statements at the top of the block.


4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
 
# File 'lib/HDLRuby/hruby_high.rb', line 4301

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