Rename OptionsObject to Dictionary
[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 "MessagePort.h"
30 #include "PlatformString.h"
31 #include "ScriptValue.h"
32 #include <v8.h>
33 #include <wtf/HashSet.h>
34 #include <wtf/text/AtomicString.h>
35
36 namespace WebCore {
37
38 class DOMStringList;
39 class DOMWindow;
40 class IDBKeyRange;
41 class Storage;
42 class TrackBase;
43 class SpeechRecognitionError;
44 class SpeechRecognitionResult;
45 class SpeechRecognitionResultList;
46
47 class Dictionary {
48 public:
49     Dictionary();
50     Dictionary(const v8::Local<v8::Value>& options);
51     ~Dictionary();
52
53     Dictionary& operator=(const Dictionary&);
54
55     bool isObject() const;
56     bool isUndefinedOrNull() const;
57
58     bool get(const String&, bool&) const;
59     bool get(const String&, int32_t&) const;
60     bool get(const String&, double&) const;
61     bool get(const String&, String&) const;
62     bool get(const String&, ScriptValue&) const;
63     bool get(const String&, short&) const;
64     bool get(const String&, unsigned short&) const;
65     bool get(const String&, unsigned&) const;
66     bool get(const String&, unsigned long long&) const;
67     bool get(const String&, RefPtr<DOMWindow>&) const;
68     bool get(const String&, RefPtr<Storage>&) const;
69     bool get(const String&, MessagePortArray&) const;
70 #if ENABLE(VIDEO_TRACK)
71     bool get(const String&, RefPtr<TrackBase>&) const;
72 #endif
73 #if ENABLE(SCRIPTED_SPEECH)
74     bool get(const String&, RefPtr<SpeechRecognitionError>&) const;
75     bool get(const String&, RefPtr<SpeechRecognitionResult>&) const;
76     bool get(const String&, RefPtr<SpeechRecognitionResultList>&) const;
77 #endif
78     bool get(const String&, HashSet<AtomicString>&) const;
79
80     bool getWithUndefinedOrNullCheck(const String&, String&) const;
81
82 private:
83     bool getKey(const String& key, v8::Local<v8::Value>&) const;
84
85     // This object can only be used safely when stack allocated because of v8::Local.
86     static void* operator new(size_t);
87     static void* operator new[](size_t);
88     static void operator delete(void *);
89
90     v8::Local<v8::Value> m_options;
91 };
92
93 }
94
95 #endif // Dictionary_h