shell.cc 14.5 KB
Newer Older
1
// Copyright 2012 the V8 project authors. All rights reserved.
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
//       notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
//       copyright notice, this list of conditions and the following
//       disclaimer in the documentation and/or other materials provided
//       with the distribution.
//     * Neither the name of Google Inc. nor the names of its
//       contributors may be used to endorse or promote products derived
//       from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

28 29 30
#include <include/v8.h>

#include <include/libplatform/libplatform.h>
31

32
#include <assert.h>
33 34 35
#include <fcntl.h>
#include <stdio.h>
#include <stdlib.h>
36
#include <string.h>
37

38 39 40 41 42 43 44 45
/**
 * This sample program shows how to implement a simple javascript shell
 * based on V8.  This includes initializing V8 with command line options,
 * creating global functions, compiling and executing strings.
 *
 * For a more sophisticated shell, consider using the debug shell D8.
 */

46

47
v8::Local<v8::Context> CreateShellContext(v8::Isolate* isolate);
48 49 50
void RunShell(v8::Local<v8::Context> context, v8::Platform* platform);
int RunMain(v8::Isolate* isolate, v8::Platform* platform, int argc,
            char* argv[]);
51 52
bool ExecuteString(v8::Isolate* isolate, v8::Local<v8::String> source,
                   v8::Local<v8::Value> name, bool print_result,
53
                   bool report_exceptions);
54 55 56 57 58
void Print(const v8::FunctionCallbackInfo<v8::Value>& args);
void Read(const v8::FunctionCallbackInfo<v8::Value>& args);
void Load(const v8::FunctionCallbackInfo<v8::Value>& args);
void Quit(const v8::FunctionCallbackInfo<v8::Value>& args);
void Version(const v8::FunctionCallbackInfo<v8::Value>& args);
59
v8::MaybeLocal<v8::String> ReadFile(v8::Isolate* isolate, const char* name);
60
void ReportException(v8::Isolate* isolate, v8::TryCatch* handler);
61 62


63
static bool run_shell;
64 65


66
int main(int argc, char* argv[]) {
67
  v8::V8::InitializeICUDefaultLocation(argv[0]);
vogelheim's avatar
vogelheim committed
68
  v8::V8::InitializeExternalStartupData(argv[0]);
69 70
  std::unique_ptr<v8::Platform> platform = v8::platform::NewDefaultPlatform();
  v8::V8::InitializePlatform(platform.get());
71
  v8::V8::Initialize();
72
  v8::V8::SetFlagsFromCommandLine(&argc, argv, true);
73
  v8::Isolate::CreateParams create_params;
74 75
  create_params.array_buffer_allocator =
      v8::ArrayBuffer::Allocator::NewDefaultAllocator();
76
  v8::Isolate* isolate = v8::Isolate::New(create_params);
77
  run_shell = (argc == 1);
78 79
  int result;
  {
80
    v8::Isolate::Scope isolate_scope(isolate);
81
    v8::HandleScope handle_scope(isolate);
82
    v8::Local<v8::Context> context = CreateShellContext(isolate);
83
    if (context.IsEmpty()) {
84
      fprintf(stderr, "Error creating context\n");
85 86
      return 1;
    }
87
    v8::Context::Scope context_scope(context);
88 89
    result = RunMain(isolate, platform.get(), argc, argv);
    if (run_shell) RunShell(context, platform.get());
90
  }
cwhan.tunz's avatar
cwhan.tunz committed
91
  isolate->Dispose();
92
  v8::V8::Dispose();
93
  v8::V8::ShutdownPlatform();
94
  delete create_params.array_buffer_allocator;
95 96 97 98
  return result;
}


99 100 101 102 103 104
// Extracts a C string from a V8 Utf8Value.
const char* ToCString(const v8::String::Utf8Value& value) {
  return *value ? *value : "<string conversion failed>";
}


105 106
// Creates a new execution environment containing the built-in
// functions.
107
v8::Local<v8::Context> CreateShellContext(v8::Isolate* isolate) {
108
  // Create a template for the global object.
109
  v8::Local<v8::ObjectTemplate> global = v8::ObjectTemplate::New(isolate);
110
  // Bind the global 'print' function to the C++ Print callback.
111
  global->Set(isolate, "print", v8::FunctionTemplate::New(isolate, Print));
112
  // Bind the global 'read' function to the C++ Read callback.
113
  global->Set(isolate, "read", v8::FunctionTemplate::New(isolate, Read));
114
  // Bind the global 'load' function to the C++ Load callback.
115
  global->Set(isolate, "load", v8::FunctionTemplate::New(isolate, Load));
116
  // Bind the 'quit' function
117
  global->Set(isolate, "quit", v8::FunctionTemplate::New(isolate, Quit));
118
  // Bind the 'version' function
119
  global->Set(isolate, "version", v8::FunctionTemplate::New(isolate, Version));
120
  return v8::Context::New(isolate, NULL, global);
121 122 123
}


124 125 126
// The callback that is invoked by v8 whenever the JavaScript 'print'
// function is called.  Prints its arguments on stdout separated by
// spaces and ending with a newline.
127
void Print(const v8::FunctionCallbackInfo<v8::Value>& args) {
128 129
  bool first = true;
  for (int i = 0; i < args.Length(); i++) {
130
    v8::HandleScope handle_scope(args.GetIsolate());
131 132 133 134 135
    if (first) {
      first = false;
    } else {
      printf(" ");
    }
136
    v8::String::Utf8Value str(args.GetIsolate(), args[i]);
137 138
    const char* cstr = ToCString(str);
    printf("%s", cstr);
139 140
  }
  printf("\n");
141
  fflush(stdout);
142 143 144
}


145 146 147
// The callback that is invoked by v8 whenever the JavaScript 'read'
// function is called.  This function loads the content of the file named in
// the argument into a JavaScript string.
148
void Read(const v8::FunctionCallbackInfo<v8::Value>& args) {
149
  if (args.Length() != 1) {
150
    args.GetIsolate()->ThrowException(
151
        v8::String::NewFromUtf8Literal(args.GetIsolate(), "Bad parameters"));
152
    return;
153
  }
154
  v8::String::Utf8Value file(args.GetIsolate(), args[0]);
155
  if (*file == NULL) {
156 157
    args.GetIsolate()->ThrowException(v8::String::NewFromUtf8Literal(
        args.GetIsolate(), "Error loading file"));
158
    return;
159
  }
160 161
  v8::Local<v8::String> source;
  if (!ReadFile(args.GetIsolate(), *file).ToLocal(&source)) {
162 163
    args.GetIsolate()->ThrowException(v8::String::NewFromUtf8Literal(
        args.GetIsolate(), "Error loading file"));
164
    return;
165
  }
166

167
  args.GetReturnValue().Set(source);
168 169
}

170 171 172
// The callback that is invoked by v8 whenever the JavaScript 'load'
// function is called.  Loads, compiles and executes its argument
// JavaScript file.
173
void Load(const v8::FunctionCallbackInfo<v8::Value>& args) {
174
  for (int i = 0; i < args.Length(); i++) {
175
    v8::HandleScope handle_scope(args.GetIsolate());
176
    v8::String::Utf8Value file(args.GetIsolate(), args[i]);
177
    if (*file == NULL) {
178 179
      args.GetIsolate()->ThrowException(v8::String::NewFromUtf8Literal(
          args.GetIsolate(), "Error loading file"));
180
      return;
181
    }
182 183
    v8::Local<v8::String> source;
    if (!ReadFile(args.GetIsolate(), *file).ToLocal(&source)) {
184 185
      args.GetIsolate()->ThrowException(v8::String::NewFromUtf8Literal(
          args.GetIsolate(), "Error loading file"));
186
      return;
187
    }
188
    if (!ExecuteString(args.GetIsolate(), source, args[i], false, false)) {
189 190
      args.GetIsolate()->ThrowException(v8::String::NewFromUtf8Literal(
          args.GetIsolate(), "Error executing file"));
191
      return;
192
    }
193 194 195 196 197 198
  }
}


// The callback that is invoked by v8 whenever the JavaScript 'quit'
// function is called.  Quits.
199
void Quit(const v8::FunctionCallbackInfo<v8::Value>& args) {
200 201
  // If not arguments are given args[0] will yield undefined which
  // converts to the integer value 0.
202 203
  int exit_code =
      args[0]->Int32Value(args.GetIsolate()->GetCurrentContext()).FromMaybe(0);
204 205 206
  fflush(stdout);
  fflush(stderr);
  exit(exit_code);
207 208 209
}


210
void Version(const v8::FunctionCallbackInfo<v8::Value>& args) {
211
  args.GetReturnValue().Set(
212 213
      v8::String::NewFromUtf8(args.GetIsolate(), v8::V8::GetVersion())
          .ToLocalChecked());
214 215 216
}


217
// Reads a file into a v8 string.
218
v8::MaybeLocal<v8::String> ReadFile(v8::Isolate* isolate, const char* name) {
219
  FILE* file = fopen(name, "rb");
220
  if (file == NULL) return v8::MaybeLocal<v8::String>();
221 222

  fseek(file, 0, SEEK_END);
223
  size_t size = ftell(file);
224 225 226 227
  rewind(file);

  char* chars = new char[size + 1];
  chars[size] = '\0';
228 229 230 231
  for (size_t i = 0; i < size;) {
    i += fread(&chars[i], 1, size - i, file);
    if (ferror(file)) {
      fclose(file);
232
      return v8::MaybeLocal<v8::String>();
233
    }
234 235
  }
  fclose(file);
236 237
  v8::MaybeLocal<v8::String> result = v8::String::NewFromUtf8(
      isolate, chars, v8::NewStringType::kNormal, static_cast<int>(size));
238 239 240 241 242
  delete[] chars;
  return result;
}


243
// Process remaining command line arguments and execute files
244 245
int RunMain(v8::Isolate* isolate, v8::Platform* platform, int argc,
            char* argv[]) {
246 247 248 249 250 251 252 253 254
  for (int i = 1; i < argc; i++) {
    const char* str = argv[i];
    if (strcmp(str, "--shell") == 0) {
      run_shell = true;
    } else if (strcmp(str, "-f") == 0) {
      // Ignore any -f flags for compatibility with the other stand-
      // alone JavaScript engines.
      continue;
    } else if (strncmp(str, "--", 2) == 0) {
255 256
      fprintf(stderr,
              "Warning: unknown flag %s.\nTry --help for options\n", str);
257 258
    } else if (strcmp(str, "-e") == 0 && i + 1 < argc) {
      // Execute argument given to -e option directly.
259
      v8::Local<v8::String> file_name =
260
          v8::String::NewFromUtf8Literal(isolate, "unnamed");
261
      v8::Local<v8::String> source;
262
      if (!v8::String::NewFromUtf8(isolate, argv[++i]).ToLocal(&source)) {
263 264
        return 1;
      }
265 266 267
      bool success = ExecuteString(isolate, source, file_name, false, true);
      while (v8::platform::PumpMessageLoop(platform, isolate)) continue;
      if (!success) return 1;
268 269
    } else {
      // Use all other arguments as names of files to load and run.
270
      v8::Local<v8::String> file_name =
271
          v8::String::NewFromUtf8(isolate, str).ToLocalChecked();
272 273
      v8::Local<v8::String> source;
      if (!ReadFile(isolate, str).ToLocal(&source)) {
274
        fprintf(stderr, "Error reading '%s'\n", str);
275 276
        continue;
      }
277 278 279
      bool success = ExecuteString(isolate, source, file_name, false, true);
      while (v8::platform::PumpMessageLoop(platform, isolate)) continue;
      if (!success) return 1;
280 281 282 283 284 285
    }
  }
  return 0;
}


286
// The read-eval-execute loop of the shell.
287
void RunShell(v8::Local<v8::Context> context, v8::Platform* platform) {
288
  fprintf(stderr, "V8 version %s [sample shell]\n", v8::V8::GetVersion());
289
  static const int kBufferSize = 256;
290 291
  // Enter the execution environment before evaluating any code.
  v8::Context::Scope context_scope(context);
292
  v8::Local<v8::String> name(
293
      v8::String::NewFromUtf8Literal(context->GetIsolate(), "(shell)"));
294 295
  while (true) {
    char buffer[kBufferSize];
296
    fprintf(stderr, "> ");
297 298
    char* str = fgets(buffer, kBufferSize, stdin);
    if (str == NULL) break;
299
    v8::HandleScope handle_scope(context->GetIsolate());
300 301
    ExecuteString(
        context->GetIsolate(),
302
        v8::String::NewFromUtf8(context->GetIsolate(), str).ToLocalChecked(),
303
        name, true, true);
304 305
    while (v8::platform::PumpMessageLoop(platform, context->GetIsolate()))
      continue;
306
  }
307
  fprintf(stderr, "\n");
308 309 310 311
}


// Executes a string within the current v8 context.
312 313
bool ExecuteString(v8::Isolate* isolate, v8::Local<v8::String> source,
                   v8::Local<v8::Value> name, bool print_result,
314
                   bool report_exceptions) {
315
  v8::HandleScope handle_scope(isolate);
316
  v8::TryCatch try_catch(isolate);
317
  v8::ScriptOrigin origin(name);
318 319 320
  v8::Local<v8::Context> context(isolate->GetCurrentContext());
  v8::Local<v8::Script> script;
  if (!v8::Script::Compile(context, source, &origin).ToLocal(&script)) {
321
    // Print errors that happened during compilation.
322
    if (report_exceptions)
323
      ReportException(isolate, &try_catch);
324 325
    return false;
  } else {
326 327
    v8::Local<v8::Value> result;
    if (!script->Run(context).ToLocal(&result)) {
328
      assert(try_catch.HasCaught());
329
      // Print errors that happened during execution.
330
      if (report_exceptions)
331
        ReportException(isolate, &try_catch);
332 333
      return false;
    } else {
334
      assert(!try_catch.HasCaught());
335
      if (print_result && !result->IsUndefined()) {
336 337
        // If all went well and the result wasn't undefined then print
        // the returned value.
338
        v8::String::Utf8Value str(isolate, result);
339 340
        const char* cstr = ToCString(str);
        printf("%s\n", cstr);
341 342 343 344 345
      }
      return true;
    }
  }
}
346 347


348 349
void ReportException(v8::Isolate* isolate, v8::TryCatch* try_catch) {
  v8::HandleScope handle_scope(isolate);
350
  v8::String::Utf8Value exception(isolate, try_catch->Exception());
351
  const char* exception_string = ToCString(exception);
352
  v8::Local<v8::Message> message = try_catch->Message();
353 354 355
  if (message.IsEmpty()) {
    // V8 didn't provide any extra information about this error; just
    // print the exception.
356
    fprintf(stderr, "%s\n", exception_string);
357 358
  } else {
    // Print (filename):(line number): (message).
359 360
    v8::String::Utf8Value filename(isolate,
                                   message->GetScriptOrigin().ResourceName());
361
    v8::Local<v8::Context> context(isolate->GetCurrentContext());
362
    const char* filename_string = ToCString(filename);
363
    int linenum = message->GetLineNumber(context).FromJust();
364
    fprintf(stderr, "%s:%i: %s\n", filename_string, linenum, exception_string);
365
    // Print line of source code.
366
    v8::String::Utf8Value sourceline(
367
        isolate, message->GetSourceLine(context).ToLocalChecked());
368
    const char* sourceline_string = ToCString(sourceline);
369
    fprintf(stderr, "%s\n", sourceline_string);
370
    // Print wavy underline (GetUnderline is deprecated).
371
    int start = message->GetStartColumn(context).FromJust();
372
    for (int i = 0; i < start; i++) {
373
      fprintf(stderr, " ");
374
    }
375
    int end = message->GetEndColumn(context).FromJust();
376
    for (int i = start; i < end; i++) {
377
      fprintf(stderr, "^");
378
    }
379
    fprintf(stderr, "\n");
380 381 382 383
    v8::Local<v8::Value> stack_trace_string;
    if (try_catch->StackTrace(context).ToLocal(&stack_trace_string) &&
        stack_trace_string->IsString() &&
        v8::Local<v8::String>::Cast(stack_trace_string)->Length() > 0) {
384
      v8::String::Utf8Value stack_trace(isolate, stack_trace_string);
385
      const char* stack_trace_string = ToCString(stack_trace);
386
      fprintf(stderr, "%s\n", stack_trace_string);
387
    }
388 389
  }
}