Part 2 of removing PlatformString.h, remove PlatformString.h
[WebKit-https.git] / Source / WebCore / platform / text / StringWithDirection.h
1 /*
2  * Copyright (C) 2011 Google 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 are
6  * met:
7  *
8  *     * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *     * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *     * Neither the name of Google Inc. nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #ifndef StringWithDirection_h
32 #define StringWithDirection_h
33
34 #include "TextDirection.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 class StringWithDirection {
48 public:
49     StringWithDirection()
50         : m_direction(LTR)
51     {
52     }
53
54     StringWithDirection(const String& string, TextDirection dir)
55         : m_string(string)
56         , m_direction(dir)
57     {
58     }
59
60     const String& string() const { return m_string; }
61     TextDirection direction() const { return m_direction; }
62
63     bool isEmpty() const { return m_string.isEmpty(); }
64     bool isNull() const { return m_string.isNull(); }
65
66     bool operator==(const StringWithDirection& other) const
67     {
68         return other.m_string == m_string && other.m_direction == m_direction;
69     }
70     bool operator!=(const StringWithDirection& other) const { return !((*this) == other); }
71
72 private:
73     String m_string;
74     TextDirection m_direction;
75 };
76
77 }
78
79 #endif // StringWithDirection_h