vhdl_tb 0.4 → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 63557b1b90136b3f8306bd68a2107cda107e930a
-  data.tar.gz: e6acdf6957129cb2f774a1c638a121e3799f4f51
+  metadata.gz: 99115f46e648d9a330a16e6998507fe532bbaac7
+  data.tar.gz: 4a7ca042f8bbe236adc0cec08c0ba820e7d26c89
 SHA512:
-  metadata.gz: e0c7d92ccc71af281e69e78583a30e07831836bc41d8678e8ecc2b2dccf8e0f1eb0c790127b4aa0b9ac37f367e686975f23d2b206ec47d42f95e845ed0baf603
-  data.tar.gz: 5f9f354c7866312c98072a400ec02a5d24b1fee52669ec9ffd928d7c940f223220ee6c1f6b33854066fcffb0386b1e9cb7171b75066e4d11a635c67e545b4870
+  metadata.gz: ccce1103568033abcdaa16ac33666e4b73c82f007550607c5b79564cb64ef24dae46d3f258963a3a5aa34263a9180298875f49539a6ba507025c70aad5fd1a94
+  data.tar.gz: 5d1f555f4908071b4360c906209dfa90ae2d99ef0d7f5b2dd22788780331a0be2b53db73e76aad1ff39f5a56e364da6d3f78dfeb59f4fb170e9ffb85da6d06e4

data/bin/tbgen

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require_relative '../lib/vhdl_tb'
-generator=VhdlTb.new
-generator.analyze_options(ARGV)
-generator.generate
+require_relative '../lib/compiler'
+compiler=VHDL_TB::Compiler.new
+compiler.analyze_options(ARGV)
+compiler.generate

data/bin/vhdl_tb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require_relative '../lib/vhdl_tb'
-generator=VhdlTb.new
+require_relative '../lib/compiler'
+generator=VHDL_TB::Compiler.new
 generator.analyze_options(ARGV)
 generator.generate

data/lib/ast.rb

@@ -0,0 +1,26 @@
+module VHDL_TB
+    Root=Struct.new(:design_units)
+    Entity=Struct.new(:name,:generics,:ports)
+    Generic=Struct.new(:name,:type,:init)
+    Input=Struct.new(:name,:type)
+    Output=Struct.new(:name,:type)
+    Architecture=Struct.new(:name,:entity)
+
+    Identifier=Struct.new(:tok) do
+      def to_s
+        "#{self.tok}"
+      end
+    end
+
+    IntLit=Struct.new(:tok) do
+      def to_s
+        "#{self.tok}"
+      end
+    end
+
+    VectorType=Struct.new(:name,:lhs,:dir,:rhs) do
+      def to_s
+        "#{self.name}(#{self.lhs} #{self.dir} #{self.rhs})"
+      end
+    end
+end

data/lib/compiler.rb

@@ -0,0 +1,127 @@
+require 'erb'
+require 'pp'
+require 'optparse'
+
+require_relative 'ast'
+require_relative 'parser'
+
+module VHDL_TB
+
+  TestBench=Struct.new(:name)
+
+ class Compiler
+
+   VERSION = "0.6.3"
+
+   def initialize
+     #puts __dir__
+     banner
+     @engine=ERB.new(IO.read "#{__dir__}/template.tb.vhd")
+     @parser=Parser.new
+   end
+
+   def banner
+     puts "-- "+"="*65
+     puts "-- VHDL testbench generator -- Jean-Christophe Le Lann 2017-2018"
+     puts "-- "+"="*65
+
+   end
+
+   def analyze_options args
+     args << "-h" if args.empty?
+
+     opt_parser = OptionParser.new do |opts|
+       opts.banner = "Usage: vhdl_tb (or tbgen) <filename>"
+
+       opts.on("-v", "--version", "Prints version") do |n|
+         puts VERSION
+         abort
+       end
+
+       opts.on("-h", "--help", "Prints this help") do
+         puts "Generates testbench in VHDL, from a given file containing an Entity-Architecture couple."
+         puts
+         puts opts
+         abort
+       end
+     end
+
+     begin
+       opt_parser.parse!(args)
+       @args=args
+
+     rescue Exception => e
+       puts e
+       #puts e.backtrace
+       exit
+     end
+   end
+
+   def generate entity_filename=@args.first
+     @symtable=[]
+     @symtable << "clk"
+     @symtable << "reset_n"
+     @symtable << "sreset"
+     begin
+       analyze(entity_filename)
+       tb_txt=@engine.result(binding)
+       tb_filename="#{@tb.name}.vhd"
+       File.open(tb_filename,'w'){|f| f.puts tb_txt}
+       puts "testbench generated : #{tb_filename}"
+     rescue Exception => e
+       abort
+     end
+   end
+
+   def analyze entity_filename
+     puts "analyzing VHDL file : #{entity_filename}"
+
+     root=Parser.new.parse entity_filename
+
+     @entity=root.design_units.find{|du| du.class==Entity}
+     puts "entity found        : #{@entity.name} (#{@entity.ports.size} ports)"
+
+     @arch=root.design_units.find{|du| du.is_a? Architecture}
+     check
+     # prepare ERB through instance variables
+     @max_length=@entity.ports.map{|p| p.name.val.size}.max
+     @ports=@entity.ports.map{|p| " "*10+"#{e=p.name.val.ljust(@max_length)} => #{e}"}.join(",\n")
+     if gs=(@entity.generics)
+       generics=gs.map{|g| " "*10+"#{g.name} => #{g.init}"}
+       @generics="generic map(\n#{generics.join(",\n")})"
+     end
+     @tb=TestBench.new(@entity.name.val+"_tb")
+   end
+
+   def check
+     print "checking".ljust(20)
+     errors =[]
+
+     if @entity.ports.size==0
+       errors << "0 ports found for #{@entity.name}"
+     end
+
+     if @arch.entity.val!=@entity.name.val
+       errors << "wrong entity-architecture pair : entity is -->#{@entity.name}<-- vs arch #{@arch.name} of -->#{@arch.entity.name}<--"
+     end
+
+     if errors.any?
+       puts ": nok"
+       puts "\nchecks failed due to the following errors :"
+       errors.each{|e| puts "- ERROR : #{e}"}
+       raise
+     else
+       puts ": ok"
+     end
+   end
+
+
+
+  end
+end
+
+if $PROGRAM_NAME == __FILE__
+  raise "you need to provide a VHDL file that contains the entity to test" if ARGV.size==0
+  filename=ARGV[0]
+  VHDL_TB.Compiler.new.generate(filename)
+end

data/lib/generic_lexer.rb

@@ -0,0 +1,62 @@
+require 'strscan'
+
+require_relative 'token'
+
+class GenericLexer
+
+  def initialize
+    @rules = []
+    @rules << [:newline,/[\n]/]
+  end
+
+  def ignore pattern
+    @rules << [:skip,pattern]
+  end
+
+  def keyword str
+    @rules.unshift [str.to_sym,/#{str}\b/]
+  end
+
+  def token hash
+    token,pattern=*hash.to_a.flatten
+    @rules << [token, pattern]
+  end
+
+  def open code
+    @ssc = StringScanner.new code
+    @line=0
+  end
+
+  def next_token
+    return [nil,nil,nil] if @ssc.empty?
+    tok = get_token
+    return (tok.is_a? :skip) ? next_token : tok
+  end
+
+  def get_token
+    linecol=position()
+    @rules.each do |rule, regexp|
+      val = @ssc.scan(regexp)
+      return Token.new([rule, val, linecol]) if val
+    end
+    raise  "lexing error line #{linecol.first} around : ...'#{@ssc.peek(5)}'... "
+  end
+
+  def position
+    if @ssc.bol?
+      @line+=1
+      @old_pos=@ssc.pos
+    end
+    [@line,@ssc.pos-@old_pos+1]
+  end
+
+  def tokenize code
+    open(code)
+    tokens=[]
+    tokens << next_token() while not @ssc.eos?
+    # while not @ssc.eos?
+    #   tokens << (p next_token)
+    # end
+    tokens
+  end
+end

data/lib/generic_parser.rb

@@ -0,0 +1,25 @@
+class GenericParser
+
+  def acceptIt
+    tok=tokens.shift
+    puts "consuming #{tok.val} (#{tok.kind})" if @verbose
+    tok
+  end
+
+  def showNext k=1
+    tokens[k-1]
+  end
+
+  def expect kind
+    if (actual=showNext.kind)!=kind
+      abort "ERROR at #{showNext.pos}. Expecting #{kind}. Got #{actual}"
+    else
+      return acceptIt()
+    end
+  end
+
+  def more?
+    !tokens.empty?
+  end
+
+end

data/lib/lexer.rb

@@ -0,0 +1,31 @@
+require_relative 'generic_lexer'
+
+class Lexer < GenericLexer
+  def initialize
+    super
+    ignore /\s+/
+    #....keywords
+    token :entity   => /entity/
+    token :is       => /is/
+    token :generic  => /generic/
+    token :port     => /port/
+    token :in       => /in/
+    token :to       => /to/
+    token :downto   => /downto/
+    token :out      => /out/
+    token :end      => /end/
+    token :comment  => /--(.*)$/
+    token :vassign  => /\:\=/
+    token :lparen   => /\(/
+    token :rparen   => /\)/
+    token :semicolon=> /\;/
+    token :colon    => /\:/
+    token :dot      => /\./
+    token :comma    => /\,/
+    token :architecture => /architecture/
+    token :of       => /of/
+    token :id       => /[a-zA-Z_][a-zA-Z0-9_]*/i
+    token :int_lit  => /[0-9]+/
+
+  end
+end

data/lib/parser.rb

@@ -0,0 +1,183 @@
+require_relative 'generic_parser'
+require_relative 'ast'
+require_relative 'lexer'
+
+require 'pp'
+
+module VHDL_TB
+
+  class Parser < GenericParser
+    attr_accessor :lexer,:tokens
+    attr_accessor :basename,:filename
+
+    def initialize
+      @lexer=Lexer.new
+    end
+
+    def parse filename
+      str=IO.read(filename)
+      begin
+        @tokens=lexer.tokenize(str)
+        @tokens=tokens.select{|t| t.class==Token} # filters [nil,nil,nil]
+        @tokens=tokens.reject{|tok| tok.is_a? [:comment,:newline]}
+      rescue Exception=>e
+        puts e
+        puts "an error occured during LEXICAL analysis. Sorry. Aborting."
+        raise
+      end
+      root=Root.new([])
+      begin
+        consume_to :entity
+        root.design_units << entity=parse_entity
+
+        consume_to :architecture
+        root.design_units << archi=parse_architecture
+
+      rescue Exception => e
+        #puts e.backtrace
+        puts e
+        puts "an error occured during SYNTACTIC analysis (around line #{showNext.pos.first}). Sorry. Aborting."
+        raise
+      end
+      return root
+    end
+
+    def consume_to token_kind
+      while showNext && showNext.kind!=token_kind
+        acceptIt
+      end
+      if showNext.nil?
+        raise "cannot find token '#{token_kind}'"
+      end
+    end
+
+    def parse_entity
+      entity=Entity.new(nil,[],[])
+      expect :entity
+      entity.name=expect :id
+      expect :is
+      if showNext.is_a? :generic
+        entity.generics=parse_generics
+      end
+      if showNext.is_a? :port
+        entity.ports=parse_ports
+      end
+      expect :end
+      return entity
+    end
+
+    def parse_generics
+      generics=[]
+      expect :generic
+      expect :lparen
+      while showNext.is_not_a? :rparen
+        generics << parse_generic
+        if showNext.is_a? :semicolon
+          acceptIt
+        end
+      end
+      expect :rparen
+      expect :semicolon
+      generics.flatten!
+      generics
+    end
+
+    def parse_generic
+      ids=[]
+      ids << expect(:id)
+      while showNext.is_a? :comma
+        acceptIt
+        ids << expect(:id)
+      end
+      expect :colon
+      type=parse_type
+      if showNext.is_a? :vassign
+        acceptIt
+        expr=parse_expression
+      end
+      ids.map{|id| Generic.new(id,type,expr)}
+    end
+
+    def parse_ports
+      ports=[]
+      expect :port
+      expect :lparen
+      while showNext.is_not_a? :rparen
+        ports << parse_io
+        if showNext.is_a? :semicolon
+          acceptIt
+        end
+      end
+      expect :rparen
+      expect :semicolon
+      ports.flatten!
+      ports
+    end
+
+    def parse_io
+      ids=[]
+      ids << expect(:id)
+      while showNext.is_a? :comma
+        acceptIt
+        ids << expect(:id)
+      end
+      expect :colon
+      if showNext.is_a? [:in,:out]
+        dir=acceptIt
+        dir=dir.kind
+      end
+      type=parse_type
+      ids.map{|id| dir==:in ? Input.new(id,type) : Output.new(id,type)}
+    end
+
+    def parse_type
+      type=Identifier.new
+      type.tok=expect(:id)
+      if showNext.is_a? :lparen
+        acceptIt
+        name=type.tok
+        type=VectorType.new
+        type.name=name
+        type.lhs=parse_expression
+        if showNext.is_a? [:downto,:to]
+          type.dir=acceptIt
+        end
+        type.rhs=parse_expression
+        expect :rparen
+      end
+      type
+    end
+
+    def parse_expression
+      parse_term
+    end
+
+    def parse_term
+      if showNext.is_a? [:int_lit,:id]
+        case showNext.kind
+        when :int_lit
+          return IntLit.new(acceptIt)
+        when :id
+          return Identifier.new(acceptIt)
+        else
+          puts "cannot parse term"
+        end
+      end
+    end
+
+    def parse_architecture
+      archi=Architecture.new
+      expect :architecture
+      archi.name=expect(:id)
+      expect :of
+      archi.entity=expect(:id)
+      archi
+    end
+  end
+end
+
+if $PROGRAM_NAME==__FILE__
+  filename=ARGV.first
+  parser=VHDL_TB::Parser.new
+  parser.parse filename
+end

data/lib/template.tb.vhd

@@ -27,7 +27,7 @@ architecture bhv of <%=@tb.name%> is
    end procedure;
 
 <%=@entity.ports.collect do |port|
-  "  signal #{port.name.rjust(@max_length)} : #{port.type}" if not @symtable.include?(port.name)
+  "  signal #{port.name.val.ljust(@max_length)} : #{port.type}" if not @symtable.include?(port.name)
   end.compact.join(";\n")%>;
 
 begin
@@ -42,8 +42,10 @@ begin
   -- Design Under Test
   --------------------------------------------------------------------
   dut : entity work.<%=@entity.name%>(<%=@arch.name%>)
-         port map (
-  <%=@entity.ports.collect{|port| "\t   #{port.name.ljust(@max_length)} => #{port.name}"}.join(",\n")%>);
+        <%=@generics%>
+        port map (
+<%=@ports%>
+        );
 
   --------------------------------------------------------------------
   -- sequential stimuli

data/lib/token.rb

@@ -0,0 +1,54 @@
+class Token
+  attr_accessor :kind,:val,:pos
+  def initialize tab
+    @kind,@val,@pos=*tab
+  end
+
+  def is_a? kind
+    case kind
+    when Symbol
+      return @kind==kind
+    when Array
+      for sym in kind
+        return true if @kind==sym
+      end
+      return false
+    else
+      raise "wrong type during lookahead"
+    end
+  end
+
+  def is_not_a? kind
+    case kind
+    when Symbol
+      return @kind!=kind
+    when Array
+      ret=true
+      for sym in kind
+        ret=false if @kind==sym
+      end
+      return ret
+    else
+      raise "wrong type during lookahead"
+    end
+  end
+
+  # def accept visitor
+  # end
+
+  def self.create str
+    Token.new [:id,str,[0,0]]
+  end
+
+  def to_s
+    val
+  end
+
+  def clone
+    Token.new([@kind,@val,@pos])
+  end
+end
+
+ONE  = Token.new [:int_lit,'1',['na','na']]
+ZERO = Token.new [:int_lit,'0',['na','na']]
+DUMMY= Token.new [:id     ,'' ,['na','na']]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vhdl_tb
 version: !ruby/object:Gem::Version
-  version: '0.4'
+  version: 0.6.3
 platform: ruby
 authors:
 - Jean-Christophe Le Lann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-24 00:00:00.000000000 Z
+date: 2018-04-06 00:00:00.000000000 Z
 dependencies: []
 description: A simple testbench generator for VHDL
 email: jean-christophe.le_lann@ensta-bretagne.fr
@@ -20,8 +20,14 @@ extra_rdoc_files: []
 files:
 - bin/tbgen
 - bin/vhdl_tb
+- lib/ast.rb
+- lib/compiler.rb
+- lib/generic_lexer.rb
+- lib/generic_parser.rb
+- lib/lexer.rb
+- lib/parser.rb
 - lib/template.tb.vhd
-- lib/vhdl_tb.rb
+- lib/token.rb
 - tests/circuit.vhd
 homepage: http://rubygems.org/gems/vhdl_tb
 licenses:

data/lib/vhdl_tb.rb

@@ -1,105 +0,0 @@
-require 'erb'
-require 'pp'
-require 'optparse'
-
-Entity       = Struct.new("Entity",:name,:ports)
-Architecture = Struct.new("Architecture",:name,:entity)
-Port         = Struct.new("Port",:name,:dir,:type)
-Testbench    = Struct.new("Testbench",:name)
-
-class VhdlTb
-
-  VERSION = "0.4"
-
-  def initialize
-    #puts __dir__
-    banner
-    @engine=ERB.new(IO.read "#{__dir__}/template.tb.vhd")
-  end
-
-  def banner
-    puts "-- "+"="*60
-    puts "-- VHDL testbench generator -- Jean-Christophe Le Lann 2017"
-    puts "-- "+"="*60
-
-  end
-
-  def analyze_options args
-    args << "-h" if args.empty?
-
-    opt_parser = OptionParser.new do |opts|
-      opts.banner = "Usage: vhdl_tb (or tbgen) <filename>"
-
-      opts.on("-v", "--version", "Prints version") do |n|
-        puts VERSION
-        abort
-      end
-
-      opts.on("-h", "--help", "Prints this help") do
-        puts "Generates testbench in VHDL, from a given file containing an Entity-Architecture couple."
-        puts
-        puts opts
-        abort
-      end
-    end
-
-    begin
-      opt_parser.parse!(args)
-      @args=args
-
-    rescue Exception => e
-      puts e
-      #puts e.backtrace
-      exit
-    end
-  end
-
-  def generate entity_filename=@args.first
-    @symtable=[]
-    @symtable << "clk"
-    @symtable << "reset_n"
-    @symtable << "sreset"
-    analyze(entity_filename)
-    tb_txt=@engine.result(binding)
-    tb_filename="#{@tb.name}.vhd"
-    File.open(tb_filename,'w'){|f| f.puts tb_txt}
-    puts "testbench generated : #{tb_filename}"
-  end
-
-  def analyze entity_filename
-    puts "analyzing VHDL file : #{entity_filename}"
-    code=IO.read(entity_filename)
-    regexp_entity=/entity\s+(\w+)\s+is\s+(generic\(.*\)\;\s+)?port\s*\(\s*(.*)\)\s*\;\s*end\s+/im
-    entity_matched = regexp_entity.match(code)
-    name,generics,iotext=*entity_matched.captures
-
-    ioregexp=/(\w+)\s*:\s*(\w+)\s+(.*)\s*;?/ix
-    iotab= iotext.scan(ioregexp)
-    io= to_port(iotab)
-    puts "entity found        : #{name} (#{io.size} ports)"
-    @entity=Entity.new(name,io)
-
-    regexp_arch=/architecture\s+(\w+)\s+of\s+(\w+)/im
-    arch_matched = regexp_arch.match(code)
-    arch_name,entity_name=*arch_matched.captures
-    @arch=Architecture.new(arch_name,entity_name)
-    @tb=Testbench.new(@entity.name+"_tb")
-  end
-
-  def to_port iotab
-    @max_length=0
-    iotab.collect do |io|
-      name,dir,type=io
-      type=type.split(";")[0] #suppress comments
-      @max_length=name.size if name.size>@max_length
-      Port.new(name,dir,type)
-    end
-  end
-
-end
-
-if $PROGRAM_NAME == __FILE__
-  raise "you need to provide a VHDL file that contains the entity to test" if ARGV.size==0
-  filename=ARGV[0]
-  VhdlTb.new.generate(filename)
-end