flgen 0.19.0 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93ba3a15351e9da39f2dfbbd23c54790140fe7134be768352aa2430533008194
-  data.tar.gz: 0e4cc12fae241384ec559682d965b68a63362ca0c934013c1312ac93eaec28cb
+  metadata.gz: fe67e7c60ca35355577e56501c46a5745fec3209091ae08adec482291480bfc2
+  data.tar.gz: b1b22bab5e3221f0b065d56cd280f6511430f7180954242e0adfc5e1d5199cb7
 SHA512:
-  metadata.gz: 01ffbee882b46664e9e77a63977abe0e5c1de2a7c75271a1ce6b0284ce7a0517d1785d8e14d95c524959aedfbc8482f6dba3174001311034fd88d863cb013cd3
-  data.tar.gz: 398adf788fa50f20d2cdda686b3364b8978a05884e554aecc19ae6c5beb908049a49e6de852b5d7ba41552e0c29310a9826c63c2e49fef2cd65899515133747f
+  metadata.gz: a736ba945d947a72ddeccf2c1f09f0f75ed27aa9ec79fc59c81518619bd004094a96dd6911185f861371abeb8c25abc3ebe3b7fae4a1695b40c221e08b47b6c3
+  data.tar.gz: b4666bb3afdd53adf29f6a8f6c63d02e660e9c0558b9a5681bf2e33196360eeead5ca6d54a863918915fb3facd4bc57999c6b89c9bdb87d7d3a787c18d5eb4a7

data/README.md

@@ -47,6 +47,8 @@ FLGen prives APIs listed below to describe your filelists.
     * Define a text macro.
 * `macro?(name)`/`macro_defined?(name)`
     * Return `true` if the given macro is defined.
+* `macro(name)`
+    * Return the value of the given macro.
 * `env?(name)`
     * Return `true` if the givne environment variable is defined.
 * `env(name)`

data/lib/flgen/context.rb

@@ -4,6 +4,7 @@ module FLGen
   class Context
     def initialize(options)
       @options = options
+      define_predefined_macros
     end
 
     attr_reader :options
@@ -35,11 +36,11 @@ module FLGen
         else
           [macro, value]
         end
-      add_macro_definition(k.to_sym, v)
+      add_macro_definition(k, v, false)
     end
 
     def macros
-      @macros ||= []
+      @macros ||= {}
     end
 
     def add_include_directory(directory)
@@ -95,8 +96,21 @@ module FLGen
       arguments.none? { |arg| arg.type == :library_file && arg.path == file }
     end
 
-    def add_macro_definition(name, value)
-      macros << name unless macros.include?(name)
+    def define_predefined_macros
+      return unless options[:tool]
+
+      list_name = File.join(__dir__, 'predefined_macros.yaml')
+      list = YAML.safe_load_file(list_name, filename: list_name, symbolize_names: true)
+      list[options[:tool]]&.each { |macro| add_macro_definition(macro, nil, true) }
+    end
+
+    def add_macro_definition(macro, value, predefined)
+      name = macro.to_sym
+      macros[name] = value || true
+      add_macro_argument(name, value) unless predefined
+    end
+
+    def add_macro_argument(name, value)
       arguments
         .delete_if { |argument| argument.type == :define && argument.name == name }
       add_compile_argument(Arguments::Define.new(name, value))

data/lib/flgen/file_list.rb

@@ -31,11 +31,12 @@ module FLGen
 
     def find_files(patterns, from: nil, &block)
       glob_files(patterns, from, __callee__, caller_location)
-        .then { |e| block ? e.each(&block) : e.to_a }
+        .then { |e| block_given? && (return e.each(&block)) || e.to_a }
     end
 
     def find_file(patterns, from: nil)
-      glob_files(patterns, from, __callee__, caller_location).first
+      glob_files(patterns, from, __callee__, caller_location)
+        .first&.then { |f| block_given? && (return yield f) || f }
     end
 
     def file?(path, from: :current)
@@ -49,11 +50,15 @@ module FLGen
     end
 
     def macro?(macro)
-      @context.macros.include?(macro.to_sym)
+      @context.macros.key?(macro.to_sym)
     end
 
     alias_method :macro_defined?, :macro?
 
+    def macro(name)
+      @context.macros[name.to_sym]
+    end
+
     def env?(name)
       ENV.key?(name.to_s)
     end
@@ -117,7 +122,7 @@ module FLGen
         return
       end
 
-      @context.__send__("add_#{method_name}".to_sym, extracted_path)
+      @context.__send__("add_#{method_name}", extracted_path)
     end
 
     def raise_no_entry_error(path, location, raise_error)

data/lib/flgen/predefined_macros.yaml

@@ -0,0 +1,12 @@
+vcs:
+  - VCS
+design_compiler:
+  - SYNTHESIS
+formality:
+  - SYNTHESIS
+xcelium:
+  - XCELIUM
+vivado:
+  - SYNTHESIS
+vivado_simulator:
+  - XILINX_SIMULATOR

data/lib/flgen/version.rb

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

data/lib/flgen.rb

@@ -3,6 +3,7 @@
 require 'digest/md5'
 require 'optparse'
 require 'pathname'
+require 'yaml'
 require_relative 'flgen/version'
 require_relative 'flgen/exceptions'
 require_relative 'flgen/source_file'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flgen
 version: !ruby/object:Gem::Version
-  version: 0.19.0
+  version: 0.21.0
 platform: ruby
 authors:
 - Taichi Ishitani
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-09-15 00:00:00.000000000 Z
+date: 2024-04-25 00:00:00.000000000 Z
 dependencies: []
 description: Filelist generator
 email:
@@ -30,6 +30,7 @@ files:
 - lib/flgen/file_list_formatter.rb
 - lib/flgen/file_list_xsim_formatter.rb
 - lib/flgen/formatter.rb
+- lib/flgen/predefined_macros.yaml
 - lib/flgen/source_file.rb
 - lib/flgen/version.rb
 - lib/flgen/vivado_tcl_formatter.rb
@@ -64,7 +65,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
+rubygems_version: 3.5.9
 signing_key: 
 specification_version: 4
 summary: Filelist generator