Remove Qt-specific code in common WebCore/{html,dom} files.
[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  * Copyright (C) 2012 Intel Corporation. All rights reserved.
10  *
11  * This library is free software; you can redistribute it and/or
12  * modify it under the terms of the GNU Library General Public
13  * License as published by the Free Software Foundation; either
14  * version 2 of the License, or (at your option) any later version.
15  *
16  * This library is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19  * Library General Public License for more details.
20  *
21  * You should have received a copy of the GNU Library General Public License
22  * along with this library; see the file COPYING.LIB.  If not, write to
23  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
24  * Boston, MA 02110-1301, USA.
25  *
26  */
27
28 #ifndef ViewportArguments_h
29 #define ViewportArguments_h
30
31 #include "FloatSize.h"
32 #include <wtf/Forward.h>
33
34 namespace WebCore {
35
36 class Document;
37
38 enum ViewportErrorCode {
39     UnrecognizedViewportArgumentKeyError,
40     UnrecognizedViewportArgumentValueError,
41     TruncatedViewportArgumentValueError,
42     MaximumScaleTooLargeError
43 };
44
45 struct ViewportAttributes {
46     FloatSize layoutSize;
47
48     float initialScale;
49     float minimumScale;
50     float maximumScale;
51
52     float userScalable;
53     float orientation;
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         CSSDeviceAdaptation
68     } type;
69
70     enum {
71         ValueAuto = -1,
72         ValueDeviceWidth = -2,
73         ValueDeviceHeight = -3,
74         ValuePortrait = -4,
75         ValueLandscape = -5
76     };
77
78     explicit ViewportArguments(Type type = Implicit)
79         : type(type)
80         , width(ValueAuto)
81         , minWidth(ValueAuto)
82         , maxWidth(ValueAuto)
83         , height(ValueAuto)
84         , minHeight(ValueAuto)
85         , maxHeight(ValueAuto)
86         , zoom(ValueAuto)
87         , minZoom(ValueAuto)
88         , maxZoom(ValueAuto)
89         , userZoom(ValueAuto)
90         , orientation(ValueAuto)
91     {
92     }
93
94     // All arguments are in CSS units.
95     ViewportAttributes resolve(const FloatSize& initialViewportSize, const FloatSize& deviceSize, int defaultWidth) const;
96
97     float width;
98     float minWidth;
99     float maxWidth;
100     float height;
101     float minHeight;
102     float maxHeight;
103     float zoom;
104     float minZoom;
105     float maxZoom;
106     float userZoom;
107     float orientation;
108
109     bool operator==(const ViewportArguments& other) const
110     {
111         // Used for figuring out whether to reset the viewport or not,
112         // thus we are not taking type into account.
113         return width == other.width
114             && minWidth == other.minWidth
115             && maxWidth == other.maxWidth
116             && height == other.height
117             && minHeight == other.minHeight
118             && maxHeight == other.maxHeight
119             && zoom == other.zoom
120             && minZoom == other.minZoom
121             && maxZoom == other.maxZoom
122             && userZoom == other.userZoom
123             && orientation == other.orientation;
124     }
125
126     bool operator!=(const ViewportArguments& other) const
127     {
128         return !(*this == other);
129     }
130
131 #if PLATFORM(BLACKBERRY) || PLATFORM(GTK)
132     // FIXME: We're going to keep this constant around until all embedders
133     // refactor their code to no longer need it.
134     static const float deprecatedTargetDPI;
135 #endif
136 };
137
138 ViewportAttributes computeViewportAttributes(ViewportArguments args, int desktopWidth, int deviceWidth, int deviceHeight, float devicePixelRatio, IntSize visibleViewport);
139
140 void restrictMinimumScaleFactorToViewportSize(ViewportAttributes& result, IntSize visibleViewport, float devicePixelRatio);
141 void restrictScaleFactorToInitialScaleIfNotUserScalable(ViewportAttributes& result);
142 float computeMinimumScaleFactorForContentContained(const ViewportAttributes& result, const IntSize& viewportSize, const IntSize& contentSize);
143
144 void setViewportFeature(const String& keyString, const String& valueString, Document*, void* data);
145 void reportViewportWarning(Document*, ViewportErrorCode, const String& replacement1, const String& replacement2);
146
147 } // namespace WebCore
148
149 #endif // ViewportArguments_h