jyapayne/Nim
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

add docs to copyNimNode and copyNimTree (#20357)

Browse source 
* add docs to copyNimNode and copyNimTree

* Apply suggestions from code review

Co-authored-by: Clay Sweetser <Varriount@users.noreply.github.com>

Co-authored-by: Clay Sweetser <Varriount@users.noreply.github.com>
This commit is contained in:
ringabout 2022-09-16 12:35:44 +08:00 • committed by GitHub
commit d44b547144
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 25 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

27
lib/core/macros.nim
View file

@ -394,8 +394,31 @@ proc newNimNode*(kind: NimNodeKind,
## produced code crashes. You should ensure that it is set to a node that ## produced code crashes. You should ensure that it is set to a node that
## you are transforming. ## you are transforming.
proc copyNimNode*(n: NimNode): NimNode {.magic: "NCopyNimNode", noSideEffect.} proc copyNimNode*(n: NimNode): NimNode {.magic: "NCopyNimNode", noSideEffect.} =
proc copyNimTree*(n: NimNode): NimNode {.magic: "NCopyNimTree", noSideEffect.} ## Creates a new AST node by copying the node `n`. Note that unlike `copyNimTree`,
## child nodes of `n` are not copied.
runnableExamples:
macro foo(x: typed) =
var s = copyNimNode(x)
doAssert s.len == 0
doAssert s.kind == nnkStmtList
foo:
let x = 12
echo x
proc copyNimTree*(n: NimNode): NimNode {.magic: "NCopyNimTree", noSideEffect.} =
## Creates a new AST node by recursively copying the node `n`. Note that
## unlike `copyNimNode`, this copies `n`, the children of `n`, etc.
runnableExamples:
macro foo(x: typed) =
var s = copyNimTree(x)
doAssert s.len == 2
doAssert s.kind == nnkStmtList
foo:
let x = 12
echo x
proc error*(msg: string, n: NimNode = nil) {.magic: "NError", benign.} proc error*(msg: string, n: NimNode = nil) {.magic: "NError", benign.}
## Writes an error message at compile time. The optional `n: NimNode` ## Writes an error message at compile time. The optional `n: NimNode`