autoc 2.0.0 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a598879205b51d5bf574b70b370ef805efe3681e0ea4ad8b6347e45296cc304b
-  data.tar.gz: d5c3290746c096a666627ff544903afe2b1f31e61b7706cf5a5e531c410191ea
+  metadata.gz: e1800467846d30e1b98d5f124f250ef87f9adf1aab5f319f7593dcd8a6d4e8ea
+  data.tar.gz: de7e6b5457c9bf747df18b86b5c06d05b065c11d13649709f2f02b7eb4eedb11
 SHA512:
-  metadata.gz: cb81338f80898d88975a0bc204b5245c6fe4e0deb931c91ff007bff5dca026f4f99fe5702d56033fa0387786cb20b03445dbb662c07ebcf7f8ba81f993848520
-  data.tar.gz: da094ff14cf393a2c7178fb45083d18b3513d686e29a693895dd4cea51bbcf406776fe26de0d550605102f7f5976170a3715fedc1d9520e1f4c1944c034b56d1
+  metadata.gz: 476a8dac04a57b7e313232b904f73297a4e5d76a0919423535f356c29fa4b48690941d04f75f79a623bac23076c2ec56f4d2f20d0d72ecfbb24ad24eb9f3b06c
+  data.tar.gz: e449fbe1e182aa541bc7bc861e4f653c5b7b23b0eb7f99dfbb769e7c44e6ef210df0e4ad8e1c2799ed99121ed0b71411c280a28ae8183a7a369fa60908132a9a

data/CHANGES.md

@@ -1,3 +1,19 @@
+# 2.0.2
+
+- Introduce private visibility specifier for functions.
+
+- Fix missing constraint checks in custom constructors.
+
+- Documentation tags streamlining.
+
+# 2.0.1
+
+- Introduce switch for incremental module generation mode.
+
+- Fix Record setter function type mismatch bug.
+
+- Fix project structure conformance issue in CMake project scaffolder.
+
 # 2.0.0
 
-A complete package overhaul.
+- A complete package overhaul.

data/lib/autoc/composite.rb

@@ -18,7 +18,7 @@ module AutoC
   # @abstract
   class Composite < Type
 
-    PRIVATE = '/** @private */'
+    PRIVATE = "\n/** @private */\n"
 
     include STD
 
@@ -67,6 +67,10 @@ module AutoC
 
     def public? = @visibility == :public
 
+    def private? = @visibility == :private
+
+    def internal? = @visibility == :internal
+
     def respond_to_missing?(meth, include_private = false) = @methods.has_key?(meth) ? true : super
 
     def type_tag = signature
@@ -95,40 +99,41 @@ module AutoC
 
     self.hasher = Hasher.instance # Default cycle-xor hasher
 
-    # Pluggable CamelCase identifier decorator
-    CAMEL_CASE_DECORATOR = -> (type, symbol, abbreviate: false, **kws) {
-      id = symbol.to_s.sub(/[!?]$/, '') # Strip trailing !?
-      _ = # Check for leading underscore
-        if /^(_+)(.*)/ =~ id
-          id = Regexp.last_match(2) # Chop leading underscore
-          true
-        else
-          false
-        end
-      id = id[0] if abbreviate
-      # Convert _separated_names to the CamelCase
-      id = type.prefix + id.split('_').collect{ |s| s[0].upcase << s[1..-1] }.join
-      # Carry over the method name's leading underscore only if the prefix is not in turn underscored
-      _ && !type.prefix.start_with?('_') ? Regexp.last_match(1) + id : id
-    }
-
-    # Pluggable _snake_case identifier decorator
-    SNAKE_CASE_DECORATOR = -> (type, symbol, abbreviate: false, **kws) {
-      id = symbol.to_s.sub(/[!?]$/, '') # Strip trailing !?
-      # Check for leading underscore
-      _ =
-        if /^(_+)(.*)/ =~ id
-          id = Regexp.last_match(2)
-          true
-        else
-          false
-        end
-      id = abbreviate ? "#{type.prefix}#{id[0]}" : "#{type.prefix}_#{id}"
-      # Carry over the method name's leading underscore only if the prefix is not in turn underscored
-      _ && !type.prefix.start_with?('_') ? Regexp.last_match(1) + id : id
-    }
-
-    self.decorator = CAMEL_CASE_DECORATOR
+    module Decorator
+      # Pluggable CamelCase identifier decorator
+      CAMEL_CASE = -> (type, symbol, abbreviate: false, **kws) {
+        id = symbol.to_s.sub(/[!?]$/, '') # Strip trailing !?
+        _ = # Check for leading underscore
+          if /^(_+)(.*)/ =~ id
+            id = Regexp.last_match(2) # Chop leading underscore
+            true
+          else
+            false
+          end
+        id = id[0] if abbreviate
+        # Convert _separated_names to the CamelCase
+        id = type.prefix + id.split('_').collect{ |s| s[0].upcase << s[1..-1] }.join
+        # Carry over the method name's leading underscore only if the prefix is not in turn underscored
+        _ && !type.prefix.start_with?('_') ? Regexp.last_match(1) + id : id
+      }
+      # Pluggable _snake_case identifier decorator
+      SNAKE_CASE = -> (type, symbol, abbreviate: false, **kws) {
+        id = symbol.to_s.sub(/[!?]$/, '') # Strip trailing !?
+        # Check for leading underscore
+        _ =
+          if /^(_+)(.*)/ =~ id
+            id = Regexp.last_match(2)
+            true
+          else
+            false
+          end
+        id = abbreviate ? "#{type.prefix}#{id[0]}" : "#{type.prefix}_#{id}"
+        # Carry over the method name's leading underscore only if the prefix is not in turn underscored
+        _ && !type.prefix.start_with?('_') ? Regexp.last_match(1) + id : id
+      }
+    end # Decorator
+
+    self.decorator = Decorator::CAMEL_CASE
 
   private
     
@@ -148,6 +153,8 @@ module AutoC
 
     # Create a new type-bound function (aka method)
     def method(result, name, parameters, inline: false, visibility: nil, constraint: true, instance: name, **kws)
+      name = name.to_sym
+      instance = instance.to_sym
       method = method_class.new(
         self,
         result,
@@ -292,6 +299,8 @@ module AutoC
             #{@header}
           */
         }
+      else
+        stream << Composite::PRIVATE
       end
     end
 

data/lib/autoc/cstring.rb

@@ -76,7 +76,7 @@ module AutoC
 
     def configure
       super
-      method(:void, :create, { target: lvalue, source: const_rvalue }, instance: :custom_create).configure do
+      method(:void, :create, { target: lvalue, source: const_rvalue }, instance: :custom_create, constraint:-> { custom_constructible? }).configure do
         header %{
           @brief Create string
 

data/lib/autoc/function.rb

@@ -4,6 +4,7 @@
 require 'autoc/type'
 require 'autoc/module'
 require 'autoc/primitive'
+require 'autoc/composite'
 
 
 module AutoC
@@ -134,15 +135,19 @@ module AutoC
   
     def public? = @visibility == :public
 
+    def private? = @visibility == :private
+
+    def internal? = @visibility == :internal
+    
     def abstract? = @abstract == true
   
     def variadic? = @variadic == true
 
     def live? = (@constraint.is_a?(Proc) ? @constraint.() : @constraint) == true
     
-    def signature = '%s(%s)' % [result.signature, (parameters.to_a.collect(&:signature) << (variadic? ? '...' : nil)).compact.join(',')]
+    def signature = '%s(%s)' % [result, (parameters.to_a.collect(&:signature) << (variadic? ? '...' : nil)).compact.join(',')]
   
-    def prototype = '%s %s(%s)' % [result.signature, name, (parameters.to_a.collect(&:declaration) << (variadic? ? '...' : nil)).compact.join(',')]
+    def prototype = '%s %s(%s)' % [result, name, (parameters.to_a.collect(&:declaration) << (variadic? ? '...' : nil)).compact.join(',')]
   
     def definition = '%s {%s}' % [prototype, @code]
   
@@ -183,16 +188,20 @@ module AutoC
 
     # Render the commentary block preceding the function declaration, both inline or external
     def render_function_header(stream)
-      stream << %{
-        /* #{@header} */
-      } unless @header.nil?
+      if public?
+        stream << %{
+          /* #{@header} */
+        } unless @header.nil?
+      else
+        stream << Composite::PRIVATE
+      end
     end
 
     # Render full function declaration statement including the commentary block
     # For inline functions this also renders a function body effectively making this also a function definition
     # The declaration comes into either public interface of forward declaration block depending on the function's visibility status
     def render_function_declaration(stream)
-      render_function_header(stream)
+      render_function_header(stream) if @render_interface
       render_declaration_specifier(stream)
       if inline?
         render_function_definition(stream)
@@ -211,18 +220,22 @@ module AutoC
     end
 
     # Render function's public interface
-    # Only public functions are rendered
+    # Render non-internal function declarations
+    # @render_interface is used internally to distinguish header-time rendering from source-time rendering
     def render_interface(stream)
-      render_function_declaration(stream) if live? && public?
+      @render_interface = true
+      render_function_declaration(stream) if live? && (public? || private?)
     end
 
     # Render function's interface for non-public functions which should not appear in the public interface
     def render_forward_declarations(stream)
-      render_function_declaration(stream) if live? && !public?
+      @render_interface = false
+      render_function_declaration(stream) if live? && !(public? || private?)
     end
 
     # Render non-inline function definition regardless of function's visibility status
     def render_implementation(stream)
+      @render_interface = false
       render_function_definition(stream) if live? && !inline?
     end
 

data/lib/autoc/hash_map.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 
+require 'autoc/std'
 require 'autoc/record'
 require 'autoc/hash_set'
 require 'autoc/association'

data/lib/autoc/hash_set.rb

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
 
 
-require 'autoc/vector'
-require 'autoc/list'
+require 'autoc/std'
 require 'autoc/set'
+require 'autoc/list'
+require 'autoc/vector'
 
 
 module AutoC

data/lib/autoc/hashers.rb

@@ -55,7 +55,7 @@ module AutoC
           #if defined(__cplusplus)
             extern "C" void _autoc_hasher_randomize_seed(void);
           #elif defined(__GNUC__) || defined(__clang__)
-            void _autoc_hasher_randomize_seed(void)  __attribute__((__constructor__));
+            void _autoc_hasher_randomize_seed(void) __attribute__((__constructor__));
           #elif defined(__POCC__)
             #pragma startup _autoc_hasher_randomize_seed
           #elif defined(_MSC_VER) || defined(__POCC__)

data/lib/autoc/list.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 
+require 'autoc/std'
 require 'autoc/ranges'
 require 'autoc/sequential'
 require 'autoc/collection'

data/lib/autoc/module.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 
-require 'set'
 require 'digest'
 
 require 'autoc'
@@ -51,7 +50,12 @@ module AutoC
 
     attr_accessor :source_threshold
 
-    def initialize(name) = @name = name
+    def stateful? = @stateful == true
+
+    def initialize(name, stateful: true)
+      @name = name
+      @stateful = stateful
+    end
 
     def header = @header ||= Header.new(self)
 
@@ -63,7 +67,7 @@ module AutoC
       distribute_entities
       header.render
       sources.each(&:render)
-      State.new(self).collect.write
+      State.new(self).collect.write if stateful?
       self
     end
 
@@ -86,8 +90,8 @@ module AutoC
       end
     end
 
-    def self.render(name, &code)
-      m = self.new(name)
+    def self.render(name, **, &code)
+      m = self.new(name, **)
       yield(m) if block_given?
       m.render
     end
@@ -114,7 +118,7 @@ module AutoC
     end
 
     def read
-      if File.exist?(file_name)
+      if self.module.stateful? && File.exist?(file_name)
         # It's OK not to have this file but if it exists it must have proper contents
         io = File.open(file_name, 'rt', chomp: true)
         begin

data/lib/autoc/ranges.rb

@@ -25,7 +25,7 @@ module AutoC
     def to_value = @v ||= Value.new(self)
 
     def initialize(iterable, visibility:)
-      super(iterable.identifier(:range, abbreviate: visibility == :internal), visibility:)
+      super(iterable.identifier(:range, abbreviate: internal?), visibility:)
       dependencies << (@iterable = iterable) << INFO
     end
 
@@ -62,7 +62,7 @@ module AutoC
 
     def configure
       super
-      method(:void, :create, { range: lvalue, iterable: iterable.const_rvalue }, instance: :custom_create).configure do
+      method(:void, :create, { range: lvalue, iterable: iterable.const_rvalue }, instance: :custom_create, constraint:-> { custom_constructible? }).configure do
         header %{
           @brief Create a new range for the specified iterable
 
@@ -440,8 +440,6 @@ module AutoC
             */
           }
         end
-      else
-        stream << PRIVATE
       end
       if public?
         stream << %{

data/lib/autoc/record.rb

@@ -131,7 +131,7 @@ module AutoC
           args[formal] = value
           docs << "@param[in] #{formal} `#{name}` field initializer of type @ref #{type}"
         end
-        method(:void, :create_set, args, instance: :custom_create).configure do
+        method(:void, :create_set, args, instance: :custom_create, constraint:-> { custom_constructible? }).configure do
           _code = 'assert(target);'
           params.each do |field, parameter|
             _code += parameter.value.type.copy.("target->#{field}", parameter) + ';'
@@ -217,17 +217,17 @@ module AutoC
               @since 2.0
             }
             end
-            method(:void, "set_#{name}",  { target: rvalue, name.to_sym => type.const_rvalue } ).configure do
+            method(:void, "set_#{name}",  { target: rvalue, value: type.const_rvalue } ).configure do
               code %{
                 assert(target);
                 #{type.destroy.("target->#{name}") if type.destructible?};
-                #{type.copy.("target->#{name}", name)};
+                #{type.copy.("target->#{name}", value)};
               }
             header %{
               @brief Set value of field #{name}
 
               @param[in] target record to modify
-              @param[in] #{name} value to initalize field #{name} with
+              @param[in] value value to initalize field #{name} with
 
               This function sets the field #{name} to contain a copy of specified value.
 
@@ -239,7 +239,7 @@ module AutoC
           end
         end
       end
-  end
+    end
 
   end # Record
 

data/lib/autoc/scaffold/1test_composite_value_vector.rb

@@ -0,0 +1,17 @@
+require 'autoc/vector'
+
+require_relative 'composite_value'
+
+type_test(AutoC::Vector, :CompositeValueVector, CompositeValue.new(:CompositeValue)) do
+
+  ###
+
+  setup %{
+    #{self} t;
+  }
+
+  cleanup %{
+    #{destroy}(&t);
+  }
+
+end

data/lib/autoc/scaffold/composite_value.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+
+require 'autoc/std'
+require 'autoc/module'
+require 'autoc/primitive'
+
+
+class CompositeValue < AutoC::STD::Primitive
+  
+  def orderable? = false
+
+  def render_interface(stream)
+    stream << %{
+      typedef struct {
+        int a;
+        char b;
+      } #{self};
+    }
+  end
+end

data/lib/autoc/scaffold/generic_value.rb

@@ -35,7 +35,7 @@ private
   
   def configure
     super
-    method(:void, :set, { target: lvalue, value: :int.const_rvalue }, instance: :custom_create).configure do
+    method(:void, :set, { target: lvalue, value: :int.const_rvalue }, instance: :custom_create, constraint:-> { custom_constructible? }).configure do
       code %{
         #{default_create.(target)};
         *target->value = value;

data/lib/autoc/scaffold/glass_record.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+
+require 'autoc/record'
+
+
+GlassRecord = AutoC::Record.new(:GlassRecord, { i: :int }, profile: :glassbox, visibility: :public)

data/lib/autoc/scaffold/project.rb

@@ -19,10 +19,10 @@ end
 ###
 def cmakelists_txt(project)
 <<END
-project(#{project})
-
 cmake_minimum_required(VERSION 3.15)
 
+project(#{project})
+
 set(AUTOC_MODULE_NAME _${PROJECT_NAME})
 set(AUTOC_MODULE_SOURCE ${CMAKE_CURRENT_SOURCE_DIR}/${PROJECT_NAME}.rb)
 

data/lib/autoc/scaffold/test_record_record.rb

@@ -0,0 +1,21 @@
+require 'autoc/record'
+
+require_relative 'glass_record'
+
+t = type_test(AutoC::Record, :RecordRecord, { r: GlassRecord }) do
+
+  ###
+
+  setup %{
+    #{self} t;
+    #{default_create.(:t)};
+  }
+
+  cleanup %{
+    #{destroy.(:t) if destructible?};
+  }
+
+  test :create_empty, %{
+  }
+
+end

data/lib/autoc/scaffold/tests.rb

@@ -29,7 +29,7 @@ def type_test(cls, *opts, **kws, &code)
   t = Class.new(cls) do
     attr_reader :tests
     def initialize(*args, **kws)
-      super
+      super(*args, visibility: :public, **kws)
       @tests = []
       @test_names = []
       dependencies << $common
@@ -160,17 +160,17 @@ $tests = []
 
 require 'autoc/composite'
 
-#AutoC::Composite.decorator = AutoC::Composite::SNAKE_CASE_DECORATOR
+#AutoC::Composite.decorator = AutoC::Composite::Decorator::SNAKE_CASE
 
 require_relative 'generic_value'
 
-Value = GenericValue.new(:Value)
+Value = GenericValue.new(:Value, visibility: :public)
 
 Dir[File.join(File.dirname(__FILE__), 'test_*.rb')].each { |t| require t }
 
 require 'autoc/cmake'
 
-x = AutoC::Module.render(:tests) do |m|
+x = AutoC::Module.render(:tests, stateful: false) do |m|
   m << $suite
   m.source_threshold = 100*1024 # Split module code into a set of TUs with ~100 Kb in size
   $tests.each { |t| $suite.dependencies << t }

data/lib/autoc/std.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 
-require 'set'
 require 'autoc/module'
 require 'autoc/primitive'
 

data/lib/autoc/vector.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 
+require 'autoc/std'
 require 'autoc/ranges'
 require 'autoc/sequential'
 require 'autoc/association'

data/lib/autoc.rb

@@ -3,6 +3,6 @@
 
 module AutoC
 
-  VERSION = '2.0.0'
+  VERSION = '2.0.2'
   
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: autoc
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.2
 platform: ruby
 authors:
 - Oleg A. Khlybov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-14 00:00:00.000000000 Z
+date: 2023-04-11 00:00:00.000000000 Z
 dependencies: []
 description: |2
       The package contains a functionality related to the C source code generation,
@@ -43,8 +43,11 @@ files:
 - lib/autoc/ranges.rb
 - lib/autoc/record.rb
 - lib/autoc/scaffold.rb
+- lib/autoc/scaffold/1test_composite_value_vector.rb
+- lib/autoc/scaffold/composite_value.rb
 - lib/autoc/scaffold/docs.rb
 - lib/autoc/scaffold/generic_value.rb
+- lib/autoc/scaffold/glass_record.rb
 - lib/autoc/scaffold/project.rb
 - lib/autoc/scaffold/test_cstring.rb
 - lib/autoc/scaffold/test_cstring_hash_set.rb
@@ -52,6 +55,7 @@ files:
 - lib/autoc/scaffold/test_int_hash_set.rb
 - lib/autoc/scaffold/test_int_list.rb
 - lib/autoc/scaffold/test_int_vector.rb
+- lib/autoc/scaffold/test_record_record.rb
 - lib/autoc/scaffold/test_v2v_hash_map.rb
 - lib/autoc/scaffold/test_value_hash_set.rb
 - lib/autoc/scaffold/test_value_vector.rb
@@ -81,7 +85,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: C source code generation package