[Qt] Implement fit-to-width behaviour
[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     TargetDensityDpiTooSmallOrLargeError
43 };
44
45 struct ViewportAttributes {
46     FloatSize layoutSize;
47
48     float devicePixelRatio;
49
50     float initialScale;
51     float minimumScale;
52     float maximumScale;
53
54     float userScalable;
55 };
56
57 struct ViewportArguments {
58
59     enum Type {
60         Implicit,
61         ViewportMeta
62     } type;
63
64     enum {
65         ValueAuto = -1,
66         ValueDesktopWidth = -2,
67         ValueDeviceWidth = -3,
68         ValueDeviceHeight = -4,
69         ValueDeviceDPI = -5,
70         ValueLowDPI = -6,
71         ValueMediumDPI = -7,
72         ValueHighDPI = -8
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         , targetDensityDpi(ValueAuto)
83         , userScalable(ValueAuto)
84     {
85     }
86
87     float initialScale;
88     float minimumScale;
89     float maximumScale;
90     float width;
91     float height;
92     float targetDensityDpi;
93     float userScalable;
94
95     bool operator==(const ViewportArguments& other) const
96     {
97         // Used for figuring out whether to reset the viewport or not,
98         // thus we are not taking type into account.
99         return initialScale == other.initialScale
100             && minimumScale == other.minimumScale
101             && maximumScale == other.maximumScale
102             && width == other.width
103             && height == other.height
104             && targetDensityDpi == other.targetDensityDpi
105             && userScalable == other.userScalable;
106     }
107 };
108
109 ViewportAttributes computeViewportAttributes(ViewportArguments args, int desktopWidth, int deviceWidth, int deviceHeight, int deviceDPI, IntSize visibleViewport);
110 void restrictMinimumScaleFactorToViewportSize(ViewportAttributes& result, IntSize visibleViewport);
111 void restrictScaleFactorToInitialScaleIfNotUserScalable(ViewportAttributes& result);
112 float computeMinimumScaleFactorForContentContained(const ViewportAttributes& result, const IntSize& viewportSize, const IntSize& contentSize);
113
114 void setViewportFeature(const String& keyString, const String& valueString, Document*, void* data);
115 void reportViewportWarning(Document*, ViewportErrorCode, const String& replacement1, const String& replacement2);
116
117 } // namespace WebCore
118
119 #endif // ViewportArguments_h