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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
use core::fmt;


#[derive(Debug, PartialEq, Clone, Copy)]
pub struct NullPtrError;

impl core::error::Error for NullPtrError {
	// Removed text from str to do not store this in output binary.
	/// `description()` is deprecated; use `Display`
	fn description(&self) -> &str { "" }
}

impl fmt::Display for NullPtrError {
	fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { write!(f, "NullPtr") }
}


pub trait OkOrNullErr<T> {
	fn ok_or_null<'a>(self) -> Result<&'a T, NullPtrError>;
}

impl<T> OkOrNullErr<T> for *const T {
	fn ok_or_null<'a>(self) -> Result<&'a T, NullPtrError> { unsafe { self.as_ref() }.ok_or(NullPtrError) }
}


pub trait OkMutOrNullErr<T> {
	fn ok_or_null<'a>(self) -> Result<&'a mut T, NullPtrError>;
}

impl<T> OkMutOrNullErr<T> for *mut T {
	fn ok_or_null<'a>(self) -> Result<&'a mut T, NullPtrError> { unsafe { self.as_mut() }.ok_or(NullPtrError) }
}


pub trait OkOrNullFnErr<T> {
	type Error: core::error::Error;
	fn ok_or_null(self) -> Result<T, Self::Error>;
}

impl OkOrNullFnErr<&'static crate::ffi::PlaydateAPI> for crate::ApiRef {
	type Error = NullPtrError;
	fn ok_or_null(self) -> Result<&'static crate::ffi::PlaydateAPI, NullPtrError> { self.ok_or(NullPtrError) }
}


macro_rules! impl_fn_def {
	($($t:ident),*) => {
		unsafe extern "C" fn($($t),*) -> R
	};

	($($t:ident),*, ...) => {
		unsafe extern "C" fn($($t),* ,...) -> R
	}
}

macro_rules! impl_ok_or_null_fn_err {
	($($t:ident),*) => {
		impl<R, $($t),*> OkOrNullFnErr<impl_fn_def!($($t),*)> for Option<impl_fn_def!($($t),*)> {
			type Error = NullPtrError;
			fn ok_or_null(self) -> Result<impl_fn_def!($($t),*), NullPtrError> {
				self.ok_or(NullPtrError)
			}
		}

		impl<'f, R, $($t),*> OkOrNullFnErr<&'f impl_fn_def!($($t),*)> for Option<&'f impl_fn_def!($($t),*)> {
			type Error = NullPtrError;
			fn ok_or_null(self) -> Result<&'f impl_fn_def!($($t),*), NullPtrError> {
				self.ok_or(NullPtrError)
			}
		}
	};

	($($t:ident),* ...) => {
		impl_ok_or_null_fn_err!($($t),*);

		impl<R, $($t),*> OkOrNullFnErr<impl_fn_def!($($t),* ,...)> for Option<impl_fn_def!($($t),* ,...)> {
			type Error = NullPtrError;
			fn ok_or_null(self) -> Result<impl_fn_def!($($t),* ,...), NullPtrError> {
				self.ok_or(NullPtrError)
			}
		}

		impl<'f, R, $($t),*> OkOrNullFnErr<&'f impl_fn_def!($($t),* ,...)> for Option<&'f impl_fn_def!($($t),* ,...)> {
			type Error = NullPtrError;
			fn ok_or_null(self) -> Result<&'f impl_fn_def!($($t),* ,...), NullPtrError> {
				self.ok_or(NullPtrError)
			}
		}
	};
}


impl_ok_or_null_fn_err!();
impl_ok_or_null_fn_err!(A ...);
impl_ok_or_null_fn_err!(A, B ...);
impl_ok_or_null_fn_err!(A, B, C ...);
impl_ok_or_null_fn_err!(A, B, C, D ...);
impl_ok_or_null_fn_err!(A, B, C, D, E ...);
impl_ok_or_null_fn_err!(A, B, C, D, E, F ...);
impl_ok_or_null_fn_err!(A, B, C, D, E, F, G ...);
impl_ok_or_null_fn_err!(A, B, C, D, E, F, G, H ...);
impl_ok_or_null_fn_err!(A, B, C, D, E, F, G, H, I ...);
impl_ok_or_null_fn_err!(A, B, C, D, E, F, G, H, I, J ...);
impl_ok_or_null_fn_err!(A, B, C, D, E, F, G, H, I, J, K ...);
impl_ok_or_null_fn_err!(A, B, C, D, E, F, G, H, I, J, K, L ...);
impl_ok_or_null_fn_err!(A, B, C, D, E, F, G, H, I, J, K, L, M ...);
impl_ok_or_null_fn_err!(A, B, C, D, E, F, G, H, I, J, K, L, M, N ...);
impl_ok_or_null_fn_err!(A, B, C, D, E, F, G, H, I, J, K, L, M, N, O ...);


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


	// this just should compile
	fn api_access_ok_() -> Result<(), NullPtrError> {
		crate::sys::api().ok_or_null()?.file.ok_or_null()?;
		crate::sys::api().ok_or_null()?
		                 .file
		                 .ok_or_null()?
		                 .open
		                 .ok_or_null()?;
		Ok(())
	}

	// this just should compile
	fn api_access_raw_() -> Result<(), NullPtrError> {
		unsafe { crate::sys::API }.ok_or_null()?.file.ok_or_null()?;
		unsafe { crate::sys::API }.ok_or_null()?
		                          .file
		                          .ok_or_null()?
		                          .open
		                          .ok_or_null()?;
		Ok(())
	}

	#[test]
	fn api_access_ok() { let _ = api_access_ok_; }

	#[test]
	fn api_access_raw() { let _ = api_access_raw_; }
}


#[cfg(feature = "error-ctx")]
pub mod ctx {
	use core::fmt;


	#[derive(Debug)]
	pub struct NullPtrError {
		pub ctx: &'static str,
	}

	impl fmt::Display for NullPtrError {
		fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { write!(f, "Ptr to {} is null", self.ctx) }
	}

	impl Into<super::NullPtrError> for NullPtrError {
		/// Convert to non-contextual error.
		/// Removes context of this error.
		fn into(self) -> super::NullPtrError { super::NullPtrError }
	}

	impl core::error::Error for NullPtrError {
		// Removed text from str to do not store this in output binary.
		/// `description()` is deprecated; use `Display`
		fn description(&self) -> &str { "" }
	}

	impl AsRef<str> for NullPtrError {
		fn as_ref(&self) -> &str { self.ctx }
	}


	pub trait OkOrNullCtx<T> {
		fn ok_or_null_ctx<'a>(self, ctx: &'static str) -> Result<&'a T, NullPtrError>;
	}

	impl<T> OkOrNullCtx<T> for *const T {
		fn ok_or_null_ctx<'a>(self, ctx: &'static str) -> Result<&'a T, NullPtrError> {
			unsafe { self.as_ref() }.ok_or(NullPtrError { ctx })
		}
	}


	pub trait OkOrNullAddCtx<T> {
		/// Convert result with non-contextual error to result with error with given `ctx`.
		fn ctx(self, ctx: &'static str) -> Result<T, NullPtrError>;
	}

	impl<T> OkOrNullAddCtx<T> for Result<T, super::NullPtrError> {
		fn ctx(self, ctx: &'static str) -> Result<T, NullPtrError> {
			match self {
				Ok(t) => Ok(t),
				Err(_) => Err(NullPtrError { ctx }),
			}
		}
	}


	pub trait OkOrNullFnCtxErr<T> {
		type Error: core::error::Error;
		fn ok_or_null_ctx(self, ctx: &'static str) -> Result<T, Self::Error>;
	}

	impl OkOrNullFnCtxErr<&'static crate::ffi::PlaydateAPI> for crate::ApiRef {
		type Error = NullPtrError;
		fn ok_or_null_ctx(self, ctx: &'static str) -> Result<&'static crate::ffi::PlaydateAPI, NullPtrError> {
			self.ok_or(NullPtrError { ctx })
		}
	}

	macro_rules! impl_ok_or_null_fn_err {
		($($t:ident),*) => {
			impl<R, $($t),*> OkOrNullFnCtxErr<impl_fn_def!($($t),*)> for Option<impl_fn_def!($($t),*)> {
				type Error = NullPtrError;
				fn ok_or_null_ctx(self, ctx: &'static str) -> Result<impl_fn_def!($($t),*), NullPtrError> {
					self.ok_or(NullPtrError { ctx })
				}
			}
		};
	}

	impl_ok_or_null_fn_err!();
	impl_ok_or_null_fn_err!(A);
	impl_ok_or_null_fn_err!(A, B);
	impl_ok_or_null_fn_err!(A, B, C);
	impl_ok_or_null_fn_err!(A, B, C, D);
	impl_ok_or_null_fn_err!(A, B, C, D, E);
	impl_ok_or_null_fn_err!(A, B, C, D, E, F);
	impl_ok_or_null_fn_err!(A, B, C, D, E, F, G);
	impl_ok_or_null_fn_err!(A, B, C, D, E, F, G, H);
	impl_ok_or_null_fn_err!(A, B, C, D, E, F, G, H, I);
	impl_ok_or_null_fn_err!(A, B, C, D, E, F, G, H, I, J);
	impl_ok_or_null_fn_err!(A, B, C, D, E, F, G, H, I, J, K);
	impl_ok_or_null_fn_err!(A, B, C, D, E, F, G, H, I, J, K, L);
	impl_ok_or_null_fn_err!(A, B, C, D, E, F, G, H, I, J, K, L, M);
	impl_ok_or_null_fn_err!(A, B, C, D, E, F, G, H, I, J, K, L, M, N);
	impl_ok_or_null_fn_err!(A, B, C, D, E, F, G, H, I, J, K, L, M, N, O);


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


		// this just should compile
		fn api_access_ok_() -> Result<(), NullPtrError> {
			crate::sys::api().ok_or_null_ctx("api")?
			                 .file
			                 .ok_or_null_ctx("file")?;
			crate::sys::api().ok_or_null_ctx("api")?
			                 .file
			                 .ok_or_null_ctx("file")?
			                 .open
			                 .ok_or_null_ctx("open")?;
			Ok(())
		}

		// this just should compile
		fn api_access_raw_() -> Result<(), NullPtrError> {
			unsafe { crate::sys::API }.ok_or_null_ctx("api")?
			                          .file
			                          .ok_or_null_ctx("file")?;
			unsafe { crate::sys::API }.ok_or_null_ctx("api")?
			                          .file
			                          .ok_or_null_ctx("file")?
			                          .open
			                          .ok_or_null_ctx("open")?;
			Ok(())
		}

		#[test]
		fn api_access_ok() { let _ = api_access_ok_; }

		#[test]
		fn api_access_raw() { let _ = api_access_raw_; }
	}
}