aboutsummaryrefslogtreecommitdiffstats
path: root/mux.go
blob: 6e5dcdbda3c7ff17de70856e11f3edc03ac3a1f5 (plain) (blame)
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
package gui

import (
	"image"
	"image/draw"
)

// Mux can be used to multiplex an Env, let's call it a root Env. Mux implements a way to
// create multiple virtual Envs that all interact with the root Env. They receive the same
// events and their draw functions get redirected to the root Env.
type Mux struct {
	addEventsIn chan<- chan<- Event
	size sharedVal[image.Rectangle]
	draw chan<- func(draw.Image) image.Rectangle
}

// NewMux creates a new Mux that multiplexes the given Env. It returns the Mux along with
// a master Env. The master Env is just like any other Env created by the Mux, except that
// closing the Draw() channel on the master Env closes the whole Mux and all other Envs
// created by the Mux.
func NewMux(env Env) (mux *Mux, master Env) {
	addEventsIn := make(chan chan<- Event)
	size := newSharedVal[image.Rectangle]()
	drawChan := make(chan func(draw.Image) image.Rectangle)
	mux = &Mux{
		addEventsIn: addEventsIn,
		size:     size,
		draw:        drawChan,
	}

	go func() {
		var eventsIns []chan<- Event

		defer close(env.Draw())
		defer close(addEventsIn)
		defer size.close()
		defer func() {
			for _, eventsIn := range eventsIns {
				close(eventsIn)
			}
		}()

		for {
			select {
			case d, ok := <-drawChan:
				if !ok { // closed by master env
					return
				}
				env.Draw() <- d
			case e, ok := <-env.Events():
				if !ok {
					return
				}
				if resize, ok := e.(Resize); ok {
					size.set <- resize.Rectangle
				}
				for _, eventsIn := range eventsIns {
					eventsIn <- e
				}
			case eventsIn := <-addEventsIn:
				eventsIns = append(eventsIns, eventsIn)
			}
		}
	}()

	master = mux.makeEnv(true)
	return mux, master
}

// MakeEnv creates a new virtual Env that interacts with the root Env of the Mux. Closing
// the Draw() channel of the Env will not close the Mux, or any other Env created by the Mux
// but will delete the Env from the Mux.
func (mux *Mux) MakeEnv() Env {
	return mux.makeEnv(false)
}

type muxEnv struct {
	events <-chan Event
	draw   chan<- func(draw.Image) image.Rectangle
}

func (m *muxEnv) Events() <-chan Event                          { return m.events }
func (m *muxEnv) Draw() chan<- func(draw.Image) image.Rectangle { return m.draw }

func (mux *Mux) makeEnv(master bool) Env {
	eventsOut, eventsIn := MakeEventsChan()
	drawChan := make(chan func(draw.Image) image.Rectangle)
	env := &muxEnv{eventsOut, drawChan}

	mux.addEventsIn <- eventsIn
	// make sure to always send a resize event to a new Env
	eventsIn <- Resize{mux.size.get()}

	go func() {
		func() {
			// When the master Env gets its Draw() channel closed, it closes all the Events()
			// channels of all the children Envs, and it also closes the internal draw channel
			// of the Mux. Otherwise, closing the Draw() channel of the master Env wouldn't
			// close the Env the Mux is muxing. However, some child Envs of the Mux may still
			// send some drawing commmands before they realize that their Events() channel got
			// closed.
			//
			// That is perfectly fine if their drawing commands simply get ignored. This down here
			// is a little hacky, but (I hope) perfectly fine solution to the problem.
			//
			// When the internal draw channel of the Mux gets closed, the line marked with ! will
			// cause panic. We recover this panic, then we receive, but ignore all furhter draw
			// commands, correctly draining the Env until it closes itself.
			defer func() {
				if recover() != nil {
					drain(drawChan)
				}
			}()
			for d := range drawChan {
				mux.draw <- d // !
			}
		}()
		if master {
			close(mux.draw)
		}
	}()

	return env
}

func drain[T any](c <-chan T) { for range c {} }