Class: HDLRuby::Low::Event

Inherits:
Object
  • Object
show all
Includes:
Hparent, Low2Symbol
Defined in:
lib/HDLRuby/hruby_low.rb,
lib/HDLRuby/hruby_low2c.rb,
lib/HDLRuby/hruby_low2hdr.rb,
lib/HDLRuby/hruby_low2sym.rb,
lib/HDLRuby/hruby_low2vhd.rb,
lib/HDLRuby/hruby_low2high.rb,
lib/HDLRuby/hruby_low_mutable.rb,
lib/HDLRuby/hruby_low_skeleton.rb

Overview

Describes an event.

Direct Known Subclasses

High::Event

Constant Summary

Constants included from Low2Symbol

Low2Symbol::Low2SymbolPrefix, Low2Symbol::Low2SymbolTable, Low2Symbol::Symbol2LowTable

Instance Attribute Summary collapse

Attributes included from Hparent

#parent

Instance Method Summary collapse

Methods included from Low2Symbol

#to_sym

Methods included from Hparent

#absolute_ref, #hierarchy, #no_parent!, #scope

Constructor Details

#initialize(type, ref) ⇒ Event

Creates a new +type+ sort of event on signal refered by +ref+.



2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
 
# File 'lib/HDLRuby/hruby_low.rb', line 2616

def initialize(type,ref)
    # Check and set the type.
    @type = type.to_sym
    # Check and set the reference.
    unless ref.is_a?(Ref)
        raise AnyError, "Invalid class for a reference: #{ref.class}"
    end
    @ref = ref
    # And set the parent of ref.
    ref.parent = self
end

Instance Attribute Details

#ref ⇒ Object (readonly)

The reference of the event.



2613
2614
2615
 
# File 'lib/HDLRuby/hruby_low.rb', line 2613

def ref
  @ref
end

#type ⇒ Object (readonly)

The type of event.



2610
2611
2612
 
# File 'lib/HDLRuby/hruby_low.rb', line 2610

def type
  @type
end

Instance Method Details

#each_deep(&ruby_block) ⇒ Object

Iterates over each object deeply.

Returns an enumerator if no ruby block is given.



2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
 
# File 'lib/HDLRuby/hruby_low.rb', line 2654

def each_deep(&ruby_block)
    # No ruby block? Return an enumerator.
    return to_enum(:each_deep) unless ruby_block
    # A ruby block? First apply it to current.
    ruby_block.call(self)
    # Then apply on the type.
    self.type.each_deep(&ruby_block)
    # Then apply on the reference.
    self.ref.each_deep(&ruby_block)
end

#eql?(obj) ⇒ Boolean

Comparison for hash: structural comparison.

Returns:

  • (Boolean) 


2632
2633
2634
2635
2636
2637
 
# File 'lib/HDLRuby/hruby_low.rb', line 2632

def eql?(obj)
    return false unless obj.is_a?(Event)
    return false unless @type.eql?(obj.type)
    return false unless @ref.eql?(obj.ref)
    return true
end

#hash ⇒ Object

Hash function.



2640
2641
2642
 
# File 'lib/HDLRuby/hruby_low.rb', line 2640

def hash
    return [@type,@ref].hash
end

#on_edge? ⇒ Boolean

Tells if there is a positive or negative edge event.

NOTE: checks if the event type is :posedge or :negedge

Returns:

  • (Boolean) 


2647
2648
2649
 
# File 'lib/HDLRuby/hruby_low.rb', line 2647

def on_edge?
    return (@type == :posedge or @type == :negedge)
end

#reassign_expressions!(node2reassign) ⇒ Object

Replace node by corresponding replacement from +node2reassign+ that is a table whose entries are: +node+ the node to replace +rep+ the replacement of the node +ref+ the reference where to reassign the node.



437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
 
# File 'lib/HDLRuby/hruby_low_mutable.rb', line 437

def reassign_expressions!(node2reassign)
    # Build the replacement table.
    node2rep = node2reassign.map {|n,r| [n,r[0]] }.to_h

    # Performs the replacement.
    node2rep_done = {} # The performed replacements.
    # Replace on the sons of the reference.
    node2rep_done.merge!(self.ref.replace_expressions!(node2rep))
    # Shall we replace the ref?
    rep = node2rep[self.ref]
    if rep then
        # Yes, do it.
        rep = rep.clone
        node = self.ref
        # node.set_parent!(nil)
        self.set_ref!(rep)
        node2rep_done[node] = rep
    end

    # Assign the replaced nodes.
    node2rep_done.each do |node,rep|
        reassign = node2reassign[node][1].clone
        self.parent.parent.
            add_connection(Connection.new(reassign,node.clone))
    end
end

#set_ref!(ref) ⇒ Object

Sets the reference to +ref+.



424
425
426
427
428
429
430
 
# File 'lib/HDLRuby/hruby_low_mutable.rb', line 424

def set_ref!(ref)
    # Check and set the reference.
    unless ref.is_a?(Ref)
        raise AnyError, "Invalid class for a reference: #{ref.class}"
    end
    @ref = ref
end

#set_type!(type) ⇒ Object

Sets the type.



418
419
420
421
 
# File 'lib/HDLRuby/hruby_low_mutable.rb', line 418

def set_type!(type)
    # Check and set the type.
    @type = type.to_sym
end

#to_c(res, level = 0) ⇒ Object

Generates the C text of the equivalent HDLRuby code. +level+ is the hierachical level of the object. def to_c(level = 0)



863
864
865
866
867
868
869
870
871
872
873
 
# File 'lib/HDLRuby/hruby_low2c.rb', line 863

def to_c(res,level = 0)
    edge = "ANYEDGE"
    edge = "POSEDGE" if self.type == :posedge
    edge = "NEGEDGE" if self.type == :negedge
    # return "make_event(#{edge}," +
    #        "#{self.ref.resolve.to_c_signal(level+1)})"
    res << "make_event(#{edge},"
    self.ref.resolve.to_c_signal(res,level+1)
    res << ")"
    return res
end

#to_hdr(level = 0) ⇒ Object

Generates the text of the equivalent hdr text. +level+ is the hierachical level of the object.



298
299
300
 
# File 'lib/HDLRuby/hruby_low2hdr.rb', line 298

def to_hdr(level = 0)
    return self.ref.to_hdr(level) + ".#{self.type}"
end

#to_high ⇒ Object

Creates a new high event.



168
169
170
 
# File 'lib/HDLRuby/hruby_low2high.rb', line 168

def to_high
    return HDLRuby::High::Event.new(self.type.to_high,self.ref.to_high)
end