USB: On Windows, block to wait for libusb events

This is another attempt at getting the mess that is libusb event
handling on Windows under control. Until libusb makes its HANDLEs
available for polling, we have no choice but to block while waiting
for libusb events. Since we do not want to force drivers to deal
with multi-threading issues, that means we have to block in the
session main loop.

Fortunately, it turns out that our drivers aren't using multiple
event sources, so it is actually possible to block the main loop
without disrupting too much. This also gets rid of the USB thread
on Windows. Thankfully, libusb does not seem to care that we are
now calling libusb_handle_events_timeout_completed() twice per
iteration: first a blocking call (with timeout) in the callback
wrapper, followed by the non-blocking call in the driver-supplied
callback.

session: Allow multiple poll FDs per event source

Turns out that having one event source per libusb poll FD is
a bad idea. There is only a single callback for all poll FDs,
and libusb expects to be called only once per poll iteration,
no matter how many FDs triggered.

Also, they should all share the same timeout, which should get
reset on events from any polled FD. The new timeout handling made
this problem apparent, as it caused the callback to be invoked
multiple times on timeouts, once for each separate event source.

In order to fix this, change the implementation to allow for an
arbitrary number of poll FDs per event source. This number is
zero for timer FDs, one for normal I/O sources, and one or more
for libusb sources (Unix only).

Also, on Windows, do not get an additional timeout from libusb
in the event loop. This is only appropriate when polling the
libusb FDs directly, which we aren't doing on Windows.

session: More poll spewing

log: Output time stamps at log level spew

drivers: Use timer sources instead of polling stdin

demo: Use simple timer source instead of pipe

Get rid of the Unix pipe and the GIOChannel wrapping it. Instead,
install a simple timer event source with the appropriate timeout.

session: Add poll debug spew

session: Unify handling of I/O and timer sources

Handle I/O sources and timer ("dummy") sources within the same
polling loop, so that both may be used together. Slightly change
the API to improve consistency: a timeout value of -1 now disables
the timeout, and 0 makes the source always time out immediately.
The "dummy" sources already behaved that way, although it wasn't
documented as such.

Make sure that I/O events are processed preferentially: Skip any
timeout callbacks if an I/O event occurred within the same poll
iteration. This applies to both timer/idle sources and timeouts
of I/O sources.

Do not create dummy GPollFDs for timer/idle sources. Instead,
split the sources array into an I/O section and a timer section,
and create corresponding GPollFDs only for the I/O section. Use
GArray to simplify the handling of the dynamic arrays.

session: Properly accumulate event source timeouts

Keep track of when source timeouts are due and properly compare
against accumulated elapsed time between invocations. This prevents
sources with short timeouts from blocking other sources with longer
timeouts indefinitely.

session: Do not expect meaningful errno on non-UNIX

Looking at the g_poll() implementations for various systems, it
appears that on Windows the return value is 0 if the wait was
interrupted, and errno is never set. Also, the MacOS X wrapper
around select() does not clear revents on timeout.

To deal with these issues, check for EINTR only on Unices, and
assume revents to be invalid unless g_poll() returned a positive
value.

session: Check for errors from g_poll()

If the call to g_poll() in sr_session_iteration() fails, report
the error back to the caller. Do not treat EINTR as error though.

Check for session abort only if a source callback was actually
invoked, or at least once if none of the callbacks are invoked.
Stop checking for abort if the session has already been stopped,
just in case a callback sets abort_session again.

Also change the documentation to match the actual behavior.

session: Fix USB timeout handling

In sr_session_iteration(), remove the inverted evaluation of the
block parameter if a USB source is present. This stops the deluge
of USB event callbacks due to the timeout always being zero.

Also, just for cleanliness, initialize the revents member of each
GPollFD instance to zero.

Build: Fix installation of Python bindings

Apparently setup.py install behaves differently when given
the --root option, so omit that if DESTDIR is empty.

Fixes #644.

python: Fix the build for Python >= 3.

SWIG_init() returns void for Python 2.x and 'PyObject *' for Python 3.

Use an #if to handle both cases properly, otherwise the Python bindings
for either Python 2 or 3 will fail to build.

Python 3.x failure:

sigrok/core/classes_wrap.cpp: In function ‘PyObject* PyInit__classes()’:
sigrok/core/classes_wrap.cpp:59002:5: error: return-statement with no
value, in function returning ‘PyObject* {aka _object*}’ [-fpermissive]
     return;
     ^

Python 2.x failure:

In file included from /usr/include/dirent.h:244:0,
                 from /usr/include/glib-2.0/glib/gdir.h:32,
                 from /usr/include/glib-2.0/glib.h:45,
                 from /usr/include/pygobject-3.0/pygobject.h:7,
                 from sigrok/core/classes_wrap.cpp:3179:
sigrok/core/classes_wrap.cpp: In function ‘void init_classes()’:
sigrok/core/classes_wrap.cpp:59002:12: error: return-statement with a
value, in function returning 'void' [-fpermissive]
     return NULL;
            ^

Remove SR_OK_CONTINUE.

This brings error reporting back to the usual: either return codes
are SR_OK (0) or they are < 1 indicating an error.

This fixes bug #633.

output/csv: Avoid using SR_OK_CONTINUE.

scpi: Avoid using SR_OK_CONTINUE.

serial: Check event ptr before using.

This avoids a NULL dereference when called twice.

Convert SR_CONF_MEASURED_QUANTITY to SR_T_MQ.

deree-de5000: Drop SR_CONF_MEASURED_QUANTITY functionality.

This was superfluous -- there is no need to be able to query the
last MQ(s) sent by the device, since they're already being sent
along with the measurements in analog packets.

Since there is also no way to change the MQ (that is done with the
buttons on the device), there is no need to even list the possible
MQs.

Change SR_T_MQLIST to SR_T_MQ.

The need to make this a list no longer applies.

SR_T_MQ is thus a type consisting of a tuple with two elements: the first
item is the MQ (type G_VARIANT_TYPE_UINT32), and the second is the MQ
flags value (G_VARIANT_TYPE_UINT64).

Check for libieee1284

Will be needed by the Hung-Chang DSO-2100 driver.

sr_session_send: pass transformed packet to datafeed callbacks

After the packet has been passed through the transformation modules,
the transformed data is in packet_in but the following code uses
the packet variable which still points to the original input.

This fixes bug #631.

hantek-dso: fix memory leak

This fixes bug #632.

lascar-el-usb: fix memory leak

This fixes bug #630.

es51919: fix memory leak

This fixes bug #629.

Don't set _POSIX_C_SOURCE for VXI/RPC related files.

Make vxi.h the first #include in all affected files and #undef the
_POSIX_C_SOURCE macro in vxi.h.

This avoids various build issues on e.g. FreeBSD or Mac OS X where
setting _POSIX_C_SOURCE leads to the unavailability of certain types
such as u_long (as used in the VXI/RPC code).

Build: Pass compiler flags from make to setup.py

Extend setup.py to allow environment variables to be set on the
command line. Use that functionality to replace the pkg-config
invocations with flags passed on from make. Suppress the annoying
-Wstrict-prototypes warning by overriding the OPT variable.

Also move the "cd bindings/python" from Makefile.am to setup.py
to side-step problems with "cd" in make rules.

This also fixes bug #628.

Build: Go back to _POSIX_C_SOURCE=200112L

configure: Enable largefile support on 32-bit systems

configure.ac: Add libserialport dependency to kern-scale.

Various key lists: Add reminders of what needs updates upon changes.

session.c: Fix key order.

analog.c: Fix key order, add missing items.

output/analog: Fix key order, add missing items.

hwdriver.c: Fix key order, add missing items.

kern-scale: Add initial driver contents.

This currently supports (and is tested on) the KERN EW 6200-2NM,
other models will be added later.

kern-scale: Initial driver skeleton.

Add a protocol parser for KERN scales.

(KERN & SOHN GmbH, http://www.kern-sohn.com/)

output/analog: Support mass related units / MQ flags.

Add a few scale related flags.

 - SR_MQ_MASS: Mass, as measured by scales / balances.

 - SR_UNIT_*: Various units of mass.

 - SR_MQFLAG_UNSTABLE: A flag denoting that a value has not
   yet stabilized (settled). E.g. when placing an object on a scale
   it'll take a few moments until a stable reading is available.
   Measurement values marked with SR_MQFLAG_UNSTABLE denote that they
   are "unsettled", unstable values (not yet stabilized).
   The absence of SR_MQFLAG_UNSTABLE denotes that the value is stable.

 - SR_CONF_SCALE: A device class for weighing scales / balances.

Build: Define feature test macro _DEFAULT_SOURCE

This basically makes glibc expose the same set of features as
if gcc was invoked without any restricting -std=c* option. Unlike
_GNU_SOURCE however, it does not enable GNU-specific extensions.

So, with this macro defined the behavior of Linux with glibc
should match that of other platforms.

Build: Use TESTS prefix instead of CHECK for flag variables

In order to avoid confusion of the flags-gathering pkg-config
result with the actual test for the availability of "check",
change the pkg-config output variable prefix from CHECK to TESTS.

Add SR_T_MQLIST.

This type consists of an array, with each item a two-member tuple,
representing an MQ/MQflags pair: the first item is the MQ (type
G_VARIANT_TYPE_UINT32), and the second is the MQ flags value
(G_VARIANT_TYPE_UINT64).

A GVariant of type SR_T_MQLIST can thus always represent more than
one MQ/MQflag pair.

Add key info tables for MQ and MQflags.

Replace sr_config_info with sr_key_info.

The tables defined with this struct can now be used for information
on items other than config keys.

Functions to access these tables have been renamed sr_key_info_[name_]get.
These take an extra argument, keytype, which should be set to SR_KEY_CONFIG
to get the config key tables. Other key types will be added.

scpi/usbtmc: Use sr_usb_close().

Add sr_usb_close().

scpi: Strip leading/trailing spaces from *IDN? response.

scpi: Propagate error codes in API functions.

This allows client drivers to detect e.g. timeout conditions.

Make sr_next_enabled_channel() from scpi-pps available library-wide.

scpi: Make helper functions from scpi-pps available library-wide.

scpi: Move SCPI-related definitions to separate header file.

sigrok.m4: License header consistency fixes.

Use the same wording and formatting as in the rest of the codebase.

Build: Limit system features to C99 and POSIX

Use -std=c99 to try and enforce standard compliance.

Build: Fix SR_CHECK_COMPILE_FLAGS

Do not put "no" into the flags if the check fails.

Build: Reduce unnecessary config substitutions

Variable substitutions with a constant value may as well be
set directly in Makefile.am.

Build: Leave LIBS alone during configure

Put the extra libraries into SR_EXTRA_LIBS instead of LIBS.
Create an SR_CHECK_LIBS macro to make that easy. Substitute
SR_EXTRA_LIBS into libsigrok.pc, too.

Build: Simplify driver dependency check

Build: Add private copy of C++11 check macro

Place a copy of ax_cxx_compile_stdcxx_11.m4 from the Autoconf
macro archive into our private m4/ directory. This is cleaner
than trying to parse M4 file versions etc. Plus, the macro is
now always available.

Build: Prefer newer versions of libftdi and SWIG

Build: Use commas to separate missing dependencies

Beautify the output. Also fix the PyGObject test.

Build: Reduce autogen.sh to a trivial stub

Use autoreconf instead of invoking the various Auto tools
separately. Get rid of the Darwin-specific guesswork -- it
does not make sense to handle this at the level of libsigrok.

People should set up their ACLOCAL_PATH themselves as appropriate
for their own system; just as they already need to set up various
other paths.

Build: Check for accepted compiler flags

Introduce the SR_CHECK_COMPILE_FLAGS macro and use it to check
for additional compiler flags. Put the accepted flags into the
separate substitution variable SR_EXTRA_CFLAGS.

With this and the preceding changes, bug #578 should now be fixed.

Build: Move package check macros to m4/sigrok.m4

Define generic macros for pkg-config dependency checks etc. in
m4/sigrok.m4, so they can be easily reused by downstream modules.

Build: Make compiler warnings configurable

Use the SR_ARG_ENABLE_WARNINGS macro to configure and check for
the availability of compiler warning flags. Maintain separate
sets of warning flags for C and C++.

The configure option --enable-warnings=[min|max|fatal|no] can
be used to set the compiler warning level for all languages.
The default level is "max".

Build: Move custom Autoconf macros to separate file

Place custom Autoconf macros which other sigrok modules may
re-use into a separate file m4/sigrok.m4. Also, introduce new
macros for defining the package and library versions, and for
gathering compiler warning flags.

Clean up .gitignore

Build: Place Autoconf macros into m4/ directory

This separates the M4 macros from the other cruft in autostuff/
to prepare for the introduction of custom macro files.

Build: Do not omit first argument to m4_warn()

It seems that contrary to what the documentation says, leaving
the category argument to m4_warn() empty is not allowed. Use
the "unsupported" category for lack of a better choice.

FreeBSD: Also check for swig3.0.

On FreeBSD (for example) the SWIG binary can also be called "swig3.0".

This fixes (together with the recent "swig2.0" addition) bug #557.

Build: Get rid of recursive make invocations

Do not invoke $(MAKE) just to execute some clean rule.
This gets rid of the "jobserver unavailable" warnings.

Build: Tell setup.py where to find SWIG

FreeBSD: Also check for swig2.0 in addition to swig.

On FreeBSD (for example) the SWIG binary is called "swig2.0".

This fixes bug #557.

FreeBSD: Fix compile/link error due to missing libusb_get_version().

The FreeBSD libusb-1.0 API implementation doesn't have libusb_get_version().
Use our CONF_LIBUSB_1_0_VERSION macro instead.

Build: Avoid $< in explicit rules

Although useful, makes other than GNU make do not like this.
Name the prerequisite explicitly instead, and circumvent any
VPATH substitution other makes may do.

Build: Skip C++ CFLAGS and LIBS check when disabled

It is not a good idea to invoke PKG_CHECK_MODULES with an empty
list of modules to check, so skip the invocation in that case.

Build: Fix typo that broke the driver enable options

Build: Make SR_DRIVER() handle dependencies

Turn the hardware driver dependency handling on its head, by
making SR_DRIVER() take a list of dependencies to check for.

Build: Make dependency on git change more robust

It can sometimes happen that .git/HEAD or .git/refs/head/*, which
are added as config.status dependencies during configure, do not
exist anymore at build time.  For instance, when the current branch
is deleted after switching to a different one.

Wrap the dependencies inside $(wildcard ...) to avoid this problem.
Note that this is a GNU make feature.  However, it should be fine
as it is only used for git builds.  Even if a non-GNU make is used,
the construct will hopefully just expand to nothing.

Build: Show glib/libzip version requirements in configure summary.

Build: Fix a typo causing libftdi1 detection issues.

Build: Properly namespace the version defines

Use the CONF_ prefix for the configured host define as well as
the various build-time version macros.

Build: Cleanup up and modernize autotools setup

Note that some --enable options of configure have become
--with or --without options.

Build: Simplify the hardware driver selection

Replace DRIVER() and DRIVER2() by a single SR_DRIVER() macro.
Derive the names of shell variables and preprocessor defines
programatically to cut down on repetition.

Add dist tarball to gitignore

setup.py: Do VPATH search for swig/enums.i

Also, in swig/classes.i include swig/enums.i rather than plain
enums.i, to guard against future name clashes.

Build: Depend on swig/enums.i where appropriate

enums.py: Place swig/enums.i into build directory

Build: Do not distribute generated headers

version.h and enums.hpp are generated at build time and should
not be included in the distribution tarball.  This seems to have
triggered a weird error when doing a VPATH build of the dist
tarball.

Build: Pass nostdinc option to automake

It seems automake automatically adds the directory containing
the generated version.h to the include path.  Use nostdinc to
disable default includes altogether.

Build: Use angle brackets for enums.cpp include

Build: Distribute bindings sources

A couple of files referenced during the build were missing from
the distribution, causing a tarball build failure.

Build: Prefix directory to include of enums.hpp

This fixes a build problem due to the reduced include search paths
introduced by my recent changes.  Also fix a couple of other
includes to use angle brackets.

Build: Append git revision hash to version

Append the git revision hash to the libsigrok package version,
unless HEAD exactly matches a release tag.  Note that this does
not affect the version known to autoconf -- e.g. source tarballs
created by make dist will not receive a revision suffix.

Changes to git HEAD automatically trigger a reconfiguration.
Uncommitted changes do not, which is why I left out the -dirty
suffix.

Consistently use SR_PACKAGE_VERSION instead of VERSION

Build: Delay expansion of $datadir in FIRMWARE_DIR

Make it so that $(datadir) is resolved at make time, as per
autotools recommendations.  Note that $datadir is not fully
resolved at configure time to begin with, i.e. part of it
already was evaluated at make time.

Build: Make version.h a configuration header

Use the proper tool for the job and make libsigrok/version.h
a secondary configuration header, so that autoconf's AC_DEFINE
machinery can be used to generate it.  Note that the header
template is still hand-written, enabling fine control of the
content.

tests: Include <libsigrok/libsigrok.h>

This matches the global style and avoids the "../" path
components.

Build: Set local include directories in Makefile.am

Move the include flags for files in the source tree from
configure.ac to Makefile.am where they belong.  Also use
AM_CPPFLAGS instead of CFLAGS/CXXFLAGS to make sure the
files in the build/source tree are always picked up first.

Also, remove the include/libsigrok sub-directory from the
search path, thereby making the <libsigrok/> prefix mandatory
when building libsigrok itself.  This matches the convention
already imposed on users of the library.