1/*
2 * Copyright (C) 2011 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 WebKitNamedFlow_h
31#define WebKitNamedFlow_h
32
33#include "EventTarget.h"
34
35#include <wtf/ListHashSet.h>
36#include <wtf/RefCounted.h>
37#include <wtf/RefPtr.h>
38#include <wtf/text/AtomicString.h>
39
40namespace WebCore {
41
42class Document;
43class NamedFlowCollection;
44class Node;
45class NodeList;
46class RenderNamedFlowThread;
47class ScriptExecutionContext;
48
49class WebKitNamedFlow : public RefCounted<WebKitNamedFlow>, public EventTarget {
50public:
51    static PassRefPtr<WebKitNamedFlow> create(PassRefPtr<NamedFlowCollection> manager, const AtomicString& flowThreadName);
52
53    ~WebKitNamedFlow();
54
55    const AtomicString& name() const;
56    bool overset() const;
57    int firstEmptyRegionIndex() const;
58    PassRefPtr<NodeList> getRegionsByContent(Node*);
59    PassRefPtr<NodeList> getRegions();
60    PassRefPtr<NodeList> getContent();
61
62    using RefCounted<WebKitNamedFlow>::ref;
63    using RefCounted<WebKitNamedFlow>::deref;
64
65    virtual const AtomicString& interfaceName() const;
66    virtual ScriptExecutionContext* scriptExecutionContext() const;
67
68    // This function is called from the JS binding code to determine if the NamedFlow object is reachable or not.
69    // If the object has listeners, the object should only be discarded if the parent Document is not reachable.
70    Node* ownerNode() const;
71
72    void setRenderer(RenderNamedFlowThread* parentFlowThread);
73
74    enum FlowState {
75        FlowStateCreated,
76        FlowStateNull
77    };
78
79    FlowState flowState() const { return m_parentFlowThread ? FlowStateCreated : FlowStateNull; }
80
81    void dispatchRegionLayoutUpdateEvent();
82
83private:
84    WebKitNamedFlow(PassRefPtr<NamedFlowCollection>, const AtomicString&);
85
86    // EventTarget implementation.
87    virtual void refEventTarget() { ref(); }
88    virtual void derefEventTarget() { deref(); }
89
90    virtual EventTargetData* eventTargetData() OVERRIDE;
91    virtual EventTargetData* ensureEventTargetData() OVERRIDE;
92
93    // The name of the flow thread as specified in CSS.
94    AtomicString m_flowThreadName;
95
96    RefPtr<NamedFlowCollection> m_flowManager;
97    RenderNamedFlowThread* m_parentFlowThread;
98
99    EventTargetData m_eventTargetData;
100};
101
102}
103
104#endif
105