API/JSVirtualMachine.h

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