wfound.go

/*
   Copyright 2012 the go.uik authors

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
*/

package uik

import (
	"github.com/skelterjohn/geom"
	"github.com/skelterjohn/go.wde"
	"image"
	"image/draw"
	"time"
)

// FrameDelay is how long the window will wait, after receiving an invalidation, to
// redraw the window. This gives related updates a chance to get ready. If they take
// too long, they'll just have to wait for the next frame.
const FrameDelay = 16 * time.Millisecond

// A foundation that wraps a wde.Window
type WindowFoundation struct {
	Foundation
	W               wde.Window
	pane            *Block
	paneCh          chan *Block
	waitForRepaint  chan bool
	doRepaintWindow chan bool
}

func NewWindow(parent wde.Window, width, height int) (wf *WindowFoundation, err error) {
	wf = new(WindowFoundation)

	wf.W, err = wde.NewWindow(width, height)
	if err != nil {
		return
	}
	wf.Size = geom.Coord{float64(width), float64(height)}
	wf.Initialize()

	if ReportIDs {
		Report(wf.ID, "window")
	}
	// Report(wf.ID, "is window")

	go wf.handleWindowEvents()
	go wf.handleWindowDrawing()
	go wf.HandleEvents()

	return
}

func (wf *WindowFoundation) Initialize() {
	wf.Foundation.Initialize()

	wf.DrawOp = draw.Src

	wf.waitForRepaint = make(chan bool)
	wf.doRepaintWindow = make(chan bool)
	wf.Invalidations = make(chan Invalidation, 1)
	wf.paneCh = make(chan *Block, 1)

	wf.Paint = LookupPaint("window", wf)
	wf.DrawOp = draw.Over

	// Report("wfound is", wf.ID)

	wf.HasKeyFocus = true
}

func (wf *WindowFoundation) SetPane(b *Block) {
	wf.paneCh <- b
}

func (wf *WindowFoundation) setPane(b *Block) {
	if wf.pane != nil {
		wf.RemoveBlock(wf.pane)
	}
	wf.pane = b
	// Report("pane", wf.ID, b.ID)
	wf.PlaceBlock(b, geom.Rect{geom.Coord{}, wf.Size})
}

func (wf *WindowFoundation) Show() {
	wf.W.Show()
	wf.Invalidate()
}

// wraps mouse events with float64 coordinates
func (wf *WindowFoundation) handleWindowEvents() {
	for e := range wf.W.EventChan() {
		ev := Event{
			TimeSinceStart(),
		}
		switch e := e.(type) {
		case wde.CloseEvent:
			wf.UserEventsIn.SendOrDrop(CloseEvent{
				Event:      ev,
				CloseEvent: e,
			})
		case wde.MouseMovedEvent:
			wf.UserEventsIn.SendOrDrop(MouseMovedEvent{
				Event:           ev,
				MouseMovedEvent: e,
				MouseLocator: MouseLocator{
					Loc: geom.Coord{float64(e.Where.X), float64(e.Where.Y)},
				},
				From: geom.Coord{float64(e.From.X), float64(e.From.Y)},
			})
		case wde.MouseDownEvent:
			wf.UserEventsIn.SendOrDrop(MouseDownEvent{
				Event:          ev,
				MouseDownEvent: e,
				MouseLocator: MouseLocator{
					Loc: geom.Coord{float64(e.Where.X), float64(e.Where.Y)},
				},
			})
		case wde.MouseUpEvent:
			// Report("wde.MouseUpEvent")
			wf.UserEventsIn.SendOrDrop(MouseUpEvent{
				Event:        ev,
				MouseUpEvent: e,
				MouseLocator: MouseLocator{
					Loc: geom.Coord{float64(e.Where.X), float64(e.Where.Y)},
				},
			})
		case wde.MouseDraggedEvent:
			wf.UserEventsIn.SendOrDrop(MouseDraggedEvent{
				Event:             ev,
				MouseDraggedEvent: e,
				MouseLocator: MouseLocator{
					Loc: geom.Coord{float64(e.Where.X), float64(e.Where.Y)},
				},
				From: geom.Coord{float64(e.From.X), float64(e.From.Y)},
			})
		case wde.MouseEnteredEvent:
			wf.UserEventsIn.SendOrDrop(MouseEnteredEvent{
				Event:             ev,
				MouseEnteredEvent: e,
				MouseLocator: MouseLocator{
					Loc: geom.Coord{float64(e.Where.X), float64(e.Where.Y)},
				},
				From: geom.Coord{float64(e.From.X), float64(e.From.Y)},
			})
		case wde.MouseExitedEvent:
			wf.UserEventsIn.SendOrDrop(MouseExitedEvent{
				Event:            ev,
				MouseExitedEvent: e,
				MouseLocator: MouseLocator{
					Loc: geom.Coord{float64(e.Where.X), float64(e.Where.Y)},
				},
				From: geom.Coord{float64(e.From.X), float64(e.From.Y)},
			})
		case wde.KeyDownEvent:
			wf.UserEventsIn.SendOrDrop(KeyDownEvent{
				Event:        ev,
				KeyDownEvent: e,
			})
		case wde.KeyUpEvent:
			wf.UserEventsIn.SendOrDrop(KeyUpEvent{
				Event:      ev,
				KeyUpEvent: e,
			})
		case wde.KeyTypedEvent:
			wf.UserEventsIn.SendOrDrop(KeyTypedEvent{
				Event:         ev,
				KeyTypedEvent: e,
			})
		case wde.ResizeEvent:
			wf.ResizeEvents.Stack(ResizeEvent{
				Size: geom.Coord{
					X: float64(e.Width),
					Y: float64(e.Height),
				},
			})
		}
	}
}

func (wf *WindowFoundation) HandleEvents() {
	for {
		select {
		case e := <-wf.UserEvents:
			wf.HandleEvent(e)
		case e := <-wf.BlockInvalidations:
			wf.DoBlockInvalidation(e)
		case e := <-wf.ResizeEvents:
			wf.DoResizeEvent(e)
			if wf.pane != nil {
				// Report("window resized", wf.Size)
				wf.PlaceBlock(wf.pane, geom.Rect{geom.Coord{}, wf.Size})
			}
			wf.Invalidate()
		}
	}
}

func (wf *WindowFoundation) handleWindowDrawing() {

	waitingForRepaint := false
	newStuff := false

	var scrBuf *image.RGBA

	var invalidRects RectSet

	for {
		select {
		case pane := <-wf.paneCh:
			wf.setPane(pane)
		case inv := <-wf.Invalidations:
			invalidRects = append(invalidRects, inv.Bounds...)
			if waitingForRepaint {
				newStuff = true
			} else {
				waitingForRepaint = true
				newStuff = true
				time.AfterFunc(FrameDelay, func() {
					wf.doRepaintWindow <- true
				})
			}

		case <-wf.doRepaintWindow:
			waitingForRepaint = false
			if !newStuff {
				break
			}
			scr := wf.W.Screen()
			if scrBuf == nil || scr.Bounds() != scrBuf.Bounds() {
				scrBuf = image.NewRGBA(scr.Bounds())
				invalidRects = RectSet{wf.Bounds()}
			}
			// Report("window drawing starting")
			wf.Drawer.Draw(scrBuf, invalidRects)
			// Report("window drawing done")
			var srs []image.Rectangle
			for _, ir := range invalidRects {
				sr := RectangleForRect(ir)
				si := scrBuf.SubImage(sr)
				srs = append(srs, sr)
				draw.Draw(scr, scr.Bounds(), si, image.Point{}, draw.Src)
			}
			invalidRects = invalidRects[:0]

			wf.W.FlushImage(srs...)
			newStuff = false
		}
	}
}