Serenity Operating System
1/*
2 * Copyright (c) 2020, Andreas Kling <kling@serenityos.org>
3 * 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 met:
7 *
8 * 1. Redistributions of source code must retain the above copyright notice, this
9 * list of conditions and the following disclaimer.
10 *
11 * 2. Redistributions in binary form must reproduce the above copyright notice,
12 * this list of conditions and the following disclaimer in the documentation
13 * and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
16 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
18 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
21 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
22 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
23 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 */
26
27#pragma once
28
29#include <AK/String.h>
30
31namespace AK {
32
33class FlyString {
34public:
35 FlyString() {}
36 FlyString(const String&);
37 FlyString(const StringView&);
38 FlyString(const char*);
39
40 bool is_null() const { return !m_impl; }
41
42 bool operator==(const FlyString& other) const { return m_impl == other.m_impl; }
43 bool operator!=(const FlyString& other) const { return m_impl != other.m_impl; }
44
45 bool operator==(const String&) const;
46 bool operator!=(const String& string) const { return !(*this == string); }
47
48 bool operator==(const StringView&) const;
49 bool operator!=(const StringView& string) const { return !(*this == string); }
50
51 bool operator==(const char*) const;
52 bool operator!=(const char* string) const { return !(*this == string); }
53
54 const StringImpl* impl() const { return m_impl; }
55 const char* characters() const { return m_impl ? m_impl->characters() : nullptr; }
56 size_t length() const { return m_impl ? m_impl->length() : 0; }
57
58 StringView view() const;
59
60 FlyString to_lowercase() const;
61
62 int to_int(bool& ok) const;
63
64 bool equals_ignoring_case(const StringView&) const;
65
66 static void did_destroy_impl(Badge<StringImpl>, StringImpl&);
67
68private:
69 RefPtr<StringImpl> m_impl;
70};
71
72template<>
73struct Traits<FlyString> : public GenericTraits<FlyString> {
74 static unsigned hash(const FlyString& s) { return s.impl() ? s.impl()->hash() : 0; }
75};
76
77}
78
79using AK::FlyString;