agdu 0.6.0

Amy's Game Dev Utilities
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132

#[macro_export]
macro_rules! info {
	($($arg:tt)*) => {
		emit_info(file!(), line!(), column!(), ::std::format!($($arg)*));
	};
}

#[macro_export]
macro_rules! warn {
	($($arg:tt)*) => {
		emit_warn(file!(), line!(), column!(), ::std::format!($($arg)*));
	};
}

#[macro_export]
macro_rules! error {
	($($arg:tt)*) => {
		emit_error(file!(), line!(), column!(), ::std::format!($($arg)*));
	};
}

#[macro_export]
macro_rules! fatal {
	($($arg:tt)*) => {
		emit_fatal(file!(), line!(), column!(), ::std::format!($($arg)*));
		::std::unreachable!();
	};
}

#[allow(clippy::needless_pass_by_value)]
pub fn emit_info(file: &str, line: u32, column: u32, message: String) {
	let message = ::std::format!("[{file}:{line}:{column}]: {message}");
	#[cfg(feature = "backtrace")]
	let message = ::std::format!(
		"{message}\n=== BACKTRACE ===\n{:?}",
		backtrace::Backtrace::new()
	);
	#[cfg(feature = "stderr")]
	eprintln!("{message}");
	#[cfg(feature = "stdout")]
	println!("{message}");
	#[cfg(not(test))]
	#[cfg(feature = "godot")]
	crate::godot::print(message.as_str());
	let _ = message;
}

#[allow(clippy::needless_pass_by_value)]
pub fn emit_warn(file: &str, line: u32, column: u32, message: String) {
	let message = ::std::format!("[{file}:{line}:{column}]: {message}");
	#[cfg(feature = "backtrace")]
	let message = ::std::format!(
		"{message}\n=== BACKTRACE ===\n{:?}",
		backtrace::Backtrace::new()
	);
	#[cfg(feature = "stderr")]
	eprintln!("{message}");
	#[cfg(feature = "stdout")]
	println!("{message}");
	#[cfg(not(test))]
	#[cfg(feature = "godot")]
	crate::godot::push_warning(message.as_str());
	#[cfg(not(test))]
	#[cfg(feature = "godot")]
	crate::godot::print(message.as_str());
	let _ = message;
}

#[allow(clippy::needless_pass_by_value)]
pub fn emit_error(file: &str, line: u32, column: u32, message: String) {
	let message = ::std::format!("[{file}:{line}:{column}]: {message}");
	#[cfg(feature = "backtrace")]
	let message = ::std::format!(
		"{message}\n=== BACKTRACE ===\n{:?}",
		backtrace::Backtrace::new()
	);
	#[cfg(feature = "stderr")]
	eprintln!("{message}");
	#[cfg(feature = "stdout")]
	println!("{message}");
	#[cfg(not(test))]
	#[cfg(feature = "godot")]
	crate::godot::push_error(message.as_str());
	#[cfg(not(test))]
	#[cfg(feature = "godot")]
	crate::godot::print(message.as_str());
	let _ = message;
}

/// # Panics
#[allow(clippy::needless_pass_by_value)]
pub fn emit_fatal(file: &str, line: u32, column: u32, message: String) {
	let message = ::std::format!("[{file}:{line}:{column}]: {message}");
	#[cfg(feature = "backtrace")]
	let message = ::std::format!(
		"{message}\n=== BACKTRACE ===\n{:?}",
		backtrace::Backtrace::new()
	);
	#[cfg(feature = "stderr")]
	eprintln!("{message}");
	#[cfg(feature = "stdout")]
	println!("{message}");
	#[cfg(not(test))]
	#[cfg(feature = "godot")]
	crate::godot::push_error(message.as_str());
	#[cfg(not(test))]
	#[cfg(feature = "godot")]
	crate::godot::print(message.as_str());
	#[cfg(not(test))]
	#[cfg(feature = "godot")]
	crate::godot::quit(1);
	::std::panic!("{message}");
}

#[cfg(test)]
mod tests {
	#[allow(unused_imports)]
	use super::*;

	#[test]
	fn test_debugging_macros_except_fatal() {
		info!("info {}", 1);
		warn!("warn {}", 2);
		error!("error {}", 3);
	}

	#[test]
	#[should_panic]
	fn test_fatal() {
		fatal!("fatal {}", 4);
	}
}