1
0
Fork 0

Add debug assertion macros

This commit is contained in:
Robbert van der Helm 2022-01-26 11:26:30 +01:00
parent a40bf1f4f5
commit 91518b82fd
2 changed files with 45 additions and 0 deletions

44
nih_plug/src/debug.rs Normal file
View file

@ -0,0 +1,44 @@
// nih-plug: plugins, but rewritten in Rust
// Copyright (C) 2022 Robbert van der Helm
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <https://www.gnu.org/licenses/>.
/// Write something to the STDERR stream.
///
/// XXX: I don't think we need all of the log crate just for some simple logging, but maybe consider
/// integrating some other crate with this function if we need to log to some other place than
/// STDERR or if it needs to be done in release builds and we should thus try to avoid
/// allocations.
macro_rules! nih_log {
($format:expr $(, $arg:tt)*) => (
eprintln!(concat!("[", file!(), ":", line!(), "] ", $format), $($arg)*)
);
}
/// A `debug_assert!()` analogue that prints the error instead with line number information instead
/// of panicking.
///
/// TODO: Detect if we're running under a debugger, and trigger a break if we are
macro_rules! nih_debug_assert {
($cond:expr) => (
if cfg!(debug_assertions) && !$cond {
nih_log!(concat!("Debug assertion failed: ", stringify!($cond)));
}
);
($cond:expr, $format:expr $(, $arg:tt)*) => (
if cfg!(debug_assertions) && !$cond {
nih_log!(concat!("Debug assertion failed: ", stringify!($cond), ", ", $format) $(, $arg)*);
}
);
}

View file

@ -14,5 +14,6 @@
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <https://www.gnu.org/licenses/>.
pub mod debug;
pub mod params;
pub mod plugin;