flgen 0.18.0 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5660041e78d446e6127ef86bb45e93468f000750b2917df3e0b34de33ab4cfd0
-  data.tar.gz: f78fa09b2bac383f4f38270ad31ed7d67c98ea06e7709d2fd2aacd7a6b6d322d
+  metadata.gz: 17c6dc413fbc743f3014c128fc304fee0459fbe5ecc3fc9e7f9d12f0d26427d0
+  data.tar.gz: 262aec83a71a59ca34904e8be6f81787c5075ba5b9ac1726fb9668b3aa4832db
 SHA512:
-  metadata.gz: d3b76b55b57b5e52a316a9eed0c7051e6c1333536b9ead179f3b0616920a1bb1524af76f6d2a6e921553083cdb4d04e53f5f28742083312dbd0cadc88514ab45
-  data.tar.gz: 13a7d45bd399cc0bb57d52084599de7912f894844092d6054289b4c8a555ff7cb4ea07c6979206ee16548409afdb5ff3ae94a452426a79778abdb9cc1bda650a
+  metadata.gz: d5515a610870d4d9ff29db0cf01f09db1aa19beaa354c85894153e21732894d7f82a5d68ca959060aee97bf4791f6457a0ee61e06aaf4e69ed3a61fdf6051787
+  data.tar.gz: 5be5528a8aaa6d2ce79fa5fcf91adf9ed95977c5fedbb5a4c70a97164a2647862aa6231d0888dab7c5166495275c2f161bbfbad473b07ea00ad97f29b099e13d

data/README.md

@@ -34,14 +34,19 @@ FLGen prives APIs listed below to describe your filelists.
     * 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.
+* `find_files(patterns, from: nil)`
+    * Return an array of filenames matching the given patterns strings.
+    * See [here](https://docs.ruby-lang.org/en/3.2/Dir.html#method-c-glob) for the format of a pattern string.
+* `find_file(patterns, from: nil)`
+    * Return the first filename matching the given pattern strings.
+* `file?(path, from: :current)`
+    * Return `true` if the given file exists.
+* `directory?(path, from: :current)`
+    * Return `true` if the given directory exists.
 * `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)`
-    * Return `treu` if the given file exists.
-* `directory?(path, from: :current)`
-    * Return `true` if the given directory exists.
 * `env?(name)`
     * Return `true` if the givne environment variable is defined.
 * `env(name)`
@@ -54,7 +59,7 @@ 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)`
+* `default_search_path(**search_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.
@@ -74,7 +79,9 @@ end
 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.
+    * Search the given file or directory from the directory path specified by the `from` argument.
+* `:cwd`
+    * Search the given file or directory from the current working directory.
 * `:current`
     * Search the given file or directory from the directory where the current filelist is.
 * `:root`
@@ -86,22 +93,22 @@ The `from` argument is to specify how to search the given file or directory. You
 
 Default behaviors when the `from` argument is not spcified are listed below:
 
-* `source_file`
-    * `:current`
-* `file_list`
-    * `:root`
-* `library_file`
-    * `:current`
-* `include_directory`
-    * `:current`
-* `library_directory`
-    * `:current`
+
+| API name          | Default `from` argument |
+|:------------------|:------------------------|
+| source_file       | :current                |
+| file_list         | :root                   |
+| library_file      | :current                |
+| include_directory | :current                |
+| library_directory | :current                |
+| find_files        | :current                |
+| find_file         | :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
+default_search_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.
 

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,7 +36,7 @@ module FLGen
         else
           [macro, value]
         end
-      add_macro_definition(k.to_sym, v)
+      add_macro_definition(k, v, false)
     end
 
     def macros
@@ -95,8 +96,21 @@ module FLGen
       arguments.none? { |arg| arg.type == :library_file && arg.path == file }
     end
 
-    def add_macro_definition(name, value)
+    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 unless macros.include?(name)
+      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

@@ -6,11 +6,11 @@ module FLGen
       @context = context
       @path = path
       @root_directories = extract_root
-      @default_search_path = {}
+      @default_search_path = init_default_search_path
     end
 
-    def default_search_path(**seach_paths)
-      @default_search_path.update(seach_paths)
+    def default_search_path(**search_paths)
+      @default_search_path.update(search_paths)
     end
 
     def reset_default_search_path(*target_types)
@@ -18,50 +18,43 @@ module FLGen
     end
 
     def file_list(path, from: nil, raise_error: true)
-      location = caller_location
-      load_file_list(path, from, location, raise_error)
+      load_file_list(path, from, raise_error, caller_location)
     end
 
     def source_file(path, from: nil, raise_error: true)
-      location = caller_location
-      add_file_entry(path, from, location, raise_error, :source_file)
+      add_entry(path, from, raise_error, __callee__, caller_location)
     end
 
-    def library_file(path, from: nil, raise_error: true)
-      location = caller_location
-      add_file_entry(path, from, location, raise_error, :library_file)
-    end
+    define_method(:library_file, instance_method(:source_file))
+    define_method(:include_directory, instance_method(:source_file))
+    define_method(:library_directory, instance_method(:source_file))
 
-    def define_macro(macro, value = nil)
-      @context.define_macro(macro, value)
+    def find_files(patterns, from: nil, &block)
+      glob_files(patterns, from, __callee__, caller_location)
+        .then { |e| block_given? && (return e.each(&block)) || e.to_a }
     end
 
-    def macro?(macro)
-      @context.macros.include?(macro.to_sym)
+    def find_file(patterns, from: nil)
+      glob_files(patterns, from, __callee__, caller_location)
+        .first&.then { |f| block_given? && (return yield f) || f }
     end
 
-    alias_method :macro_defined?, :macro?
-
-    def include_directory(path, from: nil, raise_error: true)
-      location = caller_location
-      add_directory_entry(path, from, location, raise_error, :include_directory)
+    def file?(path, from: :current)
+      !extract_path(path, from, __callee__, caller_location).nil?
     end
 
-    def library_directory(path, from: nil, raise_error: true)
-      location = caller_location
-      add_directory_entry(path, from, location, raise_error, :library_directory)
-    end
+    define_method(:directory?, instance_method(:file?))
 
-    def file?(path, from: :current)
-      location = caller_location
-      !extract_file_path(path, from, location, :file).nil?
+    def define_macro(macro, value = nil)
+      @context.define_macro(macro, value)
     end
 
-    def directory?(path, from: :current)
-      location = caller_location
-      !extract_directory_path(path, from, location, :directory).nil?
+    def macro?(macro)
+      @context.macros.include?(macro.to_sym)
     end
 
+    alias_method :macro_defined?, :macro?
+
     def env?(name)
       ENV.key?(name.to_s)
     end
@@ -89,25 +82,25 @@ module FLGen
       return nil if @path.empty?
 
       Pathname
-        .new(@path)
-        .dirname
-        .descend
-        .select(&method(:repository_root?))
-        .map(&:to_s)
+        .new(@path).dirname.descend.select(&method(:repository_root?)).map(&:to_s)
     end
 
     def repository_root?(path)
       File.exist?(path.join('.git').to_s)
     end
 
-    def load_file_list(path, from, location, raise_error)
-      unless (list_path = extract_file_path(path, from, location, :file_list))
+    def init_default_search_path
+      Hash.new { |_, key| key == :file_list ? :root : :current }
+    end
+
+    def load_file_list(path, from, raise_error, location)
+      unless (extracted_path = extract_path(path, from, :file_list, location))
         raise_no_entry_error(path, location, raise_error)
         return
       end
 
       # Need to File.realpath to resolve symblic link
-      list_path = File.realpath(list_path)
+      list_path = File.realpath(extracted_path)
       file_list_already_loaded?(list_path) && return
 
       @context.loaded_file_lists << list_path
@@ -119,59 +112,50 @@ module FLGen
       @context.loaded_file_lists.include?(path)
     end
 
-    def add_file_entry(path, from, location, raise_error, type)
-      unless (file_path = extract_file_path(path, from, location, type))
+    def add_entry(path, from, raise_error, method_name, location)
+      unless (extracted_path = extract_path(path, from, method_name, location))
         raise_no_entry_error(path, location, raise_error)
         return
       end
 
-      method = "add_#{type}".to_sym
-      @context.__send__(method, file_path)
+      @context.__send__("add_#{method_name}", extracted_path)
     end
 
-    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
+    def raise_no_entry_error(path, location, raise_error)
+      return unless raise_error
 
-      method = "add_#{type}".to_sym
-      @context.__send__(method, directory_path)
+      raise NoEntryError.new(path, location)
     end
 
-    def caller_location
-      caller_locations(2, 1).first
+    def glob_files(patterns, from, method_name, location)
+      search_root('', from, method_name, location)
+        .lazy.flat_map { |base| do_glob_files(patterns, base) }
     end
 
-    def extract_file_path(path, from, location, type)
-      extract_path(path, from, location, type, :file?)
+    def do_glob_files(patterns, base)
+      Dir.glob(Array(patterns), base: base)
+        .map { |path| File.join(base, path) }
+        .select(&File.method(:file?))
     end
 
-    def extract_directory_path(path, from, location, type)
-      extract_path(path, from, location, type, :directory?)
+    def caller_location
+      caller_locations(2, 1).first
     end
 
-    def extract_path(path, from, location, type, checker)
-      search_root(path, from, location, type)
+    def extract_path(path, from, method_name, location)
+      search_root(path, from, method_name, location)
         .map { |root| File.expand_path(path, root) }
-        .find { |abs_path| File.__send__(checker, abs_path) && abs_path }
+        .find { |abs_path| exist_path?(abs_path, method_name) }
     end
 
-    DEFAULT_SEARCH_PATH = {
-      file_list: :root, source_file: :current, library_file: :current, file: :current,
-      include_directory: :current, library_directory: :current, directory: :current
-    }.freeze
+    FROM_KEYWORDS = [:cwd, :current, :local_root, :root].freeze
 
-    def search_root(path, from, location, type)
-      search_path = from || @default_search_path[type] || DEFAULT_SEARCH_PATH[type]
+    def search_root(path, from, method_name, location)
+      search_path = from || @default_search_path[method_name]
       if absolute_path?(path)
         ['']
-      elsif search_path == :current
-        [current_directory(location)]
-      elsif search_path == :local_root
-        [@root_directories.last]
-      elsif search_path == :root
-        @root_directories
+      elsif FROM_KEYWORDS.include?(search_path)
+        search_root_specified_by_keyword(search_path, location)
       else
         [search_path]
       end
@@ -181,6 +165,15 @@ module FLGen
       Pathname.new(path).absolute?
     end
 
+    def search_root_specified_by_keyword(from_keyword, location)
+      case from_keyword
+      when :cwd then [Dir.pwd]
+      when :current then [current_directory(location)]
+      when :local_root then [@root_directories.last]
+      else @root_directories
+      end
+    end
+
     def current_directory(location)
       # From Ruby 3.1 Thread::Backtrace::Location#absolute_path returns nil
       # for code string evaluated by eval methods
@@ -189,10 +182,15 @@ module FLGen
       File.dirname(path)
     end
 
-    def raise_no_entry_error(path, location, raise_error)
-      return unless raise_error
+    METHODS_TARGETING_DIRECTORY =
+      [:include_directory, :library_directory, :directory?].freeze
 
-      raise NoEntryError.new(path, location)
+    def exist_path?(path, method_name)
+      if METHODS_TARGETING_DIRECTORY.include?(method_name)
+        File.directory?(path)
+      else
+        File.file?(path)
+      end
     end
   end
 end

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.18.0'
+  VERSION = '0.20.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,113 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: flgen
 version: !ruby/object:Gem::Version
-  version: 0.18.0
+  version: 0.20.0
 platform: ruby
 authors:
 - Taichi Ishitani
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-07-31 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: bump
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.10.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.10.0
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.12.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.12.0
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.40.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.40.0
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.21.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.21.0
-- !ruby/object:Gem::Dependency
-  name: simplecov-cobertura
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.1.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.1.0
+date: 2024-02-20 00:00:00.000000000 Z
+dependencies: []
 description: Filelist generator
 email:
 - ishitani@pezy.co.jp
@@ -128,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
@@ -162,7 +65,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.17
+rubygems_version: 3.5.3
 signing_key: 
 specification_version: 4
 summary: Filelist generator