decode: Optionally print sample numbers with protocol decoder annotations

Introduce the "--protocol-decoder-samplenum" command line option (no
short form available), which emits sample numbers with textual output
from protocol decoder annotations, regardless of a log level value.

This shall increase usability of sigrok-cli output with external
postprocessors, as the option exclusively adds sample numbers to the
output but does not affect the presence or layout of any other line.

This commit prepends "text" and "meta" annotations with sample number
information. It does not change "binary" output.

decode: Rework logic for text output of protocol decoder annotations

Fold the previous three code paths which formatted text output for
annotations into one code path, which inspects the flags that were
determined before the actual output, and then always formats the fields
in identical ways regardless of why a field is shown.

Remove the assert checks that were introduced in a previous commit. The
logic for the field selection was proven to be identical to the previous
behaviour.

decode: Prepare to rework text output for protocol decoder annotations

When the current implementation receives a protocol decoder annotation,
one out of several code paths prints one of several different variations
of text layout. The current implementation exclusively checks the active
log level to determine the layout variant.

Prepare to rework that text layout logic. Separate the determination of
which fields to display from the logic which does emit those fields in a
specific format.

This commit does not yet adjust the print statements. It is supposed to
verify that the "which fields to display?" logic results in identical
behaviour to the previous implementation.

decode: Nit, avoid 'class' identifier for local variable

session: Adjust scan for non-demo device

The "demo?" condition is a property of the driver not a device instance.
Adjust the check accordingly, by not passing the 'sdi' when retrieving
the list of options. Rename the involved variable to reflect its purpose.
Adjust an error message text.

This fixes bug #848.

HACKING: Prefer git pull requests over mailing list patches.

Also, drop the reference to gitorious.org (no longer available).

configure.ac: Bump package version to 0.8.0.

0.8.0 will be the next major release. Bump now, so that
there is no confusion of tarball 0.7.0 and 0.8.0-git snapshots.

NEWS: Update for upcoming 0.7.0 release.

Fix various clang warnings.

../show.c:668:30: warning: variable 'q' is uninitialized when used here [-Wuninitialized]
                                        s = sr_period_string(p, q);
                                                                ^
../show.c:324:30: note: initialize the variable 'q' to silence this warning
        const uint64_t *uint64, p, q, low, high;
                                    ^
                                     = 0
../show.c:668:27: warning: variable 'p' is uninitialized when used here [-Wuninitialized]
                                        s = sr_period_string(p, q);
                                                             ^
../show.c:324:27: note: initialize the variable 'p' to silence this warning
        const uint64_t *uint64, p, q, low, high;
                                 ^
                                  = 0
../show.c:458:58: warning: variable 'high' is uninitialized when used here [-Wuninitialized]
                                printf("    Maximum number of samples: %"PRIu64"\n", high);
                                                                                     ^~~~
../show.c:324:41:   CC       input.o
note: initialize the variable 'high' to silence this warning
        const uint64_t *uint64, p, q, low, high;
                                               ^
                                                = 0
../show.c:589:33: warning: variable 'low' is uninitialized when used here [-Wuninitialized]
                                printf("%"PRIu64"-%"PRIu64, low, high);
                                                            ^~~
../show.c:324:35: note: initialize the variable 'low' to silence this warning
        const uint64_t *uint64, p, q, low, high;
                                         ^
                                          = 0

HACKING: Update URL to Linux kernel coding style.

README: Drop trailing whitespace.

Fix build when using --without-libsigrokdecode.

Installer: Whitespace consistency fixes.

Installer: Add "sigrok-cli" to uninstaller/Zadig links.

Windows 10 merges all links of the same vendor ("sigrok" here) into one
section in the Start menu. If PulseView and sigrok-cli are installed,
there will be two "Uninstall" links and the user will not know which one
uninstalls which program.

Installer: Place set of example .sr files in separate section

--list-supported: Show detailed library/feature info.

List supported devices, modules, decoders via --list-supported.

Move this data from -V to -L|--list-supported for usability reasons.

This fixes bug #604.

Bump requirements to libsigrok/libsigrokdecode 0.5.0.

We use various new API calls from the upcoming 0.5.0 releases and are
not compatible with the respective 0.4.x anymore.

show: Also print the possible decoder input/output IDs.

options: expand builtin help, discuss samples/time/continuous constraint

It might be surprising when the sigrok-cli(1) program does nothing (yet
spends user noticable time) before quitting while it spews the --help
text to the screen. Expand the builtin help text, explicitly mention
that either of --samples or --frames or --time or --continuous are
essentially required for data acquisition.

Update sr_period_string usage

configure summary: Show linker flags.

Show annotations based on decoder ID

Originally, decoder ID was equal to decoder instance ID, so it didn't
matter what you were comparing with. However, with distinct decoder
instances, this assumption fails. Because instance IDs can't be known
in advance, and because it would make the CLI arguments even more
complex, we simply let the -A option continue to be per decoder, not per
instance. This maintains compatibility with prior behaviour, but
doesn't allow the full flexibility possible with the library.

Behaviour preserved:
Single PD, no -A flag => all annotations from PD
Single PD, -A pdid => all annotations from PD
Single PD, -A pdid=annX => annX from PD

Behaviour now added:
Duplicate PDs, no -A flag => all annotations from all PDs
Duplicate PDs, -A pdid => all annotations from all PDs of type pdid
Duplicate PDs, -A pdid=annX => all annX from all PDs of type pdid

This fixes parts of bug #868.

Signed-off-by: Karl Palsson <redacted>

valgrind: Clear more unfreed memory issues

Command line used for checking:

  $ valgrind -v --leak-check=full ./sigrok-cli \
    -i rockband_wireless_keyboard_wii/midi_key4.sr \
    -P uart:baudrate=31250,midi -P uart:baudrate=31250,midi

Signed-off-by: Karl Palsson <redacted>

Include decoder instance ID in normal outputs

Without this, it's nigh impossible to determine what lines of output are
from what decoder. While -l 4 and above will include this information,
this feels like something that is essential even at the basic level.

Old:
System Realtime: active sensing
System Realtime: active sensing
System Realtime: active sensing
UNHANDLED DATA: 0x00
Channel 1: note on (note = 51 'D#3', velocity = 70)
System Realtime: active sensing
System Realtime: active sensing
System Realtime: active sensing
System Realtime: active sensing
UNHANDLED DATA: 0x00
Channel 1: note on (note = 51 'D#3', velocity = 70)
System Realtime: active sensing

New:

midi1: System Realtime: active sensing
midi1: System Realtime: active sensing
midi1: System Realtime: active sensing
midi1: UNHANDLED DATA: 0x00
midi1: Channel 1: note on (note = 51 'D#3', velocity = 70)
midi1: System Realtime: active sensing
midi2: System Realtime: active sensing
midi2: System Realtime: active sensing
midi2: System Realtime: active sensing
midi2: UNHANDLED DATA: 0x00
midi2: Channel 1: note on (note = 51 'D#3', velocity = 70)
midi2: System Realtime: active sensing

This fixes parts of bug #868.

Signed-off-by: Karl Palsson <redacted>

Support multiple protocol decoder stacks

Requires libsigrokdecode changes to actually work.
This allows multiple -P options to be specified, each of which is
registered as a full stack with libsigrokdecode.

At this point, there's no way to specify annotations per instance, the
annotations are simply global per decoder (as before) rather than per
instance.

This fixes parts of bug #868.

Signed-off-by: Karl Palsson <redacted>

Drop -S stack option

The -P option already stacks. The -S option was only used for changing the
stacking order. Simply require the correct order with -P. This reduces
the confusion in stacking.

Signed-off-by: Karl Palsson <redacted>

sigrok-cli_cross.nsi.in: Use Python 3.4 (Windows XP support).

The last Python version to officially support Windows XP was 3.4.x.

We'll keep the Windows installers at that version for the time being,
until Windows XP support is no longer feasible (e.g. because important
sigrok requirements such as Qt, glib, or libusb drop XP suppport).

sigrok-cli_cross.nsi.in: Bump Python version to 3.6.

license: remove FSF postal address from boiler plate license text

Remove the FSF postal address as it might change (it did in the past).
Reference the gnu.org website instead which is more stable.

--help output: More specific --show help text.

Mention that --show also works for showing input/output format options,
as well as protocol decoder options.

This fixes bug #851.

show: print binary classes as well in protocol decoder details

The output of `sigrok -P <decoder> --show` omitted the binary classes,
users could not learn which specs are available for the -B option.  Add
a "Binary classes:" section after the list of annotations.

Signed-off-by: Gerhard Sittig <redacted>

configure.ac: Bump package version to 0.7.0.

0.7.0 will be the next major release. Bump now, so that
there is no confusion of tarball 0.6.0 and 0.7.0-git snapshots.

NEWS: Update for upcoming 0.6.0 release.

Update API calls due to recent libsigrok renames.

 - sr_driver_scan_options() -> sr_driver_scan_options_list()

 - sr_dev_config_capabilities() -> sr_dev_config_capabilities_list()

Update for configuration API changes.

input: Use own main loop instead of sr_session_run()

Again, this is mainly for demonstration purposes, and to make
sigrok-cli consistently use the same "modern" API everywhere.

build: Require GLib 2.32.0

This is needed for the G_SOURCE_REMOVE symbolic constant. Although
it would be trivial to make do without it, there is no reason not to
bump the requirement since libsigrok depends on GLib 2.32.0 anyway.

anykey: Use GLib I/O channel watch

Watch for input on a GLib I/O channel using the standard GLib main
loop API instead of injecting an FD event source into the sigrok
session loop.

Also run the session in a main loop created by sigrok-cli instead
of using sr_session_run(). This is mainly for demonstration; the
GLib I/O watch change would work even with sr_session_run() since
it is using the same main context in this case.

options: Type of G_OPTION_ARG_NONE is gboolean

Change mistaken gchar * variables to gboolean type.

Use g_strerror() in favor of strerror().

windows: Install data files into share subdirectory

This allows these files to be found on standard paths relative
to the executable location.

Makefile.am: Shorten ChangeLog target a bit.

Build: Move _POSIX_C_SOURCE definition to config.h

Do not redefine it though when already set, so that it can be
overridden by the user, or indirectly by the compiler settings.

Build: Include <config.h> first in all source files

Since Autoconf places some important feature flags only into the
configuration header, it is necessary to include it globally to
guarantee a consistent build.

Use PRIu64 instead of %ld for uint64_t printing.

Clean up .gitignore

Build: Adopt modernized Autotools build system

Build: Add copy of sigrok.m4 from libsigrok

device: Use g_ascii_strcasecmp() for portability

Free trigger after acquisition session.

NSIS installer fix for Windows

Support SR_T_MQ.

Support SR_T_MQLIST.

Use new sr_key_info instead of sr_config_info.

session: Use INTERNAL_IO_HANDLING output module flag

Also, fix the segfault occuring due to an invalid outfile
handle when using srzip.

Pass unitsize to srd_session_send() directly.

Follow an API change in libsigrokdecode where srd_inst_channel_set_all()
no longer gets passed a unitsize, but rather srd_session_send() gets it.

This allows us to avoid having to guess a unitsize based on the number
of channels (which guesses incorrectly in some cases).

This fixes (parts of) bug #352.

nsis: Add start menu entries for Zadig.

This fixes bug #543.

Don't open an output file in the case of srzip.

This fixes parts of bug #570.

session: Supply filename to the output module directly

This fixes parts of bug #570.

Build-depend on the upcoming libsigrok + libsigrokdecode 0.4.0.

Bump version to 0.6.0 (the upcoming next major release).

Append "-git" to the version string.

This avoids confusion with the released tarballs.

Check if hash table is NULL before accessing it.

This fixes bug 520.

autogen.sh: Drop obsolete MinGW/MSYS items.

For Windows builds (which require MinGW-w64) we currently support:

 - cross-builds using MXE (mxe.cc) and possibly other cross-compile setups

 - native builds using MSYS2 (sf.net/projects/msys2/)

Neither of those require explicitly specifying ACLOCAL_DIR.

Update due to sr_driver_list() now taking a context.

Minor cosmetics.

Don't check g_free() arguments for NULL.

The g_free() call is guaranteed to not segfault when NULL is passed.

Various #include file cosmetic fixes.

Generally include system headers before local headers, unless there's
a technical reason to use another order.

sigrok-cli: Update for sr_session_{new,load} API change.

Minor cosmetics, whitespace- and consistency fixes.

Use sr_dev_channel_enable().

Fix memory leak in config_key_has_cap().

session.c: Indicate the error type when --config --set fails.

When sigrok-cli fails to set a config option it doesn't indicate
the actual error as opposed to --get. Print the error message in
both cases.

Signed-off-by: Bartosz Golaszewski <redacted>

show: pass NULL parameter to config_key_has_cap() instead of uninitialized cg.

It doesn't make sense to pass a cg to this config_key_has_cap() call
as it is trying to retrieve the device's global SR_CONF_LIMIT_SAMPLES.

This fixes the following warning:

show.c: In function ‘show_dev_detail’:
show.c:392:8: warning: ‘cg’ may be used uninitialized in this function [-Wmaybe-uninitialized]
     && config_key_has_cap(driver, sdi, cg, key, SR_CONF_LIST)) {
        ^

session: remove unused variable 'size'.

Implement support for running transform modules.

Syntax:

 sigrok-cli ... -T <transformmodule>:opt1=val1:opt2=val2 ...

Add -T|--transform-module and show transform modules in -V output.

README: Update build requirements list.

opt_to_gvar: notify the user in case of invalid values for --config

sigrok-cli exits silently in many cases where values passed to --config are
empty strings or haven't been converted by GLib functions properly.

Check for errors and notify the user.

Signed-off-by: Bartosz Golaszewski <redacted>

opt_to_gvar: support SR_T_KEYVALUE

The key-value data type is not supported as a configuration option. Implement
its support as a GLib dictionary.

Signed-off-by: Bartosz Golaszewski <redacted>

opt_to_gvar: print an error message for unsupported data types

Unsupported data types are silently ignored in opt_to_gvar() switch
statement. This leads to confusion as sigrok-cli just exits without
giving the user any hint on what's the reason for not setting the option
properly.

Add an error message for unmatched data types.

Signed-off-by: Bartosz Golaszewski <redacted>

mingw: Drop libusb0.dll, always use libusb-1.0.

Always check config key capabilities before using them.

Check for config key availability before using it.

Use the srzip output module instead of session save API.

Use getters now that 'struct sr_dev_inst' is opaque.

Show driver detail even if no device was found.

show: Handle more datatypes in a generic way.

Fix memory leak.

Parse boolean command line options.

This fixes bug 450.

Clean up session file loading.

input: Use sr_input_end() at end of input stream.

input: Don't use the sdi until it's ready.

Set device options when called with --get.

Make sure to treat all config keys as uint32_t.

Fix a compiler warning.

input.c: In function ‘load_input_file’:
input.c:123:7: warning: ‘fd’ may be used uninitialized in this function
[-Wmaybe-uninitialized]
   len = read(fd, buf->str, BUFSIZE);
       ^
input.c:42:6: note: ‘fd’ was declared here
  int fd;
      ^

Adapt to config key capabilities.

Replace ann_format with ann_class.

The naming has been changed to "annotation class" a while ago.

Always save all channels to a session file.

This works around limitations of the current API that screw up saving
only enabled channels. See bug 410.