ltrender 0.1.10

a diff based terminal rendering engine
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
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
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
use crate::Drawable;
use crate::ScreenBuffer;
use crate::display_screen::AreaRect;
use crate::drawable_register::ObjectLifetime;
use crate::input_handler::hook::EventHook;
use crate::input_handler::manager::{MouseMessage, SubscriptionMessage, TargetScreen};
use crate::input_handler::screen_select_handler::ScreenSelectHMsg;
use crate::input_handler::screen_select_handler::ScreenSelectHandler;
use crate::terminal_buffer::CellDrawer;
use crate::{
    DrawError, DrawObject, DrawObjectKey, DrawObjectLibrary, Screen, ScreenKey, SpriteEntry,
    SpriteRegistry, error::AppError,
};
use ascii_assets::AsciiVideo;
use common_stdx::{Point, Rect};
use log::info;
use std::collections::HashMap;
use std::sync::mpsc::TryRecvError;

pub type SpriteId = usize;
pub type ObjectId = usize;

#[derive(Debug, Clone, Copy)]
pub struct Instant;
#[derive(Debug, Clone, Copy)]
pub struct Buffered;

pub trait RenderModeBehavior {
    fn after_update<B: ScreenBuffer>(
        renderer: &mut Renderer<B, Self>,
        object_key: DrawObjectKey,
    ) -> Result<(), DrawError>
    where
        Self: Sized;

    fn refresh<B: ScreenBuffer>(renderer: &mut Renderer<B, Self>) -> Result<(), DrawError>
    where
        Self: Sized;

    fn render_all<B: ScreenBuffer>(renderer: &mut Renderer<B, Self>) -> Result<(), DrawError>
    where
        Self: Sized;

    fn render_screen<B: ScreenBuffer>(
        renderer: &mut Renderer<B, Self>,
        screen_id: ScreenKey,
    ) -> Result<(), DrawError>
    where
        Self: Sized;
}

impl RenderModeBehavior for Instant {
    fn after_update<B: ScreenBuffer>(
        renderer: &mut Renderer<B, Self>,
        object_key: DrawObjectKey,
    ) -> Result<(), DrawError> {
        renderer.render_drawable(object_key)
    }
    fn refresh<B: ScreenBuffer>(renderer: &mut Renderer<B, Self>) -> Result<(), DrawError> {
        renderer.forced_refresh()?;
        Ok(())
    }

    /// Render all objects on all screens.
    fn render_all<B: ScreenBuffer>(renderer: &mut Renderer<B, Self>) -> Result<(), DrawError> {
        for screen in renderer.screens.values_mut() {
            screen.render_all(
                &mut renderer.screen_buffer,
                &mut renderer.obj_library,
                &renderer.sprites,
            )?;
        }
        Self::refresh(renderer)?;
        Ok(())
    }
    fn render_screen<B: ScreenBuffer>(
        renderer: &mut Renderer<B, Self>,
        screen_id: ScreenKey,
    ) -> Result<(), DrawError>
    where
        Self: Sized,
    {
        info!("rendering full screen");
        if let Some(s) = renderer.screens.get_mut(&screen_id) {
            s.render_all(
                &mut renderer.screen_buffer,
                &mut renderer.obj_library,
                &renderer.sprites,
            )?;
            Self::refresh(renderer)?;
        }
        Ok(())
    }
}

impl RenderModeBehavior for Buffered {
    fn after_update<B: ScreenBuffer>(
        _renderer: &mut Renderer<B, Self>,
        _object_key: DrawObjectKey,
    ) -> Result<(), DrawError> {
        Ok(())
    }
    // noop, since buffered rendering does not need to refresh
    fn refresh<B: ScreenBuffer>(_renderer: &mut Renderer<B, Self>) -> Result<(), DrawError> {
        Ok(())
    }
    // might change up the impl here
    fn render_all<B: ScreenBuffer>(renderer: &mut Renderer<B, Self>) -> Result<(), DrawError> {
        for screen in renderer.screens.values_mut() {
            screen.render_all(
                &mut renderer.screen_buffer,
                &mut renderer.obj_library,
                &renderer.sprites,
            )?;
        }
        renderer.forced_refresh()?;
        Ok(())
    }
    // noop, since screens are gonna get updated during frame drawing anyways
    fn render_screen<B: ScreenBuffer>(
        _renderer: &mut Renderer<B, Self>,
        _screen_id: ScreenKey,
    ) -> Result<(), DrawError>
    where
        Self: Sized,
    {
        Ok(())
    }
}

pub struct Renderer<B, M>
where
    B: ScreenBuffer,
    B::Drawer: CellDrawer,
{
    screens: HashMap<ScreenKey, Screen>,
    obj_library: DrawObjectLibrary,
    screen_buffer: B,
    sprites: SpriteRegistry,
    update_interval_expand_amount: usize,
    terminal_size: (u16, u16),
    screen_select_handler: Option<ScreenSelectHandler>,
    _mode: std::marker::PhantomData<M>,
}

impl<B, M> Renderer<B, M>
where
    B: ScreenBuffer,
    B::Drawer: CellDrawer,
    M: RenderModeBehavior,
{
    /// set how aggrisive draw batches should try to merge
    pub fn set_update_interval(&mut self, amount: usize) {
        self.update_interval_expand_amount = amount;
    }

    pub fn get_terminal_size(&self) -> (u16, u16) {
        self.terminal_size
    }

    /// Create a new renderer with an initial terminal size.
    pub fn create_renderer(size: (u16, u16)) -> Self {
        Renderer::<B, M> {
            obj_library: DrawObjectLibrary::new(),
            screens: HashMap::new(),
            screen_buffer: B::new(size),
            sprites: SpriteRegistry::new(),
            update_interval_expand_amount: 50000,
            terminal_size: size,
            screen_select_handler: None,
            _mode: std::marker::PhantomData,
        }
    }

    /// Create a new screen and return its key.
    pub fn create_screen(&mut self, rect: AreaRect, layer: usize) -> ScreenKey {
        let new_id = self.generate_screen_key();
        self.screens
            .insert(new_id, Screen::new(rect, layer, new_id, self.terminal_size));
        new_id
    }

    pub fn change_screen_area(
        &mut self,
        screen_id: ScreenKey,
        new_area: AreaRect,
    ) -> Result<(), DrawError> {
        if let Some(s) = self.screens.get_mut(&screen_id) {
            s.remove_all(
                &mut self.screen_buffer,
                &mut self.obj_library,
                &self.sprites,
            )?;
            s.change_screen_area(new_area);
            let ids = s.draw_objects.to_vec();
            let screen_rect = s.rect();

            for object_id in ids {
                self.run_drawable_screen_fitting(
                    DrawObjectKey {
                        screen_id,
                        object_id,
                    },
                    screen_rect,
                )?;
            }

            if let Some(s) = self.screens.get_mut(&screen_id) {
                s.render_all(
                    &mut self.screen_buffer,
                    &mut self.obj_library,
                    &self.sprites,
                )?;
            }
            M::refresh(self)?;
            Ok(())
        } else {
            Err(DrawError::DisplayKeyNotFound(screen_id))
        }
    }

    pub fn fit_screen_area_to_contents(&mut self, screen_id: ScreenKey) -> Result<(), DrawError> {
        if let Some(s) = self.screens.get_mut(&screen_id) {
            s.remove_all(
                &mut self.screen_buffer,
                &mut self.obj_library,
                &self.sprites,
            )?;
            s.change_screen_area_contents(&mut self.obj_library, &self.sprites);
            let ids = s.draw_objects.to_vec();
            let screen_rect = s.rect();

            for object_id in ids {
                self.run_drawable_screen_fitting(
                    DrawObjectKey {
                        screen_id,
                        object_id,
                    },
                    screen_rect,
                )?;
            }

            if let Some(s) = self.screens.get_mut(&screen_id) {
                s.render_all(
                    &mut self.screen_buffer,
                    &mut self.obj_library,
                    &self.sprites,
                )?;
            }
            M::refresh(self)?;
            Ok(())
        } else {
            Err(DrawError::DisplayKeyNotFound(screen_id))
        }
    }

    pub fn add_on_screen_select(
        &mut self,
        screen_id: ScreenKey,
        callback: Box<dyn FnMut() + 'static + Send>,
    ) {
        if let Some(s) = self.screens.get_mut(&screen_id) {
            s.add_on_screen_select(callback);
        }
    }
    fn on_screen_select(&mut self, screen_id: ScreenKey) -> Result<(), AppError> {
        if let Some(s) = self.screens.get_mut(&screen_id) {
            s.on_screen_select(&mut self.obj_library)?;
            M::render_screen(self, screen_id)?;
        }
        Ok(())
    }

    pub fn change_screen_layer(
        &mut self,
        screen_id: ScreenKey,
        new_layer: usize,
    ) -> Result<(), DrawError> {
        if let Some(s) = self.screens.get_mut(&screen_id) {
            s.remove_all(
                &mut self.screen_buffer,
                &mut self.obj_library,
                &self.sprites,
            )?;
            s.change_screen_layer(new_layer);
            s.render_all(
                &mut self.screen_buffer,
                &mut self.obj_library,
                &self.sprites,
            )?;
            M::refresh(self)?;
            Ok(())
        } else {
            Err(DrawError::DisplayKeyNotFound(screen_id))
        }
    }

    /// Register a drawable object on a screen.
    pub fn register_drawable(
        &mut self,
        screen_id: ScreenKey,
        obj: DrawObject,
    ) -> Result<DrawObjectKey, DrawError> {
        if let Some(s) = self.screens.get_mut(&screen_id) {
            let new_obj_id = self.obj_library.add_obj(screen_id, obj);
            s.register_drawable(new_obj_id, &self.obj_library);
            let area = s.rect();
            self.run_drawable_screen_fitting(
                DrawObjectKey {
                    object_id: new_obj_id,
                    screen_id,
                },
                area,
            )?;
            let key = DrawObjectKey {
                screen_id,
                object_id: new_obj_id,
            };
            M::render_screen(self, key.screen_id)?;
            Ok(key)
        } else {
            Err(DrawError::DisplayKeyNotFound(screen_id))
        }
    }

    pub fn remove_drawable(&mut self, id: DrawObjectKey) -> Result<(), DrawError> {
        if let Some(s) = self.screens.get_mut(&id.screen_id) {
            s.remove_drawable(
                id.object_id,
                &mut self.screen_buffer,
                &mut self.obj_library,
                &self.sprites,
            )?;
            M::refresh(self)?;
            Ok(())
        } else {
            Err(DrawError::DisplayKeyNotFound(id.screen_id))
        }
    }

    pub fn explicit_remove_drawable(&mut self, id: &DrawObjectKey) -> Result<(), DrawError> {
        if let Some(s) = self.screens.get_mut(&id.screen_id) {
            s.deregister_drawable(id.object_id);
            self.remove_drawable(*id)?;
            Ok(())
        } else {
            Err(DrawError::DisplayKeyNotFound(id.screen_id))
        }
    }

    pub fn replace_drawable(
        &mut self,
        id: DrawObjectKey,
        drawable: Box<dyn Drawable>,
    ) -> Result<(), DrawError> {
        {
            if let Some(s) = self.screens.get_mut(&id.screen_id) {
                s.deregister_drawable(id.object_id);
            } else {
                return Err(DrawError::DisplayKeyNotFound(id.screen_id));
            }
        }

        self.remove_drawable(id)?;

        if let Some(obj) = self.obj_library.get_mut(&id) {
            obj.drawable = drawable;
        }

        {
            if let Some(s) = self.screens.get_mut(&id.screen_id) {
                s.register_drawable(id.object_id, &self.obj_library);
                s.render_drawable(
                    id.object_id,
                    &mut self.screen_buffer,
                    &mut self.obj_library,
                    &self.sprites,
                )?;
            }
        }

        Ok(())
    }

    /// checks if any of the currently existing drawobjects should be removed,
    /// because its duration on screen has ended
    pub fn check_if_object_lifetime_ended(&mut self) -> Result<(), DrawError> {
        let now = std::time::Instant::now();
        let mut expired_keys = Vec::new();

        for (screen_id, screen) in &self.screens {
            for obj_id in &screen.draw_objects {
                let key = &DrawObjectKey {
                    screen_id: *screen_id,
                    object_id: *obj_id,
                };

                if let Some(obj) = self.obj_library.all_objects.get(key)
                    && let ObjectLifetime::ForTime(dur) = obj.lifetime
                    && now >= obj.creation_time + dur
                {
                    expired_keys.push(*key);
                }
            }
        }

        for key in expired_keys {
            self.explicit_remove_drawable(&key)?;
        }

        Ok(())
    }

    /// Load a sprite from an ASCII video file.
    pub fn register_sprite_from_source(&mut self, path: &str) -> Result<SpriteId, AppError> {
        let video = AsciiVideo::read_from_file(path)?;

        let sprite_id = self.sprites.add(SpriteEntry { info: video });

        Ok(sprite_id)
    }

    pub fn render_screen(&mut self, screen_id: ScreenKey) -> Result<(), AppError> {
        M::render_screen(self, screen_id)?;
        Ok(())
    }

    /// Render a single drawable object.
    pub fn render_drawable(&mut self, object_key: DrawObjectKey) -> Result<(), DrawError> {
        if let Some(s) = self.screens.get_mut(&object_key.screen_id) {
            if let Some(obj) = self.obj_library.get_mut(&object_key) {
                obj.creation_time = std::time::Instant::now()
            }

            s.register_drawable(object_key.object_id, &self.obj_library);

            M::render_screen(self, object_key.screen_id)?;
            Ok(())
        } else {
            Err(DrawError::DisplayKeyNotFound(object_key.screen_id))
        }
    }

    fn forced_refresh(&mut self) -> Result<(), DrawError> {
        B::update_terminal(&mut self.screen_buffer, self.update_interval_expand_amount)?;
        Ok(())
    }

    pub fn handle_resize(&mut self, new_size: (u16, u16)) -> Result<(), DrawError> {
        self.screen_buffer = B::new(new_size);
        self.terminal_size = new_size;
        for screen in self.screens.values_mut() {
            screen.terminal_size = self.terminal_size
        }
        B::mark_all_dirty(&mut self.screen_buffer, new_size);
        M::render_all(self)?;
        Ok(())
    }

    /// Generate a unique screen key.
    pub fn generate_screen_key(&self) -> ScreenKey {
        let mut id = self.screens.len();
        while self.screens.contains_key(&id) {
            id = id.saturating_add(1);
        }
        id
    }

    pub fn move_drawable_to(
        &mut self,
        handle: DrawObjectKey,
        new_pos: Point<i32>,
    ) -> Result<(), DrawError> {
        self.get_drawable_mut(handle, |drawable| {
            if let Some(dp) = drawable.as_double_pointed_mut() {
                let old_start = dp.start();
                let old_end = dp.end();
                let dx = new_pos.x - old_start.x;
                let dy = new_pos.y - old_start.y;
                dp.set_start(new_pos);
                dp.set_end(Point {
                    x: (old_end.x + dx).clamp(0, u16::MAX as i32),
                    y: (old_end.y + dy).clamp(0, u16::MAX as i32),
                });
            } else if let Some(sp) = drawable.as_single_pointed_mut() {
                sp.set_position(new_pos);
            }
        })
    }

    pub fn move_drawable_by(
        &mut self,
        handle: DrawObjectKey,
        dx: i32,
        dy: i32,
    ) -> Result<(), DrawError> {
        self.get_drawable_mut(handle, |drawable| {
            if let Some(dp) = drawable.as_double_pointed_mut() {
                let start = dp.start();
                let end = dp.end();
                dp.set_start(Point {
                    x: (start.x + dx).clamp(0, i32::MAX),
                    y: (start.y + dy).clamp(0, i32::MAX),
                });
                dp.set_end(Point {
                    x: (end.x + dx).clamp(0, i32::MAX),
                    y: (end.y + dy).clamp(0, i32::MAX),
                });
            } else if let Some(sp) = drawable.as_single_pointed_mut() {
                let pos = sp.position();
                sp.set_position(Point {
                    x: (pos.x + dx).clamp(0, i32::MAX),
                    y: (pos.y + dy).clamp(0, i32::MAX),
                });
            }
        })
    }

    pub fn move_drawable_point(
        &mut self,
        handle: DrawObjectKey,
        point_index: usize,
        new_pos: Point<i32>,
    ) -> Result<(), DrawError> {
        self.get_drawable_mut(handle, |drawable| {
            if let Some(dp) = drawable.as_double_pointed_mut() {
                let clamped = Point {
                    x: (new_pos.x).clamp(0, i32::MAX),
                    y: (new_pos.y).clamp(0, i32::MAX),
                };
                match point_index {
                    0 => dp.set_start(clamped),
                    1 => dp.set_end(clamped),
                    _ => {}
                }
            }
        })
    }
    pub fn move_multipoint_drawable_point(
        &mut self,
        handle: DrawObjectKey,
        point_index: usize,
        new_pos: Point<i32>,
    ) -> Result<(), DrawError> {
        self.get_drawable_mut(handle, |drawable| {
            if let Some(mp) = drawable.as_multi_pointed_mut() {
                let clamped = Point {
                    x: (new_pos.x).clamp(0, i32::MAX),
                    y: (new_pos.y).clamp(0, i32::MAX),
                };
                mp.set_point(point_index, clamped);
            }
        })
    }
    /// replace a drawables points
    pub fn replace_drawable_points(
        &mut self,
        handle: DrawObjectKey,
        new_points: Vec<Point<i32>>,
    ) -> Result<(), DrawError> {
        self.get_drawable_mut(handle, |drawable| {
            if let Some(mp) = drawable.as_multi_pointed_mut() {
                mp.set_points(new_points.clone());
            } else if let Some(dp) = drawable.as_double_pointed_mut() {
                if new_points.len() == 2 {
                    dp.set_start(new_points[0]);
                    dp.set_end(new_points[1]);
                } else {
                    info!(
                        "Expected exactly two points for double pointed drawable, got {}",
                        new_points.len()
                    );
                }
            } else if new_points.len() == 1 {
                if let Some(sp) = drawable.as_single_pointed_mut() {
                    sp.set_position(new_points[0]);
                } else {
                    info!("Drawable is not single pointed");
                }
            } else {
                info!(
                    "Expected exactly one point for single pointed drawable, got {}",
                    new_points.len()
                );
            }
        })
    }

    pub fn run_drawable_screen_fitting(
        &mut self,
        handle: DrawObjectKey,
        // not yet normalized to (0,0) as the top left corner
        unadjusted_screen_area: Rect<i32>,
    ) -> Result<(), DrawError> {
        let adjusted_area = Rect {
            p1: Point::from((0, 0)),
            p2: unadjusted_screen_area.p2 - unadjusted_screen_area.p1,
        };
        self.get_drawable_mut(handle, |drawable| {
            if let Some(sf) = drawable.as_screen_fitting_mut() {
                sf.fit_to_screen(adjusted_area);
            }
        })
    }

    pub fn get_amount_of_points(
        &mut self,
        handle: DrawObjectKey,
    ) -> Result<Option<usize>, DrawError> {
        self.get_drawable_mut(handle, |drawable| {
            if let Some(mp) = drawable.as_multi_pointed_mut() {
                Some(mp.points().len())
            } else if drawable.as_double_pointed_mut().is_some() {
                Some(2)
            } else if drawable.as_single_pointed_mut().is_some() {
                Some(1)
            } else {
                info!("Drawable is not multipointed");
                None
            }
        })
    }

    fn get_drawable_mut<F, R>(
        &mut self,
        object_key: DrawObjectKey,
        mut update_fn: F,
    ) -> Result<R, DrawError>
    where
        F: FnMut(&mut dyn Drawable) -> R,
        M: RenderModeBehavior,
    {
        self.remove_drawable(object_key)?;

        let result = {
            let obj =
                self.obj_library
                    .get_mut(&object_key)
                    .ok_or(DrawError::DrawableHandleNotFound {
                        screen_id: object_key.screen_id,
                        obj_id: object_key.object_id,
                    })?;

            update_fn(&mut *obj.drawable)
        };

        M::after_update(self, object_key)?;

        Ok(result)
    }

    /// selects a different screen, if a mouse button has been clicked
    /// the EventHook is needed to access the mouse's current position
    pub fn handle_screen_selection(&mut self, hook: &EventHook) -> Result<(), AppError> {
        let mut selections = Vec::new();
        if let Some(screen_sel_h) = &self.screen_select_handler {
            let (p1, p2) = {
                let m_pos = hook.mouse_pos();
                (m_pos.0 as i32, m_pos.1 as i32)
            };

            let mouse_point = Point::from((p1, p2));

            // grab the id, of the screen, on which the object has been drawn on
            // todo: add object specific selection? we already have the selected obj id anyways

            let screen_selected_char =
                if let Some(drawn_idx) = self.screen_buffer.idx_of(mouse_point) {
                    let drawn = &self.screen_buffer.cell_info_mut()[drawn_idx];
                    if let Some((obj_id, _)) = B::get_char_to_write(drawn)
                        && let Some(key) = self.obj_library.get_obj_screen(obj_id)
                    {
                        key
                    } else {
                        return Ok(());
                    }
                } else {
                    return Ok(());
                };

            let mut resize_required = (false, (0, 0));

            loop {
                let opt_selection = match screen_sel_h.try_recv() {
                    Ok(sshm) => {
                        match sshm {
                            ScreenSelectHMsg::Event(m) => {
                                if let SubscriptionMessage::Mouse { msg, screen: _ } = m
                                    && let MouseMessage::Pressed(_) = msg
                                {
                                    // find the highest screen at that position
                                    let mut current_highest_screen = (usize::MAX, 0);
                                    for (id, screen) in &self.screens {
                                        let screen_layer = screen.layer();
                                        if screen.rect().contains(mouse_point)
                                            && screen_layer >= current_highest_screen.1
                                            && id == screen_selected_char
                                        {
                                            current_highest_screen = (*id, screen_layer);
                                        }
                                    }

                                    if self.screens.contains_key(&current_highest_screen.0) {
                                        Some(TargetScreen::Screen(current_highest_screen.0))
                                    } else {
                                        Some(TargetScreen::None)
                                    }
                                } else if let SubscriptionMessage::Resize(x, y) = m {
                                    resize_required = (true, (x, y));
                                    None
                                } else {
                                    None
                                }
                            }
                            ScreenSelectHMsg::Selection(s) => Some(s),
                        }
                    }
                    Err(TryRecvError::Empty) => break,
                    Err(TryRecvError::Disconnected) => break,
                };
                if let Some(selection) = opt_selection {
                    selections.push(selection);
                };
                screen_sel_h
                    .send(opt_selection)
                    .map_err(|_| AppError::SendError)?;
            }
            if resize_required.0 {
                self.handle_resize(resize_required.1)?;
            }
        }
        // if a screen has been selected, call its on screen select function
        for selection in selections {
            if let TargetScreen::Screen(s) = selection {
                self.on_screen_select(s)?;
            };
        }
        Ok(())
    }
    pub fn add_screen_select_handler(&mut self, screen_select_handler: ScreenSelectHandler) {
        self.screen_select_handler = Some(screen_select_handler);
    }

    pub fn into_buffered(self) -> Renderer<B, M> {
        Renderer {
            screens: self.screens,
            obj_library: self.obj_library,
            screen_buffer: self.screen_buffer,
            sprites: self.sprites,
            update_interval_expand_amount: self.update_interval_expand_amount,
            terminal_size: self.terminal_size,
            screen_select_handler: self.screen_select_handler,
            _mode: std::marker::PhantomData,
        }
    }

    pub fn into_instant(self) -> Renderer<B, M> {
        Renderer {
            screens: self.screens,
            obj_library: self.obj_library,
            screen_buffer: self.screen_buffer,
            sprites: self.sprites,
            update_interval_expand_amount: self.update_interval_expand_amount,
            terminal_size: self.terminal_size,
            screen_select_handler: self.screen_select_handler,
            _mode: std::marker::PhantomData,
        }
    }
}

impl<B, Buffered> Renderer<B, Buffered>
where
    B: ScreenBuffer,
    B::Drawer: CellDrawer,
    Buffered: RenderModeBehavior,
{
    pub fn render_frame(&mut self) -> Result<(), DrawError> {
        Buffered::render_all(self)?;

        self.remove_all_framebased_objects()?;
        Ok(())
    }

    /// removes all the objects from screen, that have frame-based removal
    pub fn remove_all_framebased_objects(&mut self) -> Result<(), DrawError> {
        let mut expired_keys = Vec::new();

        for (screen_id, screen) in &self.screens {
            for obj_id in &screen.draw_objects {
                let key = &DrawObjectKey {
                    screen_id: *screen_id,
                    object_id: *obj_id,
                };
                if let Some(obj) = self.obj_library.all_objects.get(key)
                    && let ObjectLifetime::RemoveNextFrame = obj.lifetime
                {
                    expired_keys.push(*key);
                }
            }
        }

        for key in expired_keys {
            self.explicit_remove_drawable(&key)?;
        }

        Ok(())
    }
}