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