Class: HDLRuby::High::Scope

Inherits:
Low::Scope show all
Includes:
HScope_missing, Hinner, Hmux, SingletonExtend, WithFullname
Defined in:
lib/HDLRuby/hruby_high.rb,
lib/HDLRuby/hruby_rsim.rb,
lib/HDLRuby/hruby_rcsim.rb,
lib/HDLRuby/hruby_rsim_vcd.rb,
lib/HDLRuby/hruby_high_fullname.rb

Overview

Enhance the scope class with VCD support.

Constant Summary collapse

High = 
HDLRuby::High

Constants included from Hmissing

Hmissing::NAMES

Constants included from Low::Low2Symbol

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

Instance Attribute Summary collapse

Attributes included from Low::Hparent

#parent

Instance Method Summary collapse

Methods included from Hmux

#mux

Methods included from HScope_missing

#h_missing, #method_missing

Methods included from Hmissing

#method_missing

Methods included from SingletonExtend

#eigen_extend

Methods included from Hinner

included

Methods inherited from Low::Scope

#add_behavior, #add_code, #add_connection, #add_inner, #add_scope, #add_systemI, #add_systemT, #add_type, #blocks2seq!, #boolean_in_assign2select!, #break_concat_assigns!, #break_types!, #c_code_allocate, #casts_without_expression!, #cleanup!, #delete_all_behaviors!, #delete_all_connections!, #delete_behavior!, #delete_connection!, #delete_inner!, #delete_related!, #delete_scope!, #delete_systemI!, #delete_systemT!, #delete_type!, #delete_unless!, #each_behavior, #each_behavior_deep, #each_block_deep, #each_code, #each_connection, #each_connection_deep, #each_deep, #each_inner, #each_node_deep, #each_scope, #each_scope_deep, #each_signal, #each_signal_deep, #each_statement_deep, #each_systemI, #each_systemT, #each_type, #eql?, #explicit_types!, #extract_behaviors!, #extract_connections!, #extract_declares!, #extract_port_assign!, #get_all_inners, #get_by_name, #get_code, #get_inner, #get_signal, #get_systemI, #get_systemT, #get_type, #has_behavior?, #has_code?, #has_connection?, #has_inner?, #has_scope?, #has_signal?, #has_systemI?, #has_systemT?, #has_type?, #hash, #initial_concat_to_timed!, #instance_port?, #last_behavior, #make_portw, #map_behaviors!, #map_connections!, #map_inners!, #map_scopes!, #map_systemIs!, #map_systemTs!, #map_types!, #mixblocks2seq!, #par_in_seq2seq!, #parent_system, #port_assign?, #portw2ref, #portw_name2sym, #replace_names!, #replace_names_subs!, #reverse_each_behavior, #select2case!, #sym2portw_name, #to_c, #to_ch, #to_hdr, #to_high, #to_upper_space!, #to_vhdl, #top_scope, #with_port!

Methods included from Low::ForceName

#extend_name!, #force_name!

Methods included from Low::Low2Symbol

#to_sym

Methods included from Low::Hparent

#hierarchy, #no_parent!, #scope

Constructor Details

#initialize(name = :"", systemT = nil, &ruby_block) ⇒ Scope

Creates a new scope with possible +name+. If the scope is a top scope of a system, this systemT is given by +systemT+.

The proc +ruby_block+ is executed for building the scope. If no block is provided, the scope is the top of a system and is filled by the instantiation procedure of the system.



915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
 
# File 'lib/HDLRuby/hruby_high.rb', line 915

def initialize(name = :"", systemT = nil, &ruby_block)
    # Initialize the scope structure
    super(name)

    # Initialize the set of grouped system instances.
    @groupIs = {}

    # Creates the namespace.
    @namespace = Namespace.new(self)

    # Register the scope if it is not the top scope of a system
    # (in which case the system has already be registered with
    # the same name).
    unless name.empty? or systemT then
        # Named scope, set the hdl-like access to the scope.
        obj = self # For using the right self within the proc
        High.space_reg(name) { obj }
    end

    # Initialize the set of exported inner signals and instances
    @exports = {}
    # Initialize the set of included systems.
    # @includes = {}
    @includes = []

    # Builds the scope if a ruby block is provided.
    self.build(&ruby_block) if block_given?
end

Dynamic Method Handling

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

Instance Attribute Details

#name ⇒ Object (readonly)

The name of the scope if any.



899
900
901
 
# File 'lib/HDLRuby/hruby_high.rb', line 899

def name
  @name
end

#namespace ⇒ Object (readonly)

The namespace



902
903
904
 
# File 'lib/HDLRuby/hruby_high.rb', line 902

def namespace
  @namespace
end

#rcscope ⇒ Object (readonly)

The access to the C version of the scope.



152
153
154
 
# File 'lib/HDLRuby/hruby_rcsim.rb', line 152

def rcscope
  @rcscope
end

#return_value ⇒ Object (readonly)

The return value when building the scope.



905
906
907
 
# File 'lib/HDLRuby/hruby_high.rb', line 905

def return_value
  @return_value
end

Instance Method Details

#add_export(name) ⇒ Object

Adds a +name+ to export.

NOTE: if the name do not corresponds to any inner signal nor instance, raise an exception.

Raises:



986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
 
# File 'lib/HDLRuby/hruby_high.rb', line 986

def add_export(name)
    # Check the name.
    name = name.to_sym
    # Look for construct to make public.
    # Maybe it is an inner signals.
    inner = self.get_inner(name)
    if inner then
        # Yes set it as export.
        @exports[name] = inner
        return
    end
    # No, maybe it is an instance.
    instance = self.get_systemI(name)
    if instance then
        # Yes, set it as export.
        @exports[name] = instance
        return
    end
    # No, error.
    raise AnyError, "Invalid name for export: #{name}"
end

#add_groupI(name, *instances) ⇒ Object

Adds a group of system +instances+ named +name+.



951
952
953
954
955
956
957
958
959
960
961
962
963
 
# File 'lib/HDLRuby/hruby_high.rb', line 951

def add_groupI(name, *instances)
    # Ensure name is a symbol and is not already used for another
    # group.
    name = name.to_sym
    if @groupIs.key?(name)
        raise AnyError,
              "Group of system instances named #{name} already exist."
    end
    # Add the group.
    @groupIs[name.to_sym] = instances
    # Sets the parent of the instances.
    instances.each { |instance| instance.parent = self }
end

#add_inout(signal) ⇒ Object

Adds inout +signal+ in the current system.



1102
1103
1104
 
# File 'lib/HDLRuby/hruby_high.rb', line 1102

def add_inout(signal)
    self.parent.add_inout(signal)
end

#add_input(signal) ⇒ Object

Adds input +signal+ in the current system.



1092
1093
1094
 
# File 'lib/HDLRuby/hruby_high.rb', line 1092

def add_input(signal)
    self.parent.add_input(signal)
end

#add_output(signal) ⇒ Object

Adds output +signal+ in the current system.



1097
1098
1099
 
# File 'lib/HDLRuby/hruby_high.rb', line 1097

def add_output(signal)
    self.parent.add_output(signal)
end

#build(&ruby_block) ⇒ Object

Build the scope by executing +ruby_block+.

NOTE: used when the scope is not the top of a system.



1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
 
# File 'lib/HDLRuby/hruby_high.rb', line 1048

def build(&ruby_block)
    # Set the namespace for buidling the scope.
    High.space_push(@namespace)
    # Build the scope.
    @return_value = High.top_user.instance_eval(&ruby_block)
    # res = High.top_user.instance_eval(&ruby_block)
    High.space_pop
    # # Now gain access to the result within the sub scope.
    # # if (res.is_a?(HRef)) then
    # if (res.is_a?(HExpression)) then
    #     High.space_push(@namespace)
    #     @return_value = res.type.inner(HDLRuby.uniq_name)
    #     @return_value <= res
    #     High.space_pop
    #     @return_value = RefObject.new(self,@return_value)
    # else
    #     @return_value = res
    # end
    # This will be the return value.
    @return_value
end

#build_top(base, *args) ⇒ Object

Builds the scope using +base+ as model scope with possible arguments +args+.

NOTE: Used by the instantiation procedure of a system.



1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
 
# File 'lib/HDLRuby/hruby_high.rb', line 1075

def build_top(base,*args)
    # Fills its namespace with the content of the base scope
    # (this latter may already contains access points if it has been
    #  opended for extension previously).
    @namespace.concat_namespace(base.namespace)
    High.space_push(@namespace)
    # Execute the instantiation block
    base.parent.each_instance_proc do |instance_proc|
        @return_value = High.top_user.instance_exec(*args,&instance_proc)
    end
    High.space_pop
end

#code(*content, &ruby_block) ⇒ Object

Declares a non-HDLRuby set of code chunks described by +content+ and completed from +ruby_block+ execution result. NOTE: content includes the events to activate the code on and a description of the code as a hash assotiating names to code text.



1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
 
# File 'lib/HDLRuby/hruby_high.rb', line 1163

def code(*content, &ruby_block)
    # Process the content.
    # Separate events from code chunks descriptions.
    events, chunks = content.partition {|elem| elem.is_a?(Event) }
    # Generates a large hash from the code.
    chunks = chunks.reduce(:merge)
    # Adds the result of the ruby block if any.
    if ruby_block then
        chunks.merge(HDLRuby::High.top_user.instance_eval(&ruby_block))
    end
    # Create the chunk objects.
    chunks = chunks.each.map do |name,content|
        content = [*content]
        # Process the lumps
        content.map! do |lump|
            lump.respond_to?(:to_expr) ? lump.to_expr : lump
        end
        Chunk.new(name,*content)
    end
    # Create the code object.
    res = Code.new
    # Adds the events.
    events.each(&res.method(:add_event))
    # Adds the chunks.
    chunks.each(&res.method(:add_chunk))
    # Adds the resulting code to the current scope.
    HDLRuby::High.top_user.add_code(res)
    # Return the resulting code
    return res
end

#cur_system ⇒ Object

Gets the current system.



1389
1390
1391
 
# File 'lib/HDLRuby/hruby_high.rb', line 1389

def cur_system
    return HDLRuby::High.cur_system
end

#each_export(&ruby_block) ⇒ Object

Iterates over the exported constructs.

Returns an enumerator if no ruby block is given.



1011
1012
1013
1014
1015
1016
1017
1018
 
# File 'lib/HDLRuby/hruby_high.rb', line 1011

def each_export(&ruby_block)
    # No ruby block? Return an enumerator.
    return to_enum(:each_export) unless ruby_block
    # A block? Apply it on each input signal instance.
    @exports.each_value(&ruby_block)
    # And apply on the sub scopes if any.
    @scopes.each {|scope| scope.each_export(&ruby_block) }
end

#each_groupI(&ruby_block) ⇒ Object

Iterates over the group of system instances.

Returns an enumerator if no ruby block is given.



975
976
977
978
979
980
 
# File 'lib/HDLRuby/hruby_high.rb', line 975

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

#each_included(&ruby_block) ⇒ Object

Iterates over the included systems.



1021
1022
1023
1024
1025
1026
1027
1028
1029
 
# File 'lib/HDLRuby/hruby_high.rb', line 1021

def each_included(&ruby_block)
    # No ruby block? Return an enumerator.
    return to_enum(:each_included) unless ruby_block
    # A block? Apply it on each included system.
    # @includes.each_value(&ruby_block)
    @includes.each(&ruby_block)
    # And apply on the sub scopes if any.
    @scopes.each {|scope| scope.each_included(&ruby_block) }
end

#export(*names) ⇒ Object

Sets the constructs corresponding to +names+ as exports.



1328
1329
1330
 
# File 'lib/HDLRuby/hruby_high.rb', line 1328

def export(*names)
    names.each {|name| self.add_export(name) }
end

#fill_low(scopeL) ⇒ Object

Fills a low level scope with self's contents.

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



1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
 
# File 'lib/HDLRuby/hruby_high.rb', line 1464

def fill_low(scopeL)
    # Adds the content of its included systems.
    # @includes.each_value {|system| system.scope.fill_low(scopeL) }
    @includes.each {|system| system.scope.fill_low(scopeL) }
    # Adds the declared local system types.
    # NOTE: in the current version of HDLRuby::High, there should not
    # be any of them (only eigen systems are real system types).
    self.each_systemT { |systemT| scopeL.add_systemT(systemT.to_low) }
    # Adds the local types.
    self.each_type { |type| scopeL.add_type(type.to_low) }
    # Adds the inner scopes.
    self.each_scope { |scope| scopeL.add_scope(scope.to_low) }
    # Adds the inner signals.
    self.each_inner { |inner| scopeL.add_inner(inner.to_low) }
    # Adds the instances.
    # Single ones.
    self.each_systemI do |systemI|
        # puts "Filling with systemI=#{systemI.name}"
        systemI_low = scopeL.add_systemI(systemI.to_low)
        # Also add the eigen system to the list of local systems.
        scopeL.add_systemT(systemI_low.systemT)
    end
    # Grouped ones.
    self.each_groupI do |name,systemIs|
        systemIs.each.with_index { |systemI,i|
            # Sets the name of the system instance
            # (required for conversion of further accesses).
            # puts "systemI.respond_to?=#{systemI.respond_to?(:name=)}"
            systemI.name = name.to_s + "[#{i}]"
            # And convert it to low
            systemI_low = scopeL.add_systemI(systemI.to_low())
            # Also add the eigen system to the list of local systems.
            scopeL.add_systemT(systemI_low.systemT)
        }
    end
    # Adds the code chunks.
    self.each_code { |code| scopeL.add_code(code.to_low) }
    # Adds the connections.
    self.each_connection { |connection|
        # puts "connection=#{connection}"
        scopeL.add_connection(connection.to_low)
    }
    # Adds the behaviors.
    self.each_behavior { |behavior|
        scopeL.add_behavior(behavior.to_low)
    }
end

#fullname ⇒ Object

Returns the name of the signal with its hierarchy.



246
247
248
249
 
# File 'lib/HDLRuby/hruby_rsim.rb', line 246

def fullname
    @fullname ||= self.parent.fullname + ":" + self.name.to_s
    return @fullname
end

#get_groupI(name) ⇒ Object

Access a group of system instances by +name+.

NOTE: the result is a copy of the group for avoiding side effects.



968
969
970
 
# File 'lib/HDLRuby/hruby_high.rb', line 968

def get_groupI(name)
    return @groupIs[name.to_sym].clone
end

#get_vars_with_fullname(vars_with_fullname = {}) ⇒ Object

Gets the VCD variables with their long name.



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/HDLRuby/hruby_rsim_vcd.rb', line 146

def get_vars_with_fullname(vars_with_fullname = {})
    # Adds the inner signals.
    self.each_inner do |sig|
        vars_with_fullname[sig] = HDLRuby::High.vcd_name(sig.fullname)
    end
    # Recurse on the behaviors' blocks
    self.each_behavior do |beh|
        beh.block.get_vars_with_fullname(vars_with_fullname)
    end
    # Recurse on the systemI's Eigen system.
    self.each_systemI do |sys|
        sys.systemT.get_vars_with_fullname(vars_with_fullname)
    end
    # Recurse on the subscopes.
    self.each_scope do |scope|
        scope.get_vars_with_fullname(vars_with_fullname)
    end
    return vars_with_fullname
end

#hcase(value) ⇒ Object

Creates a new case statement with a +value+ used for deciding which block to execute.

NOTE:

  • the when part is defined through the hwhen method.
  • a new behavior is created to enclose the hcase.


1303
1304
1305
1306
1307
 
# File 'lib/HDLRuby/hruby_high.rb', line 1303

def hcase(value)
    self.par do
        hcase(value)
    end
end

#helse(mode = nil, &ruby_block) ⇒ Object

Sets the block executed when the condition is not met to the block in +mode+ generated by the execution of +ruby_block+.

Can only be used once.

NOTE: added to the hif of the last behavior.



1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
 
# File 'lib/HDLRuby/hruby_high.rb', line 1268

def helse(mode = nil, &ruby_block)
    # Ensure there is a block.
    ruby_block = proc {} unless block_given?
    # There is a ruby_block: the helse is assumed to be with
    # the last statement of the last behavior.
    statement = self.last_behavior.last_statement
    # Completes the hif or the hcase statement.
    unless statement.is_a?(If) or statement.is_a?(Case) then
        raise AnyError, "Error: helse statement without hif nor hcase (#{statement.class})."
    end
    statement.helse(mode, &ruby_block)
end

#helsif(condition, mode = nil, &ruby_block) ⇒ Object

Sets the condition check when the condition is not met to the block, with a +condition+ that when met lead to the execution of the block in +mode+ generated by the +ruby_block+.



1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
 
# File 'lib/HDLRuby/hruby_high.rb', line 1284

def helsif(condition, mode = nil, &ruby_block)
    # Ensure there is a block.
    ruby_block = proc {} unless block_given?
    # There is a ruby_block: the helse is assumed to be with
    # the last statement of the last behavior.
    statement = self.last_behavior.last_statement
    # Completes the hif statement.
    unless statement.is_a?(If) then
        raise AnyError, "Error: helsif statement without hif (#{statement.class})."
    end
    statement.helsif(condition, mode, &ruby_block)
end

#hif(condition, mode = nil, &ruby_block) ⇒ Object

Creates a new if statement with a +condition+ that when met lead to the execution of the block in +mode+ generated by the +ruby_block+.

NOTE:

  • the else part is defined through the helse method.
  • a behavior is created to enclose the hif.


1254
1255
1256
1257
1258
1259
1260
 
# File 'lib/HDLRuby/hruby_high.rb', line 1254

def hif(condition, mode = nil, &ruby_block)
    # Ensure there is a block.
    ruby_block = proc {} unless block_given?
    self.par do
        hif(condition,mode,&ruby_block)
    end
end

#hwhen(match, mode = nil, &ruby_block) ⇒ Object

Sets the block of a case structure executed when the +match+ is met to the block in +mode+ generated by the execution of +ruby_block+.

Can only be used once.



1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
 
# File 'lib/HDLRuby/hruby_high.rb', line 1313

def hwhen(match, mode = nil, &ruby_block)
    # Ensure there is a block.
    ruby_block = proc {} unless block_given?
    # There is a ruby_block: the helse is assumed to be with
    # the last statement of the last behavior.
    statement = @behaviors.last.last_statement
    # Completes the hcase statement.
    unless statement.is_a?(Case) then
        raise AnyError, "Error: hwhen statement without hcase (#{statement.class})."
    end
    statement.hwhen(match, mode, &ruby_block)
end

#include(system, *args) ⇒ Object

Include a +system+ type with possible +args+ instanciation arguments.



1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
 
# File 'lib/HDLRuby/hruby_high.rb', line 1334

def include(system,*args)
    # if @includes.key?(system.name) then
    #     raise AnyError, "Cannot include twice the same system: #{system}"
    # end
    if @includes.include?(system) then
        raise AnyError, "Cannot include twice the same system: #{system}"
    end
    # # puts "Include system=#{system.name}"
    # # Save the name of the included system, it will serve as key
    # # for looking for the included expanded version.
    # include_name = system.name
    # Expand the system to include
    system = system.expand(:"",*args)
    # Add the included system interface to the current one.
    if self.parent.is_a?(SystemT) then
        space = self.namespace
        # Interface signals
        # puts "i_name=#{i_name} @to_includes=#{@to_includes.size}"
        # system.each_signal_with_included do |signal|
        system.each_signal_all_with_included do |signal|
            # puts "signal=#{signal.name}"
            space.send(:define_singleton_method,signal.name) do
                signal
            end
        end
        # Exported objects
        system.each_export do |export|
            # puts "export=#{export.name}"
            space.send(:define_singleton_method,export.name) do
                export
            end
        end
        # Adds the task to execute on the instance.
        system.each_on_instance do |task|
            self.parent.on_instance(&task)
        end
    end
    # Adds it the list of includeds
    # @includes[include_name] = system
    @includes << system

    # puts "@includes=#{@includes}"
    
end

#init_sim(systemT) ⇒ Object

Initialize the simulation for system +systemT+.



232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/HDLRuby/hruby_rsim.rb', line 232

def init_sim(systemT)
    # Recurse on the inner signals.
    self.each_inner { |sig| sig.init_sim(systemT) }
    # Recurse on the behaviors.
    self.each_behavior { |beh| beh.init_sim(systemT) }
    # Recurse on the systemI.
    self.each_systemI { |sys| sys.init_sim(systemT) }
    # Recurse on the connections.
    self.each_connection { |cnx| cnx.init_sim(systemT) }
    # Recurse on the sub scopes.
    self.each_scope { |sco| sco.init_sim(systemT) }
end

#inout(*names) ⇒ Object

Declares high-level bit inout signals named +names+ in the current system.



1154
1155
1156
 
# File 'lib/HDLRuby/hruby_high.rb', line 1154

def inout(*names)
    self.parent.inout(*names)
end

#input(*names) ⇒ Object

Declares high-level bit input signals named +names+ in the current system.



1142
1143
1144
 
# File 'lib/HDLRuby/hruby_high.rb', line 1142

def input(*names)
    self.parent.input(*names)
end

#make_inouts(type, *names) ⇒ Object

Creates and adds a set of inouts typed +type+ from a list of +names+ in the current system.

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



1126
1127
1128
 
# File 'lib/HDLRuby/hruby_high.rb', line 1126

def make_inouts(type, *names)
    self.parent.make_inouts(type,*names)
end

#make_inputs(type, *names) ⇒ Object

Creates and adds a set of inputs typed +type+ from a list of +names+ in the current system.

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



1110
1111
1112
 
# File 'lib/HDLRuby/hruby_high.rb', line 1110

def make_inputs(type, *names)
    self.parent.make_inputs(type,*names)
end

#make_outputs(type, *names) ⇒ Object

Creates and adds a set of outputs typed +type+ from a list of +names+ in the current system.

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



1118
1119
1120
 
# File 'lib/HDLRuby/hruby_high.rb', line 1118

def make_outputs(type, *names)
    self.parent.make_outputs(type,*names)
end

#merge_included(systemT) ⇒ Object

Merge the included systems interface in +systemT+ NOTE: incompatible with further to_low transformation.



1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
 
# File 'lib/HDLRuby/hruby_high.rb', line 1399

def merge_included(systemT)
    # Recurse on the sub.
    self.each_scope {|scope| scope.merge_included(systemT) }
    # Include for current scope.
    self.each_included do |included|
        included.merge_included!
        # Adds its interface signals.
        included.each_input do |input|
            input.no_parent!
            systemT.add_input(input)
        end
        included.each_output do |output|  
            output.no_parent!
            systemT.add_output(output)
        end
        included.each_inout do |inout|  
            inout.no_parent!
            systemT.add_inout(inout)
        end
        # Adds its behaviors.
        included.scope.each_behavior do |beh|
            beh.no_parent!
            systemT.scope.add_behavior(beh)
        end
        # Adds its connections.
        included.scope.each_connection do |cx|
            cx.no_parent!
            systemT.scope.add_connection(cx)
        end
        # Adds its sytem instances.
        included.scope.each_systemI do |sys|
            sys.no_parent!
            systemT.scope.add_systemI(sys)
        end
        # Adds its code.
        included.scope.each_code do |code|
            code.no_parent!
            systemT.scope.add_code(code)
        end
        # Adds its subscopes.
        included.scope.each_scope do |scope|
            scope.no_parent!
            systemT.scope.add_scope(scope)
        end
        # Add its inner signals.
        included.scope.each_inner do |inner|
            inner.no_parent!
            systemT.scope.add_inner(inner)
        end
    end
end

#merge_included! ⇒ Object

Merge the included systems interface in system instances. NOTE: incompatible with further to_low transformation.



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

def merge_included!
    # Recurse on the sub.
    self.each_scope {|scope| scope.merge_included! }
    # Merge in the system instances.
    self.each_systemI {|systemI| systemI.systemT.merge_included! }
end

#open(&ruby_block) ⇒ Object

Opens for extension.

NOTE: actually executes +ruby_block+ in the context.



1035
1036
1037
1038
1039
1040
1041
1042
 
# File 'lib/HDLRuby/hruby_high.rb', line 1035

def open(&ruby_block)
    High.space_push(@namespace)
    res = High.top_user.instance_eval(&ruby_block)
    High.space_pop
    # Return the result of the execution so that it can be used
    # as an expression
    res
end

#output(*names) ⇒ Object

Declares high-level bit output signals named +names+ in the current system.



1148
1149
1150
 
# File 'lib/HDLRuby/hruby_high.rb', line 1148

def output(*names)
    self.parent.output(*names)
end

#par(*events, &ruby_block) ⇒ Object

Declares a high-level parallel behavior activated on a list of +events+, and built by executing +ruby_block+.



1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
 
# File 'lib/HDLRuby/hruby_high.rb', line 1226

def par(*events, &ruby_block)
    # Ensure there is a block.
    ruby_block = proc {} unless block_given?
    # Preprocess the events.
    events.map! do |event|
        event.respond_to?(:to_event) ? event.to_event : event
    end
    # Create and add the resulting behavior.
    self.add_behavior(Behavior.new(:par,*events,&ruby_block))
end

#seq(*events, &ruby_block) ⇒ Object

Declares a high-level sequential behavior activated on a list of +events+, and built by executing +ruby_block+.



1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
 
# File 'lib/HDLRuby/hruby_high.rb', line 1213

def seq(*events, &ruby_block)
    # Ensure there is a block.
    ruby_block = proc {} unless block_given?
    # Preprocess the events.
    events.map! do |event|
        event.respond_to?(:to_event) ? event.to_event : event
    end
    # Create and add the resulting behavior.
    self.add_behavior(Behavior.new(:seq,*events,&ruby_block))
end

#show_hierarchy(vcdout) ⇒ Object

Shows the hierarchy of the variables.



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/HDLRuby/hruby_rsim_vcd.rb', line 112

def show_hierarchy(vcdout)
    # puts "show_hierarchy for scope=#{self}"
    # Shows the current level of hierarchy if there is a name.
    ismodule = false
    if  !self.name.empty? && !self.parent.is_a?(SystemT) then
        vcdout << "$scope module #{HDLRuby::High.vcd_name(self.fullname)} $end\n"
        ismodule = true
    end
    # Shows the inner signals.
    self.each_inner do |sig|
        # puts "showing inner signal #{HDLRuby::High.vcd_name(sig.fullname)}"
        vcdout << "$var wire #{sig.type.width} "
        vcdout << "#{HDLRuby::High.vcd_name(sig.fullname)} "
        vcdout << "#{HDLRuby::High.vcd_name(sig.name)} $end\n"
    end
    # Recurse on the behaviors' blocks
    self.each_behavior do |beh|
        beh.block.show_hierarchy(vcdout)
    end
    # Recurse on the systemI's Eigen system.
    self.each_systemI do |sys|
        sys.systemT.show_hierarchy(vcdout)
    end
    # Recurse on the subscopes.
    self.each_scope do |scope|
        scope.show_hierarchy(vcdout)
    end
    # Close the current level of hierarchy if there is a name.
    if ismodule then
        vcdout << "$upscope $end\n"
    end
end

#sub(name = :"", &ruby_block) ⇒ Object

Declares a sub scope with possible +name+ and built from +ruby_block+.



1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
 
# File 'lib/HDLRuby/hruby_high.rb', line 1195

def sub(name = :"", &ruby_block)
    # Ensure there is a block.
    ruby_block = proc {} unless block_given?
    # Creates the new scope.
    # scope = Scope.new(name,&ruby_block)
    scope = Scope.new(name)
    # Add it
    self.add_scope(scope)
    # Build it.
    scope.build(&ruby_block)
    # puts "self=#{self}"
    # puts "self scopes=#{self.each_scope.to_a.join(",")}"
    # Use its return value
    return scope.return_value
end

#timed(&ruby_block) ⇒ Object

Declares a high-level timed behavior built by executing +ruby_block+. By default, timed behavior are sequential.



1239
1240
1241
1242
1243
1244
 
# File 'lib/HDLRuby/hruby_high.rb', line 1239

def timed(&ruby_block)
    # Ensure there is a block.
    ruby_block = proc {} unless block_given?
    # Create and add the resulting behavior.
    self.add_behavior(TimeBehavior.new(:seq,&ruby_block))
end

#to_low ⇒ Object

Converts the scope to HDLRuby::Low.



1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
 
# File 'lib/HDLRuby/hruby_high.rb', line 1513

def to_low()
    # Create the resulting low scope.
    # scopeL = HDLRuby::Low::Scope.new()
    scopeL = HDLRuby::Low::Scope.new(self.name)
    # # For debugging: set the source high object 
    # scopeL.properties[:low2high] = self.hdr_id
    # self.properties[:high2low] = scopeL

    # Push the private namespace for the low generation.
    High.space_push(@namespace)
    # Pushes on the name stack for converting the internals of
    # the system.
    High.names_push
    # Adds the content of the actual system.
    self.fill_low(scopeL)
    # Restores the name stack.
    High.names_pop
    # Restores the namespace stack.
    High.space_pop
    # Return theresulting system.
    return scopeL
end

#to_rcsim(rcowner) ⇒ Object

Generate the C description of the scope comming from object whose C description is +rcowner+



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/HDLRuby/hruby_rcsim.rb', line 156

def to_rcsim(rcowner)
    # puts "to_rcsim for scope=#{self}"
    # Create the scope C object.
    @rcscope = RCSim.rcsim_make_scope(self.name.to_s)

    # Set the owner.
    RCSim.rcsim_set_owner(@rcscope,rcowner)

    # Of the scope is a son of a SystemT, the owner of the sub objects
    # will be this systemT. Otherwise, it is the scope.
    subowner = self.parent.is_a?(SystemT) ? rcowner : @rcscope

    # Create and add the inner signals.
    # self.each_inner do |sig|
    #     rcsig = sig.to_rcsim(@rcscope)
    #     RCSim.rcsim_add_scope_inner(@rcscope,rcsig)
    # end
    RCSim.rcsim_add_scope_inners(@rcscope,self.each_inner.map do |sig|
        # sig.to_rcsim(@rcscope)
        sig.to_rcsim(subowner)
    end)
    
    # Create and add the system instances.
    # self.each_systemI do |sys|
    #     rcsys = sys.to_rcsim(@rcscope)
    #     RCSim.rcsim_add_scope_systemI(@rcscope,rcsys)
    # end
    RCSim.rcsim_add_scope_systemIs(@rcscope,
                                   self.each_systemI.map do |sys|
        # sys.to_rcsim(@rcscope)
        sys.to_rcsim(subowner)
    end)

    # Create and add the behaviors.
    # self.each_behavior do |beh|
    #     rcbeh = beh.to_rcsim(@rcscope)
    #     RCSim.rcsim_add_scope_behavior(@rcscope,rcbeh)
    # end
    RCSim.rcsim_add_scope_behaviors(@rcscope,
                                    self.each_behavior.map do |beh|
        # beh.to_rcsim(@rcscope)
        beh.to_rcsim(subowner)
    end)

    # Create and add the connections.
    # self.each_connection do |cnx|
    #     rccnx = cnx.to_rcsim(@rcscope)
    #     # Connections are actually converted to behaviors.
    #     RCSim.rcsim_add_scope_behavior(@rcscope,rccnx)
    # end
    RCSim.rcsim_add_scope_behaviors(@rcscope, 
                                    self.each_connection.map do |cxt|
        # cxt.to_rcsim(@rcscope)
        cxt.to_rcsim(subowner)
    end)

    # Create and add the codes.
    # TODO!!

    # Create and add the sub scopes.
    # self.each_scope do |sub|
    #     rcsub = sub.to_rcsim(@rcscope)
    #     RCSim.rcsim_add_scope_scope(@rcscope,rcsub)
    # end
    RCSim.rcsim_add_scope_scopes(@rcscope,self.each_scope.map do |sub|
        # sub.to_rcsim(@rcscope)
        sub.to_rcsim(subowner)
    end)

    return @rcscope
end

#to_ref ⇒ Object

Converts to a new reference.



1131
1132
1133
 
# File 'lib/HDLRuby/hruby_high.rb', line 1131

def to_ref
    return RefObject.new(this,self)
end

#to_user ⇒ Object

Converts to a namespace user.



945
946
947
948
 
# File 'lib/HDLRuby/hruby_high.rb', line 945

def to_user
    # Already a user.
    return self
end