Use a 1-byte enum class for TextDirection
[WebKit-https.git] / Source / WebCore / platform / text / StringWithDirection.h
1 /*
2  * Copyright (C) 2011 Google Inc. All rights reserved.
3  * Copyright (C) 2017 Apple Inc. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are
7  * met:
8  *
9  *     * Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  *     * Redistributions in binary form must reproduce the above
12  * copyright notice, this list of conditions and the following disclaimer
13  * in the documentation and/or other materials provided with the
14  * distribution.
15  *     * Neither the name of Google Inc. nor the names of its
16  * contributors may be used to endorse or promote products derived from
17  * this software without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  */
31
32 #pragma once
33
34 #include "WritingMode.h"
35 #include <wtf/text/WTFString.h>
36
37 namespace WebCore {
38
39 // In some circumstances we want to store a String along with the TextDirection
40 // of the String as learned from the context of the String. For example,
41 // consider storing the title derived from <title dir='rtl'>some title</title>
42 // in the history.
43 //
44 // Note that is explicitly *not* the direction of the string as learned
45 // from the characters of the string; it's extra metadata we have external
46 // to the string.
47
48 struct StringWithDirection {
49     String string;
50     TextDirection direction { TextDirection::LTR };
51 };
52
53 inline bool operator==(const StringWithDirection& a, const StringWithDirection& b)
54 {
55     return a.string == b.string && a.direction == b.direction;
56 }
57
58 inline bool operator!=(const StringWithDirection& a, const StringWithDirection& b)
59 {
60     return !(a == b);
61 }
62
63 inline StringWithDirection truncateFromEnd(const StringWithDirection& string, unsigned maxLength)
64 {
65     return { string.string.left(maxLength), string.direction };
66 }
67
68 }