JSVirtualMachine.h 2.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859
  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. // An instance of JSVirtualMachine represents a single JavaScript "object space"
  28. // or set of execution resources. Thread safety is supported by locking the
  29. // virtual machine, with concurrent JavaScript execution supported by allocating
  30. // separate instances of JSVirtualMachine.
  31. NS_CLASS_AVAILABLE(10_9, NA)
  32. @interface JSVirtualMachine : NSObject
  33. // Create a new JSVirtualMachine.
  34. - (id)init;
  35. // addManagedReference:withOwner and removeManagedReference:withOwner allow
  36. // clients of JSVirtualMachine to make the JavaScript runtime aware of
  37. // arbitrary external Objective-C object graphs. The runtime can then use
  38. // this information to retain any JavaScript values that are referenced
  39. // from somewhere in said object graph.
  40. //
  41. // For correct behavior clients must make their external object graphs
  42. // reachable from within the JavaScript runtime. If an Objective-C object is
  43. // reachable from within the JavaScript runtime, all managed references
  44. // transitively reachable from it as recorded with
  45. // addManagedReference:withOwner: will be scanned by the garbage collector.
  46. //
  47. - (void)addManagedReference:(id)object withOwner:(id)owner;
  48. - (void)removeManagedReference:(id)object withOwner:(id)owner;
  49. @end
  50. #endif