Part 2 of removing PlatformString.h, remove PlatformString.h
[WebKit-https.git] / Source / WebCore / bindings / v8 / Dictionary.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
6  * are met:
7  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer.
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
16  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
17  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
18  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
19  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
20  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
21  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef Dictionary_h
27 #define Dictionary_h
28
29 #include "EventListener.h"
30 #include "MessagePort.h"
31 #include "ScriptValue.h"
32 #include <v8.h>
33 #include <wtf/HashMap.h>
34 #include <wtf/HashSet.h>
35 #include <wtf/Vector.h>
36 #include <wtf/text/AtomicString.h>
37 #include <wtf/text/WTFString.h>
38
39 namespace WebCore {
40
41 class ArrayValue;
42 class DOMWindow;
43 class IDBKeyRange;
44 class MediaKeyError;
45 class Notification;
46 class SpeechRecognitionError;
47 class SpeechRecognitionResult;
48 class SpeechRecognitionResultList;
49 class Storage;
50 class TrackBase;
51
52 class Dictionary {
53 public:
54     Dictionary();
55     Dictionary(const v8::Local<v8::Value>& options, v8::Isolate*);
56     ~Dictionary();
57
58     Dictionary& operator=(const Dictionary&);
59
60     bool isObject() const;
61     bool isUndefinedOrNull() const;
62
63     bool get(const String&, bool&) const;
64     bool get(const String&, int32_t&) const;
65     bool get(const String&, double&) const;
66     bool get(const String&, String&) const;
67     bool get(const String&, ScriptValue&) const;
68     bool get(const String&, short&) const;
69     bool get(const String&, unsigned short&) const;
70     bool get(const String&, unsigned&) const;
71     bool get(const String&, unsigned long long&) const;
72     bool get(const String&, RefPtr<DOMWindow>&) const;
73     bool get(const String&, RefPtr<Storage>&) const;
74     bool get(const String&, MessagePortArray&) const;
75     bool get(const String&, RefPtr<Uint8Array>&) const;
76 #if ENABLE(ENCRYPTED_MEDIA)
77     bool get(const String&, RefPtr<MediaKeyError>&) const;
78 #endif
79 #if ENABLE(VIDEO_TRACK)
80     bool get(const String&, RefPtr<TrackBase>&) const;
81 #endif
82 #if ENABLE(SCRIPTED_SPEECH)
83     bool get(const String&, RefPtr<SpeechRecognitionError>&) const;
84     bool get(const String&, RefPtr<SpeechRecognitionResult>&) const;
85     bool get(const String&, RefPtr<SpeechRecognitionResultList>&) const;
86 #endif
87     bool get(const String&, HashSet<AtomicString>&) const;
88     bool get(const String&, Dictionary&) const;
89     bool get(const String&, Vector<String>&) const;
90     bool get(const String&, ArrayValue&) const;
91
92     bool getOwnPropertiesAsStringHashMap(HashMap<String, String>&) const;
93     bool getOwnPropertyNames(Vector<String>&) const;
94
95     bool getWithUndefinedOrNullCheck(const String&, String&) const;
96
97     PassRefPtr<EventListener> getEventListener(const String&, Notification*) const { return 0; }
98
99 private:
100     bool getKey(const String& key, v8::Local<v8::Value>&) const;
101
102     // This object can only be used safely when stack allocated because of v8::Local.
103     static void* operator new(size_t);
104     static void* operator new[](size_t);
105     static void operator delete(void *);
106
107     v8::Local<v8::Value> m_options;
108     v8::Isolate* m_isolate;
109 };
110
111 }
112
113 #endif // Dictionary_h