File: TransferString.cpp

package info (click to toggle)
webkit2gtk 2.51.4-1
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 481,584 kB
  • sloc: cpp: 3,903,132; javascript: 198,251; ansic: 165,758; python: 51,432; asm: 21,819; ruby: 18,095; perl: 16,963; xml: 4,623; sh: 2,408; yacc: 2,356; java: 2,019; lex: 1,358; pascal: 372; makefile: 203
file content (155 lines) | stat: -rw-r--r-- 6,853 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
/*
 * Copyright (C) 2025 Apple Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 * THE POSSIBILITY OF SUCH DAMAGE.
 */

#include "config.h"
#include "TransferString.h"

#include <wtf/text/ExternalStringImpl.h>

#if USE(CF)
#include <wtf/cf/VectorCF.h>
#endif

namespace IPC {

#if USE(CF)
std::optional<TransferString> TransferString::create(CFStringRef string)
{
    if (!string)
        return TransferString { String { } };
    CFIndex size = CFStringGetLength(string);
    if (!size)
        return TransferString { ""_s };
    // The transferAsMappingSize checks are inside the `if`s because we want to make sure
    // that the getter will return the data. We need that during ::toIPCData.
    if (auto span8 = CFStringGetLatin1CStringSpan(string); !span8.empty()) {
        if (span8.size_bytes() < transferAsMappingSize)
            return TransferString { string };
        return createCopy(span8);
    }
    if (auto span16 = CFStringGetCharactersSpan(string); !span16.empty()) {
        if (span16.size_bytes() < transferAsMappingSize)
            return TransferString { string };
        return createCopy(span16);
    }
    // Not native Latin1 or UTF-16 string, needs a copy from the CFString
    // to get UTF-16. Copy small ones to be held and sent as String.
    auto dataSize = static_cast<size_t>(size) * sizeof(char16_t);
    if (dataSize < transferAsMappingSize)
        return TransferString { String { string } };
    RefPtr buffer = WebCore::SharedMemory::allocate(dataSize);
    if (!buffer)
        return std::nullopt;
    auto bufferSpan = spanReinterpretCast<char16_t>(buffer->mutableSpan());
    CFStringCopyCharactersSpan(string, bufferSpan);
    auto handle = buffer->createHandle(WebCore::SharedMemoryProtection::ReadOnly);
    if (!handle)
        return std::nullopt;
    return std::optional<TransferString> { std::in_place, SharedSpan16 { WTFMove(*handle) } };
}

TransferString::TransferString(CFStringRef string)
    : m_storage(RetainPtr { string })
{
}
#endif

std::optional<TransferString> TransferString::createCopy(std::span<const Latin1Character> span8)
{
    auto handle = WebCore::SharedMemoryHandle::createCopy(span8, WebCore::SharedMemoryProtection::ReadOnly);
    if (!handle)
        return std::nullopt;
    return std::optional<TransferString> { std::in_place, SharedSpan8 { WTFMove(*handle) } };
}

std::optional<TransferString> TransferString::createCopy(std::span<const char16_t> span16)
{
    auto handle = WebCore::SharedMemoryHandle::createCopy(asBytes(span16), WebCore::SharedMemoryProtection::ReadOnly);
    if (!handle)
        return std::nullopt;
    return std::optional<TransferString> { std::in_place, SharedSpan16 { WTFMove(*handle) } };
}

std::optional<String> TransferString::release(size_t maxCopySizeInBytes) && // NOLINT
{ // NOLINT
    return WTF::switchOn(WTFMove(m_storage),
        [](String string) {
            return std::optional<String> { std::in_place, WTFMove(string) };
        },
#if USE(CF)
        [](RetainPtr<CFStringRef> string) {
            return std::optional<String> { std::in_place, string.get() };
        },
#endif
        [maxCopySizeInBytes](SharedSpan8 handle) -> std::optional<String> {
            RefPtr<SharedMemory> memory = WebCore::SharedMemory::map(WTFMove(handle.dataHandle), WebCore::SharedMemoryProtection::ReadOnly);
            if (!memory)
                return std::nullopt;
            if (memory->size() > maxCopySizeInBytes) {
                Ref<StringImpl> impl = ExternalStringImpl::create(byteCast<Latin1Character>(memory->span()), [memory = memory.releaseNonNull()] (auto...) mutable { });
                return std::optional<String> { std::in_place, String { WTFMove(impl) } };
            }
            return std::optional<String> { std::in_place, String { byteCast<Latin1Character>(memory->span()) } };
        },
        [maxCopySizeInBytes](SharedSpan16 handle) -> std::optional<String> {
            RefPtr<SharedMemory> memory = WebCore::SharedMemory::map(WTFMove(handle.dataHandle), WebCore::SharedMemoryProtection::ReadOnly);
            if (!memory || (memory->size() % sizeof(char16_t)))
                return std::nullopt;
            if (memory->size() > maxCopySizeInBytes) {
                Ref<StringImpl> impl = ExternalStringImpl::create(spanReinterpretCast<const char16_t>(memory->span()), [memory = memory.releaseNonNull()] (auto...) mutable { });
                return std::optional<String> { std::in_place, String { WTFMove(impl) } };
            }
            return std::optional<String> { std::in_place, String { spanReinterpretCast<const char16_t>(memory->span()) } };
        }
    );
}

TransferString::IPCData TransferString::toIPCData() const
{
    return WTF::switchOn(m_storage,
        [](const String& string) {
            if (string.isNull())
                return IPCData { std::monostate { } };
            if (string.is8Bit())
                return IPCData { string.span8() };
            return IPCData { string.span16() };
        },
#if USE(CF)
        [](const RetainPtr<CFStringRef>& string) {
            if (auto span8 = CFStringGetLatin1CStringSpan(string.get()); !span8.empty())
                return IPCData { span8 };
            return IPCData { CFStringGetCharactersSpan(string.get()) };
        },
#endif
        [](const SharedSpan8& handle) {
            return IPCData { SharedSpan8 { WebCore::SharedMemoryHandle { handle.dataHandle } } };
        },
        [](const SharedSpan16& handle) -> IPCData {
            return IPCData { SharedSpan16 { WebCore::SharedMemoryHandle { handle.dataHandle } } };
        }
    );
}

}