flgen 0.16.1 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ffab1952f67689d9675b1a5f0ee47b4905b7ea098b5013b2467cfa54360e311
-  data.tar.gz: bd33d9997f06c4b6a00ab54a2df2fefe9ff86d9eb766d098ed787e500f289db6
+  metadata.gz: 5660041e78d446e6127ef86bb45e93468f000750b2917df3e0b34de33ab4cfd0
+  data.tar.gz: f78fa09b2bac383f4f38270ad31ed7d67c98ea06e7709d2fd2aacd7a6b6d322d
 SHA512:
-  metadata.gz: d698fd487524fd93687db00ff03b73351579fd8499092960f6b077f42afc3fdbc2910926e95bd8a00e9d08cc47c60baa1478cf17309c008bc131371af1cd977f
-  data.tar.gz: 66c01f900315edc6d7355281112be92ef2e28eccfc174049c611959a5385b56b9ba1a9ee73f2102e34e250ead4a1a3805440c3e6c07a109d2c367312d279b1f1
+  metadata.gz: d3b76b55b57b5e52a316a9eed0c7051e6c1333536b9ead179f3b0616920a1bb1524af76f6d2a6e921553083cdb4d04e53f5f28742083312dbd0cadc88514ab45
+  data.tar.gz: 13a7d45bd399cc0bb57d52084599de7912f894844092d6054289b4c8a555ff7cb4ea07c6979206ee16548409afdb5ff3ae94a452426a79778abdb9cc1bda650a

data/README.md

@@ -24,19 +24,23 @@ $ gem install flgen
 
 FLGen prives APIs listed below to describe your filelists.
 
-* `source_file(path, from: :current, base: nil)`
+* `source_file(path, from: nil)`
     * Add the given source file to the current filelist.
-* `file_list(path, from: :root, base: nil)`
+* `file_list(path, from: nil)`
     * Load the given filelist.
-* `include_directory(path, from: :current, base: nil)`
+* `library_file(path, from: nil)`
+    * Add the given file to the list of library files.
+* `include_directory(path, from: nil)`
     * Add the given directory to the list of include direcotries.
+* `library_directory(path, from: nil)`
+    * Add the given directory to the list of library directories.
 * `define_macro(name, value = nil)`
     * Define a text macro.
 * `macro?(name)`/`macro_defined?(name)`
     * Return `true` if the given macro is defined.
-* `file?(path, from: :current, base: nil)`
+* `file?(path, from: :current)`
     * Return `treu` if the given file exists.
-* `directory?(path, from: :current, base: nil)`
+* `directory?(path, from: :current)`
     * Return `true` if the given directory exists.
 * `env?(name)`
     * Return `true` if the givne environment variable is defined.
@@ -50,6 +54,10 @@ FLGen prives APIs listed below to describe your filelists.
     * If `tool` is specified the given argument is added only when `tool` is matched with the targe tool.
 * `target_tool?(tool)`
     * Return `true` if the given tool is matched with the targe tool.
+* `default_search_path(**seach_paths)`
+    * Change the default behavior when the `from` argument is not specified.
+* `reset_default_search_path(*target_types)`
+    * Reset the default behavior when the `from` argument is not specified.
 
 FLGen's filelist is designed as an inernal DSL with Ruby. Therefore you can use Ruby's syntax. For example:
 
@@ -61,10 +69,12 @@ else
 end
 ```
 
-### About `from`/`base` arguments
+### About the `from` argument
 
 The `from` argument is to specify how to search the given file or directory. You can specify one of three below.
 
+* a directory path
+    * Seach the given file or directory from the directory path specified by the `from` argument.
 * `:current`
     * Search the given file or directory from the directory where the current filelist is.
 * `:root`
@@ -74,9 +84,31 @@ The `from` argument is to specify how to search the given file or directory. You
 * `:local_root`
     * Search the given file or directory from the repository root directory where the current filelist belongs to.
 
-The `from` argument is ignored if the given path is an absolute path or the `base` argument is specified.
+Default behaviors when the `from` argument is not spcified are listed below:
 
-The `base` argument is to specify the serach direcotry for the given file or directory.
+* `source_file`
+    * `:current`
+* `file_list`
+    * `:root`
+* `library_file`
+    * `:current`
+* `include_directory`
+    * `:current`
+* `library_directory`
+    * `:current`
+
+You can change the above default behaviors by using the `default_search_path` API.
+In addition, you can reset the default behaviors by using the `reset_default_search_path` API.
+
+```ruby
+default_seach_path source_file: :root, file_list: :current
+source_file 'foo.sv'    # FLGen will search the 'foo.sv' file from the root directories.
+file_list 'bar.list.rb' # FLGen will eaarch the 'bar.list.rb' file from the directory where this file list is.
+
+reset_default_search_path :source_file, :file_list
+source_file 'baz.sv'    # FLGen will search the 'baz.sv' file from the directory where this file list is.
+file_list 'qux.list.rb' # FLGen will eaarch the 'qux.list.rb' file from  the root directories.
+```
 
 #### Example
 
@@ -141,7 +173,7 @@ You can find an exmpale from [here](https://github.com/pezy-computing/flgen/tree
 ```
 $ flgen --output=filelist.f sample/foo.list.rb
 $ cat filelist.f
-//  flgen version 0.14.0
+//  flgen version 0.17.0
 //  applied arguments
 //    --output=filelist.f
 //    sample/foo.list.rb
@@ -149,6 +181,8 @@ $ cat filelist.f
 +define+BAR_1=1
 +incdir+/home/taichi/workspace/pezy/flgen/sample/bar
 +incdir+/home/taichi/workspace/pezy/flgen/sample/bar/baz
+-y /home/taichi/workspace/pezy/flgen/sample/bar/bar_lib
+-v /home/taichi/workspace/pezy/flgen/sample/foo_lib.sv
 -foo_0
 /home/taichi/workspace/pezy/flgen/sample/foo.sv
 /home/taichi/workspace/pezy/flgen/sample/bar/bar.sv

data/lib/flgen/arguments.rb

@@ -27,6 +27,15 @@ module FLGen
       attr_reader :value
     end
 
+    class LibraryFile < Base
+      def initialize(path)
+        super(:library_file, nil)
+        @path = path
+      end
+
+      attr_reader :path
+    end
+
     class Include < Base
       def initialize(path)
         super(:include, nil)
@@ -36,6 +45,15 @@ module FLGen
       attr_reader :path
     end
 
+    class LibraryDirectory < Base
+      def initialize(path)
+        super(:library_directory, nil)
+        @path = path
+      end
+
+      attr_reader :path
+    end
+
     class Generic < Base
       def initialize(argument, tool)
         super(:generic, tool)

data/lib/flgen/context.rb

@@ -12,14 +12,22 @@ module FLGen
       @source_files ||= []
     end
 
-    def add_source_file(root, path)
+    def add_source_file(path)
       return if runtime?
 
-      file = SourceFile.new(root, path)
+      file = SourceFile.new(path)
       add_source_file?(file) &&
         (source_files << file.remove_ext(@options[:rm_ext]))
     end
 
+    def add_library_file(path)
+      return if runtime?
+
+      file = SourceFile.new(path)
+      add_library_file?(file) &&
+        add_compile_argument(Arguments::LibraryFile.new(file))
+    end
+
     def define_macro(macro, value = nil)
       k, v =
         if value.nil? && macro.respond_to?(:split)
@@ -35,11 +43,17 @@ module FLGen
     end
 
     def add_include_directory(directory)
-      return if include_directory_already_added?(directory)
+      return if directory_already_added?(:include, directory)
 
       add_compile_argument(Arguments::Include.new(directory))
     end
 
+    def add_library_directory(directory)
+      return if directory_already_added?(:library_directory, directory)
+
+      add_compile_argument(Arguments::LibraryDirectory.new(directory))
+    end
+
     def add_compile_argument(argument)
       return if runtime?
 
@@ -67,7 +81,7 @@ module FLGen
     end
 
     def add_source_file?(file)
-      target_ext?(file) && !source_file_already_added?(file)
+      target_ext?(file) && source_files.none?(file)
     end
 
     def target_ext?(file)
@@ -77,16 +91,8 @@ module FLGen
       file.match_ext?(@options[:collect_ext])
     end
 
-    def source_file_already_added?(file)
-      return true if source_files.include?(file.path)
-      return true if checksums.include?(file.checksum)
-
-      checksums << file.checksum
-      false
-    end
-
-    def checksums
-      @checksums ||= []
+    def add_library_file?(file)
+      arguments.none? { |arg| arg.type == :library_file && arg.path == file }
     end
 
     def add_macro_definition(name, value)
@@ -96,9 +102,9 @@ module FLGen
       add_compile_argument(Arguments::Define.new(name, value))
     end
 
-    def include_directory_already_added?(path)
+    def directory_already_added?(type, path)
       arguments
-        .any? { |argument| argument.type == :include && argument.path == path }
+        .any? { |argument| argument.type == type && argument.path == path }
     end
 
     def add_argument(argument)

data/lib/flgen/file_list.rb

@@ -6,16 +6,30 @@ module FLGen
       @context = context
       @path = path
       @root_directories = extract_root
+      @default_search_path = {}
     end
 
-    def file_list(path, from: :root, base: nil, raise_error: true)
+    def default_search_path(**seach_paths)
+      @default_search_path.update(seach_paths)
+    end
+
+    def reset_default_search_path(*target_types)
+      target_types.each { |type| @default_search_path.delete(type) }
+    end
+
+    def file_list(path, from: nil, raise_error: true)
+      location = caller_location
+      load_file_list(path, from, location, raise_error)
+    end
+
+    def source_file(path, from: nil, raise_error: true)
       location = caller_location
-      load_file_list(path, from, base, location, raise_error)
+      add_file_entry(path, from, location, raise_error, :source_file)
     end
 
-    def source_file(path, from: :current, base: nil, raise_error: true)
+    def library_file(path, from: nil, raise_error: true)
       location = caller_location
-      add_source_file(path, from, base, location, raise_error)
+      add_file_entry(path, from, location, raise_error, :library_file)
     end
 
     def define_macro(macro, value = nil)
@@ -28,19 +42,24 @@ module FLGen
 
     alias_method :macro_defined?, :macro?
 
-    def include_directory(path, from: :current, base: nil, raise_error: true)
+    def include_directory(path, from: nil, raise_error: true)
+      location = caller_location
+      add_directory_entry(path, from, location, raise_error, :include_directory)
+    end
+
+    def library_directory(path, from: nil, raise_error: true)
       location = caller_location
-      add_include_directory(path, from, base, location, raise_error)
+      add_directory_entry(path, from, location, raise_error, :library_directory)
     end
 
-    def file?(path, from: :current, base: nil)
+    def file?(path, from: :current)
       location = caller_location
-      !lookup_root(path, from, base, location, :file?).nil?
+      !extract_file_path(path, from, location, :file).nil?
     end
 
-    def directory?(path, from: :current, base: nil)
+    def directory?(path, from: :current)
       location = caller_location
-      !lookup_root(path, from, base, location, :directory?).nil?
+      !extract_directory_path(path, from, location, :directory).nil?
     end
 
     def env?(name)
@@ -81,14 +100,14 @@ module FLGen
       File.exist?(path.join('.git').to_s)
     end
 
-    def load_file_list(path, from, base, location, raise_error)
-      unless (root = lookup_root(path, from, base, location, :file?))
+    def load_file_list(path, from, location, raise_error)
+      unless (list_path = extract_file_path(path, from, location, :file_list))
         raise_no_entry_error(path, location, raise_error)
         return
       end
 
       # Need to File.realpath to resolve symblic link
-      list_path = File.realpath(concat_path(root, path))
+      list_path = File.realpath(list_path)
       file_list_already_loaded?(list_path) && return
 
       @context.loaded_file_lists << list_path
@@ -100,45 +119,61 @@ module FLGen
       @context.loaded_file_lists.include?(path)
     end
 
-    def add_source_file(path, from, base, location, raise_error)
-      unless (root = lookup_root(path, from, base, location, :file?))
+    def add_file_entry(path, from, location, raise_error, type)
+      unless (file_path = extract_file_path(path, from, location, type))
         raise_no_entry_error(path, location, raise_error)
         return
       end
 
-      @context.add_source_file(root, path)
+      method = "add_#{type}".to_sym
+      @context.__send__(method, file_path)
     end
 
-    def add_include_directory(path, from, base, location, raise_error)
-      unless (root = lookup_root(path, from, base, location, :directory?))
+    def add_directory_entry(path, from, location, raise_error, type)
+      unless (directory_path = extract_directory_path(path, from, location, type))
         raise_no_entry_error(path, location, raise_error)
         return
       end
 
-      directory_path = concat_path(root, path)
-      @context.add_include_directory(directory_path)
+      method = "add_#{type}".to_sym
+      @context.__send__(method, directory_path)
     end
 
     def caller_location
       caller_locations(2, 1).first
     end
 
-    def lookup_root(path, from, base, location, checker)
-      search_root(path, from, base, location)
-        .find { |root| File.__send__(checker, concat_path(root, path)) }
+    def extract_file_path(path, from, location, type)
+      extract_path(path, from, location, type, :file?)
     end
 
-    def search_root(path, from, base, location)
+    def extract_directory_path(path, from, location, type)
+      extract_path(path, from, location, type, :directory?)
+    end
+
+    def extract_path(path, from, location, type, checker)
+      search_root(path, from, location, type)
+        .map { |root| File.expand_path(path, root) }
+        .find { |abs_path| File.__send__(checker, abs_path) && abs_path }
+    end
+
+    DEFAULT_SEARCH_PATH = {
+      file_list: :root, source_file: :current, library_file: :current, file: :current,
+      include_directory: :current, library_directory: :current, directory: :current
+    }.freeze
+
+    def search_root(path, from, location, type)
+      search_path = from || @default_search_path[type] || DEFAULT_SEARCH_PATH[type]
       if absolute_path?(path)
         ['']
-      elsif !base.nil?
-        [base]
-      elsif from == :current
+      elsif search_path == :current
         [current_directory(location)]
-      elsif from == :local_root
+      elsif search_path == :local_root
         [@root_directories.last]
-      else
+      elsif search_path == :root
         @root_directories
+      else
+        [search_path]
       end
     end
 
@@ -154,10 +189,6 @@ module FLGen
       File.dirname(path)
     end
 
-    def concat_path(root, path)
-      File.expand_path(path, root)
-    end
-
     def raise_no_entry_error(path, location, raise_error)
       return unless raise_error
 

data/lib/flgen/file_list_formatter.rb

@@ -18,6 +18,14 @@ module FLGen
       "+incdir+#{directory}"
     end
 
+    def format_libarary_directory(directory)
+      "-y #{directory}"
+    end
+
+    def format_libarary_file(file)
+      "-v #{file}"
+    end
+
     def fomrat_argument(argument)
       argument
     end

data/lib/flgen/file_list_xsim_formatter.rb

@@ -18,6 +18,14 @@ module FLGen
       "-i #{directory}"
     end
 
+    def format_libarary_directory(directory)
+      "-sourcelibdir #{directory}"
+    end
+
+    def format_libarary_file(file)
+      "-sourcelibfile #{file}"
+    end
+
     def fomrat_argument(argument)
       argument
     end

data/lib/flgen/formatter.rb

@@ -23,6 +23,8 @@ module FLGen
       print_header(io)
       print_macros(io)
       print_include_directoris(io)
+      print_library_direcotries(io)
+      print_library_files(io)
       print_arguments(io)
       print_source_files(io)
     end
@@ -33,31 +35,24 @@ module FLGen
       return unless print_header?
 
       header_lines.each do |line|
-        io.puts(format_header_line(line))
+        print_value(io, :format_header_line, line)
       end
     end
 
+    def format_header_line(_line)
+    end
+
     def print_header?
       @context.options[:output] &&
         @context.options[:print_header] && !@context.options[:source_file_only]
     end
 
-    def no_arguments?(type)
-      @context.arguments.none? { |argument| argument.type == type }
-    end
-
-    def each_argument(type, &block)
-      @context.arguments.each do |argument|
-        argument.type == type && block.call(argument)
-      end
-    end
-
     def print_macros(io)
       return if source_file_only? || no_arguments?(:define)
 
       pre_macros(io)
       each_argument(:define) do |argument|
-        io.puts(format_macro(argument.name, argument.value))
+        print_value(io, :format_macro, argument.name, argument.value)
       end
       post_macros(io)
     end
@@ -65,6 +60,9 @@ module FLGen
     def pre_macros(_io)
     end
 
+    def format_macro(_name, _value)
+    end
+
     def post_macros(_io)
     end
 
@@ -73,7 +71,7 @@ module FLGen
 
       pre_include_directories(io)
       each_argument(:include) do |argument|
-        io.puts(format_include_directory(argument.path))
+        print_value(io, :format_include_directory, argument.path)
       end
       post_include_directories(io)
     end
@@ -81,15 +79,56 @@ module FLGen
     def pre_include_directories(_io)
     end
 
+    def format_include_directory(_path)
+    end
+
     def post_include_directories(_io)
     end
 
+    def print_library_direcotries(io)
+      return if source_file_only? || no_arguments?(:library_directory)
+
+      pre_library_direcotries(io)
+      each_argument(:library_directory) do |argument|
+        print_value(io, :format_libarary_directory, argument.path)
+      end
+      post_library_direcotries(io)
+    end
+
+    def pre_library_direcotries(_io)
+    end
+
+    def format_libarary_directory(_path)
+    end
+
+    def post_library_direcotries(_io)
+    end
+
+    def print_library_files(io)
+      return if source_file_only? || no_arguments?(:library_file)
+
+      pre_library_files(io)
+      each_argument(:library_file) do |argument|
+        print_value(io, :format_libarary_file, argument.path)
+      end
+      post_library_files(io)
+    end
+
+    def pre_library_files(_io)
+    end
+
+    def format_libarary_file(_path)
+    end
+
+    def post_library_files(_io)
+    end
+
     def print_arguments(io)
       return if source_file_only? || no_arguments?(:generic)
 
       pre_arguments(io)
       each_argument(:generic) do |argument|
-        io.puts(fomrat_argument(argument.argument))
+        print_value(io, :fomrat_argument, argument.argument)
       end
       post_arguments(io)
     end
@@ -97,6 +136,9 @@ module FLGen
     def pre_arguments(io)
     end
 
+    def fomrat_argument(_argument)
+    end
+
     def post_arguments(io)
     end
 
@@ -109,7 +151,7 @@ module FLGen
 
       pre_source_files(io)
       @context.source_files.each do |file|
-        io.puts(format_file_path(file.path))
+        print_value(io, :format_file_path, file)
       end
       post_source_files(io)
     end
@@ -121,7 +163,25 @@ module FLGen
     def pre_source_files(_io)
     end
 
+    def format_file_path(_path)
+    end
+
     def post_source_files(_io)
     end
+
+    def print_value(io, fomrtatter, *args)
+      line = __send__(fomrtatter, *args)
+      line && io.puts(line)
+    end
+
+    def no_arguments?(type)
+      @context.arguments.none? { |argument| argument.type == type }
+    end
+
+    def each_argument(type, &block)
+      @context.arguments.each do |argument|
+        argument.type == type && block.call(argument)
+      end
+    end
   end
 end

data/lib/flgen/source_file.rb

@@ -2,11 +2,20 @@
 
 module FLGen
   class SourceFile
-    def initialize(root, path)
-      @path = File.join(root, path)
+    def initialize(path, checksum = nil)
+      @path = path
+      @checksum = checksum
     end
 
     attr_reader :path
+    alias_method :to_s, :path
+
+    def ==(other)
+      case other
+      when SourceFile then path == other.path || checksum == other.checksum
+      else path == other
+      end
+    end
 
     def match_ext?(ext_list)
       return false if ext_list.nil? || ext_list.empty?
@@ -18,8 +27,8 @@ module FLGen
     def remove_ext(ext_list)
       return self unless match_ext?(ext_list)
 
-      path = Pathname.new(@path).sub_ext('').to_s
-      self.class.new('', path)
+      path_no_ext = Pathname.new(path).sub_ext('').to_s
+      self.class.new(path_no_ext, checksum)
     end
 
     def checksum

data/lib/flgen/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FLGen
-  VERSION = '0.16.1'
+  VERSION = '0.18.0'
 end

data/lib/flgen/vivado_tcl_formatter.rb

@@ -34,9 +34,6 @@ module FLGen
       io.puts('set_property include_dirs $flgen_include_directories [current_fileset]')
     end
 
-    def fomrat_argument(_)
-    end
-
     def pre_source_files(io)
       io.puts('set flgen_source_files {}')
     end

data/sample/bar/bar.list.rb

@@ -2,5 +2,7 @@ define_macro :BAR_0
 define_macro :BAR_1, 1
 compile_argument '-bar_0', tool: :vcs
 runtime_argument '-bar_1', tool: :vcs
-source_file 'sample/bar/bar.sv', from: :root
-file_list   'baz/baz.list.rb', from: :current
+
+library_directory 'bar_lib'
+source_file       'sample/bar/bar.sv', from: :root
+file_list         'baz/baz.list.rb', from: :current

data/sample/foo.list.rb

@@ -1,5 +1,6 @@
 compile_argument '-foo_0'
 runtime_argument '-foo_1'
 include_directory 'bar'
-source_file 'foo.sv'
+source_file  'foo.sv'
+library_file 'foo_lib.sv'
 file_list   'sample/bar/bar.list.rb'

data/sample/foo_lib.sv

@@ -0,0 +1,2 @@
+module foo_lib;
+endmodule

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flgen
 version: !ruby/object:Gem::Version
-  version: 0.16.1
+  version: 0.18.0
 platform: ruby
 authors:
 - Taichi Ishitani
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-01-30 00:00:00.000000000 Z
+date: 2023-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bump
@@ -133,10 +133,12 @@ files:
 - lib/flgen/vivado_tcl_formatter.rb
 - sample/bar/bar.list.rb
 - sample/bar/bar.sv
+- sample/bar/bar_lib/.gitkeep
 - sample/bar/baz/baz.list.rb
 - sample/bar/baz/baz.sv
 - sample/foo.list.rb
 - sample/foo.sv
+- sample/foo_lib.sv
 homepage: https://github.com/pezy-computing/flgen
 licenses:
 - Apache-2.0
@@ -160,7 +162,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.5
+rubygems_version: 3.4.17
 signing_key: 
 specification_version: 4
 summary: Filelist generator