* [eudev] [PATCH] hwdb: add tool to parse hwdb grammer
@ 2018-02-19 9:49 Marcus Folkesson
2018-02-20 12:40 ` Anthony G. Basile
0 siblings, 1 reply; 6+ messages in thread
From: Marcus Folkesson @ 2018-02-19 9:49 UTC (permalink / raw
To: eudev; +Cc: Marcus Folkesson
Inherited from systemd project.
Signed-off-by: Marcus Folkesson <marcus.folkesson@gmail.com>
---
hwdb/parse_hwdb.py | 246 +++++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 246 insertions(+)
create mode 100755 hwdb/parse_hwdb.py
diff --git a/hwdb/parse_hwdb.py b/hwdb/parse_hwdb.py
new file mode 100755
index 000000000..f4cc9c697
--- /dev/null
+++ b/hwdb/parse_hwdb.py
@@ -0,0 +1,246 @@
+#!/usr/bin/env python3
+# -*- Mode: python; coding: utf-8; indent-tabs-mode: nil -*- */
+# SPDX-License-Identifier: MIT
+#
+# This file is part of systemd. It is distrubuted under the MIT license, see
+# below.
+#
+# Copyright 2016 Zbigniew Jędrzejewski-Szmek
+#
+# The MIT License (MIT)
+#
+# 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.
+
+import glob
+import string
+import sys
+import os
+
+try:
+ from pyparsing import (Word, White, Literal, ParserElement, Regex,
+ LineStart, LineEnd,
+ OneOrMore, Combine, Or, Optional, Suppress, Group,
+ nums, alphanums, printables,
+ stringEnd, pythonStyleComment, QuotedString,
+ ParseBaseException)
+except ImportError:
+ print('pyparsing is not available')
+ sys.exit(77)
+
+try:
+ from evdev.ecodes import ecodes
+except ImportError:
+ ecodes = None
+ print('WARNING: evdev is not available')
+
+try:
+ from functools import lru_cache
+except ImportError:
+ # don't do caching on old python
+ lru_cache = lambda: (lambda f: f)
+
+EOL = LineEnd().suppress()
+EMPTYLINE = LineEnd()
+COMMENTLINE = pythonStyleComment + EOL
+INTEGER = Word(nums)
+STRING = QuotedString('"')
+REAL = Combine((INTEGER + Optional('.' + Optional(INTEGER))) ^ ('.' + INTEGER))
+SIGNED_REAL = Combine(Optional(Word('-+')) + REAL)
+UDEV_TAG = Word(string.ascii_uppercase, alphanums + '_')
+
+TYPES = {'mouse': ('usb', 'bluetooth', 'ps2', '*'),
+ 'evdev': ('name', 'atkbd', 'input'),
+ 'id-input': ('modalias'),
+ 'touchpad': ('i8042', 'rmi', 'bluetooth', 'usb'),
+ 'joystick': ('i8042', 'rmi', 'bluetooth', 'usb'),
+ 'keyboard': ('name', ),
+ 'sensor': ('modalias', ),
+ }
+
+@lru_cache()
+def hwdb_grammar():
+ ParserElement.setDefaultWhitespaceChars('')
+
+ prefix = Or(category + ':' + Or(conn) + ':'
+ for category, conn in TYPES.items())
+ matchline = Combine(prefix + Word(printables + ' ' + '®')) + EOL
+ propertyline = (White(' ', exact=1).suppress() +
+ Combine(UDEV_TAG - '=' - Word(alphanums + '_=:@*.!-;, "') - Optional(pythonStyleComment)) +
+ EOL)
+ propertycomment = White(' ', exact=1) + pythonStyleComment + EOL
+
+ group = (OneOrMore(matchline('MATCHES*') ^ COMMENTLINE.suppress()) -
+ OneOrMore(propertyline('PROPERTIES*') ^ propertycomment.suppress()) -
+ (EMPTYLINE ^ stringEnd()).suppress())
+ commentgroup = OneOrMore(COMMENTLINE).suppress() - EMPTYLINE.suppress()
+
+ grammar = OneOrMore(group('GROUPS*') ^ commentgroup) + stringEnd()
+
+ return grammar
+
+@lru_cache()
+def property_grammar():
+ ParserElement.setDefaultWhitespaceChars(' ')
+
+ dpi_setting = (Optional('*')('DEFAULT') + INTEGER('DPI') + Suppress('@') + INTEGER('HZ'))('SETTINGS*')
+ mount_matrix_row = SIGNED_REAL + ',' + SIGNED_REAL + ',' + SIGNED_REAL
+ mount_matrix = (mount_matrix_row + ';' + mount_matrix_row + ';' + mount_matrix_row)('MOUNT_MATRIX')
+
+ props = (('MOUSE_DPI', Group(OneOrMore(dpi_setting))),
+ ('MOUSE_WHEEL_CLICK_ANGLE', INTEGER),
+ ('MOUSE_WHEEL_CLICK_ANGLE_HORIZONTAL', INTEGER),
+ ('MOUSE_WHEEL_CLICK_COUNT', INTEGER),
+ ('MOUSE_WHEEL_CLICK_COUNT_HORIZONTAL', INTEGER),
+ ('ID_INPUT', Literal('1')),
+ ('ID_INPUT_ACCELEROMETER', Literal('1')),
+ ('ID_INPUT_JOYSTICK', Literal('1')),
+ ('ID_INPUT_KEY', Literal('1')),
+ ('ID_INPUT_KEYBOARD', Literal('1')),
+ ('ID_INPUT_MOUSE', Literal('1')),
+ ('ID_INPUT_POINTINGSTICK', Literal('1')),
+ ('ID_INPUT_SWITCH', Literal('1')),
+ ('ID_INPUT_TABLET', Literal('1')),
+ ('ID_INPUT_TABLET_PAD', Literal('1')),
+ ('ID_INPUT_TOUCHPAD', Literal('1')),
+ ('ID_INPUT_TOUCHSCREEN', Literal('1')),
+ ('ID_INPUT_TRACKBALL', Literal('1')),
+ ('MOUSE_WHEEL_TILT_HORIZONTAL', Literal('1')),
+ ('MOUSE_WHEEL_TILT_VERTICAL', Literal('1')),
+ ('POINTINGSTICK_SENSITIVITY', INTEGER),
+ ('POINTINGSTICK_CONST_ACCEL', REAL),
+ ('ID_INPUT_JOYSTICK_INTEGRATION', Or(('internal', 'external'))),
+ ('ID_INPUT_TOUCHPAD_INTEGRATION', Or(('internal', 'external'))),
+ ('XKB_FIXED_LAYOUT', STRING),
+ ('XKB_FIXED_VARIANT', STRING),
+ ('KEYBOARD_LED_NUMLOCK', Literal('0')),
+ ('KEYBOARD_LED_CAPSLOCK', Literal('0')),
+ ('ACCEL_MOUNT_MATRIX', mount_matrix),
+ )
+ fixed_props = [Literal(name)('NAME') - Suppress('=') - val('VALUE')
+ for name, val in props]
+ kbd_props = [Regex(r'KEYBOARD_KEY_[0-9a-f]+')('NAME')
+ - Suppress('=') -
+ ('!' ^ (Optional('!') - Word(alphanums + '_')))('VALUE')
+ ]
+ abs_props = [Regex(r'EVDEV_ABS_[0-9a-f]{2}')('NAME')
+ - Suppress('=') -
+ Word(nums + ':')('VALUE')
+ ]
+
+ grammar = Or(fixed_props + kbd_props + abs_props) + EOL
+
+ return grammar
+
+ERROR = False
+def error(fmt, *args, **kwargs):
+ global ERROR
+ ERROR = True
+ print(fmt.format(*args, **kwargs))
+
+def convert_properties(group):
+ matches = [m[0] for m in group.MATCHES]
+ props = [p[0] for p in group.PROPERTIES]
+ return matches, props
+
+def parse(fname):
+ grammar = hwdb_grammar()
+ try:
+ with open(fname, 'r', encoding='UTF-8') as f:
+ parsed = grammar.parseFile(f)
+ except ParseBaseException as e:
+ error('Cannot parse {}: {}', fname, e)
+ return []
+ return [convert_properties(g) for g in parsed.GROUPS]
+
+def check_match_uniqueness(groups):
+ matches = sum((group[0] for group in groups), [])
+ matches.sort()
+ prev = None
+ for match in matches:
+ if match == prev:
+ error('Match {!r} is duplicated', match)
+ prev = match
+
+def check_one_default(prop, settings):
+ defaults = [s for s in settings if s.DEFAULT]
+ if len(defaults) > 1:
+ error('More than one star entry: {!r}', prop)
+
+def check_one_mount_matrix(prop, value):
+ numbers = [s for s in value if s not in {';', ','}]
+ if len(numbers) != 9:
+ error('Wrong accel matrix: {!r}', prop)
+ try:
+ numbers = [abs(float(number)) for number in numbers]
+ except ValueError:
+ error('Wrong accel matrix: {!r}', prop)
+ bad_x, bad_y, bad_z = max(numbers[0:3]) == 0, max(numbers[3:6]) == 0, max(numbers[6:9]) == 0
+ if bad_x or bad_y or bad_z:
+ error('Mount matrix is all zero in {} row: {!r}',
+ 'x' if bad_x else ('y' if bad_y else 'z'),
+ prop)
+
+def check_one_keycode(prop, value):
+ if value != '!' and ecodes is not None:
+ key = 'KEY_' + value.upper()
+ if key not in ecodes:
+ key = value.upper()
+ if key not in ecodes:
+ error('Keycode {} unknown', key)
+
+def check_properties(groups):
+ grammar = property_grammar()
+ for matches, props in groups:
+ prop_names = set()
+ for prop in props:
+ # print('--', prop)
+ prop = prop.partition('#')[0].rstrip()
+ try:
+ parsed = grammar.parseString(prop)
+ except ParseBaseException as e:
+ error('Failed to parse: {!r}', prop)
+ continue
+ # print('{!r}'.format(parsed))
+ if parsed.NAME in prop_names:
+ error('Property {} is duplicated', parsed.NAME)
+ prop_names.add(parsed.NAME)
+ if parsed.NAME == 'MOUSE_DPI':
+ check_one_default(prop, parsed.VALUE.SETTINGS)
+ elif parsed.NAME == 'ACCEL_MOUNT_MATRIX':
+ check_one_mount_matrix(prop, parsed.VALUE)
+ elif parsed.NAME.startswith('KEYBOARD_KEY_'):
+ check_one_keycode(prop, parsed.VALUE)
+
+def print_summary(fname, groups):
+ print('{}: {} match groups, {} matches, {} properties'
+ .format(fname,
+ len(groups),
+ sum(len(matches) for matches, props in groups),
+ sum(len(props) for matches, props in groups)))
+
+if __name__ == '__main__':
+ args = sys.argv[1:] or glob.glob(os.path.dirname(sys.argv[0]) + '/[67]0-*.hwdb')
+
+ for fname in args:
+ groups = parse(fname)
+ print_summary(fname, groups)
+ check_match_uniqueness(groups)
+ check_properties(groups)
+
+ sys.exit(ERROR)
--
2.15.1
^ permalink raw reply related [flat|nested] 6+ messages in thread
* Re: [eudev] [PATCH] hwdb: add tool to parse hwdb grammer
2018-02-19 9:49 [eudev] [PATCH] hwdb: add tool to parse hwdb grammer Marcus Folkesson
@ 2018-02-20 12:40 ` Anthony G. Basile
2018-02-20 12:45 ` Marcus Folkesson
2018-02-20 12:47 ` Marcus Folkesson
0 siblings, 2 replies; 6+ messages in thread
From: Anthony G. Basile @ 2018-02-20 12:40 UTC (permalink / raw
To: eudev
On 2/19/18 4:49 AM, Marcus Folkesson wrote:
> Inherited from systemd project.
>
> Signed-off-by: Marcus Folkesson <marcus.folkesson@gmail.com>
> ---
> hwdb/parse_hwdb.py | 246 +++++++++++++++++++++++++++++++++++++++++++++++++++++
> 1 file changed, 246 insertions(+)
> create mode 100755 hwdb/parse_hwdb.py
>
>
Okay this and the other two patches were pushed. Just to be clear, this
file will not be included in the release tarball because it has not been
integrated in the build system, which is what we want. Its for devs only.
--
Anthony G. Basile, Ph.D.
Gentoo Linux Developer [Hardened]
E-Mail : basile@freeharbor.net
GnuPG FP : 1FED FAD9 D82C 52A5 3BAB DC79 9384 FA6E F52D 4BBA
GnuPG ID : F52D4BBA
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [eudev] [PATCH] hwdb: add tool to parse hwdb grammer
2018-02-20 12:40 ` Anthony G. Basile
@ 2018-02-20 12:45 ` Marcus Folkesson
2018-02-20 13:07 ` Anthony G. Basile
2018-02-20 12:47 ` Marcus Folkesson
1 sibling, 1 reply; 6+ messages in thread
From: Marcus Folkesson @ 2018-02-20 12:45 UTC (permalink / raw
To: Anthony G. Basile; +Cc: eudev
[-- Attachment #1: Type: text/plain, Size: 1058 bytes --]
On Tue, Feb 20, 2018 at 07:40:46AM -0500, Anthony G. Basile wrote:
> On 2/19/18 4:49 AM, Marcus Folkesson wrote:
> > Inherited from systemd project.
> >
> > Signed-off-by: Marcus Folkesson <marcus.folkesson@gmail.com>
> > ---
> > hwdb/parse_hwdb.py | 246 +++++++++++++++++++++++++++++++++++++++++++++++++++++
> > 1 file changed, 246 insertions(+)
> > create mode 100755 hwdb/parse_hwdb.py
> >
> >
> Okay this and the other two patches were pushed. Just to be clear, this
> file will not be included in the release tarball because it has not been
> integrated in the build system, which is what we want. Its for devs only.
Do we really want it to be integrated in the build system?
My thought was that it could be a handy tool for devs only and should
not be part of the release tarball.
>
> --
> Anthony G. Basile, Ph.D.
> Gentoo Linux Developer [Hardened]
> E-Mail : basile@freeharbor.net
> GnuPG FP : 1FED FAD9 D82C 52A5 3BAB DC79 9384 FA6E F52D 4BBA
> GnuPG ID : F52D4BBA
>
>
Best regards
Marcus Folkesson
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [eudev] [PATCH] hwdb: add tool to parse hwdb grammer
2018-02-20 12:40 ` Anthony G. Basile
2018-02-20 12:45 ` Marcus Folkesson
@ 2018-02-20 12:47 ` Marcus Folkesson
2018-02-20 13:08 ` Anthony G. Basile
1 sibling, 1 reply; 6+ messages in thread
From: Marcus Folkesson @ 2018-02-20 12:47 UTC (permalink / raw
To: Anthony G. Basile; +Cc: eudev
[-- Attachment #1: Type: text/plain, Size: 937 bytes --]
On Tue, Feb 20, 2018 at 07:40:46AM -0500, Anthony G. Basile wrote:
> On 2/19/18 4:49 AM, Marcus Folkesson wrote:
> > Inherited from systemd project.
> >
> > Signed-off-by: Marcus Folkesson <marcus.folkesson@gmail.com>
> > ---
> > hwdb/parse_hwdb.py | 246 +++++++++++++++++++++++++++++++++++++++++++++++++++++
> > 1 file changed, 246 insertions(+)
> > create mode 100755 hwdb/parse_hwdb.py
> >
> >
> Okay this and the other two patches were pushed. Just to be clear, this
> file will not be included in the release tarball because it has not been
> integrated in the build system, which is what we want. Its for devs only.
Sorry, I think I intepreted you wrong.
Yes, it is what we want.
Thank you
>
> --
> Anthony G. Basile, Ph.D.
> Gentoo Linux Developer [Hardened]
> E-Mail : basile@freeharbor.net
> GnuPG FP : 1FED FAD9 D82C 52A5 3BAB DC79 9384 FA6E F52D 4BBA
> GnuPG ID : F52D4BBA
>
>
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [eudev] [PATCH] hwdb: add tool to parse hwdb grammer
2018-02-20 12:45 ` Marcus Folkesson
@ 2018-02-20 13:07 ` Anthony G. Basile
0 siblings, 0 replies; 6+ messages in thread
From: Anthony G. Basile @ 2018-02-20 13:07 UTC (permalink / raw
To: eudev
On 2/20/18 7:45 AM, Marcus Folkesson wrote:
> On Tue, Feb 20, 2018 at 07:40:46AM -0500, Anthony G. Basile wrote:
>> On 2/19/18 4:49 AM, Marcus Folkesson wrote:
>>> Inherited from systemd project.
>>>
>>> Signed-off-by: Marcus Folkesson <marcus.folkesson@gmail.com>
>>> ---
>>> hwdb/parse_hwdb.py | 246 +++++++++++++++++++++++++++++++++++++++++++++++++++++
>>> 1 file changed, 246 insertions(+)
>>> create mode 100755 hwdb/parse_hwdb.py
>>>
>>>
>> Okay this and the other two patches were pushed. Just to be clear, this
>> file will not be included in the release tarball because it has not been
>> integrated in the build system, which is what we want. Its for devs only.
>
> Do we really want it to be integrated in the build system?
> My thought was that it could be a handy tool for devs only and should
> not be part of the release tarball.
>
That's what I said.
--
Anthony G. Basile, Ph.D.
Gentoo Linux Developer [Hardened]
E-Mail : blueness@gentoo.org
GnuPG FP : 1FED FAD9 D82C 52A5 3BAB DC79 9384 FA6E F52D 4BBA
GnuPG ID : F52D4BBA
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [eudev] [PATCH] hwdb: add tool to parse hwdb grammer
2018-02-20 12:47 ` Marcus Folkesson
@ 2018-02-20 13:08 ` Anthony G. Basile
0 siblings, 0 replies; 6+ messages in thread
From: Anthony G. Basile @ 2018-02-20 13:08 UTC (permalink / raw
To: eudev
On 2/20/18 7:47 AM, Marcus Folkesson wrote:
> On Tue, Feb 20, 2018 at 07:40:46AM -0500, Anthony G. Basile wrote:
>> On 2/19/18 4:49 AM, Marcus Folkesson wrote:
>>> Inherited from systemd project.
>>>
>>> Signed-off-by: Marcus Folkesson <marcus.folkesson@gmail.com>
>>> ---
>>> hwdb/parse_hwdb.py | 246 +++++++++++++++++++++++++++++++++++++++++++++++++++++
>>> 1 file changed, 246 insertions(+)
>>> create mode 100755 hwdb/parse_hwdb.py
>>>
>>>
>> Okay this and the other two patches were pushed. Just to be clear, this
>> file will not be included in the release tarball because it has not been
>> integrated in the build system, which is what we want. Its for devs only.
>
> Sorry, I think I intepreted you wrong.
>
> Yes, it is what we want.
>
> Thank you
I just wanted everyone to know that its *intentionally* not part of the
build and so doesn't go out into the release.
--
Anthony G. Basile, Ph.D.
Gentoo Linux Developer [Hardened]
E-Mail : blueness@gentoo.org
GnuPG FP : 1FED FAD9 D82C 52A5 3BAB DC79 9384 FA6E F52D 4BBA
GnuPG ID : F52D4BBA
^ permalink raw reply [flat|nested] 6+ messages in thread
end of thread, other threads:[~2018-02-20 13:09 UTC | newest]
Thread overview: 6+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2018-02-19 9:49 [eudev] [PATCH] hwdb: add tool to parse hwdb grammer Marcus Folkesson
2018-02-20 12:40 ` Anthony G. Basile
2018-02-20 12:45 ` Marcus Folkesson
2018-02-20 13:07 ` Anthony G. Basile
2018-02-20 12:47 ` Marcus Folkesson
2018-02-20 13:08 ` Anthony G. Basile
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox