HTTPHeaderMap should not derive from HashMap
[WebKit-https.git] / Source / WebCore / platform / network / HTTPHeaderMap.h
1 /*
2  * Copyright (C) 2006 Apple Inc.  All rights reserved.
3  * Copyright (C) 2009 Google Inc. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
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 INC. ``AS IS'' AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
25  */
26
27 #ifndef HTTPHeaderMap_h
28 #define HTTPHeaderMap_h
29
30 #include <utility>
31 #include <wtf/HashMap.h>
32 #include <wtf/Vector.h>
33 #include <wtf/text/AtomicString.h>
34 #include <wtf/text/AtomicStringHash.h>
35 #include <wtf/text/StringHash.h>
36
37 namespace WebCore {
38
39 typedef Vector<std::pair<String, String>> CrossThreadHTTPHeaderMapData;
40
41 // FIXME: Not every header fits into a map. Notably, multiple Set-Cookie header fields are needed to set multiple cookies.
42
43 class HTTPHeaderMap {
44     typedef HashMap<AtomicString, String, CaseFoldingHash> HashMapType;
45 public:
46     typedef HashMapType::const_iterator const_iterator;
47     typedef HashMapType::iterator iterator;
48     typedef HashMapType::AddResult AddResult;
49
50     HTTPHeaderMap();
51     ~HTTPHeaderMap();
52
53     // Gets a copy of the data suitable for passing to another thread.
54     std::unique_ptr<CrossThreadHTTPHeaderMapData> copyData() const;
55     void adopt(std::unique_ptr<CrossThreadHTTPHeaderMapData>);
56
57     bool isEmpty() const { return m_headers.isEmpty(); }
58     int size() const { return m_headers.size(); }
59
60     void clear() { m_headers.clear(); }
61
62     String get(const AtomicString& name) const;
63
64     AddResult set(const AtomicString& name, const String& value);
65     AddResult add(const AtomicString& name, const String& value);
66
67     // Alternate accessors that are faster than converting the char* to AtomicString first.
68     bool contains(const char*) const;
69     String get(const char*) const;
70     const_iterator find(const char*) const;
71     iterator find(const char*);
72     AddResult add(const char* name, const String& value);
73
74     void remove(const char*);
75     void remove(iterator);
76
77     const_iterator begin() const { return m_headers.begin(); }
78     const_iterator end() const { return m_headers.end(); }
79
80     WTF::IteratorRange<const_iterator::Keys> keys() const;
81
82     friend bool operator==(const HTTPHeaderMap& a, const HTTPHeaderMap& b)
83     {
84         return a.m_headers == b.m_headers;
85     }
86
87     friend bool operator!=(const HTTPHeaderMap& a, const HTTPHeaderMap& b)
88     {
89         return !(a == b);
90     }
91
92 private:
93     HashMap<AtomicString, String, CaseFoldingHash> m_headers;
94 };
95
96 } // namespace WebCore
97
98 #endif // HTTPHeaderMap_h