Enhance keySyms #113

aurium · 2015-10-31T16:09:32Z

Direct translate from X.Org's xproto/keysymdef.h
Adds the key description as JSON data
Update examples where the x11.keySyms API changes

santigimeno · 2015-10-31T18:39:51Z

lib/keysyms.update.sh

@@ -0,0 +1,35 @@
+#!/bin/bash
+


santigimeno · 2015-10-31T18:44:00Z

Thanks! The code looks good but it's a major version and I don't know that's desirable. To keep compatibility the description could be inserted as comments

santigimeno · 2015-10-31T18:44:14Z

I mean a major version change

aurium · 2015-10-31T20:36:19Z

Thanks! I will update it now.
About the char description at keysyms.js, that is my desired feature. I will also push a "pedagogic" example about it keysyms displaying the description. :-)

* Direct translate from X.Org's xproto/keysymdef.h * Adds the key description as JSON data * Update examples where the `x11.keySyms` API changes

santigimeno · 2015-10-31T20:48:02Z

Oh I see. I understand the reason to store the description for pedagogic reasons, but does it make sense from a logical/API POV?
Anyway, if we would want to keep backwards compatibility, you could store the description in a different object with the same keys.

aurium · 2015-10-31T21:47:02Z

Well, i believe that information can be useful for other things, like sys testing, sys configuration... Imagine a keyboard config gui... You can set chars for each key and the description will help the user to be sure about what they are doing. Well... there is an information. We can easily provide to the user. Lets give it and open more possibilities to the public. For sure my ideas are a small set of the human mindshare. :-p

Separate the data will use more memory and will make the translation a kind bizarre... The API change is simple as you can see on the example updates that i did, but that is true. That is why i try to push a new version on my first push. But you should decide about the numbering. :-)

aurium · 2015-10-31T21:55:02Z

Hey, a cool usage: You have a game with configurable inputs. The config UI can show the key description when it is not a simple letter.

santigimeno · 2015-10-31T22:03:11Z

Yes, I can see the usefulness now. Thanks :)

Yes, I understand that trying to keep the current API might not be nice nor optimal but not breaking the API can be good for the users of the module. I'm not totally against it. Let's see what @sidorares think.

sidorares · 2015-10-31T23:00:37Z

I'm probably ok with major version bump ( it's very trivial to upgrade for those who depend on x11.keySyms ). At the same time I'm still thinking if backwards-compatible solution would be better, for example add "descriptions" hash alongside to keysyms:

 var keySyms = x11.keySyms;
 for (codeName in x11.keySyms) {
   code = keySyms[codeName];
   chr2Data[code] = { codeName: codeName, description: keysSyms.description[codeName] };
 }

aurium · 2015-11-01T01:32:05Z

Guys, how about to make x11.keySyms a getter? So the keysyms.js still a direct translation with description and x11.keySyms do filter.

I still prefer the API change, while the world domination is not accomplished, because any solution to maintain backwards compatibility, will add some extra complexity to the code.

However, i'm not here to decide. :-)

sidorares · 2015-11-01T09:31:27Z

getter is actually a good idea.
constants file is pretty large so we could lazily require it on first access which would improve startup time and memory

aurium · 2015-11-01T13:29:33Z

Lazily load is a great idea! I will add this feature.
And how about to break the API? Are you ok with it?

sidorares · 2015-11-01T13:48:06Z

I'm ok with api breakage, it's pretty minor ( but we'll bump major version as its major in semver sense )

aurium · 2015-11-02T18:36:50Z

✨ Done! ✨

santigimeno · 2015-11-03T09:00:07Z

examples/key-recognition.js

+      white = display.screen[0].white_pixel; // Will paint the window.
+
+  // Get the local key mapping to build key2Data.
+  X.GetKeyboardMapping(min, max-min, function(err, list) {


throw on error?

Talking about if (err) throw err, or other line?

Yes. Sorry if it's not clear. I mean in the callback of X.GetKeyboardMapping

Ow ok... I was worried, thinking there was a bug. As it is a simple example, if the main data provider fail, there is no why to continue. So throw it.

santigimeno · 2015-11-03T09:01:09Z

One comment and it looks good to me

Enhance keySyms

sidorares · 2015-11-16T05:36:42Z

hey @aurium

I started looking at what actually happens when you change language layout ( for example, en->ru )

Few problems/suggestions here:

X Keysym is pretty useless if we need to type text. I suggest that we completely remove keysyms.js file and use https://github.com/substack/node-keysym instead ( because it has corresponding unicode codepoinds )
Simple input is relatively easy to track: we listen for MappingNotify and remember new mapping each time. Every key correspond to some symbol
Unfortunately CJK input ( and other complex input methods ) don't have that 1-1 mapping and there needs more work to cover this ( and I don't know yet what is involved )

aurium · 2015-11-17T14:28:43Z

Hi @sidorares, I'm auto writing portuguese text with keysyms.js. The "char table" let us to know the key combination for any char, so i can write "Áçõ" and any crazy latin char.
Is not it the same case for RU?
I believe node-keysym is a nice lib for this approach, however, i also believe node-x11 must to provide all x11 features. Well... I may publish a keysyms helper to simplify the usage.

Anyway, the decision is yours. What you think about this proposal?

sidorares · 2015-11-17T22:03:47Z

That's because latin1 keysyms are the same as corresponding unicode code points:

 keysyms.fromUnicode('Á')
[ { keysym: 193, unicode: 193, status: '.', names: [ 'Aacute' ] } ]
> keysyms.fromUnicode('ф')
[ { keysym: 1734,
    unicode: 1092,
    status: '.',
    names: [ 'Cyrillic_ef' ] } ]

unfortunately not the case for codes outside of 0-255 range, X11 keysyms were created long before Unicode table and are different, so there is a need for translation table keysym -> unicode code point

sidorares · 2015-11-18T00:14:25Z

some future read for me: http://www.x.org/releases/X11R7.7/doc/libX11/XIM/xim.txt

santigimeno reviewed Oct 31, 2015
View reviewed changes

lib/keysyms.update.sh

@@ -0,0 +1,35 @@

#!/bin/bash

Copy link

Collaborator

santigimeno Oct 31, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add set -e

Aurélio A. Heckert added 2 commits October 31, 2015 17:37

Enhance keySyms

de2b73c

* Direct translate from X.Org's xproto/keysymdef.h * Adds the key description as JSON data * Update examples where the `x11.keySyms` API changes

Shows how to use keySyms data

d8cd686

aurium force-pushed the master branch from a647fce to d8cd686 Compare October 31, 2015 20:40

Lazily load keySyms

6ad3f94

santigimeno reviewed Nov 3, 2015
View reviewed changes

sidorares added a commit that referenced this pull request Nov 10, 2015

Merge pull request #113 from aurium/master

b39672b

Enhance keySyms

sidorares merged commit b39672b into sidorares:master Nov 10, 2015

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Enhance keySyms #113

Enhance keySyms #113

aurium commented Oct 31, 2015

santigimeno Oct 31, 2015

santigimeno commented Oct 31, 2015

santigimeno commented Oct 31, 2015

aurium commented Oct 31, 2015

santigimeno commented Oct 31, 2015

aurium commented Oct 31, 2015

aurium commented Oct 31, 2015

santigimeno commented Oct 31, 2015

sidorares commented Oct 31, 2015

aurium commented Nov 1, 2015

sidorares commented Nov 1, 2015

aurium commented Nov 1, 2015

sidorares commented Nov 1, 2015

aurium commented Nov 2, 2015

santigimeno Nov 3, 2015

aurium Nov 3, 2015

santigimeno Nov 3, 2015

aurium Nov 3, 2015

santigimeno commented Nov 3, 2015

sidorares commented Nov 16, 2015

aurium commented Nov 17, 2015

sidorares commented Nov 17, 2015

sidorares commented Nov 18, 2015

Enhance keySyms #113

Enhance keySyms #113

Conversation

aurium commented Oct 31, 2015

santigimeno Oct 31, 2015

Choose a reason for hiding this comment

santigimeno commented Oct 31, 2015

santigimeno commented Oct 31, 2015

aurium commented Oct 31, 2015

santigimeno commented Oct 31, 2015

aurium commented Oct 31, 2015

aurium commented Oct 31, 2015

santigimeno commented Oct 31, 2015

sidorares commented Oct 31, 2015

aurium commented Nov 1, 2015

sidorares commented Nov 1, 2015

aurium commented Nov 1, 2015

sidorares commented Nov 1, 2015

aurium commented Nov 2, 2015

santigimeno Nov 3, 2015

Choose a reason for hiding this comment

aurium Nov 3, 2015

Choose a reason for hiding this comment

santigimeno Nov 3, 2015

Choose a reason for hiding this comment

aurium Nov 3, 2015

Choose a reason for hiding this comment

santigimeno commented Nov 3, 2015

sidorares commented Nov 16, 2015

aurium commented Nov 17, 2015

sidorares commented Nov 17, 2015

sidorares commented Nov 18, 2015