Class Voodoo::CommonCodeGenerator
In: voodoo/generators/common_code_generator.rb
Parent: Object

Common base class for code generators.

Code generators are expected to implement the following methods:

This class contains base implementations of some of these methods, which can be used and/or overridden by subclasses.

An example of how to use the code generators provided by this module is provided on the main page of the documentation of the Voodoo module.

Methods

add   add_function   block   each_statement   emit   features   function   gensym   has_feature?   in_section   new   output_file_name   output_file_suffix   real_section_name   section   section=   section_alias  

Classes and Modules

Class Voodoo::CommonCodeGenerator::Environment

Public Class methods

new(params = {})

Initializes the code generator. params shall be a hash containing parameters to the code generator, and shall at least contain the keys :architecture and :format, specifying the target architecture and output format, respectively.

Public Instance methods

add(section, *code)

Adds code to the given section.

Examples: 

  add :code, [:return, 0]
  add :data, [:align], [:label, :xyzzy], [:word, 42]

This method implements the required functionality in terms of the following methods, which must be implemented by subclasses:

  • align
  • asr
  • bsr
  • byte
  • call
  • end_if
  • export
  • begin_function
  • block
  • ifelse
  • ifeq
  • ifge
  • ifgt
  • ifle
  • iflt
  • ifne
  • import
  • label
  • let
  • ret
  • rol
  • ror
  • set
  • set_byte
  • set_word
  • shl
  • shr
  • string
  • word
add_function(formals, *code)

Add function.

Parameters:

formals
an Array of formal parameter names
code
an Array of actions to be used as the function‘s body

Example: 

  add_function [:n], [:return, :add, :n, 1]
block(*code)

Processes code in its own block. Local variables can be introduced inside the block. They will be deleted at the end of the block.

each_statement(statements) {|statement| ...}

Invokes block with each statement in the given list of statements. This iterator also descends into nested statements, calling block first with the outer statement, and then for each inner statement.

emit(code)

Add code to the current section

features()

Returns a hash describing the features supported by this code generator. The keys in this hash are the names of the supported features. The associated values are strings providing additional information about the feature, such as a version number.

gensym()

Generate a new, unused symbol

has_feature?(name)

Returns true if a feature is supported by this generator, false otherwise.

output_file_name(input_name)

Given an input file name, returns the canonical output file name for this code generator.

output_file_suffix()

Returns the canonical output file suffix for this code generator

real_section_name(name)

Get the real name of a section. Given a section name which may be an alias, this method returns the real name of the section.

section=(name)

Set the current section

section_alias(alias_name, original_name)

Set up alias_name to refer to the same section as original_name.

[Validate]