JSVirtualMachine.h 3.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687
  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. ``AS IS'' AND ANY
  14. * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15. * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  16. * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR
  17. * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  18. * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  19. * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  20. * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  21. * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22. * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  23. * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24. */
  25. #import <JavaScriptCore/JavaScriptCore.h>
  26. #if JSC_OBJC_API_ENABLED
  27. /*!
  28. @interface
  29. @discussion An instance of JSVirtualMachine represents a single JavaScript "object space"
  30. or set of execution resources. Thread safety is supported by locking the
  31. virtual machine, with concurrent JavaScript execution supported by allocating
  32. separate instances of JSVirtualMachine.
  33. A virtual machine may need to run deferred tasks on a run loop, such as garbage collection
  34. or resolving WebAssembly compilations. By default, a virtual machine will use the run loop
  35. of the thread it was initialized on. Currently, there is no API to change a
  36. JSVirtualMachine's run loop once it has been initialized.
  37. */
  38. NS_CLASS_AVAILABLE(10_9, 7_0)
  39. @interface JSVirtualMachine : NSObject
  40. /*!
  41. @methodgroup Creating New Virtual Machines
  42. */
  43. /*!
  44. @method
  45. @abstract Create a new JSVirtualMachine.
  46. */
  47. - (instancetype)init;
  48. /*!
  49. @methodgroup Memory Management
  50. */
  51. /*!
  52. @method
  53. @abstract Notify the JSVirtualMachine of an external object relationship.
  54. @discussion Allows clients of JSVirtualMachine to make the JavaScript runtime aware of
  55. arbitrary external Objective-C object graphs. The runtime can then use
  56. this information to retain any JavaScript values that are referenced
  57. from somewhere in said object graph.
  58. For correct behavior clients must make their external object graphs
  59. reachable from within the JavaScript runtime. If an Objective-C object is
  60. reachable from within the JavaScript runtime, all managed references
  61. transitively reachable from it as recorded using
  62. -addManagedReference:withOwner: will be scanned by the garbage collector.
  63. @param object The object that the owner points to.
  64. @param owner The object that owns the pointed to object.
  65. */
  66. - (void)addManagedReference:(id)object withOwner:(id)owner;
  67. /*!
  68. @method
  69. @abstract Notify the JSVirtualMachine that a previous object relationship no longer exists.
  70. @discussion The JavaScript runtime will continue to scan any references that were
  71. reported to it by -addManagedReference:withOwner: until those references are removed.
  72. @param object The object that was formerly owned.
  73. @param owner The former owner.
  74. */
  75. - (void)removeManagedReference:(id)object withOwner:(id)owner;
  76. @end
  77. #endif