Remove support for "desktop-width" in the viewport meta tag
[WebKit-https.git] / Source / WebCore / dom / ViewportArguments.h
1 /*
2  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
3  *           (C) 1999 Antti Koivisto (koivisto@kde.org)
4  *           (C) 2001 Dirk Mueller (mueller@kde.org)
5  *           (C) 2006 Alexey Proskuryakov (ap@webkit.org)
6  * Copyright (C) 2004, 2005, 2006, 2007, 2008 Apple Inc. All rights reserved.
7  * Copyright (C) 2008 Torch Mobile Inc. All rights reserved. (http://www.torchmobile.com/)
8  * Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies)
9  *
10  * This library is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU Library General Public
12  * License as published by the Free Software Foundation; either
13  * version 2 of the License, or (at your option) any later version.
14  *
15  * This library is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
18  * Library General Public License for more details.
19  *
20  * You should have received a copy of the GNU Library General Public License
21  * along with this library; see the file COPYING.LIB.  If not, write to
22  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
23  * Boston, MA 02110-1301, USA.
24  *
25  */
26
27 #ifndef ViewportArguments_h
28 #define ViewportArguments_h
29
30 #include "FloatSize.h"
31 #include <wtf/Forward.h>
32
33 namespace WebCore {
34
35 class Document;
36
37 enum ViewportErrorCode {
38     UnrecognizedViewportArgumentKeyError,
39     UnrecognizedViewportArgumentValueError,
40     TruncatedViewportArgumentValueError,
41     MaximumScaleTooLargeError,
42     TargetDensityDpiUnsupported
43 };
44
45 struct ViewportAttributes {
46     FloatSize layoutSize;
47
48     float initialScale;
49     float minimumScale;
50     float maximumScale;
51
52     float userScalable;
53     bool initiallyFitToViewport;
54 };
55
56 struct ViewportArguments {
57
58     enum Type {
59         // These are ordered in increasing importance.
60         Implicit,
61 #if ENABLE(LEGACY_VIEWPORT_ADAPTION)
62         XHTMLMobileProfile,
63         HandheldFriendlyMeta,
64         MobileOptimizedMeta,
65 #endif
66         ViewportMeta
67     } type;
68
69     enum {
70         ValueAuto = -1,
71         ValueDeviceWidth = -2,
72         ValueDeviceHeight = -3,
73     };
74
75     ViewportArguments(Type type = Implicit)
76         : type(type)
77         , initialScale(ValueAuto)
78         , minimumScale(ValueAuto)
79         , maximumScale(ValueAuto)
80         , width(ValueAuto)
81         , height(ValueAuto)
82         , userScalable(ValueAuto)
83     {
84     }
85
86     float initialScale;
87     float minimumScale;
88     float maximumScale;
89     float width;
90     float height;
91     float userScalable;
92
93     bool operator==(const ViewportArguments& other) const
94     {
95         // Used for figuring out whether to reset the viewport or not,
96         // thus we are not taking type into account.
97         return initialScale == other.initialScale
98             && minimumScale == other.minimumScale
99             && maximumScale == other.maximumScale
100             && width == other.width
101             && height == other.height
102             && userScalable == other.userScalable;
103     }
104
105     bool operator!=(const ViewportArguments& other) const
106     {
107         return !(*this == other);
108     }
109
110     // FIXME: We're going to keep this constant around until all embedders
111     // refactor their code to no longer need it.
112     static const float deprecatedTargetDPI;
113 };
114
115 ViewportAttributes computeViewportAttributes(ViewportArguments args, int desktopWidth, int deviceWidth, int deviceHeight, float devicePixelRatio, IntSize visibleViewport);
116
117 void restrictMinimumScaleFactorToViewportSize(ViewportAttributes& result, IntSize visibleViewport, float devicePixelRatio);
118 void restrictScaleFactorToInitialScaleIfNotUserScalable(ViewportAttributes& result);
119 float computeMinimumScaleFactorForContentContained(const ViewportAttributes& result, const IntSize& viewportSize, const IntSize& contentSize, float devicePixelRatio);
120
121 void setViewportFeature(const String& keyString, const String& valueString, Document*, void* data);
122 void reportViewportWarning(Document*, ViewportErrorCode, const String& replacement1, const String& replacement2);
123
124 } // namespace WebCore
125
126 #endif // ViewportArguments_h