Add a preference to prevent "user-scalable=no" from having any effect
[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 #ifndef ViewportConfiguration_h
27 #define ViewportConfiguration_h
28
29 #include "FloatSize.h"
30 #include "IntSize.h"
31 #include "ViewportArguments.h"
32 #include <wtf/Noncopyable.h>
33
34 namespace WebCore {
35
36 class ViewportConfiguration {
37     WTF_MAKE_NONCOPYABLE(ViewportConfiguration); WTF_MAKE_FAST_ALLOCATED;
38 public:
39     // FIXME: unify with ViewportArguments.
40     struct Parameters {
41         Parameters()
42             : width(0)
43             , height(0)
44             , initialScale(0)
45             , minimumScale(0)
46             , maximumScale(0)
47             , allowsUserScaling(false)
48             , widthIsSet(false)
49             , heightIsSet(false)
50             , initialScaleIsSet(false)
51         {
52         }
53
54         double width;
55         double height;
56         double initialScale;
57         double minimumScale;
58         double maximumScale;
59         bool allowsUserScaling;
60
61         bool widthIsSet;
62         bool heightIsSet;
63         bool initialScaleIsSet;
64     };
65
66     WEBCORE_EXPORT ViewportConfiguration();
67
68     const Parameters& defaultConfiguration() const { return m_defaultConfiguration; }
69     WEBCORE_EXPORT void setDefaultConfiguration(const Parameters&);
70
71     const IntSize& contentsSize() const { return m_contentSize; }
72     WEBCORE_EXPORT void setContentsSize(const IntSize&);
73
74     const FloatSize& minimumLayoutSize() const { return m_minimumLayoutSize; }
75     WEBCORE_EXPORT void setMinimumLayoutSize(const FloatSize&);
76
77     const ViewportArguments& viewportArguments() const { return m_viewportArguments; }
78     WEBCORE_EXPORT void setViewportArguments(const ViewportArguments&);
79
80     void setCanIgnoreScalingConstraints(bool canIgnoreScalingConstraints) { m_canIgnoreScalingConstraints = canIgnoreScalingConstraints; }
81     void setForceAlwaysUserScalable(bool forceAlwaysUserScalable) { m_forceAlwaysUserScalable = forceAlwaysUserScalable; }
82
83     WEBCORE_EXPORT IntSize layoutSize() const;
84     WEBCORE_EXPORT double initialScale() const;
85     WEBCORE_EXPORT double minimumScale() const;
86     double maximumScale() const { return m_configuration.maximumScale; }
87     WEBCORE_EXPORT bool allowsUserScaling() const;
88
89     WEBCORE_EXPORT static Parameters webpageParameters();
90     WEBCORE_EXPORT static Parameters textDocumentParameters();
91     WEBCORE_EXPORT static Parameters imageDocumentParameters();
92     WEBCORE_EXPORT static Parameters xhtmlMobileParameters();
93     WEBCORE_EXPORT static Parameters testingParameters();
94     
95 #ifndef NDEBUG
96     WTF::CString description() const;
97     void dump() const;
98 #endif
99     
100 private:
101     void updateConfiguration();
102     double viewportArgumentsLength(double length) const;
103     int layoutWidth() const;
104     int layoutHeight() const;
105
106     bool shouldIgnoreScalingConstraints() const;
107     bool shouldIgnoreVerticalScalingConstraints() const;
108     bool shouldIgnoreHorizontalScalingConstraints() const;
109
110     Parameters m_configuration;
111     Parameters m_defaultConfiguration;
112     IntSize m_contentSize;
113     FloatSize m_minimumLayoutSize;
114     ViewportArguments m_viewportArguments;
115
116     bool m_canIgnoreScalingConstraints;
117     bool m_forceAlwaysUserScalable;
118 };
119
120 } // namespace WebCore
121
122 #endif // ViewportConfiguration_h