wrapture 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b96407ba9b0bc6b336041a035ad5f383d624a5f54b251ddeea0047c3e17bbfb
-  data.tar.gz: 4443073a21063dc4c448a378df1179422ce3bc3353ce47b68586538af491d2b3
+  metadata.gz: 5a2ff7411136ffd84e6078406f6a4a8bf76cfaf0c2f1398d9409d019d29a6b8a
+  data.tar.gz: 8c91f45af881ad5f7f28b184d5d9d63ce9cabde0320af43303efb51764a2d458
 SHA512:
-  metadata.gz: 78143a9ca60a5f041b9cabe35814cd609bbdce55384e37f83cfc7eee9c9c0c0d7714754e6ced7f1bd29f5f16b5840f2c7674dc85558135a92b3a06c33bd614c4
-  data.tar.gz: ff53c37bac35253b8df395606fecf81ef4587bc03fd2531d36908f07dad33ba52e6c62981f6bd458a4027de73fd063b360219b796aa00f9ac46c9bce4292d7e8
+  metadata.gz: cfb9b375f81fbfb6e75af4f52882fcff232ff5a9757732deb3446a1ae5b6de39cb1d4ddc2fd93d0c31f9fa3d9344e917119ad428a2040c2ec6415cdb002761ea
+  data.tar.gz: 936c998fd990eec6b580257b50a4e2d440ff9d6670c62250d1a38c6e42b7f70c1c7f8c02113a572388cd74beeeef7d235566d9bf89d90d028905eece199d2bc7

data/bin/wrapture

@@ -26,6 +26,10 @@ scope = Wrapture::Scope.new
 ARGV.each do |spec_file|
   spec = YAML.load_file(spec_file)
 
+  if spec.key?('version') && !Wrapture.supports_version?(spec['version'])
+    raise Wrapture::UnsupportedSpecVersion
+  end
+
   spec.fetch('templates', []).each do |temp_spec|
     scope << Wrapture::TemplateSpec.new(temp_spec)
   end

data/lib/wrapture/class_spec.rb

@@ -350,9 +350,9 @@ module Wrapture
       includes.uniq
     end
 
-    # Yields the class documentation one line at a time.
-    def documentation
-      @doc&.format_as_doxygen(max_line_length: 78) { |line| yield line }
+    # Calls the given block for each line of the class documentation.
+    def documentation(&block)
+      @doc&.format_as_doxygen(max_line_length: 78) { |line| block.call(line) }
     end
 
     # Yields the declaration of the equivalent member if this class has one.
@@ -470,6 +470,18 @@ module Wrapture
       @scope.overloads(self).map { |overload| "#{overload.name}.hpp" }
     end
 
+    # The initializer for the pointer constructor, if one is available, or an
+    # empty string if not.
+    def parent_provides_initializer?
+      return false if !pointer_wrapper? || !child?
+
+      parent_spec = @scope.type(TypeSpec.new(parent_name))
+
+      !parent_spec.nil? &&
+        parent_spec.pointer_wrapper? &&
+        parent_spec.struct_name == @struct.name
+    end
+
     # Yields the declaration of the pointer constructor for a class.
     #
     # If this class does not have an equivalent struct, or if there is already
@@ -523,15 +535,11 @@ module Wrapture
     # The initializer for the pointer constructor, if one is available, or an
     # empty string if not.
     def pointer_constructor_initializer
-      if pointer_wrapper? && child?
-        parent_spec = @scope.type(TypeSpec.new(parent_name))
-        parent_usable = !parent_spec.nil? &&
-                        parent_spec.pointer_wrapper? &&
-                        parent_spec.struct_name == @struct.name
-        return ": #{parent_name}( equivalent ) " if parent_usable
+      if parent_provides_initializer?
+        ": #{parent_name}( equivalent ) "
+      else
+        ''
       end
-
-      ''
     end
 
     # The signature of the constructor given an equivalent strucct pointer.

data/lib/wrapture/comment.rb

@@ -57,11 +57,12 @@ module Wrapture
       yield last_line if last_line
     end
 
-    # Yields each line of the comment formatted using Doxygen style.
-    def format_as_doxygen(max_line_length: 80)
+    # Calls the given block for each line of the comment formatted using Doxygen
+    # style.
+    def format_as_doxygen(max_line_length: 80, &block)
       format(line_prefix: ' * ', first_line: '/**',
              last_line: ' */', max_line_length: max_line_length) do |line|
-        yield line
+        block.call(line)
       end
     end
 
@@ -93,7 +94,7 @@ module Wrapture
         line.scan(/\S+/) do |word|
           if running_line.length + word.length > line_length
             yield running_line
-            running_line = word + ' '
+            running_line = String.new("#{word} ")
           else
             running_line << word << ' '
           end

data/lib/wrapture/constant_spec.rb

@@ -63,11 +63,11 @@ module Wrapture
       @spec['includes'].dup
     end
 
-    # Yields each line of the declaration of this constant, including any
-    # documentation.
-    def declaration
-      @doc&.format_as_doxygen(max_line_length: 76) { |line| yield line }
-      yield "static const #{@type.variable(@spec['name'])};"
+    # Calls the given block once for each line of the declaration of this
+    # constant, including any documentation.
+    def declaration(&block)
+      @doc&.format_as_doxygen(max_line_length: 76) { |line| block.call(line) }
+      block.call("static const #{@type.variable(@spec['name'])};")
     end
 
     # The definition of this constant.

data/lib/wrapture/enum_spec.rb

@@ -140,10 +140,11 @@ module Wrapture
       end
     end
 
-    # Yields each line of the documentation for an element.
-    def element_doc(element)
+    # Calls the given block once for each line of the documentation for an
+    # element.
+    def element_doc(element, &block)
       doc = Comment.new(element.fetch('doc', nil))
-      doc.format_as_doxygen(max_line_length: 74) { |line| yield line }
+      doc.format_as_doxygen(max_line_length: 74) { |line| block.call(line) }
     end
 
     # The header guard for the enumeration.

data/lib/wrapture/errors.rb

@@ -25,18 +25,10 @@ module Wrapture
 
   # A documentation string is invalid.
   class InvalidDoc < WraptureError
-    # Creates an InvalidDoc with the given message.
-    def initialize(message)
-      super(message)
-    end
   end
 
   # A template has been invoked in an unsupported way.
   class InvalidTemplateUsage < WraptureError
-    # Creates an InvalidTemplateUsage with the given message.
-    def initialize(message)
-      super(message)
-    end
   end
 
   # The spec has a key that is not valid.
@@ -59,10 +51,6 @@ module Wrapture
 
   # The spec is missing a key that is required.
   class MissingSpecKey < WraptureError
-    # Creates a MissingSpecKey with the given message.
-    def initialize(message)
-      super(message)
-    end
   end
 
   # Missing a namespace in the class spec
@@ -71,10 +59,6 @@ module Wrapture
 
   # The spec cannot be defined due to missing information.
   class UndefinableSpec < WraptureError
-    # Creates an UndefinableSpec with error +message+.
-    def initialize(message)
-      super(message)
-    end
   end
 
   # The spec version is not supported by this version of Wrapture.

data/lib/wrapture/function_spec.rb

@@ -198,10 +198,10 @@ module Wrapture
       "#{func_name}( #{param_list} )"
     end
 
-    # Yields each line of the declaration of the function, including any
-    # documentation.
-    def declaration
-      doc.format_as_doxygen(max_line_length: 76) { |line| yield line }
+    # Calls the given block once for each line of the declaration of the
+    # function, including any documentation.
+    def declaration(&block)
+      doc.format_as_doxygen(max_line_length: 76) { |line| block.call(line) }
 
       modifier_prefix = if @spec['static']
                           'static '
@@ -211,7 +211,7 @@ module Wrapture
                           ''
                         end
 
-      yield "#{modifier_prefix}#{return_expression};"
+      block.call("#{modifier_prefix}#{return_expression};")
     end
 
     # Gives the definition of the function in a block, line by line.
@@ -237,7 +237,11 @@ module Wrapture
 
       yield '  va_end( variadic_args );' if variadic?
 
-      yield '  return *this;' if @return_type.self?
+      if @return_type.self?
+        yield '  return *this;'
+      elsif @spec['return']['type'] != 'void' && !returns_call_directly?
+        yield '  return return_val;'
+      end
 
       yield '}'
     end
@@ -285,9 +289,11 @@ module Wrapture
 
     private
 
-    # The resolved type of the return type.
-    def resolved_return
-      @return_type.resolve(self)
+    # True if the return value of the wrapped call needs to be captured in a
+    # local variable.
+    def capture_return?
+      !@constructor &&
+        @wrapped.use_return? || returns_return_val?
     end
 
     # True if the provided wrapped param spec can be cast to when used in this
@@ -314,12 +320,17 @@ module Wrapture
     def locals
       yield 'va_list variadic_args;' if variadic?
 
-      if @wrapped.use_return? && !@constructor
+      if capture_return?
         wrapped_type = resolve_type(@wrapped.return_val_type)
         yield "#{wrapped_type.variable('return_val')};"
       end
     end
 
+    # The resolved type of the return type.
+    def resolved_return
+      @return_type.resolve(self)
+    end
+
     # The function to use to create the return value of the function.
     def return_cast(value)
       if @return_type == @wrapped.return_val_type
@@ -340,10 +351,20 @@ module Wrapture
       end
     end
 
-    # True if the function returns the result of the wrapped function call.
-    def returns_call_result?
-      !@constructor && !@destructor &&
-        !%w[void self-reference].include?(@spec['return']['type'])
+    # True if the function returns the result of the wrapped function call
+    # directly without any after actions.
+    def returns_call_directly?
+      !@constructor &&
+        !@destructor &&
+        !%w[void self-reference].include?(@spec['return']['type']) &&
+        !@wrapped.error_check?
+    end
+
+    # True if the function returns the return_val variable.
+    def returns_return_val?
+      !@return_type.self? &&
+        @spec['return']['type'] != 'void' &&
+        !returns_call_directly?
     end
 
     # The expression containing the call to the underlying wrapped function.
@@ -354,7 +375,7 @@ module Wrapture
         "this->equivalent = #{call}"
       elsif @wrapped.error_check?
         "return_val = #{call}"
-      elsif returns_call_result?
+      elsif returns_call_directly?
         "return #{return_cast(call)}"
       else
         call

data/lib/wrapture/struct_spec.rb

@@ -88,7 +88,7 @@ module Wrapture
 
           member_str += ' = '
           member_str += if member['type'] == 'const char *'
-                          '"' + default_value + '"'
+                          "\"#{default_value}\""
                         elsif member['type'].end_with?('char')
                           "'#{default_value}'"
                         else

data/lib/wrapture/template_spec.rb

@@ -256,9 +256,10 @@ module Wrapture
     # Replaces all instances of a parameter with the given name with the given
     # value in the provided spec.
     def self.replace_param!(spec, param_name, param_value)
-      if spec.is_a?(Hash)
+      case spec
+      when Hash
         replace_param_in_hash(spec, param_name, param_value)
-      elsif spec.is_a?(Array)
+      when Array
         replace_param_in_array(spec, param_name, param_value)
       else
         spec
@@ -334,9 +335,10 @@ module Wrapture
     # multiple replacements are needed, then you will need to call this function
     # multiple times.
     def replace_uses(spec)
-      if spec.is_a?(Hash)
+      case spec
+      when Hash
         replace_uses_in_hash(spec)
-      elsif spec.is_a?(Array)
+      when Array
         replace_uses_in_array(spec)
       else
         false
@@ -348,9 +350,10 @@ module Wrapture
       return false unless spec.is_a?(Hash) && spec.key?(TEMPLATE_USE_KEYWORD)
 
       invocation = spec[TEMPLATE_USE_KEYWORD]
-      if invocation.is_a?(String)
+      case invocation
+      when String
         invocation == name
-      elsif invocation.is_a?(Hash)
+      when Hash
         unless invocation.key?('name')
           error_message = "invocations of #{TEMPLATE_USE_KEYWORD} must have a "\
                           'name member'

data/lib/wrapture/version.rb

@@ -20,7 +20,7 @@
 
 module Wrapture
   # the current version of Wrapture
-  VERSION = '0.4.2'
+  VERSION = '0.5.0'
 
   # Returns true if the version of the spec is supported by this version of
   # Wrapture. Otherwise returns false.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wrapture
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Joel Anderson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-11 00:00:00.000000000 Z
+date: 2020-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -19,7 +19,7 @@ dependencies:
         version: 1.6.4
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '2.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: 1.6.4
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '2.3'
 description: Wraps C code in C++.
 email: joelanderson333@gmail.com
 executables:
@@ -56,12 +56,12 @@ files:
 - lib/wrapture/type_spec.rb
 - lib/wrapture/version.rb
 - lib/wrapture/wrapped_function_spec.rb
-homepage: http://rubygems.org/gems/wrapture
+homepage: https://goatshriek.github.io/wrapture/
 licenses:
 - Apache-2.0
 metadata:
   bug_tracker_uri: https://github.com/goatshriek/wrapture/issues
-  changelog_uri: https://github.com/goatshriek/wrapture/blob/master/ChangeLog.md
+  changelog_uri: https://github.com/goatshriek/wrapture/blob/latest/ChangeLog.md
   documentation_uri: https://goatshriek.github.io/wrapture/rdoc/
   source_code_uri: https://github.com/goatshriek/wrapture/
 post_install_message: 
@@ -72,14 +72,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.3
+rubygems_version: 3.2.1
 signing_key: 
 specification_version: 4
 summary: wrap C in C++