debugui: refactoring: put commands to each container

This change removes the jump command.

Author: hajimehoshi

command.go

@@ -12,8 +12,7 @@ import (
 )
 
 const (
-	commandJump = 1 + iota
-	commandClip
+	commandClip = 1 + iota
 	commandRect
 	commandText
 	commandIcon
@@ -55,38 +54,35 @@ type drawCommand struct {
 
 type command struct {
 	typ  int
-	idx  int
 	base baseCommand // type 0 (TODO)
-	jump jumpCommand // type 1
-	clip clipCommand // type 2
-	rect rectCommand // type 3
-	text textCommand // type 4
-	icon iconCommand // type 5
-	draw drawCommand // type 6
+	clip clipCommand // type 1
+	rect rectCommand // type 2
+	text textCommand // type 3
+	icon iconCommand // type 4
+	draw drawCommand // type 5
 }
 
 // appendCommand adds a new command with type cmd_type to the command list.
-func (c *Context) appendCommand(cmd_type int) *command {
+func (c *Context) appendCommand(cmdType int) *command {
 	cmd := command{
-		typ: cmd_type,
+		typ: cmdType,
 	}
-	cmd.base.typ = cmd_type
-	cmd.idx = len(c.commandList)
-	c.commandList = append(c.commandList, &cmd)
+	cmd.base.typ = cmdType
+	cnt := c.currentRootContainer()
+	cnt.commandList = append(cnt.commandList, &cmd)
 	return &cmd
 }
 
-// appendJumpCommand appends a new jump command to the command list.
-// dstIdx is set to -1. This can be updated later.
-func (c *Context) appendJumpCommand() int {
-	cmd := c.appendCommand(commandJump)
-	cmd.jump.dstIdx = -1
-	return len(c.commandList) - 1
-}
-
 func (c *Context) commands() iter.Seq[*command] {
 	return func(yield func(command *command) bool) {
-		if len(c.commandList) == 0 {
+		for _, cnt := range c.rootContainers {
+			for _, cmd := range cnt.commandList {
+				if !yield(cmd) {
+					return
+				}
+			}
+		}
+		/*if len(c.commandList) == 0 {
 			return
 		}
 
@@ -104,6 +100,6 @@ func (c *Context) commands() iter.Seq[*command] {
 				return
 			}
 			cmd = c.commandList[idx]
-		}
+		}*/
 	}
 }

container.go

@@ -10,13 +10,17 @@ import (
 )
 
 type container struct {
+	parent *container
+
 	layout    ContainerLayout
-	headIdx   int
-	tailIdx   int
 	zIndex    int
 	open      bool
 	collapsed bool
 
+	// commandList is valid only for root containers.
+	// See the implementation of appendCommand which is the only place to append commands.
+	commandList []*command
+
 	toggledIDs          map[WidgetID]struct{}
 	textInputTextFields map[WidgetID]*textinput.Field
 }
@@ -51,9 +55,7 @@ func (c *Context) container(id WidgetID, opt option) *container {
 		c.idToContainer = map[WidgetID]*container{}
 	}
 	cnt := &container{
-		headIdx: -1,
-		tailIdx: -1,
-		open:    true,
+		open: true,
 	}
 	c.idToContainer[id] = cnt
 	c.addUsedContainer(id)
@@ -65,6 +67,13 @@ func (c *Context) currentContainer() *container {
 	return c.containerStack[len(c.containerStack)-1]
 }
 
+func (c *Context) currentRootContainer() *container {
+	var cnt *container
+	for cnt = c.currentContainer(); cnt != nil && cnt.parent != nil; cnt = cnt.parent {
+	}
+	return cnt
+}
+
 func (c *Context) Window(title string, rect image.Rectangle, f func(layout ContainerLayout)) {
 	pc := caller()
 	id := c.idFromCaller(pc)
@@ -95,19 +104,10 @@ func (c *Context) doWindow(title string, bounds image.Rectangle, opt option, id
 		cnt.layout.Bounds = bounds
 	}
 
-	c.pushContainer(cnt)
+	c.pushContainer(cnt, true)
 	defer c.popContainer()
 
-	// push container to roots list and push head command
-	c.rootList = append(c.rootList, cnt)
-	cnt.headIdx = c.appendJumpCommand()
-	defer func() {
-		// push tail 'goto' jump command and set head 'skip' command. the final steps
-		// on initing these are done in End
-		cnt := c.currentContainer()
-		cnt.tailIdx = c.appendJumpCommand()
-		c.commandList[cnt.headIdx].jump.dstIdx = len(c.commandList) //- 1
-	}()
+	c.rootContainers = append(c.rootContainers, cnt)
 
 	// set as hover root if the pointing device is overlapping this container and it has a
 	// higher zindex than the current hover root
@@ -275,7 +275,10 @@ func (c *Context) Popup(f func(layout ContainerLayout)) WidgetID {
 	return id
 }
 
-func (c *Context) pushContainer(cnt *container) {
+func (c *Context) pushContainer(cnt *container, root bool) {
+	if !root && len(c.containerStack) > 0 {
+		cnt.parent = c.containerStack[len(c.containerStack)-1]
+	}
 	c.containerStack = append(c.containerStack, cnt)
 }
 

context.go

@@ -28,8 +28,7 @@ type Context struct {
 	numberEdit    WidgetID
 
 	idStack        []WidgetID
-	commandList    []*command
-	rootList       []*container
+	rootContainers []*container
 	containerStack []*container
 	usedContainers map[WidgetID]struct{}
 	clipStack      []image.Rectangle
@@ -69,8 +68,10 @@ func (c *Context) update(f func(ctx *Context) error) (err error) {
 }
 
 func (c *Context) begin() {
-	c.commandList = slices.Delete(c.commandList, 0, len(c.commandList))
-	c.rootList = slices.Delete(c.rootList, 0, len(c.rootList))
+	for _, cnt := range c.rootContainers {
+		cnt.commandList = slices.Delete(cnt.commandList, 0, len(cnt.commandList))
+	}
+	c.rootContainers = slices.Delete(c.rootContainers, 0, len(c.rootContainers))
 	c.scrollTarget = nil
 	c.hoverRoot = c.nextHoverRoot
 	c.nextHoverRoot = nil
@@ -116,34 +117,10 @@ func (c *Context) end() error {
 	c.lastPointingPos = c.pointingPosition()
 
 	// sort root containers by zindex
-	sort.SliceStable(c.rootList, func(i, j int) bool {
-		return c.rootList[i].zIndex < c.rootList[j].zIndex
+	sort.SliceStable(c.rootContainers, func(i, j int) bool {
+		return c.rootContainers[i].zIndex < c.rootContainers[j].zIndex
 	})
 
-	// set root container jump commands
-	for i := range c.rootList {
-		cnt := c.rootList[i]
-		// if this is the first container then make the first command jump to it.
-		// otherwise set the previous container's tail to jump to this one
-		if i == 0 {
-			cmd := c.commandList[0]
-			if cmd.typ != commandJump {
-				panic("debugui: expected jump command")
-			}
-			cmd.jump.dstIdx = cnt.headIdx + 1
-			if cnt.headIdx >= len(c.commandList) {
-				panic("debugui: invalid head index")
-			}
-		} else {
-			prev := c.rootList[i-1]
-			c.commandList[prev.tailIdx].jump.dstIdx = cnt.headIdx + 1
-		}
-		// make the last container's tail jump to the end of command list
-		if i == len(c.rootList)-1 {
-			c.commandList[cnt.tailIdx].jump.dstIdx = len(c.commandList)
-		}
-	}
-
 	for id := range c.idToContainer {
 		if _, ok := c.usedContainers[id]; !ok {
 			delete(c.idToContainer, id)

panel.go

@@ -32,7 +32,7 @@ func (c *Context) doPanel(opt option, id WidgetID, f func(layout ContainerLayout
 		c.drawFrame(cnt.layout.Bounds, colorPanelBG)
 	}
 
-	c.pushContainer(cnt)
+	c.pushContainer(cnt, false)
 	defer c.popContainer()
 
 	if err := c.pushContainerBodyLayout(cnt, cnt.layout.Bounds, opt); err != nil {

widget.go

@@ -37,11 +37,6 @@ func (c *Context) inHoverRoot() bool {
 		if c.containerStack[i] == c.hoverRoot {
 			return true
 		}
-		// only root containers have their `head` field set; stop searching if we've
-		// reached the current root container
-		if c.containerStack[i].headIdx >= 0 {
-			break
-		}
 	}
 	return false
 }