mirror of
https://github.com/nim-lang/Nim.git
synced 2025-12-29 09:24:36 +00:00
87dc838370
* fixes #17033 [backport:1.4]
* make test robust against stdlib gensym things
* cleanup assertions.nim to make topt_no_cursor easier to get right
(cherry picked from commit f32ffb6ed8)
110 lines
3.8 KiB
Nim
110 lines
3.8 KiB
Nim
when not declared(sysFatal):
|
|
include "system/fatal"
|
|
|
|
import std/private/miscdollars
|
|
# ---------------------------------------------------------------------------
|
|
# helpers
|
|
|
|
type InstantiationInfo = tuple[filename: string, line: int, column: int]
|
|
|
|
proc `$`(x: int): string {.magic: "IntToStr", noSideEffect.}
|
|
proc `$`(info: InstantiationInfo): string =
|
|
# The +1 is needed here
|
|
# instead of overriding `$` (and changing its meaning), consider explicit name.
|
|
result = ""
|
|
result.toLocation(info.filename, info.line, info.column+1)
|
|
|
|
# ---------------------------------------------------------------------------
|
|
|
|
when not defined(nimHasSinkInference):
|
|
{.pragma: nosinks.}
|
|
|
|
proc raiseAssert*(msg: string) {.noinline, noreturn, nosinks.} =
|
|
sysFatal(AssertionDefect, msg)
|
|
|
|
proc failedAssertImpl*(msg: string) {.raises: [], tags: [].} =
|
|
# trick the compiler to not list ``AssertionDefect`` when called
|
|
# by ``assert``.
|
|
type Hide = proc (msg: string) {.noinline, raises: [], noSideEffect,
|
|
tags: [].}
|
|
cast[Hide](raiseAssert)(msg)
|
|
|
|
template assertImpl(cond: bool, msg: string, expr: string, enabled: static[bool]) =
|
|
when enabled:
|
|
const
|
|
loc = instantiationInfo(fullPaths = compileOption("excessiveStackTrace"))
|
|
ploc = $loc
|
|
bind instantiationInfo
|
|
mixin failedAssertImpl
|
|
{.line: loc.}:
|
|
if not cond:
|
|
failedAssertImpl(ploc & " `" & expr & "` " & msg)
|
|
|
|
template assert*(cond: untyped, msg = "") =
|
|
## Raises ``AssertionDefect`` with `msg` if `cond` is false. Note
|
|
## that ``AssertionDefect`` is hidden from the effect system, so it doesn't
|
|
## produce ``{.raises: [AssertionDefect].}``. This exception is only supposed
|
|
## to be caught by unit testing frameworks.
|
|
##
|
|
## The compiler may not generate any code at all for ``assert`` if it is
|
|
## advised to do so through the ``-d:danger`` or ``--assertions:off``
|
|
## `command line switches <nimc.html#compiler-usage-command-line-switches>`_.
|
|
##
|
|
## .. code-block:: nim
|
|
## static: assert 1 == 9, "This assertion generates code when not built with -d:danger or --assertions:off"
|
|
assertImpl(cond, msg, astToStr(cond), compileOption("assertions"))
|
|
|
|
template doAssert*(cond: untyped, msg = "") =
|
|
## Similar to ``assert`` but is always turned on regardless of ``--assertions``.
|
|
##
|
|
## .. code-block:: nim
|
|
## static: doAssert 1 == 9, "This assertion generates code when built with/without -d:danger or --assertions:off"
|
|
const expr = astToStr(cond)
|
|
assertImpl(cond, msg, expr, true)
|
|
|
|
template onFailedAssert*(msg, code: untyped): untyped {.dirty.} =
|
|
## Sets an assertion failure handler that will intercept any assert
|
|
## statements following `onFailedAssert` in the current module scope.
|
|
##
|
|
## .. code-block:: nim
|
|
## # module-wide policy to change the failed assert
|
|
## # exception type in order to include a lineinfo
|
|
## onFailedAssert(msg):
|
|
## var e = new(TMyError)
|
|
## e.msg = msg
|
|
## e.lineinfo = instantiationInfo(-2)
|
|
## raise e
|
|
##
|
|
template failedAssertImpl(msgIMPL: string): untyped {.dirty.} =
|
|
let msg = msgIMPL
|
|
code
|
|
|
|
template doAssertRaises*(exception: typedesc, code: untyped) =
|
|
## Raises ``AssertionDefect`` if specified ``code`` does not raise the
|
|
## specified exception. Example:
|
|
##
|
|
## .. code-block:: nim
|
|
## doAssertRaises(ValueError):
|
|
## raise newException(ValueError, "Hello World")
|
|
var wrong = false
|
|
when Exception is exception:
|
|
try:
|
|
if true:
|
|
code
|
|
wrong = true
|
|
except Exception:
|
|
discard
|
|
else:
|
|
try:
|
|
if true:
|
|
code
|
|
wrong = true
|
|
except exception:
|
|
discard
|
|
except Exception:
|
|
raiseAssert(astToStr(exception) &
|
|
" wasn't raised, another error was raised instead by:\n"&
|
|
astToStr(code))
|
|
if wrong:
|
|
raiseAssert(astToStr(exception) & " wasn't raised by:\n" & astToStr(code))
|