bitshifter / glam-rs / 36701173342

99%

Build Type

push

github

Committed by web-flow

Commit Message

feat(assert): report caller location for glam_assert panics (#884)

# Objective

Fixes #868.

When a `glam_assert!` check fails, the panic points at a line inside
glam, even though the mistake is in the calling code. This changes those
panics to point at the caller instead.

While checking every assert, some panics were found that were never
documented, and some projection functions that quietly returned a broken
matrix (infinities/NaN) for invalid input. Both are fixed here too.

# Solution

Rust's `#[track_caller]` attribute makes a panic report the caller's
location, but only if every function in the call chain has it. Added it
to every glam function that can reach an assert, gated on
`any(debug_assertions, feature = "glam-assert")` so builds where asserts
are off pay nothing for it.

Also:

- documented the panics that happen through another glam call and added
tests for them;
- added two cases that weren't documented: `look_to_*` panics when the
direction and up vector point the same way, and `look_at_*` panics when
the eye and target are the same point;
- added `glam_assert!` checks to `perspective`, `frustum` and
`orthographic` for invalid arguments which could produce infinities/NaN;
- added `#[track_caller]` to functions that panic via a plain
`assert!`/`panic!`/indexing (slice constructors, matrix `col`/`row`,
`BVec::test`/`set`, …), since those panic regardless of the assert
features;
- added `tests/panic_location.rs`, which checks that panics really do
point at the caller for a representative set of functions.

Coverage Stats

124 of 124 new or added lines in 13 files covered. (100.0%)

28 existing lines in 10 files now uncovered.

93470 of 94370 relevant lines covered (99.05%)

123236.58 hits per line