Text Autosizing: prevent oscillation of font sizes during autosizing
[WebKit-https.git] / Source / WebCore / rendering / TextAutosizer.h
1 /*
2  * Copyright (C) 2012 Google 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  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer.
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
16  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
17  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
18  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
19  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
20  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
21  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef TextAutosizer_h
27 #define TextAutosizer_h
28
29 #if ENABLE(TEXT_AUTOSIZING)
30
31 #include "HTMLNames.h"
32 #include <wtf/Noncopyable.h>
33 #include <wtf/PassOwnPtr.h>
34
35 namespace WebCore {
36
37 class Document;
38 class RenderBlock;
39 class RenderObject;
40 class RenderText;
41 struct TextAutosizingWindowInfo;
42 struct TextAutosizingClusterInfo;
43
44 class TextAutosizer {
45     WTF_MAKE_NONCOPYABLE(TextAutosizer);
46
47 public:
48     static PassOwnPtr<TextAutosizer> create(Document* document) { return adoptPtr(new TextAutosizer(document)); }
49
50     virtual ~TextAutosizer();
51
52     bool processSubtree(RenderObject* layoutRoot);
53     void recalculateMultipliers();
54
55     static float computeAutosizedFontSize(float specifiedSize, float multiplier);
56
57 private:
58     enum TraversalDirection {
59         FirstToLast,
60         LastToFirst
61     };
62
63     explicit TextAutosizer(Document*);
64
65     void processClusterInternal(TextAutosizingClusterInfo&, RenderBlock* container, RenderObject* subtreeRoot, const TextAutosizingWindowInfo&, float textWidth, bool shouldBeAutosized);
66     void processCluster(TextAutosizingClusterInfo&, RenderBlock* container, RenderObject* subtreeRoot, const TextAutosizingWindowInfo&);
67     void processCompositeCluster(Vector<TextAutosizingClusterInfo>&, const TextAutosizingWindowInfo&);
68     void processContainer(float multiplier, RenderBlock* container, TextAutosizingClusterInfo&, RenderObject* subtreeRoot, const TextAutosizingWindowInfo&);
69
70     void setMultiplier(RenderObject*, float);
71
72     static bool isAutosizingContainer(const RenderObject*);
73     static bool isNarrowDescendant(const RenderBlock*, TextAutosizingClusterInfo& parentClusterInfo);
74     static bool isWiderDescendant(const RenderBlock*, const TextAutosizingClusterInfo& parentClusterInfo);
75     static bool isIndependentDescendant(const RenderBlock*);
76     static bool isAutosizingCluster(const RenderBlock*, TextAutosizingClusterInfo& parentClusterInfo);
77
78     static bool containerShouldBeAutosized(const RenderBlock* container);
79     static bool containerContainsOneOfTags(const RenderBlock* cluster, const Vector<QualifiedName>& tags);
80     static bool containerIsRowOfLinks(const RenderObject* container);
81     static bool contentHeightIsConstrained(const RenderBlock* container);
82     static bool clusterShouldBeAutosized(TextAutosizingClusterInfo&, float blockWidth);
83     static bool compositeClusterShouldBeAutosized(Vector<TextAutosizingClusterInfo>&, float blockWidth);
84     static void measureDescendantTextWidth(const RenderBlock* container, TextAutosizingClusterInfo&, float minTextWidth, float& textWidth);
85
86     // Use to traverse the tree of descendants, excluding descendants of containers (but returning the containers themselves).
87     static RenderObject* nextInPreOrderSkippingDescendantsOfContainers(const RenderObject*, const RenderObject* stayWithin);
88
89     static const RenderBlock* findDeepestBlockContainingAllText(const RenderBlock* cluster);
90
91     // Depending on the traversal direction specified, finds the first or the last leaf text node child that doesn't
92     // belong to any cluster.
93     static const RenderObject* findFirstTextLeafNotInCluster(const RenderObject*, size_t& depth, TraversalDirection);
94
95     // Returns groups of narrow descendants of a given autosizing cluster. The groups are combined
96     // by the difference between the width of the descendant and the width of the parent cluster's
97     // |blockContainingAllText|.
98     static void getNarrowDescendantsGroupedByWidth(const TextAutosizingClusterInfo& parentClusterInfo, Vector<Vector<TextAutosizingClusterInfo> >&);
99
100     Document* m_document;
101 };
102
103 } // namespace WebCore
104
105 #endif // ENABLE(TEXT_AUTOSIZING)
106
107 #endif // TextAutosizer_h