content/public/renderer/v8_value_converter.h

   1 // Copyright (c) 2012 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_PUBLIC_RENDERER_V8_VALUE_CONVERTER_H_
   6 #define CONTENT_PUBLIC_RENDERER_V8_VALUE_CONVERTER_H_
   7
   8 #include "content/common/content_export.h"
   9 #include "v8/include/v8.h"
  10
  11 namespace base {
  12 class Value;
  13 }
  14
  15 namespace content {
  16
  17 // Converts between v8::Value (JavaScript values in the v8 heap) and Chrome's
  18 // values (from base/values.h). Lists and dictionaries are converted
  19 // recursively.
  20 //
  21 // The JSON types (null, boolean, string, number, array, and object) as well as
  22 // binary values are supported. For binary values, we convert to WebKit
  23 // ArrayBuffers, and support converting from an ArrayBuffer or any of the
  24 // ArrayBufferView subclasses (Uint8Array, etc.).
  25 class CONTENT_EXPORT V8ValueConverter {
  26  public:
  27   static V8ValueConverter* create();
  28
  29   virtual ~V8ValueConverter() {}
  30
  31   // If true, Date objects are converted into DoubleValues with the number of
  32   // seconds since Unix epoch.
  33   //
  34   // Otherwise they are converted into DictionaryValues with whatever additional
  35   // properties has been set on them.
  36   virtual void SetDateAllowed(bool val) = 0;
  37
  38   // If true, RegExp objects are converted into StringValues with the regular
  39   // expression between / and /, for example "/ab?c/".
  40   //
  41   // Otherwise they are converted into DictionaryValues with whatever additional
  42   // properties has been set on them.
  43   virtual void SetRegExpAllowed(bool val) = 0;
  44
  45   // If true, Function objects are converted into DictionaryValues with whatever
  46   // additional properties has been set on them.
  47   //
  48   // Otherwise they are treated as unsupported, see FromV8Value.
  49   virtual void SetFunctionAllowed(bool val) = 0;
  50
  51   // If true, null values are stripped from objects. This is often useful when
  52   // converting arguments to extension APIs.
  53   virtual void SetStripNullFromObjects(bool val) = 0;
  54
  55   // Converts a base::Value to a v8::Value.
  56   //
  57   // Unsupported types are replaced with null.  If an array or object throws
  58   // while setting a value, that property or item is skipped, leaving a hole in
  59   // the case of arrays.
  60   virtual v8::Handle<v8::Value> ToV8Value(
  61       const base::Value* value,
  62       v8::Handle<v8::Context> context) const = 0;
  63
  64   // Converts a v8::Value to base::Value.
  65   //
  66   // Unsupported types (unless explicitly configured) are not converted, so
  67   // this method may return NULL -- the exception is when converting arrays,
  68   // where unsupported types are converted to Value(TYPE_NULL).
  69   //
  70   // Likewise, if an object throws while converting a property it will not be
  71   // converted, whereas if an array throws while converting an item it will be
  72   // converted to Value(TYPE_NULL).
  73   virtual base::Value* FromV8Value(v8::Handle<v8::Value> value,
  74                                    v8::Handle<v8::Context> context) const = 0;
  75 };
  76
  77 }  // namespace content
  78
  79 #endif  // CONTENT_PUBLIC_RENDERER_V8_VALUE_CONVERTER_H_