src/third_party/WebKit/Source/core/dom/DataObjectItem.h

   1 /*
   2  * Copyright (C) 2011 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
  31 #ifndef DataObjectItem_h
  32 #define DataObjectItem_h
  33
  34 #include "core/fileapi/File.h"
  35 #include "platform/SharedBuffer.h"
  36 #include "platform/weborigin/KURL.h"
  37 #include "wtf/RefCounted.h"
  38 #include "wtf/RefPtr.h"
  39 #include "wtf/text/WTFString.h"
  40
  41 namespace WebCore {
  42
  43 class Blob;
  44
  45 class DataObjectItem : public RefCounted<DataObjectItem> {
  46 public:
  47     enum Kind {
  48         StringKind,
  49         FileKind
  50     };
  51
  52     static PassRefPtr<DataObjectItem> createFromString(const String& type, const String& data);
  53     static PassRefPtr<DataObjectItem> createFromFile(PassRefPtr<File>);
  54     static PassRefPtr<DataObjectItem> createFromURL(const String& url, const String& title);
  55     static PassRefPtr<DataObjectItem> createFromHTML(const String& html, const KURL& baseURL);
  56     static PassRefPtr<DataObjectItem> createFromSharedBuffer(const String& filename, PassRefPtr<SharedBuffer>);
  57     static PassRefPtr<DataObjectItem> createFromPasteboard(const String& type, uint64_t sequenceNumber);
  58
  59     Kind kind() const { return m_kind; }
  60     String type() const { return m_type; }
  61     String getAsString() const;
  62     PassRefPtr<Blob> getAsFile() const;
  63
  64     // Used to support legacy DataTransfer APIs and renderer->browser serialization.
  65     PassRefPtr<SharedBuffer> sharedBuffer() const { return m_sharedBuffer; }
  66     String title() const { return m_title; }
  67     KURL baseURL() const { return m_baseURL; }
  68     bool isFilename() const;
  69
  70 private:
  71     enum DataSource {
  72         PasteboardSource,
  73         InternalSource,
  74     };
  75
  76     DataObjectItem(Kind, const String& type);
  77     DataObjectItem(Kind, const String& type, uint64_t sequenceNumber);
  78
  79     DataSource m_source;
  80     Kind m_kind;
  81     String m_type;
  82
  83     String m_data;
  84     RefPtr<File> m_file;
  85     RefPtr<SharedBuffer> m_sharedBuffer;
  86     // Optional metadata. Currently used for URL, HTML, and dragging files in.
  87     String m_title;
  88     KURL m_baseURL;
  89
  90     uint64_t m_sequenceNumber; // Only valid when m_source == PasteboardSource
  91 };
  92
  93 } // namespace WebCore
  94
  95 #endif // DataObjectItem_h