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



623
624
625
626
627
628
629
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 623

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.



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

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

#base ⇒ Object

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

Raises:



719
720
721
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 719

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

#base? ⇒ Boolean

Tells if the type has a base.

Returns:

  • (Boolean) 


714
715
716
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 714

def base?
  return false
end

#binary(operator, expr0, expr1) ⇒ Object

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



891
892
893
894
895
896
897
898
899
900
901
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 891

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



872
873
874
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 872

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.



865
866
867
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 865

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

#define_operator(operator, &ruby_block) ⇒ Object

Redefinition of +operator+.



904
905
906
907
908
909
910
911
912
913
914
915
916
917
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 904

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



921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 921

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.



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

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

#each_overload(&ruby_block) ⇒ Object

Interates over the overloaded operators.



939
940
941
942
943
944
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 939

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.



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

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) 


634
635
636
637
638
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 634

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) 


747
748
749
750
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 747

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) 


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

def fixed?
  return false
end

#float? ⇒ Boolean

Tells if the type is floating point.

Returns:

  • (Boolean) 


661
662
663
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 661

def float?
  return false
end

#hash ⇒ Object

Hash function.



641
642
643
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 641

def hash
  return [@name].hash
end

#hierarchical? ⇒ Boolean

Tells if the type is hierarchical.

Returns:

  • (Boolean) 


739
740
741
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 739

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

#htype? ⇒ Boolean

Tells htype has been included.

Returns:

  • (Boolean) 


768
769
770
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 768

def htype?
  return true
end

#inner(*names) ⇒ Object

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



859
860
861
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 859

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

#leaf? ⇒ Boolean

Tells if the type is a leaf.

Returns:

  • (Boolean) 


666
667
668
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 666

def leaf?
  return false
end

#left ⇒ Object

Gets the type as left value.

NOTE: used for asymetric types like TypeSystemI.



805
806
807
808
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 805

def left
  # By default self.
  self
end

#max ⇒ Object

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

Raises:



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

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

#min ⇒ Object

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

Raises:



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

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.



781
782
783
784
785
786
787
788
789
790
791
792
793
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 781

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:



709
710
711
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 709

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

#range? ⇒ Boolean

Tells if the type has a range.

Returns:

  • (Boolean) 


704
705
706
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 704

def range?
  return false
end

#register(name) ⇒ Object

Register the +name+ of the type.



796
797
798
799
800
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 796

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) 


729
730
731
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 729

def regular?
  return false
end

#right ⇒ Object

Gets the type as right value.

NOTE: used for asymetric types like TypeSystemI.



813
814
815
816
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 813

def right
  # By default self.
  self
end

#signed? ⇒ Boolean

Tells if the type signed.

Returns:

  • (Boolean) 


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

def signed?
  return false
end

#struct? ⇒ Boolean

Tells if the type has named sub types.

Returns:

  • (Boolean) 


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

def struct?
  return false
end

#to_c ⇒ Object

Convert to C code.



947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 947

def to_c
  case @name
  when :void
    return "void"
  when :bit, :unsigned
    return "unsigned"
  when :signed
    return "signed"
  when :float
    return "double"
  when :string
    return "char*"
  else
    return @name.to_s
  end
end

#to_c_init ⇒ Object

Convert to C initialization code.



965
966
967
968
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 965

def to_c_init
  # By default: 0
  return "0"
end

#to_type ⇒ Object

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



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

def to_type
  return self
end

#to_vector ⇒ Object

Converts to a bit vector.



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

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.



821
822
823
824
825
826
827
828
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 821

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) 


724
725
726
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 724

def types?
  return false
end

#unary(operator, expr) ⇒ Object

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



877
878
879
880
881
882
883
884
885
886
887
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 877

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) 


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

def unsigned?
  return false
end

#vector? ⇒ Boolean

Tells if the type of of vector kind.

Returns:

  • (Boolean) 


671
672
673
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 671

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.



677
678
679
680
681
682
683
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 677

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