Class: RubyHDL::High::Type

Inherits:
Object
  • Object
show all
Includes:
HDLRuby::Tprocess
Defined in:
lib/HDLRuby/std/sequencer_sw.rb

Overview

Describes a high-level data type.

NOTE: by default a type is not specified.

Direct Known Subclasses

TypeDef, TypeGen, TypeStruct, TypeTuple, TypeVector

Instance Method Summary collapse

Methods included from HDLRuby::Tprocess

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

Constructor Details

#initialize(name = nil) ⇒ Type

Creates a new type named +name+.


582
583
584
585
586
587
588
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 582

def initialize(name = nil)
  if name then
    @name = name.to_sym 
    # Registers the name.
    self.register(name)
  end
end

Instance Method Details

#[](rng) ⇒ Object

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


791
792
793
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 791

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

#base ⇒ Object

Gets the base type, by default base type is not defined.

Raises:


678
679
680
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 678

def base
  raise AnyError, "No base type for type #{self}"
end

#base? ⇒ Boolean

Tells if the type has a base.

Returns:

  • (Boolean) 

673
674
675
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 673

def base?
  return false
end

#binary(operator, expr0, expr1) ⇒ Object

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


850
851
852
853
854
855
856
857
858
859
860
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 850

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 computation.
    expr0.to_value.send(operator,expr1)
  end
end

#comp_operator(op) ⇒ Object

Gets the computation method for +operator+.


831
832
833
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 831

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.


824
825
826
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 824

def constant(hsh)
  RubyHDL::High.top_sblock.make_constants(self,hsh)
end

#define_operator(operator, &ruby_block) ⇒ Object

Redefinition of +operator+.


863
864
865
866
867
868
869
870
871
872
873
874
875
876
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 863

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}"
    RubyHDL::High.top_sblock.sub(RubyHDL.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).


880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 880

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}"
    RubyHDL::High.top_sblock.sub(RubyHDL.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

#direction ⇒ Object

Get the direction of the type, little or big endian.


657
658
659
660
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 657

def direction
  # By default, little endian.
  return :little
end

#each_overload(&ruby_block) ⇒ Object

Interates over the overloaded operators.


898
899
900
901
902
903
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 898

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

#each_type_deep(&ruby_block) ⇒ Object Also known as: each_deep

Iterates over the types deeply if any.


712
713
714
715
716
717
718
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 712

def each_type_deep(&ruby_block)
  # No ruby block? Return an enumerator.
  return to_enum(:each_type_deep) unless ruby_block
  # A ruby block? First apply it to current.
  ruby_block.call(self)
  # And that's all by default.
end

#eql?(obj) ⇒ Boolean

Comparison for hash: structural comparison.

Returns:

  • (Boolean) 

593
594
595
596
597
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 593

def eql?(obj)
  return false unless obj.is_a?(Type)
  return false unless @name.eql?(obj.name)
  return true
end

#equivalent?(type) ⇒ Boolean

Tell if +type+ is equivalent to current type.

NOTE: type can be compatible while not being equivalent, please refer to hruby_types.rb for type compatibility.

Returns:

  • (Boolean) 

706
707
708
709
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 706

def equivalent?(type)
  # By default, types are equivalent iff they have the same name.
  return (type.is_a?(Type) and self.name == type.name)
end

#fixed? ⇒ Boolean

Tells if the type is fixed point.

Returns:

  • (Boolean) 

615
616
617
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 615

def fixed?
  return false
end

#float? ⇒ Boolean

Tells if the type is floating point.

Returns:

  • (Boolean) 

620
621
622
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 620

def float?
  return false
end

#hash ⇒ Object

Hash function.


600
601
602
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 600

def hash
  return [@name].hash
end

#hierarchical? ⇒ Boolean

Tells if the type is hierarchical.

Returns:

  • (Boolean) 

698
699
700
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 698

def hierarchical?
  return self.base? || self.types?
end

#htype? ⇒ Boolean

Tells htype has been included.

Returns:

  • (Boolean) 

727
728
729
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 727

def htype?
  return true
end

#inner(*names) ⇒ Object

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


818
819
820
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 818

def inner(*names)
  RubyHDL::High.top_sblock.make_inners(self,*names)
end

#leaf? ⇒ Boolean

Tells if the type is a leaf.

Returns:

  • (Boolean) 

625
626
627
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 625

def leaf?
  return false
end

#left ⇒ Object

Gets the type as left value.

NOTE: used for asymetric types like TypeSystemI.


764
765
766
767
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 764

def left
  # By default self.
  self
end

#max ⇒ Object

Gets the type max value if any. Default: not defined.

Raises:


646
647
648
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 646

def max
  raise AnyError, "No max value for type #{self}"
end

#min ⇒ Object

Gets the type min value if any. Default: not defined.

Raises:


652
653
654
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 652

def min
  raise AnyError, "No min value for type #{self}"
end

#name=(name) ⇒ Object

Sets the +name+.

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


740
741
742
743
744
745
746
747
748
749
750
751
752
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 740

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

#range ⇒ Object

Gets the range of the type, by default range is not defined.

Raises:


668
669
670
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 668

def range
  raise AnyError, "No range for type #{self}"
end

#range? ⇒ Boolean

Tells if the type has a range.

Returns:

  • (Boolean) 

663
664
665
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 663

def range?
  return false
end

#register(name) ⇒ Object

Register the +name+ of the type.


755
756
757
758
759
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 755

def register(name)
  # Sets the hdl-like access to the type.
  obj = self # For using the right self within the proc
  RubyHDL::High.top_sblock.register(name) { obj }
end

#regular? ⇒ Boolean

Tells if the type is regular (applies for tuples).

Returns:

  • (Boolean) 

688
689
690
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 688

def regular?
  return false
end

#right ⇒ Object

Gets the type as right value.

NOTE: used for asymetric types like TypeSystemI.


772
773
774
775
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 772

def right
  # By default self.
  self
end

#signed? ⇒ Boolean

Tells if the type signed.

Returns:

  • (Boolean) 

605
606
607
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 605

def signed?
  return false
end

#struct? ⇒ Boolean

Tells if the type has named sub types.

Returns:

  • (Boolean) 

693
694
695
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 693

def struct?
  return false
end

#to_type ⇒ Object

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


733
734
735
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 733

def to_type
  return self
end

#to_vector ⇒ Object

Converts to a bit vector.


722
723
724
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 722

def to_vector
  return TypeVector.new(:"", Bit, self.width-1..0)
end

#typedef(name) ⇒ Object

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


780
781
782
783
784
785
786
787
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 780

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

#types? ⇒ Boolean

Tells if the type has sub types.

Returns:

  • (Boolean) 

683
684
685
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 683

def types?
  return false
end

#unary(operator, expr) ⇒ Object

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


836
837
838
839
840
841
842
843
844
845
846
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 836

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 computation.
    expr.to_value.send(operator)
  end
end

#unsigned? ⇒ Boolean

Tells if the type is unsigned.

Returns:

  • (Boolean) 

610
611
612
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 610

def unsigned?
  return false
end

#vector? ⇒ Boolean

Tells if the type of of vector kind.

Returns:

  • (Boolean) 

630
631
632
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 630

def vector?
  return false
end

#width ⇒ Object

Gets the bitwidth of the type, by default 0. Bit, signed, unsigned and Float base have a width of 1.


636
637
638
639
640
641
642
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 636

def width
  if [:bit, :signed, :unsigned, :float ].include?(@name) then
    return 1
  else
    return 0
  end
end