content/renderer/pepper/v8_var_converter.h

   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   explicit V8VarConverter(PP_Instance instance);
  25   V8VarConverter(PP_Instance instance, bool object_vars_allowed);
  26
  27   // Constructor for testing.
  28   V8VarConverter(PP_Instance instance,
  29                  scoped_ptr<ResourceConverter> resource_converter);
  30   ~V8VarConverter();
  31
  32   // Converts the given PP_Var to a v8::Value. True is returned upon success.
  33   bool ToV8Value(const PP_Var& var,
  34                  v8::Handle<v8::Context> context,
  35                  v8::Handle<v8::Value>* result);
  36
  37   struct VarResult {
  38    public:
  39     VarResult() : completed_synchronously(false), success(false) {}
  40
  41     // True if the conversion completed synchronously and the callback will not
  42     // be called.
  43     bool completed_synchronously;
  44
  45     // True if the conversion was successful. Only valid if
  46     // |completed_synchronously| is true.
  47     bool success;
  48
  49     // The result if the conversion was successful. Only valid if
  50     // |completed_synchronously| and |success| are true.
  51     ppapi::ScopedPPVar var;
  52   };
  53
  54   // Converts the given v8::Value to a PP_Var. Every PP_Var in the reference
  55   // graph in the result will have a refcount equal to the number of references
  56   // to it in the graph. The root of the result will have one additional
  57   // reference. The callback is run when conversion is complete with the
  58   // resulting var and a bool indicating success or failure. Conversion may be
  59   // asynchronous because converting some resources may result in communication
  60   // across IPC. |context| is guaranteed to only be used synchronously. If
  61   // the conversion can occur synchronously, |callback| will not be run,
  62   // otherwise it will be run.
  63   VarResult FromV8Value(
  64       v8::Handle<v8::Value> val,
  65       v8::Handle<v8::Context> context,
  66       const base::Callback<void(const ppapi::ScopedPPVar&, bool)>& callback);
  67   bool FromV8ValueSync(v8::Handle<v8::Value> val,
  68                        v8::Handle<v8::Context> context,
  69                        ppapi::ScopedPPVar* result_var);
  70  private:
  71   // Returns true on success, false on failure.
  72   bool FromV8ValueInternal(v8::Handle<v8::Value> val,
  73                            v8::Handle<v8::Context> context,
  74                            ppapi::ScopedPPVar* result_var);
  75
  76   PP_Instance instance_;
  77
  78   // Whether or not to support conversion to PP_VARTYPE_OBJECT.
  79   bool object_vars_allowed_;
  80
  81   // The message loop to run the callback to |FromV8Value| from.
  82   scoped_refptr<base::MessageLoopProxy> message_loop_proxy_;
  83
  84   // The converter to use for converting V8 vars to resources.
  85   scoped_ptr<ResourceConverter> resource_converter_;
  86
  87   DISALLOW_COPY_AND_ASSIGN(V8VarConverter);
  88 };
  89
  90 }  // namespace content
  91
  92 #endif  // CONTENT_RENDERER_PEPPER_V8_VAR_CONVERTER_H