Class: HDLRuby::High::SystemT

Inherits:
Low::SystemT show all
Includes:
Hmissing, Hmux, SingletonExtend
Defined in:
lib/HDLRuby/hruby_high.rb

Overview

Describes a high-level system type.

Constant Summary collapse

High = 
HDLRuby::High

Constants included from Low::Low2Symbol

Low::Low2Symbol::Low2SymbolPrefix, Low::Low2Symbol::Low2SymbolTable, Low::Low2Symbol::Symbol2LowTable

Instance Attribute Summary collapse

Attributes inherited from Low::SystemT

#name, #scope

Attributes included from Low::Hparent

#parent

Instance Method Summary collapse

Methods included from Hmux

#mux

Methods included from Hmissing

#method_missing

Methods included from SingletonExtend

#eigen_extend

Methods inherited from Low::SystemT

#add_inout, #add_input, #add_output, #bit2vector2inner!, #blocks2seq!, #boolean_in_assign2select!, #break_concat_assigns!, #break_types!, #c_code_allocate, #cleanup!, #connections_to_behaviors!, #delete_inout!, #delete_input!, #delete_output!, #each_inout, #each_input, #each_output, #each_signal, #each_signal_all, #each_signal_deep, #each_systemT_deep, #eql?, #explicit_types!, #extract_port_assign!, get, #get_all_inouts, #get_all_inputs, #get_all_outputs, #get_all_signals, #get_by_name, #get_inout, #get_input, #get_interface, #get_output, #get_signal, #has_inout?, #has_input?, #has_output?, #has_signal?, #hash, #map_inouts!, #map_inputs!, #map_outputs!, #mixblocks2seq!, #outread2inner!, #port_assign?, #replace_names!, #select2case!, #set_name!, #set_scope!, #to_c, #to_c_code, #to_ch, #to_global_systemTs!, #to_high, #to_upper_space!, #to_verilog, #to_vhdl, #with_boolean!, #with_port!, #with_var!

Methods included from Low::ForceName

#extend_name!, #force_name!

Methods included from Low::Low2Symbol

#to_sym

Constructor Details

#initialize(name, *mixins, &ruby_block) ⇒ SystemT

Creates a new high-level system type named +name+ and inheriting from +mixins+.

If name is hash, it is considered the system is unnamed and the

table is used to rename its signals or instances.

The proc +ruby_block+ is executed when instantiating the system.



328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/HDLRuby/hruby_high.rb', line 328

def initialize(name, *mixins, &ruby_block)
    # Initialize the system type structure.
    super(name,Scope.new(name,self))

    # Initialize the set of extensions to transmit to the instances'
    # eigen class
    @singleton_instanceO = Namespace.new(self.scope)

    # Create the public namespace.
    @public_namespace = Namespace.new(self.scope)

    # Check and set the mixins.
    mixins.each do |mixin|
        unless mixin.is_a?(SystemT) then
            raise AnyError,
                  "Invalid class for inheriting: #{mixin.class}."
        end
    end
    @to_includes = mixins
    # Prepare the instantiation methods
    make_instantiater(name,SystemI,&ruby_block)
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class HDLRuby::High::Hmissing

Instance Attribute Details

#instance_class ⇒ Object (readonly)

The instantiation target class.



490
491
492
 
# File 'lib/HDLRuby/hruby_high.rb', line 490

def instance_class
  @instance_class
end

#public_namespace ⇒ Object (readonly)

The public namespace

NOTE: the private namespace is the namespace of the scope object.



318
319
320
 
# File 'lib/HDLRuby/hruby_high.rb', line 318

def public_namespace
  @public_namespace
end

Instance Method Details

#as(system) ⇒ Object

Casts as an included +system+.

NOTE: use the includes of the scope.



658
659
660
661
 
# File 'lib/HDLRuby/hruby_high.rb', line 658

def as(system)
    # return self.scope.as(system.scope)
    return self.scope.as(system)
end

#each_export(&ruby_block) ⇒ Object

Iterates over the exported constructs

NOTE: look into the scope.



452
453
454
 
# File 'lib/HDLRuby/hruby_high.rb', line 452

def each_export(&ruby_block)
    @scope.each_export(&ruby_block)
end

#each_instance_proc(&ruby_block) ⇒ Object

Iterates over the instance procedures.

Returns an enumerator if no ruby block is given.



495
496
497
498
499
500
 
# File 'lib/HDLRuby/hruby_high.rb', line 495

def each_instance_proc(&ruby_block)
    # No ruby block? Return an enumerator.
    return to_enum(:each_instance_proc) unless ruby_block
    # A block? Apply it on each input signal instance.
    @instance_procs.each(&ruby_block)
end

#each_signal_with_included(&ruby_block) ⇒ Object

Iterates over the all interface signals, i.e, also the ones of the included systems.

Returns an enumerator if no ruby block is given.



432
433
434
435
436
437
438
439
440
441
 
# File 'lib/HDLRuby/hruby_high.rb', line 432

def each_signal_with_included(&ruby_block)
    # No ruby block? Return an enumerator.
    return to_enum(:each_signal_with_included) unless ruby_block
    # Iterate on the signals of the current system.
    self.each_signal(&ruby_block)
    # Recurse on the included systems.
    self.scope.each_included do |included|
        included.each_signal_with_included(&ruby_block)
    end
end

#eigenize(instance) ⇒ Object

Make a system eigen of a given +instance+.



519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
 
# File 'lib/HDLRuby/hruby_high.rb', line 519

def eigenize(instance)
    unless instance.systemT == self then
        raise "Cannot eigenize system #{self.name} to instance #{instance.name}"
    end
    # The instance becames the owner.
    @owner = instance
    # Fill the public namespace
    space = self.public_namespace
    # Interface signals
    # puts "i_name=#{i_name} @to_includes=#{@to_includes.size}"
    self.each_signal do |signal|
        # puts "signal=#{signal.name}"
        space.send(:define_singleton_method,signal.name) do
            RefObject.new(instance.to_ref,signal)
        end
    end
    # Exported objects
    self.each_export do |export|
        # puts "export=#{export.name}"
        space.send(:define_singleton_method,export.name) do
            RefObject.new(instance.to_ref,export)
        end
    end

    return self
end

#expand(name, *args) ⇒ Object

Expands the system with possible arugments +args+ to a new system named +name+.



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

def expand(name, *args)
    # puts "expand #{self.name} to #{name}"
    # Create the new system.
    expanded = self.class.new(name.to_s) {}
    # Include the mixin systems given when declaring the system.
    @to_includes.each { |system| expanded.scope.include(system) }

    # Fills the scope of the expanded class.
    # puts "Build top with #{self.name} for #{name}"
    expanded.scope.build_top(self.scope,*args)
    # puts "Top built with #{self.name} for #{name}"
    return expanded
end

#extend(system) ⇒ Object

Extend the class according to another +system+.



648
649
650
651
652
653
 
# File 'lib/HDLRuby/hruby_high.rb', line 648

def extend(system)
    # Adds the singleton methods
    self.eigen_extend(system)
    # Adds the singleton methods for the instances.
    @singleton_instanceO.eigen_extend(system.singleton_instance)
end

#fill_interface(systemTlow) ⇒ Object

Fills the interface of a low level system.



666
667
668
669
670
671
672
673
674
675
676
677
 
# File 'lib/HDLRuby/hruby_high.rb', line 666

def fill_interface(systemTlow)
    # Adds its input signals.
    self.each_input { |input|  systemTlow.add_input(input.to_low) }
    # Adds its output signals.
    self.each_output { |output| systemTlow.add_output(output.to_low) }
    # Adds its inout signals.
    self.each_inout { |inout|  systemTlow.add_inout(inout.to_low) }
    # Adds the interface of its included systems.
    self.scope.each_included do |included|
        included.fill_interface(systemTlow)
    end
end

#fill_low(systemTlow) ⇒ Object

Fills a low level system with self's contents.

NOTE: name conflicts are treated in the current NameStack state.



682
683
684
685
 
# File 'lib/HDLRuby/hruby_high.rb', line 682

def fill_low(systemTlow)
    # Fills the interface
    self.fill_interface(systemTlow)
end

#get_interface_with_included(i) ⇒ Object

Get one of all the interface signal by index, i.e., also the ones of the included systems.



445
446
447
 
# File 'lib/HDLRuby/hruby_high.rb', line 445

def get_interface_with_included(i)
    return each_signal_with_included.to_a[i]
end

#inout(*names) ⇒ Object

Declares high-level bit inout signals named +names+.

Retuns the last declared input.



643
644
645
 
# File 'lib/HDLRuby/hruby_high.rb', line 643

def inout(*names)
    self.make_inouts(bit,*names)
end

#input(*names) ⇒ Object

Declares high-level bit input signals named +names+.

Retuns the last declared input.



629
630
631
 
# File 'lib/HDLRuby/hruby_high.rb', line 629

def input(*names)
    self.make_inputs(bit,*names)
end

#instantiate(i_name, *args) ⇒ Object Also known as: call

Instantiate the system type to an instance named +i_name+ with possible arguments +args+.



548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
 
# File 'lib/HDLRuby/hruby_high.rb', line 548

def instantiate(i_name,*args)
    # Create the eigen type.
    eigen = self.expand(High.names_create(i_name.to_s + ":T"), *args)

    # Create the instance and sets its eigen system to +eigen+.
    instance = @instance_class.new(i_name,eigen)
    eigen.eigenize(instance)
    # puts "instance interface=#{instance.each_signal.to_a.size}"
    # puts "eigen interface=#{eigen.each_signal.to_a.size}"

    # Extend the instance.
    instance.eigen_extend(@singleton_instanceO)
    # puts "instance scope= #{instance.systemT.scope}"
    # Add the instance.
    High.top_user.send(:add_systemI,instance)
    # Return the resulting instance
    return instance
end

#make_inouts(type, *names) ⇒ Object

Creates and adds a set of inouts typed +type+ from a list of +names+.

NOTE: a name can also be a signal, is which case it is duplicated.



410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
 
# File 'lib/HDLRuby/hruby_high.rb', line 410

def make_inouts(type, *names)
    res = nil
    names.each do |name|
        if name.respond_to?(:to_sym) then
            res = self.add_inout(SignalI.new(name,type,:inout))
        elsif name.is_a?(Hash) then
            # Names associated with values.
            names.each do |name,value|
                res = self.add_inner(
                    SignalI.new(name,type,:inner,value))
            end
        else
            raise AnyError, "Invalid class for a name: #{name.class}"
        end
    end
    return res
end

#make_inputs(type, *names) ⇒ Object

Creates and adds a set of inputs typed +type+ from a list of +names+.

NOTE: a name can also be a signal, is which case it is duplicated.



360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/HDLRuby/hruby_high.rb', line 360

def make_inputs(type, *names)
    # Check if called within the top scope of the block.
    if High.top_user != @scope then
        # No, cannot make an input from here.
        raise AnyError,
              "Input signals can only be declared in the top scope of a system."
    end
    res = nil
    names.each do |name|
        if name.respond_to?(:to_sym) then
            res = self.add_input(SignalI.new(name,type,:input))
        elsif name.is_a?(Hash) then
            # Names associated with values.
            names.each do |name,value|
                res = self.add_inner(
                    SignalI.new(name,type,:inner,value))
            end
        else
            raise AnyError, "Invalid class for a name: #{name.class}"
        end
    end
    return res
end

#make_instantiater(name, klass, &ruby_block) ⇒ Object

Generates the instantiation capabilities including an instantiation method +name+ for hdl-like instantiation, target instantiation as +klass+, added to the calling object, and whose eigen type is initialized by +ruby_block+.

NOTE: actually creates two instantiater, a general one, being registered in the namespace stack, and one for creating an array of instances being registered in the Array class.



578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
 
# File 'lib/HDLRuby/hruby_high.rb', line 578

def make_instantiater(name,klass,&ruby_block)
    # puts "make_instantiater with name=#{name}"
    # Set the instanciater.
    @instance_procs = [ ruby_block ]
    # Set the target instantiation class.
    @instance_class = klass

    # Unnamed types do not have associated access method.
    return if name.empty?

    obj = self # For using the right self within the proc

    # Create and register the general instantiater.
    High.space_reg(name) do |*args|
        # puts "Instantiating #{name} with args=#{args.size}"
        # If no arguments, return the system as is
        return obj if args.empty?
        # Are there any generic arguments?
        if ruby_block.arity > 0 then
            # Yes, must specialize the system with the arguments.
            # If arguments, create a new system specialized with them
            return SystemT.new(:"") { include(obj,*args) }
        end
        # It is the case where it is an instantiation
        # Get the names from the arguments.
        i_names = args.shift
        # puts "i_names=#{i_names}(#{i_names.class})"
        i_names = [*i_names]
        instance = nil # The current instance
        i_names.each do |i_name|
            # Instantiate.
            instance = obj.instantiate(i_name,*args)
        end
        # # Return the last instance.
        instance
    end

    # Create and register the array of instances instantiater.
    ::Array.class_eval do
        define_method(name) { |*args| make(name,*args) }
    end
end

#make_outputs(type, *names) ⇒ Object

Creates and adds a set of outputs typed +type+ from a list of +names+.

NOTE: a name can also be a signal, is which case it is duplicated.



387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/HDLRuby/hruby_high.rb', line 387

def make_outputs(type, *names)
    # puts "type=#{type.inspect}"
    res = nil
    names.each do |name|
        # puts "name=#{name}"
        if name.respond_to?(:to_sym) then
            res = self.add_output(SignalI.new(name,type,:output))
        elsif name.is_a?(Hash) then
            # Names associated with values.
            names.each do |name,value|
                res = self.add_inner(
                    SignalI.new(name,type,:inner,value))
            end
        else
            raise AnyError, "Invalid class for a name: #{name.class}"
        end
    end
    return res
end

#namespace ⇒ Object

Gets the private namespace of the system.



462
463
464
 
# File 'lib/HDLRuby/hruby_high.rb', line 462

def namespace
    return self.scope.namespace
end

#open(&ruby_block) ⇒ Object

Opens for extension.

NOTE: actually executes +ruby_block+ in the context of the scope of the system.



475
476
477
478
479
480
481
482
483
484
485
486
487
 
# File 'lib/HDLRuby/hruby_high.rb', line 475

def open(&ruby_block)
    # Are we instantiating current system?
    if (High.space_include?(self.scope.namespace)) then
        # Yes, execute the ruby block in the top context of the
        # system.
        # self.scope.open(&ruby_block)
        self.run(&ruby_block)
    else
        # No, add the ruby block to the list of block to execute
        # when instantiating.
        @instance_procs << ruby_block
    end
end

#output(*names) ⇒ Object

Declares high-level bit output signals named +names+.

Retuns the last declared input.



636
637
638
 
# File 'lib/HDLRuby/hruby_high.rb', line 636

def output(*names)
    self.make_outputs(bit,*names)
end

#run(&ruby_block) ⇒ Object

Execute +ruby_block+ in the context of the system.



467
468
469
 
# File 'lib/HDLRuby/hruby_high.rb', line 467

def run(&ruby_block)
    self.scope.open(&ruby_block)
end

#singleton_instance ⇒ Object

Gets class containing the extension for the instances.



457
458
459
 
# File 'lib/HDLRuby/hruby_high.rb', line 457

def singleton_instance
    @singleton_instanceO.singleton_class
end

#to_low(name = self.name) ⇒ Object

Converts the system to HDLRuby::Low and set its +name+.



688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
 
# File 'lib/HDLRuby/hruby_high.rb', line 688

def to_low(name = self.name)
    name = name.to_s
    if name.empty? then
        raise AnyError, 
              "Cannot convert a system without a name to HDLRuby::Low."
    end
    # Create the resulting low system type.
    systemTlow = HDLRuby::Low::SystemT.new(High.names_create(name),
                                           self.scope.to_low)
    # Fills the interface of the new system 
    # from the included systems.
    self.fill_low(systemTlow)
    # Return theresulting system.
    return systemTlow
end

#to_user ⇒ Object

Converts to a namespace user.



352
353
354
355
 
# File 'lib/HDLRuby/hruby_high.rb', line 352

def to_user
    # Returns the scope.
    return @scope
end