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

Hyperlinks quit related docstrings in system module.

Browse source
This commit is contained in:
Grzegorz Adam Hankiewicz 2014-07-19 14:44:41 +02:00
commit 9c6d54dec6
1 changed files with 15 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

27
lib/system.nim
View file

@ -1006,11 +1006,11 @@ else:
const const
QuitSuccess* = 0 QuitSuccess* = 0
## is the value that should be passed to ``quit`` to indicate ## is the value that should be passed to `quit <#quit>`_ to indicate
## success. ## success.
QuitFailure* = 1 QuitFailure* = 1
## is the value that should be passed to ``quit`` to indicate ## is the value that should be passed to `quit <#quit>`_ to indicate
## failure. ## failure.
var programResult* {.exportc: "nim_program_result".}: int var programResult* {.exportc: "nim_program_result".}: int
@ -1023,10 +1023,11 @@ proc quit*(errorcode: int = QuitSuccess) {.
## Stops the program immediately with an exit code. ## Stops the program immediately with an exit code.
## ##
## Before stopping the program the "quit procedures" are called in the ## Before stopping the program the "quit procedures" are called in the
## opposite order they were added with ``addQuitProc``. ``quit`` never ## opposite order they were added with `addQuitProc <#addQuitProc>`_.
## returns and ignores any exception that may have been raised by the quit ## ``quit`` never returns and ignores any exception that may have been raised
## procedures. It does *not* call the garbage collector to free all the ## by the quit procedures. It does *not* call the garbage collector to free
## memory, unless a quit procedure calls ``GC_collect``. ## all the memory, unless a quit procedure calls `GC_fullCollect
## <#GC_fullCollect>`_.
## ##
## The proc ``quit(QuitSuccess)`` is called implicitly when your nimrod ## The proc ``quit(QuitSuccess)`` is called implicitly when your nimrod
## program finishes without incident. A raised unhandled exception is ## program finishes without incident. A raised unhandled exception is
@ -1034,7 +1035,8 @@ proc quit*(errorcode: int = QuitSuccess) {.
## ##
## Note that this is a *runtime* call and using ``quit`` inside a macro won't ## Note that this is a *runtime* call and using ``quit`` inside a macro won't
## have any compile time effect. If you need to stop the compiler inside a ## have any compile time effect. If you need to stop the compiler inside a
## macro, use the ``error`` or ``fatal`` pragmas. ## macro, use the `error <manual.html#error-pragma>`_ or `fatal
## <manual.html#fatal-pragma>`_ pragmas.
template sysAssert(cond: bool, msg: string) = template sysAssert(cond: bool, msg: string) =
when defined(useSysAssert): when defined(useSysAssert):
@ -1186,11 +1188,12 @@ proc toBiggestInt*(f: BiggestFloat): BiggestInt {.
proc addQuitProc*(QuitProc: proc() {.noconv.}) {. proc addQuitProc*(QuitProc: proc() {.noconv.}) {.
importc: "atexit", header: "<stdlib.h>".} importc: "atexit", header: "<stdlib.h>".}
## adds/registers a quit procedure. Each call to ``addQuitProc`` ## Adds/registers a quit procedure.
## registers another quit procedure. Up to 30 procedures can be ##
## registered. They are executed on a last-in, first-out basis ## Each call to ``addQuitProc`` registers another quit procedure. Up to 30
## (that is, the last function registered is the first to be executed). ## procedures can be registered. They are executed on a last-in, first-out
## ``addQuitProc`` raises an EOutOfIndex if ``quitProc`` cannot be ## basis (that is, the last function registered is the first to be executed).
## ``addQuitProc`` raises an EOutOfIndex exception if ``QuitProc`` cannot be
## registered. ## registered.
# Support for addQuitProc() is done by Ansi C's facilities here. # Support for addQuitProc() is done by Ansi C's facilities here.