Home | History | Annotate | Download | only in pepper
      1 // Copyright (c) 2013 The Chromium Authors. All rights reserved.
      2 // Use of this source code is governed by a BSD-style license that can be
      3 // found in the LICENSE file.
      4 
      5 #ifndef CONTENT_RENDERER_PEPPER_V8_VAR_CONVERTER_H
      6 #define CONTENT_RENDERER_PEPPER_V8_VAR_CONVERTER_H
      7 
      8 #include "base/basictypes.h"
      9 #include "base/callback.h"
     10 #include "base/compiler_specific.h"
     11 #include "base/message_loop/message_loop_proxy.h"
     12 #include "ppapi/c/pp_instance.h"
     13 #include "ppapi/c/pp_var.h"
     14 #include "ppapi/shared_impl/scoped_pp_var.h"
     15 #include "v8/include/v8.h"
     16 #include "content/common/content_export.h"
     17 
     18 namespace content {
     19 
     20 class ResourceConverter;
     21 
     22 class CONTENT_EXPORT V8VarConverter {
     23  public:
     24   // Whether or not to allow converting object vars. If they are not allowed
     25   // and they are passed in, conversion will fail.
     26   enum AllowObjectVars {
     27     kDisallowObjectVars,
     28     kAllowObjectVars
     29   };
     30   explicit V8VarConverter(PP_Instance instance);
     31   V8VarConverter(PP_Instance instance, AllowObjectVars object_vars_allowed);
     32 
     33   // Constructor for testing.
     34   V8VarConverter(PP_Instance instance,
     35                  scoped_ptr<ResourceConverter> resource_converter);
     36   ~V8VarConverter();
     37 
     38   // Converts the given PP_Var to a v8::Value. True is returned upon success.
     39   bool ToV8Value(const PP_Var& var,
     40                  v8::Handle<v8::Context> context,
     41                  v8::Handle<v8::Value>* result);
     42 
     43   struct VarResult {
     44    public:
     45     VarResult() : completed_synchronously(false), success(false) {}
     46 
     47     // True if the conversion completed synchronously and the callback will not
     48     // be called.
     49     bool completed_synchronously;
     50 
     51     // True if the conversion was successful. Only valid if
     52     // |completed_synchronously| is true.
     53     bool success;
     54 
     55     // The result if the conversion was successful. Only valid if
     56     // |completed_synchronously| and |success| are true.
     57     ppapi::ScopedPPVar var;
     58   };
     59 
     60   // Converts the given v8::Value to a PP_Var. Every PP_Var in the reference
     61   // graph in the result will have a refcount equal to the number of references
     62   // to it in the graph. The root of the result will have one additional
     63   // reference. The callback is run when conversion is complete with the
     64   // resulting var and a bool indicating success or failure. Conversion may be
     65   // asynchronous because converting some resources may result in communication
     66   // across IPC. |context| is guaranteed to only be used synchronously. If
     67   // the conversion can occur synchronously, |callback| will not be run,
     68   // otherwise it will be run.
     69   VarResult FromV8Value(
     70       v8::Handle<v8::Value> val,
     71       v8::Handle<v8::Context> context,
     72       const base::Callback<void(const ppapi::ScopedPPVar&, bool)>& callback);
     73   bool FromV8ValueSync(v8::Handle<v8::Value> val,
     74                        v8::Handle<v8::Context> context,
     75                        ppapi::ScopedPPVar* result_var);
     76  private:
     77   // Returns true on success, false on failure.
     78   bool FromV8ValueInternal(v8::Handle<v8::Value> val,
     79                            v8::Handle<v8::Context> context,
     80                            ppapi::ScopedPPVar* result_var);
     81 
     82   PP_Instance instance_;
     83 
     84   // Whether or not to support conversion to PP_VARTYPE_OBJECT.
     85   AllowObjectVars object_vars_allowed_;
     86 
     87   // The message loop to run the callback to |FromV8Value| from.
     88   scoped_refptr<base::MessageLoopProxy> message_loop_proxy_;
     89 
     90   // The converter to use for converting V8 vars to resources.
     91   scoped_ptr<ResourceConverter> resource_converter_;
     92 
     93   DISALLOW_COPY_AND_ASSIGN(V8VarConverter);
     94 };
     95 
     96 }  // namespace content
     97 
     98 #endif  // CONTENT_RENDERER_PEPPER_V8_VAR_CONVERTER_H
     99