ecic 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d135593bf08ee2250db65bf5ec3f0703335537464e0fc44ba9f39c23a46c5dad
-  data.tar.gz: ee954989cb0b2a52e55037f82b7db5002e8c00701a8bae0953aece5a75028798
+  metadata.gz: 5fe4c1aca4adfa0193f736c1ad55a32addf62978adf94d658b677805fa5efe2a
+  data.tar.gz: 7f01b0281fda482bb7007e8fbdcd592cb03cefb1c198dae0687f4ddb61b98956
 SHA512:
-  metadata.gz: 4ae1a8190ffac083f9d1f7ce09a01d1ff29a1d2bb6ad9e952862aec8f0801dd3b9142f24ae2c1ea71f8a47a4c740db307881d2889544a6bbc90920444f169cd8
-  data.tar.gz: 2f9ddd3385c0df5bd67efb405baf430bc467588cbc84472edfea35587088a1364e5417f1dc825ed624c2c726fb9d18d8c32a58db0c42aab5cc61d1ba7b1d3a51
+  metadata.gz: 9791e87cbb17451e0c5b45802a958b7ac0c4e06ce4eea40b9c6fdc850486b5c1310543afbc1ff31fba98e539bf5e09e073ed9aa40b0a054d48dd68cccf655b6f
+  data.tar.gz: 98bc6a7a59f5ab7267095dd6681eb240ccf5672ddf883ea0b23d331fe43945ce648c619dcce2d80c622957c0937cf0603729887a24c5b951fe660413e2001f90

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ecic (0.4.0)
+    ecic (0.5.0)
       activesupport (~> 5.2)
       colorize (~> 0.8)
       rake (~> 12.3)

data/README.md

@@ -95,7 +95,7 @@ Should you still wish to combine eg. the entity and architecture files into one
 
 This would result in a file with a `-ent-arc_rtl.vhd` extention for the file containing both the entity and architecture.
 
-##### Create multiple VHDL design for the same library
+##### Create multiple VHDL designs for the same library
 
 You can create multiple designs at the same time, and designs can be placed in subfolders within a library. For example, to create a new VHDL design called `my_design2` at the root of a library called `my_lib` and create another VHDL design called `my_design3` in a subfolder called `my_subblock`, run:
 
@@ -144,7 +144,7 @@ That will generate the files as:
 
     ./src/design/queue_system/statemachine-*.vhd      #Path is relative to the project root folder
 
-Note that even though the current working directory in this example is `arbitor`, the generated files will be placed in the `queue_system` folder, since no hierarchy is included in the design name.
+**Note:** Even though the current working directory in this example is `arbitor`, the generated files will be placed in the `queue_system` folder, since no hierarchy is included in the design name.
 
 ## Migrating an existing project to use ECIC
 
@@ -203,6 +203,6 @@ To install the ECIC framework onto your local machine, run `bundle exec rake ins
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/ic-factory/ecic.
+Bug reports and pull requests are most welcome on GitHub at https://github.com/ic-factory/ecic.
 
 

data/config/locales/help.en.yaml

@@ -7,6 +7,16 @@ help:
       Example: ecic new my_project
 
       This creates a new ECIC project in ./my_project
+  libraries:
+    short: Display list of libraries in the project
+    long:  |
+      Displays a list of the libraries in the project, optionally
+      along with a list of source files for each library.
+   
+      Example: ecic libraries --include-source-files --format=json
+
+      Prints a JSON formatted list of all libraries, including the source files in each library.
+
   completion:
     short: Print words for auto-completion
     long:   |
@@ -40,8 +50,23 @@ help:
 
           eval $(ecic completion script)      
 
+  addfile:
+    short: Add existing design and testbench files to the project!
+    long: |
+      Add one or more existing design files to a given library in the project!
+
+      Example: ecic addfile my_lib ./foo/bar/some_design.sv ../toto/kuku.vhd
+  
+      This adds the ./foo/bar/some_design.sv ../toto/kuku.vhd files to the library 
+      called 'my_lib' by adding these to the <PROJECT_ROOT>/src/design/my_lib/sources.rb file.
+  
+      Although all files that belong to a given library should be placed in the
+      folder for that library, you can specify files that are placed anywhere
+      in your file system.
+
   generate:
     short: Generate new testbenches, RTL modules, tests etc.!
+
     testbench:
       short: Create a new testbench
       long: |

data/lib/ecic/cli.rb

@@ -1,5 +1,7 @@
 module Ecic
   class CLI < Command
+
+    include Ecic::SourceFileAdder
       
     class << self
       def help(shell, subcommand = false)
@@ -48,9 +50,49 @@ module Ecic
     # GENERATE command:
     #--------------------------------------------------------------------------
     desc "generate SUBCOMMAND ...ARGS", Help.text('generate')['short']
-    long_desc Help.text('generate')['long']
     subcommand "generate", Generate
 
+    
+    #--------------------------------------------------------------------------
+    # design generator:
+    #--------------------------------------------------------------------------
+    desc "addfile LIBRARY_NAME FILENAME...", Help.text('addfile')['short']
+    long_desc Help.text('addfile')['long']
+
+    def addfile(lib_name, *file_names)
+      begin
+        root_dir = Project::root
+        if root_dir.nil?
+          shell.error "You must be within an ECIC project before calling this command"
+          exit(1)
+        end
+        project = Project.new(root_dir)
+        project.load_libraries
+
+        unless project.has_library?(lib_name)
+          if yes?("Library '#{lib_name}' does not exist. Create it? [y/n]:")
+            generator = LibraryGenerator.new
+            generator.destination_root = root_dir
+            generator.library_name = lib_name
+            generator.invoke_all
+          else
+            shell.error "Operation aborted!"
+            exit(2)
+          end
+        end
+        file_adder = FileAdder.new
+        file_adder.library_name = lib_name
+        file_adder.file_names = file_names
+        file_adder.invoke_all
+
+      rescue Exception => exc
+        shell.error exc.message
+        exit(3)
+      end
+      
+    end
+
+
     #--------------------------------------------------------------------------
     # COMPLETION command:
     #--------------------------------------------------------------------------
@@ -80,8 +122,18 @@ module Ecic
     #--------------------------------------------------------------------------
     # LIBRARIES command:
     #--------------------------------------------------------------------------
-    desc 'libraries', 'Display list of libraries in your project'
+    desc 'libraries', Help.text('libraries')['short']
+    long_desc Help.text('libraries')['long']
+    option :format, :type => :string, :banner => 'text|json', :desc => 'Specify the output format'
+    option :include_source_files, :type => :boolean, :aliases => '-s', :desc => "Include source files for each library"
     def libraries
+
+      defaults = {
+        "format"       => "text",
+        "include_source_files" => false
+      }
+      opt = defaults.merge(options)
+      
       root_dir = Project::root
       if root_dir.nil?
         shell.error "You must be within an ECIC project before calling this command" 
@@ -89,9 +141,14 @@ module Ecic
       end
       project = Project.new(root_dir)
       project.load_libraries
-      say project.libraries { |lib| "#{lib.to_s}" }.join("\n")
+      project.load_sources if opt['include_source_files']
+      if opt['format'] == 'json'
+        require 'json'
+        say project.libraries.map{ |lib| lib.to_json(:include_source_files => opt['include_source_files']) }.join(",") 
+      else
+        say project.libraries.map{ |lib| lib.to_str(:include_source_files => opt['include_source_files']) }.join("\n") 
+      end
     end
-    
   end
 end
 

data/lib/ecic/design_generator.rb

@@ -1,16 +1,16 @@
 module Ecic
 
   class DesignGenerator < Thor::Group
+#    require source_file_adder
     include Thor::Actions
-    desc 'Generate a new RTL design'
+    include Ecic::SourceFileAdder
 
-    attr_writer :library_name, :design_name
+    attr_writer :library_name, :design_name, :include_types_pkg
     
     def self.source_root
       File.dirname(__FILE__) + '/../../templates/project'
     end
 
-
 #    def initialize(project_root_path, lib_name)
 #      @destination_root = project_root_path
 #      @library_name = lib_name
@@ -20,11 +20,27 @@ module Ecic
 #      empty_directory "src/design/#{@library_name}/#{File.dirname(@design_name)}"
 #    end
 
+    def copy_rtl_templates
+      base_name = "src/design/#{@library_name}/#{@design_name}"
+      @include_types_pkg ||= false
+      if @include_types_pkg
+        template("src/design/lib/pkg_types.vhd.tt", "#{base_name}-pkg_types.vhd")
+      end
+      template("src/design/lib/pkg_comp.vhd.tt", "#{base_name}-pkg_comp.vhd")
+      template("src/design/lib/ent.vhd.tt", "#{base_name}-ent.vhd")
+      template("src/design/lib/arc_rtl.vhd.tt", "#{base_name}-arc_rtl.vhd")
+    end
+
     def update_src_list
-      template("src/design/lib/pkg_types.vhd.tt", "src/design/#{@library_name}/#{@design_name}-pkg_types.vhd")
-      template("src/design/lib/pkg_comp.vhd.tt", "src/design/#{@library_name}/#{@design_name}-pkg_comp.vhd")
-      template("src/design/lib/ent.vhd.tt", "src/design/#{@library_name}/#{@design_name}-ent.vhd")
-      template("src/design/lib/arc_rtl.vhd.tt", "src/design/#{@library_name}/#{@design_name}-arc_rtl.vhd")
+      src_file = "src/design/#{@library_name}/sources.rb"
+      create_file src_file unless File.exists?(src_file)
+      @include_types_pkg ||= false
+      if @include_types_pkg
+        add_src_file("#{@design_name}-pkg_types.vhd")
+      end
+      add_src_file("#{@design_name}-pkg_comp.vhd")
+      add_src_file("#{@design_name}-ent.vhd")
+      add_src_file("#{@design_name}-arc_rtl.vhd")
     end
 
   end

data/lib/ecic/file_adder.rb

@@ -0,0 +1,21 @@
+module Ecic
+
+  class FileAdder < Thor::Group
+    include Thor::Actions
+    include Ecic::SourceFileAdder
+
+    attr_writer :library_name, :file_names
+    
+#    def self.source_root
+#      File.dirname(__FILE__) + '/../../templates/project'
+#    end
+
+    def add_files_to_source_list
+      @file_names.each { |file_name|
+        add_src_file(file_name)
+      }
+    end
+
+  end
+
+end

data/lib/ecic/generate.rb

@@ -47,38 +47,64 @@ module Ecic
     option :just_print, :type => :boolean, :aliases => '-n', :desc => "Don't actually run any commands; just print them."
     option :type, :type => :string, :banner => 'vhdl|sv', :required => true, :desc => 'Speficy the RTL type (VHDL or Verilog/SystemVerilog)'
     option :lib,  :type => :string, :banner => 'LIBRARY_NAME', :required => true, :desc => 'Speficy the RTL type (VHDL or Verilog/SystemVerilog)'
+    option :types_package, :type => :boolean, :desc => "Include a package file for type and constant definitions."
+
     def design(*names)
-      lib_name = options[:lib]
-      type = options[:type]
-      root_dir = Project::root
-      if root_dir.nil?
-        shell.error "You must be within an ECIC project before calling this command"
-        exit(1)
-      end
-      project = Project.new(root_dir)
-      project.load_libraries
-#      p project.libraries
+      begin
+        lib_name = options[:lib]
+        type = options[:type]
+        root_dir = Project::root
+        if root_dir.nil?
+          shell.error "You must be within an ECIC project before calling this command"
+          exit(1)
+        end
+        project = Project.new(root_dir)
+        project.load_libraries
+  #      p project.libraries
 
-      unless project.libraries.any? {|l| l.name == lib_name }
-        if yes?("Library '#{lib_name}' does not exist. Create it?")
-          generator = LibraryGenerator.new
+        unless project.has_library?(lib_name)
+          if yes?("Library '#{lib_name}' does not exist. Create it? [y/n]:")
+            generator = LibraryGenerator.new
+            generator.destination_root = root_dir
+            generator.library_name = lib_name
+            generator.invoke_all
+          else
+            shell.error "Operation aborted!"
+            exit(2)
+          end
+        end
+
+        names.each { |design_name|
+          incl_types_pkg = options[:types_package]
+          if type == 'vhdl'
+            incl_types_pkg = yes?("Would you like to include a package for type and constant definitions for '#{design_name}'? [y/n]: ") if incl_types_pkg.nil?
+          else
+            incl_types_pkg ||= false
+            if incl_types_pkg
+              shell.error "--types_package option does not apply for Verilog/SystemVerilog generation!"  
+              exit(3)
+            end
+          end
+          #Tba 
+          if type == 'vhdl'
+            generator = DesignGenerator.new
+            generator.include_types_pkg = incl_types_pkg
+          elsif type == 'sv'
+            generator = SvDesignGenerator.new
+          else
+            shell.error "--type option must be set to either 'vhdl' or 'sv'"  
+            exit(3)
+          end
           generator.destination_root = root_dir
           generator.library_name = lib_name
+          generator.design_name = design_name
           generator.invoke_all
-        else
-          shell.error "Operation aborted!"
-          exit(2)
-        end
+        }
+      rescue Exception => exc
+        shell.error exc.message
+        exit(3)
       end
-      names.each { |design_name|
-#        shell.say "Generating '#{design_name}' design in #{lib_name} ..."
-        generator = DesignGenerator.new
-#        shell.error "DesignGenerator could not be created" if generator.nil?
-        generator.destination_root = root_dir
-        generator.library_name = lib_name
-        generator.design_name = design_name
-        generator.invoke_all
-      }
+      
     end
   end
 end

data/lib/ecic/helpers/source_file_adder.rb

@@ -0,0 +1,7 @@
+module Ecic::SourceFileAdder
+  def add_src_file(file_name)
+    src_file = "src/design/#{@library_name}/sources.rb"
+    create_file src_file unless File.exists?(src_file)
+    append_to_file src_file, "source_file.create('#{file_name}')\n"
+  end
+end

data/lib/ecic/library.rb

@@ -3,17 +3,54 @@ module Ecic
   class Library
 
     attr_accessor :name
+    attr_accessor :source_files
 
-    def initialize(name=nil)
+    def initialize(project, name=nil)
+      @project = project
       @name = name
+      @source_files = []
     end
 
     def create(name)
       @name = name      
     end
     
-    def to_s
-      @name
+    def to_str(options={})
+      str = name
+      incl_src_files = options[:include_source_files] || false
+      if incl_src_files
+        str += "\n" + source_files.join("\n") 
+      end
+      str
+    end
+
+    def to_json(options = {})
+      incl_src_files = options[:include_source_files] || false
+      if incl_src_files
+        str = {:name => name, :source_files => source_files}.to_json
+      else
+        str = {:name => name}.to_json        
+      end
+    end
+
+    def load_sources
+      src_file = File.join(@project.root, 'src', 'design', @name, 'sources.rb')
+      if File.exists?(src_file)
+        begin
+          eval File.read(src_file)
+        rescue Exception => exc
+          raise "Syntax error occurred while reading #{src_file}: #{exc.message}"
+        end
+      else
+        raise "Could not read sources for #{name} library"
+      end
+    end
+
+    #Function used by 'source.create' method used in src/confic/libraries.rb
+    def source_file
+      new_src = SourceFile.new(self)
+      source_files << new_src
+      new_src
     end
 
   end

data/lib/ecic/library_generator.rb

@@ -7,18 +7,18 @@ module Ecic
     attr_writer :library_name
     
     def self.source_root
-      File.dirname(__FILE__) + '/../../templates'
+      File.dirname(__FILE__) + '/../../templates/project'
     end
 
     def create_library_directory
-      copy_file 'project/src/design/lib/sources.rb', "src/design/#{@library_name}/sources.rb"
+      template("src/design/lib/sources.rb.tt", "src/design/#{@library_name}/sources.rb")
     end
 
     def update_library_list
       libraries_file = File.expand_path("#{destination_root}/src/config/libraries.rb")
       empty_directory 'src/config' unless File.exist?(File.dirname(libraries_file))      
       create_file libraries_file unless File.exist?(libraries_file)                  
-      append_to_file 'src/config/libraries.rb', "\nlibrary.create('#{@library_name}')"
+      append_to_file 'src/config/libraries.rb', "library.create('#{@library_name}')\n"
     end
 
   end

data/lib/ecic/project.rb

@@ -3,6 +3,7 @@ module Ecic
   class Project
 
     attr_accessor :libraries
+    attr_reader   :root
     
     require 'pathname'
     
@@ -15,6 +16,8 @@ module Ecic
     LIBRARIES_CFG_SCRIPT = File.join('src',  'config', 'libraries.rb')
     
     #Function that returns the root directory of a ECIC project
+    #This is used by some generators to check if a command is called 
+    #from within an ECIC project folder
     def self.root(path = Pathname.new(Dir.pwd))
       if File.exists?(File.join(path, SCRIPT_ECIC))
         return path
@@ -23,31 +26,39 @@ module Ecic
       end
       return root(path.parent)
     end
-
-    def default_library_cfg_file
-      File.join(@root, LIBRARIES_CFG_SCRIPT)
-    end
-
     
-    def load_libraries(lib_file = default_library_cfg_file)
+    def load_libraries
+      lib_file = File.join(@root, LIBRARIES_CFG_SCRIPT)
       if File.exists?(lib_file)
-#        puts "Reading #{lib_file}"
-        eval File.read(lib_file)
-      else
-        raise "Could not read library definitions from #{lib_file}"
+        begin
+          eval File.read(lib_file)
+        rescue Exception => exc
+          raise "Syntax error occurred while reading #{lib_file}: #{exc.message}"
+        end  
+#      else
+#        raise "Could not read library definitions from #{lib_file}"
       end
-
     end
 
-    def add_libray(name)
-      @libraries << Library.new(name)
+
+    def has_library?(lib_name)
+      libraries.any? {|l| l.name == lib_name }
     end
 
+#    def add_libray(name)
+#      @libraries << Library.new(self, name)
+#    end
+
+    #Function used by 'library.create' method used in src/confic/libraries.rb
     def library
-      new_lib = Library.new()
+      new_lib = Library.new(self)
       libraries << new_lib
       new_lib
     end
 
+    def load_sources
+      libraries.each { |lib| lib.load_sources }
+    end
+
   end
 end

data/lib/ecic/source_file.rb

@@ -0,0 +1,20 @@
+module Ecic
+
+  class SourceFile
+
+    attr_accessor :path #, :library
+
+    def initialize(library)
+      @library = library
+    end
+
+    def create(path)
+      @path = path      
+    end
+
+    def to_s
+      "#{path}"
+    end
+
+  end
+end

data/lib/ecic/sv_design_generator.rb

@@ -0,0 +1,25 @@
+module Ecic
+
+  class SvDesignGenerator < Thor::Group
+    include Thor::Actions
+    desc 'Generate a new SystemVerilog design'
+
+    attr_writer :library_name, :design_name
+    
+    def self.source_root
+      File.dirname(__FILE__) + '/../../templates/project'
+    end
+
+    def copy_rtl_templates
+      base_name = "src/design/#{@library_name}/#{@design_name}"
+      template("src/design/lib/design.sv.tt", "#{base_name}.sv")
+    end
+
+    def update_src_list
+      src_file = "src/design/#{@library_name}/sources.rb"
+      create_file src_file unless File.exists?(src_file)
+      append_to_file src_file, "source_file.create('#{@design_name}.sv')\n"
+    end
+  end
+
+end

data/lib/ecic/version.rb

@@ -1,3 +1,3 @@
 module Ecic
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/lib/ecic.rb

@@ -21,11 +21,15 @@ module Ecic
   autoload :Command, "ecic/command"
   autoload :CLI, "ecic/cli"
   autoload :Generate, "ecic/generate"
+  autoload :FileAdder, "ecic/file_adder"
   autoload :Completion, "ecic/completion"
   autoload :Completer, "ecic/completer"
   autoload :DesignGenerator, "ecic/design_generator"
+  autoload :SvDesignGenerator, "ecic/sv_design_generator"
   autoload :ProjectGenerator, "ecic/project_generator"
   autoload :LibraryGenerator, "ecic/library_generator"
+  autoload :SourceFileAdder, "ecic/helpers/source_file_adder"
+  autoload :SourceFile, "ecic/source_file"
   autoload :Library, "ecic/library"
   autoload :Project, "ecic/project"
 end

data/notes.txt

@@ -1,10 +1,12 @@
+* Remove any '/' prefix and postfix from library names when generating a new library (to allow use of "find" command to generate a number of libraries)
+* 'addfile' command must check that each add file actually exists.
+
 #Syntax for sources.rb
 
 add design   chip, :env => ['asic_rtl', 'asic_gate', 'fpga_rtl']
 add design   [basic_vhdl, chip], :except => {:env => ['asic']}
 #add design chip_tb, :path => '/some/absolute/path'
 #add testbench chip_tb, :path => '/some/absolute/path'
-#Libraries can be added in libraries.rb with two different syntaxes, eg.:
+
+#Libraries can be added in libraries.rb with the syntax:
   library.create('lib_x')
-  and 
-  libraries << Library.new('lib_z')

data/templates/project/config/libraries.rb

@@ -1,10 +1,13 @@
 #This file lists all libraries in the project.
 
 #Syntax:
-#     add library LIBRARY
+#
+#    library.create('LIBRARY')
+#
 # where LIBRARY is the name of a VHDL/Verilog library that must be placed in a folder of the same name under src/design
 
 #Syntax:
-#     add testbench TESTBENCH
-# where TESTBENCH is the name of a testbench that must be placed in a folder of the same name under src/testbench
-
+#
+#    testbench.create('TESTBENCH')
+#
+# where TESTBENCH is the name of a testbench that must be placed in a folder of the same name under src/testbench

data/templates/project/src/design/lib/arc_rtl.vhd.tt

@@ -0,0 +1 @@
+VHDL architecture template file

data/templates/project/src/design/lib/design.sv.tt

@@ -0,0 +1 @@
+SystemVerilog template file

data/templates/project/src/design/lib/ent.vhd.tt

@@ -0,0 +1 @@
+VHDL entity template file

data/templates/project/src/design/lib/pkg_comp.vhd.tt

@@ -0,0 +1 @@
+VHDL component template file

data/templates/project/src/design/lib/pkg_types.vhd.tt

@@ -0,0 +1 @@
+VHDL types package template file

data/templates/project/src/design/lib/sources.rb.tt

@@ -0,0 +1,7 @@
+#This file lists all design files for the '<%= @library_name %>' library.
+#
+# Syntax:
+#
+#    source_file.create('DESIGN_FILE')
+#
+# where DESIGN_FILE is the name of a VHDL/Verilog/SystemVerilog file.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ecic
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Torben Fox Jacobsen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-11 00:00:00.000000000 Z
+date: 2018-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -141,12 +141,16 @@ files:
 - lib/ecic/completer/script.sh
 - lib/ecic/completion.rb
 - lib/ecic/design_generator.rb
+- lib/ecic/file_adder.rb
 - lib/ecic/generate.rb
 - lib/ecic/help.rb
+- lib/ecic/helpers/source_file_adder.rb
 - lib/ecic/library.rb
 - lib/ecic/library_generator.rb
 - lib/ecic/project.rb
 - lib/ecic/project_generator.rb
+- lib/ecic/source_file.rb
+- lib/ecic/sv_design_generator.rb
 - lib/ecic/version.rb
 - notes.txt
 - spec/lib/cli_spec.rb
@@ -157,10 +161,11 @@ files:
 - templates/project/config/project.rb
 - templates/project/gitignore
 - templates/project/src/design/lib/arc_rtl.vhd.tt
+- templates/project/src/design/lib/design.sv.tt
 - templates/project/src/design/lib/ent.vhd.tt
 - templates/project/src/design/lib/pkg_comp.vhd.tt
 - templates/project/src/design/lib/pkg_types.vhd.tt
-- templates/project/src/design/lib/sources.rb
+- templates/project/src/design/lib/sources.rb.tt
 homepage: https://github.com/ic-factory/ecic
 licenses:
 - LGPL-3.0