ruby-vpi 19.0.0 → 20.0.0

data/doc/intro.inc

@@ -1,215 +0,0 @@
-Ruby-VPI is a platform for unit testing, rapid prototyping, and systems integration of Verilog modules through the "Ruby programming language":http://www.ruby-lang.org. It lets you:
-
-* Access the _entire_ "IEEE 1364-2005 Verilog VPI":http://ieeexplore.ieee.org/xpl/standardstoc.jsp?isnumber=33945 interface from Ruby.
-* Create complex Verilog test benches easily and wholly in Ruby.
-* Apply agile software development practices to develop hardware.
-* Perform "specification-driven functional verification":http://ruby-vpi.rubyforge.org/papers/masters_thesis.html ("PDF version":http://ruby-vpi.rubyforge.org/papers/masters_thesis.pdf).
-
-Ruby-VPI is "open source software":http://en.wikipedia.org/wiki/Open_source_software released under "this license":#intro.license.
-
-
-<% section "Resources", "resources" do %>
-  <% paragraph "Records" do %>
-    * "What's new":history.html#<%= version.to_html_anchor %>
-      - release notes for version <%= version %>.
-    ** "History":history.html
-      - a record of all release notes.
-    ** <a type="application/rss+xml" href="<%= RSS_URL %>"><img src="images/feed-icon-28x28.png" alt="RSS feed for release announcements" style="float: right"/></a> "RSS feed":<%= RSS_URL %>
-      - keep track of new releases at your leisure.
-    * "Plans":memo.html
-      - pending tasks for future releases.
-    * "Talks":http://ruby-vpi.rubyforge.org/talks/
-      - materials from presentations and seminars.
-    * "Papers":http://ruby-vpi.rubyforge.org/papers/
-      - research publications.
-  <% end %>
-
-  <% paragraph "Documentation" do %>
-    * "Motivation":http://ruby-vpi.rubyforge.org/papers/masters_thesis.html#tth_sEc5.2
-      - why was Ruby-VPI developed?
-    * "User manual":manual.html
-      - complete documentation for users.
-    ** "Tutorial":manual.html#usage.tutorial
-      - learn how to use Ruby-VPI quickly.
-    * "Reference":../ref/
-      - API documentation for Ruby libraries and C extension.
-  <% end %>
-
-  <% paragraph "Facilities" do %>
-    * "Downloads":<%= downloadURL %>
-      - obtain release packages
-    * "Source code":<%= codeURL %>
-      - browse online or obtain with "Darcs":http://darcs.net.
-    * "Forums":<%= forumURL %>
-      - discuss things and ask questions.
-    * "Mailing list":<%= mailListURL %>
-      - discuss things and ask questions.
-    * "Bugs":<%= trackerURL %>
-      - report defects in the software.
-    * "Patches":<%= trackerURL %>
-      - submit patches to source code.
-    * "Requests":<%= trackerURL %>
-      - request new features or get support.
-    * "Project portal":<%= portalURL %>
-      - hosted generously by "RubyForge":http://rubyforge.org.
-  <% end %>
-<% end %>
-
-
-<% section "Features", "intro.features" do %>
-  <% paragraph "Portable" do %>
-    * Supports the _entire_ "IEEE 1364-2005 Verilog VPI":http://ieeexplore.ieee.org/xpl/standardstoc.jsp?isnumber=33945 standard.
-    * Works with all <%= xref "intro.reqs", "major Verilog simulators" %> available today.
-    * Compiled _just once_ during "installation":manual.html#setup.inst and used forever!
-  <% end %>
-
-  <% paragraph "Agile" do %>
-    * Enables "agile practices":http://agilemanifesto.org/ such as
-    ** "test-driven":http://www.testdriven.com development
-    ** "behavior-driven":http://behaviour-driven.org development
-    ** "rapid prototyping":manual.html#usage.tutorial.implement-proto for design exploration
-
-    * Eliminates unneccesary work:
-    ** "Specifications":manual.html#usage.tutorial.specification are readable, portable, and _executable_.
-    ** The "automated test generator":manual.html#usage.tools.generate helps you accomodate design changes with _minimal_ effort.
-    ** There is absolutely _no compiling_!
-  <% end %>
-
-  <% paragraph "Powerful" do %>
-    * Inherits the "power and elegance":http://www.ruby-lang.org/en/about/ of Ruby:
-    ** Unlimited length integers
-    ** Regular expressions
-    ** Multi-threading
-    ** System calls and I/O
-    ** "_ad infinitum_":http://rubyforge.org
-
-    * Uses "ruby-debug":http://rubyforge.org/projects/ruby-debug/ for "interactive debugging":manual.html#usage.debugger.
-    * Uses "rcov":http://eigenclass.org/hiki.rb?rcov for test "coverage analysis and report generation":manual.html#usage.test-runner.env-vars.
-  <% end %>
-<% end %>
-
-
-<% section "Requirements", "intro.reqs" do %>
-  The following software is necessary in order to use Ruby-VPI.
-
-  <% paragraph "Verilog simulator" do %>
-    Ruby-VPI is known to work with the following simulators. However, you should be able to use it with any Verilog simulator that supports VPI.
-
-    * "Synopsys VCS":http://www.synopsys.com/products/simulation/simulation.html
-     - any version that supports the <tt>-load</tt> option is acceptable.
-
-    * "Mentor Modelsim":http://www.model.com
-     - any version that supports the <tt>-pli</tt> option is acceptable.
-
-    * "Cadence NC-Sim":http://www.cadence.com/products/functional_ver/nc-verilog/
-     - any version that supports the <tt>+loadvpi</tt> option should be acceptable.
-
-    * "GPL Cver":http://www.pragmatic-c.com/gpl-cver/
-     - version 2.11a or newer is acceptable.
-
-    * "Icarus Verilog":http://www.geda.seul.org/tools/icarus/index.html
-      - version 0.8 is _mostly_ acceptable because you *will not* be able to "access child handles through method calls":manual.html#Accessing_a_handle_s_relatives. The reason for this limitation is explained "in the user manual":manual.html#problems.ivl.vpi_handle_by_name.absolute-paths.
-  <% end %>
-
-  <% paragraph "Compilers" do %>
-    * "make":http://en.wikipedia.org/wiki/Make
-      - any flavor should be acceptable.
-
-    * C compiler
-      - the "GNU Compiler Collection (GCC)":http://www.gnu.org/software/gcc/ is preferred, but any C compiler should be acceptable.
-
-    * "SWIG":http://www.swig.org/download.html
-      - version 1.3.29 or newer is necessary.
-
-    * "Ruby":http://www.ruby-lang.org/en/downloads/
-      - version 1.8 or newer, including header and linkable object files for building extensions, is necessary. You can install Ruby by following "these instructions":http://www.ruby-lang.org/en/downloads/.
-  <% end %>
-
-  <% paragraph "Libraries" do %>
-    * "POSIX threads (pthreads)":http://en.wikipedia.org/wiki/Pthreads
-      - header and linkable object files, and operating system support for this library are necessary.
-
-    * "RubyGems":http://rubyforge.org/frs/?group_id=126
-      - any recent version should be acceptable. You can install RubyGems by following "these instructions":http://www.rubygems.org/read/chapter/3.
-  <% end %>
-<% end %>
-
-
-<% section "Appetizers", "intro.appetizers" do %>
-  Here is a tiny sampling of code to whet your appetite. See "the tutorial":manual.html#usage.tutorial for more samples.
-
-  * Assign the value 2^2048^ to a register:
-  ** @your_register.intVal = 2 ** 2048@
-  ** @your_register.put_value 2 ** 2048@
-
-  * Check if all nets in a module are at high impedance:
-  ** @your_module.all_net? { |your_net| your_net.z? }@
-  ** <code>
-  your_nets = your_module.net_a
-  your_nets.all? { |net| net.z? }
-  </code>
-
-  * See a register's path, width, and location (file & line number):
-  ** @puts your_register@
-  ** <code>
-  p :path  => your_register.fullName
-  p :width => your_register.size
-  p :file  => your_register.fileName
-  p :file  => your_register.lineNo
-  </code>
-
-  * Access the first five elements in a memory:
-  ** @your_memory.memoryWord_a.first(5)@
-  ** @your_memory.memoryWord_a[0..4]@
-  ** @your_memory.memoryWord_a[0, 5]@
-
-  * Clear a memory by filling it with zeroes:
-  ** @your_memory.each_memoryWord { |w| w.zero! }@
-  ** @your_memory.each_memoryWord { |w| w.intVal = 0 }@
-  ** @your_memory.each_memoryWord { |w| w.put_value 0 }@
-<% end %>
-
-
-<% section "Applications", "intro.applications" do %>
-  Examples of tasks that can be performed with Ruby-VPI are:
-
-  * From the second edition of "_The Verilog PLI Handbook_":http://www.sutherland-hdl.com/publications.html:
-  ** C language bus-functional models
-  ** Reading test vector files
-  ** Delay calculation
-  ** Custom output displays
-  ** Co-simulation
-  ** Design debug utilities
-  ** Simulation analysis
-
-  * Adapted from "Pin Hong's":http://embedded.eecs.berkeley.edu/Alumni/pinhong/scriptEDA/ observations:
-  ** Writing hardware models in Ruby
-  ** Dumping or processing netlist data from Verilog database
-  ** Dumping or processing simulation data
-  ** Feeding dynamic simulation stimuli
-  ** Back-annotating delay information
-  ** Interactive logic simulation
-  ** Building a distributed simulation
-<% end %>
-
-
-<% section "Related works", "intro.related-works" do %>
-  * "ANVIL":http://anvil.sourceforge.net is a C++ interface to VPI.
-  * "Teal":http://teal.sourceforge.net is a C++ interface to VPI.
-  * "JOVE":http://jove.sourceforge.net is a Java interface to VPI.
-  * "ScriptEDA":http://embedded.eecs.berkeley.edu/Alumni/pinhong/scriptEDA/ is a Perl, Python, and Tcl interface to VPI.
-  * "RHDL":http://rhdl.rubyforge.org is a hardware description and verification language based on Ruby.
-  * "MyHDL":http://myhdl.jandecaluwe.com is a hardware description and verification language based on Python, which features conversion to Verilog and co-simulation.
-
-  <% section "Ye olde PLI", "intro.related-works.pli" do %>
-    The following projects utilize the archaic *tf* and *acc* PLI interfaces, which have been officially deprecated in IEEE Std 1364-2005.
-
-    * "ScriptSim":http://www.nelsim.com is a Perl, Python, and Tcl/Tk interface to PLI.
-    * "Verilog::Pli":http://www.veripool.com/verilog-pli.html is a Perl interface to PLI.
-  <% end %>
-<% end %>
-
-
-<% section "License", "intro.license" do %>
-  <%= h(File.read('../LICENSE')).gsub(/^Copyright.*$/, '\&<br/>') %>
-<% end %>

data/doc/lib/doc_format.rb

@@ -1,137 +0,0 @@
-#--
-# Copyright 2006 Suraj N. Kurapati
-# See the file named LICENSE for details.
-
-require 'cgi'
-require 'digest/md5'
-
-begin
-  require 'rubygems'
-rescue LoadError
-end
-
-require 'coderay'
-require 'redcloth'
-
-class String
-  # The content of these HTML tags will be preserved verbatim
-  # when they are processed by Textile.  By doing this, we
-  # avoid unwanted Textile transformations, such as quotation
-  # marks becoming curly ( ), in source code.
-  PRESERVED_TAGS = %w[tt code pre]
-
-  # Transforms this string into HTML.
-  def to_html
-    text = dup
-
-    # escape preserved tags
-    preserved = {} # escaped => original
-
-    PRESERVED_TAGS.each do |tag|
-      text.gsub! %r{(<#{tag}.*?>)(.*?)(</#{tag}>)}m do
-        orig = $1 + CGI.escapeHTML(CGI.unescapeHTML($2)) + $3
-        esc  = Digest::MD5.hexdigest(orig)
-
-        preserved[esc] = orig
-        esc
-      end
-    end
-
-
-    # convert Textile into HTML
-    html = text.redcloth
-
-
-    # restore preserved tags
-    preserved.each_pair do |esc, orig|
-      html.gsub! %r{<p>#{esc}</p>|#{esc}}, orig
-    end
-
-
-    ## fix annoyances in Textile conversion
-
-    # redcloth wraps indented text within <pre> tags
-    html.gsub! %r{(<pre>)\s*<code>(.*?)\s*</code>\s*(</pre>)}m, '\1\2\3'
-    html.gsub! %r{(<pre>)\s*<pre>(.*?)</pre>\s*(</pre>)}m, '\1\2\3'
-
-    # redcloth wraps a single item within paragraph tags, which
-    # prevents the item's HTML from being validly injected within
-    # other block-level elements, such as headings (h1, h2, etc.)
-    html.sub! %r{^<p>(.*)</p>$}m do |match|
-      payload = $1
-
-      if payload =~ /<p>/
-        match
-      else
-        payload
-      end
-    end
-
-    # redcloth adds <span> tags around acronyms
-    html.gsub! %r{<span class="caps">([[:upper:][:digit:]]+)</span>}, '\1'
-
-
-    html.coderay
-  end
-
-  # Returns the result of running this string through RedCloth.
-  def redcloth
-    RedCloth.new(self).to_html
-  end
-
-  # Adds syntax coloring to <code> elements in the given text. If the <code>
-  # tag has an attribute lang="...", then that is considered the programming
-  # language for which appropriate syntax coloring should be applied.
-  # Otherwise, the programming language is assumed to be ruby.
-  def coderay
-    gsub %r{<(code)(.*?)>(.*?)</\1>}m do
-      matches = $~
-
-      atts = matches[2]
-      lang = if atts =~ /lang=('|")(.*?)\1/i then $2 else :ruby end
-
-      # obtain the raw source code w/o extraneous indentation
-      code = CGI.unescapeHTML(matches[3]).rstrip
-
-      if matches.pre_match =~ /^[ \t]+$/
-        code.gsub! %r/^#{$&}/, ''
-      end
-
-      # convert the code into HTML
-      html = CodeRay.scan(code, lang).html(:css => :style)
-
-      # perform smart sizing (block vs. inline) of the code
-      trailingText = matches.post_match[/^.*$/].to_s.strip
-
-      tag =
-        if code =~ /\n/ or trailingText.empty? or trailingText =~ %r{^</(p|div|body)}
-          :pre
-        else
-          :code
-        end
-
-      %{<#{tag} class="code"#{atts}>#{html}</#{tag}>}
-    end
-  end
-
-  # Transforms this string into a valid XHTML anchor (ID attribute).
-  # See http://www.nmt.edu/tcc/help/pubs/xhtml/id-type.html
-  def to_html_anchor
-    # remove HTML tags from the input
-    buf = self.gsub(/<.*?>/, '')
-
-    # The first or only character must be a letter.
-    buf.insert(0, 'a') unless buf[0,1] =~ /[[:alpha:]]/
-
-    # The remaining characters must be letters,
-    # digits, hyphens (-), underscores (_), colons
-    # (:), or periods (.) [or Unicode characters]
-    buf.unpack('U*').map! do |code|
-      if code > 0xFF or code.chr =~ /[[:alnum:]\-_:\.]/
-        code
-      else
-        ?_
-      end
-    end.pack('U*')
-  end
-end