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 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485
|
// Copyright 2015 The Go Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
package x11driver
import (
"fmt"
"image"
"log"
"sync"
"github.com/BurntSushi/xgb"
"github.com/BurntSushi/xgb/render"
"github.com/BurntSushi/xgb/shm"
"github.com/BurntSushi/xgb/xproto"
"golang.org/x/exp/shiny/driver/internal/pump"
"golang.org/x/exp/shiny/screen"
"golang.org/x/mobile/event/key"
"golang.org/x/mobile/event/mouse"
)
// TODO: check that xgb is safe to use concurrently from multiple goroutines.
// For example, its Conn.WaitForEvent concept is a method, not a channel, so
// it's not obvious how to interrupt it to service a NewWindow request.
type completion struct {
sender screen.Sender
event screen.UploadedEvent
}
type screenImpl struct {
xc *xgb.Conn
xsi *xproto.ScreenInfo
keysyms [256][2]xproto.Keysym
atomWMDeleteWindow xproto.Atom
atomWMProtocols xproto.Atom
atomWMTakeFocus xproto.Atom
pictformat24 render.Pictformat
pictformat32 render.Pictformat
// window32 and its related X11 resources is an unmapped window so that we
// have a depth-32 window to create depth-32 pixmaps from, i.e. pixmaps
// with an alpha channel. The root window isn't guaranteed to be depth-32.
gcontext32 xproto.Gcontext
window32 xproto.Window
mu sync.Mutex
buffers map[shm.Seg]*bufferImpl
uploads map[uint16]completion
windows map[xproto.Window]*windowImpl
}
func newScreenImpl(xc *xgb.Conn) (*screenImpl, error) {
s := &screenImpl{
xc: xc,
xsi: xproto.Setup(xc).DefaultScreen(xc),
buffers: map[shm.Seg]*bufferImpl{},
uploads: map[uint16]completion{},
windows: map[xproto.Window]*windowImpl{},
}
if err := s.initAtoms(); err != nil {
return nil, err
}
if err := s.initKeyboardMapping(); err != nil {
return nil, err
}
if err := s.initPictformats(); err != nil {
return nil, err
}
if err := s.initWindow32(); err != nil {
return nil, err
}
go s.run()
return s, nil
}
func (s *screenImpl) run() {
for {
ev, err := s.xc.WaitForEvent()
if err != nil {
log.Printf("x11driver: xproto.WaitForEvent: %v", err)
continue
}
noWindowFound := false
switch ev := ev.(type) {
case xproto.DestroyNotifyEvent:
s.mu.Lock()
delete(s.windows, ev.Window)
s.mu.Unlock()
case shm.CompletionEvent:
s.handleCompletion(ev)
case xproto.ClientMessageEvent:
if ev.Type != s.atomWMProtocols || ev.Format != 32 {
break
}
switch xproto.Atom(ev.Data.Data32[0]) {
case s.atomWMDeleteWindow:
// TODO.
case s.atomWMTakeFocus:
xproto.SetInputFocus(s.xc, xproto.InputFocusParent, ev.Window, xproto.Timestamp(ev.Data.Data32[1]))
}
case xproto.ConfigureNotifyEvent:
if w := s.findWindow(ev.Window); w != nil {
w.handleConfigureNotify(ev)
} else {
noWindowFound = true
}
case xproto.ExposeEvent:
// TODO: xw = ev.Window
case xproto.FocusInEvent:
// TODO: xw = ev.Event
case xproto.FocusOutEvent:
// TODO: xw = ev.Event
case xproto.KeyPressEvent:
if w := s.findWindow(ev.Event); w != nil {
w.handleKey(ev.Detail, ev.State, key.DirPress)
} else {
noWindowFound = true
}
case xproto.KeyReleaseEvent:
if w := s.findWindow(ev.Event); w != nil {
w.handleKey(ev.Detail, ev.State, key.DirRelease)
} else {
noWindowFound = true
}
case xproto.ButtonPressEvent:
if w := s.findWindow(ev.Event); w != nil {
w.handleMouse(ev.EventX, ev.EventY, ev.Detail, ev.State, mouse.DirPress)
} else {
noWindowFound = true
}
case xproto.ButtonReleaseEvent:
if w := s.findWindow(ev.Event); w != nil {
w.handleMouse(ev.EventX, ev.EventY, ev.Detail, ev.State, mouse.DirRelease)
} else {
noWindowFound = true
}
case xproto.MotionNotifyEvent:
if w := s.findWindow(ev.Event); w != nil {
w.handleMouse(ev.EventX, ev.EventY, 0, ev.State, mouse.DirNone)
} else {
noWindowFound = true
}
}
if noWindowFound {
log.Printf("x11driver: no window found for event %T", ev)
}
}
}
// TODO: is findBuffer and the s.buffers field unused? Delete?
func (s *screenImpl) findBuffer(key shm.Seg) *bufferImpl {
s.mu.Lock()
b := s.buffers[key]
s.mu.Unlock()
return b
}
func (s *screenImpl) findWindow(key xproto.Window) *windowImpl {
s.mu.Lock()
w := s.windows[key]
s.mu.Unlock()
return w
}
func (s *screenImpl) handleCompletion(ev shm.CompletionEvent) {
s.mu.Lock()
completion, ok := s.uploads[ev.Sequence]
s.mu.Unlock()
if !ok {
log.Printf("x11driver: no matching upload for a SHM completion event")
return
}
completion.event.Buffer.(*bufferImpl).postUpload()
if completion.sender != nil {
// Call Send in a separate goroutine, so that this event-handling
// goroutine doesn't block.
go completion.sender.Send(completion.event)
}
}
const (
maxShmSide = 0x00007fff // 32,767 pixels.
maxShmSize = 0x10000000 // 268,435,456 bytes.
)
func (s *screenImpl) NewBuffer(size image.Point) (retBuf screen.Buffer, retErr error) {
// TODO: detect if the X11 server or connection cannot support SHM pixmaps,
// and fall back to regular pixmaps.
w, h := int64(size.X), int64(size.Y)
if w < 0 || maxShmSide < w || h < 0 || maxShmSide < h || maxShmSize < 4*w*h {
return nil, fmt.Errorf("x11driver: invalid buffer size %v", size)
}
xs, err := shm.NewSegId(s.xc)
if err != nil {
return nil, fmt.Errorf("x11driver: shm.NewSegId: %v", err)
}
bufLen := 4 * size.X * size.Y
shmid, addr, err := shmOpen(bufLen)
if err != nil {
return nil, fmt.Errorf("x11driver: shmOpen: %v", err)
}
defer func() {
if retErr != nil {
shmClose(addr)
}
}()
a := (*[maxShmSize]byte)(addr)
buf := (*a)[:bufLen:bufLen]
// readOnly is whether the shared memory is read-only from the X11 server's
// point of view. We need false to use SHM pixmaps.
const readOnly = false
shm.Attach(s.xc, xs, uint32(shmid), readOnly)
b := &bufferImpl{
s: s,
addr: addr,
buf: buf,
rgba: image.RGBA{
Pix: buf,
Stride: 4 * size.X,
Rect: image.Rectangle{Max: size},
},
size: size,
xs: xs,
}
s.mu.Lock()
s.buffers[b.xs] = b
s.mu.Unlock()
return b, nil
}
func (s *screenImpl) NewTexture(size image.Point) (screen.Texture, error) {
w, h := int64(size.X), int64(size.Y)
if w < 0 || maxShmSide < w || h < 0 || maxShmSide < h || maxShmSize < 4*w*h {
return nil, fmt.Errorf("x11driver: invalid texture size %v", size)
}
xm, err := xproto.NewPixmapId(s.xc)
if err != nil {
return nil, fmt.Errorf("x11driver: xproto.NewPixmapId failed: %v", err)
}
xp, err := render.NewPictureId(s.xc)
if err != nil {
return nil, fmt.Errorf("x11driver: xproto.NewPictureId failed: %v", err)
}
t := &textureImpl{
s: s,
size: size,
xm: xm,
xp: xp,
}
xproto.CreatePixmap(s.xc, textureDepth, xm, xproto.Drawable(s.window32), uint16(w), uint16(h))
render.CreatePicture(s.xc, xp, xproto.Drawable(xm), s.pictformat32, 0, nil)
return t, nil
}
func (s *screenImpl) NewWindow(opts *screen.NewWindowOptions) (screen.Window, error) {
// TODO: look at opts.
const width, height = 1024, 768
xw, err := xproto.NewWindowId(s.xc)
if err != nil {
return nil, fmt.Errorf("x11driver: xproto.NewWindowId failed: %v", err)
}
xg, err := xproto.NewGcontextId(s.xc)
if err != nil {
return nil, fmt.Errorf("x11driver: xproto.NewGcontextId failed: %v", err)
}
xp, err := render.NewPictureId(s.xc)
if err != nil {
return nil, fmt.Errorf("x11driver: render.NewPictureId failed: %v", err)
}
pictformat := render.Pictformat(0)
switch s.xsi.RootDepth {
default:
return nil, fmt.Errorf("x11driver: unsupported root depth %d", s.xsi.RootDepth)
case 24:
pictformat = s.pictformat24
case 32:
pictformat = s.pictformat32
}
w := &windowImpl{
s: s,
xw: xw,
xg: xg,
xp: xp,
pump: pump.Make(),
xevents: make(chan xgb.Event),
}
s.mu.Lock()
s.windows[xw] = w
s.mu.Unlock()
xproto.CreateWindow(s.xc, s.xsi.RootDepth, xw, s.xsi.Root,
0, 0, width, height, 0,
xproto.WindowClassInputOutput, s.xsi.RootVisual,
xproto.CwEventMask,
[]uint32{0 |
xproto.EventMaskKeyPress |
xproto.EventMaskKeyRelease |
xproto.EventMaskButtonPress |
xproto.EventMaskButtonRelease |
xproto.EventMaskPointerMotion |
xproto.EventMaskExposure |
xproto.EventMaskStructureNotify |
xproto.EventMaskFocusChange,
},
)
s.setProperty(xw, s.atomWMProtocols, s.atomWMDeleteWindow, s.atomWMTakeFocus)
xproto.CreateGC(s.xc, xg, xproto.Drawable(xw), 0, nil)
render.CreatePicture(s.xc, xp, xproto.Drawable(xw), pictformat, 0, nil)
xproto.MapWindow(s.xc, xw)
return w, nil
}
func (s *screenImpl) initAtoms() (err error) {
s.atomWMDeleteWindow, err = s.internAtom("WM_DELETE_WINDOW")
if err != nil {
return err
}
s.atomWMProtocols, err = s.internAtom("WM_PROTOCOLS")
if err != nil {
return err
}
s.atomWMTakeFocus, err = s.internAtom("WM_TAKE_FOCUS")
if err != nil {
return err
}
return nil
}
func (s *screenImpl) internAtom(name string) (xproto.Atom, error) {
r, err := xproto.InternAtom(s.xc, false, uint16(len(name)), name).Reply()
if err != nil {
return 0, fmt.Errorf("x11driver: xproto.InternAtom failed: %v", err)
}
if r == nil {
return 0, fmt.Errorf("x11driver: xproto.InternAtom failed")
}
return r.Atom, nil
}
func (s *screenImpl) initKeyboardMapping() error {
const keyLo, keyHi = 8, 255
km, err := xproto.GetKeyboardMapping(s.xc, keyLo, keyHi-keyLo+1).Reply()
if err != nil {
return err
}
n := int(km.KeysymsPerKeycode)
if n < 2 {
return fmt.Errorf("x11driver: too few keysyms per keycode: %d", n)
}
for i := keyLo; i <= keyHi; i++ {
s.keysyms[i][0] = km.Keysyms[(i-keyLo)*n+0]
s.keysyms[i][1] = km.Keysyms[(i-keyLo)*n+1]
}
return nil
}
func (s *screenImpl) initPictformats() error {
pformats, err := render.QueryPictFormats(s.xc).Reply()
if err != nil {
return fmt.Errorf("x11driver: render.QueryPictFormats failed: %v", err)
}
s.pictformat24, err = findPictformat(pformats.Formats, 24)
if err != nil {
return err
}
s.pictformat32, err = findPictformat(pformats.Formats, 32)
if err != nil {
return err
}
return nil
}
func findPictformat(fs []render.Pictforminfo, depth byte) (render.Pictformat, error) {
// This presumes little-endian BGRA.
want := render.Directformat{
RedShift: 16,
RedMask: 0xff,
GreenShift: 8,
GreenMask: 0xff,
BlueShift: 0,
BlueMask: 0xff,
AlphaShift: 24,
AlphaMask: 0xff,
}
if depth == 24 {
want.AlphaShift = 0
want.AlphaMask = 0x00
}
for _, f := range fs {
if f.Type == render.PictTypeDirect && f.Depth == depth && f.Direct == want {
return f.Id, nil
}
}
return 0, fmt.Errorf("x11driver: no matching Pictformat for depth %d", depth)
}
func (s *screenImpl) initWindow32() error {
visualid, err := findVisual(s.xsi, 32)
if err != nil {
return err
}
colormap, err := xproto.NewColormapId(s.xc)
if err != nil {
return fmt.Errorf("x11driver: xproto.NewColormapId failed: %v", err)
}
if err := xproto.CreateColormapChecked(
s.xc, xproto.ColormapAllocNone, colormap, s.xsi.Root, visualid).Check(); err != nil {
return fmt.Errorf("x11driver: xproto.CreateColormap failed: %v", err)
}
s.window32, err = xproto.NewWindowId(s.xc)
if err != nil {
return fmt.Errorf("x11driver: xproto.NewWindowId failed: %v", err)
}
s.gcontext32, err = xproto.NewGcontextId(s.xc)
if err != nil {
return fmt.Errorf("x11driver: xproto.NewGcontextId failed: %v", err)
}
const depth = 32
xproto.CreateWindow(s.xc, depth, s.window32, s.xsi.Root,
0, 0, 1, 1, 0,
xproto.WindowClassInputOutput, visualid,
// The CwBorderPixel attribute seems necessary for depth == 32. See
// http://stackoverflow.com/questions/3645632/how-to-create-a-window-with-a-bit-depth-of-32
xproto.CwBorderPixel|xproto.CwColormap,
[]uint32{0, uint32(colormap)},
)
xproto.CreateGC(s.xc, s.gcontext32, xproto.Drawable(s.window32), 0, nil)
return nil
}
func findVisual(xsi *xproto.ScreenInfo, depth byte) (xproto.Visualid, error) {
for _, d := range xsi.AllowedDepths {
if d.Depth != depth {
continue
}
for _, v := range d.Visuals {
if v.RedMask == 0xff0000 && v.GreenMask == 0xff00 && v.BlueMask == 0xff {
return v.VisualId, nil
}
}
}
return 0, fmt.Errorf("x11driver: no matching Visualid")
}
func (s *screenImpl) setProperty(xw xproto.Window, prop xproto.Atom, values ...xproto.Atom) {
b := make([]byte, len(values)*4)
for i, v := range values {
b[4*i+0] = uint8(v >> 0)
b[4*i+1] = uint8(v >> 8)
b[4*i+2] = uint8(v >> 16)
b[4*i+3] = uint8(v >> 24)
}
xproto.ChangeProperty(s.xc, xproto.PropModeReplace, xw, prop, xproto.AtomAtom, 32, uint32(len(values)), b)
}
|