• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

JuliaLang / julia / #37481

pending completion
#37481

push

local

web-flow
dont show `#unused#` for unnamed arguments in stacktraces (#49058)

1 of 1 new or added line in 1 file covered. (100.0%)

72287 of 82697 relevant lines covered (87.41%)

34862605.48 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

97.63
/base/strings/string.jl
1
# This file is a part of Julia. License is MIT: https://julialang.org/license
2

3
"""
4
    StringIndexError(str, i)
5

6
An error occurred when trying to access `str` at index `i` that is not valid.
7
"""
8
struct StringIndexError <: Exception
9
    string::AbstractString
663✔
10
    index::Integer
11
end
12
@noinline string_index_err(s::AbstractString, i::Integer) =
659✔
13
    throw(StringIndexError(s, Int(i)))
14
function Base.showerror(io::IO, exc::StringIndexError)
4✔
15
    s = exc.string
4✔
16
    print(io, "StringIndexError: ", "invalid index [$(exc.index)]")
4✔
17
    if firstindex(s) <= exc.index <= ncodeunits(s)
4✔
18
        iprev = thisind(s, exc.index)
4✔
19
        inext = nextind(s, iprev)
4✔
20
        escprev = escape_string(s[iprev:iprev])
4✔
21
        if inext <= ncodeunits(s)
4✔
22
            escnext = escape_string(s[inext:inext])
3✔
23
            print(io, ", valid nearby indices [$iprev]=>'$escprev', [$inext]=>'$escnext'")
3✔
24
        else
25
            print(io, ", valid nearby index [$iprev]=>'$escprev'")
1✔
26
        end
27
    end
28
end
29

30
const ByteArray = Union{CodeUnits{UInt8,String}, Vector{UInt8},Vector{Int8}, FastContiguousSubArray{UInt8,1,CodeUnits{UInt8,String}}, FastContiguousSubArray{UInt8,1,Vector{UInt8}}, FastContiguousSubArray{Int8,1,Vector{Int8}}}
31

32
@inline between(b::T, lo::T, hi::T) where {T<:Integer} = (lo ≤ b) & (b ≤ hi)
153,536,800✔
33

34
"""
35
    String <: AbstractString
36

37
The default string type in Julia, used by e.g. string literals.
38

39
`String`s are immutable sequences of `Char`s. A `String` is stored internally as
40
a contiguous byte array, and while they are interpreted as being UTF-8 encoded,
41
they can be composed of any byte sequence. Use [`isvalid`](@ref) to validate
42
that the underlying byte sequence is valid as UTF-8.
43
"""
44
String
45

46
## constructors and conversions ##
47

48
# String constructor docstring from boot.jl, workaround for #16730
49
# and the unavailability of @doc in boot.jl context.
50
"""
51
    String(v::AbstractVector{UInt8})
52

53
Create a new `String` object using the data buffer from byte vector `v`.
54
If `v` is a `Vector{UInt8}` it will be truncated to zero length and future
55
modification of `v` cannot affect the contents of the resulting string.
56
To avoid truncation of `Vector{UInt8}` data, use `String(copy(v))`; for other
57
`AbstractVector` types, `String(v)` already makes a copy.
58

59
When possible, the memory of `v` will be used without copying when the `String`
60
object is created. This is guaranteed to be the case for byte vectors returned
61
by [`take!`](@ref) on a writable [`IOBuffer`](@ref) and by calls to
62
[`read(io, nb)`](@ref). This allows zero-copy conversion of I/O data to strings.
63
In other cases, `Vector{UInt8}` data may be copied, but `v` is truncated anyway
64
to guarantee consistent behavior.
65
"""
66
String(v::AbstractVector{UInt8}) = String(copyto!(StringVector(length(v)), v))
2,612,856✔
67
String(v::Vector{UInt8}) = ccall(:jl_array_to_string, Ref{String}, (Any,), v)
6,587,761✔
68

69
"""
70
    unsafe_string(p::Ptr{UInt8}, [length::Integer])
71

72
Copy a string from the address of a C-style (NUL-terminated) string encoded as UTF-8.
73
(The pointer can be safely freed afterwards.) If `length` is specified
74
(the length of the data in bytes), the string does not have to be NUL-terminated.
75

76
This function is labeled "unsafe" because it will crash if `p` is not
77
a valid memory address to data of the requested length.
78
"""
79
function unsafe_string(p::Union{Ptr{UInt8},Ptr{Int8}}, len::Integer)
1,139✔
80
    p == C_NULL && throw(ArgumentError("cannot convert NULL to string"))
511,858✔
81
    ccall(:jl_pchar_to_string, Ref{String}, (Ptr{UInt8}, Int), p, len)
511,857✔
82
end
83
function unsafe_string(p::Union{Ptr{UInt8},Ptr{Int8}})
10,228✔
84
    p == C_NULL && throw(ArgumentError("cannot convert NULL to string"))
3,050,228✔
85
    ccall(:jl_cstr_to_string, Ref{String}, (Ptr{UInt8},), p)
3,050,227✔
86
end
87

88
# This is @assume_effects :effect_free :nothrow :terminates_globally @ccall jl_alloc_string(n::Csize_t)::Ref{String},
89
# but the macro is not available at this time in bootstrap, so we write it manually.
90
@eval _string_n(n::Integer) = $(Expr(:foreigncall, QuoteNode(:jl_alloc_string), Ref{String}, Expr(:call, Expr(:core, :svec), :Csize_t), 1, QuoteNode((:ccall,0xe)), :(convert(Csize_t, n))))
108,723,066✔
91

92
"""
93
    String(s::AbstractString)
94

95
Create a new `String` from an existing `AbstractString`.
96
"""
97
String(s::AbstractString) = print_to_string(s)
397✔
98
@assume_effects :total String(s::Symbol) = unsafe_string(unsafe_convert(Ptr{UInt8}, s))
615,658✔
99

100
unsafe_wrap(::Type{Vector{UInt8}}, s::String) = ccall(:jl_string_to_array, Ref{Vector{UInt8}}, (Any,), s)
6,406,536✔
101

102
Vector{UInt8}(s::CodeUnits{UInt8,String}) = copyto!(Vector{UInt8}(undef, length(s)), s)
20,937✔
103
Vector{UInt8}(s::String) = Vector{UInt8}(codeunits(s))
20,860✔
104
Array{UInt8}(s::String)  = Vector{UInt8}(codeunits(s))
×
105

106
String(s::CodeUnits{UInt8,String}) = s.s
3✔
107

108
## low-level functions ##
109

110
pointer(s::String) = unsafe_convert(Ptr{UInt8}, s)
409,478,707✔
111
pointer(s::String, i::Integer) = pointer(s) + Int(i)::Int - 1
285,918,960✔
112

113
ncodeunits(s::String) = Core.sizeof(s)
297,913,208✔
114
codeunit(s::String) = UInt8
×
115

116
@inline function codeunit(s::String, i::Integer)
680,498✔
117
    @boundscheck checkbounds(s, i)
266,917,511✔
118
    b = GC.@preserve s unsafe_load(pointer(s, i))
266,917,511✔
119
    return b
266,917,511✔
120
end
121

122
## comparison ##
123

124
_memcmp(a::Union{Ptr{UInt8},AbstractString}, b::Union{Ptr{UInt8},AbstractString}, len) =
7,198,684✔
125
    ccall(:memcmp, Cint, (Ptr{UInt8}, Ptr{UInt8}, Csize_t), a, b, len % Csize_t) % Int
126

127
function cmp(a::String, b::String)
1✔
128
    al, bl = sizeof(a), sizeof(b)
367,290✔
129
    c = _memcmp(a, b, min(al,bl))
367,290✔
130
    return c < 0 ? -1 : c > 0 ? +1 : cmp(al,bl)
582,911✔
131
end
132

133
function ==(a::String, b::String)
10,294,192✔
134
    pointer_from_objref(a) == pointer_from_objref(b) && return true
10,294,192✔
135
    al = sizeof(a)
10,229,403✔
136
    return al == sizeof(b) && 0 == _memcmp(a, b, al)
10,229,403✔
137
end
138

139
typemin(::Type{String}) = ""
2✔
140
typemin(::String) = typemin(String)
1✔
141

142
## thisind, nextind ##
143

144
@propagate_inbounds thisind(s::String, i::Int) = _thisind_str(s, i)
177,304,741✔
145

146
# s should be String or SubString{String}
147
@inline function _thisind_str(s, i::Int)
97✔
148
    i == 0 && return 0
89,263,519✔
149
    n = ncodeunits(s)
89,236,421✔
150
    i == n + 1 && return i
89,236,421✔
151
    @boundscheck between(i, 1, n) || throw(BoundsError(s, i))
89,213,979✔
152
    @inbounds b = codeunit(s, i)
89,213,955✔
153
    (b & 0xc0 == 0x80) & (i-1 > 0) || return i
158,360,291✔
154
    @inbounds b = codeunit(s, i-1)
20,067,619✔
155
    between(b, 0b11000000, 0b11110111) && return i-1
20,067,619✔
156
    (b & 0xc0 == 0x80) & (i-2 > 0) || return i
15,660,189✔
157
    @inbounds b = codeunit(s, i-2)
7,170,993✔
158
    between(b, 0b11100000, 0b11110111) && return i-2
7,170,993✔
159
    (b & 0xc0 == 0x80) & (i-3 > 0) || return i
5,906,601✔
160
    @inbounds b = codeunit(s, i-3)
1,027,051✔
161
    between(b, 0b11110000, 0b11110111) && return i-3
1,027,051✔
162
    return i
241,004✔
163
end
164

165
@propagate_inbounds nextind(s::String, i::Int) = _nextind_str(s, i)
13,405,026✔
166

167
# s should be String or SubString{String}
168
@inline function _nextind_str(s, i::Int)
13,913,210✔
169
    i == 0 && return 1
13,913,210✔
170
    n = ncodeunits(s)
13,893,619✔
171
    @boundscheck between(i, 1, n) || throw(BoundsError(s, i))
13,893,631✔
172
    @inbounds l = codeunit(s, i)
13,893,607✔
173
    (l < 0x80) | (0xf8 ≤ l) && return i+1
13,893,607✔
174
    if l < 0xc0
132,080✔
175
        i′ = @inbounds thisind(s, i)
51,357✔
176
        return i′ < i ? @inbounds(nextind(s, i′)) : i+1
30,403✔
177
    end
178
    # first continuation byte
179
    (i += 1) > n && return i
101,677✔
180
    @inbounds b = codeunit(s, i)
101,039✔
181
    b & 0xc0 ≠ 0x80 && return i
101,039✔
182
    ((i += 1) > n) | (l < 0xe0) && return i
93,795✔
183
    # second continuation byte
184
    @inbounds b = codeunit(s, i)
76,309✔
185
    b & 0xc0 ≠ 0x80 && return i
76,309✔
186
    ((i += 1) > n) | (l < 0xf0) && return i
72,676✔
187
    # third continuation byte
188
    @inbounds b = codeunit(s, i)
20,796✔
189
    ifelse(b & 0xc0 ≠ 0x80, i, i+1)
20,796✔
190
end
191

192
## checking UTF-8 & ACSII validity ##
193

194
byte_string_classify(s::Union{String,Vector{UInt8},FastContiguousSubArray{UInt8,1,Vector{UInt8}}}) =
20,324✔
195
    ccall(:u8_isvalid, Int32, (Ptr{UInt8}, Int), s, sizeof(s))
196
    # 0: neither valid ASCII nor UTF-8
197
    # 1: valid ASCII
198
    # 2: valid UTF-8
199

200
isvalid(::Type{String}, s::Union{Vector{UInt8},FastContiguousSubArray{UInt8,1,Vector{UInt8}},String}) = byte_string_classify(s) ≠ 0
20,324✔
201
isvalid(s::String) = isvalid(String, s)
41✔
202

203
is_valid_continuation(c) = c & 0xc0 == 0x80
×
204

205
## required core functionality ##
206

207
@inline function iterate(s::String, i::Int=firstindex(s))
60,323✔
208
    (i % UInt) - 1 < ncodeunits(s) || return nothing
28,737,725✔
209
    b = @inbounds codeunit(s, i)
19,831,500✔
210
    u = UInt32(b) << 24
19,831,500✔
211
    between(b, 0x80, 0xf7) || return reinterpret(Char, u), i+1
38,743,641✔
212
    return iterate_continued(s, i, u)
919,359✔
213
end
214

215
function iterate_continued(s::String, i::Int, u::UInt32)
919,359✔
216
    u < 0xc0000000 && (i += 1; @goto ret)
919,460✔
217
    n = ncodeunits(s)
919,258✔
218
    # first continuation byte
219
    (i += 1) > n && @goto ret
919,258✔
220
    @inbounds b = codeunit(s, i)
919,238✔
221
    b & 0xc0 == 0x80 || @goto ret
919,238✔
222
    u |= UInt32(b) << 16
919,177✔
223
    # second continuation byte
224
    ((i += 1) > n) | (u < 0xe0000000) && @goto ret
919,177✔
225
    @inbounds b = codeunit(s, i)
854,507✔
226
    b & 0xc0 == 0x80 || @goto ret
854,509✔
227
    u |= UInt32(b) << 8
854,505✔
228
    # third continuation byte
229
    ((i += 1) > n) | (u < 0xf0000000) && @goto ret
854,505✔
230
    @inbounds b = codeunit(s, i)
273,730✔
231
    b & 0xc0 == 0x80 || @goto ret
273,731✔
232
    u |= UInt32(b); i += 1
547,458✔
233
@label ret
×
234
    return reinterpret(Char, u), i
919,359✔
235
end
236

237
@propagate_inbounds function getindex(s::String, i::Int)
156,407✔
238
    b = codeunit(s, i)
2,526,379✔
239
    u = UInt32(b) << 24
2,526,379✔
240
    between(b, 0x80, 0xf7) || return reinterpret(Char, u)
5,049,137✔
241
    return getindex_continued(s, i, u)
3,621✔
242
end
243

244
function getindex_continued(s::String, i::Int, u::UInt32)
3,621✔
245
    if u < 0xc0000000
3,621✔
246
        # called from `getindex` which checks bounds
247
        @inbounds isvalid(s, i) && @goto ret
16✔
248
        string_index_err(s, i)
1✔
249
    end
250
    n = ncodeunits(s)
3,605✔
251

252
    (i += 1) > n && @goto ret
3,605✔
253
    @inbounds b = codeunit(s, i) # cont byte 1
3,604✔
254
    b & 0xc0 == 0x80 || @goto ret
3,604✔
255
    u |= UInt32(b) << 16
3,603✔
256

257
    ((i += 1) > n) | (u < 0xe0000000) && @goto ret
3,603✔
258
    @inbounds b = codeunit(s, i) # cont byte 2
2,480✔
259
    b & 0xc0 == 0x80 || @goto ret
2,480✔
260
    u |= UInt32(b) << 8
2,480✔
261

262
    ((i += 1) > n) | (u < 0xf0000000) && @goto ret
2,480✔
263
    @inbounds b = codeunit(s, i) # cont byte 3
478✔
264
    b & 0xc0 == 0x80 || @goto ret
478✔
265
    u |= UInt32(b)
478✔
266
@label ret
×
267
    return reinterpret(Char, u)
3,620✔
268
end
269

270
getindex(s::String, r::AbstractUnitRange{<:Integer}) = s[Int(first(r)):Int(last(r))]
4✔
271

272
@inline function getindex(s::String, r::UnitRange{Int})
1,483,939✔
273
    isempty(r) && return ""
971,763✔
274
    i, j = first(r), last(r)
69,372✔
275
    @boundscheck begin
947,761✔
276
        checkbounds(s, r)
947,743✔
277
        @inbounds isvalid(s, i) || string_index_err(s, i)
947,731✔
278
        @inbounds isvalid(s, j) || string_index_err(s, j)
947,732✔
279
    end
280
    j = nextind(s, j) - 1
947,754✔
281
    n = j - i + 1
947,754✔
282
    ss = _string_n(n)
947,754✔
283
    GC.@preserve s ss unsafe_copyto!(pointer(ss), pointer(s, i), n)
947,754✔
284
    return ss
947,754✔
285
end
286

287
length(s::String) = length_continued(s, 1, ncodeunits(s), ncodeunits(s))
851,852✔
288

289
@inline function length(s::String, i::Int, j::Int)
68,251✔
290
    @boundscheck begin
228,837✔
291
        0 < i ≤ ncodeunits(s)+1 || throw(BoundsError(s, i))
228,837✔
292
        0 ≤ j < ncodeunits(s)+1 || throw(BoundsError(s, j))
228,841✔
293
    end
294
    j < i && return 0
228,833✔
295
    @inbounds i, k = thisind(s, i), i
351,388✔
296
    c = j - i + (i == k)
175,694✔
297
    length_continued(s, i, j, c)
175,694✔
298
end
299

300
@inline function length_continued(s::String, i::Int, n::Int, c::Int)
897,100✔
301
    i < n || return c
1,252,143✔
302
    @inbounds b = codeunit(s, i)
802,949✔
303
    @inbounds while true
4,303,032✔
304
        while true
52,753,107✔
305
            (i += 1) ≤ n || return c
53,555,285✔
306
            0xc0 ≤ b ≤ 0xf7 && break
51,950,929✔
307
            b = codeunit(s, i)
48,450,075✔
308
        end
48,450,075✔
309
        l = b
3,500,854✔
310
        b = codeunit(s, i) # cont byte 1
3,500,854✔
311
        c -= (x = b & 0xc0 == 0x80)
3,500,854✔
312
        x & (l ≥ 0xe0) || continue
3,500,854✔
313

314
        (i += 1) ≤ n || return c
3,101,552✔
315
        b = codeunit(s, i) # cont byte 2
3,100,090✔
316
        c -= (x = b & 0xc0 == 0x80)
3,100,090✔
317
        x & (l ≥ 0xf0) || continue
5,303,137✔
318

319
        (i += 1) ≤ n || return c
897,083✔
320
        b = codeunit(s, i) # cont byte 3
897,003✔
321
        c -= (b & 0xc0 == 0x80)
897,003✔
322
    end
3,500,083✔
323
end
324

325
## overload methods for efficiency ##
326

327
isvalid(s::String, i::Int) = checkbounds(Bool, s, i) && thisind(s, i) == i
81,872,156✔
328

329
isascii(s::String) = isascii(codeunits(s))
25,782✔
330

331
"""
332
    repeat(c::AbstractChar, r::Integer) -> String
333

334
Repeat a character `r` times. This can equivalently be accomplished by calling
335
[`c^r`](@ref :^(::Union{AbstractString, AbstractChar}, ::Integer)).
336

337
# Examples
338
```jldoctest
339
julia> repeat('A', 3)
340
"AAA"
341
```
342
"""
343
repeat(c::AbstractChar, r::Integer) = repeat(Char(c), r) # fallback
1✔
344
function repeat(c::Char, r::Integer)
14,159✔
345
    r == 0 && return ""
14,159✔
346
    r < 0 && throw(ArgumentError("can't repeat a character $r times"))
10,085✔
347
    u = bswap(reinterpret(UInt32, c))
10,081✔
348
    n = 4 - (leading_zeros(u | 0xff) >> 3)
10,081✔
349
    s = _string_n(n*r)
10,187✔
350
    p = pointer(s)
10,186✔
351
    GC.@preserve s if n == 1
10,186✔
352
        ccall(:memset, Ptr{Cvoid}, (Ptr{UInt8}, Cint, Csize_t), p, u % UInt8, r)
10,161✔
353
    elseif n == 2
25✔
354
        p16 = reinterpret(Ptr{UInt16}, p)
5✔
355
        for i = 1:r
9✔
356
            unsafe_store!(p16, u % UInt16, i)
14✔
357
        end
19✔
358
    elseif n == 3
20✔
359
        b1 = (u >> 0) % UInt8
16✔
360
        b2 = (u >> 8) % UInt8
16✔
361
        b3 = (u >> 16) % UInt8
16✔
362
        for i = 0:r-1
32✔
363
            unsafe_store!(p, b1, 3i + 1)
45✔
364
            unsafe_store!(p, b2, 3i + 2)
45✔
365
            unsafe_store!(p, b3, 3i + 3)
45✔
366
        end
45✔
367
    elseif n == 4
4✔
368
        p32 = reinterpret(Ptr{UInt32}, p)
4✔
369
        for i = 1:r
8✔
370
            unsafe_store!(p32, u, i)
8✔
371
        end
10,194✔
372
    end
373
    return s
10,080✔
374
end
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2025 Coveralls, Inc