flgen 0.15.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bcca98956f35047f290608dcbbf1020017006475cc0d139c05ab070b19d47aa3
-  data.tar.gz: f1f2bb32ae9a4fd5c3466d6a375573fdc6b6944a8130e6c6be03d558f5ac4f58
+  metadata.gz: 73f400f84753663384d40487070b0cc511740b0084aa9e7ecfea84e845304fcf
+  data.tar.gz: '091045c56dc31bd9f11768c0c94a6451e0dd9872f052c5e199470fa9b5e4e2e7'
 SHA512:
-  metadata.gz: 3fea45a268196454d145a21af8c2ac56d62ae6a53aae99851d88dc1a8f3b78b74af4f44b461d60e73b71fcbce3cde24e1d39bf19eeddae1d8d8de81a21550580
-  data.tar.gz: d116c3598283c4e52501e544e8159270776caaff3486a5c8bba77e38de82c4f699ac0b0948e78bd9a2bdaef27a6dfa834594dec15ddb0ef6e629f13ea44ceec0
+  metadata.gz: '066887c84c2348296e9692a620e893f1b0e97087a48f50b4c938baf9e66da27f8206f9ab7012e6ceb4d7c790cc71abfd2d34c0a7b95c7c301e500942ca6f0b43'
+  data.tar.gz: 051a76f99641f3673b777ee7702200b1ea4c11b5512952bd72bbb81c8a54fe440f7ac5a7c11be1c2d4b1b36639c6fee54ee6618e9b92cca5d44bf8e28376b2df

data/README.md

@@ -10,7 +10,7 @@ FLGen provides a DSL to write filelists and generator tool to generate a filelis
 
 ### Ruby
 
-FLGen is written in [Ruby](https://www.ruby-lang.org) programing language and its required version is 3.0 or later. Before using FLGen, you need to install Ruby before using FLGen. See [this page](https://www.ruby-lang.org/en/downloads/) for further details.
+FLGen is written in [Ruby](https://www.ruby-lang.org) programing language and its required version is 3.0 or later. You need to install Ruby before using FLGen. See [this page](https://www.ruby-lang.org/en/documentation/installation/) for further details.
 
 ### Install FLGen
 
@@ -123,8 +123,9 @@ foo_project
     * The generated filelist contains source file pash which has the specified file extentions.
 * `--format=FORMAT`
     * Specify the format of the generated filelist.
-    * If no format is specified the generated filelist is for major EDA tools.
-    * If `filelist-xsim` is specified the generated filelist is for Vivado Simulator.
+    * If no format is specified FLGen will generate a generated filelist for major EDA tools.
+    * If `vivado-tcl` is specified FLGen will generate a TCL script to load source files for Vivado synthesis.
+    * If `filelist-xsim` is specified FLGen will generate a filelist for Vivado simulator.
 * `--output=FILE`
     * Specify the path of the generated filelist
     * The generated fileslist is output to STDOUT if no path is specified.

data/lib/flgen/formatter.rb

@@ -42,6 +42,10 @@ module FLGen
         @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)
@@ -49,7 +53,7 @@ module FLGen
     end
 
     def print_macros(io)
-      return if source_file_only?
+      return if source_file_only? || no_arguments?(:define)
 
       pre_macros(io)
       each_argument(:define) do |argument|
@@ -65,7 +69,7 @@ module FLGen
     end
 
     def print_include_directoris(io)
-      return if source_file_only?
+      return if source_file_only? || no_arguments?(:include)
 
       pre_include_directories(io)
       each_argument(:include) do |argument|
@@ -81,7 +85,7 @@ module FLGen
     end
 
     def print_arguments(io)
-      return if source_file_only?
+      return if source_file_only? || no_arguments?(:generic)
 
       pre_arguments(io)
       each_argument(:generic) do |argument|
@@ -101,6 +105,8 @@ module FLGen
     end
 
     def print_source_files(io)
+      return if no_source_files?
+
       pre_source_files(io)
       @context.source_files.each do |file|
         io.puts(format_file_path(file.full_path))
@@ -108,6 +114,10 @@ module FLGen
       post_source_files(io)
     end
 
+    def no_source_files?
+      @context.source_files.empty?
+    end
+
     def pre_source_files(_io)
     end
 

data/lib/flgen/version.rb

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

data/lib/flgen/vivado_tcl_formatter.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module FLGen
+  class VivadoTCLFormatter < Formatter
+    def format_header_line(line)
+      "#  #{line}"
+    end
+
+    def pre_macros(io)
+      io.puts('set flgen_defines {}')
+    end
+
+    def format_macro(macro, value)
+      if value.nil?
+        "lappend flgen_defines \"#{macro}\""
+      else
+        "lappend flgen_defines \"#{macro}=#{value}\""
+      end
+    end
+
+    def post_macros(io)
+      io.puts('set_property verilog_define $flgen_defines [current_fileset]')
+    end
+
+    def pre_include_directories(io)
+      io.puts('set flgen_include_directories {}')
+    end
+
+    def format_include_directory(directory)
+      "lappend flgen_include_directories \"#{directory}\""
+    end
+
+    def post_include_directories(io)
+      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
+
+    def format_file_path(path)
+      "lappend flgen_source_files \"#{path}\""
+    end
+
+    def post_source_files(io)
+      io.puts('add_files -fileset [current_fileset] $flgen_source_files')
+    end
+
+    Formatter.add_formatter(:'vivado-tcl', self)
+  end
+end

data/lib/flgen.rb

@@ -11,5 +11,6 @@ require_relative 'flgen/file_list'
 require_relative 'flgen/context'
 require_relative 'flgen/formatter'
 require_relative 'flgen/file_list_formatter'
+require_relative 'flgen/vivado_tcl_formatter'
 require_relative 'flgen/file_list_xsim_formatter'
 require_relative 'flgen/cli'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flgen
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.16.0
 platform: ruby
 authors:
 - Taichi Ishitani
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-01-04 00:00:00.000000000 Z
+date: 2023-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bump
@@ -130,6 +130,7 @@ files:
 - lib/flgen/formatter.rb
 - lib/flgen/source_file.rb
 - lib/flgen/version.rb
+- lib/flgen/vivado_tcl_formatter.rb
 - sample/bar/bar.list.rb
 - sample/bar/bar.sv
 - sample/bar/baz/baz.list.rb