Merge lp:~oif-packaging/evemu/ubuntu.v1.0.5 into lp:evemu/ubuntu

[Henrik Rydberg]

[Henrik Rydberg (rydberg)]

Packaging for the v1.0.5 FFe. Package pushed to utouch unstable for testing.

[Chase Douglas (chasedouglas)]

Looks good.

review: Approve

=== modified file 'ChangeLog'
--- ChangeLog	2011-01-05 10:58:59 +0000
+++ ChangeLog	2011-03-15 16:22:40 +0000
@@ -1,4 +1,62 @@
 ------------------------------------------------------------
+revno: 30
+tags: v1.0.5
+committer: Henrik Rydberg <[e-mail]>
+branch nick: trunk
+timestamp: Tue 2011-03-15 17:03:53 +0100
+message:
+  Release v1.0.5
+------------------------------------------------------------
+revno: 29
+committer: Henrik Rydberg <[e-mail]>
+branch nick: trunk
+timestamp: Tue 2011-03-15 15:47:40 +0100
+message:
+  Complete function documentation in evemu.h
+  
+  For reasons not likely to become clear again at the moment, only
+  two functions were ever documented, and those were made in the
+  source file where nobody can see it. This patch adds function
+  documentation to all functions in the header file.
+  
+  Signed-off-by: Henrik Rydberg <[e-mail]>
+------------------------------------------------------------
+revno: 28
+committer: Henrik Rydberg <[e-mail]>
+branch nick: trunk
+timestamp: Tue 2011-03-15 15:47:21 +0100
+message:
+  Add the missing evemu_set_name() function
+  
+  During the evolution of evemu, the process of setting the device
+  name has shifted towards the evemu_extract() and evemu_read() functions,
+  rendering the initial name in evemu_new() more or less useless.
+  This patch adds the missing evemu_set_name() function, in order to
+  make it possible to override the device name before device creation.
+  
+  Signed-off-by: Henrik Rydberg <[e-mail]>
+------------------------------------------------------------
+revno: 27
+committer: Henrik Rydberg <[e-mail]>
+branch nick: trunk
+timestamp: Mon 2011-03-14 18:07:46 +0100
+message:
+  Move realtime read into its own function
+  
+  The realtime read functionality is needed in many places,
+  in particular in the test frameworks of utouch-frame and utouch-grail.
+  Move the realtime code from evemu_play into its own function,
+  and make it part of the API.
+  
+  Signed-off-by: Henrik Rydberg <[e-mail]>
+------------------------------------------------------------
+revno: 26
+committer: Stephen M. Webb <[e-mail]>
+branch nick: utouch-evemu
+timestamp: Wed 2011-02-02 21:29:13 -0500
+message:
+  Added GPL-3 licensing to source files.
+------------------------------------------------------------
 revno: 25
 committer: Henrik Rydberg <[e-mail]>
 branch nick: trunk

=== modified file 'config-aux/ltmain.sh'
--- config-aux/ltmain.sh	2010-12-22 08:47:30 +0000
+++ config-aux/ltmain.sh	2011-03-15 16:22:40 +0000
@@ -65,7 +65,7 @@
 #       compiler:		$LTCC
 #       compiler flags:		$LTCFLAGS
 #       linker:		$LD (gnu? $with_gnu_ld)
-#       $progname:		(GNU libtool) 2.2.6b Debian-2.2.6b-2ubuntu1
+#       $progname:		(GNU libtool) 2.2.6b Debian-2.2.6b-2ubuntu3
 #       automake:		$automake_version
 #       autoconf:		$autoconf_version
 #
@@ -73,7 +73,7 @@
 
 PROGRAM=ltmain.sh
 PACKAGE=libtool
-VERSION="2.2.6b Debian-2.2.6b-2ubuntu1"
+VERSION="2.2.6b Debian-2.2.6b-2ubuntu3"
 TIMESTAMP=""
 package_revision=1.3017
 

=== modified file 'configure'
--- configure	2011-01-05 10:58:59 +0000
+++ configure	2011-03-15 16:22:40 +0000
@@ -1,6 +1,6 @@
 #! /bin/sh
 # Guess values for system-dependent variables and create Makefiles.
-# Generated by GNU Autoconf 2.67 for Kernel device emulation 1.0.4.
+# Generated by GNU Autoconf 2.67 for Kernel device emulation 1.0.5.
 #
 #
 # Copyright (C) 1992, 1993, 1994, 1995, 1996, 1998, 1999, 2000, 2001,
@@ -698,8 +698,8 @@
 # Identity of this package.
 PACKAGE_NAME='Kernel device emulation'
 PACKAGE_TARNAME='utouch-evemu'
-PACKAGE_VERSION='1.0.4'
-PACKAGE_STRING='Kernel device emulation 1.0.4'
+PACKAGE_VERSION='1.0.5'
+PACKAGE_STRING='Kernel device emulation 1.0.5'
 PACKAGE_BUGREPORT=''
 PACKAGE_URL=''
 
@@ -1422,7 +1422,7 @@
   # Omit some internal or obsolete options to make the list less imposing.
   # This message is too long to be a string in the A/UX 3.1 sh.
   cat <<_ACEOF
-\`configure' configures Kernel device emulation 1.0.4 to adapt to many kinds of systems.
+\`configure' configures Kernel device emulation 1.0.5 to adapt to many kinds of systems.
 
 Usage: $0 [OPTION]... [VAR=VALUE]...
 
@@ -1492,7 +1492,7 @@
 
 if test -n "$ac_init_help"; then
   case $ac_init_help in
-     short | recursive ) echo "Configuration of Kernel device emulation 1.0.4:";;
+     short | recursive ) echo "Configuration of Kernel device emulation 1.0.5:";;
    esac
   cat <<\_ACEOF
 
@@ -1595,7 +1595,7 @@
 test -n "$ac_init_help" && exit $ac_status
 if $ac_init_version; then
   cat <<\_ACEOF
-Kernel device emulation configure 1.0.4
+Kernel device emulation configure 1.0.5
 generated by GNU Autoconf 2.67
 
 Copyright (C) 2010 Free Software Foundation, Inc.
@@ -1873,7 +1873,7 @@
 This file contains any messages produced by compilers while
 running configure, to aid debugging if configure makes a mistake.
 
-It was created by Kernel device emulation $as_me 1.0.4, which was
+It was created by Kernel device emulation $as_me 1.0.5, which was
 generated by GNU Autoconf 2.67.  Invocation command line was
 
   $ $0 $@
@@ -2693,7 +2693,7 @@
 
 # Define the identity of the package.
  PACKAGE='utouch-evemu'
- VERSION='1.0.4'
+ VERSION='1.0.5'
 
 
 cat >>confdefs.h <<_ACEOF
@@ -11667,7 +11667,7 @@
 # report actual input values of CONFIG_FILES etc. instead of their
 # values after options handling.
 ac_log="
-This file was extended by Kernel device emulation $as_me 1.0.4, which was
+This file was extended by Kernel device emulation $as_me 1.0.5, which was
 generated by GNU Autoconf 2.67.  Invocation command line was
 
   CONFIG_FILES    = $CONFIG_FILES
@@ -11733,7 +11733,7 @@
 cat >>$CONFIG_STATUS <<_ACEOF || ac_write_fail=1
 ac_cs_config="`$as_echo "$ac_configure_args" | sed 's/^ //; s/[\\""\`\$]/\\\\&/g'`"
 ac_cs_version="\\
-Kernel device emulation config.status 1.0.4
+Kernel device emulation config.status 1.0.5
 configured by $0, generated by GNU Autoconf 2.67,
   with options \\"\$ac_cs_config\\"
 

=== modified file 'configure.ac'
--- configure.ac	2011-01-05 10:58:59 +0000
+++ configure.ac	2011-03-15 16:22:40 +0000
@@ -1,7 +1,7 @@
 # Initialize Autoconf
 AC_PREREQ([2.60])
 AC_INIT([Kernel device emulation],
-        [1.0.4],
+        [1.0.5],
         [],
         [utouch-evemu])
 AC_CONFIG_SRCDIR([Makefile.am])

=== modified file 'debian/changelog'
--- debian/changelog	2011-02-03 17:51:49 +0000
+++ debian/changelog	2011-03-15 16:22:40 +0000
@@ -1,3 +1,11 @@
+utouch-evemu (1.0.5-0ubuntu1) UNRELEASED; urgency=low
+
+  * New upstream release.
+  * Add the new functions to the symbols file
+  * Feature freeze exception LP: #735558
+
+ -- Henrik Rydberg <[e-mail]>  Tue, 15 Mar 2011 17:18:53 +0100
+
 utouch-evemu (1.0.4-0ubuntu1) natty; urgency=low
 
   [ Henrik Rydberg ]

=== modified file 'debian/libutouch-evemu1.symbols'
--- debian/libutouch-evemu1.symbols	2010-12-22 09:52:23 +0000
+++ debian/libutouch-evemu1.symbols	2011-03-15 16:22:40 +0000
@@ -20,6 +20,8 @@
  evemu_play@Base 1.0.3
  evemu_read@Base 1.0.3
  evemu_read_event@Base 1.0.3
+ evemu_read_event_realtime@Base 1.0.5
  evemu_record@Base 1.0.3
+ evemu_set_name@Base 1.0.5
  evemu_write@Base 1.0.3
  evemu_write_event@Base 1.0.3

=== modified file 'include/evemu.h'
--- include/evemu.h	2011-02-03 02:54:15 +0000
+++ include/evemu.h	2011-03-15 16:22:40 +0000
@@ -49,38 +49,268 @@
 
 #define EVEMU_VERSION		0x00010000
 
+/**
+ * evemu_new() - allocate a new evemu device
+ * @name: wanted input device name (or NULL to leave empty)
+ *
+ * This function allocates a new evemu device structure and
+ * initializes all fields to zero. If name is non-null and the length
+ * is sane, it is copied to the device name.
+ *
+ * Returns NULL in case of memory failure.
+ */
 struct evemu_device *evemu_new(const char *name);
+
+/**
+ * evemu_delete() - free and allocated evemu device
+ * @dev: the device to free
+ *
+ * The device pointer is invalidated by this call.
+ */
 void evemu_delete(struct evemu_device *dev);
 
+/**
+ * evemu_get_version() - get library version
+ * @dev: the device in use
+ *
+ * Returns the library version used to create this evemu instance. The
+ * version may differ from the value of EVEMU_VERSION in this header
+ * file.
+ */
 unsigned int evemu_get_version(const struct evemu_device *dev);
 
+/**
+ * evemu_get_name() - get device name
+ * @dev: the device in use
+ *
+ * Returns the name of the device. The pointer is owned by the evemu
+ * instance and has evemu scope.
+ */
 const char *evemu_get_name(const struct evemu_device *dev);
 
+/**
+ * evemu_set_name() - set device name
+ * @dev: the device in use
+ *
+ * Sets the name of the device. If name is non-null and the length is
+ * sane, it is copied to the device name.
+ */
+void evemu_set_name(struct evemu_device *dev, const char *name);
+
+/**
+ * evemu_get_id_bustype() - get kernel device bustype
+ * @dev: the device in use
+ *
+ * Returns the kernel bus type used by the device.
+ */
 unsigned int evemu_get_id_bustype(const struct evemu_device *dev);
+
+/**
+ * evemu_get_id_vendor() - get kernel device vendor id
+ * @dev: the device in use
+ *
+ * Returns the kernel vendor id used by the device.
+ */
 unsigned int evemu_get_id_vendor(const struct evemu_device *dev);
+
+/**
+ * evemu_get_id_product() - get kernel device product id
+ * @dev: the device in use
+ *
+ * Returns the kernel product id used by the device.
+ */
 unsigned int evemu_get_id_product(const struct evemu_device *dev);
+
+/**
+ * evemu_get_id_version() - get kernel device id version
+ * @dev: the device in use
+ *
+ * Returns the kernel device id used by the device.
+ */
 unsigned int evemu_get_id_version(const struct evemu_device *dev);
 
+/**
+ * evemu_get_abs_minimum() - get kernel minimum value of event type
+ * @dev: the device in use
+ * @code: the event type code to query
+ *
+ * Returns the range minimum of the specified event type.
+ */
 int evemu_get_abs_minimum(const struct evemu_device *dev, int code);
+
+/**
+ * evemu_get_abs_maximum() - get kernel maximum value of event type
+ * @dev: the device in use
+ * @code: the event type code to query
+ *
+ * Returns the range maximum of the specified event type.
+ */
 int evemu_get_abs_maximum(const struct evemu_device *dev, int code);
+
+/**
+ * evemu_get_abs_maximum() - get kernel filter fuzz of event type
+ * @dev: the device in use
+ * @code: the event type code to query
+ *
+ * Returns the filter fuzz of the specified event type.
+ */
 int evemu_get_abs_fuzz(const struct evemu_device *dev, int code);
+
+/**
+ * evemu_get_abs_maximum() - get kernel flat value of event type
+ * @dev: the device in use
+ * @code: the event type code to query
+ *
+ * Returns the flat value of the specified event type. Only used for
+ * joysticks.
+ */
 int evemu_get_abs_flat(const struct evemu_device *dev, int code);
+
+/**
+ * evemu_get_abs_resolution() - get kernel resolution of event type
+ * @dev: the device in use
+ * @code: the event type code to query
+ *
+ * Returns the resolution of the specified event type. Resolution is
+ * specified in units per millimeter (units/mm), or units per radian
+ * where appropriate.
+ */
 int evemu_get_abs_resolution(const struct evemu_device *dev, int code);
 
+/**
+ * evemu_has_prop() - check if device has a certain property
+ * @dev: the device in use
+ * @code: the property type code to query
+ *
+ * Returns true if the device has the given property.
+ */
 int evemu_has_prop(const struct evemu_device *dev, int code);
+
+/**
+ * evemu_has_event() - check if device has a certain event type
+ * @dev: the device in use
+ * @code: the event type code to query
+ *
+ * Returns true if the event type is supported by the device.
+ */
 int evemu_has_event(const struct evemu_device *dev, int type, int code);
 
+/**
+ * evemu_extract() - configure evemu instance directly from the kernel device
+ * @dev: the device in use
+ * @fd: file descriptor of the kernel device to query
+ *
+ * Returns zero if successful, negative error otherwise.
+ */
 int evemu_extract(struct evemu_device *dev, int fd);
+
+/**
+ * evemu_write() - write evemu configuration to a file
+ * @dev: the device in use
+ * @fp: file pointer to write the evemu configuration to
+ *
+ * Returns zero if successful, negative error otherwise.
+ */
 int evemu_write(const struct evemu_device *dev, FILE *fp);
+
+/**
+ * evemu_read() - read evemu configuration from a file
+ * @dev: the device in use
+ * @fp: file pointer to read the evemu configuration from
+ *
+ * Returns a positive number if successful, zero or negative error
+ * otherwise.
+ */
 int evemu_read(struct evemu_device *dev, FILE *fp);
 
+/**
+ * evemu_write_event() - write kernel event to file
+ * @fp: file pointer to write the event to
+ * @ev: pointer to the kernel event to write
+ *
+ * Writes the kernel event to the file.
+ *
+ * Returns a positive number if successful, zero or negative error
+ * otherwise.
+ */
 int evemu_write_event(FILE *fp, const struct input_event *ev);
+
+/**
+ * evemu_read_event() - read kernel event from file
+ * @fp: file pointer to read the event from
+ * @ev: pointer to the kernel event to be filled
+ *
+ * Reads a kernel event from the file.
+ *
+ * Returns a positive number if successful, zero or negative error
+ * otherwise.
+ */
 int evemu_read_event(FILE *fp, struct input_event *ev);
 
+/**
+ * evemu_read_event_realtime() - read kernel events in realtime
+ * @fp: file pointer to read the event from
+ * @ev: pointer to the kernel event to be filled
+ * @evtime: pointer to a timeval struct
+ *
+ * The evtime struct should be cleared (zeroed) before the first call
+ * to this function. This function reads a kernel event from the file,
+ * and performs the microsleep necessary to deliver the event with the
+ * same timings as originally received.
+ *
+ * Returns a positive number if successful, zero or negative error
+ * otherwise.
+ */
+int evemu_read_event_realtime(FILE *fp, struct input_event *ev,
+			      struct timeval *evtime);
+
+/**
+ * evemu_record() - read events directly from a kernel device
+ * @fp: file pointer to write the events to
+ * @fd: file descriptor of kernel device to read from
+ * @ms: maximum time to wait for an event to appear before reading (ms)
+ *
+ * Contiuously reads events from the kernel device and writes them to
+ * the file. The function terminates after ms milliseconds of
+ * inactivity.
+ * to this function. This function reads a kernel event from the file,
+ * and performs the microsleep necessary to deliver the event with the
+ * same timings as originally received.
+ *
+ * Returns zero if successful, negative error otherwise.
+ */
 int evemu_record(FILE *fp, int fd, int ms);
+
+/**
+ * evemu_play() - replay events from file to kernel device in realtime
+ * @fp: file pointer to read the events from
+ * @fd: file descriptor of kernel device to write to
+ *
+ * Contiuously reads events from the file and writes them to the
+ * kernel device, in realtime. The function terminates when end of
+ * file has been reached.
+ *
+ * Returns zero if successful, negative error otherwise.
+ */
 int evemu_play(FILE *fp, int fd);
 
+/**
+ * evemu_create() - create a kernel device from the evemu configuration
+ * @dev: the device in use
+ * @fd: file descriptor of the special kernel uinput device
+ *
+ * Creates a new device with all the properties of the evemu device.
+ *
+ * Returns zero if successful, negative error otherwise.
+ */
 int evemu_create(const struct evemu_device *dev, int fd);
+
+/**
+ * evemu_destroy() - destroy all created kernel devices
+ * @fd: file descriptor of the special kernel uinput device
+ *
+ * Destroys all devices created using this file descriptor.
+ */
 void evemu_destroy(int fd);
 
 #endif

=== modified file 'src/evemu.c'
--- src/evemu.c	2011-02-03 02:54:15 +0000
+++ src/evemu.c	2011-03-15 16:22:40 +0000
@@ -72,33 +72,18 @@
 	}
 }
 
-/**
- * evemu_new() - allocate a new evemu device
- * @name: wanted input device name (or NULL to leave empty)
- *
- * This function allocates a new evemu device structure and
- * initializes all fields to zero. If name is non-null and the length
- * is sane, it is copied to the device name.
- *
- * Returns NULL in case of memory failure.
- */
 struct evemu_device *evemu_new(const char *name)
 {
 	struct evemu_device *dev = calloc(1, sizeof(struct evemu_device));
 
-	dev->version = EVEMU_VERSION;
-	if (name && strlen(name) < sizeof(dev->name))
-		strcpy(dev->name, name);
+	if (dev) {
+		dev->version = EVEMU_VERSION;
+		evemu_set_name(dev, name);
+	}
 
 	return dev;
 }
 
-/**
- * evemu_delete() - free and allocated evemu device
- * @dev: the device to free
- *
- * The device pointer is invalidated by this call.
- */
 void evemu_delete(struct evemu_device *dev)
 {
 	free(dev);
@@ -114,6 +99,12 @@
 	return dev->name;
 }
 
+void evemu_set_name(struct evemu_device *dev, const char *name)
+{
+	if (name && strlen(name) < sizeof(dev->name))
+		strcpy(dev->name, name);
+}
+
 unsigned int evemu_get_id_bustype(const struct evemu_device *dev)
 {
 	return dev->id.bustype;
@@ -361,24 +352,39 @@
 	return ret;
 }
 
+int evemu_read_event_realtime(FILE *fp, struct input_event *ev,
+			      struct timeval *evtime)
+{
+	unsigned long usec;
+	int ret;
+
+	ret = evemu_read_event(fp, ev);
+	if (ret <= 0)
+		return ret;
+
+	if (evtime) {
+		if (!evtime->tv_sec)
+			*evtime = ev->time;
+		usec = 1000000L * (ev->time.tv_sec - evtime->tv_sec);
+		usec += ev->time.tv_usec - evtime->tv_usec;
+		if (usec > 500) {
+			usleep(usec);
+			*evtime = ev->time;
+		}
+	}
+
+	return ret;
+}
+
 int evemu_play(FILE *fp, int fd)
 {
-	struct input_event prev, ev;
-	long check = 0, usec;
+	struct input_event ev;
+	struct timeval evtime;
 	int ret;
 
-	memset(&prev, 0, sizeof(prev));
-	while (evemu_read_event(fp, &ev) > 0) {
-		if (!prev.time.tv_sec)
-			prev = ev;
-		usec = 1000000L * (ev.time.tv_sec - prev.time.tv_sec);
-		usec += ev.time.tv_usec - prev.time.tv_usec;
-		if (usec - check > 500) {
-			usleep(usec - check);
-			check = usec;
-		}
+	memset(&evtime, 0, sizeof(evtime));
+	while (evemu_read_event_realtime(fp, &ev, &evtime) > 0)
 		SYSCALL(ret = write(fd, &ev, sizeof(ev)));
-	}
 
 	return 0;
 }

=== modified file 'tools/evemu-describe.1'
--- tools/evemu-describe.1	2011-01-05 10:58:59 +0000
+++ tools/evemu-describe.1	2011-03-15 16:22:40 +0000
@@ -2,12 +2,12 @@
 .\"     Title: evemu-describe
 .\"    Author: [see the "AUTHOR" section]
 .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
-.\"      Date: 01/05/2011
+.\"      Date: 03/15/2011
 .\"    Manual: \ \&
 .\"    Source: \ \&
 .\"  Language: English
 .\"
-.TH "EVEMU\-DESCRIBE" "1" "01/05/2011" "\ \&" "\ \&"
+.TH "EVEMU\-DESCRIBE" "1" "03/15/2011" "\ \&" "\ \&"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------

=== modified file 'tools/evemu-device.1'
--- tools/evemu-device.1	2011-01-05 10:58:59 +0000
+++ tools/evemu-device.1	2011-03-15 16:22:40 +0000
@@ -2,12 +2,12 @@
 .\"     Title: evemu-device
 .\"    Author: [see the "AUTHOR" section]
 .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
-.\"      Date: 01/05/2011
+.\"      Date: 03/15/2011
 .\"    Manual: \ \&
 .\"    Source: \ \&
 .\"  Language: English
 .\"
-.TH "EVEMU\-DEVICE" "1" "01/05/2011" "\ \&" "\ \&"
+.TH "EVEMU\-DEVICE" "1" "03/15/2011" "\ \&" "\ \&"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------