xf86-input-libinput 1.3.0

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>

.gitlab-ci.yml

@@ -1,25 +1,35 @@
-# vim: set expandtab shiftwidth=2 tabstop=8 textwidth=0:
+# vim: set expandtab shiftwidth=2 tabstop=8 textwidth=0 filetype=yaml:
+#
+# This CI uses the freedesktop.org ci-templates.
+# Please see the ci-templates documentation for details:
+# https://freedesktop.pages.freedesktop.org/ci-templates/
+
+.templates_sha: &template_sha c5626190ec14b475271288dda7a7dae8dbe0cd76 # see https://docs.gitlab.com/ee/ci/yaml/#includefile
 
 include:
   - project: 'freedesktop/ci-templates'
-    ref: 59de540b620c45739871d1a073d76d5521989d11 # see https://docs.gitlab.com/ee/ci/yaml/#includefile
+    ref: *template_sha
     file: '/templates/fedora.yml'
-
+  - project: 'freedesktop/ci-templates'
+    ref: *template_sha
+    file: '/templates/ci-fairy.yml'
+  - template: Security/SAST.gitlab-ci.yml
 
 variables:
-  FDO_UPSTREAM_REPO: xorg/drivers/xf86-input-libinput
+  FDO_UPSTREAM_REPO: xorg/driver/xf86-input-libinput
 
 
 stages:
   - containers
   - build
-
+  - test
 
 .fedora:
   variables:
     FDO_DISTRIBUTION_VERSION: 33
     FDO_DISTRIBUTION_PACKAGES: 'git autoconf automake libtool make xorg-x11-server-devel libudev-devel libevdev-devel libinput-devel xorg-x11-util-macros'
-    FDO_DISTRIBUTION_TAG: '2021-04-06.0'
+    FDO_DISTRIBUTION_EXEC: 'env FDO_CI_CONCURRENT=${FDO_CI_CONCURRENT} bash .gitlab-ci/fedora-install.sh'
+    FDO_DISTRIBUTION_TAG: '2021-09-15.0'
 
 
 fedora@container_build:
@@ -53,3 +63,36 @@ fedora:33@default-build:
     - .fedora
     - .fdo.distribution-image@fedora
     - .default_build
+
+#
+# Verify that commit messages are as expected
+#
+check-commits:
+  extends:
+    - .fdo.ci-fairy
+  stage: test
+  script:
+    - ci-fairy check-commits --junit-xml=results.xml
+  except:
+    - master@xorg/driver/xf86-input-libinput
+  variables:
+    GIT_DEPTH: 100
+  artifacts:
+    reports:
+      junit: results.xml
+  allow_failure: true
+
+#
+# Verify that the merge request has the allow-collaboration checkbox ticked
+#
+check-merge-request:
+  extends:
+    - .fdo.ci-fairy
+  stage: test
+  script:
+    - ci-fairy check-merge-request --require-allow-collaboration --junit-xml=results.xml
+  artifacts:
+    when: on_failure
+    reports:
+      junit: results.xml
+  allow_failure: true

.gitlab-ci/fedora-install.sh

@@ -0,0 +1,9 @@
+#!/bin/bash
+
+# we require at least inputproto >= 2.3.99.1 which has been released in xorgproto 2021.5
+git clone https://gitlab.freedesktop.org/xorg/proto/xorgproto.git --depth 1 --branch=xorgproto-2021.5
+pushd xorgproto
+./autogen.sh
+make -j${FDO_CI_CONCURRENT:-4} install
+popd
+rm -rf xorgproto

configure.ac

@@ -23,7 +23,7 @@
 # Initialize Autoconf
 AC_PREREQ([2.60])
 AC_INIT([xf86-input-libinput],
-        [1.1.0],
+        [1.3.0],
         [https://gitlab.freedesktop.org/xorg/driver/xf86-input-libinput/issues],
         [xf86-input-libinput])
 AC_CONFIG_SRCDIR([Makefile.am])
@@ -31,7 +31,7 @@ AC_CONFIG_HEADERS([config.h])
 AC_CONFIG_AUX_DIR(.)
 
 # Initialize Automake
-AM_INIT_AUTOMAKE([foreign dist-bzip2])
+AM_INIT_AUTOMAKE([foreign dist-xz])
 
 # Initialize libtool
 AC_DISABLE_STATIC
@@ -47,6 +47,10 @@ XORG_DEFAULT_OPTIONS
 PKG_CHECK_MODULES(XORG, [xorg-server >= 1.19] xproto [inputproto >= 2.2])
 PKG_CHECK_MODULES(LIBINPUT, [libinput >= 1.11.0])
 
+PKG_CHECK_MODULES(INPUTPROTO24, [inputproto >= 2.3.99.1],
+		  [AC_DEFINE(HAVE_INPUTPROTO24, [1], [inputproto 2.4 is available])],
+		  [:])
+
 OLD_LIBS=$LIBS
 OLD_CFLAGS=$CFLAGS
 LIBS="$LIBS $LIBINPUT_LIBS"
@@ -62,6 +66,29 @@ AC_LINK_IFELSE(
                 [libinput_have_scroll_button_lock=yes]],
                [AC_MSG_RESULT([no])
                 [libinput_have_scroll_button_lock=no]])
+
+AC_MSG_CHECKING([if libinput_event_pointer_get_scroll_value_v120 is available])
+AC_LINK_IFELSE(
+               [AC_LANG_PROGRAM([[#include <libinput.h>]],
+                                [[libinput_event_pointer_get_scroll_value_v120(NULL, 0)]])],
+               [AC_MSG_RESULT([yes])
+                AC_DEFINE(HAVE_LIBINPUT_AXIS_VALUE_V120, [1],
+                          [libinput_event_pointer_get_scroll_value_v120() is available])
+                [libinput_have_axis_value_v120=yes]],
+               [AC_MSG_RESULT([no])
+                [libinput_have_axis_value_v120=no]])
+
+AC_MSG_CHECKING([if libinput_config_accel_create is available])
+AC_LINK_IFELSE(
+               [AC_LANG_PROGRAM([[#include <libinput.h>]],
+                                [[libinput_config_accel_create(0)]])],
+               [AC_MSG_RESULT([yes])
+                AC_DEFINE(HAVE_LIBINPUT_CUSTOM_ACCEL, [1],
+                          [libinput_config_accel_create() is available])
+                [libinput_have_custom_accel=yes]],
+               [AC_MSG_RESULT([no])
+                [libinput_have_custom_accel=no]])
+
 LIBS=$OLD_LIBS
 CFLAGS=$OLD_CFLAGS
 

include/libinput-properties.h

@@ -63,18 +63,36 @@
 /* Pointer accel speed: FLOAT, 1 value, 32 bit, read-only*/
 #define LIBINPUT_PROP_ACCEL_DEFAULT "libinput Accel Speed Default"
 
-/* Pointer accel profile: BOOL, 2 values in oder adaptive, flat,
+/* Pointer accel profile: BOOL, 3 values in order adaptive, flat, custom
  * only one is enabled at a time at max, read-only */
 #define LIBINPUT_PROP_ACCEL_PROFILES_AVAILABLE "libinput Accel Profiles Available"
 
-/* Pointer accel profile: BOOL, 2 values in order adaptive, flat,
+/* Pointer accel profile: BOOL, 3 values in order adaptive, flat, custom
    only one is enabled at a time at max, read-only */
 #define LIBINPUT_PROP_ACCEL_PROFILE_ENABLED_DEFAULT "libinput Accel Profile Enabled Default"
 
-/* Pointer accel profile: BOOL, 2 values in order adaptive, flat,
+/* Pointer accel profile: BOOL, 3 values in order adaptive, flat, custom
    only one is enabled at a time at max */
 #define LIBINPUT_PROP_ACCEL_PROFILE_ENABLED "libinput Accel Profile Enabled"
 
+/* Points for the custom accel profile: FLOAT, N values */
+#define LIBINPUT_PROP_ACCEL_CUSTOM_POINTS_FALLBACK "libinput Accel Custom Fallback Points"
+
+/* Steps for the custom accel profile: FLOAT, 1 value */
+#define LIBINPUT_PROP_ACCEL_CUSTOM_STEP_FALLBACK "libinput Accel Custom Fallback Step"
+
+/* Points for the custom accel profile: FLOAT, N values */
+#define LIBINPUT_PROP_ACCEL_CUSTOM_POINTS_MOTION "libinput Accel Custom Motion Points"
+
+/* Steps for the custom accel profile: FLOAT, 1 value */
+#define LIBINPUT_PROP_ACCEL_CUSTOM_STEP_MOTION "libinput Accel Custom Motion Step"
+
+/* Points for the custom accel profile: FLOAT, N values */
+#define LIBINPUT_PROP_ACCEL_CUSTOM_POINTS_SCROLL "libinput Accel Custom Scroll Points"
+
+/* Steps for the custom accel profile: FLOAT, 1 value */
+#define LIBINPUT_PROP_ACCEL_CUSTOM_STEP_SCROLL "libinput Accel Custom Scroll Step"
+
 /* Natural scrolling: BOOL, 1 value */
 #define LIBINPUT_PROP_NATURAL_SCROLL "libinput Natural Scrolling Enabled"
 
@@ -207,4 +225,8 @@
 /* Tablet tool area ratio: CARD32, 2 values, w and h */
 #define LIBINPUT_PROP_TABLET_TOOL_AREA_RATIO "libinput Tablet Tool Area Ratio"
 
+/* High-resolution wheel scroll events enabled: BOOL, 1 value (0 or 1).
+ * If disabled, high-resolution wheel scroll events are discarded */
+#define LIBINPUT_PROP_HIRES_WHEEL_SCROLL_ENABLED "libinput High Resolution Wheel Scroll Enabled"
+
 #endif /* _LIBINPUT_PROPERTIES_H_ */

man/Makefile.am

@@ -32,6 +32,9 @@ CLEANFILES = $(driverman_DATA)
 
 SUFFIXES = .$(DRIVER_MAN_SUFFIX) .man
 
+MAN_SUBSTS += \
+         -e 's|\@VERSION\@|$(PACKAGE_NAME) $(PACKAGE_VERSION)|g'
+
 # String replacements in MAN_SUBSTS now come from xorg-macros.m4 via configure
 .man.$(DRIVER_MAN_SUFFIX):
 	$(AM_V_GEN)$(SED) $(MAN_SUBSTS) < $< > $@

man/libinput.man

@@ -1,6 +1,6 @@
 .\" shorthand for double quote that works everywhere.
 .ds q \N'34'
-.TH LIBINPUT __drivermansuffix__ __vendorversion__
+.TH LIBINPUT 4 @VERSION@
 .SH NAME
 libinput \- libinput-based X.Org input driver
 .SH SYNOPSIS
@@ -20,7 +20,7 @@ library documentation, go to
 
 .SH DESCRIPTION
 .B libinput
-is an __xservername__ input driver based on libinput.  It
+is an Xorg input driver based on libinput.  It
 therefore supports all input devices that libinput can handle, including
 most mice, keyboards, tablets and touchscreens.
 .PP
@@ -28,12 +28,12 @@ It is recommended that
 .B libinput
 devices are configured through the
 .B InputClass
-directive (refer to __xconfigfile__(__filemansuffix__)) instead of manual
+directive (refer to xorg.conf(5)) instead of manual
 per-device configuration. Devices configured in the
-__xconfigfile__(__filemansuffix__) are not hot-plug capable.
+xorg.conf(5) are not hot-plug capable.
 
 .SH CONFIGURATION DETAILS
-Please refer to __xconfigfile__(__filemansuffix__) for general configuration
+Please refer to xorg.conf(5) for general configuration
 details and for options that can be used with all input drivers.  This
 section only covers configuration details specific to this driver.
 .PP
@@ -45,17 +45,36 @@ are supported:
 Sets the pointer acceleration profile to the given profile. Permitted values
 are
 .BI adaptive,
-.BI flat.
+.BI flat,
+.BI custom.
 Not all devices support this option or all profiles. If a profile is
 unsupported, the default profile for this device is used. For a description
 on the profiles and their behavior, see the libinput documentation.
 .TP 7
 .BI "Option \*qAccelSpeed\*q \*q" float \*q
-Sets the pointer acceleration speed within the range [-1, 1]
+Sets the pointer acceleration speed within the range [-1, 1].
+This only applies to the flat or adaptive profile.
+.BI "Option \*AccelPointsFallback\*q \*q" string \*q
+Sets the points of the Fallback acceleration function, (see the libinput documentation).
+The string must be a space-separated list of floating point non-negative numbers, e.g.
+"0.0 1.0 2.4 2.5".
+This only applies to the custom profile.
+.BI "Option \*AccelStepFallback\*q \*q" float \*q
+Sets the step between the points of the Fallback acceleration function, (see the libinput documentation).
+When a step of 0.0 is provided, libinput's default Fallback acceleration function is used.
+This only applies to the custom profile.
+.BI "Option \*AccelPointsMotion\*q \*q" string \*q
+Equivalent to AccelPointsFallback but applies to the Motion acceleration function.
+.BI "Option \*AccelStepMotion\*q \*q" float \*q
+Equivalent to AccelStepFallback but applies to the Motion acceleration function.
+.BI "Option \*AccelPointsScroll\*q \*q" string \*q
+Equivalent to AccelPointsFallback but applies to the Scroll acceleration function.
+.BI "Option \*AccelStepScroll\*q \*q" float \*q
+Equivalent to AccelStepFallback but applies to the Scroll acceleration function.
 .TP 7
 .BI "Option \*qButtonMapping\*q \*q" string \*q
 Sets the logical button mapping for this device, see
-XSetPointerMapping(__libmansuffix__). The string must be a
+XSetPointerMapping(3). The string must be a
 space-separated list of button mappings in the order of the
 logical buttons on the device, starting with button 1.
 The default mapping is "1 2 3 ... 32". A mapping of 0
@@ -114,11 +133,16 @@ device button numbers, i.e. the
 .B ButtonMapping
 applies after drag lock.
 .TP 7
+.BI "Option \*qHighResolutionWheelScrolling\*q \*q" bool \*q
+Disables high-resolution wheel scroll events, enabled by default. When enabled,
+the driver forwards only high-resolution wheel scroll events from libinput.
+When disabled, the driver forwards legacy wheel scroll events instead.
+.TP 7
 .BI "Option \*qHorizontalScrolling\*q \*q" bool \*q
-Disables horizontal scrolling. When disabled, this driver will discard any
-horizontal scroll events from libinput. Note that this does not disable
-horizontal scrolling, it merely discards the horizontal axis from any scroll
-events.
+Enables or disables horizontal scrolling. When disabled, this driver will
+discard any horizontal scroll events from libinput. This does not disable
+horizontal scroll events from libinput; it merely discards the horizontal axis
+from any scroll events. Default is enabled.
 .TP 7
 .BI "Option \*qLeftHanded\*q \*q" bool \*q
 Enables left-handed button orientation, i.e. swapping left and right buttons.
@@ -262,7 +286,11 @@ button pairs. See section
 .B BUTTON DRAG LOCK
 for details.
 .TP 7
-.BI "libinput Horizontal Scrolling Enabled"
+.BI "libinput High Resolution Wheel Scroll Enabled"
+1 boolean value (8 bit, 0 or 1). Indicates whether high-resolution
+wheel scroll events are enabled or not.
+.TP 7
+.BI "libinput Horizontal Scroll Enabled"
 1 boolean value (8 bit, 0 or 1). Indicates whether horizontal scrolling
 events are enabled or not.
 .TP 7
@@ -346,14 +374,14 @@ button mapping of
 .B "\*q3 2 1 ...\*q"
 On systems using the
 .B libinput
-__xservername__ input driver it is recommended to use the
+Xorg input driver it is recommended to use the
 .B LeftHanded
 option instead.
 .PP
 The
 .B libinput
-__xservername__ input driver does not use the button mapping after setup.
-Use XSetPointerMapping(__libmansuffix__) to modify the button mapping at
+Xorg input driver does not use the button mapping after setup.
+Use XSetPointerMapping(3) to modify the button mapping at
 runtime.
 
 .SH BUTTON DRAG LOCK
@@ -425,9 +453,9 @@ generate one logical click event and each pixel is 1/50th of a wheel click.
 This driver does not work with \fBOption \*qDevice\*q\fR set to an event
 node in \fI/dev/input/by-id\fR and \fI/dev/input/by-path\fR. This can be
 usually be worked by using \fBSection \*qInputClass\*q\fR with an
-appropriate \fBMatch*\fR statement in the __xconfigfile__(__filemansuffix__).
+appropriate \fBMatch*\fR statement in the xorg.conf(5).
 
 .SH AUTHORS
 Peter Hutterer
 .SH "SEE ALSO"
-__xservername__(__appmansuffix__), __xconfigfile__(__filemansuffix__), Xserver(__appmansuffix__), X(__miscmansuffix__)
+Xorg(1), xorg.conf(5), Xserver(1), X(7)

meson.build

@@ -0,0 +1,141 @@
+project('xf86-input-libinput', 'c',
+        version: '1.3.0',  # bump version in configure.ac
+        default_options: ['warning_level=2'],
+        meson_version: '>= 0.50.0')
+
+driver_version = meson.project_version().split('.')
+
+dir_pkgconf	= get_option('prefix') / get_option('libdir') / 'pkgconfig'
+dir_man4	= get_option('prefix') / get_option('mandir') / 'man4'
+
+cc = meson.get_compiler('c')
+cflags = [
+	'-Wno-unused-parameter',
+	'-Wno-sign-compare',	 # lots of work to get rid of this
+	'-Wmissing-prototypes',
+	'-Wstrict-prototypes',
+	'-Wlogical-op',
+	'-Wpointer-arith',
+	'-Wuninitialized',
+	'-Winit-self',
+	'-Wstrict-prototypes',
+	'-Wimplicit-fallthrough',
+	'-Wredundant-decls',
+	'-Wincompatible-pointer-types',
+	'-Wformat=2',
+	'-Wno-missing-field-initializers',
+	'-Wmissing-declarations',
+
+	'-fvisibility=hidden',
+]
+add_project_arguments(cc.get_supported_arguments(cflags), language: 'c')
+
+pkgconfig = import('pkgconfig')
+dep_xserver = dependency('xorg-server', version: '>= 1.19')
+dep_xproto = dependency('xproto')
+dep_inputproto = dependency('inputproto', version: '>= 2.2')
+dep_libinput = dependency('libinput', version: '>= 1.11.0')
+
+config_h = configuration_data()
+config_h.set('PACKAGE_VERSION_MAJOR', driver_version[0])
+config_h.set('PACKAGE_VERSION_MINOR', driver_version[1])
+config_h.set('PACKAGE_VERSION_PATCHLEVEL', driver_version[2])
+
+if dep_inputproto.version().version_compare('>= 2.3.99.1')
+	config_h.set('HAVE_INPUTPROTO24', 1)
+endif
+
+if cc.has_function('libinput_device_config_scroll_get_button_lock',
+		   dependencies: dep_libinput)
+	config_h.set('HAVE_LIBINPUT_SCROLL_BUTTON_LOCK', 1)
+endif
+if cc.has_function('libinput_event_pointer_get_scroll_value_v120',
+	           dependencies: dep_libinput)
+	config_h.set('HAVE_LIBINPUT_AXIS_VALUE_V120', 1)
+endif
+if cc.has_function('libinput_config_accel_create',
+		   dependencies: dep_libinput)
+	config_h.set('HAVE_LIBINPUT_CUSTOM_ACCEL', 1)
+endif
+
+dir_headers = get_option('sdkdir')
+if dir_headers == ''
+	dir_headers = dep_xserver.get_pkgconfig_variable('sdkdir')
+endif
+
+dir_xorg_module = get_option('xorg-module-dir')
+if dir_xorg_module == ''
+    dir_xorg_module = dep_xserver.get_pkgconfig_variable('moduledir') / 'input'
+endif
+
+dir_xorg_conf = get_option('xorg-conf-dir')
+if dir_xorg_conf == ''
+    dir_xorg_conf = dep_xserver.get_pkgconfig_variable('sysconfigdir')
+endif
+
+libbezier = static_library('bezier', ['src/bezier.c', 'src/bezier.h'])
+dep_libbezier = declare_dependency(link_with: libbezier)
+
+libdraglock = static_library('draglock', ['src/draglock.c', 'src/draglock.h'])
+dep_libdraglock = declare_dependency(link_with: libdraglock)
+
+dep_drivers = [
+  dep_xserver,
+  dep_xproto,
+  dep_inputproto,
+  dep_libinput,
+  dep_libbezier,
+  dep_libdraglock,
+]
+
+driver_src = ['src/xf86libinput.c', 'src/util-strings.c']
+driver_lib = shared_module(
+	'libinput_drv',
+	driver_src,
+	name_prefix: '', # we want libinput_drv.so, not liblibinput_drv.so
+	include_directories: include_directories('include'),
+	dependencies: dep_drivers,
+	install: true,
+	install_dir: dir_xorg_module,
+)
+
+test_bezier = executable('test-bezier',
+			 ['test/test-bezier.c'],
+			 dependencies: dep_libbezier,
+			 include_directories: include_directories('src'),
+			 install: false)
+test('test-bezier', test_bezier)
+
+test_draglock = executable('test-draglock',
+			 ['test/test-draglock.c'],
+			 dependencies: dep_libdraglock,
+			 include_directories: include_directories('src'),
+			 install: false)
+test('test-draglock', test_draglock)
+
+
+conf_pkgconf = configuration_data()
+conf_pkgconf.set('PACKAGE_VERSION', meson.project_version())
+conf_pkgconf.set('sdkdir', dir_headers)
+
+configure_file(
+	input: 'xorg-libinput.pc.in',
+	output: 'xorg-libinput.pc',
+	configuration: conf_pkgconf,
+	install_dir: dir_pkgconf,
+)
+
+config_man = configuration_data()
+config_man.set('VERSION', '@0@ @1@'.format(meson.project_name(), meson.project_version()))
+
+configure_file(
+	input: 'man/libinput.man',
+	output: 'libinput.4',
+	configuration: config_man,
+	install_dir: dir_man4
+)
+
+install_data('conf/40-libinput.conf', install_dir: dir_xorg_conf)
+
+# Now generate config.h
+configure_file(output: 'config.h', configuration: config_h)

meson_options.txt

@@ -0,0 +1,15 @@
+option('sdkdir',
+	type: 'string',
+	value: '',
+	description: 'Directory to install header files in [default=from xorg-server pkgconf]',
+)
+option('xorg-module-dir',
+	type : 'string',
+	value : '',
+	description : 'Default xorg module directory [default=from xorg-server pkgconf]',
+)
+option('xorg-conf-dir',
+	type : 'string',
+	value : '',
+	description : 'Default xorg.conf.d directory [default=from xorg-server pkgconfig]'
+)

src/Makefile.am

@@ -33,7 +33,12 @@ AM_CPPFLAGS =-I$(top_srcdir)/include $(LIBINPUT_CFLAGS)
 @DRIVER_NAME@_drv_la_LIBADD = $(LIBINPUT_LIBS) libdraglock.la libbezier.la -lm
 @DRIVER_NAME@_drv_ladir = @inputdir@
 
-@DRIVER_NAME@_drv_la_SOURCES = xf86libinput.c
+@DRIVER_NAME@_drv_la_SOURCES = \
+	xf86libinput.c \
+	util-macros.h \
+	util-strings.h \
+	util-strings.c \
+	$(NULL)
 
 noinst_LTLIBRARIES = libdraglock.la libbezier.la
 libdraglock_la_SOURCES = draglock.c draglock.h

src/bezier.h

@@ -56,7 +56,7 @@ extern const struct bezier_control_point bezier_defaults[4];
  * This function requires that c[i].x <= c[i+1].x
  *
  * The curve is mapped into a canvas size [0, bezier_sz)². For each x
- * coordiante in [0, bezier_sz), the matching y coordinate is thus
+ * coordinate in [0, bezier_sz), the matching y coordinate is thus
  * bezier[x].
  *
  * In other words, if you have a range [0,2048) input possible values,

src/util-macros.h

@@ -0,0 +1,65 @@
+/*
+ * Copyright © 2008-2011 Kristian Høgsberg
+ * Copyright © 2011 Intel Corporation
+ * Copyright © 2013-2015 Red Hat, Inc.
+ *
+ * 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 (including the next
+ * paragraph) 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.
+ */
+
+#pragma once
+
+#include "config.h"
+
+#define ARRAY_LENGTH(a) (sizeof (a) / sizeof (a)[0])
+/**
+ * Iterate through the array _arr, assigning the variable elem to each
+ * element. elem only exists within the loop.
+ */
+#define ARRAY_FOR_EACH(_arr, _elem) \
+	for (__typeof__((_arr)[0]) *_elem = _arr; \
+	     _elem < (_arr) + ARRAY_LENGTH(_arr); \
+	     _elem++)
+
+#define min(a, b) (((a) < (b)) ? (a) : (b))
+#define max(a, b) (((a) > (b)) ? (a) : (b))
+
+#define ANSI_HIGHLIGHT		"\x1B[0;1;39m"
+#define ANSI_RED		"\x1B[0;31m"
+#define ANSI_GREEN		"\x1B[0;32m"
+#define ANSI_YELLOW		"\x1B[0;33m"
+#define ANSI_BLUE		"\x1B[0;34m"
+#define ANSI_MAGENTA		"\x1B[0;35m"
+#define ANSI_CYAN		"\x1B[0;36m"
+#define ANSI_BRIGHT_RED		"\x1B[0;31;1m"
+#define ANSI_BRIGHT_GREEN	"\x1B[0;32;1m"
+#define ANSI_BRIGHT_YELLOW	"\x1B[0;33;1m"
+#define ANSI_BRIGHT_BLUE	"\x1B[0;34;1m"
+#define ANSI_BRIGHT_MAGENTA	"\x1B[0;35;1m"
+#define ANSI_BRIGHT_CYAN	"\x1B[0;36;1m"
+#define ANSI_NORMAL		"\x1B[0m"
+
+#define ANSI_UP			"\x1B[%dA"
+#define ANSI_DOWN		"\x1B[%dB"
+#define ANSI_RIGHT		"\x1B[%dC"
+#define ANSI_LEFT		"\x1B[%dD"
+
+#define CASE_RETURN_STRING(a) case a: return #a
+
+#define _fallthrough_ __attribute__((fallthrough))

src/util-strings.c

@@ -0,0 +1,243 @@
+/*
+ * Copyright © 2008 Kristian Høgsberg
+ * Copyright © 2013-2015 Red Hat, Inc.
+ *
+ * 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 (including the next
+ * paragraph) 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.
+ */
+
+#include "config.h"
+
+#include "util-strings.h"
+
+/**
+ * Return the next word in a string pointed to by state before the first
+ * separator character. Call repeatedly to tokenize a whole string.
+ *
+ * @param state Current state
+ * @param len String length of the word returned
+ * @param separators List of separator characters
+ *
+ * @return The first word in *state, NOT null-terminated
+ */
+static const char *
+next_word(const char **state, size_t *len, const char *separators)
+{
+	const char *next = *state;
+	size_t l;
+
+	if (!*next)
+		return NULL;
+
+	next += strspn(next, separators);
+	if (!*next) {
+		*state = next;
+		return NULL;
+	}
+
+	l = strcspn(next, separators);
+	*state = next + l;
+	*len = l;
+
+	return next;
+}
+
+/**
+ * Return a null-terminated string array with the contents of argv
+ * duplicated.
+ *
+ * Use strv_free() to free the array.
+ *
+ * @return A null-terminated string array or NULL on errors
+ */
+char**
+strv_from_argv(int argc, char **argv)
+{
+	char **strv = NULL;
+
+	assert(argc >= 0);
+
+	if (argc == 0)
+		return NULL;
+
+	strv = zalloc((argc + 1) * sizeof *strv);
+	for (int i = 0; i < argc; i++) {
+		char *copy = safe_strdup(argv[i]);
+		if (!copy) {
+			strv_free(strv);
+			return NULL;
+		}
+		strv[i] = copy;
+	}
+	return strv;
+}
+
+/**
+ * Return a null-terminated string array with the tokens in the input
+ * string, e.g. "one two\tthree" with a separator list of " \t" will return
+ * an array [ "one", "two", "three", NULL ] and num elements 3.
+ *
+ * Use strv_free() to free the array.
+ *
+ * Another example:
+ *   result = strv_from_string("+1-2++3--4++-+5-+-", "+-", &nelem)
+ *   result == [ "1", "2", "3", "4", "5", NULL ] and nelem == 5
+ *
+ * @param in Input string
+ * @param separators List of separator characters
+ * @param num_elements Number of elements found in the input string
+ *
+ * @return A null-terminated string array or NULL on errors
+ */
+char **
+strv_from_string(const char *in, const char *separators, size_t *num_elements)
+{
+	assert(in != NULL);
+
+	const char *s = in;
+	size_t l, nelems = 0;
+	while (next_word(&s, &l, separators) != NULL)
+		nelems++;
+
+	if (nelems == 0) {
+		*num_elements = 0;
+		return NULL;
+	}
+
+	size_t strv_len = nelems + 1; /* NULL-terminated */
+	char **strv = zalloc(strv_len * sizeof *strv);
+
+	size_t idx = 0;
+	const char *word;
+	s = in;
+	while ((word = next_word(&s, &l, separators)) != NULL) {
+		char *copy = strndup(word, l);
+		if (!copy) {
+			strv_free(strv);
+			*num_elements = 0;
+			return NULL;
+		}
+
+		strv[idx++] = copy;
+	}
+
+	*num_elements = nelems;
+
+	return strv;
+}
+
+/**
+ * Return a newly allocated string with all elements joined by the
+ * joiner, same as Python's string.join() basically.
+ * A strv of ["one", "two", "three", NULL] with a joiner of ", " results
+ * in "one, two, three".
+ *
+ * An empty strv ([NULL]) returns NULL, same for passing NULL as either
+ * argument.
+ *
+ * @param strv Input string array
+ * @param joiner Joiner between the elements in the final string
+ *
+ * @return A null-terminated string joining all elements
+ */
+char *
+strv_join(char **strv, const char *joiner)
+{
+	char **s;
+	char *str;
+	size_t slen = 0;
+	size_t count = 0;
+
+	if (!strv || !joiner)
+		return NULL;
+
+	if (strv[0] == NULL)
+		return NULL;
+
+	for (s = strv, count = 0; *s; s++, count++) {
+		slen += strlen(*s);
+	}
+
+	assert(slen < 1000);
+	assert(strlen(joiner) < 1000);
+	assert(count > 0);
+	assert(count < 100);
+
+	slen += (count - 1) * strlen(joiner);
+
+	str = zalloc(slen + 1); /* trailing \0 */
+	for (s = strv; *s; s++) {
+		strcat(str, *s);
+		--count;
+		if (count > 0)
+			strcat(str, joiner);
+	}
+
+	return str;
+}
+
+/**
+ * Return a pointer to the basename within filename.
+ * If the filename the empty string or a directory (i.e. the last char of
+ * filename is '/') NULL is returned.
+ */
+const char *
+safe_basename(const char *filename)
+{
+	const char *basename;
+
+	if (*filename == '\0')
+		return NULL;
+
+	basename = strrchr(filename, '/');
+	if (basename == NULL)
+		return filename;
+
+	if (*(basename + 1) == '\0')
+		return NULL;
+
+	return basename + 1;
+}
+
+/**
+ * Similar to basename() but returns the trunk only without the (last)
+ * trailing suffix, so that:
+ *
+ * - foo.c returns foo
+ * - foo.a.b returns foo.a
+ * - foo returns foo
+ * - foo/ returns ""
+ *
+ * @return an allocated string representing the trunk name of the file
+ */
+char *
+trunkname(const char *filename)
+{
+	const char *base = safe_basename(filename);
+	char *suffix;
+
+	if (base == NULL)
+		return safe_strdup("");
+
+	suffix = rindex(base, '.');
+	if (suffix == NULL)
+		return safe_strdup(base);
+	else
+		return strndup(base, suffix-base);
+}

src/util-strings.h

@@ -0,0 +1,464 @@
+/*
+ * Copyright © 2008 Kristian Høgsberg
+ * Copyright © 2013-2015 Red Hat, Inc.
+ *
+ * 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 (including the next
+ * paragraph) 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.
+ */
+
+#pragma once
+
+#include "config.h"
+#define _GNU_SOURCE
+
+#include <assert.h>
+#include <ctype.h>
+#include <errno.h>
+#include <limits.h>
+#include <math.h>
+#include <string.h>
+#include <stdio.h>
+#include <stdbool.h>
+#include <stdlib.h>
+#include <stdarg.h>
+#ifdef HAVE_LOCALE_H
+#include <locale.h>
+#endif
+#ifdef HAVE_XLOCALE_H
+#include <xlocale.h>
+#endif
+
+#include "util-macros.h"
+
+static inline bool
+streq(const char *str1, const char *str2)
+{
+	/* one NULL, one not NULL is always false */
+	if (str1 && str2)
+		return strcmp(str1, str2) == 0;
+	return str1 == str2;
+}
+
+static inline bool
+strneq(const char *str1, const char *str2, int n)
+{
+	/* one NULL, one not NULL is always false */
+	if (str1 && str2)
+		return strncmp(str1, str2, n) == 0;
+	return str1 == str2;
+}
+
+static inline void *
+zalloc(size_t size)
+{
+	void *p;
+
+	/* We never need to alloc anything more than 1,5 MB so we can assume
+	 * if we ever get above that something's going wrong */
+	if (size > 1536 * 1024)
+		assert(!"bug: internal malloc size limit exceeded");
+
+	p = calloc(1, size);
+	if (!p)
+		abort();
+
+	return p;
+}
+
+/**
+ * strdup guaranteed to succeed. If the input string is NULL, the output
+ * string is NULL. If the input string is a string pointer, we strdup or
+ * abort on failure.
+ */
+static inline char*
+safe_strdup(const char *str)
+{
+	char *s;
+
+	if (!str)
+		return NULL;
+
+	s = strdup(str);
+	if (!s)
+		abort();
+	return s;
+}
+
+/**
+ * Simple wrapper for asprintf that ensures the passed in-pointer is set
+ * to NULL upon error.
+ * The standard asprintf() call does not guarantee the passed in pointer
+ * will be NULL'ed upon failure, whereas this wrapper does.
+ *
+ * @param strp pointer to set to newly allocated string.
+ * This pointer should be passed to free() to release when done.
+ * @param fmt the format string to use for printing.
+ * @return The number of bytes printed (excluding the null byte terminator)
+ * upon success or -1 upon failure. In the case of failure the pointer is set
+ * to NULL.
+ */
+__attribute__ ((format (printf, 2, 3)))
+static inline int
+xasprintf(char **strp, const char *fmt, ...)
+{
+	int rc = 0;
+	va_list args;
+
+	va_start(args, fmt);
+	rc = vasprintf(strp, fmt, args);
+	va_end(args);
+	if ((rc == -1) && strp)
+		*strp = NULL;
+
+	return rc;
+}
+
+__attribute__ ((format (printf, 2, 0)))
+static inline int
+xvasprintf(char **strp, const char *fmt, va_list args)
+{
+	int rc = 0;
+	rc = vasprintf(strp, fmt, args);
+	if ((rc == -1) && strp)
+		*strp = NULL;
+
+	return rc;
+}
+
+static inline bool
+safe_atoi_base(const char *str, int *val, int base)
+{
+	char *endptr;
+	long v;
+
+	assert(base == 10 || base == 16 || base == 8);
+
+	errno = 0;
+	v = strtol(str, &endptr, base);
+	if (errno > 0)
+		return false;
+	if (str == endptr)
+		return false;
+	if (*str != '\0' && *endptr != '\0')
+		return false;
+
+	if (v > INT_MAX || v < INT_MIN)
+		return false;
+
+	*val = v;
+	return true;
+}
+
+static inline bool
+safe_atoi(const char *str, int *val)
+{
+	return safe_atoi_base(str, val, 10);
+}
+
+static inline bool
+safe_atou_base(const char *str, unsigned int *val, int base)
+{
+	char *endptr;
+	unsigned long v;
+
+	assert(base == 10 || base == 16 || base == 8);
+
+	errno = 0;
+	v = strtoul(str, &endptr, base);
+	if (errno > 0)
+		return false;
+	if (str == endptr)
+		return false;
+	if (*str != '\0' && *endptr != '\0')
+		return false;
+
+	if ((long)v < 0)
+		return false;
+
+	*val = v;
+	return true;
+}
+
+static inline bool
+safe_atou(const char *str, unsigned int *val)
+{
+	return safe_atou_base(str, val, 10);
+}
+
+static inline bool
+safe_atod(const char *str, double *val)
+{
+	char *endptr;
+	double v;
+#ifdef HAVE_LOCALE_H
+	locale_t c_locale;
+#endif
+	size_t slen = strlen(str);
+
+	/* We don't have a use-case where we want to accept hex for a double
+	 * or any of the other values strtod can parse */
+	for (size_t i = 0; i < slen; i++) {
+		char c = str[i];
+
+		if (isdigit(c))
+		       continue;
+		switch(c) {
+		case '+':
+		case '-':
+		case '.':
+			break;
+		default:
+			return false;
+		}
+	}
+
+#ifdef HAVE_LOCALE_H
+	/* Create a "C" locale to force strtod to use '.' as separator */
+	c_locale = newlocale(LC_NUMERIC_MASK, "C", (locale_t)0);
+	if (c_locale == (locale_t)0)
+		return false;
+
+	errno = 0;
+	v = strtod_l(str, &endptr, c_locale);
+	freelocale(c_locale);
+#else
+	/* No locale support in provided libc, assume it already uses '.' */
+	errno = 0;
+	v = strtod(str, &endptr);
+#endif
+	if (errno > 0)
+		return false;
+	if (str == endptr)
+		return false;
+	if (*str != '\0' && *endptr != '\0')
+		return false;
+	if (v != 0.0 && !isnormal(v))
+		return false;
+
+	*val = v;
+	return true;
+}
+
+char **strv_from_argv(int argc, char **argv);
+char **strv_from_string(const char *in, const char *separator, size_t *num_elements);
+char *strv_join(char **strv, const char *joiner);
+
+static inline void
+strv_free(char **strv) {
+	char **s = strv;
+
+	if (!strv)
+		return;
+
+	while (*s != NULL) {
+		free(*s);
+		*s = (char*)0x1; /* detect use-after-free */
+		s++;
+	}
+
+	free (strv);
+}
+
+/**
+ * parse a string containing a list of doubles into a double array.
+ *
+ * @param in string to parse
+ * @param separator string used to separate double in list e.g. ","
+ * @param result double array
+ * @param length length of double array
+ * @return true when parsed successfully otherwise false
+ */
+static inline double *
+double_array_from_string(const char *in,
+			 const char *separator,
+			 size_t *length)
+{
+	double *result = NULL;
+	*length = 0;
+
+	size_t nelem;
+	char **strv = strv_from_string(in, separator, &nelem);
+	if(!strv)
+		return result;
+
+	double *numv = zalloc(sizeof(double) * nelem);
+	for (size_t idx = 0; idx < nelem; idx++) {
+		double val;
+		if (!safe_atod(strv[idx], &val))
+			goto out;
+
+		numv[idx] = val;
+	}
+
+	result = numv;
+	numv = NULL;
+	*length = nelem;
+
+out:
+	strv_free(strv);
+	free(numv);
+	return result;
+}
+
+struct key_value_str{
+	char *key;
+	char *value;
+};
+
+struct key_value_double {
+	double key;
+	double value;
+};
+
+static inline ssize_t
+kv_double_from_string(const char *string,
+		      const char *pair_separator,
+		      const char *kv_separator,
+		      struct key_value_double **result_out)
+
+{
+	struct key_value_double *result = NULL;
+
+	if (!pair_separator || pair_separator[0] == '\0' ||
+	    !kv_separator || kv_separator[0] == '\0')
+		return -1;
+
+	size_t npairs;
+	char **pairs = strv_from_string(string, pair_separator, &npairs);
+	if (!pairs || npairs == 0)
+		goto error;
+
+	result = zalloc(npairs * sizeof *result);
+
+	for (size_t idx = 0; idx < npairs; idx++) {
+		char *pair = pairs[idx];
+		size_t nelem;
+		char **kv = strv_from_string(pair, kv_separator, &nelem);
+		double k, v;
+
+		if (!kv || nelem != 2 ||
+		    !safe_atod(kv[0], &k) ||
+		    !safe_atod(kv[1], &v)) {
+			strv_free(kv);
+			goto error;
+		}
+
+		result[idx].key = k;
+		result[idx].value = v;
+
+		strv_free(kv);
+	}
+
+	strv_free(pairs);
+
+	*result_out = result;
+
+	return npairs;
+
+error:
+	strv_free(pairs);
+	free(result);
+	return -1;
+}
+
+/**
+ * Strip any of the characters in what from the beginning and end of the
+ * input string.
+ *
+ * @return a newly allocated string with none of "what" at the beginning or
+ * end of string
+ */
+static inline char *
+strstrip(const char *input, const char *what)
+{
+	char *str, *last;
+
+	str = safe_strdup(&input[strspn(input, what)]);
+
+	last = str;
+
+	for (char *c = str; *c != '\0'; c++) {
+		if (!strchr(what, *c))
+			last = c + 1;
+	}
+
+	*last = '\0';
+
+	return str;
+}
+
+/**
+ * Return true if str ends in suffix, false otherwise. If the suffix is the
+ * empty string, strendswith() always returns false.
+ */
+static inline bool
+strendswith(const char *str, const char *suffix)
+{
+	size_t slen = strlen(str);
+	size_t suffixlen = strlen(suffix);
+	size_t offset;
+
+	if (slen == 0 || suffixlen == 0 || suffixlen > slen)
+		return false;
+
+	offset = slen - suffixlen;
+	return strneq(&str[offset], suffix, suffixlen);
+}
+
+static inline bool
+strstartswith(const char *str, const char *prefix)
+{
+	size_t prefixlen = strlen(prefix);
+
+	return prefixlen > 0 ? strneq(str, prefix, strlen(prefix)) : false;
+}
+
+const char *
+safe_basename(const char *filename);
+
+char *
+trunkname(const char *filename);
+
+/**
+ * Return a copy of str with all % converted to %% to make the string
+ * acceptable as printf format.
+ */
+static inline char *
+str_sanitize(const char *str)
+{
+	if (!str)
+		return NULL;
+
+	if (!strchr(str, '%'))
+		return strdup(str);
+
+	size_t slen = min(strlen(str), 512);
+	char *sanitized = zalloc(2 * slen + 1);
+	const char *src = str;
+	char *dst = sanitized;
+
+	for (size_t i = 0; i < slen; i++) {
+		if (*src == '%')
+			*dst++ = '%';
+		*dst++ = *src++;
+	}
+	*dst = '\0';
+
+	return sanitized;
+}