third_party/WebKit/public/web/WebDOMFileSystem.h

   1 /*
   2  * Copyright (C) 2013 Google Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met:
   7  *
   8  *     * Redistributions of source code must retain the above copyright
   9  * notice, this list of conditions and the following disclaimer.
  10  *     * Redistributions in binary form must reproduce the above
  11  * copyright notice, this list of conditions and the following disclaimer
  12  * in the documentation and/or other materials provided with the
  13  * distribution.
  14  *     * Neither the name of Google Inc. nor the names of its
  15  * contributors may be used to endorse or promote products derived from
  16  * this software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29  */
  30 #ifndef WebDOMFileSystem_h
  31 #define WebDOMFileSystem_h
  32
  33 #include "../platform/WebCommon.h"
  34 #include "../platform/WebFileSystem.h"
  35 #include "../platform/WebPrivatePtr.h"
  36 #include "../platform/WebString.h"
  37 #include "../platform/WebURL.h"
  38 #include "WebFrame.h"
  39
  40 #if BLINK_IMPLEMENTATION
  41 #include "platform/heap/Handle.h"
  42 #endif
  43
  44 namespace v8 {
  45 class Isolate;
  46 class Object;
  47 class Value;
  48 template <class T> class Local;
  49 }
  50
  51 namespace blink {
  52
  53 class DOMFileSystem;
  54
  55 class WebDOMFileSystem {
  56 public:
  57     enum SerializableType {
  58         SerializableTypeSerializable,
  59         SerializableTypeNotSerializable,
  60     };
  61     enum EntryType {
  62         EntryTypeFile,
  63         EntryTypeDirectory,
  64     };
  65
  66     ~WebDOMFileSystem() { reset(); }
  67
  68     WebDOMFileSystem() { }
  69     WebDOMFileSystem(const WebDOMFileSystem& d) { assign(d); }
  70     WebDOMFileSystem& operator=(const WebDOMFileSystem& d)
  71     {
  72         assign(d);
  73         return *this;
  74     }
  75
  76     BLINK_EXPORT static WebDOMFileSystem fromV8Value(v8::Local<v8::Value>);
  77     // Create file system URL from the given entry.
  78     BLINK_EXPORT static WebURL createFileSystemURL(v8::Local<v8::Value> entry);
  79
  80     // FIXME: Deprecate the last argument when all filesystems become
  81     // serializable.
  82     BLINK_EXPORT static WebDOMFileSystem create(
  83         WebLocalFrame*,
  84         WebFileSystemType,
  85         const WebString& name,
  86         const WebURL& rootURL,
  87         SerializableType = SerializableTypeNotSerializable);
  88
  89     BLINK_EXPORT void reset();
  90     BLINK_EXPORT void assign(const WebDOMFileSystem&);
  91
  92     BLINK_EXPORT WebString name() const;
  93     BLINK_EXPORT WebFileSystem::Type type() const;
  94     BLINK_EXPORT WebURL rootURL() const;
  95
  96     BLINK_EXPORT v8::Local<v8::Value> toV8Value(v8::Local<v8::Object> creationContext, v8::Isolate*);
  97     BLINK_EXPORT v8::Local<v8::Value> createV8Entry(
  98         const WebString& path,
  99         EntryType,
 100         v8::Local<v8::Object> creationContext, v8::Isolate*);
 101
 102     bool isNull() const { return m_private.isNull(); }
 103
 104 #if BLINK_IMPLEMENTATION
 105     WebDOMFileSystem(DOMFileSystem*);
 106     WebDOMFileSystem& operator=(DOMFileSystem*);
 107 #endif
 108
 109 private:
 110     WebPrivatePtr<DOMFileSystem> m_private;
 111 };
 112
 113 } // namespace blink
 114
 115 #endif // WebDOMFileSystem_h