flgen 0.16.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73f400f84753663384d40487070b0cc511740b0084aa9e7ecfea84e845304fcf
-  data.tar.gz: '091045c56dc31bd9f11768c0c94a6451e0dd9872f052c5e199470fa9b5e4e2e7'
+  metadata.gz: 6bf48956c855b1e0bef4cb503f0d587991d16ba1ff4f36c1aa3990ba7a343263
+  data.tar.gz: ce22e515604e2790ce7ecba9d04eedfc16212ebfa5d7e20cf43a4ba233abf16c
 SHA512:
-  metadata.gz: '066887c84c2348296e9692a620e893f1b0e97087a48f50b4c938baf9e66da27f8206f9ab7012e6ceb4d7c790cc71abfd2d34c0a7b95c7c301e500942ca6f0b43'
-  data.tar.gz: 051a76f99641f3673b777ee7702200b1ea4c11b5512952bd72bbb81c8a54fe440f7ac5a7c11be1c2d4b1b36639c6fee54ee6618e9b92cca5d44bf8e28376b2df
+  metadata.gz: 14eb5efde8db89f0c3bab5c380d482dd22d61172a2ad93e3654cd5edf46983dda17b4c0e164f42a1bb40dff785af9a9e21ef73c012d873d35f056be085949e3e
+  data.tar.gz: bd522a28b24a175bc4f440af52fb548f6e01dddaa81b12e7ef3fa82f0d11b21956f7ade28a9bf3684e84e55b084b98868383c6f710d187bb27fd5e3b16de2337

data/README.md

@@ -28,8 +28,12 @@ FLGen prives APIs listed below to describe your filelists.
     * Add the given source file to the current filelist.
 * `file_list(path, from: :root, base: nil)`
     * Load the given filelist.
+* `library_file(path, from: :current, base: nil)`
+    * Add the given file to the list of library files.
 * `include_directory(path, from: :current, base: nil)`
     * Add the given directory to the list of include direcotries.
+* `library_directory(path, from: :current, base: 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)`
@@ -141,7 +145,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 +153,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

@@ -20,6 +20,14 @@ module FLGen
         (source_files << file.remove_ext(@options[:rm_ext]))
     end
 
+    def add_library_file(root, path)
+      return if runtime?
+
+      file = SourceFile.new(root, 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,18 +91,8 @@ module FLGen
       file.match_ext?(@options[:collect_ext])
     end
 
-    def source_file_already_added?(file)
-      checksum = file.checksum
-      path = file.path
-
-      return true if checksums[path].include?(checksum)
-
-      checksums[path] << checksum
-      false
-    end
-
-    def checksums
-      @checksums ||= Hash.new { |h, k| h[k] = [] }
+    def add_library_file?(file)
+      arguments.none? { |arg| arg.type == :library_file && arg.path == file }
     end
 
     def add_macro_definition(name, value)
@@ -98,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

@@ -15,7 +15,12 @@ module FLGen
 
     def source_file(path, from: :current, base: nil, raise_error: true)
       location = caller_location
-      add_source_file(path, from, base, location, raise_error)
+      add_file_entry(path, from, base, location, raise_error, :add_source_file)
+    end
+
+    def library_file(path, from: :current, base: nil, raise_error: true)
+      location = caller_location
+      add_file_entry(path, from, base, location, raise_error, :add_library_file)
     end
 
     def define_macro(macro, value = nil)
@@ -30,7 +35,12 @@ module FLGen
 
     def include_directory(path, from: :current, base: nil, raise_error: true)
       location = caller_location
-      add_include_directory(path, from, base, location, raise_error)
+      add_directory_entry(path, from, base, location, raise_error, :add_include_directory)
+    end
+
+    def library_directory(path, from: :current, base: nil, raise_error: true)
+      location = caller_location
+      add_directory_entry(path, from, base, location, raise_error, :add_library_directory)
     end
 
     def file?(path, from: :current, base: nil)
@@ -100,25 +110,29 @@ module FLGen
       @context.loaded_file_lists.include?(path)
     end
 
-    def add_source_file(path, from, base, location, raise_error)
+    # rubocop:disable Metrics/ParameterLists
+
+    def add_file_entry(path, from, base, location, raise_error, method)
       unless (root = lookup_root(path, from, base, location, :file?))
         raise_no_entry_error(path, location, raise_error)
         return
       end
 
-      @context.add_source_file(root, path)
+      @context.__send__(method, root, path)
     end
 
-    def add_include_directory(path, from, base, location, raise_error)
+    def add_directory_entry(path, from, base, location, raise_error, method)
       unless (root = lookup_root(path, from, base, location, :directory?))
         raise_no_entry_error(path, location, raise_error)
         return
       end
 
       directory_path = concat_path(root, path)
-      @context.add_include_directory(directory_path)
+      @context.__send__(method, directory_path)
     end
 
+    # rubocop:enable Metrics/ParameterLists
+
     def caller_location
       caller_locations(2, 1).first
     end

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.full_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,36 +2,37 @@
 
 module FLGen
   class SourceFile
-    def initialize(root, path)
-      @root = root
-      @path = path
+    def initialize(root, path, checksum = nil)
+      @path = File.join(root, path)
+      @checksum = checksum
     end
 
-    attr_reader :root
     attr_reader :path
+    alias_method :to_s, :path
 
-    def full_path
-      File.join(@root, @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?
 
-      file_ext = File.extname(@path)
-      ext_list.any? do |ext|
-        (ext[0] == '.' && ext || ".#{ext}") == file_ext
-      end
+      file_ext = File.extname(@path)[1..]
+      ext_list.any? { |ext| (ext[0] == '.' && ext[1..] || ext) == file_ext }
     end
 
     def remove_ext(ext_list)
       return self unless match_ext?(ext_list)
 
       path = Pathname.new(@path).sub_ext('').to_s
-      self.class.new(@root, path)
+      self.class.new('', path, checksum)
     end
 
     def checksum
-      @checksum ||= Digest::MD5.digest(File.read(full_path))
+      @checksum ||= Digest::MD5.digest(File.read(@path))
     end
   end
 end

data/lib/flgen/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FLGen
-  VERSION = '0.16.0'
+  VERSION = '0.17.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.0
+  version: 0.17.0
 platform: ruby
 authors:
 - Taichi Ishitani
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-01-30 00:00:00.000000000 Z
+date: 2023-02-13 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.2
+rubygems_version: 3.4.5
 signing_key: 
 specification_version: 4
 summary: Filelist generator