• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 // Copyright 2012 the V8 project authors. All rights reserved.
2 // Redistribution and use in source and binary forms, with or without
3 // modification, are permitted provided that the following conditions are
4 // met:
5 //
6 //     * Redistributions of source code must retain the above copyright
7 //       notice, this list of conditions and the following disclaimer.
8 //     * Redistributions in binary form must reproduce the above
9 //       copyright notice, this list of conditions and the following
10 //       disclaimer in the documentation and/or other materials provided
11 //       with the distribution.
12 //     * Neither the name of Google Inc. nor the names of its
13 //       contributors may be used to endorse or promote products derived
14 //       from this software without specific prior written permission.
15 //
16 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 
28 #include <include/v8.h>
29 
30 #include <include/libplatform/libplatform.h>
31 
32 #include <assert.h>
33 #include <fcntl.h>
34 #include <stdio.h>
35 #include <stdlib.h>
36 #include <string.h>
37 
38 /**
39  * This sample program shows how to implement a simple javascript shell
40  * based on V8.  This includes initializing V8 with command line options,
41  * creating global functions, compiling and executing strings.
42  *
43  * For a more sophisticated shell, consider using the debug shell D8.
44  */
45 
46 
47 v8::Local<v8::Context> CreateShellContext(v8::Isolate* isolate);
48 void RunShell(v8::Local<v8::Context> context, v8::Platform* platform);
49 int RunMain(v8::Isolate* isolate, v8::Platform* platform, int argc,
50             char* argv[]);
51 bool ExecuteString(v8::Isolate* isolate, v8::Local<v8::String> source,
52                    v8::Local<v8::Value> name, bool print_result,
53                    bool report_exceptions);
54 void Print(const v8::FunctionCallbackInfo<v8::Value>& args);
55 void Read(const v8::FunctionCallbackInfo<v8::Value>& args);
56 void Load(const v8::FunctionCallbackInfo<v8::Value>& args);
57 void Quit(const v8::FunctionCallbackInfo<v8::Value>& args);
58 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 
main(int argc,char * argv[])66 int main(int argc, char* argv[]) {
67   v8::V8::InitializeICUDefaultLocation(argv[0]);
68   v8::V8::InitializeExternalStartupData(argv[0]);
69   std::unique_ptr<v8::Platform> platform = v8::platform::NewDefaultPlatform();
70   v8::V8::InitializePlatform(platform.get());
71   v8::V8::Initialize();
72   v8::V8::SetFlagsFromCommandLine(&argc, argv, true);
73   v8::Isolate::CreateParams create_params;
74   create_params.array_buffer_allocator =
75       v8::ArrayBuffer::Allocator::NewDefaultAllocator();
76   v8::Isolate* isolate = v8::Isolate::New(create_params);
77   run_shell = (argc == 1);
78   int result;
79   {
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       return 1;
86     }
87     v8::Context::Scope context_scope(context);
88     result = RunMain(isolate, platform.get(), argc, argv);
89     if (run_shell) RunShell(context, platform.get());
90   }
91   isolate->Dispose();
92   v8::V8::Dispose();
93   v8::V8::ShutdownPlatform();
94   delete create_params.array_buffer_allocator;
95   return result;
96 }
97 
98 
99 // Extracts a C string from a V8 Utf8Value.
ToCString(const v8::String::Utf8Value & value)100 const char* ToCString(const v8::String::Utf8Value& value) {
101   return *value ? *value : "<string conversion failed>";
102 }
103 
104 
105 // Creates a new execution environment containing the built-in
106 // functions.
CreateShellContext(v8::Isolate * isolate)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 // The callback that is invoked by v8 whenever the JavaScript 'print'
125 // function is called.  Prints its arguments on stdout separated by
126 // spaces and ending with a newline.
Print(const v8::FunctionCallbackInfo<v8::Value> & args)127 void Print(const v8::FunctionCallbackInfo<v8::Value>& args) {
128   bool first = true;
129   for (int i = 0; i < args.Length(); i++) {
130     v8::HandleScope handle_scope(args.GetIsolate());
131     if (first) {
132       first = false;
133     } else {
134       printf(" ");
135     }
136     v8::String::Utf8Value str(args.GetIsolate(), args[i]);
137     const char* cstr = ToCString(str);
138     printf("%s", cstr);
139   }
140   printf("\n");
141   fflush(stdout);
142 }
143 
144 
145 // The callback that is invoked by v8 whenever the JavaScript 'read'
146 // function is called.  This function loads the content of the file named in
147 // the argument into a JavaScript string.
Read(const v8::FunctionCallbackInfo<v8::Value> & args)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     args.GetIsolate()->ThrowException(v8::String::NewFromUtf8Literal(
157         args.GetIsolate(), "Error loading file"));
158     return;
159   }
160   v8::Local<v8::String> source;
161   if (!ReadFile(args.GetIsolate(), *file).ToLocal(&source)) {
162     args.GetIsolate()->ThrowException(v8::String::NewFromUtf8Literal(
163         args.GetIsolate(), "Error loading file"));
164     return;
165   }
166 
167   args.GetReturnValue().Set(source);
168 }
169 
170 // The callback that is invoked by v8 whenever the JavaScript 'load'
171 // function is called.  Loads, compiles and executes its argument
172 // JavaScript file.
Load(const v8::FunctionCallbackInfo<v8::Value> & args)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       args.GetIsolate()->ThrowException(v8::String::NewFromUtf8Literal(
179           args.GetIsolate(), "Error loading file"));
180       return;
181     }
182     v8::Local<v8::String> source;
183     if (!ReadFile(args.GetIsolate(), *file).ToLocal(&source)) {
184       args.GetIsolate()->ThrowException(v8::String::NewFromUtf8Literal(
185           args.GetIsolate(), "Error loading file"));
186       return;
187     }
188     if (!ExecuteString(args.GetIsolate(), source, args[i], false, false)) {
189       args.GetIsolate()->ThrowException(v8::String::NewFromUtf8Literal(
190           args.GetIsolate(), "Error executing file"));
191       return;
192     }
193   }
194 }
195 
196 
197 // The callback that is invoked by v8 whenever the JavaScript 'quit'
198 // function is called.  Quits.
Quit(const v8::FunctionCallbackInfo<v8::Value> & args)199 void Quit(const v8::FunctionCallbackInfo<v8::Value>& args) {
200   // If not arguments are given args[0] will yield undefined which
201   // converts to the integer value 0.
202   int exit_code =
203       args[0]->Int32Value(args.GetIsolate()->GetCurrentContext()).FromMaybe(0);
204   fflush(stdout);
205   fflush(stderr);
206   exit(exit_code);
207 }
208 
209 
Version(const v8::FunctionCallbackInfo<v8::Value> & args)210 void Version(const v8::FunctionCallbackInfo<v8::Value>& args) {
211   args.GetReturnValue().Set(
212       v8::String::NewFromUtf8(args.GetIsolate(), v8::V8::GetVersion())
213           .ToLocalChecked());
214 }
215 
216 
217 // Reads a file into a v8 string.
ReadFile(v8::Isolate * isolate,const char * name)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   rewind(file);
225 
226   char* chars = new char[size + 1];
227   chars[size] = '\0';
228   for (size_t i = 0; i < size;) {
229     i += fread(&chars[i], 1, size - i, file);
230     if (ferror(file)) {
231       fclose(file);
232       return v8::MaybeLocal<v8::String>();
233     }
234   }
235   fclose(file);
236   v8::MaybeLocal<v8::String> result = v8::String::NewFromUtf8(
237       isolate, chars, v8::NewStringType::kNormal, static_cast<int>(size));
238   delete[] chars;
239   return result;
240 }
241 
242 
243 // Process remaining command line arguments and execute files
RunMain(v8::Isolate * isolate,v8::Platform * platform,int argc,char * argv[])244 int RunMain(v8::Isolate* isolate, v8::Platform* platform, int argc,
245             char* argv[]) {
246   for (int i = 1; i < argc; i++) {
247     const char* str = argv[i];
248     if (strcmp(str, "--shell") == 0) {
249       run_shell = true;
250     } else if (strcmp(str, "-f") == 0) {
251       // Ignore any -f flags for compatibility with the other stand-
252       // alone JavaScript engines.
253       continue;
254     } else if (strncmp(str, "--", 2) == 0) {
255       fprintf(stderr,
256               "Warning: unknown flag %s.\nTry --help for options\n", str);
257     } else if (strcmp(str, "-e") == 0 && i + 1 < argc) {
258       // 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         return 1;
264       }
265       bool success = ExecuteString(isolate, source, file_name, false, true);
266       while (v8::platform::PumpMessageLoop(platform, isolate)) continue;
267       if (!success) return 1;
268     } else {
269       // 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       v8::Local<v8::String> source;
273       if (!ReadFile(isolate, str).ToLocal(&source)) {
274         fprintf(stderr, "Error reading '%s'\n", str);
275         continue;
276       }
277       bool success = ExecuteString(isolate, source, file_name, false, true);
278       while (v8::platform::PumpMessageLoop(platform, isolate)) continue;
279       if (!success) return 1;
280     }
281   }
282   return 0;
283 }
284 
285 
286 // The read-eval-execute loop of the shell.
RunShell(v8::Local<v8::Context> context,v8::Platform * platform)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   // Enter the execution environment before evaluating any code.
291   v8::Context::Scope context_scope(context);
292   v8::Local<v8::String> name(
293       v8::String::NewFromUtf8Literal(context->GetIsolate(), "(shell)"));
294   while (true) {
295     char buffer[kBufferSize];
296     fprintf(stderr, "> ");
297     char* str = fgets(buffer, kBufferSize, stdin);
298     if (str == NULL) break;
299     v8::HandleScope handle_scope(context->GetIsolate());
300     ExecuteString(
301         context->GetIsolate(),
302         v8::String::NewFromUtf8(context->GetIsolate(), str).ToLocalChecked(),
303         name, true, true);
304     while (v8::platform::PumpMessageLoop(platform, context->GetIsolate()))
305       continue;
306   }
307   fprintf(stderr, "\n");
308 }
309 
310 
311 // Executes a string within the current v8 context.
ExecuteString(v8::Isolate * isolate,v8::Local<v8::String> source,v8::Local<v8::Value> name,bool print_result,bool report_exceptions)312 bool ExecuteString(v8::Isolate* isolate, v8::Local<v8::String> source,
313                    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   v8::Local<v8::Context> context(isolate->GetCurrentContext());
319   v8::Local<v8::Script> script;
320   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     return false;
325   } else {
326     v8::Local<v8::Value> result;
327     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       return false;
333     } else {
334       assert(!try_catch.HasCaught());
335       if (print_result && !result->IsUndefined()) {
336         // If all went well and the result wasn't undefined then print
337         // the returned value.
338         v8::String::Utf8Value str(isolate, result);
339         const char* cstr = ToCString(str);
340         printf("%s\n", cstr);
341       }
342       return true;
343     }
344   }
345 }
346 
347 
ReportException(v8::Isolate * isolate,v8::TryCatch * try_catch)348 void ReportException(v8::Isolate* isolate, v8::TryCatch* try_catch) {
349   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   if (message.IsEmpty()) {
354     // V8 didn't provide any extra information about this error; just
355     // print the exception.
356     fprintf(stderr, "%s\n", exception_string);
357   } else {
358     // Print (filename):(line number): (message).
359     v8::String::Utf8Value filename(isolate,
360                                    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     v8::Local<v8::Value> stack_trace_string;
381     if (try_catch->StackTrace(context).ToLocal(&stack_trace_string) &&
382         stack_trace_string->IsString() &&
383         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 }
390