kopia lustrzana https://github.com/abourget/shuttle-go
Now functional through `udev`. Improved readme, and timings.
rodzic
dd28f6750e
commit
2e206f61cb
53
README.md
53
README.md
|
@ -52,22 +52,6 @@ minimum number of milliseconds between two events to be considered
|
||||||
slow. It defaults to 200 ms.
|
slow. It defaults to 200 ms.
|
||||||
|
|
||||||
|
|
||||||
## Disable the native mouse pointer
|
|
||||||
|
|
||||||
The Shuttle acts as a mouse when you plug it into Ubuntu. Disable it with:
|
|
||||||
|
|
||||||
$ xinput --list
|
|
||||||
"Virtual core pointer" id=0 [XPointer]
|
|
||||||
"Virtual core keyboard" id=1 [XKeyboard]
|
|
||||||
"Keyboard2" id=2 [XExtensionKeyboard]
|
|
||||||
"Mouse2" id=3 [XExtensionKeyboard]
|
|
||||||
|
|
||||||
# Disable with:
|
|
||||||
$ xinput disable 2
|
|
||||||
|
|
||||||
Ref: https://unix.stackexchange.com/questions/91075/how-to-disable-keyboard
|
|
||||||
|
|
||||||
|
|
||||||
## Run
|
## Run
|
||||||
|
|
||||||
With:
|
With:
|
||||||
|
@ -75,20 +59,43 @@ With:
|
||||||
sudo shuttle-go /dev/input/by-id/usb-Contour_Design_ShuttlePRO_v2-event-if00
|
sudo shuttle-go /dev/input/by-id/usb-Contour_Design_ShuttlePRO_v2-event-if00
|
||||||
|
|
||||||
|
|
||||||
|
## Install in `udev` with:
|
||||||
|
|
||||||
|
As root, write in the file `/etc/udev/rules.d/01-shuttle-go.rules`:
|
||||||
|
|
||||||
|
ACTION=="add", ATTRS{name}=="Contour Design ShuttlePRO v2", ENV{MINOR}=="79", RUN+="/home/abourget/go/src/github.com/abourget/shuttle-go/udev-start.sh"
|
||||||
|
ACTION=="remove", ATTRS{name}=="Contour Design ShuttlePRO v2", RUN+="/usr/bin/pkill shuttle-go"
|
||||||
|
|
||||||
|
Then run:
|
||||||
|
|
||||||
|
udevadm control --reload-rules && udevadm trigger
|
||||||
|
|
||||||
|
Your device should not be plug-and-play.
|
||||||
|
|
||||||
|
WARNING: this will be executed as ROOT when the device is plugged. If
|
||||||
|
someone can write to that `udev-start.sh` file or anything that is run
|
||||||
|
by that script (`shuttle-go` for example), this could lead to
|
||||||
|
privilege escalation.
|
||||||
|
|
||||||
|
If you prefer running `shuttle-go` manually from a terminal, you can change the `ACTION=="add"` line above to:
|
||||||
|
|
||||||
|
ACTION=="add", ATTRS{name}=="Contour Design ShuttlePRO v2", MODE="0644"
|
||||||
|
|
||||||
|
This will grant non-root access to the device, so you can run
|
||||||
|
`shuttle-go` and see its logs.
|
||||||
|
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
MIT
|
MIT
|
||||||
|
|
||||||
##TODO
|
## TODO
|
||||||
|
|
||||||
* Don't require `xdotool`
|
* Don't require `xdotool`
|
||||||
* Use xgb's `xtest` package and send the FakeInput directly there.. should work
|
* Use xgb's `xtest` package and send the FakeInput directly there..
|
||||||
a lot better.
|
|
||||||
* Document in here all the keys that are work and their proper syntax. Add a few helpers.
|
* Document in here all the keys that are work and their proper syntax. Add a few helpers.
|
||||||
|
|
||||||
* Watch the configuration file, and reload on change.
|
* Watch the configuration file, and reload on change.
|
||||||
|
|
||||||
* Check udev, DISPLAY=:0.0 to start ?
|
|
||||||
* Retry ? Check the error message going out.
|
|
||||||
|
|
||||||
* Have a default SlowJog configuration.
|
* Have a default SlowJog configuration.
|
||||||
|
|
14
config.go
14
config.go
|
@ -54,11 +54,13 @@ type deviceBinding struct {
|
||||||
holdButtons []string
|
holdButtons []string
|
||||||
pressButton string
|
pressButton string
|
||||||
original string
|
original string
|
||||||
|
description string
|
||||||
}
|
}
|
||||||
|
|
||||||
func (ac *AppConfig) parseBindings() error {
|
func (ac *AppConfig) parseBindings() error {
|
||||||
for key, value := range ac.Bindings {
|
for key, value := range ac.Bindings {
|
||||||
newBinding := &deviceBinding{heldButtons: make(map[int]bool), original: value}
|
binding, description := bindingAndDescription(value)
|
||||||
|
newBinding := &deviceBinding{heldButtons: make(map[int]bool), original: binding, description: description}
|
||||||
|
|
||||||
// Input
|
// Input
|
||||||
input := strings.Split(key, "+")
|
input := strings.Split(key, "+")
|
||||||
|
@ -106,6 +108,16 @@ func (ac *AppConfig) parseBindings() error {
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
var descriptionRE = regexp.MustCompile(`([^/]*)(\s*// *(.+))?`)
|
||||||
|
|
||||||
|
func bindingAndDescription(input string) (string, string) {
|
||||||
|
matches := descriptionRE.FindStringSubmatch(input)
|
||||||
|
if matches == nil {
|
||||||
|
return input, ""
|
||||||
|
}
|
||||||
|
return strings.TrimSpace(matches[1]), strings.TrimSpace(matches[3])
|
||||||
|
}
|
||||||
|
|
||||||
func LoadConfig(filename string) error {
|
func LoadConfig(filename string) error {
|
||||||
cnt, err := ioutil.ReadFile(filename)
|
cnt, err := ioutil.ReadFile(filename)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
|
|
|
@ -0,0 +1,26 @@
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestBindingAndDescription(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
in string
|
||||||
|
bind, desc string
|
||||||
|
}{
|
||||||
|
{"Ctrl+A", "Ctrl+A", ""},
|
||||||
|
{"Ctrl+A // ", "Ctrl+A", ""},
|
||||||
|
{"Ctrl+A // Description", "Ctrl+A", "Description"},
|
||||||
|
{"Ctrl+A//Description", "Ctrl+A", "Description"},
|
||||||
|
{"Ctrl+A // Description", "Ctrl+A", "Description"},
|
||||||
|
}
|
||||||
|
|
||||||
|
for idx, test := range tests {
|
||||||
|
bind, desc := bindingAndDescription(test.in)
|
||||||
|
assert.Equal(t, test.bind, bind, "%d", idx)
|
||||||
|
assert.Equal(t, test.desc, desc, "%d", idx)
|
||||||
|
}
|
||||||
|
}
|
24
main.go
24
main.go
|
@ -12,17 +12,28 @@ import (
|
||||||
)
|
)
|
||||||
|
|
||||||
var configFile = flag.String("config", filepath.Join(os.Getenv("HOME"), ".shuttle-go.json"), "Location to the .shuttle-go.json configuration")
|
var configFile = flag.String("config", filepath.Join(os.Getenv("HOME"), ".shuttle-go.json"), "Location to the .shuttle-go.json configuration")
|
||||||
|
var logFile = flag.String("log-file", "", "Log to a file instead of stdout")
|
||||||
|
|
||||||
func main() {
|
func main() {
|
||||||
flag.Parse()
|
flag.Parse()
|
||||||
|
|
||||||
if len(flag.Args()) != 1 {
|
if *logFile != "" {
|
||||||
fmt.Println("Missing device name as parameter.\nExample: [program] /dev/input/by-id/usb-Contour_Design_ShuttlePRO_v2-event-if00\n")
|
log, err := os.Create(*logFile)
|
||||||
os.Exit(1)
|
if err != nil {
|
||||||
|
os.Exit(101)
|
||||||
|
}
|
||||||
|
defer log.Close()
|
||||||
|
os.Stderr = log
|
||||||
|
os.Stdout = log
|
||||||
}
|
}
|
||||||
|
|
||||||
err := LoadConfig(*configFile)
|
devicePath := "/dev/input/by-id/usb-Contour_Design_ShuttlePRO_v2-event-if00"
|
||||||
if err != nil {
|
if len(flag.Args()) == 1 {
|
||||||
|
devicePath = flag.Arg(0)
|
||||||
|
}
|
||||||
|
fmt.Println("Using device", devicePath)
|
||||||
|
|
||||||
|
if err := LoadConfig(*configFile); err != nil {
|
||||||
fmt.Println("Error reading configuration:", err)
|
fmt.Println("Error reading configuration:", err)
|
||||||
os.Exit(10)
|
os.Exit(10)
|
||||||
}
|
}
|
||||||
|
@ -45,7 +56,7 @@ func main() {
|
||||||
}
|
}
|
||||||
|
|
||||||
// Shuttle device event receiver
|
// Shuttle device event receiver
|
||||||
dev, err := evdev.Open(flag.Arg(0))
|
dev, err := evdev.Open(devicePath)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
fmt.Println("Couldn't open Shuttle device:", err)
|
fmt.Println("Couldn't open Shuttle device:", err)
|
||||||
os.Exit(2)
|
os.Exit(2)
|
||||||
|
@ -57,6 +68,7 @@ func main() {
|
||||||
for {
|
for {
|
||||||
if err := mapper.Process(); err != nil {
|
if err := mapper.Process(); err != nil {
|
||||||
fmt.Println("Error processing input events (continuing):", err)
|
fmt.Println("Error processing input events (continuing):", err)
|
||||||
|
os.Exit(123)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
@ -163,7 +163,7 @@ func (m *Mapper) EmitKeys(modifiers map[int]bool, keyDown int) error {
|
||||||
}
|
}
|
||||||
|
|
||||||
func (m *Mapper) executeBinding(binding *deviceBinding) error {
|
func (m *Mapper) executeBinding(binding *deviceBinding) error {
|
||||||
time.Sleep(100 * time.Millisecond)
|
time.Sleep(25 * time.Millisecond)
|
||||||
|
|
||||||
// cookie := xtest.FakeInputChecked(m.watcher.conn, 2, 0x7b00, 0, m.watcher.lastWindowID, 0, 0, 0x00)
|
// cookie := xtest.FakeInputChecked(m.watcher.conn, 2, 0x7b00, 0, m.watcher.lastWindowID, 0, 0, 0x00)
|
||||||
// if err := cookie.Check(); err != nil {
|
// if err := cookie.Check(); err != nil {
|
||||||
|
|
|
@ -0,0 +1,15 @@
|
||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
export HOME=/home/abourget
|
||||||
|
|
||||||
|
# Only the "event" input device, not the "mouse" device (where MINOR=34)
|
||||||
|
if [ $MINOR != "79" ]; then exit 99; fi
|
||||||
|
|
||||||
|
#LOGFILE=/tmp/shuttle-`basename $DEVNAME`.env
|
||||||
|
#env > $LOGFILE
|
||||||
|
|
||||||
|
export XAUTHORITY=$HOME/.Xauthority
|
||||||
|
export DISPLAY=:0.0
|
||||||
|
export PATH=/usr/bin # which includes the path to `xdotool`
|
||||||
|
|
||||||
|
$HOME/go/bin/shuttle-go -config $HOME/.shuttle-go.json -log-file /tmp/shuttle-go.log $DEVNAME
|
|
@ -0,0 +1,18 @@
|
||||||
|
Andrew Gallant is the maintainer of this fork. What follows is the original
|
||||||
|
list of authors for the x-go-binding.
|
||||||
|
|
||||||
|
# This is the official list of XGB authors for copyright purposes.
|
||||||
|
# This file is distinct from the CONTRIBUTORS files.
|
||||||
|
# See the latter for an explanation.
|
||||||
|
|
||||||
|
# Names should be added to this file as
|
||||||
|
# Name or Organization <email address>
|
||||||
|
# The email address is not required for organizations.
|
||||||
|
|
||||||
|
# Please keep the list sorted.
|
||||||
|
|
||||||
|
Anthony Martin <ality@pbrane.org>
|
||||||
|
Firmansyah Adiputra <frm.adiputra@gmail.com>
|
||||||
|
Google Inc.
|
||||||
|
Scott Lawrence <bytbox@gmail.com>
|
||||||
|
Tor Andersson <tor.andersson@gmail.com>
|
|
@ -0,0 +1,39 @@
|
||||||
|
Andrew Gallant is the maintainer of this fork. What follows is the original
|
||||||
|
list of contributors for the x-go-binding.
|
||||||
|
|
||||||
|
# This is the official list of people who can contribute
|
||||||
|
# (and typically have contributed) code to the XGB repository.
|
||||||
|
# The AUTHORS file lists the copyright holders; this file
|
||||||
|
# lists people. For example, Google employees are listed here
|
||||||
|
# but not in AUTHORS, because Google holds the copyright.
|
||||||
|
#
|
||||||
|
# The submission process automatically checks to make sure
|
||||||
|
# that people submitting code are listed in this file (by email address).
|
||||||
|
#
|
||||||
|
# Names should be added to this file only after verifying that
|
||||||
|
# the individual or the individual's organization has agreed to
|
||||||
|
# the appropriate Contributor License Agreement, found here:
|
||||||
|
#
|
||||||
|
# http://code.google.com/legal/individual-cla-v1.0.html
|
||||||
|
# http://code.google.com/legal/corporate-cla-v1.0.html
|
||||||
|
#
|
||||||
|
# The agreement for individuals can be filled out on the web.
|
||||||
|
#
|
||||||
|
# When adding J Random Contributor's name to this file,
|
||||||
|
# either J's name or J's organization's name should be
|
||||||
|
# added to the AUTHORS file, depending on whether the
|
||||||
|
# individual or corporate CLA was used.
|
||||||
|
|
||||||
|
# Names should be added to this file like so:
|
||||||
|
# Name <email address>
|
||||||
|
|
||||||
|
# Please keep the list sorted.
|
||||||
|
|
||||||
|
Anthony Martin <ality@pbrane.org>
|
||||||
|
Firmansyah Adiputra <frm.adiputra@gmail.com>
|
||||||
|
Ian Lance Taylor <iant@golang.org>
|
||||||
|
Nigel Tao <nigeltao@golang.org>
|
||||||
|
Robert Griesemer <gri@golang.org>
|
||||||
|
Russ Cox <rsc@golang.org>
|
||||||
|
Scott Lawrence <bytbox@gmail.com>
|
||||||
|
Tor Andersson <tor.andersson@gmail.com>
|
|
@ -0,0 +1,42 @@
|
||||||
|
// Copyright (c) 2009 The XGB Authors. All rights reserved.
|
||||||
|
//
|
||||||
|
// Redistribution and use in source and binary forms, with or without
|
||||||
|
// modification, are permitted provided that the following conditions are
|
||||||
|
// met:
|
||||||
|
//
|
||||||
|
// * Redistributions of source code must retain the above copyright
|
||||||
|
// notice, this list of conditions and the following disclaimer.
|
||||||
|
// * Redistributions in binary form must reproduce the above
|
||||||
|
// copyright notice, this list of conditions and the following disclaimer
|
||||||
|
// in the documentation and/or other materials provided with the
|
||||||
|
// distribution.
|
||||||
|
// * Neither the name of Google Inc. nor the names of its
|
||||||
|
// contributors may be used to endorse or promote products derived from
|
||||||
|
// this software without specific prior written permission.
|
||||||
|
//
|
||||||
|
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||||
|
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||||
|
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||||
|
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||||
|
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||||
|
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||||
|
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||||
|
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||||
|
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||||
|
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||||
|
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||||
|
//
|
||||||
|
// Subject to the terms and conditions of this License, Google hereby
|
||||||
|
// grants to You a perpetual, worldwide, non-exclusive, no-charge,
|
||||||
|
// royalty-free, irrevocable (except as stated in this section) patent
|
||||||
|
// license to make, have made, use, offer to sell, sell, import, and
|
||||||
|
// otherwise transfer this implementation of XGB, where such license
|
||||||
|
// applies only to those patent claims licensable by Google that are
|
||||||
|
// necessarily infringed by use of this implementation of XGB. If You
|
||||||
|
// institute patent litigation against any entity (including a
|
||||||
|
// cross-claim or counterclaim in a lawsuit) alleging that this
|
||||||
|
// implementation of XGB or a Contribution incorporated within this
|
||||||
|
// implementation of XGB constitutes direct or contributory patent
|
||||||
|
// infringement, then any patent licenses granted to You under this
|
||||||
|
// License for this implementation of XGB shall terminate as of the date
|
||||||
|
// such litigation is filed.
|
|
@ -0,0 +1,78 @@
|
||||||
|
# This Makefile is used by the developer. It is not needed in any way to build
|
||||||
|
# a checkout of the XGB repository.
|
||||||
|
# It will be useful, however, if you are hacking at the code generator.
|
||||||
|
# i.e., after making a change to the code generator, run 'make' in the
|
||||||
|
# xgb directory. This will build xgbgen and regenerate each sub-package.
|
||||||
|
# 'make test' will then run any appropriate tests (just tests xproto right now).
|
||||||
|
# 'make bench' will test a couple of benchmarks.
|
||||||
|
# 'make build-all' will then try to build each extension. This isn't strictly
|
||||||
|
# necessary, but it's a good idea to make sure each sub-package is a valid
|
||||||
|
# Go package.
|
||||||
|
|
||||||
|
# My path to the X protocol XML descriptions.
|
||||||
|
XPROTO=/usr/share/xcb
|
||||||
|
|
||||||
|
# All of the XML files in my /usr/share/xcb directory EXCEPT XKB. -_-
|
||||||
|
# This is intended to build xgbgen and generate Go code for each supported
|
||||||
|
# extension.
|
||||||
|
all: build-xgbgen \
|
||||||
|
bigreq.xml composite.xml damage.xml dpms.xml dri2.xml \
|
||||||
|
ge.xml glx.xml randr.xml record.xml render.xml res.xml \
|
||||||
|
screensaver.xml shape.xml shm.xml xc_misc.xml \
|
||||||
|
xevie.xml xf86dri.xml xf86vidmode.xml xfixes.xml xinerama.xml \
|
||||||
|
xprint.xml xproto.xml xselinux.xml xtest.xml \
|
||||||
|
xvmc.xml xv.xml
|
||||||
|
|
||||||
|
build-xgbgen:
|
||||||
|
(cd xgbgen && go build)
|
||||||
|
|
||||||
|
# Builds each individual sub-package to make sure its valid Go code.
|
||||||
|
build-all: bigreq.b composite.b damage.b dpms.b dri2.b ge.b glx.b randr.b \
|
||||||
|
record.b render.b res.b screensaver.b shape.b shm.b xcmisc.b \
|
||||||
|
xevie.b xf86dri.b xf86vidmode.b xfixes.b xinerama.b \
|
||||||
|
xprint.b xproto.b xselinux.b xtest.b xv.b xvmc.b
|
||||||
|
|
||||||
|
%.b:
|
||||||
|
(cd $* ; go build)
|
||||||
|
|
||||||
|
# Installs each individual sub-package.
|
||||||
|
install: bigreq.i composite.i damage.i dpms.i dri2.i ge.i glx.i randr.i \
|
||||||
|
record.i render.i res.i screensaver.i shape.i shm.i xcmisc.i \
|
||||||
|
xevie.i xf86dri.i xf86vidmode.i xfixes.i xinerama.i \
|
||||||
|
xprint.i xproto.i xselinux.i xtest.i xv.i xvmc.i
|
||||||
|
go install
|
||||||
|
|
||||||
|
%.i:
|
||||||
|
(cd $* ; go install)
|
||||||
|
|
||||||
|
# xc_misc is special because it has an underscore.
|
||||||
|
# There's probably a way to do this better, but Makefiles aren't my strong suit.
|
||||||
|
xc_misc.xml: build-xgbgen
|
||||||
|
mkdir -p xcmisc
|
||||||
|
xgbgen/xgbgen --proto-path $(XPROTO) $(XPROTO)/xc_misc.xml > xcmisc/xcmisc.go
|
||||||
|
|
||||||
|
%.xml: build-xgbgen
|
||||||
|
mkdir -p $*
|
||||||
|
xgbgen/xgbgen --proto-path $(XPROTO) $(XPROTO)/$*.xml > $*/$*.go
|
||||||
|
|
||||||
|
# Just test the xproto core protocol for now.
|
||||||
|
test:
|
||||||
|
(cd xproto ; go test)
|
||||||
|
|
||||||
|
# Force all xproto benchmarks to run and no tests.
|
||||||
|
bench:
|
||||||
|
(cd xproto ; go test -run 'nomatch' -bench '.*' -cpu 1,2,3,6)
|
||||||
|
|
||||||
|
# gofmt all non-auto-generated code.
|
||||||
|
# (auto-generated code is already gofmt'd.)
|
||||||
|
# Also do a column check (80 cols) after a gofmt.
|
||||||
|
# But don't check columns on auto-generated code, since I don't care if they
|
||||||
|
# break 80 cols.
|
||||||
|
gofmt:
|
||||||
|
gofmt -w *.go xgbgen/*.go examples/*.go examples/*/*.go xproto/xproto_test.go
|
||||||
|
colcheck *.go xgbgen/*.go examples/*.go examples/*/*.go xproto/xproto_test.go
|
||||||
|
|
||||||
|
push:
|
||||||
|
git push origin master
|
||||||
|
git push github master
|
||||||
|
|
|
@ -0,0 +1,54 @@
|
||||||
|
XGB is the X Go Binding, which is a low-level API to communicate with the
|
||||||
|
core X protocol and many of the X extensions. It is closely modeled after
|
||||||
|
XCB and xpyb.
|
||||||
|
|
||||||
|
It is thread safe and gets immediate improvement from parallelism when
|
||||||
|
GOMAXPROCS > 1. (See the benchmarks in xproto/xproto_test.go for evidence.)
|
||||||
|
|
||||||
|
Please see doc.go for more info.
|
||||||
|
|
||||||
|
Note that unless you know you need XGB, you can probably make your life
|
||||||
|
easier by using a slightly higher level library: xgbutil.
|
||||||
|
|
||||||
|
Quick Usage
|
||||||
|
===========
|
||||||
|
go get github.com/BurntSushi/xgb
|
||||||
|
go run go/path/src/github.com/BurntSushi/xgb/examples/create-window/main.go
|
||||||
|
|
||||||
|
BurntSushi's Fork
|
||||||
|
=================
|
||||||
|
I've forked the XGB repository from Google Code due to inactivty upstream.
|
||||||
|
|
||||||
|
Godoc documentation can be found here:
|
||||||
|
http://godoc.burntsushi.net/pkg/github.com/BurntSushi/xgb/
|
||||||
|
|
||||||
|
Much of the code has been rewritten in an effort to support thread safety
|
||||||
|
and multiple extensions. Namely, go_client.py has been thrown away in favor
|
||||||
|
of an xgbgen package.
|
||||||
|
|
||||||
|
The biggest parts that *haven't* been rewritten by me are the connection and
|
||||||
|
authentication handshakes. They're inherently messy, and there's really no
|
||||||
|
reason to re-work them. The rest of XGB has been completely rewritten.
|
||||||
|
|
||||||
|
I like to release my code under the WTFPL, but since I'm starting with someone
|
||||||
|
else's work, I'm leaving the original license/contributor/author information
|
||||||
|
in tact.
|
||||||
|
|
||||||
|
I suppose I can legitimately release xgbgen under the WTFPL. To be fair, it is
|
||||||
|
at least as complex as XGB itself. *sigh*
|
||||||
|
|
||||||
|
What follows is the original README:
|
||||||
|
|
||||||
|
XGB README
|
||||||
|
==========
|
||||||
|
XGB is the X protocol Go language Binding.
|
||||||
|
|
||||||
|
It is the Go equivalent of XCB, the X protocol C-language Binding
|
||||||
|
(http://xcb.freedesktop.org/).
|
||||||
|
|
||||||
|
Unless otherwise noted, the XGB source files are distributed
|
||||||
|
under the BSD-style license found in the LICENSE file.
|
||||||
|
|
||||||
|
Contributions should follow the same procedure as for the Go project:
|
||||||
|
http://golang.org/doc/contribute.html
|
||||||
|
|
|
@ -0,0 +1,29 @@
|
||||||
|
I like to keep all my code to 80 columns or less. I have plenty of screen real
|
||||||
|
estate, but enjoy 80 columns so that I can have multiple code windows open side
|
||||||
|
to side and not be plagued by the ugly auto-wrapping of a text editor.
|
||||||
|
|
||||||
|
If you don't oblige me, I will fix any patch you submit to abide 80 columns.
|
||||||
|
|
||||||
|
Note that this style restriction does not preclude gofmt, but introduces a few
|
||||||
|
peculiarities. The first is that gofmt will occasionally add spacing (typically
|
||||||
|
to comments) that ends up going over 80 columns. Either shorten the comment or
|
||||||
|
put it on its own line.
|
||||||
|
|
||||||
|
The second and more common hiccup is when a function definition extends beyond
|
||||||
|
80 columns. If one adds line breaks to keep it below 80 columns, gofmt will
|
||||||
|
indent all subsequent lines in a function definition to the same indentation
|
||||||
|
level of the function body. This results in a less-than-ideal separation
|
||||||
|
between function definition and function body. To remedy this, simply add a
|
||||||
|
line break like so:
|
||||||
|
|
||||||
|
func RestackWindowExtra(xu *xgbutil.XUtil, win xproto.Window, stackMode int,
|
||||||
|
sibling xproto.Window, source int) error {
|
||||||
|
|
||||||
|
return ClientEvent(xu, win, "_NET_RESTACK_WINDOW", source, int(sibling),
|
||||||
|
stackMode)
|
||||||
|
}
|
||||||
|
|
||||||
|
Something similar should also be applied to long 'if' or 'for' conditionals,
|
||||||
|
although it would probably be preferrable to break up the conditional to
|
||||||
|
smaller chunks with a few helper variables.
|
||||||
|
|
|
@ -0,0 +1,110 @@
|
||||||
|
package xgb
|
||||||
|
|
||||||
|
/*
|
||||||
|
auth.go contains functions to facilitate the parsing of .Xauthority files.
|
||||||
|
|
||||||
|
It is largely unmodified from the original XGB package that I forked.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/binary"
|
||||||
|
"errors"
|
||||||
|
"io"
|
||||||
|
"os"
|
||||||
|
)
|
||||||
|
|
||||||
|
// readAuthority reads the X authority file for the DISPLAY.
|
||||||
|
// If hostname == "" or hostname == "localhost",
|
||||||
|
// then use the system's hostname (as returned by os.Hostname) instead.
|
||||||
|
func readAuthority(hostname, display string) (
|
||||||
|
name string, data []byte, err error) {
|
||||||
|
|
||||||
|
// b is a scratch buffer to use and should be at least 256 bytes long
|
||||||
|
// (i.e. it should be able to hold a hostname).
|
||||||
|
b := make([]byte, 256)
|
||||||
|
|
||||||
|
// As per /usr/include/X11/Xauth.h.
|
||||||
|
const familyLocal = 256
|
||||||
|
const familyWild = 65535
|
||||||
|
|
||||||
|
if len(hostname) == 0 || hostname == "localhost" {
|
||||||
|
hostname, err = os.Hostname()
|
||||||
|
if err != nil {
|
||||||
|
return "", nil, err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fname := os.Getenv("XAUTHORITY")
|
||||||
|
if len(fname) == 0 {
|
||||||
|
home := os.Getenv("HOME")
|
||||||
|
if len(home) == 0 {
|
||||||
|
err = errors.New("Xauthority not found: $XAUTHORITY, $HOME not set")
|
||||||
|
return "", nil, err
|
||||||
|
}
|
||||||
|
fname = home + "/.Xauthority"
|
||||||
|
}
|
||||||
|
|
||||||
|
r, err := os.Open(fname)
|
||||||
|
if err != nil {
|
||||||
|
return "", nil, err
|
||||||
|
}
|
||||||
|
defer r.Close()
|
||||||
|
|
||||||
|
for {
|
||||||
|
var family uint16
|
||||||
|
if err := binary.Read(r, binary.BigEndian, &family); err != nil {
|
||||||
|
return "", nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
addr, err := getString(r, b)
|
||||||
|
if err != nil {
|
||||||
|
return "", nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
disp, err := getString(r, b)
|
||||||
|
if err != nil {
|
||||||
|
return "", nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
name0, err := getString(r, b)
|
||||||
|
if err != nil {
|
||||||
|
return "", nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
data0, err := getBytes(r, b)
|
||||||
|
if err != nil {
|
||||||
|
return "", nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
addrmatch := (family == familyWild) ||
|
||||||
|
(family == familyLocal && addr == hostname)
|
||||||
|
dispmatch := (disp == "") || (disp == display)
|
||||||
|
|
||||||
|
if addrmatch && dispmatch {
|
||||||
|
return name0, data0, nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
panic("unreachable")
|
||||||
|
}
|
||||||
|
|
||||||
|
func getBytes(r io.Reader, b []byte) ([]byte, error) {
|
||||||
|
var n uint16
|
||||||
|
if err := binary.Read(r, binary.BigEndian, &n); err != nil {
|
||||||
|
return nil, err
|
||||||
|
} else if n > uint16(len(b)) {
|
||||||
|
return nil, errors.New("bytes too long for buffer")
|
||||||
|
}
|
||||||
|
|
||||||
|
if _, err := io.ReadFull(r, b[0:n]); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return b[0:n], nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func getString(r io.Reader, b []byte) (string, error) {
|
||||||
|
b, err := getBytes(r, b)
|
||||||
|
if err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
return string(b), nil
|
||||||
|
}
|
|
@ -0,0 +1,185 @@
|
||||||
|
package xgb
|
||||||
|
|
||||||
|
/*
|
||||||
|
conn.go contains a couple of functions that do some real dirty work related
|
||||||
|
to the initial connection handshake with X.
|
||||||
|
|
||||||
|
This code is largely unmodified from the original XGB package that I forked.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import (
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"net"
|
||||||
|
"os"
|
||||||
|
"strconv"
|
||||||
|
"strings"
|
||||||
|
)
|
||||||
|
|
||||||
|
// connect connects to the X server given in the 'display' string,
|
||||||
|
// and does all the necessary setup handshaking.
|
||||||
|
// If 'display' is empty it will be taken from os.Getenv("DISPLAY").
|
||||||
|
// Note that you should read and understand the "Connection Setup" of the
|
||||||
|
// X Protocol Reference Manual before changing this function:
|
||||||
|
// http://goo.gl/4zGQg
|
||||||
|
func (c *Conn) connect(display string) error {
|
||||||
|
err := c.dial(display)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
return c.postConnect()
|
||||||
|
}
|
||||||
|
|
||||||
|
// connect init from to the net.Conn,
|
||||||
|
func (c *Conn) connectNet(netConn net.Conn) error {
|
||||||
|
c.conn = netConn
|
||||||
|
return c.postConnect()
|
||||||
|
}
|
||||||
|
|
||||||
|
// do the postConnect action after Conn get it's underly net.Conn
|
||||||
|
func (c *Conn) postConnect() error {
|
||||||
|
// Get authentication data
|
||||||
|
authName, authData, err := readAuthority(c.host, c.display)
|
||||||
|
noauth := false
|
||||||
|
if err != nil {
|
||||||
|
Logger.Printf("Could not get authority info: %v", err)
|
||||||
|
Logger.Println("Trying connection without authority info...")
|
||||||
|
authName = ""
|
||||||
|
authData = []byte{}
|
||||||
|
noauth = true
|
||||||
|
}
|
||||||
|
|
||||||
|
// Assume that the authentication protocol is "MIT-MAGIC-COOKIE-1".
|
||||||
|
if !noauth && (authName != "MIT-MAGIC-COOKIE-1" || len(authData) != 16) {
|
||||||
|
return errors.New("unsupported auth protocol " + authName)
|
||||||
|
}
|
||||||
|
|
||||||
|
buf := make([]byte, 12+Pad(len(authName))+Pad(len(authData)))
|
||||||
|
buf[0] = 0x6c
|
||||||
|
buf[1] = 0
|
||||||
|
Put16(buf[2:], 11)
|
||||||
|
Put16(buf[4:], 0)
|
||||||
|
Put16(buf[6:], uint16(len(authName)))
|
||||||
|
Put16(buf[8:], uint16(len(authData)))
|
||||||
|
Put16(buf[10:], 0)
|
||||||
|
copy(buf[12:], []byte(authName))
|
||||||
|
copy(buf[12+Pad(len(authName)):], authData)
|
||||||
|
if _, err = c.conn.Write(buf); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
head := make([]byte, 8)
|
||||||
|
if _, err = io.ReadFull(c.conn, head[0:8]); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
code := head[0]
|
||||||
|
reasonLen := head[1]
|
||||||
|
major := Get16(head[2:])
|
||||||
|
minor := Get16(head[4:])
|
||||||
|
dataLen := Get16(head[6:])
|
||||||
|
|
||||||
|
if major != 11 || minor != 0 {
|
||||||
|
return fmt.Errorf("x protocol version mismatch: %d.%d", major, minor)
|
||||||
|
}
|
||||||
|
|
||||||
|
buf = make([]byte, int(dataLen)*4+8, int(dataLen)*4+8)
|
||||||
|
copy(buf, head)
|
||||||
|
if _, err = io.ReadFull(c.conn, buf[8:]); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
if code == 0 {
|
||||||
|
reason := buf[8 : 8+reasonLen]
|
||||||
|
return fmt.Errorf("x protocol authentication refused: %s",
|
||||||
|
string(reason))
|
||||||
|
}
|
||||||
|
|
||||||
|
// Unfortunately, it isn't really feasible to read the setup bytes here,
|
||||||
|
// since the code to do so is in a different package.
|
||||||
|
// Users must call 'xproto.Setup(X)' to get the setup info.
|
||||||
|
c.SetupBytes = buf
|
||||||
|
|
||||||
|
// But also read stuff that we *need* to get started.
|
||||||
|
c.setupResourceIdBase = Get32(buf[12:])
|
||||||
|
c.setupResourceIdMask = Get32(buf[16:])
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// dial initializes the actual net connection with X.
|
||||||
|
func (c *Conn) dial(display string) error {
|
||||||
|
if len(display) == 0 {
|
||||||
|
display = os.Getenv("DISPLAY")
|
||||||
|
}
|
||||||
|
|
||||||
|
display0 := display
|
||||||
|
if len(display) == 0 {
|
||||||
|
return errors.New("empty display string")
|
||||||
|
}
|
||||||
|
|
||||||
|
colonIdx := strings.LastIndex(display, ":")
|
||||||
|
if colonIdx < 0 {
|
||||||
|
return errors.New("bad display string: " + display0)
|
||||||
|
}
|
||||||
|
|
||||||
|
var protocol, socket string
|
||||||
|
|
||||||
|
if display[0] == '/' {
|
||||||
|
socket = display[0:colonIdx]
|
||||||
|
} else {
|
||||||
|
slashIdx := strings.LastIndex(display, "/")
|
||||||
|
if slashIdx >= 0 {
|
||||||
|
protocol = display[0:slashIdx]
|
||||||
|
c.host = display[slashIdx+1 : colonIdx]
|
||||||
|
} else {
|
||||||
|
c.host = display[0:colonIdx]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
display = display[colonIdx+1 : len(display)]
|
||||||
|
if len(display) == 0 {
|
||||||
|
return errors.New("bad display string: " + display0)
|
||||||
|
}
|
||||||
|
|
||||||
|
var scr string
|
||||||
|
dotIdx := strings.LastIndex(display, ".")
|
||||||
|
if dotIdx < 0 {
|
||||||
|
c.display = display[0:]
|
||||||
|
} else {
|
||||||
|
c.display = display[0:dotIdx]
|
||||||
|
scr = display[dotIdx+1:]
|
||||||
|
}
|
||||||
|
|
||||||
|
var err error
|
||||||
|
c.DisplayNumber, err = strconv.Atoi(c.display)
|
||||||
|
if err != nil || c.DisplayNumber < 0 {
|
||||||
|
return errors.New("bad display string: " + display0)
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(scr) != 0 {
|
||||||
|
c.DefaultScreen, err = strconv.Atoi(scr)
|
||||||
|
if err != nil {
|
||||||
|
return errors.New("bad display string: " + display0)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Connect to server
|
||||||
|
if len(socket) != 0 {
|
||||||
|
c.conn, err = net.Dial("unix", socket+":"+c.display)
|
||||||
|
} else if len(c.host) != 0 {
|
||||||
|
if protocol == "" {
|
||||||
|
protocol = "tcp"
|
||||||
|
}
|
||||||
|
c.conn, err = net.Dial(protocol,
|
||||||
|
c.host+":"+strconv.Itoa(6000+c.DisplayNumber))
|
||||||
|
} else {
|
||||||
|
c.conn, err = net.Dial("unix", "/tmp/.X11-unix/X"+c.display)
|
||||||
|
}
|
||||||
|
|
||||||
|
if err != nil {
|
||||||
|
return errors.New("cannot connect to " + display0 + ": " + err.Error())
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
|
@ -0,0 +1,165 @@
|
||||||
|
package xgb
|
||||||
|
|
||||||
|
import (
|
||||||
|
"errors"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Cookie is the internal representation of a cookie, where one is generated
|
||||||
|
// for *every* request sent by XGB.
|
||||||
|
// 'cookie' is most frequently used by embedding it into a more specific
|
||||||
|
// kind of cookie, i.e., 'GetInputFocusCookie'.
|
||||||
|
type Cookie struct {
|
||||||
|
conn *Conn
|
||||||
|
Sequence uint16
|
||||||
|
replyChan chan []byte
|
||||||
|
errorChan chan error
|
||||||
|
pingChan chan bool
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewCookie creates a new cookie with the correct channels initialized
|
||||||
|
// depending upon the values of 'checked' and 'reply'. Together, there are
|
||||||
|
// four different kinds of cookies. (See more detailed comments in the
|
||||||
|
// function for more info on those.)
|
||||||
|
// Note that a sequence number is not set until just before the request
|
||||||
|
// corresponding to this cookie is sent over the wire.
|
||||||
|
//
|
||||||
|
// Unless you're building requests from bytes by hand, this method should
|
||||||
|
// not be used.
|
||||||
|
func (c *Conn) NewCookie(checked, reply bool) *Cookie {
|
||||||
|
cookie := &Cookie{
|
||||||
|
conn: c,
|
||||||
|
Sequence: 0, // we add the sequence id just before sending a request
|
||||||
|
replyChan: nil,
|
||||||
|
errorChan: nil,
|
||||||
|
pingChan: nil,
|
||||||
|
}
|
||||||
|
|
||||||
|
// There are four different kinds of cookies:
|
||||||
|
// Checked requests with replies get a reply channel and an error channel.
|
||||||
|
// Unchecked requests with replies get a reply channel and a ping channel.
|
||||||
|
// Checked requests w/o replies get a ping channel and an error channel.
|
||||||
|
// Unchecked requests w/o replies get no channels.
|
||||||
|
// The reply channel is used to send reply data.
|
||||||
|
// The error channel is used to send error data.
|
||||||
|
// The ping channel is used when one of the 'reply' or 'error' channels
|
||||||
|
// is missing but the other is present. The ping channel is way to force
|
||||||
|
// the blocking to stop and basically say "the error has been received
|
||||||
|
// in the main event loop" (when the ping channel is coupled with a reply
|
||||||
|
// channel) or "the request you made that has no reply was successful"
|
||||||
|
// (when the ping channel is coupled with an error channel).
|
||||||
|
if checked {
|
||||||
|
cookie.errorChan = make(chan error, 1)
|
||||||
|
if !reply {
|
||||||
|
cookie.pingChan = make(chan bool, 1)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if reply {
|
||||||
|
cookie.replyChan = make(chan []byte, 1)
|
||||||
|
if !checked {
|
||||||
|
cookie.pingChan = make(chan bool, 1)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return cookie
|
||||||
|
}
|
||||||
|
|
||||||
|
// Reply detects whether this is a checked or unchecked cookie, and calls
|
||||||
|
// 'replyChecked' or 'replyUnchecked' appropriately.
|
||||||
|
//
|
||||||
|
// Unless you're building requests from bytes by hand, this method should
|
||||||
|
// not be used.
|
||||||
|
func (c Cookie) Reply() ([]byte, error) {
|
||||||
|
// checked
|
||||||
|
if c.errorChan != nil {
|
||||||
|
return c.replyChecked()
|
||||||
|
}
|
||||||
|
return c.replyUnchecked()
|
||||||
|
}
|
||||||
|
|
||||||
|
// replyChecked waits for a response on either the replyChan or errorChan
|
||||||
|
// channels. If the former arrives, the bytes are returned with a nil error.
|
||||||
|
// If the latter arrives, no bytes are returned (nil) and the error received
|
||||||
|
// is returned.
|
||||||
|
//
|
||||||
|
// Unless you're building requests from bytes by hand, this method should
|
||||||
|
// not be used.
|
||||||
|
func (c Cookie) replyChecked() ([]byte, error) {
|
||||||
|
if c.replyChan == nil {
|
||||||
|
return nil, errors.New("Cannot call 'replyChecked' on a cookie that " +
|
||||||
|
"is not expecting a *reply* or an error.")
|
||||||
|
}
|
||||||
|
if c.errorChan == nil {
|
||||||
|
return nil, errors.New("Cannot call 'replyChecked' on a cookie that " +
|
||||||
|
"is not expecting a reply or an *error*.")
|
||||||
|
}
|
||||||
|
|
||||||
|
select {
|
||||||
|
case reply := <-c.replyChan:
|
||||||
|
return reply, nil
|
||||||
|
case err := <-c.errorChan:
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// replyUnchecked waits for a response on either the replyChan or pingChan
|
||||||
|
// channels. If the former arrives, the bytes are returned with a nil error.
|
||||||
|
// If the latter arrives, no bytes are returned (nil) and a nil error
|
||||||
|
// is returned. (In the latter case, the corresponding error can be retrieved
|
||||||
|
// from (Wait|Poll)ForEvent asynchronously.)
|
||||||
|
// In all honesty, you *probably* don't want to use this method.
|
||||||
|
//
|
||||||
|
// Unless you're building requests from bytes by hand, this method should
|
||||||
|
// not be used.
|
||||||
|
func (c Cookie) replyUnchecked() ([]byte, error) {
|
||||||
|
if c.replyChan == nil {
|
||||||
|
return nil, errors.New("Cannot call 'replyUnchecked' on a cookie " +
|
||||||
|
"that is not expecting a *reply*.")
|
||||||
|
}
|
||||||
|
|
||||||
|
select {
|
||||||
|
case reply := <-c.replyChan:
|
||||||
|
return reply, nil
|
||||||
|
case <-c.pingChan:
|
||||||
|
return nil, nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Check is used for checked requests that have no replies. It is a mechanism
|
||||||
|
// by which to report "success" or "error" in a synchronous fashion. (Therefore,
|
||||||
|
// unchecked requests without replies cannot use this method.)
|
||||||
|
// If the request causes an error, it is sent to this cookie's errorChan.
|
||||||
|
// If the request was successful, there is no response from the server.
|
||||||
|
// Thus, pingChan is sent a value when the *next* reply is read.
|
||||||
|
// If no more replies are being processed, we force a round trip request with
|
||||||
|
// GetInputFocus.
|
||||||
|
//
|
||||||
|
// Unless you're building requests from bytes by hand, this method should
|
||||||
|
// not be used.
|
||||||
|
func (c Cookie) Check() error {
|
||||||
|
if c.replyChan != nil {
|
||||||
|
return errors.New("Cannot call 'Check' on a cookie that is " +
|
||||||
|
"expecting a *reply*. Use 'Reply' instead.")
|
||||||
|
}
|
||||||
|
if c.errorChan == nil {
|
||||||
|
return errors.New("Cannot call 'Check' on a cookie that is " +
|
||||||
|
"not expecting a possible *error*.")
|
||||||
|
}
|
||||||
|
|
||||||
|
// First do a quick non-blocking check to see if we've been pinged.
|
||||||
|
select {
|
||||||
|
case err := <-c.errorChan:
|
||||||
|
return err
|
||||||
|
case <-c.pingChan:
|
||||||
|
return nil
|
||||||
|
default:
|
||||||
|
}
|
||||||
|
|
||||||
|
// Now force a round trip and try again, but block this time.
|
||||||
|
c.conn.Sync()
|
||||||
|
select {
|
||||||
|
case err := <-c.errorChan:
|
||||||
|
return err
|
||||||
|
case <-c.pingChan:
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,146 @@
|
||||||
|
/*
|
||||||
|
Package XGB provides the X Go Binding, which is a low-level API to communicate
|
||||||
|
with the core X protocol and many of the X extensions.
|
||||||
|
|
||||||
|
It is *very* closely modeled on XCB, so that experience with XCB (or xpyb) is
|
||||||
|
easily translatable to XGB. That is, it uses the same cookie/reply model
|
||||||
|
and is thread safe. There are otherwise no major differences (in the API).
|
||||||
|
|
||||||
|
Most uses of XGB typically fall under the realm of window manager and GUI kit
|
||||||
|
development, but other applications (like pagers, panels, tilers, etc.) may
|
||||||
|
also require XGB. Moreover, it is a near certainty that if you need to work
|
||||||
|
with X, xgbutil will be of great use to you as well:
|
||||||
|
https://github.com/BurntSushi/xgbutil
|
||||||
|
|
||||||
|
Example
|
||||||
|
|
||||||
|
This is an extremely terse example that demonstrates how to connect to X,
|
||||||
|
create a window, listen to StructureNotify events and Key{Press,Release}
|
||||||
|
events, map the window, and print out all events received. An example with
|
||||||
|
accompanying documentation can be found in examples/create-window.
|
||||||
|
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/BurntSushi/xgb"
|
||||||
|
"github.com/BurntSushi/xgb/xproto"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
X, err := xgb.NewConn()
|
||||||
|
if err != nil {
|
||||||
|
fmt.Println(err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
wid, _ := xproto.NewWindowId(X)
|
||||||
|
screen := xproto.Setup(X).DefaultScreen(X)
|
||||||
|
xproto.CreateWindow(X, screen.RootDepth, wid, screen.Root,
|
||||||
|
0, 0, 500, 500, 0,
|
||||||
|
xproto.WindowClassInputOutput, screen.RootVisual,
|
||||||
|
xproto.CwBackPixel | xproto.CwEventMask,
|
||||||
|
[]uint32{ // values must be in the order defined by the protocol
|
||||||
|
0xffffffff,
|
||||||
|
xproto.EventMaskStructureNotify |
|
||||||
|
xproto.EventMaskKeyPress |
|
||||||
|
xproto.EventMaskKeyRelease})
|
||||||
|
|
||||||
|
xproto.MapWindow(X, wid)
|
||||||
|
for {
|
||||||
|
ev, xerr := X.WaitForEvent()
|
||||||
|
if ev == nil && xerr == nil {
|
||||||
|
fmt.Println("Both event and error are nil. Exiting...")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
if ev != nil {
|
||||||
|
fmt.Printf("Event: %s\n", ev)
|
||||||
|
}
|
||||||
|
if xerr != nil {
|
||||||
|
fmt.Printf("Error: %s\n", xerr)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
Xinerama Example
|
||||||
|
|
||||||
|
This is another small example that shows how to query Xinerama for geometry
|
||||||
|
information of each active head. Accompanying documentation for this example
|
||||||
|
can be found in examples/xinerama.
|
||||||
|
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"log"
|
||||||
|
"github.com/BurntSushi/xgb"
|
||||||
|
"github.com/BurntSushi/xgb/xinerama"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
X, err := xgb.NewConn()
|
||||||
|
if err != nil {
|
||||||
|
log.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Initialize the Xinerama extension.
|
||||||
|
// The appropriate 'Init' function must be run for *every*
|
||||||
|
// extension before any of its requests can be used.
|
||||||
|
err = xinerama.Init(X)
|
||||||
|
if err != nil {
|
||||||
|
log.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
reply, err := xinerama.QueryScreens(X).Reply()
|
||||||
|
if err != nil {
|
||||||
|
log.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
fmt.Printf("Number of heads: %d\n", reply.Number)
|
||||||
|
for i, screen := range reply.ScreenInfo {
|
||||||
|
fmt.Printf("%d :: X: %d, Y: %d, Width: %d, Height: %d\n",
|
||||||
|
i, screen.XOrg, screen.YOrg, screen.Width, screen.Height)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
Parallelism
|
||||||
|
|
||||||
|
XGB can benefit greatly from parallelism due to its concurrent design. For
|
||||||
|
evidence of this claim, please see the benchmarks in xproto/xproto_test.go.
|
||||||
|
|
||||||
|
Tests
|
||||||
|
|
||||||
|
xproto/xproto_test.go contains a number of contrived tests that stress
|
||||||
|
particular corners of XGB that I presume could be problem areas. Namely:
|
||||||
|
requests with no replies, requests with replies, checked errors, unchecked
|
||||||
|
errors, sequence number wrapping, cookie buffer flushing (i.e., forcing a round
|
||||||
|
trip every N requests made that don't have a reply), getting/setting properties
|
||||||
|
and creating a window and listening to StructureNotify events.
|
||||||
|
|
||||||
|
Code Generator
|
||||||
|
|
||||||
|
Both XCB and xpyb use the same Python module (xcbgen) for a code generator. XGB
|
||||||
|
(before this fork) used the same code generator as well, but in my attempt to
|
||||||
|
add support for more extensions, I found the code generator extremely difficult
|
||||||
|
to work with. Therefore, I re-wrote the code generator in Go. It can be found
|
||||||
|
in its own sub-package, xgbgen, of xgb. My design of xgbgen includes a rough
|
||||||
|
consideration that it could be used for other languages.
|
||||||
|
|
||||||
|
What works
|
||||||
|
|
||||||
|
I am reasonably confident that the core X protocol is in full working form. I've
|
||||||
|
also tested the Xinerama and RandR extensions sparingly. Many of the other
|
||||||
|
existing extensions have Go source generated (and are compilable) and are
|
||||||
|
included in this package, but I am currently unsure of their status. They
|
||||||
|
*should* work.
|
||||||
|
|
||||||
|
What does not work
|
||||||
|
|
||||||
|
XKB is the only extension that intentionally does not work, although I suspect
|
||||||
|
that GLX also does not work (however, there is Go source code for GLX that
|
||||||
|
compiles, unlike XKB). I don't currently have any intention of getting XKB
|
||||||
|
working, due to its complexity and my current mental incapacity to test it.
|
||||||
|
|
||||||
|
*/
|
||||||
|
package xgb
|
|
@ -0,0 +1,105 @@
|
||||||
|
package xgb
|
||||||
|
|
||||||
|
/*
|
||||||
|
help.go is meant to contain a rough hodge podge of functions that are mainly
|
||||||
|
used in the auto generated code. Indeed, several functions here are simple
|
||||||
|
wrappers so that the sub-packages don't need to be smart about which stdlib
|
||||||
|
packages to import.
|
||||||
|
|
||||||
|
Also, the 'Get..' and 'Put..' functions are used through the core xgb package
|
||||||
|
too. (xgbutil uses them too.)
|
||||||
|
*/
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"strings"
|
||||||
|
)
|
||||||
|
|
||||||
|
// StringsJoin is an alias to strings.Join. It allows us to avoid having to
|
||||||
|
// import 'strings' in each of the generated Go files.
|
||||||
|
func StringsJoin(ss []string, sep string) string {
|
||||||
|
return strings.Join(ss, sep)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Sprintf is so we don't need to import 'fmt' in the generated Go files.
|
||||||
|
func Sprintf(format string, v ...interface{}) string {
|
||||||
|
return fmt.Sprintf(format, v...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Errorf is just a wrapper for fmt.Errorf. Exists for the same reason
|
||||||
|
// that 'stringsJoin' and 'sprintf' exists.
|
||||||
|
func Errorf(format string, v ...interface{}) error {
|
||||||
|
return fmt.Errorf(format, v...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Pad a length to align on 4 bytes.
|
||||||
|
func Pad(n int) int {
|
||||||
|
return (n + 3) & ^3
|
||||||
|
}
|
||||||
|
|
||||||
|
// PopCount counts the number of bits set in a value list mask.
|
||||||
|
func PopCount(mask0 int) int {
|
||||||
|
mask := uint32(mask0)
|
||||||
|
n := 0
|
||||||
|
for i := uint32(0); i < 32; i++ {
|
||||||
|
if mask&(1<<i) != 0 {
|
||||||
|
n++
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return n
|
||||||
|
}
|
||||||
|
|
||||||
|
// Put16 takes a 16 bit integer and copies it into a byte slice.
|
||||||
|
func Put16(buf []byte, v uint16) {
|
||||||
|
buf[0] = byte(v)
|
||||||
|
buf[1] = byte(v >> 8)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Put32 takes a 32 bit integer and copies it into a byte slice.
|
||||||
|
func Put32(buf []byte, v uint32) {
|
||||||
|
buf[0] = byte(v)
|
||||||
|
buf[1] = byte(v >> 8)
|
||||||
|
buf[2] = byte(v >> 16)
|
||||||
|
buf[3] = byte(v >> 24)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Put64 takes a 64 bit integer and copies it into a byte slice.
|
||||||
|
func Put64(buf []byte, v uint64) {
|
||||||
|
buf[0] = byte(v)
|
||||||
|
buf[1] = byte(v >> 8)
|
||||||
|
buf[2] = byte(v >> 16)
|
||||||
|
buf[3] = byte(v >> 24)
|
||||||
|
buf[4] = byte(v >> 32)
|
||||||
|
buf[5] = byte(v >> 40)
|
||||||
|
buf[6] = byte(v >> 48)
|
||||||
|
buf[7] = byte(v >> 56)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Get16 constructs a 16 bit integer from the beginning of a byte slice.
|
||||||
|
func Get16(buf []byte) uint16 {
|
||||||
|
v := uint16(buf[0])
|
||||||
|
v |= uint16(buf[1]) << 8
|
||||||
|
return v
|
||||||
|
}
|
||||||
|
|
||||||
|
// Get32 constructs a 32 bit integer from the beginning of a byte slice.
|
||||||
|
func Get32(buf []byte) uint32 {
|
||||||
|
v := uint32(buf[0])
|
||||||
|
v |= uint32(buf[1]) << 8
|
||||||
|
v |= uint32(buf[2]) << 16
|
||||||
|
v |= uint32(buf[3]) << 24
|
||||||
|
return v
|
||||||
|
}
|
||||||
|
|
||||||
|
// Get64 constructs a 64 bit integer from the beginning of a byte slice.
|
||||||
|
func Get64(buf []byte) uint64 {
|
||||||
|
v := uint64(buf[0])
|
||||||
|
v |= uint64(buf[1]) << 8
|
||||||
|
v |= uint64(buf[2]) << 16
|
||||||
|
v |= uint64(buf[3]) << 24
|
||||||
|
v |= uint64(buf[4]) << 32
|
||||||
|
v |= uint64(buf[5]) << 40
|
||||||
|
v |= uint64(buf[6]) << 48
|
||||||
|
v |= uint64(buf[7]) << 56
|
||||||
|
return v
|
||||||
|
}
|
|
@ -0,0 +1,29 @@
|
||||||
|
package xgb
|
||||||
|
|
||||||
|
// Sync sends a round trip request and waits for the response.
|
||||||
|
// This forces all pending cookies to be dealt with.
|
||||||
|
// You actually shouldn't need to use this like you might with Xlib. Namely,
|
||||||
|
// buffers are automatically flushed using Go's channels and round trip requests
|
||||||
|
// are forced where appropriate automatically.
|
||||||
|
func (c *Conn) Sync() {
|
||||||
|
cookie := c.NewCookie(true, true)
|
||||||
|
c.NewRequest(c.getInputFocusRequest(), cookie)
|
||||||
|
cookie.Reply() // wait for the buffer to clear
|
||||||
|
}
|
||||||
|
|
||||||
|
// getInputFocusRequest writes the raw bytes to a buffer.
|
||||||
|
// It is duplicated from xproto/xproto.go.
|
||||||
|
func (c *Conn) getInputFocusRequest() []byte {
|
||||||
|
size := 4
|
||||||
|
b := 0
|
||||||
|
buf := make([]byte, size)
|
||||||
|
|
||||||
|
buf[b] = 43 // request opcode
|
||||||
|
b += 1
|
||||||
|
|
||||||
|
b += 1 // padding
|
||||||
|
Put16(buf[b:], uint16(size/4)) // write request size in 4-byte units
|
||||||
|
b += 2
|
||||||
|
|
||||||
|
return buf
|
||||||
|
}
|
|
@ -0,0 +1,554 @@
|
||||||
|
package xgb
|
||||||
|
|
||||||
|
import (
|
||||||
|
"errors"
|
||||||
|
"io"
|
||||||
|
"log"
|
||||||
|
"net"
|
||||||
|
"os"
|
||||||
|
"sync"
|
||||||
|
)
|
||||||
|
|
||||||
|
var (
|
||||||
|
// Where to log error-messages. Defaults to stderr.
|
||||||
|
// To disable logging, just set this to log.New(ioutil.Discard, "", 0)
|
||||||
|
Logger = log.New(os.Stderr, "XGB: ", log.Lshortfile)
|
||||||
|
)
|
||||||
|
|
||||||
|
const (
|
||||||
|
// cookieBuffer represents the queue size of cookies existing at any
|
||||||
|
// point in time. The size of the buffer is really only important when
|
||||||
|
// there are many requests without replies made in sequence. Once the
|
||||||
|
// buffer fills, a round trip request is made to clear the buffer.
|
||||||
|
cookieBuffer = 1000
|
||||||
|
|
||||||
|
// xidBuffer represents the queue size of the xid channel.
|
||||||
|
// I don't think this value matters much, since xid generation is not
|
||||||
|
// that expensive.
|
||||||
|
xidBuffer = 5
|
||||||
|
|
||||||
|
// seqBuffer represents the queue size of the sequence number channel.
|
||||||
|
// I don't think this value matters much, since sequence number generation
|
||||||
|
// is not that expensive.
|
||||||
|
seqBuffer = 5
|
||||||
|
|
||||||
|
// reqBuffer represents the queue size of the number of requests that
|
||||||
|
// can be made until new ones block. This value seems OK.
|
||||||
|
reqBuffer = 100
|
||||||
|
|
||||||
|
// eventBuffer represents the queue size of the number of events or errors
|
||||||
|
// that can be loaded off the wire and not grabbed with WaitForEvent
|
||||||
|
// until reading an event blocks. This value should be big enough to handle
|
||||||
|
// bursts of events.
|
||||||
|
eventBuffer = 5000
|
||||||
|
)
|
||||||
|
|
||||||
|
// A Conn represents a connection to an X server.
|
||||||
|
type Conn struct {
|
||||||
|
host string
|
||||||
|
conn net.Conn
|
||||||
|
display string
|
||||||
|
DisplayNumber int
|
||||||
|
DefaultScreen int
|
||||||
|
SetupBytes []byte
|
||||||
|
|
||||||
|
setupResourceIdBase uint32
|
||||||
|
setupResourceIdMask uint32
|
||||||
|
|
||||||
|
eventChan chan eventOrError
|
||||||
|
cookieChan chan *Cookie
|
||||||
|
xidChan chan xid
|
||||||
|
seqChan chan uint16
|
||||||
|
reqChan chan *request
|
||||||
|
closing chan chan struct{}
|
||||||
|
|
||||||
|
// ExtLock is a lock used whenever new extensions are initialized.
|
||||||
|
// It should not be used. It is exported for use in the extension
|
||||||
|
// sub-packages.
|
||||||
|
ExtLock sync.RWMutex
|
||||||
|
|
||||||
|
// Extensions is a map from extension name to major opcode. It should
|
||||||
|
// not be used. It is exported for use in the extension sub-packages.
|
||||||
|
Extensions map[string]byte
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewConn creates a new connection instance. It initializes locks, data
|
||||||
|
// structures, and performs the initial handshake. (The code for the handshake
|
||||||
|
// has been relegated to conn.go.)
|
||||||
|
func NewConn() (*Conn, error) {
|
||||||
|
return NewConnDisplay("")
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewConnDisplay is just like NewConn, but allows a specific DISPLAY
|
||||||
|
// string to be used.
|
||||||
|
// If 'display' is empty it will be taken from os.Getenv("DISPLAY").
|
||||||
|
//
|
||||||
|
// Examples:
|
||||||
|
// NewConn(":1") -> net.Dial("unix", "", "/tmp/.X11-unix/X1")
|
||||||
|
// NewConn("/tmp/launch-12/:0") -> net.Dial("unix", "", "/tmp/launch-12/:0")
|
||||||
|
// NewConn("hostname:2.1") -> net.Dial("tcp", "", "hostname:6002")
|
||||||
|
// NewConn("tcp/hostname:1.0") -> net.Dial("tcp", "", "hostname:6001")
|
||||||
|
func NewConnDisplay(display string) (*Conn, error) {
|
||||||
|
conn := &Conn{}
|
||||||
|
|
||||||
|
// First connect. This reads authority, checks DISPLAY environment
|
||||||
|
// variable, and loads the initial Setup info.
|
||||||
|
err := conn.connect(display)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
return postNewConn(conn)
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewConnDisplay is just like NewConn, but allows a specific net.Conn
|
||||||
|
// to be used.
|
||||||
|
func NewConnNet(netConn net.Conn) (*Conn, error) {
|
||||||
|
conn := &Conn{}
|
||||||
|
|
||||||
|
// First connect. This reads authority, checks DISPLAY environment
|
||||||
|
// variable, and loads the initial Setup info.
|
||||||
|
err := conn.connectNet(netConn)
|
||||||
|
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
return postNewConn(conn)
|
||||||
|
}
|
||||||
|
|
||||||
|
func postNewConn(conn *Conn) (*Conn, error) {
|
||||||
|
conn.Extensions = make(map[string]byte)
|
||||||
|
|
||||||
|
conn.cookieChan = make(chan *Cookie, cookieBuffer)
|
||||||
|
conn.xidChan = make(chan xid, xidBuffer)
|
||||||
|
conn.seqChan = make(chan uint16, seqBuffer)
|
||||||
|
conn.reqChan = make(chan *request, reqBuffer)
|
||||||
|
conn.eventChan = make(chan eventOrError, eventBuffer)
|
||||||
|
conn.closing = make(chan chan struct{}, 1)
|
||||||
|
|
||||||
|
go conn.generateXIds()
|
||||||
|
go conn.generateSeqIds()
|
||||||
|
go conn.sendRequests()
|
||||||
|
go conn.readResponses()
|
||||||
|
|
||||||
|
return conn, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Close gracefully closes the connection to the X server.
|
||||||
|
func (c *Conn) Close() {
|
||||||
|
close(c.reqChan)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Event is an interface that can contain any of the events returned by the
|
||||||
|
// server. Use a type assertion switch to extract the Event structs.
|
||||||
|
type Event interface {
|
||||||
|
Bytes() []byte
|
||||||
|
String() string
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewEventFun is the type of function use to construct events from raw bytes.
|
||||||
|
// It should not be used. It is exported for use in the extension sub-packages.
|
||||||
|
type NewEventFun func(buf []byte) Event
|
||||||
|
|
||||||
|
// NewEventFuncs is a map from event numbers to functions that create
|
||||||
|
// the corresponding event. It should not be used. It is exported for use
|
||||||
|
// in the extension sub-packages.
|
||||||
|
var NewEventFuncs = make(map[int]NewEventFun)
|
||||||
|
|
||||||
|
// NewExtEventFuncs is a temporary map that stores event constructor functions
|
||||||
|
// for each extension. When an extension is initialized, each event for that
|
||||||
|
// extension is added to the 'NewEventFuncs' map. It should not be used. It is
|
||||||
|
// exported for use in the extension sub-packages.
|
||||||
|
var NewExtEventFuncs = make(map[string]map[int]NewEventFun)
|
||||||
|
|
||||||
|
// Error is an interface that can contain any of the errors returned by
|
||||||
|
// the server. Use a type assertion switch to extract the Error structs.
|
||||||
|
type Error interface {
|
||||||
|
SequenceId() uint16
|
||||||
|
BadId() uint32
|
||||||
|
Error() string
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewErrorFun is the type of function use to construct errors from raw bytes.
|
||||||
|
// It should not be used. It is exported for use in the extension sub-packages.
|
||||||
|
type NewErrorFun func(buf []byte) Error
|
||||||
|
|
||||||
|
// NewErrorFuncs is a map from error numbers to functions that create
|
||||||
|
// the corresponding error. It should not be used. It is exported for use in
|
||||||
|
// the extension sub-packages.
|
||||||
|
var NewErrorFuncs = make(map[int]NewErrorFun)
|
||||||
|
|
||||||
|
// NewExtErrorFuncs is a temporary map that stores error constructor functions
|
||||||
|
// for each extension. When an extension is initialized, each error for that
|
||||||
|
// extension is added to the 'NewErrorFuncs' map. It should not be used. It is
|
||||||
|
// exported for use in the extension sub-packages.
|
||||||
|
var NewExtErrorFuncs = make(map[string]map[int]NewErrorFun)
|
||||||
|
|
||||||
|
// eventOrError corresponds to values that can be either an event or an
|
||||||
|
// error.
|
||||||
|
type eventOrError interface{}
|
||||||
|
|
||||||
|
// NewId generates a new unused ID for use with requests like CreateWindow.
|
||||||
|
// If no new ids can be generated, the id returned is 0 and error is non-nil.
|
||||||
|
// This shouldn't be used directly, and is exported for use in the extension
|
||||||
|
// sub-packages.
|
||||||
|
// If you need identifiers, use the appropriate constructor.
|
||||||
|
// e.g., For a window id, use xproto.NewWindowId. For
|
||||||
|
// a new pixmap id, use xproto.NewPixmapId. And so on.
|
||||||
|
func (c *Conn) NewId() (uint32, error) {
|
||||||
|
xid := <-c.xidChan
|
||||||
|
if xid.err != nil {
|
||||||
|
return 0, xid.err
|
||||||
|
}
|
||||||
|
return xid.id, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// xid encapsulates a resource identifier being sent over the Conn.xidChan
|
||||||
|
// channel. If no new resource id can be generated, id is set to 0 and a
|
||||||
|
// non-nil error is set in xid.err.
|
||||||
|
type xid struct {
|
||||||
|
id uint32
|
||||||
|
err error
|
||||||
|
}
|
||||||
|
|
||||||
|
// generateXids sends new Ids down the channel for NewId to use.
|
||||||
|
// generateXids should be run in its own goroutine.
|
||||||
|
// This needs to be updated to use the XC Misc extension once we run out of
|
||||||
|
// new ids.
|
||||||
|
// Thanks to libxcb/src/xcb_xid.c. This code is greatly inspired by it.
|
||||||
|
func (conn *Conn) generateXIds() {
|
||||||
|
defer close(conn.xidChan)
|
||||||
|
|
||||||
|
// This requires some explanation. From the horse's mouth:
|
||||||
|
// "The resource-id-mask contains a single contiguous set of bits (at least
|
||||||
|
// 18). The client allocates resource IDs for types WINDOW, PIXMAP,
|
||||||
|
// CURSOR, FONT, GCONTEXT, and COLORMAP by choosing a value with only some
|
||||||
|
// subset of these bits set and ORing it with resource-id-base. Only values
|
||||||
|
// constructed in this way can be used to name newly created resources over
|
||||||
|
// this connection."
|
||||||
|
// So for example (using 8 bit integers), the mask might look like:
|
||||||
|
// 00111000
|
||||||
|
// So that valid values would be 00101000, 00110000, 00001000, and so on.
|
||||||
|
// Thus, the idea is to increment it by the place of the last least
|
||||||
|
// significant '1'. In this case, that value would be 00001000. To get
|
||||||
|
// that value, we can AND the original mask with its two's complement:
|
||||||
|
// 00111000 & 11001000 = 00001000.
|
||||||
|
// And we use that value to increment the last resource id to get a new one.
|
||||||
|
// (And then, of course, we OR it with resource-id-base.)
|
||||||
|
inc := conn.setupResourceIdMask & -conn.setupResourceIdMask
|
||||||
|
max := conn.setupResourceIdMask
|
||||||
|
last := uint32(0)
|
||||||
|
for {
|
||||||
|
// TODO: Use the XC Misc extension to look for released ids.
|
||||||
|
if last > 0 && last >= max-inc+1 {
|
||||||
|
conn.xidChan <- xid{
|
||||||
|
id: 0,
|
||||||
|
err: errors.New("There are no more available resource" +
|
||||||
|
"identifiers."),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
last += inc
|
||||||
|
conn.xidChan <- xid{
|
||||||
|
id: last | conn.setupResourceIdBase,
|
||||||
|
err: nil,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// newSeqId fetches the next sequence id from the Conn.seqChan channel.
|
||||||
|
func (c *Conn) newSequenceId() uint16 {
|
||||||
|
return <-c.seqChan
|
||||||
|
}
|
||||||
|
|
||||||
|
// generateSeqIds returns new sequence ids. It is meant to be run in its
|
||||||
|
// own goroutine.
|
||||||
|
// A sequence id is generated for *every* request. It's the identifier used
|
||||||
|
// to match up replies with requests.
|
||||||
|
// Since sequence ids can only be 16 bit integers we start over at zero when it
|
||||||
|
// comes time to wrap.
|
||||||
|
// N.B. As long as the cookie buffer is less than 2^16, there are no limitations
|
||||||
|
// on the number (or kind) of requests made in sequence.
|
||||||
|
func (c *Conn) generateSeqIds() {
|
||||||
|
defer close(c.seqChan)
|
||||||
|
|
||||||
|
seqid := uint16(1)
|
||||||
|
for {
|
||||||
|
c.seqChan <- seqid
|
||||||
|
if seqid == uint16((1<<16)-1) {
|
||||||
|
seqid = 0
|
||||||
|
} else {
|
||||||
|
seqid++
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// request encapsulates a buffer of raw bytes (containing the request data)
|
||||||
|
// and a cookie, which when combined represents a single request.
|
||||||
|
// The cookie is used to match up the reply/error.
|
||||||
|
type request struct {
|
||||||
|
buf []byte
|
||||||
|
cookie *Cookie
|
||||||
|
|
||||||
|
// seq is closed when the request (cookie) has been sequenced by the Conn.
|
||||||
|
seq chan struct{}
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewRequest takes the bytes and a cookie of a particular request, constructs
|
||||||
|
// a request type, and sends it over the Conn.reqChan channel.
|
||||||
|
// Note that the sequence number is added to the cookie after it is sent
|
||||||
|
// over the request channel, but before it is sent to X.
|
||||||
|
//
|
||||||
|
// Note that you may safely use NewRequest to send arbitrary byte requests
|
||||||
|
// to X. The resulting cookie can be used just like any normal cookie and
|
||||||
|
// abides by the same rules, except that for replies, you'll get back the
|
||||||
|
// raw byte data. This may be useful for performance critical sections where
|
||||||
|
// every allocation counts, since all X requests in XGB allocate a new byte
|
||||||
|
// slice. In contrast, NewRequest allocates one small request struct and
|
||||||
|
// nothing else. (Except when the cookie buffer is full and has to be flushed.)
|
||||||
|
//
|
||||||
|
// If you're using NewRequest manually, you'll need to use NewCookie to create
|
||||||
|
// a new cookie.
|
||||||
|
//
|
||||||
|
// In all likelihood, you should be able to copy and paste with some minor
|
||||||
|
// edits the generated code for the request you want to issue.
|
||||||
|
func (c *Conn) NewRequest(buf []byte, cookie *Cookie) {
|
||||||
|
seq := make(chan struct{})
|
||||||
|
c.reqChan <- &request{buf: buf, cookie: cookie, seq: seq}
|
||||||
|
<-seq
|
||||||
|
}
|
||||||
|
|
||||||
|
// sendRequests is run as a single goroutine that takes requests and writes
|
||||||
|
// the bytes to the wire and adds the cookie to the cookie queue.
|
||||||
|
// It is meant to be run as its own goroutine.
|
||||||
|
func (c *Conn) sendRequests() {
|
||||||
|
defer close(c.cookieChan)
|
||||||
|
|
||||||
|
for req := range c.reqChan {
|
||||||
|
// ho there! if the cookie channel is nearly full, force a round
|
||||||
|
// trip to clear out the cookie buffer.
|
||||||
|
// Note that we circumvent the request channel, because we're *in*
|
||||||
|
// the request channel.
|
||||||
|
if len(c.cookieChan) == cookieBuffer-1 {
|
||||||
|
if err := c.noop(); err != nil {
|
||||||
|
// Shut everything down.
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
req.cookie.Sequence = c.newSequenceId()
|
||||||
|
c.cookieChan <- req.cookie
|
||||||
|
c.writeBuffer(req.buf)
|
||||||
|
close(req.seq)
|
||||||
|
}
|
||||||
|
response := make(chan struct{})
|
||||||
|
c.closing <- response
|
||||||
|
c.noop() // Flush the response reading goroutine, ignore error.
|
||||||
|
<-response
|
||||||
|
c.conn.Close()
|
||||||
|
}
|
||||||
|
|
||||||
|
// noop circumvents the usual request sending goroutines and forces a round
|
||||||
|
// trip request manually.
|
||||||
|
func (c *Conn) noop() error {
|
||||||
|
cookie := c.NewCookie(true, true)
|
||||||
|
cookie.Sequence = c.newSequenceId()
|
||||||
|
c.cookieChan <- cookie
|
||||||
|
if err := c.writeBuffer(c.getInputFocusRequest()); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
cookie.Reply() // wait for the buffer to clear
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// writeBuffer is a convenience function for writing a byte slice to the wire.
|
||||||
|
func (c *Conn) writeBuffer(buf []byte) error {
|
||||||
|
if _, err := c.conn.Write(buf); err != nil {
|
||||||
|
Logger.Printf("A write error is unrecoverable: %s", err)
|
||||||
|
return err
|
||||||
|
} else {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// readResponses is a goroutine that reads events, errors and
|
||||||
|
// replies off the wire.
|
||||||
|
// When an event is read, it is always added to the event channel.
|
||||||
|
// When an error is read, if it corresponds to an existing checked cookie,
|
||||||
|
// it is sent to that cookie's error channel. Otherwise it is added to the
|
||||||
|
// event channel.
|
||||||
|
// When a reply is read, it is added to the corresponding cookie's reply
|
||||||
|
// channel. (It is an error if no such cookie exists in this case.)
|
||||||
|
// Finally, cookies that came "before" this reply are always cleaned up.
|
||||||
|
func (c *Conn) readResponses() {
|
||||||
|
defer close(c.eventChan)
|
||||||
|
|
||||||
|
var (
|
||||||
|
err Error
|
||||||
|
seq uint16
|
||||||
|
replyBytes []byte
|
||||||
|
)
|
||||||
|
|
||||||
|
for {
|
||||||
|
select {
|
||||||
|
case respond := <-c.closing:
|
||||||
|
respond <- struct{}{}
|
||||||
|
return
|
||||||
|
default:
|
||||||
|
}
|
||||||
|
|
||||||
|
buf := make([]byte, 32)
|
||||||
|
err, seq = nil, 0
|
||||||
|
if _, err := io.ReadFull(c.conn, buf); err != nil {
|
||||||
|
Logger.Printf("A read error is unrecoverable: %s", err)
|
||||||
|
c.eventChan <- err
|
||||||
|
c.Close()
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
switch buf[0] {
|
||||||
|
case 0: // This is an error
|
||||||
|
// Use the constructor function for this error (that is auto
|
||||||
|
// generated) by looking it up by the error number.
|
||||||
|
newErrFun, ok := NewErrorFuncs[int(buf[1])]
|
||||||
|
if !ok {
|
||||||
|
Logger.Printf("BUG: Could not find error constructor function "+
|
||||||
|
"for error with number %d.", buf[1])
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
err = newErrFun(buf)
|
||||||
|
seq = err.SequenceId()
|
||||||
|
|
||||||
|
// This error is either sent to the event channel or a specific
|
||||||
|
// cookie's error channel below.
|
||||||
|
case 1: // This is a reply
|
||||||
|
seq = Get16(buf[2:])
|
||||||
|
|
||||||
|
// check to see if this reply has more bytes to be read
|
||||||
|
size := Get32(buf[4:])
|
||||||
|
if size > 0 {
|
||||||
|
byteCount := 32 + size*4
|
||||||
|
biggerBuf := make([]byte, byteCount)
|
||||||
|
copy(biggerBuf[:32], buf)
|
||||||
|
if _, err := io.ReadFull(c.conn, biggerBuf[32:]); err != nil {
|
||||||
|
Logger.Printf("A read error is unrecoverable: %s", err)
|
||||||
|
c.eventChan <- err
|
||||||
|
c.Close()
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
replyBytes = biggerBuf
|
||||||
|
} else {
|
||||||
|
replyBytes = buf
|
||||||
|
}
|
||||||
|
|
||||||
|
// This reply is sent to its corresponding cookie below.
|
||||||
|
default: // This is an event
|
||||||
|
// Use the constructor function for this event (like for errors,
|
||||||
|
// and is also auto generated) by looking it up by the event number.
|
||||||
|
// Note that we AND the event number with 127 so that we ignore
|
||||||
|
// the most significant bit (which is set when it was sent from
|
||||||
|
// a SendEvent request).
|
||||||
|
evNum := int(buf[0] & 127)
|
||||||
|
newEventFun, ok := NewEventFuncs[evNum]
|
||||||
|
if !ok {
|
||||||
|
Logger.Printf("BUG: Could not find event construct function "+
|
||||||
|
"for event with number %d.", evNum)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
c.eventChan <- newEventFun(buf)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
// At this point, we have a sequence number and we're either
|
||||||
|
// processing an error or a reply, which are both responses to
|
||||||
|
// requests. So all we have to do is find the cookie corresponding
|
||||||
|
// to this error/reply, and send the appropriate data to it.
|
||||||
|
// In doing so, we make sure that any cookies that came before it
|
||||||
|
// are marked as successful if they are void and checked.
|
||||||
|
// If there's a cookie that requires a reply that is before this
|
||||||
|
// reply, then something is wrong.
|
||||||
|
for cookie := range c.cookieChan {
|
||||||
|
// This is the cookie we're looking for. Process and break.
|
||||||
|
if cookie.Sequence == seq {
|
||||||
|
if err != nil { // this is an error to a request
|
||||||
|
// synchronous processing
|
||||||
|
if cookie.errorChan != nil {
|
||||||
|
cookie.errorChan <- err
|
||||||
|
} else { // asynchronous processing
|
||||||
|
c.eventChan <- err
|
||||||
|
// if this is an unchecked reply, ping the cookie too
|
||||||
|
if cookie.pingChan != nil {
|
||||||
|
cookie.pingChan <- true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} else { // this is a reply
|
||||||
|
if cookie.replyChan == nil {
|
||||||
|
Logger.Printf("Reply with sequence id %d does not "+
|
||||||
|
"have a cookie with a valid reply channel.", seq)
|
||||||
|
continue
|
||||||
|
} else {
|
||||||
|
cookie.replyChan <- replyBytes
|
||||||
|
}
|
||||||
|
}
|
||||||
|
break
|
||||||
|
}
|
||||||
|
|
||||||
|
switch {
|
||||||
|
// Checked requests with replies
|
||||||
|
case cookie.replyChan != nil && cookie.errorChan != nil:
|
||||||
|
Logger.Printf("Found cookie with sequence id %d that is "+
|
||||||
|
"expecting a reply but will never get it. Currently "+
|
||||||
|
"on sequence number %d", cookie.Sequence, seq)
|
||||||
|
// Unchecked requests with replies
|
||||||
|
case cookie.replyChan != nil && cookie.pingChan != nil:
|
||||||
|
Logger.Printf("Found cookie with sequence id %d that is "+
|
||||||
|
"expecting a reply (and not an error) but will never "+
|
||||||
|
"get it. Currently on sequence number %d",
|
||||||
|
cookie.Sequence, seq)
|
||||||
|
// Checked requests without replies
|
||||||
|
case cookie.pingChan != nil && cookie.errorChan != nil:
|
||||||
|
cookie.pingChan <- true
|
||||||
|
// Unchecked requests without replies don't have any channels,
|
||||||
|
// so we can't do anything with them except let them pass by.
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// processEventOrError takes an eventOrError, type switches on it,
|
||||||
|
// and returns it in Go idiomatic style.
|
||||||
|
func processEventOrError(everr eventOrError) (Event, Error) {
|
||||||
|
switch ee := everr.(type) {
|
||||||
|
case Event:
|
||||||
|
return ee, nil
|
||||||
|
case Error:
|
||||||
|
return nil, ee
|
||||||
|
default:
|
||||||
|
Logger.Printf("Invalid event/error type: %T", everr)
|
||||||
|
return nil, nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// WaitForEvent returns the next event from the server.
|
||||||
|
// It will block until an event is available.
|
||||||
|
// WaitForEvent returns either an Event or an Error. (Returning both
|
||||||
|
// is a bug.) Note than an Error here is an X error and not an XGB error. That
|
||||||
|
// is, X errors are sometimes completely expected (and you may want to ignore
|
||||||
|
// them in some cases).
|
||||||
|
//
|
||||||
|
// If both the event and error are nil, then the connection has been closed.
|
||||||
|
func (c *Conn) WaitForEvent() (Event, Error) {
|
||||||
|
return processEventOrError(<-c.eventChan)
|
||||||
|
}
|
||||||
|
|
||||||
|
// PollForEvent returns the next event from the server if one is available in
|
||||||
|
// the internal queue without blocking. Note that unlike WaitForEvent, both
|
||||||
|
// Event and Error could be nil. Indeed, they are both nil when the event queue
|
||||||
|
// is empty.
|
||||||
|
func (c *Conn) PollForEvent() (Event, Error) {
|
||||||
|
select {
|
||||||
|
case everr := <-c.eventChan:
|
||||||
|
return processEventOrError(everr)
|
||||||
|
default:
|
||||||
|
return nil, nil
|
||||||
|
}
|
||||||
|
}
|
Plik diff jest za duży
Load Diff
|
@ -0,0 +1,416 @@
|
||||||
|
// Package xtest is the X client API for the XTEST extension.
|
||||||
|
package xtest
|
||||||
|
|
||||||
|
// This file is automatically generated from xtest.xml. Edit at your peril!
|
||||||
|
|
||||||
|
import (
|
||||||
|
"github.com/BurntSushi/xgb"
|
||||||
|
|
||||||
|
"github.com/BurntSushi/xgb/xproto"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Init must be called before using the XTEST extension.
|
||||||
|
func Init(c *xgb.Conn) error {
|
||||||
|
reply, err := xproto.QueryExtension(c, 5, "XTEST").Reply()
|
||||||
|
switch {
|
||||||
|
case err != nil:
|
||||||
|
return err
|
||||||
|
case !reply.Present:
|
||||||
|
return xgb.Errorf("No extension named XTEST could be found on on the server.")
|
||||||
|
}
|
||||||
|
|
||||||
|
c.ExtLock.Lock()
|
||||||
|
c.Extensions["XTEST"] = reply.MajorOpcode
|
||||||
|
c.ExtLock.Unlock()
|
||||||
|
for evNum, fun := range xgb.NewExtEventFuncs["XTEST"] {
|
||||||
|
xgb.NewEventFuncs[int(reply.FirstEvent)+evNum] = fun
|
||||||
|
}
|
||||||
|
for errNum, fun := range xgb.NewExtErrorFuncs["XTEST"] {
|
||||||
|
xgb.NewErrorFuncs[int(reply.FirstError)+errNum] = fun
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func init() {
|
||||||
|
xgb.NewExtEventFuncs["XTEST"] = make(map[int]xgb.NewEventFun)
|
||||||
|
xgb.NewExtErrorFuncs["XTEST"] = make(map[int]xgb.NewErrorFun)
|
||||||
|
}
|
||||||
|
|
||||||
|
const (
|
||||||
|
CursorNone = 0
|
||||||
|
CursorCurrent = 1
|
||||||
|
)
|
||||||
|
|
||||||
|
// Skipping definition for base type 'Bool'
|
||||||
|
|
||||||
|
// Skipping definition for base type 'Byte'
|
||||||
|
|
||||||
|
// Skipping definition for base type 'Card8'
|
||||||
|
|
||||||
|
// Skipping definition for base type 'Char'
|
||||||
|
|
||||||
|
// Skipping definition for base type 'Void'
|
||||||
|
|
||||||
|
// Skipping definition for base type 'Double'
|
||||||
|
|
||||||
|
// Skipping definition for base type 'Float'
|
||||||
|
|
||||||
|
// Skipping definition for base type 'Int16'
|
||||||
|
|
||||||
|
// Skipping definition for base type 'Int32'
|
||||||
|
|
||||||
|
// Skipping definition for base type 'Int8'
|
||||||
|
|
||||||
|
// Skipping definition for base type 'Card16'
|
||||||
|
|
||||||
|
// Skipping definition for base type 'Card32'
|
||||||
|
|
||||||
|
// CompareCursorCookie is a cookie used only for CompareCursor requests.
|
||||||
|
type CompareCursorCookie struct {
|
||||||
|
*xgb.Cookie
|
||||||
|
}
|
||||||
|
|
||||||
|
// CompareCursor sends a checked request.
|
||||||
|
// If an error occurs, it will be returned with the reply by calling CompareCursorCookie.Reply()
|
||||||
|
func CompareCursor(c *xgb.Conn, Window xproto.Window, Cursor xproto.Cursor) CompareCursorCookie {
|
||||||
|
c.ExtLock.RLock()
|
||||||
|
defer c.ExtLock.RUnlock()
|
||||||
|
if _, ok := c.Extensions["XTEST"]; !ok {
|
||||||
|
panic("Cannot issue request 'CompareCursor' using the uninitialized extension 'XTEST'. xtest.Init(connObj) must be called first.")
|
||||||
|
}
|
||||||
|
cookie := c.NewCookie(true, true)
|
||||||
|
c.NewRequest(compareCursorRequest(c, Window, Cursor), cookie)
|
||||||
|
return CompareCursorCookie{cookie}
|
||||||
|
}
|
||||||
|
|
||||||
|
// CompareCursorUnchecked sends an unchecked request.
|
||||||
|
// If an error occurs, it can only be retrieved using xgb.WaitForEvent or xgb.PollForEvent.
|
||||||
|
func CompareCursorUnchecked(c *xgb.Conn, Window xproto.Window, Cursor xproto.Cursor) CompareCursorCookie {
|
||||||
|
c.ExtLock.RLock()
|
||||||
|
defer c.ExtLock.RUnlock()
|
||||||
|
if _, ok := c.Extensions["XTEST"]; !ok {
|
||||||
|
panic("Cannot issue request 'CompareCursor' using the uninitialized extension 'XTEST'. xtest.Init(connObj) must be called first.")
|
||||||
|
}
|
||||||
|
cookie := c.NewCookie(false, true)
|
||||||
|
c.NewRequest(compareCursorRequest(c, Window, Cursor), cookie)
|
||||||
|
return CompareCursorCookie{cookie}
|
||||||
|
}
|
||||||
|
|
||||||
|
// CompareCursorReply represents the data returned from a CompareCursor request.
|
||||||
|
type CompareCursorReply struct {
|
||||||
|
Sequence uint16 // sequence number of the request for this reply
|
||||||
|
Length uint32 // number of bytes in this reply
|
||||||
|
Same bool
|
||||||
|
}
|
||||||
|
|
||||||
|
// Reply blocks and returns the reply data for a CompareCursor request.
|
||||||
|
func (cook CompareCursorCookie) Reply() (*CompareCursorReply, error) {
|
||||||
|
buf, err := cook.Cookie.Reply()
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
if buf == nil {
|
||||||
|
return nil, nil
|
||||||
|
}
|
||||||
|
return compareCursorReply(buf), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// compareCursorReply reads a byte slice into a CompareCursorReply value.
|
||||||
|
func compareCursorReply(buf []byte) *CompareCursorReply {
|
||||||
|
v := new(CompareCursorReply)
|
||||||
|
b := 1 // skip reply determinant
|
||||||
|
|
||||||
|
if buf[b] == 1 {
|
||||||
|
v.Same = true
|
||||||
|
} else {
|
||||||
|
v.Same = false
|
||||||
|
}
|
||||||
|
b += 1
|
||||||
|
|
||||||
|
v.Sequence = xgb.Get16(buf[b:])
|
||||||
|
b += 2
|
||||||
|
|
||||||
|
v.Length = xgb.Get32(buf[b:]) // 4-byte units
|
||||||
|
b += 4
|
||||||
|
|
||||||
|
return v
|
||||||
|
}
|
||||||
|
|
||||||
|
// Write request to wire for CompareCursor
|
||||||
|
// compareCursorRequest writes a CompareCursor request to a byte slice.
|
||||||
|
func compareCursorRequest(c *xgb.Conn, Window xproto.Window, Cursor xproto.Cursor) []byte {
|
||||||
|
size := 12
|
||||||
|
b := 0
|
||||||
|
buf := make([]byte, size)
|
||||||
|
|
||||||
|
c.ExtLock.RLock()
|
||||||
|
buf[b] = c.Extensions["XTEST"]
|
||||||
|
c.ExtLock.RUnlock()
|
||||||
|
b += 1
|
||||||
|
|
||||||
|
buf[b] = 1 // request opcode
|
||||||
|
b += 1
|
||||||
|
|
||||||
|
xgb.Put16(buf[b:], uint16(size/4)) // write request size in 4-byte units
|
||||||
|
b += 2
|
||||||
|
|
||||||
|
xgb.Put32(buf[b:], uint32(Window))
|
||||||
|
b += 4
|
||||||
|
|
||||||
|
xgb.Put32(buf[b:], uint32(Cursor))
|
||||||
|
b += 4
|
||||||
|
|
||||||
|
return buf
|
||||||
|
}
|
||||||
|
|
||||||
|
// FakeInputCookie is a cookie used only for FakeInput requests.
|
||||||
|
type FakeInputCookie struct {
|
||||||
|
*xgb.Cookie
|
||||||
|
}
|
||||||
|
|
||||||
|
// FakeInput sends an unchecked request.
|
||||||
|
// If an error occurs, it can only be retrieved using xgb.WaitForEvent or xgb.PollForEvent.
|
||||||
|
func FakeInput(c *xgb.Conn, Type byte, Detail uint16, Time uint32, Root xproto.Window, RootX int16, RootY int16, Deviceid byte) FakeInputCookie {
|
||||||
|
c.ExtLock.RLock()
|
||||||
|
defer c.ExtLock.RUnlock()
|
||||||
|
if _, ok := c.Extensions["XTEST"]; !ok {
|
||||||
|
panic("Cannot issue request 'FakeInput' using the uninitialized extension 'XTEST'. xtest.Init(connObj) must be called first.")
|
||||||
|
}
|
||||||
|
cookie := c.NewCookie(false, false)
|
||||||
|
c.NewRequest(fakeInputRequest(c, Type, Detail, Time, Root, RootX, RootY, Deviceid), cookie)
|
||||||
|
return FakeInputCookie{cookie}
|
||||||
|
}
|
||||||
|
|
||||||
|
// FakeInputChecked sends a checked request.
|
||||||
|
// If an error occurs, it can be retrieved using FakeInputCookie.Check()
|
||||||
|
func FakeInputChecked(c *xgb.Conn, Type byte, Detail uint16, Time uint32, Root xproto.Window, RootX int16, RootY int16, Deviceid byte) FakeInputCookie {
|
||||||
|
c.ExtLock.RLock()
|
||||||
|
defer c.ExtLock.RUnlock()
|
||||||
|
if _, ok := c.Extensions["XTEST"]; !ok {
|
||||||
|
panic("Cannot issue request 'FakeInput' using the uninitialized extension 'XTEST'. xtest.Init(connObj) must be called first.")
|
||||||
|
}
|
||||||
|
cookie := c.NewCookie(true, false)
|
||||||
|
c.NewRequest(fakeInputRequest(c, Type, Detail, Time, Root, RootX, RootY, Deviceid), cookie)
|
||||||
|
return FakeInputCookie{cookie}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Check returns an error if one occurred for checked requests that are not expecting a reply.
|
||||||
|
// This cannot be called for requests expecting a reply, nor for unchecked requests.
|
||||||
|
func (cook FakeInputCookie) Check() error {
|
||||||
|
return cook.Cookie.Check()
|
||||||
|
}
|
||||||
|
|
||||||
|
// Write request to wire for FakeInput
|
||||||
|
// fakeInputRequest writes a FakeInput request to a byte slice.
|
||||||
|
func fakeInputRequest(c *xgb.Conn, Type byte, Detail uint16, Time uint32, Root xproto.Window, RootX int16, RootY int16, Deviceid byte) []byte {
|
||||||
|
size := 36
|
||||||
|
b := 0
|
||||||
|
buf := make([]byte, size)
|
||||||
|
|
||||||
|
c.ExtLock.RLock()
|
||||||
|
buf[b] = c.Extensions["XTEST"]
|
||||||
|
c.ExtLock.RUnlock()
|
||||||
|
b += 1
|
||||||
|
|
||||||
|
buf[b] = 2 // request opcode
|
||||||
|
b += 1
|
||||||
|
|
||||||
|
xgb.Put16(buf[b:], uint16(size/4)) // write request size in 4-byte units
|
||||||
|
b += 2
|
||||||
|
|
||||||
|
buf[b] = Type
|
||||||
|
b += 1
|
||||||
|
|
||||||
|
xgb.Put16(buf[b:], Detail) // write request size in 4-byte units
|
||||||
|
b += 2
|
||||||
|
|
||||||
|
b += 1 // padding
|
||||||
|
|
||||||
|
xgb.Put32(buf[b:], Time)
|
||||||
|
b += 4
|
||||||
|
|
||||||
|
xgb.Put32(buf[b:], uint32(Root))
|
||||||
|
b += 4
|
||||||
|
|
||||||
|
b += 8 // padding
|
||||||
|
|
||||||
|
xgb.Put16(buf[b:], uint16(RootX))
|
||||||
|
b += 2
|
||||||
|
|
||||||
|
xgb.Put16(buf[b:], uint16(RootY))
|
||||||
|
b += 2
|
||||||
|
|
||||||
|
b += 7 // padding
|
||||||
|
|
||||||
|
buf[b] = Deviceid
|
||||||
|
b += 1
|
||||||
|
|
||||||
|
return buf
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetVersionCookie is a cookie used only for GetVersion requests.
|
||||||
|
type GetVersionCookie struct {
|
||||||
|
*xgb.Cookie
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetVersion sends a checked request.
|
||||||
|
// If an error occurs, it will be returned with the reply by calling GetVersionCookie.Reply()
|
||||||
|
func GetVersion(c *xgb.Conn, MajorVersion byte, MinorVersion uint16) GetVersionCookie {
|
||||||
|
c.ExtLock.RLock()
|
||||||
|
defer c.ExtLock.RUnlock()
|
||||||
|
if _, ok := c.Extensions["XTEST"]; !ok {
|
||||||
|
panic("Cannot issue request 'GetVersion' using the uninitialized extension 'XTEST'. xtest.Init(connObj) must be called first.")
|
||||||
|
}
|
||||||
|
cookie := c.NewCookie(true, true)
|
||||||
|
c.NewRequest(getVersionRequest(c, MajorVersion, MinorVersion), cookie)
|
||||||
|
return GetVersionCookie{cookie}
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetVersionUnchecked sends an unchecked request.
|
||||||
|
// If an error occurs, it can only be retrieved using xgb.WaitForEvent or xgb.PollForEvent.
|
||||||
|
func GetVersionUnchecked(c *xgb.Conn, MajorVersion byte, MinorVersion uint16) GetVersionCookie {
|
||||||
|
c.ExtLock.RLock()
|
||||||
|
defer c.ExtLock.RUnlock()
|
||||||
|
if _, ok := c.Extensions["XTEST"]; !ok {
|
||||||
|
panic("Cannot issue request 'GetVersion' using the uninitialized extension 'XTEST'. xtest.Init(connObj) must be called first.")
|
||||||
|
}
|
||||||
|
cookie := c.NewCookie(false, true)
|
||||||
|
c.NewRequest(getVersionRequest(c, MajorVersion, MinorVersion), cookie)
|
||||||
|
return GetVersionCookie{cookie}
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetVersionReply represents the data returned from a GetVersion request.
|
||||||
|
type GetVersionReply struct {
|
||||||
|
Sequence uint16 // sequence number of the request for this reply
|
||||||
|
Length uint32 // number of bytes in this reply
|
||||||
|
MajorVersion byte
|
||||||
|
MinorVersion uint16
|
||||||
|
}
|
||||||
|
|
||||||
|
// Reply blocks and returns the reply data for a GetVersion request.
|
||||||
|
func (cook GetVersionCookie) Reply() (*GetVersionReply, error) {
|
||||||
|
buf, err := cook.Cookie.Reply()
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
if buf == nil {
|
||||||
|
return nil, nil
|
||||||
|
}
|
||||||
|
return getVersionReply(buf), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// getVersionReply reads a byte slice into a GetVersionReply value.
|
||||||
|
func getVersionReply(buf []byte) *GetVersionReply {
|
||||||
|
v := new(GetVersionReply)
|
||||||
|
b := 1 // skip reply determinant
|
||||||
|
|
||||||
|
v.MajorVersion = buf[b]
|
||||||
|
b += 1
|
||||||
|
|
||||||
|
v.Sequence = xgb.Get16(buf[b:])
|
||||||
|
b += 2
|
||||||
|
|
||||||
|
v.Length = xgb.Get32(buf[b:]) // 4-byte units
|
||||||
|
b += 4
|
||||||
|
|
||||||
|
v.MinorVersion = xgb.Get16(buf[b:])
|
||||||
|
b += 2
|
||||||
|
|
||||||
|
return v
|
||||||
|
}
|
||||||
|
|
||||||
|
// Write request to wire for GetVersion
|
||||||
|
// getVersionRequest writes a GetVersion request to a byte slice.
|
||||||
|
func getVersionRequest(c *xgb.Conn, MajorVersion byte, MinorVersion uint16) []byte {
|
||||||
|
size := 8
|
||||||
|
b := 0
|
||||||
|
buf := make([]byte, size)
|
||||||
|
|
||||||
|
c.ExtLock.RLock()
|
||||||
|
buf[b] = c.Extensions["XTEST"]
|
||||||
|
c.ExtLock.RUnlock()
|
||||||
|
b += 1
|
||||||
|
|
||||||
|
buf[b] = 0 // request opcode
|
||||||
|
b += 1
|
||||||
|
|
||||||
|
xgb.Put16(buf[b:], uint16(size/4)) // write request size in 4-byte units
|
||||||
|
b += 2
|
||||||
|
|
||||||
|
buf[b] = MajorVersion
|
||||||
|
b += 1
|
||||||
|
|
||||||
|
b += 1 // padding
|
||||||
|
|
||||||
|
xgb.Put16(buf[b:], MinorVersion)
|
||||||
|
b += 2
|
||||||
|
|
||||||
|
return buf
|
||||||
|
}
|
||||||
|
|
||||||
|
// GrabControlCookie is a cookie used only for GrabControl requests.
|
||||||
|
type GrabControlCookie struct {
|
||||||
|
*xgb.Cookie
|
||||||
|
}
|
||||||
|
|
||||||
|
// GrabControl sends an unchecked request.
|
||||||
|
// If an error occurs, it can only be retrieved using xgb.WaitForEvent or xgb.PollForEvent.
|
||||||
|
func GrabControl(c *xgb.Conn, Impervious bool) GrabControlCookie {
|
||||||
|
c.ExtLock.RLock()
|
||||||
|
defer c.ExtLock.RUnlock()
|
||||||
|
if _, ok := c.Extensions["XTEST"]; !ok {
|
||||||
|
panic("Cannot issue request 'GrabControl' using the uninitialized extension 'XTEST'. xtest.Init(connObj) must be called first.")
|
||||||
|
}
|
||||||
|
cookie := c.NewCookie(false, false)
|
||||||
|
c.NewRequest(grabControlRequest(c, Impervious), cookie)
|
||||||
|
return GrabControlCookie{cookie}
|
||||||
|
}
|
||||||
|
|
||||||
|
// GrabControlChecked sends a checked request.
|
||||||
|
// If an error occurs, it can be retrieved using GrabControlCookie.Check()
|
||||||
|
func GrabControlChecked(c *xgb.Conn, Impervious bool) GrabControlCookie {
|
||||||
|
c.ExtLock.RLock()
|
||||||
|
defer c.ExtLock.RUnlock()
|
||||||
|
if _, ok := c.Extensions["XTEST"]; !ok {
|
||||||
|
panic("Cannot issue request 'GrabControl' using the uninitialized extension 'XTEST'. xtest.Init(connObj) must be called first.")
|
||||||
|
}
|
||||||
|
cookie := c.NewCookie(true, false)
|
||||||
|
c.NewRequest(grabControlRequest(c, Impervious), cookie)
|
||||||
|
return GrabControlCookie{cookie}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Check returns an error if one occurred for checked requests that are not expecting a reply.
|
||||||
|
// This cannot be called for requests expecting a reply, nor for unchecked requests.
|
||||||
|
func (cook GrabControlCookie) Check() error {
|
||||||
|
return cook.Cookie.Check()
|
||||||
|
}
|
||||||
|
|
||||||
|
// Write request to wire for GrabControl
|
||||||
|
// grabControlRequest writes a GrabControl request to a byte slice.
|
||||||
|
func grabControlRequest(c *xgb.Conn, Impervious bool) []byte {
|
||||||
|
size := 8
|
||||||
|
b := 0
|
||||||
|
buf := make([]byte, size)
|
||||||
|
|
||||||
|
c.ExtLock.RLock()
|
||||||
|
buf[b] = c.Extensions["XTEST"]
|
||||||
|
c.ExtLock.RUnlock()
|
||||||
|
b += 1
|
||||||
|
|
||||||
|
buf[b] = 3 // request opcode
|
||||||
|
b += 1
|
||||||
|
|
||||||
|
xgb.Put16(buf[b:], uint16(size/4)) // write request size in 4-byte units
|
||||||
|
b += 2
|
||||||
|
|
||||||
|
if Impervious {
|
||||||
|
buf[b] = 1
|
||||||
|
} else {
|
||||||
|
buf[b] = 0
|
||||||
|
}
|
||||||
|
b += 1
|
||||||
|
|
||||||
|
b += 3 // padding
|
||||||
|
|
||||||
|
return buf
|
||||||
|
}
|
|
@ -0,0 +1,21 @@
|
||||||
|
The MIT License (MIT)
|
||||||
|
|
||||||
|
Copyright (c) 2014 Benjamin Dahlmanns
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in
|
||||||
|
all copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||||
|
THE SOFTWARE.
|
|
@ -0,0 +1,41 @@
|
||||||
|
Uinput [![Build Status](https://travis-ci.org/bendahl/uinput.svg?branch=master)](https://travis-ci.org/bendahl/uinput) [![GoDoc](https://godoc.org/github.com/bendahl/uinput?status.png)](https://godoc.org/github.com/bendahl/uinput) [![Go Report Card](https://goreportcard.com/badge/github.com/bendahl/uinput)](https://goreportcard.com/report/github.com/bendahl/uinput)
|
||||||
|
====
|
||||||
|
|
||||||
|
This package provides pure go wrapper functions for the LINUX uinput device, which allows to create virtual input devices
|
||||||
|
in userspace. At the moment this package offers a virtual keyboard implementation as well as a virtual mouse device and
|
||||||
|
a touch pad device.
|
||||||
|
The keyboard can be used to either send single key presses or hold down a specified key and release it later
|
||||||
|
(useful for building game controllers). The mouse device issues relative positional change events to the x and y axis
|
||||||
|
of the mouse pointer and may also fire click events (left and right click). More functionality will be added in future
|
||||||
|
version.
|
||||||
|
The touch pad, on the other hand can be used to move the mouse cursor to the specified position on the screen and to
|
||||||
|
issue left and right clicks. Note that you'll need to specify the region size of your screen first though (happens during
|
||||||
|
device creation).
|
||||||
|
|
||||||
|
Please note that you will need to make sure to have the necessary rights to write to uinput. You can either chmod your
|
||||||
|
uinput device, or add a rule in /etc/udev/rules.d to allow your user's group or a dedicated group to write to the device.
|
||||||
|
You may use the following two commands to add the necessary rights for you current user to a file called 99-$USER.rules
|
||||||
|
(where $USER is your current user's name):
|
||||||
|
<pre><code>
|
||||||
|
echo KERNEL==\"uinput\", GROUP=\"$USER\", MODE:=\"0660\" | sudo tee /etc/udev/rules.d/99-$USER.rules
|
||||||
|
sudo udevadm trigger
|
||||||
|
</code></pre>
|
||||||
|
|
||||||
|
Installation
|
||||||
|
-------------
|
||||||
|
Simply check out the repository and use the commands <pre><code>go build && go install</code></pre>
|
||||||
|
The package will then be installed to your local respository, along with the package documentation.
|
||||||
|
The documentation contains more details on the usage of this package.
|
||||||
|
|
||||||
|
License
|
||||||
|
--------
|
||||||
|
The package falls under the MIT license. Please see the "LICENSE" file for details.
|
||||||
|
|
||||||
|
ToDos
|
||||||
|
------------------
|
||||||
|
All testing has been done on Ubunu 14.04 and 16.04 x86\_64.
|
||||||
|
Testing for other platforms will need to be done.
|
||||||
|
To get an idea of the things that are on the current todo list, check out the file "TODO.md".
|
||||||
|
As always, helpful comments and ideas are always welcome.
|
||||||
|
Feel free to do some testing on your own if you're up to it.
|
||||||
|
|
|
@ -0,0 +1,10 @@
|
||||||
|
TODO
|
||||||
|
====
|
||||||
|
|
||||||
|
1. ~~Create Tests for the uinput package~~
|
||||||
|
2. ~~Migrate code from C to GO~~
|
||||||
|
3. ~~Implement relative input~~
|
||||||
|
4. ~~Implement absolute input~~
|
||||||
|
5. Test on different platforms (besides x86_64)
|
||||||
|
6. Implement functions to allow mouse button up and down events (for region selects)
|
||||||
|
7. Extend test cases
|
|
@ -0,0 +1,375 @@
|
||||||
|
/*
|
||||||
|
Package uinput is a pure go package that provides access to the userland input device driver uinput on linux systems.
|
||||||
|
Virtual keyboard devices as well as virtual mouse input devices may be created using this package.
|
||||||
|
The keycodes and other event definitions, that are available and can be used to trigger input events,
|
||||||
|
are part of this package ("Key1" for number 1, for example).
|
||||||
|
|
||||||
|
In order to use the virtual keyboard, you will need to follow these three steps:
|
||||||
|
|
||||||
|
1. Initialize the device
|
||||||
|
Example: vk, err := CreateKeyboard("/dev/uinput", "Virtual Keyboard")
|
||||||
|
|
||||||
|
2. Send Button events to the device
|
||||||
|
Example (print a single D):
|
||||||
|
err = vk.KeyPress(uinput.KeyD)
|
||||||
|
|
||||||
|
Example (keep moving right by holding down right arrow key):
|
||||||
|
err = vk.KeyDown(uinput.KeyRight)
|
||||||
|
|
||||||
|
Example (stop moving right by releasing the right arrow key):
|
||||||
|
err = vk.KeyUp(uinput.KeyRight)
|
||||||
|
|
||||||
|
3. Close the device
|
||||||
|
Example: err = vk.Close()
|
||||||
|
|
||||||
|
A virtual mouse input device is just as easy to create and use:
|
||||||
|
|
||||||
|
1. Initialize the device:
|
||||||
|
Example: vm, err := CreateMouse("/dev/uinput", "DangerMouse")
|
||||||
|
|
||||||
|
2. Move the cursor around and issue click events
|
||||||
|
Example (move mouse right):
|
||||||
|
err = vm.MoveRight(42)
|
||||||
|
|
||||||
|
Example (move mouse left):
|
||||||
|
err = vm.MoveLeft(42)
|
||||||
|
|
||||||
|
Example (move mouse up):
|
||||||
|
err = vm.MoveUp(42)
|
||||||
|
|
||||||
|
Example (move mouse down):
|
||||||
|
err = vm.MoveDown(42)
|
||||||
|
|
||||||
|
Example (trigger a left click):
|
||||||
|
err = vm.LeftClick()
|
||||||
|
|
||||||
|
Example (trigger a right click):
|
||||||
|
err = vm.RightClick()
|
||||||
|
|
||||||
|
3. Close the device
|
||||||
|
Example: err = vm.Close()
|
||||||
|
|
||||||
|
|
||||||
|
If you'd like to use absolute input events (move the cursor to specific positions on screen), use the touch pad.
|
||||||
|
Note that you'll need to specify the size of the screen area you want to use when you initialize the
|
||||||
|
device. Here are a few examples of how to use the virtual touch pad:
|
||||||
|
|
||||||
|
1. Initialize the device:
|
||||||
|
Example: vt, err := CreateTouchPad("/dev/uinput", "DontTouchThis", 0, 1024, 0, 768)
|
||||||
|
|
||||||
|
2. Move the cursor around and issue click events
|
||||||
|
Example (move cursor to the top left corner of the screen):
|
||||||
|
err = vt.MoveTo(0, 0)
|
||||||
|
|
||||||
|
Example (move cursor to the position x: 100, y: 250):
|
||||||
|
err = vt.MoveTo(100, 250)
|
||||||
|
|
||||||
|
Example (trigger a left click):
|
||||||
|
err = vt.LeftClick()
|
||||||
|
|
||||||
|
Example (trigger a right click):
|
||||||
|
err = vt.RightClick()
|
||||||
|
|
||||||
|
3. Close the device
|
||||||
|
Example: err = vt.Close()
|
||||||
|
|
||||||
|
*/
|
||||||
|
package uinput
|
||||||
|
|
||||||
|
import (
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"os"
|
||||||
|
)
|
||||||
|
|
||||||
|
// A Keyboard is an key event output device. It is used to
|
||||||
|
// enable a program to simulate HID keyboard input events.
|
||||||
|
type Keyboard interface {
|
||||||
|
// KeyPress will cause the key to be pressed and immediately released.
|
||||||
|
KeyPress(key int) error
|
||||||
|
|
||||||
|
// KeyDown will send a keypress event to an existing keyboard device.
|
||||||
|
// The key can be any of the predefined keycodes from uinputdefs.
|
||||||
|
// Note that the key will be "held down" until "KeyUp" is called.
|
||||||
|
KeyDown(key int) error
|
||||||
|
|
||||||
|
// KeyUp will send a keyrelease event to an existing keyboard device.
|
||||||
|
// The key can be any of the predefined keycodes from uinputdefs.
|
||||||
|
KeyUp(key int) error
|
||||||
|
|
||||||
|
io.Closer
|
||||||
|
}
|
||||||
|
|
||||||
|
type vKeyboard struct {
|
||||||
|
name []byte
|
||||||
|
deviceFile *os.File
|
||||||
|
}
|
||||||
|
|
||||||
|
// A Mouse is a device that will trigger an absolute change event.
|
||||||
|
// For details see: https://www.kernel.org/doc/Documentation/input/event-codes.txt
|
||||||
|
type Mouse interface {
|
||||||
|
// MoveLeft will move the mouse cursor left by the given number of pixel.
|
||||||
|
MoveLeft(pixel int32) error
|
||||||
|
|
||||||
|
// MoveRight will move the mouse cursor right by the given number of pixel.
|
||||||
|
MoveRight(pixel int32) error
|
||||||
|
|
||||||
|
// MoveUp will move the mouse cursor up by the given number of pixel.
|
||||||
|
MoveUp(pixel int32) error
|
||||||
|
|
||||||
|
// MoveDown will move the mouse cursor down by the given number of pixel.
|
||||||
|
MoveDown(pixel int32) error
|
||||||
|
|
||||||
|
// LeftClick will issue a single left click.
|
||||||
|
LeftClick() error
|
||||||
|
|
||||||
|
// RightClick will issue a right click.
|
||||||
|
RightClick() error
|
||||||
|
|
||||||
|
io.Closer
|
||||||
|
}
|
||||||
|
|
||||||
|
type vMouse struct {
|
||||||
|
name []byte
|
||||||
|
deviceFile *os.File
|
||||||
|
}
|
||||||
|
|
||||||
|
// A TouchPad is an input device that uses absolute axis events, meaning that you can specify
|
||||||
|
// the exact position the cursor should move to. Therefore, it is necessary to define the size
|
||||||
|
// of the rectangle in which the cursor may move upon creation of the device.
|
||||||
|
type TouchPad interface {
|
||||||
|
// MoveTo will move the cursor to the specified position on the screen
|
||||||
|
MoveTo(x int32, y int32) error
|
||||||
|
|
||||||
|
// LeftClick will issue a single left click.
|
||||||
|
LeftClick() error
|
||||||
|
|
||||||
|
// RightClick will issue a right click.
|
||||||
|
RightClick() error
|
||||||
|
|
||||||
|
io.Closer
|
||||||
|
}
|
||||||
|
|
||||||
|
type vTouchPad struct {
|
||||||
|
name []byte
|
||||||
|
deviceFile *os.File
|
||||||
|
}
|
||||||
|
|
||||||
|
// CreateTouchPad will create a new touch pad device. note that you will need to define the x and y axis boundaries
|
||||||
|
// (min and max) within which the cursor maybe moved around.
|
||||||
|
func CreateTouchPad(path string, name []byte, minX int32, maxX int32, minY int32, maxY int32) (TouchPad, error) {
|
||||||
|
if path == "" {
|
||||||
|
return nil, errors.New("device path must not be empty")
|
||||||
|
}
|
||||||
|
if len(name) > uinputMaxNameSize {
|
||||||
|
return nil, fmt.Errorf("device name %s is too long (maximum of %d characters allowed)", name, uinputMaxNameSize)
|
||||||
|
}
|
||||||
|
|
||||||
|
fd, err := createTouchPad(path, name, minX, maxX, minY, maxY)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
return vTouchPad{name: name, deviceFile: fd}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (vTouch vTouchPad) MoveTo(x int32, y int32) error {
|
||||||
|
return sendAbsEvent(vTouch.deviceFile, x, y)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (vTouch vTouchPad) LeftClick() error {
|
||||||
|
err := sendBtnEvent(vTouch.deviceFile, evBtnLeft, btnStatePressed)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("Failed to issue the LeftClick event: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
err = sendBtnEvent(vTouch.deviceFile, evBtnLeft, btnStateReleased)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("Failed to issue the KeyUp event: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
err = syncEvents(vTouch.deviceFile)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("sync to device file failed: %v", err)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (vTouch vTouchPad) RightClick() error {
|
||||||
|
err := sendBtnEvent(vTouch.deviceFile, evBtnRight, btnStatePressed)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("Failed to issue the RightClick event: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
err = sendBtnEvent(vTouch.deviceFile, evBtnRight, btnStateReleased)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("Failed to issue the KeyUp event: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
err = syncEvents(vTouch.deviceFile)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("sync to device file failed: %v", err)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (vTouch vTouchPad) Close() error {
|
||||||
|
return closeDevice(vTouch.deviceFile)
|
||||||
|
}
|
||||||
|
|
||||||
|
// CreateMouse will create a new mouse input device. A mouse is a device that allows relative input.
|
||||||
|
// Relative input means that all changes to the x and y coordinates of the mouse pointer will be
|
||||||
|
func CreateMouse(path string, name []byte) (Mouse, error) {
|
||||||
|
if path == "" {
|
||||||
|
return nil, errors.New("device path must not be empty")
|
||||||
|
}
|
||||||
|
if len(name) > uinputMaxNameSize {
|
||||||
|
return nil, fmt.Errorf("device name %s is too long (maximum of %d characters allowed)", name, uinputMaxNameSize)
|
||||||
|
}
|
||||||
|
|
||||||
|
fd, err := createMouse(path, name)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
return vMouse{name: name, deviceFile: fd}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// MoveLeft will move the cursor left by the number of pixel specified.
|
||||||
|
func (vRel vMouse) MoveLeft(pixel int32) error {
|
||||||
|
return sendRelEvent(vRel.deviceFile, relX, -pixel)
|
||||||
|
}
|
||||||
|
|
||||||
|
// MoveRight will move the cursor right by the number of pixel specified.
|
||||||
|
func (vRel vMouse) MoveRight(pixel int32) error {
|
||||||
|
return sendRelEvent(vRel.deviceFile, relX, pixel)
|
||||||
|
}
|
||||||
|
|
||||||
|
// MoveUp will move the cursor up by the number of pixel specified.
|
||||||
|
func (vRel vMouse) MoveUp(pixel int32) error {
|
||||||
|
return sendRelEvent(vRel.deviceFile, relY, -pixel)
|
||||||
|
}
|
||||||
|
|
||||||
|
// MoveDown will move the cursor down by the number of pixel specified.
|
||||||
|
func (vRel vMouse) MoveDown(pixel int32) error {
|
||||||
|
return sendRelEvent(vRel.deviceFile, relY, pixel)
|
||||||
|
}
|
||||||
|
|
||||||
|
// LeftClick will issue a LeftClick.
|
||||||
|
func (vRel vMouse) LeftClick() error {
|
||||||
|
err := sendBtnEvent(vRel.deviceFile, evBtnLeft, btnStatePressed)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("Failed to issue the LeftClick event: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
err = sendBtnEvent(vRel.deviceFile, evBtnLeft, btnStateReleased)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("Failed to issue the KeyUp event: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
err = syncEvents(vRel.deviceFile)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("sync to device file failed: %v", err)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// RightClick will issue a RightClick
|
||||||
|
func (vRel vMouse) RightClick() error {
|
||||||
|
err := sendBtnEvent(vRel.deviceFile, evBtnRight, btnStatePressed)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("Failed to issue the RightClick event: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
err = sendBtnEvent(vRel.deviceFile, evBtnRight, btnStateReleased)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("Failed to issue the KeyUp event: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
err = syncEvents(vRel.deviceFile)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("sync to device file failed: %v", err)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Close closes the device and releases the device.
|
||||||
|
func (vRel vMouse) Close() error {
|
||||||
|
return closeDevice(vRel.deviceFile)
|
||||||
|
}
|
||||||
|
|
||||||
|
// CreateKeyboard will create a new keyboard using the given uinput
|
||||||
|
// device path of the uinput device.
|
||||||
|
func CreateKeyboard(path string, name []byte) (Keyboard, error) {
|
||||||
|
if path == "" {
|
||||||
|
return nil, errors.New("device path must not be empty")
|
||||||
|
}
|
||||||
|
if len(name) > uinputMaxNameSize {
|
||||||
|
return nil, fmt.Errorf("device name %s is too long (maximum of %d characters allowed)", name, uinputMaxNameSize)
|
||||||
|
}
|
||||||
|
|
||||||
|
fd, err := createVKeyboardDevice(path, name)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
return vKeyboard{name: name, deviceFile: fd}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// KeyPress will issue a single key press (push down a key and then immediately release it).
|
||||||
|
func (vk vKeyboard) KeyPress(key int) error {
|
||||||
|
err := sendBtnEvent(vk.deviceFile, key, btnStatePressed)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("Failed to issue the KeyDown event: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
err = sendBtnEvent(vk.deviceFile, key, btnStateReleased)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("Failed to issue the KeyUp event: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
err = syncEvents(vk.deviceFile)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("sync to device file failed: %v", err)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// KeyDown will send the key code passed (see uinputdefs.go for available keycodes). Note that unless a key release
|
||||||
|
// event is sent to the device, the key will remain pressed and therefore input will continuously be generated. Therefore,
|
||||||
|
// do not forget to call "KeyUp" afterwards.
|
||||||
|
func (vk vKeyboard) KeyDown(key int) error {
|
||||||
|
err := sendBtnEvent(vk.deviceFile, key, btnStatePressed)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("Failed to issue the KeyDown event: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
err = syncEvents(vk.deviceFile)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("sync to device file failed: %v", err)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// KeyUp will release the given key passed as a parameter (see uinputdefs.go for available keycodes). In most
|
||||||
|
// cases it is recommended to call this function immediately after the "KeyDown" function in order to only issue a
|
||||||
|
// single key press.
|
||||||
|
func (vk vKeyboard) KeyUp(key int) error {
|
||||||
|
err := sendBtnEvent(vk.deviceFile, key, btnStatePressed)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("Failed to issue the KeyUp event: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
err = syncEvents(vk.deviceFile)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("sync to device file failed: %v", err)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Close will close the device and free resources.
|
||||||
|
// It's usually a good idea to use defer to call this function.
|
||||||
|
func (vk vKeyboard) Close() error {
|
||||||
|
return closeDevice(vk.deviceFile)
|
||||||
|
}
|
|
@ -0,0 +1,249 @@
|
||||||
|
package uinput
|
||||||
|
|
||||||
|
// the constants were copied from input.h for convenience reasons
|
||||||
|
const (
|
||||||
|
keyReserved = 0
|
||||||
|
KeyEsc = 1
|
||||||
|
Key1 = 2
|
||||||
|
Key2 = 3
|
||||||
|
Key3 = 4
|
||||||
|
Key4 = 5
|
||||||
|
Key5 = 6
|
||||||
|
Key6 = 7
|
||||||
|
Key7 = 8
|
||||||
|
Key8 = 9
|
||||||
|
Key9 = 10
|
||||||
|
Key0 = 11
|
||||||
|
KeyMinus = 12
|
||||||
|
KeyEqual = 13
|
||||||
|
KeyBackspace = 14
|
||||||
|
KeyTab = 15
|
||||||
|
KeyQ = 16
|
||||||
|
KeyW = 17
|
||||||
|
KeyE = 18
|
||||||
|
KeyR = 19
|
||||||
|
KeyT = 20
|
||||||
|
KeyY = 21
|
||||||
|
KeyU = 22
|
||||||
|
KeyI = 23
|
||||||
|
KeyO = 24
|
||||||
|
KeyP = 25
|
||||||
|
KeyLeftbrace = 26
|
||||||
|
KeyRightbrace = 27
|
||||||
|
KeyEnter = 28
|
||||||
|
KeyLeftctrl = 29
|
||||||
|
KeyA = 30
|
||||||
|
KeyS = 31
|
||||||
|
KeyD = 32
|
||||||
|
KeyF = 33
|
||||||
|
KeyG = 34
|
||||||
|
KeyH = 35
|
||||||
|
KeyJ = 36
|
||||||
|
KeyK = 37
|
||||||
|
KeyL = 38
|
||||||
|
KeySemicolon = 39
|
||||||
|
KeyApostrophe = 40
|
||||||
|
KeyGrave = 41
|
||||||
|
KeyLeftshift = 42
|
||||||
|
KeyBackslash = 43
|
||||||
|
KeyZ = 44
|
||||||
|
KeyX = 45
|
||||||
|
KeyC = 46
|
||||||
|
KeyV = 47
|
||||||
|
KeyB = 48
|
||||||
|
KeyN = 49
|
||||||
|
KeyM = 50
|
||||||
|
KeyComma = 51
|
||||||
|
KeyDot = 52
|
||||||
|
KeySlash = 53
|
||||||
|
KeyRightshift = 54
|
||||||
|
KeyKpasterisk = 55
|
||||||
|
KeyLeftalt = 56
|
||||||
|
KeySpace = 57
|
||||||
|
KeyCapslock = 58
|
||||||
|
KeyF1 = 59
|
||||||
|
KeyF2 = 60
|
||||||
|
KeyF3 = 61
|
||||||
|
KeyF4 = 62
|
||||||
|
KeyF5 = 63
|
||||||
|
KeyF6 = 64
|
||||||
|
KeyF7 = 65
|
||||||
|
KeyF8 = 66
|
||||||
|
KeyF9 = 67
|
||||||
|
KeyF10 = 68
|
||||||
|
KeyNumlock = 69
|
||||||
|
KeyScrolllock = 70
|
||||||
|
KeyKp7 = 71
|
||||||
|
KeyKp8 = 72
|
||||||
|
KeyKp9 = 73
|
||||||
|
KeyKpminus = 74
|
||||||
|
KeyKp4 = 75
|
||||||
|
KeyKp5 = 76
|
||||||
|
KeyKp6 = 77
|
||||||
|
KeyKpplus = 78
|
||||||
|
KeyKp1 = 79
|
||||||
|
KeyKp2 = 80
|
||||||
|
KeyKp3 = 81
|
||||||
|
KeyKp0 = 82
|
||||||
|
KeyKpdot = 83
|
||||||
|
KeyZenkakuhankaku = 85
|
||||||
|
Key102Nd = 86
|
||||||
|
KeyF11 = 87
|
||||||
|
KeyF12 = 88
|
||||||
|
KeyRo = 89
|
||||||
|
KeyKatakana = 90
|
||||||
|
KeyHiragana = 91
|
||||||
|
KeyHenkan = 92
|
||||||
|
KeyKatakanahiragana = 93
|
||||||
|
KeyMuhenkan = 94
|
||||||
|
KeyKpjpcomma = 95
|
||||||
|
KeyKpenter = 96
|
||||||
|
KeyRightctrl = 97
|
||||||
|
KeyKpslash = 98
|
||||||
|
KeySysrq = 99
|
||||||
|
KeyRightalt = 100
|
||||||
|
KeyLinefeed = 101
|
||||||
|
KeyHome = 102
|
||||||
|
KeyUp = 103
|
||||||
|
KeyPageup = 104
|
||||||
|
KeyLeft = 105
|
||||||
|
KeyRight = 106
|
||||||
|
KeyEnd = 107
|
||||||
|
KeyDown = 108
|
||||||
|
KeyPagedown = 109
|
||||||
|
KeyInsert = 110
|
||||||
|
KeyDelete = 111
|
||||||
|
KeyMacro = 112
|
||||||
|
KeyMute = 113
|
||||||
|
KeyVolumedown = 114
|
||||||
|
KeyVolumeup = 115
|
||||||
|
KeyPower = 116 /*ScSystemPowerDown*/
|
||||||
|
KeyKpequal = 117
|
||||||
|
KeyKpplusminus = 118
|
||||||
|
KeyPause = 119
|
||||||
|
KeyScale = 120 /*AlCompizScale(Expose)*/
|
||||||
|
KeyKpcomma = 121
|
||||||
|
KeyHangeul = 122
|
||||||
|
KeyHanja = 123
|
||||||
|
KeyYen = 124
|
||||||
|
KeyLeftmeta = 125
|
||||||
|
KeyRightmeta = 126
|
||||||
|
KeyCompose = 127
|
||||||
|
KeyStop = 128 /*AcStop*/
|
||||||
|
KeyAgain = 129
|
||||||
|
KeyProps = 130 /*AcProperties*/
|
||||||
|
KeyUndo = 131 /*AcUndo*/
|
||||||
|
KeyFront = 132
|
||||||
|
KeyCopy = 133 /*AcCopy*/
|
||||||
|
KeyOpen = 134 /*AcOpen*/
|
||||||
|
KeyPaste = 135 /*AcPaste*/
|
||||||
|
KeyFind = 136 /*AcSearch*/
|
||||||
|
KeyCut = 137 /*AcCut*/
|
||||||
|
KeyHelp = 138 /*AlIntegratedHelpCenter*/
|
||||||
|
KeyMenu = 139 /*Menu(ShowMenu)*/
|
||||||
|
KeyCalc = 140 /*AlCalculator*/
|
||||||
|
KeySetup = 141
|
||||||
|
KeySleep = 142 /*ScSystemSleep*/
|
||||||
|
KeyWakeup = 143 /*SystemWakeUp*/
|
||||||
|
KeyFile = 144 /*AlLocalMachineBrowser*/
|
||||||
|
KeySendfile = 145
|
||||||
|
KeyDeletefile = 146
|
||||||
|
KeyXfer = 147
|
||||||
|
KeyProg1 = 148
|
||||||
|
KeyProg2 = 149
|
||||||
|
KeyWww = 150 /*AlInternetBrowser*/
|
||||||
|
KeyMsdos = 151
|
||||||
|
KeyCoffee = 152 /*AlTerminalLock/Screensaver*/
|
||||||
|
KeyDirection = 153
|
||||||
|
KeyCyclewindows = 154
|
||||||
|
KeyMail = 155
|
||||||
|
KeyBookmarks = 156 /*AcBookmarks*/
|
||||||
|
KeyComputer = 157
|
||||||
|
KeyBack = 158 /*AcBack*/
|
||||||
|
KeyForward = 159 /*AcForward*/
|
||||||
|
KeyClosecd = 160
|
||||||
|
KeyEjectcd = 161
|
||||||
|
KeyEjectclosecd = 162
|
||||||
|
KeyNextsong = 163
|
||||||
|
KeyPlaypause = 164
|
||||||
|
KeyPrevioussong = 165
|
||||||
|
KeyStopcd = 166
|
||||||
|
KeyRecord = 167
|
||||||
|
KeyRewind = 168
|
||||||
|
KeyPhone = 169 /*MediaSelectTelephone*/
|
||||||
|
KeyIso = 170
|
||||||
|
KeyConfig = 171 /*AlConsumerControlConfiguration*/
|
||||||
|
KeyHomepage = 172 /*AcHome*/
|
||||||
|
KeyRefresh = 173 /*AcRefresh*/
|
||||||
|
KeyExit = 174 /*AcExit*/
|
||||||
|
KeyMove = 175
|
||||||
|
KeyEdit = 176
|
||||||
|
KeyScrollup = 177
|
||||||
|
KeyScrolldown = 178
|
||||||
|
KeyKpleftparen = 179
|
||||||
|
KeyKprightparen = 180
|
||||||
|
KeyNew = 181 /*AcNew*/
|
||||||
|
KeyRedo = 182 /*AcRedo/Repeat*/
|
||||||
|
KeyF13 = 183
|
||||||
|
KeyF14 = 184
|
||||||
|
KeyF15 = 185
|
||||||
|
KeyF16 = 186
|
||||||
|
KeyF17 = 187
|
||||||
|
KeyF18 = 188
|
||||||
|
KeyF19 = 189
|
||||||
|
KeyF20 = 190
|
||||||
|
KeyF21 = 191
|
||||||
|
KeyF22 = 192
|
||||||
|
KeyF23 = 193
|
||||||
|
KeyF24 = 194
|
||||||
|
KeyPlaycd = 200
|
||||||
|
KeyPausecd = 201
|
||||||
|
KeyProg3 = 202
|
||||||
|
KeyProg4 = 203
|
||||||
|
KeyDashboard = 204 /*AlDashboard*/
|
||||||
|
KeySuspend = 205
|
||||||
|
KeyClose = 206 /*AcClose*/
|
||||||
|
KeyPlay = 207
|
||||||
|
KeyFastforward = 208
|
||||||
|
KeyBassboost = 209
|
||||||
|
KeyPrint = 210 /*AcPrint*/
|
||||||
|
KeyHp = 211
|
||||||
|
KeyCamera = 212
|
||||||
|
KeySound = 213
|
||||||
|
KeyQuestion = 214
|
||||||
|
KeyEmail = 215
|
||||||
|
KeyChat = 216
|
||||||
|
KeySearch = 217
|
||||||
|
KeyConnect = 218
|
||||||
|
KeyFinance = 219 /*AlCheckbook/Finance*/
|
||||||
|
KeySport = 220
|
||||||
|
KeyShop = 221
|
||||||
|
KeyAlterase = 222
|
||||||
|
KeyCancel = 223 /*AcCancel*/
|
||||||
|
KeyBrightnessdown = 224
|
||||||
|
KeyBrightnessup = 225
|
||||||
|
KeyMedia = 226
|
||||||
|
KeySwitchvideomode = 227 /*CycleBetweenAvailableVideo */
|
||||||
|
KeyKbdillumtoggle = 228
|
||||||
|
KeyKbdillumdown = 229
|
||||||
|
KeyKbdillumup = 230
|
||||||
|
KeySend = 231 /*AcSend*/
|
||||||
|
KeyReply = 232 /*AcReply*/
|
||||||
|
KeyForwardmail = 233 /*AcForwardMsg*/
|
||||||
|
KeySave = 234 /*AcSave*/
|
||||||
|
KeyDocuments = 235
|
||||||
|
KeyBattery = 236
|
||||||
|
KeyBluetooth = 237
|
||||||
|
KeyWlan = 238
|
||||||
|
KeyUwb = 239
|
||||||
|
KeyUnknown = 240
|
||||||
|
KeyVideoNext = 241 /*DriveNextVideoSource*/
|
||||||
|
KeyVideoPrev = 242 /*DrivePreviousVideoSource*/
|
||||||
|
KeyBrightnessCycle = 243 /*BrightnessUp,AfterMaxIsMin*/
|
||||||
|
KeyBrightnessZero = 244 /*BrightnessOff,UseAmbient*/
|
||||||
|
KeyDisplayOff = 245 /*DisplayDeviceToOffState*/
|
||||||
|
KeyWimax = 246
|
||||||
|
KeyRfkill = 247 /*KeyThatControlsAllRadios*/
|
||||||
|
KeyMicmute = 248 /*Mute/UnmuteTheMicrophone*/
|
||||||
|
keyMax = 248 // highest key currently defined
|
||||||
|
)
|
|
@ -0,0 +1,369 @@
|
||||||
|
package uinput
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"encoding/binary"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"os"
|
||||||
|
"syscall"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
// types needed from uinput.h
|
||||||
|
const (
|
||||||
|
uinputMaxNameSize = 80
|
||||||
|
uiDevCreate = 0x5501
|
||||||
|
uiDevDestroy = 0x5502
|
||||||
|
uiSetEvBit = 0x40045564
|
||||||
|
uiSetKeyBit = 0x40045565
|
||||||
|
uiSetRelBit = 0x40045566
|
||||||
|
uiSetAbsBit = 0x40045567
|
||||||
|
busUsb = 0x03
|
||||||
|
)
|
||||||
|
|
||||||
|
// input event codes as specified in input-event-codes.h
|
||||||
|
const (
|
||||||
|
evSyn = 0x00
|
||||||
|
evKey = 0x01
|
||||||
|
evRel = 0x02
|
||||||
|
evAbs = 0x03
|
||||||
|
relX = 0x0
|
||||||
|
relY = 0x1
|
||||||
|
absX = 0x0
|
||||||
|
absY = 0x1
|
||||||
|
synReport = 0
|
||||||
|
evBtnLeft = 0x110
|
||||||
|
evBtnRight = 0x111
|
||||||
|
)
|
||||||
|
|
||||||
|
const (
|
||||||
|
btnStateReleased = 0
|
||||||
|
btnStatePressed = 1
|
||||||
|
absSize = 64
|
||||||
|
)
|
||||||
|
|
||||||
|
type inputID struct {
|
||||||
|
Bustype uint16
|
||||||
|
Vendor uint16
|
||||||
|
Product uint16
|
||||||
|
Version uint16
|
||||||
|
}
|
||||||
|
|
||||||
|
// translated to go from uinput.h
|
||||||
|
type uinputUserDev struct {
|
||||||
|
Name [uinputMaxNameSize]byte
|
||||||
|
ID inputID
|
||||||
|
EffectsMax uint32
|
||||||
|
Absmax [absSize]int32
|
||||||
|
Absmin [absSize]int32
|
||||||
|
Absfuzz [absSize]int32
|
||||||
|
Absflat [absSize]int32
|
||||||
|
}
|
||||||
|
|
||||||
|
// translated to go from input.h
|
||||||
|
type inputEvent struct {
|
||||||
|
Time syscall.Timeval
|
||||||
|
Type uint16
|
||||||
|
Code uint16
|
||||||
|
Value int32
|
||||||
|
}
|
||||||
|
|
||||||
|
func closeDevice(deviceFile *os.File) (err error) {
|
||||||
|
err = releaseDevice(deviceFile)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("failed to close device: %v", err)
|
||||||
|
}
|
||||||
|
return deviceFile.Close()
|
||||||
|
}
|
||||||
|
|
||||||
|
func releaseDevice(deviceFile *os.File) (err error) {
|
||||||
|
return ioctl(deviceFile, uiDevDestroy, uintptr(0))
|
||||||
|
}
|
||||||
|
|
||||||
|
func createDeviceFile(path string) (fd *os.File, err error) {
|
||||||
|
deviceFile, err := os.OpenFile(path, syscall.O_WRONLY|syscall.O_NONBLOCK, 0660)
|
||||||
|
if err != nil {
|
||||||
|
return nil, errors.New("could not open device file")
|
||||||
|
}
|
||||||
|
return deviceFile, err
|
||||||
|
}
|
||||||
|
|
||||||
|
func registerDevice(deviceFile *os.File, evType uintptr) error {
|
||||||
|
err := ioctl(deviceFile, uiSetEvBit, evType)
|
||||||
|
if err != nil {
|
||||||
|
err = releaseDevice(deviceFile)
|
||||||
|
if err != nil {
|
||||||
|
deviceFile.Close()
|
||||||
|
return fmt.Errorf("failed to close device: %v", err)
|
||||||
|
}
|
||||||
|
deviceFile.Close()
|
||||||
|
return fmt.Errorf("invalid file handle returned from ioctl: %v", err)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func createVKeyboardDevice(path string, name []byte) (fd *os.File, err error) {
|
||||||
|
deviceFile, err := createDeviceFile(path)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("failed to create virtual keyboard device: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
err = registerDevice(deviceFile, uintptr(evKey))
|
||||||
|
if err != nil {
|
||||||
|
deviceFile.Close()
|
||||||
|
return nil, fmt.Errorf("failed to register virtual keyboard device: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// register key events
|
||||||
|
for i := 0; i < keyMax; i++ {
|
||||||
|
err = ioctl(deviceFile, uiSetKeyBit, uintptr(i))
|
||||||
|
if err != nil {
|
||||||
|
deviceFile.Close()
|
||||||
|
return nil, fmt.Errorf("failed to register key number %d: %v", i, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return createUsbDevice(deviceFile,
|
||||||
|
uinputUserDev{
|
||||||
|
Name: toUinputName(name),
|
||||||
|
ID: inputID{
|
||||||
|
Bustype: busUsb,
|
||||||
|
Vendor: 0x4711,
|
||||||
|
Product: 0x0815,
|
||||||
|
Version: 1}})
|
||||||
|
}
|
||||||
|
|
||||||
|
func toUinputName(name []byte) (uinputName [uinputMaxNameSize]byte) {
|
||||||
|
var fixedSizeName [uinputMaxNameSize]byte
|
||||||
|
copy(fixedSizeName[:], name)
|
||||||
|
return fixedSizeName
|
||||||
|
}
|
||||||
|
|
||||||
|
func createTouchPad(path string, name []byte, minX int32, maxX int32, minY int32, maxY int32) (fd *os.File, err error) {
|
||||||
|
deviceFile, err := createDeviceFile(path)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("could not create absolute axis input device: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
err = registerDevice(deviceFile, uintptr(evKey))
|
||||||
|
if err != nil {
|
||||||
|
deviceFile.Close()
|
||||||
|
return nil, fmt.Errorf("failed to register key device: %v", err)
|
||||||
|
}
|
||||||
|
// register button events (in order to enable left and right click)
|
||||||
|
err = ioctl(deviceFile, uiSetKeyBit, uintptr(evBtnLeft))
|
||||||
|
if err != nil {
|
||||||
|
deviceFile.Close()
|
||||||
|
return nil, fmt.Errorf("failed to register left click event: %v", err)
|
||||||
|
}
|
||||||
|
err = ioctl(deviceFile, uiSetKeyBit, uintptr(evBtnRight))
|
||||||
|
if err != nil {
|
||||||
|
deviceFile.Close()
|
||||||
|
return nil, fmt.Errorf("failed to register right click event: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
err = registerDevice(deviceFile, uintptr(evAbs))
|
||||||
|
if err != nil {
|
||||||
|
deviceFile.Close()
|
||||||
|
return nil, fmt.Errorf("failed to register absolute axis input device: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// register x and y axis events
|
||||||
|
err = ioctl(deviceFile, uiSetAbsBit, uintptr(absX))
|
||||||
|
if err != nil {
|
||||||
|
deviceFile.Close()
|
||||||
|
return nil, fmt.Errorf("failed to register absolute x axis events: %v", err)
|
||||||
|
}
|
||||||
|
err = ioctl(deviceFile, uiSetAbsBit, uintptr(absY))
|
||||||
|
if err != nil {
|
||||||
|
deviceFile.Close()
|
||||||
|
return nil, fmt.Errorf("failed to register absolute y axis events: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
var absMin [absSize]int32
|
||||||
|
absMin[absX] = minX
|
||||||
|
absMin[absY] = minY
|
||||||
|
|
||||||
|
var absMax [absSize]int32
|
||||||
|
absMax[absX] = maxX
|
||||||
|
absMax[absY] = maxY
|
||||||
|
|
||||||
|
return createUsbDevice(deviceFile,
|
||||||
|
uinputUserDev{
|
||||||
|
Name: toUinputName(name),
|
||||||
|
ID: inputID{
|
||||||
|
Bustype: busUsb,
|
||||||
|
Vendor: 0x4711,
|
||||||
|
Product: 0x0817,
|
||||||
|
Version: 1},
|
||||||
|
Absmin: absMin,
|
||||||
|
Absmax: absMax})
|
||||||
|
}
|
||||||
|
|
||||||
|
func createMouse(path string, name []byte) (fd *os.File, err error) {
|
||||||
|
deviceFile, err := createDeviceFile(path)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("could not create relative axis input device: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
err = registerDevice(deviceFile, uintptr(evKey))
|
||||||
|
if err != nil {
|
||||||
|
deviceFile.Close()
|
||||||
|
return nil, fmt.Errorf("failed to register key device: %v", err)
|
||||||
|
}
|
||||||
|
// register button events (in order to enable left and right click)
|
||||||
|
err = ioctl(deviceFile, uiSetKeyBit, uintptr(evBtnLeft))
|
||||||
|
if err != nil {
|
||||||
|
deviceFile.Close()
|
||||||
|
return nil, fmt.Errorf("failed to register left click event: %v", err)
|
||||||
|
}
|
||||||
|
err = ioctl(deviceFile, uiSetKeyBit, uintptr(evBtnRight))
|
||||||
|
if err != nil {
|
||||||
|
deviceFile.Close()
|
||||||
|
return nil, fmt.Errorf("failed to register right click event: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
err = registerDevice(deviceFile, uintptr(evRel))
|
||||||
|
if err != nil {
|
||||||
|
deviceFile.Close()
|
||||||
|
return nil, fmt.Errorf("failed to register relative axis input device: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// register x and y axis events
|
||||||
|
err = ioctl(deviceFile, uiSetRelBit, uintptr(relX))
|
||||||
|
if err != nil {
|
||||||
|
deviceFile.Close()
|
||||||
|
return nil, fmt.Errorf("failed to register relative x axis events: %v", err)
|
||||||
|
}
|
||||||
|
err = ioctl(deviceFile, uiSetRelBit, uintptr(relY))
|
||||||
|
if err != nil {
|
||||||
|
deviceFile.Close()
|
||||||
|
return nil, fmt.Errorf("failed to register relative y axis events: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
return createUsbDevice(deviceFile,
|
||||||
|
uinputUserDev{
|
||||||
|
Name: toUinputName(name),
|
||||||
|
ID: inputID{
|
||||||
|
Bustype: busUsb,
|
||||||
|
Vendor: 0x4711,
|
||||||
|
Product: 0x0816,
|
||||||
|
Version: 1}})
|
||||||
|
}
|
||||||
|
|
||||||
|
func createUsbDevice(deviceFile *os.File, dev uinputUserDev) (fd *os.File, err error) {
|
||||||
|
buf := new(bytes.Buffer)
|
||||||
|
err = binary.Write(buf, binary.LittleEndian, dev)
|
||||||
|
if err != nil {
|
||||||
|
deviceFile.Close()
|
||||||
|
return nil, fmt.Errorf("failed to write user device buffer: %v", err)
|
||||||
|
}
|
||||||
|
_, err = deviceFile.Write(buf.Bytes())
|
||||||
|
if err != nil {
|
||||||
|
deviceFile.Close()
|
||||||
|
return nil, fmt.Errorf("failed to write uidev struct to device file: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
err = ioctl(deviceFile, uiDevCreate, uintptr(0))
|
||||||
|
if err != nil {
|
||||||
|
deviceFile.Close()
|
||||||
|
return nil, fmt.Errorf("failed to create device: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
time.Sleep(time.Millisecond * 200)
|
||||||
|
|
||||||
|
return deviceFile, err
|
||||||
|
}
|
||||||
|
|
||||||
|
func sendBtnEvent(deviceFile *os.File, key int, btnState int) (err error) {
|
||||||
|
buf, err := inputEventToBuffer(inputEvent{
|
||||||
|
Time: syscall.Timeval{Sec: 0, Usec: 0},
|
||||||
|
Type: evKey,
|
||||||
|
Code: uint16(key),
|
||||||
|
Value: int32(btnState)})
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("key event could not be set: %v", err)
|
||||||
|
}
|
||||||
|
_, err = deviceFile.Write(buf)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("writing btnEvent structure to the device file failed: %v", err)
|
||||||
|
}
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
func sendAbsEvent(deviceFile *os.File, xPos int32, yPos int32) error {
|
||||||
|
var ev [2]inputEvent
|
||||||
|
ev[0].Type = evAbs
|
||||||
|
ev[0].Code = absX
|
||||||
|
ev[0].Value = xPos
|
||||||
|
|
||||||
|
ev[1].Type = evAbs
|
||||||
|
ev[1].Code = absY
|
||||||
|
ev[1].Value = yPos
|
||||||
|
|
||||||
|
for _, iev := range ev {
|
||||||
|
buf, err := inputEventToBuffer(iev)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("writing abs event failed: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
_, err = deviceFile.Write(buf)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("failed to write abs event to device file: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return syncEvents(deviceFile)
|
||||||
|
}
|
||||||
|
|
||||||
|
func sendRelEvent(deviceFile *os.File, eventCode uint16, pixel int32) error {
|
||||||
|
iev := inputEvent{
|
||||||
|
Time: syscall.Timeval{Sec: 0, Usec: 0},
|
||||||
|
Type: evRel,
|
||||||
|
Code: eventCode,
|
||||||
|
Value: pixel}
|
||||||
|
|
||||||
|
buf, err := inputEventToBuffer(iev)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("writing abs event failed: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
_, err = deviceFile.Write(buf)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("failed to write rel event to device file: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
return syncEvents(deviceFile)
|
||||||
|
}
|
||||||
|
|
||||||
|
func syncEvents(deviceFile *os.File) (err error) {
|
||||||
|
buf, err := inputEventToBuffer(inputEvent{
|
||||||
|
Time: syscall.Timeval{Sec: 0, Usec: 0},
|
||||||
|
Type: evSyn,
|
||||||
|
Code: 0,
|
||||||
|
Value: int32(synReport)})
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("writing sync event failed: %v", err)
|
||||||
|
}
|
||||||
|
_, err = deviceFile.Write(buf)
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
func inputEventToBuffer(iev inputEvent) (buffer []byte, err error) {
|
||||||
|
buf := new(bytes.Buffer)
|
||||||
|
err = binary.Write(buf, binary.LittleEndian, iev)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("failed to write input event to buffer: %v", err)
|
||||||
|
}
|
||||||
|
return buf.Bytes(), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// original function taken from: https://github.com/tianon/debian-golang-pty/blob/master/ioctl.go
|
||||||
|
func ioctl(deviceFile *os.File, cmd, ptr uintptr) error {
|
||||||
|
_, _, errorCode := syscall.Syscall(syscall.SYS_IOCTL, deviceFile.Fd(), cmd, ptr)
|
||||||
|
if errorCode != 0 {
|
||||||
|
return errorCode
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
|
@ -0,0 +1,15 @@
|
||||||
|
ISC License
|
||||||
|
|
||||||
|
Copyright (c) 2012-2013 Dave Collins <dave@davec.name>
|
||||||
|
|
||||||
|
Permission to use, copy, modify, and distribute this software for any
|
||||||
|
purpose with or without fee is hereby granted, provided that the above
|
||||||
|
copyright notice and this permission notice appear in all copies.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
||||||
|
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
||||||
|
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
||||||
|
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
||||||
|
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
||||||
|
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
||||||
|
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
|
@ -0,0 +1,152 @@
|
||||||
|
// Copyright (c) 2015 Dave Collins <dave@davec.name>
|
||||||
|
//
|
||||||
|
// Permission to use, copy, modify, and distribute this software for any
|
||||||
|
// purpose with or without fee is hereby granted, provided that the above
|
||||||
|
// copyright notice and this permission notice appear in all copies.
|
||||||
|
//
|
||||||
|
// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
||||||
|
// WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
||||||
|
// MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
||||||
|
// ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
||||||
|
// WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
||||||
|
// ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
||||||
|
// OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
||||||
|
|
||||||
|
// NOTE: Due to the following build constraints, this file will only be compiled
|
||||||
|
// when the code is not running on Google App Engine, compiled by GopherJS, and
|
||||||
|
// "-tags safe" is not added to the go build command line. The "disableunsafe"
|
||||||
|
// tag is deprecated and thus should not be used.
|
||||||
|
// +build !js,!appengine,!safe,!disableunsafe
|
||||||
|
|
||||||
|
package spew
|
||||||
|
|
||||||
|
import (
|
||||||
|
"reflect"
|
||||||
|
"unsafe"
|
||||||
|
)
|
||||||
|
|
||||||
|
const (
|
||||||
|
// UnsafeDisabled is a build-time constant which specifies whether or
|
||||||
|
// not access to the unsafe package is available.
|
||||||
|
UnsafeDisabled = false
|
||||||
|
|
||||||
|
// ptrSize is the size of a pointer on the current arch.
|
||||||
|
ptrSize = unsafe.Sizeof((*byte)(nil))
|
||||||
|
)
|
||||||
|
|
||||||
|
var (
|
||||||
|
// offsetPtr, offsetScalar, and offsetFlag are the offsets for the
|
||||||
|
// internal reflect.Value fields. These values are valid before golang
|
||||||
|
// commit ecccf07e7f9d which changed the format. The are also valid
|
||||||
|
// after commit 82f48826c6c7 which changed the format again to mirror
|
||||||
|
// the original format. Code in the init function updates these offsets
|
||||||
|
// as necessary.
|
||||||
|
offsetPtr = uintptr(ptrSize)
|
||||||
|
offsetScalar = uintptr(0)
|
||||||
|
offsetFlag = uintptr(ptrSize * 2)
|
||||||
|
|
||||||
|
// flagKindWidth and flagKindShift indicate various bits that the
|
||||||
|
// reflect package uses internally to track kind information.
|
||||||
|
//
|
||||||
|
// flagRO indicates whether or not the value field of a reflect.Value is
|
||||||
|
// read-only.
|
||||||
|
//
|
||||||
|
// flagIndir indicates whether the value field of a reflect.Value is
|
||||||
|
// the actual data or a pointer to the data.
|
||||||
|
//
|
||||||
|
// These values are valid before golang commit 90a7c3c86944 which
|
||||||
|
// changed their positions. Code in the init function updates these
|
||||||
|
// flags as necessary.
|
||||||
|
flagKindWidth = uintptr(5)
|
||||||
|
flagKindShift = uintptr(flagKindWidth - 1)
|
||||||
|
flagRO = uintptr(1 << 0)
|
||||||
|
flagIndir = uintptr(1 << 1)
|
||||||
|
)
|
||||||
|
|
||||||
|
func init() {
|
||||||
|
// Older versions of reflect.Value stored small integers directly in the
|
||||||
|
// ptr field (which is named val in the older versions). Versions
|
||||||
|
// between commits ecccf07e7f9d and 82f48826c6c7 added a new field named
|
||||||
|
// scalar for this purpose which unfortunately came before the flag
|
||||||
|
// field, so the offset of the flag field is different for those
|
||||||
|
// versions.
|
||||||
|
//
|
||||||
|
// This code constructs a new reflect.Value from a known small integer
|
||||||
|
// and checks if the size of the reflect.Value struct indicates it has
|
||||||
|
// the scalar field. When it does, the offsets are updated accordingly.
|
||||||
|
vv := reflect.ValueOf(0xf00)
|
||||||
|
if unsafe.Sizeof(vv) == (ptrSize * 4) {
|
||||||
|
offsetScalar = ptrSize * 2
|
||||||
|
offsetFlag = ptrSize * 3
|
||||||
|
}
|
||||||
|
|
||||||
|
// Commit 90a7c3c86944 changed the flag positions such that the low
|
||||||
|
// order bits are the kind. This code extracts the kind from the flags
|
||||||
|
// field and ensures it's the correct type. When it's not, the flag
|
||||||
|
// order has been changed to the newer format, so the flags are updated
|
||||||
|
// accordingly.
|
||||||
|
upf := unsafe.Pointer(uintptr(unsafe.Pointer(&vv)) + offsetFlag)
|
||||||
|
upfv := *(*uintptr)(upf)
|
||||||
|
flagKindMask := uintptr((1<<flagKindWidth - 1) << flagKindShift)
|
||||||
|
if (upfv&flagKindMask)>>flagKindShift != uintptr(reflect.Int) {
|
||||||
|
flagKindShift = 0
|
||||||
|
flagRO = 1 << 5
|
||||||
|
flagIndir = 1 << 6
|
||||||
|
|
||||||
|
// Commit adf9b30e5594 modified the flags to separate the
|
||||||
|
// flagRO flag into two bits which specifies whether or not the
|
||||||
|
// field is embedded. This causes flagIndir to move over a bit
|
||||||
|
// and means that flagRO is the combination of either of the
|
||||||
|
// original flagRO bit and the new bit.
|
||||||
|
//
|
||||||
|
// This code detects the change by extracting what used to be
|
||||||
|
// the indirect bit to ensure it's set. When it's not, the flag
|
||||||
|
// order has been changed to the newer format, so the flags are
|
||||||
|
// updated accordingly.
|
||||||
|
if upfv&flagIndir == 0 {
|
||||||
|
flagRO = 3 << 5
|
||||||
|
flagIndir = 1 << 7
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// unsafeReflectValue converts the passed reflect.Value into a one that bypasses
|
||||||
|
// the typical safety restrictions preventing access to unaddressable and
|
||||||
|
// unexported data. It works by digging the raw pointer to the underlying
|
||||||
|
// value out of the protected value and generating a new unprotected (unsafe)
|
||||||
|
// reflect.Value to it.
|
||||||
|
//
|
||||||
|
// This allows us to check for implementations of the Stringer and error
|
||||||
|
// interfaces to be used for pretty printing ordinarily unaddressable and
|
||||||
|
// inaccessible values such as unexported struct fields.
|
||||||
|
func unsafeReflectValue(v reflect.Value) (rv reflect.Value) {
|
||||||
|
indirects := 1
|
||||||
|
vt := v.Type()
|
||||||
|
upv := unsafe.Pointer(uintptr(unsafe.Pointer(&v)) + offsetPtr)
|
||||||
|
rvf := *(*uintptr)(unsafe.Pointer(uintptr(unsafe.Pointer(&v)) + offsetFlag))
|
||||||
|
if rvf&flagIndir != 0 {
|
||||||
|
vt = reflect.PtrTo(v.Type())
|
||||||
|
indirects++
|
||||||
|
} else if offsetScalar != 0 {
|
||||||
|
// The value is in the scalar field when it's not one of the
|
||||||
|
// reference types.
|
||||||
|
switch vt.Kind() {
|
||||||
|
case reflect.Uintptr:
|
||||||
|
case reflect.Chan:
|
||||||
|
case reflect.Func:
|
||||||
|
case reflect.Map:
|
||||||
|
case reflect.Ptr:
|
||||||
|
case reflect.UnsafePointer:
|
||||||
|
default:
|
||||||
|
upv = unsafe.Pointer(uintptr(unsafe.Pointer(&v)) +
|
||||||
|
offsetScalar)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pv := reflect.NewAt(vt, upv)
|
||||||
|
rv = pv
|
||||||
|
for i := 0; i < indirects; i++ {
|
||||||
|
rv = rv.Elem()
|
||||||
|
}
|
||||||
|
return rv
|
||||||
|
}
|
|
@ -0,0 +1,38 @@
|
||||||
|
// Copyright (c) 2015 Dave Collins <dave@davec.name>
|
||||||
|
//
|
||||||
|
// Permission to use, copy, modify, and distribute this software for any
|
||||||
|
// purpose with or without fee is hereby granted, provided that the above
|
||||||
|
// copyright notice and this permission notice appear in all copies.
|
||||||
|
//
|
||||||
|
// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
||||||
|
// WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
||||||
|
// MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
||||||
|
// ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
||||||
|
// WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
||||||
|
// ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
||||||
|
// OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
||||||
|
|
||||||
|
// NOTE: Due to the following build constraints, this file will only be compiled
|
||||||
|
// when the code is running on Google App Engine, compiled by GopherJS, or
|
||||||
|
// "-tags safe" is added to the go build command line. The "disableunsafe"
|
||||||
|
// tag is deprecated and thus should not be used.
|
||||||
|
// +build js appengine safe disableunsafe
|
||||||
|
|
||||||
|
package spew
|
||||||
|
|
||||||
|
import "reflect"
|
||||||
|
|
||||||
|
const (
|
||||||
|
// UnsafeDisabled is a build-time constant which specifies whether or
|
||||||
|
// not access to the unsafe package is available.
|
||||||
|
UnsafeDisabled = true
|
||||||
|
)
|
||||||
|
|
||||||
|
// unsafeReflectValue typically converts the passed reflect.Value into a one
|
||||||
|
// that bypasses the typical safety restrictions preventing access to
|
||||||
|
// unaddressable and unexported data. However, doing this relies on access to
|
||||||
|
// the unsafe package. This is a stub version which simply returns the passed
|
||||||
|
// reflect.Value when the unsafe package is not available.
|
||||||
|
func unsafeReflectValue(v reflect.Value) reflect.Value {
|
||||||
|
return v
|
||||||
|
}
|
|
@ -0,0 +1,341 @@
|
||||||
|
/*
|
||||||
|
* Copyright (c) 2013 Dave Collins <dave@davec.name>
|
||||||
|
*
|
||||||
|
* Permission to use, copy, modify, and distribute this software for any
|
||||||
|
* purpose with or without fee is hereby granted, provided that the above
|
||||||
|
* copyright notice and this permission notice appear in all copies.
|
||||||
|
*
|
||||||
|
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
||||||
|
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
||||||
|
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
||||||
|
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
||||||
|
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
||||||
|
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
||||||
|
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package spew
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"reflect"
|
||||||
|
"sort"
|
||||||
|
"strconv"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Some constants in the form of bytes to avoid string overhead. This mirrors
|
||||||
|
// the technique used in the fmt package.
|
||||||
|
var (
|
||||||
|
panicBytes = []byte("(PANIC=")
|
||||||
|
plusBytes = []byte("+")
|
||||||
|
iBytes = []byte("i")
|
||||||
|
trueBytes = []byte("true")
|
||||||
|
falseBytes = []byte("false")
|
||||||
|
interfaceBytes = []byte("(interface {})")
|
||||||
|
commaNewlineBytes = []byte(",\n")
|
||||||
|
newlineBytes = []byte("\n")
|
||||||
|
openBraceBytes = []byte("{")
|
||||||
|
openBraceNewlineBytes = []byte("{\n")
|
||||||
|
closeBraceBytes = []byte("}")
|
||||||
|
asteriskBytes = []byte("*")
|
||||||
|
colonBytes = []byte(":")
|
||||||
|
colonSpaceBytes = []byte(": ")
|
||||||
|
openParenBytes = []byte("(")
|
||||||
|
closeParenBytes = []byte(")")
|
||||||
|
spaceBytes = []byte(" ")
|
||||||
|
pointerChainBytes = []byte("->")
|
||||||
|
nilAngleBytes = []byte("<nil>")
|
||||||
|
maxNewlineBytes = []byte("<max depth reached>\n")
|
||||||
|
maxShortBytes = []byte("<max>")
|
||||||
|
circularBytes = []byte("<already shown>")
|
||||||
|
circularShortBytes = []byte("<shown>")
|
||||||
|
invalidAngleBytes = []byte("<invalid>")
|
||||||
|
openBracketBytes = []byte("[")
|
||||||
|
closeBracketBytes = []byte("]")
|
||||||
|
percentBytes = []byte("%")
|
||||||
|
precisionBytes = []byte(".")
|
||||||
|
openAngleBytes = []byte("<")
|
||||||
|
closeAngleBytes = []byte(">")
|
||||||
|
openMapBytes = []byte("map[")
|
||||||
|
closeMapBytes = []byte("]")
|
||||||
|
lenEqualsBytes = []byte("len=")
|
||||||
|
capEqualsBytes = []byte("cap=")
|
||||||
|
)
|
||||||
|
|
||||||
|
// hexDigits is used to map a decimal value to a hex digit.
|
||||||
|
var hexDigits = "0123456789abcdef"
|
||||||
|
|
||||||
|
// catchPanic handles any panics that might occur during the handleMethods
|
||||||
|
// calls.
|
||||||
|
func catchPanic(w io.Writer, v reflect.Value) {
|
||||||
|
if err := recover(); err != nil {
|
||||||
|
w.Write(panicBytes)
|
||||||
|
fmt.Fprintf(w, "%v", err)
|
||||||
|
w.Write(closeParenBytes)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// handleMethods attempts to call the Error and String methods on the underlying
|
||||||
|
// type the passed reflect.Value represents and outputes the result to Writer w.
|
||||||
|
//
|
||||||
|
// It handles panics in any called methods by catching and displaying the error
|
||||||
|
// as the formatted value.
|
||||||
|
func handleMethods(cs *ConfigState, w io.Writer, v reflect.Value) (handled bool) {
|
||||||
|
// We need an interface to check if the type implements the error or
|
||||||
|
// Stringer interface. However, the reflect package won't give us an
|
||||||
|
// interface on certain things like unexported struct fields in order
|
||||||
|
// to enforce visibility rules. We use unsafe, when it's available,
|
||||||
|
// to bypass these restrictions since this package does not mutate the
|
||||||
|
// values.
|
||||||
|
if !v.CanInterface() {
|
||||||
|
if UnsafeDisabled {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
v = unsafeReflectValue(v)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Choose whether or not to do error and Stringer interface lookups against
|
||||||
|
// the base type or a pointer to the base type depending on settings.
|
||||||
|
// Technically calling one of these methods with a pointer receiver can
|
||||||
|
// mutate the value, however, types which choose to satisify an error or
|
||||||
|
// Stringer interface with a pointer receiver should not be mutating their
|
||||||
|
// state inside these interface methods.
|
||||||
|
if !cs.DisablePointerMethods && !UnsafeDisabled && !v.CanAddr() {
|
||||||
|
v = unsafeReflectValue(v)
|
||||||
|
}
|
||||||
|
if v.CanAddr() {
|
||||||
|
v = v.Addr()
|
||||||
|
}
|
||||||
|
|
||||||
|
// Is it an error or Stringer?
|
||||||
|
switch iface := v.Interface().(type) {
|
||||||
|
case error:
|
||||||
|
defer catchPanic(w, v)
|
||||||
|
if cs.ContinueOnMethod {
|
||||||
|
w.Write(openParenBytes)
|
||||||
|
w.Write([]byte(iface.Error()))
|
||||||
|
w.Write(closeParenBytes)
|
||||||
|
w.Write(spaceBytes)
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
w.Write([]byte(iface.Error()))
|
||||||
|
return true
|
||||||
|
|
||||||
|
case fmt.Stringer:
|
||||||
|
defer catchPanic(w, v)
|
||||||
|
if cs.ContinueOnMethod {
|
||||||
|
w.Write(openParenBytes)
|
||||||
|
w.Write([]byte(iface.String()))
|
||||||
|
w.Write(closeParenBytes)
|
||||||
|
w.Write(spaceBytes)
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
w.Write([]byte(iface.String()))
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
// printBool outputs a boolean value as true or false to Writer w.
|
||||||
|
func printBool(w io.Writer, val bool) {
|
||||||
|
if val {
|
||||||
|
w.Write(trueBytes)
|
||||||
|
} else {
|
||||||
|
w.Write(falseBytes)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// printInt outputs a signed integer value to Writer w.
|
||||||
|
func printInt(w io.Writer, val int64, base int) {
|
||||||
|
w.Write([]byte(strconv.FormatInt(val, base)))
|
||||||
|
}
|
||||||
|
|
||||||
|
// printUint outputs an unsigned integer value to Writer w.
|
||||||
|
func printUint(w io.Writer, val uint64, base int) {
|
||||||
|
w.Write([]byte(strconv.FormatUint(val, base)))
|
||||||
|
}
|
||||||
|
|
||||||
|
// printFloat outputs a floating point value using the specified precision,
|
||||||
|
// which is expected to be 32 or 64bit, to Writer w.
|
||||||
|
func printFloat(w io.Writer, val float64, precision int) {
|
||||||
|
w.Write([]byte(strconv.FormatFloat(val, 'g', -1, precision)))
|
||||||
|
}
|
||||||
|
|
||||||
|
// printComplex outputs a complex value using the specified float precision
|
||||||
|
// for the real and imaginary parts to Writer w.
|
||||||
|
func printComplex(w io.Writer, c complex128, floatPrecision int) {
|
||||||
|
r := real(c)
|
||||||
|
w.Write(openParenBytes)
|
||||||
|
w.Write([]byte(strconv.FormatFloat(r, 'g', -1, floatPrecision)))
|
||||||
|
i := imag(c)
|
||||||
|
if i >= 0 {
|
||||||
|
w.Write(plusBytes)
|
||||||
|
}
|
||||||
|
w.Write([]byte(strconv.FormatFloat(i, 'g', -1, floatPrecision)))
|
||||||
|
w.Write(iBytes)
|
||||||
|
w.Write(closeParenBytes)
|
||||||
|
}
|
||||||
|
|
||||||
|
// printHexPtr outputs a uintptr formatted as hexidecimal with a leading '0x'
|
||||||
|
// prefix to Writer w.
|
||||||
|
func printHexPtr(w io.Writer, p uintptr) {
|
||||||
|
// Null pointer.
|
||||||
|
num := uint64(p)
|
||||||
|
if num == 0 {
|
||||||
|
w.Write(nilAngleBytes)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// Max uint64 is 16 bytes in hex + 2 bytes for '0x' prefix
|
||||||
|
buf := make([]byte, 18)
|
||||||
|
|
||||||
|
// It's simpler to construct the hex string right to left.
|
||||||
|
base := uint64(16)
|
||||||
|
i := len(buf) - 1
|
||||||
|
for num >= base {
|
||||||
|
buf[i] = hexDigits[num%base]
|
||||||
|
num /= base
|
||||||
|
i--
|
||||||
|
}
|
||||||
|
buf[i] = hexDigits[num]
|
||||||
|
|
||||||
|
// Add '0x' prefix.
|
||||||
|
i--
|
||||||
|
buf[i] = 'x'
|
||||||
|
i--
|
||||||
|
buf[i] = '0'
|
||||||
|
|
||||||
|
// Strip unused leading bytes.
|
||||||
|
buf = buf[i:]
|
||||||
|
w.Write(buf)
|
||||||
|
}
|
||||||
|
|
||||||
|
// valuesSorter implements sort.Interface to allow a slice of reflect.Value
|
||||||
|
// elements to be sorted.
|
||||||
|
type valuesSorter struct {
|
||||||
|
values []reflect.Value
|
||||||
|
strings []string // either nil or same len and values
|
||||||
|
cs *ConfigState
|
||||||
|
}
|
||||||
|
|
||||||
|
// newValuesSorter initializes a valuesSorter instance, which holds a set of
|
||||||
|
// surrogate keys on which the data should be sorted. It uses flags in
|
||||||
|
// ConfigState to decide if and how to populate those surrogate keys.
|
||||||
|
func newValuesSorter(values []reflect.Value, cs *ConfigState) sort.Interface {
|
||||||
|
vs := &valuesSorter{values: values, cs: cs}
|
||||||
|
if canSortSimply(vs.values[0].Kind()) {
|
||||||
|
return vs
|
||||||
|
}
|
||||||
|
if !cs.DisableMethods {
|
||||||
|
vs.strings = make([]string, len(values))
|
||||||
|
for i := range vs.values {
|
||||||
|
b := bytes.Buffer{}
|
||||||
|
if !handleMethods(cs, &b, vs.values[i]) {
|
||||||
|
vs.strings = nil
|
||||||
|
break
|
||||||
|
}
|
||||||
|
vs.strings[i] = b.String()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if vs.strings == nil && cs.SpewKeys {
|
||||||
|
vs.strings = make([]string, len(values))
|
||||||
|
for i := range vs.values {
|
||||||
|
vs.strings[i] = Sprintf("%#v", vs.values[i].Interface())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return vs
|
||||||
|
}
|
||||||
|
|
||||||
|
// canSortSimply tests whether a reflect.Kind is a primitive that can be sorted
|
||||||
|
// directly, or whether it should be considered for sorting by surrogate keys
|
||||||
|
// (if the ConfigState allows it).
|
||||||
|
func canSortSimply(kind reflect.Kind) bool {
|
||||||
|
// This switch parallels valueSortLess, except for the default case.
|
||||||
|
switch kind {
|
||||||
|
case reflect.Bool:
|
||||||
|
return true
|
||||||
|
case reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64, reflect.Int:
|
||||||
|
return true
|
||||||
|
case reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64, reflect.Uint:
|
||||||
|
return true
|
||||||
|
case reflect.Float32, reflect.Float64:
|
||||||
|
return true
|
||||||
|
case reflect.String:
|
||||||
|
return true
|
||||||
|
case reflect.Uintptr:
|
||||||
|
return true
|
||||||
|
case reflect.Array:
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
// Len returns the number of values in the slice. It is part of the
|
||||||
|
// sort.Interface implementation.
|
||||||
|
func (s *valuesSorter) Len() int {
|
||||||
|
return len(s.values)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Swap swaps the values at the passed indices. It is part of the
|
||||||
|
// sort.Interface implementation.
|
||||||
|
func (s *valuesSorter) Swap(i, j int) {
|
||||||
|
s.values[i], s.values[j] = s.values[j], s.values[i]
|
||||||
|
if s.strings != nil {
|
||||||
|
s.strings[i], s.strings[j] = s.strings[j], s.strings[i]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// valueSortLess returns whether the first value should sort before the second
|
||||||
|
// value. It is used by valueSorter.Less as part of the sort.Interface
|
||||||
|
// implementation.
|
||||||
|
func valueSortLess(a, b reflect.Value) bool {
|
||||||
|
switch a.Kind() {
|
||||||
|
case reflect.Bool:
|
||||||
|
return !a.Bool() && b.Bool()
|
||||||
|
case reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64, reflect.Int:
|
||||||
|
return a.Int() < b.Int()
|
||||||
|
case reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64, reflect.Uint:
|
||||||
|
return a.Uint() < b.Uint()
|
||||||
|
case reflect.Float32, reflect.Float64:
|
||||||
|
return a.Float() < b.Float()
|
||||||
|
case reflect.String:
|
||||||
|
return a.String() < b.String()
|
||||||
|
case reflect.Uintptr:
|
||||||
|
return a.Uint() < b.Uint()
|
||||||
|
case reflect.Array:
|
||||||
|
// Compare the contents of both arrays.
|
||||||
|
l := a.Len()
|
||||||
|
for i := 0; i < l; i++ {
|
||||||
|
av := a.Index(i)
|
||||||
|
bv := b.Index(i)
|
||||||
|
if av.Interface() == bv.Interface() {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
return valueSortLess(av, bv)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return a.String() < b.String()
|
||||||
|
}
|
||||||
|
|
||||||
|
// Less returns whether the value at index i should sort before the
|
||||||
|
// value at index j. It is part of the sort.Interface implementation.
|
||||||
|
func (s *valuesSorter) Less(i, j int) bool {
|
||||||
|
if s.strings == nil {
|
||||||
|
return valueSortLess(s.values[i], s.values[j])
|
||||||
|
}
|
||||||
|
return s.strings[i] < s.strings[j]
|
||||||
|
}
|
||||||
|
|
||||||
|
// sortValues is a sort function that handles both native types and any type that
|
||||||
|
// can be converted to error or Stringer. Other inputs are sorted according to
|
||||||
|
// their Value.String() value to ensure display stability.
|
||||||
|
func sortValues(values []reflect.Value, cs *ConfigState) {
|
||||||
|
if len(values) == 0 {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
sort.Sort(newValuesSorter(values, cs))
|
||||||
|
}
|
|
@ -0,0 +1,306 @@
|
||||||
|
/*
|
||||||
|
* Copyright (c) 2013 Dave Collins <dave@davec.name>
|
||||||
|
*
|
||||||
|
* Permission to use, copy, modify, and distribute this software for any
|
||||||
|
* purpose with or without fee is hereby granted, provided that the above
|
||||||
|
* copyright notice and this permission notice appear in all copies.
|
||||||
|
*
|
||||||
|
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
||||||
|
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
||||||
|
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
||||||
|
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
||||||
|
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
||||||
|
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
||||||
|
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package spew
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"os"
|
||||||
|
)
|
||||||
|
|
||||||
|
// ConfigState houses the configuration options used by spew to format and
|
||||||
|
// display values. There is a global instance, Config, that is used to control
|
||||||
|
// all top-level Formatter and Dump functionality. Each ConfigState instance
|
||||||
|
// provides methods equivalent to the top-level functions.
|
||||||
|
//
|
||||||
|
// The zero value for ConfigState provides no indentation. You would typically
|
||||||
|
// want to set it to a space or a tab.
|
||||||
|
//
|
||||||
|
// Alternatively, you can use NewDefaultConfig to get a ConfigState instance
|
||||||
|
// with default settings. See the documentation of NewDefaultConfig for default
|
||||||
|
// values.
|
||||||
|
type ConfigState struct {
|
||||||
|
// Indent specifies the string to use for each indentation level. The
|
||||||
|
// global config instance that all top-level functions use set this to a
|
||||||
|
// single space by default. If you would like more indentation, you might
|
||||||
|
// set this to a tab with "\t" or perhaps two spaces with " ".
|
||||||
|
Indent string
|
||||||
|
|
||||||
|
// MaxDepth controls the maximum number of levels to descend into nested
|
||||||
|
// data structures. The default, 0, means there is no limit.
|
||||||
|
//
|
||||||
|
// NOTE: Circular data structures are properly detected, so it is not
|
||||||
|
// necessary to set this value unless you specifically want to limit deeply
|
||||||
|
// nested data structures.
|
||||||
|
MaxDepth int
|
||||||
|
|
||||||
|
// DisableMethods specifies whether or not error and Stringer interfaces are
|
||||||
|
// invoked for types that implement them.
|
||||||
|
DisableMethods bool
|
||||||
|
|
||||||
|
// DisablePointerMethods specifies whether or not to check for and invoke
|
||||||
|
// error and Stringer interfaces on types which only accept a pointer
|
||||||
|
// receiver when the current type is not a pointer.
|
||||||
|
//
|
||||||
|
// NOTE: This might be an unsafe action since calling one of these methods
|
||||||
|
// with a pointer receiver could technically mutate the value, however,
|
||||||
|
// in practice, types which choose to satisify an error or Stringer
|
||||||
|
// interface with a pointer receiver should not be mutating their state
|
||||||
|
// inside these interface methods. As a result, this option relies on
|
||||||
|
// access to the unsafe package, so it will not have any effect when
|
||||||
|
// running in environments without access to the unsafe package such as
|
||||||
|
// Google App Engine or with the "safe" build tag specified.
|
||||||
|
DisablePointerMethods bool
|
||||||
|
|
||||||
|
// DisablePointerAddresses specifies whether to disable the printing of
|
||||||
|
// pointer addresses. This is useful when diffing data structures in tests.
|
||||||
|
DisablePointerAddresses bool
|
||||||
|
|
||||||
|
// DisableCapacities specifies whether to disable the printing of capacities
|
||||||
|
// for arrays, slices, maps and channels. This is useful when diffing
|
||||||
|
// data structures in tests.
|
||||||
|
DisableCapacities bool
|
||||||
|
|
||||||
|
// ContinueOnMethod specifies whether or not recursion should continue once
|
||||||
|
// a custom error or Stringer interface is invoked. The default, false,
|
||||||
|
// means it will print the results of invoking the custom error or Stringer
|
||||||
|
// interface and return immediately instead of continuing to recurse into
|
||||||
|
// the internals of the data type.
|
||||||
|
//
|
||||||
|
// NOTE: This flag does not have any effect if method invocation is disabled
|
||||||
|
// via the DisableMethods or DisablePointerMethods options.
|
||||||
|
ContinueOnMethod bool
|
||||||
|
|
||||||
|
// SortKeys specifies map keys should be sorted before being printed. Use
|
||||||
|
// this to have a more deterministic, diffable output. Note that only
|
||||||
|
// native types (bool, int, uint, floats, uintptr and string) and types
|
||||||
|
// that support the error or Stringer interfaces (if methods are
|
||||||
|
// enabled) are supported, with other types sorted according to the
|
||||||
|
// reflect.Value.String() output which guarantees display stability.
|
||||||
|
SortKeys bool
|
||||||
|
|
||||||
|
// SpewKeys specifies that, as a last resort attempt, map keys should
|
||||||
|
// be spewed to strings and sorted by those strings. This is only
|
||||||
|
// considered if SortKeys is true.
|
||||||
|
SpewKeys bool
|
||||||
|
}
|
||||||
|
|
||||||
|
// Config is the active configuration of the top-level functions.
|
||||||
|
// The configuration can be changed by modifying the contents of spew.Config.
|
||||||
|
var Config = ConfigState{Indent: " "}
|
||||||
|
|
||||||
|
// Errorf is a wrapper for fmt.Errorf that treats each argument as if it were
|
||||||
|
// passed with a Formatter interface returned by c.NewFormatter. It returns
|
||||||
|
// the formatted string as a value that satisfies error. See NewFormatter
|
||||||
|
// for formatting details.
|
||||||
|
//
|
||||||
|
// This function is shorthand for the following syntax:
|
||||||
|
//
|
||||||
|
// fmt.Errorf(format, c.NewFormatter(a), c.NewFormatter(b))
|
||||||
|
func (c *ConfigState) Errorf(format string, a ...interface{}) (err error) {
|
||||||
|
return fmt.Errorf(format, c.convertArgs(a)...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Fprint is a wrapper for fmt.Fprint that treats each argument as if it were
|
||||||
|
// passed with a Formatter interface returned by c.NewFormatter. It returns
|
||||||
|
// the number of bytes written and any write error encountered. See
|
||||||
|
// NewFormatter for formatting details.
|
||||||
|
//
|
||||||
|
// This function is shorthand for the following syntax:
|
||||||
|
//
|
||||||
|
// fmt.Fprint(w, c.NewFormatter(a), c.NewFormatter(b))
|
||||||
|
func (c *ConfigState) Fprint(w io.Writer, a ...interface{}) (n int, err error) {
|
||||||
|
return fmt.Fprint(w, c.convertArgs(a)...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Fprintf is a wrapper for fmt.Fprintf that treats each argument as if it were
|
||||||
|
// passed with a Formatter interface returned by c.NewFormatter. It returns
|
||||||
|
// the number of bytes written and any write error encountered. See
|
||||||
|
// NewFormatter for formatting details.
|
||||||
|
//
|
||||||
|
// This function is shorthand for the following syntax:
|
||||||
|
//
|
||||||
|
// fmt.Fprintf(w, format, c.NewFormatter(a), c.NewFormatter(b))
|
||||||
|
func (c *ConfigState) Fprintf(w io.Writer, format string, a ...interface{}) (n int, err error) {
|
||||||
|
return fmt.Fprintf(w, format, c.convertArgs(a)...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Fprintln is a wrapper for fmt.Fprintln that treats each argument as if it
|
||||||
|
// passed with a Formatter interface returned by c.NewFormatter. See
|
||||||
|
// NewFormatter for formatting details.
|
||||||
|
//
|
||||||
|
// This function is shorthand for the following syntax:
|
||||||
|
//
|
||||||
|
// fmt.Fprintln(w, c.NewFormatter(a), c.NewFormatter(b))
|
||||||
|
func (c *ConfigState) Fprintln(w io.Writer, a ...interface{}) (n int, err error) {
|
||||||
|
return fmt.Fprintln(w, c.convertArgs(a)...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Print is a wrapper for fmt.Print that treats each argument as if it were
|
||||||
|
// passed with a Formatter interface returned by c.NewFormatter. It returns
|
||||||
|
// the number of bytes written and any write error encountered. See
|
||||||
|
// NewFormatter for formatting details.
|
||||||
|
//
|
||||||
|
// This function is shorthand for the following syntax:
|
||||||
|
//
|
||||||
|
// fmt.Print(c.NewFormatter(a), c.NewFormatter(b))
|
||||||
|
func (c *ConfigState) Print(a ...interface{}) (n int, err error) {
|
||||||
|
return fmt.Print(c.convertArgs(a)...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Printf is a wrapper for fmt.Printf that treats each argument as if it were
|
||||||
|
// passed with a Formatter interface returned by c.NewFormatter. It returns
|
||||||
|
// the number of bytes written and any write error encountered. See
|
||||||
|
// NewFormatter for formatting details.
|
||||||
|
//
|
||||||
|
// This function is shorthand for the following syntax:
|
||||||
|
//
|
||||||
|
// fmt.Printf(format, c.NewFormatter(a), c.NewFormatter(b))
|
||||||
|
func (c *ConfigState) Printf(format string, a ...interface{}) (n int, err error) {
|
||||||
|
return fmt.Printf(format, c.convertArgs(a)...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Println is a wrapper for fmt.Println that treats each argument as if it were
|
||||||
|
// passed with a Formatter interface returned by c.NewFormatter. It returns
|
||||||
|
// the number of bytes written and any write error encountered. See
|
||||||
|
// NewFormatter for formatting details.
|
||||||
|
//
|
||||||
|
// This function is shorthand for the following syntax:
|
||||||
|
//
|
||||||
|
// fmt.Println(c.NewFormatter(a), c.NewFormatter(b))
|
||||||
|
func (c *ConfigState) Println(a ...interface{}) (n int, err error) {
|
||||||
|
return fmt.Println(c.convertArgs(a)...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Sprint is a wrapper for fmt.Sprint that treats each argument as if it were
|
||||||
|
// passed with a Formatter interface returned by c.NewFormatter. It returns
|
||||||
|
// the resulting string. See NewFormatter for formatting details.
|
||||||
|
//
|
||||||
|
// This function is shorthand for the following syntax:
|
||||||
|
//
|
||||||
|
// fmt.Sprint(c.NewFormatter(a), c.NewFormatter(b))
|
||||||
|
func (c *ConfigState) Sprint(a ...interface{}) string {
|
||||||
|
return fmt.Sprint(c.convertArgs(a)...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Sprintf is a wrapper for fmt.Sprintf that treats each argument as if it were
|
||||||
|
// passed with a Formatter interface returned by c.NewFormatter. It returns
|
||||||
|
// the resulting string. See NewFormatter for formatting details.
|
||||||
|
//
|
||||||
|
// This function is shorthand for the following syntax:
|
||||||
|
//
|
||||||
|
// fmt.Sprintf(format, c.NewFormatter(a), c.NewFormatter(b))
|
||||||
|
func (c *ConfigState) Sprintf(format string, a ...interface{}) string {
|
||||||
|
return fmt.Sprintf(format, c.convertArgs(a)...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Sprintln is a wrapper for fmt.Sprintln that treats each argument as if it
|
||||||
|
// were passed with a Formatter interface returned by c.NewFormatter. It
|
||||||
|
// returns the resulting string. See NewFormatter for formatting details.
|
||||||
|
//
|
||||||
|
// This function is shorthand for the following syntax:
|
||||||
|
//
|
||||||
|
// fmt.Sprintln(c.NewFormatter(a), c.NewFormatter(b))
|
||||||
|
func (c *ConfigState) Sprintln(a ...interface{}) string {
|
||||||
|
return fmt.Sprintln(c.convertArgs(a)...)
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
NewFormatter returns a custom formatter that satisfies the fmt.Formatter
|
||||||
|
interface. As a result, it integrates cleanly with standard fmt package
|
||||||
|
printing functions. The formatter is useful for inline printing of smaller data
|
||||||
|
types similar to the standard %v format specifier.
|
||||||
|
|
||||||
|
The custom formatter only responds to the %v (most compact), %+v (adds pointer
|
||||||
|
addresses), %#v (adds types), and %#+v (adds types and pointer addresses) verb
|
||||||
|
combinations. Any other verbs such as %x and %q will be sent to the the
|
||||||
|
standard fmt package for formatting. In addition, the custom formatter ignores
|
||||||
|
the width and precision arguments (however they will still work on the format
|
||||||
|
specifiers not handled by the custom formatter).
|
||||||
|
|
||||||
|
Typically this function shouldn't be called directly. It is much easier to make
|
||||||
|
use of the custom formatter by calling one of the convenience functions such as
|
||||||
|
c.Printf, c.Println, or c.Printf.
|
||||||
|
*/
|
||||||
|
func (c *ConfigState) NewFormatter(v interface{}) fmt.Formatter {
|
||||||
|
return newFormatter(c, v)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Fdump formats and displays the passed arguments to io.Writer w. It formats
|
||||||
|
// exactly the same as Dump.
|
||||||
|
func (c *ConfigState) Fdump(w io.Writer, a ...interface{}) {
|
||||||
|
fdump(c, w, a...)
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
Dump displays the passed parameters to standard out with newlines, customizable
|
||||||
|
indentation, and additional debug information such as complete types and all
|
||||||
|
pointer addresses used to indirect to the final value. It provides the
|
||||||
|
following features over the built-in printing facilities provided by the fmt
|
||||||
|
package:
|
||||||
|
|
||||||
|
* Pointers are dereferenced and followed
|
||||||
|
* Circular data structures are detected and handled properly
|
||||||
|
* Custom Stringer/error interfaces are optionally invoked, including
|
||||||
|
on unexported types
|
||||||
|
* Custom types which only implement the Stringer/error interfaces via
|
||||||
|
a pointer receiver are optionally invoked when passing non-pointer
|
||||||
|
variables
|
||||||
|
* Byte arrays and slices are dumped like the hexdump -C command which
|
||||||
|
includes offsets, byte values in hex, and ASCII output
|
||||||
|
|
||||||
|
The configuration options are controlled by modifying the public members
|
||||||
|
of c. See ConfigState for options documentation.
|
||||||
|
|
||||||
|
See Fdump if you would prefer dumping to an arbitrary io.Writer or Sdump to
|
||||||
|
get the formatted result as a string.
|
||||||
|
*/
|
||||||
|
func (c *ConfigState) Dump(a ...interface{}) {
|
||||||
|
fdump(c, os.Stdout, a...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Sdump returns a string with the passed arguments formatted exactly the same
|
||||||
|
// as Dump.
|
||||||
|
func (c *ConfigState) Sdump(a ...interface{}) string {
|
||||||
|
var buf bytes.Buffer
|
||||||
|
fdump(c, &buf, a...)
|
||||||
|
return buf.String()
|
||||||
|
}
|
||||||
|
|
||||||
|
// convertArgs accepts a slice of arguments and returns a slice of the same
|
||||||
|
// length with each argument converted to a spew Formatter interface using
|
||||||
|
// the ConfigState associated with s.
|
||||||
|
func (c *ConfigState) convertArgs(args []interface{}) (formatters []interface{}) {
|
||||||
|
formatters = make([]interface{}, len(args))
|
||||||
|
for index, arg := range args {
|
||||||
|
formatters[index] = newFormatter(c, arg)
|
||||||
|
}
|
||||||
|
return formatters
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewDefaultConfig returns a ConfigState with the following default settings.
|
||||||
|
//
|
||||||
|
// Indent: " "
|
||||||
|
// MaxDepth: 0
|
||||||
|
// DisableMethods: false
|
||||||
|
// DisablePointerMethods: false
|
||||||
|
// ContinueOnMethod: false
|
||||||
|
// SortKeys: false
|
||||||
|
func NewDefaultConfig() *ConfigState {
|
||||||
|
return &ConfigState{Indent: " "}
|
||||||
|
}
|
|
@ -0,0 +1,202 @@
|
||||||
|
/*
|
||||||
|
* Copyright (c) 2013 Dave Collins <dave@davec.name>
|
||||||
|
*
|
||||||
|
* Permission to use, copy, modify, and distribute this software for any
|
||||||
|
* purpose with or without fee is hereby granted, provided that the above
|
||||||
|
* copyright notice and this permission notice appear in all copies.
|
||||||
|
*
|
||||||
|
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
||||||
|
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
||||||
|
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
||||||
|
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
||||||
|
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
||||||
|
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
||||||
|
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/*
|
||||||
|
Package spew implements a deep pretty printer for Go data structures to aid in
|
||||||
|
debugging.
|
||||||
|
|
||||||
|
A quick overview of the additional features spew provides over the built-in
|
||||||
|
printing facilities for Go data types are as follows:
|
||||||
|
|
||||||
|
* Pointers are dereferenced and followed
|
||||||
|
* Circular data structures are detected and handled properly
|
||||||
|
* Custom Stringer/error interfaces are optionally invoked, including
|
||||||
|
on unexported types
|
||||||
|
* Custom types which only implement the Stringer/error interfaces via
|
||||||
|
a pointer receiver are optionally invoked when passing non-pointer
|
||||||
|
variables
|
||||||
|
* Byte arrays and slices are dumped like the hexdump -C command which
|
||||||
|
includes offsets, byte values in hex, and ASCII output (only when using
|
||||||
|
Dump style)
|
||||||
|
|
||||||
|
There are two different approaches spew allows for dumping Go data structures:
|
||||||
|
|
||||||
|
* Dump style which prints with newlines, customizable indentation,
|
||||||
|
and additional debug information such as types and all pointer addresses
|
||||||
|
used to indirect to the final value
|
||||||
|
* A custom Formatter interface that integrates cleanly with the standard fmt
|
||||||
|
package and replaces %v, %+v, %#v, and %#+v to provide inline printing
|
||||||
|
similar to the default %v while providing the additional functionality
|
||||||
|
outlined above and passing unsupported format verbs such as %x and %q
|
||||||
|
along to fmt
|
||||||
|
|
||||||
|
Quick Start
|
||||||
|
|
||||||
|
This section demonstrates how to quickly get started with spew. See the
|
||||||
|
sections below for further details on formatting and configuration options.
|
||||||
|
|
||||||
|
To dump a variable with full newlines, indentation, type, and pointer
|
||||||
|
information use Dump, Fdump, or Sdump:
|
||||||
|
spew.Dump(myVar1, myVar2, ...)
|
||||||
|
spew.Fdump(someWriter, myVar1, myVar2, ...)
|
||||||
|
str := spew.Sdump(myVar1, myVar2, ...)
|
||||||
|
|
||||||
|
Alternatively, if you would prefer to use format strings with a compacted inline
|
||||||
|
printing style, use the convenience wrappers Printf, Fprintf, etc with
|
||||||
|
%v (most compact), %+v (adds pointer addresses), %#v (adds types), or
|
||||||
|
%#+v (adds types and pointer addresses):
|
||||||
|
spew.Printf("myVar1: %v -- myVar2: %+v", myVar1, myVar2)
|
||||||
|
spew.Printf("myVar3: %#v -- myVar4: %#+v", myVar3, myVar4)
|
||||||
|
spew.Fprintf(someWriter, "myVar1: %v -- myVar2: %+v", myVar1, myVar2)
|
||||||
|
spew.Fprintf(someWriter, "myVar3: %#v -- myVar4: %#+v", myVar3, myVar4)
|
||||||
|
|
||||||
|
Configuration Options
|
||||||
|
|
||||||
|
Configuration of spew is handled by fields in the ConfigState type. For
|
||||||
|
convenience, all of the top-level functions use a global state available
|
||||||
|
via the spew.Config global.
|
||||||
|
|
||||||
|
It is also possible to create a ConfigState instance that provides methods
|
||||||
|
equivalent to the top-level functions. This allows concurrent configuration
|
||||||
|
options. See the ConfigState documentation for more details.
|
||||||
|
|
||||||
|
The following configuration options are available:
|
||||||
|
* Indent
|
||||||
|
String to use for each indentation level for Dump functions.
|
||||||
|
It is a single space by default. A popular alternative is "\t".
|
||||||
|
|
||||||
|
* MaxDepth
|
||||||
|
Maximum number of levels to descend into nested data structures.
|
||||||
|
There is no limit by default.
|
||||||
|
|
||||||
|
* DisableMethods
|
||||||
|
Disables invocation of error and Stringer interface methods.
|
||||||
|
Method invocation is enabled by default.
|
||||||
|
|
||||||
|
* DisablePointerMethods
|
||||||
|
Disables invocation of error and Stringer interface methods on types
|
||||||
|
which only accept pointer receivers from non-pointer variables.
|
||||||
|
Pointer method invocation is enabled by default.
|
||||||
|
|
||||||
|
* ContinueOnMethod
|
||||||
|
Enables recursion into types after invoking error and Stringer interface
|
||||||
|
methods. Recursion after method invocation is disabled by default.
|
||||||
|
|
||||||
|
* SortKeys
|
||||||
|
Specifies map keys should be sorted before being printed. Use
|
||||||
|
this to have a more deterministic, diffable output. Note that
|
||||||
|
only native types (bool, int, uint, floats, uintptr and string)
|
||||||
|
and types which implement error or Stringer interfaces are
|
||||||
|
supported with other types sorted according to the
|
||||||
|
reflect.Value.String() output which guarantees display
|
||||||
|
stability. Natural map order is used by default.
|
||||||
|
|
||||||
|
* SpewKeys
|
||||||
|
Specifies that, as a last resort attempt, map keys should be
|
||||||
|
spewed to strings and sorted by those strings. This is only
|
||||||
|
considered if SortKeys is true.
|
||||||
|
|
||||||
|
Dump Usage
|
||||||
|
|
||||||
|
Simply call spew.Dump with a list of variables you want to dump:
|
||||||
|
|
||||||
|
spew.Dump(myVar1, myVar2, ...)
|
||||||
|
|
||||||
|
You may also call spew.Fdump if you would prefer to output to an arbitrary
|
||||||
|
io.Writer. For example, to dump to standard error:
|
||||||
|
|
||||||
|
spew.Fdump(os.Stderr, myVar1, myVar2, ...)
|
||||||
|
|
||||||
|
A third option is to call spew.Sdump to get the formatted output as a string:
|
||||||
|
|
||||||
|
str := spew.Sdump(myVar1, myVar2, ...)
|
||||||
|
|
||||||
|
Sample Dump Output
|
||||||
|
|
||||||
|
See the Dump example for details on the setup of the types and variables being
|
||||||
|
shown here.
|
||||||
|
|
||||||
|
(main.Foo) {
|
||||||
|
unexportedField: (*main.Bar)(0xf84002e210)({
|
||||||
|
flag: (main.Flag) flagTwo,
|
||||||
|
data: (uintptr) <nil>
|
||||||
|
}),
|
||||||
|
ExportedField: (map[interface {}]interface {}) (len=1) {
|
||||||
|
(string) (len=3) "one": (bool) true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
Byte (and uint8) arrays and slices are displayed uniquely like the hexdump -C
|
||||||
|
command as shown.
|
||||||
|
([]uint8) (len=32 cap=32) {
|
||||||
|
00000000 11 12 13 14 15 16 17 18 19 1a 1b 1c 1d 1e 1f 20 |............... |
|
||||||
|
00000010 21 22 23 24 25 26 27 28 29 2a 2b 2c 2d 2e 2f 30 |!"#$%&'()*+,-./0|
|
||||||
|
00000020 31 32 |12|
|
||||||
|
}
|
||||||
|
|
||||||
|
Custom Formatter
|
||||||
|
|
||||||
|
Spew provides a custom formatter that implements the fmt.Formatter interface
|
||||||
|
so that it integrates cleanly with standard fmt package printing functions. The
|
||||||
|
formatter is useful for inline printing of smaller data types similar to the
|
||||||
|
standard %v format specifier.
|
||||||
|
|
||||||
|
The custom formatter only responds to the %v (most compact), %+v (adds pointer
|
||||||
|
addresses), %#v (adds types), or %#+v (adds types and pointer addresses) verb
|
||||||
|
combinations. Any other verbs such as %x and %q will be sent to the the
|
||||||
|
standard fmt package for formatting. In addition, the custom formatter ignores
|
||||||
|
the width and precision arguments (however they will still work on the format
|
||||||
|
specifiers not handled by the custom formatter).
|
||||||
|
|
||||||
|
Custom Formatter Usage
|
||||||
|
|
||||||
|
The simplest way to make use of the spew custom formatter is to call one of the
|
||||||
|
convenience functions such as spew.Printf, spew.Println, or spew.Printf. The
|
||||||
|
functions have syntax you are most likely already familiar with:
|
||||||
|
|
||||||
|
spew.Printf("myVar1: %v -- myVar2: %+v", myVar1, myVar2)
|
||||||
|
spew.Printf("myVar3: %#v -- myVar4: %#+v", myVar3, myVar4)
|
||||||
|
spew.Println(myVar, myVar2)
|
||||||
|
spew.Fprintf(os.Stderr, "myVar1: %v -- myVar2: %+v", myVar1, myVar2)
|
||||||
|
spew.Fprintf(os.Stderr, "myVar3: %#v -- myVar4: %#+v", myVar3, myVar4)
|
||||||
|
|
||||||
|
See the Index for the full list convenience functions.
|
||||||
|
|
||||||
|
Sample Formatter Output
|
||||||
|
|
||||||
|
Double pointer to a uint8:
|
||||||
|
%v: <**>5
|
||||||
|
%+v: <**>(0xf8400420d0->0xf8400420c8)5
|
||||||
|
%#v: (**uint8)5
|
||||||
|
%#+v: (**uint8)(0xf8400420d0->0xf8400420c8)5
|
||||||
|
|
||||||
|
Pointer to circular struct with a uint8 field and a pointer to itself:
|
||||||
|
%v: <*>{1 <*><shown>}
|
||||||
|
%+v: <*>(0xf84003e260){ui8:1 c:<*>(0xf84003e260)<shown>}
|
||||||
|
%#v: (*main.circular){ui8:(uint8)1 c:(*main.circular)<shown>}
|
||||||
|
%#+v: (*main.circular)(0xf84003e260){ui8:(uint8)1 c:(*main.circular)(0xf84003e260)<shown>}
|
||||||
|
|
||||||
|
See the Printf example for details on the setup of variables being shown
|
||||||
|
here.
|
||||||
|
|
||||||
|
Errors
|
||||||
|
|
||||||
|
Since it is possible for custom Stringer/error interfaces to panic, spew
|
||||||
|
detects them and handles them internally by printing the panic information
|
||||||
|
inline with the output. Since spew is intended to provide deep pretty printing
|
||||||
|
capabilities on structures, it intentionally does not return any errors.
|
||||||
|
*/
|
||||||
|
package spew
|
|
@ -0,0 +1,509 @@
|
||||||
|
/*
|
||||||
|
* Copyright (c) 2013 Dave Collins <dave@davec.name>
|
||||||
|
*
|
||||||
|
* Permission to use, copy, modify, and distribute this software for any
|
||||||
|
* purpose with or without fee is hereby granted, provided that the above
|
||||||
|
* copyright notice and this permission notice appear in all copies.
|
||||||
|
*
|
||||||
|
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
||||||
|
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
||||||
|
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
||||||
|
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
||||||
|
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
||||||
|
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
||||||
|
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package spew
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"encoding/hex"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"os"
|
||||||
|
"reflect"
|
||||||
|
"regexp"
|
||||||
|
"strconv"
|
||||||
|
"strings"
|
||||||
|
)
|
||||||
|
|
||||||
|
var (
|
||||||
|
// uint8Type is a reflect.Type representing a uint8. It is used to
|
||||||
|
// convert cgo types to uint8 slices for hexdumping.
|
||||||
|
uint8Type = reflect.TypeOf(uint8(0))
|
||||||
|
|
||||||
|
// cCharRE is a regular expression that matches a cgo char.
|
||||||
|
// It is used to detect character arrays to hexdump them.
|
||||||
|
cCharRE = regexp.MustCompile("^.*\\._Ctype_char$")
|
||||||
|
|
||||||
|
// cUnsignedCharRE is a regular expression that matches a cgo unsigned
|
||||||
|
// char. It is used to detect unsigned character arrays to hexdump
|
||||||
|
// them.
|
||||||
|
cUnsignedCharRE = regexp.MustCompile("^.*\\._Ctype_unsignedchar$")
|
||||||
|
|
||||||
|
// cUint8tCharRE is a regular expression that matches a cgo uint8_t.
|
||||||
|
// It is used to detect uint8_t arrays to hexdump them.
|
||||||
|
cUint8tCharRE = regexp.MustCompile("^.*\\._Ctype_uint8_t$")
|
||||||
|
)
|
||||||
|
|
||||||
|
// dumpState contains information about the state of a dump operation.
|
||||||
|
type dumpState struct {
|
||||||
|
w io.Writer
|
||||||
|
depth int
|
||||||
|
pointers map[uintptr]int
|
||||||
|
ignoreNextType bool
|
||||||
|
ignoreNextIndent bool
|
||||||
|
cs *ConfigState
|
||||||
|
}
|
||||||
|
|
||||||
|
// indent performs indentation according to the depth level and cs.Indent
|
||||||
|
// option.
|
||||||
|
func (d *dumpState) indent() {
|
||||||
|
if d.ignoreNextIndent {
|
||||||
|
d.ignoreNextIndent = false
|
||||||
|
return
|
||||||
|
}
|
||||||
|
d.w.Write(bytes.Repeat([]byte(d.cs.Indent), d.depth))
|
||||||
|
}
|
||||||
|
|
||||||
|
// unpackValue returns values inside of non-nil interfaces when possible.
|
||||||
|
// This is useful for data types like structs, arrays, slices, and maps which
|
||||||
|
// can contain varying types packed inside an interface.
|
||||||
|
func (d *dumpState) unpackValue(v reflect.Value) reflect.Value {
|
||||||
|
if v.Kind() == reflect.Interface && !v.IsNil() {
|
||||||
|
v = v.Elem()
|
||||||
|
}
|
||||||
|
return v
|
||||||
|
}
|
||||||
|
|
||||||
|
// dumpPtr handles formatting of pointers by indirecting them as necessary.
|
||||||
|
func (d *dumpState) dumpPtr(v reflect.Value) {
|
||||||
|
// Remove pointers at or below the current depth from map used to detect
|
||||||
|
// circular refs.
|
||||||
|
for k, depth := range d.pointers {
|
||||||
|
if depth >= d.depth {
|
||||||
|
delete(d.pointers, k)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Keep list of all dereferenced pointers to show later.
|
||||||
|
pointerChain := make([]uintptr, 0)
|
||||||
|
|
||||||
|
// Figure out how many levels of indirection there are by dereferencing
|
||||||
|
// pointers and unpacking interfaces down the chain while detecting circular
|
||||||
|
// references.
|
||||||
|
nilFound := false
|
||||||
|
cycleFound := false
|
||||||
|
indirects := 0
|
||||||
|
ve := v
|
||||||
|
for ve.Kind() == reflect.Ptr {
|
||||||
|
if ve.IsNil() {
|
||||||
|
nilFound = true
|
||||||
|
break
|
||||||
|
}
|
||||||
|
indirects++
|
||||||
|
addr := ve.Pointer()
|
||||||
|
pointerChain = append(pointerChain, addr)
|
||||||
|
if pd, ok := d.pointers[addr]; ok && pd < d.depth {
|
||||||
|
cycleFound = true
|
||||||
|
indirects--
|
||||||
|
break
|
||||||
|
}
|
||||||
|
d.pointers[addr] = d.depth
|
||||||
|
|
||||||
|
ve = ve.Elem()
|
||||||
|
if ve.Kind() == reflect.Interface {
|
||||||
|
if ve.IsNil() {
|
||||||
|
nilFound = true
|
||||||
|
break
|
||||||
|
}
|
||||||
|
ve = ve.Elem()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Display type information.
|
||||||
|
d.w.Write(openParenBytes)
|
||||||
|
d.w.Write(bytes.Repeat(asteriskBytes, indirects))
|
||||||
|
d.w.Write([]byte(ve.Type().String()))
|
||||||
|
d.w.Write(closeParenBytes)
|
||||||
|
|
||||||
|
// Display pointer information.
|
||||||
|
if !d.cs.DisablePointerAddresses && len(pointerChain) > 0 {
|
||||||
|
d.w.Write(openParenBytes)
|
||||||
|
for i, addr := range pointerChain {
|
||||||
|
if i > 0 {
|
||||||
|
d.w.Write(pointerChainBytes)
|
||||||
|
}
|
||||||
|
printHexPtr(d.w, addr)
|
||||||
|
}
|
||||||
|
d.w.Write(closeParenBytes)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Display dereferenced value.
|
||||||
|
d.w.Write(openParenBytes)
|
||||||
|
switch {
|
||||||
|
case nilFound == true:
|
||||||
|
d.w.Write(nilAngleBytes)
|
||||||
|
|
||||||
|
case cycleFound == true:
|
||||||
|
d.w.Write(circularBytes)
|
||||||
|
|
||||||
|
default:
|
||||||
|
d.ignoreNextType = true
|
||||||
|
d.dump(ve)
|
||||||
|
}
|
||||||
|
d.w.Write(closeParenBytes)
|
||||||
|
}
|
||||||
|
|
||||||
|
// dumpSlice handles formatting of arrays and slices. Byte (uint8 under
|
||||||
|
// reflection) arrays and slices are dumped in hexdump -C fashion.
|
||||||
|
func (d *dumpState) dumpSlice(v reflect.Value) {
|
||||||
|
// Determine whether this type should be hex dumped or not. Also,
|
||||||
|
// for types which should be hexdumped, try to use the underlying data
|
||||||
|
// first, then fall back to trying to convert them to a uint8 slice.
|
||||||
|
var buf []uint8
|
||||||
|
doConvert := false
|
||||||
|
doHexDump := false
|
||||||
|
numEntries := v.Len()
|
||||||
|
if numEntries > 0 {
|
||||||
|
vt := v.Index(0).Type()
|
||||||
|
vts := vt.String()
|
||||||
|
switch {
|
||||||
|
// C types that need to be converted.
|
||||||
|
case cCharRE.MatchString(vts):
|
||||||
|
fallthrough
|
||||||
|
case cUnsignedCharRE.MatchString(vts):
|
||||||
|
fallthrough
|
||||||
|
case cUint8tCharRE.MatchString(vts):
|
||||||
|
doConvert = true
|
||||||
|
|
||||||
|
// Try to use existing uint8 slices and fall back to converting
|
||||||
|
// and copying if that fails.
|
||||||
|
case vt.Kind() == reflect.Uint8:
|
||||||
|
// We need an addressable interface to convert the type
|
||||||
|
// to a byte slice. However, the reflect package won't
|
||||||
|
// give us an interface on certain things like
|
||||||
|
// unexported struct fields in order to enforce
|
||||||
|
// visibility rules. We use unsafe, when available, to
|
||||||
|
// bypass these restrictions since this package does not
|
||||||
|
// mutate the values.
|
||||||
|
vs := v
|
||||||
|
if !vs.CanInterface() || !vs.CanAddr() {
|
||||||
|
vs = unsafeReflectValue(vs)
|
||||||
|
}
|
||||||
|
if !UnsafeDisabled {
|
||||||
|
vs = vs.Slice(0, numEntries)
|
||||||
|
|
||||||
|
// Use the existing uint8 slice if it can be
|
||||||
|
// type asserted.
|
||||||
|
iface := vs.Interface()
|
||||||
|
if slice, ok := iface.([]uint8); ok {
|
||||||
|
buf = slice
|
||||||
|
doHexDump = true
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// The underlying data needs to be converted if it can't
|
||||||
|
// be type asserted to a uint8 slice.
|
||||||
|
doConvert = true
|
||||||
|
}
|
||||||
|
|
||||||
|
// Copy and convert the underlying type if needed.
|
||||||
|
if doConvert && vt.ConvertibleTo(uint8Type) {
|
||||||
|
// Convert and copy each element into a uint8 byte
|
||||||
|
// slice.
|
||||||
|
buf = make([]uint8, numEntries)
|
||||||
|
for i := 0; i < numEntries; i++ {
|
||||||
|
vv := v.Index(i)
|
||||||
|
buf[i] = uint8(vv.Convert(uint8Type).Uint())
|
||||||
|
}
|
||||||
|
doHexDump = true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Hexdump the entire slice as needed.
|
||||||
|
if doHexDump {
|
||||||
|
indent := strings.Repeat(d.cs.Indent, d.depth)
|
||||||
|
str := indent + hex.Dump(buf)
|
||||||
|
str = strings.Replace(str, "\n", "\n"+indent, -1)
|
||||||
|
str = strings.TrimRight(str, d.cs.Indent)
|
||||||
|
d.w.Write([]byte(str))
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// Recursively call dump for each item.
|
||||||
|
for i := 0; i < numEntries; i++ {
|
||||||
|
d.dump(d.unpackValue(v.Index(i)))
|
||||||
|
if i < (numEntries - 1) {
|
||||||
|
d.w.Write(commaNewlineBytes)
|
||||||
|
} else {
|
||||||
|
d.w.Write(newlineBytes)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// dump is the main workhorse for dumping a value. It uses the passed reflect
|
||||||
|
// value to figure out what kind of object we are dealing with and formats it
|
||||||
|
// appropriately. It is a recursive function, however circular data structures
|
||||||
|
// are detected and handled properly.
|
||||||
|
func (d *dumpState) dump(v reflect.Value) {
|
||||||
|
// Handle invalid reflect values immediately.
|
||||||
|
kind := v.Kind()
|
||||||
|
if kind == reflect.Invalid {
|
||||||
|
d.w.Write(invalidAngleBytes)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// Handle pointers specially.
|
||||||
|
if kind == reflect.Ptr {
|
||||||
|
d.indent()
|
||||||
|
d.dumpPtr(v)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// Print type information unless already handled elsewhere.
|
||||||
|
if !d.ignoreNextType {
|
||||||
|
d.indent()
|
||||||
|
d.w.Write(openParenBytes)
|
||||||
|
d.w.Write([]byte(v.Type().String()))
|
||||||
|
d.w.Write(closeParenBytes)
|
||||||
|
d.w.Write(spaceBytes)
|
||||||
|
}
|
||||||
|
d.ignoreNextType = false
|
||||||
|
|
||||||
|
// Display length and capacity if the built-in len and cap functions
|
||||||
|
// work with the value's kind and the len/cap itself is non-zero.
|
||||||
|
valueLen, valueCap := 0, 0
|
||||||
|
switch v.Kind() {
|
||||||
|
case reflect.Array, reflect.Slice, reflect.Chan:
|
||||||
|
valueLen, valueCap = v.Len(), v.Cap()
|
||||||
|
case reflect.Map, reflect.String:
|
||||||
|
valueLen = v.Len()
|
||||||
|
}
|
||||||
|
if valueLen != 0 || !d.cs.DisableCapacities && valueCap != 0 {
|
||||||
|
d.w.Write(openParenBytes)
|
||||||
|
if valueLen != 0 {
|
||||||
|
d.w.Write(lenEqualsBytes)
|
||||||
|
printInt(d.w, int64(valueLen), 10)
|
||||||
|
}
|
||||||
|
if !d.cs.DisableCapacities && valueCap != 0 {
|
||||||
|
if valueLen != 0 {
|
||||||
|
d.w.Write(spaceBytes)
|
||||||
|
}
|
||||||
|
d.w.Write(capEqualsBytes)
|
||||||
|
printInt(d.w, int64(valueCap), 10)
|
||||||
|
}
|
||||||
|
d.w.Write(closeParenBytes)
|
||||||
|
d.w.Write(spaceBytes)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Call Stringer/error interfaces if they exist and the handle methods flag
|
||||||
|
// is enabled
|
||||||
|
if !d.cs.DisableMethods {
|
||||||
|
if (kind != reflect.Invalid) && (kind != reflect.Interface) {
|
||||||
|
if handled := handleMethods(d.cs, d.w, v); handled {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
switch kind {
|
||||||
|
case reflect.Invalid:
|
||||||
|
// Do nothing. We should never get here since invalid has already
|
||||||
|
// been handled above.
|
||||||
|
|
||||||
|
case reflect.Bool:
|
||||||
|
printBool(d.w, v.Bool())
|
||||||
|
|
||||||
|
case reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64, reflect.Int:
|
||||||
|
printInt(d.w, v.Int(), 10)
|
||||||
|
|
||||||
|
case reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64, reflect.Uint:
|
||||||
|
printUint(d.w, v.Uint(), 10)
|
||||||
|
|
||||||
|
case reflect.Float32:
|
||||||
|
printFloat(d.w, v.Float(), 32)
|
||||||
|
|
||||||
|
case reflect.Float64:
|
||||||
|
printFloat(d.w, v.Float(), 64)
|
||||||
|
|
||||||
|
case reflect.Complex64:
|
||||||
|
printComplex(d.w, v.Complex(), 32)
|
||||||
|
|
||||||
|
case reflect.Complex128:
|
||||||
|
printComplex(d.w, v.Complex(), 64)
|
||||||
|
|
||||||
|
case reflect.Slice:
|
||||||
|
if v.IsNil() {
|
||||||
|
d.w.Write(nilAngleBytes)
|
||||||
|
break
|
||||||
|
}
|
||||||
|
fallthrough
|
||||||
|
|
||||||
|
case reflect.Array:
|
||||||
|
d.w.Write(openBraceNewlineBytes)
|
||||||
|
d.depth++
|
||||||
|
if (d.cs.MaxDepth != 0) && (d.depth > d.cs.MaxDepth) {
|
||||||
|
d.indent()
|
||||||
|
d.w.Write(maxNewlineBytes)
|
||||||
|
} else {
|
||||||
|
d.dumpSlice(v)
|
||||||
|
}
|
||||||
|
d.depth--
|
||||||
|
d.indent()
|
||||||
|
d.w.Write(closeBraceBytes)
|
||||||
|
|
||||||
|
case reflect.String:
|
||||||
|
d.w.Write([]byte(strconv.Quote(v.String())))
|
||||||
|
|
||||||
|
case reflect.Interface:
|
||||||
|
// The only time we should get here is for nil interfaces due to
|
||||||
|
// unpackValue calls.
|
||||||
|
if v.IsNil() {
|
||||||
|
d.w.Write(nilAngleBytes)
|
||||||
|
}
|
||||||
|
|
||||||
|
case reflect.Ptr:
|
||||||
|
// Do nothing. We should never get here since pointers have already
|
||||||
|
// been handled above.
|
||||||
|
|
||||||
|
case reflect.Map:
|
||||||
|
// nil maps should be indicated as different than empty maps
|
||||||
|
if v.IsNil() {
|
||||||
|
d.w.Write(nilAngleBytes)
|
||||||
|
break
|
||||||
|
}
|
||||||
|
|
||||||
|
d.w.Write(openBraceNewlineBytes)
|
||||||
|
d.depth++
|
||||||
|
if (d.cs.MaxDepth != 0) && (d.depth > d.cs.MaxDepth) {
|
||||||
|
d.indent()
|
||||||
|
d.w.Write(maxNewlineBytes)
|
||||||
|
} else {
|
||||||
|
numEntries := v.Len()
|
||||||
|
keys := v.MapKeys()
|
||||||
|
if d.cs.SortKeys {
|
||||||
|
sortValues(keys, d.cs)
|
||||||
|
}
|
||||||
|
for i, key := range keys {
|
||||||
|
d.dump(d.unpackValue(key))
|
||||||
|
d.w.Write(colonSpaceBytes)
|
||||||
|
d.ignoreNextIndent = true
|
||||||
|
d.dump(d.unpackValue(v.MapIndex(key)))
|
||||||
|
if i < (numEntries - 1) {
|
||||||
|
d.w.Write(commaNewlineBytes)
|
||||||
|
} else {
|
||||||
|
d.w.Write(newlineBytes)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
d.depth--
|
||||||
|
d.indent()
|
||||||
|
d.w.Write(closeBraceBytes)
|
||||||
|
|
||||||
|
case reflect.Struct:
|
||||||
|
d.w.Write(openBraceNewlineBytes)
|
||||||
|
d.depth++
|
||||||
|
if (d.cs.MaxDepth != 0) && (d.depth > d.cs.MaxDepth) {
|
||||||
|
d.indent()
|
||||||
|
d.w.Write(maxNewlineBytes)
|
||||||
|
} else {
|
||||||
|
vt := v.Type()
|
||||||
|
numFields := v.NumField()
|
||||||
|
for i := 0; i < numFields; i++ {
|
||||||
|
d.indent()
|
||||||
|
vtf := vt.Field(i)
|
||||||
|
d.w.Write([]byte(vtf.Name))
|
||||||
|
d.w.Write(colonSpaceBytes)
|
||||||
|
d.ignoreNextIndent = true
|
||||||
|
d.dump(d.unpackValue(v.Field(i)))
|
||||||
|
if i < (numFields - 1) {
|
||||||
|
d.w.Write(commaNewlineBytes)
|
||||||
|
} else {
|
||||||
|
d.w.Write(newlineBytes)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
d.depth--
|
||||||
|
d.indent()
|
||||||
|
d.w.Write(closeBraceBytes)
|
||||||
|
|
||||||
|
case reflect.Uintptr:
|
||||||
|
printHexPtr(d.w, uintptr(v.Uint()))
|
||||||
|
|
||||||
|
case reflect.UnsafePointer, reflect.Chan, reflect.Func:
|
||||||
|
printHexPtr(d.w, v.Pointer())
|
||||||
|
|
||||||
|
// There were not any other types at the time this code was written, but
|
||||||
|
// fall back to letting the default fmt package handle it in case any new
|
||||||
|
// types are added.
|
||||||
|
default:
|
||||||
|
if v.CanInterface() {
|
||||||
|
fmt.Fprintf(d.w, "%v", v.Interface())
|
||||||
|
} else {
|
||||||
|
fmt.Fprintf(d.w, "%v", v.String())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// fdump is a helper function to consolidate the logic from the various public
|
||||||
|
// methods which take varying writers and config states.
|
||||||
|
func fdump(cs *ConfigState, w io.Writer, a ...interface{}) {
|
||||||
|
for _, arg := range a {
|
||||||
|
if arg == nil {
|
||||||
|
w.Write(interfaceBytes)
|
||||||
|
w.Write(spaceBytes)
|
||||||
|
w.Write(nilAngleBytes)
|
||||||
|
w.Write(newlineBytes)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
d := dumpState{w: w, cs: cs}
|
||||||
|
d.pointers = make(map[uintptr]int)
|
||||||
|
d.dump(reflect.ValueOf(arg))
|
||||||
|
d.w.Write(newlineBytes)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Fdump formats and displays the passed arguments to io.Writer w. It formats
|
||||||
|
// exactly the same as Dump.
|
||||||
|
func Fdump(w io.Writer, a ...interface{}) {
|
||||||
|
fdump(&Config, w, a...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Sdump returns a string with the passed arguments formatted exactly the same
|
||||||
|
// as Dump.
|
||||||
|
func Sdump(a ...interface{}) string {
|
||||||
|
var buf bytes.Buffer
|
||||||
|
fdump(&Config, &buf, a...)
|
||||||
|
return buf.String()
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
Dump displays the passed parameters to standard out with newlines, customizable
|
||||||
|
indentation, and additional debug information such as complete types and all
|
||||||
|
pointer addresses used to indirect to the final value. It provides the
|
||||||
|
following features over the built-in printing facilities provided by the fmt
|
||||||
|
package:
|
||||||
|
|
||||||
|
* Pointers are dereferenced and followed
|
||||||
|
* Circular data structures are detected and handled properly
|
||||||
|
* Custom Stringer/error interfaces are optionally invoked, including
|
||||||
|
on unexported types
|
||||||
|
* Custom types which only implement the Stringer/error interfaces via
|
||||||
|
a pointer receiver are optionally invoked when passing non-pointer
|
||||||
|
variables
|
||||||
|
* Byte arrays and slices are dumped like the hexdump -C command which
|
||||||
|
includes offsets, byte values in hex, and ASCII output
|
||||||
|
|
||||||
|
The configuration options are controlled by an exported package global,
|
||||||
|
spew.Config. See ConfigState for options documentation.
|
||||||
|
|
||||||
|
See Fdump if you would prefer dumping to an arbitrary io.Writer or Sdump to
|
||||||
|
get the formatted result as a string.
|
||||||
|
*/
|
||||||
|
func Dump(a ...interface{}) {
|
||||||
|
fdump(&Config, os.Stdout, a...)
|
||||||
|
}
|
|
@ -0,0 +1,419 @@
|
||||||
|
/*
|
||||||
|
* Copyright (c) 2013 Dave Collins <dave@davec.name>
|
||||||
|
*
|
||||||
|
* Permission to use, copy, modify, and distribute this software for any
|
||||||
|
* purpose with or without fee is hereby granted, provided that the above
|
||||||
|
* copyright notice and this permission notice appear in all copies.
|
||||||
|
*
|
||||||
|
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
||||||
|
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
||||||
|
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
||||||
|
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
||||||
|
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
||||||
|
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
||||||
|
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package spew
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"fmt"
|
||||||
|
"reflect"
|
||||||
|
"strconv"
|
||||||
|
"strings"
|
||||||
|
)
|
||||||
|
|
||||||
|
// supportedFlags is a list of all the character flags supported by fmt package.
|
||||||
|
const supportedFlags = "0-+# "
|
||||||
|
|
||||||
|
// formatState implements the fmt.Formatter interface and contains information
|
||||||
|
// about the state of a formatting operation. The NewFormatter function can
|
||||||
|
// be used to get a new Formatter which can be used directly as arguments
|
||||||
|
// in standard fmt package printing calls.
|
||||||
|
type formatState struct {
|
||||||
|
value interface{}
|
||||||
|
fs fmt.State
|
||||||
|
depth int
|
||||||
|
pointers map[uintptr]int
|
||||||
|
ignoreNextType bool
|
||||||
|
cs *ConfigState
|
||||||
|
}
|
||||||
|
|
||||||
|
// buildDefaultFormat recreates the original format string without precision
|
||||||
|
// and width information to pass in to fmt.Sprintf in the case of an
|
||||||
|
// unrecognized type. Unless new types are added to the language, this
|
||||||
|
// function won't ever be called.
|
||||||
|
func (f *formatState) buildDefaultFormat() (format string) {
|
||||||
|
buf := bytes.NewBuffer(percentBytes)
|
||||||
|
|
||||||
|
for _, flag := range supportedFlags {
|
||||||
|
if f.fs.Flag(int(flag)) {
|
||||||
|
buf.WriteRune(flag)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
buf.WriteRune('v')
|
||||||
|
|
||||||
|
format = buf.String()
|
||||||
|
return format
|
||||||
|
}
|
||||||
|
|
||||||
|
// constructOrigFormat recreates the original format string including precision
|
||||||
|
// and width information to pass along to the standard fmt package. This allows
|
||||||
|
// automatic deferral of all format strings this package doesn't support.
|
||||||
|
func (f *formatState) constructOrigFormat(verb rune) (format string) {
|
||||||
|
buf := bytes.NewBuffer(percentBytes)
|
||||||
|
|
||||||
|
for _, flag := range supportedFlags {
|
||||||
|
if f.fs.Flag(int(flag)) {
|
||||||
|
buf.WriteRune(flag)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if width, ok := f.fs.Width(); ok {
|
||||||
|
buf.WriteString(strconv.Itoa(width))
|
||||||
|
}
|
||||||
|
|
||||||
|
if precision, ok := f.fs.Precision(); ok {
|
||||||
|
buf.Write(precisionBytes)
|
||||||
|
buf.WriteString(strconv.Itoa(precision))
|
||||||
|
}
|
||||||
|
|
||||||
|
buf.WriteRune(verb)
|
||||||
|
|
||||||
|
format = buf.String()
|
||||||
|
return format
|
||||||
|
}
|
||||||
|
|
||||||
|
// unpackValue returns values inside of non-nil interfaces when possible and
|
||||||
|
// ensures that types for values which have been unpacked from an interface
|
||||||
|
// are displayed when the show types flag is also set.
|
||||||
|
// This is useful for data types like structs, arrays, slices, and maps which
|
||||||
|
// can contain varying types packed inside an interface.
|
||||||
|
func (f *formatState) unpackValue(v reflect.Value) reflect.Value {
|
||||||
|
if v.Kind() == reflect.Interface {
|
||||||
|
f.ignoreNextType = false
|
||||||
|
if !v.IsNil() {
|
||||||
|
v = v.Elem()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return v
|
||||||
|
}
|
||||||
|
|
||||||
|
// formatPtr handles formatting of pointers by indirecting them as necessary.
|
||||||
|
func (f *formatState) formatPtr(v reflect.Value) {
|
||||||
|
// Display nil if top level pointer is nil.
|
||||||
|
showTypes := f.fs.Flag('#')
|
||||||
|
if v.IsNil() && (!showTypes || f.ignoreNextType) {
|
||||||
|
f.fs.Write(nilAngleBytes)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// Remove pointers at or below the current depth from map used to detect
|
||||||
|
// circular refs.
|
||||||
|
for k, depth := range f.pointers {
|
||||||
|
if depth >= f.depth {
|
||||||
|
delete(f.pointers, k)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Keep list of all dereferenced pointers to possibly show later.
|
||||||
|
pointerChain := make([]uintptr, 0)
|
||||||
|
|
||||||
|
// Figure out how many levels of indirection there are by derferencing
|
||||||
|
// pointers and unpacking interfaces down the chain while detecting circular
|
||||||
|
// references.
|
||||||
|
nilFound := false
|
||||||
|
cycleFound := false
|
||||||
|
indirects := 0
|
||||||
|
ve := v
|
||||||
|
for ve.Kind() == reflect.Ptr {
|
||||||
|
if ve.IsNil() {
|
||||||
|
nilFound = true
|
||||||
|
break
|
||||||
|
}
|
||||||
|
indirects++
|
||||||
|
addr := ve.Pointer()
|
||||||
|
pointerChain = append(pointerChain, addr)
|
||||||
|
if pd, ok := f.pointers[addr]; ok && pd < f.depth {
|
||||||
|
cycleFound = true
|
||||||
|
indirects--
|
||||||
|
break
|
||||||
|
}
|
||||||
|
f.pointers[addr] = f.depth
|
||||||
|
|
||||||
|
ve = ve.Elem()
|
||||||
|
if ve.Kind() == reflect.Interface {
|
||||||
|
if ve.IsNil() {
|
||||||
|
nilFound = true
|
||||||
|
break
|
||||||
|
}
|
||||||
|
ve = ve.Elem()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Display type or indirection level depending on flags.
|
||||||
|
if showTypes && !f.ignoreNextType {
|
||||||
|
f.fs.Write(openParenBytes)
|
||||||
|
f.fs.Write(bytes.Repeat(asteriskBytes, indirects))
|
||||||
|
f.fs.Write([]byte(ve.Type().String()))
|
||||||
|
f.fs.Write(closeParenBytes)
|
||||||
|
} else {
|
||||||
|
if nilFound || cycleFound {
|
||||||
|
indirects += strings.Count(ve.Type().String(), "*")
|
||||||
|
}
|
||||||
|
f.fs.Write(openAngleBytes)
|
||||||
|
f.fs.Write([]byte(strings.Repeat("*", indirects)))
|
||||||
|
f.fs.Write(closeAngleBytes)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Display pointer information depending on flags.
|
||||||
|
if f.fs.Flag('+') && (len(pointerChain) > 0) {
|
||||||
|
f.fs.Write(openParenBytes)
|
||||||
|
for i, addr := range pointerChain {
|
||||||
|
if i > 0 {
|
||||||
|
f.fs.Write(pointerChainBytes)
|
||||||
|
}
|
||||||
|
printHexPtr(f.fs, addr)
|
||||||
|
}
|
||||||
|
f.fs.Write(closeParenBytes)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Display dereferenced value.
|
||||||
|
switch {
|
||||||
|
case nilFound == true:
|
||||||
|
f.fs.Write(nilAngleBytes)
|
||||||
|
|
||||||
|
case cycleFound == true:
|
||||||
|
f.fs.Write(circularShortBytes)
|
||||||
|
|
||||||
|
default:
|
||||||
|
f.ignoreNextType = true
|
||||||
|
f.format(ve)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// format is the main workhorse for providing the Formatter interface. It
|
||||||
|
// uses the passed reflect value to figure out what kind of object we are
|
||||||
|
// dealing with and formats it appropriately. It is a recursive function,
|
||||||
|
// however circular data structures are detected and handled properly.
|
||||||
|
func (f *formatState) format(v reflect.Value) {
|
||||||
|
// Handle invalid reflect values immediately.
|
||||||
|
kind := v.Kind()
|
||||||
|
if kind == reflect.Invalid {
|
||||||
|
f.fs.Write(invalidAngleBytes)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// Handle pointers specially.
|
||||||
|
if kind == reflect.Ptr {
|
||||||
|
f.formatPtr(v)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// Print type information unless already handled elsewhere.
|
||||||
|
if !f.ignoreNextType && f.fs.Flag('#') {
|
||||||
|
f.fs.Write(openParenBytes)
|
||||||
|
f.fs.Write([]byte(v.Type().String()))
|
||||||
|
f.fs.Write(closeParenBytes)
|
||||||
|
}
|
||||||
|
f.ignoreNextType = false
|
||||||
|
|
||||||
|
// Call Stringer/error interfaces if they exist and the handle methods
|
||||||
|
// flag is enabled.
|
||||||
|
if !f.cs.DisableMethods {
|
||||||
|
if (kind != reflect.Invalid) && (kind != reflect.Interface) {
|
||||||
|
if handled := handleMethods(f.cs, f.fs, v); handled {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
switch kind {
|
||||||
|
case reflect.Invalid:
|
||||||
|
// Do nothing. We should never get here since invalid has already
|
||||||
|
// been handled above.
|
||||||
|
|
||||||
|
case reflect.Bool:
|
||||||
|
printBool(f.fs, v.Bool())
|
||||||
|
|
||||||
|
case reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64, reflect.Int:
|
||||||
|
printInt(f.fs, v.Int(), 10)
|
||||||
|
|
||||||
|
case reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64, reflect.Uint:
|
||||||
|
printUint(f.fs, v.Uint(), 10)
|
||||||
|
|
||||||
|
case reflect.Float32:
|
||||||
|
printFloat(f.fs, v.Float(), 32)
|
||||||
|
|
||||||
|
case reflect.Float64:
|
||||||
|
printFloat(f.fs, v.Float(), 64)
|
||||||
|
|
||||||
|
case reflect.Complex64:
|
||||||
|
printComplex(f.fs, v.Complex(), 32)
|
||||||
|
|
||||||
|
case reflect.Complex128:
|
||||||
|
printComplex(f.fs, v.Complex(), 64)
|
||||||
|
|
||||||
|
case reflect.Slice:
|
||||||
|
if v.IsNil() {
|
||||||
|
f.fs.Write(nilAngleBytes)
|
||||||
|
break
|
||||||
|
}
|
||||||
|
fallthrough
|
||||||
|
|
||||||
|
case reflect.Array:
|
||||||
|
f.fs.Write(openBracketBytes)
|
||||||
|
f.depth++
|
||||||
|
if (f.cs.MaxDepth != 0) && (f.depth > f.cs.MaxDepth) {
|
||||||
|
f.fs.Write(maxShortBytes)
|
||||||
|
} else {
|
||||||
|
numEntries := v.Len()
|
||||||
|
for i := 0; i < numEntries; i++ {
|
||||||
|
if i > 0 {
|
||||||
|
f.fs.Write(spaceBytes)
|
||||||
|
}
|
||||||
|
f.ignoreNextType = true
|
||||||
|
f.format(f.unpackValue(v.Index(i)))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
f.depth--
|
||||||
|
f.fs.Write(closeBracketBytes)
|
||||||
|
|
||||||
|
case reflect.String:
|
||||||
|
f.fs.Write([]byte(v.String()))
|
||||||
|
|
||||||
|
case reflect.Interface:
|
||||||
|
// The only time we should get here is for nil interfaces due to
|
||||||
|
// unpackValue calls.
|
||||||
|
if v.IsNil() {
|
||||||
|
f.fs.Write(nilAngleBytes)
|
||||||
|
}
|
||||||
|
|
||||||
|
case reflect.Ptr:
|
||||||
|
// Do nothing. We should never get here since pointers have already
|
||||||
|
// been handled above.
|
||||||
|
|
||||||
|
case reflect.Map:
|
||||||
|
// nil maps should be indicated as different than empty maps
|
||||||
|
if v.IsNil() {
|
||||||
|
f.fs.Write(nilAngleBytes)
|
||||||
|
break
|
||||||
|
}
|
||||||
|
|
||||||
|
f.fs.Write(openMapBytes)
|
||||||
|
f.depth++
|
||||||
|
if (f.cs.MaxDepth != 0) && (f.depth > f.cs.MaxDepth) {
|
||||||
|
f.fs.Write(maxShortBytes)
|
||||||
|
} else {
|
||||||
|
keys := v.MapKeys()
|
||||||
|
if f.cs.SortKeys {
|
||||||
|
sortValues(keys, f.cs)
|
||||||
|
}
|
||||||
|
for i, key := range keys {
|
||||||
|
if i > 0 {
|
||||||
|
f.fs.Write(spaceBytes)
|
||||||
|
}
|
||||||
|
f.ignoreNextType = true
|
||||||
|
f.format(f.unpackValue(key))
|
||||||
|
f.fs.Write(colonBytes)
|
||||||
|
f.ignoreNextType = true
|
||||||
|
f.format(f.unpackValue(v.MapIndex(key)))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
f.depth--
|
||||||
|
f.fs.Write(closeMapBytes)
|
||||||
|
|
||||||
|
case reflect.Struct:
|
||||||
|
numFields := v.NumField()
|
||||||
|
f.fs.Write(openBraceBytes)
|
||||||
|
f.depth++
|
||||||
|
if (f.cs.MaxDepth != 0) && (f.depth > f.cs.MaxDepth) {
|
||||||
|
f.fs.Write(maxShortBytes)
|
||||||
|
} else {
|
||||||
|
vt := v.Type()
|
||||||
|
for i := 0; i < numFields; i++ {
|
||||||
|
if i > 0 {
|
||||||
|
f.fs.Write(spaceBytes)
|
||||||
|
}
|
||||||
|
vtf := vt.Field(i)
|
||||||
|
if f.fs.Flag('+') || f.fs.Flag('#') {
|
||||||
|
f.fs.Write([]byte(vtf.Name))
|
||||||
|
f.fs.Write(colonBytes)
|
||||||
|
}
|
||||||
|
f.format(f.unpackValue(v.Field(i)))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
f.depth--
|
||||||
|
f.fs.Write(closeBraceBytes)
|
||||||
|
|
||||||
|
case reflect.Uintptr:
|
||||||
|
printHexPtr(f.fs, uintptr(v.Uint()))
|
||||||
|
|
||||||
|
case reflect.UnsafePointer, reflect.Chan, reflect.Func:
|
||||||
|
printHexPtr(f.fs, v.Pointer())
|
||||||
|
|
||||||
|
// There were not any other types at the time this code was written, but
|
||||||
|
// fall back to letting the default fmt package handle it if any get added.
|
||||||
|
default:
|
||||||
|
format := f.buildDefaultFormat()
|
||||||
|
if v.CanInterface() {
|
||||||
|
fmt.Fprintf(f.fs, format, v.Interface())
|
||||||
|
} else {
|
||||||
|
fmt.Fprintf(f.fs, format, v.String())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Format satisfies the fmt.Formatter interface. See NewFormatter for usage
|
||||||
|
// details.
|
||||||
|
func (f *formatState) Format(fs fmt.State, verb rune) {
|
||||||
|
f.fs = fs
|
||||||
|
|
||||||
|
// Use standard formatting for verbs that are not v.
|
||||||
|
if verb != 'v' {
|
||||||
|
format := f.constructOrigFormat(verb)
|
||||||
|
fmt.Fprintf(fs, format, f.value)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
if f.value == nil {
|
||||||
|
if fs.Flag('#') {
|
||||||
|
fs.Write(interfaceBytes)
|
||||||
|
}
|
||||||
|
fs.Write(nilAngleBytes)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
f.format(reflect.ValueOf(f.value))
|
||||||
|
}
|
||||||
|
|
||||||
|
// newFormatter is a helper function to consolidate the logic from the various
|
||||||
|
// public methods which take varying config states.
|
||||||
|
func newFormatter(cs *ConfigState, v interface{}) fmt.Formatter {
|
||||||
|
fs := &formatState{value: v, cs: cs}
|
||||||
|
fs.pointers = make(map[uintptr]int)
|
||||||
|
return fs
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
NewFormatter returns a custom formatter that satisfies the fmt.Formatter
|
||||||
|
interface. As a result, it integrates cleanly with standard fmt package
|
||||||
|
printing functions. The formatter is useful for inline printing of smaller data
|
||||||
|
types similar to the standard %v format specifier.
|
||||||
|
|
||||||
|
The custom formatter only responds to the %v (most compact), %+v (adds pointer
|
||||||
|
addresses), %#v (adds types), or %#+v (adds types and pointer addresses) verb
|
||||||
|
combinations. Any other verbs such as %x and %q will be sent to the the
|
||||||
|
standard fmt package for formatting. In addition, the custom formatter ignores
|
||||||
|
the width and precision arguments (however they will still work on the format
|
||||||
|
specifiers not handled by the custom formatter).
|
||||||
|
|
||||||
|
Typically this function shouldn't be called directly. It is much easier to make
|
||||||
|
use of the custom formatter by calling one of the convenience functions such as
|
||||||
|
Printf, Println, or Fprintf.
|
||||||
|
*/
|
||||||
|
func NewFormatter(v interface{}) fmt.Formatter {
|
||||||
|
return newFormatter(&Config, v)
|
||||||
|
}
|
|
@ -0,0 +1,148 @@
|
||||||
|
/*
|
||||||
|
* Copyright (c) 2013 Dave Collins <dave@davec.name>
|
||||||
|
*
|
||||||
|
* Permission to use, copy, modify, and distribute this software for any
|
||||||
|
* purpose with or without fee is hereby granted, provided that the above
|
||||||
|
* copyright notice and this permission notice appear in all copies.
|
||||||
|
*
|
||||||
|
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
||||||
|
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
||||||
|
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
||||||
|
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
||||||
|
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
||||||
|
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
||||||
|
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package spew
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Errorf is a wrapper for fmt.Errorf that treats each argument as if it were
|
||||||
|
// passed with a default Formatter interface returned by NewFormatter. It
|
||||||
|
// returns the formatted string as a value that satisfies error. See
|
||||||
|
// NewFormatter for formatting details.
|
||||||
|
//
|
||||||
|
// This function is shorthand for the following syntax:
|
||||||
|
//
|
||||||
|
// fmt.Errorf(format, spew.NewFormatter(a), spew.NewFormatter(b))
|
||||||
|
func Errorf(format string, a ...interface{}) (err error) {
|
||||||
|
return fmt.Errorf(format, convertArgs(a)...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Fprint is a wrapper for fmt.Fprint that treats each argument as if it were
|
||||||
|
// passed with a default Formatter interface returned by NewFormatter. It
|
||||||
|
// returns the number of bytes written and any write error encountered. See
|
||||||
|
// NewFormatter for formatting details.
|
||||||
|
//
|
||||||
|
// This function is shorthand for the following syntax:
|
||||||
|
//
|
||||||
|
// fmt.Fprint(w, spew.NewFormatter(a), spew.NewFormatter(b))
|
||||||
|
func Fprint(w io.Writer, a ...interface{}) (n int, err error) {
|
||||||
|
return fmt.Fprint(w, convertArgs(a)...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Fprintf is a wrapper for fmt.Fprintf that treats each argument as if it were
|
||||||
|
// passed with a default Formatter interface returned by NewFormatter. It
|
||||||
|
// returns the number of bytes written and any write error encountered. See
|
||||||
|
// NewFormatter for formatting details.
|
||||||
|
//
|
||||||
|
// This function is shorthand for the following syntax:
|
||||||
|
//
|
||||||
|
// fmt.Fprintf(w, format, spew.NewFormatter(a), spew.NewFormatter(b))
|
||||||
|
func Fprintf(w io.Writer, format string, a ...interface{}) (n int, err error) {
|
||||||
|
return fmt.Fprintf(w, format, convertArgs(a)...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Fprintln is a wrapper for fmt.Fprintln that treats each argument as if it
|
||||||
|
// passed with a default Formatter interface returned by NewFormatter. See
|
||||||
|
// NewFormatter for formatting details.
|
||||||
|
//
|
||||||
|
// This function is shorthand for the following syntax:
|
||||||
|
//
|
||||||
|
// fmt.Fprintln(w, spew.NewFormatter(a), spew.NewFormatter(b))
|
||||||
|
func Fprintln(w io.Writer, a ...interface{}) (n int, err error) {
|
||||||
|
return fmt.Fprintln(w, convertArgs(a)...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Print is a wrapper for fmt.Print that treats each argument as if it were
|
||||||
|
// passed with a default Formatter interface returned by NewFormatter. It
|
||||||
|
// returns the number of bytes written and any write error encountered. See
|
||||||
|
// NewFormatter for formatting details.
|
||||||
|
//
|
||||||
|
// This function is shorthand for the following syntax:
|
||||||
|
//
|
||||||
|
// fmt.Print(spew.NewFormatter(a), spew.NewFormatter(b))
|
||||||
|
func Print(a ...interface{}) (n int, err error) {
|
||||||
|
return fmt.Print(convertArgs(a)...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Printf is a wrapper for fmt.Printf that treats each argument as if it were
|
||||||
|
// passed with a default Formatter interface returned by NewFormatter. It
|
||||||
|
// returns the number of bytes written and any write error encountered. See
|
||||||
|
// NewFormatter for formatting details.
|
||||||
|
//
|
||||||
|
// This function is shorthand for the following syntax:
|
||||||
|
//
|
||||||
|
// fmt.Printf(format, spew.NewFormatter(a), spew.NewFormatter(b))
|
||||||
|
func Printf(format string, a ...interface{}) (n int, err error) {
|
||||||
|
return fmt.Printf(format, convertArgs(a)...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Println is a wrapper for fmt.Println that treats each argument as if it were
|
||||||
|
// passed with a default Formatter interface returned by NewFormatter. It
|
||||||
|
// returns the number of bytes written and any write error encountered. See
|
||||||
|
// NewFormatter for formatting details.
|
||||||
|
//
|
||||||
|
// This function is shorthand for the following syntax:
|
||||||
|
//
|
||||||
|
// fmt.Println(spew.NewFormatter(a), spew.NewFormatter(b))
|
||||||
|
func Println(a ...interface{}) (n int, err error) {
|
||||||
|
return fmt.Println(convertArgs(a)...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Sprint is a wrapper for fmt.Sprint that treats each argument as if it were
|
||||||
|
// passed with a default Formatter interface returned by NewFormatter. It
|
||||||
|
// returns the resulting string. See NewFormatter for formatting details.
|
||||||
|
//
|
||||||
|
// This function is shorthand for the following syntax:
|
||||||
|
//
|
||||||
|
// fmt.Sprint(spew.NewFormatter(a), spew.NewFormatter(b))
|
||||||
|
func Sprint(a ...interface{}) string {
|
||||||
|
return fmt.Sprint(convertArgs(a)...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Sprintf is a wrapper for fmt.Sprintf that treats each argument as if it were
|
||||||
|
// passed with a default Formatter interface returned by NewFormatter. It
|
||||||
|
// returns the resulting string. See NewFormatter for formatting details.
|
||||||
|
//
|
||||||
|
// This function is shorthand for the following syntax:
|
||||||
|
//
|
||||||
|
// fmt.Sprintf(format, spew.NewFormatter(a), spew.NewFormatter(b))
|
||||||
|
func Sprintf(format string, a ...interface{}) string {
|
||||||
|
return fmt.Sprintf(format, convertArgs(a)...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Sprintln is a wrapper for fmt.Sprintln that treats each argument as if it
|
||||||
|
// were passed with a default Formatter interface returned by NewFormatter. It
|
||||||
|
// returns the resulting string. See NewFormatter for formatting details.
|
||||||
|
//
|
||||||
|
// This function is shorthand for the following syntax:
|
||||||
|
//
|
||||||
|
// fmt.Sprintln(spew.NewFormatter(a), spew.NewFormatter(b))
|
||||||
|
func Sprintln(a ...interface{}) string {
|
||||||
|
return fmt.Sprintln(convertArgs(a)...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// convertArgs accepts a slice of arguments and returns a slice of the same
|
||||||
|
// length with each argument converted to a default spew Formatter interface.
|
||||||
|
func convertArgs(args []interface{}) (formatters []interface{}) {
|
||||||
|
formatters = make([]interface{}, len(args))
|
||||||
|
for index, arg := range args {
|
||||||
|
formatters[index] = NewFormatter(arg)
|
||||||
|
}
|
||||||
|
return formatters
|
||||||
|
}
|
|
@ -0,0 +1,28 @@
|
||||||
|
Copyright (c) 2016 Georgi Valkov. All rights reserved.
|
||||||
|
|
||||||
|
Redistribution and use in source and binary forms, with or without
|
||||||
|
modification, are permitted provided that the following conditions are
|
||||||
|
met:
|
||||||
|
|
||||||
|
1. Redistributions of source code must retain the above copyright
|
||||||
|
notice, this list of conditions and the following disclaimer.
|
||||||
|
|
||||||
|
2. Redistributions in binary form must reproduce the above copyright
|
||||||
|
notice, this list of conditions and the following disclaimer in
|
||||||
|
the documentation and/or other materials provided with the
|
||||||
|
distribution.
|
||||||
|
|
||||||
|
3. Neither the name of author nor the names of its contributors may
|
||||||
|
be used to endorse or promote products derived from this software
|
||||||
|
without specific prior written permission.
|
||||||
|
|
||||||
|
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
|
||||||
|
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
||||||
|
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||||
|
DISCLAIMED. IN NO EVENT SHALL GEORGI VALKOV BE LIABLE FOR ANY
|
||||||
|
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
||||||
|
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
||||||
|
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
|
||||||
|
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||||
|
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
||||||
|
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
@ -0,0 +1,9 @@
|
||||||
|
all: ecodes.go
|
||||||
|
|
||||||
|
HEADERS = /usr/include/linux/input.h
|
||||||
|
HEADERS += /usr/include/linux/input-event-codes.h
|
||||||
|
|
||||||
|
ecodes.go: ecodes.go.template
|
||||||
|
./bin/genecodes.py $(HEADERS) $< > $@
|
||||||
|
|
||||||
|
.PHONY: ecodes.go
|
|
@ -0,0 +1,13 @@
|
||||||
|
*golang-evdev*
|
||||||
|
--------------
|
||||||
|
|
||||||
|
This package provides Go language bindings to the generic input event
|
||||||
|
interface in Linux. The *evdev* interface serves the purpose of
|
||||||
|
passing events generated in the kernel directly to userspace through
|
||||||
|
character devices that are typically located in `/dev/input/`.
|
||||||
|
|
||||||
|
Documentation:
|
||||||
|
http://godoc.org/github.com/gvalkov/golang-evdev
|
||||||
|
|
||||||
|
Development:
|
||||||
|
https://github.com/gvalkov/golang-evdev
|
|
@ -0,0 +1,50 @@
|
||||||
|
package evdev
|
||||||
|
|
||||||
|
// Bits and pieces from asm-generic/ioctl.h
|
||||||
|
import (
|
||||||
|
"syscall"
|
||||||
|
"unsafe"
|
||||||
|
)
|
||||||
|
|
||||||
|
const (
|
||||||
|
_IOC_NONE = 0x0
|
||||||
|
_IOC_WRITE = 0x1
|
||||||
|
_IOC_READ = 0x2
|
||||||
|
|
||||||
|
_IOC_NRBITS = 8
|
||||||
|
_IOC_TYPEBITS = 8
|
||||||
|
_IOC_SIZEBITS = 14
|
||||||
|
_IOC_DIRBITS = 2
|
||||||
|
_IOC_NRSHIFT = 0
|
||||||
|
|
||||||
|
_IOC_TYPESHIFT = _IOC_NRSHIFT + _IOC_NRBITS
|
||||||
|
_IOC_SIZESHIFT = _IOC_TYPESHIFT + _IOC_TYPEBITS
|
||||||
|
_IOC_DIRSHIFT = _IOC_SIZESHIFT + _IOC_SIZEBITS
|
||||||
|
)
|
||||||
|
|
||||||
|
func _IOC(dir int, t int, nr int, size int) int {
|
||||||
|
return (dir << _IOC_DIRSHIFT) | (t << _IOC_TYPESHIFT) |
|
||||||
|
(nr << _IOC_NRSHIFT) | (size << _IOC_SIZESHIFT)
|
||||||
|
}
|
||||||
|
|
||||||
|
func _IOR(t int, nr int, size int) int {
|
||||||
|
return _IOC(_IOC_READ, t, nr, size)
|
||||||
|
}
|
||||||
|
|
||||||
|
func ioctl(fd uintptr, name int, data unsafe.Pointer) syscall.Errno {
|
||||||
|
_, _, err := syscall.RawSyscall(syscall.SYS_IOCTL, fd, uintptr(name), uintptr(data))
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
// input.h ioctls
|
||||||
|
var _EVIOCGID = _IOR('E', 0x02, SizeofInputId) // 8 <- sizeof(struct input_id)
|
||||||
|
var _EVIOCGNAME = _IOC(_IOC_READ, 'E', 0x06, _MAX_NAME_SIZE)
|
||||||
|
var _EVIOCGPHYS = _IOC(_IOC_READ, 'E', 0x07, _MAX_NAME_SIZE)
|
||||||
|
|
||||||
|
func _EVIOCGABS(ev int) int {
|
||||||
|
return _IOR('E', 0x40+ev, 24) // 24 <= sizeof(struct input_absinfo)
|
||||||
|
}
|
||||||
|
|
||||||
|
func _EVIOCGBIT(ev, len int) int {
|
||||||
|
return _IOC(_IOC_READ, 'E', 0x20+ev, len)
|
||||||
|
}
|
|
@ -0,0 +1,73 @@
|
||||||
|
package evdev
|
||||||
|
|
||||||
|
/*
|
||||||
|
#include <linux/input.h>
|
||||||
|
static int _EVIOCGNAME(int len) {return EVIOCGNAME(len);}
|
||||||
|
static int _EVIOCGPHYS(int len) {return EVIOCGPHYS(len);}
|
||||||
|
static int _EVIOCGUNIQ(int len) {return EVIOCGUNIQ(len);}
|
||||||
|
static int _EVIOCGPROP(int len) {return EVIOCGPROP(len);}
|
||||||
|
|
||||||
|
static int _EVIOCGKEY(int len) {return EVIOCGKEY(len);}
|
||||||
|
static int _EVIOCGLED(int len) {return EVIOCGLED(len);}
|
||||||
|
static int _EVIOCGSND(int len) {return EVIOCGSND(len);}
|
||||||
|
static int _EVIOCGSW(int len) {return EVIOCGSW(len);}
|
||||||
|
|
||||||
|
static int _EVIOCGBIT(int ev, int len) {return EVIOCGBIT(ev, len);}
|
||||||
|
static int _EVIOCGABS(int abs) {return EVIOCGABS(abs);}
|
||||||
|
static int _EVIOCSABS(int abs) {return EVIOCSABS(abs);}
|
||||||
|
*/
|
||||||
|
import "C"
|
||||||
|
import "syscall"
|
||||||
|
import "unsafe"
|
||||||
|
|
||||||
|
type _InputEvent C.struct_input_event
|
||||||
|
type _InputAbsinfo C.struct_input_absinfo
|
||||||
|
type _InputId C.struct_input_id
|
||||||
|
type _InputKeymapEntry C.struct_input_keymap_entry
|
||||||
|
|
||||||
|
const (
|
||||||
|
sizeofInputAbsinfo = C.sizeof_struct_input_absinfo
|
||||||
|
sizeofInputId = C.sizeof_struct_input_id
|
||||||
|
sizeofInputKeymapEntry = C.sizeof_struct_input_keymap_entry
|
||||||
|
)
|
||||||
|
|
||||||
|
const MAX_NAME_SIZE = 256
|
||||||
|
|
||||||
|
const (
|
||||||
|
EVIOCGID = C.EVIOCGID // get device ID
|
||||||
|
EVIOCGVERSION = C.EVIOCGVERSION // get driver version
|
||||||
|
EVIOCGREP = C.EVIOCGREP // get repeat settings
|
||||||
|
EVIOCSREP = C.EVIOCSREP // set repeat settings
|
||||||
|
|
||||||
|
EVIOCGKEYCODE = C.EVIOCGKEYCODE // get keycode
|
||||||
|
EVIOCGKEYCODE_V2 = C.EVIOCGKEYCODE_V2 // get keycode
|
||||||
|
|
||||||
|
EVIOCSKEYCODE = C.EVIOCSKEYCODE // set keycode
|
||||||
|
EVIOCSKEYCODE_V2 = C.EVIOCSKEYCODE_V2 // set keycode
|
||||||
|
|
||||||
|
EVIOCSFF = C.EVIOCSFF // send a force effect to a force feedback device
|
||||||
|
EVIOCRMFF = C.EVIOCRMFF // erase a force effect
|
||||||
|
EVIOCGEFFECTS = C.EVIOCGEFFECTS // report number of effects playable at the same time
|
||||||
|
|
||||||
|
EVIOCGRAB = C.EVIOCGRAB // grab/release device
|
||||||
|
EVIOCSCLOCKID = C.EVIOCSCLOCKID // set clockid to be used for timestamps
|
||||||
|
)
|
||||||
|
|
||||||
|
var EVIOCGNAME = C._EVIOCGNAME(MAX_NAME_SIZE) // get device name
|
||||||
|
var EVIOCGPHYS = C._EVIOCGPHYS(MAX_NAME_SIZE) // get physical location
|
||||||
|
var EVIOCGUNIQ = C._EVIOCGUNIQ(MAX_NAME_SIZE) // get unique identifier
|
||||||
|
var EVIOCGPROP = C._EVIOCGPROP(MAX_NAME_SIZE) // get device properties
|
||||||
|
|
||||||
|
var EVIOCGKEY = C._EVIOCGKEY(MAX_NAME_SIZE) // get global key state
|
||||||
|
var EVIOCGLED = C._EVIOCGLED(MAX_NAME_SIZE) // get all LEDs
|
||||||
|
var EVIOCGSND = C._EVIOCGSND(MAX_NAME_SIZE) // get all sounds status
|
||||||
|
var EVIOCGSW = C._EVIOCGSW(MAX_NAME_SIZE) // get all switch states
|
||||||
|
|
||||||
|
func EVIOCGBIT(ev, l int) int { return int(C._EVIOCGBIT(C.int(ev), C.int(l))) } // get event bits
|
||||||
|
func EVIOCGABS(abs int) int { return int(C._EVIOCGABS(C.int(abs))) } // get abs bits
|
||||||
|
func EVIOCSABS(abs int) int { return int(C._EVIOCSABS(C.int(abs))) } // set abs bits
|
||||||
|
|
||||||
|
func ioctl(fd uintptr, name uintptr, data unsafe.Pointer) syscall.Errno {
|
||||||
|
_, _, err := syscall.RawSyscall(syscall.SYS_IOCTL, fd, name, uintptr(data))
|
||||||
|
return err
|
||||||
|
}
|
|
@ -0,0 +1,307 @@
|
||||||
|
// +build linux
|
||||||
|
|
||||||
|
package evdev
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"encoding/binary"
|
||||||
|
"fmt"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"strings"
|
||||||
|
"unsafe"
|
||||||
|
)
|
||||||
|
|
||||||
|
// A Linux input device from which events can be read.
|
||||||
|
type InputDevice struct {
|
||||||
|
Fn string // path to input device (devnode)
|
||||||
|
|
||||||
|
Name string // device name
|
||||||
|
Phys string // physical topology of device
|
||||||
|
File *os.File // an open file handle to the input device
|
||||||
|
|
||||||
|
Bustype uint16 // bus type identifier
|
||||||
|
Vendor uint16 // vendor identifier
|
||||||
|
Product uint16 // product identifier
|
||||||
|
Version uint16 // version identifier
|
||||||
|
|
||||||
|
EvdevVersion int // evdev protocol version
|
||||||
|
|
||||||
|
Capabilities map[CapabilityType][]CapabilityCode // supported event types and codes.
|
||||||
|
CapabilitiesFlat map[int][]int
|
||||||
|
}
|
||||||
|
|
||||||
|
// Open an evdev input device.
|
||||||
|
func Open(devnode string) (*InputDevice, error) {
|
||||||
|
f, err := os.Open(devnode)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
dev := InputDevice{}
|
||||||
|
dev.Fn = devnode
|
||||||
|
dev.File = f
|
||||||
|
|
||||||
|
dev.set_device_info()
|
||||||
|
dev.set_device_capabilities()
|
||||||
|
|
||||||
|
return &dev, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Read and return a slice of input events from device.
|
||||||
|
func (dev *InputDevice) Read() ([]InputEvent, error) {
|
||||||
|
events := make([]InputEvent, 16)
|
||||||
|
buffer := make([]byte, eventsize*16)
|
||||||
|
|
||||||
|
_, err := dev.File.Read(buffer)
|
||||||
|
if err != nil {
|
||||||
|
return events, err
|
||||||
|
}
|
||||||
|
|
||||||
|
b := bytes.NewBuffer(buffer)
|
||||||
|
err = binary.Read(b, binary.LittleEndian, &events)
|
||||||
|
if err != nil {
|
||||||
|
return events, err
|
||||||
|
}
|
||||||
|
|
||||||
|
// remove trailing structures
|
||||||
|
for i := range events {
|
||||||
|
if events[i].Time.Sec == 0 {
|
||||||
|
events = append(events[:i])
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return events, err
|
||||||
|
}
|
||||||
|
|
||||||
|
// Read and return a single input event.
|
||||||
|
func (dev *InputDevice) ReadOne() (*InputEvent, error) {
|
||||||
|
event := InputEvent{}
|
||||||
|
buffer := make([]byte, eventsize)
|
||||||
|
|
||||||
|
_, err := dev.File.Read(buffer)
|
||||||
|
if err != nil {
|
||||||
|
return &event, err
|
||||||
|
}
|
||||||
|
|
||||||
|
b := bytes.NewBuffer(buffer)
|
||||||
|
err = binary.Read(b, binary.LittleEndian, &event)
|
||||||
|
if err != nil {
|
||||||
|
return &event, err
|
||||||
|
}
|
||||||
|
|
||||||
|
return &event, err
|
||||||
|
}
|
||||||
|
|
||||||
|
// Get a useful description for an input device. Example:
|
||||||
|
// InputDevice /dev/input/event3 (fd 3)
|
||||||
|
// name Logitech USB Laser Mouse
|
||||||
|
// phys usb-0000:00:12.0-2/input0
|
||||||
|
// bus 0x3, vendor 0x46d, product 0xc069, version 0x110
|
||||||
|
// events EV_KEY 1, EV_SYN 0, EV_REL 2, EV_MSC 4
|
||||||
|
func (dev *InputDevice) String() string {
|
||||||
|
evtypes := make([]string, 0)
|
||||||
|
|
||||||
|
for ev := range dev.Capabilities {
|
||||||
|
evtypes = append(evtypes, fmt.Sprintf("%s %d", ev.Name, ev.Type))
|
||||||
|
}
|
||||||
|
evtypes_s := strings.Join(evtypes, ", ")
|
||||||
|
|
||||||
|
return fmt.Sprintf(
|
||||||
|
"InputDevice %s (fd %d)\n"+
|
||||||
|
" name %s\n"+
|
||||||
|
" phys %s\n"+
|
||||||
|
" bus 0x%04x, vendor 0x%04x, product 0x%04x, version 0x%04x\n"+
|
||||||
|
" events %s",
|
||||||
|
dev.Fn, dev.File.Fd(), dev.Name, dev.Phys, dev.Bustype,
|
||||||
|
dev.Vendor, dev.Product, dev.Version, evtypes_s)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Gets the event types and event codes that the input device supports.
|
||||||
|
func (dev *InputDevice) set_device_capabilities() error {
|
||||||
|
// Capabilities is a map of supported event types to lists of
|
||||||
|
// events e.g: {1: [272, 273, 274, 275], 2: [0, 1, 6, 8]}
|
||||||
|
// capabilities := make(map[int][]int)
|
||||||
|
capabilities := make(map[CapabilityType][]CapabilityCode)
|
||||||
|
|
||||||
|
evbits := new([(EV_MAX + 1) / 8]byte)
|
||||||
|
codebits := new([(KEY_MAX + 1) / 8]byte)
|
||||||
|
// absbits := new([6]byte)
|
||||||
|
|
||||||
|
err := ioctl(dev.File.Fd(), uintptr(EVIOCGBIT(0, EV_MAX)), unsafe.Pointer(evbits))
|
||||||
|
if err != 0 {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
// Build a map of the device's capabilities
|
||||||
|
for evtype := 0; evtype < EV_MAX; evtype++ {
|
||||||
|
if evbits[evtype/8]&(1<<uint(evtype%8)) != 0 {
|
||||||
|
eventcodes := make([]CapabilityCode, 0)
|
||||||
|
|
||||||
|
ioctl(dev.File.Fd(), uintptr(EVIOCGBIT(evtype, KEY_MAX)), unsafe.Pointer(codebits))
|
||||||
|
for evcode := 0; evcode < KEY_MAX; evcode++ {
|
||||||
|
if codebits[evcode/8]&(1<<uint(evcode%8)) != 0 {
|
||||||
|
c := CapabilityCode{evcode, ByEventType[evtype][evcode]}
|
||||||
|
eventcodes = append(eventcodes, c)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// capabilities[EV_KEY] = [KEY_A, KEY_B, KEY_C, ...]
|
||||||
|
key := CapabilityType{evtype, EV[evtype]}
|
||||||
|
capabilities[key] = eventcodes
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
dev.Capabilities = capabilities
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// An all-in-one function for describing an input device.
|
||||||
|
func (dev *InputDevice) set_device_info() error {
|
||||||
|
info := device_info{}
|
||||||
|
|
||||||
|
name := new([MAX_NAME_SIZE]byte)
|
||||||
|
phys := new([MAX_NAME_SIZE]byte)
|
||||||
|
|
||||||
|
err := ioctl(dev.File.Fd(), uintptr(EVIOCGID), unsafe.Pointer(&info))
|
||||||
|
if err != 0 {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
ioctl(dev.File.Fd(), uintptr(EVIOCGNAME), unsafe.Pointer(name))
|
||||||
|
if err != 0 {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
// it's ok if the topology info is not available
|
||||||
|
ioctl(dev.File.Fd(), uintptr(EVIOCGPHYS), unsafe.Pointer(phys))
|
||||||
|
|
||||||
|
dev.Name = bytes_to_string(name)
|
||||||
|
dev.Phys = bytes_to_string(phys)
|
||||||
|
|
||||||
|
dev.Vendor = info.vendor
|
||||||
|
dev.Bustype = info.bustype
|
||||||
|
dev.Product = info.product
|
||||||
|
dev.Version = info.version
|
||||||
|
|
||||||
|
ev_version := new(int)
|
||||||
|
ioctl(dev.File.Fd(), uintptr(EVIOCGVERSION), unsafe.Pointer(ev_version))
|
||||||
|
dev.EvdevVersion = *ev_version
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Get repeat rate as a two element array.
|
||||||
|
// [0] repeat rate in characters per second
|
||||||
|
// [1] amount of time that a key must be depressed before it will start
|
||||||
|
// to repeat (in milliseconds)
|
||||||
|
func (dev *InputDevice) GetRepeatRate() *[2]uint {
|
||||||
|
repeat_delay := new([2]uint)
|
||||||
|
ioctl(dev.File.Fd(), uintptr(EVIOCGREP), unsafe.Pointer(repeat_delay))
|
||||||
|
|
||||||
|
return repeat_delay
|
||||||
|
}
|
||||||
|
|
||||||
|
// Set repeat rate and delay.
|
||||||
|
func (dev *InputDevice) SetRepeatRate(repeat, delay uint) {
|
||||||
|
repeat_delay := new([2]uint)
|
||||||
|
repeat_delay[0], repeat_delay[1] = repeat, delay
|
||||||
|
ioctl(dev.File.Fd(), uintptr(EVIOCSREP), unsafe.Pointer(repeat_delay))
|
||||||
|
}
|
||||||
|
|
||||||
|
type CapabilityType struct {
|
||||||
|
Type int
|
||||||
|
Name string
|
||||||
|
}
|
||||||
|
|
||||||
|
type CapabilityCode struct {
|
||||||
|
Code int
|
||||||
|
Name string
|
||||||
|
}
|
||||||
|
|
||||||
|
type AbsInfo struct {
|
||||||
|
value int32
|
||||||
|
minimum int32
|
||||||
|
maximum int32
|
||||||
|
fuzz int32
|
||||||
|
flat int32
|
||||||
|
resolution int32
|
||||||
|
}
|
||||||
|
|
||||||
|
// Corresponds to the input_id struct.
|
||||||
|
type device_info struct {
|
||||||
|
bustype, vendor, product, version uint16
|
||||||
|
}
|
||||||
|
|
||||||
|
// Return the keys of a map as a slice (dict.keys())
|
||||||
|
func keys(cap *map[int][]int) []int {
|
||||||
|
slice := make([]int, 0)
|
||||||
|
|
||||||
|
for key := range *cap {
|
||||||
|
slice = append(slice, key)
|
||||||
|
}
|
||||||
|
|
||||||
|
return slice
|
||||||
|
}
|
||||||
|
|
||||||
|
// Determine if a path exist and is a character input device.
|
||||||
|
func IsInputDevice(path string) bool {
|
||||||
|
fi, err := os.Stat(path)
|
||||||
|
|
||||||
|
if os.IsNotExist(err) {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
m := fi.Mode()
|
||||||
|
if m&os.ModeCharDevice == 0 {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
// Return a list of accessible input device names matched by
|
||||||
|
// deviceglob (default '/dev/input/event*').
|
||||||
|
func ListInputDevicePaths(device_glob string) ([]string, error) {
|
||||||
|
paths, err := filepath.Glob(device_glob)
|
||||||
|
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
devices := make([]string, 0)
|
||||||
|
for _, path := range paths {
|
||||||
|
if IsInputDevice(path) {
|
||||||
|
devices = append(devices, path)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return devices, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Return a list of accessible input devices matched by deviceglob
|
||||||
|
// (default '/dev/input/event/*').
|
||||||
|
func ListInputDevices(device_glob_arg ...string) ([]*InputDevice, error) {
|
||||||
|
device_glob := "/dev/input/event*"
|
||||||
|
if len(device_glob_arg) > 0 {
|
||||||
|
device_glob = device_glob_arg[0]
|
||||||
|
}
|
||||||
|
|
||||||
|
fns, _ := ListInputDevicePaths(device_glob)
|
||||||
|
devices := make([]*InputDevice, 0)
|
||||||
|
|
||||||
|
for i := range fns {
|
||||||
|
dev, err := Open(fns[i])
|
||||||
|
if err == nil {
|
||||||
|
devices = append(devices, dev)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return devices, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func bytes_to_string(b *[MAX_NAME_SIZE]byte) string {
|
||||||
|
idx := bytes.IndexByte(b[:], 0)
|
||||||
|
return string(b[:idx])
|
||||||
|
}
|
|
@ -0,0 +1,10 @@
|
||||||
|
/*
|
||||||
|
This package provides bindings to the generic input event interface in
|
||||||
|
Linux. The evdev interface serves the purpose of passing events
|
||||||
|
generated in the kernel directly to userspace through character
|
||||||
|
devices that are typically located in /dev/input/.
|
||||||
|
|
||||||
|
Please refer to the godoc examples and the bin/evtest example program.
|
||||||
|
|
||||||
|
*/
|
||||||
|
package evdev
|
Plik diff jest za duży
Load Diff
|
@ -0,0 +1,88 @@
|
||||||
|
// -*- mode: go; -*-
|
||||||
|
|
||||||
|
// Integer constants defined in linux/input.h and linux/input-event-codes.h can be accessed
|
||||||
|
// directly as constants or through the provided reverse and forward mappings:
|
||||||
|
|
||||||
|
//
|
||||||
|
// evdev.KEY_A // 30
|
||||||
|
// evdev.ecodes["KEY_A"] // 30
|
||||||
|
// evdev.KEY[30] // "KEY_A"
|
||||||
|
// evdev.REL[0] // "REL_X"
|
||||||
|
// evdev.EV[evdev.EV_KEY] // "EV_KEY"
|
||||||
|
// evdev.ByEventType[EV_REL][0] // "REL_X"
|
||||||
|
//
|
||||||
|
// Generated on: ${UNAME}
|
||||||
|
|
||||||
|
package evdev
|
||||||
|
|
||||||
|
import "strings"
|
||||||
|
|
||||||
|
const (
|
||||||
|
${CODES}
|
||||||
|
)
|
||||||
|
|
||||||
|
var ecodes = map[string] int {
|
||||||
|
${CODEMAP}
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
var KEY = map[int]string {}
|
||||||
|
var ABS = map[int]string {}
|
||||||
|
var REL = map[int]string {}
|
||||||
|
var SW = map[int]string {}
|
||||||
|
var MSC = map[int]string {}
|
||||||
|
var LED = map[int]string {}
|
||||||
|
var BTN = map[int]string {}
|
||||||
|
var REP = map[int]string {}
|
||||||
|
var SND = map[int]string {}
|
||||||
|
var ID = map[int]string {}
|
||||||
|
var EV = map[int]string {}
|
||||||
|
var BUS = map[int]string {}
|
||||||
|
var SYN = map[int]string {}
|
||||||
|
var FF = map[int]string {}
|
||||||
|
|
||||||
|
var ByEventType = map[int] map[int]string {
|
||||||
|
EV_KEY: KEY,
|
||||||
|
EV_ABS: ABS,
|
||||||
|
EV_REL: REL,
|
||||||
|
EV_SW: SW,
|
||||||
|
EV_MSC: MSC,
|
||||||
|
EV_LED: LED,
|
||||||
|
EV_REP: REP,
|
||||||
|
EV_SND: SND,
|
||||||
|
EV_SYN: SYN,
|
||||||
|
EV_FF: FF,
|
||||||
|
}
|
||||||
|
|
||||||
|
func init() {
|
||||||
|
for code, value := range ecodes {
|
||||||
|
switch {
|
||||||
|
case strings.HasPrefix(code, "KEY"):
|
||||||
|
KEY[value] = code
|
||||||
|
case strings.HasPrefix(code, "ABS"):
|
||||||
|
ABS[value] = code
|
||||||
|
case strings.HasPrefix(code, "REL"):
|
||||||
|
REL[value] = code
|
||||||
|
case strings.HasPrefix(code, "SW"):
|
||||||
|
SW[value] = code
|
||||||
|
case strings.HasPrefix(code, "MSC"):
|
||||||
|
MSC[value] = code
|
||||||
|
case strings.HasPrefix(code, "LED"):
|
||||||
|
LED[value] = code
|
||||||
|
case strings.HasPrefix(code, "BTN"):
|
||||||
|
BTN[value] = code
|
||||||
|
case strings.HasPrefix(code, "SND"):
|
||||||
|
SND[value] = code
|
||||||
|
case strings.HasPrefix(code, "ID"):
|
||||||
|
ID[value] = code
|
||||||
|
case strings.HasPrefix(code, "EV"):
|
||||||
|
EV[value] = code
|
||||||
|
case strings.HasPrefix(code, "BUS"):
|
||||||
|
BUS[value] = code
|
||||||
|
case strings.HasPrefix(code, "SYN"):
|
||||||
|
SYN[value] = code
|
||||||
|
case strings.HasPrefix(code, "FF"):
|
||||||
|
FF[value] = code
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,109 @@
|
||||||
|
package evdev
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"syscall"
|
||||||
|
"unsafe"
|
||||||
|
)
|
||||||
|
|
||||||
|
type InputEvent struct {
|
||||||
|
Time syscall.Timeval // time in seconds since epoch at which event occurred
|
||||||
|
Type uint16 // event type - one of ecodes.EV_*
|
||||||
|
Code uint16 // event code related to the event type
|
||||||
|
Value int32 // event value related to the event type
|
||||||
|
}
|
||||||
|
|
||||||
|
// Get a useful description for an input event. Example:
|
||||||
|
// event at 1347905437.435795, code 01, type 02, val 02
|
||||||
|
func (ev *InputEvent) String() string {
|
||||||
|
return fmt.Sprintf("event at %d.%d, code %02d, type %02d, val %02d",
|
||||||
|
ev.Time.Sec, ev.Time.Usec, ev.Code, ev.Type, ev.Value)
|
||||||
|
}
|
||||||
|
|
||||||
|
var eventsize = int(unsafe.Sizeof(InputEvent{}))
|
||||||
|
|
||||||
|
type KeyEventState uint8
|
||||||
|
|
||||||
|
const (
|
||||||
|
KeyUp KeyEventState = 0x0
|
||||||
|
KeyDown KeyEventState = 0x1
|
||||||
|
KeyHold KeyEventState = 0x2
|
||||||
|
)
|
||||||
|
|
||||||
|
// KeyEvents are used to describe state changes of keyboards, buttons,
|
||||||
|
// or other key-like devices.
|
||||||
|
type KeyEvent struct {
|
||||||
|
Event *InputEvent
|
||||||
|
Scancode uint16
|
||||||
|
Keycode uint16
|
||||||
|
State KeyEventState
|
||||||
|
}
|
||||||
|
|
||||||
|
func (kev *KeyEvent) New(ev *InputEvent) {
|
||||||
|
kev.Event = ev
|
||||||
|
kev.Keycode = 0 // :todo
|
||||||
|
kev.Scancode = ev.Code
|
||||||
|
|
||||||
|
switch ev.Value {
|
||||||
|
case 0:
|
||||||
|
kev.State = KeyUp
|
||||||
|
case 2:
|
||||||
|
kev.State = KeyHold
|
||||||
|
case 1:
|
||||||
|
kev.State = KeyDown
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func NewKeyEvent(ev *InputEvent) *KeyEvent {
|
||||||
|
kev := &KeyEvent{}
|
||||||
|
kev.New(ev)
|
||||||
|
return kev
|
||||||
|
}
|
||||||
|
|
||||||
|
func (ev *KeyEvent) String() string {
|
||||||
|
state := "unknown"
|
||||||
|
|
||||||
|
switch ev.State {
|
||||||
|
case KeyUp:
|
||||||
|
state = "up"
|
||||||
|
case KeyHold:
|
||||||
|
state = "hold"
|
||||||
|
case KeyDown:
|
||||||
|
state = "down"
|
||||||
|
}
|
||||||
|
|
||||||
|
return fmt.Sprintf("key event at %d.%d, %d (%d), (%s)",
|
||||||
|
ev.Event.Time.Sec, ev.Event.Time.Usec,
|
||||||
|
ev.Scancode, ev.Event.Code, state)
|
||||||
|
}
|
||||||
|
|
||||||
|
// RelEvents are used to describe relative axis value changes,
|
||||||
|
// e.g. moving the mouse 5 units to the left.
|
||||||
|
type RelEvent struct {
|
||||||
|
Event *InputEvent
|
||||||
|
}
|
||||||
|
|
||||||
|
func (rev *RelEvent) New(ev *InputEvent) {
|
||||||
|
rev.Event = ev
|
||||||
|
}
|
||||||
|
|
||||||
|
func NewRelEvent(ev *InputEvent) *RelEvent {
|
||||||
|
rev := &RelEvent{}
|
||||||
|
rev.New(ev)
|
||||||
|
return rev
|
||||||
|
}
|
||||||
|
|
||||||
|
func (ev *RelEvent) String() string {
|
||||||
|
return fmt.Sprintf("relative axis event at %d.%d, %s",
|
||||||
|
ev.Event.Time.Sec, ev.Event.Time.Usec,
|
||||||
|
REL[int(ev.Event.Code)])
|
||||||
|
}
|
||||||
|
|
||||||
|
// TODO: Make this work
|
||||||
|
|
||||||
|
var EventFactory map[uint16]interface{} = make(map[uint16]interface{})
|
||||||
|
|
||||||
|
func init() {
|
||||||
|
EventFactory[uint16(EV_KEY)] = NewKeyEvent
|
||||||
|
EventFactory[uint16(EV_REL)] = NewRelEvent
|
||||||
|
}
|
|
@ -0,0 +1,27 @@
|
||||||
|
Copyright (c) 2013, Patrick Mezard
|
||||||
|
All rights reserved.
|
||||||
|
|
||||||
|
Redistribution and use in source and binary forms, with or without
|
||||||
|
modification, are permitted provided that the following conditions are
|
||||||
|
met:
|
||||||
|
|
||||||
|
Redistributions of source code must retain the above copyright
|
||||||
|
notice, this list of conditions and the following disclaimer.
|
||||||
|
Redistributions in binary form must reproduce the above copyright
|
||||||
|
notice, this list of conditions and the following disclaimer in the
|
||||||
|
documentation and/or other materials provided with the distribution.
|
||||||
|
The names of its contributors may not be used to endorse or promote
|
||||||
|
products derived from this software without specific prior written
|
||||||
|
permission.
|
||||||
|
|
||||||
|
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
|
||||||
|
IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
|
||||||
|
TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
|
||||||
|
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||||
|
HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||||
|
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
|
||||||
|
TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
|
||||||
|
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
|
||||||
|
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
|
||||||
|
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
||||||
|
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
@ -0,0 +1,758 @@
|
||||||
|
// Package difflib is a partial port of Python difflib module.
|
||||||
|
//
|
||||||
|
// It provides tools to compare sequences of strings and generate textual diffs.
|
||||||
|
//
|
||||||
|
// The following class and functions have been ported:
|
||||||
|
//
|
||||||
|
// - SequenceMatcher
|
||||||
|
//
|
||||||
|
// - unified_diff
|
||||||
|
//
|
||||||
|
// - context_diff
|
||||||
|
//
|
||||||
|
// Getting unified diffs was the main goal of the port. Keep in mind this code
|
||||||
|
// is mostly suitable to output text differences in a human friendly way, there
|
||||||
|
// are no guarantees generated diffs are consumable by patch(1).
|
||||||
|
package difflib
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bufio"
|
||||||
|
"bytes"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"strings"
|
||||||
|
)
|
||||||
|
|
||||||
|
func min(a, b int) int {
|
||||||
|
if a < b {
|
||||||
|
return a
|
||||||
|
}
|
||||||
|
return b
|
||||||
|
}
|
||||||
|
|
||||||
|
func max(a, b int) int {
|
||||||
|
if a > b {
|
||||||
|
return a
|
||||||
|
}
|
||||||
|
return b
|
||||||
|
}
|
||||||
|
|
||||||
|
func calculateRatio(matches, length int) float64 {
|
||||||
|
if length > 0 {
|
||||||
|
return 2.0 * float64(matches) / float64(length)
|
||||||
|
}
|
||||||
|
return 1.0
|
||||||
|
}
|
||||||
|
|
||||||
|
type Match struct {
|
||||||
|
A int
|
||||||
|
B int
|
||||||
|
Size int
|
||||||
|
}
|
||||||
|
|
||||||
|
type OpCode struct {
|
||||||
|
Tag byte
|
||||||
|
I1 int
|
||||||
|
I2 int
|
||||||
|
J1 int
|
||||||
|
J2 int
|
||||||
|
}
|
||||||
|
|
||||||
|
// SequenceMatcher compares sequence of strings. The basic
|
||||||
|
// algorithm predates, and is a little fancier than, an algorithm
|
||||||
|
// published in the late 1980's by Ratcliff and Obershelp under the
|
||||||
|
// hyperbolic name "gestalt pattern matching". The basic idea is to find
|
||||||
|
// the longest contiguous matching subsequence that contains no "junk"
|
||||||
|
// elements (R-O doesn't address junk). The same idea is then applied
|
||||||
|
// recursively to the pieces of the sequences to the left and to the right
|
||||||
|
// of the matching subsequence. This does not yield minimal edit
|
||||||
|
// sequences, but does tend to yield matches that "look right" to people.
|
||||||
|
//
|
||||||
|
// SequenceMatcher tries to compute a "human-friendly diff" between two
|
||||||
|
// sequences. Unlike e.g. UNIX(tm) diff, the fundamental notion is the
|
||||||
|
// longest *contiguous* & junk-free matching subsequence. That's what
|
||||||
|
// catches peoples' eyes. The Windows(tm) windiff has another interesting
|
||||||
|
// notion, pairing up elements that appear uniquely in each sequence.
|
||||||
|
// That, and the method here, appear to yield more intuitive difference
|
||||||
|
// reports than does diff. This method appears to be the least vulnerable
|
||||||
|
// to synching up on blocks of "junk lines", though (like blank lines in
|
||||||
|
// ordinary text files, or maybe "<P>" lines in HTML files). That may be
|
||||||
|
// because this is the only method of the 3 that has a *concept* of
|
||||||
|
// "junk" <wink>.
|
||||||
|
//
|
||||||
|
// Timing: Basic R-O is cubic time worst case and quadratic time expected
|
||||||
|
// case. SequenceMatcher is quadratic time for the worst case and has
|
||||||
|
// expected-case behavior dependent in a complicated way on how many
|
||||||
|
// elements the sequences have in common; best case time is linear.
|
||||||
|
type SequenceMatcher struct {
|
||||||
|
a []string
|
||||||
|
b []string
|
||||||
|
b2j map[string][]int
|
||||||
|
IsJunk func(string) bool
|
||||||
|
autoJunk bool
|
||||||
|
bJunk map[string]struct{}
|
||||||
|
matchingBlocks []Match
|
||||||
|
fullBCount map[string]int
|
||||||
|
bPopular map[string]struct{}
|
||||||
|
opCodes []OpCode
|
||||||
|
}
|
||||||
|
|
||||||
|
func NewMatcher(a, b []string) *SequenceMatcher {
|
||||||
|
m := SequenceMatcher{autoJunk: true}
|
||||||
|
m.SetSeqs(a, b)
|
||||||
|
return &m
|
||||||
|
}
|
||||||
|
|
||||||
|
func NewMatcherWithJunk(a, b []string, autoJunk bool,
|
||||||
|
isJunk func(string) bool) *SequenceMatcher {
|
||||||
|
|
||||||
|
m := SequenceMatcher{IsJunk: isJunk, autoJunk: autoJunk}
|
||||||
|
m.SetSeqs(a, b)
|
||||||
|
return &m
|
||||||
|
}
|
||||||
|
|
||||||
|
// Set two sequences to be compared.
|
||||||
|
func (m *SequenceMatcher) SetSeqs(a, b []string) {
|
||||||
|
m.SetSeq1(a)
|
||||||
|
m.SetSeq2(b)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Set the first sequence to be compared. The second sequence to be compared is
|
||||||
|
// not changed.
|
||||||
|
//
|
||||||
|
// SequenceMatcher computes and caches detailed information about the second
|
||||||
|
// sequence, so if you want to compare one sequence S against many sequences,
|
||||||
|
// use .SetSeq2(s) once and call .SetSeq1(x) repeatedly for each of the other
|
||||||
|
// sequences.
|
||||||
|
//
|
||||||
|
// See also SetSeqs() and SetSeq2().
|
||||||
|
func (m *SequenceMatcher) SetSeq1(a []string) {
|
||||||
|
if &a == &m.a {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
m.a = a
|
||||||
|
m.matchingBlocks = nil
|
||||||
|
m.opCodes = nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Set the second sequence to be compared. The first sequence to be compared is
|
||||||
|
// not changed.
|
||||||
|
func (m *SequenceMatcher) SetSeq2(b []string) {
|
||||||
|
if &b == &m.b {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
m.b = b
|
||||||
|
m.matchingBlocks = nil
|
||||||
|
m.opCodes = nil
|
||||||
|
m.fullBCount = nil
|
||||||
|
m.chainB()
|
||||||
|
}
|
||||||
|
|
||||||
|
func (m *SequenceMatcher) chainB() {
|
||||||
|
// Populate line -> index mapping
|
||||||
|
b2j := map[string][]int{}
|
||||||
|
for i, s := range m.b {
|
||||||
|
indices := b2j[s]
|
||||||
|
indices = append(indices, i)
|
||||||
|
b2j[s] = indices
|
||||||
|
}
|
||||||
|
|
||||||
|
// Purge junk elements
|
||||||
|
m.bJunk = map[string]struct{}{}
|
||||||
|
if m.IsJunk != nil {
|
||||||
|
junk := m.bJunk
|
||||||
|
for s, _ := range b2j {
|
||||||
|
if m.IsJunk(s) {
|
||||||
|
junk[s] = struct{}{}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for s, _ := range junk {
|
||||||
|
delete(b2j, s)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Purge remaining popular elements
|
||||||
|
popular := map[string]struct{}{}
|
||||||
|
n := len(m.b)
|
||||||
|
if m.autoJunk && n >= 200 {
|
||||||
|
ntest := n/100 + 1
|
||||||
|
for s, indices := range b2j {
|
||||||
|
if len(indices) > ntest {
|
||||||
|
popular[s] = struct{}{}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for s, _ := range popular {
|
||||||
|
delete(b2j, s)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
m.bPopular = popular
|
||||||
|
m.b2j = b2j
|
||||||
|
}
|
||||||
|
|
||||||
|
func (m *SequenceMatcher) isBJunk(s string) bool {
|
||||||
|
_, ok := m.bJunk[s]
|
||||||
|
return ok
|
||||||
|
}
|
||||||
|
|
||||||
|
// Find longest matching block in a[alo:ahi] and b[blo:bhi].
|
||||||
|
//
|
||||||
|
// If IsJunk is not defined:
|
||||||
|
//
|
||||||
|
// Return (i,j,k) such that a[i:i+k] is equal to b[j:j+k], where
|
||||||
|
// alo <= i <= i+k <= ahi
|
||||||
|
// blo <= j <= j+k <= bhi
|
||||||
|
// and for all (i',j',k') meeting those conditions,
|
||||||
|
// k >= k'
|
||||||
|
// i <= i'
|
||||||
|
// and if i == i', j <= j'
|
||||||
|
//
|
||||||
|
// In other words, of all maximal matching blocks, return one that
|
||||||
|
// starts earliest in a, and of all those maximal matching blocks that
|
||||||
|
// start earliest in a, return the one that starts earliest in b.
|
||||||
|
//
|
||||||
|
// If IsJunk is defined, first the longest matching block is
|
||||||
|
// determined as above, but with the additional restriction that no
|
||||||
|
// junk element appears in the block. Then that block is extended as
|
||||||
|
// far as possible by matching (only) junk elements on both sides. So
|
||||||
|
// the resulting block never matches on junk except as identical junk
|
||||||
|
// happens to be adjacent to an "interesting" match.
|
||||||
|
//
|
||||||
|
// If no blocks match, return (alo, blo, 0).
|
||||||
|
func (m *SequenceMatcher) findLongestMatch(alo, ahi, blo, bhi int) Match {
|
||||||
|
// CAUTION: stripping common prefix or suffix would be incorrect.
|
||||||
|
// E.g.,
|
||||||
|
// ab
|
||||||
|
// acab
|
||||||
|
// Longest matching block is "ab", but if common prefix is
|
||||||
|
// stripped, it's "a" (tied with "b"). UNIX(tm) diff does so
|
||||||
|
// strip, so ends up claiming that ab is changed to acab by
|
||||||
|
// inserting "ca" in the middle. That's minimal but unintuitive:
|
||||||
|
// "it's obvious" that someone inserted "ac" at the front.
|
||||||
|
// Windiff ends up at the same place as diff, but by pairing up
|
||||||
|
// the unique 'b's and then matching the first two 'a's.
|
||||||
|
besti, bestj, bestsize := alo, blo, 0
|
||||||
|
|
||||||
|
// find longest junk-free match
|
||||||
|
// during an iteration of the loop, j2len[j] = length of longest
|
||||||
|
// junk-free match ending with a[i-1] and b[j]
|
||||||
|
j2len := map[int]int{}
|
||||||
|
for i := alo; i != ahi; i++ {
|
||||||
|
// look at all instances of a[i] in b; note that because
|
||||||
|
// b2j has no junk keys, the loop is skipped if a[i] is junk
|
||||||
|
newj2len := map[int]int{}
|
||||||
|
for _, j := range m.b2j[m.a[i]] {
|
||||||
|
// a[i] matches b[j]
|
||||||
|
if j < blo {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if j >= bhi {
|
||||||
|
break
|
||||||
|
}
|
||||||
|
k := j2len[j-1] + 1
|
||||||
|
newj2len[j] = k
|
||||||
|
if k > bestsize {
|
||||||
|
besti, bestj, bestsize = i-k+1, j-k+1, k
|
||||||
|
}
|
||||||
|
}
|
||||||
|
j2len = newj2len
|
||||||
|
}
|
||||||
|
|
||||||
|
// Extend the best by non-junk elements on each end. In particular,
|
||||||
|
// "popular" non-junk elements aren't in b2j, which greatly speeds
|
||||||
|
// the inner loop above, but also means "the best" match so far
|
||||||
|
// doesn't contain any junk *or* popular non-junk elements.
|
||||||
|
for besti > alo && bestj > blo && !m.isBJunk(m.b[bestj-1]) &&
|
||||||
|
m.a[besti-1] == m.b[bestj-1] {
|
||||||
|
besti, bestj, bestsize = besti-1, bestj-1, bestsize+1
|
||||||
|
}
|
||||||
|
for besti+bestsize < ahi && bestj+bestsize < bhi &&
|
||||||
|
!m.isBJunk(m.b[bestj+bestsize]) &&
|
||||||
|
m.a[besti+bestsize] == m.b[bestj+bestsize] {
|
||||||
|
bestsize += 1
|
||||||
|
}
|
||||||
|
|
||||||
|
// Now that we have a wholly interesting match (albeit possibly
|
||||||
|
// empty!), we may as well suck up the matching junk on each
|
||||||
|
// side of it too. Can't think of a good reason not to, and it
|
||||||
|
// saves post-processing the (possibly considerable) expense of
|
||||||
|
// figuring out what to do with it. In the case of an empty
|
||||||
|
// interesting match, this is clearly the right thing to do,
|
||||||
|
// because no other kind of match is possible in the regions.
|
||||||
|
for besti > alo && bestj > blo && m.isBJunk(m.b[bestj-1]) &&
|
||||||
|
m.a[besti-1] == m.b[bestj-1] {
|
||||||
|
besti, bestj, bestsize = besti-1, bestj-1, bestsize+1
|
||||||
|
}
|
||||||
|
for besti+bestsize < ahi && bestj+bestsize < bhi &&
|
||||||
|
m.isBJunk(m.b[bestj+bestsize]) &&
|
||||||
|
m.a[besti+bestsize] == m.b[bestj+bestsize] {
|
||||||
|
bestsize += 1
|
||||||
|
}
|
||||||
|
|
||||||
|
return Match{A: besti, B: bestj, Size: bestsize}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Return list of triples describing matching subsequences.
|
||||||
|
//
|
||||||
|
// Each triple is of the form (i, j, n), and means that
|
||||||
|
// a[i:i+n] == b[j:j+n]. The triples are monotonically increasing in
|
||||||
|
// i and in j. It's also guaranteed that if (i, j, n) and (i', j', n') are
|
||||||
|
// adjacent triples in the list, and the second is not the last triple in the
|
||||||
|
// list, then i+n != i' or j+n != j'. IOW, adjacent triples never describe
|
||||||
|
// adjacent equal blocks.
|
||||||
|
//
|
||||||
|
// The last triple is a dummy, (len(a), len(b), 0), and is the only
|
||||||
|
// triple with n==0.
|
||||||
|
func (m *SequenceMatcher) GetMatchingBlocks() []Match {
|
||||||
|
if m.matchingBlocks != nil {
|
||||||
|
return m.matchingBlocks
|
||||||
|
}
|
||||||
|
|
||||||
|
var matchBlocks func(alo, ahi, blo, bhi int, matched []Match) []Match
|
||||||
|
matchBlocks = func(alo, ahi, blo, bhi int, matched []Match) []Match {
|
||||||
|
match := m.findLongestMatch(alo, ahi, blo, bhi)
|
||||||
|
i, j, k := match.A, match.B, match.Size
|
||||||
|
if match.Size > 0 {
|
||||||
|
if alo < i && blo < j {
|
||||||
|
matched = matchBlocks(alo, i, blo, j, matched)
|
||||||
|
}
|
||||||
|
matched = append(matched, match)
|
||||||
|
if i+k < ahi && j+k < bhi {
|
||||||
|
matched = matchBlocks(i+k, ahi, j+k, bhi, matched)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return matched
|
||||||
|
}
|
||||||
|
matched := matchBlocks(0, len(m.a), 0, len(m.b), nil)
|
||||||
|
|
||||||
|
// It's possible that we have adjacent equal blocks in the
|
||||||
|
// matching_blocks list now.
|
||||||
|
nonAdjacent := []Match{}
|
||||||
|
i1, j1, k1 := 0, 0, 0
|
||||||
|
for _, b := range matched {
|
||||||
|
// Is this block adjacent to i1, j1, k1?
|
||||||
|
i2, j2, k2 := b.A, b.B, b.Size
|
||||||
|
if i1+k1 == i2 && j1+k1 == j2 {
|
||||||
|
// Yes, so collapse them -- this just increases the length of
|
||||||
|
// the first block by the length of the second, and the first
|
||||||
|
// block so lengthened remains the block to compare against.
|
||||||
|
k1 += k2
|
||||||
|
} else {
|
||||||
|
// Not adjacent. Remember the first block (k1==0 means it's
|
||||||
|
// the dummy we started with), and make the second block the
|
||||||
|
// new block to compare against.
|
||||||
|
if k1 > 0 {
|
||||||
|
nonAdjacent = append(nonAdjacent, Match{i1, j1, k1})
|
||||||
|
}
|
||||||
|
i1, j1, k1 = i2, j2, k2
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if k1 > 0 {
|
||||||
|
nonAdjacent = append(nonAdjacent, Match{i1, j1, k1})
|
||||||
|
}
|
||||||
|
|
||||||
|
nonAdjacent = append(nonAdjacent, Match{len(m.a), len(m.b), 0})
|
||||||
|
m.matchingBlocks = nonAdjacent
|
||||||
|
return m.matchingBlocks
|
||||||
|
}
|
||||||
|
|
||||||
|
// Return list of 5-tuples describing how to turn a into b.
|
||||||
|
//
|
||||||
|
// Each tuple is of the form (tag, i1, i2, j1, j2). The first tuple
|
||||||
|
// has i1 == j1 == 0, and remaining tuples have i1 == the i2 from the
|
||||||
|
// tuple preceding it, and likewise for j1 == the previous j2.
|
||||||
|
//
|
||||||
|
// The tags are characters, with these meanings:
|
||||||
|
//
|
||||||
|
// 'r' (replace): a[i1:i2] should be replaced by b[j1:j2]
|
||||||
|
//
|
||||||
|
// 'd' (delete): a[i1:i2] should be deleted, j1==j2 in this case.
|
||||||
|
//
|
||||||
|
// 'i' (insert): b[j1:j2] should be inserted at a[i1:i1], i1==i2 in this case.
|
||||||
|
//
|
||||||
|
// 'e' (equal): a[i1:i2] == b[j1:j2]
|
||||||
|
func (m *SequenceMatcher) GetOpCodes() []OpCode {
|
||||||
|
if m.opCodes != nil {
|
||||||
|
return m.opCodes
|
||||||
|
}
|
||||||
|
i, j := 0, 0
|
||||||
|
matching := m.GetMatchingBlocks()
|
||||||
|
opCodes := make([]OpCode, 0, len(matching))
|
||||||
|
for _, m := range matching {
|
||||||
|
// invariant: we've pumped out correct diffs to change
|
||||||
|
// a[:i] into b[:j], and the next matching block is
|
||||||
|
// a[ai:ai+size] == b[bj:bj+size]. So we need to pump
|
||||||
|
// out a diff to change a[i:ai] into b[j:bj], pump out
|
||||||
|
// the matching block, and move (i,j) beyond the match
|
||||||
|
ai, bj, size := m.A, m.B, m.Size
|
||||||
|
tag := byte(0)
|
||||||
|
if i < ai && j < bj {
|
||||||
|
tag = 'r'
|
||||||
|
} else if i < ai {
|
||||||
|
tag = 'd'
|
||||||
|
} else if j < bj {
|
||||||
|
tag = 'i'
|
||||||
|
}
|
||||||
|
if tag > 0 {
|
||||||
|
opCodes = append(opCodes, OpCode{tag, i, ai, j, bj})
|
||||||
|
}
|
||||||
|
i, j = ai+size, bj+size
|
||||||
|
// the list of matching blocks is terminated by a
|
||||||
|
// sentinel with size 0
|
||||||
|
if size > 0 {
|
||||||
|
opCodes = append(opCodes, OpCode{'e', ai, i, bj, j})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
m.opCodes = opCodes
|
||||||
|
return m.opCodes
|
||||||
|
}
|
||||||
|
|
||||||
|
// Isolate change clusters by eliminating ranges with no changes.
|
||||||
|
//
|
||||||
|
// Return a generator of groups with up to n lines of context.
|
||||||
|
// Each group is in the same format as returned by GetOpCodes().
|
||||||
|
func (m *SequenceMatcher) GetGroupedOpCodes(n int) [][]OpCode {
|
||||||
|
if n < 0 {
|
||||||
|
n = 3
|
||||||
|
}
|
||||||
|
codes := m.GetOpCodes()
|
||||||
|
if len(codes) == 0 {
|
||||||
|
codes = []OpCode{OpCode{'e', 0, 1, 0, 1}}
|
||||||
|
}
|
||||||
|
// Fixup leading and trailing groups if they show no changes.
|
||||||
|
if codes[0].Tag == 'e' {
|
||||||
|
c := codes[0]
|
||||||
|
i1, i2, j1, j2 := c.I1, c.I2, c.J1, c.J2
|
||||||
|
codes[0] = OpCode{c.Tag, max(i1, i2-n), i2, max(j1, j2-n), j2}
|
||||||
|
}
|
||||||
|
if codes[len(codes)-1].Tag == 'e' {
|
||||||
|
c := codes[len(codes)-1]
|
||||||
|
i1, i2, j1, j2 := c.I1, c.I2, c.J1, c.J2
|
||||||
|
codes[len(codes)-1] = OpCode{c.Tag, i1, min(i2, i1+n), j1, min(j2, j1+n)}
|
||||||
|
}
|
||||||
|
nn := n + n
|
||||||
|
groups := [][]OpCode{}
|
||||||
|
group := []OpCode{}
|
||||||
|
for _, c := range codes {
|
||||||
|
i1, i2, j1, j2 := c.I1, c.I2, c.J1, c.J2
|
||||||
|
// End the current group and start a new one whenever
|
||||||
|
// there is a large range with no changes.
|
||||||
|
if c.Tag == 'e' && i2-i1 > nn {
|
||||||
|
group = append(group, OpCode{c.Tag, i1, min(i2, i1+n),
|
||||||
|
j1, min(j2, j1+n)})
|
||||||
|
groups = append(groups, group)
|
||||||
|
group = []OpCode{}
|
||||||
|
i1, j1 = max(i1, i2-n), max(j1, j2-n)
|
||||||
|
}
|
||||||
|
group = append(group, OpCode{c.Tag, i1, i2, j1, j2})
|
||||||
|
}
|
||||||
|
if len(group) > 0 && !(len(group) == 1 && group[0].Tag == 'e') {
|
||||||
|
groups = append(groups, group)
|
||||||
|
}
|
||||||
|
return groups
|
||||||
|
}
|
||||||
|
|
||||||
|
// Return a measure of the sequences' similarity (float in [0,1]).
|
||||||
|
//
|
||||||
|
// Where T is the total number of elements in both sequences, and
|
||||||
|
// M is the number of matches, this is 2.0*M / T.
|
||||||
|
// Note that this is 1 if the sequences are identical, and 0 if
|
||||||
|
// they have nothing in common.
|
||||||
|
//
|
||||||
|
// .Ratio() is expensive to compute if you haven't already computed
|
||||||
|
// .GetMatchingBlocks() or .GetOpCodes(), in which case you may
|
||||||
|
// want to try .QuickRatio() or .RealQuickRation() first to get an
|
||||||
|
// upper bound.
|
||||||
|
func (m *SequenceMatcher) Ratio() float64 {
|
||||||
|
matches := 0
|
||||||
|
for _, m := range m.GetMatchingBlocks() {
|
||||||
|
matches += m.Size
|
||||||
|
}
|
||||||
|
return calculateRatio(matches, len(m.a)+len(m.b))
|
||||||
|
}
|
||||||
|
|
||||||
|
// Return an upper bound on ratio() relatively quickly.
|
||||||
|
//
|
||||||
|
// This isn't defined beyond that it is an upper bound on .Ratio(), and
|
||||||
|
// is faster to compute.
|
||||||
|
func (m *SequenceMatcher) QuickRatio() float64 {
|
||||||
|
// viewing a and b as multisets, set matches to the cardinality
|
||||||
|
// of their intersection; this counts the number of matches
|
||||||
|
// without regard to order, so is clearly an upper bound
|
||||||
|
if m.fullBCount == nil {
|
||||||
|
m.fullBCount = map[string]int{}
|
||||||
|
for _, s := range m.b {
|
||||||
|
m.fullBCount[s] = m.fullBCount[s] + 1
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// avail[x] is the number of times x appears in 'b' less the
|
||||||
|
// number of times we've seen it in 'a' so far ... kinda
|
||||||
|
avail := map[string]int{}
|
||||||
|
matches := 0
|
||||||
|
for _, s := range m.a {
|
||||||
|
n, ok := avail[s]
|
||||||
|
if !ok {
|
||||||
|
n = m.fullBCount[s]
|
||||||
|
}
|
||||||
|
avail[s] = n - 1
|
||||||
|
if n > 0 {
|
||||||
|
matches += 1
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return calculateRatio(matches, len(m.a)+len(m.b))
|
||||||
|
}
|
||||||
|
|
||||||
|
// Return an upper bound on ratio() very quickly.
|
||||||
|
//
|
||||||
|
// This isn't defined beyond that it is an upper bound on .Ratio(), and
|
||||||
|
// is faster to compute than either .Ratio() or .QuickRatio().
|
||||||
|
func (m *SequenceMatcher) RealQuickRatio() float64 {
|
||||||
|
la, lb := len(m.a), len(m.b)
|
||||||
|
return calculateRatio(min(la, lb), la+lb)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Convert range to the "ed" format
|
||||||
|
func formatRangeUnified(start, stop int) string {
|
||||||
|
// Per the diff spec at http://www.unix.org/single_unix_specification/
|
||||||
|
beginning := start + 1 // lines start numbering with one
|
||||||
|
length := stop - start
|
||||||
|
if length == 1 {
|
||||||
|
return fmt.Sprintf("%d", beginning)
|
||||||
|
}
|
||||||
|
if length == 0 {
|
||||||
|
beginning -= 1 // empty ranges begin at line just before the range
|
||||||
|
}
|
||||||
|
return fmt.Sprintf("%d,%d", beginning, length)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Unified diff parameters
|
||||||
|
type UnifiedDiff struct {
|
||||||
|
A []string // First sequence lines
|
||||||
|
FromFile string // First file name
|
||||||
|
FromDate string // First file time
|
||||||
|
B []string // Second sequence lines
|
||||||
|
ToFile string // Second file name
|
||||||
|
ToDate string // Second file time
|
||||||
|
Eol string // Headers end of line, defaults to LF
|
||||||
|
Context int // Number of context lines
|
||||||
|
}
|
||||||
|
|
||||||
|
// Compare two sequences of lines; generate the delta as a unified diff.
|
||||||
|
//
|
||||||
|
// Unified diffs are a compact way of showing line changes and a few
|
||||||
|
// lines of context. The number of context lines is set by 'n' which
|
||||||
|
// defaults to three.
|
||||||
|
//
|
||||||
|
// By default, the diff control lines (those with ---, +++, or @@) are
|
||||||
|
// created with a trailing newline. This is helpful so that inputs
|
||||||
|
// created from file.readlines() result in diffs that are suitable for
|
||||||
|
// file.writelines() since both the inputs and outputs have trailing
|
||||||
|
// newlines.
|
||||||
|
//
|
||||||
|
// For inputs that do not have trailing newlines, set the lineterm
|
||||||
|
// argument to "" so that the output will be uniformly newline free.
|
||||||
|
//
|
||||||
|
// The unidiff format normally has a header for filenames and modification
|
||||||
|
// times. Any or all of these may be specified using strings for
|
||||||
|
// 'fromfile', 'tofile', 'fromfiledate', and 'tofiledate'.
|
||||||
|
// The modification times are normally expressed in the ISO 8601 format.
|
||||||
|
func WriteUnifiedDiff(writer io.Writer, diff UnifiedDiff) error {
|
||||||
|
buf := bufio.NewWriter(writer)
|
||||||
|
defer buf.Flush()
|
||||||
|
w := func(format string, args ...interface{}) error {
|
||||||
|
_, err := buf.WriteString(fmt.Sprintf(format, args...))
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(diff.Eol) == 0 {
|
||||||
|
diff.Eol = "\n"
|
||||||
|
}
|
||||||
|
|
||||||
|
started := false
|
||||||
|
m := NewMatcher(diff.A, diff.B)
|
||||||
|
for _, g := range m.GetGroupedOpCodes(diff.Context) {
|
||||||
|
if !started {
|
||||||
|
started = true
|
||||||
|
fromDate := ""
|
||||||
|
if len(diff.FromDate) > 0 {
|
||||||
|
fromDate = "\t" + diff.FromDate
|
||||||
|
}
|
||||||
|
toDate := ""
|
||||||
|
if len(diff.ToDate) > 0 {
|
||||||
|
toDate = "\t" + diff.ToDate
|
||||||
|
}
|
||||||
|
err := w("--- %s%s%s", diff.FromFile, fromDate, diff.Eol)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
err = w("+++ %s%s%s", diff.ToFile, toDate, diff.Eol)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
first, last := g[0], g[len(g)-1]
|
||||||
|
range1 := formatRangeUnified(first.I1, last.I2)
|
||||||
|
range2 := formatRangeUnified(first.J1, last.J2)
|
||||||
|
if err := w("@@ -%s +%s @@%s", range1, range2, diff.Eol); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
for _, c := range g {
|
||||||
|
i1, i2, j1, j2 := c.I1, c.I2, c.J1, c.J2
|
||||||
|
if c.Tag == 'e' {
|
||||||
|
for _, line := range diff.A[i1:i2] {
|
||||||
|
if err := w(" " + line); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if c.Tag == 'r' || c.Tag == 'd' {
|
||||||
|
for _, line := range diff.A[i1:i2] {
|
||||||
|
if err := w("-" + line); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if c.Tag == 'r' || c.Tag == 'i' {
|
||||||
|
for _, line := range diff.B[j1:j2] {
|
||||||
|
if err := w("+" + line); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Like WriteUnifiedDiff but returns the diff a string.
|
||||||
|
func GetUnifiedDiffString(diff UnifiedDiff) (string, error) {
|
||||||
|
w := &bytes.Buffer{}
|
||||||
|
err := WriteUnifiedDiff(w, diff)
|
||||||
|
return string(w.Bytes()), err
|
||||||
|
}
|
||||||
|
|
||||||
|
// Convert range to the "ed" format.
|
||||||
|
func formatRangeContext(start, stop int) string {
|
||||||
|
// Per the diff spec at http://www.unix.org/single_unix_specification/
|
||||||
|
beginning := start + 1 // lines start numbering with one
|
||||||
|
length := stop - start
|
||||||
|
if length == 0 {
|
||||||
|
beginning -= 1 // empty ranges begin at line just before the range
|
||||||
|
}
|
||||||
|
if length <= 1 {
|
||||||
|
return fmt.Sprintf("%d", beginning)
|
||||||
|
}
|
||||||
|
return fmt.Sprintf("%d,%d", beginning, beginning+length-1)
|
||||||
|
}
|
||||||
|
|
||||||
|
type ContextDiff UnifiedDiff
|
||||||
|
|
||||||
|
// Compare two sequences of lines; generate the delta as a context diff.
|
||||||
|
//
|
||||||
|
// Context diffs are a compact way of showing line changes and a few
|
||||||
|
// lines of context. The number of context lines is set by diff.Context
|
||||||
|
// which defaults to three.
|
||||||
|
//
|
||||||
|
// By default, the diff control lines (those with *** or ---) are
|
||||||
|
// created with a trailing newline.
|
||||||
|
//
|
||||||
|
// For inputs that do not have trailing newlines, set the diff.Eol
|
||||||
|
// argument to "" so that the output will be uniformly newline free.
|
||||||
|
//
|
||||||
|
// The context diff format normally has a header for filenames and
|
||||||
|
// modification times. Any or all of these may be specified using
|
||||||
|
// strings for diff.FromFile, diff.ToFile, diff.FromDate, diff.ToDate.
|
||||||
|
// The modification times are normally expressed in the ISO 8601 format.
|
||||||
|
// If not specified, the strings default to blanks.
|
||||||
|
func WriteContextDiff(writer io.Writer, diff ContextDiff) error {
|
||||||
|
buf := bufio.NewWriter(writer)
|
||||||
|
defer buf.Flush()
|
||||||
|
var diffErr error
|
||||||
|
w := func(format string, args ...interface{}) {
|
||||||
|
_, err := buf.WriteString(fmt.Sprintf(format, args...))
|
||||||
|
if diffErr == nil && err != nil {
|
||||||
|
diffErr = err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(diff.Eol) == 0 {
|
||||||
|
diff.Eol = "\n"
|
||||||
|
}
|
||||||
|
|
||||||
|
prefix := map[byte]string{
|
||||||
|
'i': "+ ",
|
||||||
|
'd': "- ",
|
||||||
|
'r': "! ",
|
||||||
|
'e': " ",
|
||||||
|
}
|
||||||
|
|
||||||
|
started := false
|
||||||
|
m := NewMatcher(diff.A, diff.B)
|
||||||
|
for _, g := range m.GetGroupedOpCodes(diff.Context) {
|
||||||
|
if !started {
|
||||||
|
started = true
|
||||||
|
fromDate := ""
|
||||||
|
if len(diff.FromDate) > 0 {
|
||||||
|
fromDate = "\t" + diff.FromDate
|
||||||
|
}
|
||||||
|
toDate := ""
|
||||||
|
if len(diff.ToDate) > 0 {
|
||||||
|
toDate = "\t" + diff.ToDate
|
||||||
|
}
|
||||||
|
w("*** %s%s%s", diff.FromFile, fromDate, diff.Eol)
|
||||||
|
w("--- %s%s%s", diff.ToFile, toDate, diff.Eol)
|
||||||
|
}
|
||||||
|
|
||||||
|
first, last := g[0], g[len(g)-1]
|
||||||
|
w("***************" + diff.Eol)
|
||||||
|
|
||||||
|
range1 := formatRangeContext(first.I1, last.I2)
|
||||||
|
w("*** %s ****%s", range1, diff.Eol)
|
||||||
|
for _, c := range g {
|
||||||
|
if c.Tag == 'r' || c.Tag == 'd' {
|
||||||
|
for _, cc := range g {
|
||||||
|
if cc.Tag == 'i' {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
for _, line := range diff.A[cc.I1:cc.I2] {
|
||||||
|
w(prefix[cc.Tag] + line)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
range2 := formatRangeContext(first.J1, last.J2)
|
||||||
|
w("--- %s ----%s", range2, diff.Eol)
|
||||||
|
for _, c := range g {
|
||||||
|
if c.Tag == 'r' || c.Tag == 'i' {
|
||||||
|
for _, cc := range g {
|
||||||
|
if cc.Tag == 'd' {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
for _, line := range diff.B[cc.J1:cc.J2] {
|
||||||
|
w(prefix[cc.Tag] + line)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return diffErr
|
||||||
|
}
|
||||||
|
|
||||||
|
// Like WriteContextDiff but returns the diff a string.
|
||||||
|
func GetContextDiffString(diff ContextDiff) (string, error) {
|
||||||
|
w := &bytes.Buffer{}
|
||||||
|
err := WriteContextDiff(w, diff)
|
||||||
|
return string(w.Bytes()), err
|
||||||
|
}
|
||||||
|
|
||||||
|
// Split a string on "\n" while preserving them. The output can be used
|
||||||
|
// as input for UnifiedDiff and ContextDiff structures.
|
||||||
|
func SplitLines(s string) []string {
|
||||||
|
lines := strings.SplitAfter(s, "\n")
|
||||||
|
lines[len(lines)-1] += "\n"
|
||||||
|
return lines
|
||||||
|
}
|
|
@ -0,0 +1,22 @@
|
||||||
|
Copyright (c) 2012 - 2013 Mat Ryer and Tyler Bunnell
|
||||||
|
|
||||||
|
Please consider promoting this project if you find it useful.
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person
|
||||||
|
obtaining a copy of this software and associated documentation
|
||||||
|
files (the "Software"), to deal in the Software without restriction,
|
||||||
|
including without limitation the rights to use, copy, modify, merge,
|
||||||
|
publish, distribute, sublicense, and/or sell copies of the Software,
|
||||||
|
and to permit persons to whom the Software is furnished to do so,
|
||||||
|
subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included
|
||||||
|
in all copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||||||
|
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
|
||||||
|
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
||||||
|
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
|
||||||
|
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
|
||||||
|
OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
|
||||||
|
OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
Plik binarny nie jest wyświetlany.
|
@ -0,0 +1,352 @@
|
||||||
|
/*
|
||||||
|
* CODE GENERATED AUTOMATICALLY WITH github.com/stretchr/testify/_codegen
|
||||||
|
* THIS FILE MUST NOT BE EDITED BY HAND
|
||||||
|
*/
|
||||||
|
|
||||||
|
package assert
|
||||||
|
|
||||||
|
import (
|
||||||
|
http "net/http"
|
||||||
|
url "net/url"
|
||||||
|
time "time"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Condition uses a Comparison to assert a complex condition.
|
||||||
|
func (a *Assertions) Condition(comp Comparison, msgAndArgs ...interface{}) bool {
|
||||||
|
return Condition(a.t, comp, msgAndArgs...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Contains asserts that the specified string, list(array, slice...) or map contains the
|
||||||
|
// specified substring or element.
|
||||||
|
//
|
||||||
|
// a.Contains("Hello World", "World", "But 'Hello World' does contain 'World'")
|
||||||
|
// a.Contains(["Hello", "World"], "World", "But ["Hello", "World"] does contain 'World'")
|
||||||
|
// a.Contains({"Hello": "World"}, "Hello", "But {'Hello': 'World'} does contain 'Hello'")
|
||||||
|
//
|
||||||
|
// Returns whether the assertion was successful (true) or not (false).
|
||||||
|
func (a *Assertions) Contains(s interface{}, contains interface{}, msgAndArgs ...interface{}) bool {
|
||||||
|
return Contains(a.t, s, contains, msgAndArgs...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Empty asserts that the specified object is empty. I.e. nil, "", false, 0 or either
|
||||||
|
// a slice or a channel with len == 0.
|
||||||
|
//
|
||||||
|
// a.Empty(obj)
|
||||||
|
//
|
||||||
|
// Returns whether the assertion was successful (true) or not (false).
|
||||||
|
func (a *Assertions) Empty(object interface{}, msgAndArgs ...interface{}) bool {
|
||||||
|
return Empty(a.t, object, msgAndArgs...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Equal asserts that two objects are equal.
|
||||||
|
//
|
||||||
|
// a.Equal(123, 123, "123 and 123 should be equal")
|
||||||
|
//
|
||||||
|
// Returns whether the assertion was successful (true) or not (false).
|
||||||
|
//
|
||||||
|
// Pointer variable equality is determined based on the equality of the
|
||||||
|
// referenced values (as opposed to the memory addresses).
|
||||||
|
func (a *Assertions) Equal(expected interface{}, actual interface{}, msgAndArgs ...interface{}) bool {
|
||||||
|
return Equal(a.t, expected, actual, msgAndArgs...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// EqualError asserts that a function returned an error (i.e. not `nil`)
|
||||||
|
// and that it is equal to the provided error.
|
||||||
|
//
|
||||||
|
// actualObj, err := SomeFunction()
|
||||||
|
// a.EqualError(err, expectedErrorString, "An error was expected")
|
||||||
|
//
|
||||||
|
// Returns whether the assertion was successful (true) or not (false).
|
||||||
|
func (a *Assertions) EqualError(theError error, errString string, msgAndArgs ...interface{}) bool {
|
||||||
|
return EqualError(a.t, theError, errString, msgAndArgs...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// EqualValues asserts that two objects are equal or convertable to the same types
|
||||||
|
// and equal.
|
||||||
|
//
|
||||||
|
// a.EqualValues(uint32(123), int32(123), "123 and 123 should be equal")
|
||||||
|
//
|
||||||
|
// Returns whether the assertion was successful (true) or not (false).
|
||||||
|
func (a *Assertions) EqualValues(expected interface{}, actual interface{}, msgAndArgs ...interface{}) bool {
|
||||||
|
return EqualValues(a.t, expected, actual, msgAndArgs...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Error asserts that a function returned an error (i.e. not `nil`).
|
||||||
|
//
|
||||||
|
// actualObj, err := SomeFunction()
|
||||||
|
// if a.Error(err, "An error was expected") {
|
||||||
|
// assert.Equal(t, err, expectedError)
|
||||||
|
// }
|
||||||
|
//
|
||||||
|
// Returns whether the assertion was successful (true) or not (false).
|
||||||
|
func (a *Assertions) Error(err error, msgAndArgs ...interface{}) bool {
|
||||||
|
return Error(a.t, err, msgAndArgs...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Exactly asserts that two objects are equal is value and type.
|
||||||
|
//
|
||||||
|
// a.Exactly(int32(123), int64(123), "123 and 123 should NOT be equal")
|
||||||
|
//
|
||||||
|
// Returns whether the assertion was successful (true) or not (false).
|
||||||
|
func (a *Assertions) Exactly(expected interface{}, actual interface{}, msgAndArgs ...interface{}) bool {
|
||||||
|
return Exactly(a.t, expected, actual, msgAndArgs...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Fail reports a failure through
|
||||||
|
func (a *Assertions) Fail(failureMessage string, msgAndArgs ...interface{}) bool {
|
||||||
|
return Fail(a.t, failureMessage, msgAndArgs...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// FailNow fails test
|
||||||
|
func (a *Assertions) FailNow(failureMessage string, msgAndArgs ...interface{}) bool {
|
||||||
|
return FailNow(a.t, failureMessage, msgAndArgs...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// False asserts that the specified value is false.
|
||||||
|
//
|
||||||
|
// a.False(myBool, "myBool should be false")
|
||||||
|
//
|
||||||
|
// Returns whether the assertion was successful (true) or not (false).
|
||||||
|
func (a *Assertions) False(value bool, msgAndArgs ...interface{}) bool {
|
||||||
|
return False(a.t, value, msgAndArgs...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// HTTPBodyContains asserts that a specified handler returns a
|
||||||
|
// body that contains a string.
|
||||||
|
//
|
||||||
|
// a.HTTPBodyContains(myHandler, "www.google.com", nil, "I'm Feeling Lucky")
|
||||||
|
//
|
||||||
|
// Returns whether the assertion was successful (true) or not (false).
|
||||||
|
func (a *Assertions) HTTPBodyContains(handler http.HandlerFunc, method string, url string, values url.Values, str interface{}) bool {
|
||||||
|
return HTTPBodyContains(a.t, handler, method, url, values, str)
|
||||||
|
}
|
||||||
|
|
||||||
|
// HTTPBodyNotContains asserts that a specified handler returns a
|
||||||
|
// body that does not contain a string.
|
||||||
|
//
|
||||||
|
// a.HTTPBodyNotContains(myHandler, "www.google.com", nil, "I'm Feeling Lucky")
|
||||||
|
//
|
||||||
|
// Returns whether the assertion was successful (true) or not (false).
|
||||||
|
func (a *Assertions) HTTPBodyNotContains(handler http.HandlerFunc, method string, url string, values url.Values, str interface{}) bool {
|
||||||
|
return HTTPBodyNotContains(a.t, handler, method, url, values, str)
|
||||||
|
}
|
||||||
|
|
||||||
|
// HTTPError asserts that a specified handler returns an error status code.
|
||||||
|
//
|
||||||
|
// a.HTTPError(myHandler, "POST", "/a/b/c", url.Values{"a": []string{"b", "c"}}
|
||||||
|
//
|
||||||
|
// Returns whether the assertion was successful (true) or not (false).
|
||||||
|
func (a *Assertions) HTTPError(handler http.HandlerFunc, method string, url string, values url.Values) bool {
|
||||||
|
return HTTPError(a.t, handler, method, url, values)
|
||||||
|
}
|
||||||
|
|
||||||
|
// HTTPRedirect asserts that a specified handler returns a redirect status code.
|
||||||
|
//
|
||||||
|
// a.HTTPRedirect(myHandler, "GET", "/a/b/c", url.Values{"a": []string{"b", "c"}}
|
||||||
|
//
|
||||||
|
// Returns whether the assertion was successful (true) or not (false).
|
||||||
|
func (a *Assertions) HTTPRedirect(handler http.HandlerFunc, method string, url string, values url.Values) bool {
|
||||||
|
return HTTPRedirect(a.t, handler, method, url, values)
|
||||||
|
}
|
||||||
|
|
||||||
|
// HTTPSuccess asserts that a specified handler returns a success status code.
|
||||||
|
//
|
||||||
|
// a.HTTPSuccess(myHandler, "POST", "http://www.google.com", nil)
|
||||||
|
//
|
||||||
|
// Returns whether the assertion was successful (true) or not (false).
|
||||||
|
func (a *Assertions) HTTPSuccess(handler http.HandlerFunc, method string, url string, values url.Values) bool {
|
||||||
|
return HTTPSuccess(a.t, handler, method, url, values)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Implements asserts that an object is implemented by the specified interface.
|
||||||
|
//
|
||||||
|
// a.Implements((*MyInterface)(nil), new(MyObject), "MyObject")
|
||||||
|
func (a *Assertions) Implements(interfaceObject interface{}, object interface{}, msgAndArgs ...interface{}) bool {
|
||||||
|
return Implements(a.t, interfaceObject, object, msgAndArgs...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// InDelta asserts that the two numerals are within delta of each other.
|
||||||
|
//
|
||||||
|
// a.InDelta(math.Pi, (22 / 7.0), 0.01)
|
||||||
|
//
|
||||||
|
// Returns whether the assertion was successful (true) or not (false).
|
||||||
|
func (a *Assertions) InDelta(expected interface{}, actual interface{}, delta float64, msgAndArgs ...interface{}) bool {
|
||||||
|
return InDelta(a.t, expected, actual, delta, msgAndArgs...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// InDeltaSlice is the same as InDelta, except it compares two slices.
|
||||||
|
func (a *Assertions) InDeltaSlice(expected interface{}, actual interface{}, delta float64, msgAndArgs ...interface{}) bool {
|
||||||
|
return InDeltaSlice(a.t, expected, actual, delta, msgAndArgs...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// InEpsilon asserts that expected and actual have a relative error less than epsilon
|
||||||
|
//
|
||||||
|
// Returns whether the assertion was successful (true) or not (false).
|
||||||
|
func (a *Assertions) InEpsilon(expected interface{}, actual interface{}, epsilon float64, msgAndArgs ...interface{}) bool {
|
||||||
|
return InEpsilon(a.t, expected, actual, epsilon, msgAndArgs...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// InEpsilonSlice is the same as InEpsilon, except it compares each value from two slices.
|
||||||
|
func (a *Assertions) InEpsilonSlice(expected interface{}, actual interface{}, epsilon float64, msgAndArgs ...interface{}) bool {
|
||||||
|
return InEpsilonSlice(a.t, expected, actual, epsilon, msgAndArgs...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// IsType asserts that the specified objects are of the same type.
|
||||||
|
func (a *Assertions) IsType(expectedType interface{}, object interface{}, msgAndArgs ...interface{}) bool {
|
||||||
|
return IsType(a.t, expectedType, object, msgAndArgs...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// JSONEq asserts that two JSON strings are equivalent.
|
||||||
|
//
|
||||||
|
// a.JSONEq(`{"hello": "world", "foo": "bar"}`, `{"foo": "bar", "hello": "world"}`)
|
||||||
|
//
|
||||||
|
// Returns whether the assertion was successful (true) or not (false).
|
||||||
|
func (a *Assertions) JSONEq(expected string, actual string, msgAndArgs ...interface{}) bool {
|
||||||
|
return JSONEq(a.t, expected, actual, msgAndArgs...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Len asserts that the specified object has specific length.
|
||||||
|
// Len also fails if the object has a type that len() not accept.
|
||||||
|
//
|
||||||
|
// a.Len(mySlice, 3, "The size of slice is not 3")
|
||||||
|
//
|
||||||
|
// Returns whether the assertion was successful (true) or not (false).
|
||||||
|
func (a *Assertions) Len(object interface{}, length int, msgAndArgs ...interface{}) bool {
|
||||||
|
return Len(a.t, object, length, msgAndArgs...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Nil asserts that the specified object is nil.
|
||||||
|
//
|
||||||
|
// a.Nil(err, "err should be nothing")
|
||||||
|
//
|
||||||
|
// Returns whether the assertion was successful (true) or not (false).
|
||||||
|
func (a *Assertions) Nil(object interface{}, msgAndArgs ...interface{}) bool {
|
||||||
|
return Nil(a.t, object, msgAndArgs...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// NoError asserts that a function returned no error (i.e. `nil`).
|
||||||
|
//
|
||||||
|
// actualObj, err := SomeFunction()
|
||||||
|
// if a.NoError(err) {
|
||||||
|
// assert.Equal(t, actualObj, expectedObj)
|
||||||
|
// }
|
||||||
|
//
|
||||||
|
// Returns whether the assertion was successful (true) or not (false).
|
||||||
|
func (a *Assertions) NoError(err error, msgAndArgs ...interface{}) bool {
|
||||||
|
return NoError(a.t, err, msgAndArgs...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// NotContains asserts that the specified string, list(array, slice...) or map does NOT contain the
|
||||||
|
// specified substring or element.
|
||||||
|
//
|
||||||
|
// a.NotContains("Hello World", "Earth", "But 'Hello World' does NOT contain 'Earth'")
|
||||||
|
// a.NotContains(["Hello", "World"], "Earth", "But ['Hello', 'World'] does NOT contain 'Earth'")
|
||||||
|
// a.NotContains({"Hello": "World"}, "Earth", "But {'Hello': 'World'} does NOT contain 'Earth'")
|
||||||
|
//
|
||||||
|
// Returns whether the assertion was successful (true) or not (false).
|
||||||
|
func (a *Assertions) NotContains(s interface{}, contains interface{}, msgAndArgs ...interface{}) bool {
|
||||||
|
return NotContains(a.t, s, contains, msgAndArgs...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// NotEmpty asserts that the specified object is NOT empty. I.e. not nil, "", false, 0 or either
|
||||||
|
// a slice or a channel with len == 0.
|
||||||
|
//
|
||||||
|
// if a.NotEmpty(obj) {
|
||||||
|
// assert.Equal(t, "two", obj[1])
|
||||||
|
// }
|
||||||
|
//
|
||||||
|
// Returns whether the assertion was successful (true) or not (false).
|
||||||
|
func (a *Assertions) NotEmpty(object interface{}, msgAndArgs ...interface{}) bool {
|
||||||
|
return NotEmpty(a.t, object, msgAndArgs...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// NotEqual asserts that the specified values are NOT equal.
|
||||||
|
//
|
||||||
|
// a.NotEqual(obj1, obj2, "two objects shouldn't be equal")
|
||||||
|
//
|
||||||
|
// Returns whether the assertion was successful (true) or not (false).
|
||||||
|
//
|
||||||
|
// Pointer variable equality is determined based on the equality of the
|
||||||
|
// referenced values (as opposed to the memory addresses).
|
||||||
|
func (a *Assertions) NotEqual(expected interface{}, actual interface{}, msgAndArgs ...interface{}) bool {
|
||||||
|
return NotEqual(a.t, expected, actual, msgAndArgs...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// NotNil asserts that the specified object is not nil.
|
||||||
|
//
|
||||||
|
// a.NotNil(err, "err should be something")
|
||||||
|
//
|
||||||
|
// Returns whether the assertion was successful (true) or not (false).
|
||||||
|
func (a *Assertions) NotNil(object interface{}, msgAndArgs ...interface{}) bool {
|
||||||
|
return NotNil(a.t, object, msgAndArgs...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// NotPanics asserts that the code inside the specified PanicTestFunc does NOT panic.
|
||||||
|
//
|
||||||
|
// a.NotPanics(func(){
|
||||||
|
// RemainCalm()
|
||||||
|
// }, "Calling RemainCalm() should NOT panic")
|
||||||
|
//
|
||||||
|
// Returns whether the assertion was successful (true) or not (false).
|
||||||
|
func (a *Assertions) NotPanics(f PanicTestFunc, msgAndArgs ...interface{}) bool {
|
||||||
|
return NotPanics(a.t, f, msgAndArgs...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// NotRegexp asserts that a specified regexp does not match a string.
|
||||||
|
//
|
||||||
|
// a.NotRegexp(regexp.MustCompile("starts"), "it's starting")
|
||||||
|
// a.NotRegexp("^start", "it's not starting")
|
||||||
|
//
|
||||||
|
// Returns whether the assertion was successful (true) or not (false).
|
||||||
|
func (a *Assertions) NotRegexp(rx interface{}, str interface{}, msgAndArgs ...interface{}) bool {
|
||||||
|
return NotRegexp(a.t, rx, str, msgAndArgs...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// NotZero asserts that i is not the zero value for its type and returns the truth.
|
||||||
|
func (a *Assertions) NotZero(i interface{}, msgAndArgs ...interface{}) bool {
|
||||||
|
return NotZero(a.t, i, msgAndArgs...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Panics asserts that the code inside the specified PanicTestFunc panics.
|
||||||
|
//
|
||||||
|
// a.Panics(func(){
|
||||||
|
// GoCrazy()
|
||||||
|
// }, "Calling GoCrazy() should panic")
|
||||||
|
//
|
||||||
|
// Returns whether the assertion was successful (true) or not (false).
|
||||||
|
func (a *Assertions) Panics(f PanicTestFunc, msgAndArgs ...interface{}) bool {
|
||||||
|
return Panics(a.t, f, msgAndArgs...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Regexp asserts that a specified regexp matches a string.
|
||||||
|
//
|
||||||
|
// a.Regexp(regexp.MustCompile("start"), "it's starting")
|
||||||
|
// a.Regexp("start...$", "it's not starting")
|
||||||
|
//
|
||||||
|
// Returns whether the assertion was successful (true) or not (false).
|
||||||
|
func (a *Assertions) Regexp(rx interface{}, str interface{}, msgAndArgs ...interface{}) bool {
|
||||||
|
return Regexp(a.t, rx, str, msgAndArgs...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// True asserts that the specified value is true.
|
||||||
|
//
|
||||||
|
// a.True(myBool, "myBool should be true")
|
||||||
|
//
|
||||||
|
// Returns whether the assertion was successful (true) or not (false).
|
||||||
|
func (a *Assertions) True(value bool, msgAndArgs ...interface{}) bool {
|
||||||
|
return True(a.t, value, msgAndArgs...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// WithinDuration asserts that the two times are within duration delta of each other.
|
||||||
|
//
|
||||||
|
// a.WithinDuration(time.Now(), time.Now(), 10*time.Second, "The difference should not be more than 10s")
|
||||||
|
//
|
||||||
|
// Returns whether the assertion was successful (true) or not (false).
|
||||||
|
func (a *Assertions) WithinDuration(expected time.Time, actual time.Time, delta time.Duration, msgAndArgs ...interface{}) bool {
|
||||||
|
return WithinDuration(a.t, expected, actual, delta, msgAndArgs...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Zero asserts that i is the zero value for its type and returns the truth.
|
||||||
|
func (a *Assertions) Zero(i interface{}, msgAndArgs ...interface{}) bool {
|
||||||
|
return Zero(a.t, i, msgAndArgs...)
|
||||||
|
}
|
|
@ -0,0 +1,4 @@
|
||||||
|
{{.CommentWithoutT "a"}}
|
||||||
|
func (a *Assertions) {{.DocInfo.Name}}({{.Params}}) bool {
|
||||||
|
return {{.DocInfo.Name}}(a.t, {{.ForwardedParams}})
|
||||||
|
}
|
Plik diff jest za duży
Load Diff
|
@ -0,0 +1,45 @@
|
||||||
|
// Package assert provides a set of comprehensive testing tools for use with the normal Go testing system.
|
||||||
|
//
|
||||||
|
// Example Usage
|
||||||
|
//
|
||||||
|
// The following is a complete example using assert in a standard test function:
|
||||||
|
// import (
|
||||||
|
// "testing"
|
||||||
|
// "github.com/stretchr/testify/assert"
|
||||||
|
// )
|
||||||
|
//
|
||||||
|
// func TestSomething(t *testing.T) {
|
||||||
|
//
|
||||||
|
// var a string = "Hello"
|
||||||
|
// var b string = "Hello"
|
||||||
|
//
|
||||||
|
// assert.Equal(t, a, b, "The two words should be the same.")
|
||||||
|
//
|
||||||
|
// }
|
||||||
|
//
|
||||||
|
// if you assert many times, use the format below:
|
||||||
|
//
|
||||||
|
// import (
|
||||||
|
// "testing"
|
||||||
|
// "github.com/stretchr/testify/assert"
|
||||||
|
// )
|
||||||
|
//
|
||||||
|
// func TestSomething(t *testing.T) {
|
||||||
|
// assert := assert.New(t)
|
||||||
|
//
|
||||||
|
// var a string = "Hello"
|
||||||
|
// var b string = "Hello"
|
||||||
|
//
|
||||||
|
// assert.Equal(a, b, "The two words should be the same.")
|
||||||
|
// }
|
||||||
|
//
|
||||||
|
// Assertions
|
||||||
|
//
|
||||||
|
// Assertions allow you to easily write test code, and are global funcs in the `assert` package.
|
||||||
|
// All assertion functions take, as the first argument, the `*testing.T` object provided by the
|
||||||
|
// testing framework. This allows the assertion funcs to write the failings and other details to
|
||||||
|
// the correct place.
|
||||||
|
//
|
||||||
|
// Every assertion function also takes an optional string message as the final argument,
|
||||||
|
// allowing custom error messages to be appended to the message the assertion method outputs.
|
||||||
|
package assert
|
|
@ -0,0 +1,10 @@
|
||||||
|
package assert
|
||||||
|
|
||||||
|
import (
|
||||||
|
"errors"
|
||||||
|
)
|
||||||
|
|
||||||
|
// AnError is an error instance useful for testing. If the code does not care
|
||||||
|
// about error specifics, and only needs to return the error for example, this
|
||||||
|
// error should be used to make the test code more readable.
|
||||||
|
var AnError = errors.New("assert.AnError general error for testing")
|
|
@ -0,0 +1,16 @@
|
||||||
|
package assert
|
||||||
|
|
||||||
|
// Assertions provides assertion methods around the
|
||||||
|
// TestingT interface.
|
||||||
|
type Assertions struct {
|
||||||
|
t TestingT
|
||||||
|
}
|
||||||
|
|
||||||
|
// New makes a new Assertions object for the specified TestingT.
|
||||||
|
func New(t TestingT) *Assertions {
|
||||||
|
return &Assertions{
|
||||||
|
t: t,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
//go:generate go run ../_codegen/main.go -output-package=assert -template=assertion_forward.go.tmpl
|
|
@ -0,0 +1,106 @@
|
||||||
|
package assert
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"net/http"
|
||||||
|
"net/http/httptest"
|
||||||
|
"net/url"
|
||||||
|
"strings"
|
||||||
|
)
|
||||||
|
|
||||||
|
// httpCode is a helper that returns HTTP code of the response. It returns -1
|
||||||
|
// if building a new request fails.
|
||||||
|
func httpCode(handler http.HandlerFunc, method, url string, values url.Values) int {
|
||||||
|
w := httptest.NewRecorder()
|
||||||
|
req, err := http.NewRequest(method, url+"?"+values.Encode(), nil)
|
||||||
|
if err != nil {
|
||||||
|
return -1
|
||||||
|
}
|
||||||
|
handler(w, req)
|
||||||
|
return w.Code
|
||||||
|
}
|
||||||
|
|
||||||
|
// HTTPSuccess asserts that a specified handler returns a success status code.
|
||||||
|
//
|
||||||
|
// assert.HTTPSuccess(t, myHandler, "POST", "http://www.google.com", nil)
|
||||||
|
//
|
||||||
|
// Returns whether the assertion was successful (true) or not (false).
|
||||||
|
func HTTPSuccess(t TestingT, handler http.HandlerFunc, method, url string, values url.Values) bool {
|
||||||
|
code := httpCode(handler, method, url, values)
|
||||||
|
if code == -1 {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
return code >= http.StatusOK && code <= http.StatusPartialContent
|
||||||
|
}
|
||||||
|
|
||||||
|
// HTTPRedirect asserts that a specified handler returns a redirect status code.
|
||||||
|
//
|
||||||
|
// assert.HTTPRedirect(t, myHandler, "GET", "/a/b/c", url.Values{"a": []string{"b", "c"}}
|
||||||
|
//
|
||||||
|
// Returns whether the assertion was successful (true) or not (false).
|
||||||
|
func HTTPRedirect(t TestingT, handler http.HandlerFunc, method, url string, values url.Values) bool {
|
||||||
|
code := httpCode(handler, method, url, values)
|
||||||
|
if code == -1 {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
return code >= http.StatusMultipleChoices && code <= http.StatusTemporaryRedirect
|
||||||
|
}
|
||||||
|
|
||||||
|
// HTTPError asserts that a specified handler returns an error status code.
|
||||||
|
//
|
||||||
|
// assert.HTTPError(t, myHandler, "POST", "/a/b/c", url.Values{"a": []string{"b", "c"}}
|
||||||
|
//
|
||||||
|
// Returns whether the assertion was successful (true) or not (false).
|
||||||
|
func HTTPError(t TestingT, handler http.HandlerFunc, method, url string, values url.Values) bool {
|
||||||
|
code := httpCode(handler, method, url, values)
|
||||||
|
if code == -1 {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
return code >= http.StatusBadRequest
|
||||||
|
}
|
||||||
|
|
||||||
|
// HTTPBody is a helper that returns HTTP body of the response. It returns
|
||||||
|
// empty string if building a new request fails.
|
||||||
|
func HTTPBody(handler http.HandlerFunc, method, url string, values url.Values) string {
|
||||||
|
w := httptest.NewRecorder()
|
||||||
|
req, err := http.NewRequest(method, url+"?"+values.Encode(), nil)
|
||||||
|
if err != nil {
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
handler(w, req)
|
||||||
|
return w.Body.String()
|
||||||
|
}
|
||||||
|
|
||||||
|
// HTTPBodyContains asserts that a specified handler returns a
|
||||||
|
// body that contains a string.
|
||||||
|
//
|
||||||
|
// assert.HTTPBodyContains(t, myHandler, "www.google.com", nil, "I'm Feeling Lucky")
|
||||||
|
//
|
||||||
|
// Returns whether the assertion was successful (true) or not (false).
|
||||||
|
func HTTPBodyContains(t TestingT, handler http.HandlerFunc, method, url string, values url.Values, str interface{}) bool {
|
||||||
|
body := HTTPBody(handler, method, url, values)
|
||||||
|
|
||||||
|
contains := strings.Contains(body, fmt.Sprint(str))
|
||||||
|
if !contains {
|
||||||
|
Fail(t, fmt.Sprintf("Expected response body for \"%s\" to contain \"%s\" but found \"%s\"", url+"?"+values.Encode(), str, body))
|
||||||
|
}
|
||||||
|
|
||||||
|
return contains
|
||||||
|
}
|
||||||
|
|
||||||
|
// HTTPBodyNotContains asserts that a specified handler returns a
|
||||||
|
// body that does not contain a string.
|
||||||
|
//
|
||||||
|
// assert.HTTPBodyNotContains(t, myHandler, "www.google.com", nil, "I'm Feeling Lucky")
|
||||||
|
//
|
||||||
|
// Returns whether the assertion was successful (true) or not (false).
|
||||||
|
func HTTPBodyNotContains(t TestingT, handler http.HandlerFunc, method, url string, values url.Values, str interface{}) bool {
|
||||||
|
body := HTTPBody(handler, method, url, values)
|
||||||
|
|
||||||
|
contains := strings.Contains(body, fmt.Sprint(str))
|
||||||
|
if contains {
|
||||||
|
Fail(t, fmt.Sprintf("Expected response body for \"%s\" to NOT contain \"%s\" but found \"%s\"", url+"?"+values.Encode(), str, body))
|
||||||
|
}
|
||||||
|
|
||||||
|
return !contains
|
||||||
|
}
|
|
@ -0,0 +1,57 @@
|
||||||
|
{
|
||||||
|
"comment": "",
|
||||||
|
"ignore": "test",
|
||||||
|
"package": [
|
||||||
|
{
|
||||||
|
"checksumSHA1": "AcWCvzWyeJdc1Iw/Gw6upQPsroE=",
|
||||||
|
"path": "github.com/BurntSushi/xgb",
|
||||||
|
"revision": "27f122750802c950b2c869a5b63dafcf590ced95",
|
||||||
|
"revisionTime": "2016-05-22T18:18:43Z"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"checksumSHA1": "i8V/eYv4tGJs3tL6lpz7IEvRYVs=",
|
||||||
|
"path": "github.com/BurntSushi/xgb/xproto",
|
||||||
|
"revision": "27f122750802c950b2c869a5b63dafcf590ced95",
|
||||||
|
"revisionTime": "2016-05-22T18:18:43Z"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"checksumSHA1": "0i0VqgwQdvY01/RdxtRu6MCGwZs=",
|
||||||
|
"path": "github.com/BurntSushi/xgb/xtest",
|
||||||
|
"revision": "27f122750802c950b2c869a5b63dafcf590ced95",
|
||||||
|
"revisionTime": "2016-05-22T18:18:43Z"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"checksumSHA1": "DuHM9UBDn6AHdGqYDMZZqzFMOkI=",
|
||||||
|
"path": "github.com/bendahl/uinput",
|
||||||
|
"revision": "050ec524df761f5a128a5bb9bb5b7609f1886f21",
|
||||||
|
"revisionTime": "2017-06-20T19:50:18Z"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"checksumSHA1": "OFu4xJEIjiI8Suu+j/gabfp+y6Q=",
|
||||||
|
"origin": "github.com/stretchr/testify/vendor/github.com/davecgh/go-spew/spew",
|
||||||
|
"path": "github.com/davecgh/go-spew/spew",
|
||||||
|
"revision": "2402e8e7a02fc811447d11f881aa9746cdc57983",
|
||||||
|
"revisionTime": "2016-12-17T20:04:45Z"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"checksumSHA1": "B8TpaihN7IAVweKEqETyEisecbw=",
|
||||||
|
"path": "github.com/gvalkov/golang-evdev",
|
||||||
|
"revision": "87c03aa1a370124ec5a5fac733a629e0f9acd9a6",
|
||||||
|
"revisionTime": "2016-09-25T11:10:49Z"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"checksumSHA1": "zKKp5SZ3d3ycKe4EKMNT0BqAWBw=",
|
||||||
|
"origin": "github.com/stretchr/testify/vendor/github.com/pmezard/go-difflib/difflib",
|
||||||
|
"path": "github.com/pmezard/go-difflib/difflib",
|
||||||
|
"revision": "2402e8e7a02fc811447d11f881aa9746cdc57983",
|
||||||
|
"revisionTime": "2016-12-17T20:04:45Z"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"checksumSHA1": "c4Fu2xN9Wt2qhupbwp0atOtragE=",
|
||||||
|
"path": "github.com/stretchr/testify/assert",
|
||||||
|
"revision": "2402e8e7a02fc811447d11f881aa9746cdc57983",
|
||||||
|
"revisionTime": "2016-12-17T20:04:45Z"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"rootPath": "github.com/abourget/shuttle-go"
|
||||||
|
}
|
|
@ -9,7 +9,7 @@ import (
|
||||||
)
|
)
|
||||||
|
|
||||||
var xinputDevices = []*regexp.Regexp{
|
var xinputDevices = []*regexp.Regexp{
|
||||||
regexp.MustCompile(`↳ Contour Design ShuttlePRO v2\s+id=(\d)\s`),
|
regexp.MustCompile(`↳ Contour Design ShuttlePRO v2\s+id=(\d+)\s`),
|
||||||
}
|
}
|
||||||
|
|
||||||
func disableXInputPointer() {
|
func disableXInputPointer() {
|
||||||
|
|
Ładowanie…
Reference in New Issue