summaryrefslogtreecommitdiff
path: root/plugin.go
blob: e13f7519bf26b0400a3a0d05ad20293b3377a3ac (plain)
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
package gui

// This is based off of the excellent example and documentation here:
// https://github.com/vladimirvivien/go-plugin-example
// There truly are great people in this world.
// It's a pleasure to be here with all of you

import (
	"log"
	"os"
	"plugin"

	"git.wit.org/wit/gui/toolkit"
)

var err error
type Symbol any

type aplug struct {
	// Ok bool
	name string
	filename string
	plug *plugin.Plugin
	sym *plugin.Symbol
	LoadOk bool
	InitOk bool
	MainOk bool

	Init func()
	Main func(func ())
	Queue func(func ())
	Quit func()
	NewWindow func(*toolkit.Widget)
	NewButton func(*toolkit.Widget, *toolkit.Widget)
	NewGroup func(*toolkit.Widget, *toolkit.Widget)
	NewCheckbox func(*toolkit.Widget, *toolkit.Widget)
	NewTab func(*toolkit.Widget, *toolkit.Widget)
	NewLabel func(*toolkit.Widget, *toolkit.Widget)
	NewTextbox func(*toolkit.Widget, *toolkit.Widget)
	NewSlider func(*toolkit.Widget, *toolkit.Widget)
	NewSpinner func(*toolkit.Widget, *toolkit.Widget)

	NewDropdown func(*toolkit.Widget, *toolkit.Widget)
	AddDropdownName func(*toolkit.Widget, string)
}

var allPlugins []*aplug

// loads and initializes a toolkit (andlabs/ui, gocui, etc)
func LoadToolkit(name string) bool {
	var newPlug aplug

	log.Println("gui.LoadToolkit() START")
	newPlug.LoadOk = false

	for _, aplug := range allPlugins {
		log.Println("gui.LoadToolkit() already loaded toolkit plugin =", aplug.name)
		if (aplug.name == name) {
			log.Println("gui.LoadToolkit() SKIPPING")
			return true
		}
	}

	// locate the shared library file
	filename := name + ".so"
	loadPlugin(&newPlug, filename)
	if (newPlug.plug == nil) {
		return false
	}
	// newPlug.Ok = true
	newPlug.name = name

	// map all the functions
	newPlug.Init = loadFuncE(&newPlug, "Init")
	newPlug.Quit = loadFuncE(&newPlug, "Quit")

	// this should be laodFuncE()
	newPlug.Main  = loadFuncF(&newPlug, "Main")
	newPlug.Queue = loadFuncF(&newPlug, "Queue")

	newPlug.NewWindow = loadFunc1(&newPlug, "NewWindow")

	newPlug.NewButton = loadFunc2(&newPlug, "NewButton")
	newPlug.NewGroup = loadFunc2(&newPlug, "NewGroup")
	newPlug.NewCheckbox = loadFunc2(&newPlug, "NewCheckbox")
	newPlug.NewTab = loadFunc2(&newPlug, "NewTab")
	newPlug.NewLabel = loadFunc2(&newPlug, "NewLabel")
	newPlug.NewTextbox = loadFunc2(&newPlug, "NewTextbox")
	newPlug.NewSlider = loadFunc2(&newPlug, "NewSlider")
	newPlug.NewSpinner = loadFunc2(&newPlug, "NewSpinner")

	newPlug.NewDropdown = loadFunc2(&newPlug, "NewDropdown")
	newPlug.AddDropdownName = loadFuncS(&newPlug, "AddDropdownName")

	allPlugins = append(allPlugins, &newPlug)

	log.Println("gui.LoadToolkit() END", newPlug.name, filename)
	newPlug.LoadOk = true
	return true
}

func loadFuncE(p *aplug, funcName string) func() {
	var newfunc func()
	var ok bool
	var test plugin.Symbol

	test, err = p.plug.Lookup(funcName)
	if err != nil {
		log.Println("DID NOT FIND: name =", test, "err =", err)
		return nil
	}

	newfunc, ok = test.(func())
	if !ok {
		log.Println("function name =", funcName, "names didn't map correctly. Fix the plugin name =", p.name)
		return nil
	}
	return newfunc
}

func loadFunc1(p *aplug, funcName string) func(*toolkit.Widget) {
	var newfunc func(*toolkit.Widget)
	var ok bool
	var test plugin.Symbol

	test, err = p.plug.Lookup(funcName)
	if err != nil {
		log.Println("DID NOT FIND: name =", test, "err =", err)
		return nil
	}

	newfunc, ok = test.(func(*toolkit.Widget))
	if !ok {
		log.Println("function name =", funcName, "names didn't map correctly. Fix the plugin name =", p.name)
		return nil
	}
	return newfunc
}

func loadFuncS(p *aplug, funcName string) func(*toolkit.Widget, string) {
	var newfunc func(*toolkit.Widget, string)
	var ok bool
	var test plugin.Symbol

	test, err = p.plug.Lookup(funcName)
	if err != nil {
		log.Println("DID NOT FIND: name =", test, "err =", err)
		return nil
	}

	newfunc, ok = test.(func(*toolkit.Widget, string))
	if !ok {
		log.Println("function name =", funcName, "names didn't map correctly. Fix the plugin name =", p.name)
		return nil
	}
	return newfunc
}

func loadFunc2(p *aplug, funcName string) func(*toolkit.Widget, *toolkit.Widget) {
	var newfunc func(*toolkit.Widget, *toolkit.Widget)
	var ok bool
	var test plugin.Symbol

	test, err = p.plug.Lookup(funcName)
	if err != nil {
		log.Println("DID NOT FIND: name =", test, "err =", err)
		return nil
	}

	newfunc, ok = test.(func(*toolkit.Widget, *toolkit.Widget))
	if !ok {
		log.Println("function name =", funcName, "names didn't map correctly. Fix the plugin name =", p.name)
		return nil
	}
	return newfunc
}

// This is probably dangerous and should never be done
// executing arbitrary functions will cause them to run inside the goroutine that
// the GUI toolkit itself is running in. TODO: move to channels here
func loadFuncF(p *aplug, funcName string) func(func ()) {
	var newfunc func(func ())
	var ok bool
	var test plugin.Symbol

	test, err = p.plug.Lookup(funcName)
	if err != nil {
		log.Println("DID NOT FIND: name =", test, "err =", err)
		return nil
	}

	newfunc, ok = test.(func(func ()))
	if !ok {
		log.Println("function name =", funcName, "names didn't map correctly. Fix the plugin name =", p.name)
		return nil
	}
	return newfunc
}

func loadPlugin(p *aplug, name string) {
	var filename string

	// attempt to write out the file from the internal resource
	internalName := "toolkit/" + name 
	soFile, err := res.ReadFile(internalName)
	if (err != nil) {
		log.Println(err)
	} else {
		err = os.WriteFile("/tmp/wit/" + name, soFile, 0644)
		if (err != nil) {
			log.Println(err)
		}
	}

	filename = "/tmp/wit/" + name
	p.plug = loadfile(filename)
	if (p.plug != nil) {
		p.filename = filename
		return
	}

	filename = "/usr/share/wit/gui/" + name
	p.plug = loadfile(filename)
	if (p.plug != nil) {
		p.filename = filename
		return
	}
	return
}

// load module
// 1. open the shared object file to load the symbols
func loadfile(filename string) *plugin.Plugin {
	plug, err := plugin.Open(filename)
	log.Println("plug =", plug)
	if err != nil {
		log.Println(err)
		return nil
	}
	return plug
}