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.

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

AnnotatedString support #180

Merged
merged 2 commits into from
Dec 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
15 changes: 15 additions & 0 deletions src/functionlenses.jl
Original file line number Diff line number Diff line change
Expand Up @@ -204,3 +204,18 @@ function set(s::AbstractString, o::Base.Fix2{typeof(split), <:Union{AbstractChar
any(c -> occursin(o.x, c), v) && throw(ArgumentError("split components cannot contain the delimiter $(repr(o.x))"))
join(v, o.x)
end

if isdefined(Base, :AnnotatedString)
# 1.11+
using Base: AnnotatedString, AnnotatedChar, annotations

set(s::AbstractString, ::typeof(annotations), anns) = AnnotatedString(s, anns)
set(s::AnnotatedString, ::typeof(annotations), anns) = AnnotatedString(s.string, anns)
delete(s::AnnotatedString, ::typeof(annotations)) = s.string
insert(s::AbstractString, ::typeof(annotations), anns) = AnnotatedString(s, anns)

set(s::AbstractChar, ::typeof(annotations), anns) = AnnotatedChar(s, anns)
set(s::AnnotatedChar, ::typeof(annotations), anns) = AnnotatedChar(s.char, anns)
delete(s::AnnotatedChar, ::typeof(annotations)) = s.char
insert(s::AbstractChar, ::typeof(annotations), anns) = AnnotatedChar(s, anns)
end
38 changes: 38 additions & 0 deletions test/test_functionlenses.jl
Original file line number Diff line number Diff line change
Expand Up @@ -396,6 +396,44 @@ end
@test_throws ArgumentError set(" abc def ", @optic(split(_, ' ')), [" ", "y"])
end

VERSION ≥ v"1.11" && @testset "AnnotatedStrings" begin
using Base: AnnotatedChar, AnnotatedString, annotations

s = AnnotatedString("good bad", [(region=1:4, label=:sentiment, value=+1), (region=6:8, label=:sentiment, value=-1)])

@test (@delete annotations(s))::String == "good bad"

snew = @delete annotations(s)[2]
@test String(snew) == "good bad"
@test annotations(snew) == [(region=1:4, label=:sentiment, value=+1)]

snew = (@set annotations(s)[1].region = 2:6)
@test String(snew) == "good bad"
@test annotations(snew) == [(region=2:6, label=:sentiment, value=+1), (region=6:8, label=:sentiment, value=-1)]

test_getset_laws((@o annotations(_)[2].region), s, 5:5, 1:3)
test_getset_laws((@o annotations(_)[2].label), s, :abc, :def)
test_getset_laws((@o annotations(_)[2].value), s, "sad", +2)
test_insertdelete_laws((@o annotations(_)[2]), s, (region=2:2, label=:mylabel, value=+1))


c = AnnotatedChar('x', [(label=:level, value="warning"), (label=:alphabet, value=1)])

@test (@delete annotations(c))::Char == 'x'

cnew = @delete annotations(c)[2]
@test Char(cnew) == 'x'
@test annotations(cnew) == [(label=:level, value="warning")]

cnew = (@set annotations(c)[1].label = :severity)
@test Char(cnew) == 'x'
@test annotations(cnew) == [(label=:severity, value="warning"), (label=:alphabet, value=1)]

test_getset_laws((@o annotations(_)[2].label), c, :abc, :def)
test_getset_laws((@o annotations(_)[1].value), c, 5, "bad")
test_insertdelete_laws((@o annotations(_)[2]), c, (label=:mylabel, value=+1))
end

@testset "custom binary function" begin
↑(x, y) = x - y
Accessors.set(x, f::Base.Fix1{typeof(↑)}, y) = f.x - y
Expand Down
Loading