JSManagedValue.h 3.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081
  1. /*
  2. * Copyright (C) 2013 Apple Inc. All rights reserved.
  3. *
  4. * Redistribution and use in source and binary forms, with or without
  5. * modification, are permitted provided that the following conditions
  6. * are met:
  7. * 1. Redistributions of source code must retain the above copyright
  8. * notice, this list of conditions and the following disclaimer.
  9. * 2. Redistributions in binary form must reproduce the above copyright
  10. * notice, this list of conditions and the following disclaimer in the
  11. * documentation and/or other materials provided with the distribution.
  12. *
  13. * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
  14. * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  15. * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  16. * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
  17. * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  18. * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  19. * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  20. * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  21. * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  22. * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  23. * THE POSSIBILITY OF SUCH DAMAGE.
  24. */
  25. #ifndef JSManagedValue_h
  26. #define JSManagedValue_h
  27. #import <JavaScriptCore/JSBase.h>
  28. #import <JavaScriptCore/WebKitAvailability.h>
  29. #if JSC_OBJC_API_ENABLED
  30. @class JSValue;
  31. @class JSContext;
  32. /*!
  33. @interface
  34. @discussion JSManagedValue represents a "conditionally retained" JSValue.
  35. "Conditionally retained" means that as long as the JSManagedValue's
  36. JSValue is reachable through the JavaScript object graph,
  37. or through the Objective-C object graph reported to the JSVirtualMachine using
  38. addManagedReference:withOwner:, the corresponding JSValue will
  39. be retained. However, if neither graph reaches the JSManagedValue, the
  40. corresponding JSValue will be released and set to nil.
  41. The primary use for a JSManagedValue is to store a JSValue in an Objective-C
  42. or Swift object that is exported to JavaScript. It is incorrect to store a JSValue
  43. in an object that is exported to JavaScript, since doing so creates a retain cycle.
  44. */
  45. NS_CLASS_AVAILABLE(10_9, 7_0)
  46. @interface JSManagedValue : NSObject
  47. /*!
  48. @method
  49. @abstract Create a JSManagedValue from a JSValue.
  50. @result The new JSManagedValue.
  51. */
  52. + (JSManagedValue *)managedValueWithValue:(JSValue *)value;
  53. + (JSManagedValue *)managedValueWithValue:(JSValue *)value andOwner:(id)owner JSC_API_AVAILABLE(macosx(10.10), ios(8.0));
  54. /*!
  55. @method
  56. @abstract Create a JSManagedValue.
  57. @result The new JSManagedValue.
  58. */
  59. - (instancetype)initWithValue:(JSValue *)value;
  60. /*!
  61. @property
  62. @abstract Get the JSValue from the JSManagedValue.
  63. @result The corresponding JSValue for this JSManagedValue or
  64. nil if the JSValue has been collected.
  65. */
  66. @property (readonly, strong) JSValue *value;
  67. @end
  68. #endif // JSC_OBJC_API_ENABLED
  69. #endif // JSManagedValue_h