wrapture 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a5516a3af955bee34acada560a1c0f67e4a7f6b07772e0fc27accf82103377e
-  data.tar.gz: ddba6f0862fcde505a9f7501b95ddf22acdffc6f9b4fed15a8fc5b0d3afdcf42
+  metadata.gz: 8b96407ba9b0bc6b336041a035ad5f383d624a5f54b251ddeea0047c3e17bbfb
+  data.tar.gz: 4443073a21063dc4c448a378df1179422ce3bc3353ce47b68586538af491d2b3
 SHA512:
-  metadata.gz: c770a67468d131f448a1640a9f2f76ce7e089bbf42980443cd70ce9388d581d1066e6c4435419bda81c442f4e09a838a52986f6661cf52791ca57cda88ddbb66
-  data.tar.gz: 27fc54ad64f8375c6815fb9b3263050f551d5a180089c1aa733833ef8a1d80bc3a9e625be74e990645dbd3db9fe78fac466bf90599a80c140e9d88bf05a1e2da
+  metadata.gz: 78143a9ca60a5f041b9cabe35814cd609bbdce55384e37f83cfc7eee9c9c0c0d7714754e6ced7f1bd29f5f16b5840f2c7674dc85558135a92b3a06c33bd614c4
+  data.tar.gz: ff53c37bac35253b8df395606fecf81ef4587bc03fd2531d36908f07dad33ba52e6c62981f6bd458a4027de73fd063b360219b796aa00f9ac46c9bce4292d7e8

data/lib/wrapture/action_spec.rb

@@ -40,8 +40,8 @@ module Wrapture
         raise(InvalidSpecKey, extra_msg)
       end
 
-      includes = Wrapture.normalize_includes(spec['constructor']['includes'])
-      normalized['constructor']['includes'] = includes
+      func_spec = WrappedFunctionSpec.normalize_spec_hash(spec['constructor'])
+      normalized['constructor'] = func_spec
 
       normalized
     end

data/lib/wrapture/constants.rb

@@ -36,5 +36,6 @@ module Wrapture
 
   # A list of all keywords.
   KEYWORDS = [EQUIVALENT_STRUCT_KEYWORD, EQUIVALENT_POINTER_KEYWORD,
-              RETURN_VALUE_KEYWORD, TEMPLATE_USE_KEYWORD].freeze
+              SELF_REFERENCE_KEYWORD, RETURN_VALUE_KEYWORD,
+              TEMPLATE_USE_KEYWORD].freeze
 end

data/lib/wrapture/function_spec.rb

@@ -228,7 +228,9 @@ module Wrapture
         yield
         yield "  #{wrapped_call_expression};"
         yield
-        @wrapped.error_check { |line| yield "  #{line}" }
+        @wrapped.error_check(return_val: return_variable) do |line|
+          yield "  #{line}"
+        end
       else
         yield "  #{wrapped_call_expression};"
       end
@@ -311,17 +313,30 @@ module Wrapture
     # Yields a declaration of each local variable used by the function.
     def locals
       yield 'va_list variadic_args;' if variadic?
-      yield "#{@wrapped.return_val_type} return_val;" if @wrapped.error_check?
+
+      if @wrapped.use_return? && !@constructor
+        wrapped_type = resolve_type(@wrapped.return_val_type)
+        yield "#{wrapped_type.variable('return_val')};"
+      end
     end
 
     # The function to use to create the return value of the function.
     def return_cast(value)
-      if @spec['return']['type'] == @wrapped.return_val_type
+      if @return_type == @wrapped.return_val_type
         value
       elsif @spec['return']['overloaded']
         "new#{@spec['return']['type'].chomp('*').strip} ( #{value} )"
       else
-        "#{@spec['return']['type']} ( #{value} )"
+        resolved_return.cast_expression(value)
+      end
+    end
+
+    # The name of the variable holding the return value.
+    def return_variable
+      if @constructor
+        'this->equivalent'
+      else
+        'return_val'
       end
     end
 

data/lib/wrapture/rule_spec.rb

@@ -64,20 +64,36 @@ module Wrapture
       normalized
     end
 
-    # Creates a rule spec based on the provided spec.
+    # Creates a rule spec based on the provided spec. Rules may be one of a
+    # number of different varieties.
     #
-    # The hash must have the following keys:
+    # Available conditions are available in the RuleSpec::CONDITIONS map, with
+    # the mapped values being the operate each one translates to.
+    #
+    # For a rule that checks a struct member against a given value (a
+    # +struct-member+ rule):
     # member-name:: the name of the struct member the rule applies to
-    # condition:: the condition this rule uses (supported values are keys in the
-    #             RuleSpec::CONDITIONS map, with the mapped values being the
-    #             operator they translate to)
+    # condition:: the condition this rule uses
     # value:: the value to use in the condition check
+    #
+    # For a rule that compares two expressions against one another (an
+    # +expression+ rule):
+    # left-expression:: the left expression in the comparison
+    # condition:: the condition this rule uses
+    # right-expression:: the right expression in the comparison
     def initialize(spec)
       @spec = RuleSpec.normalize_spec_hash(spec)
     end
 
     # A string containing a check for a struct of the given name for this rule.
-    def check(variable: nil)
+    #
+    # +variable+ can be provided to provide the variable holding a struct
+    # pointer for +struct-member+ rules.
+    #
+    # +return_val+ is used as the replacement for a return value signified by
+    # the use of RETURN_VALUE_KEYWORD in the spec. If not specified it defaults
+    # to +'return_val'+. This parameter was added in release 0.4.2.
+    def check(variable: nil, return_val: 'return_val')
       condition = RuleSpec::CONDITIONS[@spec['condition']]
 
       if @spec['type'] == 'struct-member'
@@ -85,8 +101,18 @@ module Wrapture
       else
         left = @spec['left-expression']
         right = @spec['right-expression']
-        "#{left} #{condition} #{right}".sub(RETURN_VALUE_KEYWORD, 'return_val')
+        "#{left} #{condition} #{right}".sub(RETURN_VALUE_KEYWORD, return_val)
       end
     end
+
+    # True if this rule requires a return value. This is equivalent to checking
+    # for the presence of RETURN_VALUE_KEYWORD in any of the expressions.
+    #
+    # This method was added in release 0.4.2.
+    def use_return?
+      @spec['type'] == 'expression' &&
+        [@spec['left-expression'],
+         @spec['right-expression']].include?(RETURN_VALUE_KEYWORD)
+    end
   end
 end

data/lib/wrapture/type_spec.rb

@@ -54,11 +54,26 @@ module Wrapture
       @spec = TypeSpec.normalize_spec_hash(actual_spec)
     end
 
+    # Compares this TypeSpec with +other+. Comparison happens by converting each
+    # object to a string using to_s and comparing.
+    #
+    # Added in release 0.4.2.
+    def ==(other)
+      to_s == other.to_s
+    end
+
     # The name of this type with all special characters removed.
     def base
       name.delete('*&').strip
     end
 
+    # An expression casting the result of a given expression into this type.
+    #
+    # Added in release 0.4.2.
+    def cast_expression(expression)
+      "( #{variable} )( #{expression} )"
+    end
+
     # True if this type is an equivalent struct pointer reference.
     def equivalent_pointer?
       name == EQUIVALENT_POINTER_KEYWORD
@@ -132,6 +147,13 @@ module Wrapture
       name == SELF_REFERENCE_KEYWORD
     end
 
+    # Gives a string representation of this type (its name).
+    #
+    # Added in release 0.4.2.
+    def to_s
+      name
+    end
+
     # A string with a declaration of a variable named +var_name+ of this type.
     # If +var_name+ is nil then this will simply be a type declaration.
     def variable(var_name = nil)

data/lib/wrapture/version.rb

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

data/lib/wrapture/wrapped_function_spec.rb

@@ -88,10 +88,14 @@ module Wrapture
     # Yields each line of the error check and any actions taken for this wrapped
     # function. If this function does not have any error check defined, then
     # this function returns without yielding anything.
-    def error_check
+    #
+    # +return_val+ is used as the replacement for a return value signified by
+    # the use of RETURN_VALUE_KEYWORD in the spec. If not specified it defaults
+    # to +'return_val'+. This parameter was added in release 0.4.2.
+    def error_check(return_val: 'return_val')
       return if @error_rules.empty?
 
-      checks = @error_rules.map(&:check)
+      checks = @error_rules.map { |rule| rule.check(return_val: return_val) }
       yield "if( #{checks.join(' && ')} ){"
       yield "  #{@error_action.take};"
       yield '}'
@@ -111,9 +115,20 @@ module Wrapture
       includes
     end
 
-    # A string with the type of the return value.
+    # A TypeSpec describing the type of the return value.
+    #
+    # Changed in release 0.4.2 to return a TypeSpec instead of a String.
     def return_val_type
-      @spec['return']['type']
+      TypeSpec.new(@spec['return']['type'])
+    end
+
+    # True if calling this wrapped function needs to save/use the return value
+    # for error checking. This is equivalent to checking all error rules for the
+    # use of RETURN_VALUE_KEYWORD.
+    #
+    # This method was added in release 0.4.2.
+    def use_return?
+      @error_rules.any?(&:use_return?)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wrapture
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Joel Anderson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-24 00:00:00.000000000 Z
+date: 2020-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -79,7 +79,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.3
 signing_key: 
 specification_version: 4
 summary: wrap C in C++