f028c9b0a4d655eca6870d3e283ea7c1ce2e754d
[WebKit-https.git] / Source / WebCore / page / ViewportConfiguration.h
1 /*
2  * Copyright (C) 2005-2014 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. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #include "FloatSize.h"
29 #include "IntSize.h"
30 #include "ViewportArguments.h"
31 #include <wtf/Noncopyable.h>
32
33 namespace WTF {
34 class TextStream;
35 }
36
37 namespace WebCore {
38
39 static const double forceAlwaysUserScalableMaximumScale = 5.0;
40 static const double forceAlwaysUserScalableMinimumScale = 1.0;
41
42 class ViewportConfiguration {
43     WTF_MAKE_NONCOPYABLE(ViewportConfiguration); WTF_MAKE_FAST_ALLOCATED;
44 public:
45     // FIXME: unify with ViewportArguments.
46     struct Parameters {
47         double width { 0 };
48         double height { 0 };
49         double initialScale { 0 };
50         double minimumScale { 0 };
51         double maximumScale { 0 };
52         bool allowsUserScaling { false };
53         bool allowsShrinkToFit { false };
54         bool avoidsUnsafeArea { true };
55
56         bool widthIsSet { false };
57         bool heightIsSet { false };
58         bool initialScaleIsSet { false };
59
60         bool operator==(const Parameters& other) const
61         {
62             return width == other.width && height == other.height
63                 && initialScale == other.initialScale && minimumScale == other.minimumScale && maximumScale == other.maximumScale
64                 && allowsUserScaling == other.allowsUserScaling && allowsShrinkToFit == other.allowsShrinkToFit && avoidsUnsafeArea == other.avoidsUnsafeArea
65                 && widthIsSet == other.widthIsSet && heightIsSet == other.heightIsSet && initialScaleIsSet == other.initialScaleIsSet;
66         }
67     };
68
69     WEBCORE_EXPORT ViewportConfiguration();
70
71     const Parameters& defaultConfiguration() const { return m_defaultConfiguration; }
72     WEBCORE_EXPORT void setDefaultConfiguration(const Parameters&);
73
74     const IntSize& contentsSize() const { return m_contentSize; }
75     WEBCORE_EXPORT bool setContentsSize(const IntSize&);
76
77     WEBCORE_EXPORT FloatSize viewSize() const { return m_viewSize; }
78
79     const FloatSize& minimumLayoutSize() const { return m_minimumLayoutSize; }
80     WEBCORE_EXPORT bool setMinimumLayoutSize(const FloatSize&, const FloatSize& viewSize);
81
82     const ViewportArguments& viewportArguments() const { return m_viewportArguments; }
83     WEBCORE_EXPORT bool setViewportArguments(const ViewportArguments&);
84
85     WEBCORE_EXPORT bool setForceHorizontalShrinkToFit(bool);
86
87     WEBCORE_EXPORT bool setCanIgnoreScalingConstraints(bool);
88     void setForceAlwaysUserScalable(bool forceAlwaysUserScalable) { m_forceAlwaysUserScalable = forceAlwaysUserScalable; }
89
90     WEBCORE_EXPORT IntSize layoutSize() const;
91     WEBCORE_EXPORT double initialScale() const;
92     WEBCORE_EXPORT double initialScaleIgnoringContentSize() const;
93     WEBCORE_EXPORT double minimumScale() const;
94     double maximumScale() const { return m_forceAlwaysUserScalable ? forceAlwaysUserScalableMaximumScale : m_configuration.maximumScale; }
95     double maximumScaleIgnoringAlwaysScalable() const { return m_configuration.maximumScale; }
96     WEBCORE_EXPORT bool allowsUserScaling() const;
97     WEBCORE_EXPORT bool allowsUserScalingIgnoringAlwaysScalable() const;
98     bool allowsShrinkToFit() const;
99     bool avoidsUnsafeArea() const { return m_configuration.avoidsUnsafeArea; }
100
101     WEBCORE_EXPORT static Parameters webpageParameters();
102     WEBCORE_EXPORT static Parameters textDocumentParameters();
103     WEBCORE_EXPORT static Parameters imageDocumentParameters();
104     WEBCORE_EXPORT static Parameters xhtmlMobileParameters();
105     WEBCORE_EXPORT static Parameters testingParameters();
106     
107 #ifndef NDEBUG
108     String description() const;
109     WEBCORE_EXPORT void dump() const;
110 #endif
111
112 private:
113     void updateConfiguration();
114     double viewportArgumentsLength(double length) const;
115     double initialScaleFromSize(double width, double height, bool shouldIgnoreScalingConstraints) const;
116     int layoutWidth() const;
117     int layoutHeight() const;
118
119     bool shouldIgnoreScalingConstraints() const;
120     bool shouldIgnoreVerticalScalingConstraints() const;
121     bool shouldIgnoreHorizontalScalingConstraints() const;
122
123     Parameters m_configuration;
124     Parameters m_defaultConfiguration;
125     IntSize m_contentSize;
126     FloatSize m_minimumLayoutSize;
127     FloatSize m_viewSize;
128     ViewportArguments m_viewportArguments;
129
130     bool m_canIgnoreScalingConstraints;
131     bool m_forceAlwaysUserScalable;
132     bool m_forceHorizontalShrinkToFit;
133 };
134
135 WTF::TextStream& operator<<(WTF::TextStream&, const ViewportConfiguration::Parameters&);
136 WTF::TextStream& operator<<(WTF::TextStream&, const ViewportConfiguration&);
137
138 } // namespace WebCore