Class: HDLRuby::Low::Statement

Inherits:
Object
  • Object
show all
Includes:
Hparent, Low2Symbol
Defined in:
lib/HDLRuby/hruby_low.rb,
lib/HDLRuby/hruby_low2c.rb,
lib/HDLRuby/hruby_low2hdr.rb,
lib/HDLRuby/hruby_low2seq.rb,
lib/HDLRuby/hruby_low2sym.rb,
lib/HDLRuby/hruby_low2vhd.rb,
lib/HDLRuby/hruby_low2high.rb,
lib/HDLRuby/hruby_low_cleanup.rb,
lib/HDLRuby/hruby_low_mutable.rb,
lib/HDLRuby/hruby_low_skeleton.rb,
lib/HDLRuby/hruby_low_fix_types.rb,
lib/HDLRuby/hruby_low_with_bool.rb,
lib/HDLRuby/hruby_low_without_parinseq.rb,
lib/HDLRuby/hruby_low_without_namespace.rb

Overview

Describes a statement.

NOTE: this is an abstract class which is not to be used directly.

Constant Summary

Constants included from Low2Symbol

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

Instance Attribute Summary

Attributes included from Hparent

#parent

Instance Method Summary collapse

Methods included from Low2Symbol

#to_sym

Methods included from Hparent

#absolute_ref, #hierarchy, #no_parent!

Instance Method Details

#add_blocks_code(res, level) ⇒ Object

Adds the c code of the blocks to +res+ at +level+



1348
1349
1350
1351
1352
1353
1354
1355
1356
 
# File 'lib/HDLRuby/hruby_low2c.rb', line 1348

def add_blocks_code(res,level)
    if self.respond_to?(:each_node) then
        self.each_node do |node|
            if node.respond_to?(:add_blocks_code) then
                node.add_blocks_code(res,level)
            end
        end
    end
end

#add_make_block(res, level) ⇒ Object

Adds the creation of the blocks to +res+ at +level+.



1359
1360
1361
1362
1363
1364
1365
1366
1367
 
# File 'lib/HDLRuby/hruby_low2c.rb', line 1359

def add_make_block(res,level)
    if self.respond_to?(:each_node) then
        self.each_node do |node|
            if node.respond_to?(:add_blocks_code) then
                node.add_make_block(res,level)
            end
        end
    end
end

#behavior ⇒ Object

Gets the behavior the statement is in.



3293
3294
3295
3296
3297
3298
3299
 
# File 'lib/HDLRuby/hruby_low.rb', line 3293

def behavior
    if self.parent.is_a?(Behavior) then
        return self.parent
    else
        return self.parent.behavior
    end
end

#block ⇒ Object

Get the block of the statement.



3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
 
# File 'lib/HDLRuby/hruby_low.rb', line 3270

def block
    if self.is_a?(Block)
        return self
    elsif self.parent.is_a?(Scope)
        # No block
        return nil
    else
        return self.parent.block
    end
end

#blocks2seq! ⇒ Object

Converts the par sub blocks to seq.



85
86
87
88
 
# File 'lib/HDLRuby/hruby_low2seq.rb', line 85

def blocks2seq!
    # By default, nothing to do.
    return self
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.



511
512
513
514
515
 
# File 'lib/HDLRuby/hruby_low_without_namespace.rb', line 511

def break_types!(types)
    self.each_node do |node|
        node.break_types!(types)
    end
end

#clone ⇒ Object

Clones (deeply)

Raises:



3235
3236
3237
3238
 
# File 'lib/HDLRuby/hruby_low.rb', line 3235

def clone
    raise AnyError,
          "Internal error: clone is not defined for class: #{self.class}"
end

#delete_related!(*names) ⇒ Object

Deletes the elements related to one of +names+: either they have one of the names or they use an element with these names. NOTE: only delete actual instantiated elements, types or systemTs are left as is.



537
538
539
 
# File 'lib/HDLRuby/hruby_low_mutable.rb', line 537

def delete_related!(*names)
    # Nothing to do by default.
end

#delete_unless!(keep) ⇒ Object

Removes the signals and corresponding assignments whose name is not in +keep+.



116
117
118
 
# File 'lib/HDLRuby/hruby_low_cleanup.rb', line 116

def delete_unless!(keep)
    # By default nothing to do.
end

#each_deep(&ruby_block) ⇒ Object

Iterates over each object deeply.

Returns an enumerator if no ruby block is given.

Raises:



3243
3244
3245
3246
 
# File 'lib/HDLRuby/hruby_low.rb', line 3243

def each_deep(&ruby_block)
    raise AnyError,
        "Internal error: each_deep is not defined for class: #{self.class}"
end

#each_statement(&ruby_block) ⇒ Object

Iterates over each sub statement if any.

Returns an enumerator if no ruby block is given.



3263
3264
3265
3266
3267
 
# File 'lib/HDLRuby/hruby_low.rb', line 3263

def each_statement(&ruby_block)
    # No ruby statement? Return an enumerator.
    return to_enum(:each_statement) unless ruby_block
    # By default: nothing to do.
end

#eql?(obj) ⇒ Boolean

Comparison for hash: structural comparison.

Returns:

  • (Boolean)

Raises:



3249
3250
3251
3252
 
# File 'lib/HDLRuby/hruby_low.rb', line 3249

def eql?(obj)
    raise AnyError,
        "Internal error: eql? is not defined for class: #{self.class}"
end

#explicit_types! ⇒ Object

Explicit the types conversions in the statement.



78
79
80
 
# File 'lib/HDLRuby/hruby_low_fix_types.rb', line 78

def explicit_types!
    raise "Should implement explicit_types! for class #{self.class}."
end

#extract_declares! ⇒ Object

Extract the declares from the scope and returns them into an array.

NOTE: do not recurse into the sub scopes or behaviors!



493
494
495
496
 
# File 'lib/HDLRuby/hruby_low_without_namespace.rb', line 493

def extract_declares!
    # By default, nothing to do.
    return []
end

#fix_scope_refnames!(scopes) ⇒ Object

Fix the references names using scopes given in +scopes + list (they are marked to be deleted).



519
520
521
522
 
# File 'lib/HDLRuby/hruby_low_without_namespace.rb', line 519

def fix_scope_refnames!(scopes)
  # By default, does nothing.
  return self
end

#hash ⇒ Object

Hash function.

Raises:



3255
3256
3257
3258
 
# File 'lib/HDLRuby/hruby_low.rb', line 3255

def hash
    raise AnyError,
        "Internal error: hash is not defined for class: #{self.class}"
end

#mix?(mode = nil) ⇒ Boolean

Tell if there is a mix block. +mode+ is the mode of the upper block.

Returns:

  • (Boolean) 


92
93
94
95
 
# File 'lib/HDLRuby/hruby_low2seq.rb', line 92

def mix?(mode = nil)
    # By default, no mix block.
    return false
end

#par_in_seq2seq! ⇒ Object

Converts par blocks within seq blocks to seq blocks.



48
49
50
51
 
# File 'lib/HDLRuby/hruby_low_without_parinseq.rb', line 48

def par_in_seq2seq!
    # By default nothing to do.
    return self
end

#parent_system ⇒ Object

Gets the parent system, i.e., the parent of the top scope.



3312
3313
3314
 
# File 'lib/HDLRuby/hruby_low.rb', line 3312

def parent_system
    return self.top_scope.parent
end

#replace_expressions!(node2rep) ⇒ Object

Replaces sub expressions using +node2rep+ table indicating the node to replace and the corresponding replacement. Returns the actually replaced nodes and their corresponding replacement.

NOTE: the replacement is duplicated.



528
529
530
531
 
# File 'lib/HDLRuby/hruby_low_mutable.rb', line 528

def replace_expressions!(node2rep)
    # By default: nothing to do.
    return {}
end

#replace_names!(former, nname) ⇒ Object

Replaces recursively +former+ name by +nname+ until it is redeclared.



499
500
501
502
503
504
505
506
 
# File 'lib/HDLRuby/hruby_low_without_namespace.rb', line 499

def replace_names!(former,nname)
    # By default: try to replace the name recursively.
    self.each_node_deep do |node|
        if node.respond_to?(:name) && node.name == former then
            node.set_name!(nname)
        end
    end
end

#scope ⇒ Object

Get the scope of the statement.



3282
3283
3284
3285
3286
3287
3288
3289
3290
 
# File 'lib/HDLRuby/hruby_low.rb', line 3282

def scope
    if self.parent.is_a?(Scope) then
        return self.parent
    elsif self.parent.is_a?(Behavior) then
        return self.parent.parent
    else
        return self.parent.scope
    end
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)

Raises:



1334
1335
1336
1337
 
# File 'lib/HDLRuby/hruby_low2c.rb', line 1334

def to_c(res,level = 0)
    # Should never be here.
    raise AnyError, "Internal error: to_c should be implemented in class :#{self.class}"
end

#to_ch(res) ⇒ Object

Generates the content of the h file. def to_ch



1341
1342
1343
1344
1345
 
# File 'lib/HDLRuby/hruby_low2c.rb', line 1341

def to_ch(res)
    # By default nothing to generate.
    # return ""
    return res
end

#to_hdr(level = 0) ⇒ Object

Generates the text of the equivalent hdr text. +level+ is the hierachical level of the object.

Raises:



332
333
334
335
 
# File 'lib/HDLRuby/hruby_low2hdr.rb', line 332

def to_hdr(level = 0)
    # Should never be here.
    raise AnyError, "Internal error: to_high should be implemented in class :#{self.class}"
end

#to_high ⇒ Object

Creates a new high statement.

Raises:



250
251
252
253
 
# File 'lib/HDLRuby/hruby_low2high.rb', line 250

def to_high
    raise AnyError,
          "Internal error: to_high is not defined for class: #{self.class}"
end

#to_seq! ⇒ Object

Convert the block to seq.



54
55
56
57
 
# File 'lib/HDLRuby/hruby_low_without_parinseq.rb', line 54

def to_seq!
    # By default nothing to do.
    return self
end

#to_upper_space! ⇒ Object

Moves the declarations to the upper namespace.



486
487
488
 
# File 'lib/HDLRuby/hruby_low_without_namespace.rb', line 486

def to_upper_space!
    # By default, nothing to do.
end

#to_vhdl(vars, level = 0) ⇒ Object

Generates the text of the equivalent HDLRuby::High code. +vars+ is the list of the variables and +level+ is the hierachical level of the object.

Raises:



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

def to_vhdl(vars, level = 0)
    # Should never be here.
    raise AnyError, "Internal error: to_vhdl should be implemented in class :#{self.class}"
end

#top_block ⇒ Object

Gets the top block, i.e. the first block of the current behavior.



3302
3303
3304
 
# File 'lib/HDLRuby/hruby_low.rb', line 3302

def top_block
    return self.parent.is_a?(Behavior) ? self : self.parent.top_block
end

#top_scope ⇒ Object

Gets the top scope, i.e. the first scope of the current system.



3307
3308
3309
 
# File 'lib/HDLRuby/hruby_low.rb', line 3307

def top_scope
    return self.scope.top_scope
end

#use_name?(*names) ⇒ Boolean

Tell if the statement includes a signal whose name is one of +names+.

Returns:

  • (Boolean) 


3317
3318
3319
 
# File 'lib/HDLRuby/hruby_low.rb', line 3317

def use_name?(*names)
    # By default, nothing to do.
end

#with_boolean! ⇒ Object

Converts to a variable-compatible system.

NOTE: the result is the same Behaviour.



94
95
96
97
98
99
100
 
# File 'lib/HDLRuby/hruby_low_with_bool.rb', line 94

def with_boolean!
    self.each_node do |node| 
        if node.is_a?(Expression) && node.boolean? then
            node.set_type!(HDLRuby::Low::Boolean)
        end
    end
end