debugui: expose WidgetID and specify ID at SetTextFieldValue explicitly

hajimehoshi · hajimehoshi · commit 99b97dcd8489 · 2025-03-28T03:29:07.000+09:00
diff --git a/button.go b/button.go
@@ -27,7 +27,7 @@ func (c *Context) Button(label string) bool {
 	return res
 }
 
-func (c *Context) button(label string, opt option, id widgetID) (bool, error) {
+func (c *Context) button(label string, opt option, id WidgetID) (bool, error) {
 	res, err := c.widget(id, opt, func(bounds image.Rectangle, wasFocused bool) (bool, error) {
 		var res bool
 		// handle click
diff --git a/container.go b/container.go
@@ -17,8 +17,8 @@ type container struct {
 	open      bool
 	collapsed bool
 
-	toggledIDs          map[widgetID]struct{}
-	textInputTextFields map[widgetID]*textinput.Field
+	toggledIDs          map[WidgetID]struct{}
+	textInputTextFields map[WidgetID]*textinput.Field
 }
 
 // ContainerLayout represents the layout of a container widget.
@@ -37,7 +37,7 @@ type ContainerLayout struct {
 	ScrollOffset image.Point
 }
 
-func (c *Context) container(id widgetID, opt option) *container {
+func (c *Context) container(id WidgetID, opt option) *container {
 	if container, ok := c.idToContainer[id]; ok {
 		c.addUsedContainer(id)
 		return container
@@ -48,7 +48,7 @@ func (c *Context) container(id widgetID, opt option) *container {
 	}
 
 	if c.idToContainer == nil {
-		c.idToContainer = map[widgetID]*container{}
+		c.idToContainer = map[WidgetID]*container{}
 	}
 	cnt := &container{
 		headIdx: -1,
@@ -76,15 +76,15 @@ func (c *Context) Window(title string, rect image.Rectangle, f func(layout Conta
 	})
 }
 
-func (c *Context) window(title string, bounds image.Rectangle, opt option, id widgetID, f func(layout ContainerLayout)) error {
+func (c *Context) window(title string, bounds image.Rectangle, opt option, id WidgetID, f func(layout ContainerLayout)) error {
 	var err error
 	c.idScopeFromID(id, func() {
 		err = c.doWindow(title, bounds, opt, id, f)
 	})
 	return err
 }
 
-func (c *Context) doWindow(title string, bounds image.Rectangle, opt option, id widgetID, f func(layout ContainerLayout)) (err error) {
+func (c *Context) doWindow(title string, bounds image.Rectangle, opt option, id WidgetID, f func(layout ContainerLayout)) (err error) {
 	cnt := c.container(id, opt)
 	if cnt == nil || !cnt.open {
 		return nil
@@ -296,31 +296,34 @@ func (c *Context) SetScroll(scroll image.Point) {
 	c.currentContainer().layout.ScrollOffset = scroll
 }
 
-func (c *container) textInputTextField(id widgetID) *textinput.Field {
+func (c *container) textInputTextField(id WidgetID, createIfNeeded bool) *textinput.Field {
 	if id == emptyWidgetID {
 		return nil
 	}
 	if _, ok := c.textInputTextFields[id]; !ok {
+		if !createIfNeeded {
+			return nil
+		}
 		if c.textInputTextFields == nil {
-			c.textInputTextFields = make(map[widgetID]*textinput.Field)
+			c.textInputTextFields = make(map[WidgetID]*textinput.Field)
 		}
 		c.textInputTextFields[id] = &textinput.Field{}
 	}
 	return c.textInputTextFields[id]
 }
 
-func (c *container) toggled(id widgetID) bool {
+func (c *container) toggled(id WidgetID) bool {
 	_, ok := c.toggledIDs[id]
 	return ok
 }
 
-func (c *container) toggle(id widgetID) {
+func (c *container) toggle(id WidgetID) {
 	if _, toggled := c.toggledIDs[id]; toggled {
 		delete(c.toggledIDs, id)
 		return
 	}
 	if c.toggledIDs == nil {
-		c.toggledIDs = map[widgetID]struct{}{}
+		c.toggledIDs = map[WidgetID]struct{}{}
 	}
 	c.toggledIDs[id] = struct{}{}
 }
diff --git a/context.go b/context.go
@@ -15,28 +15,28 @@ import (
 type Context struct {
 	pointing pointing
 
-	scaleMinus1     int
-	hover           widgetID
-	focus           widgetID
-	lastID          widgetID
-	lastTextFieldID widgetID
-	lastZIndex      int
-	keepFocus       bool
-	hoverRoot       *container
-	nextHoverRoot   *container
-	scrollTarget    *container
-	numberEditBuf   string
-	numberEdit      widgetID
-
-	idStack        []widgetID
+	scaleMinus1   int
+	hover         WidgetID
+	focus         WidgetID
+	currentID     WidgetID
+	lastID        WidgetID
+	lastZIndex    int
+	keepFocus     bool
+	hoverRoot     *container
+	nextHoverRoot *container
+	scrollTarget  *container
+	numberEditBuf string
+	numberEdit    WidgetID
+
+	idStack        []WidgetID
 	commandList    []*command
 	rootList       []*container
 	containerStack []*container
-	usedContainers map[widgetID]struct{}
+	usedContainers map[WidgetID]struct{}
 	clipStack      []image.Rectangle
 	layoutStack    []layout
 
-	idToContainer map[widgetID]*container
+	idToContainer map[WidgetID]*container
 
 	lastPointingPos image.Point
 
@@ -75,8 +75,8 @@ func (c *Context) begin() {
 	c.scrollTarget = nil
 	c.hoverRoot = c.nextHoverRoot
 	c.nextHoverRoot = nil
+	c.currentID = emptyWidgetID
 	c.lastID = emptyWidgetID
-	c.lastTextFieldID = emptyWidgetID
 }
 
 func (c *Context) end() error {
diff --git a/draw.go b/draw.go
@@ -214,7 +214,7 @@ func (c *Context) drawFrame(rect image.Rectangle, colorid int) {
 	}
 }
 
-func (c *Context) drawWidgetFrame(id widgetID, rect image.Rectangle, colorid int, opt option) {
+func (c *Context) drawWidgetFrame(id WidgetID, rect image.Rectangle, colorid int, opt option) {
 	if (opt & optionNoFrame) != 0 {
 		return
 	}
diff --git a/example/ui.go b/example/ui.go
@@ -184,6 +184,7 @@ func (g *Game) logWindow(ctx *debugui.Context) {
 					submit = true
 				}
 			}
+			textFieldID := ctx.CurrentWidgetID()
 			if ctx.Button("Submit") {
 				if g.logSubmitBuf != "" {
 					submit = true
@@ -192,7 +193,7 @@ func (g *Game) logWindow(ctx *debugui.Context) {
 			if submit {
 				g.writeLog(g.logSubmitBuf)
 				g.logSubmitBuf = ""
-				ctx.SetTextFieldValue(g.logSubmitBuf)
+				ctx.SetTextFieldValue(textFieldID, g.logSubmitBuf)
 			}
 		})
 	})
diff --git a/export_test.go b/export_test.go
@@ -3,8 +3,6 @@
 
 package debugui
 
-type WidgetID = widgetID
-
 const EmptyWidgetID = emptyWidgetID
 
 func (c *Context) IDFromCaller() WidgetID {
diff --git a/header.go b/header.go
@@ -48,7 +48,7 @@ func (c *Context) TreeNode(label string, f func()) {
 	})
 }
 
-func (c *Context) header(label string, isTreeNode bool, opt option, id widgetID, f func() error) error {
+func (c *Context) header(label string, isTreeNode bool, opt option, id WidgetID, f func() error) error {
 	c.SetGridLayout(nil, nil)
 
 	var expanded bool
@@ -97,7 +97,7 @@ func (c *Context) header(label string, isTreeNode bool, opt option, id widgetID,
 	return nil
 }
 
-func (c *Context) treeNode(label string, opt option, id widgetID, f func()) error {
+func (c *Context) treeNode(label string, opt option, id WidgetID, f func()) error {
 	if err := c.header(label, true, opt, id, func() (err error) {
 		l, err := c.layout()
 		if err != nil {
diff --git a/helpers.go b/helpers.go
@@ -16,14 +16,14 @@ func (c *Context) Focus() {
 	c.setFocus(c.lastID)
 }
 
-func (c *Context) setFocus(id widgetID) {
+func (c *Context) setFocus(id WidgetID) {
 	c.focus = id
 	c.keepFocus = true
 }
 
-func (c *Context) addUsedContainer(id widgetID) {
+func (c *Context) addUsedContainer(id WidgetID) {
 	if c.usedContainers == nil {
-		c.usedContainers = map[widgetID]struct{}{}
+		c.usedContainers = map[WidgetID]struct{}{}
 	}
 	c.usedContainers[id] = struct{}{}
 }
diff --git a/id.go b/id.go
@@ -24,24 +24,24 @@ func caller() uintptr {
 // IDScope is useful when you want to create multiple widgets at the same position e.g. in a for loop.
 func (c *Context) IDScope(name string, f func()) {
 	pc := caller()
-	c.idStack = append(c.idStack, widgetID(fmt.Sprintf("caller:%d", pc)))
-	c.idStack = append(c.idStack, widgetID(fmt.Sprintf("string:%q", name)))
+	c.idStack = append(c.idStack, WidgetID(fmt.Sprintf("caller:%d", pc)))
+	c.idStack = append(c.idStack, WidgetID(fmt.Sprintf("string:%q", name)))
 	defer func() {
 		c.idStack = slices.Delete(c.idStack, len(c.idStack)-2, len(c.idStack))
 	}()
 	f()
 }
 
-func (c *Context) idScopeFromID(id widgetID, f func()) {
+func (c *Context) idScopeFromID(id WidgetID, f func()) {
 	c.idStack = append(c.idStack, id)
 	defer func() {
 		c.idStack = slices.Delete(c.idStack, len(c.idStack)-1, len(c.idStack))
 	}()
 	f()
 }
 
-func (c *Context) idScopeToWidgetID() widgetID {
-	var newID widgetID
+func (c *Context) idScopeToWidgetID() WidgetID {
+	var newID WidgetID
 	for _, id := range c.idStack {
 		if len(newID) > 0 {
 			newID += ":"
@@ -51,25 +51,25 @@ func (c *Context) idScopeToWidgetID() widgetID {
 	return newID
 }
 
-func (c *Context) idFromGlobalString(str string) widgetID {
-	return widgetID(fmt.Sprintf("string:%q", str))
+func (c *Context) idFromGlobalString(str string) WidgetID {
+	return WidgetID(fmt.Sprintf("string:%q", str))
 }
 
-func (c *Context) idFromString(str string) widgetID {
+func (c *Context) idFromString(str string) WidgetID {
 	newID := c.idScopeToWidgetID()
 	if len(newID) > 0 {
 		newID += ":"
 	}
-	newID += widgetID(fmt.Sprintf("string:%q", str))
+	newID += WidgetID(fmt.Sprintf("string:%q", str))
 	return newID
 }
 
 // idFromCaller returns a hash value based on the caller's file and line number.
-func (c *Context) idFromCaller(callerPC uintptr) widgetID {
+func (c *Context) idFromCaller(callerPC uintptr) WidgetID {
 	newID := c.idScopeToWidgetID()
 	if len(newID) > 0 {
 		newID += ":"
 	}
-	newID += widgetID(fmt.Sprintf("caller:%d", callerPC))
+	newID += WidgetID(fmt.Sprintf("caller:%d", callerPC))
 	return newID
 }
diff --git a/panel.go b/panel.go
@@ -14,14 +14,14 @@ func (c *Context) Panel(f func(layout ContainerLayout)) {
 	})
 }
 
-func (c *Context) panel(opt option, id widgetID, f func(layout ContainerLayout)) (err error) {
+func (c *Context) panel(opt option, id WidgetID, f func(layout ContainerLayout)) (err error) {
 	c.idScopeFromID(id, func() {
 		err = c.doPanel(opt, id, f)
 	})
 	return
 }
 
-func (c *Context) doPanel(opt option, id widgetID, f func(layout ContainerLayout)) (err error) {
+func (c *Context) doPanel(opt option, id WidgetID, f func(layout ContainerLayout)) (err error) {
 	cnt := c.container(id, opt)
 	l, err := c.layoutNext()
 	if err != nil {
diff --git a/slider.go b/slider.go
@@ -58,7 +58,7 @@ func (c *Context) SliderF(value *float64, lo, hi float64, step float64, digits i
 	return res
 }
 
-func (c *Context) slider(value *int, low, high, step int, id widgetID, opt option) (bool, error) {
+func (c *Context) slider(value *int, low, high, step int, id WidgetID, opt option) (bool, error) {
 	last := *value
 	v := last
 
@@ -103,7 +103,7 @@ func (c *Context) slider(value *int, low, high, step int, id widgetID, opt optio
 	return res, nil
 }
 
-func (c *Context) sliderF(value *float64, low, high, step float64, digits int, id widgetID, opt option) (bool, error) {
+func (c *Context) sliderF(value *float64, low, high, step float64, digits int, id WidgetID, opt option) (bool, error) {
 	last := *value
 	v := last
 
diff --git a/textfield.go b/textfield.go
diff --git a/widget.go b/widget.go

Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ func (c *Context) Button(label string) bool {`
`27`	`27`	`return res`
`28`	`28`	`}`
`29`	`29`
`30`		`-func (c *Context) button(label string, opt option, id widgetID) (bool, error) {`
	`30`	`+func (c *Context) button(label string, opt option, id WidgetID) (bool, error) {`
`31`	`31`	`res, err := c.widget(id, opt, func(bounds image.Rectangle, wasFocused bool) (bool, error) {`
`32`	`32`	`var res bool`
`33`	`33`	`// handle click`
Original file line number	Diff line number	Diff line change
`@@ -17,8 +17,8 @@ type container struct {`
`17`	`17`	`open bool`
`18`	`18`	`collapsed bool`
`19`	`19`
`20`		`- toggledIDs map[widgetID]struct{}`
`21`		`- textInputTextFields map[widgetID]*textinput.Field`
	`20`	`+ toggledIDs map[WidgetID]struct{}`
	`21`	`+ textInputTextFields map[WidgetID]*textinput.Field`
`22`	`22`	`}`
`23`	`23`
`24`	`24`	`// ContainerLayout represents the layout of a container widget.`
`@@ -37,7 +37,7 @@ type ContainerLayout struct {`
`37`	`37`	`ScrollOffset image.Point`
`38`	`38`	`}`
`39`	`39`
`40`		`-func (c Context) container(id widgetID, opt option) container {`
	`40`	`+func (c Context) container(id WidgetID, opt option) container {`
`41`	`41`	`if container, ok := c.idToContainer[id]; ok {`
`42`	`42`	`c.addUsedContainer(id)`
`43`	`43`	`return container`
`@@ -48,7 +48,7 @@ func (c Context) container(id widgetID, opt option) container {`
`48`	`48`	`}`
`49`	`49`
`50`	`50`	`if c.idToContainer == nil {`
`51`		`- c.idToContainer = map[widgetID]*container{}`
	`51`	`+ c.idToContainer = map[WidgetID]*container{}`
`52`	`52`	`}`
`53`	`53`	`cnt := &container{`
`54`	`54`	`headIdx: -1,`
`@@ -76,15 +76,15 @@ func (c *Context) Window(title string, rect image.Rectangle, f func(layout Conta`
`76`	`76`	`})`
`77`	`77`	`}`
`78`	`78`
`79`		`-func (c *Context) window(title string, bounds image.Rectangle, opt option, id widgetID, f func(layout ContainerLayout)) error {`
	`79`	`+func (c *Context) window(title string, bounds image.Rectangle, opt option, id WidgetID, f func(layout ContainerLayout)) error {`
`80`	`80`	`var err error`
`81`	`81`	`c.idScopeFromID(id, func() {`
`82`	`82`	`err = c.doWindow(title, bounds, opt, id, f)`
`83`	`83`	`})`
`84`	`84`	`return err`
`85`	`85`	`}`
`86`	`86`
`87`		`-func (c *Context) doWindow(title string, bounds image.Rectangle, opt option, id widgetID, f func(layout ContainerLayout)) (err error) {`
	`87`	`+func (c *Context) doWindow(title string, bounds image.Rectangle, opt option, id WidgetID, f func(layout ContainerLayout)) (err error) {`
`88`	`88`	`cnt := c.container(id, opt)`
`89`	`89`	`if cnt == nil \|\| !cnt.open {`
`90`	`90`	`return nil`
`@@ -296,31 +296,34 @@ func (c *Context) SetScroll(scroll image.Point) {`
`296`	`296`	`c.currentContainer().layout.ScrollOffset = scroll`
`297`	`297`	`}`
`298`	`298`
`299`		`-func (c container) textInputTextField(id widgetID) textinput.Field {`
	`299`	`+func (c container) textInputTextField(id WidgetID, createIfNeeded bool) textinput.Field {`
`300`	`300`	`if id == emptyWidgetID {`
`301`	`301`	`return nil`
`302`	`302`	`}`
`303`	`303`	`if _, ok := c.textInputTextFields[id]; !ok {`
	`304`	`+ if !createIfNeeded {`
	`305`	`+ return nil`
	`306`	`+ }`
`304`	`307`	`if c.textInputTextFields == nil {`
`305`		`- c.textInputTextFields = make(map[widgetID]*textinput.Field)`
	`308`	`+ c.textInputTextFields = make(map[WidgetID]*textinput.Field)`
`306`	`309`	`}`
`307`	`310`	`c.textInputTextFields[id] = &textinput.Field{}`
`308`	`311`	`}`
`309`	`312`	`return c.textInputTextFields[id]`
`310`	`313`	`}`
`311`	`314`
`312`		`-func (c *container) toggled(id widgetID) bool {`
	`315`	`+func (c *container) toggled(id WidgetID) bool {`
`313`	`316`	`_, ok := c.toggledIDs[id]`
`314`	`317`	`return ok`
`315`	`318`	`}`
`316`	`319`
`317`		`-func (c *container) toggle(id widgetID) {`
	`320`	`+func (c *container) toggle(id WidgetID) {`
`318`	`321`	`if _, toggled := c.toggledIDs[id]; toggled {`
`319`	`322`	`delete(c.toggledIDs, id)`
`320`	`323`	`return`
`321`	`324`	`}`
`322`	`325`	`if c.toggledIDs == nil {`
`323`		`- c.toggledIDs = map[widgetID]struct{}{}`
	`326`	`+ c.toggledIDs = map[WidgetID]struct{}{}`
`324`	`327`	`}`
`325`	`328`	`c.toggledIDs[id] = struct{}{}`
`326`	`329`	`}`
Original file line number	Diff line number	Diff line change
`@@ -214,7 +214,7 @@ func (c *Context) drawFrame(rect image.Rectangle, colorid int) {`
`214`	`214`	`}`
`215`	`215`	`}`
`216`	`216`
`217`		`-func (c *Context) drawWidgetFrame(id widgetID, rect image.Rectangle, colorid int, opt option) {`
	`217`	`+func (c *Context) drawWidgetFrame(id WidgetID, rect image.Rectangle, colorid int, opt option) {`
`218`	`218`	`if (opt & optionNoFrame) != 0 {`
`219`	`219`	`return`
`220`	`220`	`}`
Original file line number	Diff line number	Diff line change
`@@ -184,6 +184,7 @@ func (g Game) logWindow(ctx debugui.Context) {`
`184`	`184`	`submit = true`
`185`	`185`	`}`
`186`	`186`	`}`
	`187`	`+ textFieldID := ctx.CurrentWidgetID()`
`187`	`188`	`if ctx.Button("Submit") {`
`188`	`189`	`if g.logSubmitBuf != "" {`
`189`	`190`	`submit = true`
`@@ -192,7 +193,7 @@ func (g Game) logWindow(ctx debugui.Context) {`
`192`	`193`	`if submit {`
`193`	`194`	`g.writeLog(g.logSubmitBuf)`
`194`	`195`	`g.logSubmitBuf = ""`
`195`		`- ctx.SetTextFieldValue(g.logSubmitBuf)`
	`196`	`+ ctx.SetTextFieldValue(textFieldID, g.logSubmitBuf)`
`196`	`197`	`}`
`197`	`198`	`})`
`198`	`199`	`})`
Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,7 @@ func (c *Context) TreeNode(label string, f func()) {`
`48`	`48`	`})`
`49`	`49`	`}`
`50`	`50`
`51`		`-func (c *Context) header(label string, isTreeNode bool, opt option, id widgetID, f func() error) error {`
	`51`	`+func (c *Context) header(label string, isTreeNode bool, opt option, id WidgetID, f func() error) error {`
`52`	`52`	`c.SetGridLayout(nil, nil)`
`53`	`53`
`54`	`54`	`var expanded bool`
`@@ -97,7 +97,7 @@ func (c *Context) header(label string, isTreeNode bool, opt option, id widgetID,`
`97`	`97`	`return nil`
`98`	`98`	`}`
`99`	`99`
`100`		`-func (c *Context) treeNode(label string, opt option, id widgetID, f func()) error {`
	`100`	`+func (c *Context) treeNode(label string, opt option, id WidgetID, f func()) error {`
`101`	`101`	`if err := c.header(label, true, opt, id, func() (err error) {`
`102`	`102`	`l, err := c.layout()`
`103`	`103`	`if err != nil {`
Original file line number	Diff line number	Diff line change
`@@ -16,14 +16,14 @@ func (c *Context) Focus() {`
`16`	`16`	`c.setFocus(c.lastID)`
`17`	`17`	`}`
`18`	`18`
`19`		`-func (c *Context) setFocus(id widgetID) {`
	`19`	`+func (c *Context) setFocus(id WidgetID) {`
`20`	`20`	`c.focus = id`
`21`	`21`	`c.keepFocus = true`
`22`	`22`	`}`
`23`	`23`
`24`		`-func (c *Context) addUsedContainer(id widgetID) {`
	`24`	`+func (c *Context) addUsedContainer(id WidgetID) {`
`25`	`25`	`if c.usedContainers == nil {`
`26`		`- c.usedContainers = map[widgetID]struct{}{}`
	`26`	`+ c.usedContainers = map[WidgetID]struct{}{}`
`27`	`27`	`}`
`28`	`28`	`c.usedContainers[id] = struct{}{}`
`29`	`29`	`}`