ruby-vpi 15.0.2 → 16.0.0

data/Rakefile

@@ -1,25 +1,9 @@
 # = Environment variables
 # CFLAGS:: Arguments to the compiler.
 # LDFLAGS:: Arguments to the linker.
-=begin
-  Copyright 2006 Suraj N. Kurapati
-
-  This file is part of Ruby-VPI.
-
-  Ruby-VPI is free software; you can redistribute it and/or
-  modify it under the terms of the GNU General Public License
-  as published by the Free Software Foundation; either version 2
-  of the License, or (at your option) any later version.
-
-  Ruby-VPI is distributed in the hope that it will be useful,
-  but WITHOUT ANY WARRANTY; without even the implied warranty of
-  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-  GNU General Public License for more details.
-
-  You should have received a copy of the GNU General Public License
-  along with Ruby-VPI; if not, write to the Free Software Foundation,
-  Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
-=end
+#--
+# Copyright 2006-2007 Suraj N. Kurapati
+# See the file named LICENSE for details.
 
 CFLAGS, LDFLAGS = ENV['CFLAGS'], ENV['LDFLAGS']
 
@@ -36,245 +20,238 @@ $:.unshift PROJECT_LIBS
 require 'ruby-vpi'
 require 'ruby-vpi/rake'
 
+task :default => :build
 
-include RubyVpi::Config
-PROJECT_SSH_URL = "snk@rubyforge.org:/var/www/gforge-projects/#{PROJECT_ID}"
-
-load 'doc/history.rb'
-head = @history.first
-PROJECT_VERSION = head['Version']
-PROJECT_BIRTHDAY = head['Date']
 
+# load project information
+  include RubyVpi::Config
+  PROJECT_SSH_URL = "snk@rubyforge.org:/var/www/gforge-projects/#{PROJECT_ID}"
 
-# Returns a temporary, unique path ready for use. No file exists at the returned path.
-def generate_temp_path
-  rm_f path = Tempfile.new($$).path
-  path
-end
+  load 'doc/history.rb'
+  head = @history.first
+  PROJECT_VERSION = head['Version']
+  PROJECT_BIRTHDAY = head['Date']
 
-# uploads the given sources to the given destination URL
-def upload aDestUrl, *aSources
-  sh 'rsync', '-avz', '--delete', aSources, aDestUrl
-end
 
+# utility
 
+  # Returns a temporary, unique path ready for use. No file exists at the
+  # returned path.
+  def generate_temp_path
+    rm_f path = Tempfile.new($$).path
+    path
+  end
 
-task :default => :build
+  # uploads the given sources to the given destination URL
+  def upload aDestUrl, *aSources
+    sh 'rsync', '-avz', '--delete', aSources, aDestUrl
+  end
 
-[:clean, :clobber].each do |t|
-  task t do
-    files = FileList['**/Rakefile'].exclude('_darcs')
-    files.shift # avoid infinite loop on _this_ file
+  # propogate cleaning tasks recursively to lower levels
+  [:clean, :clobber].each do |t|
+    task t do
+      files = FileList['**/Rakefile'].exclude('_darcs')
+      files.shift # avoid infinite loop on _this_ file
 
-    # allows propogation to lower levels when gem not installed
-    ENV['RUBYLIB'] = PROJECT_LIBS
+      # allows propogation to lower levels when gem not installed
+      ENV['RUBYLIB'] = PROJECT_LIBS
 
-    files.each do |f|
-      cd File.dirname(f) do
-        sh 'rake', t.to_s
+      files.each do |f|
+        cd File.dirname(f) do
+          sh 'rake', t.to_s
+        end
       end
     end
   end
-end
 
 
+# extension
 
-## extension
+  desc "Builds object files for all simulators."
+  task :build
 
-desc "Builds object files for all simulators."
-task :build
+  directory 'obj'
+  CLOBBER.include 'obj'
 
-directory 'obj'
-CLOBBER.include 'obj'
+  SIMULATORS.each_pair do |id, sim|
+    taskName = "build_#{id}"
 
+    desc "Builds object files for #{sim.name}."
+    task taskName => ['obj', 'ext'] do
+      src = "#{PROJECT_ID}.so"
+      dst = "#{PROJECT_ID}.#{id}.so"
 
-SIMULATORS.each do |sim|
-  taskName = "build_#{sim.id}"
+      dst = File.expand_path(File.join('obj', dst))
 
-  desc "Builds object files for #{sim.name} simulator."
-  task taskName => ['obj', 'ext'] do
-    src = "#{PROJECT_ID}.so"
-    dst = "#{PROJECT_ID}.#{sim.id}.so"
+      unless File.exist? dst
+        cd 'ext' do
+          ENV['CFLAGS'] = "#{CFLAGS} #{sim.compiler_args}"
+          ENV['LDFLAGS'] = "#{LDFLAGS} #{sim.linker_args}"
 
-    dst = File.expand_path(File.join('obj', dst))
-
-    unless File.exist? dst
-      cd 'ext' do
-        ENV['CFLAGS'] = "#{CFLAGS} #{sim.compiler_args}"
-        ENV['LDFLAGS'] = "#{LDFLAGS} #{sim.linker_args}"
-
-        sh 'rake'
-        mv src, dst
-        sh 'rake clean'
+          sh 'rake'
+          mv src, dst
+          sh 'rake clean'
+        end
       end
     end
-  end
-
-  task :build => taskName
-end
-
 
-
-## documentation
-
-desc 'Generate user documentation.'
-task :doc do |t|
-  cd t.name do
-    sh 'rake'
+    task :build => taskName
   end
-end
 
 
-directory 'ref'
-CLOBBER.include 'ref'
-
-desc 'Generate reference documentation.'
-file 'ref' => ['ref/c', 'ref/ruby']
+# documentation
 
+  desc 'Generate user documentation.'
+  task :doc do |t|
+    cd t.name do
+      sh 'rake'
+    end
+  end
 
-directory 'ref/ruby'
-CLOBBER.include 'ref/ruby'
 
-desc 'Generate reference for Ruby.'
-Rake::RDocTask.new 'ref/ruby' do |t|
-  t.rdoc_dir = t.name
-  t.title = "#{PROJECT_NAME}: #{PROJECT_SUMMARY}"
-  t.options.concat %w(--charset utf-8 --line-numbers)
-  t.rdoc_files.include '{bin,lib/**}/*.rb'
-end
+  directory 'ref'
+  CLOBBER.include 'ref'
 
+  desc 'Generate reference documentation.'
+  file 'ref' => ['ref/c', 'ref/ruby']
 
-directory 'ref/c'
-CLOBBER.include 'ref/c'
 
-desc 'Generate reference for C.'
-file 'ref/c' do |t|
-  # doxygen outputs to this temporary destination
-  tempDest = 'ext/html'
+  directory 'ref/ruby'
+  CLOBBER.include 'ref/ruby'
 
-  cd File.dirname(tempDest) do
-    sh "doxygen"
+  desc 'Generate reference for Ruby.'
+  Rake::RDocTask.new 'ref/ruby' do |t|
+    t.rdoc_dir = t.name
+    t.title = "#{PROJECT_NAME}: #{PROJECT_SUMMARY}"
+    t.options.concat %w(--charset utf-8 --line-numbers)
+    t.rdoc_files.include '{bin,lib/**}/*.rb'
   end
 
-  mv FileList[tempDest + '/*'].to_a, t.name
-  rmdir tempDest
-end
 
+  directory 'ref/c'
+  CLOBBER.include 'ref/c'
 
-desc 'Generate release announcement.'
-task :ann => 'doc/history.rb' do |t|
-  require t.prerequisites[0]
-  text = [
-    PROJECT_DETAIL,
-    "* " + PROJECT_URL,
-    "---",
-    format_history_entry(@history.first)
-  ].join "\n\n"
+  desc 'Generate reference for C.'
+  file 'ref/c' do |t|
+    # doxygen outputs to this temporary destination
+    tempDest = 'ext/html'
 
-  require 'doc/lib/doc_format'
-  html = text.redcloth
+    cd File.dirname(tempDest) do
+      sh "doxygen"
+    end
 
-  IO.popen('w3m -T text/html -dump -cols 60', 'w+') do |pipe|
-    pipe.write html
-    pipe.close_write
-    puts pipe.read
+    mv FileList[tempDest + '/*'].to_a, t.name
+    rmdir tempDest
   end
-end
-
 
 
-## distribution
+# distribution
 
-desc "Prepare for distribution."
-task :dist => ['ext', 'ref', :doc] do |t|
-  cd 'ext' do
-    sh 'rake swig'
+  desc "Prepare for distribution."
+  task :dist => ['ext', 'ref', :doc] do |t|
+    cd 'ext' do
+      sh 'rake swig'
+    end
   end
-end
-
 
-desc 'Publish documentation to website.'
-task :web => [:web_ref, :web_doc]
+  desc 'Publish documentation to website.'
+  task :web => [:web_ref, :web_doc]
 
-desc "Publish reference documentation."
-task :web_ref => 'ref' do |t|
-  upload PROJECT_SSH_URL, *t.prerequisites
-end
-
-desc "Publish user documentation."
-task :web_doc => 'doc' do |t|
-  upload PROJECT_SSH_URL, *t.prerequisites
-end
+  desc "Publish reference documentation."
+  task :web_ref => 'ref' do |t|
+    upload PROJECT_SSH_URL, *t.prerequisites
+  end
 
-desc 'Connect to website FTP.'
-task :ftp do
-  sh 'lftp', "sftp://#{PROJECT_SSH_URL}"
-end
+  desc "Publish user documentation."
+  task :web_doc => 'doc' do |t|
+    upload PROJECT_SSH_URL, *t.prerequisites
+  end
 
+  desc 'Connect to website FTP.'
+  task :ftp do
+    sh 'lftp', "sftp://#{PROJECT_SSH_URL}"
+  end
 
-desc "Generate release packages."
-task :release => [:clobber, :dist] do
-  sh 'rake package'
-end
+  desc 'Generate release announcement.'
+  task :ann => 'doc/history.rb' do |t|
+    require t.prerequisites[0]
 
-spec = Gem::Specification.new do |s|
-  s.name = s.rubyforge_project = PROJECT_ID
-  s.summary = PROJECT_SUMMARY
-  s.description = PROJECT_DETAIL
-  s.homepage = PROJECT_URL
-  s.version = PROJECT_VERSION
+    $: << File.join(File.dirname(__FILE__), 'doc', 'lib')
+    require 'doc_proxy'
 
-  s.add_dependency 'rake', '>= 0.7.0'
-  s.add_dependency 'rspec', '>= 0.7.0'
-  s.add_dependency 'rcov', '>= 0.7.0'
-  s.add_dependency 'xx' # needed by rcov
-  s.add_dependency 'ruby-debug', '>= 0.5.2'
+    text = [
+      PROJECT_DETAIL,
+      "* See #{PROJECT_URL} for details.",
+      "---",
+      @history.first
+    ].join "\n\n"
 
-  s.requirements << "POSIX threads library"
-  s.requirements << "C language compiler"
+    IO.popen('w3m -T text/html -dump -cols 60', 'w+') do |pipe|
+      pipe.write text.to_html
+      pipe.close_write
+      puts pipe.read
+    end
+  end
 
-  s.files = FileList['**/*'].exclude('_darcs')
-  s.autorequire = PROJECT_ID
-  s.extensions << 'gem_extconf.rb'
 
-  # make tools executable
-    tools = FileList['bin/*.rb']
+# packaging
 
-    tools.each do |f|
-      chmod 0755, f
-    end
+  desc "Generate release packages."
+  task :release => [:clobber, :dist] do
+    sh 'rake package'
+  end
 
-  s.executables = tools.map {|f| File.basename f}
-end
+  spec = Gem::Specification.new do |s|
+    s.name = s.rubyforge_project = PROJECT_ID
+    s.summary = PROJECT_SUMMARY
+    s.description = PROJECT_DETAIL
+    s.homepage = PROJECT_URL
+    s.version = PROJECT_VERSION
+
+    s.add_dependency 'rake', '>= 0.7.0'
+    s.add_dependency 'rspec', '>= 0.7.0'
+    s.add_dependency 'rcov', '>= 0.7.0'
+    s.add_dependency 'xx' # needed by rcov
+    s.add_dependency 'ruby-debug', '>= 0.5.2'
+
+    s.requirements << "POSIX threads library"
+    s.requirements << "C language compiler"
+
+    s.files = FileList['**/*'].exclude('_darcs')
+    s.autorequire = PROJECT_ID
+    s.extensions << 'gem_extconf.rb'
+    s.executables = FileList['bin/*.rb'].map {|f| File.basename f}
+  end
 
-Rake::GemPackageTask.new(spec) do |pkg|
-  pkg.need_tar = true
-end
+  Rake::GemPackageTask.new(spec) do |pkg|
+    pkg.need_tar = true
+  end
 
 
-desc "Configures the gem during installation."
-task :gem_config_inst do |t|
-  # make documentation available to gem_server
-    gemDir = File.dirname(__FILE__)
-    gemName = File.basename(gemDir)
-    docDir = File.join('..', '..', 'doc', gemName)
+# installation
 
-    mkdir_p docDir
-    ln_s gemDir, File.join(docDir, 'rdoc')
-end
+  desc "Configures the gem during installation."
+  task :gem_config_inst do |t|
+    # make documentation available to gem_server
+      gemDir = File.dirname(__FILE__)
+      gemName = File.basename(gemDir)
+      docDir = File.join('..', '..', 'doc', gemName)
 
+      mkdir_p docDir
+      ln_s gemDir, File.join(docDir, 'rdoc')
+  end
 
 
-## testing
+# testing
 
-desc "Ensure that examples work with $SIMULATOR"
-task :test => :build do
-  # ensures that current sources are tested instead of the installed gem
-  ENV['RUBYLIB'] = PROJECT_LIBS
+  desc "Ensure that examples work with $SIMULATOR"
+  task :test => :build do
+    # ensures that current sources are tested instead of the installed gem
+    ENV['RUBYLIB'] = PROJECT_LIBS
 
-  FileList['samp/*/'].each do |s|
-    cd s do
-      sh 'rake', ENV['SIMULATOR'] || 'cver'
+    FileList['samp/*/'].each do |s|
+      cd s do
+        sh 'rake', ENV['SIMULATOR'] || 'cver'
+      end
     end
   end
-end

data/bin/generate_test.rb

@@ -1,37 +1,37 @@
 # Generates Ruby-VPI tests from Verilog 2001 module declarations.
+#
 # * The standard input stream is read if no input files are specified.
-# * The first input signal in a module's declaration is assumed to be the clocking signal.
+#
+# * The first input signal in a module's declaration is assumed to be the
+#   clocking signal.
+#
 #
 # = Progress indicators
+#
 # module:: A Verilog module has been identified.
+#
 # create:: A file is being created because it does not exist.
+#
 # skip:: A file is being skipped because it is already up to date.
-# update:: A file will be updated because it is out of date. A text merging tool (see MERGER) will be launched to transfer content from the old file (*.old) and the new file (*.new) to the out of date file. If a text merging tool is not specified, then you will have to do the merging by hand.
+#
+# update::  A file will be updated because it is out of date. A text merging
+#           tool (see MERGER) will be launched to transfer content from the old
+#           file (*.old) and the new file (*.new) to the out of date file. If a
+#           text merging tool is not specified, then you will have to do the
+#           merging by hand.
+#
 #
 # = Environment variables
-# MERGER:: A command that invokes a text merging tool with three arguments: (1) old file, (2) new file, (3) output file. The tool's output should be written to the output file.
-
-
-=begin
-  Copyright 2006 Suraj N. Kurapati
-
-  This file is part of Ruby-VPI.
-
-  Ruby-VPI is free software; you can redistribute it and/or
-  modify it under the terms of the GNU General Public License
-  as published by the Free Software Foundation; either version 2
-  of the License, or (at your option) any later version.
-
-  Ruby-VPI is distributed in the hope that it will be useful,
-  but WITHOUT ANY WARRANTY; without even the implied warranty of
-  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-  GNU General Public License for more details.
-
-  You should have received a copy of the GNU General Public License
-  along with Ruby-VPI; if not, write to the Free Software Foundation,
-  Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
-=end
+#
+# MERGER::  A command that invokes a text merging tool with three arguments: (1)
+#           old file, (2) new file, (3) output file. The tool's output should be
+#           written to the output file.
+#
+#--
+# Copyright 2006 Suraj N. Kurapati
+# See the file named LICENSE for details.
 
+require 'ruby-vpi' # for project info
 require 'ruby-vpi/verilog_parser'
 require 'fileutils'
 require 'digest/md5'
@@ -42,7 +42,8 @@ def notify *args # :nodoc:
   printf "%8s  %s\n", *args
 end
 
-# Writes the given contents to the file at the given path. If the given path already exists, then a backup is created before invoking the merging tool.
+# Writes the given contents to the file at the given path. If the given path
+# already exists, then a backup is created before invoking the merging tool.
 def write_file aPath, aContent # :nodoc:
   if File.exist? aPath
     oldDigest = Digest::MD5.digest(File.read(aPath))

data/bin/generate_test_tpl/runner.rake

@@ -22,17 +22,11 @@ SIMULATOR_TARGET = '<%= aOutputInfo.verilogBenchName %>'
 #   :cver => %w[these are also separate arguments],
 #
 SIMULATOR_ARGUMENTS = {
-  # GPL Cver
-  :cver => '',
+<% RubyVpi::Config::SIMULATORS.each_pair do |id, sim| %>
+  # <%= sim.name %>
+  :<%= id %> => '',
 
-  # Icarus Verilog
-  :ivl => '',
-
-  # Synopsys VCS
-  :vcs => '',
-
-  # Mentor Modelsim
-  :vsim => '',
+<% end %>
 }
 
 # This task is invoked _before_ the simulator runs.

data/bin/header_to_ruby.rb

@@ -1,26 +1,9 @@
 # Transforms Verilog header files into Ruby.
 # * The standard input stream is read if no input files are specified.
 # * Output is written to the standard output stream.
-
-=begin
-  Copyright 2006 Suraj N. Kurapati
-
-  This file is part of Ruby-VPI.
-
-  Ruby-VPI is free software; you can redistribute it and/or
-  modify it under the terms of the GNU General Public License
-  as published by the Free Software Foundation; either version 2
-  of the License, or (at your option) any later version.
-
-  Ruby-VPI is distributed in the hope that it will be useful,
-  but WITHOUT ANY WARRANTY; without even the implied warranty of
-  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-  GNU General Public License for more details.
-
-  You should have received a copy of the GNU General Public License
-  along with Ruby-VPI; if not, write to the Free Software Foundation,
-  Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
-=end
+#--
+# Copyright 2006 Suraj N. Kurapati
+# See the file named LICENSE for details.
 
 if File.basename($0) == File.basename(__FILE__)
   # parse command-line options

data/doc/README

@@ -0,0 +1,11 @@
+The *.doc files in this directory are plain-text files!
+
+To transform them into XHTML, you need the following software:
+
+  Rake:     http://docs.rubyrake.org/
+
+  RedCloth: http://whytheluckystiff.net/ruby/redcloth/
+
+  Coderay:  http://coderay.rubychan.de/
+
+Once you have the above software, simply run the "rake" command.

data/doc/Rakefile

@@ -1,22 +1,7 @@
-=begin
-  Copyright 2006 Suraj N. Kurapati
-
-  This file is part of Ruby-VPI.
-
-  Ruby-VPI is free software; you can redistribute it and/or
-  modify it under the terms of the GNU General Public License
-  as published by the Free Software Foundation; either version 2
-  of the License, or (at your option) any later version.
-
-  Ruby-VPI is distributed in the hope that it will be useful,
-  but WITHOUT ANY WARRANTY; without even the implied warranty of
-  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-  GNU General Public License for more details.
-
-  You should have received a copy of the GNU General Public License
-  along with Ruby-VPI; if not, write to the Free Software Foundation,
-  Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
-=end
+# Generates the documentation in HTML format.
+#--
+# Copyright 2006 Suraj N. Kurapati
+# See the file named LICENSE for details.
 
 require 'rake/clean'
 
@@ -43,9 +28,11 @@ FileList['*.doc'].each do |src|
 
   desc "Process file #{src.inspect}."
   file dst => [src, 'common.tpl', *deps] do |t|
+    String.reset_anchors
+
     content = DocProxy.new.instance_eval do
       # default output configuration
-      table_of_contents = true
+      insert_toc = true
       page_title = nil
 
       # load the documentation's helper
@@ -56,7 +43,7 @@ FileList['*.doc'].each do |src|
       # evaluate the documentation file
         template = ERB.new(File.read(src))
         content = template.result(binding)
-        post_process! content
+        toc, content = post_process(content)
 
       # fit result into common HTML format
         template = ERB.new(File.read(t.prerequisites[1]))