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 NamedFlow_h
31#define NamedFlow_h
32
33#include "bindings/v8/ScriptWrappable.h"
34#include "core/dom/EventTarget.h"
35#include "wtf/RefCounted.h"
36#include "wtf/RefPtr.h"
37#include "wtf/text/AtomicString.h"
38
39namespace WebCore {
40
41class Document;
42class NamedFlowCollection;
43class Node;
44class NodeList;
45class RenderNamedFlowThread;
46class ScriptExecutionContext;
47
48class NamedFlow : public RefCounted<NamedFlow>, public ScriptWrappable, public EventTarget {
49public:
50    static PassRefPtr<NamedFlow> create(PassRefPtr<NamedFlowCollection> manager, const AtomicString& flowThreadName);
51
52    ~NamedFlow();
53
54    const AtomicString& name() const;
55    bool overset() const;
56    int firstEmptyRegionIndex() const;
57    PassRefPtr<NodeList> getRegionsByContent(Node*);
58    PassRefPtr<NodeList> getRegions();
59    PassRefPtr<NodeList> getContent();
60
61    using RefCounted<NamedFlow>::ref;
62    using RefCounted<NamedFlow>::deref;
63
64    virtual const AtomicString& interfaceName() const;
65    virtual ScriptExecutionContext* scriptExecutionContext() const;
66
67    // This function is called from the JS binding code to determine if the NamedFlow object is reachable or not.
68    // If the object has listeners, the object should only be discarded if the parent Document is not reachable.
69    Node* ownerNode() const;
70
71    void setRenderer(RenderNamedFlowThread* parentFlowThread);
72
73    enum FlowState {
74        FlowStateCreated,
75        FlowStateNull
76    };
77
78    FlowState flowState() const { return m_parentFlowThread ? FlowStateCreated : FlowStateNull; }
79
80    void dispatchRegionLayoutUpdateEvent();
81    void dispatchRegionOversetChangeEvent();
82
83private:
84    NamedFlow(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