Class: HDLRuby::Low::Type
- Inherits:
-
Base::Type
- Object
- Base::Type
- HDLRuby::Low::Type
- Includes:
- Hparent, Low2Symbol, Ltype
- Defined in:
- lib/HDLRuby/hruby_db.rb,
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_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
Constant Summary
Constants included from Low2Symbol
Low2Symbol::Low2SymbolPrefix, Low2Symbol::Low2SymbolTable, Low2Symbol::Symbol2LowTable
Instance Attribute Summary collapse
-
#name ⇒ Object
readonly
The name of the type.
Attributes included from Hparent
Instance Method Summary collapse
-
#base ⇒ Object
Gets the base type, by default base type is not defined.
-
#base? ⇒ Boolean
Tells if the type has a base.
-
#boolean? ⇒ Boolean
Tells if it is a boolean type.
-
#break_types!(types) ⇒ Object
Breaks the hierarchical types into sequences of type definitions.
-
#direction ⇒ Object
Get the direction of the type, little or big endian.
-
#each_type_deep(&ruby_block) ⇒ Object
(also: #each_deep)
Iterates over the types deeply if any.
-
#eql?(obj) ⇒ Boolean
Comparison for hash: structural comparison.
-
#equivalent?(type) ⇒ Boolean
Tell if +type+ is equivalent to current type.
-
#fixed? ⇒ Boolean
Tells if the type is fixed point.
-
#float? ⇒ Boolean
Tells if the type is floating point.
-
#hash ⇒ Object
Hash function.
-
#hierarchical? ⇒ Boolean
Tells if the type is hierarchical.
-
#initialize(name) ⇒ Type
constructor
Creates a new type named +name+.
-
#leaf? ⇒ Boolean
Tells if the type is a leaf.
-
#max ⇒ Object
Gets the type max value if any.
-
#min ⇒ Object
Gets the type min value if any.
-
#range ⇒ Object
Gets the range of the type, by default range is not defined.
-
#range? ⇒ Boolean
Tells if the type has a range.
-
#regular? ⇒ Boolean
Tells if the type is regular (applies for tuples).
-
#set_name!(name) ⇒ Object
Sets the +name+.
-
#signed? ⇒ Boolean
Tells if the type signed.
-
#struct? ⇒ Boolean
Tells if the type has named sub types.
-
#to_c(res, level = 0) ⇒ Object
Generates the C text of the equivalent HDLRuby code.
-
#to_hdr(level = 0) ⇒ Object
Generates the text of the equivalent hdr text.
-
#to_high ⇒ Object
Creates a new high type.
-
#to_vector ⇒ Object
Converts to a bit vector.
-
#to_verilog ⇒ Object
Converts the type to Verilog code.
-
#to_vhdl(level = 0) ⇒ Object
Generates the text of the equivalent HDLRuby::High code.
-
#types? ⇒ Boolean
Tells if the type has sub types.
-
#unsigned? ⇒ Boolean
Tells if the type is unsigned.
-
#vector? ⇒ Boolean
Tells if the type of of vector kind.
-
#width ⇒ Object
Gets the bitwidth of the type, by default 0.
Methods included from Low2Symbol
Methods included from Hparent
Methods included from Ltype
Constructor Details
#initialize(name) ⇒ Type
Creates a new type named +name+.
1267 1268 1269 1270 |
# File 'lib/HDLRuby/hruby_low.rb', line 1267 def initialize(name) # Check and set the name. @name = name.to_sym end |
Instance Attribute Details
#name ⇒ Object (readonly)
The name of the type
1264 1265 1266 |
# File 'lib/HDLRuby/hruby_low.rb', line 1264 def name @name end |
Instance Method Details
#base ⇒ Object
Gets the base type, by default base type is not defined.
1361 1362 1363 |
# File 'lib/HDLRuby/hruby_low.rb', line 1361 def base raise AnyError, "No base type for type #{self}" end |
#base? ⇒ Boolean
Tells if the type has a base.
1356 1357 1358 |
# File 'lib/HDLRuby/hruby_low.rb', line 1356 def base? return false end |
#boolean? ⇒ Boolean
Tells if it is a boolean type.
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.
289 290 291 292 |
# File 'lib/HDLRuby/hruby_low_without_namespace.rb', line 289 def break_types!(types) # By default, nothing to do. return self end |
#direction ⇒ Object
Get the direction of the type, little or big endian.
1340 1341 1342 1343 |
# File 'lib/HDLRuby/hruby_low.rb', line 1340 def direction # By default, little endian. return :little end |
#each_type_deep(&ruby_block) ⇒ Object Also known as: each_deep
Iterates over the types deeply if any.
1395 1396 1397 1398 1399 1400 1401 |
# File 'lib/HDLRuby/hruby_low.rb', line 1395 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.
1276 1277 1278 1279 1280 |
# File 'lib/HDLRuby/hruby_low.rb', line 1276 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.
1389 1390 1391 1392 |
# File 'lib/HDLRuby/hruby_low.rb', line 1389 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.
1298 1299 1300 |
# File 'lib/HDLRuby/hruby_low.rb', line 1298 def fixed? return false end |
#float? ⇒ Boolean
Tells if the type is floating point.
1303 1304 1305 |
# File 'lib/HDLRuby/hruby_low.rb', line 1303 def float? return false end |
#hash ⇒ Object
Hash function.
1283 1284 1285 |
# File 'lib/HDLRuby/hruby_low.rb', line 1283 def hash return [@name].hash end |
#hierarchical? ⇒ Boolean
Tells if the type is hierarchical.
1381 1382 1383 |
# File 'lib/HDLRuby/hruby_low.rb', line 1381 def hierarchical? return self.base? || self.types? end |
#leaf? ⇒ Boolean
Tells if the type is a leaf.
1308 1309 1310 |
# File 'lib/HDLRuby/hruby_low.rb', line 1308 def leaf? return false end |
#max ⇒ Object
Gets the type max value if any. Default: not defined.
1329 1330 1331 |
# File 'lib/HDLRuby/hruby_low.rb', line 1329 def max raise AnyError, "No max value for type #{self}" end |
#min ⇒ Object
Gets the type min value if any. Default: not defined.
1335 1336 1337 |
# File 'lib/HDLRuby/hruby_low.rb', line 1335 def min raise AnyError, "No min value for type #{self}" end |
#range ⇒ Object
Gets the range of the type, by default range is not defined.
1351 1352 1353 |
# File 'lib/HDLRuby/hruby_low.rb', line 1351 def range raise AnyError, "No range for type #{self}" end |
#range? ⇒ Boolean
Tells if the type has a range.
1346 1347 1348 |
# File 'lib/HDLRuby/hruby_low.rb', line 1346 def range? return false end |
#regular? ⇒ Boolean
Tells if the type is regular (applies for tuples).
1371 1372 1373 |
# File 'lib/HDLRuby/hruby_low.rb', line 1371 def regular? return false end |
#set_name!(name) ⇒ Object
Sets the +name+.
280 281 282 |
# File 'lib/HDLRuby/hruby_low_mutable.rb', line 280 def set_name!(name) @name = name.to_sym end |
#signed? ⇒ Boolean
Tells if the type signed.
1288 1289 1290 |
# File 'lib/HDLRuby/hruby_low.rb', line 1288 def signed? return false end |
#struct? ⇒ Boolean
Tells if the type has named sub types.
1376 1377 1378 |
# File 'lib/HDLRuby/hruby_low.rb', line 1376 def struct? return false 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)
575 576 577 578 579 580 581 582 583 584 585 586 |
# File 'lib/HDLRuby/hruby_low2c.rb', line 575 def to_c(res,level = 0) if self.name == :bit || self.name == :unsigned then # return "get_type_bit()" res << "get_type_bit()" elsif self.name == :signed then # return "get_type_signed()" res << "get_type_signed()" else raise "Unknown type: #{self.name}" end return res end |
#to_hdr(level = 0) ⇒ Object
Generates the text of the equivalent hdr text. +level+ is the hierachical level of the object.
174 175 176 |
# File 'lib/HDLRuby/hruby_low2hdr.rb', line 174 def to_hdr(level = 0) return Low2HDR.hdr_use_name(self.name) end |
#to_high ⇒ Object
Creates a new high type.
61 62 63 |
# File 'lib/HDLRuby/hruby_low2high.rb', line 61 def to_high return HDLRuby::High::Type.new(self.name) end |
#to_vector ⇒ Object
Converts to a bit vector.
1405 1406 1407 |
# File 'lib/HDLRuby/hruby_low.rb', line 1405 def to_vector return TypeVector.new(:"", Bit, self.width-1..0) end |
#to_verilog ⇒ Object
Converts the type to Verilog code.
1758 1759 1760 |
# File 'lib/HDLRuby/hruby_verilog.rb', line 1758 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.
619 620 621 |
# File 'lib/HDLRuby/hruby_low2vhd.rb', line 619 def to_vhdl(level = 0) return self.boolean? ? "boolean" : "std_logic" end |
#types? ⇒ Boolean
Tells if the type has sub types.
1366 1367 1368 |
# File 'lib/HDLRuby/hruby_low.rb', line 1366 def types? return false end |
#unsigned? ⇒ Boolean
Tells if the type is unsigned.
1293 1294 1295 |
# File 'lib/HDLRuby/hruby_low.rb', line 1293 def unsigned? return false end |
#vector? ⇒ Boolean
Tells if the type of of vector kind.
1313 1314 1315 |
# File 'lib/HDLRuby/hruby_low.rb', line 1313 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.
1319 1320 1321 1322 1323 1324 1325 |
# File 'lib/HDLRuby/hruby_low.rb', line 1319 def width if [:bit, :signed, :unsigned, :float ].include?(@name) then return 1 else return 0 end end |