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
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
//! Provides high-level access to the GPU APIs.

use crate::common::{Dimension, Point, Rgb, Vector2};
use crate::error::Error;
use crate::helpers::Ignore;
use core::fmt::{Debug, Formatter};
use minicbor::Encode;
use oc_wasm_futures::invoke::{component_method, Buffer};
use oc_wasm_helpers::{error::NullAndStringOr, Lockable};
use oc_wasm_safe::{
	component::{Invoker, MethodCallError},
	extref, Address,
};

/// The type name for GPU components.
pub const TYPE: &str = "gpu";

/// A GPU component.
#[derive(Clone, Copy, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
pub struct Gpu(Address);

impl Gpu {
	/// Creates a wrapper around a GPU.
	///
	/// The `address` parameter is the address of the GPU. It is not checked for correctness at
	/// this time because network topology could change after this function returns; as such, each
	/// usage of the value may fail instead.
	#[must_use = "This function is only useful for its return value"]
	pub fn new(address: Address) -> Self {
		Self(address)
	}

	/// Returns the address of the GPU.
	#[must_use = "This function is only useful for its return value"]
	pub fn address(&self) -> &Address {
		&self.0
	}
}

impl<'a, B: 'a + Buffer> Lockable<'a, 'a, B> for Gpu {
	type Locked = Locked<'a, B>;

	fn lock(&self, invoker: &'a mut Invoker, buffer: &'a mut B) -> Self::Locked {
		Locked {
			address: self.0,
			invoker,
			buffer,
		}
	}
}

/// A GPU component on which methods can be invoked.
///
/// This type combines a GPU address, an [`Invoker`](Invoker) that can be used to make method
/// calls, and a scratch buffer used to perform CBOR encoding and decoding. A value of this type
/// can be created by calling [`Gpu::lock`](Gpu::lock), and it can be dropped to return the borrow
/// of the invoker and buffer to the caller so they can be reused for other purposes.
///
/// The `'a` lifetime is the lifetime of the invoker and the buffer. The `B` type is the type of
/// scratch buffer to use.
pub struct Locked<'a, B: Buffer> {
	/// The component address.
	address: Address,

	/// The invoker.
	invoker: &'a mut Invoker,

	/// The buffer.
	buffer: &'a mut B,
}

impl<'a, B: Buffer> Locked<'a, B> {
	/// Binds the GPU to a screen.
	///
	/// If `reset` is `true`, then the screen is reset to its maximum resolution and colour depth,
	/// and its colours are set to white on black. The text content, however, is not cleared.
	///
	/// # Errors
	/// * [`BadComponent`](Error::BadComponent)
	/// * [`BadScreen`](Error::BadScreen)
	/// * [`TooManyDescriptors`](Error::TooManyDescriptors)
	pub async fn bind(&mut self, screen: Address, reset: bool) -> Result<(), Error> {
		let ret: NullAndStringOr<'_, Ignore> = component_method(
			self.invoker,
			self.buffer,
			&self.address,
			"bind",
			Some(&(screen, reset)),
		)
		.await?;
		match ret {
			NullAndStringOr::Ok(_) => Ok(()),
			NullAndStringOr::Err(_) => Err(Error::BadScreen),
		}
	}

	/// Returns the address of the screen the GPU is bound to, or `None` if it is unbound.
	///
	/// # Errors
	/// * [`BadComponent`](Error::BadComponent)
	/// * [`BadScreen`](Error::BadScreen)
	/// * [`TooManyDescriptors`](Error::TooManyDescriptors)
	pub async fn get_screen(&mut self) -> Result<Option<Address>, Error> {
		let ret: NullAndStringOr<'_, (Option<Address>,)> = component_method::<(), _, _>(
			self.invoker,
			self.buffer,
			&self.address,
			"getScreen",
			None,
		)
		.await?;
		Ok(match ret {
			NullAndStringOr::Ok(ret) => ret.0,
			NullAndStringOr::Err(_) => None,
		})
	}

	/// Returns the background colour.
	///
	/// # Errors
	/// * [`BadComponent`](Error::BadComponent)
	/// * [`BadScreen`](Error::BadScreen)
	/// * [`TooManyDescriptors`](Error::TooManyDescriptors)
	pub async fn get_background(&mut self) -> Result<Colour, Error> {
		self.get_colour("getBackground").await
	}

	/// Sets the background colour, returning the old colour.
	///
	/// # Errors
	/// * [`BadComponent`](Error::BadComponent)
	/// * [`BadPaletteIndex`](Error::BadPaletteIndex)
	/// * [`BadScreen`](Error::BadScreen)
	/// * [`TooManyDescriptors`](Error::TooManyDescriptors)
	pub async fn set_background(
		&mut self,
		colour: Colour,
	) -> Result<(Rgb, Option<PaletteIndex>), Error> {
		self.set_colour(colour, "setBackground").await
	}

	/// Returns the foreground colour.
	///
	/// # Errors
	/// * [`BadComponent`](Error::BadComponent)
	/// * [`BadScreen`](Error::BadScreen)
	/// * [`TooManyDescriptors`](Error::TooManyDescriptors)
	pub async fn get_foreground(&mut self) -> Result<Colour, Error> {
		self.get_colour("getForeground").await
	}

	/// Sets the foreground colour, returning the old colour.
	///
	/// # Errors
	/// * [`BadComponent`](Error::BadComponent)
	/// * [`BadPaletteIndex`](Error::BadPaletteIndex)
	/// * [`BadScreen`](Error::BadScreen)
	/// * [`TooManyDescriptors`](Error::TooManyDescriptors)
	pub async fn set_foreground(
		&mut self,
		colour: Colour,
	) -> Result<(Rgb, Option<PaletteIndex>), Error> {
		self.set_colour(colour, "setForeground").await
	}

	/// Returns the colour at a palette index.
	///
	/// # Errors
	/// * [`BadComponent`](Error::BadComponent)
	/// * [`BadPaletteIndex`](Error::BadPaletteIndex)
	/// * [`BadScreen`](Error::BadScreen)
	/// * [`TooManyDescriptors`](Error::TooManyDescriptors)
	pub async fn get_palette_colour(&mut self, index: PaletteIndex) -> Result<Rgb, Error> {
		let ret: Result<NullAndStringOr<'_, (u32,)>, _> = component_method(
			self.invoker,
			self.buffer,
			&self.address,
			"getPaletteColor",
			Some(&(index.0,)),
		)
		.await;
		let ret = Self::map_bad_parameters(ret, Error::BadPaletteIndex)?;
		let ret = Self::map_no_screen(ret)?;
		Ok(Rgb(ret.0))
	}

	/// Sets the colour at a palette index, returning the old colour.
	///
	/// # Errors
	/// * [`BadComponent`](Error::BadComponent)
	/// * [`BadPaletteIndex`](Error::BadPaletteIndex)
	/// * [`BadScreen`](Error::BadScreen)
	/// * [`TooManyDescriptors`](Error::TooManyDescriptors)
	pub async fn set_palette_colour(
		&mut self,
		index: PaletteIndex,
		colour: Rgb,
	) -> Result<Rgb, Error> {
		let ret: Result<NullAndStringOr<'_, (u32,)>, _> = component_method(
			self.invoker,
			self.buffer,
			&self.address,
			"setPaletteColor",
			Some(&(index.0, colour.0)),
		)
		.await;
		let ret = Self::map_bad_parameters(ret, Error::BadPaletteIndex)?;
		let ret = Self::map_no_screen(ret)?;
		Ok(Rgb(ret.0))
	}

	/// Returns the maximum supported colour depth based on the tiers of the GPU and the bound
	/// screen.
	///
	/// # Errors
	/// * [`BadComponent`](Error::BadComponent)
	/// * [`BadScreen`](Error::BadScreen)
	/// * [`TooManyDescriptors`](Error::TooManyDescriptors)
	pub async fn max_depth(&mut self) -> Result<u8, Error> {
		let ret: NullAndStringOr<'_, (u8,)> = component_method::<(), _, _>(
			self.invoker,
			self.buffer,
			&self.address,
			"maxDepth",
			None,
		)
		.await?;
		let ret = Self::map_no_screen(ret)?;
		Ok(ret.0)
	}

	/// Returns the colour depth currently in use.
	///
	/// # Errors
	/// * [`BadComponent`](Error::BadComponent)
	/// * [`BadScreen`](Error::BadScreen)
	/// * [`TooManyDescriptors`](Error::TooManyDescriptors)
	pub async fn get_depth(&mut self) -> Result<u8, Error> {
		let ret: NullAndStringOr<'_, (u8,)> = component_method::<(), _, _>(
			self.invoker,
			self.buffer,
			&self.address,
			"getDepth",
			None,
		)
		.await?;
		let ret = Self::map_no_screen(ret)?;
		Ok(ret.0)
	}

	/// Sets the colour depth.
	///
	/// # Errors
	/// * [`BadComponent`](Error::BadComponent)
	/// * [`BadDepth`](Error::BadDepth)
	/// * [`BadScreen`](Error::BadScreen)
	/// * [`TooManyDescriptors`](Error::TooManyDescriptors)
	pub async fn set_depth(&mut self, depth: u8) -> Result<(), Error> {
		let ret: Result<NullAndStringOr<'_, Ignore>, _> = component_method(
			self.invoker,
			self.buffer,
			&self.address,
			"setDepth",
			Some(&(depth,)),
		)
		.await;
		let ret = Self::map_bad_parameters(ret, Error::BadDepth)?;
		Self::map_no_screen(ret)?;
		Ok(())
	}

	/// Returns the maximum supported resolution based on the tiers of the GPU and the bound
	/// screen.
	///
	/// # Errors
	/// * [`BadComponent`](Error::BadComponent)
	/// * [`BadScreen`](Error::BadScreen)
	/// * [`TooManyDescriptors`](Error::TooManyDescriptors)
	pub async fn max_resolution(&mut self) -> Result<Dimension, Error> {
		self.get_dimension("maxResolution").await
	}

	/// Returns the resolution currently in use.
	///
	/// # Errors
	/// * [`BadComponent`](Error::BadComponent)
	/// * [`BadScreen`](Error::BadScreen)
	/// * [`TooManyDescriptors`](Error::TooManyDescriptors)
	pub async fn get_resolution(&mut self) -> Result<Dimension, Error> {
		self.get_dimension("getResolution").await
	}

	/// Sets the screen resolution, returning whether or not it was changed from its previous
	/// value.
	///
	/// # Errors
	/// * [`BadComponent`](Error::BadComponent)
	/// * [`BadCoordinate`](Error::BadCoordinate)
	/// * [`BadScreen`](Error::BadScreen)
	/// * [`TooManyDescriptors`](Error::TooManyDescriptors)
	pub async fn set_resolution(&mut self, resolution: Dimension) -> Result<bool, Error> {
		self.set_dimension("setResolution", resolution).await
	}

	/// Returns the viewport currently in use.
	///
	/// # Errors
	/// * [`BadComponent`](Error::BadComponent)
	/// * [`BadScreen`](Error::BadScreen)
	/// * [`TooManyDescriptors`](Error::TooManyDescriptors)
	pub async fn get_viewport(&mut self) -> Result<Dimension, Error> {
		self.get_dimension("getViewport").await
	}

	/// Sets the viewport, returning whether or not it was changed from its previous value.
	///
	/// # Errors
	/// * [`BadComponent`](Error::BadComponent)
	/// * [`BadCoordinate`](Error::BadCoordinate)
	/// * [`BadScreen`](Error::BadScreen)
	/// * [`TooManyDescriptors`](Error::TooManyDescriptors)
	pub async fn set_viewport(&mut self, resolution: Dimension) -> Result<bool, Error> {
		self.set_dimension("setViewport", resolution).await
	}

	/// Returns the character and colours at a specific character cell.
	///
	/// It is possible for a Java string to contain an unpaired UTF-16 surrogate half. It is
	/// possible (in Lua, at least) to place such a byte sequence into a character cell in a
	/// screen. Should this method be called on such a character cell, a replacement character is
	/// silently returned instead.
	///
	/// # Errors
	/// * [`BadComponent`](Error::BadComponent)
	/// * [`BadCoordinate`](Error::BadCoordinate)
	/// * [`BadScreen`](Error::BadScreen)
	/// * [`TooManyDescriptors`](Error::TooManyDescriptors)
	pub async fn get(&mut self, point: Point) -> Result<CharacterCellContents, Error> {
		type Return<'character> = (&'character str, u32, u32, Option<u32>, Option<u32>);
		let ret: Result<NullAndStringOr<'_, Return<'_>>, _> = component_method(
			self.invoker,
			self.buffer,
			&self.address,
			"get",
			Some(&(point.x, point.y)),
		)
		.await;
		let ret = Self::map_bad_parameters(ret, Error::BadCoordinate)?;
		let ret = Self::map_no_screen(ret)?;
		if let Some(character) = ret.0.chars().next() {
			Ok(CharacterCellContents {
				character,
				foreground: (Rgb(ret.1), ret.3.map(PaletteIndex)),
				background: (Rgb(ret.2), ret.4.map(PaletteIndex)),
			})
		} else {
			// A GPU’s get method never returns an empty string. Therefore, if we see one,
			// we must not have been talking to a GPU.
			Err(Error::BadComponent(oc_wasm_safe::error::Error::CborDecode))
		}
	}

	/// Writes text to the screen.
	///
	/// # Errors
	/// * [`BadComponent`](Error::BadComponent)
	/// * [`BadScreen`](Error::BadScreen)
	/// * [`NotEnoughEnergy`](Error::NotEnoughEnergy)
	/// * [`TooManyDescriptors`](Error::TooManyDescriptors)
	pub async fn set(
		&mut self,
		position: Point,
		text: &str,
		direction: TextDirection,
	) -> Result<(), Error> {
		#[derive(Encode)]
		#[cbor(array)]
		struct Params<'a> {
			#[n(0)]
			x: u32,
			#[n(1)]
			y: u32,
			#[n(2)]
			value: extref::String<'a>,
			#[n(3)]
			direction: TextDirection,
		}
		// SAFETY: component_method() both encodes and submits the CBOR in one go.
		let text = unsafe { extref::String::new(text) };
		let ret: NullAndStringOr<'_, Ignore> = component_method(
			self.invoker,
			self.buffer,
			&self.address,
			"set",
			Some(&Params {
				x: position.x,
				y: position.y,
				value: text,
				direction,
			}),
		)
		.await?;
		match ret {
			NullAndStringOr::Ok(_) => Ok(()),
			NullAndStringOr::Err("no screen") => Err(Error::BadScreen),
			NullAndStringOr::Err("not enough energy") => Err(Error::NotEnoughEnergy),
			NullAndStringOr::Err(_) => {
				Err(Error::BadComponent(oc_wasm_safe::error::Error::Unknown))
			}
		}
	}

	/// Copies data from one rectangle to another.
	///
	/// # Errors
	/// * [`BadComponent`](Error::BadComponent)
	/// * [`BadScreen`](Error::BadScreen)
	/// * [`NotEnoughEnergy`](Error::NotEnoughEnergy)
	/// * [`TooManyDescriptors`](Error::TooManyDescriptors)
	pub async fn copy(
		&mut self,
		source: Point,
		dimension: Dimension,
		translation: Vector2,
	) -> Result<(), Error> {
		#[derive(Encode)]
		#[cbor(array)]
		struct Params {
			#[n(0)]
			x: u32,
			#[n(1)]
			y: u32,
			#[n(2)]
			width: u32,
			#[n(3)]
			height: u32,
			#[n(4)]
			tx: i32,
			#[n(5)]
			ty: i32,
		}
		let ret: NullAndStringOr<'_, Ignore> = component_method(
			self.invoker,
			self.buffer,
			&self.address,
			"copy",
			Some(&Params {
				x: source.x,
				y: source.y,
				width: dimension.width,
				height: dimension.height,
				tx: translation.x,
				ty: translation.y,
			}),
		)
		.await?;
		match ret {
			NullAndStringOr::Ok(_) => Ok(()),
			NullAndStringOr::Err("no screen") => Err(Error::BadScreen),
			NullAndStringOr::Err("not enough energy") => Err(Error::NotEnoughEnergy),
			NullAndStringOr::Err(_) => {
				Err(Error::BadComponent(oc_wasm_safe::error::Error::Unknown))
			}
		}
	}

	/// Fills a rectangle with a character.
	///
	/// # Errors
	/// * [`BadComponent`](Error::BadComponent)
	/// * [`BadScreen`](Error::BadScreen)
	/// * [`NotEnoughEnergy`](Error::NotEnoughEnergy)
	/// * [`TooManyDescriptors`](Error::TooManyDescriptors)
	pub async fn fill(
		&mut self,
		target: Point,
		dimension: Dimension,
		character: char,
	) -> Result<(), Error> {
		#[derive(Encode)]
		#[cbor(array)]
		struct Params<'a> {
			#[n(0)]
			x: u32,
			#[n(1)]
			y: u32,
			#[n(2)]
			width: u32,
			#[n(3)]
			height: u32,
			#[n(4)]
			value: &'a str,
		}
		let mut character_buffer = [0_u8; 4];
		let character = character.encode_utf8(&mut character_buffer);
		let ret: Result<NullAndStringOr<'_, Ignore>, _> = component_method(
			self.invoker,
			self.buffer,
			&self.address,
			"fill",
			Some(&Params {
				x: target.x,
				y: target.y,
				width: dimension.width,
				height: dimension.height,
				value: character,
			}),
		)
		.await;
		match ret {
			Ok(NullAndStringOr::Ok(_)) => Ok(()),
			Ok(NullAndStringOr::Err("no screen")) => Err(Error::BadScreen),
			Ok(NullAndStringOr::Err("not enough energy")) => Err(Error::NotEnoughEnergy),
			Ok(NullAndStringOr::Err(_)) => {
				Err(Error::BadComponent(oc_wasm_safe::error::Error::Unknown))
			}
			Err(
				e @ (MethodCallError::Other(exception) | MethodCallError::BadParameters(exception)),
			) => {
				// BadParameters would be the sensible error if the character involves more than
				// one UTF-16 code unit. However, OpenComputers throws unqualified Exception, not
				// IllegalArgumentException, in this case, which maps to Other. Just in case they
				// make it more sane later, check both! And for more certainty, check the message
				// too.
				const INVALID_FILL_VALUE: &str = "invalid fill value";
				const ERROR_MESSAGE_BUFFER_SIZE: usize = INVALID_FILL_VALUE.len();
				let mut message_buffer = [0_u8; ERROR_MESSAGE_BUFFER_SIZE];
				match exception.message(&mut message_buffer) {
					Ok(INVALID_FILL_VALUE) => Err(Error::BadFillCharacter),
					_ => Err(Error::BadComponent(e.into())),
				}
			}
			Err(MethodCallError::TooManyDescriptors) => Err(Error::TooManyDescriptors),
			Err(e) => {
				// Any other errors convert to BadComponent as usual.
				Err(Error::BadComponent(e.into()))
			}
		}
	}

	/// Returns the foreground or background colour.
	///
	/// # Errors
	/// * [`BadComponent`](Error::BadComponent)
	/// * [`BadScreen`](Error::BadScreen)
	/// * [`TooManyDescriptors`](Error::TooManyDescriptors)
	#[allow(clippy::missing_panics_doc)] // Only encode() calls to a buffer which cannot fail.
	async fn get_colour(&mut self, method: &str) -> Result<Colour, Error> {
		let ret: NullAndStringOr<'_, (u32, bool)> =
			component_method::<(), _, _>(self.invoker, self.buffer, &self.address, method, None)
				.await?;
		let ret = Self::map_no_screen(ret)?;
		Ok(if ret.1 {
			Colour::PaletteIndex(PaletteIndex(ret.0))
		} else {
			Colour::Rgb(Rgb(ret.0))
		})
	}

	/// Sets the foreground or background colour, returning the old colour.
	///
	/// # Errors
	/// * [`BadComponent`](Error::BadComponent)
	/// * [`BadPaletteIndex`](Error::BadPaletteIndex)
	/// * [`BadScreen`](Error::BadScreen)
	/// * [`TooManyDescriptors`](Error::TooManyDescriptors)
	#[allow(clippy::missing_panics_doc)] // Only encode() calls to a buffer which cannot fail.
	async fn set_colour(
		&mut self,
		colour: Colour,
		method: &str,
	) -> Result<(Rgb, Option<PaletteIndex>), Error> {
		let params: (u32, bool) = match colour {
			Colour::Rgb(rgb) => (rgb.0, false),
			Colour::PaletteIndex(pi) => (pi.0, true),
		};
		let ret: Result<NullAndStringOr<'_, (u32, Option<u32>)>, _> = component_method(
			self.invoker,
			self.buffer,
			&self.address,
			method,
			Some(&params),
		)
		.await;
		let ret = Self::map_bad_parameters(ret, Error::BadPaletteIndex)?;
		let ret = Self::map_no_screen(ret)?;
		Ok((Rgb(ret.0), ret.1.map(PaletteIndex)))
	}

	/// Returns the current or maximum resolution or the current viewport size.
	///
	/// # Errors
	/// * [`BadComponent`](Error::BadComponent)
	/// * [`BadScreen`](Error::BadScreen)
	/// * [`TooManyDescriptors`](Error::TooManyDescriptors)
	async fn get_dimension(&mut self, method: &str) -> Result<Dimension, Error> {
		let ret: NullAndStringOr<'_, Dimension> =
			component_method::<(), _, _>(self.invoker, self.buffer, &self.address, method, None)
				.await?;
		let ret = Self::map_no_screen(ret)?;
		Ok(ret)
	}

	/// Sets the resolution or viewport size, returning whether or not it changed.
	///
	/// # Errors
	/// * [`BadComponent`](Error::BadComponent)
	/// * [`BadCoordinate`](Error::BadCoordinate)
	/// * [`BadScreen`](Error::BadScreen)
	/// * [`TooManyDescriptors`](Error::TooManyDescriptors)
	async fn set_dimension(&mut self, method: &str, parameter: Dimension) -> Result<bool, Error> {
		let ret: Result<NullAndStringOr<'_, (bool,)>, _> = component_method(
			self.invoker,
			self.buffer,
			&self.address,
			method,
			Some(&parameter),
		)
		.await;
		let ret = Self::map_bad_parameters(ret, Error::BadCoordinate)?;
		let ret = Self::map_no_screen(ret)?;
		Ok(ret.0)
	}

	/// Given a “raw” `Result` whose
	/// [`MethodCallError::BadParameters`](MethodCallError::BadParameters) needs to map to one
	/// specific [`Error`](Error) value, with all others except
	/// [`MethodCallError::TooManyDescriptors`](MethodCallError::TooManyDescriptors) mapping to
	/// [`Error::BadComponent`](Error::BadComponent), returns the “cooked” `Result` with the errors
	/// mapped accordingly.
	fn map_bad_parameters<T>(
		x: Result<T, MethodCallError<'_>>,
		bad_parameters: Error,
	) -> Result<T, Error> {
		x.map_err(|e| match e {
			MethodCallError::BadParameters(_) => bad_parameters,
			MethodCallError::TooManyDescriptors => Error::TooManyDescriptors,
			e => Error::BadComponent(e.into()),
		})
	}

	/// Given a `NullAndStringOr` from a function whose only expected null-and-string return is “no
	/// screen”, maps that error to [`Error::BadScreen`](Error::BadScreen), all other
	/// null-and-string errors to [`Error::BadComponent`](Error::BadComponent), and returns any
	/// success object unmodified.
	fn map_no_screen<T>(x: NullAndStringOr<'_, T>) -> Result<T, Error> {
		match x {
			NullAndStringOr::Ok(x) => Ok(x),
			NullAndStringOr::Err("no screen") => Err(Error::BadScreen),
			NullAndStringOr::Err(_) => {
				Err(Error::BadComponent(oc_wasm_safe::error::Error::Unknown))
			}
		}
	}
}

impl<B: Buffer> Debug for Locked<'_, B> {
	fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), core::fmt::Error> {
		Gpu::new(self.address).fmt(f)
	}
}

/// A palette index.
#[derive(Clone, Copy, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
pub struct PaletteIndex(pub u32);

/// The types of colours available on a GPU.
#[derive(Clone, Copy, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
pub enum Colour {
	/// A 24-bit RGB value.
	Rgb(Rgb),

	/// A palette index.
	PaletteIndex(PaletteIndex),
}

/// The full contents of a character cell.
#[derive(Clone, Copy, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
pub struct CharacterCellContents {
	/// The character displayed at this position.
	pub character: char,
	/// The foreground colour.
	pub foreground: (Rgb, Option<PaletteIndex>),
	/// The background colour.
	pub background: (Rgb, Option<PaletteIndex>),
}

/// The possible directions in which text can be written.
#[derive(Clone, Copy, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
pub enum TextDirection {
	/// The text is written from left to write.
	Horizontal,
	/// The text is written from top to bottom.
	Vertical,
}

impl<Context> Encode<Context> for TextDirection {
	fn encode<W: minicbor::encode::Write>(
		&self,
		e: &mut minicbor::Encoder<W>,
		_: &mut Context,
	) -> Result<(), minicbor::encode::Error<W::Error>> {
		e.bool(*self == Self::Vertical)?;
		Ok(())
	}
}