Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename internal copy_string function to bytes2string #54

Merged
merged 1 commit into from
May 30, 2024
Merged

Rename internal copy_string function to bytes2string #54

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/filename-checks.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ function check_name_used(name::String, used_names::Set{String}, used_stripped_di
# need to rstrip because of repeated '/'
if isempty(parent_data) || parent_data[end] != UInt8('/')
# this effectively rstrips all '/'
parent_name = copy_string(parent_data)
parent_name = bytes2string(parent_data)
# @show parent_name
@argcheck parent_name ∉ used_names
end
Expand All @@ -75,7 +75,7 @@ function add_name_used!(name::String, used_names::Set{String}, used_stripped_dir
# need to rstrip because of repeated '/'
if isempty(parent_data) || parent_data[end] != UInt8('/')
# this effectively rstrips all '/'
parent_name = copy_string(parent_data)
parent_name = bytes2string(parent_data)
# @show parent_name
push!(used_stripped_dir_names, parent_name)
end
Expand Down
10 changes: 5 additions & 5 deletions src/reader.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ const ByteArray = Union{
}

# version of String(v::AbstractVector{UInt8}) that works consistently.
function copy_string(v::AbstractVector{UInt8})::String
function bytes2string(v::AbstractVector{UInt8})::String
String(v)
end
function copy_string(v::Vector{UInt8})::String
function bytes2string(v::Vector{UInt8})::String
GC.@preserve v unsafe_string(pointer(v), length(v))
end

Expand Down Expand Up @@ -72,7 +72,7 @@ Return the name of entry `i`.

`i` can range from `1:zip_nentries(x)`
"""
zip_name(x::HasEntries, i::Integer)::String = copy_string(_name_view(x, i))
zip_name(x::HasEntries, i::Integer)::String = bytes2string(_name_view(x, i))

"""
zip_names(x::HasEntries)::Vector{String}
Expand Down Expand Up @@ -111,7 +111,7 @@ zip_iscompressed(x::HasEntries, i::Integer)::Bool = x.entries[i].method != Store

Return the comment attached to entry `i`
"""
zip_comment(x::HasEntries, i::Integer)::String = copy_string(view(x.central_dir_buffer, x.entries[i].comment_range))
zip_comment(x::HasEntries, i::Integer)::String = bytes2string(view(x.central_dir_buffer, x.entries[i].comment_range))

"""
zip_stored_crc32(x::HasEntries, i::Integer)::UInt32
Expand Down Expand Up @@ -301,7 +301,7 @@ function zip_readentry(r::ZipReader, s::AbstractString)
end

function zip_readentry(r::ZipReader, i::Union{AbstractString, Integer}, ::Type{String})
copy_string(zip_readentry(r, i))
bytes2string(zip_readentry(r, i))
end


Expand Down
2 changes: 1 addition & 1 deletion src/writer.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ function zip_append_archive(io::IO; trunc_footer=true, zip_kwargs=(;))::ZipWrite
w.central_dir_buffer = central_dir_buffer
if w.check_names
for e in entries
add_name_used!(copy_string(view(central_dir_buffer, e.name_range)), w.used_names, w.used_stripped_dir_names)
add_name_used!(bytes2string(view(central_dir_buffer, e.name_range)), w.used_names, w.used_stripped_dir_names)
end
end
w
Expand Down
2 changes: 1 addition & 1 deletion test/runtests.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Random.seed!(1234)


# @test Any[] == detect_ambiguities(Base, Core, ZipArchives)
include("test_copy_string.jl")
include("test_bytes2string.jl")
include("test_simple-usage.jl")
include("test_filename-checks.jl")
include("test_show.jl")
Expand Down
20 changes: 10 additions & 10 deletions test/test_copy_string.jl → test/test_bytes2string.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,41 +1,41 @@
include("common.jl")
using OffsetArrays: Origin

@testset "copy_string" begin
# copy_string is an internal function
@testset "bytes2string" begin
# bytes2string is an internal function

a = UInt8[]
s = ZipArchives.copy_string(a)
s = ZipArchives.bytes2string(a)
@test s == ""
@test a == UInt8[]
push!(a, 0x61)
@test s == ""
s = ZipArchives.copy_string(a)
s = ZipArchives.bytes2string(a)
@test s == "a"
@test a == [0x61]

a = UInt8[0x00]
s = ZipArchives.copy_string(a)
s = ZipArchives.bytes2string(a)
@test s == "\0"
@test a == UInt8[0x00]
push!(a, 0x61)
@test s == "\0"
s = ZipArchives.copy_string(a)
s = ZipArchives.bytes2string(a)
@test s == "\0a"
@test a == [0x00, 0x61]

a = UInt8[0x00]
s = ZipArchives.copy_string(a)
s = ZipArchives.bytes2string(a)
@test s == "\0"
@test a == UInt8[0x00]
pushfirst!(a, 0x61)
@test s == "\0"
s = ZipArchives.copy_string(a)
s = ZipArchives.bytes2string(a)
@test s == "a\0"
@test a == [0x61, 0x00]

a = Origin(0)([0x61,0x62,0x63])
b = ZipArchives.copy_string(a)
b = ZipArchives.bytes2string(a)
@test a == Origin(0)([0x61,0x62,0x63])
@test b == "abc"
a[0] = 0x62
Expand All @@ -48,7 +48,7 @@ using OffsetArrays: Origin
@test a == [0x61,0x62,0x63]
b = reshape(a, 1, 3)
c = reshape(b, 3)
s = ZipArchives.copy_string(a)
s = ZipArchives.bytes2string(a)
@test a == [0x61,0x62,0x63]
@test c == [0x61,0x62,0x63]
@test s == "abc"
Expand Down
Loading