653c27c0d857f39ef115719831df9d1a9375f00c
[platform/upstream/nodejs.git] / lib / vm.js
1 // Copyright Joyent, Inc. and other Node contributors.
2 //
3 // Permission is hereby granted, free of charge, to any person obtaining a
4 // copy of this software and associated documentation files (the
5 // "Software"), to deal in the Software without restriction, including
6 // without limitation the rights to use, copy, modify, merge, publish,
7 // distribute, sublicense, and/or sell copies of the Software, and to permit
8 // persons to whom the Software is furnished to do so, subject to the
9 // following conditions:
10 //
11 // The above copyright notice and this permission notice shall be included
12 // in all copies or substantial portions of the Software.
13 //
14 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
15 // OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
17 // NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18 // DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
19 // OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20 // USE OR OTHER DEALINGS IN THE SOFTWARE.
21
22 'use strict';
23
24 var binding = process.binding('contextify');
25 var Script = binding.ContextifyScript;
26 var util = require('util');
27
28 // The binding provides a few useful primitives:
29 // - ContextifyScript(code, { filename = "evalmachine.anonymous",
30 //                            displayErrors = true } = {})
31 //   with methods:
32 //   - runInThisContext({ displayErrors = true } = {})
33 //   - runInContext(sandbox, { displayErrors = true, timeout = undefined } = {})
34 // - makeContext(sandbox)
35 // - isContext(sandbox)
36 // From this we build the entire documented API.
37
38 Script.prototype.runInNewContext = function(sandbox, options) {
39   var context = exports.createContext(sandbox);
40   return this.runInContext(context, options);
41 };
42
43 exports.Script = Script;
44
45 exports.createScript = function(code, options) {
46   return new Script(code, options);
47 };
48
49 exports.createContext = function(sandbox) {
50   if (util.isUndefined(sandbox)) {
51     sandbox = {};
52   } else if (binding.isContext(sandbox)) {
53     return sandbox;
54   }
55
56   binding.makeContext(sandbox);
57   return sandbox;
58 };
59
60 exports.runInDebugContext = function(code) {
61   return binding.runInDebugContext(code);
62 };
63
64 exports.runInContext = function(code, contextifiedSandbox, options) {
65   var script = new Script(code, options);
66   return script.runInContext(contextifiedSandbox, options);
67 };
68
69 exports.runInNewContext = function(code, sandbox, options) {
70   var script = new Script(code, options);
71   return script.runInNewContext(sandbox, options);
72 };
73
74 exports.runInThisContext = function(code, options) {
75   var script = new Script(code, options);
76   return script.runInThisContext(options);
77 };
78
79 exports.isContext = binding.isContext;