mirror of
https://github.com/nim-lang/Nim.git
synced 2026-08-01 13:09:14 +00:00
ddcaed7f70
These functions are unused and never exposed publically - along with it, get rid of `GC_Strategy` - although it's possible someone could use this `enum` for their own code it seems unlikely.
88 lines
3.4 KiB
Nim
88 lines
3.4 KiB
Nim
# ----------------- GC interface ---------------------------------------------
|
|
|
|
when not usesDestructors:
|
|
{.pragma: nodestroy.}
|
|
|
|
when hasAlloc and not defined(js) and not usesDestructors:
|
|
proc GC_disable*() {.rtl, inl, gcsafe, raises: [].}
|
|
## Disables the GC. If called `n` times, `n` calls to `GC_enable`
|
|
## are needed to reactivate the GC.
|
|
##
|
|
## Note that in most circumstances one should only disable
|
|
## the mark and sweep phase with
|
|
## `GC_disableMarkAndSweep <#GC_disableMarkAndSweep>`_.
|
|
|
|
proc GC_enable*() {.rtl, inl, gcsafe, raises: [].}
|
|
## Enables the GC again.
|
|
|
|
proc GC_fullCollect*() {.rtl, gcsafe, raises: [].}
|
|
## Forces a full garbage collection pass.
|
|
## Ordinary code does not need to call this (and should not).
|
|
|
|
proc GC_enableMarkAndSweep*() {.rtl, gcsafe, raises: [].}
|
|
proc GC_disableMarkAndSweep*() {.rtl, gcsafe, raises: [].}
|
|
## The current implementation uses a reference counting garbage collector
|
|
## with a seldomly run mark and sweep phase to free cycles. The mark and
|
|
## sweep phase may take a long time and is not needed if the application
|
|
## does not create cycles. Thus the mark and sweep phase can be deactivated
|
|
## and activated separately from the rest of the GC.
|
|
|
|
proc GC_getStatistics*(): string {.rtl, gcsafe, raises: [].}
|
|
## Returns an informative string about the GC's activity. This may be useful
|
|
## for tweaking.
|
|
|
|
proc GC_ref*[T](x: ref T) {.magic: "GCref", gcsafe, raises: [].}
|
|
proc GC_ref*[T](x: seq[T]) {.magic: "GCref", gcsafe, raises: [].}
|
|
proc GC_ref*(x: string) {.magic: "GCref", gcsafe, raises: [].}
|
|
## Marks the object `x` as referenced, so that it will not be freed until
|
|
## it is unmarked via `GC_unref`.
|
|
## If called n-times for the same object `x`,
|
|
## n calls to `GC_unref` are needed to unmark `x`.
|
|
|
|
proc GC_unref*[T](x: ref T) {.magic: "GCunref", gcsafe, raises: [].}
|
|
proc GC_unref*[T](x: seq[T]) {.magic: "GCunref", gcsafe, raises: [].}
|
|
proc GC_unref*(x: string) {.magic: "GCunref", gcsafe, raises: [].}
|
|
## See the documentation of `GC_ref <#GC_ref,string>`_.
|
|
|
|
proc nimGC_setStackBottom*(theStackBottom: pointer) {.compilerRtl, noinline, gcsafe, raises: [].}
|
|
## Expands operating GC stack range to `theStackBottom`. Does nothing
|
|
## if current stack bottom is already lower than `theStackBottom`.
|
|
|
|
when hasAlloc and defined(js):
|
|
template GC_disable* =
|
|
{.warning: "GC_disable is a no-op in JavaScript".}
|
|
|
|
template GC_enable* =
|
|
{.warning: "GC_enable is a no-op in JavaScript".}
|
|
|
|
template GC_fullCollect* =
|
|
{.warning: "GC_fullCollect is a no-op in JavaScript".}
|
|
|
|
template GC_enableMarkAndSweep* =
|
|
{.warning: "GC_enableMarkAndSweep is a no-op in JavaScript".}
|
|
|
|
template GC_disableMarkAndSweep* =
|
|
{.warning: "GC_disableMarkAndSweep is a no-op in JavaScript".}
|
|
|
|
template GC_ref*[T](x: ref T) =
|
|
{.warning: "GC_ref is a no-op in JavaScript".}
|
|
|
|
template GC_ref*[T](x: seq[T]) =
|
|
{.warning: "GC_ref is a no-op in JavaScript".}
|
|
|
|
template GC_ref*(x: string) =
|
|
{.warning: "GC_ref is a no-op in JavaScript".}
|
|
|
|
template GC_unref*[T](x: ref T) =
|
|
{.warning: "GC_unref is a no-op in JavaScript".}
|
|
|
|
template GC_unref*[T](x: seq[T]) =
|
|
{.warning: "GC_unref is a no-op in JavaScript".}
|
|
|
|
template GC_unref*(x: string) =
|
|
{.warning: "GC_unref is a no-op in JavaScript".}
|
|
|
|
template GC_getStatistics*(): string =
|
|
{.warning: "GC_getStatistics is a no-op in JavaScript".}
|
|
""
|