Add a fyne.Do method for developers and update our naming/docs

fyne-io · Jan 11, 2025 · 742693e · 742693e
1 parent 2355f9d
commit 742693e
Show file tree

Hide file tree

Showing 16 changed files with 25 additions and 25 deletions.
diff --git a/app/app.go b/app/app.go
@@ -68,7 +68,7 @@ func (a *fyneApp) NewWindow(title string) fyne.Window {
 }
 
 func (a *fyneApp) Run() {
-	go a.lifecycle.RunEventQueue(a.driver.CallFromGoroutine)
+	go a.lifecycle.RunEventQueue(a.driver.DoFromGoroutine)
 	a.driver.Run()
 }
 

diff --git a/app/preferences.go b/app/preferences.go
@@ -52,7 +52,7 @@ func (p *preferences) resetSavedRecently() {
 		time.Sleep(time.Millisecond * 100) // writes are not always atomic. 10ms worked, 100 is safer.
 
 		// For test reasons we need to use current app not what we were initialised with as they can differ
-		fyne.CurrentApp().Driver().CallFromGoroutine(func() {
+		fyne.Do(func() {
 			p.prefLock.Lock()
 			p.savedRecently = false
 			changedDuringSaving := p.changedDuringSaving

diff --git a/app/preferences_other.go b/app/preferences_other.go
@@ -28,6 +28,6 @@ func (p *preferences) watch() {
 			return
 		}
 
-		fyne.CurrentApp().Driver().CallFromGoroutine(p.load)
+		fyne.Do(p.load)
 	})
 }
diff --git a/cmd/fyne_demo/tutorials/advanced.go b/cmd/fyne_demo/tutorials/advanced.go
@@ -38,7 +38,7 @@ func advancedScreen(win fyne.Window) fyne.CanvasObject {
 
 	go func(canvas fyne.Canvas) {
 		for range time.NewTicker(time.Second).C {
-			fyne.CurrentApp().Driver().CallFromGoroutine(func() {
+			fyne.Do(func() {
 				scale.SetText(scaleToString(canvas))
 				tex.SetText(textureScaleToString(canvas))
 			})

diff --git a/cmd/fyne_demo/tutorials/canvas.go b/cmd/fyne_demo/tutorials/canvas.go
@@ -22,7 +22,7 @@ func canvasScreen(_ fyne.Window) fyne.CanvasObject {
 	gradient := canvas.NewHorizontalGradient(color.NRGBA{0x80, 0, 0, 0xff}, color.NRGBA{0, 0x80, 0, 0xff})
 	go func() {
 		for range time.NewTicker(time.Second).C {
-			fyne.CurrentApp().Driver().CallFromGoroutine(func() {
+			fyne.Do(func() {
 				gradient.Angle += 45
 				if gradient.Angle >= 360 {
 					gradient.Angle -= 360

diff --git a/cmd/fyne_demo/tutorials/welcome.go b/cmd/fyne_demo/tutorials/welcome.go
@@ -63,7 +63,7 @@ func welcomeScreen(_ fyne.Window) fyne.CanvasObject {
 	fyne.CurrentApp().Settings().AddChangeListener(listen)
 	go func() {
 		for range listen {
-			fyne.CurrentApp().Driver().CallFromGoroutine(func() {
+			fyne.Do(func() {
 				bgColor = withAlpha(theme.Color(theme.ColorNameBackground), 0xe0)
 				bg.FillColor = bgColor
 				bg.Refresh()

diff --git a/cmd/fyne_demo/tutorials/widget.go b/cmd/fyne_demo/tutorials/widget.go
@@ -62,7 +62,7 @@ func makeActivityTab(win fyne.Window) fyne.CanvasObject {
 		a2.Show()
 
 		time.AfterFunc(10*time.Second, func() {
-			fyne.CurrentApp().Driver().CallFromGoroutine(func() {
+			fyne.Do(func() {
 				a1.Stop()
 				a1.Hide()
 				a2.Stop()
@@ -90,7 +90,7 @@ func makeActivityTab(win fyne.Window) fyne.CanvasObject {
 			d.Show()
 
 			time.AfterFunc(5*time.Second, func() {
-				fyne.CurrentApp().Driver().CallFromGoroutine(func() {
+				fyne.Do(func() {
 					a3.Stop()
 					d.Hide()
 				})

diff --git a/cmd/fyne_demo/tutorials/window.go b/cmd/fyne_demo/tutorials/window.go
@@ -72,7 +72,7 @@ func windowScreen(_ fyne.Window) fyne.CanvasObject {
 				w.Show()
 
 				time.AfterFunc(3*time.Second, func() {
-					fyne.CurrentApp().Driver().CallFromGoroutine(w.Close)
+					fyne.Do(w.Close)
 				})
 			}))
 	}

diff --git a/data/binding/queue.go b/data/binding/queue.go
@@ -11,5 +11,5 @@ func queueItem(f func()) {
 		return
 	}
 
-	fyne.CurrentApp().Driver().CallFromGoroutine(f)
+	fyne.Do(f)
 }
diff --git a/driver.go b/driver.go
@@ -44,8 +44,10 @@ type Driver interface {
 	// Since: 2.5
 	SetDisableScreenBlanking(bool)
 
-	// CallFromGoroutine provides a way to queue a function that is running on a goroutine back to the main thread.
+	// DoFromGoroutine provides a way to queue a function that is running on a goroutine back to
+	// the central thread for Fyne updates.
 	// This is required when background tasks want to execute code safely in the graphical context.
+	//
 	// Since: 2.6
-	CallFromGoroutine(func())
+	DoFromGoroutine(func())
 }
diff --git a/internal/driver/glfw/driver.go b/internal/driver/glfw/driver.go
@@ -56,7 +56,7 @@ func toOSIcon(icon []byte) ([]byte, error) {
 	return buf.Bytes(), nil
 }
 
-func (d *gLDriver) CallFromGoroutine(f func()) {
+func (d *gLDriver) DoFromGoroutine(f func()) {
 	runOnMain(f)
 }
 

diff --git a/internal/driver/mobile/canvas.go b/internal/driver/mobile/canvas.go
@@ -386,7 +386,7 @@ func (c *canvas) waitForDoubleTap(co fyne.CanvasObject, ev *fyne.PointEvent, tap
 	defer cancel()
 
 	<-ctx.Done()
-	fyne.CurrentApp().Driver().CallFromGoroutine(func() {
+	fyne.CurrentApp().Driver().DoFromGoroutine(func() {
 		c.touchCancelLock.Lock()
 		touchCount := c.touchTapCount
 		touchLast := c.touchLastTapped

diff --git a/internal/driver/mobile/canvas_test.go b/internal/driver/mobile/canvas_test.go
@@ -137,7 +137,7 @@ func Test_canvas_Focusable(t *testing.T) {
 	content.Resize(fyne.NewSize(25, 25))
 
 	pos := fyne.NewPos(10, 10)
-	d.CallFromGoroutine(func() {
+	d.DoFromGoroutine(func() {
 		c.tapDown(pos, 0)
 		c.tapUp(pos, 0, func(wid fyne.Tappable, ev *fyne.PointEvent) {
 			wid.Tapped(ev)
@@ -149,7 +149,7 @@ func Test_canvas_Focusable(t *testing.T) {
 		assert.Equal(t, 0, content.unfocusedTimes)
 	})
 
-	d.CallFromGoroutine(func() {
+	d.DoFromGoroutine(func() {
 		c.tapDown(pos, 1)
 		c.tapUp(pos, 1, func(wid fyne.Tappable, ev *fyne.PointEvent) {
 			wid.Tapped(ev)
@@ -160,7 +160,7 @@ func Test_canvas_Focusable(t *testing.T) {
 		assert.Equal(t, 0, content.unfocusedTimes)
 	})
 
-	d.CallFromGoroutine(func() {
+	d.DoFromGoroutine(func() {
 		c.Focus(content)
 		assert.Equal(t, 1, content.focusedTimes)
 		assert.Equal(t, 0, content.unfocusedTimes)
@@ -530,7 +530,7 @@ func waitAndCheck(msWait time.Duration, fn func()) {
 		defer common.DonePool.Put(waitForCheck)
 
 		time.Sleep(msWait * time.Millisecond)
-		d.CallFromGoroutine(func() {
+		d.DoFromGoroutine(func() {
 			fn()
 
 			waitForCheck <- struct{}{}

diff --git a/internal/driver/mobile/driver.go b/internal/driver/mobile/driver.go
@@ -73,7 +73,7 @@ func init() {
 	runtime.LockOSThread()
 }
 
-func (d *driver) CallFromGoroutine(fn func()) {
+func (d *driver) DoFromGoroutine(fn func()) {
 	done := common.DonePool.Get()
 	defer common.DonePool.Put(done)
 
@@ -433,15 +433,13 @@ func (d *driver) tapUpCanvas(w *window, x, y float32, tapID touch.Sequence) {
 					ev.Dragged.DY *= tapMoveDecay
 				}
 
-				d.CallFromGoroutine(func() {
+				d.DoFromGoroutine(func() {
 					wid.Dragged(ev)
 				})
 				time.Sleep(time.Millisecond * 16)
 			}
 
-			d.CallFromGoroutine(func() {
-				wid.DragEnd()
-			})
+			d.DoFromGoroutine(wid.DragEnd)
 		}()
 	})
 }

diff --git a/test/app.go b/test/app.go
@@ -247,7 +247,7 @@ func (s *testSettings) apply() {
 		listener <- s
 	}
 
-	s.app.driver.CallFromGoroutine(func() {
+	s.app.driver.DoFromGoroutine(func() {
 		s.app.propertyLock.Lock()
 		painter.ClearFontCache()
 		cache.ResetThemeCaches()

diff --git a/test/driver.go b/test/driver.go
@@ -49,7 +49,7 @@ func NewDriverWithPainter(painter SoftwarePainter) fyne.Driver {
 	return &driver{painter: painter}
 }
 
-func (d *driver) CallFromGoroutine(f func()) {
+func (d *driver) DoFromGoroutine(f func()) {
 	f() // Tests all run on a single (but potentially different per-test) thread
 }
-Original file line number
+Diff line change
@@ Expand Up / @@ -28,6 +28,6 @@ func (p *preferences) watch() { @@
     			return
     		}
-    		fyne.CurrentApp().Driver().CallFromGoroutine(p.load)
+    		fyne.Do(p.load)
     	})
     }