1/*
2 * Copyright (C) 2016 Apple Inc. 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 * 1. Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 *
13 * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR
17 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24 */
25
26#pragma once
27
28#include "DisplayListItems.h"
29#include <wtf/FastMalloc.h>
30#include <wtf/Noncopyable.h>
31#include <wtf/text/WTFString.h>
32
33namespace WTF {
34class TextStream;
35}
36
37namespace WebCore {
38
39class FloatRect;
40class GraphicsContext;
41
42namespace DisplayList {
43
44class Item;
45
46enum AsTextFlag {
47 None = 0,
48 IncludesPlatformOperations = 1 << 0,
49};
50
51typedef unsigned AsTextFlags;
52
53class DisplayList {
54 WTF_MAKE_NONCOPYABLE(DisplayList); WTF_MAKE_FAST_ALLOCATED;
55 friend class Recorder;
56 friend class Replayer;
57public:
58 DisplayList() = default;
59 DisplayList(DisplayList&&) = default;
60
61 DisplayList& operator=(DisplayList&&) = default;
62
63 void dump(WTF::TextStream&) const;
64
65 const Vector<Ref<Item>>& list() const { return m_list; }
66 Item& itemAt(size_t index)
67 {
68 ASSERT(index < m_list.size());
69 return m_list[index].get();
70 }
71
72 void clear();
73 void removeItemsFromIndex(size_t);
74
75 size_t itemCount() const { return m_list.size(); }
76 size_t sizeInBytes() const;
77
78 String asText(AsTextFlags) const;
79
80#if !defined(NDEBUG) || !LOG_DISABLED
81 WTF::CString description() const;
82 void dump() const;
83#endif
84
85private:
86 Item& append(Ref<Item>&& item)
87 {
88 m_list.append(WTFMove(item));
89 return m_list.last().get();
90 }
91
92 // Less efficient append, only used for tracking replay.
93 void appendItem(Item& item)
94 {
95 m_list.append(item);
96 }
97
98 static bool shouldDumpForFlags(AsTextFlags, const Item&);
99
100 Vector<Ref<Item>>& list() { return m_list; }
101
102 Vector<Ref<Item>> m_list;
103};
104
105} // DisplayList
106
107WTF::TextStream& operator<<(WTF::TextStream&, const DisplayList::DisplayList&);
108
109} // WebCore
110
111using WebCore::DisplayList::DisplayList;
112
113