f214d0b3f92e16bd377bb6888dcbbad234608b89
[WebKit-https.git] / Source / WebCore / dom / NamedFlowCollection.h
1 /*
2  * Copyright (C) 2012 Adobe Systems Incorporated. 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
9  *    copyright notice, this list of conditions and the following
10  *    disclaimer.
11  * 2. Redistributions in binary form must reproduce the above
12  *    copyright notice, this list of conditions and the following
13  *    disclaimer in the documentation and/or other materials
14  *    provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER "AS IS" AND ANY
17  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
19  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE
20  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
21  * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
22  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
23  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
25  * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
26  * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  */
29
30 #ifndef NamedFlowCollection_h
31 #define NamedFlowCollection_h
32
33 #include "WebKitNamedFlow.h"
34 #include <wtf/Forward.h>
35 #include <wtf/ListHashSet.h>
36 #include <wtf/PassRefPtr.h>
37 #include <wtf/RefCounted.h>
38 #include <wtf/Vector.h>
39
40 namespace WebCore {
41
42 class Document;
43 class DOMNamedFlowCollection;
44
45 class NamedFlowCollection : public RefCounted<NamedFlowCollection> {
46 public:
47     static PassRefPtr<NamedFlowCollection> create(Document* doc) { return adoptRef(new NamedFlowCollection(doc)); }
48
49     Vector<RefPtr<WebKitNamedFlow> > namedFlows();
50     WebKitNamedFlow* flowByName(const String&);
51     PassRefPtr<WebKitNamedFlow> ensureFlowWithName(const String&);
52
53     void discardNamedFlow(WebKitNamedFlow*);
54
55     void documentDestroyed();
56
57     Document* document() const { return m_document; }
58
59     virtual ~NamedFlowCollection() { }
60
61     PassRefPtr<DOMNamedFlowCollection> createCSSOMSnapshot();
62
63 private:
64     struct NamedFlowHashFunctions;
65     struct NamedFlowHashTranslator;
66
67     typedef ListHashSet<WebKitNamedFlow*, 1, NamedFlowHashFunctions> NamedFlowSet;
68
69     explicit NamedFlowCollection(Document*);
70
71     Document* m_document;
72     NamedFlowSet m_namedFlows;
73 };
74
75 } // namespace WebCore
76
77 #endif // NamedFlowCollection_h