2c0d9c821e43a298e3bcec74a20a687684009684
[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 "ContextDestructionObserver.h"
34 #include "WebKitNamedFlow.h"
35 #include <wtf/Forward.h>
36 #include <wtf/ListHashSet.h>
37 #include <wtf/PassRefPtr.h>
38 #include <wtf/RefCounted.h>
39 #include <wtf/Vector.h>
40
41 namespace WebCore {
42
43 class Document;
44 class DOMNamedFlowCollection;
45
46 class NamedFlowCollection : public RefCounted<NamedFlowCollection>, public ContextDestructionObserver {
47 public:
48     static PassRefPtr<NamedFlowCollection> create(Document* doc) { return adoptRef(new NamedFlowCollection(doc)); }
49
50     Vector<RefPtr<WebKitNamedFlow>> namedFlows();
51     WebKitNamedFlow* flowByName(const String&);
52     PassRef<WebKitNamedFlow> ensureFlowWithName(const String&);
53
54     void discardNamedFlow(WebKitNamedFlow*);
55
56     Document* document() const;
57
58     virtual ~NamedFlowCollection() { }
59
60     PassRefPtr<DOMNamedFlowCollection> createCSSOMSnapshot();
61
62 private:
63     struct NamedFlowHashFunctions;
64     struct NamedFlowHashTranslator;
65
66     typedef ListHashSet<WebKitNamedFlow*, 1, NamedFlowHashFunctions> NamedFlowSet;
67
68     explicit NamedFlowCollection(Document*);
69
70     NamedFlowSet m_namedFlows;
71 };
72
73 } // namespace WebCore
74
75 #endif // NamedFlowCollection_h