Commit graph

375 commits

Author SHA1 Message Date
Daniel Martin
eb38fd9af8 specs: XI2: Rename AxisClass to ValuatorClass
ValuatorClass is the XI2 term for AxisClass.

Signed-off-by: Daniel Martin <consume.noise@gmail.com>
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2012-11-07 21:47:08 +10:00
Daniel Martin
b30e7221b8 specs: XI2: Fix typos
Signed-off-by: Daniel Martin <consume.noise@gmail.com>
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2012-11-07 21:46:42 +10:00
Peter Hutterer
743cb2cf15 XI2proto: spec formatting fix
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2012-11-02 15:37:28 +10:00
Ran Benita
a06905c8ef specs: XI2: add titles to requests/events and show them in TOC
You often want to quickly jump to the specification of a specific
request/event, so add them to the table of contents to allow for that.
This also provides the reader with a quick glance at what the protocol
looks like.

Signed-off-by: Ran Benita <ran234@gmail.com>
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2012-10-29 16:31:52 +10:00
Ran Benita
7409807176 specs: XI2: make event/request name formatting consistent
None of the other have ':' there.

Signed-off-by: Ran Benita <ran234@gmail.com>
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2012-10-29 16:31:38 +10:00
Peter Hutterer
3ed8aed321 Fix two typos in spec/comments
The ButtonClass provides the number of buttons, not the lentgh of the mask.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2012-06-14 08:57:32 +10:00
Peter Hutterer
e752e92dbd inputproto 2.2
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2012-03-02 12:58:18 +10:00
Peter Hutterer
b02b0b42e2 specs: XI 2.2 release date is March 2012
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Reviewed-by: Chase Douglas <chase.douglas@canonical.com>
2012-03-02 12:05:04 +10:00
Peter Hutterer
950a7a0b2e specs: Remove work in progress warning
We're close enough to a release now.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Reviewed-by: Chase Douglas <chase.douglas@canonical.com>
2012-03-02 12:05:04 +10:00
Peter Hutterer
3ac053f2c7 specs: remove "since" from TouchOwnershipEvent
It's already in a section "Events introduced in version 2.2"

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Reviewed-by: Chase Douglas <chase.douglas@canonical.com>
2012-03-02 12:05:04 +10:00
Peter Hutterer
b42e4d24a2 specs: remove TouchOwnership mention from DeviceEvent
TouchOwnership is described separately below.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Reviewed-by: Chase Douglas <chase.douglas@canonical.com>
2012-03-02 12:05:04 +10:00
Peter Hutterer
a09ca92ce3 specs: whitespace fix to avoid wrong asciidoc formatting
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Reviewed-by: Chase Douglas <chase.douglas@canonical.com>
2012-03-02 12:05:04 +10:00
Peter Hutterer
b1458f6fa9 specs: fix link to touch ownership section
Introduced in 535a4377dd

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Reviewed-by: Chase Douglas <chase.douglas@canonical.com>
2012-03-02 12:05:04 +10:00
Peter Hutterer
b321ea46fb specs: GrabtypeTouchBegin was added in XI 2.2
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Reviewed-by: Chase Douglas <chase.douglas@canonical.com>
2012-03-02 12:05:04 +10:00
Peter Hutterer
3773e33579 specs: formatting fix, move AcceptTouch and RejectTouch onto their own line
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Reviewed-by: Chase Douglas <chase.douglas@canonical.com>
2012-03-02 12:05:04 +10:00
Peter Hutterer
4de6f26a70 specs: replace † with ²
† looks too much like a letter and we can't use * and ** because asciidoc
interprets it as lists.

Use numbers instead, and replace all current * with ¹.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Reviewed-by: Chase Douglas <chase.douglas@canonical.com>
2012-03-02 12:05:03 +10:00
Peter Hutterer
000a20296a specs: XITouchClass doesn't have properties
Leftover from an earlier version.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Reviewed-by: Chase Douglas <chase.douglas@canonical.com>
2012-03-02 12:05:03 +10:00
Peter Hutterer
0d7bfc10bf specs: Formatting fix
asciidoc requires caption to be on one line but this one here is too long.
Split it up instead.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Reviewed-by: Chase Douglas <chase.douglas@canonical.com>
2012-03-02 12:05:03 +10:00
Peter Hutterer
883143e345 specs: some wording fixes
Button press events are insufficient even on scroll wheels, so don't say
they are good enough.

Remove duplicate claim of event emulation

Don't claim we send touch events "without delay"

Touch screens hardly ever "physically move" an object.

Hyphenate "implementation-dependent"

Remove unnecessary "however"

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Reviewed-by: Chase Douglas <chase.douglas@canonical.com>
2012-03-02 12:05:01 +10:00
Peter Hutterer
9a2e10213c specs: fix typos 'hierachy' → 'hierarchy'
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Reviewed-by: Chase Douglas <chase.douglas@canonical.com>
2012-03-02 10:49:59 +10:00
Peter Hutterer
5e18f74e24 Unbreak protocol ABI for XIAllowEvents - inputproto 2.1.99.6
XIAllowEvents was extended with touchid and grab_window in
2ea2f99f4f. This extended the size of
the request from 12 to 20 but also broke the ABI. Older server
match the request size exactly, so compiling libXi 1.5 against
inputproto 2.2 and then running it against a pre-XI 2.2 server causes a
BadLength for any XIAllowEvent request.

Add a new request for the new data.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Reviewed-by: Keith Packard <keithp@keithp.com>
2012-02-09 08:02:59 +10:00
Peter Hutterer
217afacda0 specs: explain touch behaviour for dependent devices
Dependent devices don't send touch events until the interaction is a true
touch interaction (i.e. doesn't just serve to move the pointer). Once that
happens, all touchpoints send touch events exclusively. Pointer movement
restarts once we're down to one touch that controls the pointer again.

For clients listening to touch events in addition to pointer events, this
also means that a two-finger tap looks identical to holding one finger down
and tapping with a second-finger. Both actions will result in short
TouchBegin/TouchEnd sequences for both fingers.

The above is the default behaviour we expect from touchpads, the protocol is
more generically worded to leave more room for drivers to decide when a
touch only controls the pointer and when it doesn't.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Reviewed-by: Chase Douglas <chase.douglas@canonical.com>
2012-02-02 17:39:39 +10:00
Peter Hutterer
fc9372868b specs: move touch support details to "Touch device support" section
Keep the changelog small.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Reviewed-by: Chase Douglas <chase.douglas@canonical.com>
2012-01-31 22:20:17 +10:00
Peter Hutterer
92f769675b specs: remove superfluous "Changes introduced by ..."
The line right above says the same thing.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Reviewed-by: Chase Douglas <chase.douglas@canonical.com>
2012-01-31 22:19:58 +10:00
Peter Hutterer
556ea96060 specs: move touch mode explanations to where it belongs
Rather than have two different explanations to the touch modes, remove it
from the "Changes in version 2.2" section and merge the content into the
text.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Reviewed-by: Chase Douglas <chase.douglas@canonical.com>
2012-01-31 22:19:41 +10:00
Gaetan Nadon
535a4377dd specs: replace hard coded number in some "See section" references
The glossary does not accept <<links>> however.

Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Reviewed-by: Chase Douglas <chase.douglas@canonical.com>
2012-01-26 13:23:15 +10:00
Gaetan Nadon
f3d2feead4 specs: fix Appendix A title
This section starts a new numbered sequence.

Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Reviewed-by: Chase Douglas <chase.douglas@canonical.com>
2012-01-26 13:23:04 +10:00
Gaetan Nadon
9ff28b092f specs: remove older manually typed in section number
These would come out in html as 5.2, 6.3 and 6.4.3.4

Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Reviewed-by: Chase Douglas <chase.douglas@canonical.com>
2012-01-26 13:22:51 +10:00
Gaetan Nadon
508a360f65 specs: use subsections to group use cases description
It makes an entry in the appendix for quick navigation.
It looks more readable with subtitles.

Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Reviewed-by: Chase Douglas <chase.douglas@canonical.com>
2012-01-26 13:22:32 +10:00
Gaetan Nadon
08ba2d4e10 specs: Edit titles for section 3 and 4
In the htlm version, the section number appeared to be 3.2.1 and
4.2.2 because of the generated section number.

A section title should not begin with a number.

Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Reviewed-by: Chase Douglas <chase.douglas@canonical.com>
2012-01-26 13:22:19 +10:00
Peter Hutterer
1306ccf9f2 inputproto 2.1.99.5
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2012-01-06 13:35:25 +10:00
Peter Hutterer
997ae03437 Set a flag on the pointer-emulating touch event
Toolkits need to know which touch event emulated a pointer event and which
ones do not. To quote Carlos Garnacho:

    GTK+ does client-side windows by default (GdkWindows without a backing X
    window), for this to work the toplevel window in the client needs to
    select for more events that it wouldn't normally select for in order to
    cater for the event masks in such child "windows". This means that
    ideally GTK+ should set the touch events mask in the toplevel, and then
    find out whether the "window" would receive pointer or touch events for
    the sequence emulating the pointer, and perform the emulation itself.

Reported-by: Carlos Garnacho <carlosg@gnome.org>
Reviewed-by: Chase Douglas <chase.douglas@canonical.com>
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2012-01-03 13:21:55 +10:00
Peter Hutterer
5ee845c1bf specs: purge leftover TouchAccepted note
This flag does not exist anymore.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Reviewed-by: Chase Douglas <chase.douglas@canonical.com>
2012-01-03 13:21:35 +10:00
Peter Hutterer
e65ba758c2 specs: only pointer events have a PointerEmulated flag
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Reviewed-by: Chase Douglas <chase.douglas@canonical.com>
2012-01-03 13:21:35 +10:00
Peter Hutterer
9611be0a5b specs: Clarify rejection for touch events on current owner
The current owner never gets a TouchUpdate(PendingEnd), that event is
superfluous for the owner. The owner receives a TouchEnd when the touch
physically ends. If the touch is still active, the owner receives a
TouchEnd after rejecting the touch.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Reviewed-by: Chase Douglas <chase.douglas@canonical.com>
2012-01-03 09:43:39 +10:00
Peter Hutterer
b9f1b26f07 inputproto 2.1.99.4
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2011-12-21 15:30:22 +10:00
Peter Hutterer
b4da32ed28 Merge branch 'multitouch-devel'
Conflicts:
	configure.ac
	specs/XI2proto.txt
2011-12-21 15:28:44 +10:00
Peter Hutterer
c508e93604 specs: add XI 2.1 release to history section
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2011-12-21 15:27:47 +10:00
Peter Hutterer
5c9a6569e5 Remove --enable-unstable-protocol configure option
Protocol is reasonably stable and about to be merged onto the master
branch. People should be used to stuff on master being a tad unstable, don't
require any specific configure flags.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2011-12-21 15:24:44 +10:00
Peter Hutterer
aef700dbac specs: remove parts of the "Work in progress" warning
The protocol is stable enough now that a simple warning should be enough.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2011-12-21 15:23:23 +10:00
Peter Hutterer
9a9746b95f Reinstate libXi's version defines
Realistically, we can't remove these from the protocol without breaking
older libraries.

Introduced in a02566ca7f

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Reviewed-by: Chase Douglas <chase.douglas@canonical.com>
Signed-off-by: Chase Douglas <chase.douglas@canonical.com>
2011-12-20 14:11:04 -08:00
Peter Hutterer
ee0bc61ee3 Drop wrong comment for sourceid in TouchOwnershipEvents
Copy/paste error from DeviceChangedEvent

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Reviewed-by: Chase Douglas <chase.douglas@canonical.com>
Signed-off-by: Chase Douglas <chase.douglas@canonical.com>
2011-12-20 14:10:29 -08:00
Peter Hutterer
8640944f4f inputproto 2.1
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2011-12-16 11:07:14 +10:00
Cyril Brulebois
b701750ee9 specs: Fix tiny typo.
Signed-off-by: Cyril Brulebois <kibi@debian.org>
Reviewed-by: Peter Hutterer <peter.hutterer@who-t.net>
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2011-12-16 08:57:23 +10:00
Peter Hutterer
8687f155d8 specs: clarify button state in touch events
Emulated pointer events will have button 1 logically down, but touch events
only represent the actual button state, irrespective of the touches.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Reviewed-by: Chase Douglas <chase.douglas@canonical.com>
Signed-off-by: Chase Douglas <chase.douglas@canonical.com>
2011-12-14 11:49:25 -08:00
Peter Hutterer
b1d71fe4cd specs: drop leftover from active_touches removal
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Reviewed-by: Chase Douglas <chase.douglas@canonical.com>
Signed-off-by: Chase Douglas <chase.douglas@canonical.com>
2011-12-14 11:48:50 -08:00
Chase Douglas
02eadf00f0 inputproto 2.1.99.3
Signed-off-by: Chase Douglas <chase.douglas@canonical.com>
2011-12-13 10:35:18 -08:00
Chase Douglas
84c049b660 State that future touch IDs are indeterminate
This just makes it absolutely clear that clients should not make any
assumptions about future touch ID values.

I also added "strictly monotonically" increasing to the definition of
touch IDs. It's a more precise definition of the protocol.

Reviewed-by: Peter Hutterer <peter.hutterer@who-t.net>
Signed-off-by: Chase Douglas <chase.douglas@canonical.com>
2011-12-12 13:47:48 -08:00
Chase Douglas
7d20c9bf38 Touch IDs must be globally unique
XIAllowEvents with a master device and a touch ID must uniquely identify
a touch sequence. If touch IDs were unique per slave device, multiple
slave devices could have valid sequences with the same touch ID, and the
sequences may both be grabbed through the same master device grab.

Reviewed-by: Peter Hutterer <peter.hutterer@who-t.net>
Signed-off-by: Chase Douglas <chase.douglas@canonical.com>
2011-12-12 13:46:07 -08:00
Peter Hutterer
c4703fd9d9 Remove XI2.1 and XI2.2 warnings and errors
This is too much of a pain, anyone who includes XI headers needs to define
this. And that affects input and output drivers as well as legacy clients
that don't even need the new stuff.

Removing the need for defines would be enough but then the warnings clog up
the output and hide real warnings. Just ditch them and laugh at those that
use an experimental branch and expect it to work.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Reviewed-by: Chase Douglas <chase.douglas@canonical.com>
Signed-off-by: Chase Douglas <chase.douglas@canonical.com>
2011-12-12 11:24:20 -08:00