Class: HDLRuby::Low::Type

Inherits:
Base::Type
  • Object
show all
Includes:
Hparent, Low2Symbol, Ltype
Defined in:
lib/HDLRuby/hruby_db.rb,
lib/HDLRuby/hruby_low.rb,
lib/HDLRuby/hruby_low2c.rb,
lib/HDLRuby/hruby_low2sym.rb,
lib/HDLRuby/hruby_low2vhd.rb,
lib/HDLRuby/hruby_verilog.rb,
lib/HDLRuby/hruby_low2high.rb,
lib/HDLRuby/hruby_low_mutable.rb,
lib/HDLRuby/hruby_low_skeleton.rb,
lib/HDLRuby/hruby_low_with_bool.rb,
lib/HDLRuby/hruby_low_without_namespace.rb

Overview

Extends the Type class with functionality for breaking hierarchical types.

Direct Known Subclasses

High::Type, TypeDef, TypeStruct, TypeTuple, TypeVector

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

#scope

Methods included from Ltype

included, #ltype?

Constructor Details

#initialize(name) ⇒ Type

Creates a new type named +name+.



1144
1145
1146
1147
 
# File 'lib/HDLRuby/hruby_low.rb', line 1144

def initialize(name)
    # Check and set the name.
    @name = name.to_sym
end

Instance Attribute Details

#name ⇒ Object (readonly)

The name of the type



1141
1142
1143
 
# File 'lib/HDLRuby/hruby_low.rb', line 1141

def name
  @name
end

Instance Method Details

#base ⇒ Object

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

Raises:



1218
1219
1220
 
# File 'lib/HDLRuby/hruby_low.rb', line 1218

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

#base? ⇒ Boolean

Tells if the type has a base.

Returns:

  • (Boolean) 


1213
1214
1215
 
# File 'lib/HDLRuby/hruby_low.rb', line 1213

def base?
    return false
end

#boolean? ⇒ Boolean

Tells if it is a boolean type.

Returns:

  • (Boolean) 


20
21
22
 
# File 'lib/HDLRuby/hruby_low_with_bool.rb', line 20

def boolean?
    return false
end

#break_types!(types) ⇒ Object

Breaks the hierarchical types into sequences of type definitions. Assumes to_upper_space! has been called before. +types+ include the resulting types.



284
285
286
287
 
# File 'lib/HDLRuby/hruby_low_without_namespace.rb', line 284

def break_types!(types)
    # By default, nothing to do.
    return self
end

#direction ⇒ Object

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



1197
1198
1199
1200
 
# File 'lib/HDLRuby/hruby_low.rb', line 1197

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

#each_type_deep(&ruby_block) ⇒ Object

Iterates over the types deeply if any.



1247
1248
1249
1250
1251
1252
1253
 
# File 'lib/HDLRuby/hruby_low.rb', line 1247

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) 


1150
1151
1152
1153
1154
 
# File 'lib/HDLRuby/hruby_low.rb', line 1150

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) 


1241
1242
1243
1244
 
# File 'lib/HDLRuby/hruby_low.rb', line 1241

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) 


1172
1173
1174
 
# File 'lib/HDLRuby/hruby_low.rb', line 1172

def fixed?
    return false
end

#float? ⇒ Boolean

Tells if the type is floating point.

Returns:

  • (Boolean) 


1177
1178
1179
 
# File 'lib/HDLRuby/hruby_low.rb', line 1177

def float?
    return false
end

#hash ⇒ Object

Hash function.



1157
1158
1159
 
# File 'lib/HDLRuby/hruby_low.rb', line 1157

def hash
    return [@name].hash
end

#leaf? ⇒ Boolean

Tells if the type is a leaf.

Returns:

  • (Boolean) 


1182
1183
1184
 
# File 'lib/HDLRuby/hruby_low.rb', line 1182

def leaf?
    return false
end

#range ⇒ Object

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

Raises:



1208
1209
1210
 
# File 'lib/HDLRuby/hruby_low.rb', line 1208

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

#range? ⇒ Boolean

Tells if the type has a range.

Returns:

  • (Boolean) 


1203
1204
1205
 
# File 'lib/HDLRuby/hruby_low.rb', line 1203

def range?
    return false
end

#regular? ⇒ Boolean

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

Returns:

  • (Boolean) 


1228
1229
1230
 
# File 'lib/HDLRuby/hruby_low.rb', line 1228

def regular?
    return false
end

#set_name!(name) ⇒ Object

Sets the +name+.



268
269
270
 
# File 'lib/HDLRuby/hruby_low_mutable.rb', line 268

def set_name!(name)
    @name = name.to_sym
end

#signed? ⇒ Boolean

Tells if the type signed.

Returns:

  • (Boolean) 


1162
1163
1164
 
# File 'lib/HDLRuby/hruby_low.rb', line 1162

def signed?
    return false
end

#struct? ⇒ Boolean

Tells if the type has named sub types.

Returns:

  • (Boolean) 


1233
1234
1235
 
# File 'lib/HDLRuby/hruby_low.rb', line 1233

def struct?
    return false
end

#to_c(level = 0) ⇒ Object

Generates the C text of the equivalent HDLRuby::High code. +level+ is the hierachical level of the object.



505
506
507
508
509
510
511
512
513
514
515
 
# File 'lib/HDLRuby/hruby_low2c.rb', line 505

def to_c(level = 0)
    # return Low2C.c_name(self.name)
    # return Low2C.type_name(Bit) + "()"
    if self.name == :bit || self.name == :unsigned then
        return "get_type_bit()"
    elsif self.name == :signed then
        return "get_type_signed()"
    else
        raise "Unknown type: #{self.name}"
    end
end

#to_high(level = 0) ⇒ Object

Generates the text of the equivalent HDLRuby::High code. +level+ is the hierachical level of the object.



174
175
176
 
# File 'lib/HDLRuby/hruby_low2high.rb', line 174

def to_high(level = 0)
    return Low2High.high_use_name(self.name)
end

#to_vector ⇒ Object

Converts to a bit vector.



1256
1257
1258
 
# File 'lib/HDLRuby/hruby_low.rb', line 1256

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

#to_verilog ⇒ Object

Converts the type to Verilog code.



1634
1635
1636
 
# File 'lib/HDLRuby/hruby_verilog.rb', line 1634

def to_verilog
    return self.name == :signed ? "#{self.name.to_s} " : ""
end

#to_vhdl(level = 0) ⇒ Object

Generates the text of the equivalent HDLRuby::High code. +level+ is the hierachical level of the object.



609
610
611
 
# File 'lib/HDLRuby/hruby_low2vhd.rb', line 609

def to_vhdl(level = 0)
    return self.boolean? ? "boolean" : "std_logic"
end

#types? ⇒ Boolean

Tells if the type has sub types.

Returns:

  • (Boolean) 


1223
1224
1225
 
# File 'lib/HDLRuby/hruby_low.rb', line 1223

def types?
    return false
end

#unsigned? ⇒ Boolean

Tells if the type is unsigned.

Returns:

  • (Boolean) 


1167
1168
1169
 
# File 'lib/HDLRuby/hruby_low.rb', line 1167

def unsigned?
    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.



1188
1189
1190
1191
1192
1193
1194
 
# File 'lib/HDLRuby/hruby_low.rb', line 1188

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