Implement CSS `display: flow-root` (modern clearfix)
[WebKit-https.git] / Source / WebCore / rendering / style / TextUnderlineOffset.h
1 /*
2  * Copyright (C) 2018 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 #pragma once
27
28 #include "Length.h"
29 #include <wtf/text/TextStream.h>
30
31 namespace WebCore {
32
33 class TextUnderlineOffset {
34 public:
35     static TextUnderlineOffset createWithAuto()
36     {
37         return TextUnderlineOffset(Type::Auto);
38     }
39
40     static TextUnderlineOffset createWithLength(float length)
41     {
42         TextUnderlineOffset result(Type::Length);
43         result.setLengthValue(length);
44         return result;
45     }
46
47     bool isAuto() const
48     {
49         return !isLength();
50     }
51
52     bool isLength() const
53     {
54         return static_cast<bool>(m_length);
55     }
56
57     void setLengthValue(float length)
58     {
59         ASSERT(isLength());
60         m_length = length;
61     }
62
63     float lengthValue() const
64     {
65         ASSERT(isLength());
66         return *m_length;
67     }
68
69     float lengthOr(float defaultValue) const
70     {
71         return m_length.valueOr(defaultValue);
72     }
73
74     bool operator==(const TextUnderlineOffset& other) const
75     {
76         return m_length == other.m_length;
77     }
78
79     bool operator!=(const TextUnderlineOffset& other) const
80     {
81         return !(*this == other);
82     }
83
84 private:
85     enum class Type {
86         Auto,
87         Length
88     };
89
90     TextUnderlineOffset(Type type)
91     {
92         if (type == Type::Length)
93             m_length = 0;
94     }
95
96     Optional<float> m_length;
97 };
98
99 inline TextStream& operator<<(TextStream& ts, const TextUnderlineOffset& offset)
100 {
101     if (offset.isAuto())
102         ts << "auto";
103     else
104         ts << TextStream::FormatNumberRespectingIntegers(offset.lengthValue());
105     return ts;
106 }
107
108 } // namespace WebCore