ecic 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a216371da32fdac9361a74bec2731d155686754f57b0d36a8568eb5c48caf1d
-  data.tar.gz: 90920997e9a82cdeb267d83b18fe3a685198ffa0aa2be1c1898775d84f2a6267
+  metadata.gz: d135593bf08ee2250db65bf5ec3f0703335537464e0fc44ba9f39c23a46c5dad
+  data.tar.gz: ee954989cb0b2a52e55037f82b7db5002e8c00701a8bae0953aece5a75028798
 SHA512:
-  metadata.gz: 6e121298d8fbb508c1ea7215e7aa346162b34bc75778612835018fd6104267c8ac270c5c3cd6c74e55c437a2641aa19e93768c469ca0b0084e15e0886dbe0caa
-  data.tar.gz: 034ca0e7b15f88814183258af18f825f1f0b2b916857dc6876cf4f6de3b206e0789561e1cf1bd81b45c8e49b1fe774b9a36e9c97c68998de7c36d85bcb47a112
+  metadata.gz: 4ae1a8190ffac083f9d1f7ce09a01d1ff29a1d2bb6ad9e952862aec8f0801dd3b9142f24ae2c1ea71f8a47a4c740db307881d2889544a6bbc90920444f169cd8
+  data.tar.gz: 2f9ddd3385c0df5bd67efb405baf430bc467588cbc84472edfea35587088a1364e5417f1dc825ed624c2c726fb9d18d8c32a58db0c42aab5cc61d1ba7b1d3a51

data/Gemfile.lock

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

data/README.md

@@ -64,9 +64,9 @@ To see the full list of options for the `ecic generate library` command, run `ec
 
 ### Create new RTL file
 
-Creating a **new** RTL design can be done with the `ecic generate design` command. For VHDL designs, this command will generate both the component, entity and architecture and for SystemVerilog it will create a module. If you already have existing RTL design files you wish to add to the project, you should use the `ecic add design` command instead, see the 'Add existing RTL files' section.
+Creating a **new** RTL design can be done with the `ecic generate design` command. For VHDL designs, this command will generate both the component, entity and architecture and for SystemVerilog it will create a module. If you already have existing RTL design files you wish to add to the project, you should use the `ecic add design` command instead, see the `Add existing RTL files` section.
 
-The type of RTL design (VHDL or Verilog) to create is controlled by a `--type=vhdl|verilog` option and defaults to the value defined by the `config.generator.library.type.default` setting in the `./src/config/ecic.rb` configuratinon file.
+The type of RTL design (VHDL or Verilog) to create is controlled by a `--type=vhdl|sv` option and defaults to the value defined by the `config.generator.library.type.default` setting in the `./src/config/ecic.rb` configuratinon file.
 
 The `ecic generate design` command can be called from any directory within your project. To see the full list of options for the `ecic generate design` command, run `ecic generate help design`.
 
@@ -82,17 +82,19 @@ When creating a new VHDL design, you will be given the option to also create and
 
 The following VHDL files will be created (relative to the project root folder):
 
-    ./src/design/my_lib/my_design1-pkg-comp.vhd    # Component definition
+    ./src/design/my_lib/my_design1-pkg_types.vhd   # Types and constants definition package (optional)                                                     
+    ./src/design/my_lib/my_design1-pkg_comp.vhd    # Component definition
     ./src/design/my_lib/my_design1-ent.vhd         # Entity definition
-    ./src/design/my_lib/my_design1-arc-rtl.vhd     # RTL architecture
-    ./src/design/my_lib/my_design1-pkg-types.vhd   # Types and constants definition package (optional)                                                     
+    ./src/design/my_lib/my_design1-arc_rtl.vhd     # RTL architecture
 
 Placing each component, entity and architecture in separate files allows a projects to be recompiled very fast when only a few files have been modified, since eg. an update that is isolated to a single RTL architecture only requires that one file to be recompiled. Splitting the entity and architecture into separate files also allows you to have multiple architectures for the save entity and choose between the architecture files at compile time without having to use `VHDL configuration` constructs.
 
-Should you still wish to combine eg. the entity and architecture files into one file, you can configure `ECIC` to do this by default by setting `config.generator.design.vhdl.combine` option in `./src/config/ecic.rb`:
+Should you still wish to combine eg. the entity and architecture files into one file, you can configure `ECIC` to do this by default by setting the `config.generator.design.vhdl.combine` option in `./src/config/ecic.rb`, eg.:
 
     config.generator.design.vhdl.combine = 'entity + architecture'
 
+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
 
 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:
@@ -101,14 +103,14 @@ You can create multiple designs at the same time, and designs can be placed in s
 
 This will create the following VHDL files (relative to the project root folder):
 
-    ./src/design/my_lib/my_design2-comp.pkg.vhd                # Component definition
+    ./src/design/my_lib/my_design2-pkg_types.vhd               # Types and constants definition package (optional)                                                     
+    ./src/design/my_lib/my_design2-pkg_comp.vhd                # Component definition
     ./src/design/my_lib/my_design2-ent.vhd                     # Entity definition
-    ./src/design/my_lib/my_design2-rtl_arc.vhd                 # RTL architecture
-    ./src/design/my_lib/my_design2-pkg-types.vhd               # Types and constants definition package (optional)                                                     
-    ./src/design/my_lib/my_subblock/my_design3-comp-pkg.vhd    # Component definition
+    ./src/design/my_lib/my_design2-arc_rtl.vhd                 # RTL architecture
+    ./src/design/my_lib/my_subblock/my_design3-pkg_types.vhd   # Types and constants definition package (optional)                                                     
+    ./src/design/my_lib/my_subblock/my_design3-pkg_comp.vhd    # Component definition
     ./src/design/my_lib/my_subblock/my_design3-ent.vhd         # Entity definition
-    ./src/design/my_lib/my_subblock/my_design3-rtl_arc.vhd     # RTL architecture
-    ./src/design/my_lib/my_subblock/my_design3-pkg-types.vhd   # Types and constants definition package (optional)                                                     
+    ./src/design/my_lib/my_subblock/my_design3-arc_rtl.vhd     # RTL architecture
 
 In this example the `--types-package` option is used to automatically include the `*-pkg-types.vhd` files without prompting the user with the option.
  
@@ -131,7 +133,7 @@ All generated SystemVerilog files will be added to the `sources.rb` file in the
 
 #### Omitting the --lib option
 
-If the `ecic generate design` command is called from within a library folder (or subfolder), the `--lib` option can be omitted, in which case the new designs will be created for that library. The files will be placed relative to the current working directory.
+If the `ecic generate design` command is called from within a library folder (or subfolder) and the `--lib` option is omitted, the new designs will be created for the library in that folder.
 
 Example:
 
@@ -140,7 +142,9 @@ Example:
 
 That will generate the files as:
 
-    ./src/design/queue_system/arbitor/statemachine-*.vhd      #Path is relative to the project root folder
+    ./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.
 
 ## Migrating an existing project to use ECIC
 

data/config/locales/help.en.yaml

@@ -35,11 +35,11 @@ help:
       
     script:
       short: Generate script that can be eval to setup auto-completion      
-      long:   |
+      long: |
         To use, add the following to your ~/.bashrc or ~/.profile
 
           eval $(ecic completion script)      
-      
+
   generate:
     short: Generate new testbenches, RTL modules, tests etc.!
     testbench:
@@ -60,4 +60,18 @@ help:
             Example: ecic generate library lib1 lib2 lib3...
 
             This creates the given libraries in the ./src/design/ directory of 
-            your project and adds the libraries to ./src/config/libraries.rb
+            your project and adds the libraries to ./src/config/libraries.rb
+            
+    design:
+      short: Create a new RTL design
+      long: |
+            Create a new VHDL/SystemVerilog design.
+            
+            Example: ecic generate design --type=vhdl --library=some_lib design1 sub_block/design2
+
+            This creates the component, entity and architecture files for two designs called 'design1' and 'design2'.
+            An optional types and constants definition file may also be created for each design.
+            The files for 'design1' will be placed under 'src/design/some_lib' whereas the files for 'design2'
+            will be placed in 'src/design/some_lib/sub_block'.
+            
+            The RTL files are automatically added to the project and the given library will be created and added as well if needed.

data/lib/ecic.rb

@@ -23,6 +23,7 @@ module Ecic
   autoload :Generate, "ecic/generate"
   autoload :Completion, "ecic/completion"
   autoload :Completer, "ecic/completer"
+  autoload :DesignGenerator, "ecic/design_generator"
   autoload :ProjectGenerator, "ecic/project_generator"
   autoload :LibraryGenerator, "ecic/library_generator"
   autoload :Library, "ecic/library"

data/lib/ecic/cli.rb

@@ -83,10 +83,12 @@ module Ecic
     desc 'libraries', 'Display list of libraries in your project'
     def libraries
       root_dir = Project::root
-      shell.error "You must be within an ECIC project before calling this command" if root_dir.nil?
-      library_cfg_file = Project::library_cfg_file(root_dir)
-      project = Project.new
-      project.load_libraries(library_cfg_file)
+      if root_dir.nil?
+        shell.error "You must be within an ECIC project before calling this command" 
+        exit(3)
+      end
+      project = Project.new(root_dir)
+      project.load_libraries
       say project.libraries { |lib| "#{lib.to_s}" }.join("\n")
     end
     

data/lib/ecic/design_generator.rb

@@ -0,0 +1,32 @@
+module Ecic
+
+  class DesignGenerator < Thor::Group
+    include Thor::Actions
+    desc 'Generate a new RTL design'
+
+    attr_writer :library_name, :design_name
+    
+    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
+#    end
+    
+#    def create_design_directory
+#      empty_directory "src/design/#{@library_name}/#{File.dirname(@design_name)}"
+#    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")
+    end
+
+  end
+
+end

data/lib/ecic/generate.rb

@@ -32,13 +32,53 @@ module Ecic
         names.each { |lib_name|
           generator = LibraryGenerator.new
           generator.destination_root = project_root_path
-  #        names.each do |lib_name|
-            generator.library_name = lib_name
-            generator.invoke_all
-  #        end
+          generator.library_name = lib_name
+          generator.invoke_all
         }
       end
+    end
+    
+    #--------------------------------------------------------------------------
+    # design generator:
+    #--------------------------------------------------------------------------
+    desc "design NAME...", Help.text('generate')['design']['short']
+    long_desc Help.text('generate')['design']['long']
+    
+    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)'
+    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
 
+      unless project.libraries.any? {|l| l.name == lib_name }
+        if yes?("Library '#{lib_name}' does not exist. Create it?")
+          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|
+#        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/library.rb

@@ -2,6 +2,8 @@ module Ecic
 
   class Library
 
+    attr_accessor :name
+
     def initialize(name=nil)
       @name = name
     end

data/lib/ecic/project.rb

@@ -6,17 +6,14 @@ module Ecic
     
     require 'pathname'
     
-    def initialize
+    def initialize(root = Project::root)
       @libraries = []
+      @root = root
     end
 
     SCRIPT_ECIC = File.join('src',  'config', 'ecic.rb')
     LIBRARIES_CFG_SCRIPT = File.join('src',  'config', 'libraries.rb')
     
-    def self.library_cfg_file(root = Project::root)
-      File.join(root, LIBRARIES_CFG_SCRIPT)
-    end
-
     #Function that returns the root directory of a ECIC project
     def self.root(path = Pathname.new(Dir.pwd))
       if File.exists?(File.join(path, SCRIPT_ECIC))
@@ -26,10 +23,15 @@ 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)
+    def load_libraries(lib_file = default_library_cfg_file)
       if File.exists?(lib_file)
-        puts "Reading #{lib_file}"
+#        puts "Reading #{lib_file}"
         eval File.read(lib_file)
       else
         raise "Could not read library definitions from #{lib_file}"

data/lib/ecic/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ecic
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Torben Fox Jacobsen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-10 00:00:00.000000000 Z
+date: 2018-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -140,6 +140,7 @@ files:
 - lib/ecic/completer/script.rb
 - lib/ecic/completer/script.sh
 - lib/ecic/completion.rb
+- lib/ecic/design_generator.rb
 - lib/ecic/generate.rb
 - lib/ecic/help.rb
 - lib/ecic/library.rb
@@ -155,6 +156,10 @@ files:
 - templates/project/config/libraries.rb
 - templates/project/config/project.rb
 - templates/project/gitignore
+- templates/project/src/design/lib/arc_rtl.vhd.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
 homepage: https://github.com/ic-factory/ecic
 licenses: