src/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 Value;
  46 template <class T> class Handle;
  47 }
  48
  49 namespace WebCore { class DOMFileSystem; }
  50
  51 namespace blink {
  52
  53 class WebDOMFileSystem {
  54 public:
  55     enum SerializableType {
  56         SerializableTypeSerializable,
  57         SerializableTypeNotSerializable,
  58     };
  59     enum EntryType {
  60         EntryTypeFile,
  61         EntryTypeDirectory,
  62     };
  63
  64     ~WebDOMFileSystem() { reset(); }
  65
  66     WebDOMFileSystem() { }
  67     WebDOMFileSystem(const WebDOMFileSystem& d) { assign(d); }
  68     WebDOMFileSystem& operator=(const WebDOMFileSystem& d)
  69     {
  70         assign(d);
  71         return *this;
  72     }
  73
  74     BLINK_EXPORT static WebDOMFileSystem fromV8Value(v8::Handle<v8::Value>);
  75
  76     // FIXME: Deprecate the last argument when all filesystems become
  77     // serializable.
  78     BLINK_EXPORT static WebDOMFileSystem create(
  79         WebLocalFrame*,
  80         WebFileSystemType,
  81         const WebString& name,
  82         const WebURL& rootURL,
  83         SerializableType = SerializableTypeNotSerializable);
  84
  85     BLINK_EXPORT void reset();
  86     BLINK_EXPORT void assign(const WebDOMFileSystem&);
  87
  88     BLINK_EXPORT WebString name() const;
  89     BLINK_EXPORT WebFileSystem::Type type() const;
  90     BLINK_EXPORT WebURL rootURL() const;
  91
  92     BLINK_EXPORT v8::Handle<v8::Value> toV8Value();
  93     BLINK_EXPORT v8::Handle<v8::Value> createV8Entry(
  94         const WebString& path,
  95         EntryType);
  96
  97     bool isNull() const { return m_private.isNull(); }
  98
  99 #if BLINK_IMPLEMENTATION
 100     WebDOMFileSystem(const PassRefPtrWillBeRawPtr<WebCore::DOMFileSystem>&);
 101     WebDOMFileSystem& operator=(const PassRefPtrWillBeRawPtr<WebCore::DOMFileSystem>&);
 102 #endif
 103
 104 private:
 105     WebPrivatePtr<WebCore::DOMFileSystem> m_private;
 106 };
 107
 108 } // namespace blink
 109
 110 #endif // WebDOMFileSystem_h