Skip to content

Commit

Permalink
Introduce explicit copy (#15330)
Browse files Browse the repository at this point in the history
  • Loading branch information
cooldome authored Sep 16, 2020
1 parent ae4ede6 commit a3e9cc5
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 1 deletion.
2 changes: 1 addition & 1 deletion compiler/injectdestructors.nim
Original file line number Diff line number Diff line change
Expand Up @@ -408,7 +408,7 @@ proc passCopyToSink(n: PNode; c: var Con; s: var Scope): PNode =
if isLValue(n) and not isCapturedVar(n) and n.typ.skipTypes(abstractInst).kind != tyRef and c.inSpawn == 0:
message(c.graph.config, n.info, hintPerformance,
("passing '$1' to a sink parameter introduces an implicit copy; " &
"if possible, rearrange your program's control flow to prevent it") % $n)
"if possible, rearrange your program's control flow to prevent it or use 'copy($1)' to hint the compiler it is intentional") % $n)
else:
if c.graph.config.selectedGC in {gcArc, gcOrc}:
assert(not containsGarbageCollectedRef(n.typ))
Expand Down
5 changes: 5 additions & 0 deletions lib/system.nim
Original file line number Diff line number Diff line change
Expand Up @@ -264,6 +264,11 @@ proc move*[T](x: var T): T {.magic: "Move", noSideEffect.} =
result = x
wasMoved(x)

func copy*[T](x: T): T {.inline.} =
## make explicit copy of the argument `x`, used to signal to the compiler
## the copy is intentional
result = x

type
range*[T]{.magic: "Range".} ## Generic type to construct range types.
array*[I, T]{.magic: "Array".} ## Generic type to construct
Expand Down
22 changes: 22 additions & 0 deletions tests/arc/tcopytosink_warning.nim
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
discard """
cmd: "nim c --gc:arc $file"
nimout: '''tcopytosink_warning.nim(17, 7) Hint: myhint [User]
tcopytosink_warning.nim(19, 9) Hint: passing 'x' to a sink parameter introduces an implicit copy; if possible, rearrange your program's control flow to prevent it or use 'copy(x)' to hint the compiler it is intentional [Performance]
'''
output: "x"
"""
import macros

proc test(v: var seq[string], x: sink string) =
v.add x

var v = @["a", "b", "c"]
var x = "x"

static:
hint("myhint")
test(v, copy(x)) # no warning
test(v, x) # produces warning

echo x # use after sink

0 comments on commit a3e9cc5

Please sign in to comment.