typo

Document stream-base.dbd usage when sCalcout is not needed

.VERSION

@@ -0,0 +1,3 @@
+COMMIT: $Format:%H$
+REFS:   $Format:%D$
+DATE:   $Format:%ci$

.ci-local/defaults.set

@@ -0,0 +1,12 @@
+MODULES=calc asyn
+
+# EPICS Base
+BASE_DIRNAME=base
+BASE_REPONAME=epics-base
+BASE_REPOOWNER=epics-base
+BASE_VARNAME=EPICS_BASE
+BASE_RECURSIVE=no
+
+ASYN_REPOOWNER=epics-modules
+
+CALC_REPOOWNER=epics-modules

.gitattributes

@@ -0,0 +1,2 @@
+GNUmakefile export-ignore
+.VERSION export-subst

.github/workflows/ci-scripts-build.yml

@@ -0,0 +1,164 @@
+# .github/workflows/ci-scripts-build.yml for use with EPICS Base ci-scripts
+# (see: https://github.com/epics-base/ci-scripts)
+
+# This is YAML - indentation levels are crucial
+
+# Workflow name, shared by all branches
+
+name: StreamDevice
+
+# Trigger on pushes and PRs to any branch
+on:
+  push:
+    paths-ignore:
+      - 'docs/*'
+      - '.gitattributes'
+      - '.gitignore'
+      - '**/*.html'
+      - '**/*.md'
+  pull_request:
+    paths-ignore:
+      - 'docs/*'
+      - '.gitattributes'
+      - '.gitignore'
+      - '**/*.html'
+      - '**/*.md'
+
+env:
+    SETUP_PATH: .ci-local:.ci
+    EPICS_TEST_IMPRECISE_TIMING: YES
+
+jobs:
+  native:
+    name: ${{ matrix.name }}
+    runs-on: ${{ matrix.os }}
+    # Set environment variables from matrix parameters
+    env:
+      CMP: ${{ matrix.cmp }}
+      BCFG: ${{ matrix.configuration }}
+      BASE: ${{ matrix.base }}
+      WINE: ${{ matrix.wine }}
+      RTEMS: ${{ matrix.rtems }}
+      RTEMS_TARGET: ${{ matrix.rtems_target }}
+      TEST: ${{ matrix.test }}
+      EXTRA: ${{ matrix.extra }}
+      VV: "1"
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - name: Native Linux (WError)
+            os: ubuntu-20.04
+            cmp: gcc
+            configuration: default
+            base: "7.0"
+            extra: "CMD_CPPFLAGS=-Werror"
+            pcre: apt
+
+          - name: Cross mingw64 DLL
+            os: ubuntu-20.04
+            cmp: gcc
+            configuration: default
+            base: "7.0"
+            wine: "64"
+            pcre: no
+
+          - name: Cross mingw64 static
+            os: ubuntu-20.04
+            cmp: gcc
+            configuration: static
+            base: "7.0"
+            wine: "64"
+            pcre: no
+
+          - name: RTEMS 4.10
+            os: ubuntu-20.04
+            cmp: gcc
+            configuration: default
+            base: "7.0"
+            rtems: "4.10"
+            rtems_target: RTEMS-pc386-qemu
+            pcre: no
+ 
+          - name: Native Linux with clang
+            os: ubuntu-20.04
+            cmp: clang
+            configuration: default
+            base: "7.0"
+            pcre: apt
+
+          - name: Native Linux with 3.15
+            os: ubuntu-20.04
+            cmp: gcc
+            configuration: default
+            base: "3.15"
+            pcre: apt
+
+          - name: Native Linux with 3.14
+            os: ubuntu-20.04
+            cmp: gcc
+            configuration: default
+            base: "3.14"
+            pcre: apt
+
+          - name: OSX
+            os: macos-latest
+            cmp: clang
+            configuration: default
+            base: "7.0"
+            pcre: no
+
+          - name: vs2019 DLL
+            os: windows-2019
+            cmp: vs2019
+            configuration: debug
+            base: "7.0"
+            pcre: no
+            extra: "CMD_CFLAGS=-analysis CMD_CXXFLAGS=-analysis"
+
+          - name: vs2019 static
+            os: windows-2019
+            cmp: vs2019
+            configuration: static-debug
+            base: "7.0"
+            pcre: no
+            extra: "CMD_CFLAGS=-analysis CMD_CXXFLAGS=-analysis"
+
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        submodules: true
+    - name: Automatic core dumper analysis
+      uses: mdavidsaver/ci-core-dumper@master
+    - name: "apt-get install"
+      run: |
+        sudo apt-get update
+        sudo apt-get -y install qemu-system-x86 g++-mingw-w64-x86-64 gdb
+      if: runner.os == 'Linux'
+
+    - name: Reset RELEASE
+      shell: bash
+      # 'make' on Mac doesn't understand "undefine PCRE"
+      # so replace the whole file
+      run: |
+        cat <<EOF > configure/RELEASE
+        -include \$(TOP)/../RELEASE.local
+        -include \$(TOP)/../RELEASE.\$(EPICS_HOST_ARCH).local
+        -include \$(TOP)/configure/RELEASE.local
+        EOF
+
+    - name: Prepare and compile dependencies
+      run: python .ci/cue.py prepare
+
+    - name: "apt-get install pcre"
+      if: matrix.pcre == 'apt'
+      shell: bash
+      run: |
+        sudo apt-get -y install libpcre3-dev
+        cat <<EOF >> configure/CONFIG_SITE.local
+        PCRE_INCLUDE=/usr/include
+        PCRE_LIB=/usr/lib
+        EOF
+
+    - name: Build main module
+      run: python .ci/cue.py build

.gitignore

@@ -6,3 +6,5 @@ dbd
 include
 *.pdf
 *.*log
+StreamVersion.h
+*.local

.gitmodules

@@ -0,0 +1,3 @@
+[submodule ".ci"]
+	path = .ci
+	url = https://github.com/epics-base/ci-scripts.git

CHANGELOG.md

@@ -0,0 +1,303 @@
+# Changelog
+
+## Changes in release 2.8.20
+
+Fix missing initialization of `inTerminator` and `outTerminator`.
+Thanks to Krisztián Löki.
+
+New checksums `%<lrc>` and `%<hexlrc>`.
+Thanks to Marcio Paduan Donadio.
+
+Make timestamp output in error and debug messages optional with new
+iocsh variable `streamMsgTimeStamped`. Default is 1.
+
+Reduce number of duplicate error messages. Dead time for repeated messages
+is configurable with new iocsh variable `streamErrorDeadTime`.
+Thanks to Dominic Oram.
+
+Shifted some noisy debug messages to `streamDebug` level 2.
+
+In `STREAM_PROTOCOL_PATH`, allow both `:` and `;` separators on all
+operating systems to make startup scripts OS independent.
+On Windows however, an initial single letter followed by a `:` is detected
+as a drive letter. Thus single letter directories must be separated with
+`;` or followed by `\` or `/` on Windows.
+
+Allow absolute path protocol files. Those will not use
+`STREAM_PROTOCOL_PATH`. 
+Changed the default search path from `"."` to `NULL`.
+
+Only poll for `I/O Intr` records while `interruptAccept` is true,
+in particular not between `iocPause` and `iocRun`.
+
+Added this change log and a document about contributing to StreamDevice.
+
+## Changes in release 2.8.19
+
+Make colorization of error and debug messages optional with new
+iocsh variable `streamDebugColored`. Defaults to 1 when output is a tty
+and 0 otherwise.
+
+## Changes in release 2.8.18
+
+Another format string fix for VxWorks in checksum converter.
+
+## Changes in release 2.8.17
+
+Fix format strings for VxWorks 6.9 in checksum converter.
+
+Fix some compiler warnings on Windows.
+
+Fix some missing header files installations.
+
+## Changes in release 2.8.16
+
+Drop support of upper level `configure/` directory for improved
+compatibility with SynApps.
+
+Fix problem with extra spaces after protocol name in record links.
+
+Make version string generation more robust.
+
+## Changes in release 2.8.15
+
+Do not overwrite `HOST_OPT` flag. 
+
+Fix version string generation for zip downloads.
+
+On Windows use `;` and `\` in `STREAM_PROTOCOL_PATH`.
+(Was not the case before due to typo in macro name.)
+
+Link streamApp with `seq` and `pv` libraries when `SNCSEQ` is defined in
+RELEASE file.
+
+## Changes in release 2.8.14
+
+Fix version string generation from git tags.
+
+## Changes in release 2.8.13
+
+Fix bug with integer datatype handling in redirectons.
+
+## Changes in release 2.8.12
+
+Apply GPL-3.0.
+
+## Changes in release 2.8.11
+
+Fix buffer overrun.
+Thanks to Garth Brown and Bruce Hill.
+
+Fix bug in 64 bit data type handling in array records (`aai`, `aao`,
+`waveform`).
+Thanks to Andrew Johnson.
+
+Fix Windows linker problem.
+Thanks to Freddie Akeroyd.
+
+Allow `(,)` inside protocol parameters. Limitation: Parenthesis must be in
+matching pairs. Commas within inner parenthesis are consideres part of the
+argument. Example: `protocol(arg1, (arg2, still arg 2), arg3)`.
+
+New checksums `%<brksCryo>`, `%<xor8ff>`, `%<nsum8>`, `%<nsum16>`,
+`%<nsum32>`, `%<notsum>`.
+Thanks to Mark Davis.
+
+Some error message cleanup.
+
+## Changes in release 2.8.10
+
+Fixes for Windows / Visual Studio 2010.
+Thanks to Freddie Akeroyd.
+
+Fix infinite loop in `I/O Intr` scanned records.
+
+Enable error messages by default and always show error messages too when
+debug messages are enabled.
+
+Make sure any console output from StreamDevice can be redirected.
+
+Fix some problems when building for old EPICS R3.13.
+
+## Changes in release 2.8.9
+
+Leave `asynTraceMask` alone. Before, streamDevice had set `setTraceMask`
+to 0 initially.
+
+Link with `sscan` module if `SSCAN` is defined in RELEASE file because the
+`calc` module may need it.
+
+Fix in regsub converter: Avoid infinite loop if an empty string is matched.
+Add support for toupper/tolower to regsub converter.
+
+Fix build problem observed on MacOS related to clash between `wait()`
+system function and the StreamDevice `wait` command.
+
+Allow `%%` in addition to `\%` to escape `%` in protocols (compatibility
+with `printf`/`scanf`).
+
+Have separate dbd file for applications without scalcout support built in.
+
+Improved compatibility with SynApps. (fix of the attempt in 2.8.6)
+
+## Changes in release 2.8.8
+
+Fix problem with `in` command hanging forever if it is the the first
+command of the protocol and the device is offline.
+
+## Changes in release 2.8.7
+
+Enable colored error/debug output on Windows.
+
+Changed error/debug hex output highlight from fat to inverse.
+
+Fix build problem on Windows.
+
+## Changes in release 2.8.6
+
+Improved compatibility with SynApps.
+
+Fix redirection to records with names not starting with a letter or
+underscore.
+
+### Fixes/improvements for `mbbo` device support:
+
+Use `.MASK` and `.SHFT` fields even if no `xxVL` field is defined
+(and thus `.VAL` is used instead of `.RVAL`).
+
+Bugfix: Set `mbbo` to unknown state `0xffff` if in readback no state
+matches.
+
+Bugfix: Use defined state alarms when `mbbo` is updated by `@init` handler.
+
+## Changes in release 2.8.5
+
+A `"\?"` at the end of an input format now matches an empty string.
+Used to do so unintendedly in earlier versions but had been changed.
+
+## Changes in release 2.8.4
+
+Bugfix: After `@init` had been triggered with "magic value" 2 in `.PROC`
+field, reset the field to 0.
+
+## Changes in release 2.8.3
+
+Increase limits on filename, protocolname, busname in record links.
+
+Bugfix: Fix typo calcout device support that prevented compiling it.
+
+## Changes in release 2.8.2
+
+Bugfix: Fix string termination reading into char array records (`waveform`,
+`aai`, `aao`, `lsi`, `lso`).
+
+## Changes in release 2.8.1
+
+Allow empty parameter list `()` in record links.
+
+## Changes between 2.7 and 2.8.0
+
+### Build system
+
+Drop support for (buggy) cygnus-2.7.2 gcc (as used in some old cygwin
+version).
+
+Add standard EPICS App build system (`configure/`).
+
+Some re-ordering of directories.
+When upgrading from 2.7 or earlier to 2.8, better start with a fresh
+source directory to avoid problems with files that have moved.
+
+### New Features
+
+Support for 64 bit integers. This affects some conversions (e.g. in `ai`
+and `ao` records).
+
+Device support for new record types `int64in`, `int64out`, `lsi` and `lso`
+added.
+
+Support for new `INT64` and `UINT64` types in `aai`, `aao` and `waveform`
+records.
+
+Allow spaces in protocol parameter list in record link.
+One space after the opening `(`, before and after the separating `,` and
+before the closing `)` ignored. More spaces are part of the parameter.
+
+String format `%s` can now pad with 0-bytes instead of spaces using the
+`0` flag.
+
+New checksums `%<cpi>` and `%<leybold>`.
+
+Properly distinguish beween signed and unsigned integers, e.g. when
+converting to double.
+Allow signed enums to do this: `%#{backwards=-1|stop=0|forwards=1}`.
+
+#### New connection handling
+
+Run `@init` handler each time the device (re-)connects
+(as long as asynDriver detects connection changes), also at each `iocRun`
+(after being paused with `iocPause`), and after each `streamReload`.
+
+Also run `@init` of a record when the "magic value" 2 is written to the
+`.PROC` field or when new `streamReinitRecord` shell function is called.
+
+Trigger monitors when `@init` updates output records (after the intial run
+in `iocInit`).
+
+Use `"COMM"` error code in `.STAT` when device is disconnected.
+
+If write fails because device has disconnected, try to re-connect and re-do
+write once.
+
+### Bug fixes 
+
+Fix parser bug when command reference was followed by `}` without `;`.
+
+Fix potential buffer overrun during `streamReload`.
+After `streamReload`, properly delete handlers and variables that do not
+exist any longer.
+
+Fix for waveforms of unsigned integers.
+
+Several Windows related fixes and support building shared libraries on
+Windows.
+
+Fix C++11 warnings.
+
+Check formatting of `exec` command for errors.
+
+Fix bug in `dbior` output.
+
+Fix BCD `%D` format and allow negative values.
+
+Fix signed hex and octal formats.
+
+Fix in regsub: Do not run regsub again on substituted string.
+
+### Shell functions
+
+New functions `streamReportRecord` and `streamSetLogfile`.
+
+Support output redirection to file of stream shell functions
+and protocol dump via `dbior`.
+
+### Error and debug output
+
+Cleanup some debug and error messages.
+
+Hex bytes in debug/error output are now highlighted.
+
+`StreamError` can now be set before `iocInit`.
+
+Avoid repeating error messages.
+Thanks to Ben Franksen.
+
+### Documentation
+
+HTML files converted to HTML 5. 
+
+Update and improve several chapters.
+
+## Changes in releases up to 2.7.14
+
+Not available. See git log.

Contributing.md

@@ -0,0 +1,81 @@
+# Contributing to StreamDevice
+
+Contributions from the EPICS community (and others) are welcome.
+To ease the integration process, please follow the following guidelines.
+
+All contributions should be done as a pull request to the git repository
+https://github.com/paulscherrerinstitute/StreamDevice. Make sure to provide
+meaningful commit messages (no essay but more than "changes").
+
+For small modifications, a patch file is sufficient. Send it to me or better
+create an issue on https://github.com/paulscherrerinstitute/StreamDevice/issues
+and attach the patch file.
+
+Justify your change requests. Write a short summary for your pull request
+to explain what the change is about and what it improves or which bug it
+fixes. Use the issue system on github to report bugs.
+
+I reserve the right to accept or reject contributions or to request
+modifications before I accept them.
+
+Of course, you may as well report bugs without providing a solution yourself.
+
+## Code compatibility
+
+All code must compile for any EPICS release from at least R3.14.12 up to the
+latest one. Likewise the code must be compatible with any operating system
+supported by EPICS, like Linux, Windows, MacOS, RTEMS and VxWorks.
+In particular VxWorks 5 compatibility rules out many modern C++ features.
+But there are also other platforms that for example do not support C++11, so
+don't use it. 
+There should also be no compiler warning on any OS.
+
+Avoid compiler dependent features like #pragmas, assumptions on byte order,
+type size (in particular the size of pointers and long int) and other
+non-portable things like the availability of certain header files. Make sure
+non-portable code parts are enclosed in proper compiler branches and provide
+working implementations for all architectures.
+
+Make sure that the code in AsynDriverInterface stays compatible with old
+and new versions of asyn driver.
+
+The core of StreamDevice does not depend on EPICS. This is on purpose, to be
+able to use it in other control system frameworks. Modifications should not
+add EPICS dependencies except to StreamEpics and AsynDriverInterface, or the
+new dependency must be in a separate file which can be left out of the build
+without jeopardizing the main functionality of StreamDevice.
+
+The code must not depend on external libraries that may not be available on
+all systems, except if provided as a separate file which can be left out of
+the build on platforms that do not support the library.
+
+## Language
+
+Write in English. That includes all identifiers (variables, functions, ...),
+comments, documentation and commit messages. Check your spelling.
+
+## File formats
+
+All files are in Unix format (\n line terminators). Do not change them to
+any other format (e.g. Windows with \r\n terminators). Do not add new files in
+other formats.
+
+The files must contain only ASCII characters. Do not use any Unicode multi-byte
+characters (including byte order marks) or any pre-Unicode code page dependent
+characters (e.g. umlaut), not even in comments. Do not use form feed, vertical
+tab, or other control characters except newline.
+
+Indents are 4 spaces. Do not use tabs (except in Makefiles). Make sure your
+editor is set up accordingly.
+
+Files must end in a newline and there must be no spaces at the end of lines.
+Do not add excessive amount of newlines at the end of files.
+
+Do not add any editor configurations (e.g. for emacs) to the files. Also do
+not add any configuration files or directories for development environments,
+editors, etc.
+
+-------
+
+Dirk Zimoch <dirk.zimoch@psi.ch>, June 2021
+

GNUmakefile

@@ -5,7 +5,7 @@ else
 include /ioc/tools/driver.makefile
 EXCLUDE_VERSIONS = 3.13.2
 PROJECT=stream
-BUILDCLASSES += Linux
+BUILDCLASSES += vxWorks Linux WIN32
 
 DOCUDIR = docs
 
@@ -19,18 +19,27 @@ SOURCES += $(FORMATS:%=src/%Converter.cc)
 SOURCES += $(BUSSES:%=src/%Interface.cc)
 SOURCES += $(STREAM_SRCS:%=src/%)
 
-HEADERS += devStream.h
-HEADERS += StreamFormat.h
-HEADERS += StreamFormatConverter.h
-HEADERS += StreamBuffer.h
-HEADERS += StreamError.h
+HEADERS += src/devStream.h
+HEADERS += src/StreamFormat.h
+HEADERS += src/StreamFormatConverter.h
+HEADERS += src/StreamBuffer.h
+HEADERS += src/StreamError.h
+HEADERS += src/StreamProtocol.h
+HEADERS += src/StreamBusInterface.h
+HEADERS += src/StreamCore.h
+HEADERS += src/MacroMagic.h
+HEADERS += $(COMMON_DIR)/StreamVersion.h
 
-StreamCore.o StreamCore.d: streamReferences
+CPPFLAGS += -DSTREAM_INTERNAL -I$(COMMON_DIR)
 
-# Update version string (contains __DATE__ and __TIME__)
-# each time anything changes.
-StreamVersion.o: $(filter-out StreamVersion.o stream_exportAddress.o,$(LIBOBJS))
+# Update version string each time anything changes
+StreamVersion$(OBJ) StreamVersion$(DEP): $(COMMON_DIR)/StreamVersion.h $(filter-out StreamVersion$(OBJ) stream_exportAddress$(OBJ),$(LIBOBJS) $(LIBRARY_OBJS))
 
+$(COMMON_DIR)/StreamVersion.h: $(filter-out StreamVersion.h,$(notdir $(SOURCES) $(HEADERS)))
+	@echo Creating $@
+	$(PERL) ../src/makeStreamVersion.pl $@
+
+StreamCore$(OBJ) StreamCore$(DEP): streamReferences
 streamReferences:
 	$(PERL) ../src/makeref.pl Interface $(BUSSES) > $@
 	$(PERL) ../src/makeref.pl Converter $(FORMATS) >> $@

LICENSE

@@ -0,0 +1,674 @@
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+  The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works.  By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.  We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors.  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+  To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights.  Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received.  You must make sure that they, too, receive
+or can get the source code.  And you must show them these terms so they
+know their rights.
+
+  Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+  For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software.  For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+  Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so.  This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software.  The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable.  Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products.  If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+  Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary.  To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                       TERMS AND CONDITIONS
+
+  0. Definitions.
+
+  "This License" refers to version 3 of the GNU General Public License.
+
+  "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+  "The Program" refers to any copyrightable work licensed under this
+License.  Each licensee is addressed as "you".  "Licensees" and
+"recipients" may be individuals or organizations.
+
+  To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy.  The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+  A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+  To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy.  Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+  To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies.  Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+  An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License.  If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+  1. Source Code.
+
+  The "source code" for a work means the preferred form of the work
+for making modifications to it.  "Object code" means any non-source
+form of a work.
+
+  A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+  The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form.  A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+  The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities.  However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work.  For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+  The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+  The Corresponding Source for a work in source code form is that
+same work.
+
+  2. Basic Permissions.
+
+  All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met.  This License explicitly affirms your unlimited
+permission to run the unmodified Program.  The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work.  This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+  You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force.  You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright.  Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+  Conveying under any other circumstances is permitted solely under
+the conditions stated below.  Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+  No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+  When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+  4. Conveying Verbatim Copies.
+
+  You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+  You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+  5. Conveying Modified Source Versions.
+
+  You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+    a) The work must carry prominent notices stating that you modified
+    it, and giving a relevant date.
+
+    b) The work must carry prominent notices stating that it is
+    released under this License and any conditions added under section
+    7.  This requirement modifies the requirement in section 4 to
+    "keep intact all notices".
+
+    c) You must license the entire work, as a whole, under this
+    License to anyone who comes into possession of a copy.  This
+    License will therefore apply, along with any applicable section 7
+    additional terms, to the whole of the work, and all its parts,
+    regardless of how they are packaged.  This License gives no
+    permission to license the work in any other way, but it does not
+    invalidate such permission if you have separately received it.
+
+    d) If the work has interactive user interfaces, each must display
+    Appropriate Legal Notices; however, if the Program has interactive
+    interfaces that do not display Appropriate Legal Notices, your
+    work need not make them do so.
+
+  A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit.  Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+  6. Conveying Non-Source Forms.
+
+  You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+    a) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by the
+    Corresponding Source fixed on a durable physical medium
+    customarily used for software interchange.
+
+    b) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by a
+    written offer, valid for at least three years and valid for as
+    long as you offer spare parts or customer support for that product
+    model, to give anyone who possesses the object code either (1) a
+    copy of the Corresponding Source for all the software in the
+    product that is covered by this License, on a durable physical
+    medium customarily used for software interchange, for a price no
+    more than your reasonable cost of physically performing this
+    conveying of source, or (2) access to copy the
+    Corresponding Source from a network server at no charge.
+
+    c) Convey individual copies of the object code with a copy of the
+    written offer to provide the Corresponding Source.  This
+    alternative is allowed only occasionally and noncommercially, and
+    only if you received the object code with such an offer, in accord
+    with subsection 6b.
+
+    d) Convey the object code by offering access from a designated
+    place (gratis or for a charge), and offer equivalent access to the
+    Corresponding Source in the same way through the same place at no
+    further charge.  You need not require recipients to copy the
+    Corresponding Source along with the object code.  If the place to
+    copy the object code is a network server, the Corresponding Source
+    may be on a different server (operated by you or a third party)
+    that supports equivalent copying facilities, provided you maintain
+    clear directions next to the object code saying where to find the
+    Corresponding Source.  Regardless of what server hosts the
+    Corresponding Source, you remain obligated to ensure that it is
+    available for as long as needed to satisfy these requirements.
+
+    e) Convey the object code using peer-to-peer transmission, provided
+    you inform other peers where the object code and Corresponding
+    Source of the work are being offered to the general public at no
+    charge under subsection 6d.
+
+  A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+  A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling.  In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage.  For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product.  A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+  "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source.  The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+  If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information.  But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+  The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed.  Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+  Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+  7. Additional Terms.
+
+  "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law.  If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+  When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it.  (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.)  You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+  Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+    a) Disclaiming warranty or limiting liability differently from the
+    terms of sections 15 and 16 of this License; or
+
+    b) Requiring preservation of specified reasonable legal notices or
+    author attributions in that material or in the Appropriate Legal
+    Notices displayed by works containing it; or
+
+    c) Prohibiting misrepresentation of the origin of that material, or
+    requiring that modified versions of such material be marked in
+    reasonable ways as different from the original version; or
+
+    d) Limiting the use for publicity purposes of names of licensors or
+    authors of the material; or
+
+    e) Declining to grant rights under trademark law for use of some
+    trade names, trademarks, or service marks; or
+
+    f) Requiring indemnification of licensors and authors of that
+    material by anyone who conveys the material (or modified versions of
+    it) with contractual assumptions of liability to the recipient, for
+    any liability that these contractual assumptions directly impose on
+    those licensors and authors.
+
+  All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10.  If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term.  If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+  If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+  Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+  8. Termination.
+
+  You may not propagate or modify a covered work except as expressly
+provided under this License.  Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+  However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+  Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+  Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License.  If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+  9. Acceptance Not Required for Having Copies.
+
+  You are not required to accept this License in order to receive or
+run a copy of the Program.  Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance.  However,
+nothing other than this License grants you permission to propagate or
+modify any covered work.  These actions infringe copyright if you do
+not accept this License.  Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+  10. Automatic Licensing of Downstream Recipients.
+
+  Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License.  You are not responsible
+for enforcing compliance by third parties with this License.
+
+  An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations.  If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+  You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License.  For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+  11. Patents.
+
+  A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based.  The
+work thus licensed is called the contributor's "contributor version".
+
+  A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version.  For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+  Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+  In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement).  To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+  If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients.  "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+  If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+  A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License.  You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+  Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+  12. No Surrender of Others' Freedom.
+
+  If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all.  For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+  13. Use with the GNU Affero General Public License.
+
+  Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work.  The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+  14. Revised Versions of this License.
+
+  The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+  Each version is given a distinguishing version number.  If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation.  If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+  If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+  Later license versions may give you additional or different
+permissions.  However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+  15. Disclaimer of Warranty.
+
+  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+  16. Limitation of Liability.
+
+  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+  17. Interpretation of Sections 15 and 16.
+
+  If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+  If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+    <program>  Copyright (C) <year>  <name of author>
+    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+  You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+<https://www.gnu.org/licenses/>.
+
+  The GNU General Public License does not permit incorporating your program
+into proprietary programs.  If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.  But first, please read
+<https://www.gnu.org/licenses/why-not-lgpl.html>.

LICENSE.LESSER

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

Makefile

@@ -1,18 +1,30 @@
-TOP = ..
-ifneq ($(wildcard ../configure),)
-  # We are in an EPICS R3.14+ <TOP> location
-  include $(TOP)/configure/CONFIG
-else ifneq ($(wildcard ../config),)
-  # We are in an EPICS R3.13 <TOP> location
-  CONFIG = $(TOP)/config
-  include $(TOP)/config/CONFIG_APP
-else
-  # Using our own local configuration
-  TOP = .
-  DIRS = configure
-  src_DEPEND_DIRS := $(DIRS)
-  include $(TOP)/configure/CONFIG
-endif
+##########################################################################
+# This is an EPICS Makefile for StreamDevice.
+# Normally it should not be necessary to modify this file.
+# All configuration can be done in CONFIG_STREAM
+#
+# (C) 2007,2018 Dirk Zimoch (dirk.zimoch@psi.ch)
+#
+# This file is part of StreamDevice.
+#
+# StreamDevice is free software: You can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# StreamDevice is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with StreamDevice. If not, see https://www.gnu.org/licenses/.
+#########################################################################/
+
+TOP = .
+DIRS = configure
+src_DEPEND_DIRS := $(DIRS)
+include $(TOP)/configure/CONFIG
 
 DIRS += src
 DIRS += streamApp

README.md

@@ -18,3 +18,18 @@ and the replies it sends.
 
 For a full documentation see
 https://paulscherrerinstitute.github.io/StreamDevice.
+
+## Licensing
+
+StreamDevice is free software: You can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published
+by the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+StreamDevice is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License
+along with StreamDevice. If not, see https://www.gnu.org/licenses/.

config/Makefile

@@ -1,3 +1,26 @@
+##########################################################################
+# This is an EPICS Makefile for StreamDevice.
+# Normally it should not be necessary to modify this file.
+# All configuration can be done in CONFIG_STREAM
+#
+# (C) 2018 Dirk Zimoch (dirk.zimoch@psi.ch)
+#
+# This file is part of StreamDevice.
+#
+# StreamDevice is free software: You can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# StreamDevice is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with StreamDevice. If not, see https://www.gnu.org/licenses/.
+#########################################################################/
+
 TOP=..
 include $(TOP)/config/CONFIG_APP
 ifneq ($(wildcard $(EPICS_BASE)/config),)

configure/CONFIG

@@ -1,14 +1,29 @@
-#CONFIG
-include $(TOP)/configure/CONFIG_APP
-# Add any changes to make definitions here
+# CONFIG - Load build configuration data
+#
+# Do not make changes to this file!
 
-#CROSS_COMPILER_TARGET_ARCHS = vxWorks-68040
-#CROSS_COMPILER_TARGET_ARCHS = 
+# Allow user to override where the build rules come from
+RULES = $(EPICS_BASE)
 
-# Use this when your IOC and the host use different paths
-# to access the application. Typically this will be 
-# used with the Microsoft FTP server or with NFS mounts. Use
-# is indicated by failure of the cdCommands script on
-# vxWorks. You must rebuild in the iocBoot directory 
-# before this takes effect.
-#IOCS_APPL_TOP = <the top of the application as seen by the IOC>
+# RELEASE files point to other application tops
+include $(TOP)/configure/RELEASE
+-include $(TOP)/configure/RELEASE.$(EPICS_HOST_ARCH)
+-include $(TOP)/configure/RELEASE.$(EPICS_HOST_ARCH).Common
+ifdef T_A
+-include $(TOP)/configure/RELEASE.Common.$(T_A)
+-include $(TOP)/configure/RELEASE.$(EPICS_HOST_ARCH).$(T_A)
+endif
+
+CONFIG = $(RULES)/configure
+include $(CONFIG)/CONFIG
+
+# Override the Base definition:
+INSTALL_LOCATION = $(TOP)
+
+# CONFIG_SITE files contain other build configuration settings
+include $(TOP)/configure/CONFIG_SITE
+-include $(TOP)/configure/CONFIG_SITE.$(EPICS_HOST_ARCH).Common
+ifdef T_A
+ -include $(TOP)/configure/CONFIG_SITE.Common.$(T_A)
+ -include $(TOP)/configure/CONFIG_SITE.$(EPICS_HOST_ARCH).$(T_A)
+endif

configure/CONFIG_APP

@@ -1,27 +0,0 @@
-# CONFIG_APP
-
-include $(TOP)/configure/RELEASE
--include $(TOP)/configure/RELEASE.$(EPICS_HOST_ARCH)
--include $(TOP)/configure/RELEASE.Common.$(T_A)
--include $(TOP)/configure/RELEASE.$(EPICS_HOST_ARCH).$(T_A)
-
-ifneq ($(wildcard $(EPICS_BASE)/configure),)
-CONFIG=$(EPICS_BASE)/configure
-else
-CONFIG=$(EPICS_BASE)/config
-DIRS += config
-endif
-include $(CONFIG)/CONFIG
-
-INSTALL_LOCATION = $(TOP)
-ifdef INSTALL_LOCATION_APP
-INSTALL_LOCATION = $(INSTALL_LOCATION_APP)
-endif
-
-ifdef T_A
--include $(TOP)/configure/O.$(T_A)/CONFIG_APP_INCLUDE
-endif
-
-# dbst based database optimization (default: NO)
-DB_OPT = NO
-HOST_OPT=NO

configure/CONFIG_SITE

@@ -0,0 +1,40 @@
+# CONFIG_SITE
+
+-include $(SUPPORT)/configure/CONFIG_SITE
+
+# Make any application-specific changes to the EPICS build
+#   configuration variables in this file.
+#
+# Host/target specific settings can be specified in files named
+#   CONFIG_SITE.$(EPICS_HOST_ARCH).Common
+#   CONFIG_SITE.Common.$(T_A)
+#   CONFIG_SITE.$(EPICS_HOST_ARCH).$(T_A)
+
+# CHECK_RELEASE controls the consistency checking of the support
+#   applications pointed to by the RELEASE* files.
+# Normally CHECK_RELEASE should be set to YES.
+# Set CHECK_RELEASE to NO to disable checking completely.
+# Set CHECK_RELEASE to WARN to perform consistency checking but
+#   continue building even if conflicts are found.
+CHECK_RELEASE = YES
+
+# Set this when you only want to compile this application
+#   for a subset of the cross-compiled target architectures
+#   that Base is built for.
+#CROSS_COMPILER_TARGET_ARCHS = vxWorks-ppc32
+
+# To install files into a location other than $(TOP) define
+#   INSTALL_LOCATION here.
+#INSTALL_LOCATION=</absolute/path/to/install/top>
+
+# Set this when the IOC and build host use different paths
+#   to the install location. This may be needed to boot from
+#   a Microsoft FTP server say, or on some NFS configurations.
+#IOCS_APPL_TOP = </IOC's/absolute/path/to/install/top>
+
+# These allow developers to override the CONFIG_SITE variable
+# settings without having to modify the configure/CONFIG_SITE
+# file itself.
+-include $(TOP)/../CONFIG_SITE.local
+-include $(TOP)/../configure/CONFIG_SITE.local
+-include $(TOP)/configure/CONFIG_SITE.local

configure/Makefile

@@ -2,11 +2,7 @@
 
 TOP=..
 
-include $(TOP)/configure/CONFIG_APP
-
-# Set the following to NO to disable consistency checking of
-# the support applications defined in $(TOP)/configure/RELEASE
-CHECK_RELEASE = YES
+include $(TOP)/configure/CONFIG
 
 TARGETS = $(CONFIG_TARGETS)
 CONFIGS += $(subst ../,,$(wildcard $(CONFIG_INSTALLS)))

docs/businterface.html

@@ -69,7 +69,7 @@ class MyInterface : StreamBusInterface
     bool <a href="#lock">lockRequest</a>(unsigned long lockTimeout_ms);
     bool <a href="#lock">unlock</a>();
     bool <a href="#write">writeRequest</a>(const void* output, size_t size, unsigned long writeTimeout_ms);
-    bool <a href="#read">readRequest</a>(unsigned long replyTimeout_ms, unsigned long readTimeout_ms, size_t expectedLength, bool async);
+    bool <a href="#read">readRequest</a>(unsigned long replyTimeout_ms, unsigned long readTimeout_ms, ssize_t expectedLength, bool async);
     bool <a href="#read">supportsAsyncRead</a>();
     bool <a href="#event">supportsEvent</a>();
     bool <a href="#event">acceptEvent</a>(unsigned long mask, unsigned long timeout_ms);
@@ -118,7 +118,7 @@ bool <a href="#write">writeRequest</a>(const&nbsp;void*&nbsp;output,
 <div class="indent"><code>
 bool <a href="#read">readRequest</a>(unsigned&nbsp;long&nbsp;replyTimeout_ms,
     unsigned&nbsp;long&nbsp;readTimeout_ms,
-    size_t&nbsp;expectedLength, bool&nbsp;async);
+    ssize_t&nbsp;expectedLength, bool&nbsp;async);
 </code></div>
 <div class="indent"><code>
 bool <a href="#read">supportsAsyncRead</a>();
@@ -460,7 +460,7 @@ The client may request more I/O or call <code>unlock()</code> after
 <div class="indent"><code>
 bool readRequest(unsigned&nbsp;long&nbsp;replyTimeout_ms,
     unsigned&nbsp;long&nbsp;readTimeout_ms,
-    size_t&nbsp;expectedLength, bool&nbsp;async);
+    ssize_t&nbsp;expectedLength, bool&nbsp;async);
 </code></div>
 <div class="indent"><code>
 ssize_t readCallback(IoStatus&nbsp;status,

docs/formats.html

@@ -485,6 +485,12 @@ than 9.
 <p>
 This is not a normal "converter", because no user data is converted.
 Instead, a checksum is calculated from the input or output.
+<span class="new">
+Any pre-processing of input, e.g. by the <a href="#regsub">regsub</a> converter
+is ignored for the calculation of the checksum.
+</span>
+</p>
+<p>
 The <em>width</em> field is the byte number from which to start
 calculating the checksum.
 Default is 0, i.e. the first byte of the input or output of the current
@@ -589,6 +595,23 @@ In input, the next byte or bytes must match the checksum.
    href="http://www.ietf.org/rfc/rfc1950.txt">RFC 1950</a>.</dd>
  <dt><code>%&lt;hexsum8&gt;</code></dt>
   <dd>One byte. The sum of all hex digits. (Other characters are ignored.)</dd>
+ <dt><code>%&lt;lrc&gt;</code></dt>
+  <dd>One byte. The Longitudinal Redundancy Check according to <a target="ex"
+   href="https://en.wikipedia.org/wiki/Longitudinal_redundancy_check">Wikipedia</a>.</dd>
+ <dt><code>%&lt;hexlrc&gt;</code></dt>
+  <dd>One byte. The LRC for the hex digits. (Other characters are ignored.)</dd>
+ <dt><code>%&lt;leybold&gt;</code></dt>
+  <dd>One byte. Used by some Leybold products. 255-bytesum%255 (+32 if result would be <32)</dd>
+ <dt><code>%&lt;brksCryo&gt;</code></dt>
+  <dd>One byte. Used by Brooks Cryopumps.</dd>
+ <dt><code>%&lt;CPI&gt;</code></dt>
+  <dd>One byte. Used by TRIUMF CPI RF amplifier.</dd>
+ <dt><code>%&lt;bitsum&gt;</code> or <code>%&lt;bitsum8&gt;</code></dt>
+  <dd>One byte. Number of 1 bits in all characters.</dd>
+ <dt><code>%&lt;bitsum16&gt;</code></dt>
+  <dd>Two bytes. Number of 1 bits in all characters.</dd>
+ <dt><code>%&lt;bitsum32&gt;</code></dt>
+  <dd>Four bytes. Number of 1 bits in all characters.</dd>
 </dl>
 
 <a name="regex"></a>
@@ -694,10 +717,14 @@ However if an empty string is matched, searching advances by 1 character in orde
 avoid matching the same empty string again.</span>
 </p>
 <p>
-In input this converter pre-processes data received from the device before
+In input, this converter pre-processes data received from the device before
 following converters read it.
 Converters preceding this one will read unmodified input.
 Thus place this converter before those whose input should be pre-processed.
+<span class="new">
+However, <a href="#chksum">checksum</a> converters will always use the unmodified
+input as sent by the device because the modified input would not match the checksum.
+</span>
 </p>
 <p>
 In output it post-processes data already formatted by preceding converters

docs/makepdf

@@ -1,10 +1,22 @@
 #/bin/sh
-if ! wkhtmltopdf -V >/dev/null 2>&1
-then
+wkhtmltopdf --enable-local-file-access -V >/dev/null 2>&1
+case $? in
+  127)
     echo "wkhtmltopdf not installed." >&2
     echo "See https://wkhtmltopdf.org" >&2
     exit 1
-fi
+    ;;
+  0)
+    # have (and need) --enable-local-file-access
+    ENABLE_FILE_ACCESS=--enable-local-file-access
+    ;;
+  1)
+    # have no (and need no) --enable-local-file-access
+    ;;
+  *)
+    # Some error but I don't know what it means. Try anyway.
+    ;;
+esac
 
 PAGES="
 index.html
@@ -43,5 +55,5 @@ osinterface.html
 "
 
 rm -f stream.pdf
-wkhtmltopdf --print-media-type --dpi 1200 --zoom 0.85 --page-size Letter \
-$PAGES stream.pdf
+wkhtmltopdf --print-media-type --page-size Letter \
+$ENABLE_FILE_ACCESS $PAGES stream.pdf

docs/protocol.html

@@ -482,12 +482,63 @@ To make this easier, <em>protocol arguments</em> can be used:
 move { out "\$1 GOTO %d"; }
 </pre>
 <p>
-Now, the protocol can be references in the <code>OUT</code> link
+Now the same protocol can be used in the <code>OUT</code> link
 of three different records as <code>move(X)</code>,
 <code>move(Y)</code> and <code>move(Z)</code>.
-Up to 9 parameters, referenced as <code>$1</code> ... <code>$9</code>
-can be specified in parentheses, separated by comma.
-The variable <code>$0</code> is replaced by the name of the protocol.
+</p>
+<p>
+Up to 9 parameters can be specified in parentheses, separated by comma.
+In the protocol, they are referenced as <code>$1</code> ...
+<code>$9</code> outside quotes or <code>\$1</code> ... <code>\$9</code>
+within quotes. The parameter <code>$0</code> resolves to the protocol name.
+</p>
+<div class="new">
+<p>
+To make links more readable, one space is allowed before and after each comma
+and the enclosing parentheses. This space is not part of the parameter string.
+Any additional space is part of the parameter.
+</p>
+<p>
+If a parameter contains matching pairs of parentheses, these and all commas
+inside are part of the parameter.
+This allows to pass parameter strings like <code>(1,2)</code> easily without
+much escaping.
+</p>
+<p>
+Unmatched parentheses must be escaped with double backslash <code>\\</code>
+as well as must be commas outside pairs of parentheses.
+Double backslash is necessary because one backslash is already consumed by
+the db file parser.
+To pass a literal backslash in a parameter string use 4 backslashes
+<code>\\\\</code>.
+</p>
+</div>
+<p>
+Note that macros can be used in parameters. That makes it possible to
+pass part of the record name to the protocol to be used in
+<a href="formats.html#redirection">redirections</a>.
+</p>
+
+<h4>Example:</h3>
+<pre>
+record(ai, "$(PREFIX)recX5") {
+    field(DTYP, "stream")
+    field(INP,  "@$(PROTOCOLFILE) read(5, X\\,Y $(PREFIX)) $(PORT)")
+}
+record(ai, "$(PREFIX)recY5") {}
+
+read { out 0x8$1 "READ \$2"; in "%f,%(\$3recY\$1)f" }
+</pre>
+<p>
+The protocol resolves to:
+</p>
+<pre>
+read { out 0x85 "READ X,Y"; in "%f,%($(PREFIX)recY5)f" }
+</pre>
+<p>
+Here <code>$(PREFIX)</code> is replaced with its macro value.
+But be aware that the macro is actually replaced before the link is parsed so
+that macro values containing comma or parentheses may have unintended effects.
 </p>
 
 <a name="usrvar"></a>
@@ -565,7 +616,7 @@ There is a fixed set of exception handler names starting with
   
  </dd>
 </dl>
-<h3>Example:</h3>
+<h4>Example:</h3>
 <pre>
 setPosition {
     out "POS %f";

docs/setup.html

@@ -54,15 +54,17 @@ git clone https://github.com/paulscherrerinstitute/StreamDevice.git
 <p class="new">
 <em>StreamDevice</em> now comes with a standard
 <kbd>configure</kbd> directory.
-But it can still be built in an external <em>&lt;top&gt;</em>
+<del>But it can still be built in an external <em>&lt;top&gt;</em>
 directory as in previous versions.
 It will automatically detect <em>&lt;top&gt;</em> locations
 from the presence of <kbd>../configure</kbd> or <kbd>../config</kbd>
-directories.
+directories.</del> Using an upper level <kbd>../configure</kbd> is
+no longer supported due to compatibility issues with <em>SynApps</em>.
 </p>
 <p class="new">
 Edit the <kbd>configure/RELEASE</kbd> file to specify the install location
-of EPICS base and of additional software modules, for example:
+of EPICS base and of additional software modules or add a
+<kbd>configure/RELEASE.local</kbd> file to overwrite, for example:
 <pre>
 EPICS_BASE=/home/epics/base-3.16.1
 </pre>
@@ -83,7 +85,7 @@ Make sure that the <em>asyn</em> library can be found by adding the path to the
 ASYN=/home/epics/asyn4-30
 </pre>
 
-<h4>Support for <em>sCalcout</em> record</h4>
+<h4 id="scalcout">Support for <em>sCalcout</em> record</h4>
 <p>
 The <a 
 href="https://htmlpreview.github.io/?https://raw.githubusercontent.com/epics-modules/calc/R3-6-1/documentation/sCalcoutRecord.html"
@@ -107,7 +109,10 @@ modules. Release R2-8 or newer is recommended.
 </p>
 <p>
 Support for the <em>sCalcout</em> is optional. <em>StreamDevice</em> works
-as well without <em>sCalcout</em> or <em>SynApps</em>.
+as well without <em>sCalcout</em> or <em>SynApps</em>. If your application does
+not need this record support, you may load <kbd>stream-base.dbd</kbd> instead of
+<kbd>stream.dbd</kbd>, making it optional to include <em>calc</em> as an
+application dependency.
 </p>
 
 <h4>Support for regular expression matching</h4>
@@ -183,13 +188,14 @@ Regular expressions are optional. If you don't want them, you don't need this.
 Go to the <em>StreamDevice</em> directory
 and run <code>make</code> (or <code>gmake</code>).
 This will create and install the <em>stream</em> library and the
-<kbd>stream.dbd</kbd> file and an example IOC application.
+<em>StreamDevice</em> database definition files and an example IOC application.
 </p>
 
 <p>
 To use <em>StreamDevice</em>, your own application must be built with the
 <em>stream</em> and <em>asyn</em> (and optionally <em>pcre</em>) libraries
-and must load <kbd>asyn.dbd</kbd> and <kbd>stream.dbd</kbd>.
+and must load <kbd>asyn.dbd</kbd> and <kbd>stream.dbd</kbd> (or alternatively
+<kbd>stream-base.dbd</kbd>; see <a href="#scalcout">Support for sCalcout record</a>).
 </p>
 <p>
 Include the following lines in your application <kbd>Makefile</kbd>:
@@ -383,25 +389,54 @@ See the <a href="protocol.html">next chapter</a> for protocol files in depth.
 Generation of debug and error messages is controlled with two shell variables,
 <code>streamDebug</code> and <code>streamError</code>.
 Setting those variables to 1 (actually to any number but 0) enables the
-messages.
+messages. A few noisy and rarely useful debug messages are only enabled when
+setting <code>streamDebug</code> to 2.
 Per default debug messages are switched off and error messages are switched on.
 Errors occuring while loading protocol files are always shown.
 </p>
 <p>
-Warning: Enabling debug messages can create a lot of output!
-At the moment, there is no way to set filters on debug or error messages.
+Warning: Enabling debug messages this way can create a lot of output!
+Therefore, some limited debugging can be enabled per record, independent of
+the <code>streamDebug</code> variable using the <code>.TPRO</code> field of
+the record. Currently, setting <code>.TPRO</code> to 1 or 2 enables some
+basic information about the processing of a record and its i/o.
 </p>
 <p>
 Debug output can be redirected to a file with the command
 <code>streamSetLogfile("<var>filename</var>")</code>.
-When called without a filename, debug output is directed back
-to the console.
+If the file already exists, it will be overwritten, not appended to.
+While debug messages are only written to the defined log file, error messages
+are still printed to <var>stderr</var> too.
+Calling <code>streamSetLogfile</code> without a filename directs debug output
+back to <var>stderr</var> and closes the log file.
+</p>
+<p>
+By default, error messages to the console are printed in red color if
+<var>stderr</var> is a tty at startup time, using ANSI color codes. Some
+terminals may not support this properly.
+The variable <code>streamDebugColored</code> can be set to 0 or 1 to
+disable or enable colored error messages explicitly.
+Error messages written to a log file do not use colors.
+</p>
+<p>
+Error and debug messages are prefixed with a time stamp unless the variable
+<code>streamMsgTimeStamped</code> is set to 0.
+</p>
+<p>
+when a device is unresponsive, StreamDevice may produce many repeated timeout 
+messages. To reduce this, you can set <code>streamErrorDeadTime</code>
+to an integer number of seconds. In this case, repeated timeout messages 
+will not be printed during the specified dead time after the last printed
+message. The default dead time is 0, resulting in every message being printed.
 </p>
 
 <h3>Example (vxWorks):</h3>
 <pre>
 streamError=1
 streamDebug=1
+streamDebugColored=1
+streamErrorDeadTime=30
+streamMsgTimeStamped=1
 streamSetLogfile("logfile.txt")
 </pre>
 
@@ -409,6 +444,9 @@ streamSetLogfile("logfile.txt")
 <pre>
 var streamError 1
 var streamDebug 1
+var streamDebugColored 1
+var streamErrorDeadTime 30
+var streamMsgTimeStamped 1
 streamSetLogfile("logfile.txt")
 </pre>
 

docs/stream.css

@@ -1,90 +1,104 @@
-a:link    {color: #0000D0;}
-a:visited {color: #0000D0;}
-a:hover   {color: #FF0000;}
+a:link    { color: #0000D0; }
+a:visited { color: #0000D0; }
+a:hover   { color: #FF0000; }
 
 body {
-    margin-right:1em;
-    margin-left:15em;
-    margin-top:75px;
-    padding-top:1px;
+    margin-right: 1em;
+    margin-left: 15em;
+    margin-top: 75px;
+    padding-top: 1px;
     font-family: Helvetica, Arial, sans-serif;
     font-size: 100%;
-    background-color:#ffffff;
+    background-color: #ffffff;
 }
 
-a[name] { position:relative; top:-11ex;}
+a[name] {
+    position: relative;
+    top: -11ex;
+}
+
+pre, tt, kbd, code {
+    font-size: 95%;
+    font-family: Mono, "Lucida Console", Courier, monospace;
+}
 
 pre {
-    background-color:#f4f4f4;
-    padding:1ex;
-    border:1px solid #000000;
-    white-space:pre;
-    margin:2ex;
-    page-break-inside:avoid;
+    background-color: #f4f4f4;
+    padding: 1ex;
+    border: 1px solid #000000;
+    white-space: pre;
+    margin: 2ex;
+    page-break-inside: avoid;
+    font-size: 85%;
+    white-space: pre-wrap;
 }
 
 kbd {
-    font-weight:bold;
+    font-weight: bold;
+}
+
+code {
+    color: #008000;
 }
 
 dt {
-    margin-top:0.5ex;
+    margin-top: 0.5ex;
 }
 
 h1 {
-    font-size:250%;
-    margin-top:0;
-    font-style:italic;
-    font-weight:bold;
-    font-family:"Times New Roman", serif;
-    text-align:center;
-    position:fixed;
-    top:0;
-    left:0;
-    width:100%;
-    line-height:190%;
-    background-color:white;
-    border-width:0;
-    border-bottom:3px solid #1b4486;
-    white-space:nowrap;
-    background-image:url(PSI.png);
-    background-repeat:no-repeat;
-    background-position:10px 5px;
-    text-shadow:.1em .1em .1em darkgray;
-    box-shadow:0 .3em .1em -.2em darkgray;
+    font-size: 250%;
+    margin-top: 0;
+    font-style: italic;
+    font-weight: bold;
+    font-family: "Times New Roman", Times, serif;
+    text-align: center;
+    position: fixed;
+    top: 0;
+    left: 0;
+    width: 100%;
+    line-height: 190%;
+    background-color: white;
+    border-width: 0;
+    border-bottom: 3px solid #1b4486;
+    white-space: nowrap;
+    background-image: url(PSI.png);
+    background-repeat: no-repeat;
+    background-position: 10px 5px;
+    text-shadow: .1em .1em .1em lightgray;
+    box-shadow: 0 .3em .1em -.2em darkgray;
 }
 
 h2 {
-    font-size:150%;
-    margin-bottom:0.5ex;
+    font-size: 140%;
+    margin-bottom: 0.5ex;
 }
 
 h3 {
-    font-size:120%;
-    margin-bottom:0.25ex;
+    font-size: 120%;
+    margin-bottom: 0.25ex;
 }
 
 h4 {
-    font-size:100%;
-    margin-bottom:0.25ex;
+    font-size: 100%;
+    margin-bottom: 0.25ex;
 }
 
 h1, h2, h3, h4 {
-    page-break-after:avoid;
+    page-break-after: avoid;
 }
 
 p {
-    margin-top:0.75ex;
-    margin-bottom:0.75ex;
+    margin-top: 0.75ex;
+    margin-bottom: 0.75ex;
 }
 
 body h1 + p {
-    margin-top:1.5ex;
-    margin-bottom:0.75ex;
+    margin-top: 1.5ex;
+    margin-bottom: 0.75ex;
 }
 
 footer {
-    font-size:75%;
+    font-size: 75%;
     margin-top: 1em;
     border-top: 1px solid darkgray;
     padding-top: 1em;
@@ -97,44 +111,40 @@ footer a:only-of-type {
 }
 
 small {
-    font-size:75%;
-}
-
-code {
-    font-size: 125%;
-    color: #008000;
+    font-size: 75%;
 }
 
 .indent {
-    text-indent:-4ex;
-    margin-left:4ex;
-    margin-top:0.5ex;
-    text-align:left;
+    text-indent: -4ex;
+    margin-left: 4ex;
+    margin-top: 0.5ex;
+    text-align: left;
 }
 
 .box {
-    margin-left:1ex;
-    margin-right:1ex;
-    margin-top:0.5ex;
+    margin-left: 1ex;
+    margin-right: 1ex;
+    margin-top: 0.5ex;
     padding: 0 1ex;
-    border: 1px solid black;
-    text-align:left;
-    background-color:#f0f0f0;
+    border: thin solid black;
+    text-align: left;
+    background-color: #f0f0f0;
+    page-break-inside: avoid;
 }
 
 #navleft {
-    position:fixed;
-    left:0;
-    top:0;
-    padding-top:70px;
-    width:14em;
-    height:100%;
-    border-style:solid;
-    border-color:black;
-    border-width:0 1px 0 0;
-    background-color:#e3eaf6;
-    overflow:hidden;
-    z-index:0;
+    position: fixed;
+    left: 0;
+    top: 0;
+    padding-top: 70px;
+    width: 14em;
+    height: 100%;
+    border-style: solid;
+    border-color: black;
+    border-width: 0 1px 0 0;
+    background-color: #e3eaf6;
+    overflow: hidden;
+    z-index: 0;
 }
 
 .new {
@@ -142,17 +152,18 @@ code {
 }
 
 a[target=ex]:after {
-  content:" " url(ex.png);
+    content: " " url(ex.png);
 }
 
 a[target=ex]:hover:after {
-  content: " " url(exr.png);
+    content: " " url(exr.png);
 }
 
 @media print {
-  a:link    {text-decoration:none;}
-  a[target=ex]:after {content:" [" attr(href) "]";}
-  body      {margin:0 4em;}
-  h1        {position:relative; background-position:0 0;}
-  #navleft  {display:none;}
+    a:link    { text-decoration: none; }
+    a[target=ex]:after { content:" [" attr(href) "]"; font-size: 75%; }
+    body      { margin: 0 4em; }
+    h1        { position: relative; background-position: 0 0; }
+    #navleft  { display: none; }
+    footer    { display: none; }
 }

docs/tipsandtricks.html

@@ -293,9 +293,10 @@ record (stringout, "$(DEVICE):clean_2") {<br>
 <a name="web"></a>
 <h2>I need to read a web page</h2>
 <p>
-First you have to send a correctly formatted HTML request.
-Note that this request must contain the full URL like
-"http://server/page" and must be terminated with <u>two</u> newlines.
+First you have to send a correctly formatted HTML header for a GET request.
+Note that this header must contain the full URL like
+"http://server/page" and must be terminated with <u>two</u>
+CR LF sequences (<code>"\r\n\r\n"</code> or <code>CR LF CR LF</code>).
 The server should be the same as in the
 <a href="setup.html#sta"><code>drvAsynIPPortConfigure</code></a>
 command (if not using a http proxy).
@@ -313,17 +314,18 @@ Read the title of a web page.
 get_title {<br>
 &nbsp;&nbsp;extrainput = ignore;<br>
 &nbsp;&nbsp;replyTimeout = 1000;<br>
-&nbsp;&nbsp;out "GET http://\$1\n\n";<br>
+&nbsp;&nbsp;out "GET http://\$1\r\n\r\n";<br>
 &nbsp;&nbsp;in "%+.1/(?im)&lt;title&gt(.*)&lt\/title&gt;/";<br>
 }
 </code>
 </p>
 <p>
-Terminate the request with two newlines, either explicit like here
-<u>or</u> using an 
+Terminate the request with two carriage return + newlines, either explicit
+like here <u>or</u> using an 
 <a href="protocol.html#sysvar"><code>outTerminator</code></a>.
 The URI (without http:// but including the web server host name)
-is passed as <a href="protocol.html#argvar">argument</a> 1 to <code>\$1</code>.
+is passed as <a href="protocol.html#argvar">argument</a> 1 to <code>\$1</code>
+in this example.
 Note that web servers may be slow, so allow some
 <a href="protocol.html#argvar"><code>replyTimeout</code></a>.
 </p>
@@ -390,7 +392,7 @@ Then we read the number.
 get_title {<br>
 &nbsp;&nbsp;extrainput = ignore;<br>
 &nbsp;&nbsp;replyTimeout = 1000;<br>
-&nbsp;&nbsp;out "GET http://\$1\n\n";<br>
+&nbsp;&nbsp;out "GET http://\$1\r\n\r\n";<br>
 &nbsp;&nbsp;in "%*/Interesting value:/%f more text";<br>
 }
 </code>

src/AsynDriverInterface.cc

@@ -1,33 +1,24 @@
-/***************************************************************
-* StreamDevice Support                                         *
-*                                                              *
-* (C) 2005 Dirk Zimoch (dirk.zimoch@psi.ch)                    *
-*                                                              *
-* This is the interface to asyn driver for StreamDevice.       *
-* Please refer to the HTML files in ../docs/ for a detailed    *
-* documentation.                                               *
-*                                                              *
-* If you do any changes in this file, you are not allowed to   *
-* redistribute it any more. If there is a bug or a missing     *
-* feature, send me an email and/or your patch. If I accept     *
-* your changes, they will go to the next release.              *
-*                                                              *
-* DISCLAIMER: If this software breaks something or harms       *
-* someone, it's your problem.                                  *
-*                                                              *
-***************************************************************/
-
-#include "StreamBusInterface.h"
-#include "StreamError.h"
-#include "StreamBuffer.h"
-
-#include "asynDriver.h"
-#include "asynOctet.h"
-#include "asynInt32.h"
-#include "asynUInt32Digital.h"
-#include "asynGpibDriver.h"
-
-#include "devStream.h"
+/*************************************************************************
+* This is the interface to asyn driver for StreamDevice.
+* Please see ../docs/ for detailed documentation.
+*
+* (C) 2005 Dirk Zimoch (dirk.zimoch@psi.ch)
+*
+* This file is part of StreamDevice.
+*
+* StreamDevice is free software: You can redistribute it and/or modify
+* it under the terms of the GNU Lesser General Public License as published
+* by the Free Software Foundation, either version 3 of the License, or
+* (at your option) any later version.
+*
+* StreamDevice is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+* GNU Lesser General Public License for more details.
+*
+* You should have received a copy of the GNU Lesser General Public License
+* along with StreamDevice. If not, see https://www.gnu.org/licenses/.
+*************************************************************************/
 
 #ifdef EPICS_3_13
 #include <assert.h>
@@ -43,6 +34,16 @@ extern "C" {
 #include "iocsh.h"
 #endif
 
+#include "asynDriver.h"
+#include "asynOctet.h"
+#include "asynInt32.h"
+#include "asynUInt32Digital.h"
+#include "asynGpibDriver.h"
+
+#include "StreamBusInterface.h"
+#include "StreamError.h"
+#include "StreamBuffer.h"
+#include "devStream.h"
 #include "MacroMagic.h"
 
 #define Z PRINTF_SIZE_T_PREFIX
@@ -162,7 +163,7 @@ class AsynDriverInterface : StreamBusInterface
     double writeTimeout;
     double readTimeout;
     double replyTimeout;
-    size_t expectedLength;
+    ssize_t expectedLength;
     unsigned long eventMask;
     unsigned long receivedEvent;
     StreamBuffer inputBuffer;
@@ -187,7 +188,7 @@ class AsynDriverInterface : StreamBusInterface
     bool writeRequest(const void* output, size_t size,
         unsigned long writeTimeout_ms);
     bool readRequest(unsigned long replyTimeout_ms,
-        unsigned long readTimeout_ms, size_t expectedLength, bool async);
+        unsigned long readTimeout_ms, ssize_t expectedLength, bool async);
     bool acceptEvent(unsigned long mask, unsigned long replytimeout_ms);
     bool supportsEvent();
     bool supportsAsyncRead();
@@ -800,7 +801,7 @@ writeHandler()
 // interface function: we want to read something
 bool AsynDriverInterface::
 readRequest(unsigned long replyTimeout_ms, unsigned long readTimeout_ms,
-    size_t _expectedLength, bool async)
+    ssize_t _expectedLength, bool async)
 {
     debug("AsynDriverInterface::readRequest(%s, %ld msec reply, "
         "%ld msec read, expect %" Z "u bytes, async=%s)\n",
@@ -884,14 +885,11 @@ readHandler()
             if (pasynOctet->setInputEos(pvtOctet, pasynUser,
                 deveos, (int)deveoslen) == asynSuccess)
             {
-                if (ioAction != AsyncRead)
-                {
-                    debug("AsynDriverInterface::readHandler(%s) "
-                        "input EOS changed from \"%s\" to \"%s\"\n",
-                        clientName(),
-                        StreamBuffer(oldeos, oldeoslen).expand()(),
-                        StreamBuffer(deveos, deveoslen).expand()());
-                }
+                debug2("AsynDriverInterface::readHandler(%s) "
+                    "input EOS changed from \"%s\" to \"%s\"\n",
+                    clientName(),
+                    StreamBuffer(oldeos, oldeoslen).expand()(),
+                    StreamBuffer(deveos, deveoslen).expand()());
                 break;
             }
             deveos++; deveoslen--;
@@ -945,20 +943,18 @@ readHandler()
         eomReason = 0;
         pasynUser->errorMessage[0] = 0;
 
-        debug("AsynDriverInterface::readHandler(%s): ioAction=%s "
-            "read(..., bytesToRead=%" Z "u, ...) "
-            "[timeout=%g sec]\n",
-            clientName(), toStr(ioAction),
-            bytesToRead, pasynUser->timeout);
         status = pasynOctet->read(pvtOctet, pasynUser,
             buffer, bytesToRead, &received, &eomReason);
-        // Even though received is size_t I have seen (size_t)-1 here!
-        debug("AsynDriverInterface::readHandler(%s): "
-            "read returned %s: ioAction=%s received=%" Z "d, "
-            "eomReason=%s, buffer=\"%s\"\n",
-            clientName(), toStr(status), toStr(ioAction),
-            received, eomReasonToStr(eomReason),
-            StreamBuffer(buffer, received).expand()());
+        // Even though received is size_t I have seen (size_t)-1 here
+        // in case half a terminator had been read last time!
+        if (!(status == asynTimeout && pasynUser->timeout == 0 && received == 0))
+            debug("AsynDriverInterface::readHandler(%s): ioAction=%s "
+                "read(%" Z "u bytes, timeout=%g sec) returned status %s: received=%" Z "d bytes, "
+                "eomReason=%s, buffer=\"%s\"\n",
+                clientName(), toStr(ioAction),
+                bytesToRead, pasynUser->timeout, toStr(status), received,
+                eomReasonToStr(eomReason), StreamBuffer(buffer, received).expand()());
+
         // asyn 4.16 sets reason to ASYN_EOM_END when device disconnects.
         // What about earlier versions?
         if (!connected) eomReason |= ASYN_EOM_END;
@@ -1034,7 +1030,7 @@ readHandler()
                     // reply timeout
                     if (ioAction == AsyncRead)
                     {
-                        debug("AsynDriverInterface::readHandler(%s): "
+                        debug2("AsynDriverInterface::readHandler(%s): "
                             "no async input, retry in in %g seconds\n",
                             clientName(), replyTimeout);
                         // start next poll after timer expires
@@ -1137,9 +1133,10 @@ readHandler()
     {
         pasynOctet->setInputEos(pvtOctet, pasynUser,
             oldeos, oldeoslen);
-        debug("AsynDriverInterface::readHandler(%s) "
-            "input EOS restored to \"%s\"\n",
+        debug2("AsynDriverInterface::readHandler(%s) "
+            "input EOS restored from \"%s\" to \"%s\"\n",
             clientName(),
+            StreamBuffer(deveos, deveoslen).expand()(),
             StreamBuffer(oldeos, oldeoslen).expand()());
     }
 }
@@ -1357,8 +1354,6 @@ timerExpired()
             // at the moment if another asynUser got input right now.
             // queueRequest might fail if another request was just queued
             pasynManager->isAutoConnect(pasynUser, &autoconnect);
-            debug("%s: polling for I/O Intr: autoconnected: %d, connect: %d\n",
-                clientName(), autoconnect, connected);
             if (autoconnect && !connected)
             {
                 // has explicitely been disconnected
@@ -1372,7 +1367,7 @@ timerExpired()
                 asynStatus status = pasynManager->queueRequest(pasynUser,
                     asynQueuePriorityLow, -1.0);
                 // if this fails, we are already queued by another thread
-                debug("AsynDriverInterface::timerExpired %s: "
+                debug2("AsynDriverInterface::timerExpired %s: "
                     "queueRequest(..., priority=Low, queueTimeout=-1) = %s %s\n",
                     clientName(), toStr(status),
                     status!=asynSuccess ? pasynUser->errorMessage : "");
@@ -1490,7 +1485,7 @@ void AsynDriverInterface::
 handleRequest()
 {
     cancelTimer();
-    debug("AsynDriverInterface::handleRequest(%s) %s\n",
+    debug2("AsynDriverInterface::handleRequest(%s) %s\n",
         clientName(), toStr(ioAction));
     switch (ioAction)
     {

src/BCDConverter.cc

@@ -1,22 +1,24 @@
-/***************************************************************
-* StreamDevice Support                                         *
-*                                                              *
-* (C) 1999 Dirk Zimoch (zimoch@delta.uni-dortmund.de)          *
-* (C) 2005 Dirk Zimoch (dirk.zimoch@psi.ch)                    *
-*                                                              *
-* This is the BCD format converter of StreamDevice.            *
-* Please refer to the HTML files in ../docs/ for a detailed    *
-* documentation.                                               *
-*                                                              *
-* If you do any changes in this file, you are not allowed to   *
-* redistribute it any more. If there is a bug or a missing     *
-* feature, send me an email and/or your patch. If I accept     *
-* your changes, they will go to the next release.              *
-*                                                              *
-* DISCLAIMER: If this software breaks something or harms       *
-* someone, it's your problem.                                  *
-*                                                              *
-***************************************************************/
+/*************************************************************************
+* This is the BCD format converter of StreamDevice.
+* Please see ../docs/ for detailed documentation.
+*
+* (C) 1999,2005 Dirk Zimoch (dirk.zimoch@psi.ch)
+*
+* This file is part of StreamDevice.
+*
+* StreamDevice is free software: You can redistribute it and/or modify
+* it under the terms of the GNU Lesser General Public License as published
+* by the Free Software Foundation, either version 3 of the License, or
+* (at your option) any later version.
+*
+* StreamDevice is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+* GNU Lesser General Public License for more details.
+*
+* You should have received a copy of the GNU Lesser General Public License
+* along with StreamDevice. If not, see https://www.gnu.org/licenses/.
+*************************************************************************/
 
 #include "StreamFormatConverter.h"
 #include "StreamError.h"

src/BinaryConverter.cc

@@ -1,25 +1,28 @@
-/***************************************************************
-* StreamDevice Support                                         *
-*                                                              *
-* (C) 1999 Dirk Zimoch (zimoch@delta.uni-dortmund.de)          *
-* (C) 2005 Dirk Zimoch (dirk.zimoch@psi.ch)                    *
-*                                                              *
-* This is the binary format converter of StreamDevice.         *
-* Please refer to the HTML files in ../docs/ for a detailed    *
-* documentation.                                               *
-*                                                              *
-* If you do any changes in this file, you are not allowed to   *
-* redistribute it any more. If there is a bug or a missing     *
-* feature, send me an email and/or your patch. If I accept     *
-* your changes, they will go to the next release.              *
-*                                                              *
-* DISCLAIMER: If this software breaks something or harms       *
-* someone, it's your problem.                                  *
-*                                                              *
-***************************************************************/
+/*************************************************************************
+* This is the binary format converter of StreamDevice.
+* Please see ../docs/ for detailed documentation.
+*
+* (C) 1999,2005 Dirk Zimoch (dirk.zimoch@psi.ch)
+*
+* This file is part of StreamDevice.
+*
+* StreamDevice is free software: You can redistribute it and/or modify
+* it under the terms of the GNU Lesser General Public License as published
+* by the Free Software Foundation, either version 3 of the License, or
+* (at your option) any later version.
+*
+* StreamDevice is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+* GNU Lesser General Public License for more details.
+*
+* You should have received a copy of the GNU Lesser General Public License
+* along with StreamDevice. If not, see https://www.gnu.org/licenses/.
+*************************************************************************/
 
 #include <ctype.h>
 #include <limits.h>
+
 #include "StreamFormatConverter.h"
 #include "StreamError.h"
 

src/CONFIG_STREAM

@@ -1,3 +1,24 @@
+##########################################################################
+# This is the build configuration file of StreamDevice.
+#
+# (C) 2007,2018 Dirk Zimoch (dirk.zimoch@psi.ch)
+#
+# This file is part of StreamDevice.
+#
+# StreamDevice is free software: You can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# StreamDevice is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with StreamDevice. If not, see https://www.gnu.org/licenses/.
+#########################################################################/
+
 # You may add more record interfaces
 # This requires the naming conventions
 # dev$(RECORDTYPE)Stream.c

src/ChecksumConverter.cc

@@ -1,61 +1,82 @@
-/***************************************************************
-* StreamDevice Support                                         *
-*                                                              *
-* (C) 1999 Dirk Zimoch (zimoch@delta.uni-dortmund.de)          *
-* (C) 2006-2018 Dirk Zimoch (dirk.zimoch@psi.ch)               *
-*                                                              *
-* This is the checksum pseudo-converter of StreamDevice.       *
-* Please refer to the HTML files in ../docs/ for a detailed    *
-* documentation.                                               *
-*                                                              *
-* If you do any changes in this file, you are not allowed to   *
-* redistribute it any more. If there is a bug or a missing     *
-* feature, send me an email and/or your patch. If I accept     *
-* your changes, they will go to the next release.              *
-*                                                              *
-* DISCLAIMER: If this software breaks something or harms       *
-* someone, it's your problem.                                  *
-*                                                              *
-***************************************************************/
+/*************************************************************************
+* This is the checksum pseudo-converter of StreamDevice.
+* Please see ../docs/ for detailed documentation.
+*
+* (C) 1999,2006,2018 Dirk Zimoch (dirk.zimoch@psi.ch)
+*
+* This file is part of StreamDevice.
+*
+* StreamDevice is free software: You can redistribute it and/or modify
+* it under the terms of the GNU Lesser General Public License as published
+* by the Free Software Foundation, either version 3 of the License, or
+* (at your option) any later version.
+*
+* StreamDevice is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+* GNU Lesser General Public License for more details.
+*
+* You should have received a copy of the GNU Lesser General Public License
+* along with StreamDevice. If not, see https://www.gnu.org/licenses/.
+*************************************************************************/
+
+#ifdef vxWorks
+  #include <version.h>
+  /* VxWorks has strncasecmp since version 6
+     but availability depends on configuration.
+     We cannot know.
+  */
+  #define NEED_strncasecmp
+  /* VxWorks does not have inttypes.h and uint32_t differs between versions */
+  #if defined(_WRS_VXWORKS_MAJOR) && (_WRS_VXWORKS_MAJOR > 6 || (_WRS_VXWORKS_MAJOR == 6 && _WRS_VXWORKS_MINOR >= 9))
+    #define PRIX32 "X"
+    #define PRIu32 "u"
+  #else
+    #define PRIX32 "lX"
+    #define PRIu32 "lu"
+  #endif
+  #define PRIX8  "X"
+#elif defined(_MSC_VER) && _MSC_VER < 1700
+  /* Visual Studio 2010 does not have inttypes.h */
+  #define PRIX32 "X"
+  #define PRIu32 "u"
+  #define PRIX8  "X"
+#else
+  #define __STDC_FORMAT_MACROS
+  #include <inttypes.h>
+#endif
+
+#include <ctype.h>
+#include <stdlib.h>
+
+#if defined(__rtems__)
+  #include <rtems.h>
+  #if __RTEMS_MAJOR__ < 5
+    /* RTEMS has strncasecmp since version 5 */
+    #define NEED_strncasecmp
+  #endif
+#endif
+
+#ifdef _MSC_VER
+  /* Windows strncasecmp has a different name. */
+  #define strncasecmp _strnicmp
+#endif
+
+#ifdef NEED_strncasecmp
+// Have no strncasecmp but avoid compiler errors in case it exists in future versions
+extern "C" {
+    static int mystrncasecmp(const char *s1, const char *s2, size_t n)
+    {
+        int r=0;
+        while (n && (r = toupper(*s1)-toupper(*s2)) == 0) { n--; s1++; s2++; };
+        return r;
+    }
+}
+#define strncasecmp mystrncasecmp
+#endif
 
 #include "StreamFormatConverter.h"
 #include "StreamError.h"
-#include <ctype.h>
-#if defined(__vxworks) || defined(vxWorks)
-#define PRIX32 "lX"
-#define PRIu32 "lu"
-#define PRIX8  "X"
-#define SCNx8  "hhx"
-#define uint_fast8_t uint8_t
-#define int_fast8_t int8_t
-#elif defined(_MSC_VER) && _MSC_VER < 1700 /* Visual Studio 2010 does not have inttypes.h */
-#include <stdint.h>
-#define PRIX32 "X"
-#define PRIu32 "u"
-#define PRIX8  "X"
-#define SCNx8  "hhx"
-#else
-#define __STDC_FORMAT_MACROS
-#include <stdint.h>
-#include <inttypes.h>
-#endif
-
-#if defined(__vxworks) || defined(vxWorks) || defined(_WIN32) || defined(__rtems__)
-// These systems have no strncasecmp
-#include "epicsVersion.h"
-#ifdef BASE_VERSION
-// 3.13
-static int strncasecmp(const char *s1, const char *s2, size_t n)
-{
-    int r=0;
-    while (n && (r = toupper(*s1)-toupper(*s2)) == 0) { n--; s1++; s2++; };
-    return r;
-}
-#else
-#include "epicsString.h"
-#define strncasecmp epicsStrnCaseCmp
-#endif
-#endif
 
 typedef uint32_t (*checksumFunc)(const uint8_t* data, size_t len,  uint32_t init);
 
@@ -82,6 +103,33 @@ static uint32_t xor7(const uint8_t* data, size_t len, uint32_t sum)
     return xor8(data, len, sum) & 0x7F;
 }
 
+static uint32_t bitsum(const uint8_t* data, size_t len, uint32_t sum)
+{
+    // number of set bits in each byte
+    const uint8_t table[256] = {
+        0,1,1,2,1,2,2,3,1,2,2,3,2,3,3,4,
+        1,2,2,3,2,3,3,4,2,3,3,4,3,4,4,5,
+        1,2,2,3,2,3,3,4,2,3,3,4,3,4,4,5,
+        2,3,3,4,3,4,4,5,3,4,4,5,4,5,5,6,
+        1,2,2,3,2,3,3,4,2,3,3,4,3,4,4,5,
+        2,3,3,4,3,4,4,5,3,4,4,5,4,5,5,6,
+        2,3,3,4,3,4,4,5,3,4,4,5,4,5,5,6,
+        3,4,4,5,4,5,5,6,4,5,5,6,5,6,6,7,
+        1,2,2,3,2,3,3,4,2,3,3,4,3,4,4,5,
+        2,3,3,4,3,4,4,5,3,4,4,5,4,5,5,6,
+        2,3,3,4,3,4,4,5,3,4,4,5,4,5,5,6,
+        3,4,4,5,4,5,5,6,4,5,5,6,5,6,6,7,
+        2,3,3,4,3,4,4,5,3,4,4,5,4,5,5,6,
+        3,4,4,5,4,5,5,6,4,5,5,6,5,6,6,7,
+        3,4,4,5,4,5,5,6,4,5,5,6,5,6,6,7,
+        4,5,5,6,5,6,6,7,5,6,6,7,6,7,7,8};
+    while (len--)
+    {
+        sum += table[*data++];
+    }
+    return sum;
+}
+
 static uint32_t crc_0x07(const uint8_t* data, size_t len, uint32_t crc)
 {
     // x^8 + x^2 + x^1 + x^0 (0x07)
@@ -500,10 +548,84 @@ static uint32_t leybold(const uint8_t* data, size_t len, uint32_t sum)
         sum += *data++;
     }
     sum = ~sum;
+    sum &= 0xff;
     if (sum < 32) sum+=32;
     return sum;
 }
 
+// Checksum used by Brooks Cryopumps
+static uint32_t brksCryo(const uint8_t* data, size_t len, uint32_t sum)
+{
+    uint32_t xsum;
+    while (len--)  {
+        sum += (*data++) & 0x7F;
+    }
+    xsum = (((sum >> 6) ^ sum) & 0x3F) + 0x30;
+    return xsum;
+}
+
+// Longitudinal Redundancy Check
+static uint32_t lrc(const uint8_t* data, size_t len, uint32_t sum)
+{
+    while (len--) {
+        sum = (sum + (*data++)) & 0xFF;
+    }
+
+    sum = ((sum ^ 0xFF) + 1) & 0xFF;
+
+    return sum;
+}
+
+// Longitudinal Redundancy Check using ASCII representation of numbers, 2-by-2
+static uint32_t hexlrc(const uint8_t* data, size_t len, uint32_t sum)
+{
+    uint32_t d;
+    uint32_t final_digit = 0;
+
+    while (len--)
+    {
+        d = toupper(*data++);
+
+        // Convert all hex digits, ignore all other bytes
+        if (isxdigit(d))
+        {
+            // Convert digits from ASCII to number
+            if (isdigit(d)) {
+                d -= '0';
+            }
+            else {
+                d -= 'A' - 0x0A;
+            }
+
+            // For the most significant bits, shift 4 bits
+            if (len % 2) {
+                final_digit = d << 4;
+            // Least significant bits are summed to previous converted digit
+            } else {
+                d += final_digit;
+                final_digit = 0;
+                // Apply lrc rule
+                sum = (sum + d) & 0xFF;
+            }
+        }
+    }
+
+    // Apply lrc rule
+    sum = ((sum ^ 0xFF) + 1) & 0xFF;
+
+    return sum;
+}
+
+// Checksum used by Spellman High Voltage Supplies MPS
+static uint32_t hv_mps(const uint8_t* data, size_t len, uint32_t sum)
+{
+    while (len--)
+    {
+        sum += *data++;
+    }
+    return (~sum & 0x7F) | 0x40;
+}
+
 struct checksum
 {
     const char* name;
@@ -521,8 +643,13 @@ static checksum checksumMap[] =
     {"sum8",    sum,              0x00,       0x00,       1}, // 0xDD
     {"sum16",   sum,              0x0000,     0x0000,     2}, // 0x01DD
     {"sum32",   sum,              0x00000000, 0x00000000, 4}, // 0x000001DD
+    {"nsum8",   sum,              0xFF,       0xFF,       1}, // 0x23
+    {"nsum16",  sum,              0xFFFF,     0xFFFF,     2}, // 0xFE23
+    {"nsum32",  sum,              0xFFFFFFFF, 0xFFFFFFFF, 4}, // 0xFFFFFE23
+    {"notsum",  sum,              0x00,       0xFF,       1}, // 0x22
     {"xor",     xor8,             0x00,       0x00,       1}, // 0x31
     {"xor8",    xor8,             0x00,       0x00,       1}, // 0x31
+    {"xor8ff",  xor8,             0x00,       0xFF,       1}, // 0xCE
     {"xor7",    xor7,             0x00,       0x00,       1}, // 0x31
     {"crc8",    crc_0x07,         0x00,       0x00,       1}, // 0xF4
     {"ccitt8",  crc_0x31,         0x00,       0x00,       1}, // 0xA1
@@ -541,19 +668,27 @@ static checksum checksumMap[] =
     {"hexsum8", hexsum,           0x00,       0x00,       1}, // 0x2D
     {"cpi",     CPI,              0x00,       0x00,       1}, // 0x7E
     {"leybold", leybold,          0x00,       0x00,       1}, // 0x22
+    {"brksCryo",brksCryo,         0x00,       0x00,       1}, // 0x4A
+    {"lrc",     lrc,              0x00,       0x00,       1}, // 0x23 
+    {"hexlrc",  hexlrc,           0x00,       0x00,       1}, // 0xA7
+    {"bitsum",  bitsum,           0x00,       0x00,       1}, // 0x21
+    {"bitsum8", bitsum,           0x00,       0x00,       1}, // 0x21
+    {"bitsum16",bitsum,           0x0000,     0x0000,     2}, // 0x0021
+    {"bitsum32",bitsum,           0x00000000, 0x00000000, 4}, // 0x00000021
+    {"hv_mps",  hv_mps,           0xFF,       0x00,       1}  // 0x63
 };
 
 static uint32_t mask[5] = {0, 0xFF, 0xFFFF, 0xFFFFFF, 0xFFFFFFFF};
 
 class ChecksumConverter : public StreamFormatConverter
 {
-    int parse (const StreamFormat&, StreamBuffer&, const char*&, bool);
+    int parse (const StreamFormat&, StreamBuffer&, const char*&, bool scanFormat);
     bool printPseudo(const StreamFormat&, StreamBuffer&);
     ssize_t scanPseudo(const StreamFormat&, StreamBuffer&, size_t& cursor);
 };
 
 int ChecksumConverter::
-parse(const StreamFormat&, StreamBuffer& info, const char*& source, bool)
+parse(const StreamFormat&, StreamBuffer& info, const char*& source, bool scanFormat)
 {
     const char* p = strchr(source, '>');
     if (!p)
@@ -607,7 +742,7 @@ parse(const StreamFormat&, StreamBuffer& info, const char*& source, bool)
             info.append(&xorout, sizeof(xorout));
             info.append(fnum);
             source = p+1;
-            return pseudo_format;
+            return scanFormat ? needs_original_format : pseudo_format;
         }
     }
 
@@ -622,11 +757,16 @@ printPseudo(const StreamFormat& format, StreamBuffer& output)
     const char* info = format.info;
     uint32_t init = extract<uint32_t>(info);
     uint32_t xorout = extract<uint32_t>(info);
-    uint_fast8_t fnum = extract<uint8_t>(info);
+    uint8_t fnum = extract<uint8_t>(info);
 
     size_t start = format.width;
-    size_t length = output.length()-format.width;
-    if (format.prec > 0) length -= format.prec;
+    size_t length = output.length();
+    if (length >= start) length -= start;
+    else length = 0;
+    if (format.prec > 0) {
+        if (length >= (size_t)format.prec) length -= format.prec;
+        else length = 0;
+    }
 
     debug("ChecksumConverter %s: output to check: \"%s\"\n",
         checksumMap[fnum].name, output.expand(start,length)());
@@ -638,8 +778,8 @@ printPseudo(const StreamFormat& format, StreamBuffer& output)
     debug("ChecksumConverter %s: output checksum is 0x%" PRIX32 "\n",
         checksumMap[fnum].name, sum);
 
-    uint_fast8_t i;
-    uint_fast8_t outchar;
+    uint8_t i;
+    uint8_t outchar;
 
     if (format.flags & sign_flag) // decimal
     {
@@ -698,24 +838,29 @@ scanPseudo(const StreamFormat& format, StreamBuffer& input, size_t& cursor)
     uint32_t init = extract<uint32_t>(info);
     uint32_t xorout = extract<uint32_t>(info);
     size_t start = format.width;
-    uint_fast8_t fnum = extract<uint8_t>(info);
-    size_t length = cursor-format.width;
+    uint8_t fnum = extract<uint8_t>(info);
+    size_t length = cursor;
+    if (length >= start) length -= start;
+    else length = 0;
+    if (format.prec > 0) {
+        if (length >= (size_t)format.prec) length -= format.prec;
+        else length = 0;
+    }
 
-    if (format.prec > 0) length -= format.prec;
-
-    debug("ChecksumConverter %s: input to check: \"%s\n",
+    debug("ChecksumConverter %s: input to check: \"%s\"\n",
         checksumMap[fnum].name, input.expand(start,length)());
 
-    uint_fast8_t expectedLength =
+    uint8_t nDigits =
         // get number of decimal digits from number of bytes: ceil(bytes*2.5)
         format.flags & sign_flag ? (checksumMap[fnum].bytes + 1) * 25 / 10 - 2 :
         format.flags & (zero_flag|left_flag) ? 2 * checksumMap[fnum].bytes :
         checksumMap[fnum].bytes;
+    ssize_t expectedLength = nDigits;
 
-    if (input.length() - cursor < expectedLength)
+    if ((ssize_t)( input.length() - cursor ) < expectedLength)
     {
-        debug("ChecksumConverter %s: Input '%s' too short for checksum\n",
-            checksumMap[fnum].name, input.expand(cursor)());
+        debug("ChecksumConverter %s: Input '%s' too short (%zu-%zu<%zu) for checksum\n",
+            checksumMap[fnum].name, input.expand(cursor)(), input.length(), cursor, expectedLength);
         return -1;
     }
 
@@ -726,12 +871,12 @@ scanPseudo(const StreamFormat& format, StreamBuffer& input, size_t& cursor)
     debug("ChecksumConverter %s: input checksum is 0x%0*" PRIX32 "\n",
         checksumMap[fnum].name, 2*checksumMap[fnum].bytes, sum);
 
-    uint_fast8_t inchar;
+    unsigned int inchar;
 
     if (format.flags & sign_flag) // decimal
     {
         uint32_t sumin = 0;
-        size_t i;
+        ssize_t i;
         for (i = 0; i < expectedLength; i++)
         {
             inchar = input[cursor+i];
@@ -748,12 +893,12 @@ scanPseudo(const StreamFormat& format, StreamBuffer& input, size_t& cursor)
     else
     if (format.flags & alt_flag) // lsb first (little endian)
     {
-        uint_fast8_t i;
+        uint8_t i;
         for (i = 0; i < checksumMap[fnum].bytes; i++)
         {
             if (format.flags & zero_flag) // ASCII
             {
-                if (sscanf(input(cursor+2*i), "%2" SCNx8, &inchar) != 1)
+                if (sscanf(input(cursor+2*i), "%2x", &inchar) != 1)
                 {
                     debug("ChecksumConverter %s: Input byte '%s' is not a hex byte\n",
                         checksumMap[fnum].name, input.expand(cursor+2*i,2)());
@@ -791,13 +936,13 @@ scanPseudo(const StreamFormat& format, StreamBuffer& input, size_t& cursor)
     }
     else // msb first (big endian)
     {
-        int_fast8_t i;
-        uint_fast8_t j;
+        int8_t i;
+        uint8_t j;
         for (i = checksumMap[fnum].bytes-1, j = 0; i >= 0; i--, j++)
         {
             if (format.flags & zero_flag) // ASCII
             {
-                sscanf(input(cursor+2*i), "%2" SCNx8, &inchar);
+                sscanf(input(cursor+2*i), "%2x", &inchar);
             }
             else
             if (format.flags & left_flag) // poor man's hex: 0x30 - 0x3F

src/DebugInterface.cc

@@ -1,21 +1,24 @@
-/***************************************************************
-* StreamDevice Support                                         *
-*                                                              *
-* (C) 2005 Dirk Zimoch (dirk.zimoch@psi.ch)                    *
-*                                                              *
-* This is the interface to a debug and example bus drivers for *
-* StreamDevice. Please refer to the HTML files in ../doc/ for  *
-* a detailed documentation.                                    *
-*                                                              *
-* If you do any changes in this file, you are not allowed to   *
-* redistribute it any more. If there is a bug or a missing     *
-* feature, send me an email and/or your patch. If I accept     *
-* your changes, they will go to the next release.              *
-*                                                              *
-* DISCLAIMER: If this software breaks something or harms       *
-* someone, it's your problem.                                  *
-*                                                              *
-***************************************************************/
+/*************************************************************************
+* This is a debug and example bus interface for StreamDevice.
+* Please see ../docs/ for detailed documentation.
+*
+* (C) 2005 Dirk Zimoch (dirk.zimoch@psi.ch)
+*
+* This file is part of StreamDevice.
+*
+* StreamDevice is free software: You can redistribute it and/or modify
+* it under the terms of the GNU Lesser General Public License as published
+* by the Free Software Foundation, either version 3 of the License, or
+* (at your option) any later version.
+*
+* StreamDevice is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+* GNU Lesser General Public License for more details.
+*
+* You should have received a copy of the GNU Lesser General Public License
+* along with StreamDevice. If not, see https://www.gnu.org/licenses/.
+*************************************************************************/
 
 #include "StreamBusInterface.h"
 #include "StreamError.h"
@@ -37,7 +40,7 @@ class DebugInterface : StreamBusInterface
     bool writeRequest(const void* output, size_t size,
         unsigned long writeTimeout_ms);
     bool readRequest(unsigned long replyTimeout_ms,
-        unsigned long readTimeout_ms, size_t expectedLength, bool async);
+        unsigned long readTimeout_ms, ssize_t expectedLength, bool async);
 
 protected:
     ~DebugInterface();
@@ -169,9 +172,9 @@ writeRequest(const void* output, size_t size, unsigned long writeTimeout_ms)
 // Return false if the read request cannot be accepted.
 bool DebugInterface::
 readRequest(unsigned long replyTimeout_ms, unsigned long readTimeout_ms,
-    size_t expectedLength, bool async)
+    ssize_t expectedLength, bool async)
 {
-    debug("DebugInterface::readRequest(%s, %ld msec reply, %ld msec read, expect %" Z "u bytes, asyn=%s)\n",
+    debug("DebugInterface::readRequest(%s, %ld msec reply, %ld msec read, expect %" Z "d bytes, asyn=%s)\n",
         clientName(), replyTimeout_ms, readTimeout_ms, expectedLength, async?"yes":"no");
 
     // Debug interface does not support async mode.

src/DummyInterface.cc

@@ -1,20 +1,25 @@
-/***************************************************************
-* StreamDevice Support                                         *
-*                                                              *
-* (C) 2011 Dirk Zimoch (dirk.zimoch@psi.ch)                    *
-*                                                              *
-* This is the interface to a "dummy" bus driver for            *
-* StreamDevice. It does not provide any I/O functionality.     *
-*                                                              *
-* If you do any changes in this file, you are not allowed to   *
-* redistribute it any more. If there is a bug or a missing     *
-* feature, send me an email and/or your patch. If I accept     *
-* your changes, they will go to the next release.              *
-*                                                              *
-* DISCLAIMER: If this software breaks something or harms       *
-* someone, it's your problem.                                  *
-*                                                              *
-***************************************************************/
+/*************************************************************************
+* This is a debug and example bus interface for StreamDevice.
+* It does not provide any I/O functionality.
+* Please see ../docs/ for detailed documentation.
+*
+* (C) 2005 Dirk Zimoch (dirk.zimoch@psi.ch)
+*
+* This file is part of StreamDevice.
+*
+* StreamDevice is free software: You can redistribute it and/or modify
+* it under the terms of the GNU Lesser General Public License as published
+* by the Free Software Foundation, either version 3 of the License, or
+* (at your option) any later version.
+*
+* StreamDevice is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+* GNU Lesser General Public License for more details.
+*
+* You should have received a copy of the GNU Lesser General Public License
+* along with StreamDevice. If not, see https://www.gnu.org/licenses/.
+*************************************************************************/
 
 #include "StreamBusInterface.h"
 #include "StreamError.h"

src/EnumConverter.cc

@@ -1,27 +1,30 @@
-/***************************************************************
-* StreamDevice Support                                         *
-*                                                              *
-* (C) 1999 Dirk Zimoch (zimoch@delta.uni-dortmund.de)          *
-* (C) 2005 Dirk Zimoch (dirk.zimoch@psi.ch)                    *
-*                                                              *
-* This is the enum format converter of StreamDevice.           *
-* Please refer to the HTML files in ../docs/ for a detailed    *
-* documentation.                                               *
-*                                                              *
-* If you do any changes in this file, you are not allowed to   *
-* redistribute it any more. If there is a bug or a missing     *
-* feature, send me an email and/or your patch. If I accept     *
-* your changes, they will go to the next release.              *
-*                                                              *
-* DISCLAIMER: If this software breaks something or harms       *
-* someone, it's your problem.                                  *
-*                                                              *
-***************************************************************/
+/*************************************************************************
+* This is the enum format converter of StreamDevice.
+* Please see ../docs/ for detailed documentation.
+*
+* (C) 1999,2005 Dirk Zimoch (dirk.zimoch@psi.ch)
+*
+* This file is part of StreamDevice.
+*
+* StreamDevice is free software: You can redistribute it and/or modify
+* it under the terms of the GNU Lesser General Public License as published
+* by the Free Software Foundation, either version 3 of the License, or
+* (at your option) any later version.
+*
+* StreamDevice is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+* GNU Lesser General Public License for more details.
+*
+* You should have received a copy of the GNU Lesser General Public License
+* along with StreamDevice. If not, see https://www.gnu.org/licenses/.
+*************************************************************************/
+
+#include <stdlib.h>
 
 #include "StreamFormatConverter.h"
 #include "StreamError.h"
 #include "StreamProtocol.h"
-#include <stdlib.h>
 
 // Enum %{string0|string1|...}
 
@@ -74,7 +77,7 @@ parse(const StreamFormat& fmt, StreamBuffer& info,
                 numEnums = -(numEnums+1);
                 info.append('\0');
                 memcpy(info(n), &numEnums, sizeof(numEnums));
-                debug("EnumConverter::parse %ld choices with default: %s\n",
+                debug2("EnumConverter::parse %ld choices with default: %s\n",
                     -numEnums, info.expand()());
                 return enum_format;
             }
@@ -97,7 +100,7 @@ parse(const StreamFormat& fmt, StreamBuffer& info,
             if (*source++ == '}')
             {
                 memcpy(info(n), &numEnums, sizeof(numEnums));
-                debug("EnumConverter::parse %ld choices: %s\n",
+                debug2("EnumConverter::parse %ld choices: %s\n",
                     numEnums, info.expand()());
                 return enum_format;
             }
@@ -127,7 +130,7 @@ printLong(const StreamFormat& fmt, StreamBuffer& output, long value)
     if (numEnums < 0) numEnums=-numEnums-1;
     while (numEnums-- && (value != index))
     {
-        while(*s)
+        while (*s)
         {
             if (*s == esc) s++;
             s++;
@@ -140,7 +143,7 @@ printLong(const StreamFormat& fmt, StreamBuffer& output, long value)
         error("Value %li not found in enum set\n", value);
         return false;
     }
-    while(*s)
+    while (*s)
     {
         if (*s == esc) s++;
         output.append(*s++);
@@ -165,7 +168,7 @@ scanLong(const StreamFormat& fmt, const char* input, long& value)
         debug("EnumConverter::scanLong: check #%ld \"%s\"\n", index, s);
         consumed = 0;
         match = true;
-        while(*s)
+        while (*s)
         {
             if (*s == StreamProtocolParser::skip)
             {

src/MacroMagic.h

@@ -1,3 +1,25 @@
+/*************************************************************************
+* This header provides macros for enum to string conversions.
+* Please see ../docs/ for detailed documentation.
+*
+* (C) 2018 Dirk Zimoch (dirk.zimoch@psi.ch)
+*
+* This file is part of StreamDevice.
+*
+* StreamDevice is free software: You can redistribute it and/or modify
+* it under the terms of the GNU Lesser General Public License as published
+* by the Free Software Foundation, either version 3 of the License, or
+* (at your option) any later version.
+*
+* StreamDevice is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+* GNU Lesser General Public License for more details.
+*
+* You should have received a copy of the GNU Lesser General Public License
+* along with StreamDevice. If not, see https://www.gnu.org/licenses/.
+*************************************************************************/
+
 #ifndef _MacroMagic_h
 #define _MacroMagic_h
 
@@ -28,7 +50,7 @@
 
 #define ENUM(type, args...) \
 enum type { args }; \
-static inline const char* type##ToStr(int x) {switch(x){MACRO_FOR_EACH(_CASE_LINE,args)default: return "invalid";}}\
+static inline const char* type##ToStr(int x) {switch(x) {MACRO_FOR_EACH(_CASE_LINE,args)default: return "invalid";}}\
 _ENUM_CAST(type)
 
 #else
@@ -65,7 +87,7 @@ _ENUM_CAST(type)
 
 #define ENUM(type,...) \
 enum type { __VA_ARGS__ }; \
-static inline const char* type##ToStr(int x) {switch(x){_EXPAND(MACRO_FOR_EACH(_CASE_LINE,__VA_ARGS__)) default: return "invalid";}} \
+static inline const char* type##ToStr(int x) {switch(x) {_EXPAND(MACRO_FOR_EACH(_CASE_LINE,__VA_ARGS__)) default: return "invalid";}} \
 _ENUM_CAST(type)
 #endif
 

src/Makefile

@@ -1,43 +1,38 @@
-################################################################
-# StreamDevice Support                                         #
-#                                                              #
-# (C) 1999 Dirk Zimoch (zimoch@delta.uni-dortmund.de)          #
-# (C) 2007 Dirk Zimoch (dirk.zimoch@psi.ch)                    #
-#                                                              #
-# This is the EPICS 3.14 Makefile of StreamDevice.             #
-# Normally it should not be necessary to modify this file.     #
-# All configuration can be done in CONFIG_STREAM               #
-#                                                              #
-# If you do any changes in this file, you are not allowed to   #
-# redistribute it any more. If there is a bug or a missing     #
-# feature, send me an email and/or your patch. If I accept     #
-# your changes, they will go to the next release.              #
-#                                                              #
-# DISCLAIMER: If this software breaks something or harms       #
-# someone, it's your problem.                                  #
-#                                                              #
-################################################################
+##########################################################################
+# This is the EPICS 3.14+ Makefile for StreamDevice.
+# Normally it should not be necessary to modify this file.
+# All configuration can be done in CONFIG_STREAM
+#
+# (C) 2007,2018 Dirk Zimoch (dirk.zimoch@psi.ch)
+#
+# This file is part of StreamDevice.
+#
+# StreamDevice is free software: You can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# StreamDevice is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with StreamDevice. If not, see https://www.gnu.org/licenses/.
+#########################################################################/
 
-TOP = ../..
-ifneq ($(wildcard ../../configure),)
-  include $(TOP)/configure/CONFIG
-else ifneq ($(wildcard ../../config),)
-  include $(TOP)/config/CONFIG_APP
-  include $(TOP)/config/RULES_ARCHS
-else
-  TOP= ..
-  include $(TOP)/configure/CONFIG
-endif
+TOP= ..
+include $(TOP)/configure/CONFIG
 
 -include CONFIG_STREAM
 -include ../CONFIG_STREAM
 
-LIBRARY_DEFAULT = stream
+LIBRARY_IOC = stream
 
-DBD += $(LIBRARY_DEFAULT).dbd
-DBD += $(LIBRARY_DEFAULT)-base.dbd
-ifdef CALC
-DBD += $(LIBRARY_DEFAULT)-scalcout.dbd
+DBD += stream.dbd
+DBD += stream-base.dbd
+ifneq ($(words $(CALC) $(SYNAPPS)), 0)
+DBD += stream-scalcout.dbd
 endif
 
 ifdef ASYN
@@ -47,8 +42,8 @@ $(warning Asyn not included! Didn't you set ASYN in your RELEASE file?)
 endif
 
 ifeq ($(LOADABLE_MODULE),YES)
-SRCS += $(LIBRARY_DEFAULT)_registerRecordDeviceDriver.cpp
-endif 
+SRCS += stream_registerRecordDeviceDriver.cpp
+endif
 SRCS += $(BUSSES:%=%Interface.cc)
 SRCS += $(FORMATS:%=%Converter.cc)
 SRCS += $(RECORDTYPES:%=dev%Stream.c)
@@ -65,20 +60,37 @@ ifneq ($(words $(PCRE_LIB) $(PCRE_INCLUDE)),0)
 LIB_SYS_LIBS_DEFAULT += pcre
 LIB_SYS_LIBS_WIN32 += $(PCRE_LIB)\\pcre
 SHRLIB_DEPLIB_DIRS += $(PCRE_LIB)
+ifdef ENABLE_STATIC
+CPPFLAGS += -DPCRE_STATIC
+endif
 endif
 endif
 
 LIB_LIBS += $(EPICS_BASE_IOC_LIBS)
 
 INC += devStream.h
+INC += StreamFormat.h
+INC += StreamFormatConverter.h
+INC += StreamBuffer.h
+INC += StreamError.h
+INC += StreamVersion.h
+INC += StreamProtocol.h
+INC += StreamBusInterface.h
+INC += StreamCore.h
+INC += MacroMagic.h
 
 # switch off annoying rset warnings in 3.16+
 CPPFLAGS += -DUSE_TYPED_RSET
 
+CPPFLAGS += -DSTREAM_INTERNAL
+
 -include $(TOP)/configure/RULES
 
-# Update version string whenever something changes
-StreamVersion$(OBJ): $(filter-out StreamVersion.o,$(LIBOBJS)$(LIBRARY_OBJS))
+# Update version string whenever something changed.
+StreamVersion$(OBJ): $(COMMON_DIR)/StreamVersion.h $(filter-out StreamVersion$(OBJ),$(LIBOBJS) $(LIBRARY_OBJS)) ../CONFIG_STREAM
+$(COMMON_DIR)/StreamVersion.h: ../../.VERSION $(SRCS) $(filter-out StreamVersion.h, $(INC))
+	@echo Creating $@
+	$(PERL) ../makeStreamVersion.pl $@
 
 # Add references to all registrars to main file to avoid
 # missing initialization.
@@ -89,28 +101,28 @@ streamReferences: ../CONFIG_STREAM
 	$(PERL) ../makeref.pl Converter $(FORMATS) >> $@
 
 # create stream-base.dbd from all RECORDTYPES except scalcout record
-$(COMMON_DIR)/$(LIBRARY_DEFAULT)-base.dbd: ../CONFIG_STREAM
+$(COMMON_DIR)/stream-base.dbd: ../CONFIG_STREAM
 	$(PERL) ../makedbd.pl $(if $(ASYN),--with-asyn) $(if $(BASE_3_14),,-3.13) $(filter-out scalcout, $(RECORDTYPES)) > $@
 
-$(LIBRARY_DEFAULT)-base.dbd$(DEP): ../CONFIG_STREAM
-	echo $(LIBRARY_DEFAULT)-base.dbd: $< > $@
+stream-base.dbd$(DEP): ../CONFIG_STREAM
+        echo stream-base.dbd: $< > $@
 
-STREAM_DBD_FILES = $(LIBRARY_DEFAULT)-base.dbd
+STREAM_DBD_FILES = stream-base.dbd
 
-ifdef CALC
+ifneq ($(words $(CALC) $(SYNAPPS)), 0)
 # create stream-scalcout.dbd for scalcout record
-$(COMMON_DIR)/$(LIBRARY_DEFAULT)-scalcout.dbd: ../CONFIG_STREAM
+$(COMMON_DIR)/stream-scalcout.dbd: ../CONFIG_STREAM
 	$(PERL) ../makedbd.pl --rec-only scalcout > $@
 
-$(LIBRARY_DEFAULT)-scalcout.dbd$(DEP): ../CONFIG_STREAM
-	echo $(LIBRARY_DEFAULT)-scalcout.dbd: $< > $@
+stream-scalcout.dbd$(DEP): ../CONFIG_STREAM
+        echo stream-scalcout.dbd: $< > $@
 
-STREAM_DBD_FILES += $(LIBRARY_DEFAULT)-scalcout.dbd
+STREAM_DBD_FILES += stream-scalcout.dbd
 endif
 
 # create stream.dbd for all record types
-$(COMMON_DIR)/$(LIBRARY_DEFAULT).dbd: ../CONFIG_STREAM
+$(COMMON_DIR)/stream.dbd: ../CONFIG_STREAM
 	$(PERL) ../makedbd.pl $(if $(ASYN),--with-asyn) $(if $(BASE_3_14),,-3.13) $(RECORDTYPES) > $@
 
-$(LIBRARY_DEFAULT).dbd$(DEP): ../CONFIG_STREAM
-	echo $(LIBRARY_DEFAULT).dbd: $< > $@
+stream.dbd$(DEP): ../CONFIG_STREAM
+        echo stream.dbd: $< > $@

src/Makefile.Host

@@ -1,22 +1,25 @@
-################################################################
-# StreamDevice Support                                         #
-#                                                              #
-# (C) 1999 Dirk Zimoch (zimoch@delta.uni-dortmund.de)          #
-# (C) 2006 Dirk Zimoch (dirk.zimoch@psi.ch)                    #
-#                                                              #
-# This is the EPICS 3.13 Makefile of StreamDevice.             #
-# Normally it should not be necessary to modify this file.     #
-# All configuration can be done in CONFIG_STREAM               #
-#                                                              #
-# If you do any changes in this file, you are not allowed to   #
-# redistribute it any more. If there is a bug or a missing     #
-# feature, send me an email and/or your patch. If I accept     #
-# your changes, they will go to the next release.              #
-#                                                              #
-# DISCLAIMER: If this software breaks something or harms       #
-# someone, it's your problem.                                  #
-#                                                              #
-################################################################
+##########################################################################
+# This is an EPICS 3.13 Makefile for StreamDevice.
+# Normally it should not be necessary to modify this file.
+# All configuration can be done in CONFIG_STREAM
+#
+# (C) 2007,2018 Dirk Zimoch (dirk.zimoch@psi.ch)
+#
+# This file is part of StreamDevice.
+#
+# StreamDevice is free software: You can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# StreamDevice is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with StreamDevice. If not, see https://www.gnu.org/licenses/.
+#########################################################################/
 
 TOP = ../..
 ifneq ($(wildcard ../../../config),)
@@ -26,11 +29,4 @@ endif
 include $(TOP)/config/CONFIG_APP
 include ../CONFIG_STREAM
 
-DBDNAME = stream.dbd
-INC += devStream.h
-
 include $(EPICS_BASE)/config/RULES.Host
-
-# create stream.dbd from all RECORDTYPES
-stream.dbd: ../CONFIG_STREAM
-	$(PERL) ../makedbd.pl -3.13 $(RECORDTYPES) > $@

src/Makefile.Vx

@@ -1,22 +1,25 @@
-################################################################
-# StreamDevice Support                                         #
-#                                                              #
-# (C) 1999 Dirk Zimoch (zimoch@delta.uni-dortmund.de)          #
-# (C) 2006 Dirk Zimoch (dirk.zimoch@psi.ch)                    #
-#                                                              #
-# This is the EPICS 3.13 Makefile of StreamDevice.             #
-# Normally it should not be necessary to modify this file.     #
-# All configuration can be done in CONFIG_STREAM               #
-#                                                              #
-# If you do any changes in this file, you are not allowed to   #
-# redistribute it any more. If there is a bug or a missing     #
-# feature, send me an email and/or your patch. If I accept     #
-# your changes, they will go to the next release.              #
-#                                                              #
-# DISCLAIMER: If this software breaks something or harms       #
-# someone, it's your problem.                                  #
-#                                                              #
-################################################################
+##########################################################################
+# This is an EPICS 3.13 Makefile for StreamDevice.
+# Normally it should not be necessary to modify this file.
+# All configuration can be done in CONFIG_STREAM
+#
+# (C) 2007,2018 Dirk Zimoch (dirk.zimoch@psi.ch)
+#
+# This file is part of StreamDevice.
+#
+# StreamDevice is free software: You can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# StreamDevice is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with StreamDevice. If not, see https://www.gnu.org/licenses/.
+#########################################################################/
 
 TOP = ../..
 ifneq ($(wildcard ../../../config),)
@@ -39,17 +42,37 @@ SRCS.c += $(filter %.c,$(STREAM_SRCS:%=%../%))
 
 LIBOBJS = $(patsubst ../%,%.o,$(basename $(SRCS.cc) $(SRCS.c)))
 
+DBDNAME = stream.dbd
+
+INC += devStream.h
+INC += StreamFormat.h
+INC += StreamFormatConverter.h
+INC += StreamBuffer.h
+INC += StreamError.h
+INC += StreamVersion.h
+
 include $(EPICS_BASE)/config/RULES.Vx
 include ../../config/RULES.munch
 
 DEPENDS: depends
 -include DEPENDS
 
+CPPFLAGS += -DSTREAM_INTERNAL
+
 # Update version string whenever something changes
-StreamVersion.o: ../*.c ../*.h ../*.cc ../CONFIG_STREAM
 $(LIBNAME): StreamVersion.o
 
+StreamVersion.o: StreamVersion.h $(filter-out StreamVersion.o,$(LIBOBJS)) ../CONFIG_STREAM
+StreamVersion.h: $(SRCS.cc) $(SRCS.c) $(add-prefix ../,$(filter-out StreamVersion.h, $(INC)))
+	@echo Creating $@ from git tag
+	$(PERL) ../makeStreamVersion.pl > $@
+
 StreamCore.o: streamReferences
 
 streamReferences:
 	touch $@
+
+# create stream.dbd from all RECORDTYPES
+stream.dbd: ../CONFIG_STREAM
+	$(PERL) ../makedbd.pl -3.13 $(RECORDTYPES) > $@
+

src/MantissaExponentConverter.cc

@@ -1,28 +1,31 @@
-/***************************************************************
-* StreamDevice Support                                         *
-*                                                              *
-* (C) 2008 Dirk Zimoch (dirk.zimoch@psi.ch)                    *
-*                                                              *
-* This is a custom exponential format converter for            *
-* StreamDevice.                                                *
-* The number is represented as two signed integers, mantissa   *
-* and exponent, like in +00011-01                              *
-* Please refer to the HTML files in ../docs/ for a detailed    *
-* documentation.                                               *
-*                                                              *
-* If you do any changes in this file, you are not allowed to   *
-* redistribute it any more. If there is a bug or a missing     *
-* feature, send me an email and/or your patch. If I accept     *
-* your changes, they will go to the next release.              *
-*                                                              *
-* DISCLAIMER: If this software breaks something or harms       *
-* someone, it's your problem.                                  *
-*                                                              *
-***************************************************************/
+/*************************************************************************
+* This is a custom exponential format converter for StreamDevice.
+* A number is represented as two signed integers, mantissa and exponent,
+* like in "+00011-01" (without an "E")
+* Please see ../docs/ for detailed documentation.
+*
+* (C) 2008 Dirk Zimoch (dirk.zimoch@psi.ch)
+*
+* This file is part of StreamDevice.
+*
+* StreamDevice is free software: You can redistribute it and/or modify
+* it under the terms of the GNU Lesser General Public License as published
+* by the Free Software Foundation, either version 3 of the License, or
+* (at your option) any later version.
+*
+* StreamDevice is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+* GNU Lesser General Public License for more details.
+*
+* You should have received a copy of the GNU Lesser General Public License
+* along with StreamDevice. If not, see https://www.gnu.org/licenses/.
+*************************************************************************/
+
+#include <math.h>
 
 #include "StreamFormatConverter.h"
 #include "StreamError.h"
-#include <math.h>
 
 // Exponential Converter %m
 // Eric Berryman requested a double format that reads

src/RawConverter.cc

@@ -1,22 +1,24 @@
-/***************************************************************
-* StreamDevice Support                                         *
-*                                                              *
-* (C) 1999 Dirk Zimoch (zimoch@delta.uni-dortmund.de)          *
-* (C) 2005 Dirk Zimoch (dirk.zimoch@psi.ch)                    *
-*                                                              *
-* This is the raw format converter of StreamDevice.            *
-* Please refer to the HTML files in ../docs/ for a detailed    *
-* documentation.                                               *
-*                                                              *
-* If you do any changes in this file, you are not allowed to   *
-* redistribute it any more. If there is a bug or a missing     *
-* feature, send me an email and/or your patch. If I accept     *
-* your changes, they will go to the next release.              *
-*                                                              *
-* DISCLAIMER: If this software breaks something or harms       *
-* someone, it's your problem.                                  *
-*                                                              *
-***************************************************************/
+/*************************************************************************
+* This is the raw integer format converter of StreamDevice.
+* Please see ../docs/ for detailed documentation.
+*
+* (C) 1999,2005 Dirk Zimoch (dirk.zimoch@psi.ch)
+*
+* This file is part of StreamDevice.
+*
+* StreamDevice is free software: You can redistribute it and/or modify
+* it under the terms of the GNU Lesser General Public License as published
+* by the Free Software Foundation, either version 3 of the License, or
+* (at your option) any later version.
+*
+* StreamDevice is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+* GNU Lesser General Public License for more details.
+*
+* You should have received a copy of the GNU Lesser General Public License
+* along with StreamDevice. If not, see https://www.gnu.org/licenses/.
+*************************************************************************/
 
 #include "StreamFormatConverter.h"
 #include "StreamError.h"

src/RawFloatConverter.cc

@@ -1,22 +1,24 @@
-/***************************************************************
-* StreamDevice Support                                         *
-*                                                              *
-* (C) 1999 Dirk Zimoch (zimoch@delta.uni-dortmund.de)          *
-* (C) 2005 Dirk Zimoch (dirk.zimoch@psi.ch)                    *
-*                                                              *
-* This is the raw format converter of StreamDevice.            *
-* Please refer to the HTML files in ../docs/ for a detailed    *
-* documentation.                                               *
-*                                                              *
-* If you do any changes in this file, you are not allowed to   *
-* redistribute it any more. If there is a bug or a missing     *
-* feature, send me an email and/or your patch. If I accept     *
-* your changes, they will go to the next release.              *
-*                                                              *
-* DISCLAIMER: If this software breaks something or harms       *
-* someone, it's your problem.                                  *
-*                                                              *
-***************************************************************/
+/*************************************************************************
+* This is the raw floating point format converter of StreamDevice.
+* Please see ../docs/ for detailed documentation.
+*
+* (C) 1999,2005 Dirk Zimoch (dirk.zimoch@psi.ch)
+*
+* This file is part of StreamDevice.
+*
+* StreamDevice is free software: You can redistribute it and/or modify
+* it under the terms of the GNU Lesser General Public License as published
+* by the Free Software Foundation, either version 3 of the License, or
+* (at your option) any later version.
+*
+* StreamDevice is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+* GNU Lesser General Public License for more details.
+*
+* You should have received a copy of the GNU Lesser General Public License
+* along with StreamDevice. If not, see https://www.gnu.org/licenses/.
+*************************************************************************/
 
 #include "StreamFormatConverter.h"
 #include "StreamError.h"
@@ -77,15 +79,15 @@ printDouble(const StreamFormat& format, StreamBuffer& output, double value)
     if (!(format.flags & alt_flag) ^ (endian == 4321))
     {
         // swap if byte orders differ
-    	for (n = nbOfBytes-1; n >= 0; n--)
-    	{
+        for (n = nbOfBytes-1; n >= 0; n--)
+        {
             output.append(buffer.bytes[n]);
-    	}
+        }
     } else {
-    	for (n = 0; n < nbOfBytes; n++)
-    	{
+        for (n = 0; n < nbOfBytes; n++)
+        {
             output.append(buffer.bytes[n]);
-    	}
+        }
     }
     return true;
 }
@@ -114,15 +116,15 @@ scanDouble(const StreamFormat& format, const char* input, double& value)
     if (!(format.flags & alt_flag) ^ (endian == 4321))
     {
         // swap if byte orders differ
-    	for (n = nbOfBytes-1, i = 0; n >= 0; n--, i++)
-    	{
+        for (n = nbOfBytes-1, i = 0; n >= 0; n--, i++)
+        {
             buffer.bytes[n] = input[i];
-    	}
+        }
     } else {
-    	for (n = 0; n < nbOfBytes; n++)
-    	{
+        for (n = 0; n < nbOfBytes; n++)
+        {
             buffer.bytes[n] = input[n];
-    	}
+        }
     }
 
     if (nbOfBytes == 4)

src/RegexpConverter.cc

@@ -1,30 +1,34 @@
-/***************************************************************
-* StreamDevice Support                                         *
-*                                                              *
-* (C) 1999 Dirk Zimoch (zimoch@delta.uni-dortmund.de)          *
-* (C) 2007 Dirk Zimoch (dirk.zimoch@psi.ch)                    *
-*                                                              *
-* This is the regexp format converter of StreamDevice.         *
-* Please refer to the HTML files in ../docs/ for a detailed    *
-* documentation.                                               *
-*                                                              *
-* If you do any changes in this file, you are not allowed to   *
-* redistribute it any more. If there is a bug or a missing     *
-* feature, send me an email and/or your patch. If I accept     *
-* your changes, they will go to the next release.              *
-*                                                              *
-* DISCLAIMER: If this software breaks something or harms       *
-* someone, it's your problem.                                  *
-*                                                              *
-***************************************************************/
+/*************************************************************************
+* This is the regular expression format converter of StreamDevice.
+* Please see ../docs/ for detailed documentation.
+*
+* (C) 1999,2007 Dirk Zimoch (dirk.zimoch@psi.ch)
+*
+* This file is part of StreamDevice.
+*
+* StreamDevice is free software: You can redistribute it and/or modify
+* it under the terms of the GNU Lesser General Public License as published
+* by the Free Software Foundation, either version 3 of the License, or
+* (at your option) any later version.
+*
+* StreamDevice is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+* GNU Lesser General Public License for more details.
+*
+* You should have received a copy of the GNU Lesser General Public License
+* along with StreamDevice. If not, see https://www.gnu.org/licenses/.
+*************************************************************************/
 
-#include "StreamFormatConverter.h"
-#include "StreamError.h"
-#include "pcre.h"
 #include <string.h>
 #include <limits.h>
 #include <ctype.h>
 
+#include "pcre.h"
+
+#include "StreamFormatConverter.h"
+#include "StreamError.h"
+
 #define Z PRINTF_SIZE_T_PREFIX
 
 // Perl regular expressions (PCRE) %/regexp/ and  %#/regexp/subst/

src/StreamBuffer.cc

@@ -1,30 +1,30 @@
-/***************************************************************
-* StreamBuffer                                                 *
-*                                                              *
-* (C) 2005 Dirk Zimoch (dirk.zimoch@psi.ch)                    *
-*                                                              *
-* This is a buffer class used in StreamDevice for I/O.         *
-* Please refer to the HTML files in ../docs/ for a detailed    *
-* documentation.                                               *
-*                                                              *
-* If you do any changes in this file, you are not allowed to   *
-* redistribute it any more. If there is a bug or a missing     *
-* feature, send me an email and/or your patch. If I accept     *
-* your changes, they will go to the next release.              *
-*                                                              *
-* DISCLAIMER: If this software breaks something or harms       *
-* someone, it's your problem.                                  *
-*                                                              *
-***************************************************************/
+/*************************************************************************
+* This is a buffer class used in StreamDevice for I/O.
+* Please see ../docs/ for detailed documentation.
+*
+* (C) 2005 Dirk Zimoch (dirk.zimoch@psi.ch)
+*
+* This file is part of StreamDevice.
+*
+* StreamDevice is free software: You can redistribute it and/or modify
+* it under the terms of the GNU Lesser General Public License as published
+* by the Free Software Foundation, either version 3 of the License, or
+* (at your option) any later version.
+*
+* StreamDevice is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+* GNU Lesser General Public License for more details.
+*
+* You should have received a copy of the GNU Lesser General Public License
+* along with StreamDevice. If not, see https://www.gnu.org/licenses/.
+*************************************************************************/
 
 // Make sure that vsnprintf is available
 #ifndef _BSD_SOURCE
 #define _BSD_SOURCE
 #endif
 
-#include "StreamBuffer.h"
-#include "StreamError.h"
-
 #include <stdio.h>
 #include <stdarg.h>
 #include <stdlib.h>
@@ -37,6 +37,7 @@
 
 #include <vxWorks.h>
 #include <fioLib.h>
+#include <string.h>
 
 struct outStr_s {
     char *str;
@@ -71,6 +72,9 @@ int vsnprintf(char *str, size_t size, const char *format, va_list ap) {
 #endif // ! _WRS_VXWORKS_MAJOR
 #endif // vxWorks
 
+#include "StreamBuffer.h"
+#include "StreamError.h"
+
 #define P PRINTF_SIZE_T_PREFIX
 
 void StreamBuffer::
@@ -98,7 +102,7 @@ init(const void* s, ssize_t minsize)
 }
 
 // How the buffer looks like:
-// |----free-----|####used####|--------00--------|
+// |----junk-----|####used####|--------00--------|
 ///|<--- offs -->|<-- len --->|<- cap-offs-len ->|
 // 0            offs      offs+len              cap
 //               |<-------------- minsize --------------->
@@ -250,39 +254,71 @@ replace(ssize_t remstart, ssize_t remlen, const void* ins, ssize_t inslen)
     if (inslen < 0) inslen = 0;
     size_t remend = remstart+remlen;
     size_t newlen = len+inslen-remlen;
+
+// How the buffer looks like before and after:
+// |---junk---|##content_start##|/////////remove_this////////|##content_end##|0000|
+// |<- offs ->|<-- remstart --->|<--------- remlen --------->|               |    |
+// |          |<--------------------- len ---------------------------------->|    |
+// 0         offs           offs+remstart                offs+remend    offs+len cap
+//
+// If content size stays the same, no need to move old content:
+// |---junk---|##content_start##|+++++++inserted_text++++++++|##content_end##|0000|
+//                              |<----- inslen==remlen ----->|         newlen==len
+//
+// If content shrinks (need to clear end of buffer):          |< clear this >|
+// |---junk---|##content_start##|inserted_text|##content_end##|00000000000000|0000|
+// 0         offs               |<- inslen -->|               |< len-newlen >|
+//                                                        offs+newlen    offs+len
+//
+// If content grows but still fits (make sure to keep at least one 0 byte at end):
+// |---junk---|##content_start##|++++++++inserted_text++++++++++|##content_end##|0|
+// |<- offs ->|<--------------------- newlen ---------------------------------->| |
+// 0         offs                                                           offs+newlen<cap
+//
+// If content would overflow, moving to offs 0 may help:
+// May need to clear end if newlen < offs+len:                       |<clear>|
+// |##content_start##|++++++++inserted_text++++++++++|##content_end##|0000000|0000|
+// |<--------------------- newlen ---------------------------------->|       |
+//                                                                newlen  offs+len
+// 
+// Otherwise we need to copy to a new buffer.
+
+
     if (cap <= newlen)
     {
-        // buffer too short
+        // buffer too short, copy to new buffer
         size_t newcap;
         for (newcap = sizeof(local)*2; newcap <= newlen; newcap *= 2);
         char* newbuffer = new char[newcap];
-        memcpy(newbuffer, buffer+offs, remstart);
-        memcpy(newbuffer+remstart, ins, inslen);
-        memcpy(newbuffer+remstart+inslen, buffer+offs+remend, len-remend);
-        memset(newbuffer+newlen, 0, newcap-newlen);
+        memcpy(newbuffer, buffer+offs, remstart);                           // copy content start
+        memcpy(newbuffer+remstart, ins, inslen);                            // insert
+        memcpy(newbuffer+remstart+inslen, buffer+offs+remend, len-remend);  // copy content end
+        memset(newbuffer+newlen, 0, newcap-newlen);                         // clear buffer end
         if (buffer != local)
-        {
-            delete [] buffer;
-        }
+            delete[] buffer;
         buffer = newbuffer;
         cap = newcap;
         offs = 0;
     }
     else
     {
-        if (newlen+offs<=cap)
+        if (offs+newlen < cap)
         {
-            // move to start of buffer
-            memmove(buffer+offs+remstart+inslen, buffer+offs+remend, len-remend);
-            memcpy(buffer+offs+remstart, ins, inslen);
-            if (newlen<len) memset(buffer+offs+newlen, 0, len-newlen);
+            // modified content still fits with current offs, just move content end
+            if (newlen != len)
+                memmove(buffer+offs+remstart+inslen, buffer+offs+remend, len-remend); // move old content end if necessary
+            memcpy(buffer+offs+remstart, ins, inslen);                                // insert before
+            if (newlen < len)
+                memset(buffer+offs+newlen, 0, len-newlen);                            // clear buffer end if content shrunk
         }
         else
         {
-            memmove(buffer,buffer+offs,remstart);
-            memmove(buffer+remstart+inslen, buffer+offs+remend, len-remend);
-            memcpy(buffer+remstart, ins, inslen);
-            if (newlen<len) memset(buffer+newlen, 0, len-newlen);
+            // move content to start of buffer
+            memmove(buffer, buffer+offs, remstart);                                   // move content start to 0 offs
+            memmove(buffer+remstart+inslen, buffer+offs+remend, len-remend);          // move content end
+            memcpy(buffer+remstart, ins, inslen);                                     // insert in between
+            if (newlen < offs+len)
+                memset(buffer+newlen, 0, offs+len-newlen);                            // clear buffer end if necessary
             offs = 0;
         }
     }
@@ -306,7 +342,7 @@ print(const char* fmt, ...)
             return *this;
         }
         if (printed > -1) grow(len+printed);
-        else grow(len);
+        else grow(cap*2-1);
     }
 }
 
@@ -338,7 +374,10 @@ StreamBuffer StreamBuffer::expand(ssize_t start, ssize_t length) const
     {
         c = buffer[i];
         if (c < 0x20 || c >= 0x7f)
-            result.print("\033[7m<%02x>\033[27m", c & 0xff);
+            result.print("%s<%02x>%s",
+                         ansiEscape(ANSI_REVERSE_VIDEO),
+                         c & 0xff,
+                         ansiEscape(ANSI_NOT_REVERSE_VIDEO));
         else
             result.append(c);
     }
@@ -351,18 +390,21 @@ dump() const
     StreamBuffer result;
     size_t i;
     result.print("%" P "d,%" P "d,%" P "d:", offs, len, cap);
-    if (offs) result.print("\033[47m");
+    if (offs) result.print("%s", ansiEscape(ANSI_BG_WHITE));
     char c;
     for (i = 0; i < cap; i++)
     {
         c = buffer[i];
-        if (offs && i == offs) result.append("\033[0m");
+        if (offs && i == offs) result.append(ansiEscape(ANSI_RESET));
         if (c < 0x20 || c >= 0x7f)
-            result.print("\033[7m<%02x>\033[27m", c & 0xff);
+            result.print("%s<%02x>%s",
+                         ansiEscape(ANSI_REVERSE_VIDEO),
+                         c & 0xff,
+                         ansiEscape(ANSI_NOT_REVERSE_VIDEO));
         else
             result.append(c);
-        if (i == offs+len-1) result.append("\033[47m");
+        if (i == offs+len-1) result.append(ansiEscape(ANSI_BG_WHITE));
     }
-    result.append("\033[0m");
+    result.append(ansiEscape(ANSI_RESET));
     return result;
 }

src/StreamBuffer.h

@@ -1,21 +1,24 @@
-/***************************************************************
-* StreamBuffer                                                 *
-*                                                              *
-* (C) 2005 Dirk Zimoch (dirk.zimoch@psi.ch)                    *
-*                                                              *
-* This is a buffer class used in StreamDevice for I/O.         *
-* Please refer to the HTML files in ../docs/ for a detailed    *
-* documentation.                                               *
-*                                                              *
-* If you do any changes in this file, you are not allowed to   *
-* redistribute it any more. If there is a bug or a missing     *
-* feature, send me an email and/or your patch. If I accept     *
-* your changes, they will go to the next release.              *
-*                                                              *
-* DISCLAIMER: If this software breaks something or harms       *
-* someone, it's your problem.                                  *
-*                                                              *
-***************************************************************/
+/*************************************************************************
+* This is a buffer class used in StreamDevice for I/O.
+* Please see ../docs/ for detailed documentation.
+*
+* (C) 2005 Dirk Zimoch (dirk.zimoch@psi.ch)
+*
+* This file is part of StreamDevice.
+*
+* StreamDevice is free software: You can redistribute it and/or modify
+* it under the terms of the GNU Lesser General Public License as published
+* by the Free Software Foundation, either version 3 of the License, or
+* (at your option) any later version.
+*
+* StreamDevice is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+* GNU Lesser General Public License for more details.
+*
+* You should have received a copy of the GNU Lesser General Public License
+* along with StreamDevice. If not, see https://www.gnu.org/licenses/.
+*************************************************************************/
 
 #ifndef StreamBuffer_h
 #define StreamBuffer_h
@@ -199,11 +202,10 @@ public:
 
     // find: get index of data in buffer or -1
     ssize_t find(char c, ssize_t start=0) const
-        {char* p;
+        {if (start < 0 && (start -= len) < 0) start = 0;
+         char* p;
          return (p = static_cast<char*>(
-            memchr(buffer+offs+(start<0?start+len:start),
-                c, start<0?-start:len-start)))?
-            p-(buffer+offs) : -1;}
+            memchr(buffer+offs+start, c, len-start)))? p-(buffer+offs) : -1;}
 
     ssize_t find(const void* s, size_t size, ssize_t start=0) const;
 

src/StreamBusInterface.cc

@@ -1,23 +1,27 @@
-/***************************************************************
-* StreamDevice Support                                         *
-*                                                              *
-* (C) 2005 Dirk Zimoch (dirk.zimoch@psi.ch)                    *
-*                                                              *
-* This is the interface to bus drivers for StreamDevice.       *
-* Please refer to the HTML files in ../docs/ for a detailed    *
-* documentation.                                               *
-*                                                              *
-* If you do any changes in this file, you are not allowed to   *
-* redistribute it any more. If there is a bug or a missing     *
-* feature, send me an email and/or your patch. If I accept     *
-* your changes, they will go to the next release.              *
-*                                                              *
-* DISCLAIMER: If this software breaks something or harms       *
-* someone, it's your problem.                                  *
-*                                                              *
-***************************************************************/
+/*************************************************************************
+* This is the interface to bus (I/O) drivers for StreamDevice.
+* Please see ../docs/ for detailed documentation.
+*
+* (C) 2005 Dirk Zimoch (dirk.zimoch@psi.ch)
+*
+* This file is part of StreamDevice.
+*
+* StreamDevice is free software: You can redistribute it and/or modify
+* it under the terms of the GNU Lesser General Public License as published
+* by the Free Software Foundation, either version 3 of the License, or
+* (at your option) any later version.
+*
+* StreamDevice is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+* GNU Lesser General Public License for more details.
+*
+* You should have received a copy of the GNU Lesser General Public License
+* along with StreamDevice. If not, see https://www.gnu.org/licenses/.
+*************************************************************************/
 
 #include <stdio.h>
+
 #include "StreamBusInterface.h"
 #include "StreamError.h"
 
@@ -118,7 +122,7 @@ writeRequest(const void*, size_t, unsigned long)
 }
 
 bool StreamBusInterface::
-readRequest(unsigned long, unsigned long, size_t, bool)
+readRequest(unsigned long, unsigned long, ssize_t, bool)
 {
     return false;
 }

src/StreamBusInterface.h

@@ -1,21 +1,24 @@
-/***************************************************************
-* StreamDevice Support                                         *
-*                                                              *
-* (C) 2005 Dirk Zimoch (dirk.zimoch@psi.ch)                    *
-*                                                              *
-* This is the interface to bus drivers for StreamDevice.       *
-* Please refer to the HTML files in ../docs/ for a detailed    *
-* documentation.                                               *
-*                                                              *
-* If you do any changes in this file, you are not allowed to   *
-* redistribute it any more. If there is a bug or a missing     *
-* feature, send me an email and/or your patch. If I accept     *
-* your changes, they will go to the next release.              *
-*                                                              *
-* DISCLAIMER: If this software breaks something or harms       *
-* someone, it's your problem.                                  *
-*                                                              *
-***************************************************************/
+/*************************************************************************
+* This is the interface to bus (I/O) drivers for StreamDevice.
+* Please see ../docs/ for detailed documentation.
+*
+* (C) 2005 Dirk Zimoch (dirk.zimoch@psi.ch)
+*
+* This file is part of StreamDevice.
+*
+* StreamDevice is free software: You can redistribute it and/or modify
+* it under the terms of the GNU Lesser General Public License as published
+* by the Free Software Foundation, either version 3 of the License, or
+* (at your option) any later version.
+*
+* StreamDevice is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+* GNU Lesser General Public License for more details.
+*
+* You should have received a copy of the GNU Lesser General Public License
+* along with StreamDevice. If not, see https://www.gnu.org/licenses/.
+*************************************************************************/
 
 #ifndef StreamBusInterface_h
 #define StreamBusInterface_h
@@ -76,7 +79,7 @@ public:
             return businterface && businterface->writeRequest(output, size, timeout_ms);
         }
         bool busReadRequest(unsigned long replytimeout_ms,
-            unsigned long readtimeout_ms, size_t expectedLength,
+            unsigned long readtimeout_ms, ssize_t expectedLength,
             bool async) {
             return businterface && businterface->readRequest(replytimeout_ms,
                     readtimeout_ms, expectedLength, async);
@@ -133,7 +136,7 @@ protected:
     virtual bool writeRequest(const void* output, size_t size,
         unsigned long timeout_ms);
     virtual bool readRequest(unsigned long replytimeout_ms,
-        unsigned long readtimeout_ms, size_t expectedLength,
+        unsigned long readtimeout_ms, ssize_t expectedLength,
         bool async);
     virtual bool supportsEvent(); // defaults to false
     virtual bool supportsAsyncRead(); // defaults to false

src/StreamCore.cc

@@ -1,30 +1,35 @@
-/***************************************************************
-* StreamDevice Support                                         *
-*                                                              *
-* (C) 1999 Dirk Zimoch (zimoch@delta.uni-dortmund.de)          *
-* (C) 2005 Dirk Zimoch (dirk.zimoch@psi.ch)                    *
-*                                                              *
-* This is the kernel of StreamDevice.                          *
-* Please refer to the HTML files in ../docs/ for a detailed    *
-* documentation.                                               *
-*                                                              *
-* If you do any changes in this file, you are not allowed to   *
-* redistribute it any more. If there is a bug or a missing     *
-* feature, send me an email and/or your patch. If I accept     *
-* your changes, they will go to the next release.              *
-*                                                              *
-* DISCLAIMER: If this software breaks something or harms       *
-* someone, it's your problem.                                  *
-*                                                              *
-***************************************************************/
+/*************************************************************************
+* This is the core of StreamDevice.
+* Please see ../docs/ for detailed documentation.
+*
+* (C) 1999,2005 Dirk Zimoch (dirk.zimoch@psi.ch)
+*
+* This file is part of StreamDevice.
+*
+* StreamDevice is free software: You can redistribute it and/or modify
+* it under the terms of the GNU Lesser General Public License as published
+* by the Free Software Foundation, either version 3 of the License, or
+* (at your option) any later version.
+*
+* StreamDevice is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+* GNU Lesser General Public License for more details.
+*
+* You should have received a copy of the GNU Lesser General Public License
+* along with StreamDevice. If not, see https://www.gnu.org/licenses/.
+*************************************************************************/
 
-#include "StreamCore.h"
-#include "StreamError.h"
 #include <ctype.h>
 #include <stdlib.h>
 
+#include "StreamCore.h"
+#include "StreamError.h"
+
 #define Z PRINTF_SIZE_T_PREFIX
 
+int streamErrorDeadTime = 0;
+
 /// debug functions /////////////////////////////////////////////
 
 char* StreamCore::
@@ -34,7 +39,7 @@ printCommands(StreamBuffer& buffer, const char* c)
     unsigned long eventnumber;
     while (1)
     {
-        switch(*c++)
+        switch (*c++)
         {
             case end:
                 return buffer();
@@ -70,9 +75,9 @@ printCommands(StreamBuffer& buffer, const char* c)
                 buffer.append("    disconnect;\n");
                 break;
             default:
-                buffer.append("\033[31;1mGARBAGE: ");
+                buffer.append(ansiEscape(ANSI_RED_BOLD)).append("GARBAGE: ");
                 c = StreamProtocolParser::printString(buffer, c-1);
-                buffer.append("\033[0m\n");
+                buffer.append(ansiEscape(ANSI_RESET)).append("\n");
         }
     }
 }
@@ -120,12 +125,11 @@ printProtocol(FILE* file)
 StreamCore* StreamCore::first = NULL;
 
 StreamCore::
-StreamCore() : activeCommand(end)
+StreamCore() : StreamBusInterface::Client(),
+    next(), streamname(), flags(None), inTerminatorDefined(), outTerminatorDefined(),
+    activeCommand(end), previousResult(Success), numberOfErrors(0), unparsedInput()
 {
     businterface = NULL;
-    flags = None;
-    next = NULL;
-    unparsedInput = false;
     // add myself to list of streams
     StreamCore** pstream;
     for (pstream = &first; *pstream; pstream = &(*pstream)->next);
@@ -185,18 +189,33 @@ bool StreamCore::
 parse(const char* filename, const char* _protocolname)
 {
     protocolname = _protocolname;
-    // extract substitutions from protocolname "name(sub1,sub2)"
+    // extract substitutions from protocolname "name ( sub1, sub2 ) "
     ssize_t i = protocolname.find('(');
-    if (i >= 0)
+    if (i < 0) i = 0;
+    while (protocolname[i-1] == ' ')
+        protocolname.remove(--i, 1);
+    if (protocolname[i] == '(')
     {
-        while (i >= 0)
+        while (i < (ssize_t)protocolname.length())
         {
             if (protocolname[i-1] == ' ')
                 protocolname.remove(--i, 1); // remove trailing space
-            protocolname[i] = '\0'; // replace '(' and ',' with '\0'
+            protocolname[i] = '\0'; // replace initial '(' and separating ',' with '\0'
             if (protocolname[i+1] == ' ')
                 protocolname.remove(i+1, 1); // remove leading space
-            i = protocolname.find(',', i+1);
+            int brackets = 0;
+            do {
+                i++;
+                i += strcspn(protocolname(i), ",()\\");
+                char c = protocolname[i];
+                if (c == '(') brackets++;
+                else if (c == ')') brackets--;
+                else if (c == ',' && brackets <= 0) break;
+                else if (c == '\\') {
+                    if (protocolname[i+1] == '\\') i++; // keep '\\'
+                    else protocolname.remove(i, 1); // else skip over next char
+                }
+            } while (i < (ssize_t)protocolname.length());
         }
         // should have closing parentheses
         if (protocolname[-1] != ')')
@@ -206,9 +225,8 @@ parse(const char* filename, const char* _protocolname)
         }
         protocolname.truncate(-1); // remove ')'
         if (protocolname[-1] == ' ')
-        {
             protocolname.truncate(-1); // remove trailing space
-        }
+        debug("StreamCore::parse \"%s\" -> \"%s\"\n", _protocolname, protocolname.expand()());
     }
     StreamProtocolParser::Protocol* protocol;
     protocol = StreamProtocolParser::getProtocol(filename, protocolname);
@@ -473,6 +491,8 @@ finishProtocol(ProtocolResult status)
         switch (status)
         {
             case Success:
+                previousResult = Success;
+                numberOfErrors = 0;
                 handler = NULL;
                 break;
             case WriteTimeout:
@@ -583,6 +603,7 @@ evalOut()
     // flush all unread input
     unparsedInput = false;
     inputBuffer.clear();
+    inputLine.clear();
     if (!formatOutput())
     {
         finishProtocol(FormatError);
@@ -975,8 +996,10 @@ readCallback(StreamIoStatus status,
                 evalIn();
                 return 0;
             }
-            debug("StreamCore::readCallback(%s): No reply from device within %ld ms\n",
-                name(), replyTimeout);
+            if (checkShouldPrint(ReplyTimeout)) {
+                error("%s: No reply within %ld ms to \"%s\"\n",
+                    name(), replyTimeout, outputLine.expand()());
+            }
             inputBuffer.clear();
             finishProtocol(ReplyTimeout);
             return 0;
@@ -989,6 +1012,7 @@ readCallback(StreamIoStatus status,
             finishProtocol(Fault);
             return 0;
     }
+    inputHook(input, size);
     inputBuffer.append(input, size);
     debug("StreamCore::readCallback(%s) inputBuffer=\"%s\", size %" Z "u\n",
         name(), inputBuffer.expand()(), inputBuffer.length());
@@ -1093,9 +1117,11 @@ readCallback(StreamIoStatus status,
         }
         else
         {
-            error("%s: Timeout after reading %" Z "d byte%s \"%s%s\"\n",
-                name(), end, end==1 ? "" : "s", end > 20 ? "..." : "",
-                inputBuffer.expand(-20)());
+            if (checkShouldPrint(ReadTimeout)) {
+                error("%s: Timeout after reading %" Z "d byte%s \"%s%s\"\n",
+                    name(), end, end==1 ? "" : "s", end > 20 ? "..." : "",
+                    inputBuffer.expand(-20)());
+            }
         }
     }
 
@@ -1106,7 +1132,7 @@ readCallback(StreamIoStatus status,
     inputBuffer.remove(end + termlen);
     if (inputBuffer)
     {
-        debug("StreamCore::readCallback(%s) unpared input left: \"%s\"\n",
+        debug("StreamCore::readCallback(%s) unparsed input left: \"%s\"\n",
             name(), inputBuffer.expand()());
         unparsedInput = true;
     }
@@ -1158,6 +1184,7 @@ matchInput()
     char command;
     const char* fieldName = NULL;
     StreamBuffer formatstring;
+    ssize_t delta = 0;
 
     consumedInput = 0;
 
@@ -1192,7 +1219,7 @@ normal_format:
                 debug("StreamCore::matchInput(%s): format = \"%%%s\"\n",
                     name(), formatstring());
 
-                if (fmt.flags & skip_flag || fmt.type == pseudo_format)
+                if (fmt.flags & skip_flag || fmt.type == pseudo_format || fmt.type == needs_original_format)
                 {
                     long ldummy;
                     double ddummy;
@@ -1214,9 +1241,20 @@ normal_format:
                                 scanString(fmt, inputLine(consumedInput), NULL, size);
                             break;
                         case pseudo_format:
-                            // pass complete input
+                            // pass complete input line for scan and/or re-write
+                            size = inputLine.length();
                             consumed = StreamFormatConverter::find(fmt.conv)->
                                 scanPseudo(fmt, inputLine, consumedInput);
+                            delta += inputLine.length() - size; // track length changes
+                            debug("after rewrite delta=%zi\n", delta);
+                            break;
+                        case needs_original_format:
+                            // pass original input with adjusted current position
+                            debug("before checksum delta=%zi\n", delta);
+                            consumedInput -= delta; // correct for length changes
+                            consumed = StreamFormatConverter::find(fmt.conv)->
+                                scanPseudo(fmt, inputBuffer, consumedInput);
+                            consumedInput += delta;
                             break;
                         default:
                             error("INTERNAL ERROR (%s): illegal format.type 0x%02x\n",
@@ -1343,7 +1381,7 @@ normal_format:
                     {
                         int i = 0;
                         while (commandIndex[i] >= ' ') i++;
-                        error("%s: Input \"%s%s%s\"\n", 
+                        error("%s: Input \"%s%s%s\"\n",
                             name(),
                             consumedInput > 20 ? "..." : "",
                             inputLine.expand(consumedInput > 20 ? consumedInput-20 : 0, 40)(),
@@ -1356,7 +1394,7 @@ normal_format:
                             consumedInput > 10 ? "..." : "",
                             inputLine.expand(consumedInput > 10 ? consumedInput-10 : 0,
                                 consumedInput > 10 ? 10 : consumedInput)());
-                        
+
                         error("%s: got \"%s%s\" where \"%s\" was expected\n",
                             name(),
                             inputLine.expand(consumedInput, 10)(),
@@ -1789,4 +1827,55 @@ printStatus(StreamBuffer& buffer)
     busPrintStatus(buffer);
 }
 
+const char* StreamCore::
+license(void)
+{
+    return
+        "StreamDevice is free software: You can redistribute it and/or modify\n"
+        "it under the terms of the GNU Lesser General Public License as published\n"
+        "by the Free Software Foundation, either version 3 of the License, or\n"
+        "(at your option) any later version.\n"
+        "\n"
+        "StreamDevice is distributed in the hope that it will be useful,\n"
+        "but WITHOUT ANY WARRANTY; without even the implied warranty of\n"
+        "MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n"
+        "GNU Lesser General Public License for more details\n"
+        "\n"
+        "You should have received a copy of the GNU Lesser General Public License\n"
+        "along with StreamDevice. If not, see https://www.gnu.org/licenses/.\n";
+}
+
+/**
+ * \brief Checks whether an error message should be printed based on the new error type.
+ *
+ * Will check based on the error type and the time since last error of the same type
+ * whether to print the new error. Also has a number of side effects such as counting
+ * up errors of each type and resetting the time since last error.
+ *
+ * \param[in] newErrorType the type of the new error
+ * \return true if the error should be preinted, else false
+ */
+bool  StreamCore::checkShouldPrint(ProtocolResult newErrorType)
+{
+    if (previousResult != newErrorType) {
+        previousResult = newErrorType;
+        numberOfErrors = 0;
+        time(&lastErrorTime);
+        return true;
+    }
+    else if ((int)(time(NULL) - lastErrorTime) > streamErrorDeadTime) {
+        time(&lastErrorTime);
+        if (numberOfErrors != 0) {
+            error("%s: %i additional errors of the following type seen in the last %i seconds\n",
+                name(), numberOfErrors, streamErrorDeadTime);
+        }
+        numberOfErrors = 0;
+        return true;
+    }
+    else {
+        numberOfErrors++;
+        return false;
+    }
+}
+
 #include "streamReferences"

src/StreamCore.h

@@ -1,22 +1,24 @@
-/***************************************************************
-* StreamDevice Support                                         *
-*                                                              *
-* (C) 1999 Dirk Zimoch (zimoch@delta.uni-dortmund.de)          *
-* (C) 2005 Dirk Zimoch (dirk.zimoch@psi.ch)                    *
-*                                                              *
-* This is the kernel of StreamDevice.                          *
-* Please refer to the HTML files in ../docs/ for a detailed    *
-* documentation.                                               *
-*                                                              *
-* If you do any changes in this file, you are not allowed to   *
-* redistribute it any more. If there is a bug or a missing     *
-* feature, send me an email and/or your patch. If I accept     *
-* your changes, they will go to the next release.              *
-*                                                              *
-* DISCLAIMER: If this software breaks something or harms       *
-* someone, it's your problem.                                  *
-*                                                              *
-***************************************************************/
+/*************************************************************************
+* This is the core of StreamDevice.
+* Please see ../docs/ for detailed documentation.
+*
+* (C) 1999,2005 Dirk Zimoch (dirk.zimoch@psi.ch)
+*
+* This file is part of StreamDevice.
+*
+* StreamDevice is free software: You can redistribute it and/or modify
+* it under the terms of the GNU Lesser General Public License as published
+* by the Free Software Foundation, either version 3 of the License, or
+* (at your option) any later version.
+*
+* StreamDevice is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+* GNU Lesser General Public License for more details.
+*
+* You should have received a copy of the GNU Lesser General Public License
+* along with StreamDevice. If not, see https://www.gnu.org/licenses/.
+*************************************************************************/
 
 #ifndef StreamCore_h
 #define StreamCore_h
@@ -71,7 +73,7 @@ void acceptEvent(unsigned short mask, unsigned short timeout)
 ***************************************/
 
 #include "MacroMagic.h"
-
+#include "time.h"
 
 // Flags: 0x00FFFFFF reserved for StreamCore
 const unsigned long None             = 0x0000;
@@ -93,6 +95,9 @@ const unsigned long ClearOnStart     = InitRun|AsyncMode|GotValue|Aborted|
                                        BusOwner|Separator|ScanTried|
                                        AcceptInput|AcceptEvent|BusPending;
 
+// The amount of time to wait before printing duplicated messages
+extern int streamErrorDeadTime;
+
 struct StreamFormat;
 
 class StreamCore :
@@ -171,6 +176,11 @@ protected:
     ProtocolResult runningHandler;
     StreamBuffer fieldAddress;
 
+    // Keep track of errors to reduce logging frequencies
+    ProtocolResult previousResult;
+    time_t lastErrorTime;
+    int numberOfErrors;
+
     StreamIoStatus lastInputStatus;
     bool unparsedInput;
 
@@ -209,6 +219,7 @@ protected:
 
 // virtual methods
     virtual void protocolStartHook() {}
+    virtual void inputHook(const void* input, size_t size) {};
     virtual void protocolFinishHook(ProtocolResult) {}
     virtual void startTimer(unsigned long timeout) = 0;
     virtual bool formatValue(const StreamFormat&, const void* fieldaddress) = 0;
@@ -224,9 +235,11 @@ public:
     void printProtocol(FILE* = stdout);
     const char* name() { return streamname; }
     void printStatus(StreamBuffer& buffer);
-    
+    static const char* license(void);
+
 private:
     char* printCommands(StreamBuffer& buffer, const char* c);
+    bool  checkShouldPrint(ProtocolResult newErrorType);
 };
 
 #endif

src/StreamEpics.cc

@@ -1,26 +1,36 @@
-/***************************************************************
-* StreamDevice Support                                         *
-*                                                              *
-* (C) 1999 Dirk Zimoch (zimoch@delta.uni-dortmund.de)          *
-* (C) 2005 Dirk Zimoch (dirk.zimoch@psi.ch)                    *
-*                                                              *
-* This is the interface to EPICS for StreamDevice.             *
-* Please refer to the HTML files in ../docs/ for a detailed    *
-* documentation.                                               *
-*                                                              *
-* If you do any changes in this file, you are not allowed to   *
-* redistribute it any more. If there is a bug or a missing     *
-* feature, send me an email and/or your patch. If I accept     *
-* your changes, they will go to the next release.              *
-*                                                              *
-* DISCLAIMER: If this software breaks something or harms       *
-* someone, it's your problem.                                  *
-*                                                              *
-***************************************************************/
+/*************************************************************************
+* This is the StreamDevice interface to EPICS.
+* Please see ../docs/ for detailed documentation.
+*
+* (C) 1999,2005 Dirk Zimoch (dirk.zimoch@psi.ch)
+*
+* This file is part of StreamDevice.
+*
+* StreamDevice is free software: You can redistribute it and/or modify
+* it under the terms of the GNU Lesser General Public License as published
+* by the Free Software Foundation, either version 3 of the License, or
+* (at your option) any later version.
+*
+* StreamDevice is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+* GNU Lesser General Public License for more details.
+*
+* You should have received a copy of the GNU Lesser General Public License
+* along with StreamDevice. If not, see https://www.gnu.org/licenses/.
+*************************************************************************/
 
 #include <errno.h>
-#include "StreamCore.h"
-#include "StreamError.h"
+#include <ctype.h>
+#include <stdarg.h>
+#include <stdlib.h>
+#include <string.h>
+#include <stdio.h>
+
+#if defined(vxWorks)
+#include <symLib.h>
+#include <sysSymTbl.h>
+#endif
 
 #include "epicsVersion.h"
 #ifdef BASE_VERSION
@@ -28,6 +38,10 @@
 #endif
 
 #ifdef EPICS_3_13
+#include <semLib.h>
+#include <wdLib.h>
+#include <taskLib.h>
+
 extern "C" {
 #endif
 
@@ -40,18 +54,11 @@ extern "C" {
 #include "recGbl.h"
 #include "devLib.h"
 #include "callback.h"
+#include "initHooks.h"
 
-#include <ctype.h>
-#include <stdarg.h>
-#include <stdlib.h>
 #ifdef EPICS_3_13
-
-#include <semLib.h>
-#include <wdLib.h>
-#include <taskLib.h>
-
+static char* epicsStrDup(const char *s) { char* c = (char*)malloc(strlen(s)+1); strcpy(c, s); return c; }
 extern DBBASE *pdbbase;
-
 } // extern "C"
 
 #else // !EPICS_3_13
@@ -66,29 +73,25 @@ extern DBBASE *pdbbase;
 #include "iocsh.h"
 #include "epicsExport.h"
 
-#if defined(VERSION_INT) || EPICS_MODIFICATION >= 11
-#include "initHooks.h"
-#define WITH_IOC_RUN
-#endif
-
 #if !defined(VERSION_INT) && EPICS_MODIFICATION < 9
 // iocshCmd() is missing in iocsh.h (up to R3.14.8.2)
-// To build with win32-x86, you MUST fix iocsh.h.
+// To build for Windows, you MUST fix iocsh.h.
 // Move the declaration below to iocsh.h and rebuild base.
 extern "C" epicsShareFunc int epicsShareAPI iocshCmd(const char *command);
 #endif
 
 #endif // !EPICS_3_13
 
-#if defined(__vxworks) || defined(vxWorks)
-#include <symLib.h>
-#include <sysSymTbl.h>
-#endif
-
+#include "StreamCore.h"
+#include "StreamError.h"
 #include "devStream.h"
 
 #define Z PRINTF_SIZE_T_PREFIX
 
+#if defined(VERSION_INT) || EPICS_MODIFICATION >= 11
+#define WITH_IOC_RUN
+#endif
+
 // More flags: 0x00FFFFFF used by StreamCore
 const unsigned long InDestructor  = 0x0100000;
 const unsigned long ValueReceived = 0x0200000;
@@ -134,6 +137,7 @@ class Stream : protected StreamCore
 #endif
 
 // StreamCore methods
+    void inputHook(const void* input, size_t size);
     void protocolFinishHook(ProtocolResult);
     void startTimer(unsigned long timeout);
     bool getFieldAddress(const char* fieldname,
@@ -161,17 +165,11 @@ class Stream : protected StreamCore
     Stream(dbCommon* record, const struct link *ioLink,
         streamIoFunction readData, streamIoFunction writeData);
     ~Stream();
-    long parseLink(const struct link *ioLink, char* filename, char* protocol,
-        char* busname, int* addr, char* busparam);
-    long initRecord(const char* filename, const char* protocol,
-        const char* busname, int addr, const char* busparam);
+    long initRecord(char* linkstring);
     bool print(format_t *format, va_list ap);
     ssize_t scan(format_t *format, void* pvalue, size_t maxStringSize);
     bool process();
-
-#ifdef WITH_IOC_RUN
     static void initHook(initHookState);
-#endif
 
 // device support functions
     friend long streamInitRecord(dbCommon *record, const struct link *ioLink,
@@ -196,6 +194,9 @@ public:
 extern "C" { // needed for Windows
 epicsExportAddress(int, streamDebug);
 epicsExportAddress(int, streamError);
+epicsExportAddress(int, streamDebugColored);
+epicsExportAddress(int, streamErrorDeadTime);
+epicsExportAddress(int, streamMsgTimeStamped);
 }
 
 // for subroutine record
@@ -211,7 +212,7 @@ long streamReload(const char* recordname)
     int oldStreamError = streamError;
     streamError = 1;
 
-    if(!pdbbase) {
+    if (!pdbbase) {
         error("No database has been loaded\n");
         streamError = oldStreamError;
         return ERROR;
@@ -223,7 +224,7 @@ long streamReload(const char* recordname)
         if (recordname && recordname[0] &&
 #ifdef EPICS_3_13
             strcmp(stream->name(), recordname) == 0)
-#else        
+#else
             !epicsStrGlobMatch(stream->name(), recordname))
 #endif
             continue;
@@ -328,7 +329,6 @@ epicsExportAddress(drvet, stream);
 #ifdef EPICS_3_13
 void streamEpicsPrintTimestamp(char* buffer, size_t size)
 {
-    size_t tlen;
     char* c;
     TS_STAMP tm;
     tsLocalTime (&tm);
@@ -337,16 +337,17 @@ void streamEpicsPrintTimestamp(char* buffer, size_t size)
     if (c) {
         c[4] = 0;
     }
-    tlen = strlen(buffer);
-    sprintf(buffer+tlen, " %.*s", (int)(size-tlen-2), taskName(0));
+}
+
+static const char* epicsThreadGetNameSelf()
+{
+    return taskName(0);
 }
 #else // !EPICS_3_13
 void streamEpicsPrintTimestamp(char* buffer, size_t size)
 {
-    size_t tlen;
     epicsTime tm = epicsTime::getCurrent();
-    tlen = tm.strftime(buffer, size, "%Y/%m/%d %H:%M:%S.%06f");
-    sprintf(buffer+tlen, " %.*s", (int)(size-tlen-2), epicsThreadGetNameSelf());
+    tm.strftime(buffer, size, "%Y/%m/%d %H:%M:%S.%06f");
 }
 #endif // !EPICS_3_13
 
@@ -355,6 +356,13 @@ report(int interest)
 {
     debug("Stream::report(interest=%d)\n", interest);
     printf("  %s\n", StreamVersion);
+    printf("  (C) 1999 Dirk Zimoch (dirk.zimoch@psi.ch)\n");
+    if (interest == 100)
+    {
+        printf("\n%s", license());
+        return OK;
+    }
+    printf("  Use interest level 100 for license information\n");
 
     printf("  registered bus interfaces:\n");
     StreamBusInterfaceClass interface;
@@ -365,6 +373,7 @@ report(int interest)
     }
 
     if (interest < 1) return OK;
+
     printf("  registered converters:\n");
     StreamFormatConverter* converter;
     int c;
@@ -428,13 +437,21 @@ long streamReportRecord(const char* recordname)
     return OK;
 }
 
+#if defined(_WIN32) && !defined(_WIN64)
+static const char* epicsThreadGetNameSelfWrapper(void)
+{
+    return epicsThreadGetNameSelf();
+}
+#define epicsThreadGetNameSelf epicsThreadGetNameSelfWrapper
+#endif
+
 long Stream::
 drvInit()
 {
     char* path;
     debug("drvStreamInit()\n");
     path = getenv("STREAM_PROTOCOL_PATH");
-#if defined(__vxworks) || defined(vxWorks)
+#if defined(vxWorks)
     // for compatibility reasons look for global symbols
     if (!path)
     {
@@ -451,54 +468,87 @@ drvInit()
 #endif
     if (!path)
         fprintf(stderr,
-            "drvStreamInit: Warning! STREAM_PROTOCOL_PATH not set. "
-            "Defaults to \"%s\"\n", StreamProtocolParser::path);
+            "drvStreamInit: Warning! STREAM_PROTOCOL_PATH not set.\n");
     else
         StreamProtocolParser::path = path;
     debug("StreamProtocolParser::path = %s\n",
         StreamProtocolParser::path);
     StreamPrintTimestampFunction = streamEpicsPrintTimestamp;
-
-#ifdef WITH_IOC_RUN
+    StreamGetThreadNameFunction = epicsThreadGetNameSelf;
     initHookRegister(initHook);
-#endif
 
     return OK;
 }
 
-#ifdef WITH_IOC_RUN
 void Stream::
 initHook(initHookState state)
 {
     Stream* stream;
 
-    if (state == initHookAtIocRun)
-    {
-        debug("Stream::initHook(initHookAtIocRun) interruptAccept=%d\n", interruptAccept);
-
-        static int inIocInit = 1;
-        if (inIocInit)
+    switch (state) {
+#ifdef WITH_IOC_RUN
+        case initHookAtIocRun:
         {
-            // We don't want to run @init twice in iocInit
-            inIocInit = 0;
-            return;
-        }
-
-        for (stream = static_cast<Stream*>(first); stream;
-            stream = static_cast<Stream*>(stream->next))
-        {
-            if (!stream->onInit) continue;
-            debug("Stream::initHook(initHookAtIocRun) Re-inititializing %s\n", stream->name());
-            if (!stream->startProtocol(StartInit))
+            // re-run @init handlers after restart
+            static int inIocInit = 1;
+            if (inIocInit)
             {
-                error("%s: Re-initialization failed.\n",
-                    stream->name());
+                // We don't want to run @init twice in iocInit
+                inIocInit = 0;
+                return;
             }
-            stream->initDone.wait();
+
+            for (stream = static_cast<Stream*>(first); stream;
+                stream = static_cast<Stream*>(stream->next))
+            {
+                if (!stream->onInit) continue;
+                debug("%s: running @init handler\n", stream->name());
+                if (!stream->startProtocol(StartInit))
+                {
+                    error("%s: @init handler failed.\n",
+                        stream->name());
+                }
+                stream->initDone.wait();
+            }
+            break;
         }
+        case initHookAtIocPause:
+        {
+            // stop polling I/O Intr
+            for (stream = static_cast<Stream*>(first); stream;
+                stream = static_cast<Stream*>(stream->next))
+            {
+                if (stream->record->scan == SCAN_IO_EVENT) {
+                    debug("%s: stopping \"I/O Intr\"\n", stream->name());
+                    stream->finishProtocol(Stream::Abort);
+                }
+            }
+            break;
+        }
+        case initHookAfterIocRunning:
+#else
+        case initHookAfterInterruptAccept:
+#endif
+        {
+            // start polling I/O Intr
+            for (stream = static_cast<Stream*>(first); stream;
+                stream = static_cast<Stream*>(stream->next))
+            {
+                if (stream->record->scan == SCAN_IO_EVENT) {
+                    debug("%s: starting \"I/O Intr\"\n", stream->name());
+                    if (!stream->startProtocol(StartAsync))
+                    {
+                        error("%s: Can't start \"I/O Intr\" protocol\n",
+                            stream->name());
+                    }
+                }
+            }
+            break;
+        }
+        default:
+            break;
     }
 }
-#endif
 
 // device support (C interface) //////////////////////////////////////////
 
@@ -534,12 +584,7 @@ long streamInitRecord(dbCommon* record, const struct link *ioLink,
     streamIoFunction readData, streamIoFunction writeData)
 {
     long status;
-    char filename[256];
-    char protocol[256];
-    char busname[256];
-    int addr = -1;
-    char busparam[256];
-    memset(busparam, 0 ,sizeof(busparam));
+    char* linkstring;
 
     debug("streamInitRecord(%s): SEVR=%d\n", record->name, record->sevr);
     Stream* stream = static_cast<Stream*>(record->dpvt);
@@ -556,19 +601,30 @@ long streamInitRecord(dbCommon* record, const struct link *ioLink,
             record->name);
         stream->finishProtocol(Stream::Abort);
     }
-    // scan the i/o link
-    debug("streamInitRecord(%s): parse link \"%s\"\n",
-        record->name, ioLink->value.instio.string);
-    status = stream->parseLink(ioLink, filename, protocol,
-        busname, &addr, busparam);
-    // (re)initialize bus and protocol
-    if (status == 0)
+    if (ioLink->type != INST_IO)
     {
-        debug("streamInitRecord(%s): calling initRecord\n",
-            record->name);
-        status = stream->initRecord(filename, protocol,
-            busname, addr, busparam);
+        error("%s: Wrong I/O link type %s\n", record->name,
+            pamaplinkType[ioLink->type].strvalue);
+        return S_dev_badInitRet;
     }
+    if (!ioLink->value.instio.string[0])
+    {
+        error("%s: Empty I/O link. "
+            "Forgot the leading '@' or confused INP with OUT or link is too long ?\n",
+            record->name);
+        return S_dev_badInitRet;
+    }
+    // (re)initialize bus and protocol
+    linkstring = epicsStrDup(ioLink->value.instio.string);
+    if (!linkstring)
+    {
+        error("%s: Out of memory", record->name);
+        return S_dev_noMemory;
+    }
+    debug("streamInitRecord(%s): calling initRecord\n",
+        record->name);
+    status = stream->initRecord(linkstring);
+    free(linkstring);
     if (status != OK && status != DO_NOT_CONVERT)
     {
         error("%s: Record initialization failed\n", record->name);
@@ -587,7 +643,6 @@ long streamReadWrite(dbCommon *record)
     if (!stream || stream->status == ERROR)
     {
         (void) recGblSetSevr(record, UDF_ALARM, INVALID_ALARM);
-        error("%s: Record not initialised correctly\n", record->name);
         return ERROR;
     }
     return stream->process() ? stream->convert : ERROR;
@@ -607,7 +662,16 @@ long streamGetIointInfo(int cmd, dbCommon *record, IOSCANPVT *ppvt)
     *ppvt = stream->ioscanpvt;
     if (cmd == 0)
     {
-        debug("streamGetIointInfo: starting protocol\n");
+#ifdef WITH_IOC_RUN
+        if (!interruptAccept) {
+            // We will start polling later in initHook.
+            debug("streamGetIointInfo(%s): start later...\n",
+                record->name);
+            return OK;
+        }
+#endif
+        debug("streamGetIointInfo(%s): start protocol\n",
+            record->name);
         // SCAN has been set to "I/O Intr"
         if (!stream->startProtocol(Stream::StartAsync))
         {
@@ -618,6 +682,8 @@ long streamGetIointInfo(int cmd, dbCommon *record, IOSCANPVT *ppvt)
     else
     {
         // SCAN is no longer "I/O Intr"
+        debug("streamGetIointInfo(%s): abort protocol\n",
+            record->name);
         stream->finishProtocol(Stream::Abort);
     }
     return OK;
@@ -699,77 +765,77 @@ Stream::
 }
 
 long Stream::
-parseLink(const struct link *ioLink, char* filename,
-    char* protocol, char* busname, int* addr, char* busparam)
+initRecord(char* linkstring /* modifiable copy */)
 {
-    // parse link parameters: filename protocol busname addr busparam
-    int n1, n2;
-    if (ioLink->type != INST_IO)
-    {
-        error("%s: Wrong I/O link type %s\n", name(),
-            pamaplinkType[ioLink->type].strvalue);
-        return S_dev_badInitRet;
-    }
-    if (0 >= sscanf(ioLink->value.instio.string, "%s%n", filename, &n1))
-    {
-        error("%s: Empty I/O link. "
-            "Forgot the leading '@' or confused INP with OUT or link is too long ?\n",
-            name());
-        return S_dev_badInitRet;
-    }
-    if (0 >= sscanf(ioLink->value.instio.string+n1, " %[^ \t(] %n", protocol, &n2))
-    {
-        error("%s: Missing protocol name\n"
-            "  expect \"@file protocol[(arg1,...)] bus [addr] [params]\"\n"
-            "  in \"@%s\"\n", name(),
-            ioLink->value.instio.string);
-        return S_dev_badInitRet;
-    }
-    n1+=n2;
-    if (ioLink->value.instio.string[n1] == '(')
-    {
-        n2 = 0;
-        sscanf(ioLink->value.instio.string+n1, " %[^)] %n", protocol+strlen(protocol), &n2);
-        n1+=n2;
-        if (ioLink->value.instio.string[n1++] != ')')
-        {
-            error("%s: Missing ')' after protocol arguments '%s'\n"
-                "  expect \"@file protocol(arg1,...) bus [addr] [params]\"\n"
-                "  in \"@%s\"\n", name(), protocol,
-                ioLink->value.instio.string);
-            return S_dev_badInitRet;
-        }
-        strcat(protocol, ")");
-    }
-    if (0 >= sscanf(ioLink->value.instio.string+n1, "%s %i %99c", busname, addr, busparam))
-    {
-        error("%s: Missing bus name\n"
-            "  expect \"@file protocol[(arg1,...)] bus [addr] [params]\"\n"
-            "  in \"@%s\"\n", name(),
-            ioLink->value.instio.string);
-        return S_dev_badInitRet;
-    }    
-    return OK;
-}
+    char *filename;
+    char *protocol;
+    char *busname;
+    char *busparam;
+    long addr = -1;
 
-long Stream::
-initRecord(const char* filename, const char* protocol,
-    const char* busname, int addr, const char* busparam)
-{
-    // It is safe to call this function again with different arguments
+    debug("Stream::initRecord %s: parse link string \"%s\"\n", name(), linkstring);
+
+    while (isspace(*linkstring)) linkstring++;
+    filename = linkstring;
+    while (*linkstring && !isspace(*linkstring)) linkstring++;
+    if (*linkstring) *linkstring++ = 0;
+
+    while (isspace(*linkstring)) linkstring++;
+    protocol = linkstring;
+    while (*linkstring && !isspace(*linkstring) && *linkstring != '(') linkstring++;
+    while (isspace(*linkstring)) linkstring++;
+    if (*linkstring == '(') {
+        int brackets = 0;
+        while(*++linkstring) {
+            if (*linkstring == '(') brackets++;
+            else if (*linkstring == ')') brackets--;
+            else if (*linkstring == '\\' && !*++linkstring) break;
+            else if (isspace(*linkstring) && brackets < 0) break;
+        }
+    }
+    else if (*linkstring) linkstring--;
+    if (*linkstring) *linkstring++ = 0;
+
+    while (isspace(*linkstring)) linkstring++;
+    busname = linkstring;
+    while (*linkstring && !isspace(*linkstring)) linkstring++;
+    if (*linkstring) *linkstring++ = 0;
+
+    if (linkstring) addr = strtol(linkstring, &linkstring, 0);
+    while (isspace(*linkstring)) linkstring++;
+    busparam = linkstring;
+
+    debug("Stream::initRecord %s: filename=\"%s\" protocol=\"%s\" bus=\"%s\" addr=%ld params=\"%s\"\n",
+        name(), filename, protocol, busname, addr, busparam);
+
+    if (!*filename)
+    {
+        error("%s: Missing protocol file name\n", name());
+        return S_dev_badInitRet;
+    }
+    if (!*protocol)
+    {
+        error("%s: Missing protocol name\n", name());
+        return S_dev_badInitRet;
+    }
+    if (!*busname)
+    {
+        error("%s: Missing bus name\n", name());
+        return S_dev_badInitRet;
+    }
 
     // attach to bus interface
-    debug("Stream::initRecord %s: attachBus(%s, %d, \"%s\")\n",
+    debug("Stream::initRecord %s: attachBus(\"%s\", %ld, \"%s\")\n",
         name(), busname, addr, busparam);
     if (!attachBus(busname, addr, busparam))
     {
-        error("%s: Can't attach to bus %s %d\n",
+        error("%s: Can't attach to bus %s %ld\n",
             name(), busname, addr);
         return S_dev_noDevice;
     }
 
     // parse protocol file
-    debug("Stream::initRecord %s: parse(%s, %s)\n",
+    debug("Stream::initRecord %s: parse(\"%s\", \"%s\")\n",
         name(), filename, protocol);
     if (!parse(filename, protocol))
     {
@@ -869,10 +935,14 @@ process()
     debug("Stream::process(%s) start\n", name());
     status = NO_ALARM;
     convert = OK;
+    if (record->tpro)
+    {
+        StreamDebugClass(record->name).print("start protocol '%s'\n", protocolname());
+    }
     if (!startProtocol(record->proc == 2 ? StreamCore::StartInit : StreamCore::StartNormal))
     {
         debug("Stream::process(%s): could not start %sprotocol, status=%s (%d)\n",
-            name(), record->proc == 2 ? "@init " : "", 
+            name(), record->proc == 2 ? "@init " : "",
                 status >= 0 && status < ALARM_NSTATUS ?
                     epicsAlarmConditionStrings[status] : "ERROR",
             status);
@@ -963,11 +1033,26 @@ expire(const epicsTime&)
 
 // StreamCore virtual methods ////////////////////////////////////////////
 
+void Stream::
+inputHook(const void* input, size_t size)
+{
+    if (record->tpro > 1)
+    {
+        StreamDebugClass(record->name).print("received \"%s\"\n",
+            StreamBuffer(input, size).expand()());
+    }
+}
+
 void Stream::
 protocolFinishHook(ProtocolResult result)
 {
     debug("Stream::protocolFinishHook(%s, %s)\n",
         name(), toStr(result));
+    if (record->tpro)
+    {
+        StreamDebugClass(record->name).print("%s. out=\"%s\", in=\"%s\"\n",
+            toStr(result), outputLine.expand()(), inputLine.expand()());
+    }
     switch (result)
     {
         case Success:
@@ -1100,11 +1185,7 @@ getFieldAddress(const char* fieldname, StreamBuffer& address)
 }
 
 static const unsigned char dbfMapping[] =
-#ifdef DBF_INT64
-    {0, DBF_UINT64, DBF_INT64, DBF_ENUM, DBF_DOUBLE, DBF_STRING};
-#else
     {0, DBF_ULONG, DBF_LONG, DBF_ENUM, DBF_DOUBLE, DBF_STRING};
-#endif
 
 bool Stream::
 formatValue(const StreamFormat& format, const void* fieldaddress)

src/StreamError.cc

@@ -1,38 +1,44 @@
-/***************************************************************
-* StreamDevice Support                                         *
-*                                                              *
-* (C) 2005 Dirk Zimoch (dirk.zimoch@psi.ch)                    *
-*                                                              *
-* This is error and debug message handling of StreamDevice.    *
-* Please refer to the HTML files in ../docs/ for a detailed    *
-* documentation.                                               *
-*                                                              *
-* If you do any changes in this file, you are not allowed to   *
-* redistribute it any more. If there is a bug or a missing     *
-* feature, send me an email and/or your patch. If I accept     *
-* your changes, they will go to the next release.              *
-*                                                              *
-* DISCLAIMER: If this software breaks something or harms       *
-* someone, it's your problem.                                  *
-*                                                              *
-***************************************************************/
+/*************************************************************************
+* This is error and debug message handling of StreamDevice.
+* Please see ../docs/ for detailed documentation.
+*
+* (C) 2005 Dirk Zimoch (dirk.zimoch@psi.ch)
+*
+* This file is part of StreamDevice.
+*
+* StreamDevice is free software: You can redistribute it and/or modify
+* it under the terms of the GNU Lesser General Public License as published
+* by the Free Software Foundation, either version 3 of the License, or
+* (at your option) any later version.
+*
+* StreamDevice is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+* GNU Lesser General Public License for more details.
+*
+* You should have received a copy of the GNU Lesser General Public License
+* along with StreamDevice. If not, see https://www.gnu.org/licenses/.
+*************************************************************************/
 
-#include "StreamError.h"
-#ifdef _WIN32
-#include <windows.h>
-#endif
 #include <string.h>
 #include <time.h>
 #include <stdio.h>
 
+#ifdef _WIN32
+#include <windows.h>
+#include <io.h>
+#else
+#include <unistd.h>
+#endif /* _WIN32 */
+
+#include "StreamError.h"
+
 int streamDebug = 0;
 int streamError = 1;
-extern "C" {
-#ifdef _WIN32
-__declspec(dllexport)
-#endif
 FILE *StreamDebugFile = NULL;
-}
+
+/*0: disable timestamps on stream messages (both debug and error)*/
+int streamMsgTimeStamped = 1;
 
 #ifndef va_copy
 #ifdef __va_copy
@@ -48,18 +54,36 @@ FILE *StreamDebugFile = NULL;
 #define ENABLE_VIRTUAL_TERMINAL_PROCESSING 0x0004
 #endif
 
-/* Enable ANSI colors in Windows console */
-static int win_console_init() {
-	DWORD dwMode = 0;
-    HANDLE hCons = GetStdHandle(STD_ERROR_HANDLE);
-	GetConsoleMode(hCons, &dwMode);
-	dwMode |= ENABLE_VIRTUAL_TERMINAL_PROCESSING;
-	SetConsoleMode(hCons, dwMode);
-	return 0;
+/* Enable ANSI color support in Windows console */
+static bool win_console_init() {
+    HANDLE hCons[] = { GetStdHandle(STD_ERROR_HANDLE),
+                       GetStdHandle(STD_OUTPUT_HANDLE) };
+    for(int i=0; i < sizeof(hCons) / sizeof(HANDLE); ++i)
+    {
+        DWORD dwMode = 0;
+        if (hCons[i] == NULL ||
+            hCons[i] == INVALID_HANDLE_VALUE ||
+            !GetConsoleMode(hCons[i], &dwMode))
+        {
+            return false;
+        }
+        dwMode |= ENABLE_VIRTUAL_TERMINAL_PROCESSING;
+        if (!SetConsoleMode(hCons[i], dwMode))
+        {
+            return false;
+        }
+    }
+    return true;
 }
-static int s = win_console_init();
 
-#endif
+/* do isatty() call second as always want to run win_console_init() */
+int streamDebugColored = win_console_init() && _isatty(_fileno(stderr));
+
+#else
+
+int streamDebugColored = isatty(fileno(stderr));
+
+#endif /* _WIN32 */
 
 /* You can globally change the printTimestamp function
    by setting the StreamPrintTimestampFunction variable
@@ -75,6 +99,7 @@ static void printTimestamp(char* buffer, size_t size)
 }
 
 void (*StreamPrintTimestampFunction)(char* buffer, size_t size) = printTimestamp;
+const char* (*StreamGetThreadNameFunction)(void) = NULL;
 
 void StreamError(const char* fmt, ...)
 {
@@ -94,44 +119,88 @@ void StreamError(int line, const char* file, const char* fmt, ...)
 
 void StreamVError(int line, const char* file, const char* fmt, va_list args)
 {
-    char timestamp[40];
     if (!(streamError || streamDebug)) return; // Error logging disabled
-    StreamPrintTimestampFunction(timestamp, 40);
+    char timestamp[40];
+    const char *threadname = NULL;
+    int timeStamped = streamMsgTimeStamped;
+    if (timeStamped)
+    {
+        StreamPrintTimestampFunction(timestamp, sizeof(timestamp));
+    }
+    if (StreamGetThreadNameFunction)
+    {
+        threadname = StreamGetThreadNameFunction();
+    }
 #ifdef va_copy
     if (StreamDebugFile)
     {
         va_list args2;
         va_copy(args2, args);
-        fprintf(StreamDebugFile, "%s ", timestamp);
+        if (timeStamped)
+        {
+            fprintf(StreamDebugFile, "%s ", timestamp);
+        }
+        if (threadname)
+        {
+            fprintf(StreamDebugFile, "%s ", threadname);
+        }
         vfprintf(StreamDebugFile, fmt, args2);
         fflush(StreamDebugFile);
         va_end(args2);
     }
 #endif
-    fprintf(stderr, "\033[31;1m");
-    fprintf(stderr, "%s ", timestamp);
+    fprintf(stderr, "%s", ansiEscape(ANSI_RED_BOLD));
+    if (timeStamped)
+    {
+        fprintf(stderr, "%s ", timestamp);
+    }
+    if (threadname)
+    {
+        fprintf(stderr, "%s ", threadname);
+    }
     if (file)
     {
         fprintf(stderr, "%s line %d: ", file, line);
     }
     vfprintf(stderr, fmt, args);
-    fprintf(stderr, "\033[0m");
+    fprintf(stderr, "%s", ansiEscape(ANSI_RESET));
 }
 
 int StreamDebugClass::
 print(const char* fmt, ...)
 {
     va_list args;
-    char timestamp[40];
-    StreamPrintTimestampFunction(timestamp, 40);
     va_start(args, fmt);
-    const char* f = strrchr(file, '/');
-    if (f) f++; else f = file;
     FILE* fp = StreamDebugFile ? StreamDebugFile : stderr;
-    fprintf(fp, "%s ", timestamp);
-    fprintf(fp, "%s:%d: ", f, line);
+    if (streamMsgTimeStamped)
+    {
+        char timestamp[40];
+        StreamPrintTimestampFunction(timestamp, sizeof(timestamp));
+        fprintf(fp, "%s ", timestamp);
+    }
+    if (StreamGetThreadNameFunction)
+    {
+        fprintf(fp, "%s ", StreamGetThreadNameFunction());
+    }
+    if (file) {
+        const char* f = strrchr(file, '/');
+        if (f) f++; else f = file;
+        fprintf(fp, "%s:", f);
+        if (line) fprintf(fp, "%d:", line);
+        fprintf(fp, " ");
+    }
     vfprintf(fp, fmt, args);
     fflush(fp);
     va_end(args);
     return 1;
 }
+
+/**
+ * Return an ANSI escape code if coloured debug output is enabled
+ */
+const char* ansiEscape(AnsiMode mode)
+{
+    static const char* AnsiEscapes[] = { "\033[7m", "\033[27m", "\033[47m",
+                                         "\033[0m", "\033[31;1m" };
+    return streamDebugColored ? AnsiEscapes[mode] : "";
+}

src/StreamError.h

@@ -1,21 +1,24 @@
-/***************************************************************
-* StreamDevice Support                                         *
-*                                                              *
-* (C) 2005 Dirk Zimoch (dirk.zimoch@psi.ch)                    *
-*                                                              *
-* This is error and debug message handling of StreamDevice.    *
-* Please refer to the HTML files in ../docs/ for a detailed    *
-* documentation.                                               *
-*                                                              *
-* If you do any changes in this file, you are not allowed to   *
-* redistribute it any more. If there is a bug or a missing     *
-* feature, send me an email and/or your patch. If I accept     *
-* your changes, they will go to the next release.              *
-*                                                              *
-* DISCLAIMER: If this software breaks something or harms       *
-* someone, it's your problem.                                  *
-*                                                              *
-***************************************************************/
+/*************************************************************************
+* This is error and debug message handling of StreamDevice.
+* Please see ../docs/ for detailed documentation.
+*
+* (C) 2005 Dirk Zimoch (dirk.zimoch@psi.ch)
+*
+* This file is part of StreamDevice.
+*
+* StreamDevice is free software: You can redistribute it and/or modify
+* it under the terms of the GNU Lesser General Public License as published
+* by the Free Software Foundation, either version 3 of the License, or
+* (at your option) any later version.
+*
+* StreamDevice is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+* GNU Lesser General Public License for more details.
+*
+* You should have received a copy of the GNU Lesser General Public License
+* along with StreamDevice. If not, see https://www.gnu.org/licenses/.
+*************************************************************************/
 
 #ifndef StreamError_h
 #define StreamError_h
@@ -29,7 +32,10 @@
 
 extern int streamDebug;
 extern int streamError;
+extern int streamDebugColored;
+extern int streamMsgTimeStamped;
 extern void (*StreamPrintTimestampFunction)(char* buffer, size_t size);
+extern const char* (*StreamGetThreadNameFunction)(void);
 
 void StreamError(int line, const char* file, const char* fmt, ...)
 __attribute__((__format__(__printf__,3,4)));
@@ -50,17 +56,21 @@ class StreamDebugClass
     const char* file;
     int line;
 public:
-    StreamDebugClass(const char* file, int line) :
+    StreamDebugClass(const char* file = NULL, int line = 0) :
         file(file), line(line) {}
     int print(const char* fmt, ...)
         __attribute__((__format__(__printf__,2,3)));
 };
 
-inline StreamDebugClass
-StreamDebugObject(const char* file, int line)
-{ return StreamDebugClass(file, line); }
-
 #define error StreamError
-#define debug (!streamDebug)?0:StreamDebugObject(__FILE__,__LINE__).print
+#define debug (!streamDebug)?0:StreamDebugClass(__FILE__,__LINE__).print
+#define debug2 (streamDebug<2)?0:StreamDebugClass(__FILE__,__LINE__).print
+
+/*
+ * ANSI escape sequences for terminal output
+ */
+enum AnsiMode { ANSI_REVERSE_VIDEO, ANSI_NOT_REVERSE_VIDEO, ANSI_BG_WHITE,
+                ANSI_RESET, ANSI_RED_BOLD };
+extern const char* ansiEscape(AnsiMode mode);
 
 #endif

src/StreamFormat.h

@@ -1,23 +1,25 @@
-/***************************************************************
-* StreamDevice Support                                         *
-*                                                              *
-* (C) 1999 Dirk Zimoch (zimoch@delta.uni-dortmund.de)          *
-* (C) 2005 Dirk Zimoch (dirk.zimoch@psi.ch)                    *
-*                                                              *
-* This header defines the format stucture used to interface    *
-* format converters and record interfaces to StreamDevice      *
-* Please refer to the HTML files in ../docs/ for a detailed    *
-* documentation.                                               *
-*                                                              *
-* If you do any changes in this file, you are not allowed to   *
-* redistribute it any more. If there is a bug or a missing     *
-* feature, send me an email and/or your patch. If I accept     *
-* your changes, they will go to the next release.              *
-*                                                              *
-* DISCLAIMER: If this software breaks something or harms       *
-* someone, it's your problem.                                  *
-*                                                              *
-***************************************************************/
+/*************************************************************************
+* This header defines the format stucture used to interface
+* format converters and EPICS records to StreamDevice
+* Please see ../docs/ for detailed documentation.
+*
+* (C) 1999,2005 Dirk Zimoch (dirk.zimoch@psi.ch)
+*
+* This file is part of StreamDevice.
+*
+* StreamDevice is free software: You can redistribute it and/or modify
+* it under the terms of the GNU Lesser General Public License as published
+* by the Free Software Foundation, either version 3 of the License, or
+* (at your option) any later version.
+*
+* StreamDevice is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+* GNU Lesser General Public License for more details.
+*
+* You should have received a copy of the GNU Lesser General Public License
+* along with StreamDevice. If not, see https://www.gnu.org/licenses/.
+*************************************************************************/
 
 #ifndef StreamFormat_h
 #define StreamFormat_h
@@ -40,7 +42,8 @@ typedef enum {
     enum_format,
     double_format,
     string_format,
-    pseudo_format
+    pseudo_format,
+    needs_original_format
 } StreamFormatType;
 
 extern const char* StreamFormatTypeStr[];

src/StreamFormatConverter.cc

@@ -1,27 +1,30 @@
-/***************************************************************
-* StreamDevice Support                                         *
-*                                                              *
-* (C) 1999 Dirk Zimoch (zimoch@delta.uni-dortmund.de)          *
-* (C) 2005 Dirk Zimoch (dirk.zimoch@psi.ch)                    *
-*                                                              *
-* This is the format converter base and includes the standard  *
-* format converters for StreamDevice.                          *
-* Please refer to the HTML files in ../docs/ for a detailed    *
-* documentation.                                               *
-*                                                              *
-* If you do any changes in this file, you are not allowed to   *
-* redistribute it any more. If there is a bug or a missing     *
-* feature, send me an email and/or your patch. If I accept     *
-* your changes, they will go to the next release.              *
-*                                                              *
-* DISCLAIMER: If this software breaks something or harms       *
-* someone, it's your problem.                                  *
-*                                                              *
-***************************************************************/
+/*************************************************************************
+* This is the format converter base for StreamDevice.
+* It includes the standard converters as known from printf/scanf.
+* Please see ../docs/ for detailed documentation.
+*
+* (C) 1999,2005 Dirk Zimoch (dirk.zimoch@psi.ch)
+*
+* This file is part of StreamDevice.
+*
+* StreamDevice is free software: You can redistribute it and/or modify
+* it under the terms of the GNU Lesser General Public License as published
+* by the Free Software Foundation, either version 3 of the License, or
+* (at your option) any later version.
+*
+* StreamDevice is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+* GNU Lesser General Public License for more details.
+*
+* You should have received a copy of the GNU Lesser General Public License
+* along with StreamDevice. If not, see https://www.gnu.org/licenses/.
+*************************************************************************/
 
 #include <stdlib.h>
 #include <ctype.h>
 #include <limits.h>
+
 #include "StreamFormatConverter.h"
 #include "StreamError.h"
 
@@ -146,8 +149,6 @@ parseFormat(const char*& source, FormatType formatType, StreamFormat& streamForm
         error("Missing converter character\n");
         return false;
     }
-    debug("StreamFormatConverter::parseFormat: converter='%c'\n",
-        streamFormat.conv);
     StreamFormatConverter* converter;
     converter = StreamFormatConverter::find(streamFormat.conv);
     if (!converter)

src/StreamFormatConverter.h

@@ -1,21 +1,24 @@
-/***************************************************************
-* StreamDevice Support                                         *
-*                                                              *
-* (C) 2005 Dirk Zimoch (dirk.zimoch@psi.ch)                    *
-*                                                              *
-* This is the format converter header of StreamDevice.         *
-* Please refer to the HTML files in ../docs/ for a detailed    *
-* documentation.                                               *
-*                                                              *
-* If you do any changes in this file, you are not allowed to   *
-* redistribute it any more. If there is a bug or a missing     *
-* feature, send me an email and/or your patch. If I accept     *
-* your changes, they will go to the next release.              *
-*                                                              *
-* DISCLAIMER: If this software breaks something or harms       *
-* someone, it's your problem.                                  *
-*                                                              *
-***************************************************************/
+/*************************************************************************
+* This is the format converter header of StreamDevice.
+* Please see ../docs/ for detailed documentation.
+*
+* (C) 2005 Dirk Zimoch (dirk.zimoch@psi.ch)
+*
+* This file is part of StreamDevice.
+*
+* StreamDevice is free software: You can redistribute it and/or modify
+* it under the terms of the GNU Lesser General Public License as published
+* by the Free Software Foundation, either version 3 of the License, or
+* (at your option) any later version.
+*
+* StreamDevice is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+* GNU Lesser General Public License for more details.
+*
+* You should have received a copy of the GNU Lesser General Public License
+* along with StreamDevice. If not, see https://www.gnu.org/licenses/.
+*************************************************************************/
 
 #ifndef StreamFormatConverter_h
 #define StreamFormatConverter_h

src/StreamProtocol.cc

@@ -1,26 +1,29 @@
-/***************************************************************
-* StreamDevice Support                                         *
-*                                                              *
-* (C) 1999 Dirk Zimoch (zimoch@delta.uni-dortmund.de)          *
-* (C) 2005 Dirk Zimoch (dirk.zimoch@psi.ch)                    *
-*                                                              *
-* This is the protocol parser of StreamDevice.                 *
-* Please refer to the HTML files in ../docs/ for a detailed    *
-* documentation.                                               *
-*                                                              *
-* If you do any changes in this file, you are not allowed to   *
-* redistribute it any more. If there is a bug or a missing     *
-* feature, send me an email and/or your patch. If I accept     *
-* your changes, they will go to the next release.              *
-*                                                              *
-* DISCLAIMER: If this software breaks something or harms       *
-* someone, it's your problem.                                  *
-*                                                              *
-***************************************************************/
+/*************************************************************************
+* This is the protocol parser of StreamDevice.
+* Please see ../docs/ for detailed documentation.
+*
+* (C) 1999,2005 Dirk Zimoch (dirk.zimoch@psi.ch)
+*
+* This file is part of StreamDevice.
+*
+* StreamDevice is free software: You can redistribute it and/or modify
+* it under the terms of the GNU Lesser General Public License as published
+* by the Free Software Foundation, either version 3 of the License, or
+* (at your option) any later version.
+*
+* StreamDevice is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+* GNU Lesser General Public License for more details.
+*
+* You should have received a copy of the GNU Lesser General Public License
+* along with StreamDevice. If not, see https://www.gnu.org/licenses/.
+*************************************************************************/
 
 #include <ctype.h>
 #include <stdlib.h>
 #include <stdarg.h>
+
 #include "StreamProtocol.h"
 #include "StreamFormatConverter.h"
 #include "StreamError.h"
@@ -50,7 +53,7 @@ class StreamProtocolParser::Protocol::Variable
 // StreamProtocolParser
 
 StreamProtocolParser* StreamProtocolParser::parsers = NULL;
-const char* StreamProtocolParser::path = ".";
+const char* StreamProtocolParser::path = NULL;
 static const char* specialChars = " ,;{}=()$'\"+-*/";
 
 // Client destructor
@@ -154,52 +157,70 @@ this after protocol arguments have been replaced.
 StreamProtocolParser* StreamProtocolParser::
 readFile(const char* filename)
 {
-    FILE* file;
-#ifdef windows
-    const char pathseparator = ';';
-    const char dirseparator = '\\';
-#else
-    const char pathseparator = ':';
-    const char dirseparator = '/';
-#endif
+    FILE* file = NULL;
     StreamProtocolParser* parser;
     const char *p;
-    const char *s;
     size_t n;
     StreamBuffer dir;
 
-    // look for filename in every dir in search path
-    for (p = path; *p; p += n)
-    {
-        dir.clear();
-        // get next dir from search path (avoiding strtok, strsep, strcspn)
-        s = strchr(p, pathseparator);
-        if (s) n = s - p;
-        else n = strlen(p);
-        dir.append(p, n);
-        if (n && p[n-1] != dirseparator) dir.append(dirseparator);
-        if (s) p++;
-        // append filename
-        dir.append(filename);
-        // try to read the file
-        debug("StreamProtocolParser::readFile: try '%s'\n", dir());
-        file = fopen(dir(), "r");
-        if (file)
+    // no path or absolute file name
+    if (!path || filename[0] == '/'
+#ifdef _WIN32
+        || filename[0] == '\\' || (isalpha(filename[0]) && filename[1] == ':')
+#endif
+        ) {
+        // absolute file name
+        file = fopen(filename, "r");
+        if (file) {
+            debug("StreamProtocolParser::readFile: found '%s'\n", filename);
+        } else {
+            error("Can't find readable file '%s'\n", filename);
+            return NULL;
+        }
+    } else {
+        // look for filename in every dir in search path
+        for (p = path; *p; p += n)
         {
-            // file found; create a parser to read it
-            parser = new StreamProtocolParser(file, filename);
-            fclose(file);
-            if (!parser->valid) return NULL;
-//             printf(
-// "/---------------------------------------------------------------------\\\n");
-//             parser->report();
-//             printf(
-// "\\---------------------------------------------------------------------/\n");
-            return parser;
+            dir.clear();
+            // allow ':' or ';' for OS independence
+            // we need to be careful with drive letters though
+            n = strcspn(p, ":;");
+#ifdef _WIN32
+            if (n == 1 && p[1] == ':' && isalpha(p[0]))
+            {
+                // driver letter
+                n = 2 + strcspn(p+2, ":;");
+            }
+#endif
+            dir.append(p, n);
+            // append / after everything except empty path [or drive letter]
+            // Windows is fine with / as well
+            if (n) {
+#ifdef _WIN32
+                if (n != 2 || p[1] != ':' || !isalpha(p[0]))
+#endif
+                dir.append('/');
+            }
+            if (p[n]) n++; // skip the path separator
+            dir.append(filename);
+            // try to read the file
+            debug("StreamProtocolParser::readFile: try '%s'\n", dir());
+            file = fopen(dir(), "r");
+            if (file) {
+                debug("StreamProtocolParser::readFile: found '%s'\n", dir());
+                break;
+            }
+        }
+        if (!file) {
+            error("Can't find readable file '%s' in '%s'\n", filename, path);
+            return NULL;
         }
     }
-    error("Can't find readable file '%s' in '%s'\n", filename, path);
-    return NULL;
+    // file found; create a parser to read it
+    parser = new StreamProtocolParser(file, filename);
+    fclose(file);
+    if (!parser->valid) return NULL;
+    return parser;
 }
 
 /*
@@ -260,7 +281,7 @@ parseProtocol(Protocol& protocol, StreamBuffer* commands)
         startline = line;
         if (!readToken(token, " ,;{}=()$'\"", isGlobalContext(commands)))
             return false;
-        debug("StreamProtocolParser::parseProtocol:"
+        debug2("StreamProtocolParser::parseProtocol:"
             " token='%s'\n", token.expand()());
 
         if (token[0] == 0)
@@ -286,7 +307,7 @@ parseProtocol(Protocol& protocol, StreamBuffer* commands)
         }
         if (token[0] == '{')
         {
-            error(line, filename(), "Expect %s name before '%c'\n", 
+            error(line, filename(), "Expect %s name before '%c'\n",
                 isGlobalContext(commands) ? "protocol" : "handler",
                 token[0]);
             return false;
@@ -411,7 +432,7 @@ parseProtocol(Protocol& protocol, StreamBuffer* commands)
             error(line, filename(), "after command '%s'\n", token());
             return false;
         }
-        debug("parseProtocol: command '%s'\n", (*commands).expand()());
+        debug2("parseProtocol: command '%s'\n", (*commands).expand()());
         commands->append('\0'); // terminate value with null byte
     }
 }
@@ -466,7 +487,7 @@ Each time newline is read, line is incremented.
     if (c == '$')
     {
         // a variable
-        debug("StreamProtocolParser::readToken: Variable\n");
+        debug2("StreamProtocolParser::readToken: Variable\n");
         buffer.append(c);
         if (quote) buffer.append('"'); // mark as quoted variable
         c = getc(file);
@@ -483,7 +504,7 @@ Each time newline is read, line is incremented.
             quote = false;
             // variable like ${xyz}
             if (!readToken(buffer, "{}=;")) return false;
-            debug("StreamProtocolParser::readToken: Variable '%s' in {}\n",
+            debug2("StreamProtocolParser::readToken: Variable '%s' in {}\n",
                 buffer(token));
             c = getc(file);
             if (c != '}')
@@ -509,7 +530,7 @@ Each time newline is read, line is incremented.
     }
     else if (quote || c == '\'' || c == '"')
     {
-        debug("StreamProtocolParser::readToken: Quoted string\n");
+        debug2("StreamProtocolParser::readToken: Quoted string\n");
         // quoted string
         if (!quote)
         {
@@ -568,13 +589,13 @@ Each time newline is read, line is incremented.
     }
     else if (strchr (specialchars, c))
     {
-        debug("StreamProtocolParser::readToken: Special '%c'\n", c);
+        debug2("StreamProtocolParser::readToken: Special '%c'\n", c);
         // a single character
         buffer.append(c);
         return true;
     }
     // a word or (variable name)
-    debug("StreamProtocolParser::readToken: word\n");
+    debug2("StreamProtocolParser::readToken: word\n");
     while (1)
     {
         buffer.append(tolower(c));
@@ -585,7 +606,7 @@ Each time newline is read, line is incremented.
             break;
         }
     }
-    debug("StreamProtocolParser::readToken: word='%s' c='%c'\n",
+    debug2("StreamProtocolParser::readToken: word='%s' c='%c'\n",
         buffer(token), c);
     buffer.append('\0').append(&l, sizeof(l)); // append line number
     return true;
@@ -613,7 +634,7 @@ parseValue(StreamBuffer& buffer, bool lazy)
     {
         token = buffer.length(); // start of next token
         if (!readToken(buffer)) return false;
-        debug("StreamProtocolParser::parseValue:%d: %s\n",
+        debug2("StreamProtocolParser::parseValue:%d: %s\n",
             line, buffer.expand(token)());
         c = buffer[token];
         if (c == '$') // a variable
@@ -773,7 +794,7 @@ Protocol(const Protocol& p, StreamBuffer& name, int _line)
     parameter[0] = protocolname();
     for (i = 0; i < 9; i++)
     {
-        debug("StreamProtocolParser::Protocol::Protocol $%d=\"%s\"\n",
+        if (i) debug("StreamProtocolParser::Protocol::Protocol $%d=\"%s\"\n",
             i, parameter[i]);
         nextparameter = parameter[i] + strlen(parameter[i]) + 1;
         if (nextparameter > name.length() + parameter[0]) break;
@@ -926,7 +947,7 @@ getCommands(const char* handlername, StreamBuffer& code, Client* client)
     if (!pvar) return true;
     if (!pvar->value) return true;
     const char* source = pvar->value();
-    debug("StreamProtocolParser::Protocol::getCommands"
+    debug2("StreamProtocolParser::Protocol::getCommands"
         "(handlername=\"%s\", client=\"%s\"): source=%s\n",
             handlername, client->name(), pvar->value.expand()());
     if (!compileCommands(code, source, client))
@@ -943,15 +964,15 @@ getCommands(const char* handlername, StreamBuffer& code, Client* client)
             "in protocol '%s'\n", protocolname());
         return false;
     }
-    debug("commands %s: %s\n", handlername, pvar->value.expand()());
-    debug("compiled to: %s\n", code.expand()());
+    debug2("commands %s: %s\n", handlername, pvar->value.expand()());
+    debug2("compiled to: %s\n", code.expand()());
     return true;
 }
 
 bool StreamProtocolParser::Protocol::
 replaceVariable(StreamBuffer& buffer, const char* varname)
 {
-    debug("StreamProtocolParser::Protocol::replaceVariable %s\n", varname);
+    debug2("StreamProtocolParser::Protocol::replaceVariable %s\n", varname);
     bool quoted = false;
     if (*++varname == '"')
     {
@@ -1031,16 +1052,16 @@ compileNumber(unsigned long& number, const char*& source, unsigned long max)
     unsigned long n;
     StreamBuffer buffer;
 
-    debug("StreamProtocolParser::Protocol::compileNumber source=\"%s\"\n",
+    debug2("StreamProtocolParser::Protocol::compileNumber source=\"%s\"\n",
         source);
     while (*source == '$' || (*source >= '0' && *source <= '9'))
     {
-        debug("StreamProtocolParser::Protocol::compileNumber *source=%u source=\"%s\"\n",
+        debug2("StreamProtocolParser::Protocol::compileNumber *source=%u source=\"%s\"\n",
             *source, source);
         if (*source == '$')
         {
-            if(!replaceVariable(buffer, source)) return false;
-            debug("buffer=%s\n", buffer.expand()());
+            if (!replaceVariable(buffer, source)) return false;
+            debug2("buffer=%s\n", buffer.expand()());
             buffer.truncate(-1-(int)sizeof(int));
         }
         else
@@ -1075,7 +1096,7 @@ compileNumber(unsigned long& number, const char*& source, unsigned long max)
         return false;
     }
     number = n;
-    debug("StreamProtocolParser::Protocol::compileNumber %s = %ld\n",
+    debug2("StreamProtocolParser::Protocol::compileNumber %s = %ld\n",
         buffer(), n);
     return true;
 }
@@ -1093,7 +1114,7 @@ compileString(StreamBuffer& buffer, const char*& source,
     size_t formatpos = buffer.length();
     line = getLineNumber(source);
 
-    debug("StreamProtocolParser::Protocol::compileString "
+    debug2("StreamProtocolParser::Protocol::compileString "
         "line %d source=\"%s\" formatType=%s quoted=%i recursionDepth=%d\n",
         line, source, ::toStr(formatType), quoted, recursionDepth);
 
@@ -1108,7 +1129,7 @@ compileString(StreamBuffer& buffer, const char*& source,
         // this is step 2: replacing the formats
         if (!*source || (newline = getLineNumber(source)) != line)
         {
-            debug("StreamProtocolParser::Protocol::compileString line %i: %s\n", line, buffer.expand()());
+            debug2("StreamProtocolParser::Protocol::compileString line %i: %s\n", line, buffer.expand()());
             // compile all formats in this line
             // We do this here after all variables in this line
             // have been replaced and after string has been coded.
@@ -1131,7 +1152,7 @@ compileString(StreamBuffer& buffer, const char*& source,
                             formatpos+=2;
                             continue;
                         }
-                        debug("StreamProtocolParser::Protocol::compileString "
+                        debug2("StreamProtocolParser::Protocol::compileString "
                             "format=\"%s\"\n", buffer.expand(formatpos)());
                         nformats++;
                         formatbuffer.clear();
@@ -1148,14 +1169,14 @@ compileString(StreamBuffer& buffer, const char*& source,
                         }
                         size_t formatlen = p - buffer(formatpos);
                         buffer.replace(formatpos, formatlen, formatbuffer);
-                        debug("StreamProtocolParser::Protocol::compileString "
+                        debug2("StreamProtocolParser::Protocol::compileString "
                             "replaced by: \"%s\"\n", buffer.expand(formatpos)());
                         formatpos += formatbuffer.length();
                         continue;
                     }
                     formatpos ++;
                 }
-                debug("StreamProtocolParser::Protocol::compileString "
+                debug2("StreamProtocolParser::Protocol::compileString "
                     "%d formats found in line %d\n", nformats, line);
             }
             if (!*source) break;
@@ -1398,7 +1419,7 @@ compileString(StreamBuffer& buffer, const char*& source,
             "Unexpected '%s' in string\n", source);
         return false;
     }
-    debug("StreamProtocolParser::Protocol::compileString buffer=%s\n", buffer.expand()());
+    debug2("StreamProtocolParser::Protocol::compileString buffer=%s\n", buffer.expand()());
     return true;
 }
 
@@ -1444,7 +1465,7 @@ compileFormat(StreamBuffer& buffer, const char*& formatstr,
         // add fieldname for debug purpose
         fieldname=buffer.length();
         buffer.append(source, fieldnameEnd - source).append(eos);
-        debug("StreamProtocolParser::Protocol::compileFormat: fieldname='%s'\n",
+        debug2("StreamProtocolParser::Protocol::compileFormat: fieldname='%s'\n",
             buffer(fieldname));
         StreamBuffer fieldAddress;
         if (!client->getFieldAddress(buffer(fieldname), fieldAddress))
@@ -1505,14 +1526,14 @@ compileFormat(StreamBuffer& buffer, const char*& formatstr,
     // add formatstr for debug purpose
     buffer.append(formatstart, source-formatstart).append(eos);
 
-    debug("StreamProtocolParser::Protocol::compileFormat: formatstring=\"%s\"\n",
+    debug2("StreamProtocolParser::Protocol::compileFormat: formatstring=\"%s\"\n",
         StreamBuffer(formatstart, source-formatstart).expand()());
 
     // add streamFormat structure and info
     buffer.append(&streamFormat, sizeof(streamFormat));
     buffer.append(infoString);
 
-    debug("StreamProtocolParser::Protocol::compileFormat: format.type=%s, "
+    debug2("StreamProtocolParser::Protocol::compileFormat: format.type=%s, "
         "infolen=%ld infostring=\"%s\"\n",
         StreamFormatTypeStr[streamFormat.type],
         streamFormat.infolen, infoString.expand()());

src/StreamProtocol.h

@@ -1,22 +1,24 @@
-/***************************************************************
-* StreamDevice Support                                         *
-*                                                              *
-* (C) 1999 Dirk Zimoch (zimoch@delta.uni-dortmund.de)          *
-* (C) 2005 Dirk Zimoch (dirk.zimoch@psi.ch)                    *
-*                                                              *
-* This is the protocol parser of StreamDevice.                 *
-* Please refer to the HTML files in ../docs/ for a detailed    *
-* documentation.                                               *
-*                                                              *
-* If you do any changes in this file, you are not allowed to   *
-* redistribute it any more. If there is a bug or a missing     *
-* feature, send me an email and/or your patch. If I accept     *
-* your changes, they will go to the next release.              *
-*                                                              *
-* DISCLAIMER: If this software breaks something or harms       *
-* someone, it's your problem.                                  *
-*                                                              *
-***************************************************************/
+/*************************************************************************
+* This is the protocol parser of StreamDevice.
+* Please see ../docs/ for detailed documentation.
+*
+* (C) 1999,2005 Dirk Zimoch (dirk.zimoch@psi.ch)
+*
+* This file is part of StreamDevice.
+*
+* StreamDevice is free software: You can redistribute it and/or modify
+* it under the terms of the GNU Lesser General Public License as published
+* by the Free Software Foundation, either version 3 of the License, or
+* (at your option) any later version.
+*
+* StreamDevice is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+* GNU Lesser General Public License for more details.
+*
+* You should have received a copy of the GNU Lesser General Public License
+* along with StreamDevice. If not, see https://www.gnu.org/licenses/.
+*************************************************************************/
 
 #ifndef StreamProtocol_h
 #define StreamProtocol_h

src/StreamVersion.c

@@ -1,29 +1,41 @@
-/***************************************************************
-* StreamDevice Support                                         *
-*                                                              *
-* (C) 1999 Dirk Zimoch (zimoch@delta.uni-dortmund.de)          *
-* (C) 2005 Dirk Zimoch (dirk.zimoch@psi.ch)                    *
-*                                                              *
-* This provides a version string for StreamDevice.             *
-* Please refer to the HTML files in ../docs/ for a detailed    *
-* documentation.                                               *
-*                                                              *
-* If you do any changes in this file, you are not allowed to   *
-* redistribute it any more. If there is a bug or a missing     *
-* feature, send me an email and/or your patch. If I accept     *
-* your changes, they will go to the next release.              *
-*                                                              *
-* DISCLAIMER: If this software breaks something or harms       *
-* someone, it's your problem.                                  *
-*                                                              *
-***************************************************************/
+/*************************************************************************
+* This file provides a version string for StreamDevice.
+* Please see ../docs/ for detailed documentation.
+*
+* (C) 1999,2005 Dirk Zimoch (dirk.zimoch@psi.ch)
+*
+* This file is part of StreamDevice.
+*
+* StreamDevice is free software: You can redistribute it and/or modify
+* it under the terms of the GNU Lesser General Public License as published
+* by the Free Software Foundation, either version 3 of the License, or
+* (at your option) any later version.
+*
+* StreamDevice is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+* GNU Lesser General Public License for more details.
+*
+* You should have received a copy of the GNU Lesser General Public License
+* along with StreamDevice. If not, see https://www.gnu.org/licenses/.
+*************************************************************************/
 
-#include "devStream.h"
+#include "StreamVersion.h"
 
 #define STR2(x) #x
 #define STR(x) STR2(x)
 const char StreamVersion [] =
-    "StreamDevice " STR(STREAM_MAJOR)
+    "StreamDevice"
+#ifdef STREAM_MAJOR
+    " " STR(STREAM_MAJOR)
     "." STR(STREAM_MINOR)
     "." STR(STREAM_PATCHLEVEL)
-    " built " __DATE__ " " __TIME__;
+    STREAM_DEV
+#endif
+#ifdef STREAM_COMMIT_DATE
+    " " STREAM_COMMIT_DATE
+#endif
+#ifdef STREAM_COMMIT_HASH
+    "\n  commit: " STREAM_COMMIT_HASH
+#endif
+;

src/TimestampConverter.cc

@@ -1,31 +1,33 @@
-/***************************************************************
-* StreamDevice Support                                         *
-*                                                              *
-* (C) 1999 Dirk Zimoch (zimoch@delta.uni-dortmund.de)          *
-* (C) 2010 Dirk Zimoch (dirk.zimoch@psi.ch)                    *
-*                                                              *
-* This is the time stamp converter of StreamDevice.            *
-* Please refer to the HTML files in ../docs/ for a detailed    *
-* documentation.                                               *
-*                                                              *
-* If you do any changes in this file, you are not allowed to   *
-* redistribute it any more. If there is a bug or a missing     *
-* feature, send me an email and/or your patch. If I accept     *
-* your changes, they will go to the next release.              *
-*                                                              *
-* DISCLAIMER: If this software breaks something or harms       *
-* someone, it's your problem.                                  *
-*                                                              *
-***************************************************************/
-
-#include "StreamFormatConverter.h"
-#include "StreamError.h"
+/*************************************************************************
+* This is the time stamp converter of StreamDevice.
+* Please see ../docs/ for detailed documentation.
+*
+* (C) 1999,2010 Dirk Zimoch (dirk.zimoch@psi.ch)
+*
+* This file is part of StreamDevice.
+*
+* StreamDevice is free software: You can redistribute it and/or modify
+* it under the terms of the GNU Lesser General Public License as published
+* by the Free Software Foundation, either version 3 of the License, or
+* (at your option) any later version.
+*
+* StreamDevice is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+* GNU Lesser General Public License for more details.
+*
+* You should have received a copy of the GNU Lesser General Public License
+* along with StreamDevice. If not, see https://www.gnu.org/licenses/.
+*************************************************************************/
 
 #include <time.h>
 #include <ctype.h>
 #include <stdlib.h>
 #include <errno.h>
 
+#include "StreamFormatConverter.h"
+#include "StreamError.h"
+
 /* timezone in UNIX contains the seconds between UTC and local time,
 but not in Free-BSD! Here timezone() is a function delivering
 the time zone abbreviation (e.g. CET). Alternatively, the timezone
@@ -40,7 +42,7 @@ value can also be gained from tm_gmtoff of the tm-structure.
     defined(__DragonFly__)
 static int timezone_bsd=0;
 #define timezone timezone_bsd
-#define tzset() { struct tm tm; time_t timet; tzset(); time(&timet);	\
+#define tzset() { struct tm tm; time_t timet; tzset(); time(&timet);    \
                   localtime_r(&timet, &tm); timezone=tm.tm_gmtoff; }
 #endif
 

src/devStream.h

@@ -1,22 +1,24 @@
-/***************************************************************
-* StreamDevice Support                                         *
-*                                                              *
-* (C) 1999 Dirk Zimoch (zimoch@delta.uni-dortmund.de)          *
-* (C) 2005 Dirk Zimoch (dirk.zimoch@psi.ch)                    *
-*                                                              *
-* This is the header for the EPICS interface to StreamDevice.  *
-* Please refer to the HTML files in ../docs/ for a detailed    *
-* documentation.                                               *
-*                                                              *
-* If you do any changes in this file, you are not allowed to   *
-* redistribute it any more. If there is a bug or a missing     *
-* feature, send me an email and/or your patch. If I accept     *
-* your changes, they will go to the next release.              *
-*                                                              *
-* DISCLAIMER: If this software breaks something or harms       *
-* someone, it's your problem.                                  *
-*                                                              *
-***************************************************************/
+/*************************************************************************
+* This is the header for StreamDevice interfaces to EPICS.
+* Please see ../docs/ for detailed documentation.
+*
+* (C) 1999,2005 Dirk Zimoch (dirk.zimoch@psi.ch)
+*
+* This file is part of StreamDevice.
+*
+* StreamDevice is free software: You can redistribute it and/or modify
+* it under the terms of the GNU Lesser General Public License as published
+* by the Free Software Foundation, either version 3 of the License, or
+* (at your option) any later version.
+*
+* StreamDevice is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+* GNU Lesser General Public License for more details.
+*
+* You should have received a copy of the GNU Lesser General Public License
+* along with StreamDevice. If not, see https://www.gnu.org/licenses/.
+*************************************************************************/
 
 #ifndef devStream_h
 #define devStream_h
@@ -26,8 +28,9 @@
 #include <string.h>
 #include <sys/types.h>
 
-#define STREAM_MAJOR 2
-#define STREAM_MINOR 8
+#ifndef STREAM_INTERNAL
+#include "StreamVersion.h"
+#endif
 
 #ifndef OK
 #define OK 0
@@ -40,6 +43,12 @@
 #define DO_NOT_CONVERT 2
 #define INIT_RUN (!interruptAccept)
 
+#ifdef epicsExportSharedSymbols
+#   define devStream_epicsExportSharedSymbols
+#   undef epicsExportSharedSymbols
+#   include "shareLib.h"
+#endif
+
 #include "epicsVersion.h"
 #ifdef BASE_VERSION
 #define EPICS_3_13
@@ -49,12 +58,6 @@ extern "C" {
 #endif
 #endif
 
-#ifdef epicsExportSharedSymbols
-#   define devStream_epicsExportSharedSymbols
-#   undef epicsExportSharedSymbols
-#   include <shareLib.h>
-#endif
-
 #include "dbCommon.h"
 #include "dbScan.h"
 #include "devSup.h"
@@ -65,12 +68,6 @@ extern "C" {
 #include "dbEvent.h"
 #include "epicsMath.h"
 
-#ifdef devStream_epicsExportSharedSymbols
-#   undef devStream_epicsExportSharedSymbols
-#   define epicsExportSharedSymbols
-#   include <shareLib.h>
-#endif
-
 #ifdef EPICS_3_13
 #ifdef __cplusplus
 }
@@ -79,6 +76,12 @@ extern "C" {
 #include "epicsStdioRedirect.h"
 #endif
 
+#ifdef devStream_epicsExportSharedSymbols
+#   undef devStream_epicsExportSharedSymbols
+#   define epicsExportSharedSymbols
+#   include "shareLib.h"
+#endif
+
 #ifdef _WIN32
 typedef ptrdiff_t ssize_t;
 #endif
@@ -88,8 +91,7 @@ typedef const struct format_s {
     const struct StreamFormat* priv;
 } format_t;
 
-epicsShareExtern FILE* StreamDebugFile;
-extern const char StreamVersion [];
+extern FILE* StreamDebugFile;
 
 typedef long (*streamIoFunction) (dbCommon*, format_t*);
 
@@ -97,6 +99,8 @@ typedef long (*streamIoFunction) (dbCommon*, format_t*);
 extern "C" {
 #endif
 
+extern const char StreamVersion [];
+
 long streamInit(int after);
 long streamInitRecord(dbCommon *record,
     const struct link *ioLink,

src/devaaiStream.c

@@ -1,22 +1,24 @@
-/***************************************************************
-* StreamDevice record interface for aai records                *
-*                                                              *
-* (C) 1999 Dirk Zimoch (zimoch@delta.uni-dortmund.de)          *
-* (C) 2006 Dirk Zimoch (dirk.zimoch@psi.ch)                    *
-*                                                              *
-* This is an EPICS record Interface for StreamDevice.          *
-* Please refer to the HTML files in ../docs/ for a detailed    *
-* documentation.                                               *
-*                                                              *
-* If you do any changes in this file, you are not allowed to   *
-* redistribute it any more. If there is a bug or a missing     *
-* feature, send me an email and/or your patch. If I accept     *
-* your changes, they will go to the next release.              *
-*                                                              *
-* DISCLAIMER: If this software breaks something or harms       *
-* someone, it's your problem.                                  *
-*                                                              *
-***************************************************************/
+/*************************************************************************
+* This is the StreamDevice interface for EPICS aai records.
+* Please see ../docs/ for detailed documentation.
+*
+* (C) 1999,2006 Dirk Zimoch (dirk.zimoch@psi.ch)
+*
+* This file is part of StreamDevice.
+*
+* StreamDevice is free software: You can redistribute it and/or modify
+* it under the terms of the GNU Lesser General Public License as published
+* by the Free Software Foundation, either version 3 of the License, or
+* (at your option) any later version.
+*
+* StreamDevice is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+* GNU Lesser General Public License for more details.
+*
+* You should have received a copy of the GNU Lesser General Public License
+* along with StreamDevice. If not, see https://www.gnu.org/licenses/.
+*************************************************************************/
 
 #include "aaiRecord.h"
 #include "devStream.h"
@@ -69,7 +71,7 @@ static long readData(dbCommon *record, format_t *format)
                     case DBF_FLOAT:
                         ((epicsFloat32 *)aai->bptr)[aai->nord] = (epicsFloat32)lval;
                         break;
-#ifdef DBF_INT64
+#ifdef DBR_INT64
                     case DBF_INT64:
                     case DBF_UINT64:
                         ((epicsInt64 *)aai->bptr)[aai->nord] = (epicsInt64)lval;
@@ -124,7 +126,7 @@ static long readData(dbCommon *record, format_t *format)
                         }
                         aai->nord = (long)length;
                         return OK;
-				    }
+                    }
                     default:
                         errlogSevPrintf(errlogFatal,
                             "readData %s: can't convert from string to %s\n",
@@ -167,12 +169,12 @@ static long writeData(dbCommon *record, format_t *format)
                     case DBF_FLOAT:
                         dval = ((epicsFloat32 *)aai->bptr)[nowd];
                         break;
-#ifdef DBF_INT64
+#ifdef DBR_INT64
                     case DBF_INT64:
-                        dval = ((epicsInt64 *)aai->bptr)[nowd];
+                        dval = (double)((epicsInt64 *)aai->bptr)[nowd];
                         break;
                     case DBF_UINT64:
-                        dval = ((epicsUInt64 *)aai->bptr)[nowd];
+                        dval = (double)((epicsUInt64 *)aai->bptr)[nowd];
                         break;
 #endif
                     case DBF_LONG:
@@ -210,12 +212,12 @@ static long writeData(dbCommon *record, format_t *format)
             {
                 switch (aai->ftvl)
                 {
-#ifdef DBF_INT64
+#ifdef DBR_INT64
                     case DBF_INT64:
-                        lval = ((epicsInt64 *)aao->bptr)[nowd];
+                        lval = (long)((epicsInt64 *)aai->bptr)[nowd];
                         break;
                     case DBF_UINT64:
-                        lval = ((epicsUInt64 *)aao->bptr)[nowd];
+                        lval = (long)((epicsUInt64 *)aai->bptr)[nowd];
                         break;
 #endif
                     case DBF_LONG:

src/devaaoStream.c

@@ -1,24 +1,25 @@
-/***************************************************************
-* StreamDevice record interface for aao records                *
-*                                                              *
-* (C) 1999 Dirk Zimoch (zimoch@delta.uni-dortmund.de)          *
-* (C) 2006 Dirk Zimoch (dirk.zimoch@psi.ch)                    *
-*                                                              *
-* This is an EPICS record Interface for StreamDevice.          *
-* Please refer to the HTML files in ../docs/ for a detailed    *
-* documentation.                                               *
-*                                                              *
-* If you do any changes in this file, you are not allowed to   *
-* redistribute it any more. If there is a bug or a missing     *
-* feature, send me an email and/or your patch. If I accept     *
-* your changes, they will go to the next release.              *
-*                                                              *
-* DISCLAIMER: If this software breaks something or harms       *
-* someone, it's your problem.                                  *
-*                                                              *
-***************************************************************/
+/*************************************************************************
+* This is the StreamDevice interface for EPICS aao records.
+* Please see ../docs/ for detailed documentation.
+*
+* (C) 1999,2006 Dirk Zimoch (dirk.zimoch@psi.ch)
+*
+* This file is part of StreamDevice.
+*
+* StreamDevice is free software: You can redistribute it and/or modify
+* it under the terms of the GNU Lesser General Public License as published
+* by the Free Software Foundation, either version 3 of the License, or
+* (at your option) any later version.
+*
+* StreamDevice is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+* GNU Lesser General Public License for more details.
+*
+* You should have received a copy of the GNU Lesser General Public License
+* along with StreamDevice. If not, see https://www.gnu.org/licenses/.
+*************************************************************************/
 
-#include <stdio.h>
 #include "epicsString.h"
 #include "aaoRecord.h"
 #include "devStream.h"
@@ -68,7 +69,7 @@ static long readData(dbCommon *record, format_t *format)
                     case DBF_FLOAT:
                         ((epicsFloat32 *)aao->bptr)[aao->nord] = (epicsFloat32)lval;
                         break;
-#ifdef DBF_INT64
+#ifdef DBR_INT64
                     case DBF_INT64:
                     case DBF_UINT64:
                         ((epicsInt64 *)aao->bptr)[aao->nord] = (epicsInt64)lval;
@@ -171,7 +172,7 @@ end_no_check:
 #endif
     if (monitor_mask)
         db_post_events(aao, aao->bptr, monitor_mask);
-    
+
     return OK;
 }
 
@@ -196,12 +197,12 @@ static long writeData(dbCommon *record, format_t *format)
                     case DBF_FLOAT:
                         dval = ((epicsFloat32 *)aao->bptr)[nowd];
                         break;
-#ifdef DBF_INT64
+#ifdef DBR_INT64
                     case DBF_INT64:
-                        dval = ((epicsInt64 *)aao->bptr)[nowd];
+                        dval = (double)((epicsInt64 *)aao->bptr)[nowd];
                         break;
                     case DBF_UINT64:
-                        dval = ((epicsUInt64 *)aao->bptr)[nowd];
+                        dval = (double)((epicsUInt64 *)aao->bptr)[nowd];
                         break;
 #endif
                     case DBF_LONG:
@@ -239,12 +240,12 @@ static long writeData(dbCommon *record, format_t *format)
             {
                 switch (aao->ftvl)
                 {
-#ifdef DBF_INT64
+#ifdef DBR_INT64
                     case DBF_INT64:
-                        lval = ((epicsInt64 *)aao->bptr)[nowd];
+                        lval = (long)((epicsInt64 *)aao->bptr)[nowd];
                         break;
                     case DBF_UINT64:
-                        lval = ((epicsUInt64 *)aao->bptr)[nowd];
+                        lval = (long)((epicsUInt64 *)aao->bptr)[nowd];
                         break;
 #endif
                     case DBF_LONG:

src/devaiStream.c

@@ -1,22 +1,24 @@
-/***************************************************************
-* StreamDevice record interface for analog input records       *
-*                                                              *
-* (C) 1999 Dirk Zimoch (zimoch@delta.uni-dortmund.de)          *
-* (C) 2005 Dirk Zimoch (dirk.zimoch@psi.ch)                    *
-*                                                              *
-* This is an EPICS record Interface for StreamDevice.          *
-* Please refer to the HTML files in ../docs/ for a detailed    *
-* documentation.                                               *
-*                                                              *
-* If you do any changes in this file, you are not allowed to   *
-* redistribute it any more. If there is a bug or a missing     *
-* feature, send me an email and/or your patch. If I accept     *
-* your changes, they will go to the next release.              *
-*                                                              *
-* DISCLAIMER: If this software breaks something or harms       *
-* someone, it's your problem.                                  *
-*                                                              *
-***************************************************************/
+/*************************************************************************
+* This is the StreamDevice interface for EPICS ai records.
+* Please see ../docs/ for detailed documentation.
+*
+* (C) 1999,2005 Dirk Zimoch (dirk.zimoch@psi.ch)
+*
+* This file is part of StreamDevice.
+*
+* StreamDevice is free software: You can redistribute it and/or modify
+* it under the terms of the GNU Lesser General Public License as published
+* by the Free Software Foundation, either version 3 of the License, or
+* (at your option) any later version.
+*
+* StreamDevice is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+* GNU Lesser General Public License for more details.
+*
+* You should have received a copy of the GNU Lesser General Public License
+* along with StreamDevice. If not, see https://www.gnu.org/licenses/.
+*************************************************************************/
 
 #include "aiRecord.h"
 #include "devStream.h"

src/devaoStream.c

@@ -1,22 +1,24 @@
-/***************************************************************
-* Stream Device record interface for analog output records     *
-*                                                              *
-* (C) 1999 Dirk Zimoch (zimoch@delta.uni-dortmund.de)          *
-* (C) 2005 Dirk Zimoch (dirk.zimoch@psi.ch)                    *
-*                                                              *
-* This is an EPICS record Interface for StreamDevice.          *
-* Please refer to the HTML files in ../docs/ for a detailed    *
-* documentation.                                               *
-*                                                              *
-* If you do any changes in this file, you are not allowed to   *
-* redistribute it any more. If there is a bug or a missing     *
-* feature, send me an email and/or your patch. If I accept     *
-* your changes, they will go to the next release.              *
-*                                                              *
-* DISCLAIMER: If this software breaks something or harms       *
-* someone, it's your problem.                                  *
-*                                                              *
-***************************************************************/
+/*************************************************************************
+* This is the StreamDevice interface for EPICS ao records.
+* Please see ../docs/ for detailed documentation.
+*
+* (C) 1999,2005 Dirk Zimoch (dirk.zimoch@psi.ch)
+*
+* This file is part of StreamDevice.
+*
+* StreamDevice is free software: You can redistribute it and/or modify
+* it under the terms of the GNU Lesser General Public License as published
+* by the Free Software Foundation, either version 3 of the License, or
+* (at your option) any later version.
+*
+* StreamDevice is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+* GNU Lesser General Public License for more details.
+*
+* You should have received a copy of the GNU Lesser General Public License
+* along with StreamDevice. If not, see https://www.gnu.org/licenses/.
+*************************************************************************/
 
 #include "aoRecord.h"
 #include "menuConvert.h"
@@ -50,16 +52,16 @@ static long readData(dbCommon *record, format_t *format)
             break;
             val += ao->roff;
             if (ao->linr == menuConvertNO_CONVERSION) {
-	        ; /*do nothing*/
+                ; /*do nothing*/
             } else if ((ao->linr == menuConvertLINEAR)
 #ifndef EPICS_3_13
-		    || (ao->linr == menuConvertSLOPE)
+                    || (ao->linr == menuConvertSLOPE)
 #endif
                     ) {
                 val = val * ao->eslo + ao->eoff;
             } else {
                 if (cvtRawToEngBpt(&val, ao->linr, 0,
-		        (void *)&ao->pbrk, &ao->lbrk) == ERROR) return ERROR;
+                    (void *)&ao->pbrk, &ao->lbrk) == ERROR) return ERROR;
             }
         }
         default:
@@ -71,7 +73,7 @@ static long readData(dbCommon *record, format_t *format)
     if (record->pact) return DO_NOT_CONVERT;
     /* In @init handler, no processing, enforce monitor updates. */
     ao->omod = ao->oval != val;
-    ao->orbv = ao->oval = val;
+    ao->orbv = (epicsInt32)(ao->oval = val);
     monitor_mask = recGblResetAlarms(record);
     if (!(fabs(ao->mlst - val) <= ao->mdel))
     {

src/devbiStream.c

@@ -1,22 +1,24 @@
-/***************************************************************
-* Stream Device record interface for binary input records      *
-*                                                              *
-* (C) 1999 Dirk Zimoch (zimoch@delta.uni-dortmund.de)          *
-* (C) 2005 Dirk Zimoch (dirk.zimoch@psi.ch)                    *
-*                                                              *
-* This is an EPICS record Interface for StreamDevice.          *
-* Please refer to the HTML files in ../docs/ for a detailed    *
-* documentation.                                               *
-*                                                              *
-* If you do any changes in this file, you are not allowed to   *
-* redistribute it any more. If there is a bug or a missing     *
-* feature, send me an email and/or your patch. If I accept     *
-* your changes, they will go to the next release.              *
-*                                                              *
-* DISCLAIMER: If this software breaks something or harms       *
-* someone, it's your problem.                                  *
-*                                                              *
-***************************************************************/
+/*************************************************************************
+* This is the StreamDevice interface for EPICS bi records.
+* Please see ../docs/ for detailed documentation.
+*
+* (C) 1999,2005 Dirk Zimoch (dirk.zimoch@psi.ch)
+*
+* This file is part of StreamDevice.
+*
+* StreamDevice is free software: You can redistribute it and/or modify
+* it under the terms of the GNU Lesser General Public License as published
+* by the Free Software Foundation, either version 3 of the License, or
+* (at your option) any later version.
+*
+* StreamDevice is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+* GNU Lesser General Public License for more details.
+*
+* You should have received a copy of the GNU Lesser General Public License
+* along with StreamDevice. If not, see https://www.gnu.org/licenses/.
+*************************************************************************/
 
 #include "biRecord.h"
 #include "devStream.h"

src/devboStream.c

@@ -1,22 +1,24 @@
-/***************************************************************
-* Stream Device record interface for binary output records     *
-*                                                              *
-* (C) 1999 Dirk Zimoch (zimoch@delta.uni-dortmund.de)          *
-* (C) 2005 Dirk Zimoch (dirk.zimoch@psi.ch)                    *
-*                                                              *
-* This is an EPICS record Interface for StreamDevice.          *
-* Please refer to the HTML files in ../docs/ for a detailed    *
-* documentation.                                               *
-*                                                              *
-* If you do any changes in this file, you are not allowed to   *
-* redistribute it any more. If there is a bug or a missing     *
-* feature, send me an email and/or your patch. If I accept     *
-* your changes, they will go to the next release.              *
-*                                                              *
-* DISCLAIMER: If this software breaks something or harms       *
-* someone, it's your problem.                                  *
-*                                                              *
-***************************************************************/
+/*************************************************************************
+* This is the StreamDevice interface for EPICS bo records.
+* Please see ../docs/ for detailed documentation.
+*
+* (C) 1999,2005 Dirk Zimoch (dirk.zimoch@psi.ch)
+*
+* This file is part of StreamDevice.
+*
+* StreamDevice is free software: You can redistribute it and/or modify
+* it under the terms of the GNU Lesser General Public License as published
+* by the Free Software Foundation, either version 3 of the License, or
+* (at your option) any later version.
+*
+* StreamDevice is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+* GNU Lesser General Public License for more details.
+*
+* You should have received a copy of the GNU Lesser General Public License
+* along with StreamDevice. If not, see https://www.gnu.org/licenses/.
+*************************************************************************/
 
 #include "boRecord.h"
 #include "devStream.h"

src/devcalcoutStream.c

@@ -1,21 +1,24 @@
-/***************************************************************
-* Stream Device record interface for calcout records           *
-*                                                              *
-* (C) 2005 Dirk Zimoch (dirk.zimoch@psi.ch)                    *
-*                                                              *
-* This is an EPICS record Interface for StreamDevice.          *
-* Please refer to the HTML files in ../docs/ for a detailed    *
-* documentation.                                               *
-*                                                              *
-* If you do any changes in this file, you are not allowed to   *
-* redistribute it any more. If there is a bug or a missing     *
-* feature, send me an email and/or your patch. If I accept     *
-* your changes, they will go to the next release.              *
-*                                                              *
-* DISCLAIMER: If this software breaks something or harms       *
-* someone, it's your problem.                                  *
-*                                                              *
-***************************************************************/
+/*************************************************************************
+* This is the StreamDevice interface for EPICS calcout records.
+* Please see ../docs/ for detailed documentation.
+*
+* (C) 2005 Dirk Zimoch (dirk.zimoch@psi.ch)
+*
+* This file is part of StreamDevice.
+*
+* StreamDevice is free software: You can redistribute it and/or modify
+* it under the terms of the GNU Lesser General Public License as published
+* by the Free Software Foundation, either version 3 of the License, or
+* (at your option) any later version.
+*
+* StreamDevice is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+* GNU Lesser General Public License for more details.
+*
+* You should have received a copy of the GNU Lesser General Public License
+* along with StreamDevice. If not, see https://www.gnu.org/licenses/.
+*************************************************************************/
 
 #include "calcoutRecord.h"
 #include "devStream.h"
@@ -46,7 +49,7 @@ static long readData(dbCommon *record, format_t *format)
             break;
         }
         default:
-            return ERROR;        
+            return ERROR;
     }
     if (record->pact) return OK;
     /* In @init handler, no processing, enforce monitor updates. */
@@ -60,10 +63,10 @@ static long readData(dbCommon *record, format_t *format)
         monitor_mask |= DBE_LOG;
         co->alst = co->val;
     }
-    if (monitor_mask){
+    if (monitor_mask) {
         db_post_events(record, &co->val, monitor_mask);
     }
-    
+
     return OK;
 }
 

src/devint64inStream.c

@@ -1,21 +1,24 @@
-/***************************************************************
-* Stream Device record interface for int64in records           *
-*                                                              *
-* (C) 2018 Dirk Zimoch (dirk.zimoch@psi.ch)                    *
-*                                                              *
-* This is an EPICS record Interface for StreamDevice.          *
-* Please refer to the HTML files in ../docs/ for a detailed    *
-* documentation.                                               *
-*                                                              *
-* If you do any changes in this file, you are not allowed to   *
-* redistribute it any more. If there is a bug or a missing     *
-* feature, send me an email and/or your patch. If I accept     *
-* your changes, they will go to the next release.              *
-*                                                              *
-* DISCLAIMER: If this software breaks something or harms       *
-* someone, it's your problem.                                  *
-*                                                              *
-***************************************************************/
+/*************************************************************************
+* This is the StreamDevice interface for EPICS int64in records.
+* Please see ../docs/ for detailed documentation.
+*
+* (C) 2018 Dirk Zimoch (dirk.zimoch@psi.ch)
+*
+* This file is part of StreamDevice.
+*
+* StreamDevice is free software: You can redistribute it and/or modify
+* it under the terms of the GNU Lesser General Public License as published
+* by the Free Software Foundation, either version 3 of the License, or
+* (at your option) any later version.
+*
+* StreamDevice is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+* GNU Lesser General Public License for more details.
+*
+* You should have received a copy of the GNU Lesser General Public License
+* along with StreamDevice. If not, see https://www.gnu.org/licenses/.
+*************************************************************************/
 
 #include "int64inRecord.h"
 #include "devStream.h"

src/devint64outStream.c

@@ -1,21 +1,24 @@
-/***************************************************************
-* Stream Device record interface for int64out records          *
-*                                                              *
-* (C) 2018 Dirk Zimoch (dirk.zimoch@psi.ch)                    *
-*                                                              *
-* This is an EPICS record Interface for StreamDevice.          *
-* Please refer to the HTML files in ../docs/ for a detailed    *
-* documentation.                                               *
-*                                                              *
-* If you do any changes in this file, you are not allowed to   *
-* redistribute it any more. If there is a bug or a missing     *
-* feature, send me an email and/or your patch. If I accept     *
-* your changes, they will go to the next release.              *
-*                                                              *
-* DISCLAIMER: If this software breaks something or harms       *
-* someone, it's your problem.                                  *
-*                                                              *
-***************************************************************/
+/*************************************************************************
+* This is the StreamDevice interface for EPICS int64out records.
+* Please see ../docs/ for detailed documentation.
+*
+* (C) 2018 Dirk Zimoch (dirk.zimoch@psi.ch)
+*
+* This file is part of StreamDevice.
+*
+* StreamDevice is free software: You can redistribute it and/or modify
+* it under the terms of the GNU Lesser General Public License as published
+* by the Free Software Foundation, either version 3 of the License, or
+* (at your option) any later version.
+*
+* StreamDevice is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+* GNU Lesser General Public License for more details.
+*
+* You should have received a copy of the GNU Lesser General Public License
+* along with StreamDevice. If not, see https://www.gnu.org/licenses/.
+*************************************************************************/
 
 #include "int64outRecord.h"
 #include "devStream.h"

src/devlonginStream.c

@@ -1,22 +1,24 @@
-/***************************************************************
-* Stream Device record interface for long input records        *
-*                                                              *
-* (C) 1999 Dirk Zimoch (zimoch@delta.uni-dortmund.de)          *
-* (C) 2005 Dirk Zimoch (dirk.zimoch@psi.ch)                    *
-*                                                              *
-* This is an EPICS record Interface for StreamDevice.          *
-* Please refer to the HTML files in ../docs/ for a detailed    *
-* documentation.                                               *
-*                                                              *
-* If you do any changes in this file, you are not allowed to   *
-* redistribute it any more. If there is a bug or a missing     *
-* feature, send me an email and/or your patch. If I accept     *
-* your changes, they will go to the next release.              *
-*                                                              *
-* DISCLAIMER: If this software breaks something or harms       *
-* someone, it's your problem.                                  *
-*                                                              *
-***************************************************************/
+/*************************************************************************
+* This is the StreamDevice interface for EPICS longin records.
+* Please see ../docs/ for detailed documentation.
+*
+* (C) 1999,2005 Dirk Zimoch (dirk.zimoch@psi.ch)
+*
+* This file is part of StreamDevice.
+*
+* StreamDevice is free software: You can redistribute it and/or modify
+* it under the terms of the GNU Lesser General Public License as published
+* by the Free Software Foundation, either version 3 of the License, or
+* (at your option) any later version.
+*
+* StreamDevice is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+* GNU Lesser General Public License for more details.
+*
+* You should have received a copy of the GNU Lesser General Public License
+* along with StreamDevice. If not, see https://www.gnu.org/licenses/.
+*************************************************************************/
 
 #include "longinRecord.h"
 #include "devStream.h"

src/devlongoutStream.c

@@ -1,22 +1,24 @@
-/***************************************************************
-* Stream Device record interface for long output records       *
-*                                                              *
-* (C) 1999 Dirk Zimoch (zimoch@delta.uni-dortmund.de)          *
-* (C) 2005 Dirk Zimoch (dirk.zimoch@psi.ch)                    *
-*                                                              *
-* This is an EPICS record Interface for StreamDevice.          *
-* Please refer to the HTML files in ../docs/ for a detailed    *
-* documentation.                                               *
-*                                                              *
-* If you do any changes in this file, you are not allowed to   *
-* redistribute it any more. If there is a bug or a missing     *
-* feature, send me an email and/or your patch. If I accept     *
-* your changes, they will go to the next release.              *
-*                                                              *
-* DISCLAIMER: If this software breaks something or harms       *
-* someone, it's your problem.                                  *
-*                                                              *
-***************************************************************/
+/*************************************************************************
+* This is the StreamDevice interface for EPICS longout records.
+* Please see ../docs/ for detailed documentation.
+*
+* (C) 1999,2005 Dirk Zimoch (dirk.zimoch@psi.ch)
+*
+* This file is part of StreamDevice.
+*
+* StreamDevice is free software: You can redistribute it and/or modify
+* it under the terms of the GNU Lesser General Public License as published
+* by the Free Software Foundation, either version 3 of the License, or
+* (at your option) any later version.
+*
+* StreamDevice is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+* GNU Lesser General Public License for more details.
+*
+* You should have received a copy of the GNU Lesser General Public License
+* along with StreamDevice. If not, see https://www.gnu.org/licenses/.
+*************************************************************************/
 
 #include "longoutRecord.h"
 #include "devStream.h"

src/devlsiStream.c

@@ -1,21 +1,24 @@
-/***************************************************************
-* Stream Device record interface for long string in records    *
-*                                                              *
-* (C) 2018 Dirk Zimoch (dirk.zimoch@psi.ch)                    *
-*                                                              *
-* This is an EPICS record Interface for StreamDevice.          *
-* Please refer to the HTML files in ../docs/ for a detailed    *
-* documentation.                                               *
-*                                                              *
-* If you do any changes in this file, you are not allowed to   *
-* redistribute it any more. If there is a bug or a missing     *
-* feature, send me an email and/or your patch. If I accept     *
-* your changes, they will go to the next release.              *
-*                                                              *
-* DISCLAIMER: If this software breaks something or harms       *
-* someone, it's your problem.                                  *
-*                                                              *
-***************************************************************/
+/*************************************************************************
+* This is the StreamDevice interface for EPICS lsi records.
+* Please see ../docs/ for detailed documentation.
+*
+* (C) 2018 Dirk Zimoch (dirk.zimoch@psi.ch)
+*
+* This file is part of StreamDevice.
+*
+* StreamDevice is free software: You can redistribute it and/or modify
+* it under the terms of the GNU Lesser General Public License as published
+* by the Free Software Foundation, either version 3 of the License, or
+* (at your option) any later version.
+*
+* StreamDevice is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+* GNU Lesser General Public License for more details.
+*
+* You should have received a copy of the GNU Lesser General Public License
+* along with StreamDevice. If not, see https://www.gnu.org/licenses/.
+*************************************************************************/
 
 #include "lsiRecord.h"
 #include "devStream.h"
@@ -34,7 +37,7 @@ static long readData(dbCommon *record, format_t *format)
     {
         lsi->val[length] = 0;
     }
-    lsi->len = length;
+    lsi->len = (epicsUInt32)length;
     return OK;
 }
 

src/devlsoStream.c

@@ -1,21 +1,24 @@
-/***************************************************************
-* Stream Device record interface for long string out records   *
-*                                                              *
-* (C) 2018 Dirk Zimoch (dirk.zimoch@psi.ch)                    *
-*                                                              *
-* This is an EPICS record Interface for StreamDevice.          *
-* Please refer to the HTML files in ../docs/ for a detailed    *
-* documentation.                                               *
-*                                                              *
-* If you do any changes in this file, you are not allowed to   *
-* redistribute it any more. If there is a bug or a missing     *
-* feature, send me an email and/or your patch. If I accept     *
-* your changes, they will go to the next release.              *
-*                                                              *
-* DISCLAIMER: If this software breaks something or harms       *
-* someone, it's your problem.                                  *
-*                                                              *
-***************************************************************/
+/*************************************************************************
+* This is the StreamDevice interface for EPICS lso records.
+* Please see ../docs/ for detailed documentation.
+*
+* (C) 2018 Dirk Zimoch (dirk.zimoch@psi.ch)
+*
+* This file is part of StreamDevice.
+*
+* StreamDevice is free software: You can redistribute it and/or modify
+* it under the terms of the GNU Lesser General Public License as published
+* by the Free Software Foundation, either version 3 of the License, or
+* (at your option) any later version.
+*
+* StreamDevice is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+* GNU Lesser General Public License for more details.
+*
+* You should have received a copy of the GNU Lesser General Public License
+* along with StreamDevice. If not, see https://www.gnu.org/licenses/.
+*************************************************************************/
 
 #include "lsoRecord.h"
 #include "menuPost.h"
@@ -36,7 +39,7 @@ static long readData(dbCommon *record, format_t *format)
     {
         lso->val[length] = 0;
     }
-    lso->len = length;
+    lso->len = (epicsUInt32)length;
     if (record->pact) return OK;
     /* In @init handler, no processing, enforce monitor updates. */
     monitor_mask = recGblResetAlarms(record);

src/devmbbiDirectStream.c

@@ -1,23 +1,24 @@
-/***************************************************************
-* StreamDevice record interface for                            *
-* multibit binary input direct records                         *
-*                                                              *
-* (C) 1999 Dirk Zimoch (zimoch@delta.uni-dortmund.de)          *
-* (C) 2005 Dirk Zimoch (dirk.zimoch@psi.ch)                    *
-*                                                              *
-* This is an EPICS record Interface for StreamDevice.          *
-* Please refer to the HTML files in ../docs/ for a detailed    *
-* documentation.                                               *
-*                                                              *
-* If you do any changes in this file, you are not allowed to   *
-* redistribute it any more. If there is a bug or a missing     *
-* feature, send me an email and/or your patch. If I accept     *
-* your changes, they will go to the next release.              *
-*                                                              *
-* DISCLAIMER: If this software breaks something or harms       *
-* someone, it's your problem.                                  *
-*                                                              *
-***************************************************************/
+/*************************************************************************
+* This is the StreamDevice interface for EPICS mbbiDirect records.
+* Please see ../docs/ for detailed documentation.
+*
+* (C) 1999,2005 Dirk Zimoch (dirk.zimoch@psi.ch)
+*
+* This file is part of StreamDevice.
+*
+* StreamDevice is free software: You can redistribute it and/or modify
+* it under the terms of the GNU Lesser General Public License as published
+* by the Free Software Foundation, either version 3 of the License, or
+* (at your option) any later version.
+*
+* StreamDevice is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+* GNU Lesser General Public License for more details.
+*
+* You should have received a copy of the GNU Lesser General Public License
+* along with StreamDevice. If not, see https://www.gnu.org/licenses/.
+*************************************************************************/
 
 #include "mbbiDirectRecord.h"
 #include "devStream.h"

src/devmbbiStream.c

@@ -1,23 +1,24 @@
-/***************************************************************
-* StreamDevice record interface for                            *
-* multibit binary input records                                *
-*                                                              *
-* (C) 1999 Dirk Zimoch (zimoch@delta.uni-dortmund.de)          *
-* (C) 2005 Dirk Zimoch (dirk.zimoch@psi.ch)                    *
-*                                                              *
-* This is an EPICS record Interface for StreamDevice.          *
-* Please refer to the HTML files in ../docs/ for a detailed    *
-* documentation.                                               *
-*                                                              *
-* If you do any changes in this file, you are not allowed to   *
-* redistribute it any more. If there is a bug or a missing     *
-* feature, send me an email and/or your patch. If I accept     *
-* your changes, they will go to the next release.              *
-*                                                              *
-* DISCLAIMER: If this software breaks something or harms       *
-* someone, it's your problem.                                  *
-*                                                              *
-***************************************************************/
+/*************************************************************************
+* This is the StreamDevice interface for EPICS mbbi records.
+* Please see ../docs/ for detailed documentation.
+*
+* (C) 1999,2005 Dirk Zimoch (dirk.zimoch@psi.ch)
+*
+* This file is part of StreamDevice.
+*
+* StreamDevice is free software: You can redistribute it and/or modify
+* it under the terms of the GNU Lesser General Public License as published
+* by the Free Software Foundation, either version 3 of the License, or
+* (at your option) any later version.
+*
+* StreamDevice is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+* GNU Lesser General Public License for more details.
+*
+* You should have received a copy of the GNU Lesser General Public License
+* along with StreamDevice. If not, see https://www.gnu.org/licenses/.
+*************************************************************************/
 
 #include "mbbiRecord.h"
 #include "devStream.h"

src/devmbboDirectStream.c

@@ -1,23 +1,24 @@
-/***************************************************************
-* StreamDevice record interface for                            *
-* multibit binary output direct records                        *
-*                                                              *
-* (C) 1999 Dirk Zimoch (zimoch@delta.uni-dortmund.de)          *
-* (C) 2005 Dirk Zimoch (dirk.zimoch@psi.ch)                    *
-*                                                              *
-* This is an EPICS record Interface for StreamDevice.          *
-* Please refer to the HTML files in ../docs/ for a detailed    *
-* documentation.                                               *
-*                                                              *
-* If you do any changes in this file, you are not allowed to   *
-* redistribute it any more. If there is a bug or a missing     *
-* feature, send me an email and/or your patch. If I accept     *
-* your changes, they will go to the next release.              *
-*                                                              *
-* DISCLAIMER: If this software breaks something or harms       *
-* someone, it's your problem.                                  *
-*                                                              *
-***************************************************************/
+/*************************************************************************
+* This is the StreamDevice interface for EPICS mbboDirect records.
+* Please see ../docs/ for detailed documentation.
+*
+* (C) 1999,2005 Dirk Zimoch (dirk.zimoch@psi.ch)
+*
+* This file is part of StreamDevice.
+*
+* StreamDevice is free software: You can redistribute it and/or modify
+* it under the terms of the GNU Lesser General Public License as published
+* by the Free Software Foundation, either version 3 of the License, or
+* (at your option) any later version.
+*
+* StreamDevice is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+* GNU Lesser General Public License for more details.
+*
+* You should have received a copy of the GNU Lesser General Public License
+* along with StreamDevice. If not, see https://www.gnu.org/licenses/.
+*************************************************************************/
 
 #include "mbboDirectRecord.h"
 #include "devStream.h"

src/devmbboStream.c

@@ -1,23 +1,24 @@
-/***************************************************************
-* StreamDevice record interface for                            *
-* multibit binary output records                               *
-*                                                              *
-* (C) 1999 Dirk Zimoch (zimoch@delta.uni-dortmund.de)          *
-* (C) 2005 Dirk Zimoch (dirk.zimoch@psi.ch)                    *
-*                                                              *
-* This is an EPICS record Interface for StreamDevice.          *
-* Please refer to the HTML files in ../docs/ for a detailed    *
-* documentation.                                               *
-*                                                              *
-* If you do any changes in this file, you are not allowed to   *
-* redistribute it any more. If there is a bug or a missing     *
-* feature, send me an email and/or your patch. If I accept     *
-* your changes, they will go to the next release.              *
-*                                                              *
-* DISCLAIMER: If this software breaks something or harms       *
-* someone, it's your problem.                                  *
-*                                                              *
-***************************************************************/
+/*************************************************************************
+* This is the StreamDevice interface for EPICS mbbo records.
+* Please see ../docs/ for detailed documentation.
+*
+* (C) 1999,2005 Dirk Zimoch (dirk.zimoch@psi.ch)
+*
+* This file is part of StreamDevice.
+*
+* StreamDevice is free software: You can redistribute it and/or modify
+* it under the terms of the GNU Lesser General Public License as published
+* by the Free Software Foundation, either version 3 of the License, or
+* (at your option) any later version.
+*
+* StreamDevice is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+* GNU Lesser General Public License for more details.
+*
+* You should have received a copy of the GNU Lesser General Public License
+* along with StreamDevice. If not, see https://www.gnu.org/licenses/.
+*************************************************************************/
 
 #include "mbboRecord.h"
 #include "devStream.h"

src/devscalcoutStream.c

@@ -1,21 +1,24 @@
-/***************************************************************
-* Stream Device record interface for string calcout records    *
-*                                                              *
-* (C) 2006 Dirk Zimoch (dirk.zimoch@psi.ch)                    *
-*                                                              *
-* This is an EPICS record Interface for StreamDevice.          *
-* Please refer to the HTML files in ../docs/ for a detailed    *
-* documentation.                                               *
-*                                                              *
-* If you do any changes in this file, you are not allowed to   *
-* redistribute it any more. If there is a bug or a missing     *
-* feature, send me an email and/or your patch. If I accept     *
-* your changes, they will go to the next release.              *
-*                                                              *
-* DISCLAIMER: If this software breaks something or harms       *
-* someone, it's your problem.                                  *
-*                                                              *
-***************************************************************/
+/*************************************************************************
+* This is the StreamDevice interface for EPICS scalcout records.
+* Please see ../docs/ for detailed documentation.
+*
+* (C) 2006 Dirk Zimoch (dirk.zimoch@psi.ch)
+*
+* This file is part of StreamDevice.
+*
+* StreamDevice is free software: You can redistribute it and/or modify
+* it under the terms of the GNU Lesser General Public License as published
+* by the Free Software Foundation, either version 3 of the License, or
+* (at your option) any later version.
+*
+* StreamDevice is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+* GNU Lesser General Public License for more details.
+*
+* You should have received a copy of the GNU Lesser General Public License
+* along with StreamDevice. If not, see https://www.gnu.org/licenses/.
+*************************************************************************/
 
 #include "sCalcoutRecord.h"
 #include "devStream.h"
@@ -25,7 +28,7 @@
    of the device support.
    Fix: sCalcoutRecord.c, end of init_record() add
 
-        if(pscalcoutDSET->init_record ) {
+        if (pscalcoutDSET->init_record ) {
             return (*pscalcoutDSET->init_record)(pcalc);
         }
 */

src/devstringinStream.c

@@ -1,22 +1,24 @@
-/***************************************************************
-* Stream Device record interface for string input records      *
-*                                                              *
-* (C) 1999 Dirk Zimoch (zimoch@delta.uni-dortmund.de)          *
-* (C) 2005 Dirk Zimoch (dirk.zimoch@psi.ch)                    *
-*                                                              *
-* This is an EPICS record Interface for StreamDevice.          *
-* Please refer to the HTML files in ../docs/ for a detailed    *
-* documentation.                                               *
-*                                                              *
-* If you do any changes in this file, you are not allowed to   *
-* redistribute it any more. If there is a bug or a missing     *
-* feature, send me an email and/or your patch. If I accept     *
-* your changes, they will go to the next release.              *
-*                                                              *
-* DISCLAIMER: If this software breaks something or harms       *
-* someone, it's your problem.                                  *
-*                                                              *
-***************************************************************/
+/*************************************************************************
+* This is the StreamDevice interface for EPICS stringin records.
+* Please see ../docs/ for detailed documentation.
+*
+* (C) 1999,2005 Dirk Zimoch (dirk.zimoch@psi.ch)
+*
+* This file is part of StreamDevice.
+*
+* StreamDevice is free software: You can redistribute it and/or modify
+* it under the terms of the GNU Lesser General Public License as published
+* by the Free Software Foundation, either version 3 of the License, or
+* (at your option) any later version.
+*
+* StreamDevice is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+* GNU Lesser General Public License for more details.
+*
+* You should have received a copy of the GNU Lesser General Public License
+* along with StreamDevice. If not, see https://www.gnu.org/licenses/.
+*************************************************************************/
 
 #include "stringinRecord.h"
 #include "devStream.h"

src/devstringoutStream.c

@@ -1,22 +1,24 @@
-/***************************************************************
-* Stream Device record interface for string output records     *
-*                                                              *
-* (C) 1999 Dirk Zimoch (zimoch@delta.uni-dortmund.de)          *
-* (C) 2005 Dirk Zimoch (dirk.zimoch@psi.ch)                    *
-*                                                              *
-* This is an EPICS record Interface for StreamDevice.          *
-* Please refer to the HTML files in ../docs/ for a detailed    *
-* documentation.                                               *
-*                                                              *
-* If you do any changes in this file, you are not allowed to   *
-* redistribute it any more. If there is a bug or a missing     *
-* feature, send me an email and/or your patch. If I accept     *
-* your changes, they will go to the next release.              *
-*                                                              *
-* DISCLAIMER: If this software breaks something or harms       *
-* someone, it's your problem.                                  *
-*                                                              *
-***************************************************************/
+/*************************************************************************
+* This is the StreamDevice interface for EPICS stringout records.
+* Please see ../docs/ for detailed documentation.
+*
+* (C) 1999,2005 Dirk Zimoch (dirk.zimoch@psi.ch)
+*
+* This file is part of StreamDevice.
+*
+* StreamDevice is free software: You can redistribute it and/or modify
+* it under the terms of the GNU Lesser General Public License as published
+* by the Free Software Foundation, either version 3 of the License, or
+* (at your option) any later version.
+*
+* StreamDevice is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+* GNU Lesser General Public License for more details.
+*
+* You should have received a copy of the GNU Lesser General Public License
+* along with StreamDevice. If not, see https://www.gnu.org/licenses/.
+*************************************************************************/
 
 #include "stringoutRecord.h"
 #include "devStream.h"
@@ -41,7 +43,7 @@ static long readData(dbCommon *record, format_t *format)
         strncmp(so->oval, so->val, sizeof(so->val)))
     {
         monitor_mask |= DBE_VALUE | DBE_LOG;
-        strncpy(so->oval, so->val, sizeof(so->val));
+        strncpy(so->oval, so->val, sizeof(so->oval));
     }
     if (monitor_mask)
         db_post_events(record, so->val, monitor_mask);

src/devwaveformStream.c

@@ -1,22 +1,24 @@
-/***************************************************************
-* StreamDevice record interface for waveform records           *
-*                                                              *
-* (C) 1999 Dirk Zimoch (zimoch@delta.uni-dortmund.de)          *
-* (C) 2005 Dirk Zimoch (dirk.zimoch@psi.ch)                    *
-*                                                              *
-* This is an EPICS record Interface for StreamDevice.          *
-* Please refer to the HTML files in ../docs/ for a detailed    *
-* documentation.                                               *
-*                                                              *
-* If you do any changes in this file, you are not allowed to   *
-* redistribute it any more. If there is a bug or a missing     *
-* feature, send me an email and/or your patch. If I accept     *
-* your changes, they will go to the next release.              *
-*                                                              *
-* DISCLAIMER: If this software breaks something or harms       *
-* someone, it's your problem.                                  *
-*                                                              *
-***************************************************************/
+/*************************************************************************
+* This is the StreamDevice interface for EPICS waveform records.
+* Please see ../docs/ for detailed documentation.
+*
+* (C) 1999,2005 Dirk Zimoch (dirk.zimoch@psi.ch)
+*
+* This file is part of StreamDevice.
+*
+* StreamDevice is free software: You can redistribute it and/or modify
+* it under the terms of the GNU Lesser General Public License as published
+* by the Free Software Foundation, either version 3 of the License, or
+* (at your option) any later version.
+*
+* StreamDevice is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+* GNU Lesser General Public License for more details.
+*
+* You should have received a copy of the GNU Lesser General Public License
+* along with StreamDevice. If not, see https://www.gnu.org/licenses/.
+*************************************************************************/
 
 #include "waveformRecord.h"
 #include "devStream.h"
@@ -70,10 +72,10 @@ static long readData(dbCommon *record, format_t *format)
                     case DBF_FLOAT:
                         ((epicsFloat32 *)wf->bptr)[wf->nord] = (epicsFloat32)lval;
                         break;
-#ifdef DBF_INT64
+#ifdef DBR_INT64
                     case DBF_INT64:
                     case DBF_UINT64:
-                        ((epicsInt64 *)wf->bptr)[aao->nord] = (epicsInt64)lval;
+                        ((epicsInt64 *)wf->bptr)[wf->nord] = (epicsInt64)lval;
                         break;
 #endif
                     case DBF_LONG:
@@ -168,12 +170,12 @@ static long writeData(dbCommon *record, format_t *format)
                     case DBF_FLOAT:
                         dval = ((epicsFloat32 *)wf->bptr)[nowd];
                         break;
-#ifdef DBF_INT64
+#ifdef DBR_INT64
                     case DBF_INT64:
-                        dval = ((epicsInt64 *)wf->bptr)[nowd];
+                        dval = (double)((epicsInt64 *)wf->bptr)[nowd];
                         break;
                     case DBF_UINT64:
-                        dval = ((epicsUInt64 *)wf->bptr)[nowd];
+                        dval = (double)((epicsUInt64 *)wf->bptr)[nowd];
                         break;
 #endif
                     case DBF_LONG:
@@ -211,12 +213,12 @@ static long writeData(dbCommon *record, format_t *format)
             {
                 switch (wf->ftvl)
                 {
-#ifdef DBF_INT64
+#ifdef DBR_INT64
                     case DBF_INT64:
-                        lval = ((epicsInt64 *)wf->bptr)[nowd];
+                        lval = (long)((epicsInt64 *)wf->bptr)[nowd];
                         break;
                     case DBF_UINT64:
-                        lval = ((epicsUInt64 *)wf->bptr)[nowd];
+                        lval = (long)((epicsUInt64 *)wf->bptr)[nowd];
                         break;
 #endif
                     case DBF_LONG:

src/makeStreamVersion.pl

@@ -0,0 +1,77 @@
+##########################################################################
+# This is a helper script for StreamDevice.
+# It generates a version file from git tags.
+#
+# (C) 2020 Dirk Zimoch (dirk.zimoch@psi.ch)
+#
+# This file is part of StreamDevice.
+#
+# StreamDevice is free software: You can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# StreamDevice is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with StreamDevice. If not, see https://www.gnu.org/licenses/.
+#########################################################################/
+
+use strict;
+
+
+my ( $major, $minor, $patch, $dev, $date, $hash );
+
+if (my $version = `git describe --tags --abbrev=0 --dirty --match "[0-9]*" 2>/dev/null`) {
+    if ($version =~ m/(\d+)\.(\d+)\.(\d+)?(.*)?/) {
+        $major = $1; $minor = $2; $patch = $3; $dev = $4;
+    }
+    if (`git log -1 --format="%H %ci"`=~ m/([[:xdigit:]]+) (.+)/) {
+        $hash = $1; $date = $2;
+    }
+}
+if (!$major) {
+    if (open(my $fh, '<', '../../.VERSION')) {
+        while (my $line = <$fh>) {
+            if ($line =~ m/COMMIT: *([[:xdigit:]]+)/) {
+                $hash = $1;
+            }
+            if ($line =~ m/REFS: .*tag: *(\d+)\.(\d+)\.?(\d+)?/) {
+                $major = $1; $minor = $2; $patch = $3 or $patch = 0;
+            }
+            if ($line =~ m/DATE: *([-0-9:+ ]*)/) {  
+                $date = $1;
+            }
+        }
+    } else {
+        print "neither git repo nor .VERSION file found\n";
+    }
+}
+
+open my $out, '>', @ARGV or die $!;
+print $out <<EOF;
+/* Generated file */
+
+#ifndef StreamVersion_h
+#define StreamVersion_h
+
+EOF
+if ($major) {
+    print $out <<EOF;
+#define STREAM_MAJOR $major
+#define STREAM_MINOR $minor
+#define STREAM_PATCHLEVEL $patch
+#define STREAM_DEV "$dev"
+EOF
+}
+if ($hash) {
+    print $out "#define STREAM_COMMIT_HASH \"$hash\"\n";
+}
+if ($date) {
+    print $out "#define STREAM_COMMIT_DATE \"$date\"\n";
+}
+print $out "#endif /* StreamVersion_h */\n";
+close $out

src/makedbd.pl

@@ -1,3 +1,25 @@
+##########################################################################
+# This is a helper script for StreamDevice.
+# It generates a file that registers StreamDevice interfaces with EPICS.
+#
+# (C) 2011 Dirk Zimoch (dirk.zimoch@psi.ch)
+#
+# This file is part of StreamDevice.
+#
+# StreamDevice is free software: You can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# StreamDevice is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with StreamDevice. If not, see https://www.gnu.org/licenses/.
+#########################################################################/
+
 if (@ARGV[0] eq "--rec-only") {
     shift;
 } else {
@@ -10,6 +32,9 @@ if (@ARGV[0] eq "-3.13") {
 } else {
     print "variable(streamDebug, int)\n";
     print "variable(streamError, int)\n";
+    print "variable(streamDebugColored, int)\n";
+    print "variable(streamErrorDeadTime, int)\n";
+    print "variable(streamMsgTimeStamped, int)\n";
     print "registrar(streamRegistrar)\n";
     if ($asyn) { print "registrar(AsynDriverInterfaceRegistrar)\n"; }
 }

src/makeref.pl

@@ -1,3 +1,25 @@
+##########################################################################
+# This is a helper script for StreamDevice.
+# It generates a file that makes sure all defined interfaces get linked.
+#
+# (C) 2011 Dirk Zimoch (dirk.zimoch@psi.ch)
+#
+# This file is part of StreamDevice.
+#
+# StreamDevice is free software: You can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# StreamDevice is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with StreamDevice. If not, see https://www.gnu.org/licenses/.
+#########################################################################/
+
 $t=@ARGV[0];
 shift;
 for (@ARGV) {

streamApp/Makefile

@@ -1,13 +1,28 @@
-TOP = ../..
-ifneq ($(wildcard ../../configure),)
-  include $(TOP)/configure/CONFIG
-else ifneq ($(wildcard ../../config),)
-  include $(TOP)/config/CONFIG_APP
-  include $(TOP)/config/RULES_ARCHS
-else
-  TOP= ..
-  include $(TOP)/configure/CONFIG
-endif
+##########################################################################
+# This is an EPICS 3.14+ Makefile for StreamDevice.
+# Normally it should not be necessary to modify this file.
+# All configuration can be done in CONFIG_STREAM
+#
+# (C) 2007,2018 Dirk Zimoch (dirk.zimoch@psi.ch)
+#
+# This file is part of StreamDevice.
+#
+# StreamDevice is free software: You can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# StreamDevice is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with StreamDevice. If not, see https://www.gnu.org/licenses/.
+#########################################################################/
+
+TOP= ..
+include $(TOP)/configure/CONFIG
 
 PROD = streamApp
 DBD  = streamApp.dbd
@@ -27,10 +42,12 @@ PROD_SRCS_vxWorks = -nil-
 PROD_LIBS = stream
 
 ifdef ASYN
-# edit asynRegistrars.dbd if necessary
-streamApp_DBD += asynRegistrars.dbd
-# add asynRecord.dbd if you like
-streamApp_DBD += asynRecord.dbd
+streamApp_DBD += asyn.dbd
+streamApp_DBD += drvAsynIPPort.dbd
+streamApp_DBD += drvAsynSerialPort.dbd
+# vxi11 support is optional in recent asyn versions
+#streamApp_DBD += drvVxi11.dbd
+
 PROD_LIBS += asyn
 # cygwin needs separate RPC library for asyn
 PROD_SYS_LIBS_cygwin32 += $(CYGWIN_RPC_LIB)
@@ -45,6 +62,10 @@ PROD_LIBS += sscan
 endif
 endif
 
+ifneq ($(words $(SNCSEQ) $(SYNAPPS)), 0)
+PROD_LIBS += seq pv
+endif
+
 streamApp_DBD += stream.dbd
 
 ifdef PCRE
@@ -59,6 +80,13 @@ endif
 
 PROD_LIBS += $(EPICS_BASE_IOC_LIBS)
 
+# Some linux systems moved RPC related symbols to libtirpc
+# Define TIRPC in configure/CONFIG_SITE in this case
+ifeq ($(TIRPC),YES)
+  USR_INCLUDES_Linux += -I/usr/include/tirpc
+  PROD_SYS_LIBS_DEFAULT += tirpc
+endif
+
 # switch off annoying rset warnings in 3.16+
 CPPFLAGS += -DUSE_TYPED_RSET
 

streamApp/Makefile.Host

@@ -1,3 +1,26 @@
+##########################################################################
+# This is an EPICS 3.13 Makefile for StreamDevice.
+# Normally it should not be necessary to modify this file.
+# All configuration can be done in CONFIG_STREAM
+#
+# (C) 2007,2018 Dirk Zimoch (dirk.zimoch@psi.ch)
+#
+# This file is part of StreamDevice.
+#
+# StreamDevice is free software: You can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# StreamDevice is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with StreamDevice. If not, see https://www.gnu.org/licenses/.
+#########################################################################/
+
 TOP = ../..
 ifneq ($(wildcard ../../../config),)
 TOP = ../../..

streamApp/Makefile.Vx

@@ -1,3 +1,26 @@
+##########################################################################
+# This is an EPICS 3.13 Makefile for StreamDevice.
+# Normally it should not be necessary to modify this file.
+# All configuration can be done in CONFIG_STREAM
+#
+# (C) 2007,2018 Dirk Zimoch (dirk.zimoch@psi.ch)
+#
+# This file is part of StreamDevice.
+#
+# StreamDevice is free software: You can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# StreamDevice is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with StreamDevice. If not, see https://www.gnu.org/licenses/.
+#########################################################################/
+
 TOP = ../..
 ifneq ($(wildcard ../../../config),)
 TOP = ../../..

streamApp/asynRegistrars.dbd

@@ -1,9 +0,0 @@
-registrar(asynRegister)
-registrar(asynInterposeFlushRegister)
-registrar(asynInterposeEosRegister)
-
-# asynDriver up to version 4-16 does not support serial port for Windows!
-registrar(drvAsynSerialPortRegisterCommands)
-registrar(drvAsynIPPortRegisterCommands)
-registrar(drvAsynIPServerPortRegisterCommands)
-registrar(vxi11RegisterCommands)

streamApp/checksums.cmd

@@ -1,4 +1,25 @@
 #!/bin/sh
+##########################################################################
+# This is an example and debug EPICS startup script for StreamDevice.
+#
+# (C) 2010 Dirk Zimoch (dirk.zimoch@psi.ch)
+#
+# This file is part of StreamDevice.
+#
+# StreamDevice is free software: You can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# StreamDevice is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with StreamDevice. If not, see https://www.gnu.org/licenses/.
+#########################################################################/
+
 exec O.$EPICS_HOST_ARCH/streamApp $0
 dbLoadDatabase "O.Common/streamApp.dbd"
 streamApp_registerRecordDeviceDriver

streamApp/checksums.db

@@ -1,3 +1,24 @@
+##########################################################################
+# This is an example and debug EPICS database for StreamDevice.
+#
+# (C) 2010 Dirk Zimoch (dirk.zimoch@psi.ch)
+#
+# This file is part of StreamDevice.
+#
+# StreamDevice is free software: You can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# StreamDevice is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with StreamDevice. If not, see https://www.gnu.org/licenses/.
+#########################################################################/
+
 record (stringout, "DZ:checksums")
 {
     field (DTYP, "stream")

streamApp/checksums.proto

@@ -1,3 +1,24 @@
+##########################################################################
+# This is an example and debug protocol file for StreamDevice.
+#
+# (C) 2010 Dirk Zimoch (dirk.zimoch@psi.ch)
+#
+# This file is part of StreamDevice.
+#
+# StreamDevice is free software: You can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# StreamDevice is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with StreamDevice. If not, see https://www.gnu.org/licenses/.
+#########################################################################/
+
 Terminator = NL;
 
 # Output string, checksum name and checksum value
@@ -33,4 +54,6 @@ write {
     out "%s  hexsum8   %0.12<hexsum8>";
     out "%s  cpi       %0.12<cpi>";
     out "%s  leybold   %0.12<leybold>";
+    out "%s  lrc       %0.12<lrc>";
+    out "%s  hexlrc    %0.12<hexlrc>";
 }

streamApp/example-3-13.cmd

@@ -1,3 +1,24 @@
+##########################################################################
+# This is an example and debug EPICS startup script for StreamDevice.
+#
+# (C) 2010 Dirk Zimoch (dirk.zimoch@psi.ch)
+#
+# This file is part of StreamDevice.
+#
+# StreamDevice is free software: You can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# StreamDevice is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with StreamDevice. If not, see https://www.gnu.org/licenses/.
+#########################################################################/
+
 BIN="<library directory>"
 DBD="<dbd directory>"
 HOME="<ioc home direcory>"

streamApp/example.cmd

@@ -1,4 +1,25 @@
 #!/bin/sh
+##########################################################################
+# This is an example and debug EPICS startup script for StreamDevice.
+#
+# (C) 2010 Dirk Zimoch (dirk.zimoch@psi.ch)
+#
+# This file is part of StreamDevice.
+#
+# StreamDevice is free software: You can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# StreamDevice is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with StreamDevice. If not, see https://www.gnu.org/licenses/.
+#########################################################################/
+
 exec O.$EPICS_HOST_ARCH/streamApp $0
 dbLoadDatabase "O.Common/streamApp.dbd"
 streamApp_registerRecordDeviceDriver

streamApp/example.db

@@ -1,3 +1,24 @@
+##########################################################################
+# This is an example and debug EPICS database for StreamDevice.
+#
+# (C) 2010 Dirk Zimoch (dirk.zimoch@psi.ch)
+#
+# This file is part of StreamDevice.
+#
+# StreamDevice is free software: You can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# StreamDevice is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with StreamDevice. If not, see https://www.gnu.org/licenses/.
+#########################################################################/
+
 # process this record to reload all stream protocols
 record (sub, "$(PREFIX):reload")
 {

streamApp/example.proto

@@ -1,3 +1,24 @@
+##########################################################################
+# This is an example and debug protocol file for StreamDevice.
+#
+# (C) 2010 Dirk Zimoch (dirk.zimoch@psi.ch)
+#
+# This file is part of StreamDevice.
+#
+# StreamDevice is free software: You can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# StreamDevice is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with StreamDevice. If not, see https://www.gnu.org/licenses/.
+#########################################################################/
+
 # example stream protocol file
 
 Terminator = CR LF;

streamApp/regexp.cmd

@@ -1,4 +1,25 @@
 #!/bin/sh
+##########################################################################
+# This is an example and debug EPICS startup script for StreamDevice.
+#
+# (C) 2010 Dirk Zimoch (dirk.zimoch@psi.ch)
+#
+# This file is part of StreamDevice.
+#
+# StreamDevice is free software: You can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# StreamDevice is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with StreamDevice. If not, see https://www.gnu.org/licenses/.
+#########################################################################/
+
 exec O.$EPICS_HOST_ARCH/streamApp $0
 dbLoadDatabase "O.Common/streamApp.dbd"
 streamApp_registerRecordDeviceDriver

streamApp/regexp.db

@@ -1,3 +1,24 @@
+##########################################################################
+# This is an example and debug EPICS database for StreamDevice.
+#
+# (C) 2010 Dirk Zimoch (dirk.zimoch@psi.ch)
+#
+# This file is part of StreamDevice.
+#
+# StreamDevice is free software: You can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# StreamDevice is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with StreamDevice. If not, see https://www.gnu.org/licenses/.
+#########################################################################/
+
 record (stringin, "DZ:regexp")
 {
     field (DTYP, "stream")

streamApp/regexp.proto

@@ -1,3 +1,24 @@
+##########################################################################
+# This is an example and debug protocol file for StreamDevice.
+#
+# (C) 2010 Dirk Zimoch (dirk.zimoch@psi.ch)
+#
+# This file is part of StreamDevice.
+#
+# StreamDevice is free software: You can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# StreamDevice is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with StreamDevice. If not, see https://www.gnu.org/licenses/.
+#########################################################################/
+
 # regular expression example
 # extract the title of from a web page
 

streamApp/simple.cmd

@@ -1,4 +1,25 @@
 #!/bin/sh
+##########################################################################
+# This is an example and debug EPICS startup script for StreamDevice.
+#
+# (C) 2010 Dirk Zimoch (dirk.zimoch@psi.ch)
+#
+# This file is part of StreamDevice.
+#
+# StreamDevice is free software: You can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# StreamDevice is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with StreamDevice. If not, see https://www.gnu.org/licenses/.
+#########################################################################/
+
 exec O.$EPICS_HOST_ARCH/streamApp $0
 dbLoadDatabase "O.Common/streamApp.dbd"
 streamApp_registerRecordDeviceDriver

streamApp/simple.db

@@ -1,3 +1,24 @@
+##########################################################################
+# This is an example and debug EPICS database for StreamDevice.
+#
+# (C) 2010 Dirk Zimoch (dirk.zimoch@psi.ch)
+#
+# This file is part of StreamDevice.
+#
+# StreamDevice is free software: You can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# StreamDevice is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with StreamDevice. If not, see https://www.gnu.org/licenses/.
+#########################################################################/
+
 record (stringout, "$(P):cmd")
 {
     field (DTYP, "stream")

streamApp/simple.proto

@@ -1,4 +1,25 @@
-terminator = CR LF;
+##########################################################################
+# This is an example and debug protocol file for StreamDevice.
+#
+# (C) 2010 Dirk Zimoch (dirk.zimoch@psi.ch)
+#
+# This file is part of StreamDevice.
+#
+# StreamDevice is free software: You can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# StreamDevice is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with StreamDevice. If not, see https://www.gnu.org/licenses/.
+#########################################################################/
+
+terminator = LF;
 
 cmd {
     out "%s";