2011-02-04 Daniel Cheng <dcheng@chromium.org>
[WebKit.git] / Source / WebCore / platform / chromium / ReadableDataObject.h
1 /*
2  * Copyright (c) 2010 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 ReadableDataObject_h
32 #define ReadableDataObject_h
33
34 #include "Clipboard.h"
35 #include "PlatformString.h"
36 #include <wtf/HashSet.h>
37 #include <wtf/RefCounted.h>
38 #include <wtf/RefPtr.h>
39 #include <wtf/text/StringHash.h>
40
41 namespace WebCore {
42
43 // Used for one way communication of drag/drop and copy/paste data from the
44 // browser to the renderer.
45 class ReadableDataObject : public RefCounted<ReadableDataObject> {
46 public:
47     static PassRefPtr<ReadableDataObject> create(const Frame*, Clipboard::ClipboardType);
48
49     bool hasData() const;
50     HashSet<String> types() const;
51     String getData(const String& type, bool& succeeded) const;
52
53     String urlTitle() const;
54     KURL htmlBaseUrl() const;
55
56     bool containsFilenames() const;
57     Vector<String> filenames() const;
58
59 private:
60     explicit ReadableDataObject(const Frame*, Clipboard::ClipboardType);
61
62     // This isn't always const... but most of the time it is.
63     void ensureTypeCacheInitialized() const;
64
65     // The owner frame. Used to send IPCs back to the correspdonging view via WebFrameClient.
66     const Frame* m_frame;
67
68     Clipboard::ClipboardType m_clipboardType;
69
70     // To avoid making a lot of IPC calls for each drag event, we cache some
71     // values in the renderer.
72     mutable HashSet<String> m_types;
73     mutable bool m_containsFilenames;
74     mutable bool m_isTypeCacheInitialized;
75 };
76
77 } // namespace WebCore
78
79 #endif