implement getfield overloading

fix #16226 (close #16195)
fix #16195

Author: vtjnash

base/boot.jl

@@ -140,7 +140,7 @@ export
     Expr, GotoNode, LabelNode, LineNumberNode, QuoteNode,
     GlobalRef, NewvarNode, SSAValue, Slot, SlotNumber, TypedSlot,
     # object model functions
-    fieldtype, getfield, setfield!, nfields, throw, tuple, ===, isdefined, eval,
+    fieldtype, nfields, throw, tuple, ===, isdefined, eval,
     # sizeof    # not exported, to avoid conflicting with Base.sizeof
     # type reflection
     <:, typeof, isa, typeassert,

base/coreimg.jl

@@ -2,7 +2,7 @@
 
 Main.Core.eval(Main.Core, :(baremodule Inference
 using Core.Intrinsics
-import Core: print, println, show, write, unsafe_write, STDOUT, STDERR
+import Core: print, println, show, write, unsafe_write, STDOUT, STDERR, getfield, setfield!
 
 ccall(:jl_set_istopmod, Void, (Any, Bool), Inference, false)
 

base/exports.jl

@@ -910,6 +910,8 @@ export
 
 # types
     convert,
+    getfield,
+    setfield!,
     fieldoffset,
     fieldname,
     fieldnames,

base/namedtuple.jl

@@ -35,10 +35,10 @@ another named tuple.
 function NamedTuple{names}(nt::NamedTuple) where {names}
     if @generated
         types = Tuple{(fieldtype(nt, n) for n in names)...}
-        Expr(:new, :(NamedTuple{names, $types}), Any[ :(getfield(nt, $(QuoteNode(n)))) for n in names ]...)
+        Expr(:new, :(NamedTuple{names, $types}), Any[ :(Core.getfield(nt, $(QuoteNode(n)))) for n in names ]...)
     else
         types = Tuple{(fieldtype(typeof(nt), n) for n in names)...}
-        NamedTuple{names, types}(Tuple(getfield(nt, n) for n in names))
+        NamedTuple{names, types}(Tuple(Core.getfield(nt, n) for n in names))
     end
 end
 
@@ -47,11 +47,11 @@ end # if Base
 length(t::NamedTuple) = nfields(t)
 start(t::NamedTuple) = 1
 done(t::NamedTuple, iter) = iter > nfields(t)
-next(t::NamedTuple, iter) = (getfield(t, iter), iter + 1)
+next(t::NamedTuple, iter) = (Core.getfield(t, iter), iter + 1)
 endof(t::NamedTuple) = nfields(t)
-getindex(t::NamedTuple, i::Int) = getfield(t, i)
-getindex(t::NamedTuple, i::Symbol) = getfield(t, i)
-indexed_next(t::NamedTuple, i::Int, state) = (getfield(t, i), i+1)
+getindex(t::NamedTuple, i::Int) = Core.getfield(t, i)
+getindex(t::NamedTuple, i::Symbol) = Core.getfield(t, i)
+indexed_next(t::NamedTuple, i::Int, state) = (Core.getfield(t, i), i+1)
 isempty(::NamedTuple{()}) = true
 isempty(::NamedTuple) = false
 
@@ -66,7 +66,7 @@ function show(io::IO, t::NamedTuple)
     n = nfields(t)
     for i = 1:n
         # if field types aren't concrete, show full type
-        if typeof(getfield(t, i)) !== fieldtype(typeof(t), i)
+        if typeof(Core.getfield(t, i)) !== fieldtype(typeof(t), i)
             show(io, typeof(t))
             print(io, "(")
             show(io, Tuple(t))
@@ -79,7 +79,7 @@ function show(io::IO, t::NamedTuple)
     else
         print(io, "(")
         for i = 1:n
-            print(io, fieldname(typeof(t),i), " = "); show(io, getfield(t, i))
+            print(io, fieldname(typeof(t),i), " = "); show(io, Core.getfield(t, i))
             if n == 1
                 print(io, ",")
             elseif i < n
@@ -118,7 +118,7 @@ function map(f, nt::NamedTuple{names}, nts::NamedTuple...) where names
     if @generated
         N = length(names)
         M = length(nts)
-        args = Expr[:(f($(Expr[:(getfield(nt, $j)), (:(getfield(nts[$i], $j)) for i = 1:M)...]...))) for j = 1:N]
+        args = Expr[:(f($(Expr[:(Core.getfield(nt, $j)), (:(Core.getfield(nts[$i], $j)) for i = 1:M)...]...))) for j = 1:N]
         :( NT(($(args...),)) )
     else
         NT(map(f, map(Tuple, (nt, nts...))...))
@@ -164,12 +164,12 @@ function merge(a::NamedTuple{an}, b::NamedTuple{bn}) where {an, bn}
     if @generated
         names = merge_names(an, bn)
         types = merge_types(names, a, b)
-        vals = Any[ :(getfield($(sym_in(n, bn) ? :b : :a), $(QuoteNode(n)))) for n in names ]
+        vals = Any[ :(Core.getfield($(sym_in(n, bn) ? :b : :a), $(QuoteNode(n)))) for n in names ]
         :( NamedTuple{$names,$types}(($(vals...),)) )
     else
         names = merge_names(an, bn)
         types = merge_types(names, typeof(a), typeof(b))
-        NamedTuple{names,types}(map(n->getfield(sym_in(n, bn) ? b : a, n), names))
+        NamedTuple{names,types}(map(n->Core.getfield(sym_in(n, bn) ? b : a, n), names))
     end
 end
 
@@ -205,8 +205,8 @@ end
 keys(nt::NamedTuple{names}) where {names} = names
 values(nt::NamedTuple) = Tuple(nt)
 haskey(nt::NamedTuple, key::Union{Integer, Symbol}) = isdefined(nt, key)
-get(nt::NamedTuple, key::Union{Integer, Symbol}, default) = haskey(nt, key) ? getfield(nt, key) : default
-get(f::Callable, nt::NamedTuple, key::Union{Integer, Symbol}) = haskey(nt, key) ? getfield(nt, key) : f()
+get(nt::NamedTuple, key::Union{Integer, Symbol}, default) = haskey(nt, key) ? Core.getfield(nt, key) : default
+get(f::Callable, nt::NamedTuple, key::Union{Integer, Symbol}) = haskey(nt, key) ? Core.getfield(nt, key) : f()
 
 @pure function diff_names(an::Tuple{Vararg{Symbol}}, bn::Tuple{Vararg{Symbol}})
     names = Symbol[]
@@ -228,11 +228,11 @@ function structdiff(a::NamedTuple{an}, b::Union{NamedTuple{bn}, Type{NamedTuple{
     if @generated
         names = diff_names(an, bn)
         types = Tuple{Any[ fieldtype(a, n) for n in names ]...}
-        vals = Any[ :(getfield(a, $(QuoteNode(n)))) for n in names ]
+        vals = Any[ :(Core.getfield(a, $(QuoteNode(n)))) for n in names ]
         :( NamedTuple{$names,$types}(($(vals...),)) )
     else
         names = diff_names(an, bn)
         types = Tuple{Any[ fieldtype(typeof(a), n) for n in names ]...}
-        NamedTuple{names,types}(map(n->getfield(a, n), names))
+        NamedTuple{names,types}(map(n->Core.getfield(a, n), names))
     end
 end

base/sysimg.jl

@@ -3,6 +3,16 @@
 baremodule Base
 
 using Core.Intrinsics
+getfield(x, f) = Core.getfield(x, f)
+setfield!(x, f, v) = Core.setfield!(x, f, convert(Core.fieldtype(Core.typeof(x), f), v))
+
+getfield(x::Module, f::Symbol) = Core.getfield(x, f)
+setfield!(x::Module, f::Symbol, v) = Core.setfield!(x, f, v)
+getfield(x::Type, f::Symbol) = Core.getfield(x, f)
+setfield!(x::Type, f::Symbol, v) = Core.setfield!(x, f, v)
+getfield(x::Type, f::Int) = Core.getfield(x, f)
+setfield!(x::Type, f::Int, v) = Core.setfield!(x, f, v)
+
 ccall(:jl_set_istopmod, Void, (Any, Bool), Base, true)
 
 function include(mod::Module, path::AbstractString)

base/tuple.jl

@@ -18,8 +18,8 @@ NTuple
 length(t::Tuple) = nfields(t)
 endof(t::Tuple) = length(t)
 size(t::Tuple, d) = (d == 1) ? length(t) : throw(ArgumentError("invalid tuple dimension $d"))
-@eval getindex(t::Tuple, i::Int) = getfield(t, i, $(Expr(:boundscheck)))
-@eval getindex(t::Tuple, i::Real) = getfield(t, convert(Int, i), $(Expr(:boundscheck)))
+@eval getindex(t::Tuple, i::Int) = Core.getfield(t, i, $(Expr(:boundscheck)))
+@eval getindex(t::Tuple, i::Real) = Core.getfield(t, convert(Int, i), $(Expr(:boundscheck)))
 getindex(t::Tuple, r::AbstractArray{<:Any,1}) = ([t[ri] for ri in r]...,)
 getindex(t::Tuple, b::AbstractArray{Bool,1}) = length(b) == length(t) ? getindex(t, find(b)) : throw(BoundsError(t, b))
 

src/julia-syntax.scm

@@ -1752,7 +1752,7 @@
     (if (and (pair? e) (eq? (car e) '|.|))
         (let ((f (cadr e)) (x (caddr e)))
           (cond ((or (eq? (car x) 'quote) (eq? (car x) 'inert) (eq? (car x) '$))
-                 `(call (core getfield) ,f ,x))
+                 `(call (top getfield) ,f ,x))
                 ((eq? (car x) 'tuple)
                  (make-fuse f (cdr x)))
                 (else
@@ -2039,10 +2039,12 @@
                 ,.(if (eq? aa a)   '() `((= ,aa ,(expand-forms a))))
                 ,.(if (eq? bb b)   '() `((= ,bb ,(expand-forms b))))
                 ,.(if (eq? rr rhs) '() `((= ,rr ,(expand-forms rhs))))
-                (call (core setfield!) ,aa ,bb
-                      (call (top convert)
-                            (call (core fieldtype) (call (core typeof) ,aa) ,bb)
-                            ,rr))
+                (call (top setfield!) ,aa ,bb
+                      (if (call (top ===) (top setfield!) (core setfield!))
+		          (call (top convert)
+                                (call (core fieldtype) (call (core typeof) ,aa) ,bb)
+                                ,rr)
+			  ,rr))
                 (unnecessary ,rr)))))
          ((tuple)
           ;; multiple assignment

test/core.jl

@@ -997,36 +997,44 @@ end
 
 let
     local z = complex(3, 4)
-    v = Int[0,0]
-    for i=1:2
-        v[i] = getfield(z, i)
+    v = Int[0, 0]
+    for i = 1:2
+        v[i] = Core.getfield(z, i)
     end
-    @test v == [3,4]
-    @test_throws BoundsError getfield(z, -1)
-    @test_throws BoundsError getfield(z, 0)
-    @test_throws BoundsError getfield(z, 3)
+    @test v == [3, 4]
+    @test_throws BoundsError(z, -1) Core.getfield(z, -1)
+    @test_throws BoundsError(z, 0) Core.getfield(z, 0)
+    @test_throws BoundsError(z, 3) Core.getfield(z, 3)
 
     strct = LoadError("yofile", 0, "bad")
-    @test_throws BoundsError getfield(strct, 10)
-    @test_throws ErrorException setfield!(strct, 0, "")
-    @test_throws ErrorException setfield!(strct, 4, "")
+    @test nfields(strct) == 3 # sanity test
+    @test_throws BoundsError(strct, 10) Core.getfield(strct, 10)
+    @test_throws BoundsError(strct, 10) getfield(strct, 10)
+    @test_throws ErrorException("type LoadError is immutable") Core.setfield!(strct, 0, "")
+    @test_throws ErrorException("type LoadError is immutable") Core.setfield!(strct, 4, "")
+    @test_throws BoundsError(LoadError, 0) setfield!(strct, 0, "")
+    @test_throws BoundsError(LoadError, 4) setfield!(strct, 4, "")
     @test strct.file == "yofile"
     @test strct.line == 0
     @test strct.error == "bad"
-    @test getfield(strct, 1) == "yofile"
-    @test getfield(strct, 2) == 0
-    @test getfield(strct, 3) == "bad"
+    @test Core.getfield(strct, 1) == "yofile"
+    @test Core.getfield(strct, 2) == 0
+    @test Core.getfield(strct, 3) == "bad"
 
     mstrct = TestMutable("melm", 1, nothing)
-    setfield!(mstrct, 2, 8)
+    setfield!(mstrct, 2, 8.0)
     @test mstrct.line == 8
-    setfield!(mstrct, 3, "hi")
+    @test_throws TypeError(:setfield!, "", Int, 8.0) Core.setfield!(mstrct, 2, 8.0)
+    Core.setfield!(mstrct, 3, "hi")
     @test mstrct.error == "hi"
-    setfield!(mstrct, 1, "yo")
+    Core.setfield!(mstrct, 1, "yo")
     @test mstrct.file == "yo"
-    @test_throws BoundsError getfield(mstrct, 10)
-    @test_throws BoundsError setfield!(mstrct, 0, "")
-    @test_throws BoundsError setfield!(mstrct, 4, "")
+    @test_throws BoundsError(mstrct, 10) Core.getfield(mstrct, 10)
+    @test_throws BoundsError(mstrct, 0) Core.setfield!(mstrct, 0, "")
+    @test_throws BoundsError(mstrct, 4) Core.setfield!(mstrct, 4, "")
+    @test_throws BoundsError(mstrct, 10) getfield(mstrct, 10)
+    @test_throws BoundsError(TestMutable, 0) setfield!(mstrct, 0, "")
+    @test_throws BoundsError(TestMutable, 4) setfield!(mstrct, 4, "")
 end
 
 # allow typevar in Union to match as long as the arguments contain
@@ -2175,10 +2183,9 @@ g7652() = fieldtype(DataType, :types)
 h7652() = setfield!(a7652, 1, 2)
 h7652()
 @test a7652.a == 2
-# commented out due to issue #16195: setfield! does not perform conversions
-#   i7652() = setfield!(a7652, 1, 3.0)
-#   i7652()
-#   @test a7652.a == 3
+i7652() = setfield!(a7652, 1, 3.0)
+i7652()
+@test a7652.a == 3
 
 # issue #7679
 @test map(f->f(), Any[ ()->i for i=1:3 ]) == Any[1,2,3]
@@ -2358,49 +2365,53 @@ let
 end
 
 # pull request #9534
-@test try; a,b,c = 1,2; catch ex; (ex::BoundsError).a === (1,2) && ex.i == 3; end
-# @test try; [][]; catch ex; isempty((ex::BoundsError).a::Array{Any,1}) && ex.i == (1,); end # TODO: Re-enable after PLI
-@test try; [][1,2]; catch ex; isempty((ex::BoundsError).a::Array{Any,1}) && ex.i == (1,2); end
-@test try; [][10]; catch ex; isempty((ex::BoundsError).a::Array{Any,1}) && ex.i == (10,); end
-f9534a() = (a=1+2im; getfield(a, -100))
-f9534a(x) = (a=1+2im; getfield(a, x))
-@test try; f9534a() catch ex; (ex::BoundsError).a === 1+2im && ex.i == -100; end
-@test try; f9534a(3) catch ex; (ex::BoundsError).a === 1+2im && ex.i == 3; end
-f9534b() = (a=(1,2.,""); a[5])
-f9534b(x) = (a=(1,2.,""); a[x])
-@test try; f9534b() catch ex; (ex::BoundsError).a == (1,2.,"") && ex.i == 5; end
-@test try; f9534b(4) catch ex; (ex::BoundsError).a == (1,2.,"") && ex.i == 4; end
-f9534c() = (a=(1,2.); a[3])
-f9534c(x) = (a=(1,2.); a[x])
-@test try; f9534c() catch ex; (ex::BoundsError).a === (1,2.) && ex.i == 3; end
-@test try; f9534c(0) catch ex; (ex::BoundsError).a === (1,2.) && ex.i == 0; end
-f9534d() = (a=(1,2,4,6,7); a[7])
-f9534d(x) = (a=(1,2,4,6,7); a[x])
-@test try; f9534d() catch ex; (ex::BoundsError).a === (1,2,4,6,7) && ex.i == 7; end
-@test try; f9534d(-1) catch ex; (ex::BoundsError).a === (1,2,4,6,7) && ex.i == -1; end
-f9534e(x) = (a=IOBuffer(); setfield!(a, x, 3))
-@test try; f9534e(-2) catch ex; isa((ex::BoundsError).a,Base.IOBuffer) && ex.i == -2; end
-f9534f() = (a=IOBuffer(); getfield(a, -2))
-f9534f(x) = (a=IOBuffer(); getfield(a, x))
-@test try; f9534f() catch ex; isa((ex::BoundsError).a,Base.IOBuffer) && ex.i == -2; end
-@test try; f9534f(typemin(Int)+2) catch ex; isa((ex::BoundsError).a,Base.IOBuffer) && ex.i == typemin(Int)+2; end
+@test_throws BoundsError((1, 2), 3) begin; a, b, c = 1, 2; end
+let a = []
+    @test_broken try; a[]; catch ex; (ex::BoundsError).a === a && ex.i == (1,); end # TODO: Re-enable after PLI
+    @test_throws BoundsError(a, (1, 2)) a[1, 2]
+    @test_throws BoundsError(a, (10,)) a[10]
+end
+f9534a() = (a = 1 + 2im; Core.getfield(a, -100))
+f9534a(x) = (a = 1 + 2im; Core.getfield(a, x))
+@test_throws BoundsError(1 + 2im, -100) f9534a()
+@test_throws BoundsError(1 + 2im, 3) f9534a(3)
+f9534b() = (a = (1, 2., ""); a[5])
+f9534b(x) = (a = (1, 2., ""); a[x])
+@test_throws BoundsError((1, 2., ""), 5) f9534b()
+@test_throws BoundsError((1, 2., ""), 4) f9534b(4)
+f9534c() = (a = (1, 2.); a[3])
+f9534c(x) = (a = (1, 2.); a[x])
+@test_throws BoundsError((1, 2.), 3) f9534c()
+@test_throws BoundsError((1, 2.), 0) f9534c(0)
+f9534d() = (a = (1, 2, 4, 6, 7); a[7])
+f9534d(x) = (a = (1, 2, 4, 6, 7); a[x])
+@test_throws BoundsError((1, 2, 4, 6, 7), 7) f9534d()
+@test_throws BoundsError((1, 2, 4, 6, 7), -1) f9534d(-1)
+let a = IOBuffer()
+    f9534e(x) = Core.setfield!(a, x, 3)
+    @test_throws BoundsError(a, -2) f9534e(-2)
+    f9534f() = Core.getfield(a, -2)
+    f9534f(x) = Core.getfield(a, x)
+    @test_throws BoundsError(a, -2) f9534f()
+    @test_throws BoundsError(a, typemin(Int) + 2) f9534f(typemin(Int) + 2)
+end
 x9634 = 3
-@test try; getfield(1+2im, x9634); catch ex; (ex::BoundsError).a === 1+2im && ex.i == 3; end
-@test try; throw(BoundsError()) catch ex; !isdefined((ex::BoundsError), :a) && !isdefined((ex::BoundsError), :i); end
-@test try; throw(BoundsError(Int)) catch ex; (ex::BoundsError).a == Int && !isdefined((ex::BoundsError), :i); end
-@test try; throw(BoundsError(Int, typemin(Int))) catch ex; (ex::BoundsError).a == Int && (ex::BoundsError).i == typemin(Int); end
-@test try; throw(BoundsError(Int, (:a,))) catch ex; (ex::BoundsError).a == Int && (ex::BoundsError).i == (:a,); end
-f9534g(a,b,c...) = c[0]
-@test try; f9534g(1,2,3,4,5,6) catch ex; (ex::BoundsError).a === (3,4,5,6) && ex.i == 0; end
-f9534h(a,b,c...) = c[a]
-@test f9534h(4,2,3,4,5,6) == 6
-@test try; f9534h(5,2,3,4,5,6) catch ex; (ex::BoundsError).a === (3,4,5,6) && ex.i == 5; end
+@test_throws BoundsError(1 + 2im, 3) Core.getfield(1 + 2im, x9634)
+@test try; throw(BoundsError()); catch ex; !isdefined((ex::BoundsError), :a) && !isdefined((ex::BoundsError), :i); end
+@test try; throw(BoundsError(Int)); catch ex; (ex::BoundsError).a == Int && !isdefined((ex::BoundsError), :i); end
+@test_throws BoundsError(Int, typemin(Int)) throw(BoundsError(Int, typemin(Int)))
+@test_throws BoundsError(Int, (:a,)) throw(BoundsError(Int, (:a,)))
+f9534g(a, b, c...) = c[0]
+@test_throws BoundsError((3, 4, 5, 6), 0) f9534g(1, 2, 3, 4, 5, 6)
+f9534h(a, b, c...) = c[a]
+@test f9534h(4, 2, 3, 4, 5, 6) == 6
+@test_throws BoundsError((3, 4, 5, 6), 5) f9534h(5, 2, 3, 4, 5, 6)
 
 # issue #7978, comment 332352438
 f7978a() = 1
-@test try; a, b = f7978a() catch ex; (ex::BoundsError).a == 1 && ex.i == 2; end
+@test_throws BoundsError(1, 2) begin; a, b = f7978a(); end
 f7978b() = 1, 2
-@test try; a, b, c = f7978b() catch ex; (ex::BoundsError).a == (1, 2) && ex.i == 3; end
+@test_throws BoundsError((1, 2), 3) begin; a, b, c = f7978b(); end
 
 # issue #9535
 counter9535 = 0

test/reflection.jl

@@ -505,14 +505,14 @@ test_typed_ast_printing(g15714, Tuple{Vector{Float32}},
 @test used_dup_var_tested15714
 @test used_unique_var_tested15714
 
-let li = typeof(getfield).name.mt.cache.func::Core.MethodInstance,
+let li = typeof(fieldtype).name.mt.cache.func::Core.MethodInstance,
     lrepr = string(li),
     mrepr = string(li.def),
     lmime = stringmime("text/plain", li),
     mmime = stringmime("text/plain", li.def)
 
-    @test lrepr == lmime == "MethodInstance for getfield(...)"
-    @test mrepr == mmime == "getfield(...) in Core"
+    @test lrepr == lmime == "MethodInstance for fieldtype(...)"
+    @test mrepr == mmime == "fieldtype(...) in Core"
 end
 
 

test/stacktraces.jl

@@ -109,10 +109,10 @@ let src = Meta.lower(Main, quote let x = 1 end end).args[1]::CodeInfo,
     repr = string(sf)
     @test repr == "Toplevel MethodInstance thunk at b:3"
 end
-let li = typeof(getfield).name.mt.cache.func::Core.MethodInstance,
+let li = typeof(fieldtype).name.mt.cache.func::Core.MethodInstance,
     sf = StackFrame(:a, :b, 3, li, false, false, 0),
     repr = string(sf)
-    @test repr == "getfield(...) at b:3"
+    @test repr == "fieldtype(...) at b:3"
 end
 
 let ctestptr = cglobal((:ctest, "libccalltest")),

test/vecelement.jl

@@ -90,7 +90,7 @@ const _llvmtypes = Dict{DataType, String}(
     """
     return quote
         Base.@_inline_meta
-        Base.llvmcall($exp, Vec{$N, $T}, Tuple{Vec{$N, $T}, Vec{$N, $T}}, x, y)
+        Core.getfield(Base, :llvmcall)($exp, Vec{$N, $T}, Tuple{Vec{$N, $T}, Vec{$N, $T}}, x, y)
     end
 end