Module: HDLRuby::High::Htype

Includes:
Tprocess
Included in:
Type, TypeDef, TypeStruct, TypeTuple, TypeVector
Defined in:
lib/HDLRuby/hruby_high.rb

Overview

Module bringing high-level properties to Type classes.

NOTE: by default a type is not specified.

Constant Summary collapse

High = 
HDLRuby::High

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Tprocess

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

Class Method Details

.included(base) ⇒ Object

Ensures initialize registers the type name



1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
 
# File 'lib/HDLRuby/hruby_high.rb', line 1393

def self.included(base) # built-in Ruby hook for modules
    base.class_eval do    
        original_method = instance_method(:initialize)
        define_method(:initialize) do |*args, &block|
            original_method.bind(self).call(*args, &block)
            # Registers the name (if not empty).
            self.register(name) unless name.empty?
        end
    end
end

Instance Method Details

#[](rng) ⇒ Object

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



1474
1475
1476
 
# File 'lib/HDLRuby/hruby_high.rb', line 1474

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

#binary(operator, expr0, expr1) ⇒ Object

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



1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
 
# File 'lib/HDLRuby/hruby_high.rb', line 1533

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 generation of binary expression.
        return Binary.new(self.send(operator,expr1.type),operator,
                          expr0,expr1)
    end
end

#comp_operator(op) ⇒ Object

Gets the computation method for +operator+.



1514
1515
1516
 
# File 'lib/HDLRuby/hruby_high.rb', line 1514

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.



1507
1508
1509
 
# File 'lib/HDLRuby/hruby_high.rb', line 1507

def constant(hsh)
    High.top_user.make_constants(self,hsh)
end

#define_operator(operator, &ruby_block) ⇒ Object

Redefinition of +operator+.



1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
 
# File 'lib/HDLRuby/hruby_high.rb', line 1547

def define_operator(operator,&ruby_block)
    # 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}"
        HDLRuby::High.top_user.instance_exec do
           sub do
                HDLRuby::High.top_user.instance_exec(*args,&ruby_block)
           end
        end
    end
end

#each_overload(&ruby_block) ⇒ Object

Interates over the overloaded operators.



1563
1564
1565
1566
1567
1568
 
# File 'lib/HDLRuby/hruby_high.rb', line 1563

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

#htype? ⇒ Boolean

Tells htype has been included.

Returns:

  • (Boolean) 


1405
1406
1407
 
# File 'lib/HDLRuby/hruby_high.rb', line 1405

def htype?
    return true
end

#inner(*names) ⇒ Object

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



1501
1502
1503
 
# File 'lib/HDLRuby/hruby_high.rb', line 1501

def inner(*names)
    High.top_user.make_inners(self,*names)
end

#inout(*names) ⇒ Object

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



1494
1495
1496
1497
 
# File 'lib/HDLRuby/hruby_high.rb', line 1494

def inout(*names)
    # High.top_user.make_inouts(self.instantiate,*names)
    High.top_user.make_inouts(self,*names)
end

#input(*names) ⇒ Object

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



1481
1482
1483
 
# File 'lib/HDLRuby/hruby_high.rb', line 1481

def input(*names)
    High.top_user.make_inputs(self,*names)
end

#left ⇒ Object

Gets the type as left value.

NOTE: used for asymetric types like TypeSystemI.



1447
1448
1449
1450
 
# File 'lib/HDLRuby/hruby_high.rb', line 1447

def left
    # By default self.
    self
end

#name=(name) ⇒ Object

Sets the +name+.

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



1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
 
# File 'lib/HDLRuby/hruby_high.rb', line 1418

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

#output(*names) ⇒ Object

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



1487
1488
1489
1490
 
# File 'lib/HDLRuby/hruby_high.rb', line 1487

def output(*names)
    # High.top_user.make_outputs(self.instantiate,*names)
    High.top_user.make_outputs(self,*names)
end

#register(name) ⇒ Object

Register the +name+ of the type.



1433
1434
1435
1436
1437
1438
1439
1440
1441
 
# File 'lib/HDLRuby/hruby_high.rb', line 1433

def register(name)
    if self.name.empty? then
        raise AnyError, "Cannot register with empty name."
    else
        # Sets the hdl-like access to the type.
        obj = self # For using the right self within the proc
        High.space_reg(name) { obj }
    end
end

#right ⇒ Object

Gets the type as right value.

NOTE: used for asymetric types like TypeSystemI.



1455
1456
1457
1458
 
# File 'lib/HDLRuby/hruby_high.rb', line 1455

def right
    # By default self.
    self
end

#to_type ⇒ Object

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



1411
1412
1413
 
# File 'lib/HDLRuby/hruby_high.rb', line 1411

def to_type
    return self
end

#typedef(name) ⇒ Object

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



1463
1464
1465
1466
1467
1468
1469
1470
 
# File 'lib/HDLRuby/hruby_high.rb', line 1463

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

#unary(operator, expr) ⇒ Object

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



1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
 
# File 'lib/HDLRuby/hruby_high.rb', line 1519

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 generation of unary expression.
        return Unary.new(self.send(operator),operator,expr)
    end
end