4df52dd6e8480ccd789a315ecc198cf67c25f568
[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     float shrinkToFit;
55 };
56
57 struct ViewportArguments {
58
59     enum Type {
60         // These are ordered in increasing importance.
61         Implicit,
62 #if PLATFORM(IOS)
63         PluginDocument,
64         ImageDocument,
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     {
81     }
82
83     // All arguments are in CSS units.
84     ViewportAttributes resolve(const FloatSize& initialViewportSize, const FloatSize& deviceSize, int defaultWidth) const;
85
86     float width { ValueAuto };
87     float minWidth { ValueAuto };
88     float maxWidth { ValueAuto };
89     float height { ValueAuto };
90     float minHeight { ValueAuto };
91     float maxHeight { ValueAuto };
92     float zoom { ValueAuto };
93     float minZoom { ValueAuto };
94     float maxZoom { ValueAuto };
95     float userZoom { ValueAuto };
96     float orientation { ValueAuto };
97     float shrinkToFit { ValueAuto };
98
99     bool operator==(const ViewportArguments& other) const
100     {
101         // Used for figuring out whether to reset the viewport or not,
102         // thus we are not taking type into account.
103         return width == other.width
104             && minWidth == other.minWidth
105             && maxWidth == other.maxWidth
106             && height == other.height
107             && minHeight == other.minHeight
108             && maxHeight == other.maxHeight
109             && zoom == other.zoom
110             && minZoom == other.minZoom
111             && maxZoom == other.maxZoom
112             && userZoom == other.userZoom
113             && orientation == other.orientation
114             && shrinkToFit == other.shrinkToFit;
115     }
116
117     bool operator!=(const ViewportArguments& other) const
118     {
119         return !(*this == other);
120     }
121
122 #if PLATFORM(GTK)
123     // FIXME: We're going to keep this constant around until all embedders
124     // refactor their code to no longer need it.
125     static const float deprecatedTargetDPI;
126 #endif
127 };
128
129 WEBCORE_EXPORT ViewportAttributes computeViewportAttributes(ViewportArguments args, int desktopWidth, int deviceWidth, int deviceHeight, float devicePixelRatio, IntSize visibleViewport);
130
131 WEBCORE_EXPORT void restrictMinimumScaleFactorToViewportSize(ViewportAttributes& result, IntSize visibleViewport, float devicePixelRatio);
132 WEBCORE_EXPORT void restrictScaleFactorToInitialScaleIfNotUserScalable(ViewportAttributes& result);
133 float computeMinimumScaleFactorForContentContained(const ViewportAttributes& result, const IntSize& viewportSize, const IntSize& contentSize);
134
135 void setViewportFeature(const String& keyString, const String& valueString, Document*, void* data);
136 void reportViewportWarning(Document*, ViewportErrorCode, const String& replacement1, const String& replacement2);
137
138 TextStream& operator<<(TextStream&, const ViewportArguments&);
139
140 } // namespace WebCore
141
142 #endif // ViewportArguments_h