ecic 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5fe4c1aca4adfa0193f736c1ad55a32addf62978adf94d658b677805fa5efe2a
-  data.tar.gz: 7f01b0281fda482bb7007e8fbdcd592cb03cefb1c198dae0687f4ddb61b98956
+  metadata.gz: a1529013358fa74fc927995546738340500b80fcc80aaf96155a761a6696dbf4
+  data.tar.gz: 75a1426a8775b5d267ea9df4f3d32af6ab7f7f87dbbc37ae062f47d8a048ef4c
 SHA512:
-  metadata.gz: 9791e87cbb17451e0c5b45802a958b7ac0c4e06ce4eea40b9c6fdc850486b5c1310543afbc1ff31fba98e539bf5e09e073ed9aa40b0a054d48dd68cccf655b6f
-  data.tar.gz: 98bc6a7a59f5ab7267095dd6681eb240ccf5672ddf883ea0b23d331fe43945ce648c619dcce2d80c622957c0937cf0603729887a24c5b951fe660413e2001f90
+  metadata.gz: 9723f99531c5ef0d17d79360f647ca2f8c24329041c44adf7e769f8b0e09f9b3315694421eb736ba9355f7a2af530c9b23f445ce97e9dc9149eef5ab52597e4b
+  data.tar.gz: 5afaeb4239982741957301afcc184386d1db04701c6fce5f026b8389bc332b8b18c12a760c1364811ad9d38d7c88ee7cf8488be389756ecb3e7032186d540749

data/README.md

@@ -161,21 +161,32 @@ If the folder contains files that will normally be overwritten by the framework,
 
 ### Add existing RTL files
 
-To add an existing RTL file to the project, go to the project folder and use the `ecic add design` commmand. This will add all the listed files to the given design library. If the library does not already exist, you will be asked to confirm the creation of it.
+To add an existing RTL file to the project, go to the project folder and use the `ecic addfile` commmand. This will add all the listed files to your project.
 
-For example, to add two existing files named `./foo/bar/some_design.sv` and `../toto/kuku.vhd` to a library called `my_lib`, run:
+You can specify the library name with the `--lib` option or rely on an implicit library name that is extracted from the full paths of the added files. In the latter case the extracted library name will be equal to the name of the directory just under `src/design` or `src/testbench`. In either case, if the library does not already exist, you will be asked to confirm the creation of it.
 
-    $ ecic add design my_lib ./foo/bar/some_design.sv ../toto/kuku.vhd
+For example, given that:
 
-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.
+  * you have a Unix like terminal
+  * you want to eg. add all design files that have a `.vhd` or `.sv` extention
+  * all design files are placed in subfolders under a `./src/design`
+  * all files for a given RTL library are placed under a folder (of the same name) in the `./src/design`
 
-If you have a Unix like terminal and want to eg. add all files in a `./foo` folder that has the extension `.vhd`, you can use the standard Unix `find` command:
+... then you can use the standard Unix `find` command and leave out the `--lib` option:
 
-    $ ecic add design my_lib `find ./foo -name "*.vhd"`
+    $ ecic addfile `find ./src/design -name "*.vhd"` `find ./src/design -name "*.sv"`
 
-When adding files to the project, the file extension (eg. vhd) is used to determine the file type. VHDL files are expected to have a .vhd or .vhdl extension and Verilog/SystemVerilog files are expected to have a .sv og .v extension. You can also specify the file type with a `type=vhdl|sv` option, eg.:
+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, but this requires using the `--lib` option. For example, to add two existing files named `./foo/bar/some_design.sv` and `../../some/path/outside/the/library/folder/kuku.vhd` to a library called `my_lib`, run:
 
-    $ ecic add design --type=vhdl my_lib `find ./foo -name "*.*"`
+    $ ecic addfile --lib=my_lib ./foo/bar/some_design.sv ../../some/path/outside/the/library/folder/kuku.vhd
+
+If all your VHDL designs assume to be compiled into one library called `work`, you can just set `--lib=work`, eg.:
+
+    $ ecic addfile --lib=work `find . -name "*.vhd"`
+
+When adding files to the project, the file extension (eg. .vhd) is used to determine the file type. VHDL files are expected to have a .vhd or .vhdl extension and Verilog/SystemVerilog files are expected to have a .sv og .v extension. You can also specify the file type with a `type=vhdl|sv` option, eg.:
+
+    $ ecic addfile --type=vhdl --lib=my_lib `find ./foo -name "*.*"`
 
 ## Compiling and elaborating RTL files
 

data/config/locales/help.en.yaml

@@ -55,14 +55,16 @@ help:
     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
+      Example: ecic addfile --lib=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.
+      called 'my_lib' by adding these to the sources.rb file of the libray.
   
       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.
+      
+      If an added file is located outside the project folder, an absolute path will be used by default.
 
   generate:
     short: Generate new testbenches, RTL modules, tests etc.!

data/ecic.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
-
+  spec.required_ruby_version = '>= 2.4.4'
   spec.add_dependency "thor", '~> 0.20'
   spec.add_dependency "colorize", '~> 0.8'
   spec.add_dependency "rake", '~> 12.3'

data/lib/ecic/cli.rb

@@ -1,7 +1,7 @@
 module Ecic
   class CLI < Command
 
-    include Ecic::SourceFileAdder
+    include Ecic::SourceListUpdater
       
     class << self
       def help(shell, subcommand = false)
@@ -11,10 +11,6 @@ module Ecic
         shell.say "To get more help on a specific command, try 'ecic help [COMMAND]'"
       end
 
-      #TBA: Make a function that returns the root folder for the project
-      def root
-        File.expand_path("./tfj2")
-      end
     end
 
     check_unknown_options!
@@ -56,37 +52,32 @@ module Ecic
     #--------------------------------------------------------------------------
     # design generator:
     #--------------------------------------------------------------------------
-    desc "addfile LIBRARY_NAME FILENAME...", Help.text('addfile')['short']
+    desc "addfile FILENAME...", Help.text('addfile')['short']
     long_desc Help.text('addfile')['long']
+    option :lib, :type => :string, :banner => 'LIBRARY_NAME', :desc => 'Specify the name of the design library'
 
-    def addfile(lib_name, *file_names)
+    def addfile(*file_names)
       begin
         root_dir = Project::root
         if root_dir.nil?
-          shell.error "You must be within an ECIC project before calling this command"
+          shell.error set_color("You must be within an ECIC project before calling this command",Thor::Shell::Color::RED)
           exit(1)
         end
+
+        opt = {"lib" => nil}.merge(options)
+
         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
+        lib_name = opt['lib']
         file_adder = FileAdder.new
+        file_adder.destination_root = root_dir
         file_adder.library_name = lib_name
-        file_adder.file_names = file_names
+        file_adder.project      = project
+        file_adder.file_names   = file_names
         file_adder.invoke_all
 
       rescue Exception => exc
-        shell.error exc.message
+        shell.error set_color(exc.message, Thor::Shell::Color::RED)
         exit(3)
       end
       
@@ -127,7 +118,6 @@ module Ecic
     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
@@ -136,22 +126,21 @@ module Ecic
       
       root_dir = Project::root
       if root_dir.nil?
-        shell.error "You must be within an ECIC project before calling this command" 
+        shell.error set_color("You must be within an ECIC project before calling this command",Thor::Shell::Color::RED)
         exit(3)
       end
       project = Project.new(root_dir)
       project.load_libraries
-      project.load_sources if opt['include_source_files']
+      if opt['include_source_files']
+#        puts "reading source files..."
+        project.load_sources 
+      end
       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") 
+        say project.libraries.map{ |lib| lib.to_s(:include_source_files => opt['include_source_files']) }.join("\n") 
       end
     end
   end
-end
-
-
-
-
+end

data/lib/ecic/design_generator.rb

@@ -3,9 +3,9 @@ module Ecic
   class DesignGenerator < Thor::Group
 #    require source_file_adder
     include Thor::Actions
-    include Ecic::SourceFileAdder
+    include Ecic::SourceListUpdater
 
-    attr_writer :library_name, :design_name, :include_types_pkg
+    attr_writer :library, :design_name, :include_types_pkg
     
     def self.source_root
       File.dirname(__FILE__) + '/../../templates/project'
@@ -21,7 +21,7 @@ module Ecic
 #    end
 
     def copy_rtl_templates
-      base_name = "src/design/#{@library_name}/#{@design_name}"
+      base_name = "#{@library.path}/#{@design_name}"
       @include_types_pkg ||= false
       if @include_types_pkg
         template("src/design/lib/pkg_types.vhd.tt", "#{base_name}-pkg_types.vhd")
@@ -32,15 +32,16 @@ module Ecic
     end
 
     def update_src_list
-      src_file = "src/design/#{@library_name}/sources.rb"
+      src_file = "#{@library.path}/sources.rb"
       create_file src_file unless File.exists?(src_file)
       @include_types_pkg ||= false
+      #TBA: update these cals to 'Pathname'
       if @include_types_pkg
-        add_src_file("#{@design_name}-pkg_types.vhd")
+        append_to_file(src_file, "source_file('#{@design_name}-pkg_types.vhd')\n"
       end
-      add_src_file("#{@design_name}-pkg_comp.vhd")
-      add_src_file("#{@design_name}-ent.vhd")
-      add_src_file("#{@design_name}-arc_rtl.vhd")
+      append_to_file(src_file, "source_file('#{@design_name}-pkg_comp.vhd')\n"
+      append_to_file(src_file, "source_file('#{@design_name}-ent.vhd')\n"
+      append_to_file(src_file, "source_file('#{@design_name}-arc_rtl.vhd')\n"
     end
 
   end

data/lib/ecic/file_adder.rb

@@ -1,21 +1,31 @@
 module Ecic
-
   class FileAdder < Thor::Group
     include Thor::Actions
-    include Ecic::SourceFileAdder
+    include Ecic::SourceListUpdater
+    include Ecic::LibraryCreationHelper
+    require 'pathname'
 
-    attr_writer :library_name, :file_names
-    
-#    def self.source_root
-#      File.dirname(__FILE__) + '/../../templates/project'
-#    end
+    attr_accessor :library_name, :file_names, :project
 
     def add_files_to_source_list
-      @file_names.each { |file_name|
-        add_src_file(file_name)
+      #If a library name is given, then the project must already contain a library with that 
+      #name. Otherwise an error message must be returned, because we do not know if it is a
+      #design or testbench library.
+      unless library_name.nil?
+        library = project.get_library(library_name)
+        raise "Unknown library called '#{library_name}'. Please create the library before adding files to it. " if library.nil?
+      end
+      destination_path = Pathname.new(destination_root)      
+      file_names.each { |file_name|
+        src_file_info = SourceFileInfo.new(project, file_name, library)
+        raise "Library name could not be determined from the path of '#{file_name}'. Make sure the appropriate library has been created and specify it with the --lib option." if src_file_info.library.nil?
+#        puts "lib name=#{src_file_info.library.name}, lib_path = #{src_file_info.library.path}"
+        if create_library_if_missing(src_file_info.library)
+          add_src_file(src_file_info, destination_path)
+        else
+          say set_color("Skipping #{file_name}",Thor::Shell::Color::BLUE)
+        end
       }
     end
-
   end
-
 end

data/lib/ecic/generate.rb

@@ -1,5 +1,6 @@
 module Ecic
   class Generate < Command    
+    include Ecic::LibraryCreationHelper
     
     #--------------------------------------------------------------------------
     # TESTBENCH generator:
@@ -21,20 +22,30 @@ module Ecic
     
     option :just_print, :type => :boolean, :aliases => '-n', :desc => "Don't actually run any commands; just print them."
     def library(*names)
-      project_root_path = Ecic::Project::root
-#project_root_path = Dir.pwd
-#if false
-      if project_root_path.nil?
-        shell.error "You must be within an ECIC project before calling this command"
-        exit(1)
-      else
-#        shell.say "Generating library in #{project_root_path}"
-        names.each { |lib_name|
-          generator = LibraryGenerator.new
-          generator.destination_root = project_root_path
-          generator.library_name = lib_name
-          generator.invoke_all
-        }
+      begin
+        project_root_path = Ecic::Project::root
+  #project_root_path = Dir.pwd
+  #if false
+        if project_root_path.nil?
+          shell.error set_color("You must be within an ECIC project before calling this command",Thor::Shell::Color::RED)
+          exit(1)
+        else
+  #        shell.say "Generating library in #{project_root_path}"
+          project = Project.new(project_root_path)
+          project.load_libraries
+          names.each { |lib_name|
+            #TBA: Add option to generate a testbench library as well
+            new_lib = project.design_library(lib_name)
+            if new_lib.already_exists?
+              say set_color("Library called '#{lib_name}' already exists",Thor::Shell::Color::GREEN)
+            else
+              shell.error set_color("Library called '#{lib_name}' could not be generated",Thor::Shell::Color::RED) unless generate_library new_lib
+            end
+          }
+        end
+      rescue Exception => exc
+        shell.error set_color(exc.message,Thor::Shell::Color::RED)
+        exit(3)
       end
     end
     
@@ -51,26 +62,21 @@ module Ecic
 
     def design(*names)
       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"
+          shell.error set_color("You must be within an ECIC project before calling this command",Thor::Shell::Color::RED)
           exit(1)
         end
         project = Project.new(root_dir)
         project.load_libraries
   #      p project.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)
+        lib = project.design_library(options[:lib])
+        unless lib.already_exists?
+          unless ok_to_create_library? lib
+            say "Operation aborted!"
+            raise SystemExit
           end
         end
 
@@ -81,7 +87,7 @@ module Ecic
           else
             incl_types_pkg ||= false
             if incl_types_pkg
-              shell.error "--types_package option does not apply for Verilog/SystemVerilog generation!"  
+              shell.error set_color("--types_package option does not apply for Verilog/SystemVerilog generation!",Thor::Shell::Color::RED)
               exit(3)
             end
           end
@@ -92,16 +98,16 @@ module Ecic
           elsif type == 'sv'
             generator = SvDesignGenerator.new
           else
-            shell.error "--type option must be set to either 'vhdl' or 'sv'"  
+            shell.error set_color("--type option must be set to either 'vhdl' or 'sv'",Thor::Shell::Color::RED)
             exit(3)
           end
           generator.destination_root = root_dir
-          generator.library_name = lib_name
+          generator.library = lib
           generator.design_name = design_name
           generator.invoke_all
         }
       rescue Exception => exc
-        shell.error exc.message
+        shell.error set_color(exc.message,Thor::Shell::Color::RED)
         exit(3)
       end
       

data/lib/ecic/helpers/library_creation_helper.rb

@@ -0,0 +1,77 @@
+module Ecic::LibraryCreationHelper
+  
+  def create_library_if_missing(library)
+    unless library.already_exists?
+      return ok_to_create_library? library
+    end
+    return true
+  end
+
+  def ok_to_create_library?(library)
+    if must_create_new_library? library
+      return generate_library library
+    end
+#    shell.error set_color("Operation aborted!",Thor::Shell::Color::RED)
+#    exit(2)
+    return false
+  end
+  
+  def generate_library(library)
+    if library.is_valid?
+      generator = Ecic::LibraryGenerator.new
+      generator.destination_root = library.project.root
+      generator.library = library
+      generator.invoke_all
+      library.save
+    else
+      return false
+    end
+  end
+
+  protected
+  
+  def must_create_new_library?(library)
+    return true if @always_create_library
+    options = "[Ynaq]"
+    loop do
+      answer = ask(
+        %[#{library.type.to_s.capitalize} library '#{library.name}' does not exist. Create it? (enter "h" for help) #{options}],
+        :add_to_history => false
+      )
+      case answer
+      when nil
+        say ""
+        return true
+      when is?(:yes), is?(:all), ""
+        return true
+      when is?(:no), is?(:skip)
+        return false
+      when is?(:always)
+        return @always_create_library = true
+      when is?(:quit)
+        say "Aborting..."
+        raise SystemExit
+      else
+        say library_creation_help
+      end
+    end
+  end
+  
+  def library_creation_help
+    puts "Options:"
+    puts "  Yes     : Create the library (default)"
+    puts "  No      : Continue without creating the library"
+    puts "  All     : Create the library (and any additional libraries)"
+    puts "  Quit    : Abort operation"
+  end
+  
+  def is?(value) #:nodoc:
+    value = value.to_s
+    if value.size == 1
+      /\A#{value}\z/i
+    else
+      /\A(#{value}|#{value[0, 1]})\z/i
+    end
+  end
+  
+end

data/lib/ecic/helpers/source_list_updater.rb

@@ -0,0 +1,21 @@
+module Ecic::SourceListUpdater
+  def add_src_file(src_file_info, dest_root)
+    #TBA: IF THE absolute_file_path IS OUTSIDE THE PROJECT FOLDER, THEN THE ABSOLUTE FILE PATH MUST BE USED INSTEAD OF 'relative_file_path'
+    src_list_filepath = src_file_info.sources_file_path
+    absolute_file_path = src_file_info.absolute_path
+#    puts "src_list_filepath=#{src_list_filepath}"
+#    puts "absolute_file_path=#{absolute_file_path}"
+#    puts "dest_root=#{dest_root}"
+    if src_file_info.is_outside_project?
+      used_file_ref = absolute_file_path.to_s
+    else
+      used_file_ref = absolute_file_path.relative_path_from(dest_root.join(src_list_filepath.dirname)).to_s
+    end
+#        puts "relative_file_path = #{relative_file_path}"
+#        relative_src_list_filepath = src_list_filepath.relative_path_from(dest_root).to_s
+#    puts "relative_src_list_filepath = relative_src_list_filepath"
+#    src_file = "src/design/#{library_name}/sources.rb.tfj"
+    create_file src_list_filepath unless File.exists?(File.join(dest_root,src_list_filepath))
+    append_to_file src_list_filepath, "source_file('#{used_file_ref}')\n"
+  end
+end

data/lib/ecic/library.rb

@@ -2,56 +2,99 @@ module Ecic
 
   class Library
 
-    attr_accessor :name
+    attr_accessor :name, :path, :project
     attr_accessor :source_files
+    attr_reader   :type
 
-    def initialize(project, name=nil)
+    
+    def initialize(project, name, type, options={})
+      opt = {:path => nil}.merge(options)
       @project = project
+      @type = type
       @name = name
+      default_path = {:testbench => "src/testbench/#{@name}",
+                      :design    => "src/design/#{@name}"}
+      @path = opt[:path] || default_path[@type]
       @source_files = []
     end
-
-    def create(name)
-      @name = name      
+    
+    def is_valid?
+      begin
+        validate_name
+        return false if already_exists?
+        #TBA: validate unique name as well
+        return true
+        #TBA: 'validate_name' should raise a specific naming exception and only this specific exception should be caught. 
+      rescue Exception => exc
+        return false
+      end
     end
     
+    def save
+      validate_name
+      @project.add_library self      
+    end
+
+    def already_exists?
+      @project.has_library?(self)
+    end
+
     def to_str(options={})
+      to_s(options)
+    end
+    
+    def to_s(options={})
       str = name
       incl_src_files = options[:include_source_files] || false
       if incl_src_files
-        str += "\n" + source_files.join("\n") 
+        str += ":"
+        str += "\n  " + source_files.join("\n  ") unless source_files.length == 0
       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
+      hash = {:name => name, :path => path}
+      hash[:source_files] = source_files if incl_src_files
+      hash.to_json
     end
 
     def load_sources
-      src_file = File.join(@project.root, 'src', 'design', @name, 'sources.rb')
+      src_file = File.join(@project.root, @path, 'sources.rb')
       if File.exists?(src_file)
         begin
+          puts "reading #{src_file} ..."
           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"
+#        p @path
+#        p @type
+        raise "Could not read sources for #{name} library. #{src_file} file does not exist"
       end
     end
 
-    #Function used by 'source.create' method used in src/confic/libraries.rb
-    def source_file
-      new_src = SourceFile.new(self)
+    def is_a_testbench?
+      @type == :testbench
+    end
+    
+    #Function used in sources.rb file of each library
+    def source_file(path)
+#      puts "Creating new source file"
+      new_src = SourceFile.new(self, path)
       source_files << new_src
       new_src
     end
 
+    ###########################################################################    
+    protected
+    ###########################################################################    
+
+    def validate_name
+      raise "#{@name} is not a valid library name. Library names must start with a letter, followed by one or more numbers, letters or underscores" unless /\A[a-zA-Z]\w*\Z/.match(@name)
+    end
+    
   end
 end

data/lib/ecic/library_generator.rb

@@ -4,21 +4,34 @@ module Ecic
     include Thor::Actions
     desc 'Generate a new RTL library'
 
-    attr_writer :library_name
+    attr_writer :library
     
     def self.source_root
       File.dirname(__FILE__) + '/../../templates/project'
     end
 
     def create_library_directory
-      template("src/design/lib/sources.rb.tt", "src/design/#{@library_name}/sources.rb")
+      src_list_file = File.expand_path("#{destination_root}/#{@library.path}/sources.rb")
+      template("src/design/lib/sources.rb.tt", src_list_file) unless File.exist?(src_list_file)
     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', "library.create('#{@library_name}')\n"
+      empty_directory 'src/config' unless File.exist?(File.dirname(libraries_file))
+      create_file libraries_file unless File.exist?(libraries_file)
+      case @library.path.to_s
+      when "src/design/#{@library.name}"
+        cmd = "design_library('#{@library.name}')"
+      when "src/testbench/#{@library.name}"
+        cmd = "testbench_library('#{@library.name}')"
+      else
+        if @library.is_a_testbench?
+          cmd = "testbench_library('#{@library.name}', :path => '#{@library.path}')"
+        else
+          cmd = "design_library('#{@library.name}', :path => '#{@library.path}')"
+        end
+      end
+      append_to_file 'src/config/libraries.rb', "#{cmd}\n"
     end
 
   end

data/lib/ecic/project.rb

@@ -20,13 +20,13 @@ module Ecic
     #from within an ECIC project folder
     def self.root(path = Pathname.new(Dir.pwd))
       if File.exists?(File.join(path, SCRIPT_ECIC))
-        return path
+        return File.expand_path(path)
       elsif path.root?
         return nil
       end
       return root(path.parent)
     end
-    
+
     def load_libraries
       lib_file = File.join(@root, LIBRARIES_CFG_SCRIPT)
       if File.exists?(lib_file)
@@ -34,26 +34,47 @@ module Ecic
           eval File.read(lib_file)
         rescue Exception => exc
           raise "Syntax error occurred while reading #{lib_file}: #{exc.message}"
-        end  
+        end
 #      else
 #        raise "Could not read library definitions from #{lib_file}"
       end
     end
 
+    def has_library?(library)
+      libraries.any? {|l| l.name.eql? library.name}
+    end
 
-    def has_library?(lib_name)
-      libraries.any? {|l| l.name == lib_name }
+    def library_mapped_to(path)
+      matching_libraries = libraries.select {|l| l.path.eql? path }
+      raise "Found multiple libraries mapped to '#{path}'" if matching_libraries.length > 1
+      matching_libraries.first
+    end
+      
+    def get_library(lib_name)
+      matching_libraries = libraries.select {|l| l.name.eql? lib_name }
+      raise "Found multiple libraries called '#{lib_name}'" if matching_libraries.length > 1
+      matching_libraries.first
     end
 
-#    def add_libray(name)
-#      @libraries << Library.new(self, name)
-#    end
+    def add_library(lib)
+      raise "A library called '#{lib.name}' already exists" if has_library?(lib)
+      raise "A library is already mapped to '#{lib.path}'" if library_mapped_to(lib.path)
+      @libraries << lib
+      return true
+    end
+
+    #Function used in src/confic/libraries.rb
+    def design_library(name, options={})
+      lib = Library.new(self, name, :design, options)
+      lib.save
+      lib
+    end
 
-    #Function used by 'library.create' method used in src/confic/libraries.rb
-    def library
-      new_lib = Library.new(self)
-      libraries << new_lib
-      new_lib
+    #Function used in src/confic/libraries.rb
+    def testbench_library(name, options={})
+      lib = Library.new(self, name, :testbench, options)
+      lib.save
+      lib
     end
 
     def load_sources

data/lib/ecic/source_file.rb

@@ -4,12 +4,9 @@ module Ecic
 
     attr_accessor :path #, :library
 
-    def initialize(library)
+    def initialize(library, path)
       @library = library
-    end
-
-    def create(path)
-      @path = path      
+      @path = path
     end
 
     def to_s

data/lib/ecic/source_file_info.rb

@@ -0,0 +1,98 @@
+module Ecic
+  #Class that can provide various info about what do to with a source file.
+  class SourceFileInfo
+
+    require 'pathname'
+
+    attr_reader :absolute_path, :library
+    
+    STANDARD_LIBRARY_FOLDERS_LIST = ["src/design", "src/testbench"]
+
+    def initialize(project, file_name, library=nil)
+      @project = project
+      @absolute_path = Pathname.new(File.expand_path(file_name))      
+      @relative_path_from_project = @absolute_path.relative_path_from(Pathname.new("#{@project.root}"))
+      @library = library || get_library_from_file_path
+    end
+
+    #TBA: Make sure this function works for libraries under src/testbench as
+    #well and make sure it returns nil, if the library name cannot be determined.
+    #TBA: Update this function to first look for any sources.rb files within the
+    #project folder structure.
+    def get_library_from_file_path
+      return nil if is_outside_project?
+      sources_file_dir = find_sources_file_dir 
+      if sources_file_dir
+        #A sources.rb file was found."
+        #Check if an existing library is already mapped to that folder. If so, return that library
+        #and otherwise return a new library that is named according to the  folder
+        already_mapped_lib = @project.library_mapped_to(sources_file_dir.to_s)
+        return already_mapped_lib if already_mapped_lib
+        #Use the name of the folder as the library name:"
+        lib_dir = sources_file_dir
+      else
+#        puts "        #Could not find an existing sources.rb file for the given source file"
+        lib_dir = get_default_library_dir_from_file_path
+      end
+      unless lib_dir.nil?
+        lib_name = lib_dir.basename.to_s
+        Ecic::Library.new(@project, lib_name, get_library_type_from_file_path, :path => lib_dir)
+      end
+    end
+
+    def is_outside_project?
+#      @relative_path_from_project.to_s.split('/')[0] == ".."
+      /\A\.\./.match(@relative_path_from_project.to_s)
+    end
+ 
+#    def within_expected_folder?
+#      rel_design_path_list = @relative_path_from_project.to_s.split('/')
+#      return nil if rel_design_path_list.length < 3
+#      str = [rel_design_path_list.first(2)].join('/')
+#      STANDARD_LIBRARY_FOLDERS_LIST.include? str
+#    end
+    
+    #Function that looks for a sources.rb file within the project
+    def find_sources_file_dir(dir = @relative_path_from_project.dirname)
+      return nil if is_outside_project?
+      file = File.join(@project.root, dir, "sources.rb")
+      if dir.root? or dir.to_s == "."
+        return nil
+      elsif File.exists?(file)
+        return dir
+      else
+        return find_sources_file_dir(dir.parent)
+      end
+    end
+
+    #Function that returns the name of the directory that is placed just under src/design or src/testbench:
+    def get_default_library_dir_from_file_path
+      #Get the first directory name after src/design or src/testbench:
+      rel_design_path_list = @relative_path_from_project.to_s.split('/')
+      return nil if rel_design_path_list.length < 3
+      return nil unless STANDARD_LIBRARY_FOLDERS_LIST.include? [rel_design_path_list.first(2)].join('/')
+      Pathname.new([rel_design_path_list.first(3)].join('/'))
+    end
+
+    #Function that returns the type of library that 
+    def get_library_type_from_file_path
+      #Get the first directory name after src/design or src/testbench:
+      rel_design_path_list = @relative_path_from_project.to_s.split('/')
+      return nil if rel_design_path_list.length < 2
+      case [rel_design_path_list.first(2)].join('/')
+      when "src/testbench"
+        return :testbench
+      when "src/design"
+        return :design
+      else
+        return nil
+      end
+    end
+
+    def sources_file_path
+      return nil if @library.nil?
+#      puts "#{@library.path}/sources.rb"
+      Pathname.new("#{@library.path}/sources.rb")
+    end
+  end
+end

data/lib/ecic/sv_design_generator.rb

@@ -4,21 +4,21 @@ module Ecic
     include Thor::Actions
     desc 'Generate a new SystemVerilog design'
 
-    attr_writer :library_name, :design_name
+    attr_writer :library, :design_name
     
     def self.source_root
       File.dirname(__FILE__) + '/../../templates/project'
     end
 
     def copy_rtl_templates
-      base_name = "src/design/#{@library_name}/#{@design_name}"
+      base_name = "#{@library.path}/#{@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"
+      src_file = "#{@library.path}/sources.rb"
       create_file src_file unless File.exists?(src_file)
-      append_to_file src_file, "source_file.create('#{@design_name}.sv')\n"
+      append_to_file src_file, "source_file('#{@design_name}.sv')\n"
     end
   end
 

data/lib/ecic/version.rb

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

data/lib/ecic.rb

@@ -28,8 +28,10 @@ module Ecic
   autoload :SvDesignGenerator, "ecic/sv_design_generator"
   autoload :ProjectGenerator, "ecic/project_generator"
   autoload :LibraryGenerator, "ecic/library_generator"
-  autoload :SourceFileAdder, "ecic/helpers/source_file_adder"
+  autoload :SourceListUpdater, "ecic/helpers/source_list_updater"
+  autoload :LibraryCreationHelper, "ecic/helpers/library_creation_helper"
   autoload :SourceFile, "ecic/source_file"
   autoload :Library, "ecic/library"
   autoload :Project, "ecic/project"
-end
+  autoload :SourceFileInfo, "ecic/source_file_info"
+end

data/notes.txt

@@ -1,3 +1,30 @@
+#Make sure to check if a library already is mapped to a given folder - before asking to create a new one (in case a library with different name than the folder name is already mapped to that folder) 
+
+#The 'all' option for creating a new library (when adding files) does not work
+
+#When sources files are listed, they must be displayed in alphabetical order.
+
+#Use "raise SystemExit" instead of the various "exit" calls
+
+* Make sure the design_generator still works, now that the 'add_src_file' method has been changed.
+
+* make sure "/Users/torbenj/projects/github/ecic/exe/ecic generate library dsp_core" command works
+
+* When generating a library, the libraries.rb file must include a path as a 2nd optional option, if the design library is not placed in src/design or if a testbench library is not placed in src/testbench.
+
+* Update the 'add_src_file' method so this method ensures that file paths are always relative to the sources.rb file.
+
+* Consider adding support for having libraries within subfolders, ie. a 
+    "--lib=blk1/subblock" should expect a sources.rb file in eg "src/design/blk1/subblock" and the library name should be
+    converted eg. "blk1-subblock" when compiling and when using it in a VHDL design.
+    
+
+* bug: 'addfile' command assumes that files are placed inder src/design - and never under src/testbench!! (given the fact that the --lib option is used, how can be specify a library under src/testbench ?? One option could be to require that the addfile command is called from within a library/testbench folder if adding a file not placed in either src/Design or src/testbench - and then remove the --lib option completely?) .
+
+Same issue with 'add_src_file' which also assumes src/design folder
+
+*    ls -d */  -> returns list of directorys (but include a trailing / character)
+
 * 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.
 
@@ -6,7 +33,4 @@
 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 the syntax:
-  library.create('lib_x')
+#add testbench chip_tb, :path => '/some/absolute/path'

data/templates/project/config/libraries.rb

@@ -2,12 +2,10 @@
 
 #Syntax:
 #
-#    library.create('LIBRARY')
+#    design_library('library_name')
 #
-# 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:
+# where library_name is the name of a VHDL/Verilog library, which is normally placed in a folder of the same name under src/design
 #
-#    testbench.create('TESTBENCH')
+#    testbench_library('testbench_name')
 #
-# where TESTBENCH is the name of a testbench that must be placed in a folder of the same name under src/testbench
+# where testbench_name is the name of a testbench library, which is normally placed in a folder of the same name under src/testbench

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

@@ -2,6 +2,6 @@
 #
 # Syntax:
 #
-#    source_file.create('DESIGN_FILE')
+#    source_file('design_file')
 #
-# where DESIGN_FILE is the name of a VHDL/Verilog/SystemVerilog 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.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Torben Fox Jacobsen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-18 00:00:00.000000000 Z
+date: 2018-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -144,12 +144,14 @@ files:
 - lib/ecic/file_adder.rb
 - lib/ecic/generate.rb
 - lib/ecic/help.rb
-- lib/ecic/helpers/source_file_adder.rb
+- lib/ecic/helpers/library_creation_helper.rb
+- lib/ecic/helpers/source_list_updater.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/source_file_info.rb
 - lib/ecic/sv_design_generator.rb
 - lib/ecic/version.rb
 - notes.txt
@@ -178,7 +180,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.4.4
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/ecic/helpers/source_file_adder.rb

@@ -1,7 +0,0 @@
-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