Merge branch 'master' of github.com:paulscherrerinstitute/StreamDevice

Updated more EPICS web links.  SynApps link was actually broken

.cvsignore

@@ -0,0 +1,7 @@
+O.*
+*~
+bin
+lib
+dbd
+include
+*.pdf

.gitignore

@@ -0,0 +1,8 @@
+O.*
+*~
+bin
+lib
+dbd
+include
+*.pdf
+*.*log

GNUmakefile

@@ -0,0 +1,53 @@
+ifeq ($(wildcard /ioc/tools/driver.makefile),)
+$(info If you are not using the PSI build environment, GNUmakefile can be removed.)
+include Makefile
+else
+include /ioc/tools/driver.makefile
+EXCLUDE_VERSIONS = 3.13.2
+PROJECT=stream
+BUILDCLASSES += Linux
+
+DOCUDIR = docs
+
+PCRE=1
+ASYN=1
+ifdef EPICSVERSION
+ifndef RECORDTYPES
+include src/CONFIG_STREAM
+export RECORDTYPES BUSSES FORMATS
+endif
+endif
+
+SOURCES += $(RECORDTYPES:%=src/dev%Stream.c)
+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
+
+StreamCore.o StreamCore.d: streamReferences
+
+# Update version string (contains __DATE__ and __TIME__)
+# each time make runs.
+StreamVersion.o: FORCE
+FORCE:
+
+streamReferences:
+	$(PERL) ../src/makeref.pl Interface $(BUSSES) > $@
+	$(PERL) ../src/makeref.pl Converter $(FORMATS) >> $@
+
+export DBDFILES = streamSup.dbd
+streamSup.dbd:
+	@echo Creating $@ from $(RECORDTYPES)
+	$(PERL) ../src/makedbd.pl $(RECORDTYPES) > $@
+ifdef BASE_3_14
+ifdef ASYN
+	echo "registrar(AsynDriverInterfaceRegistrar)" >> $@
+endif
+endif
+
+endif

Makefile

@@ -1,65 +1,26 @@
-include /ioc/tools/driver.makefile
-EXCLUDE_VERSIONS = 3.13.2
-PROJECT=stream2
-BUILDCLASSES += Linux
-
-#DOCUDIR = doc
-
-DBDS = stream.dbd
-
-BUSSES  += AsynDriver
-FORMATS += Enum
-FORMATS += BCD
-FORMATS += Raw
-FORMATS += RawFloat
-FORMATS += Binary
-FORMATS += Checksum
-FORMATS += Regexp
-FORMATS += Exponential
-RECORDTYPES += aai aao
-RECORDTYPES += ao ai
-RECORDTYPES += bo bi
-RECORDTYPES += mbbo mbbi
-RECORDTYPES += mbboDirect mbbiDirect
-RECORDTYPES += longout longin
-RECORDTYPES += stringout stringin
-RECORDTYPES += waveform
-
-SOURCES += $(RECORDTYPES:%=src/dev%Stream.c)
-SOURCES += $(FORMATS:%=src/%Converter.cc)
-SOURCES += $(BUSSES:%=src/%Interface.cc)
-SOURCES += $(wildcard src/Stream*.cc)
-SOURCES += src/StreamVersion.c
-SOURCES_3.14 += src/devcalcoutStream.c
-
-ifeq (${EPICS_BASETYPE},3.13)
-USR_INCLUDES += -include $(INSTALL_INCLUDE)/compat3_13.h
-endif
-
-StreamCore.o: streamReferences
-
-streamReferences:
-	@for i in $(BUSSES); \
-	do echo "extern void* ref_$${i}Interface;"; \
-           echo "void* p$$i = ref_$${i}Interface;"; \
-	done > $@
-	@for i in $(FORMATS); \
-	do echo "extern void* ref_$${i}Converter;"; \
-           echo "void* p$$i = ref_$${i}Converter;"; \
-	done >> $@
-
-ifeq (${EPICS_BASETYPE},3.13)
-stream.dbd:
-	@for r in $(RECORDTYPES); \
-	do echo "device($$r,INST_IO,dev$${r}Stream,\"stream\")"; \
-	done > $@
-	@echo "driver(stream)" >> $@
+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
-stream.dbd:
-	@for r in $(RECORDTYPES) calcout; \
-	do echo "device($$r,INST_IO,dev$${r}Stream,\"stream\")"; \
-	done > $@
-	@echo "driver(stream)" >> $@
-	@echo "variable(streamDebug, int)" >> $@
-	@echo "registrar(streamRegistrar)" >> $@
+  # Using our own local configuration
+  TOP = .
+  DIRS = config configure 
+  src_DEPEND_DIRS := $(DIRS)
+  include $(TOP)/configure/CONFIG
 endif
+
+DIRS += src
+DIRS += streamApp
+streamApp_DEPEND_DIRS = src
+
+include $(CONFIG)/RULES_TOP
+
+docs/stream.pdf: docs/*.html docs/*.css docs/*.png
+	cd docs; makepdf
+
+pdf: docs/stream.pdf

README.md

@@ -0,0 +1,20 @@
+# StreamDevice
+
+_StreamDevice_ is a generic [EPICS](https://epics.anl.gov/)
+device support for devices with a "byte stream" based
+communication interface.
+That means devices that can be controlled by sending and receiving
+strings (in the broadest sense, including non-printable characters
+and even null-bytes). 
+Examples for this type of communication interface are
+serial line (RS-232, RS-485, ...), 
+IEEE-488 (also known as GPIB or HP-IB), and telnet-like TCP/IP.
+
+_StreamDevice_ is not limited to a specific device type or manufacturer
+nor is it necessary to re-compile anything to support a new device type.
+Instead, it can be configured for any device type with _protocol files_
+in plain ASCII text which describes the commands a device understands
+and the replies it sends.
+
+For a full documentation see
+https://paulscherrerinstitute.github.io/StreamDevice.

config/CONFIG_APP

@@ -0,0 +1,12 @@
+#CONFIG_APP 
+include $(TOP)/configure/RELEASE
+-include $(TOP)/configure/RELEASE.$(HOST_ARCH)
+-include $(EPICS_BASE)/config/CONFIG
+INSTALL_LOCATION = $(TOP)
+ifdef INSTALL_LOCATION_APP
+INSTALL_LOCATION = $(INSTALL_LOCATION_APP)
+endif
+
+ifdef T_A
+-include $(TOP)/config/O.$(T_A)/CONFIG_APP_INCLUDE
+endif

config/Makefile

@@ -0,0 +1,7 @@
+TOP=..
+include $(TOP)/config/CONFIG_APP
+ifneq ($(wildcard $(EPICS_BASE)/config),)
+include $(EPICS_BASE)/config/RULES_ARCHS
+else
+build install clean realclean:
+endif

config/Makefile.Host

@@ -0,0 +1,20 @@
+#
+# $Id: Makefile.Host,v 1.1.1.1 2000/04/05 07:33:44 janousch Exp $
+#
+
+TOP=../..
+include $(TOP)/config/CONFIG_APP
+
+TARGETS = CONFIG_APP_INCLUDE
+
+include $(TOP)/config/RULES.Host
+
+inc:: $(TARGETS)
+
+ifeq ($(wildcard $(TOP)/configure/RELEASE.$(HOST_ARCH)),$(TOP)/configure/RELEASE.$(HOST_ARCH))
+CONFIG_APP_INCLUDE: $(TOP)/configure/RELEASE.$(HOST_ARCH)
+endif
+
+CONFIG_APP_INCLUDE: $(TOP)/configure/RELEASE $(TOP)/config/CONFIG_APP
+	$(RM) $@
+	@$(PERL) $(TOP)/config/makeConfigAppInclude.pl $(T_A) $@ $(TOP)

config/Makefile.Vx

@@ -0,0 +1,15 @@
+#
+# Makefile.Vx,v 1.1.2.3 2001/09/14 19:39:15 anj Exp
+#
+
+TOP=../..
+include $(TOP)/config/CONFIG_APP
+
+TARGETS = CONFIG_APP_INCLUDE
+
+include $(EPICS_BASE)/config/RULES.Vx
+
+inc:: $(TARGETS)
+
+CONFIG_APP_INCLUDE: $(wildcard $(TOP)/config/RELEASE*) $(TOP)/config/CONFIG_APP
+	$(PERL) $(TOP)/config/convertRelease.pl -h $(HOST_ARCH) $@

config/RULES.Host

@@ -0,0 +1,3 @@
+#RULES.Host
+
+include $(EPICS_BASE)/config/RULES.Host

config/RULES.munch

@@ -1,12 +1,14 @@
-MUNCH = $(PERL) $(INSTALL_LOCATION)/bin/$(HOST_ARCH)/munch.pl
-
 # The original 3.13.10 munching rule does not really work well
 
+# This is the munch.pl taken from EPICS base 3.14.8.2
+MUNCH = $(PERL) ../../config/munch.pl
+
 build:: $(LIBNAME).munch
 
 buildInstall:: $(INSTALL_BIN)/$(LIBNAME).munch
 
 %.munch: %
+	@echo "Munching $<"
 	$(RM) $*_ctct.o $*_ctdt.c
 	$(NM) $< | $(MUNCH) > $*_ctdt.c
 	$(GCC) -traditional $(CFLAGS) -fdollars-in-identifiers -c $(SOURCE_FLAG) $*_ctdt.c

config/RULES_ARCHS

@@ -0,0 +1,2 @@
+#RULES_ARCHS
+include $(EPICS_BASE)/config/RULES_ARCHS

config/RULES_DIRS

@@ -0,0 +1,2 @@
+#RULES_DIRS
+include $(EPICS_BASE)/config/RULES_DIRS

config/convertRelease.pl

@@ -0,0 +1,186 @@
+eval 'exec perl -S $0 ${1+"$@"}'  # -*- Mode: perl -*-
+    if $running_under_some_shell; # convertRelease.pl
+#
+# convertRelease.pl,v 1.1.2.1 2001/09/14 19:39:15 anj Exp
+#
+# Parse config/RELEASE file(s) and generate a derived output file.
+#
+# This tool replaces makeConfigAppInclude.pl and makeIocCdCommands.pl
+# and adds consistency checks for RELEASE files.
+#
+
+use Cwd;
+use Getopt::Std;
+
+$cwd = cwd();
+$cwd =~ s/\/tmp_mnt//;	# hack for sun4
+$cwd =~ s/\\/\//g;	# hack for win32
+
+getopt "aht";
+
+if ($opt_a) {
+    $arch = $opt_a;
+} else {		# Look for O.<arch> in current path
+    $_ = $cwd;
+    ($arch) = /.*\/O.([\w-]+)$/;
+}
+
+$hostarch = $arch;
+$hostarch = $opt_h if ($opt_h);
+
+if ($opt_t) {
+    $top = $opt_t;
+} else {		# Find $top from current path
+    $top = $cwd;
+    $top =~ s/\/iocBoot.*//;
+    $top =~ s/\/config\/O\..*//;
+}
+
+unless (@ARGV == 1) {
+    print "Usage: convertRelease.pl [-a arch] [-h hostarch] [-t top] outfile\n";
+    print "   where outfile is be one of:\n";
+    print "\tcheckRelease - checks consistency with support apps\n";
+    print "\tcdCommands - generate cd path strings for IOC use\n";
+    print "\tCONFIG_APP_INCLUDE - additional build variables\n";
+    exit 2;
+}
+$outfile = $ARGV[0];
+
+# TOP refers to this application
+%macros = (TOP => $top);
+@apps   = (TOP);	# Provides the order of apps in RELEASE file
+
+# Read the RELEASE file(s)
+$relfile = "$top/configure/RELEASE";
+die "Can't find configure/RELEASE file" unless (-r $relfile);
+&readRelease($relfile, \%macros, \@apps);
+
+if ($hostarch) {
+    $relfile .= ".$hostarch";
+    &readRelease($relfile, \%macros, \@apps) if (-r $relfile);
+}
+
+# This is a perl switch statement:
+for ($outfile) {
+    /CONFIG_APP_INCLUDE/ and do { &configAppInclude;	last; };
+    /cdCommands/	 and do { &cdCommands;		last; };
+    /checkRelease/	 and do { &checkRelease;	last; };
+    die "Output file type \'$outfile\' not supported";
+}
+
+sub readRelease {
+    my ($file, $Rmacros, $Rapps) = @_;
+    # $Rmacros is a reference to a hash, $Rapps a ref to an array
+    my ($pre, $macro, $post, $path);
+    local *IN;
+    open(IN, $file) or die "Can't open $file: $!\n";
+    while (<IN>) {
+	chomp;
+	s/\s*#.*$//;		# Remove trailing comments
+        next if /^\s*$/;	# Skip blank lines
+	
+	# Expand all macros in the line:
+	while (($pre,$macro,$post) = /(.*)\$\((\w+)\)(.*)/, $macro ne "") {
+	    $_ = $pre . $Rmacros->{$macro} . $post;
+	}
+	
+	# Handle "<macro> = <path>"
+	($macro, $path) = /^\s*(\w+)\s*=\s*(.*)/;
+	if ($macro ne "") {
+	    $Rmacros->{$macro} = $path;
+	    push @$Rapps, $macro;
+	    next;
+	}
+	# Handle "include <path>" syntax
+	($path) = /^\s*include\s+(.*)/;
+	&readRelease($path, $Rmacros, $Rapps) if (-r $path);
+    }
+    close IN;
+}
+
+sub configAppInclude {
+    @includes = grep !/^(TOP|TEMPLATE_TOP)$/, @apps;
+    
+    unlink($outfile);
+    open(OUT,">$outfile") or die "$! creating $outfile";
+    print OUT "# Do not modify this file, changes made here will\n";
+    print OUT "# be lost when the application is next rebuilt.\n\n";
+    
+    if ($arch) {
+	foreach $app (@includes) {
+            $path = $macros{$app};
+	    next unless (-d "$path/bin/$arch");
+	    print OUT "${app}_BIN = \$($app)/bin/$arch\n";
+	}
+	foreach $app (@includes) {
+            $path = $macros{$app};
+            next unless (-d "$path/lib/$arch");
+	    print OUT "${app}_LIB = \$($app)/lib/$arch\n";
+	}
+    }
+    foreach $app (@includes) {
+        $path = $macros{$app};
+        next unless (-d "$path/include");
+	print OUT "EPICS_INCLUDES += -I\$($app)/include\n";
+    }
+    foreach $app (@includes) {
+        $path = $macros{$app};
+        next unless (-d "$path/dbd");
+        print OUT "EPICS_DBDFLAGS += -I \$($app)/dbd\n";
+    }
+    close OUT;
+}
+
+sub cdCommands {
+    die "Architecture not set (use -a option)" unless ($arch);
+    @includes = grep !/^TEMPLATE_TOP$/, @apps;
+    
+    # if -t <top> was given, substitute it in the startup path
+    $startup = $cwd;
+    $startup =~ s/.*(\/iocBoot\/.*)/$top$1/ if ($opt_t);
+    
+    unlink($outfile);
+    open(OUT,">$outfile") or die "$! creating $outfile";
+    print OUT "startup = \"$startup\"\n";
+    print OUT "appbin = \"$top/bin/$arch\"\n";	# compatibility with R3.13.1
+    
+    foreach $app (@includes) {
+        $path = $macros{$app};
+	$lcapp = lc($app);
+        print OUT "$lcapp = \"$path\"\n" if (-d $path);
+	print OUT "${lcapp}bin = \"$path/bin/$arch\"\n" if (-d "$path/bin/$arch");
+    }
+    close OUT;
+}
+
+sub checkRelease {
+    $status = 0;
+    delete $macros{TOP};
+    delete $macros{TEMPLATE_TOP};
+    
+    while (($app, $path) = each %macros) {
+	%check = (TOP => $path);
+	@order = ();
+	$relfile = "$path/config/RELEASE";
+	&readRelease($relfile, \%check, \@order) if (-r $relfile);
+	if ($hostarch) {
+	    $relfile .= ".$hostarch";
+	    &readRelease($relfile, \%check, \@order) if (-r $relfile);
+	}
+	delete $check{TOP};
+	
+	while (($parent, $ppath) = each %check) {
+	    if (exists $macros{$parent} && ($macros{$parent} ne $ppath)) {
+		print "\n" unless ($status);
+		print "Definition of $parent conflicts with $app support.\n";
+		print "In this application config/RELEASE defines\n";
+		print "\t$parent = $macros{$parent}\n";
+		print "but $app at $path has\n";
+		print "\t$parent = $ppath\n";
+		$status = 1;
+	    }
+	}
+    }
+    print "\n" if ($status);
+    exit $status;
+}

config/makeConfigAppInclude.pl

@@ -0,0 +1,62 @@
+# $Id: makeConfigAppInclude.pl,v 1.1.1.1 2000/04/05 07:33:44 janousch Exp $ 
+
+eval 'exec perl -S $0 ${1+"$@"}'  # -*- Mode: perl -*-
+    if $running_under_some_shell; # makeConfigAppInclude.pl
+
+use Cwd;
+
+$arch = $ARGV[0];
+$outfile = $ARGV[1];
+$top = $ARGV[2];
+
+unlink("${outfile}");
+open(OUT,">${outfile}") or die "$! opening ${outfile}";
+print OUT "#Do not modify this file.\n";
+print OUT "#This file is created during the build.\n";
+
+@files =();
+push(@files,"$top/config/RELEASE");
+push(@files,"$top/config/RELEASE.${arch}");
+foreach $file (@files) {
+  if (-r "$file") {
+    open(IN, "$file") or die "Cannot open $file\n";
+    while ($line = <IN>) {
+        next if ( $line =~ /\s*#/ );
+	chomp($line);
+        $_ = $line;
+        #the following looks for
+        # prefix = $(macro)post
+        ($prefix,$macro,$post) = /(.*)\s*=\s*\$\((.*)\)(.*)/;
+        if ($macro eq "") { # true if no macro is present
+            # the following looks for
+            # prefix = post
+            ($prefix,$post) = /(.*)\s*=\s*(.*)/;
+        } else {
+            $base = $applications{$macro};
+            if ($base eq "") {
+                #print "error: $macro was not previously defined\n";
+            } else {
+                $post = $base . $post;
+            }
+        }
+        $applications{$prefix} = $post;
+        if ( -d "$post") { #check that directory exists
+            print OUT "\n";
+            if ( -d "$post/bin/$arch") { #check that directory exists
+                print OUT "${prefix}_BIN = $post/bin/${arch}\n";
+            }
+            if ( -d "$post/lib/$arch") { #check that directory exists
+                print OUT "${prefix}_LIB = $post/lib/${arch}\n";
+            }
+            if ( -d "$post/include") { #check that directory exists
+                print OUT "EPICS_INCLUDES += -I$post/include\n";
+            }
+            if ( -d "$post/dbd") { #check that directory exists
+                print OUT "EPICS_DBDFLAGS += -I $post/dbd\n";
+            }
+        }
+    }
+    close IN;
+  }
+}
+close OUT;

configure/CONFIG

@@ -0,0 +1,14 @@
+#CONFIG
+include $(TOP)/configure/CONFIG_APP
+# Add any changes to make definitions here
+
+#CROSS_COMPILER_TARGET_ARCHS = vxWorks-68040
+#CROSS_COMPILER_TARGET_ARCHS = 
+
+# 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>

configure/CONFIG_APP

@@ -0,0 +1,27 @@
+# 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/Makefile

@@ -0,0 +1,15 @@
+# Makefile
+
+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
+
+TARGETS = $(CONFIG_TARGETS)
+CONFIGS += $(subst ../,,$(wildcard $(CONFIG_INSTALLS)))
+
+include $(TOP)/configure/RULES
+

configure/RELEASE

@@ -0,0 +1,43 @@
+#RELEASE Location of external products
+# Run "gnumake clean uninstall install" in the application
+# top directory each time this file is changed.
+#
+# NOTE: The build does not check dependencies on files
+# external to this application. Thus you should run
+# "gnumake clean uninstall install" in the top directory
+# each time EPICS_BASE, SNCSEQ, or any other external
+# module defined in the RELEASE file is rebuilt.
+
+TEMPLATE_TOP=$(EPICS_BASE)/templates/makeBaseApp/top
+
+# If you don't want to install into $(TOP) then
+# define INSTALL_LOCATION_APP here
+#INSTALL_LOCATION_APP=<fullpathname>
+
+
+EPICS_BASE=/usr/local/epics/base-3.16.1
+ASYN=~/top-3.16/asyn4-30
+CALC=~/top-3.16/SynApps/calc-2-8
+PCRE=~/top-3.16/pcre-7-2
+PCRE_INCLUDE_SL6-x86=/usr/include
+PCRE_INCLUDE_SL6-x86_64=/usr/include
+PCRE_INCLUDE_SL6-x86_64-clang=/usr/include
+
+#EPICS_BASE=/usr/local/epics/base-3.15.5
+#ASYN=~/top-3.15/asyn4-30
+#CALC=~/top-3.15/SynApps/calc-2-8
+#PCRE=~/top-3.15/pcre-7-2
+
+#EPICS_BASE=/usr/local/epics/base-3.14.12
+#ASYN=~/top/asyn4-30
+#CALC=~/top/SynApps/calc-2-8
+#PCRE=~/top/pcre-7-2
+
+#3.14.8 does not understand ~
+#EPICS_BASE=/usr/local/epics/base-3.14.8
+#ASYN=/afs/psi.ch/user/z/zimoch/top/asyn-4.10
+
+##Example 3.13 build
+#EPICS_BASE=/usr/local/epics/base-3.13.10
+#ASYN=/afs/psi.ch/user/z/zimoch/top_3.13/4-6
+#COMPAT=/afs/psi.ch/user/z/zimoch/top_3.13

configure/RULES

@@ -0,0 +1,9 @@
+#CONFIG
+ifneq ($(wildcard $(EPICS_BASE)/configure),)
+include $(EPICS_BASE)/configure/RULES
+else
+include $(EPICS_BASE)/config/RULES_ARCHS
+endif
+
+# Library should be rebuilt because LIBOBJS may have changed.
+$(LIBNAME): ../Makefile

doc/formatconverter.html

@@ -1,20 +0,0 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
-    "http://www.w3.org/TR/html4/loose.dtd">
-<html>
-<head>
-<title>StreamDevice: Format Converter API</title>
-<link rel="shortcut icon" href="sls_icon.ico">
-<link rel="stylesheet" type="text/css" href="stream.css">
-<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-<meta name="author" content="Dirk Zimoch">
-</head>
-<body>
-<h1>StreamDevice: Format Converter API</h1>
-
-<h2>Sorry, this documentation is still missing.</h2>
-
-<hr>
-<p><small>Dirk Zimoch, 2006</small></p>
-<script src="stream.js" type="text/javascript"></script>
-</body>
-</html>

doc/formats.html

@@ -1,480 +0,0 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
-    "http://www.w3.org/TR/html4/loose.dtd">
-<html>
-<head>
-<title>StreamDevice: Format Converters</title>
-<link rel="shortcut icon" href="sls_icon.ico">
-<link rel="stylesheet" type="text/css" href="stream.css">
-<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-<meta name="author" content="Dirk Zimoch">
-</head>
-<body>
-<h1>StreamDevice: Format Converters</h1>
-
-<a name="syntax"></a>
-<h2>1. Format Syntax</h2>
-<p>
-<em>StreamDevice</em> format converters work very similar to the format
-converters of the C functions <em>printf()</em> and <em>scanf()</em>.
-But <em>StreamDevice</em> provides more different converters and you can
-also write your own converters.
-Formats are specified in <a href="protocol.html#str">quoted strings</a>
-as arguments of <code>out</code> or <code>in</code>
-<a href="protocol.html#cmd">commands</a>.
-</p>
-<p>
-A format converter consists of
-</p>
-<ul>
- <li>The <code>%</code> character</li>
- <li>Optionally a field name in <code>()</code></li>
- <li>Optionally flags out of the characters <code>*# +0-</code></li>
- <li>Optionally an integer <em>width</em> field</li>
- <li>Optionally a period character (<code>.</code>) followed
-     by an integer <em>precision</em> field (input ony for most formats)</li>
- <li>A conversion character</li>
- <li>Additional information required by some converters</li>
-</ul>
-
-<p>
-The <code>*</code> flag skips data in input formats.
-Input is consumed and parsed, a mismatch is an error, but the read
-data is dropped.
-This is useful if input contains more than one value.
-Example: <code>in "%*f%f";</code> reads the second floating point
-number.
-</p>
-<p>
-The <code>#</code> flag may alter the format, depending on the
-converter (see below).
-</p>
-<p>
-The '<code> </code>' (space) and <code>+</code> flags print a space
-or a <code>+</code> sign before positive numbers, where negative
-numbers would have a <code>-</code>.
-</p>
-<p>
-The <code>0</code> flag says that numbers should be left padded with
-<code>0</code> if <em>width</em> is larger than required.
-</p>
-<p>
-The <code>-</code> flag specifies that output is left justified if
-<em>width</em> is larger than required.
-</p>
-
-<h3>Examples:</h3>
-<table>
- <tr>
-  <td><code>in "%f";</code></td>
-  <td>float</td>
- </tr>
- <tr>
-  <td><code>out "%(HOPR)7.4f";</code></td>
-  <td>the HOPR field as 7 char float with precision 4</td>
- </tr>
- <tr>
-  <td><code>out "%#010x";</code></td>
-  <td>0-padded 10 char alternate hex (with leading 0x)</td>
- </tr>
- <tr>
-  <td><code>in "%[_a-zA-Z0-9]";</code></td>
-  <td>string of chars out of a charset</td>
- </tr>
- <tr>
-  <td><code>in "%*i";</code></td>
-  <td>skipped integer number</td>
- </tr>
-</table>
-
-<a name="types"></a>
-<h2>2. Data Types and Record Fields</h2>
-<h3>Default fields</h3>
-<p>
-Every conversion character corresponds to one of the data types DOUBLE,
-LONG, ENUM, or STRING.
-In opposite to to <em>printf()</em> and <em>scanf()</em>, it is not
-required to specify a variable for the conversion.
-The variable is typically the <code>VAL</code> or <code>RVAL</code> field
-of the record, selected automatically depending on the data type.
-Not all data types make sense for all record types.
-Refer to the description of <a href="recordtypes.html">supported record
-types</a> for details.
-</p>
-<p>
-<em>StreamDevice</em> makes no difference between <code>float</code>
-and <code>double</code> nor between <code>short</code>, <code>int</code>
-and <code>long</code> values.
-Thus, data type modifiers like <code>l</code> or <code>h</code> do not
-exist in <em>StreamDevice</em> formats.
-</p>
-
-<h3>Accessing record fields directly</h3>
-<p>
-To use other fields of the record or even fields of other records on the
-same IOC for the conversion, write the field name in parentheses directly
-after the <code>%</code>.
-For example <code>out&nbsp;"%(EGU)s";</code> outputs the <code>EGU</code>
-field formatted as a string.
-Use <code>in&nbsp;"%(<i>otherrecord</i>.VAL)f";</code> to write the floating
-point input value into the <code>VAL</code> field of
-<code><i>otherrecord</i></code>.
-(You can't skip <code>.VAL</code> here.)
-This is very useful when one line of input contains many values that should
-be distributed to many records.
-If <code><i>otherrecord</i></code> is passive and the field has the PP
-attribute (see
-<a href="http://www.aps.anl.gov/asd/controls/epics/EpicsDocumentation/AppDevManuals/RecordRef/Recordref-1.html"
-target="ex">Record Reference Manual</a>), the record will be processed.
-It is your responsibility that the data type of the record field is
-compatible to the the data type of the converter.
-Note that using this syntax is by far not as efficient as using the
-default field.
-</p>
-
-<h3>Pseudo-converters</h3>
-<p>
-Some formats are not actually converters.
-They format data which is not stored in a record field, such as a
-<a href="#chksum">checksum</a>.
-No data type corresponds to those <em>pseudo-converters</em> and the
-<code>%(<em>FIELD</em>)</code> syntax cannot be used.
-</p>
-
-<a name="stdd"></a>
-<h2>3. Standard DOUBLE Converters (<code>%f</code>, <code>%e</code>,
-<code>%E</code>, <code>%g</code>, <code>%G</code>)</h2>
-<p>
-In output, <code>%f</code> prints fixed point, <code>%e</code> prints
-exponential notation and <code>%g</code> prints either fixed point or
-exponential depending on the magnitude of the value.
-<code>%E</code> and <code>%G</code> use <code>E</code> instead of
-<code>e</code> to separate the exponent.
-With the <code>#</code> flag, output always contains a period character.
-</p>
-<p>
-In input, all these formats are equivalent.
-Leading whitespaces are skipped.
-</p>
-
-<a name="stdl"></a>
-<h2>4. Standard LONG Converters (<code>%d</code>, <code>%i</code>,
-<code>%u</code>, <code>%o</code>, <code>%x</code>, <code>%X</code>)</h2>
-<p>
-In output, <code>%d</code> and <code>%i</code> print signed decimal,
-<code>%u</code> unsigned decimal, <code>%o</code> unsigned octal, and
-<code>%x</code> or <code>%X</code> unsigned hexadecimal.
-<code>%X</code> uses upper case letters.
-With the <code>#</code> flag, octal values are prefixed with <code>0</code>
-and hexadecimal values with <code>0x</code> or <code>0X</code>.
-</p>
-<p>
-In input, <code>%d</code> matches signed decimal, <code>%u</code> matches
-unsigned decimal, <code>%o</code> unsigned octal.
-<code>%x</code> and <code>%X</code> both match upper or lower case unsigned
-hexadecimal.
-Octal and hexadecimal values can optionally be prefixed.
-<code>%i</code> matches any integer in decimal, or prefixed octal or
-hexadecimal notation.
-Leading whitespaces are skipped.
-</p>
-
-<a name="stds"></a>
-<h2>5. Standard STRING Converters (<code>%s</code>, <code>%c</code>)</h2>
-<p>
-In output, <code>%s</code> prints a string.
-If <em>precision</em> is specified, this is the maximum string length.
-<code>%c</code> is a LONG format in output, printing one character!
-</p>
-<p>
-In input, <code>%s</code> matches a sequence of non-whitespace characters
-and <code>%c</code> a sequence of not-null characters.
-The maximum string length is given by <em>width</em>.
-The default <em>width</em> is infinite for <code>%s</code> and
-1 for <code>%c</code>.
-Leading whitespaces are skipped with <code>%s</code> but not with
-<code>%c</code>.
-The empty string matches. 
-</p>
-
-<a name="cset"></a>
-<h2>6. Standard Charset STRING Converter (<code>%[<em>charset</em>]</code>)</h2>
-<p>
-This is an input-only format.
-It matches a sequence of characters from <em>charset</em>.
-If <em>charset</em> starts with <code>^</code>, the format matches
-all characters <u>not</u> in <em>charset</em>.
-Leading whitespaces are not skipped.
-</p>
-<p>
-Example: <code>%[_a-z]</code> matches a string consisting
-entirely of <code>_</code> (underscore) or letters from <code>a</code>
-to <code>z</code>.
-</p>
-
-<a name="enum"></a>
-<h2>7. ENUM Converter (<code>%{<em>string0</em>|<em>string1</em>|...}</code>)</h2>
-<p>
-This format maps an unsigned integer value on a set of strings.
-The value 0 corresponds to <em>string0</em> and so on.
-The strings are separated by <code>|</code>.
-If one of the strings contains <code>|</code> or <code>}</code>,
-a <code>\</code> must be used to escape the character.
-</p>
-<p>
-Example: <code>%{OFF|STANDBY|ON}</code> mapps the string <code>OFF</code>
-to the value 0, <code>STANDBY</code> to 1 and <code>ON</code> to 2.
-</p>
-<p>
-In output, depending on the value, one of the strings is printed.
-</p>
-<p>
-In input, if any of the strings matches the value is set accordingly.
-</p>
-
-<a name="bin"></a>
-<h2>8. Binary LONG Converter (<code>%b</code>, <code>%B<em>zo</em></code>)</h2>
-<p>
-This format prints or scans an unsigned integer represented as a binary
-string (one character per bit).
-The <code>%b</code> format uses the characters <code>0</code> and
-<code>1</code>.
-With the <code>%B</code> format, you can choose two other characters
-to represent zero and one.
-With the <code>#</code> flag, the bit order is changed to <em>little
-endian</em>, i.e. least significant bit first.
-</p>
-<p>
-Examples: <code>%B.!</code> or <code>%B\x00\xff</code>.
-<code>%B01</code> is equivalent to <code>%b</code>.
-</p>
-<p>
-If in output <em>width</em> is larger than the number of significant bits,
-then the flag <code>0</code> means that the value should be padded with
-with the chosen zero character instead of spaces.
-If <em>precision</em> is set, it means the number of significant bits.
-Otherwise, the highest 1 bit defines the number of significant bits. 
-There is no alternate format when <code>#</code> is used.
-</p>
-<p>
-In input, leading spaces are skipped.
-A maximum of <em>width</em> characters is read.
-Conversion stops with the first character that is not the zero or the
-one character.
-</p>
-
-<a name="raw"></a>
-<h2>9. Raw LONG Converter (<code>%r</code>)</h2>
-<p>
-The raw converter does not really "convert".
-A signed or unsigned integer value is written or read in the internal
-(usually two's complement) representation of the computer.
-The normal byte order is <em>big endian</em>, i.e. most significant byte
-first.
-With the <code>#</code> flag, the byte order is changed to <em>little
-endian</em>, i.e. least significant byte first.
-With the <code>0</code> flag, the value is unsigned, otherwise signed.
-</p>
-<p>
-In output, the <em>width</em> least significant bytes of the value
-are written.
-If <em>width</em> is larger than the size of a <code>long</code>,
-the value is sign extended or zero extended, depending on the
-<code>0</code> flag.
-</p>
-<p>
-In input, <em>width</em> bytes are read and put into the value.
-If <em>width</em> is larger than the size of a <code>long</code>, only
-the least significant bytes are used.
-If <em>width</em> is smaller than the size of a <code>long</code>,
-the value is sign extended or zero extended, depending on the
-<code>0</code> flag.
-</p>
-
-<a name="bcd"></a>
-<h2>10. Packed BCD (Binary Coded Decimal) LONG Converter (<code>%D</code>)</h2>
-<p>
-Packed BCD is a format where each byte contains two binary coded
-decimal digits (<code>0</code> ... <code>9</code>).
-Thus a BCD byte is in the range from <code>0x00</code> to <code>0x99</code>.
-The normal byte order is <em>big endian</em>, i.e. most significant byte
-first.
-With the <code>#</code> flag, the byte order is changed to <em>little
-endian</em>, i.e. least significant byte first.
-The <code>+</code> flag defines that the value is signed, using the
-upper half of the most significant byte for the sign.
-Otherwise the value is unsigned.
-</p>
-<p>
-In output, <em>precision</em> decimal digits are printed in at least
-<em>width</em> output bytes.
-Signed negative values have <code>0xF</code> in their most significant half
-byte followed by the absolute value.
-</p>
-<p>
-In input, <em>width</em> bytes are read.
-If the value is signed, a one in the most significant bit is interpreted as
-a negative sign.
-Input stops with the first byte (after the sign) that does not represent a
-BCD value, i.e. where either the upper or the lower half byte is larger
-than 9.
-</p>
-
-<a name="chksum"></a>
-<h2>11. Checksum Pseudo-Converter (<code>%&lt;<em>checksum</em>&gt;</code>)</h2>
-<p>
-This is not a normal "converter", because no user data is converted.
-Instead, a checksum is calculated from the input or output.
-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
-command.
-The last byte is <em>prec</em> bytes before the checksum (default 0).
-For example in <code>"abcdefg%&lt;xor&gt;"</code> the checksum is calculated
-from <code>abcdefg</code>,
-but in <code>"abcdefg%2.1&lt;xor&gt;"</code> only from <code>cdef</code>.
-</p>
-<p>
-Normally, multi-byte checksums are in <em>big endian</em> byteorder,
-i.e. most significant byte first.
-With the <code>#</code> flag, the byte order is changed to <em>little
-endian</em>, i.e. least significant byte first.
-</p>
-<p>
-The <code>0</code> flag changes the checksum representation from
-binary to hexadecimal ASCII (2 bytes per checksum byte).
-<!--
-In output, the case of the ASCII checksum matches the case of first
-letter of the function name.
-E.g. <code>out&nbsp;"123456789%&lt;sum&gt;"</code> writes <code>dd</code>
-but <code>out&nbsp;"123456789%&lt;Sum&gt;"</code> writes <code>DD</code>.
-In input, case is ignored.
--->
-</p>
-<p>
-In output, the checksum is appended.
-</p>
-<p>
-In input, the next byte or bytes must match the checksum.
-</p>
-
-<h3>Implemented checksum functions</h3>
-<dl>
- <dt><code>%&lt;sum&gt;</code> or <code>%&lt;sum8&gt;</code></dt>
-  <dd>One byte. The sum of all characters modulo 2<sup>8</sup>.</dd>
- <dt><code>%&lt;sum16&gt;</code></dt>
-  <dd>Two bytes. The sum of all characters modulo 2<sup>16</sup>.</dd>
- <dt><code>%&lt;sum32&gt;</code></dt>
-  <dd>Four bytes. The sum of all characters modulo 2<sup>32</sup>.</dd>
- <dt><code>%&lt;negsum&gt;</code>, <code>%&lt;nsum&gt;</code>, <code>%&lt;-sum&gt;</code>, <code>%&lt;negsum8&gt;</code>, <code>%&lt;nsum8&gt;</code>, or <code>%&lt;-sum8&gt;</code></dt>
-  <dd>One byte. The negative of the sum of all characters modulo 2<sup>8</sup>.</dd>
- <dt><code>%&lt;negsum16&gt;</code>, <code>%&lt;nsum16&gt;</code>, or <code>%&lt;-sum16&gt;</code></dt>
-  <dd>Two bytes. The negative of the sum of all characters modulo 2<sup>16</sup>.</dd>
- <dt><code>%&lt;negsum32&gt;</code>, <code>%&lt;nsum32&gt;</code>, or <code>%&lt;-sum32&gt;</code></dt>
-  <dd>Four bytes. The negative of the sum of all characters modulo 2<sup>32</sup>.</dd>
- <dt><code>%&lt;notsum&gt;</code> or <code>%&lt;~sum&gt;</code></dt>
-  <dd>One byte. The bitwise inverse of the sum of all characters modulo 2<sup>8</sup>.</dd>
- <dt><code>%&lt;xor&gt;</code></dt>
-  <dd>One byte. All characters xor'ed.</dd>
- <dt><code>%&lt;xor7&gt;</code></dt>
-  <dd>One byte. All characters xor'ed &amp; 0x7F.</dd>
- <dt><code>%&lt;crc8&gt;</code></dt>
-  <dd>One byte. An often used 8 bit crc checksum
-  (poly=0x07, init=0x00, xorout=0x00).</dd>
- <dt><code>%&lt;ccitt8&gt;</code></dt>
-  <dd>One byte. The CCITT standard 8 bit crc checksum
-  (poly=0x31, init=0x00, xorout=0x00).</dd>
- <dt><code>%&lt;crc16&gt;</code></dt>
-  <dd>Two bytes. An often used 16 bit crc checksum
-  (poly=0x8005, init=0x0000, xorout=0x0000).</dd>
- <dt><code>%&lt;crc16r&gt;</code></dt>
-  <dd>Two bytes. An often used reflected 16 bit crc checksum
-  (poly=0x8005, init=0x0000, xorout=0x0000).</dd>
- <dt><code>%&lt;ccitt16&gt;</code></dt>
-  <dd>Two bytes. The usual (but <a target="ex"
-   href="http://www.joegeluso.com/software/articles/ccitt.htm">wrong?</a>)
-   implementation of the CCITT standard 16 bit crc checksum
-   (poly=0x1021, init=0xFFFF, xorout=0x0000).</dd>
- <dt><code>%&lt;ccitt16a&gt;</code></dt>
-  <dd>Two bytes. The unusual (but <a target="ex"
-   href="http://www.joegeluso.com/software/articles/ccitt.htm">correct?</a>)
-   implementation of the CCITT standard 16 bit crc checksum with augment.
-   (poly=0x1021, init=0x1D0F, xorout=0x0000).</dd>
- <dt><code>%&lt;crc32&gt;</code></dt>
-  <dd>Four bytes. The standard 32 bit crc checksum.
-   (poly=0x04C11DB7, init=0xFFFFFFFF, xorout=0xFFFFFFFF).</dd>
- <dt><code>%&lt;crc32r&gt;</code></dt>
-  <dd>Four bytes. The standard reflected 32 bit crc checksum.
-   (poly=0x04C11DB7, init=0xFFFFFFFF, xorout=0xFFFFFFFF).</dd>
- <dt><code>%&lt;jamcrc&gt;</code></dt>
-  <dd>Four bytes. Another reflected 32 bit crc checksum.
-   (poly=0x04C11DB7, init=0xFFFFFFFF, xorout=0x00000000).</dd>
- <dt><code>%&lt;adler32&gt;</code></dt>
-  <dd>Four bytes. The Adler32 checksum according to <a target="ex"
-   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>
-</dl>
-
-<a name="regex"></a>
-<h2>12. Regular Expresion STRING Converter (<code>%/<em>regex</em>/</code>)</h2>
-<p>
-This input-only format matches <a target="ex"
-href="http://www.pcre.org/" >Perl compatible regular expressions (PCRE)</a>.
-It is only available if a PCRE library is installed.
-</p>
-<p>
-If PCRE is not available for your host or cross architecture, download
-the sourcecode from <a target="ex" href="http://www.pcre.org/">www.pcre.org</a>
-and try my EPICS compatible <a target="ex"
-href="http://epics.web.psi.ch/software/streamdevice/pcre/Makefile">Makefile</a>
-to compile it like a normal EPICS application.
-The Makefile is known to work with EPICS 3.14.8 and PCRE 7.2.
-In your RELEASE file define the variable <code>PCRE</code> so that
-it points to the install location of PCRE.
-</p>
-<p>
-If PCRE is already installed on your system, use the variables
-<code>PCRE_INCLUDE</code> and <code>PCRE_LIB</code> instead to provide
-the install directories of <code>pcre.h</code> and the library.
-</p>
-<p>
-If you have PCRE installed in different locations for different (cross)
-architectures, define the variables in RELEASE.Common.&lt;architecture&gt;
-instead of the global RELEASE file.
-</p>
-<p>
-If the regular expression is not anchored, i.e. does not start with
-<code>^</code>, leading non-matching input is skipped. 
-A maximum of <em>width</em> bytes is matched, if specified.
-If <em>prec</em> is given, it specifies the sub-expression whose match
-is retuned.
-Otherwise the complete match is returned.
-In any case, the complete match is consumed from the input buffer.
-If the expression contains a <code>/</code> is must be escaped.
-</p>
-<p>
-Example: <code>%.1/&lt;title&gt;(.*)&lt;\/title&gt;/</code> returns
-the title of an HTML page, skipps anything before the
-<code>&lt;title&gt</code> tag and leaves anything after the
-<code>&lt;/title&gt;</code> tag in the input buffer.
-</p>
-<a name="exp"></a>
-<h2>13. Exponential DOUBLE converter (<code>%m</code>)</h2>
-<p>
-This experimental input-only format matches numbers in the format
-<i>[sign] mantissa sign exponent<i>, e.g <code>+123-4</code> meaning
-123e-4 or 0.0123. Mantissa and exponent are integers. The sign of the
-mantissa is optional. Compared to the standard <code>%e</code> format,
-this format does not contain the characters <code>.</code> and <code>e</code>.
-</p>
-<p>
-Output formatting is ambigous (e.g. <code>123-4</code> versus
-<code>1230-5</code>). Until it has been specified how to handle this,
-output is not supported.
-</p>
-<hr>
-<p align="right"><a href="processing.html">Next: Record Processing</a></p>
-<p><small>Dirk Zimoch, 2007</small></p>
-<script src="stream.js" type="text/javascript"></script>
-</body>
-</html>

doc/head.html

@@ -1,32 +0,0 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
-    "http://www.w3.org/TR/html4/loose.dtd">
-<html>
-<head>
-<title>Headbar</title>
-<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-<meta name="author" content="Dirk Zimoch">
-<style type="text/css">
-<!--
-body      {margin:0px 0px 0px 0px;}
-big       {font-size: 30px; font-family:serif;}
--->
-</style>
-</head>
-<body bgcolor="white">
-<table cellspacing=0 cellpadding=0 border=0 width="100%">
- <tr><td bgcolor="#267ab8" colspan=6 valign="bottom" height=9 width="100%"></td></tr>
- <tr><td bgcolor="#000000" colspan=6 valign="bottom" height=1 width="100%"></td></tr>
- <tr>
-  <td><img src="space.gif" width=180 height=1 alt=""><center><a href="http://www.psi.ch" target="ex"><img src="PSI.gif" width=150 height=55 alt="PSI" border=0></a></center></td>
-  <td><img src="space.gif" width=1 height=65 alt=""></td>
-  <td><a href="http://www.aps.anl.gov/epics" target="ex"><img
-    src="EPICS.gif" border=0 width=50 height=50 alt="EPICS"></a></td>
-  <td width="100%" align="center" nowrap>
-  <big><b><em id="subtitle">StreamDevice</em></b></big></td>
-  <td><img src="space.gif" width=166 height=1 alt=""><center><a href="http://sls.web.psi.ch/view.php/about/index.html" target="ex"><img src="SLS.gif" width=146 height=55 alt="SLS" border=0></a></center></td>
- </tr>
- <tr><td bgcolor="#267ab8" colspan=6 valign="bottom" height=4 width="100%"></td></tr>
- <tr><td bgcolor="#000000" colspan=6 valign="bottom" height=1 width="100%"></td></tr>
-</table>
-</body>
-</html>

doc/index.html

@@ -1,20 +0,0 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN"
-   "http://www.w3.org/TR/html4/frameset.dtd">
-<html>
-<head>
-<title>StreamDevice Documentation</title>
-<link rel="shortcut icon" href="sls_icon.ico">
-<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-<meta name="author" content="Dirk Zimoch">
-</head>
-<frameset rows="80,*" framespacing=0 frameborder=0 border=0>
-  <frame src="head.html" name="head" scrolling="no" noresize> 
-  <frameset cols="180,*" >
-    <frame src="nav.html" name="nav" noresize> 
-    <frame src="stream.html" name="text"> 
-  </frameset>
-  <noframes>
-    <a href="stream.html">Click here for no-frames version.</a>
-  </noframes>
-</frameset>
-</html>

doc/nav.html

@@ -1,220 +0,0 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
-    "http://www.w3.org/TR/html4/loose.dtd">
-<html>
-<head>
-<title>Navbar</title>
-<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-<meta name="author" content="Dirk Zimoch">
-<script type="text/javascript">
-<!--
-active="";
-function show(name) {
-    var m = document.getElementById(name);
-    var b = document.getElementById(name+"Button");
-    if (active != "") { hide(active); }
-    m.style.display = "block";
-    b.innerHTML="[&laquo;]";
-    b.href="javascript:hide(\'"+name+"\')"
-    active=name;
-}
-function hide(name) {
-    var m = document.getElementById(name);
-    var b = document.getElementById(name+"Button");
-    m.style.display = "none";
-    b.innerHTML="[&raquo;]";
-    b.href="javascript:show(\'"+name+"\')"
-    active="";
-}
-function printview() {
-    w = window.open(parent.text.location, "_parent", "dependent=yes,width=800,menubar=yes,toolbar=yes,location=yes");
-}
--->
-</script>
-<style type="text/css">
-<!--
-body      {margin:0px 0px 0px 0px;
-           font-family:sans-serif;
-           font-weight:bold;
-           font-size:13px;}
-a         {text-decoration:none;}
-a:link    {color:#333333;}
-a:visited {color:#333333;}
-a:hover   {color:#FF0000;}
-a:active  {color:#FF0000;}
-.top      {margin-bottom: 0px;
-           margin-top: 10px;
-           border-bottom: solid 1px black;}
-.top ul   {margin-left: 5px;
-           margin-top: 2px;
-           margin-bottom: 2px;
-           font-size:95%;
-           line-height:120%;
-           padding-left:1em;}
-.subsub   {margin-left: 15px;
-           line-height:120%;
-           font-size:80%;}
-h1        {font-size:120%;
-           margin-top: 20px;
-           margin-right: 20px;
-           margin-bottom: 10px;
-           color:#267ab8;}
--->
-</style>
-
-</head>
-<body background="bg.gif">
-<p align="center">
-</p>
-<div style="margin-left: 20px;">
- <h1>User's Guide</h1>
- <div class="top">
-  <a target="text" href="stream.html">Intro</a>
- </div>
- <div class="top">
-  <a target="text" href="setup.html">Setup</a>
-  <a href="javascript:show('setup')" id="setupButton"></a>
-  <ul id="setup">
-   <li><a target="text" href="setup.html#pre">Prerequisites</a>
-    <ul>
-     <li><a target="text" href="epics3_13.html">Using EPICS 3.13</a></li>
-   </ul></li>
-   <li><a target="text" href="setup.html#lib">Build Library</a></li>
-   <li><a target="text" href="setup.html#app">Build Application</a></li>
-   <li><a target="text" href="setup.html#sta">Startup Script</a></li>
-   <li><a target="text" href="setup.html#pro">Protocol File</a>
-    <ul>
-     <li><a target="text" href="setup.html#reload">Reloading</a></li>
-    </ul></li>
-   <li><a target="text" href="setup.html#rec">Records</a></li>
-  </ul>
- </div>
- <div class="top">
-  <a target="text" href="protocol.html">Protocol Files</a>
-  <a href="javascript:show('protocol')" id="protocolButton"></a>
-  <ul id="protocol">
-   <li><a target="text" href="protocol.html#gen">General</a></li>
-   <li><a target="text" href="protocol.html#proto">Protocols</a></li>
-   <li><a target="text" href="protocol.html#cmd">Commands</a></li>
-   <li><a target="text" href="protocol.html#str">Strings</a></li>
-   <li><a target="text" href="protocol.html#var">Variables</a>
-    <ul>
-     <li><a target="text" href="protocol.html#sysvar">System variables</a></li>
-     <li><a target="text" href="protocol.html#argvar">Protocol Arguments</a></li>
-     <li><a target="text" href="protocol.html#usrvar">User variables</a></li>
-    </ul></li>
-   <li><a target="text" href="protocol.html#except">Exception Handlers</a></li>
-  </ul>
- </div>
- <div class="top">
-  <a target="text" href="formats.html">Format Converters</a>
-  <a href="javascript:show('formats')" id="formatsButton"></a>
-  <ul id="formats">
-   <li><a target="text" href="formats.html#syntax">Syntax</a></li>
-   <li><a target="text" href="formats.html#types">Types &amp; Fields</a></li>
-   <li><a target="text" href="formats.html#stdd">%f %e %g</a></li>
-   <li><a target="text" href="formats.html#stdl">%i %d %u %o %x</a></li>
-   <li><a target="text" href="formats.html#stds">%s %c</a></li>
-   <li><a target="text" href="formats.html#cset">%[<em>charset</em>]</a></li>
-   <li><a target="text" href="formats.html#enum">%{<em>s0</em>|<em>s1</em>|...}</a></li>
-   <li><a target="text" href="formats.html#bin">%b %B</a></li>
-   <li><a target="text" href="formats.html#raw">%r</a></li>
-   <li><a target="text" href="formats.html#bcd">%D</a></li>
-   <li><a target="text" href="formats.html#chksum">%&lt;<em>checksum</em>&gt;</a></li>
-   <li><a target="text" href="formats.html#regex">%/<em>regex</em>/</a></li>
-   <li><a target="text" href="formats.html#exp">%m</a></li>
-  </ul>
- </div>
- <div class="top">
-  <a target="text" href="processing.html">Record Processing</a>
-  <a href="javascript:show('proc')" id="procButton"></a>
-  <ul id="proc">
-   <li><a target="text" href="processing.html#proc">Normal Processing</a></li>
-   <li><a target="text" href="processing.html#init">Initialization</a></li>
-   <li><a target="text" href="processing.html#iointr">I/O Intr</a></li>
-  </ul>
- </div>
- <div class="top">
-  <a target="text" href="recordtypes.html">Record Types</a>
-  <a href="javascript:show('records')" id="recordsButton"></a>
-  <ul id="records" class="sub">
-   <li><a target="text" href="aai.html">aai</a></li>
-   <li><a target="text" href="aao.html">aao</a></li>
-   <li><a target="text" href="ai.html">ai</a></li>
-   <li><a target="text" href="ao.html">ao</a></li>
-   <li><a target="text" href="bi.html">bi</a></li>
-   <li><a target="text" href="bo.html">bo</a></li>
-   <li><a target="text" href="mbbi.html">mbbi</a></li>
-   <li><a target="text" href="mbbo.html">mbbo</a></li>
-   <li><a target="text" href="mbbiDirect.html">mbbiDirect</a></li>
-   <li><a target="text" href="mbboDirect.html">mbboDirect</a></li>
-   <li><a target="text" href="stringin.html">stringin</a></li>
-   <li><a target="text" href="stringout.html">stringout</a></li>
-   <li><a target="text" href="longin.html">longin</a></li>
-   <li><a target="text" href="longout.html">longout</a></li>
-   <li><a target="text" href="waveform.html">waveform</a></li>
-   <li><a target="text" href="calcout.html">calcout</a></li>
-   <li><a target="text" href="scalcout.html">scalcout</a></li>
-  </ul>
- </div>
- <div class="top">
-  <a target="text" href="tipsandtricks.html">Tips &amp; Tricks</a>
-  <a href="javascript:show('tipsandtricks')" id="tipsandtricksButton"></a>
-  <ul id="tipsandtricks">
-   <li><a target="text" href="tipsandtricks.html#argvar">Many almost identical protocols</a></li>
-   <li><a target="text" href="tipsandtricks.html#iointr">Read unsolicited input</a></li>
-   <li><a target="text" href="tipsandtricks.html#multiline">Read multi-line messages</a></li>
-   <li><a target="text" href="tipsandtricks.html#writemany">Write more than one value in one message</a></li>
-   <li><a target="text" href="tipsandtricks.html#readmany">Read more than one value from one message</a></li>
-   <li><a target="text" href="tipsandtricks.html#mixed">Read values of mixed data type</a></li>
-  </ul>
- </div>
-    
- <h1>Programmer's Guide</h1>
- <div class="top">
-  <a target="text" href="recordinterface.html">Record API</a>
- </div>
- <div class="top">
-  <a target="text" href="businterface.html">Bus API</a>
-  <a href="javascript:show('bus')" id="busButton"></a>
-  <ul id="bus">
-   <li><a target="text" href="businterface.html#class">Interface Class</a></li>
-   <li><a target="text" href="businterface.html#theory">Theory of Operation</a>
-    <ul>
-     <li><a target="text" href="businterface.html#registration">Registration</a></li>
-     <li><a target="text" href="businterface.html#create">Creation &amp; deletion</a></li>
-     <li><a target="text" href="businterface.html#connect">Connecting</a></li>
-     <li><a target="text" href="businterface.html#lock">Bus locking</a></li>
-     <li><a target="text" href="businterface.html#write">Writing output</a></li>
-     <li><a target="text" href="businterface.html#read">Reading input</a></li>
-     <li><a target="text" href="businterface.html#event">Handling events</a></li>
-   </ul></li>
-  </ul>
- </div>
- <div class="top">
-  <a target="text" href="formatconverter.html">Format Converter API</a>
- </div>
- <div class="top">
-  <a target="text" href="osinterface.html">Operating System API</a>
- </div>
-</div>
-<p align="center" style="margin-top:20px;">
-<script type="text/javascript">
-<!--
-    document.writeln('<a href="javascript:printview()">' +
-        '<img src="printer.gif" alt="Printer friendly" border=0><br>' +
-        '<small>Printer friendly<\/small><\/a>');
-    hide('setup');
-    hide('protocol');
-    hide('formats');
-    hide('proc');
-    hide('records');
-    hide('bus');
-    hide('tipsandtricks');
-    chapter=decodeURIComponent(parent.location.search.substr(1));
-    if (chapter) parent.text.location.href=chapter;
-//-->
-</script>
-</p>
-</body>
-</html>
-

doc/osinterface.html

@@ -1,20 +0,0 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
-    "http://www.w3.org/TR/html4/loose.dtd">
-<html>
-<head>
-<title>StreamDevice: Operating System API</title>
-<link rel="shortcut icon" href="sls_icon.ico">
-<link rel="stylesheet" type="text/css" href="stream.css">
-<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-<meta name="author" content="Dirk Zimoch">
-</head>
-<body>
-<h1>StreamDevice: Operating System API</h1>
-
-<h2>Sorry, this documentation is still missing.</h2>
-
-<hr>
-<p><small>Dirk Zimoch, 2006</small></p>
-<script src="stream.js" type="text/javascript"></script>
-</body>
-</html>

doc/recordinterface.html

@@ -1,20 +0,0 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
-    "http://www.w3.org/TR/html4/loose.dtd">
-<html>
-<head>
-<title>StreamDevice: Record API</title>
-<link rel="shortcut icon" href="sls_icon.ico">
-<link rel="stylesheet" type="text/css" href="stream.css">
-<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-<meta name="author" content="Dirk Zimoch">
-</head>
-<body>
-<h1>StreamDevice: Record API</h1>
-
-<h2>Sorry, this documentation is still missing.</h2>
-
-<hr>
-<p><small>Dirk Zimoch, 2006</small></p>
-<script src="stream.js" type="text/javascript"></script>
-</body>
-</html>

doc/setup.html

@@ -1,317 +0,0 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
-    "http://www.w3.org/TR/html4/loose.dtd">
-<html>
-<head>
-<title>StreamDevice: Setup</title>
-<link rel="shortcut icon" href="sls_icon.ico">
-<link rel="stylesheet" type="text/css" href="stream.css">
-<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-<meta name="author" content="Dirk Zimoch">
-</head>
-<body>
-<h1>StreamDevice: Setup</h1>
-
-<a name="pre"></a>
-<h2>1. Prerequisites</h2>
-<p>
-<em>StreamDevice</em> requires either 
-<a href="http://www.aps.anl.gov/epics/base/R3-14/index.php"
-target="ex">EPICS base R3.14.6 or higher</a> or
-<a href="http://www.aps.anl.gov/epics/base/R3-13.php"
-target="ex">EPICS base R3.13.7 or higher</a>.
-How to use <em>StreamDevice</em> on EPICS R3.13 is described on a
-<a href="epics3_13.html">separate page</a>.
-Because <em>StreamDevice</em> comes with an interface to
-<a href="http://www.aps.anl.gov/epics/modules/soft/asyn/"
-target="ex"><em>asynDriver</em> version R4-3 or higher</a> as the
-underlying driver layer,
-you should have <em>asynDriver</em> installed first.
-</p>
-<p>
-<em>StreamDevice</em> has support for the
-<a href="scalcout.html"><em>scalcout</em></a> record from the
-<em>calc</em> module of <a target="ex"
-href="http://www.aps.anl.gov/aod/bcda/synApps/index.php"
-><em>synApps</em></a>.
-Up to <em>calc</em> release R2-6 (<em>synApps</em> release R5_1),
-the <em>scalcout</em> record needs a fix.
-(See separate <a href="scalcout.html"><em>scalcout</em> page</a>.)
-Support for the scalcout is optional. <em>StreamDevice</em> works
-as well without scalcout or SynApps.
-</p>
-<p>
-Up to release R3.14.8.2, a fix in EPICS base is required to build
-<em>StreamDevice</em> on Windows (not cygwin).
-In <kbd>src/iocsh/iocsh.h</kbd>, add the following line
-and rebuild base.
-</p>
-<pre>
-epicsShareFunc int epicsShareAPI iocshCmd(const char *command);
-</pre>
-
-<p>
-Make sure that the <em>asyn</em> library (and the <em>calc</em> module of
-<em>synApps</em>, if desired) can be found, e.g. by
-adding <code>ASYN</code>
-and (if installed) <code>CALC</code> or <code>SYNAPPS</code>
-to your <kbd>&lt;top&gt;/configure/RELEASE</kbd> file:
-</p>
-<pre>
-ASYN=/home/epics/asyn/4-5
-CALC=/home/epics/synApps/calc/2-7
-</pre>
-<p>
-If you want to enable regular expression matching, you need the <em>PCRE</em> package.
-For most Linux systems, it is already installed. In that case add the locations
-of the <em>PCRE</em> header and library to your <kbd>RELEASE</kbd> file:
-</p>
-<pre>
-PCRE_INCLUDE=/usr/include/pcre
-PCRE_LIB=/usr/lib
-</pre>
-<p>
-If you want to build <em>StreamDevice</em> for platforms without <em>PCRE</em> support,
-it is the easiest to build <em>PCRE</em> as an EPICS application.
-Download the <em>PCRE</em> package from <a target=ex href="http://www.pcre.org">www.pcre.org</a>
-and compile it with my EPICS compatible
-<a target=ex href="http://epics.web.psi.ch/software/streamdevice/pcre/Makefile">Makefile</a>.
-Then define the location of the application in your RELEASE file.
-</p>
-<pre>
-PCRE=/home/epics/pcre
-</pre>
-<p>
-Regular expressions are optional. If you don't want them, you don't need this.
-</p>
-
-<p>
-For details on <kbd>&lt;top&gt;</kbd> directories and RELEASE files,
-please refer to the
-<a href="http://www.aps.anl.gov/epics/base/R3-14/8-docs/AppDevGuide.pdf"
-target="ex"><em>IOC Application Developer's Guide</em></a> chapter 4:
-EPICS Build Facility.
-</p>
-
-<a name="lib"></a>
-<h2>2. Build the <em>StreamDevice</em> Library</h2>
-<p>
-Unpack the
-<a href="http://epics.web.psi.ch/software/streamdevice/StreamDevice-2.tgz"
-><em>StreamDevice</em> package</a> in a <kbd>&lt;top&gt;</kbd> directory
-of your application build area.
-(You might probably have done this already.)
-Go to the newly created <em>StreamDevice</em> directory
-and run <kbd>make</kbd> (or <kbd>gmake</kbd>).
-This will create and install the <em>stream</em> library and the 
-<kbd>stream.dbd</kbd> file.
-</p>
-<a name="app"></a>
-<h2>3. Build an Application</h2>
-<p>
-To use <em>StreamDevice</em>, your application must be built with the
-<em>asyn</em> and <em>stream</em> libraries and must load
-<kbd>asyn.dbd</kbd> and <kbd>stream.dbd</kbd>.
-</p>
-<p>
-Include the following lines in your application Makefile:
-</p>
-<pre>
-PROD_LIBS += stream
-PROD_LIBS += asyn
-</pre>
-<p>
-Include the following lines in your xxxAppInclude.dbd file to use
-<em>stream</em> and <em>asyn</em> with serial lines and IP sockets:
-</p>
-<pre>
-include "base.dbd"
-include "stream.dbd"
-include "asyn.dbd"
-registrar(drvAsynIPPortRegisterCommands)
-registrar(drvAsynSerialPortRegisterCommands)
-</pre>
-<p>
-You can find an example application in the <kbd>streamApp</kbd>
-subdirectory.
-</p>
-
-<a name="sta"></a>
-<h2>4. The Startup Script</h2>
-<p>
-<em>StreamDevice</em> is based on <a
-href="protocol.html"><em>protocol files</em></a>.
-To tell <em>StreamDevice</em> where to search for protocol files,
-set the environment variable <code>STREAM_PROTOCOL_PATH</code> to a
-list of directories to search.
-On Unix and vxWorks systems, directories are separated by <code>:</code>,
-on Windows systems by <code>;</code>.
-The default value is <code>STREAM_PROTOCOL_PATH=.</code>,
-i.e. the current directory.
-</p>
-<p>
-Also configure the buses (in <em>asynDriver</em> terms: ports) you want
-to use with <em>StreamDevice</em>.
-You can give the buses any name you want, like <kbd>COM1</kbd> or 
-<kbd>socket</kbd>, but I recommend to use names related to the
-connected device.
-</p>
-<h3>Example:</h3>
-<p>
-A power supply with serial communication (9600 baud, 8N1) is connected to
-<kbd>/dev/ttyS1</kbd>.
-The name of the power supply is <tt>PS1</tt>.
-Protocol files are either in the current working directory or in the
-<kbd>../protocols</kbd> directory.
-</p>
-<p>
-Then the startup script must contain lines like this:
-</p>
-<pre>
-epicsEnvSet ("STREAM_PROTOCOL_PATH", ".:../protocols")
-
-drvAsynSerialPortConfigure ("PS1","/dev/ttyS1")
-asynSetOption ("PS1", 0, "baud", "9600")
-asynSetOption ("PS1", 0, "bits", "8")
-asynSetOption ("PS1", 0, "parity", "none")
-asynSetOption ("PS1", 0, "stop", "1")
-asynSetOption ("PS1", 0, "clocal", "Y")
-asynSetOption ("PS1", 0, "crtscts", "N")
-</pre>
-
-<p>If the power supply was connected via telnet-style TCP/IP
-at address 192.168.164.10 on port 23,
-the startupscript would contain:
-</p>
-<pre>
-epicsEnvSet ("STREAM_PROTOCOL_PATH", ".:../protocols")
-
-drvAsynIPPortConfigure ("PS1", "192.168.164.10:23")
-</pre>
-
-<p>
-With a VXI11 (GPIB via TCP/IP) connection, e.g. a 
-HP E2050A on IP address 192.168.164.10, it would look like this:
-</p>
-<pre>
-epicsEnvSet ("STREAM_PROTOCOL_PATH", ".:../protocols")
-
-vxi11Configure ("PS1","192.168.164.10",1,1000,"hpib")
-</pre>
-
-
-<a name="pro"></a>
-<h2>5. The Protocol File</h2>
-<p>
-For each different type of hardware, create a protocol file
-which defines protocols for all needed functions of the device.
-The file name is arbitrary, but I recommend that it contains
-the device type.
-It must not contain spaces and should be short.
-During <code>iocInit</code>, <em>streamDevice</em> loads and parses
-the required protocol files.
-If the files contain errors, they are printed on the IOC shell.
-Put the protocol file in one of the directories listed in
-<code>STREAM_PROTOCOL_PATH</code>. 
-</p>
-<h3>Example:</h3>
-<p>
-<tt>PS1</tt> is an <em>ExamplePS</em> power supply.
-It communicates via ASCII strings which are terminated by
-&lt;carriage&nbsp;return&gt; &lt;line&nbsp;feed&gt; (ASCII codes 13, 10).
-The output current can be set by sending a string like
-<code>"CURRENT 5.13"</code>.
-When asked with the string <code>"CURRENT?"</code>, the device returns
-the last set value in a string like <code>"CURRENT 5.13 A"</code>.
-</p>
-<p>
-Normally, an analog output record should write its value to the device.
-But during startup, the record should be initialized from the the device.
-The protocol file <kbd>ExamplePS.proto</kbd> defines the protocol
-<code>setCurrent</code>.
-</p>
-<pre>
-Terminator = CR LF;
-
-setCurrent {
-    out "CURRENT %.2f";
-    @init { 
-        out "CURRENT?";
-        in "CURRENT %f A";
-    }
-}
-</pre>
-
-<a name="reload"></a>
-<h3>Reloading the Protocol File</h3>
-<p>
-During development, the protocol files might change frequently.
-To prevent restarting the IOC all the time, it is possible to reload
-the protocol file of one or all records with the shell function
-<code>streamReload("<var>record</var>")</code>.
-If <code>"<var>record</var>"</code> is not given, all records using
-<em>StreamDevice</em> reload their protocols.
-Furthermore, the <code>streamReloadSub</code> function can be used
-with a subroutine record to reload all protocols.
-</p>
-<p>
-Reloading the protocol file aborts currently running protocols.
-This might set <code>SEVR=INVALID</code> and <code>STAT=UDF</code>.
-If a record can't reload its protocol file (e.g. because of a syntax
-error), it stays <code>INVALID</code>/<code>UDF</code> until a valid
-protocol is loaded.
-</p>
-
-<p>
-See the <a href="protocol.html">next chapter</a> for protocol files in depth.
-</p>
-
-<a name="rec"></a>
-<h2>6. Configure the Records</h2>
-<p>
-To make a record use <em>StreamDevice</em>, set its <code>DTYP</code> field to
-<code>"stream"</code>.
-The <code>INP</code> or <code>OUT</code> link has the form
-<code>"@<var>file&nbsp;protocol&nbsp;bus</var>&nbsp;[<var>address</var>&nbsp;[<var>parameters</var>]]"</code>.
-</p>
-<p>
-Here, <code><var>file</var></code> is the name of the protocol file and
-<code><var>protocol</var></code> is the name of a protocol defined in this file.
-If the protocol requires <a href="protocol.html#argvar">arguments</a>,
-specify them enclosed in parentheses:
-<code><var>protocol</var>(<var>arg1,arg2,...</var>)</code>.
-</p>
-<p>
-The communication channel is specified with <code><var>bus</var></code> and
-<code><var>addr</var></code>.
-If the bus does not have addresses, <code><var>addr</var></code> is dispensable.
-Optional <code><var>parameters</var></code> are passed to the bus driver.
-</p>
-
-<h3>Example:</h3>
-<p>
-Create an output record to set the current of <tt>PS1</tt>.
-Use protocol <em>setCurrent</em> from file <em>ExamplePS.proto</em>.
-The bus is called <em>PS1</em> like the device.
-</p>
-
-<pre>
-record (ao, "PS1:I-set")
-{
-    field (DESC, "Set current of PS1")
-    field (DTYP, "stream")
-    field (OUT,  "@ExamplePS.proto setCurrent PS1")
-    field (EGU,  "A")
-    field (PREC, "2")
-    field (DRVL, "0")
-    field (DRVH, "60")
-    field (LOPR, "0")
-    field (HOPR, "60")
-}
-</pre>
-
-<hr>
-<p align="right"><a href="protocol.html">Next: Protocol Files</a></p>
-<p><small>Dirk Zimoch, 2007</small></p>
-<script src="stream.js" type="text/javascript"></script>
-</body>
-</html>

doc/stream.css

@@ -1,79 +0,0 @@
-a:link    {color: #0000D0; text-decoration:none;}
-a:visited {color: #0000D0; text-decoration:none;}
-a:hover   {color: #FF0000; text-decoration:none;}
-
-body {
-    margin-right:20px;
-    font-family:sans-serif;
-    font-size:14px;
-    background-color:#ffffff;
-}    
-
-pre {
-    background-color:#f4f4f4;
-    padding:1ex;
-    border:1px solid #000000;
-    white-space:pre;
-    margin:2ex;
-}
-
-dt {
-    margin-top:0.5ex;
-}
-
-h1 {
-    font-size:225%;
-    margin-top:0;
-    font-style:italic;
-    font-family:serif;
-}
-
-h2 {
-    font-size:150%;
-    margin-bottom:0.5ex;
-}
-
-h3 {
-    font-size:100%;
-    margin-bottom:0.25ex;
-}
-
-p {
-    margin-top:0.75ex;
-    margin-bottom:0.75ex;
-}
-
-small {
-    font-size:75%;
-}
-
-code {
-    color: #008000;
-}
-
-.indent {
-    text-indent:-4ex;
-    margin-left:4ex;
-    margin-top:0.5ex;
-    text-align:left;
-}
-
-/*
-  a[target=ex] {
-      background-image:url(ex.png);
-      background-repeat:no-repeat;
-      background-position:right center;
-      padding-right: 12px;
-  }
-
-  a[target=ex]:hover {
-      background-image:url(exr.png);
-  }
-*/
-
-@media print {
-  a:link    {color: black; text-decoration:none;}
-  a:visited {color: black; text-decoration:none;}
-  a:hover   {color: black; text-decoration:none;}
-  code      {color: black; }
-}

doc/stream.html

@@ -1,92 +0,0 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
-    "http://www.w3.org/TR/html4/loose.dtd">
-<html>
-<head>
-<title>StreamDevice</title>
-<link rel="shortcut icon" href="sls_icon.ico">
-<link rel="stylesheet" type="text/css" href="stream.css">
-<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-<meta name="author" content="Dirk Zimoch">
-</head>
-<body>
-<h1>EPICS <em>StreamDevice</em> Documentation</h1>
-
-<h2>What is <em>StreamDevice</em>?</h2>
-<p>
-<em>StreamDevice</em> is a generic
-<a href="http://www.aps.anl.gov/epics" target="ex">EPICS</a>
-device support for devices with a "byte stream" based
-communication interface.
-That means devices that can be controlled by sending and
-receiving strings (in the broadest sense, including non-printable
-characters and even null-bytes). 
-Examples for this type of communication interface are
-serial line (RS-232, RS-485, ...),
-IEEE-488 (also known as GPIB or HP-IB), and TCP/IP.
-<em>StreamDevice</em> comes with an interface to<a target="ex"
-href="http://www.aps.anl.gov/epics/modules/soft/asyn/">
-<em>asynDriver</em></a>
-but can be extended to
-<a href="businterface.html">support other bus drivers</a>.
-</p>
-<p>
-If the device can be controlled with strings like
-"<code>RF:FREQ 499.655 MHZ</code>", <em>StreamDevice</em> can be used.
-How the strings exactly look like is defined in <em>protocols</em>.
-Formatting and interpretation of values is done with
-<a href="formats.html"><em>format converters</em></a> similar to those
-known from the C functions <em>printf()</em> and <em>scanf()</em>.
-To support other formats, it is possible to
-<a href="formatconverter.html">write your own converters</a>.
-</p>
-<p>
-Each record with <em>StreamDevice</em> support runs one <em>protocol</em>
-to read or write its value.
-All <em>protocols</em> are defined in
-<a href="protocol.html"><em>protocol files</em></a> in plain ASCII text.
-No compiling is necessary to change a protocol or to support new devices.
-<em>Protocols</em> can be as simple as just one output string or can
-consist of many strings sent to and read from the device.
-However, a protocol is linear.
-That means it runs from start to end each time the record is
-<a href="processing.html">processed</a>.
-It does not provide loops or branches.
-</p>
-<p>
-<em>StreamDevice</em> supports all
-<a href="recordtypes.html">standard records</a> of EPICS base
-which can have device support.
-It is also possible to
-<a href="recordinterface.html">write support for new record types</a>.
-</p>
-
-<h2>What is <em>StreamDevice</em> not?</h2>
-<p>
-It is not a programming language for a high-level application.
-It is, for example, not possible to write a complete scanning program
-in a <em>protocol</em>.
-Use other tools for that and use <em>StreamDevice</em> only for the
-primitive commands.
-</p>
-<p>
-It is not a block oriented device support.
-It is not possible to send or receive huge blocks of data that contain
-many process variables distributed over many records.
-</p>
-
-<h2>Recommended Readings</h2>
-<p>
-<a href="http://www.aps.anl.gov/epics/base/R3-14/8-docs/AppDevGuide.pdf"
-target="ex">IOC Application Developer's Guide (PDF)</a>
-</p>
-<p>
-<a href="http://www.aps.anl.gov/asd/controls/epics/EpicsDocumentation/AppDevManuals/RecordRef/Recordref-1.html"
-target="ex">EPICS Record Reference Manual</a>
-</p>
-
-<hr>
-<p align="right"><a href="setup.html">Next: Setup</a></p>
-<p><small>Dirk Zimoch, 2006</small></p>
-<script src="stream.js" type="text/javascript"></script>
-</body>
-</html>

doc/stream.js

@@ -1,5 +0,0 @@
-if (parent.head) {
-    parent.head.document.getElementById('subtitle').innerHTML=document.title;
-    parent.document.title=document.title;
-    document.getElementsByTagName('h1')[0].style.display="none";
-}

docs/aai.html

@@ -1,24 +1,24 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
-    "http://www.w3.org/TR/html4/loose.dtd">
-<html>
+<!DOCTYPE HTML>
+<html lang="en">
 <head>
 <title>StreamDevice: aai Records</title>
-<link rel="shortcut icon" href="sls_icon.ico">
-<link rel="stylesheet" type="text/css" href="stream.css">
-<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-<meta name="author" content="Dirk Zimoch">
+<meta charset="utf-8" />
+<link rel="shortcut icon" href="favicon.ico" />
+<link rel="stylesheet" type="text/css" href="stream.css" />
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<meta name="author" content="Dirk Zimoch" />
 </head>
 <body>
-<h1>StreamDevice: aai Records</h1>
+<iframe src="nav.html" id="navleft"></iframe>
+<h1>aai Records</h1>
 <p>
-<b>Note:</b> aai record support is disabled per default.
-Enable it in <code>src/CONFIG_STREAM</code>.
+<b>Note:</b> In EPICS versions before 3.14.12, aai records may be disabled.
 </p>
 
 <h2>Normal Operation</h2>
 <p>
 With aai records, the format converter is applied to
-each element. Between the elements, a separator is printed
+each array element. Between the elements, a separator is printed
 or expected as specified by the <code>Separator</code>
 <a href="protocol.html#sysvar">variable</a> in the protocol.
 When parsing input, a space as the first character of the
@@ -39,6 +39,10 @@ written.
 <p>
 The format data type must be convertible to or from the type
 specified in the <code>FTVL</code> field.
+The types <code>"INT64"</code> and <code>"UINT64"</code> are
+only available in EPICS base version 3.16 or higher.
+</p>
+<p>
 The variable <code><i>x[i]</i></code> stands for one element of
 the written or read value.
 </p>
@@ -47,6 +51,7 @@ the written or read value.
   <dd>
    <u>Output:</u> <code><i>x[i]</i>=double(VAL[i])</code><br>
    <code>FTVL</code> can be <code>"DOUBLE"</code>, <code>"FLOAT"</code>,
+   <code>"INT64"</code>, <code>"UINT64"</code>,
    <code>"LONG"</code>, <code>"ULONG"</code>, <code>"SHORT"</code>,
    <code>"USHORT"</code>, <code>"CHAR"</code>, <code>"UCHAR"</code>,
    or <code>"ENUM"</code> (which is treated as <code>"USHORT"</code>).<br>
@@ -57,6 +62,7 @@ the written or read value.
   <dd>
    <u>Output:</u> <code><i>x[i]</i>=long(VAL[i])</code><br>
    <code>FTVL</code> can be 
+   <code>"INT64"</code>, <code>"UINT64"</code>,
    <code>"LONG"</code>, <code>"ULONG"</code>, <code>"SHORT"</code>,
    <code>"USHORT"</code>, <code>"CHAR"</code>, <code>"UCHAR"</code>,
    or <code>"ENUM"</code> (which is treated as <code>"USHORT"</code>).<br>
@@ -64,6 +70,7 @@ the written or read value.
    zero-extended to long before converting them.<br>
    <u>Input:</u> <code>VAL[i]=FTVL(<i>x[i])</i></code><br>
    <code>FTVL</code> can be <code>"DOUBLE"</code>, <code>"FLOAT"</code>,
+   <code>"INT64"</code>, <code>"UINT64"</code>,
    <code>"LONG"</code>, <code>"ULONG"</code>, <code>"SHORT"</code>,
    <code>"USHORT"</code>, <code>"CHAR"</code>, <code>"UCHAR"</code>,
    or <code>"ENUM"</code> (which is treated as <code>"USHORT"</code>).<br>
@@ -104,25 +111,31 @@ the written or read value.
  present. All format converters work like in normal operation.
 </p>
 
-<hr>
-<p>
+<footer>
+<nav>
+<a href="aai.html">aai</a>
 <a href="aao.html">aao</a>
 <a href="ai.html">ai</a>
 <a href="ao.html">ao</a>
 <a href="bi.html">bi</a>
 <a href="bo.html">bo</a>
-<a href="mbbi.html">mbbi</a>
-<a href="mbbo.html">mbbo</a>
-<a href="mbbiDirect.html">mbbiDirect</a>
-<a href="mbboDirect.html">mbboDirect</a>
+<a href="calcout.html">calcout</a>
+<a href="int64in.html">int64in</a>
+<a href="int64out.html">int64out</a>
 <a href="longin.html">longin</a>
 <a href="longout.html">longout</a>
+<a href="lsi.html">lsi</a>
+<a href="lso.html">lso</a>
+<a href="mbbiDirect.html">mbbiDirect</a>
+<a href="mbboDirect.html">mbboDirect</a>
+<a href="mbbi.html">mbbi</a>
+<a href="mbbo.html">mbbo</a>
+<a href="scalcout.html">scalcout</a>
 <a href="stringin.html">stringin</a>
 <a href="stringout.html">stringout</a>
-<a href="calcout.html">calcout</a>
-<a href="scalcout.html">scalcout</a>
-</p>
-<p><small>Dirk Zimoch, 2006</small></p>
-<script src="stream.js" type="text/javascript"></script>
+<a href="waveform.html">waveform</a>
+</nav>
+Dirk Zimoch, 2018
+</footer>
 </body>
 </html>

docs/aao.html

@@ -1,24 +1,24 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
-    "http://www.w3.org/TR/html4/loose.dtd">
-<html>
+<!DOCTYPE HTML>
+<html lang="en">
 <head>
 <title>StreamDevice: aao Records</title>
-<link rel="shortcut icon" href="sls_icon.ico">
-<link rel="stylesheet" type="text/css" href="stream.css">
-<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-<meta name="author" content="Dirk Zimoch">
+<meta charset="utf-8" />
+<link rel="shortcut icon" href="favicon.ico" />
+<link rel="stylesheet" type="text/css" href="stream.css" />
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<meta name="author" content="Dirk Zimoch" />
 </head>
 <body>
-<h1>StreamDevice: aao Records</h1>
+<iframe src="nav.html" id="navleft"></iframe>
+<h1>aao Records</h1>
 <p>
-<b>Note:</b> aao record support is disabled per default.
-Enable it in <code>src/CONFIG_STREAM</code>.
+<b>Note:</b> In EPICS versions before 3.14.12, aao records may be disabled.
 </p>
 
 <h2>Normal Operation</h2>
 <p>
 With aao records, the format converter is applied to
-each element. Between the elements, a separator is printed
+each array element. Between the elements, a separator is printed
 or expected as specified by the <code>Separator</code>
 <a href="protocol.html#sysvar">variable</a> in the protocol.
 When parsing input, a space as the first character of the
@@ -39,6 +39,10 @@ A minimum of one element must be available.
 <p>
 The format data type must be convertible to or from the type
 specified in the <code>FTVL</code> field.
+The types <code>"INT64"</code> and <code>"UINT64"</code> are
+only available in EPICS base version 3.16 or higher.
+</p>
+<p>
 The variable <code><i>x[i]</i></code> stands for one element of
 the written or read value.
 </p>
@@ -47,6 +51,7 @@ the written or read value.
   <dd>
    <u>Output:</u> <code><i>x[i]</i>=double(VAL[i])</code><br>
    <code>FTVL</code> can be <code>"DOUBLE"</code>, <code>"FLOAT"</code>,
+   <code>"INT64"</code>, <code>"UINT64"</code>,
    <code>"LONG"</code>, <code>"ULONG"</code>, <code>"SHORT"</code>,
    <code>"USHORT"</code>, <code>"CHAR"</code>, <code>"UCHAR"</code>,
    or <code>"ENUM"</code> (which is treated as <code>"USHORT"</code>).<br>
@@ -57,6 +62,7 @@ the written or read value.
   <dd>
    <u>Output:</u> <code><i>x[i]</i>=long(VAL[i])</code><br>
    <code>FTVL</code> can be 
+   <code>"INT64"</code>, <code>"UINT64"</code>,
    <code>"LONG"</code>, <code>"ULONG"</code>, <code>"SHORT"</code>,
    <code>"USHORT"</code>, <code>"CHAR"</code>, <code>"UCHAR"</code>,
    or <code>"ENUM"</code> (which is treated as <code>"USHORT"</code>).<br>
@@ -64,6 +70,7 @@ the written or read value.
    zero-extended to long before converting them.<br>
    <u>Input:</u> <code>VAL[i]=FTVL(<i>x[i])</i></code><br>
    <code>FTVL</code> can be <code>"DOUBLE"</code>, <code>"FLOAT"</code>,
+   <code>"INT64"</code>, <code>"UINT64"</code>,
    <code>"LONG"</code>, <code>"ULONG"</code>, <code>"SHORT"</code>,
    <code>"USHORT"</code>, <code>"CHAR"</code>, <code>"UCHAR"</code>,
    or <code>"ENUM"</code> (which is treated as <code>"USHORT"</code>).<br>
@@ -104,25 +111,31 @@ the written or read value.
  present. All format converters work like in normal operation.
 </p>
 
-<hr>
-<p>
+<footer>
+<nav>
 <a href="aai.html">aai</a>
+<a href="aao.html">aao</a>
 <a href="ai.html">ai</a>
 <a href="ao.html">ao</a>
 <a href="bi.html">bi</a>
 <a href="bo.html">bo</a>
-<a href="mbbi.html">mbbi</a>
-<a href="mbbo.html">mbbo</a>
-<a href="mbbiDirect.html">mbbiDirect</a>
-<a href="mbboDirect.html">mbboDirect</a>
+<a href="calcout.html">calcout</a>
+<a href="int64in.html">int64in</a>
+<a href="int64out.html">int64out</a>
 <a href="longin.html">longin</a>
 <a href="longout.html">longout</a>
+<a href="lsi.html">lsi</a>
+<a href="lso.html">lso</a>
+<a href="mbbiDirect.html">mbbiDirect</a>
+<a href="mbboDirect.html">mbboDirect</a>
+<a href="mbbi.html">mbbi</a>
+<a href="mbbo.html">mbbo</a>
+<a href="scalcout.html">scalcout</a>
 <a href="stringin.html">stringin</a>
 <a href="stringout.html">stringout</a>
-<a href="calcout.html">calcout</a>
-<a href="scalcout.html">scalcout</a>
-</p>
-<p><small>Dirk Zimoch, 2006</small></p>
-<script src="stream.js" type="text/javascript"></script>
+<a href="waveform.html">waveform</a>
+</nav>
+Dirk Zimoch, 2018
+</footer>
 </body>
 </html>

docs/ai.html

@@ -1,15 +1,16 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
-    "http://www.w3.org/TR/html4/loose.dtd">
-<html>
+<!DOCTYPE HTML>
+<html lang="en">
 <head>
 <title>StreamDevice: ai Records</title>
-<link rel="shortcut icon" href="sls_icon.ico">
-<link rel="stylesheet" type="text/css" href="stream.css">
-<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-<meta name="author" content="Dirk Zimoch">
+<meta charset="utf-8" />
+<link rel="shortcut icon" href="favicon.ico" />
+<link rel="stylesheet" type="text/css" href="stream.css" />
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<meta name="author" content="Dirk Zimoch" />
 </head>
 <body>
-<h1>StreamDevice: ai Records</h1>
+<iframe src="nav.html" id="navleft"></iframe>
+<h1>ai Records</h1>
 
 <h2>Normal Operation</h2>
 <p>
@@ -38,6 +39,14 @@ written or read value.
    definition. <em>StreamDevice</em> does not set it. For example,
    <code>EOFF=-10</code> and <code>ESLO=0.000305180437934</code>
    (=20.0/0xFFFF) maps 0x0000 to -10.0, 0x7FFF to 0.0 and 0xFFFF to 10.0.
+   Using unsigned formats with values &ge; 0x800000 gives different results
+   on 64 bit machines.
+   <p>
+   If <code>LINR=="NO CONVERSION"</code> (the default), <code>VAL</code>
+   is directly converted from and to <code>long</code> without going through
+   <code>RVAL</code>. This allows for more bits on 64 bit machines.
+   To get the old behavior, use <code>LINR=="LINEAR"</code>.
+   </p>
   </dd>
  <dt>ENUM format (e.g. <code>%{</code>):</dt>
   <dd>
@@ -56,26 +65,31 @@ written or read value.
  (treated as <code>0.0</code>).
 </p>
 
-<hr>
-<p>
+<footer>
+<nav>
 <a href="aai.html">aai</a>
 <a href="aao.html">aao</a>
+<a href="ai.html">ai</a>
 <a href="ao.html">ao</a>
 <a href="bi.html">bi</a>
 <a href="bo.html">bo</a>
-<a href="mbbi.html">mbbi</a>
-<a href="mbbo.html">mbbo</a>
-<a href="mbbiDirect.html">mbbiDirect</a>
-<a href="mbboDirect.html">mbboDirect</a>
+<a href="calcout.html">calcout</a>
+<a href="int64in.html">int64in</a>
+<a href="int64out.html">int64out</a>
 <a href="longin.html">longin</a>
 <a href="longout.html">longout</a>
+<a href="lsi.html">lsi</a>
+<a href="lso.html">lso</a>
+<a href="mbbiDirect.html">mbbiDirect</a>
+<a href="mbboDirect.html">mbboDirect</a>
+<a href="mbbi.html">mbbi</a>
+<a href="mbbo.html">mbbo</a>
+<a href="scalcout.html">scalcout</a>
 <a href="stringin.html">stringin</a>
 <a href="stringout.html">stringout</a>
 <a href="waveform.html">waveform</a>
-<a href="calcout.html">calcout</a>
-<a href="scalcout.html">scalcout</a>
-</p>
-<p><small>Dirk Zimoch, 2005</small></p>
-<script src="stream.js" type="text/javascript"></script>
+</nav>
+Dirk Zimoch, 2018
+</footer>
 </body>
 </html>

docs/ao.html

@@ -1,15 +1,16 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
-    "http://www.w3.org/TR/html4/loose.dtd">
-<html>
+<!DOCTYPE HTML>
+<html lan="en">
 <head>
 <title>StreamDevice: ao Records</title>
-<link rel="shortcut icon" href="sls_icon.ico">
-<link rel="stylesheet" type="text/css" href="stream.css">
-<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-<meta name="author" content="Dirk Zimoch">
+<meta charset="utf-8" />
+<link rel="shortcut icon" href="favicon.ico" / />
+<link rel="stylesheet" type="text/css" href="stream.css" / />
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" / />
+<meta name="author" content="Dirk Zimoch" / />
 </head>
 <body>
-<h1>StreamDevice: ao Records</h1>
+<iframe src="nav.html" id="navleft"></iframe>
+<h1>ao Records</h1>
 
 <h2>Normal Operation</h2>
 <p>
@@ -30,13 +31,21 @@ written or read value.
  <dt>LONG format (e.g. <code>%i</code>):</dt>
   <dd>
    <u>Output:</u> <code><i>x</i>=RVAL</code><br>
-   <u>Input:</u> <code>RBV=<i>x</i></code><br>
+   <u>Input:</u> <code>RBV=RVAL=<i>x</i></code><br>
    Note that the record calculates
    <code>RVAL=(((OVAL-EOFF)/ESLO)-AOFF)/ASLO</code> if
    <code>LINR=="LINEAR"</code>. <code>ESLO</code> and <code>EOFF</code>
    might be set in the record definition. <em>StreamDevice</em> does not set it.
    For example, <code>EOFF=-10</code> and <code>ESLO=0.000305180437934</code>
    (=20.0/0xFFFF) maps -10.0 to 0x0000, 0.0 to 0x7FFF and 10.0 to 0xFFFF.
+   Using unsigned formats with values &ge; 0x800000 gives different results
+   on 64 bit machines.
+   <p>
+   If <code>LINR=="NO CONVERSION"</code> (the default), <code>OVAL</code>
+   is directly converted to <code>long</code> without going through
+   <code>RVAL</code>. This allows for more bits on 64 bit machines.
+   To get the old behavior, use <code>LINR=="LINEAR"</code>.
+   </p>
   </dd>
  <dt>ENUM format (e.g. <code>%{</code>):</dt>
   <dd>
@@ -54,29 +63,33 @@ written or read value.
  present. In contrast to normal operation, output in DOUBLE format uses
  <code>VAL</code> instead of <code>OVAL</code>. Note that the record
  initializes <code>VAL</code> from <code>DOL</code> if that is a constant.
- LONG input is put to <code>RVAL</code> as well as to <code>RBV</code> and
- converted by the record.
 </p>
-<hr>
-<p>
+
+<footer>
+<nav>
 <a href="aai.html">aai</a>
 <a href="aao.html">aao</a>
 <a href="ai.html">ai</a>
+<a href="ao.html">ao</a>
 <a href="bi.html">bi</a>
 <a href="bo.html">bo</a>
-<a href="mbbi.html">mbbi</a>
-<a href="mbbo.html">mbbo</a>
-<a href="mbbiDirect.html">mbbiDirect</a>
-<a href="mbboDirect.html">mbboDirect</a>
+<a href="calcout.html">calcout</a>
+<a href="int64in.html">int64in</a>
+<a href="int64out.html">int64out</a>
 <a href="longin.html">longin</a>
 <a href="longout.html">longout</a>
+<a href="lsi.html">lsi</a>
+<a href="lso.html">lso</a>
+<a href="mbbiDirect.html">mbbiDirect</a>
+<a href="mbboDirect.html">mbboDirect</a>
+<a href="mbbi.html">mbbi</a>
+<a href="mbbo.html">mbbo</a>
+<a href="scalcout.html">scalcout</a>
 <a href="stringin.html">stringin</a>
 <a href="stringout.html">stringout</a>
 <a href="waveform.html">waveform</a>
-<a href="calcout.html">calcout</a>
-<a href="scalcout.html">scalcout</a>
-</p>
-<p><small>Dirk Zimoch, 2005</small></p>
-<script src="stream.js" type="text/javascript"></script>
+</nav>
+Dirk Zimoch, 2018
+</footer>
 </body>
 </html>

docs/bi.html

@@ -1,15 +1,16 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
-    "http://www.w3.org/TR/html4/loose.dtd">
-<html>
+<!DOCTYPE HTML>
+<html lang="en">
 <head>
 <title>StreamDevice: bi Records</title>
-<link rel="shortcut icon" href="sls_icon.ico">
-<link rel="stylesheet" type="text/css" href="stream.css">
-<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-<meta name="author" content="Dirk Zimoch">
+<meta charset="utf-8" />
+<link rel="shortcut icon" href="favicon.ico" />
+<link rel="stylesheet" type="text/css" href="stream.css" />
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<meta name="author" content="Dirk Zimoch" />
 </head>
 <body>
-<h1>StreamDevice: bi Records</h1>
+<iframe src="nav.html" id="navleft"></iframe>
+<h1>bi Records</h1>
 
 <h2>Normal Operation</h2>
 <p>
@@ -52,26 +53,31 @@ written or read value.
  present. All format converters work like in normal operation.
 </p>
 
-<hr>
-<p>
+<footer>
+<nav>
 <a href="aai.html">aai</a>
 <a href="aao.html">aao</a>
 <a href="ai.html">ai</a>
 <a href="ao.html">ao</a>
+<a href="bi.html">bi</a>
 <a href="bo.html">bo</a>
-<a href="mbbi.html">mbbi</a>
-<a href="mbbo.html">mbbo</a>
-<a href="mbbiDirect.html">mbbiDirect</a>
-<a href="mbboDirect.html">mbboDirect</a>
+<a href="calcout.html">calcout</a>
+<a href="int64in.html">int64in</a>
+<a href="int64out.html">int64out</a>
 <a href="longin.html">longin</a>
 <a href="longout.html">longout</a>
+<a href="lsi.html">lsi</a>
+<a href="lso.html">lso</a>
+<a href="mbbiDirect.html">mbbiDirect</a>
+<a href="mbboDirect.html">mbboDirect</a>
+<a href="mbbi.html">mbbi</a>
+<a href="mbbo.html">mbbo</a>
+<a href="scalcout.html">scalcout</a>
 <a href="stringin.html">stringin</a>
 <a href="stringout.html">stringout</a>
 <a href="waveform.html">waveform</a>
-<a href="calcout.html">calcout</a>
-<a href="scalcout.html">scalcout</a>
-</p>
-<p><small>Dirk Zimoch, 2005</small></p>
-<script src="stream.js" type="text/javascript"></script>
+</nav>
+Dirk Zimoch, 2018
+</footer>
 </body>
 </html>

docs/bo.html

@@ -1,15 +1,16 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
-    "http://www.w3.org/TR/html4/loose.dtd">
-<html>
+<!DOCTYPE HTML>
+<html lang="en">
 <head>
 <title>StreamDevice: bo Records</title>
-<link rel="shortcut icon" href="sls_icon.ico">
-<link rel="stylesheet" type="text/css" href="stream.css">
-<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-<meta name="author" content="Dirk Zimoch">
+<meta charset="utf-8" />
+<link rel="shortcut icon" href="favicon.ico" />
+<link rel="stylesheet" type="text/css" href="stream.css" />
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<meta name="author" content="Dirk Zimoch" />
 </head>
 <body>
-<h1>StreamDevice: bo Records</h1>
+<iframe src="nav.html" id="navleft"></iframe>
+<h1>bo Records</h1>
 
 <h2>Normal Operation</h2>
 <p>
@@ -51,26 +52,31 @@ written or read value.
  <code>RVAL</code> as well as to <code>RBV</code> and converted by the record.
 </p>
 
-<hr>
-<p>
+<footer>
+<nav>
 <a href="aai.html">aai</a>
 <a href="aao.html">aao</a>
 <a href="ai.html">ai</a>
 <a href="ao.html">ao</a>
 <a href="bi.html">bi</a>
-<a href="mbbi.html">mbbi</a>
-<a href="mbbo.html">mbbo</a>
-<a href="mbbiDirect.html">mbbiDirect</a>
-<a href="mbboDirect.html">mbboDirect</a>
+<a href="bo.html">bo</a>
+<a href="calcout.html">calcout</a>
+<a href="int64in.html">int64in</a>
+<a href="int64out.html">int64out</a>
 <a href="longin.html">longin</a>
 <a href="longout.html">longout</a>
+<a href="lsi.html">lsi</a>
+<a href="lso.html">lso</a>
+<a href="mbbiDirect.html">mbbiDirect</a>
+<a href="mbboDirect.html">mbboDirect</a>
+<a href="mbbi.html">mbbi</a>
+<a href="mbbo.html">mbbo</a>
+<a href="scalcout.html">scalcout</a>
 <a href="stringin.html">stringin</a>
 <a href="stringout.html">stringout</a>
 <a href="waveform.html">waveform</a>
-<a href="calcout.html">calcout</a>
-<a href="scalcout.html">scalcout</a>
-</p>
-<p><small>Dirk Zimoch, 2005</small></p>
-<script src="stream.js" type="text/javascript"></script>
+</nav>
+Dirk Zimoch, 2018
+</footer>
 </body>
 </html>

docs/businterface.html

@@ -1,14 +1,15 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
-    "http://www.w3.org/TR/html4/loose.dtd">
-<html>
+<!DOCTYPE HTML>
+<html lang="en">
 <head>
 <title>StreamDevice: Bus API</title>
-<link rel="shortcut icon" href="sls_icon.ico">
-<link rel="stylesheet" type="text/css" href="stream.css">
-<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-<meta name="author" content="Dirk Zimoch">
+<meta charset="utf-8" />
+<link rel="shortcut icon" href="favicon.ico" />
+<link rel="stylesheet" type="text/css" href="stream.css" />
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<meta name="author" content="Dirk Zimoch" />
 </head>
 <body>
+<iframe src="nav.html" id="navleft"></iframe>
 <h1>Bus API</h1>
 
 <a name="class"></a>
@@ -18,7 +19,7 @@
     href="http://www.aps.anl.gov/epics/modules/soft/asyn/">
     <em>asynDriver</em></a>.
 You should first try to implement your bus driver compatible to
-<em>asynDriver</em>.
+<em>asynOctet</em>.
 Then it can be used by <em>StreamDevice</em> automatically.
 Only if that does not work, write your own bus interface.
 </p>
@@ -67,17 +68,13 @@ class MyInterface : StreamBusInterface
     // StreamBusInterface virtual methods
     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,
-        long expectedLength, bool async);
+    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, long 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 replytimeout_ms);
-    bool <a href="#connect">connectRequest</a>(unsigned long connecttimeout_ms);
-    bool <a href="#connect">disconnect</a>();
+    bool <a href="#event">acceptEvent</a>(unsigned long mask, unsigned long timeout_ms);
+    bool <a href="#connect">connectRequest</a>(unsigned long timeout_ms);
+    bool <a href="#connect">disconnectRequest</a>();
     void <a href="#lock">finish</a>();
 
 public:
@@ -131,13 +128,13 @@ bool <a href="#event">supportsEvent</a>();
 </code></div>
 <div class="indent"><code>
 bool <a href="#event">acceptEvent</a>(unsigned&nbsp;long&nbsp;mask, 
-    unsigned&nbsp;long&nbsp;replytimeout_ms);
+    unsigned&nbsp;long&nbsp;timeout_ms);
 </code></div>
 <div class="indent"><code>
-bool <a href="#connect">connectRequest</a>(unsigned&nbsp;long&nbsp;connecttimeout_ms);
+bool <a href="#connect">connectRequest</a>(unsigned&nbsp;long&nbsp;timeout_ms);
 </code></div>
 <div class="indent"><code>
-bool <a href="#connect">disconnect</a>();
+bool <a href="#connect">disconnectRequest</a>();
 </code></div>
 <div class="indent"><code>
 void <a href="#lock">finish</a>();
@@ -156,24 +153,24 @@ callback methods which must be called in response to the above request
 methods (most probably from another thread):
 </p>
 <div class="indent"><code>
-void <a href="#lock">lockCallback</a>(StreamIoStatus&nbsp;status);
+void <a href="#lock">lockCallback</a>(StreamIoStatus&nbsp;status = StreamIoSuccess);
 </code></div>
 <div class="indent"><code>
-void <a href="#write">writeCallback</a>(StreamIoStatus&nbsp;status);
+void <a href="#write">writeCallback</a>(StreamIoStatus&nbsp;status = StreamIoSuccess);
 </code></div>
 <div class="indent"><code>
-long <a href="#read">readCallback</a>(StreamIoStatus&nbsp;status,
-        const&nbsp;void*&nbsp;input&nbsp;=&nbsp;NULL,
-        long&nbsp;size&nbsp;=&nbsp;0);
+ssize_t <a href="#read">readCallback</a>(StreamIoStatus&nbsp;status,
+        const&nbsp;void*&nbsp;buffer&nbsp;=&nbsp;NULL,
+        size_t&nbsp;size&nbsp;=&nbsp;0);
 </code></div>
 <div class="indent"><code>
-void <a href="#event">eventCallback</a>(StreamIoStatus&nbsp;status);
+void <a href="#event">eventCallback</a>(StreamIoStatus&nbsp;status = StreamIoSuccess);
 </code></div>
 <div class="indent"><code>
-void <a href="#connect">connectCallback</a>(StreamIoStatus&nbsp;status);
+void <a href="#connect">connectCallback</a>(StreamIoStatus&nbsp;status = StreamIoSuccess);
 </code></div>
 <div class="indent"><code>
-void <a href="#connect">disconnectCallback</a>(StreamIoStatus&nbsp;status);
+void <a href="#connect">disconnectCallback</a>(StreamIoStatus&nbsp;status = StreamIoSuccess);
 </code></div>
 
 <h3>Other provided methods, attibutes, and types</h3>
@@ -196,6 +193,9 @@ const&nbsp;char*&nbsp;<a href="#read">getInTerminator</a>(size_t&&nbsp;length);
 <div class="indent"><code>
 enum&nbsp;StreamIoStatus {StreamIoSuccess, StreamIoTimeout, StreamIoNoReply, StreamIoEnd, StreamIoFault};
 </code></div>
+<div class="indent"><code>
+const char* ::toStr(StreamIoStatus);
+</code></div>
 
 <a name="theory"></a>
 <h2>Theory of Operation</h2>
@@ -275,34 +275,47 @@ correct.
 <a name="connect"></a>
 <h3>Connecting and disconnecting</h3>
 <div class="indent"><code>
-bool connectRequest(unsigned&nbsp;long&nbsp;connecttimeout_ms);
+bool connectRequest(unsigned&nbsp;long&nbsp;timeout_ms);
 </code></div>
 <div class="indent"><code>
-bool disconnect();
+bool disconnectRequest();
 </code></div>
 <div class="indent"><code>
-void connectCallback(IoStatus&nbsp;status);
+void connectCallback(IoStatus&nbsp;status = StreamIoSuccess);
 </code></div>
 <div class="indent"><code>
-void disconnectCallback(IoStatus&nbsp;status);
+void disconnectCallback(IoStatus&nbsp;status = StreamIoSuccess);
 </code></div>
 <p>
-Connection should be handled automatically.
-If the device is disconnected, each attempt to access the
-device should try to (re-)connect.
+Whenever possible connection should be handled automatically.
+The interface should call <code>connectCallback()</code> when
+the device has connected and <code>disconnectCallback()</code> when
+the device has disconnected.
+These callbacks can be called asynchronously at any time.
+</p>
+<p>
+If the device is disconnected, an attempt to access the
+device should try to reconnect.
 Normally, the interface should not try to disconnect unless
-the device does so.
+the device does so automatically.
 </p>
 <p>
 However, sometimes the client wants to connect or
-disconnect explicitely.
+disconnect explicitly.
 To connect, the client calls <code>connectRequest()</code>.
-This function should return <code>true</code> immediately
-or <code>false</code> if the request cannot be accepted or connection
+This function should set up things to reconnect but should not block
+waiting.
+Instead it should immediately return <code>true</code> if
+it expects that connection can be established soon, or
+<code>false</code> if the request cannot be accepted or connection
 handling is not supported.
-The interface should call <code>connectCallback(StreamIoSuccess)</code>
+The interface should call <code>connectCallback()</code>
 once the bus could be connected.
-If the bus cannot be connected within <code>connecttimeout_ms</code>
+If the device can connect immediately without waiting, it may also call
+<code>connectCallback()</code> directly from <code>connectRequest()</code>.
+</p>
+<p>
+If the bus cannot be connected within <code>timeout_ms</code>
 milliseconds, the bus interface should call
 <code>connectCallback(StreamIoTimeout)</code>.
 </p>
@@ -312,11 +325,11 @@ something wrong with the I/O hardware,
 <code>connectCallback(StreamIoFault)</code> may be called.
 </p>
 <p>
-To disconnect, the client calls <code>disconnectRequest()</code>;
+To disconnect explicitly, the client calls <code>disconnectRequest()</code>;
 This function should return <code>true</code> immediately or
 <code>false</code> if the request cannot be accepted or connection
 handling is not supported.
-The interface should call <code>connectCallback(StreamIoSuccess)</code>
+The interface should call <code>connectCallback()</code>
 once the bus is disconnected. There is no timeout for this operation.
 If disconnecting is impossible, the interface should call
 <code>connectCallback(StreamIoFault)</code>.
@@ -325,10 +338,10 @@ If disconnecting is impossible, the interface should call
 <a name="lock"></a>
 <h3>Bus locking</h3>
 <div class="indent"><code>
-bool lockRequest(unsigned&nbsp;long&nbsp;lockTimeout_ms);
+bool lockRequest(unsigned&nbsp;long&nbsp;timeout_ms);
 </code></div>
 <div class="indent"><code>
-void lockCallback(IoStatus&nbsp;status);
+void lockCallback(IoStatus&nbsp;status = StreamIoSuccess);
 </code></div>
 <div class="indent"><code>
 bool unlock();
@@ -347,7 +360,7 @@ or <code>false</code> if the request cannot be accepted.
 If the device is already locked, the bus interface should add itself to
 a queue, sorted by <code>priority()</code>.
 As soon as the device is available, the bus interface should call
-<code>lockCallback(StreamIoSuccess)</code>.
+<code>lockCallback()</code>.
 If the bus cannot be locked within <code>lockTimeout_ms</code>
 milliseconds, the bus interface should call
 <code>lockCallback(StreamIoTimeout)</code>.
@@ -368,7 +381,7 @@ locked the device.
 When the protocol ends and the device is locked, the client calls
 <code>unlock()</code>.
 If other bus interfaces are in the lock queue, the next one should
-call <code>lockCallback(StreamIoSuccess)</code> now.
+call <code>lockCallback()</code> now.
 </p>
 <p>
 The client calls <code>finish()</code> when the protocol ends.
@@ -384,7 +397,7 @@ bool writeRequest(const&nbsp;void*&nbsp;output,
     size_t&nbsp;size, unsigned&nbsp;long&nbsp;writeTimeout_ms);
 </code></div>
 <div class="indent"><code>
-void writeCallback(IoStatus&nbsp;status);
+void writeCallback(IoStatus&nbsp;status = StreamIoSuccess);
 </code></div>
 <div class="indent"><code>
 const&nbsp;char*&nbsp;getOutTerminator(size_t&&nbsp;length);
@@ -403,7 +416,7 @@ The function should arrange transmission of <code>size</code> bytes of
 or <code>false</code> if the request cannot be accepted.
 It must not block until output has completed.
 After all output has been successfully transmitted, but not earlier, the
-interface should call <code>writeCallback(StreamIoSuccess)</code>.
+interface should call <code>writeCallback()</code>.
 </p>
 <p>
 If output blocks for <code>writeTimeout_ms</code> milliseconds,
@@ -416,14 +429,15 @@ something wrong with the I/O hardware,
 <code>writeCallback(StreamIoFault)</code> may be called.
 </p>
 <p>
-The interface must transmit excactly the <code>size</code> bytes
-from <code>output</code>.
-It must not change anything and it should not assume that
-any bytes have a special meaning.
+The interface must send excactly the <code>size</code> bytes
+from <code>output</code>, not less.
+It should not change anything unless the bus needs some special
+formatting (e.g. added header, escaped bytes) and it should not
+assume that any bytes have a special meaning.
 In particular, a null byte does not terminate <code>output</code>.
 </p>
 <p>
-A call to <code>getOutTerminator</code> tells the interface which
+A call to <code>getOutTerminator()</code> tells the interface which
 terminator has already been added to the output.
 If <code>NULL</code> was returned, the client is not aware of a
 terminator (no outTerminator was defined in the protocol).
@@ -449,9 +463,9 @@ bool readRequest(unsigned&nbsp;long&nbsp;replyTimeout_ms,
     long&nbsp;expectedLength, bool&nbsp;async);
 </code></div>
 <div class="indent"><code>
-long readCallback(IoStatus&nbsp;status,
-        const&nbsp;void*&nbsp;input&nbsp;=&nbsp;NULL,
-        long&nbsp;size&nbsp;=&nbsp;0);
+ssize_t readCallback(IoStatus&nbsp;status,
+        const&nbsp;void*&nbsp;buffer&nbsp;=&nbsp;NULL,
+        size_t&nbsp;size&nbsp;=&nbsp;0);
 </code></div>
 <div class="indent"><code>
 const&nbsp;char*&nbsp;getInTerminator(size_t&&nbsp;length);
@@ -486,11 +500,11 @@ The client copies its contents. It does not modify or free it.
 It is not necessary to wait until all data has been received.
 The bus interface can call <code>n=readCallback()</code> after
 any amount of input has been received.
-If the client needs more input, <code>readCallback()</code>
+If the client expects more input, <code>readCallback()</code>
 returns a non-zero value.
-A positive <code>n</code> means, the client needs another
+A positive <code>n</code> means, the client expects another
 <code>n</code> bytes of input.
-A negative <code>n</code> means, the client needs an unspecified
+A negative <code>n</code> means, the client expects an unspecified
 amount of additional input.
 </p>
 <p>
@@ -558,46 +572,43 @@ something wrong with the I/O hardware,
 <code>readCallback(StreamIoFault)</code> may be called.
 </p>
 <p>
-If the <code>async</code> flag is <code>true</code>, the client
-wants to read input asyncronously without any timeout.
-That means, the bus interface should call <code>readCallback()</code>
-even if the input was requested by another client.
-</p>
-<p>
-If a client wishes to receive asynchonous input, it first calls
+Sometimes a client wishes to get any input received at any time, even
+when requested by another client. 
+If a client wishes to receive such asynchronous input, it first calls
 <code>supportsAsyncRead()</code>.
 The default implementation of this method always returns
 <code>false</code>.
-A bus interface may overwrite this method to return <code>true</code>
-and eventually prepare for asynchonous input.
+If a bus interface supports asynchronous input, it should overwrite
+this method to set up everything needed to receive asynchronous input
+and then return <code>true</code>.
 The client is then allowed to call <code>readRequest()</code> with
 the <code>async==true</code>.
-This means that the client is interested in any input.
+This means that the client is now interested in asynchronous input.
 It should receive a <code>readCallback()</code> of all input which came
-in response to a synchonous (<code>async==false</code>) request from
-another client (which of course should receive the input, too).
-The interface should also receive asynchonous input when no
+in response to any synchonous (<code>async==false</code>) request from
+another client (which should receive the input, too).
+The interface should also receive asynchronous input when no
 synchonous client is active at the moment.
-Many asynchonous <code>readRequest()</code> calls from different clients
+Many asynchronous <code>readRequest()</code> calls from different clients
 may be active at the same time.
 All of them should receive the same input.
 </p>
 <p>
-For asynchonous requests, <code>replyTimeout_ms</code> has a different
+For asynchronous requests, <code>replyTimeout_ms</code> has a different
 meaning: If the bus interface has to poll the bus for input, it may take
 <code>replyTimeout_ms</code> as a hint for the poll period.
-If many asynchonous requests are active at the same time, it should poll
+If many asynchronous requests are active at the same time, it should poll
 with the shortest period of all clients.
-An asynchonous request does not time out.
+An asynchronous request does not time out.
 It stays active until the next input arrives.
 The client may reissue the asynchronous <code>readRequest()</code>
 from within the <code>readCallback()</code> if it wants to continue
-receiving asynchonous input.
+receiving asynchronous input.
 </p>
 <p>
 If the client calls <code>finish()</code> at any time, the bus
 interface should cancel all outstanding requests, including
-asynchonous read requests.
+asynchronous read requests.
 </p>
 <a name="event"></a>
 <h3>Handling events</h3>
@@ -605,10 +616,10 @@ asynchonous read requests.
 bool supportsEvent();
 </code></div>
 <div class="indent"><code>
-bool acceptEvent(unsigned long mask, unsigned long replytimeout_ms);
+bool acceptEvent(unsigned long mask, unsigned long timeout_ms);
 </code></div>
 <div class="indent"><code>
-void eventCallback(StreamIoStatus status);
+void eventCallback(StreamIoStatus status = StreamIoSuccess);
 </code></div>
 <p>
 An event is a sort of input from a device which is not part of
@@ -626,9 +637,9 @@ If <code>true</code> is returned, the client is allowed to call
 If <code>mask</code> is illegal, <code>acceptEvent()</code> should
 return <code>false</code>.
 The call to <code>acceptEvent()</code> must not block.
-It should arrange to call <code>eventCallback(StreamIoSuccess)</code>
+It should arrange to call <code>eventCallback()</code>
 when the event matching <code>mask</code> arrives within
-<code>replytimeout_ms</code> milliseconds.
+<code>timeout_ms</code> milliseconds.
 If no such event arrives within this time, the bus interface
 should call <code>eventCallback(StreamIoTimeout)</code>.
 </p>
@@ -638,8 +649,9 @@ also report a matching event which occured before the actual call
 to <code>acceptEvent()</code> but after any previous call of any
 other request method like <code>writeRequest()</code>.
 </p>
-<hr>
-<p><small>Dirk Zimoch, 2007</small></p>
-<script src="stream.js" type="text/javascript"></script>
+
+<footer>
+Dirk Zimoch, 2018
+</footer>
 </body>
 </html>

docs/calcout.html

@@ -1,15 +1,16 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
-    "http://www.w3.org/TR/html4/loose.dtd">
-<html>
+<!DOCTYPE HTML>
+<html lang="en">
 <head>
 <title>StreamDevice: calcout Records</title>
-<link rel="shortcut icon" href="sls_icon.ico">
-<link rel="stylesheet" type="text/css" href="stream.css">
-<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-<meta name="author" content="Dirk Zimoch">
+<meta charset="utf-8" />
+<link rel="shortcut icon" href="favicon.ico" />
+<link rel="stylesheet" type="text/css" href="stream.css" />
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<meta name="author" content="Dirk Zimoch" />
 </head>
 <body>
-<h1>StreamDevice: calcout Records</h1>
+<iframe src="nav.html" id="navleft"></iframe>
+<h1>calcout Records</h1>
 
 <p>
 <b>Note:</b> Device support for calcout records is only available for
@@ -58,26 +59,31 @@ Different record fields are used for output and input. The variable
  present. All format converters work like in normal operation.
 </p>
 
-<hr>
-<p>
+<footer>
+<nav>
 <a href="aai.html">aai</a>
 <a href="aao.html">aao</a>
 <a href="ai.html">ai</a>
 <a href="ao.html">ao</a>
 <a href="bi.html">bi</a>
 <a href="bo.html">bo</a>
-<a href="mbbi.html">mbbi</a>
-<a href="mbbo.html">mbbo</a>
-<a href="mbbiDirect.html">mbbiDirect</a>
-<a href="mbboDirect.html">mbboDirect</a>
+<a href="calcout.html">calcout</a>
+<a href="int64in.html">int64in</a>
+<a href="int64out.html">int64out</a>
 <a href="longin.html">longin</a>
 <a href="longout.html">longout</a>
+<a href="lsi.html">lsi</a>
+<a href="lso.html">lso</a>
+<a href="mbbiDirect.html">mbbiDirect</a>
+<a href="mbboDirect.html">mbboDirect</a>
+<a href="mbbi.html">mbbi</a>
+<a href="mbbo.html">mbbo</a>
+<a href="scalcout.html">scalcout</a>
 <a href="stringin.html">stringin</a>
 <a href="stringout.html">stringout</a>
 <a href="waveform.html">waveform</a>
-<a href="scalcout.html">scalcout</a>
-</p>
-<p><small>Dirk Zimoch, 2005</small></p>
-<script src="stream.js" type="text/javascript"></script>
+</nav>
+Dirk Zimoch, 2018
+</footer>
 </body>
 </html>

docs/epics3_13.html

@@ -1,15 +1,16 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
-    "http://www.w3.org/TR/html4/loose.dtd">
-<html>
+<!DOCTYPE HTML>
+<html lang="en">
 <head>
 <title>StreamDevice: Using EPICS 3.13</title>
-<link rel="shortcut icon" href="sls_icon.ico">
-<link rel="stylesheet" type="text/css" href="stream.css">
-<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-<meta name="author" content="Dirk Zimoch">
+<meta charset="utf-8" />
+<link rel="shortcut icon" href="favicon.ico" />
+<link rel="stylesheet" type="text/css" href="stream.css" />
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<meta name="author" content="Dirk Zimoch" />
 </head>
 <body>
-<h1>StreamDevice: Using EPICS 3.13</h1>
+<iframe src="nav.html" id="navleft"></iframe>
+<h1>Using EPICS 3.13</h1>
 
 <a name="pre"></a>
 <h2>1. Prerequisites</h2>
@@ -217,8 +218,31 @@ asynSetOption ("PS1", 0, "stop", "1")
 
 <h2>7. <a href="setup.html#pro">Continue as with EPICS 3.14.</a></h2>
 
-<hr>
-<p><small>Dirk Zimoch, 2006</small></p>
-<script src="stream.js" type="text/javascript"></script>
+<footer>
+<nav>
+<a href="aai.html">aai</a>
+<a href="aao.html">aao</a>
+<a href="ai.html">ai</a>
+<a href="ao.html">ao</a>
+<a href="bi.html">bi</a>
+<a href="bo.html">bo</a>
+<a href="calcout.html">calcout</a>
+<a href="int64in.html">int64in</a>
+<a href="int64out.html">int64out</a>
+<a href="longin.html">longin</a>
+<a href="longout.html">longout</a>
+<a href="lsi.html">lsi</a>
+<a href="lso.html">lso</a>
+<a href="mbbiDirect.html">mbbiDirect</a>
+<a href="mbboDirect.html">mbboDirect</a>
+<a href="mbbi.html">mbbi</a>
+<a href="mbbo.html">mbbo</a>
+<a href="scalcout.html">scalcout</a>
+<a href="stringin.html">stringin</a>
+<a href="stringout.html">stringout</a>
+<a href="waveform.html">waveform</a>
+</nav>
+Dirk Zimoch, 2018
+</footer>
 </body>
 </html>

docs/formatconverter.html

@@ -0,0 +1,266 @@
+<!DOCTYPE HTML>
+<html lang="en">
+<head>
+<title>StreamDevice: Format Converter API</title>
+<meta charset="utf-8" />
+<link rel="shortcut icon" href="favicon.ico" />
+<link rel="stylesheet" type="text/css" href="stream.css" />
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<meta name="author" content="Dirk Zimoch" />
+</head>
+<body>
+<iframe src="nav.html" id="navleft"></iframe>
+<h1>Format Converter API</h1>
+
+<a name="class"></a>
+<h2>Converter Class</h2>
+<p>
+A user defined converter class inherits public from
+<i>StreamFormatConverter</i> and handles one or more conversion characters.
+It is not necessary that a given conversion character supports both,
+printing and scanning.
+But if it does, both must be handled by the same converter class.
+</p>
+<p>
+Any conversion corresponds to one data type. The converter class must
+implement print and/or scan methods for this data type. It must also
+implement a parse method to analyse the format string.
+</p>
+<p>
+A converter class must be registered with a call to RegisterConverter()
+in the global file context.
+</p>
+<p>
+The converter must not contain any class variables, because there will be
+only one global instance for each conversion character - not one for each
+format string!
+</p>
+
+<h3>Example: LONG converter for <code>%Q</code></h3>
+<pre>
+#include "StreamFormatConverter.h"
+
+class MyConverter : public StreamFormatConverter
+{
+    int parse(const StreamFormat&, StreamBuffer&, const char*&, bool);
+    bool printLong(const StreamFormat&, StreamBuffer&, long);
+    ssize_t scanLong(const StreamFormat&, const char*, long&);
+};
+
+RegisterConverter(MyConverter,"Q");
+
+// ... (implementation)
+</pre>
+
+<a name="theory"></a>
+<h2>Theory of Operation</h2>
+
+<a name="registration"></a>
+<h3>Registration </h3>
+<div class="indent"><code>
+RegisterConverter(<i>converterClass</i>, "<i>characters</i>");
+</code></div>
+<p>
+This macro registers the converter class for all given conversion
+characters. In most cases, you will give only one character.
+The macro must be called once for each class in the global file context.
+</p>
+<p>
+HINT: Do not branch depending on the conversion character.
+Provide multiple classes, that's more efficient.
+</p>
+
+<a name="parsing"></a>
+<h3>Parsing</h3>
+<div class="indent"><code>
+int parse(const&nbsp;StreamFormat&&nbsp;fmt, StreamBuffer&&nbsp;info,
+const&nbsp;char*&&nbsp;source, bool&nbsp;scanFormat);
+</code></div>
+<div class="indent"><code>
+struct&nbsp;StreamFormat {
+char&nbsp;conv;
+StreamFormatType&nbsp;type;
+unsigned&nbsp;short&nbsp;flags;
+long&nbsp;prec;
+unsigned&nbsp;long&nbsp;width;
+unsigned&nbsp;long&nbsp;infolen;
+const&nbsp;char*&nbsp;info;
+};
+</code></div>
+
+<p>
+During initialization, <code>parse()</code> is called whenever one of the
+conversion characters handled by your converter class is found in a protocol.
+The fields <code>fmt.conv</code>, <code>fmt.flags</code>,
+<code>fmt.prec</code>, and <code>fmt.width</code> have
+already been filled in. If a scan format is parsed, <code>scanFormat</code>
+is <code>true</code>. If a print format is parsed, <code>scanFormat</code>
+is <code>false</code>.
+</p>
+<p>
+The <code>fmt.flags</code> field is a bitset and can have any of the following
+flags set:
+</p>
+<ul>
+ <li><code>left_flag</code>: the format contained a <code>-</code>.
+   This is normaly used to indicate that the value should be printed
+   left-aligned.
+ </li>
+ <li><code>sign_flag</code>: the format contained a <code>+</code>.
+   This normaly requests to print a sign even for positive numbers.
+ </li>
+ <li><code>space_flag</code>: the format contained a '<code>&nbsp;</code>' (space).
+   This normaly requests to print a space instead of a sign for positive numbers.
+ </li>
+ <li><code>alt_flag</code>: the format contained a <code>#</code>.
+   This indicated the request to use an alternative format. For example in
+   <code>%#x</code> the hex number is preficed with <code>0x</code>.
+ </li>
+ <li><code>zero_flag</code>: the format contained a <code>0</code>.
+   This normaly requests to pad a numerical value with leading zeros
+   instead of leading spaces.
+ <li><code>skip_flag</code>: the format contained a <code>*</code>.
+   The value is parsed and checked but then discarded.
+</ul>
+<p>
+It is not necessary that these flags have exactly the same meaning in your
+formats, but a similar and intuitive meaning is helpful for the user.
+</p>
+<p>
+There are two additional flags, <code>default_flag</code> indicating a
+<code>?</code> and <code>compare_flag</code> indicating a <code>=</code>
+in the format, that are handled internally by <em>StreamDevice</em> and
+are not of interest to the converter class.
+</p>
+<p>
+The <code>source</code> pointer points to the character of the format string
+just after the conversion character. You can parse additional characters if
+they belong to the format string handled by your class.
+Move the <code>source</code> pointer so that is points to the first character
+after your format string.
+This is done for example in the builtin formats
+<code>%[charset]</code> or <code>%{enum0|enum1}</code>.
+However, many formats don't need additional characters.
+
+</p>
+<h4>Example</h4>
+<pre>
+ source       source
+ before       after
+ parse()      parse()
+     |         |
+"%39[0-9a-zA-Z]constant text"
+    |
+ conversion
+ character
+</pre>
+
+<p>
+You can write any data you may need later in <code>print*()</code> or
+<code>scan*()</code> to the
+<a href="streambuffer.html"><i>Streambuffer</i></a> <code>info</code>.
+This will probably be necessary if you have parsed additional characters
+from the format string as in the above example<br>
+</p>
+<p>
+Return <code>unsigned_format</code>, <code>signed_format</code>,
+<code>double_format</code>, <code>string_format</code>, or
+<code>enum_format</code> depending on the
+datatype associated with the conversion character.
+It is not necessary to return the same value for print and for scan
+formats.
+You can even return different values depending on the format string.
+</p>
+<p>
+If the format is not a real data conversion but does other things with
+the data (append or check a checksum, encode or decode the data,...),
+return <code>pseudo_format</code>.
+</p>
+<p>
+Return <code>false</code> if there is any parse error or if print or scan
+is requested but not supported by this conversion or flags are used that
+are not supported by this conversion.
+</p>
+
+<a name="printing_scanning"></a>
+<h3>Printing and Scanning</h3>
+<p>
+Provide a <code>print[Long|Double|String|Pseudo]()</code> and/or
+<code>scan[Long|Double|String|Pseudo]()</code> method appropriate
+for the data type you have returned in the <code>parse()</code> method.
+That method is called whenever the conversion appears in an output or input,
+respectively.
+You only need to implement the flavour of print and/or scan suitable for
+the datatype returned by <code>parse()</code>.
+Both <code>unsigned_format</code> and <code>signed_format</code> will use
+the <code>Long</code> flavour.
+</p>
+</p>
+The possible interface methods are:
+</p>
+<div class="indent"><code>
+bool printLong(const&nbsp;StreamFormat&&nbsp;fmt,
+        StreamBuffer& output, long value);
+</code></div>
+<div class="indent"><code>
+bool printDouble(const&nbsp;StreamFormat&&nbsp;fmt,
+        StreamBuffer& output, double value);
+</code></div>
+<div class="indent"><code>
+bool printString(const&nbsp;StreamFormat&&nbsp;fmt,
+        StreamBuffer& output, const&nbsp;char* value);
+</code></div>
+<div class="indent"><code>
+bool printPseudo(const&nbsp;StreamFormat&&nbsp;fmt,
+        StreamBuffer& output);
+</code></div>
+<div class="indent"><code>
+ssize_t scanLong(const&nbsp;StreamFormat&&nbsp;fmt,
+        const&nbsp;char* input, long& value);
+</code></div>
+<div class="indent"><code>
+ssize_t scanDouble(const&nbsp;StreamFormat&&nbsp;fmt,
+        const&nbsp;char* input, double& value);
+</code></div>
+<div class="indent"><code>
+ssize_t scanString(const&nbsp;StreamFormat&&nbsp;fmt,
+        const&nbsp;char* input, char* value, size_t& size);
+</code></div>
+<div class="indent"><code>
+ssize_t scanPseudo(const&nbsp;StreamFormat&&nbsp;fmt,
+        StreamBuffer& inputLine, size_t& cursor);
+</code></div>
+
+<p>
+Now, <code>fmt.type</code> contains the value returned by <code>parse()</code>.
+With <code>fmt.info()</code> get access to the string you have written to
+<code>info</code> in <code>parse()</code> (null terminated).
+</p>
+<p>
+The length of the info string can be found in <code>fmt.infolen</code>.
+</p>
+<p>
+In <code>print*()</code>, append the converted value to <code>output</code>.
+Do not modify what is already in output (unless you really know what you're
+doing, e.g. some <code>printPseudo</code> methods).
+Return <code>true</code> on success, <code>false</code> on failure.
+</p>
+<p>
+In <code>scan*()</code>, read the value from input and return the number of
+consumed bytes or -1 on failure.
+If the <code>skip_flag</code> is set, you don't need to write to
+<code>value</code>, since the value will be discarded anyway. 
+In <code>scanString()</code>, don't write more bytes than
+<code>maxlen</code> to <code>value</code> and set <code>size</code> to the
+actual string length, which may be different to the number of bytes consumed
+(e.g. if leading spaces are skipped).
+In <code>scanPseudo()</code>, <code>cursor</code> is the index of the first
+byte in <code>inputLine</code> to consider, which may be larger than
+<code>0</code>.
+</p>
+
+<footer>
+Dirk Zimoch, 2018
+</footer>
+</body>
+</html>

docs/formats.html

@@ -0,0 +1,782 @@
+<!DOCTYPE HTML>
+<html lang="en">
+<head>
+<title>StreamDevice: Format Converters</title>
+<meta charset="utf-8" />
+<link rel="shortcut icon" href="favicon.ico" />
+<link rel="stylesheet" type="text/css" href="stream.css" />
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<meta name="author" content="Dirk Zimoch" />
+</head>
+<body>
+<iframe src="nav.html" id="navleft"></iframe>
+<h1>Format Converters</h1>
+
+<a name="syntax"></a>
+<h2>1. Format Syntax</h2>
+<p>
+<em>StreamDevice</em> format converters work very similar to the format
+converters of the C functions <em>printf()</em> and <em>scanf()</em>.
+But <em>StreamDevice</em> provides more different converters and you can
+also write your own converters.
+Formats are specified in <a href="protocol.html#str">quoted strings</a>
+as arguments of <code>out</code> or <code>in</code>
+<a href="protocol.html#cmd">commands</a>.
+</p>
+<p>
+A format converter consists of
+</p>
+<ul>
+ <li>The <code>%</code> character</li>
+ <li>Optionally a field or record name in <code>()</code></li>
+ <li>Optionally flags out of the characters <code>*# +0-?=!</code></li>
+ <li>Optionally an integer <em>width</em> field</li>
+ <li>Optionally a period character (<code>.</code>) followed
+     by an integer <em>precision</em> field (input ony for most formats)</li>
+ <li>A conversion character</li>
+ <li>Additional information required by some converters</li>
+</ul>
+
+<p>
+The flags <code>*# +0-</code> work like in the C functions
+<em>printf()</em> and <em>scanf()</em>.
+The flags <code>?</code>, <code>=</code> and <code>!</code> are extensions.
+</p>
+<p>
+The <code>*</code> flag skips data in input formats.
+Input is consumed and parsed, a mismatch is an error, but the read
+data is dropped.
+This is useful if input contains more than one value.
+Example: <code>in "%*f%f";</code> reads the second floating point
+number.
+</p>
+<p>
+The <code>#</code> flag may alter the format, depending on the
+converter (see below).
+</p>
+<p>
+The '<code> </code>' (space) and <code>+</code> flags usually print a
+space or a <code>+</code> sign before positive numbers, where negative
+numbers would have a <code>-</code>.
+Some converters may redefine the meaning of these flags (see below).
+</p>
+<p>
+The <code>0</code> flag usually says that numbers should be left padded
+with <code>0</code> if <em>width</em> is larger than required.
+Some converters may redefine the meaning of this flag (see below).
+<p>
+The <code>-</code> flag usually specifies that output is left justified
+if <em>width</em> is larger than required.
+Some converters may redefine the meaning of this flag (see below).
+</p>
+<p>
+The <code>?</code> flag makes failing input conversions succeed with
+a default zero value (0, 0.0, or "", depending on the format type).
+</p>
+<p>
+The <code>=</code> flag allows to compare input with current values.
+It is only allowed in input formats.
+Instead of reading a new value from input, the current value is
+formatted (like for output) and then compared to the input.
+</p>
+<p>
+The <code>!</code> flag demands that input is exactly <em>width</em>
+bytes long (normally <em>width</em> defines the maximum number of
+bytes read in many formats).
+For example <code>in "%!5d";</code> expects exactly 5 digits.
+Fewer digits are considered loss of data and make the format fail.
+This feature has been added by Klemen Vodopivec, SNS.
+</p>
+
+<h3>Examples:</h3>
+<table>
+ <tr>
+  <td><code>in "%f";</code></td>
+  <td>Read a float value</td>
+ </tr>
+ <tr>
+  <td><code>out "%(HOPR)7.4f";</code></td>
+  <td>Write the HOPR field as 7 char float with precision 4</td>
+ </tr>
+ <tr>
+  <td><code>out "%#010x";</code></td>
+  <td>Write a 0-padded 10 char hex integer using the alternative format (with leading 0x)</td>
+ </tr>
+ <tr>
+  <td><code>in "%[_a-zA-Z0-9]";</code></td>
+  <td>Read a string of alphanumerical chars or underscores</td>
+ </tr>
+ <tr>
+  <td><code>in "%*i";</code></td>
+  <td>Skip over an integer number</td>
+ </tr>
+ <tr>
+  <td><code>in "%?d";</code></td>
+  <td>Read a decimal number or if that fails pretend that value was 0</td>
+ </tr>
+ <tr>
+  <td><code>in "%=.3f";</code></td>
+  <td>Assure that the input is equal to the current value formatted as a float with precision 3</td>
+ </tr>
+</table>
+
+<a name="types"></a>
+<h2>2. Data Types and Record Fields</h2>
+<h3>Default fields</h3>
+<p>
+Every conversion character corresponds to one of the data types DOUBLE,
+LONG, ULONG, ENUM, or STRING.
+In contrast to to the C functions <em>printf()</em> and <em>scanf()</em>,
+it is not required to specify a variable for the conversion.
+The variable is typically the <code>VAL</code> or <code>RVAL</code> field
+of the record, selected automatically depending on the data type.
+Not all data types make sense for all record types.
+Refer to the description of <a href="recordtypes.html">supported record
+types</a> for details.
+</p>
+<p>
+<em>StreamDevice</em> makes no difference between <code>float</code>
+and <code>double</code> nor between <code>short</code>, <code>int</code>
+and <code>long</code> values.
+Thus, data type modifiers like <code>l</code> or <code>h</code> do not
+exist in <em>StreamDevice</em> formats.
+</p>
+
+<a name="redirection"></a>
+<h3>I/O Redirection to other records or fields</h3>
+<p>
+To use formats with other than the default fields of a record or even with
+fields of other records on the same IOC, use the syntax
+<code>%(<var>record</var>.<var>FIEL</var>D)</code>.
+If only a field name but no record is given, the active record is assumed.
+If only a record name but no field name is given, the <code>VAL</code>
+field is assumed.
+</p>
+<p>
+<b>Example 1:</b> <code>out&nbsp;"%(EGU)s";</code> outputs the
+<code>EGU</code> field of the active record.
+</p>
+<p>
+<b>Example 2:</b> <code>in&nbsp;"%(<var>otherrecord</var>.RVAL)i";</code>
+stores the received integer value in the <code>RVAL</code> field of the
+other record and then processes that record.
+The other record should probably use <code>DTYP="Raw Soft Channel"</code>
+in order to convert <code>RVAL</code> to <code>VAL</code>.
+</p>
+<p>
+<b>Example 3:</b> <code>in&nbsp;"%(<var>otherrecord</var>)f";</code>
+stores the received floating point value in the <code>VAL</code> field
+of the other record and then processes that record. 
+The other record should probably use <code>DTYP="Soft Channel"</code>.
+In the unlikely case that the name of the other record is the same as a field
+of the active record (e.g. if you name a record "DESC"), then use <code>.VAL</code>
+explicitly to refer to the record rather than the field of the active record.
+</p>
+<p>
+This feature is quite useful in the case that one line of input contains more
+than one value that need to be stored in multiple records or if one line of
+output needs to be contructed from values of multiple records.
+In order to avoid using full record names in the protocol file, it is recommended
+to pass the name or part of the name (e.g. the device prefix) of the other
+record as a <a href="protocol.html#argvar">protocol argument</a>.
+In that case the redirection usually looks like this:
+<code>in "%(\$1<var>recordpart</var>)f"</code> and the record calls the protocol
+like this:
+<code>field(INP, "@<var>protocolfile</var> <var>protocol</var>($(PREFIX)) $(PORT)")</code>
+using a macro for the prefix part which is then used for <code>\$1</code>.
+</p>
+<p>
+If the other record is passive and the field has the PP
+attribute (see
+<a href="http://www.aps.anl.gov/asd/controls/epics/EpicsDocumentation/AppDevManuals/RecordRef/Recordref-1.html"
+target="ex">Record Reference Manual</a>), the record will be processed.
+It is your responsibility that the data type of the record field is
+compatible to the the data type of the converter.
+STRING formats are compatible with arrays of CHAR or UCHAR.
+</p>
+<p>
+Be aware that using this syntax is by far not as efficient as using the
+default field.
+At the moment it is not possible to set the other record to an alarm
+state if anything fails. It will simply not be processed if the fault
+happens before or while handling it and it will already have been
+processed if the fault happens later.
+</p>
+
+<h3>Pseudo-converters</h3>
+<p>
+Some formats are not actually converters.
+They format data which is not stored in a record field, such as a
+<a href="#chksum">checksum</a> or
+<a href="#regsub">regular expression substitution</a>.
+No data type corresponds to those <em>pseudo-converters</em> and the
+<code>%(<em>FIELD</em>)</code> syntax cannot be used.
+</p>
+
+<a name="stdd"></a>
+<h2>3. Standard DOUBLE Converters (<code>%f</code>, <code>%e</code>,
+<code>%E</code>, <code>%g</code>, <code>%G</code>)</h2>
+<p>
+<b>Output:</b> <code>%f</code> prints fixed point, <code>%e</code> prints
+exponential notation and <code>%g</code> prints either fixed point or
+exponential depending on the magnitude of the value.
+<code>%E</code> and <code>%G</code> use <code>E</code> instead of
+<code>e</code> to separate the exponent.
+</p>
+<p>
+With the <code>#</code> flag, output always contains a period character.
+</p>
+<p>
+<b>Input:</b> All these formats are equivalent. Leading whitespaces are skipped.
+</p>
+<p>
+With the <code>#</code> flag additional whitespace between sign and number
+is accepted.
+</p>
+<p>
+When a maximum field width is given, leading whitespace only counts to the
+field witdth when the space flag is used.
+</p>
+
+<a name="stdl"></a>
+<h2>4. Standard LONG and ULONG Converters (<code>%d</code>, <code>%i</code>,
+<code>%u</code>, <code>%o</code>, <code>%x</code>, <code>%X</code>)</h2>
+<p>
+<b>Output</b>: <code>%d</code> and <code>%i</code> print signed decimal,
+<code>%u</code> unsigned decimal, <code>%o</code> unsigned octal, and
+<code>%x</code> or <code>%X</code> unsigned hexadecimal.
+<code>%X</code> uses upper case letters.
+</p>
+<p>
+With the <code>#</code> flag, octal values are prefixed with <code>0</code>
+and hexadecimal values with <code>0x</code> or <code>0X</code>.
+<p>
+Unlike printf, <code>%x</code> and <code>%X</code> truncate the
+output to the the given width (number of least significant half bytes).
+</p>
+</p>
+<p>
+<b>Input:</b> <code>%d</code> matches signed decimal, <code>%u</code> matches
+unsigned decimal, <code>%o</code> unsigned octal.
+<code>%x</code> and <code>%X</code> both match upper or lower case unsigned
+hexadecimal.
+Octal and hexadecimal values can optionally be prefixed.
+<code>%i</code> matches any integer in decimal, or prefixed octal or
+hexadecimal notation.
+Leading whitespaces are skipped.
+</p>
+<p>
+With the <code>-</code> negative octal and hexadecimal values are accepted. 
+</p>
+<p>
+With the <code>#</code> flag additional whitespace between sign and number
+is accepted.
+</p>
+<p>
+When a maximum field width is given, leading whitespace only counts to the
+field witdth when the space flag is used.
+</p>
+
+<a name="stds"></a>
+<h2>5. Standard STRING Converters (<code>%s</code>, <code>%c</code>)</h2>
+<p>
+<b>Output:</b> <code>%s</code> prints a string.
+If <em>precision</em> is specified, this is the maximum string length.
+<code>%c</code> is a LONG format in output, printing one character!
+</p>
+<p>
+<b>Input:</b> <code>%s</code> matches a sequence of non-whitespace characters
+and <code>%c</code> matches a sequence of not-null characters.
+The maximum string length is given by <em>width</em>.
+The default <em>width</em> is infinite for <code>%s</code> and
+1 for <code>%c</code>.
+Leading whitespaces are skipped with <code>%s</code> except when
+the space flag is used but not with <code>%c</code>.
+The empty string matches.
+</p>
+<p>
+With the <code>#</code> flag <code>%s</code> matches a sequence of not-null
+characters instead of non-whitespace characters.
+</p>
+<p>
+With the <code>0</code> flag <code>%s</code> pads with 0 bytes instead of
+spaces.
+</p>
+
+
+<a name="cset"></a>
+<h2>6. Standard Charset STRING Converter (<code>%[<em>charset</em>]</code>)</h2>
+<p>
+This is an input-only format.
+It matches a sequence of characters from <em>charset</em>.
+If <em>charset</em> starts with <code>^</code>, the format matches
+all characters <u>not</u> in <em>charset</em>.
+Leading whitespaces are not skipped.
+</p>
+<p>
+Example: <code>%[_a-z]</code> matches a string consisting
+entirely of <code>_</code> (underscore) or letters from <code>a</code>
+to <code>z</code>.
+</p>
+
+<a name="enum"></a>
+<h2>7. ENUM Converter (<code>%{<em>string0</em>|<em>string1</em>|...}</code>)</h2>
+<p>
+This format maps an unsigned integer value on a set of strings.
+The value 0 corresponds to <em>string0</em> and so on.
+The strings are separated by <code>|</code>.
+</p>
+<p>
+Example: <code>%{OFF|STANDBY|ON}</code> mapps the string <code>OFF</code>
+to the value 0, <code>STANDBY</code> to 1 and <code>ON</code> to 2.
+</p>
+<p>
+When using the <code>#</code> flag it is allowed to assign integer values
+to the strings using <code>=</code>.
+Unassigned strings increment their values by 1 as usual.
+</p>
+<p>
+If one string is the initial substing of another, the substing must come
+later to ensure correct matching.
+In particular if one string is the emptry string, it must be the last one
+because it always matches.
+Use <code>#</code> and <code>=</code> to renumber if necessary.
+</p>
+<p>
+Use the assignment <code>=?</code> for the last string to make it the
+default value for output formats.
+</p>
+<p>
+Example: <code>%#{neg=-1|stop|pos|fast=10|rewind=-10}</code>.
+</p>
+<p>
+If one of the strings contains <code>|</code> or <code>}</code>
+(or <code>=</code>  if the <code>#</code> flag is used)
+a <code>\</code> must be used to escape the character.
+</p>
+<p>
+<b>Output:</b> Depending on the value, one of the strings is printed,
+or the default if given and no value matches.
+</p>
+<p>
+<b>Input:</b> If any of the strings matches, the value is set accordingly.
+</p>
+
+<a name="bin"></a>
+<h2>8. Binary LONG or ULONG Converter (<code>%b</code>, <code>%B<em>zo</em></code>)</h2>
+<p>
+This format prints or scans an unsigned integer represented as a binary
+string (one character per bit).
+The <code>%b</code> format uses the characters <code>0</code> and
+<code>1</code>.
+With the <code>%B</code> format, you can choose two other characters
+to represent zero and one.
+With the <code>#</code> flag, the bit order is changed to <em>little
+endian</em>, i.e. least significant bit first.
+</p>
+<p>
+Examples: <code>%B.!</code> or <code>%B\x00\xff</code>.
+<code>%B01</code> is equivalent to <code>%b</code>.
+</p>
+<p>
+In output, if <em>width</em> is larger than the number of significant bits,
+then the flag <code>0</code> means that the value should be padded with
+with the chosen zero character instead of spaces.
+If <em>precision</em> is set, it means the number of significant bits.
+Otherwise, the highest 1 bit defines the number of significant bits. 
+</p>
+<p>
+In input, leading spaces are skipped.
+A maximum of <em>width</em> characters is read.
+Conversion stops with the first character that is not the zero or the
+one character.
+</p>
+
+<a name="raw"></a>
+<h2>9. Raw LONG or ULONG Converter (<code>%r</code>)</h2>
+<p>
+The raw converter does not really "convert".
+A signed or unsigned integer value is written or read in the internal
+(usually two's complement) representation of the computer.
+The normal byte order is <em>big endian</em>, i.e. most significant byte
+first.
+With the <code>#</code> flag, the byte order is changed to <em>little
+endian</em>, i.e. least significant byte first.
+With the <code>0</code> flag, the value is unsigned, otherwise signed.
+</p>
+<p>
+In output, the <em>precision</em> (or sizeof(long) whatever is less) least
+significant bytes of the value are sign extended or zero extended
+(depending on the <code>0</code> flag) to <em>width</em> bytes.
+The default for <em>precision</em> is 1. Thus if you do not specify
+the <em>precision</em>, only the least significant byte is written!
+It is common error to write <code>out "%2r";</code> instead of <code>out "%.2r";</code>.
+</p>
+<p>
+In input, <em>width</em> bytes are read and put into the value.
+If <em>width</em> is larger than the size of a <code>long</code>, only
+the least significant bytes are used.
+If <em>width</em> is smaller than the size of a <code>long</code>,
+the value is sign extended or zero extended, depending on the
+<code>0</code> flag.
+</p>
+<p>
+Examples: <code>out "%.2r"; in "%02r";</code>
+</p>
+
+<a name="rawdouble"></a>
+<h2>10. Raw DOUBLE Converter (<code>%R</code>)</h2>
+<p>
+The raw converter does not really "convert".
+A float or double value is written or read in the internal
+(maybe IEEE) representation of the computer.
+The normal byte order is <em>big endian</em>, i.e. most significant byte
+first.
+With the <code>#</code> flag, the byte order is changed to <em>little
+endian</em>, i.e. least significant byte first.
+The <em>width</em> must be 4 (float) or 8 (double). The default is 4.
+</p>
+
+<a name="bcd"></a>
+<h2>11. Packed BCD (Binary Coded Decimal) LONG or ULONG Converter (<code>%D</code>)</h2>
+<p>
+Packed BCD is a format where each byte contains two binary coded
+decimal digits (<code>0</code> ... <code>9</code>).
+Thus a BCD byte is in the range from <code>0x00</code> to <code>0x99</code>.
+The normal byte order is <em>big endian</em>, i.e. most significant byte
+first.
+With the <code>#</code> flag, the byte order is changed to <em>little
+endian</em>, i.e. least significant byte first.
+The <code>+</code> flag defines that the value is signed, using the
+upper half of the most significant byte for the sign.
+Otherwise the value is unsigned.
+</p>
+<p>
+In output, <em>precision</em> decimal digits are printed in at least
+<em>width</em> output bytes.
+Signed negative values have <code>0xF</code> in their most significant half
+byte followed by the absolute value.
+</p>
+<p>
+In input, <em>width</em> bytes are read.
+If the value is signed, a one in the most significant bit is interpreted as
+a negative sign.
+Input stops with the first byte (after the sign) that does not represent a
+BCD value, i.e. where either the upper or the lower half byte is larger
+than 9.
+</p>
+
+<a name="chksum"></a>
+<h2>12. Checksum Pseudo-Converter (<code>%&lt;<em>checksum</em>&gt;</code>)</h2>
+<p>
+This is not a normal "converter", because no user data is converted.
+Instead, a checksum is calculated from the input or output.
+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
+command.
+The last byte is <em>precision</em> bytes before the checksum (default 0).
+For example in <code>"abcdefg%&lt;xor&gt;"</code> the checksum is calculated
+from <code>abcdefg</code>,
+but in <code>"abcdefg%2.1&lt;xor&gt;"</code> only from <code>cdef</code>.
+</p>
+<p>
+Normally, multi-byte checksums are in <em>big endian</em> byteorder,
+i.e. most significant byte first.
+With the <code>#</code> flag, the byte order is changed to <em>little
+endian</em>, i.e. least significant byte first.
+</p>
+<p>
+The <code>0</code> flag changes the checksum representation to
+hexadecimal ASCII (2 chars per checksum byte).
+</p>
+<p>
+The <code>-</code> flag changes the checksum representation to
+"poor man's hex": 0x30 ... 0x3f (2 chars per checksum byte).
+</p>
+<p>
+The <code>+</code> flag changes the checksum representation to
+decimal ASCII (formatted with %d).
+</p>
+<!--
+In output, the case of the ASCII checksum matches the case of first
+letter of the function name.
+E.g. <code>out&nbsp;"123456789%&lt;sum&gt;"</code> writes <code>dd</code>
+but <code>out&nbsp;"123456789%&lt;Sum&gt;"</code> writes <code>DD</code>.
+In input, case is ignored.
+-->
+</p>
+<p>
+In output, the checksum is appended.
+</p>
+<p>
+In input, the next byte or bytes must match the checksum.
+</p>
+
+<h3>Implemented checksum functions</h3>
+<dl>
+ <dt><code>%&lt;sum&gt;</code> or <code>%&lt;sum8&gt;</code></dt>
+  <dd>One byte. The sum of all characters modulo 2<sup>8</sup>.</dd>
+ <dt><code>%&lt;sum16&gt;</code></dt>
+  <dd>Two bytes. The sum of all characters modulo 2<sup>16</sup>.</dd>
+ <dt><code>%&lt;sum32&gt;</code></dt>
+  <dd>Four bytes. The sum of all characters modulo 2<sup>32</sup>.</dd>
+ <dt><code>%&lt;negsum&gt;</code>, <code>%&lt;nsum&gt;</code>, <code>%&lt;-sum&gt;</code>, <code>%&lt;negsum8&gt;</code>, <code>%&lt;nsum8&gt;</code>, or <code>%&lt;-sum8&gt;</code></dt>
+  <dd>One byte. The negative of the sum of all characters modulo 2<sup>8</sup>.</dd>
+ <dt><code>%&lt;negsum16&gt;</code>, <code>%&lt;nsum16&gt;</code>, or <code>%&lt;-sum16&gt;</code></dt>
+  <dd>Two bytes. The negative of the sum of all characters modulo 2<sup>16</sup>.</dd>
+ <dt><code>%&lt;negsum32&gt;</code>, <code>%&lt;nsum32&gt;</code>, or <code>%&lt;-sum32&gt;</code></dt>
+  <dd>Four bytes. The negative of the sum of all characters modulo 2<sup>32</sup>.</dd>
+ <dt><code>%&lt;notsum&gt;</code> or <code>%&lt;~sum&gt;</code></dt>
+  <dd>One byte. The bitwise inverse of the sum of all characters modulo 2<sup>8</sup>.</dd>
+ <dt><code>%&lt;xor&gt;</code></dt>
+  <dd>One byte. All characters xor'ed.</dd>
+ <dt><code>%&lt;xor7&gt;</code></dt>
+  <dd>One byte. All characters xor'ed &amp; 0x7F.</dd>
+ <dt><code>%&lt;crc8&gt;</code></dt>
+  <dd>One byte. An often used 8 bit crc checksum
+  (poly=0x07, init=0x00, xorout=0x00).</dd>
+ <dt><code>%&lt;ccitt8&gt;</code></dt>
+  <dd>One byte. The CCITT standard 8 bit crc checksum
+  (poly=0x31, init=0x00, xorout=0x00, reflected).</dd>
+ <dt><code>%&lt;crc16&gt;</code></dt>
+  <dd>Two bytes. An often used 16 bit crc checksum
+  (poly=0x8005, init=0x0000, xorout=0x0000).</dd>
+ <dt><code>%&lt;crc16r&gt;</code></dt>
+  <dd>Two bytes. An often used reflected 16 bit crc checksum
+  (poly=0x8005, init=0x0000, xorout=0x0000, reflected).</dd>
+ <dt><code>%&lt;modbus&gt;</code></dt>
+  <dd>Two bytes. The modbus 16 bit crc checksum
+  (poly=0x8005, init=0xffff, xorout=0x0000, reflected)</dd>
+ <dt><code>%&lt;ccitt16&gt;</code></dt>
+  <dd>Two bytes. The usual (but <a target="ex"
+   href="http://srecord.sourceforge.net/crc16-ccitt.html">wrong?</a>)
+   implementation of the CCITT standard 16 bit crc checksum
+   (poly=0x1021, init=0xFFFF, xorout=0x0000).</dd>
+ <dt><code>%&lt;ccitt16a&gt;</code></dt>
+  <dd>Two bytes. The unusual (but <a target="ex"
+   href="http://srecord.sourceforge.net/crc16-ccitt.html">correct?</a>)
+   implementation of the CCITT standard 16 bit crc checksum with augment.
+   (poly=0x1021, init=0x1D0F, xorout=0x0000).</dd>
+ <dt><code>%&lt;ccitt16x&gt;</code> or <code>%&lt;crc16c&gt;</code> or <code>%&lt;xmodem&gt;</code></dt>
+  <dd>Two bytes. The XMODEM checksum.
+   (poly=0x1021, init=0x0000, xorout=0x0000).</dd>
+ <dt><code>%&lt;crc32&gt;</code></dt>
+  <dd>Four bytes. The standard 32 bit crc checksum.
+   (poly=0x04C11DB7, init=0xFFFFFFFF, xorout=0xFFFFFFFF).</dd>
+ <dt><code>%&lt;crc32r&gt;</code></dt>
+  <dd>Four bytes. The standard reflected 32 bit crc checksum.
+   (poly=0x04C11DB7, init=0xFFFFFFFF, xorout=0xFFFFFFFF, reflected).</dd>
+ <dt><code>%&lt;jamcrc&gt;</code></dt>
+  <dd>Four bytes. Another reflected 32 bit crc checksum.
+   (poly=0x04C11DB7, init=0xFFFFFFFF, xorout=0x00000000, reflected).</dd>
+ <dt><code>%&lt;adler32&gt;</code></dt>
+  <dd>Four bytes. The Adler32 checksum according to <a target="ex"
+   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>
+</dl>
+
+<a name="regex"></a>
+<h2>13. Regular Expresion STRING Converter (<code>%/<em>regex</em>/</code>)</h2>
+<p>
+This input-only format matches <a target="ex"
+href="http://www.pcre.org/" >Perl compatible regular expressions (PCRE)</a>.
+It is only available if a PCRE library is installed.
+</p>
+<div class="box">
+<p>
+If PCRE is not available for your host or cross architecture, download
+the sourcecode from <a target="ex" href="http://www.pcre.org/">www.pcre.org</a>
+and try my EPICS compatible <a target="ex"
+href="http://epics.web.psi.ch/software/streamdevice/pcre/Makefile">Makefile</a>
+to compile it like a normal EPICS support module.
+The Makefile is known to work with EPICS 3.14.8 and PCRE 7.2.
+In your RELEASE file define the variable <code>PCRE</code> so that
+it points to the install location of PCRE.
+</p>
+<p>
+If PCRE is already installed on (some of) your systems, you may add
+architectures where PCRE can be found in standard include and library
+locations to the variable <code>WITH_SYSTEM_PCRE</code>.
+If either the header file or the library are in a non-standard place,
+set in your RELEASE file the variables <code>PCRE_INCLUDE_<em>arch</em></code>
+and/or <code>PCRE_LIB_<em>arch</em></code> for the respective architectures
+to the correct directories or set
+<code>PCRE_INCLUDE</code> and/or <code>PCRE_LIB</code>
+in architecture specific RELEASE.Common.<em>arch</em> files.
+</p>
+</div>
+<p>
+If the regular expression is not anchored, i.e. does not start with
+<code>^</code>, leading non-matching input is skipped.
+To match in multiline mode (across newlines) add <code>(?m)</code>
+at the beginning of the pattern.
+To match case insensitive, add <code>(?i)</code>.
+</p>
+<p>
+A maximum of <em>width</em> bytes is matched, if specified.
+If <em>precision</em> is given, it specifies the sub-expression in <code>()</code>
+whose match is returned.
+Otherwise the complete match is returned.
+In any case, the complete match is consumed from the input buffer.
+If the expression contains a <code>/</code> it must be escaped like <code>\/</code>.
+</p>
+<p>
+Example: <code>%.1/&lt;title&gt;(.*)&lt;\/title&gt;/</code> returns
+the title of an HTML page, skipps anything before the
+<code>&lt;title&gt</code> tag and leaves anything after the
+<code>&lt;/title&gt;</code> tag in the input buffer.
+</p>
+<a name="regsub"></a>
+<h2>14. Regular Expresion Substitution Pseudo-Converter (<code>%#/<em>regex</em>/<em>subst</em>/</code>)</h2>
+<p>
+This is a variant of the previous converter (note the <code>#</code>)
+but instead of returning the matching string,
+it can be used as a pre-processor for input or
+as a post-processor for output.
+</p>
+<p>
+Matches of the <em>regex</em> are replaced by the string <em>subst</em> with all
+<code>&</code> in <em>subst</em> replaced with the match itself and all
+<code>\1</code> through <code>\9</code> replaced with the match of the corresponding
+sub-expression <span class="new"> if such a sub-expression exists.
+
+Due to limitations of the parser, <code>\1</code> and <code>\x01</code> are the same 
+which makes it difficult to use literal bytes with values lower than 10 in <em>subst</em>.
+Therefore <code>\0</code> aways means a literal byte (incompatible change from earlier version!)
+and <code>\1</code> through <code>\9</code> mean literal bytes if they are larger than
+the number of sub-expressions.
+</span>
+
+To get a literal <code>&</code> or <code>\</code> or <code>/</code> in the substitution write
+<code>\&</code> or <code>\\</code> or <code>\/</code>.
+</p>
+<p>
+If <em>width</em> is specified, it limits the number of characters processed.
+If the <code>-</code> flag is used (i.e. <em>width</em> looks like a negative number)
+only the last <em>width</em> characters are processed, else the first.
+Without <em>width</em> (or 0) all available characters are processed.
+</p>
+<p>
+If <em>precision</em> is specified, it indicates which matches to replace.
+With the <code>+</code> flag given, <em>precision</em> is the maximum
+number of matches to replace.
+Otherwise <em>precision</em> is the index (counting from 1) of the match to replace. 
+Without <em>precision</em> (or 0), all matches are replaced.
+</p>
+<p>
+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.
+</p>
+<p>
+In output it post-processes data already formatted by preceding converters
+before sending it to the device.
+Converters following this one will send their output unmodified.
+Thus place this converter after those whose output should be post-processed.
+</p>
+<p>
+Examples:
+<div class="indent">
+<code>%#+-10.2/ab/X/</code> replaces the string <code>ab</code> with <code>X</code>
+maximal 2 times in the last 10 characters.
+(<code>abcabcabcabc</code> becomes <code>abcXcXcabc</code>)
+</div>
+<div class="indent">
+<code>%#/\\/\//</code> replaces all <code>\</code> with <code>/</code>
+(<code>\dir\file</code> becomes <code>/dir/file</code>)
+</div>
+<div class="indent">
+<code>%#/..\B/&:/</code> inserts <code>:</code> after every second character
+which is not at the end of a word.
+(<code>0b19353134</code> becomes <code>0b:19:35:31:34</code>)
+</div>
+<div class="indent">
+<code>%#/://</code> removes all <code>:</code> characters.
+(<code>0b:19:35:31:34</code> becomes <code>0b19353134</code>)
+</div>
+<div class="indent">
+<code>%#/([^+-])*([+-])/\2\1/</code> moves a postfix sign to the front.
+(<code>1.23-</code> becomes <code>-1.23</code>)<br>
+</div>
+<a name="mantexp"></a>
+<h2>15. MantissaExponent DOUBLE converter (<code>%m</code>)</h2>
+<p>
+This exotic and experimental format matches numbers in the format
+<i>[sign] mantissa sign exponent</i>, e.g <code>+123-4</code> meaning
+123e-4 or 0.0123. Mantissa and exponent are decimal integers.
+The sign of the mantissa is optional.
+Compared to the standard <code>%e</code> format, this format does not
+contain the characters <code>.</code> and <code>e</code>.
+</p>
+<p>
+Output formatting is ambigous (e.g. <code>123-4</code> versus
+<code>1230-5</code>). I chose the following convention:
+Format <em>precision</em> defines number of digits in mantissa.
+No leading '0' in mantissa (except for 0.0 of course).
+Number of digits in exponent is at least 2.
+Format flags <code>+</code>, <code>-</code>, and space are supported in
+the usual way (always sign, left justified, space instead of + sign).
+Flags <code>#</code> and <code>0</code> are unsupported.
+</p>
+<a name="timestamp"></a>
+<h2>16. Timestamp DOUBLE converter (<code>%T(<em>timeformat</em>)</code>)</h2>
+<p>
+This format reads or writes timestamps and converts them to a double number.
+The value represents the number of seconds since 1970 (the UNIX epoch).
+The precision of a double is large enough for microseconds (but not for
+nanoseconds). This format is probably used best in combination with a
+redirection to the <code>TIME</code> field. In this case, the value is
+converted to EPICS timestamps (seconds since 1990 and nanoseconds).
+The timestamp format understands the usual converters that the C function
+<em>strftime()</em> understands. In addition, fractions of a second can
+be specified and the time zone can be set in the format string.
+</p>
+<p>
+Example: <code>%(TIME)T(%d %b %Y %H:%M:%.3S %z)</code> may print something like
+<code> 3 Sep 2010 15:45:59 +0200</code>.
+</p>
+<p>
+Fractions of a second can be specified as <code>%.<em>n</em>S</code>
+(seconds with <em>n</em> fractional digits), as <code>%0<em>n</em>f</code>
+or <code>%<em>n</em>f</code> (<em>n</em> fractional digits) or as
+<code>%N</code> (nanoseconds).
+In input, <em>n</em> is the maximum number of digits parsed, there may be
+actually less digits in the input.
+If <em>n</em> is not specified (<code>%.S</code> or <code>%f</code>) it uses
+a default value of 6.
+</p>
+<p>
+In input, the time zone can be specified in the format like
+<code>%+<em>hhmm</em></code> or <code>%-<em>hhmm</em></code> for cases
+where the parsed time stamp does not specify the time zone, where
+<em>hhmm</em> is a 4 digit number specifying the offset in hours and minutes.
+</p>
+<p>
+In output, the system function <em>strftime()</em> is used to format the time.
+There may be differences in the implementation between operating systems.
+</p>
+<p>
+In input, <em>StreamDevice</em> uses its own implementation because many
+systems are missing the <em>strptime()</em> function and additional formats
+are supported.
+</p>
+<p>
+Day of the week can be parsed but is ignored because the information is
+redundant when used together with day, month and year and more or less
+useless otherwise. No check is done for consistency.
+</p>
+<p>
+Because of the complexity of the problem, locales are not supported.
+Thus, only the English month names can be used (week day names are
+ignored anyway).
+</p>
+
+<footer>
+<a href="processing.html">Next: Record Processing</a>
+Dirk Zimoch, 2018
+</footer>
+</body>
+</html>

docs/index.html

@@ -0,0 +1,147 @@
+<!DOCTYPE HTML>
+<html lang="en">
+<head>
+<title>StreamDevice</title>
+<meta charset="utf-8" />
+<link rel="shortcut icon" href="favicon.ico" />
+<link rel="stylesheet" type="text/css" href="stream.css" />
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<meta name="author" content="Dirk Zimoch" />
+</head>
+<body>
+<iframe src="nav.html" id="navleft"></iframe>
+<h1>EPICS <em>StreamDevice</em></h1>
+
+<h2>What is <em>StreamDevice</em>?</h2>
+<p>
+<em>StreamDevice</em> is a generic
+<a href="https://epics.anl.gov/" target="ex">EPICS</a>
+device support for devices with a "byte stream" based
+communication interface.
+That means devices that can be controlled by sending and
+receiving strings (in the broadest sense, including non-printable
+characters and even null-bytes). 
+Examples for this type of communication interface are
+serial line (RS-232, RS-485, ...),
+IEEE-488 (also known as GPIB or HP-IB), and telnet-like TCP/IP.
+</p>
+<p>
+<em>StreamDevice</em> is not limited to a specific device type or
+manufacturer nor is it necessary to re-compile anything to support a
+new device type.
+Instead, it can be configured for any device type with
+<a href="protocol.html"><em>protocol files</em></a> in plain ASCII text
+which describes the commands a device understands and the replies it sends.
+If the device can be controlled with strings like
+"<kbd>RF:FREQ 499.655 MHZ</kbd>" <em>StreamDevice</em> can be used.
+Formatting and parsing of values is done with
+<a href="formats.html"><em>format converters</em></a> similar to those
+known from the C functions <em>printf()</em> and <em>scanf()</em>.
+To support other formats, it is possible to
+<a href="formatconverter.html">write your own converters</a>.
+</p>
+<p>
+Each record with <em>StreamDevice</em> support runs one protocol
+from the protocol file to read or write its value.
+Protocols can be as simple as just one output string or can
+consist of many strings sent to and read from the device.
+However, a protocol is linear.
+That means it runs from start to end each time the record is
+<a href="processing.html">processed</a>.
+It does not provide loops or branches.
+</p>
+<p>
+<em>StreamDevice</em> comes with an interface to<a target="ex"
+href="https://www.aps.anl.gov/epics/modules/soft/asyn/">
+<em>asynDriver</em></a>
+but can be extended to
+<a href="businterface.html">support other bus drivers</a>.
+Note that <em>StreamDevice</em> is not an alternative or replacement
+but a supplement for <em>asynDriver</em>.
+<em>StreamDevice</em> converts record values to and from strings but
+leaves it to <em>asynDriver</em> (or other bus interfaces) to exchange
+these strings with the device.
+Thus any bus type supported by <em>asynDriver</em> (to be exact by
+<em>asynOctet</em>) can automatically be used with <em>StreamDevice</em>.
+</p>
+<p>
+<em>StreamDevice</em> supports all
+<a href="recordtypes.html">standard records</a> of EPICS base
+which can have device support.
+It is also possible to
+<a href="recordinterface.html">write support for new record types</a>.
+</p>
+
+<h2>What is <em>StreamDevice</em> not?</h2>
+<p>
+It is not a programming language for a high-level application.
+It is, for example, not possible to write a complete scanning program
+in a protocol.
+Use other tools for that and use <em>StreamDevice</em> only for the
+primitive commands.
+</p>
+<p>
+It is not a block oriented device support.
+It is not intended for huge binary blocks of data that contain
+many process variables distributed over many records.
+Consider <a href="https://github.com/paulscherrerinstitute/regdev"
+target="ex"><em>regDev</em></a>
+for that.
+</p>
+<p>
+It is not a very flexible html, xml, json, etc. parser. Data needs to
+come in a predictible order to be parsable by <em>StreamDevice</em>.
+</p>
+
+<h2>Recommended Readings</h2>
+<p>
+IOC Application Developer's Guide:
+<a href="https://epics.anl.gov/base/R3-14/12-docs/AppDevGuide/"
+target="ex">R3.14.12</a>,
+<a href="https://epics.anl.gov/base/R3-15/5-docs/AppDevGuide/AppDevGuide.html"
+target="ex">R3.15.5</a>,
+<a href="https://epics.anl.gov/base/R3-16/1-docs/AppDevGuide/AppDevGuide.html"
+target="ex">R3.16.1</a>
+</p>
+<p>
+<a href="https://wiki-ext.aps.anl.gov/epics/index.php/RRM_3-14"
+target="ex">EPICS Record Reference Manual</a>
+</p>
+
+<h2>Color and Style Conventions</h2>
+<p>
+In this document, code is witten in <code>green fixed width font</code>.
+This marks text you typically type in configuration files etc.
+</p>
+<pre>
+Longer code segments are often set in a box.
+</pre>
+
+<h2>Changes in Version 2.8</h2>
+<ul>
+ <li>Support standard EPICS module build system.
+ <li>Compatible with EPICS base releases up to 7.0.1.
+   <ul>
+    <li>Support for new record types: int64in, int64out, lsi, lso.
+    <li>Support for INT64 and UINT64 in aai, aao, waveform.
+   </ul>
+ <li>Run @init more often (e.g. when device re-connects or paused IOC is resumed).
+ <li>Use "COMM" error code in .STAT when device is disconnected.
+ <li>Allow spaces in protocol parameter list.
+ <li>Errors are new silent by default (var streamError 0) except during init.
+ <li>Support output redirect of all shell functions.
+ <li>Fix building shared libraries on Windows.
+ <li>Fix some C++11 warnings.
+ <li>Fix several signed/unsigned problems.
+ <li>Dropped support for cygnus-2.7.2 gcc (used by some old cygwin).
+ <li>Several bug fixes.
+ <li>Several documentation updates.
+</ul>
+
+
+<footer>
+<a href="setup.html">Next: Setup</a>
+Dirk Zimoch, 2018
+</footer>
+</body>
+</html>

docs/int64in.html

@@ -0,0 +1,78 @@
+<!DOCTYPE HTML>
+<html lang="en">
+<head>
+<title>StreamDevice: int64in Records</title>
+<meta charset="utf-8" />
+<link rel="shortcut icon" href="favicon.ico" />
+<link rel="stylesheet" type="text/css" href="stream.css" />
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<meta name="author" content="Dirk Zimoch" />
+</head>
+<body>
+<iframe src="nav.html" id="navleft"></iframe>
+<h1>int64in Records</h1>
+
+<p>
+<b>Note:</b> The int64in (integer 64 bit input) record is only available from EPICS base R3.16 on.
+</p>
+
+<h2>Normal Operation</h2>
+<p>
+The variable <code><i>x</i></code> stands for the
+written or read value.
+</p>
+<dl>
+ <dt>DOUBLE format (e.g. <code>%f</code>):</dt>
+  <dd>
+   Not allowed.
+  </dd>
+ <dt>LONG format (e.g. <code>%i</code>):</dt>
+  <dd>
+   <u>Output:</u> <code><i>x</i>=VAL</code><br>
+   <u>Input:</u> <code>VAL=<i>x</i></code>
+  </dd>
+ <dt>ENUM format (e.g. <code>%{</code>):</dt>
+  <dd>
+   <u>Output:</u> <code><i>x</i>=VAL</code><br>
+   <u>Input:</u> <code>VAL=<i>x</i></code>
+  </dd>
+ <dt>STRING format (e.g. <code>%s</code>):</dt>
+  <dd>
+   Not allowed.
+  </dd>
+</dl>
+
+<h2>Initialization</h2>
+<p>
+ During <a href="processing.html#init">initialization</a>, the <code>@init</code> handler is executed, if
+ present. All format converters work like in normal operation.
+</p>
+
+<footer>
+<nav>
+<a href="aai.html">aai</a>
+<a href="aao.html">aao</a>
+<a href="ai.html">ai</a>
+<a href="ao.html">ao</a>
+<a href="bi.html">bi</a>
+<a href="bo.html">bo</a>
+<a href="calcout.html">calcout</a>
+<a href="int64in.html">int64in</a>
+<a href="int64out.html">int64out</a>
+<a href="longin.html">longin</a>
+<a href="longout.html">longout</a>
+<a href="lsi.html">lsi</a>
+<a href="lso.html">lso</a>
+<a href="mbbiDirect.html">mbbiDirect</a>
+<a href="mbboDirect.html">mbboDirect</a>
+<a href="mbbi.html">mbbi</a>
+<a href="mbbo.html">mbbo</a>
+<a href="scalcout.html">scalcout</a>
+<a href="stringin.html">stringin</a>
+<a href="stringout.html">stringout</a>
+<a href="waveform.html">waveform</a>
+</nav>
+Dirk Zimoch, 2018
+</footer>
+</body>
+</html>

docs/int64out.html

@@ -0,0 +1,78 @@
+<!DOCTYPE HTML>
+<html lang="en">
+<head>
+<title>StreamDevice: int64out Records</title>
+<meta charset="utf-8" />
+<link rel="shortcut icon" href="favicon.ico" />
+<link rel="stylesheet" type="text/css" href="stream.css" />
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<meta name="author" content="Dirk Zimoch" />
+</head>
+<body>
+<iframe src="nav.html" id="navleft"></iframe>
+<h1>int64out Records</h1>
+
+<p>
+<b>Note:</b> The int64out (integer 64 bit output) record is only available from EPICS base R3.16 on.
+</p>
+
+<h2>Normal Operation</h2>
+<p>
+The variable <code><i>x</i></code> stands for the
+written or read value.
+</p>
+<dl>
+ <dt>DOUBLE format (e.g. <code>%f</code>):</dt>
+  <dd>
+   Not allowed.
+  </dd>
+ <dt>LONG format (e.g. <code>%i</code>):</dt>
+  <dd>
+   <u>Output:</u> <code><i>x</i>=VAL</code><br>
+   <u>Input:</u> <code>VAL=<i>x</i></code>
+  </dd>
+ <dt>ENUM format (e.g. <code>%{</code>):</dt>
+  <dd>
+   <u>Output:</u> <code><i>x</i>=VAL</code><br>
+   <u>Input:</u> <code>VAL=<i>x</i></code>
+  </dd>
+ <dt>STRING format (e.g. <code>%s</code>):</dt>
+  <dd>
+   Not allowed.
+  </dd>
+</dl>
+
+<h2>Initialization</h2>
+<p>
+ During <a href="processing.html#init">initialization</a>, the <code>@init</code> handler is executed, if
+ present. All format converters work like in normal operation.
+</p>
+
+<footer>
+<nav>
+<a href="aai.html">aai</a>
+<a href="aao.html">aao</a>
+<a href="ai.html">ai</a>
+<a href="ao.html">ao</a>
+<a href="bi.html">bi</a>
+<a href="bo.html">bo</a>
+<a href="calcout.html">calcout</a>
+<a href="int64in.html">int64in</a>
+<a href="int64out.html">int64out</a>
+<a href="longin.html">longin</a>
+<a href="longout.html">longout</a>
+<a href="lsi.html">lsi</a>
+<a href="lso.html">lso</a>
+<a href="mbbiDirect.html">mbbiDirect</a>
+<a href="mbboDirect.html">mbboDirect</a>
+<a href="mbbi.html">mbbi</a>
+<a href="mbbo.html">mbbo</a>
+<a href="scalcout.html">scalcout</a>
+<a href="stringin.html">stringin</a>
+<a href="stringout.html">stringout</a>
+<a href="waveform.html">waveform</a>
+</nav>
+Dirk Zimoch, 2018
+</footer>
+</body>
+</html>

docs/longin.html

@@ -1,15 +1,16 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
-    "http://www.w3.org/TR/html4/loose.dtd">
-<html>
+<!DOCTYPE HTML>
+<html lang="en">
 <head>
 <title>StreamDevice: longin Records</title>
-<link rel="shortcut icon" href="sls_icon.ico">
-<link rel="stylesheet" type="text/css" href="stream.css">
-<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-<meta name="author" content="Dirk Zimoch">
+<meta charset="utf-8" />
+<link rel="shortcut icon" href="favicon.ico" />
+<link rel="stylesheet" type="text/css" href="stream.css" />
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<meta name="author" content="Dirk Zimoch" />
 </head>
 <body>
-<h1>StreamDevice: longin Records</h1>
+<iframe src="nav.html" id="navleft"></iframe>
+<h1>longin Records</h1>
 
 <h2>Normal Operation</h2>
 <p>
@@ -25,6 +26,8 @@ written or read value.
   <dd>
    <u>Output:</u> <code><i>x</i>=VAL</code><br>
    <u>Input:</u> <code>VAL=<i>x</i></code>
+   Using unsigned formats with values &ge; 0x800000 gives different results
+   on 64 bit machines.
   </dd>
  <dt>ENUM format (e.g. <code>%{</code>):</dt>
   <dd>
@@ -43,26 +46,31 @@ written or read value.
  present. All format converters work like in normal operation.
 </p>
 
-<hr>
-<p>
+<footer>
+<nav>
 <a href="aai.html">aai</a>
 <a href="aao.html">aao</a>
 <a href="ai.html">ai</a>
 <a href="ao.html">ao</a>
 <a href="bi.html">bi</a>
 <a href="bo.html">bo</a>
-<a href="mbbi.html">mbbi</a>
-<a href="mbbo.html">mbbo</a>
+<a href="calcout.html">calcout</a>
+<a href="int64in.html">int64in</a>
+<a href="int64out.html">int64out</a>
+<a href="longin.html">longin</a>
+<a href="longout.html">longout</a>
+<a href="lsi.html">lsi</a>
+<a href="lso.html">lso</a>
 <a href="mbbiDirect.html">mbbiDirect</a>
 <a href="mbboDirect.html">mbboDirect</a>
-<a href="longout.html">longout</a>
+<a href="mbbi.html">mbbi</a>
+<a href="mbbo.html">mbbo</a>
+<a href="scalcout.html">scalcout</a>
 <a href="stringin.html">stringin</a>
 <a href="stringout.html">stringout</a>
 <a href="waveform.html">waveform</a>
-<a href="calcout.html">calcout</a>
-<a href="scalcout.html">scalcout</a>
-</p>
-<p><small>Dirk Zimoch, 2005</small></p>
-<script src="stream.js" type="text/javascript"></script>
+</nav>
+Dirk Zimoch, 2018
+</footer>
 </body>
 </html>

docs/longout.html

@@ -1,15 +1,16 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
-    "http://www.w3.org/TR/html4/loose.dtd">
-<html>
+<!DOCTYPE HTML>
+<html lang="en">
 <head>
 <title>StreamDevice: longout Records</title>
-<link rel="shortcut icon" href="sls_icon.ico">
-<link rel="stylesheet" type="text/css" href="stream.css">
-<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-<meta name="author" content="Dirk Zimoch">
+<meta charset="utf-8" />
+<link rel="shortcut icon" href="favicon.ico" />
+<link rel="stylesheet" type="text/css" href="stream.css" />
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<meta name="author" content="Dirk Zimoch" />
 </head>
 <body>
-<h1>StreamDevice: longout Records</h1>
+<iframe src="nav.html" id="navleft"></iframe>
+<h1>longout Records</h1>
 
 <h2>Normal Operation</h2>
 <p>
@@ -25,6 +26,8 @@ written or read value.
   <dd>
    <u>Output:</u> <code><i>x</i>=VAL</code><br>
    <u>Input:</u> <code>VAL=<i>x</i></code>
+   Using unsigned formats with values &ge; 0x800000 gives different results
+   on 64 bit machines.
   </dd>
  <dt>ENUM format (e.g. <code>%{</code>):</dt>
   <dd>
@@ -43,26 +46,31 @@ written or read value.
  present. All format converters work like in normal operation.
 </p>
 
-<hr>
-<p>
+<footer>
+<nav>
 <a href="aai.html">aai</a>
 <a href="aao.html">aao</a>
 <a href="ai.html">ai</a>
 <a href="ao.html">ao</a>
 <a href="bi.html">bi</a>
 <a href="bo.html">bo</a>
-<a href="mbbi.html">mbbi</a>
-<a href="mbbo.html">mbbo</a>
+<a href="calcout.html">calcout</a>
+<a href="int64in.html">int64in</a>
+<a href="int64out.html">int64out</a>
+<a href="longin.html">longin</a>
+<a href="longout.html">longout</a>
+<a href="lsi.html">lsi</a>
+<a href="lso.html">lso</a>
 <a href="mbbiDirect.html">mbbiDirect</a>
 <a href="mbboDirect.html">mbboDirect</a>
-<a href="longin.html">longin</a>
+<a href="mbbi.html">mbbi</a>
+<a href="mbbo.html">mbbo</a>
+<a href="scalcout.html">scalcout</a>
 <a href="stringin.html">stringin</a>
 <a href="stringout.html">stringout</a>
 <a href="waveform.html">waveform</a>
-<a href="calcout.html">calcout</a>
-<a href="scalcout.html">scalcout</a>
-</p>
-<p><small>Dirk Zimoch, 2005</small></p>
-<script src="stream.js" type="text/javascript"></script>
+</nav>
+Dirk Zimoch, 2018
+</footer>
 </body>
 </html>

docs/lsi.html

@@ -0,0 +1,79 @@
+<!DOCTYPE HTML>
+<html lang="en">
+<head>
+<title>StreamDevice: lsi Records</title>
+<meta charset="utf-8" />
+<link rel="shortcut icon" href="favicon.ico" />
+<link rel="stylesheet" type="text/css" href="stream.css" />
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<meta name="author" content="Dirk Zimoch" />
+</head>
+<body>
+<iframe src="nav.html" id="navleft"></iframe>
+<h1>lsi Records</h1>
+
+<p>
+<b>Note:</b> The lsi (long string in) record is only available from EPICS base R3.15 on.
+</p>
+
+<h2>Normal Operation</h2>
+<p>
+The variable <code><i>x</i></code> stands for the
+written or read value.
+</p>
+<dl>
+ <dt>DOUBLE format (e.g. <code>%f</code>):</dt>
+  <dd>
+   Not allowed.
+  </dd>
+ <dt>LONG format (e.g. <code>%i</code>):</dt>
+  <dd>
+   Not allowed.
+  </dd>
+ <dt>ENUM format (e.g. <code>%{</code>):</dt>
+  <dd>
+   Not allowed.
+  </dd>
+ <dt>STRING format (e.g. <code>%s</code>):</dt>
+  <dd>
+   <u>Output:</u> <code><i>x</i>=VAL</code><br>
+   <u>Input:</u> <code>VAL=<i>x</i></code><br>
+   Also the <code>LEN</code> field is set to the length of the input
+   including possible null bytes.
+  </dd>
+</dl>
+
+<h2>Initialization</h2>
+<p>
+ During <a href="processing.html#init">initialization</a>, the <code>@init</code> handler is executed, if
+ present. All format converters work like in normal operation.
+</p>
+
+<footer>
+<nav>
+<a href="aai.html">aai</a>
+<a href="aao.html">aao</a>
+<a href="ai.html">ai</a>
+<a href="ao.html">ao</a>
+<a href="bi.html">bi</a>
+<a href="bo.html">bo</a>
+<a href="calcout.html">calcout</a>
+<a href="int64in.html">int64in</a>
+<a href="int64out.html">int64out</a>
+<a href="longin.html">longin</a>
+<a href="longout.html">longout</a>
+<a href="lsi.html">lsi</a>
+<a href="lso.html">lso</a>
+<a href="mbbiDirect.html">mbbiDirect</a>
+<a href="mbboDirect.html">mbboDirect</a>
+<a href="mbbi.html">mbbi</a>
+<a href="mbbo.html">mbbo</a>
+<a href="scalcout.html">scalcout</a>
+<a href="stringin.html">stringin</a>
+<a href="stringout.html">stringout</a>
+<a href="waveform.html">waveform</a>
+</nav>
+Dirk Zimoch, 2018
+</footer>
+</body>
+</html>

docs/lso.html

@@ -0,0 +1,79 @@
+<!DOCTYPE HTML>
+<html lang="en">
+<head>
+<title>StreamDevice: lso Records</title>
+<meta charset="utf-8" />
+<link rel="shortcut icon" href="favicon.ico" />
+<link rel="stylesheet" type="text/css" href="stream.css" />
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<meta name="author" content="Dirk Zimoch" />
+</head>
+<body>
+<iframe src="nav.html" id="navleft"></iframe>
+<h1>lso Records</h1>
+
+<p>
+<b>Note:</b> The lso (long string out) record is only available from EPICS base R3.15 on.
+</p>
+
+<h2>Normal Operation</h2>
+<p>
+The variable <code><i>x</i></code> stands for the
+written or read value.
+</p>
+<dl>
+ <dt>DOUBLE format (e.g. <code>%f</code>):</dt>
+  <dd>
+   Not allowed.
+  </dd>
+ <dt>LONG format (e.g. <code>%i</code>):</dt>
+  <dd>
+   Not allowed.
+  </dd>
+ <dt>ENUM format (e.g. <code>%{</code>):</dt>
+  <dd>
+   Not allowed.
+  </dd>
+ <dt>STRING format (e.g. <code>%s</code>):</dt>
+  <dd>
+   <u>Output:</u> <code><i>x</i>=VAL</code><br>
+   <u>Input:</u> <code>VAL=<i>x</i></code><br>
+   Also the <code>LEN</code> field is set to the length of the input
+   including possible null bytes.
+  </dd>
+</dl>
+
+<h2>Initialization</h2>
+<p>
+ During <a href="processing.html#init">initialization</a>, the <code>@init</code> handler is executed, if
+ present. All format converters work like in normal operation.
+</p>
+
+<footer>
+<nav>
+<a href="aai.html">aai</a>
+<a href="aao.html">aao</a>
+<a href="ai.html">ai</a>
+<a href="ao.html">ao</a>
+<a href="bi.html">bi</a>
+<a href="bo.html">bo</a>
+<a href="calcout.html">calcout</a>
+<a href="int64in.html">int64in</a>
+<a href="int64out.html">int64out</a>
+<a href="longin.html">longin</a>
+<a href="longout.html">longout</a>
+<a href="lsi.html">lsi</a>
+<a href="lso.html">lso</a>
+<a href="mbbiDirect.html">mbbiDirect</a>
+<a href="mbboDirect.html">mbboDirect</a>
+<a href="mbbi.html">mbbi</a>
+<a href="mbbo.html">mbbo</a>
+<a href="scalcout.html">scalcout</a>
+<a href="stringin.html">stringin</a>
+<a href="stringout.html">stringout</a>
+<a href="waveform.html">waveform</a>
+</nav>
+Dirk Zimoch, 2018
+</footer>
+</body>
+</html>

docs/makepdf

@@ -0,0 +1,43 @@
+#/bin/sh
+if ! wkhtmltopdf -V >/dev/null 2>&1
+then
+    echo "wkhtmltopdf not installed." >&2
+    echo "See https://wkhtmltopdf.org" >&2
+    exit 1
+fi
+
+PAGES="
+index.html
+setup.html
+epics3_13.html
+protocol.html
+formats.html
+processing.html
+recordtypes.html
+aai.html
+aao.html
+ai.html
+ao.html
+bi.html
+bo.html
+mbbi.html
+mbbo.html
+mbbiDirect.html
+mbboDirect.html
+stringin.html
+stringout.html
+longin.html
+longout.html
+waveform.html
+calcout.html
+scalcout.html
+tipsandtricks.html
+recordinterface.html
+businterface.html
+formatconverter.html
+osinterface.html
+"
+
+rm -f stream.pdf
+wkhtmltopdf --print-media-type --dpi 1200 --zoom 0.85 --page-size Letter \
+$PAGES stream.pdf

docs/mbbi.html

@@ -1,15 +1,16 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
-    "http://www.w3.org/TR/html4/loose.dtd">
-<html>
+<!DOCTYPE HTML>
+<html lang="en">
 <head>
 <title>StreamDevice: mbbi Records</title>
-<link rel="shortcut icon" href="sls_icon.ico">
-<link rel="stylesheet" type="text/css" href="stream.css">
-<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-<meta name="author" content="Dirk Zimoch">
+<meta charset="utf-8" />
+<link rel="shortcut icon" href="favicon.ico" />
+<link rel="stylesheet" type="text/css" href="stream.css" />
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<meta name="author" content="Dirk Zimoch" />
 </head>
 <body>
-<h1>StreamDevice: mbbi Records</h1>
+<iframe src="nav.html" id="navleft"></iframe>
+<h1>mbbi Records</h1>
 
 <h2>Normal Operation</h2>
 <p>
@@ -69,26 +70,31 @@ written or read value.
  present. All format converters work like in normal operation.
 </p>
 
-<hr>
-<p>
+<footer>
+<nav>
 <a href="aai.html">aai</a>
 <a href="aao.html">aao</a>
 <a href="ai.html">ai</a>
 <a href="ao.html">ao</a>
 <a href="bi.html">bi</a>
 <a href="bo.html">bo</a>
-<a href="mbbo.html">mbbo</a>
-<a href="mbbiDirect.html">mbbiDirect</a>
-<a href="mbboDirect.html">mbboDirect</a>
+<a href="calcout.html">calcout</a>
+<a href="int64in.html">int64in</a>
+<a href="int64out.html">int64out</a>
 <a href="longin.html">longin</a>
 <a href="longout.html">longout</a>
+<a href="lsi.html">lsi</a>
+<a href="lso.html">lso</a>
+<a href="mbbiDirect.html">mbbiDirect</a>
+<a href="mbboDirect.html">mbboDirect</a>
+<a href="mbbi.html">mbbi</a>
+<a href="mbbo.html">mbbo</a>
+<a href="scalcout.html">scalcout</a>
 <a href="stringin.html">stringin</a>
 <a href="stringout.html">stringout</a>
 <a href="waveform.html">waveform</a>
-<a href="calcout.html">calcout</a>
-<a href="scalcout.html">scalcout</a>
-</p>
-<p><small>Dirk Zimoch, 2005</small></p>
-<script src="stream.js" type="text/javascript"></script>
+</nav>
+Dirk Zimoch, 2018
+</footer>
 </body>
 </html>

docs/mbbiDirect.html

@@ -1,15 +1,16 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
-    "http://www.w3.org/TR/html4/loose.dtd">
-<html>
+<!DOCTYPE HTML>
+<html lang="en">
 <head>
 <title>StreamDevice: mbbiDirect Records</title>
-<link rel="shortcut icon" href="sls_icon.ico">
-<link rel="stylesheet" type="text/css" href="stream.css">
-<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-<meta name="author" content="Dirk Zimoch">
+<meta charset="utf-8" />
+<link rel="shortcut icon" href="favicon.ico" />
+<link rel="stylesheet" type="text/css" href="stream.css" />
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<meta name="author" content="Dirk Zimoch" />
 </head>
 <body>
-<h1>StreamDevice: mbbiDirect Records</h1>
+<iframe src="nav.html" id="navleft"></iframe>
+<h1>mbbiDirect Records</h1>
 
 <h2>Normal Operation</h2>
 <p>
@@ -55,26 +56,31 @@ written or read value.
  present. All format converters work like in normal operation.
 </p>
 
-<hr>
-<p>
+<footer>
+<nav>
 <a href="aai.html">aai</a>
 <a href="aao.html">aao</a>
 <a href="ai.html">ai</a>
 <a href="ao.html">ao</a>
 <a href="bi.html">bi</a>
 <a href="bo.html">bo</a>
-<a href="mbbi.html">mbbi</a>
-<a href="mbbo.html">mbbo</a>
-<a href="mbboDirect.html">mbboDirect</a>
+<a href="calcout.html">calcout</a>
+<a href="int64in.html">int64in</a>
+<a href="int64out.html">int64out</a>
 <a href="longin.html">longin</a>
 <a href="longout.html">longout</a>
+<a href="lsi.html">lsi</a>
+<a href="lso.html">lso</a>
+<a href="mbbiDirect.html">mbbiDirect</a>
+<a href="mbboDirect.html">mbboDirect</a>
+<a href="mbbi.html">mbbi</a>
+<a href="mbbo.html">mbbo</a>
+<a href="scalcout.html">scalcout</a>
 <a href="stringin.html">stringin</a>
 <a href="stringout.html">stringout</a>
 <a href="waveform.html">waveform</a>
-<a href="calcout.html">calcout</a>
-<a href="scalcout.html">calcout</a>
-</p>
-<p><small>Dirk Zimoch, 2005</small></p>
-<script src="stream.js" type="text/javascript"></script>
+</nav>
+Dirk Zimoch, 2018
+</footer>
 </body>
 </html>

docs/mbbo.html

@@ -1,15 +1,16 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
-    "http://www.w3.org/TR/html4/loose.dtd">
-<html>
+<!DOCTYPE HTML>
+<html lang="en">
 <head>
 <title>StreamDevice: mbbo Records</title>
-<link rel="shortcut icon" href="sls_icon.ico">
-<link rel="stylesheet" type="text/css" href="stream.css">
-<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-<meta name="author" content="Dirk Zimoch">
+<meta charset="utf-8" />
+<link rel="shortcut icon" href="favicon.ico" />
+<link rel="stylesheet" type="text/css" href="stream.css" />
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<meta name="author" content="Dirk Zimoch" />
 </head>
 <body>
-<h1>StreamDevice: mbbo Records</h1>
+<iframe src="nav.html" id="navleft"></iframe>
+<h1>mbbo Records</h1>
 
 <h2>Normal Operation</h2>
 <p>
@@ -32,11 +33,11 @@ written or read value.
       Note that the record calculates <code>RVAL</code> by choosing one of
       <code>ZRVL</code> ... <code>FFVL</code> depending on <code>VAL</code>
       and by shifting it left by <code>SHFT</code> bits.<br>
-      <u>Input:</u> <code>RBV=<i>x</i>&amp;MASK</code><br>
+      <u>Input:</u> <code>RBV=RVAL=<i>x</i>&amp;MASK</code><br>
       <code>MASK</code> is initialized to <code>NOBT</code> 1-bits shifted
       left by <code>SHFT</code>. If <code>MASK==0</code> (because
       <code>NOBT</code> was not set) it is ignored, i.e.
-      <code><i>x</i>=RVAL</code> and <code>RBV=<i>x</i></code>.
+      <code><i>x</i>=RVAL</code> and <code>RBV=RVAL=<i>x</i></code>.
      </dd>
     <dt>If none of <code>ZRVL</code> ... <code>FFVL</code> is set
         (all are <code>0</code>):</dt>
@@ -65,31 +66,34 @@ written or read value.
 <h2>Initialization</h2>
 <p>
  During <a href="processing.html#init">initialization</a>, the <code>@init</code> handler is executed, if
- present. In contrast to normal operation, LONG input is put to
- <code>RVAL</code> as well as to <code>RBV</code> and converted by the
- record.
+ present.
 </p>
 
-<hr>
-<p>
+<footer>
+<nav>
 <a href="aai.html">aai</a>
 <a href="aao.html">aao</a>
 <a href="ai.html">ai</a>
 <a href="ao.html">ao</a>
 <a href="bi.html">bi</a>
 <a href="bo.html">bo</a>
-<a href="mbbi.html">mbbi</a>
-<a href="mbbiDirect.html">mbbiDirect</a>
-<a href="mbboDirect.html">mbboDirect</a>
+<a href="calcout.html">calcout</a>
+<a href="int64in.html">int64in</a>
+<a href="int64out.html">int64out</a>
 <a href="longin.html">longin</a>
 <a href="longout.html">longout</a>
+<a href="lsi.html">lsi</a>
+<a href="lso.html">lso</a>
+<a href="mbbiDirect.html">mbbiDirect</a>
+<a href="mbboDirect.html">mbboDirect</a>
+<a href="mbbi.html">mbbi</a>
+<a href="mbbo.html">mbbo</a>
+<a href="scalcout.html">scalcout</a>
 <a href="stringin.html">stringin</a>
 <a href="stringout.html">stringout</a>
 <a href="waveform.html">waveform</a>
-<a href="calcout.html">calcout</a>
-<a href="scalcout.html">scalcout</a>
-</p>
-<p><small>Dirk Zimoch, 2005</small></p>
-<script src="stream.js" type="text/javascript"></script>
+</nav>
+Dirk Zimoch, 2018
+</footer>
 </body>
 </html>

docs/mbboDirect.html

@@ -1,15 +1,16 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
-    "http://www.w3.org/TR/html4/loose.dtd">
-<html>
+<!DOCTYPE HTML>
+<html lang="en">
 <head>
 <title>StreamDevice: mbboDirect Records</title>
-<link rel="shortcut icon" href="sls_icon.ico">
-<link rel="stylesheet" type="text/css" href="stream.css">
-<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-<meta name="author" content="Dirk Zimoch">
+<meta charset="utf-8" />
+<link rel="shortcut icon" href="favicon.ico" />
+<link rel="stylesheet" type="text/css" href="stream.css" />
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<meta name="author" content="Dirk Zimoch" />
 </head>
 <body>
-<h1>StreamDevice: mbboDirect Records</h1>
+<iframe src="nav.html" id="navleft"></iframe>
+<h1>mbboDirect Records</h1>
 
 <h2>Normal Operation</h2>
 <p>
@@ -22,26 +23,23 @@ written or read value.
   <dd>
    Not allowed.
   </dd>
- <dt>LONG format (e.g. <code>%i</code>):</dt>
+ <dt>LONG or ENUM format (e.g. <code>%i</code>):</dt>
   <dd>
    <dl>
     <dt>If <code>MASK==0</code> (because <code>NOBT</code> is not set):</dt>
      <dd>
-       <u>Output:</u> <code><i>x</i>=VAL</code><br>
-       <u>Input:</u> <code>VAL=<i>x</i></code><br>
+       <u>Output:</u> <code><i>x</i>=RVAL</code><br>
+       <u>Input:</u> <code>RAL=<i>x</i></code>, <code>VAL=RVAL&gt;&gt;SHFT</code><br>
      </dd>
     <dt>If <code>MASK!=0</code>:</dt>
      <dd>
        <u>Output:</u> <code><i>x</i>=RVAL&amp;MASK</code><br>
-       <u>Input:</u> <code>RBV=<i>x</i>&amp;MASK</code><br>
+       <u>Input:</u> <code>RBV=RVAL=<i>x</i>&amp;MASK</code>, <code>VAL=RVAL&gt;&gt;SHFT</code><br>
      </dd>
     </dl>
     <code>MASK</code> is initialized to <code>NOBT</code> 1-bits shifted
-    left by <code>SHFT</code>.
-  </dd>
- <dt>ENUM format (e.g. <code>%{</code>):</dt>
-  <dd>
-   Not allowed.
+    left by <code>SHFT</code> (<code>((2^NOBT)-1)&lt;&lt;SHFT</code>).
+    The record calculates <code>RVAL=VAL&lt;&lt;SHFT</code>.
   </dd>
  <dt>STRING format (e.g. <code>%s</code>):</dt>
   <dd>
@@ -52,31 +50,34 @@ written or read value.
 <h2>Initialization</h2>
 <p>
  During <a href="processing.html#init">initialization</a>, the <code>@init</code> handler is executed, if
- present. In contrast to normal operation, input is put to
- <code>RVAL</code> as well as to <code>RBV</code> and converted by the
- record if <code>MASK!=0</code>.
+ present.
 </p>
 
-<hr>
-<p>
+<footer>
+<nav>
 <a href="aai.html">aai</a>
 <a href="aao.html">aao</a>
 <a href="ai.html">ai</a>
 <a href="ao.html">ao</a>
 <a href="bi.html">bi</a>
 <a href="bo.html">bo</a>
-<a href="mbbi.html">mbbi</a>
-<a href="mbbo.html">mbbo</a>
-<a href="mbbiDirect.html">mbbiDirect</a>
+<a href="calcout.html">calcout</a>
+<a href="int64in.html">int64in</a>
+<a href="int64out.html">int64out</a>
 <a href="longin.html">longin</a>
 <a href="longout.html">longout</a>
+<a href="lsi.html">lsi</a>
+<a href="lso.html">lso</a>
+<a href="mbbiDirect.html">mbbiDirect</a>
+<a href="mbboDirect.html">mbboDirect</a>
+<a href="mbbi.html">mbbi</a>
+<a href="mbbo.html">mbbo</a>
+<a href="scalcout.html">scalcout</a>
 <a href="stringin.html">stringin</a>
 <a href="stringout.html">stringout</a>
 <a href="waveform.html">waveform</a>
-<a href="calcout.html">calcout</a>
-<a href="scalcout.html">scalcout</a>
-</p>
-<p><small>Dirk Zimoch, 2005</small></p>
-<script src="stream.js" type="text/javascript"></script>
+</nav>
+Dirk Zimoch, 2018
+</footer>
 </body>
 </html>

docs/nav.html

@@ -0,0 +1,228 @@
+<!DOCTYPE HTML>
+<html lang="en">
+<head>
+<title>Navbar</title>
+<meta charset="utf-8" />
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<meta name="author" content="Dirk Zimoch" />
+<style type="text/css">
+<!--
+body      {margin:0 0 13ex 1em;
+           font-family: "HelveticaNeue-Light", "Helvetica Neue Light", "Helvetica Neue", Helvetica, Arial, "Lucida Grande", sans-serif;
+           font-weight:bold;
+           font-size:13px;
+           background-color:#e3eaf6;}
+a         {text-decoration:none;}
+a:link    {color:#333333;}
+a:visited {color:#333333;}
+a:hover   {color:#FF0000;}
+a:active  {color:#FF0000;}
+
+h1        {font-size:120%;
+           margin-top: 20px;
+           margin-right: 20px;
+           margin-bottom: 10px;
+           color:#267ab8;}
+
+div       {border-bottom:1px solid black;
+           padding-top:1ex;}
+
+div div, div div div, div:hover div div
+          {
+           padding-top:0;
+           margin-right:.1em;
+           border:none;
+           box-shadow: none;
+           -moz-box-shadow: none;
+           -webkit-box-shadow: none;
+           padding 0;
+           display:block;
+           position:relative;
+           }
+div div
+          {display:none;
+           margin-left:2em;
+           margin-right:1em;
+           background-color:#e3eaf6;
+           padding:0 .5em .5ex .5em;
+           border-width:0 thick thick 1px;
+           border-color:black;
+           border-style:solid;
+           }
+:root *> div div
+         {border-width:0 1px 1px 1px;
+           box-shadow: 5px 5px 5px black;
+           -moz-box-shadow: 5px 5px 5px black;
+           -webkit-box-shadow: 5px 5px 5px black;
+         }
+div:hover div {
+            position:absolute;
+            display:block;}
+
+div div div {margin-left:0;}
+
+a         {display:block;
+           margin-top:.3ex;}
+
+div div a {display:list-item;
+           margin-left:1em;
+           list-style-type:disc;
+           }
+
+div div div a {list-style-type:circle;}
+
+-->
+</style>
+
+</head>
+<body>
+<h1>User's Guide</h1>
+<div>
+ <a target="_parent" href="index.html">Intro</a>
+</div>
+<div>
+ <a target="_parent" href="setup.html">Setup</a>
+ <a href="javascript:show('setup')" id="setupButton"></a>
+ <div>
+  <a target="_parent" href="setup.html#pre">Prerequisites</a>
+   <div>
+    <a target="_parent" href="epics3_13.html">Using EPICS 3.13</a>
+  </div>
+  <a target="_parent" href="setup.html#lib">Build Library</a>
+  <a target="_parent" href="setup.html#app">Build Application</a>
+  <a target="_parent" href="setup.html#sta">Startup Script</a>
+  <a target="_parent" href="setup.html#pro">Protocol File</a>
+   <div>
+    <a target="_parent" href="setup.html#reload">Reloading</a>
+   </div>
+  <a target="_parent" href="setup.html#rec">Records</a>
+ </div>
+</div>
+<div>
+ <a target="_parent" href="protocol.html">Protocol Files</a>
+ <a href="javascript:show('protocol')" id="protocolButton"></a>
+ <div>
+  <a target="_parent" href="protocol.html#gen">General</a>
+  <a target="_parent" href="protocol.html#proto">Protocols</a>
+  <a target="_parent" href="protocol.html#cmd">Commands</a>
+  <a target="_parent" href="protocol.html#str">Strings</a>
+  <a target="_parent" href="protocol.html#var">Variables</a>
+   <div>
+    <a target="_parent" href="protocol.html#sysvar">System variables</a>
+    <a target="_parent" href="protocol.html#argvar">Protocol Arguments</a>
+    <a target="_parent" href="protocol.html#usrvar">User variables</a>
+   </div>
+  <a target="_parent" href="protocol.html#except">Exception Handlers</a>
+ </div>
+</div>
+<div>
+ <a target="_parent" href="formats.html">Format Converters</a>
+ <a href="javascript:show('formats')" id="formatsButton"></a>
+ <div>
+  <a target="_parent" href="formats.html#syntax">Syntax</a>
+  <a target="_parent" href="formats.html#types">Types &amp; Fields</a>
+  <a target="_parent" href="formats.html#stdd"      title="Standard DOUBLE converters">%f %e %g</a>
+  <a target="_parent" href="formats.html#stdl"      title="Standard LONG converters">%i %d %u %o %x</a>
+  <a target="_parent" href="formats.html#stds"      title="Standard STRING converters">%s %c</a>
+  <a target="_parent" href="formats.html#cset"      title="Character set STRING converter">%[<em>charset</em>]</a>
+  <a target="_parent" href="formats.html#enum"      title="Enumeration LONG converter">%{<em>s0</em>|<em>s1</em>|...}</a>
+  <a target="_parent" href="formats.html#bin"       title="Binary LONG converter">%b %B</a>
+  <a target="_parent" href="formats.html#raw"       title="Raw LONG converter">%r</a>
+  <a target="_parent" href="formats.html#rawdouble" title="Raw DOUBLE converter">%R</a>
+  <a target="_parent" href="formats.html#bcd"       title="Binary coded decimal LONG converter">%D</a>
+  <a target="_parent" href="formats.html#chksum"    title="Checksum pseudo converter">%&lt;<em>checksum</em>&gt;</a>
+  <a target="_parent" href="formats.html#regex"     title="Perl regular expression STRING converter">%/<em>regex</em>/</a>
+  <a target="_parent" href="formats.html#regsub"    title="Perl regular expression substitution pseudo converter">%#/<em>regex</em>/<em>subst</em>/</a>
+  <a target="_parent" href="formats.html#mantexp"   title="MantissaExponent DOUBLE converter">%m</a>
+  <a target="_parent" href="formats.html#timestamp" title="Timestamp DOUBLE converter">%T</a>
+ </div>
+</div>
+<div>
+ <a target="_parent" href="processing.html">Record Processing</a>
+ <a href="javascript:show('proc')" id="procButton"></a>
+ <div>
+  <a target="_parent" href="processing.html#proc">Normal Processing</a>
+  <a target="_parent" href="processing.html#init">Initialization</a>
+  <a target="_parent" href="processing.html#iointr">I/O Intr</a>
+ </div>
+</div>
+<div>
+ <a target="_parent" href="recordtypes.html">Record Types</a>
+ <a href="javascript:show('records')" id="recordsButton"></a>
+ <div>
+  <a target="_parent" href="aai.html">aai</a>
+  <a target="_parent" href="aao.html">aao</a>
+  <a target="_parent" href="ai.html">ai</a>
+  <a target="_parent" href="ao.html">ao</a>
+  <a target="_parent" href="bi.html">bi</a>
+  <a target="_parent" href="bo.html">bo</a>
+  <a target="_parent" href="calcout.html">calcout</a>
+  <a target="_parent" href="int64in.html">int64in</a>
+  <a target="_parent" href="int64out.html">int64out</a>
+  <a target="_parent" href="longin.html">longin</a>
+  <a target="_parent" href="longout.html">longout</a>
+  <a target="_parent" href="lsi.html">lsi</a>
+  <a target="_parent" href="lso.html">lso</a>
+  <a target="_parent" href="mbbiDirect.html">mbbiDirect</a>
+  <a target="_parent" href="mbboDirect.html">mbboDirect</a>
+  <a target="_parent" href="mbbi.html">mbbi</a>
+  <a target="_parent" href="mbbo.html">mbbo</a>
+  <a target="_parent" href="scalcout.html">scalcout</a>
+  <a target="_parent" href="stringin.html">stringin</a>
+  <a target="_parent" href="stringout.html">stringout</a>
+  <a target="_parent" href="waveform.html">waveform</a>
+ </div>
+</div>
+<div>
+ <a target="_parent" href="tipsandtricks.html">Tips &amp; Tricks</a>
+ <a href="javascript:show('tipsandtricks')" id="tipsandtricksButton"></a>
+ <div>
+  <a target="_parent" href="tipsandtricks.html#argvar">Many almost identical protocols</a>
+  <a target="_parent" href="tipsandtricks.html#iointr">Read unsolicited input</a>
+  <a target="_parent" href="tipsandtricks.html#multiline">Read multi-line messages</a>
+  <a target="_parent" href="tipsandtricks.html#writemany">Write more than one value in one message</a>
+  <a target="_parent" href="tipsandtricks.html#readmany">Read more than one value from one message</a>
+  <a target="_parent" href="tipsandtricks.html#mixed">Read values of mixed data type</a>
+  <a target="_parent" href="tipsandtricks.html#web">Read a web page</a>
+ </div>
+</div>
+
+<h1>Programmer's Guide</h1>
+<div>
+ <a target="_parent" href="recordinterface.html">Record API</a>
+</div>
+<div>
+ <a target="_parent" href="businterface.html">Bus API</a>
+ <a href="javascript:show('bus')" id="busButton"></a>
+ <div>
+  <a target="_parent" href="businterface.html#class">Interface Class</a>
+  <a target="_parent" href="businterface.html#theory">Theory of Operation</a>
+   <div>
+    <a target="_parent" href="businterface.html#registration">Registration</a>
+    <a target="_parent" href="businterface.html#create">Creation &amp; deletion</a>
+    <a target="_parent" href="businterface.html#connect">Connecting</a>
+    <a target="_parent" href="businterface.html#lock">Bus locking</a>
+    <a target="_parent" href="businterface.html#write">Writing output</a>
+    <a target="_parent" href="businterface.html#read">Reading input</a>
+    <a target="_parent" href="businterface.html#event">Handling events</a>
+  </div>
+ </div>
+</div>
+<div>
+ <a target="_parent" href="formatconverter.html">Format Converter API</a>
+ <div>
+  <a target="_parent" href="formatconverter.html#class">Converter Class</a>
+  <a target="_parent" href="formatconverter.html#theory">Theory of Operation</a>
+   <div>
+    <a target="_parent" href="formatconverter.html#registration">Registration</a>
+    <a target="_parent" href="formatconverter.html#parsing">Parsing</a>
+    <a target="_parent" href="formatconverter.html#printing_scanning">Printing and Scanning</a>
+  </div>
+ </div>
+</div>
+<div>
+ <a target="_parent" href="osinterface.html">Operating System API</a>
+</div>
+</body>
+</html>
+

docs/osinterface.html

@@ -0,0 +1,22 @@
+<!DOCTYPE HTML>
+<html lang="en">
+<head>
+<title>StreamDevice: Operating System API</title>
+<meta charset="utf-8" />
+<link rel="shortcut icon" href="favicon.ico" />
+<link rel="stylesheet" type="text/css" href="stream.css" />
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<meta name="author" content="Dirk Zimoch" />
+</head>
+<body>
+<iframe src="nav.html" id="navleft"></iframe>
+<h1>Operating System API</h1>
+
+<h2>Sorry, this documentation is still missing.</h2>
+
+
+<footer>
+Dirk Zimoch, 2018
+</footer>
+</body>
+</html>

docs/processing.html

@@ -1,21 +1,22 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
-    "http://www.w3.org/TR/html4/loose.dtd">
-<html>
+<!DOCTYPE HTML>
+<html lang="en">
 <head>
 <title>StreamDevice: Record Processing</title>
-<link rel="shortcut icon" href="sls_icon.ico">
-<link rel="stylesheet" type="text/css" href="stream.css">
-<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-<meta name="author" content="Dirk Zimoch">
+<meta charset="utf-8" />
+<link rel="shortcut icon" href="favicon.ico" />
+<link rel="stylesheet" type="text/css" href="stream.css" />
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<meta name="author" content="Dirk Zimoch" />
 </head>
 <body>
-<h1>StreamDevice: Record Processing</h1>
+<iframe src="nav.html" id="navleft"></iframe>
+<h1>Record Processing</h1>
 
 <a name="proc"></a>
 <h2>1. Normal Processing</h2>
 <p>
 <em>StreamDevice</em> is an asynchronous device support
-(see <a href="http://www.aps.anl.gov/epics/base/R3-14/8-docs/AppDevGuide.pdf"
+(see <a href="http://www.aps.anl.gov/epics/base/R3-14/12-docs/AppDevGuide.pdf"
 target="ex">IOC Application Developer's Guide</a> chapter 12:
 Device Support).
 Whenever the record is processed, the <a href="protocol.html">protocol</a>
@@ -53,22 +54,23 @@ its <code>SEVR</code> field set to <code>INVALID</code> and its
 <dl>
  <dt><code>TIMEOUT</code></dt>
  <dd>
-  The device could not be locked (<code>LockTimeout</code>) or the
-  device did not reply (<code>ReplyTimeout</code>).
+  The device could not be locked (<code>LockTimeout</code>) because
+  other records are keeping the device busy or the device did not reply
+  in time (<a href="protocol.html#sysvar"><code>ReplyTimeout</code></a>).
  </dd>
  <dt><code>WRITE</code></dt>
  <dd>
-  Output could not be written to the device (<code>WriteTimeout</code>).
+  Output could not be written to the device in time
+  (<a href="protocol.html#sysvar"><code>WriteTimeout</code></a>).
  </dd>
  <dt><code>READ</code></dt>
  <dd>
   Input from the device started but stopped unexpectedly
-  (<code>ReadTimeout</code>).
+  (<a href="protocol.html#sysvar"><code>ReadTimeout</code></a>).
  </dd>
  <dt><code>COMM</code></dt>
  <dd>
-  The device driver reported some other communication error (e.g.
-  unplugged cable).
+  The device driver reported that the device is disconnected.
  </dd>
  <dt><code>CALC</code></dt>
  <dd>
@@ -94,13 +96,14 @@ will be set according to the original error.
 <a name="init"></a>
 <h2>2. Initialization</h2>
 <p>
-Often, it is required to initialize records from the hardware after
+Often, it is useful to initialize records from the hardware after
 booting the IOC, especially output records.
 For this purpose, initialization is formally handled as an
 <a href="protocol.html#except">exception</a>.
 The <code>@init</code> handler is called as part of the
 <code>initRecord()</code> function during <code>iocInit</code>
-before any scan task starts.
+before any scan task starts <span class="new">and may be re-run
+later under circumstances listed below</span>.
 </p>
 <p>
 In contrast to <a href="#proc">normal processing</a>, the protocol
@@ -118,7 +121,7 @@ If the handler fails, the record remains uninitialized:
 The <code>@init</code> handler has nothing to do with the
 <code>PINI</code> field.
 The handler does <u>not</u> process the record nor does it trigger
-forward links or other PP links.
+forward links or any links with the <code>PP</code> flag.
 It runs <u>before</u> <code>PINI</code> is handled.
 If the record has <code>PINI=YES</code>, the <code>PINI</code>
 processing is a <a href="#proc">normal processing</a> after the
@@ -145,6 +148,33 @@ read from a constant <code>INP</code> or <code>DOL</code> field,
 or restored from a bump-less reboot system
 (e.g. <em>autosave</em> from the <em>synApps</em> package).
 </p>
+<p>
+  The <code>@init</code> handler is called in the following situations:
+  <ul>
+    <li>At startup by <code>iocInit</code> during record initialization
+        as described above.
+    <li class="new">When the IOC is resumed with <code>iocRun</code> (after
+        beeing paused with <code>iocPause</code>) before the scan tasks
+        restart and before records with <code>PINI=RUN</code> are processed.
+    <li class="new">When the protocol is
+        <a href="setup.html#reload">reloaded</a></span> for example with
+        <code>streamReload ["<var>recordname</var>"]</code>.
+    <li class="new">When <em>StreamDevice</em> detects that the device has
+        reconnected (after being disconnected). This includes the case that
+        the device was disconnected when the IOC started.
+        Be aware that some drivers test the connection only periodically,
+        e.g. the <em>asynIPPort</em> driver tests it every few seconds.
+        Thus there may be a small delay between the device being online
+        and the record re-initializing.
+    <li class="new">When <code>streamReinit
+        "<var>asynPortname</var>"[,<var>addr</var>]</code> is called
+        (if using an <em>asynDriver</em> port).
+    <li class="new">When the "magic value" <code>2</code> is written to the
+        <code>.PROC</code> field of the record.
+        In this case the record is processed and thus its <code>FLNK</code>
+        and links with the <code>PP</code> flag are triggered.
+  </ul>
+</p>
 
 <a name="iointr"></a>
 <h2>3. I/O Intr</h2>
@@ -236,9 +266,10 @@ Even though the <code>getROIend</code> protocol may receive input
 from other requests, it silently ignores every message that does not start
 with "<code>ROI</code>", followed by two floating point numbers.
 </p> 
-<hr>
-<p align="right"><a href="recordtypes.html">Next: Supported Record Types</a></p>
-<p><small>Dirk Zimoch, 2005</small></p>
-<script src="stream.js" type="text/javascript"></script>
+
+<footer>
+<a href="recordtypes.html">Next: Supported Record Types</a>
+Dirk Zimoch, 2018
+</footer>
 </body>
 </html>

docs/protocol.html

@@ -1,15 +1,16 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
-    "http://www.w3.org/TR/html4/loose.dtd">
-<html>
+<!DOCTYPE HTML>
+<html lang="en">
 <head>
 <title>StreamDevice: Protocol Files</title>
-<link rel="shortcut icon" href="sls_icon.ico">
-<link rel="stylesheet" type="text/css" href="stream.css">
-<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-<meta name="author" content="Dirk Zimoch">
+<meta charset="utf-8" />
+<link rel="shortcut icon" href="favicon.ico" />
+<link rel="stylesheet" type="text/css" href="stream.css" />
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<meta name="author" content="Dirk Zimoch" />
 </head>
 <body>
-<h1>StreamDevice: Protocol Files</h1>
+<iframe src="nav.html" id="navleft"></iframe>
+<h1>Protocol Files</h1>
 <a name="gen"></a>
 <h2>1. General Information</h2>
 <p>
@@ -241,8 +242,12 @@ that hex value.<br>
 that octal value.<br>
 <code>\1</code> to <code>\9</code> followed by up to two more decimal
 digits means a byte with that decimal value.<br>
-<code>\?</code> in the argument string of an <code>in</code>
-<a href="#cmd">command</a> matches any input byte<br>
+<code>\?</code> in input matches any byte, in output it does not print
+anything.<br>
+<span class="new">
+<code>\_</code> in input matches any amount of white space (including none),
+in output it prints a single space.<br>
+</span>
 <code>\$</code> followed by the name of a
 <a href="#var">protocol varible</a> is replaced by the contents of that
 variable.
@@ -251,29 +256,54 @@ variable.
 For non-printable characters, it is often easier to write sequences of
 byte values instead of escaped quoted string literals.
 A byte is written as an unquoted decimal, hexadecimal, or octal
-number in the range of -128 to 255 (-0x80 to 0xff, -0200 to 0377).
-<em>StreamDevice</em> also defines some symbolic names for frequently
-used byte codes as aliases for the numeric byte value:<br>
-<code>EOT</code> means <em>end of transmission</em> (ASCII code 4).<br>
-<code>ACK</code> means <em>acknowledge</em> (ASCII code 6).<br>
-<code>BEL</code> means <em>bell</em> (ASCII code 7).<br>
-<code>BS</code> means <em>backspace</em> (ASCII code 8).<br>
-<code>HT</code> or <code>TAB</code> mean <em>horizontal tabulator</em>
-(ASCII code 9).<br>
-<code>LF</code> or <code>NL</code> mean <em>line feed</em> /
-<em>new line</em> (ASCII code 10).<br>
-<code>CR</code> means <em>carriage return</em> (ASCII code 13).<br>
-<code>ESC</code> means <em>escape</em> (ASCII code 27).<br>
-<code>DEL</code> means <em>delete</em> (ASCII code 127).<br>
-<code>SKIP</code> in the argument string of an <code>in</code>
-<a href="#cmd">command</a> matches any input byte.
+number in the range of <code>-128</code> to <code>255</code>,
+<code>-0x80</code> to <code>0xff</code> (not case sesitive),
+or <code>-0200</code> to <code>0377</code>, respectively. 
+</p>
+<p>
+<em>StreamDevice</em> also recognizes the ASCII symbolic names
+(not case sensitive) for several byte codes:<br>
+<code>NUL </code>(= <code>0x00</code>) <em>null</em><br>
+<code>SOH </code>(= <code>0x01</code>) <em>start of heading</em><br>
+<code>STX </code>(= <code>0x02</code>) <em>start of text</em><br>
+<code>ETX </code>(= <code>0x03</code>) <em>end of text</em><br>
+<code>EOT </code>(= <code>0x04</code>) <em>end of transmission</em><br>
+<code>ENQ </code>(= <code>0x05</code>) <em>enquiry</em><br>
+<code>ACK </code>(= <code>0x06</code>) <em>acknowledge</em><br>
+<code>BEL </code>(= <code>0x07</code>) <em>bell</em><br>
+<code>BS&nbsp; </code>(= <code>0x08</code>) <em>backspace</em><br>
+<code>HT</code> or <code>TAB</code> (= <code>0x09</code>) <em>horizontal tabulator</em><br>
+<code>LF</code> or <code>NL</code> (= <code>0x0A</code> or <code>10</code>) <em>line feed / new line</em><br>
+<code>VT&nbsp; </code>(= <code>0x0B</code> or <code>11</code>) <em>vertical tabulator</em><br>
+<code>FF</code> or <code>NP</code> (= <code>0x0C</code> or <code>12</code>) <em>form feed / new page</em><br>
+<code>CR&nbsp; </code>(= <code>0x0D</code> or <code>13</code>) <em>carriage return</em><br>
+<code>SO&nbsp; </code>(= <code>0x0E</code> or <code>14</code>) <em>shift out</em><br>
+<code>SI&nbsp; </code>(= <code>0x0F</code> or <code>15</code>) <em>shift in</em><br>
+<code>DLE </code>(= <code>0x10</code> or <code>16</code>) <em>data link escape</em><br>
+<code>DC1 </code>(= <code>0x11</code> or <code>17</code>) <em>device control 1</em><br>
+<code>DC2 </code>(= <code>0x12</code> or <code>18</code>) <em>device control 2</em><br>
+<code>DC3 </code>(= <code>0x13</code> or <code>19</code>) <em>device control 3</em><br>
+<code>DC4 </code>(= <code>0x14</code> or <code>20</code>) <em>device control 4</em><br>
+<code>NAK </code>(= <code>0x15</code> or <code>21</code>) <em>negative acknowledge</em><br>
+<code>SYN </code>(= <code>0x16</code> or <code>22</code>) <em>synchronous idle</em><br>
+<code>ETB </code>(= <code>0x17</code> or <code>23</code>) <em>end of transmission block</em><br>
+<code>CAN </code>(= <code>0x18</code> or <code>24</code>) <em>cancel</em><br>
+<code>EM&nbsp; </code>(= <code>0x19</code> or <code>25</code>) <em>end of medium</em><br>
+<code>SUB </code>(= <code>0x1A</code> or <code>26</code>) <em></em>substitute<br>
+<code>ESC </code>(= <code>0x1B</code> or <code>27</code>) <em>escape</em><br>
+<code>FS&nbsp; </code>(= <code>0x1C</code> or <code>28</code>) <em>file separator</em><br>
+<code>GS&nbsp; </code>(= <code>0x1D</code> or <code>29</code>) <em>group separator</em><br>
+<code>RS&nbsp; </code>(= <code>0x1E</code> or <code>30</code>) <em>record separator</em><br>
+<code>US&nbsp; </code>(= <code>0x1F</code> or <code>31</code>) <em>unit separator</em><br>
+<code>DEL </code>(= <code>0x7F</code> or <code>127</code>) <em>delete</em><br>
+<code>SKIP</code> or <code>?</code> matches any input byte
 </p>
 <p>
 A single string can be built from several quoted literals and byte values
 by writing them separated by whitespaces or comma.
 </p>
 
-<h3>Example:</h3>
+<h3>Examples:</h3>
 <p>
 The following lines represent the same string:<br>
 <code>"Hello world\r\n"</code><br>
@@ -408,9 +438,12 @@ what they influence.
   (see <a href="formats.html">formats</a> and
   <a href="waveform.html">waveform record</a>), what string
   to write or to expect between values?
-  If the first character of the <code>Separator</code> is a
+  <span class="new">
+  <strike>If the first character of the <code>Separator</code> is a
   space, it matches any number of any whitespace characters in
-  an <code>in</code> command. 
+  an <code>in</code> command.</strike> To match arbitrary amount of
+  whitespace in input, use <code>"\_"</code>.
+  </span>
  </dd>
  <dt><code>ExtraInput = Error;</code></dt>
  <dd>
@@ -523,11 +556,10 @@ There is a fixed set of exception handler names starting with
  <dt><code>@init</code></dt>
  <dd>
   Not really an exception but formally specified in the same syntax.
-  This handler is called from <code>iocInit</code> during record
-  initialization.
-  It can be used to initialize an output record with a value read from
+  This handler can be used to initialize an output record with a value read from
   the device.
-  Also see chapter <a href="processing.html#init">Record Processing</a>.
+  See also chapter <a href="processing.html#init">Record Processing</a>.
+  
  </dd>
 </dl>
 <h3>Example:</h3>
@@ -544,9 +576,10 @@ is called but the protocol terminates immediately.
 An exception handler uses all <a href="#sysvar">system variable</a>
 settings from the protocol in which the exception occurred.
 </p>
-<hr>
-<p align="right"><a href="formats.html">Next: Format Converters</a></p>
-<p><small>Dirk Zimoch, 2006</small></p>
-<script src="stream.js" type="text/javascript"></script>
+
+<footer>
+<a href="formats.html">Next: Format Converters</a>
+Dirk Zimoch, 2018
+</footer>
 </body>
 </html>

docs/recordinterface.html

@@ -0,0 +1,328 @@
+<!DOCTYPE HTML>
+<html lang="en">
+<head>
+<title>StreamDevice: Record API</title>
+<meta charset="utf-8" />
+<link rel="shortcut icon" href="favicon.ico" />
+<link rel="stylesheet" type="text/css" href="stream.css" />
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<meta name="author" content="Dirk Zimoch" />
+</head>
+<body>
+<iframe src="nav.html" id="navleft"></iframe>
+<h1>Record API</h1>
+
+<a name="theory"></a>
+<h2>Theory of Operation</h2>
+<p>
+<em>StreamDevice</em> implements the generic part of an EPICS device support.
+However it cannot know the internals of a specific record type, such as the
+.VAL or .RVAL fields or the .INP or .OUT links. It can only access a record
+as dbCommon. Thus it is necessary to write an interface for each record type
+which takes care of these details.
+</p>
+<p>
+A record interface consists of three functions, <code>readData()</code> and
+<code>writeData()</code> and <code>initRecord()</code>.
+</p>
+The record interface also implements the device support structure for this
+record type. Most of its functions will be generic <em>StreamDevice</em>
+functions. The exception is <code>initRecord()</code>. 
+</p>
+<p>
+The name of the device support structure must have the form
+<code>dev<var>recordtype</var>Stream</code> and the name of the record
+interface source code file must be
+<code>dev<var>recordtype</var>Stream.c</code> to work seamlessly with the
+build system implemented in the Makefile of <em>StreamDevice</em>.
+</p>
+<p>
+Finally add <code><var>recordtype</var></code> to the
+<code>RECORDTYPES</code> variable in the file src/CONFIG_STREAM
+and rebuild.
+</p>
+<a name="headers"></a>
+<h3>Headers to Include</h2>
+<p>
+A record interface typically <code>#include</code>s the header file
+for the supported record type, <code>"<var>recordtype</var>Record.h"</code>
+and <code>"devStream.h"</code>.
+For many record interfaces this is sufficient, but sometimes additional
+header files may be needed.
+</p>
+
+<a name="functions"></a>
+<h3>Functions to Implement</h2>
+<p>
+A record interface has to implement three functions:
+</p>
+<div class="indent"><code>
+static long readData(dbCommon&nbsp;*record, format_t&nbsp;*format);
+</code></div>
+<div class="indent"><code>
+static long writeData(dbCommon&nbsp;*record, format_t&nbsp;*format);
+</code></div>
+<div class="indent"><code>
+static long initRecord(dbCommon&nbsp;*record);
+</code></div>
+
+<h4>writeData</h4>
+<p>
+The function <code>writeData()</code> is called whenever a
+<a href="protocol.html#proto">protocol</a> needs
+to handle a prining <a href="formats.html">format converter</a>
+(without <a href="formats.html#redirection">redirection</a>),
+typically in an <code>out</code> command.
+It is also possible that <code>writeData()</code> is called for an input
+record, e.g. when the <a href="formats.html#syntax"><code>=</code>&nbsp;flag</a>
+is used in an <code>in</code> command.
+Thus implement this function for input records as well.
+</p>
+<p>
+The functions is called with a <code>dbCommon *record</code> argument,
+which the function should cast to the specific record type to get
+access to the record specific fields, in particular .VAL and .RVAL.
+</p>
+<p>
+The second argument, <code>format_t&nbsp;*format</code>, contains information
+about the format converter. The only field of interest in this argument
+is <code>format->type</code> which specifies the data type of the format
+conversion. Its value is one of <code>DBF_ULONG</code>,
+<code>DBF_ULONG</code>, <code>DBF_ENUM</code>, <code>DBF_DOUBLE</code>,
+or <code>DBF_STRING</code>.
+</p>
+<p>
+The <code>writeData()</code> function may access different fields depending
+on <code>format->type</code>, e.g. .VAL for <code>DBF_DOUBLE</code> but
+.RVAL for <code>DBF_LONG</code>.
+It also may interpret the fields in a different way, e.g. cast to
+<code>long</code> for <code>DBF_LONG</code> but to <code>unsigned long</code>
+for <code>DBF_ULONG</code>.
+This is typically done with a <code>switch(format->type)</code> statement.
+</p>
+<p>
+The function may refuse to handle <code>format->type</code> values
+that make no sense for the record type, e.g. <code>DBF_STRING</code> for a
+record type that cannot handle strings. In that case the function should
+return <code>ERROR</code>. It is a good idea to return <code>ERROR</code>
+in the <code>default</code> part of the <code>switch</code> statement.
+</p>
+<p>
+<em>StreamDevice</em> provides a function to output a value from the record:
+</p>
+<div class="indent"><code>
+long streamPrintf(dbCommon&nbsp;*record, format_t&nbsp;*format, ...);
+</code></div>
+<p>
+Once the correct record field and type cast has been chosen, the
+<code>writeData()</code> function calls
+<code>return streamPrintf(record, format, value)</code> where the type of
+value should match <code>field->type</code> (<code>long</code>, 
+<code>unsigned long</code>, <code>double</code>, or <code>char*</code>),
+returning the result of that call.
+</p>
+<p>
+<b>Example:</b>
+</p>
+<pre>
+static long writeData(dbCommon *record, format_t *format)
+{
+    <var>recordtype</var>Record *rec = (<var>recordtype</var>Record *)record;
+
+    switch (format->type)
+    {
+        case DBF_ULONG:
+        case DBF_ENUM:
+            return streamPrintf(record, format, (unsigned long)rec->rval);
+        case DBF_LONG:
+            return streamPrintf(record, format, (long)rec->rval);
+        case DBF_DOUBLE:
+            return streamPrintf(record, format, rec->val);
+        default:
+            return ERROR;
+    }
+}
+</pre>
+
+<h4>readData</h4>
+<p>
+The arguments of this function are the same as for <code>writeData()</code>.
+But this function stores a value into record fields depending on
+<code>format->type</code>.
+</p>
+<p>
+<em>StreamDevice</em> provides two functions to receive a value;
+</p>
+<div class="indent"><code>
+ssize_t streamScanf(dbCommon&nbsp;*record, format_t&nbsp;*format, void*&nbsp;value);
+</code></div>
+<div class="indent"><code>
+ssize_t streamScanfN(dbCommon&nbsp;*record, format_t&nbsp;*format, void*&nbsp;value, size_t&nbsp;maxStringSize);
+</code></div>
+<p>
+The argument <code>value</code> is a pointer to the variable where the value
+is to be stored. Its type must match <code>field->type</code>
+(<code>long*</code>, <code>unsigned long*</code>, <code>double*</code>, or
+<code>char*</code>).
+</p>
+<p>
+The <code>streamScanfN()</code> function is meant for strings and gets the
+additional argument <code>maxStringSize</code> to specify the size of the
+string buffer.
+</p>
+<p>
+The <code>streamScanf()</code> function is actually a macro calling
+<code>streamScanfN()</code> with <code>MAX_STRING_SIZE</code> (=40) for
+the last argument. For <code>field->type</code> values other than
+<code>DBF_STRING</code>, this argument is ignored.
+</p>
+<p>
+In case of strings, these functions return the number of characters
+actually stored (which may be less than <code>maxStringSize</code>).
+Some record types may want to store this value into a field of the record.
+</p>
+<p>
+The functions return <code>ERROR</code> on failure. In this case the
+<code>readData()</code> function should return <code>ERROR</code> as well.
+Otherwise the function should store the value received into the appropriate
+record field.
+</p>
+<p>
+If <code>record->pact</code> is <code>true</code>, the function
+should now return <code>OK</code> or <code>DO_NOT_CONVERT</code> (=2),
+depending on wheter conversion from .RVAL to .VAL should be left to the
+record or not.
+</p>
+<p>
+If <code>record->pact</code> is <code>false</code>, the record is curretly
+executing the <code>@init</code> handler. 
+This typically only affects output records.
+As the record is not processed by EPICS at this time, changes in fields would
+not trigger monitor updates.
+</p>
+<p>
+Also the record will not convert .RVAL to .VAL in this case, thus the
+<code>readData()</code> function should now convert .RVAL
+to .VAL as usually done by the record.
+</p>
+<p>
+In order to make monitors work properly, the <code>readData()</code> function
+should then first call <code>recGblResetAlarms()</code> and then call
+<code>db_post_events()</code> as needed. Usually the code
+from the record support function <code>monitor()</code> needs to be copied.
+Unfortunately the <code>monitor()</code> function of the record cannot be
+called directly because it is <code>static</code>.
+</p>
+<p>
+<b>Example:</b>
+</p>
+<pre>
+static long readData(dbCommon *record, format_t *format)
+{
+    <var>recordtype</var>Record *rec = (<var>recordtype</var>Record *)record;
+    unsigned long rval;
+    unsigned short monitor_mask;
+
+    switch (format->type)
+    {
+        case DBF_ULONG:
+        case DBF_LONG:
+        case DBF_ENUM:
+            if (streamScanf(record, format, &amp;rval) == ERROR) return ERROR;
+            rec->rval = rval;
+            if (record->pact) return OK;
+            /* emulate convertion to val */
+            rec->val = rval * rec->eslo + rec->eoff;
+            break;
+        case DBF_DOUBLE:
+            if (streamScanf(record, format, &amp;rec->val) == ERROR) return ERROR;
+            break;
+            if (record->pact) return DO_NOT_CONVERT;
+        default:
+            return ERROR;
+    }
+    /* In @init handler, no processing, enforce monitor updates. */
+    monitor_mask = recGblResetAlarms(record);
+    if (rec->oraw != rec->rval)
+    {
+        db_post_events(record, &amp;rec->rval, monitor_mask | DBE_VALUE | DBE_LOG);
+        rec->oraw = rec->rval;
+    }
+    if (!(fabs(rec->mlst - rec->val) <= rec->mdel))
+    {
+        monitor_mask |= DBE_VALUE;
+        ao->mlst = rec->val;
+    }
+    if (!(fabs(rec->alst - rec->val) <= rec->adel))
+    {
+        monitor_mask |= DBE_VALUE;
+        ao->alst = rec->val;
+    }
+    if (monitor_mask)
+        db_post_events(record, &amp;rec->val, monitor_mask);
+    return OK;
+}
+</pre>
+
+<h4>initRecord</h4>
+<p>
+The main purpose of this function is to pass the .INP or .OUT link to
+<em>StreamDevice</em> for parsing and to make the two functions
+<code>readData</code> and <code>writeData</code> known.
+Often the only thing the <code>initRecord()</code> function does is to call
+<code>streamInitRecord()</code> and return its result.
+</p>
+<div class="indent"><code>
+long streamInitRecord(dbCommon&nbsp;*record, const struct link&nbsp;*ioLink,
+    streamIoFunction&nbsp;readData, streamIoFunction&nbsp;writeData);
+</code></div>
+<pre>
+static long initRecord(dbCommon *record)
+{
+    <var>recordtype</var>Record *rec = (<var>recordtype</var>Record *)record;
+
+    return streamInitRecord(record, &amp;rec->out, readData, writeData);
+}
+</pre>
+
+<h3>Device Support Structure</h3>
+<p>
+For most record types the device support structure contains 5 functions,
+<code>report</code>, <code>init</code>, <code>init_record</code>,
+<code>get_ioint_info</code>, and <code>read</code> or <code>write</code>.
+Few other record typess, for examle ai and ao may have additional functions.
+For most of these functions simply pass one of the provided
+<em>StreamDevice</em> functions <code>streamReport</code>,
+<code>streamInit</code>, <code>streamGetIoInitInfo</code>, and
+<code>streamRead</code> or <code>streamWrite</code>.
+Only for <code>init_record</code> pass your own
+<code>initRecord</code> function. Then export the structure.
+</p>
+<pre>
+struct {
+    long number;
+    DEVSUPFUN report;
+    DEVSUPFUN init;
+    DEVSUPFUN init_record;
+    DEVSUPFUN get_ioint_info;
+    DEVSUPFUN write;
+} dev<var>recordtype</var>Stream = {
+    5,
+    streamReport,
+    streamInit,
+    initRecord,
+    streamGetIointInfo,
+    streamWrite
+};
+
+epicsExportAddress(dset,dev<var>recordtype</var>Stream);
+
+</pre>
+
+
+<footer>
+Dirk Zimoch, 2018
+</footer>
+</body>
+</html>
+ 

docs/recordtypes.html

@@ -1,15 +1,16 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
-    "http://www.w3.org/TR/html4/loose.dtd">
-<html>
+<!DOCTYPE HTML>
+<html lang="en">
 <head>
 <title>StreamDevice: Record Types</title>
-<link rel="shortcut icon" href="sls_icon.ico">
-<link rel="stylesheet" type="text/css" href="stream.css">
-<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-<meta name="author" content="Dirk Zimoch">
+<meta charset="utf-8" />
+<link rel="shortcut icon" href="favicon.ico" />
+<link rel="stylesheet" type="text/css" href="stream.css" />
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<meta name="author" content="Dirk Zimoch" />
 </head>
 <body>
-<h1>StreamDevice: Record Types</h1>
+<iframe src="nav.html" id="navleft"></iframe>
+<h1>Record Types</h1>
 
 <h2>Supported Record Types</h2>
 <p>
@@ -17,25 +18,32 @@
 in EPICS base which can have device support. 
 </p>
 <p>
-There is a separate page for each supported record type:<br>
+There is a separate page for each supported record type:
+</p>
+<p>
 <a href="aai.html">aai</a>
 <a href="aao.html">aao</a>
 <a href="ai.html">ai</a>
 <a href="ao.html">ao</a>
 <a href="bi.html">bi</a>
 <a href="bo.html">bo</a>
-<a href="mbbi.html">mbbi</a>
-<a href="mbbo.html">mbbo</a>
-<a href="mbbiDirect.html">mbbiDirect</a>
-<a href="mbboDirect.html">mbboDirect</a>
+<a href="calcout.html">calcout</a>
+<a href="int64in.html">int64in</a>
+<a href="int64out.html">int64out</a>
 <a href="longin.html">longin</a>
 <a href="longout.html">longout</a>
+<a href="lsi.html">lsi</a>
+<a href="lso.html">lso</a>
+<a href="mbbiDirect.html">mbbiDirect</a>
+<a href="mbboDirect.html">mbboDirect</a>
+<a href="mbbi.html">mbbi</a>
+<a href="mbbo.html">mbbo</a>
+<a href="scalcout.html">scalcout</a>
 <a href="stringin.html">stringin</a>
 <a href="stringout.html">stringout</a>
 <a href="waveform.html">waveform</a>
-<a href="calcout.html">calcout</a>
-<a href="scalcout.html">scalcout</a>
 </p>
+
 <p>
 Each page describes which record fields are used in input and output
 for different <a href="formats.html#types">format data types</a>
@@ -47,8 +55,8 @@ It is also possible to
 <a href="recordinterface.html">write support for other recordtypes</a>.
 </p>
 
-<hr>
-<p><small>Dirk Zimoch, 2005</small></p>
-<script src="stream.js" type="text/javascript"></script>
+<footer>
+Dirk Zimoch, 2018
+</footer>
 </body>
 </html>

docs/scalcout.html

@@ -1,20 +1,21 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
-    "http://www.w3.org/TR/html4/loose.dtd">
-<html>
+<!DOCTYPE HTML>
+<html lang="en">
 <head>
 <title>StreamDevice: scalcout Records</title>
-<link rel="shortcut icon" href="sls_icon.ico">
-<link rel="stylesheet" type="text/css" href="stream.css">
-<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-<meta name="author" content="Dirk Zimoch">
+<meta charset="utf-8" />
+<link rel="shortcut icon" href="favicon.ico" />
+<link rel="stylesheet" type="text/css" href="stream.css" />
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<meta name="author" content="Dirk Zimoch" />
 </head>
 <body>
-<h1>StreamDevice: scalcout Records</h1>
+<iframe src="nav.html" id="navleft"></iframe>
+<h1>scalcout Records</h1>
 
 <p>
 <b>Note:</b> The scalcout record is part of the <i>calc</i> module of
 the <a target="ex"
-href="http://www.aps.anl.gov/aod/bcda/synApps/index.php"
+href="https://www.aps.anl.gov/BCDA/synApps"
 ><em>synApps</em></a> package.
 Device support for scalcout records is only available for <i>calc</i>
 module release 2-4 or higher.
@@ -76,26 +77,31 @@ Different record fields are used for output and input. The variable
  present. All format converters work like in normal operation.
 </p>
 
-<hr>
-<p>
+<footer>
+<nav>
 <a href="aai.html">aai</a>
 <a href="aao.html">aao</a>
 <a href="ai.html">ai</a>
 <a href="ao.html">ao</a>
 <a href="bi.html">bi</a>
 <a href="bo.html">bo</a>
-<a href="mbbi.html">mbbi</a>
-<a href="mbbo.html">mbbo</a>
-<a href="mbbiDirect.html">mbbiDirect</a>
-<a href="mbboDirect.html">mbboDirect</a>
+<a href="calcout.html">calcout</a>
+<a href="int64in.html">int64in</a>
+<a href="int64out.html">int64out</a>
 <a href="longin.html">longin</a>
 <a href="longout.html">longout</a>
+<a href="lsi.html">lsi</a>
+<a href="lso.html">lso</a>
+<a href="mbbiDirect.html">mbbiDirect</a>
+<a href="mbboDirect.html">mbboDirect</a>
+<a href="mbbi.html">mbbi</a>
+<a href="mbbo.html">mbbo</a>
+<a href="scalcout.html">scalcout</a>
 <a href="stringin.html">stringin</a>
 <a href="stringout.html">stringout</a>
 <a href="waveform.html">waveform</a>
-<a href="calcout.html">calcout</a>
-</p>
-<p><small>Dirk Zimoch, 2005</small></p>
-<script src="stream.js" type="text/javascript"></script>
+</nav>
+Dirk Zimoch, 2018
+</footer>
 </body>
 </html>

docs/setup.html

@@ -0,0 +1,453 @@
+<!DOCTYPE HTML>
+<html lang="en">
+<head>
+<title>StreamDevice: Setup</title>
+<meta charset="utf-8" />
+<link rel="shortcut icon" href="favicon.ico" />
+<link rel="stylesheet" type="text/css" href="stream.css" />
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<meta name="author" content="Dirk Zimoch" />
+</head>
+<body>
+<iframe src="nav.html" id="navleft"></iframe>
+<h1>Setup</h1>
+
+<a name="pre"></a>
+<h2>1. Prerequisites</h2>
+<p>
+<em>StreamDevice</em> works with
+<a href="https://epics.anl.gov/base/index.php">EPICS base</a>
+versions from R3.14.6 on, tested up to 7.0.1.
+It also works (with limitations) with older
+<a href="https://www.aps.anl.gov/epics/base/R3-13.php">R3.13</a> 
+versions from R3.13.7 on.
+How to use <em>StreamDevice</em> with EPICS R3.13 is described on a
+<a href="epics3_13.html">separate page</a>.
+<p>
+Download and build the EPICS version of your choice first before continuing.
+</p>
+</p>
+<h3>Fix required for base R3.14.8.2 and earlier on Windows</h3>
+<p>
+Up to release R3.14.8.2, a fix in EPICS base is required to build
+<em>StreamDevice</em> on Windows (not cygwin).
+Add the following line to <kbd>src/iocsh/iocsh.h</kbd>
+and rebuild base.
+</p>
+<pre>
+epicsShareFunc int epicsShareAPI iocshCmd(const char *command);
+</pre>
+
+<h3>Downloading <em>StreamDevice</em></h3>
+The latest version of StreamDevice can be found on github:
+<a href="https://github.com/paulscherrerinstitute/StreamDevice"
+>https://github.com/paulscherrerinstitute/StreamDevice</a>.
+
+Either download a <a
+href="https://github.com/paulscherrerinstitute/StreamDevice/archive/master.zip
+">zip file</a> or clone the git repo:
+<pre>
+git clone https://github.com/paulscherrerinstitute/StreamDevice.git
+</pre>
+
+<h3>Configuration</h3>
+<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>
+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.
+</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:
+<pre>
+EPICS_BASE=/home/epics/base-3.16.1
+</pre>
+
+<h4>Support for <em>asynDriver</em></h4>
+<p>
+You most probably want to have <em>asynDriver</em> support included, because
+that is the standard way for <em>StreamDevice</em> to talk to hardware.
+First get and install
+<a href="https://www.aps.anl.gov/epics/modules/soft/asyn/"
+><em>asynDriver</em></a> version 4-3 or higher before you build
+<em>StreamDevice</em>.
+I have tested <em>StreamDevice</em> with <em>asynDriver</em> versions up to 4-30.
+Make sure that the <em>asyn</em> library can be found by adding the path to the
+<em>&lt;top&gt;</em> directory of your <em>asyn</em> installation to the
+<kbd>configure/RELEASE</kbd> file:
+<pre>
+ASYN=/home/epics/asyn4-30
+</pre>
+
+<h4>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"
+><em>sCalcout</em></a> record is part of <a
+href="https://www.aps.anl.gov/BCDA/synApps"
+><em>synApps</em></a>.
+If <em>streamDevice</em> should be built with support for this record,
+you have to install at least the <a
+href="https://epics.anl.gov/bcda/synApps/calc/calc.html"
+><em>calc</em> module</a> from <em>SynApps</em> first.
+Add references to the <kbd>RELEASE</kbd> file as shown here:
+<pre>
+CALC=/home/epics/synApps/calc-R3-6-1
+</pre>
+<p>
+Up to <em>calc</em> release R2-6 (<em>synApps</em> release R5_1),
+the <em>sCalcout</em> record needs a fix.
+(See separate <a href="scalcout.html"><em>scalcout</em> page</a>.)
+And the <em>calc</em> module had dependencies on other <em>SynApps</em>
+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>.
+</p>
+
+<h4>Support for regular expression matching</h4>
+<p>
+If you want to enable regular expression matching, you need the <em>PCRE</em> package.
+For most Linux systems, it is already installed.
+In that case tell <em>StreamDevice</em> the locations of the
+<em>PCRE</em> header file and library.
+However, the pre-installed package can only by used for the host architecture.
+Thus, add them not to <kbd>RELEASE</kbd> but to
+<kbd>RELEASE.Common.linux-x86</kbd> (if linux-x86 is your EPICS_HOST_ARCH).
+Be aware that different Linux distributions may locate the files in different
+directories.
+</p>
+<pre>
+PCRE_INCLUDE=/usr/include/pcre
+PCRE_LIB=/usr/lib
+</pre>
+<p>
+For 64 bit installations, the path to the library may be different:
+</p>
+<pre>
+PCRE_INCLUDE=/usr/include/pcre
+PCRE_LIB=/usr/lib64
+</pre>
+<p>
+A pre-compiled Windows version of <em>PCRE</em> is available at
+<a href="https://sourceforge.net/projects/gnuwin32/files/pcre/7.0/pcre-7.0.exe/download"
+>sourceforge</a>
+</p>
+<p>
+If you want to have <em>PCRE</em> support on platforms that don't support it natively,
+e.g. vxWorks, it is probably the easiest to build <em>PCRE</em> as an EPICS module.
+</p>
+<p>
+<h4>Building the <em>PCRE</em> package as an EPICS module</h4>
+<p>
+<ol>
+<li>
+Download the <em>PCRE</em> package from <a href="https://www.pcre.org">www.pcre.org</a>.
+</li>
+<li>
+Extract the <em>PCRE</em> package in the <kbd>&lt;top&gt;</kbd> directory of
+<em>StreamDevice</em> or create a separate <kbd>&lt;top&gt;</kbd> location using
+<code>makeBaseApp.pl</code>.
+</li>
+<li>
+Download this <a href="http://epics.web.psi.ch/software/streamdevice/pcre/Makefile"
+>Makefile</a> and this
+<a href="http://epics.web.psi.ch/software/streamdevice/pcre/fixforvxworks.pl"
+>fixforvxworks.pl</a> script and save them to the extracted pcre directory.
+</li>
+<li>
+Change into the pcre direcrory and run <code>perl fixforvxworks.pl</code>
+</li>
+<li>
+Run <code>make</code> (or <code>gmake</code>)
+</li>
+</ol>
+<p>
+Define the location of the pcre <kbd>&lt;top&gt;</kbd> in the RELEASE file for <em>StreamDevice</em>.
+</p>
+<pre>
+PCRE=/home/epics/pcre
+</pre>
+<p>
+Regular expressions are optional. If you don't want them, you don't need this.
+</p>
+
+<a name="lib"></a>
+<h2>2. Building <em>StreamDevice</em></h2>
+<p>
+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.
+</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>.
+</p>
+<p>
+Include the following lines in your application <kbd>Makefile</kbd>:
+</p>
+<pre>
+PROD_LIBS += stream
+PROD_LIBS += asyn
+PROD_LIBS += pcre
+</pre>
+<p>
+Include the following lines in your <kbd>xxxAppInclude.dbd</kbd> file to use
+<em>stream</em> and <em>asyn</em> with serial lines, IP sockets,
+and vxi11 ("GPIB over ethernet") support.
+</p>
+<pre>
+include "base.dbd"
+include "stream.dbd"
+include "asyn.dbd"
+registrar(drvAsynIPPortRegisterCommands)
+registrar(drvAsynSerialPortRegisterCommands)
+registrar(vxi11RegisterCommands)
+</pre>
+<p>
+You can find an example application in the <kbd>streamApp</kbd>
+subdirectory.
+</p>
+
+<a name="sta"></a>
+<h2>3. The Startup Script</h2>
+<p>
+<em>StreamDevice</em> is based on <a
+href="protocol.html"><em>protocol files</em></a>.
+To tell <em>StreamDevice</em> where to search for protocol files,
+set the environment variable <code>STREAM_PROTOCOL_PATH</code> to a
+list of directories to search.
+On Unix and vxWorks systems, directories are separated by <code>:</code>,
+on Windows systems by <code>;</code>.
+The default value is <code>STREAM_PROTOCOL_PATH=.</code>,
+i.e. the current directory.
+</p>
+<p>
+Also configure the buses (in <em>asynDriver</em> terms: ports) you want
+to use with <em>StreamDevice</em>.
+You can give the buses any name you want, like <kbd>COM1</kbd> or
+<kbd>socket</kbd>, but I recommend to use names related to the
+connected device.
+</p>
+<h3>Example:</h3>
+<p>
+A device with serial communication (9600 baud, 8N1, no flow control) is
+connected to <kbd>/dev/ttyS1</kbd>.
+The name of the device shall be <tt>PS1</tt>.
+Protocol files are either in the current working directory or in the
+<kbd>../protocols</kbd> directory.
+</p>
+<p>
+Then the startup script may look like this:
+</p>
+<pre>
+epicsEnvSet ("STREAM_PROTOCOL_PATH", ".:../protocols")
+
+drvAsynSerialPortConfigure ("PS1","/dev/ttyS1")
+asynSetOption ("PS1", 0, "baud", "9600")
+asynSetOption ("PS1", 0, "bits", "8")
+asynSetOption ("PS1", 0, "parity", "none")
+asynSetOption ("PS1", 0, "stop", "1")
+asynSetOption ("PS1", 0, "clocal", "Y")
+asynSetOption ("PS1", 0, "crtscts", "N")
+</pre>
+
+<p>All above options are the defaults.
+Thus their usage in optional in this case.
+</p>
+<p>
+If the device uses hardware flow control, change the last two lines to:
+</p>
+<pre>
+asynSetOption ("PS1", 0, "clocal", "N")
+asynSetOption ("PS1", 0, "crtscts", "Y")
+</pre>
+<p>
+Newer versions of <em>asyn</em> also support software flow control
+(CTRL-S,CTRL-Q). If the device uses this, you may want to set:
+</p>
+<pre>
+asynSetOption ("PS1", 0, "ixon", "Y")
+asynSetOption ("PS1", 0, "ixany", "Y")
+</pre>
+
+<p>If the device was instead connected via telnet-style TCP/IP
+at address 192.168.164.10 on port 23,
+the startup script would contain:
+</p>
+<pre>
+epicsEnvSet ("STREAM_PROTOCOL_PATH", ".:../protocols")
+
+drvAsynIPPortConfigure ("PS1", "192.168.164.10:23")
+</pre>
+
+<p>
+With a VXI11 (GPIB via TCP/IP) connection, e.g. a
+HP E2050A on IP address 192.168.164.10, it would look like this:
+</p>
+<pre>
+epicsEnvSet ("STREAM_PROTOCOL_PATH", ".:../protocols")
+
+vxi11Configure ("PS1","192.168.164.10",1,1000,"hpib")
+</pre>
+
+
+<a name="pro"></a>
+<h2>4. The Protocol File</h2>
+<p>
+For each different type of hardware, create a protocol file
+which defines protocols for all needed functions of the device.
+The file name is arbitrary, but I recommend that it contains
+the device type.
+It must not contain spaces and should be short.
+During <code>iocInit</code>, <em>streamDevice</em> loads and parses
+the required protocol files.
+If the files contain errors, they are printed on the IOC shell.
+Put the protocol file in one of the directories listed in
+<code>STREAM_PROTOCOL_PATH</code>.
+</p>
+<h3>Example:</h3>
+<p>
+<tt>PS1</tt> is an <em>ExamplePS</em> power supply.
+It communicates via ASCII strings which are terminated by
+&lt;carriage&nbsp;return&gt; &lt;line&nbsp;feed&gt; (ASCII codes 13, 10).
+The output current can be set by sending a string like
+<code>"CURRENT 5.13"</code>.
+When asked with the string <code>"CURRENT?"</code>, the device returns
+the last set value in a string like <code>"CURRENT 5.13 A"</code>.
+</p>
+<p>
+Normally, an analog output record should write its value to the device.
+But during startup, the record should be initialized from the the device.
+The protocol file <kbd>ExamplePS.proto</kbd> defines the protocols
+<code>getCurrent</code> and <code>setCurrent</code>.
+</p>
+<pre>
+Terminator = CR LF;
+
+getCurent {
+        out "CURRENT?";
+        in "CURRENT %f A";
+    }
+
+setCurrent {
+    out "CURRENT %.2f";
+    @init {
+        getCurent;
+    }
+}
+</pre>
+
+<a name="reload"></a>
+<h3>Reloading the Protocol File</h3>
+<p>
+During development, the protocol files might change frequently.
+To prevent restarting the IOC all the time, it is possible to reload
+the protocol file of one or all records with the shell function
+<code>streamReload("<var>record</var>")</code>.
+If <code>"<var>record</var>"</code> is not given
+<span class="new">or empty</span>, all records using
+<em>StreamDevice</em> reload their protocols.
+<span class="new">In EPICS 3.14 or higher,
+<code><var>record</var></code> can be a glob pattern.</span>
+</p>
+<p>
+Furthermore, the <code>streamReloadSub</code> function can be used
+with a subroutine record to reload all protocols.
+</p>
+<p>
+Reloading the protocol file aborts currently running protocols.
+This might set <code>SEVR=INVALID</code> and <code>STAT=UDF</code>.
+If a record can't reload its protocol file (e.g. because of a syntax
+error), it stays <code>INVALID</code>/<code>UDF</code> until a valid
+protocol is loaded.
+</p>
+
+<p>
+<span class="new">Reloading triggers an <code>@init</code>
+<a href="protocol.html#except">handler</a>.</span>
+See the <a href="protocol.html">next chapter</a> for protocol files in depth.
+</p>
+
+<a name="rec"></a>
+<h2>5. Configuring the Records</h2>
+<p>
+To tell a record to use <em>StreamDevice</em>, set its <code>DTYP</code> field to
+<code>"stream"</code>.
+</p>
+<p>
+The <code>INP</code> or <code>OUT</code> link has the form
+<code>"@<var>filename&nbsp;protocol</var>[(<var>arg1</var>,<var>arg2</var>,...)]&nbsp;</var>bus</var>&nbsp;[<var>address</var>&nbsp;[<var>parameters</var>]]"</code>.
+</p>
+<p>
+(Elements in <code>[]</code> are optional. Do not type the <code>[]</code>).
+</p>
+<p>
+Here, <code><var>filename</var></code> is the name of the protocol file and
+<code><var>protocol</var></code> is the name of a protocol defined in this file.
+(See the <a href="protocol.html">next chapter</a>.)
+</p>
+<p>
+If the protocol requires <a href="protocol.html#argvar">arguments</a>,
+specify them enclosed in parentheses:
+<code><var>protocol</var>(<var>arg1,arg2,...</var>)</code>.
+<span class="new">Spaces in the argument list are now allowed.
+The first space before and after an argument is ignored. Further spaces are
+considered part of the argument.</span>
+</p>
+<p>
+The communication channel is specified with <code><var>bus</var></code>
+(aka <em>asynDriver</em> "port") and <code><var>addr</var></code>.
+If the bus does not have addresses, <code><var>addr</var></code> may be skipped.
+Optional <code><var>parameters</var></code> are passed to the bus driver.
+(At the moment, no bus driver supports parameters.)
+</p>
+
+<h3>Example:</h3>
+<p>
+Create an input record to read and an output record to set the current of <tt>PS1</tt>.
+Use protocols <em>getCurrent</em> and <em>setCurrent</em> from file <em>ExamplePS.proto</em>.
+The bus is called <em>PS1</em> like the device.
+</p>
+
+<pre>
+record (ai, "PS1:I-get")
+{
+    field (DESC, "Read current of PS1")
+    <b>field (DTYP, "stream")</b>
+    <b>field (INP,  "@ExamplePS.proto getCurrent PS1")</b>
+    field (EGU,  "A")
+    field (PREC, "2")
+    field (LOPR, "0")
+    field (HOPR, "60")
+    field (PINI, "YES")
+    field (SCAN, "10 second")
+}
+record (ao, "PS1:I-set")
+{
+    field (DESC, "Set current of PS1")
+    <b>field (DTYP, "stream")</b>
+    <b>field (OUT,  "@ExamplePS.proto setCurrent PS1")</b>
+    field (EGU,  "A")
+    field (PREC, "2")
+    field (DRVL, "0")
+    field (DRVH, "60")
+    field (LOPR, "0")
+    field (HOPR, "60")
+}
+</pre>
+
+<footer>
+<a href="protocol.html">Next: Protocol Files</a>
+Dirk Zimoch, 2018
+</footer>
+</body>
+</html>

docs/stream.css

@@ -0,0 +1,154 @@
+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;
+    font-family: Helvetica, Arial, sans-serif;
+    font-size: 100%;
+    background-color:#ffffff;
+}
+
+a[name] { position:relative; top:-11ex;}
+
+pre {
+    background-color:#f4f4f4;
+    padding:1ex;
+    border:1px solid #000000;
+    white-space:pre;
+    margin:2ex;
+    page-break-inside:avoid;
+}
+
+kbd {
+    font-weight:bold;
+}
+
+dt {
+    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;
+}
+
+h2 {
+    font-size:150%;
+    margin-bottom:0.5ex;
+}
+
+h3 {
+    font-size:120%;
+    margin-bottom:0.25ex;
+}
+
+h4 {
+    font-size:100%;
+    margin-bottom:0.25ex;
+}
+
+p {
+    margin-top:0.75ex;
+    margin-bottom:0.75ex;
+}
+
+body h1 + p {
+    margin-top:1.5ex;
+    margin-bottom:0.75ex;
+}
+
+footer {
+    font-size:75%;
+    margin-top: 1em;
+    border-top: 1px solid darkgray;
+    padding-top: 1em;
+}
+
+footer a:only-of-type {
+    display: block;
+    position: absolute;
+    right: 1em;
+}
+
+small {
+    font-size:75%;
+}
+
+code {
+    font-size: 125%;
+    color: #008000;
+}
+
+.indent {
+    text-indent:-4ex;
+    margin-left:4ex;
+    margin-top:0.5ex;
+    text-align:left;
+}
+
+.box {
+    margin-left:1ex;
+    margin-right:1ex;
+    margin-top:0.5ex;
+    padding: 0 1ex;
+    border: 1px solid black;
+    text-align:left;
+    background-color:#f0f0f0;
+}
+
+#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;
+}
+
+.new {
+    background-color: #ffc;
+}
+
+a[target=ex]:after {
+  content:" " url(ex.png);
+}
+
+a[target=ex]:hover:after {
+  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;}
+}

docs/stringin.html

@@ -1,15 +1,16 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
-    "http://www.w3.org/TR/html4/loose.dtd">
-<html>
+<!DOCTYPE HTML>
+<html lang="en">
 <head>
 <title>StreamDevice: stringin Records</title>
-<link rel="shortcut icon" href="sls_icon.ico">
-<link rel="stylesheet" type="text/css" href="stream.css">
-<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-<meta name="author" content="Dirk Zimoch">
+<meta charset="utf-8" />
+<link rel="shortcut icon" href="favicon.ico" />
+<link rel="stylesheet" type="text/css" href="stream.css" />
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<meta name="author" content="Dirk Zimoch" />
 </head>
 <body>
-<h1>StreamDevice: stringin Records</h1>
+<iframe src="nav.html" id="navleft"></iframe>
+<h1>stringin Records</h1>
 
 <h2>Normal Operation</h2>
 <p>
@@ -42,26 +43,31 @@ written or read value.
  present. All format converters work like in normal operation.
 </p>
 
-<hr>
-<p>
+<footer>
+<nav>
 <a href="aai.html">aai</a>
 <a href="aao.html">aao</a>
 <a href="ai.html">ai</a>
 <a href="ao.html">ao</a>
 <a href="bi.html">bi</a>
 <a href="bo.html">bo</a>
-<a href="mbbi.html">mbbi</a>
-<a href="mbbo.html">mbbo</a>
-<a href="mbbiDirect.html">mbbiDirect</a>
-<a href="mbboDirect.html">mbboDirect</a>
+<a href="calcout.html">calcout</a>
+<a href="int64in.html">int64in</a>
+<a href="int64out.html">int64out</a>
 <a href="longin.html">longin</a>
 <a href="longout.html">longout</a>
+<a href="lsi.html">lsi</a>
+<a href="lso.html">lso</a>
+<a href="mbbiDirect.html">mbbiDirect</a>
+<a href="mbboDirect.html">mbboDirect</a>
+<a href="mbbi.html">mbbi</a>
+<a href="mbbo.html">mbbo</a>
+<a href="scalcout.html">scalcout</a>
+<a href="stringin.html">stringin</a>
 <a href="stringout.html">stringout</a>
 <a href="waveform.html">waveform</a>
-<a href="calcout.html">calcout</a>
-<a href="scalcout.html">scalcout</a>
-</p>
-<p><small>Dirk Zimoch, 2005</small></p>
-<script src="stream.js" type="text/javascript"></script>
+</nav>
+Dirk Zimoch, 2018
+</footer>
 </body>
 </html>

docs/stringout.html

@@ -1,15 +1,16 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
-    "http://www.w3.org/TR/html4/loose.dtd">
-<html>
+<!DOCTYPE HTML>
+<html lang="en">
 <head>
 <title>StreamDevice: stringout Records</title>
-<link rel="shortcut icon" href="sls_icon.ico">
-<link rel="stylesheet" type="text/css" href="stream.css">
-<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-<meta name="author" content="Dirk Zimoch">
+<meta charset="utf-8" />
+<link rel="shortcut icon" href="favicon.ico" />
+<link rel="stylesheet" type="text/css" href="stream.css" />
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<meta name="author" content="Dirk Zimoch" />
 </head>
 <body>
-<h1>StreamDevice: stringout Records</h1>
+<iframe src="nav.html" id="navleft"></iframe>
+<h1>stringout Records</h1>
 
 <h2>Normal Operation</h2>
 <p>
@@ -42,26 +43,31 @@ written or read value.
  present. All format converters work like in normal operation.
 </p>
 
-<hr>
-<p>
+<footer>
+<nav>
 <a href="aai.html">aai</a>
 <a href="aao.html">aao</a>
 <a href="ai.html">ai</a>
 <a href="ao.html">ao</a>
 <a href="bi.html">bi</a>
 <a href="bo.html">bo</a>
-<a href="mbbi.html">mbbi</a>
-<a href="mbbo.html">mbbo</a>
-<a href="mbbiDirect.html">mbbiDirect</a>
-<a href="mbboDirect.html">mbboDirect</a>
+<a href="calcout.html">calcout</a>
+<a href="int64in.html">int64in</a>
+<a href="int64out.html">int64out</a>
 <a href="longin.html">longin</a>
 <a href="longout.html">longout</a>
-<a href="stringin.html">stringin</a>
-<a href="waveform.html">waveform</a>
-<a href="calcout.html">calcout</a>
+<a href="lsi.html">lsi</a>
+<a href="lso.html">lso</a>
+<a href="mbbiDirect.html">mbbiDirect</a>
+<a href="mbboDirect.html">mbboDirect</a>
+<a href="mbbi.html">mbbi</a>
+<a href="mbbo.html">mbbo</a>
 <a href="scalcout.html">scalcout</a>
-</p>
-<p><small>Dirk Zimoch, 2005</small></p>
-<script src="stream.js" type="text/javascript"></script>
+<a href="stringin.html">stringin</a>
+<a href="stringout.html">stringout</a>
+<a href="waveform.html">waveform</a>
+</nav>
+Dirk Zimoch, 2018
+</footer>
 </body>
 </html>

docs/tipsandtricks.html

@@ -1,15 +1,16 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
-    "http://www.w3.org/TR/html4/loose.dtd">
-<html>
+<!DOCTYPE HTML>
+<html lang="en">
 <head>
 <title>StreamDevice: Tips and Tricks</title>
-<link rel="shortcut icon" href="sls_icon.ico">
-<link rel="stylesheet" type="text/css" href="stream.css">
-<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-<meta name="author" content="Dirk Zimoch">
+<meta charset="utf-8" />
+<link rel="shortcut icon" href="favicon.ico" />
+<link rel="stylesheet" type="text/css" href="stream.css" />
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<meta name="author" content="Dirk Zimoch" />
 </head>
 <body>
-<h1>StreamDevice: Tips and Tricks</h1>
+<iframe src="nav.html" id="navleft"></iframe>
+<h1>Tips and Tricks</h1>
 
 <a name="argvar"></a>
 <h2>I have many almost identical protocols</h2>
@@ -54,7 +55,7 @@ read {in "new value = %f";}
 <code>
 record (ai, "$(RECORD)") {<br>
 &nbsp;&nbsp;field (DTYP, "stream")<br>
-&nbsp;&nbsp;field (INP, "@(DEVICETYPE).proto read $(BUS)")<br>
+&nbsp;&nbsp;field (INP, "@$(DEVICETYPE).proto read $(BUS)")<br>
 &nbsp;&nbsp;field (SCAN, "I/O Intr")<br>
 }
 </code>
@@ -95,14 +96,14 @@ array_out {separator=", "; out "an array: (%.2f)";}
 The format <code>%.2f</code> is repeated for each element of the array.
 All elements are separated by <code>", "</code>.<br>
 Output will look like this:
+</p>
 <pre>
 an array: (3.14, 17.30, -12.34)
 </pre>
-</p>
 <h3>B) We have up to 12 numeric values</h3>
 <p>
 Use a <a href="calcout.html">calcout</a> record and
-<a href="formats.html#types">field references</a> in the format.
+<a href="formats.html#redirection">redirection to fields</a>.
 </p>
 <p>
 <code>
@@ -121,24 +122,24 @@ record (calcout, "$(RECORD)") {<br>
 &nbsp;&nbsp;field (INPC, "$(C_RECORD)")<br>
 &nbsp;&nbsp;field (CALC, "0")<br>
 &nbsp;&nbsp;field (DTYP, "stream")<br>
-&nbsp;&nbsp;field (OUT, "@(DEVICETYPE).proto write_ABC $(BUS)")<br>
+&nbsp;&nbsp;field (OUT, "@$(DEVICETYPE).proto write_ABC $(BUS)")<br>
 }
 </code>
 </p>
 <h3>C) Values are in other records on the same IOC</h3>
 <p>
-Use <a href="formats.html#types">record references</a> in the format.
+Use <a href="formats.html#redirection">redirection to records</a>.
 </p>
 <p>
 <code>
-acquire {out 'ACQUIRE "%(\$1:directory.VAL)s/%s",%(\$1:time.VAL).3f;';}
+acquire {out 'ACQUIRE "%(\$1:directory)s/%s",%(\$1:time).3f;';}
 </code>
 </p>
 <p>
-You must specify the full <code>record.FIELD</code> name,
-even for <code>VAL</code> fields.
-To avoid record names in protocol files use
-<a href="protocol.html#argvar">protocol arguments</a>.
+You can specify a record name or record.FIELD in parentheses directly
+after the <code>%</code>.
+To avoid plain record names in protocol files use
+<a href="protocol.html#argvar">protocol arguments</a> like <code>\$1</code>.
 In the link, specify the record name or just the basename of the
 other records (device name) in parentheses.
 </p>
@@ -146,7 +147,7 @@ other records (device name) in parentheses.
 <code>
 record (stringout, "$(DEVICE):getimage") {<br>
 &nbsp;&nbsp;field (DTYP, "stream")<br>
-&nbsp;&nbsp;field (OUT, "@(DEVICETYPE).proto acquire($(DEVICE)) $(BUS)")<br>
+&nbsp;&nbsp;field (OUT, "@$(DEVICETYPE).proto acquire($(DEVICE)) $(BUS)")<br>
 }
 </code>
 </p>
@@ -190,12 +191,12 @@ read_B {in "A=%*f, B=%f";}
 <code>
 record (ai, "$(DEVICE):A") {<br>
 &nbsp;&nbsp;field (DTYP, "stream")<br>
-&nbsp;&nbsp;field (INP, "@(DEVICETYPE).proto read_A $(BUS)")<br>
+&nbsp;&nbsp;field (INP, "@$(DEVICETYPE).proto read_A $(BUS)")<br>
 &nbsp;&nbsp;field (SCAN, "1 second")<br>
 }<br>
 record (ai, "$(DEVICE):B") {<br>
 &nbsp;&nbsp;field (DTYP, "stream")<br>
-&nbsp;&nbsp;field (INP, "@(DEVICETYPE).proto read_B $(BUS)")<br>
+&nbsp;&nbsp;field (INP, "@$(DEVICETYPE).proto read_B $(BUS)")<br>
 &nbsp;&nbsp;field (SCAN, "I/O Intr")<br>
 }
 </code>
@@ -215,20 +216,20 @@ Any non-matching input is ignored by record B.
 </p>
 <h3>C) Values should be stored in other records on the same IOC</h3>
 <p>
-Use <a href="formats.html#types">record references</a> in the format.
+Use <a href="formats.html#redirection">redirection to records</a>.
 To avoid record names in protocol files, use
 <a href="protocol.html#argvar">protocol arguments</a>.
 </p>
 <p>
 <code>
-read_AB {out "GET A,B"; in "A=%f, B=%(\$1.VAL)f";}
+read_AB {out "GET A,B"; in "A=%f, B=%(\$1)f";}
 </code>
 </p>
 <p>
 <code>
 record (ai, "$(DEVICE):A") {<br>
 &nbsp;&nbsp;field (DTYP, "stream")<br>
-&nbsp;&nbsp;field (INP, "@(DEVICETYPE).proto read_AB($(DEVICE):B) $(BUS)")<br>
+&nbsp;&nbsp;field (INP, "@$(DEVICETYPE).proto read_AB($(DEVICE):B) $(BUS)")<br>
 &nbsp;&nbsp;field (SCAN, "1 second")<br>
 }<br>
 record (ai, "$(DEVICE):B") {<br>
@@ -243,11 +244,11 @@ processes record B.
 </p>
 
 <a name="mixed"></a>
-<h2>I have a device that sends mixed data types: numbers and strings</h2>
+<h2>I have a device that sends mixed data types: numbers or strings</h2>
 <p>
 Use a <code>@mismatch</code>
 <a href="protocol.html#except">exception handler</a> and
-<a href="formats.html#types">record references</a> in the format.
+<a href="formats.html#redirection">redirection to records</a>.
 To avoid record names in protocol files, use
 <a href="protocol.html#argvar">protocol arguments</a>.
 </p>
@@ -259,14 +260,14 @@ When asked "<code>CURRENT?</code>", the device send something like
 </p>
 <p>
 <code>
-read_current {out "CURRENT?"; in "CURRENT %f A"; @mismatch {in "%(\1.VAL)39c";}}
+read_current {out "CURRENT?"; in "CURRENT %f A"; @mismatch {in "%(\$1)39c";}}
 </code>
 </p>
 <p>
 <code>
 record (ai, "$(DEVICE):readcurrent") {<br>
 &nbsp;&nbsp;field (DTYP, "stream")<br>
-&nbsp;&nbsp;field (INP, "@(DEVICETYPE).proto read_current($(DEVICE):message) $(BUS)")<br>
+&nbsp;&nbsp;field (INP, "@$(DEVICETYPE).proto read_current($(DEVICE):message) $(BUS)")<br>
 }<br>
 record (stringin, "$(DEVICE):message") {<br>
 }
@@ -280,7 +281,7 @@ With some more records, you can clean the message record if SEVR is not INVALID.
 <code>
 record (calcout, "$(DEVICE):clean_1") {<br>
 &nbsp;&nbsp;field (INPA, "$(DEVICE):readcurrent.SEVR CP")<br>
-&nbsp;&nbsp;field (CALC, "A!=2")<br>
+&nbsp;&nbsp;field (CALC, "A#3")<br>
 &nbsp;&nbsp;field (OOPT, "When Non-zero")<br>
 &nbsp;&nbsp;field (OUT,  "$(DEVICE):clean_2.PROC")<br>
 }<br>
@@ -288,10 +289,126 @@ record (stringout, "$(DEVICE):clean_2") {<br>
 &nbsp;&nbsp;field (VAL, "OK")<br>
 &nbsp;&nbsp;field (OUT,  "$(DEVICE):message PP")<br>
 }<br>
-
 </code>
-<hr>
-<p><small>Dirk Zimoch, 2007</small></p>
-<script src="stream.js" type="text/javascript"></script>
+<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.
+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).
+
+The web page you get often contains much more information than you need.
+<a href="formats.html#regex">Regular expressions</a> are great
+to find what you are looking for.
+</p>
+<h3>Example 1</h3>
+<p>
+Read the title of a web page.
+</p>
+<p>
+<code>
+get_title {<br>
+&nbsp;&nbsp;extrainput = ignore;<br>
+&nbsp;&nbsp;replyTimeout = 1000;<br>
+&nbsp;&nbsp;out "GET http://\$1\n\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 
+<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>.
+Note that web servers may be slow, so allow some
+<a href="protocol.html#argvar"><code>replyTimeout</code></a>.
+</p>
+<p>
+If you don't use an <code>inTerminator</code> then the whole page is
+read as one "line" to the <code>in</code> command and can be parsed easily
+with a regular expression.
+We want to see the string between <code>&lt;title&gt</code> and
+<code>&lt;/title&gt;</code>, so we put it into a subexpression in
+<code>()</code> and request the first subexpression with <code>.1</code>.
+Note that the <code>/</code> in the closing tag has be be escaped
+to avoid a misinterpretation as the closing <code>/</code> of the regular
+expression.
+</p>
+<p>
+The tags may be upper or lower case like <code>&lt;TITLE&gt;</code> or
+<code>&lt;Title&gt;</code>, so we ask for case insensitive matching with
+<code>(?i)</code>.
+</p>
+<p>
+The string should be terminated with the first closing
+<code>&lt;/title&gt;</code>, not the last one in the file.
+(There should not be more than one title but you never know.)
+Thus we ask not to be greedy with <code>(?m)</code>.
+<code>(?i)</code> and <code>(?m)</code> can be combined to <code>(?im)</code>.
+See the PCRE documentation for more regexp syntax.
+</p>
+<p>
+The regular expression matcher ignores and discards any content before the
+matching section.
+Content after the match is discarded with <code>extrainput = ignore</code>
+so that it does not trigger errors reporting "surplus input".
+</p>
+<p>
+Finally, the title may be too long for the record.
+The <code>+</code> tells the format matcher not to fail in this case
+but to truncate the string instead.
+You can read the string with a stringin record or for longer strings with
+a waveform record with data type CHAR.
+</p>
+<p>
+<code>
+record (stringin, "$(DEVICE):title") {<br>
+&nbsp;&nbsp;field (DTYP, "stream")<br>
+&nbsp;&nbsp;field (INP,  "@$(DEVICETYPE).proto get_title($(PAGE)) $(BUS)")<br>
+}<br>
+record (waveform, "$(DEVICE):longtitle") {<br>
+&nbsp;&nbsp;field (DTYP, "stream")<br>
+&nbsp;&nbsp;field (INP,  "@$(DEVICETYPE).proto get_title($(PAGE)) $(BUS)")<br>
+&nbsp;&nbsp;field (FTVL, "CHAR")<br>
+&nbsp;&nbsp;field (NELM, "100")<br>
+}<br>
+</code>
+</p>
+
+<h3>Example 2</h3>
+<p>
+Read a number from a web page. First we have to locate the number.
+For that we match against any known string right before the number
+(and <a href="formats.html#syntax">discard the match</a> with <code>*</code>).
+Then we read the number.
+</p>
+<code>
+get_title {<br>
+&nbsp;&nbsp;extrainput = ignore;<br>
+&nbsp;&nbsp;replyTimeout = 1000;<br>
+&nbsp;&nbsp;out "GET http://\$1\n\n";<br>
+&nbsp;&nbsp;in "%*/Interesting value:/%f more text";<br>
+}
+</code>
+<p>
+When using <code>extrainput = ignore;</code>, it is always a good idea to
+match a few bytes after the value, too.
+This catches errors where loading of the page is interrupted in the middle
+of the number. (You don't want to miss the exponent from something like 1.23E-14).
+</p>
+<p>
+You can read more than one value from a file with successive regular expressions
+and <a href="formats.html#redirection">redirections</a>.
+But this only works if the order of the values is predictible.
+<i>StreamDevice</i> is not an XML parser! It always reads sequentially.
+</p>
+
+<footer>
+Dirk Zimoch, 2018
+</footer>
 </body>
 </html>

docs/waveform.html

@@ -1,20 +1,21 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
-    "http://www.w3.org/TR/html4/loose.dtd">
-<html>
+<!DOCTYPE HTML>
+<html lang="en">
 <head>
 <title>StreamDevice: waveform Records</title>
-<link rel="shortcut icon" href="sls_icon.ico">
-<link rel="stylesheet" type="text/css" href="stream.css">
-<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-<meta name="author" content="Dirk Zimoch">
+<meta charset="utf-8" />
+<link rel="shortcut icon" href="favicon.ico" />
+<link rel="stylesheet" type="text/css" href="stream.css" />
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<meta name="author" content="Dirk Zimoch" />
 </head>
 <body>
-<h1>StreamDevice: waveform Records</h1>
+<iframe src="nav.html" id="navleft"></iframe>
+<h1>waveform Records</h1>
 
 <h2>Normal Operation</h2>
 <p>
 With waveform records, the format converter is applied to
-each element. Between the elements, a separator is printed
+each array element. Between the elements, a separator is printed
 or expected as specified by the <code>Separator</code>
 <a href="protocol.html#sysvar">variable</a> in the
 protocol.
@@ -36,6 +37,10 @@ written.
 <p>
 The format data type must be convertible to or from the type
 specified in the <code>FTVL</code> field.
+The types <code>"INT64"</code> and <code>"UINT64"</code> are
+only available in EPICS base version 3.16 or higher.
+</p>
+<p>
 The variable <code><i>x[i]</i></code> stands for one element of
 the written or read value.
 </p>
@@ -44,6 +49,7 @@ the written or read value.
   <dd>
    <u>Output:</u> <code><i>x[i]</i>=double(VAL[i])</code><br>
    <code>FTVL</code> can be <code>"DOUBLE"</code>, <code>"FLOAT"</code>,
+   <code>"INT64"</code>, <code>"UINT64"</code>,
    <code>"LONG"</code>, <code>"ULONG"</code>, <code>"SHORT"</code>,
    <code>"USHORT"</code>, <code>"CHAR"</code>, <code>"UCHAR"</code>,
    or <code>"ENUM"</code> (which is treated as <code>"USHORT"</code>).<br>
@@ -54,6 +60,7 @@ the written or read value.
   <dd>
    <u>Output:</u> <code><i>x[i]</i>=long(VAL[i])</code><br>
    <code>FTVL</code> can be 
+   <code>"INT64"</code>, <code>"UINT64"</code>,
    <code>"LONG"</code>, <code>"ULONG"</code>, <code>"SHORT"</code>,
    <code>"USHORT"</code>, <code>"CHAR"</code>, <code>"UCHAR"</code>,
    or <code>"ENUM"</code> (which is treated as <code>"USHORT"</code>).<br>
@@ -61,6 +68,7 @@ the written or read value.
    zero-extended to long before converting them.<br>
    <u>Input:</u> <code>VAL[i]=FTVL(<i>x[i])</i></code><br>
    <code>FTVL</code> can be <code>"DOUBLE"</code>, <code>"FLOAT"</code>,
+   <code>"INT64"</code>, <code>"UINT64"</code>,
    <code>"LONG"</code>, <code>"ULONG"</code>, <code>"SHORT"</code>,
    <code>"USHORT"</code>, <code>"CHAR"</code>, <code>"UCHAR"</code>,
    or <code>"ENUM"</code> (which is treated as <code>"USHORT"</code>).<br>
@@ -101,26 +109,31 @@ the written or read value.
  present. All format converters work like in normal operation.
 </p>
 
-<hr>
-<p>
+<footer>
+<nav>
 <a href="aai.html">aai</a>
 <a href="aao.html">aao</a>
 <a href="ai.html">ai</a>
 <a href="ao.html">ao</a>
 <a href="bi.html">bi</a>
 <a href="bo.html">bo</a>
-<a href="mbbi.html">mbbi</a>
-<a href="mbbo.html">mbbo</a>
-<a href="mbbiDirect.html">mbbiDirect</a>
-<a href="mbboDirect.html">mbboDirect</a>
+<a href="calcout.html">calcout</a>
+<a href="int64in.html">int64in</a>
+<a href="int64out.html">int64out</a>
 <a href="longin.html">longin</a>
 <a href="longout.html">longout</a>
+<a href="lsi.html">lsi</a>
+<a href="lso.html">lso</a>
+<a href="mbbiDirect.html">mbbiDirect</a>
+<a href="mbboDirect.html">mbboDirect</a>
+<a href="mbbi.html">mbbi</a>
+<a href="mbbo.html">mbbo</a>
+<a href="scalcout.html">scalcout</a>
 <a href="stringin.html">stringin</a>
 <a href="stringout.html">stringout</a>
-<a href="calcout.html">calcout</a>
-<a href="scalcout.html">scalcout</a>
-</p>
-<p><small>Dirk Zimoch, 2005</small></p>
-<script src="stream.js" type="text/javascript"></script>
+<a href="waveform.html">waveform</a>
+</nav>
+Dirk Zimoch, 2018
+</footer>
 </body>
 </html>

src/BCDConverter.cc

@@ -5,7 +5,7 @@
 * (C) 2005 Dirk Zimoch (dirk.zimoch@psi.ch)                    *
 *                                                              *
 * This is the BCD format converter of StreamDevice.            *
-* Please refer to the HTML files in ../doc/ for a detailed     *
+* 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   *
@@ -27,76 +27,67 @@ class BCDConverter : public StreamFormatConverter
 {
     int parse (const StreamFormat&, StreamBuffer&, const char*&, bool);
     bool printLong(const StreamFormat&, StreamBuffer&, long);
-    int scanLong(const StreamFormat&, const char*, long&);
+    ssize_t scanLong(const StreamFormat&, const char*, long&);
 };
 
 int BCDConverter::
-parse(const StreamFormat&, StreamBuffer&, const char*&, bool)
+parse(const StreamFormat& fmt, StreamBuffer&, const char*&, bool)
 {
-    return long_format;
+    return (fmt.flags & sign_flag) ? signed_format : unsigned_format;
 }
 
 bool BCDConverter::
 printLong(const StreamFormat& fmt, StreamBuffer& output, long value)
 {
-    unsigned char bcd[6]={0,0,0,0,0,0}; // sufficient for 2^32
-    int i;
-    int prec = fmt.prec; // number of nibbles
-    if (prec == -1)
-    {
-        prec = 2 * sizeof (value);
-    }
-    int width = (prec + (fmt.flags & sign_flag ? 2 : 1)) / 2;
+    unsigned char bcd;
+    long i, d, s;
+    unsigned long prec = fmt.prec < 0 ? 2 * sizeof(value) : fmt.prec; // number of nibbles
+    unsigned long width = (prec + (fmt.flags & sign_flag ? 2 : 1)) / 2;
+    unsigned long val = value;
+
+    output.append('\0', width);
     if (fmt.width > width) width = fmt.width;
     if (fmt.flags & sign_flag && value < 0)
-    {
-        // negative BCD value, I hope "F" as "-" is OK
-        bcd[5] = 0xF0;
-        value = -value;
-    }
-    if (prec > 10) prec = 10;
-    for (i = 0; i < prec; i++)
-    {
-        bcd[i/2] |= (value % 10) << (4 * (i & 1));
-        value /= 10;
-    }
+        val = -value;
     if (fmt.flags & alt_flag)
     {
-        // least significant byte first (little endian)
-        for (i = 0; i < (prec + 1) / 2; i++)
-        {
-            output.append(bcd[i]);
-        }
-        for (; i < width; i++)
-        {
-            output.append('\0');
-        }
-        output[-1] |=  bcd[5];
+        i = -(long)width;
+        d = 1;
+        s = -1;
     }
     else
     {
-        // most significant byte first (big endian)
-        int firstbyte = output.length();
-        for (i = 0; i < width - (prec + 1) / 2; i++)
-        {
-            output.append('\0');
+        i = -1;
+        d = -1;
+        s = -(long)width;
     }
-        for (i = (prec - 1) / 2; i >= 0; i--)
+    while (width && prec)
     {
-            output.append(bcd[i]);
+        width--;
+        bcd = val%10;
+        if (--prec)
+        {
+            --prec;
+            val /= 10;
+            bcd |= (val%10)<<4;
+            val /= 10;
         }
-        output[firstbyte] |= bcd[5];
+        output[i] = bcd;
+        i += d;
+    }
+    if (fmt.flags & sign_flag && value < 0) {
+        output[s] |= 0xf0;
     }
     return true;
 }
 
-int BCDConverter::
+ssize_t BCDConverter::
 scanLong(const StreamFormat& fmt, const char* input, long& value)
 {
-    int length = 0;
-    int val = 0;
+    ssize_t consumed = 0;
+    long val = 0;
     unsigned char bcd1, bcd10;
-    int width = fmt.width;
+    long width = fmt.width;
     if (width == 0) width = 1;
     if (fmt.flags & alt_flag)
     {
@@ -104,7 +95,8 @@ scanLong(const StreamFormat& fmt, const char* input, long& value)
         int shift = 1;
         while (width--)
         {
-            bcd1 = bcd10 = (unsigned char) input[length++];
+            bcd1 = input[consumed++];
+            bcd10 = bcd1>>4;
             bcd1 &= 0x0F;
             bcd10 >>= 4;
             if (bcd1 > 9 || shift * bcd1 < bcd1) break;
@@ -127,10 +119,10 @@ scanLong(const StreamFormat& fmt, const char* input, long& value)
         while (width--)
         {
             long temp;
-            bcd1 = bcd10 = (unsigned char) input[length];
+            bcd1 = input[consumed];
+            bcd10 = bcd1>>4;
             bcd1 &= 0x0F;
-            bcd10 >>= 4;
-            if (length == 0 && fmt.flags & sign_flag && bcd10)
+            if (consumed == 0 && fmt.flags & sign_flag && bcd10)
             {
                 sign = -1;
                 bcd10 = 0;
@@ -139,17 +131,17 @@ scanLong(const StreamFormat& fmt, const char* input, long& value)
             temp = val * 100 + (bcd1 + 10 * bcd10);
             if (temp < val)
             {
-                length = 0;
+                consumed = 0;
                 break;
             }
             val = temp;
-            length++;
+            consumed++;
         }
         val *= sign;
     }
-    if (length == 0) return -1;
+    if (consumed == 0) return -1;
     value = val;
-    return length;
+    return consumed;
 }
 
 RegisterConverter (BCDConverter, "D");

src/BinaryConverter.cc

@@ -5,7 +5,7 @@
 * (C) 2005 Dirk Zimoch (dirk.zimoch@psi.ch)                    *
 *                                                              *
 * This is the binary format converter of StreamDevice.         *
-* Please refer to the HTML files in ../doc/ for a detailed     *
+* 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   *
@@ -19,6 +19,7 @@
 ***************************************************************/
 
 #include <ctype.h>
+#include <limits.h>
 #include "StreamFormatConverter.h"
 #include "StreamError.h"
 
@@ -28,15 +29,20 @@ class BinaryConverter : public StreamFormatConverter
 {
     int parse(const StreamFormat&, StreamBuffer&, const char*&, bool);
     bool printLong(const StreamFormat&, StreamBuffer&, long);
-    int scanLong(const StreamFormat&, const char*, long&);
+    ssize_t scanLong(const StreamFormat&, const char*, long&);
 };
 
 int BinaryConverter::
-parse(const StreamFormat& format, StreamBuffer& info,
+parse(const StreamFormat& fmt, StreamBuffer& info,
     const char*& source, bool)
 {
-    if (format.conv == 'B')
+    if (fmt.conv == 'b')
     {
+        // default characters 0 and 1 for %b
+        info.append("01");
+        return unsigned_format;
+    }
+
     // user defined characters for %B (next 2 in source)
     if (*source)
     {
@@ -46,40 +52,43 @@ parse(const StreamFormat& format, StreamBuffer& info,
         {
             if (*source == esc) source++;
             info.append(*source++);
-                return long_format;
+            return unsigned_format;
         }
     }
     error("Missing characters after %%B format conversion\n");
     return false;
 }
-    // default characters for %b
-    info.append("01");
-    return long_format;
-}
 
 bool BinaryConverter::
-printLong(const StreamFormat& format, StreamBuffer& output, long value)
+printLong(const StreamFormat& fmt, StreamBuffer& output, long value)
 {
-    int prec = format.prec;
+    int prec = fmt.prec;
     if (prec == -1)
     {
-        // find number of significant bits
-        prec = sizeof (value) * 8;
-        while (prec && (value & (1 << (prec - 1))) == 0) prec--;
+        // Find number of significant bits is nothing is specified.
+        unsigned long x = (unsigned long) value;
+        prec = 32;
+#if (LONG_BIT > 32)
+        if (x > 0xFFFFFFFF)  { prec = 64;  x >>=32; }
+#endif
+        if (x <= 0x0000FFFF) { prec -= 16; x <<=16; }
+        if (x <= 0x00FFFFFF) { prec -= 8; x <<=8; }
+        if (x <= 0x0FFFFFFF) { prec -= 4; x <<=4; }
+        if (x <= 0x3FFFFFFF) { prec -= 2; x <<=2; }
+        if (x <= 0x7FFFFFFF) { prec -= 1; }
     }
-    if (prec == 0) prec++; // print at least one bit
-    int width = prec;
-    if (format.width > width) width = format.width;
-    char zero = format.info[0];
-    char one = format.info[1];
-    char fill = (format.flags & zero_flag) ? zero : ' ';
-    if (format.flags & alt_flag)
+    unsigned long width = prec;
+    if (fmt.width > width) width = fmt.width;
+    char zero = fmt.info[0];
+    char one = fmt.info[1];
+    char fill = (fmt.flags & zero_flag) ? zero : ' ';
+    if (fmt.flags & alt_flag)
     {
-        // little endian (least significan bit first)
-        if (!(format.flags & left_flag))
+        // little endian (least significant bit first)
+        if (!(fmt.flags & left_flag))
         {
             // pad left
-            while (width > prec)
+            while (width > (unsigned int)prec)
             {
                 output.append(' ');
                 width--;
@@ -99,11 +108,11 @@ printLong(const StreamFormat& format, StreamBuffer& output, long value)
     }
     else
     {
-        // big endian (most significan bit first)
-        if (!(format.flags & left_flag))
+        // big endian (most significant bit first)
+        if (!(fmt.flags & left_flag))
         {
             // pad left
-            while (width > prec)
+            while (width > (unsigned int)prec)
             {
                 output.append(fill);
                 width--;
@@ -111,7 +120,7 @@ printLong(const StreamFormat& format, StreamBuffer& output, long value)
         }
         while (prec--)
         {
-            output.append((value & (1 << prec)) ? one : zero);
+            output.append((value & (1L << prec)) ? one : zero);
             width--;
         }
         while (width--)
@@ -123,38 +132,39 @@ printLong(const StreamFormat& format, StreamBuffer& output, long value)
     return true;
 }
 
-int BinaryConverter::
-scanLong(const StreamFormat& format, const char* input, long& value)
+ssize_t BinaryConverter::
+scanLong(const StreamFormat& fmt, const char* input, long& value)
 {
     long val = 0;
-    int width = format.width;
+    long width = fmt.width;
     if (width == 0) width = -1;
-    int length = 0;
-    while (isspace(input[length])) length++; // skip whitespaces
-    char zero = format.info[0];
-    char one = format.info[1];
-    if (input[length] != zero && input[length] != one) return -1;
-    if (format.flags & alt_flag)
+    size_t consumed = 0;
+    char zero = fmt.info[0];
+    char one = fmt.info[1];
+    if (!isspace(zero) && !isspace(one))
+        while (isspace(input[consumed])) consumed++; // skip whitespaces
+    if (input[consumed] != zero && input[consumed] != one) return -1;
+    if (fmt.flags & alt_flag)
     {
         // little endian (least significan bit first)
         long mask = 1;
-        while (width-- && (input[length] == zero || input[length] == one))
+        while (width-- && (input[consumed] == zero || input[consumed] == one))
         {
-            if (input[length++] == one) val |= mask;
+            if (input[consumed++] == one) val |= mask;
             mask <<= 1;
         }
     }
     else
     {
         // big endian (most significan bit first)
-        while (width-- && (input[length] == zero || input[length] == one))
+        while (width-- && (input[consumed] == zero || input[consumed] == one))
         {
             val <<= 1;
-            if (input[length++] == one) val |= 1;
+            if (input[consumed++] == one) val |= 1;
         }
     }
     value = val;
-    return length;
+    return consumed;
 }
 
 RegisterConverter (BinaryConverter, "bB");

src/CONFIG_STREAM

@@ -1,35 +1,50 @@
-# Want debugging?
-# HOST_OPT = NO
-
 # You may add more record interfaces
 # This requires the naming conventions
-# dev$(RECORD)Stream.c
+# dev$(RECORDTYPE)Stream.c
 
-RECORDS += ao ai
-RECORDS += bo bi
-RECORDS += mbbo mbbi
-RECORDS += mbboDirect mbbiDirect
-RECORDS += longout longin
-RECORDS += stringout stringin
-RECORDS += waveform
-RECORDS += calcout
-#RECORDS += aai aao
+RECORDTYPES += ao ai
+RECORDTYPES += bo bi
+RECORDTYPES += mbbo mbbi
+RECORDTYPES += mbboDirect mbbiDirect
+RECORDTYPES += longout longin
+RECORDTYPES += stringout stringin
+RECORDTYPES += waveform
+RECORDTYPES += aai aao
+
+ifdef BASE_3_14
+RECORDTYPES += calcout
+endif
+
+ifdef BASE_3_15
+RECORDTYPES += lsi lso
+endif
+
+ifdef BASE_3_16
+RECORDTYPES += int64in int64out
+endif
 
 # Do you have synApps and want support for scalcout?
 # Then define CALC or SYNAPPS in your RELEASE file
 # pointing to the 'calc' module of synApps.
-# Due to strange cross dependencies in synApps
-# you have to build the 'sscan' and 'genSub'
-# modules before building 'calc'.
-# See doc/scalcout.html for a required fix in scalcout.
-SYNAPPS_RECORDS += scalcout
+# Older 'calc' versions have a cross reference on
+# 'sscan' and/or 'genSub', so you may have to build them first.
+# Up to version 2-6 (synApps 5-1) the 'calc' module needs a fix.
+# See doc/scalcout.html for details.
+ifneq ($(words $(CALC) $(SYNAPPS)), 0)
+RECORDTYPES += scalcout
+endif
 
 # You may add more bus interfaces
 # This requires the naming convention
 # $(BUS)Interface.cc
 # asynDriver interface is added automatically
 # if ASYN is defined in your RELEASE file.
-# BUSSES += Debug
+
+BUSSES += Debug
+BUSSES += Dummy
+ifdef ASYN
+BUSSES += AsynDriver
+endif
 
 # You may add more format converters
 # This requires the naming convention
@@ -38,10 +53,11 @@ SYNAPPS_RECORDS += scalcout
 FORMATS += Enum
 FORMATS += BCD
 FORMATS += Raw
+FORMATS += RawFloat
 FORMATS += Binary
 FORMATS += Checksum
-FORMATS += Exponential
-FORMATS += RawFloat
+FORMATS += MantissaExponent
+FORMATS += Timestamp
 
 # Want Perl regular expression matching?
 # If PCRE is installed at the same location for all
@@ -66,10 +82,6 @@ endif
 # by "static IoccrfReg iocshReg;"
 # LOADABLE_MODULE = YES
 
-# Want to add some memory tracing
-# to find memory leaks?
-# USE_MEMGUARD = YES
-
 # Sources of Stream Kernel
 # Do not modify
 

src/ChecksumConverter.cc

@@ -2,10 +2,10 @@
 * StreamDevice Support                                         *
 *                                                              *
 * (C) 1999 Dirk Zimoch (zimoch@delta.uni-dortmund.de)          *
-* (C) 2006 Dirk Zimoch (dirk.zimoch@psi.ch)                    *
+* (C) 2006-2018 Dirk Zimoch (dirk.zimoch@psi.ch)               *
 *                                                              *
 * This is the checksum pseudo-converter of StreamDevice.       *
-* Please refer to the HTML files in ../doc/ for a detailed     *
+* 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   *
@@ -20,19 +20,40 @@
 
 #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
+#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 <epicsString.h>
+#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
-#include <ctype.h>
+#endif
 
-typedef unsigned long ulong;
-typedef unsigned char uchar;
+typedef uint32_t (*checksumFunc)(const uint8_t* data, size_t len,  uint32_t init);
 
-typedef ulong (*checksumFunc)(const uchar* data, ulong len, ulong init);
-
-static ulong sum(const uchar* data, ulong len, ulong sum)
+static uint32_t sum(const uint8_t* data, size_t len, uint32_t sum)
 {
     while (len--)
     {
@@ -41,7 +62,7 @@ static ulong sum(const uchar* data, ulong len, ulong sum)
     return sum;
 }
 
-static ulong xor8(const uchar* data, ulong len, ulong sum)
+static uint32_t xor8(const uint8_t* data, size_t len, uint32_t sum)
 {
     while (len--)
     {
@@ -50,15 +71,15 @@ static ulong xor8(const uchar* data, ulong len, ulong sum)
     return sum;
 }
 
-static ulong xor7(const uchar* data, ulong len, ulong sum)
+static uint32_t xor7(const uint8_t* data, size_t len, uint32_t sum)
 {
     return xor8(data, len, sum) & 0x7F;
 }
 
-static ulong crc_0x07(const uchar* data, ulong len, ulong crc)
+static uint32_t crc_0x07(const uint8_t* data, size_t len, uint32_t crc)
 {
     // x^8 + x^2 + x^1 + x^0 (0x07)
-    const static uchar table[256] = {
+    const uint8_t table[256] = {
         0x00, 0x07, 0x0E, 0x09, 0x1C, 0x1B, 0x12, 0x15,
         0x38, 0x3F, 0x36, 0x31, 0x24, 0x23, 0x2A, 0x2D,
         0x70, 0x77, 0x7E, 0x79, 0x6C, 0x6B, 0x62, 0x65,
@@ -96,10 +117,10 @@ static ulong crc_0x07(const uchar* data, ulong len, ulong crc)
     return crc;
 }
 
-static ulong crc_0x31(const uchar* data, ulong len, ulong crc)
+static uint32_t crc_0x31(const uint8_t* data, size_t len, uint32_t crc)
 {
     // x^8 + x^5 + x^4 + x^0 (0x31)
-    const static uchar table[256] = {
+    const uint8_t table[256] = {
         0x00, 0x5e, 0xbc, 0xe2, 0x61, 0x3f, 0xdd, 0x83,
         0xc2, 0x9c, 0x7e, 0x20, 0xa3, 0xfd, 0x1f, 0x41,
         0x9d, 0xc3, 0x21, 0x7f, 0xfc, 0xa2, 0x40, 0x1e,
@@ -137,10 +158,10 @@ static ulong crc_0x31(const uchar* data, ulong len, ulong crc)
     return crc;
 }
 
-static ulong crc_0x8005(const uchar* data, ulong len, ulong crc)
+static uint32_t crc_0x8005(const uint8_t* data, size_t len, uint32_t crc)
 {
     // x^16 + x^15 + x^2 + x^0  (0x8005)
-    const static unsigned short table[256] = {
+    const uint16_t table[256] = {
         0x0000, 0x8005, 0x800f, 0x000a, 0x801b, 0x001e, 0x0014, 0x8011,
         0x8033, 0x0036, 0x003c, 0x8039, 0x0028, 0x802d, 0x8027, 0x0022,
         0x8063, 0x0066, 0x006c, 0x8069, 0x0078, 0x807d, 0x8077, 0x0072,
@@ -178,11 +199,11 @@ static ulong crc_0x8005(const uchar* data, ulong len, ulong crc)
     return crc;
 }
 
-static ulong crc_0x8005_r(const uchar* data, ulong len, ulong crc)
+static uint32_t crc_0x8005_r(const uint8_t* data, size_t len, uint32_t crc)
 {
     // x^16 + x^15 + x^2 + x^0  (0x8005)
     // reflected
-    const static unsigned short table[256] = {
+    const uint16_t table[256] = {
         0x0000, 0xC0C1, 0xC181, 0x0140, 0xC301, 0x03C0, 0x0280, 0xC241,
         0xC601, 0x06C0, 0x0780, 0xC741, 0x0500, 0xC5C1, 0xC481, 0x0440,
         0xCC01, 0x0CC0, 0x0D80, 0xCD41, 0x0F00, 0xCFC1, 0xCE81, 0x0E40,
@@ -220,10 +241,10 @@ static ulong crc_0x8005_r(const uchar* data, ulong len, ulong crc)
     return crc;
 }
 
-static ulong crc_0x1021(const uchar* data, ulong len, ulong crc)
+static uint32_t crc_0x1021(const uint8_t* data, size_t len, uint32_t crc)
 {
     // x^16 + x^12 + x^5 + x^0 (0x1021)
-    const static unsigned short table[256] = {
+    const uint16_t table[256] = {
       0x0000, 0x1021, 0x2042, 0x3063, 0x4084, 0x50A5, 0x60C6, 0x70E7,
       0x8108, 0x9129, 0xA14A, 0xB16B, 0xC18C, 0xD1AD, 0xE1CE, 0xF1EF,
       0x1231, 0x0210, 0x3273, 0x2252, 0x52B5, 0x4294, 0x72F7, 0x62D6,
@@ -261,11 +282,11 @@ static ulong crc_0x1021(const uchar* data, ulong len, ulong crc)
     return crc;
 }
 
-static ulong crc_0x04C11DB7(const uchar* data, ulong len, ulong crc)
+static uint32_t crc_0x04C11DB7(const uint8_t* data, size_t len, uint32_t crc)
 {
     // x^32 + x^26 + x^23 + x^22 + x^16 + x^12 + x^11 + x^10 +
     //    x^8 + x^7 + x^5 + x^4 + x^2 + x^1 + x^0  (0x04C11DB7)
-    const static ulong table[] = {
+    const uint32_t table[] = {
         0x00000000, 0x04c11db7, 0x09823b6e, 0x0d4326d9,
         0x130476dc, 0x17c56b6b, 0x1a864db2, 0x1e475005,
         0x2608edb8, 0x22c9f00f, 0x2f8ad6d6, 0x2b4bcb61,
@@ -335,12 +356,12 @@ static ulong crc_0x04C11DB7(const uchar* data, ulong len, ulong crc)
     return crc;
 }
 
-static ulong crc_0x04C11DB7_r(const uchar* data, ulong len, ulong crc)
+static uint32_t crc_0x04C11DB7_r(const uint8_t* data, size_t len, uint32_t crc)
 {
     // x^32 + x^26 + x^23 + x^22 + x^16 + x^12 + x^11 + x^10 +
     //    x^8 + x^7 + x^5 + x^4 + x^2 + x^1 + x^0  (0x04C11DB7)
     // reflected
-    const static ulong table[] = {
+    const uint32_t table[] = {
         0x00000000, 0x77073096, 0xee0e612c, 0x990951ba,
         0x076dc419, 0x706af48f, 0xe963a535, 0x9e6495a3,
         0x0edb8832, 0x79dcb8a4, 0xe0d5e91e, 0x97d2d988,
@@ -410,13 +431,13 @@ static ulong crc_0x04C11DB7_r(const uchar* data, ulong len, ulong crc)
     return crc;
 }
 
-static ulong adler32(const uchar* data, ulong len, ulong init)
+static uint32_t adler32(const uint8_t* data, size_t len, uint32_t init)
 {
-    ulong a = init & 0xFFFF;
-    ulong b = (init >> 16) & 0xFFFF;
+    uint32_t a = init & 0xFFFF;
+    uint32_t b = (init >> 16) & 0xFFFF;
 
     while (len) {
-        ulong tlen = len > 5550 ? 5550 : len;
+        size_t tlen = len > 5550 ? 5550 : len;
         len -= tlen;
         do {
             a += *data++;
@@ -431,10 +452,10 @@ static ulong adler32(const uchar* data, ulong len, ulong init)
     return b << 16 | a;
 }
 
-static ulong hexsum(const uchar* data, ulong len, ulong sum)
+static uint32_t hexsum(const uint8_t* data, size_t len, uint32_t sum)
 {
     // Add all hex digits, ignore all other bytes.
-    ulong d; 
+    uint32_t d;
     while (len--)
     {
         d = toupper(*data++);
@@ -448,13 +469,42 @@ static ulong hexsum(const uchar* data, ulong len, ulong sum)
     return sum;
 }
 
+// Special TRIUMF version for the CPI RF Amplifier
+static uint32_t CPI(const uint8_t * data, size_t len, uint32_t init)
+{
+    init -= (uint32_t)len<<5;
+    while (len--)
+    {
+        init += *data++;
+    }
+    init %= 95;
+    init += 32;
+    return init;
+}
+
+// Leybold Graphix uses a strange sum (= notsum + fix):
+// "CRC = 255 - [(Byte sum of all preceding characters) mod 256]
+//  If this value is lower than 32 (control character of the ASCII code),
+//  then 32 must be added."
+
+static uint32_t leybold(const uint8_t* data, size_t len, uint32_t sum)
+{
+    while (len--)
+    {
+        sum += *data++;
+    }
+    sum = ~sum;
+    if (sum < 32) sum+=32;
+    return sum;
+}
+
 struct checksum
 {
     const char* name;
     checksumFunc func;
-    ulong init;
-    ulong xorout;
-    signed char bytes;
+    uint32_t init;
+    uint32_t xorout;
+    uint8_t bytes;
 };
 
 static checksum checksumMap[] =
@@ -465,20 +515,6 @@ static checksum checksumMap[] =
     {"sum8",    sum,              0x00,       0x00,       1}, // 0xDD
     {"sum16",   sum,              0x0000,     0x0000,     2}, // 0x01DD
     {"sum32",   sum,              0x00000000, 0x00000000, 4}, // 0x000001DD
-    {"nsum",    sum,              0xFF,       0xFF,       1}, // 0x23
-    {"negsum",  sum,              0xFF,       0xFF,       1}, // 0x23
-    {"-sum",    sum,              0xFF,       0xFF,       1}, // 0x23
-    {"nsum8",   sum,              0xFF,       0xFF,       1}, // 0x23
-    {"negsum8", sum,              0xFF,       0xFF,       1}, // 0x23
-    {"-sum8",   sum,              0xFF,       0xFF,       1}, // 0x23
-    {"nsum16",  sum,              0xFFFF,     0xFFFF,     2}, // 0xFE23
-    {"negsum16",sum,              0xFFFF,     0xFFFF,     2}, // 0xFE23
-    {"-sum16",  sum,              0xFFFF,     0xFFFF,     2}, // 0xFE23
-    {"nsum32",  sum,              0xFFFFFFFF, 0xFFFFFFFF, 4}, // 0xFFFFFE23
-    {"negsum32",sum,              0xFFFFFFFF, 0xFFFFFFFF, 4}, // 0xFFFFFE23
-    {"-sum32",  sum,              0xFFFFFFFF, 0xFFFFFFFF, 4}, // 0xFFFFFE23
-    {"notsum",  sum,              0x00,       0xFF,       1}, // 0x22
-    {"~sum",    sum,              0x00,       0xFF,       1}, // 0x22
     {"xor",     xor8,             0x00,       0x00,       1}, // 0x31
     {"xor8",    xor8,             0x00,       0x00,       1}, // 0x31
     {"xor7",    xor7,             0x00,       0x00,       1}, // 0x31
@@ -486,22 +522,28 @@ static checksum checksumMap[] =
     {"ccitt8",  crc_0x31,         0x00,       0x00,       1}, // 0xA1
     {"crc16",   crc_0x8005,       0x0000,     0x0000,     2}, // 0xFEE8
     {"crc16r",  crc_0x8005_r,     0x0000,     0x0000,     2}, // 0xBB3D
+    {"modbus",  crc_0x8005_r,     0xFFFF,     0x0000,     2}, // 0x4B37
     {"ccitt16", crc_0x1021,       0xFFFF,     0x0000,     2}, // 0x29B1
     {"ccitt16a",crc_0x1021,       0x1D0F,     0x0000,     2}, // 0xE5CC
+    {"ccitt16x",crc_0x1021,       0x0000,     0x0000,     2}, // 0x31C3
+    {"crc16c",  crc_0x1021,       0x0000,     0x0000,     2}, // 0x31C3
+    {"xmodem",  crc_0x1021,       0x0000,     0x0000,     2}, // 0x31C3
     {"crc32",   crc_0x04C11DB7,   0xFFFFFFFF, 0xFFFFFFFF, 4}, // 0xFC891918
     {"crc32r",  crc_0x04C11DB7_r, 0xFFFFFFFF, 0xFFFFFFFF, 4}, // 0xCBF43926
     {"jamcrc",  crc_0x04C11DB7_r, 0xFFFFFFFF, 0x00000000, 4}, // 0x340BC6D9
     {"adler32", adler32,          0x00000001, 0x00000000, 4}, // 0x091E01DE
-    {"hexsum8", hexsum,           0x00,       0x00,       1}  // 0x2D
+    {"hexsum8", hexsum,           0x00,       0x00,       1}, // 0x2D
+    {"cpi",     CPI,              0x00,       0x00,       1}, // 0x7E
+    {"leybold", leybold,          0x00,       0x00,       1}, // 0x22
 };
 
-static ulong mask[5] = {0, 0xFF, 0xFFFF, 0xFFFFFF, 0xFFFFFFFF};
+static uint32_t mask[5] = {0, 0xFF, 0xFFFF, 0xFFFFFF, 0xFFFFFFFF};
 
 class ChecksumConverter : public StreamFormatConverter
 {
     int parse (const StreamFormat&, StreamBuffer&, const char*&, bool);
     bool printPseudo(const StreamFormat&, StreamBuffer&);
-    int scanPseudo(const StreamFormat&, StreamBuffer&, long& cursor);
+    ssize_t scanPseudo(const StreamFormat&, StreamBuffer&, size_t& cursor);
 };
 
 int ChecksumConverter::
@@ -514,53 +556,107 @@ parse(const StreamFormat&, StreamBuffer& info, const char*& source, bool)
         return false;
     }
 
-    size_t fnum;
+    bool negflag=false;
+    bool notflag=false;
+    if (*source == '-')
+    {
+        source++;
+        negflag = true;
+    }
+    if (strncasecmp(source, "neg", 3) == 0)
+    {
+        source+=3;
+        negflag = true;
+    }
+    if (*source == '~')
+    {
+        source++;
+        notflag = true;
+    }
+    if (strncasecmp(source, "not", 3) == 0)
+    {
+        source+=3;
+        notflag = true;
+    }
+    uint8_t fnum;
+    size_t len = p-source;
+    uint32_t init, xorout;
     for (fnum = 0; fnum < sizeof(checksumMap)/sizeof(checksum); fnum++)
     {
-        if (strncasecmp(source, checksumMap[fnum].name, p-source) == 0)
+        if ((strncasecmp(source, checksumMap[fnum].name, len) == 0) ||
+            (*source == 'n' && len > 1 && strncasecmp(source+1, checksumMap[fnum].name, len-1) == 0 && (negflag = true)))
         {
+            init = checksumMap[fnum].init;
+            xorout = checksumMap[fnum].xorout;
+            if (negflag)
+            {
+                init = ~init;
+                xorout = ~xorout;
+            }
+            if (notflag)
+            {
+                xorout = ~xorout;
+            }
+            info.append(&init,  sizeof(init));
+            info.append(&xorout, sizeof(xorout));
             info.append(fnum);
             source = p+1;
             return pseudo_format;
         }
     }
 
-    error ("Unknown checksum algorithm \"%.*s\"\n",
-        static_cast<int>(p-source), source);
+    error ("Unknown checksum algorithm \"%.*s\"\n", (int)len, source);
     return false;
 }
 
 bool ChecksumConverter::
 printPseudo(const StreamFormat& format, StreamBuffer& output)
 {
-    ulong sum;
-    int fnum = format.info[0];
-    int start = format.width;
-    int length = output.length()-format.width;
+    uint32_t sum;
+    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);
+
+    size_t start = format.width;
+    size_t length = output.length()-format.width;
     if (format.prec > 0) length -= format.prec;
 
     debug("ChecksumConverter %s: output to check: \"%s\"\n",
         checksumMap[fnum].name, output.expand(start,length)());
 
-    sum = checksumMap[fnum].xorout ^ checksumMap[fnum].func(
-        reinterpret_cast<uchar*>(output(start)), length,
-        checksumMap[fnum].init) & mask[checksumMap[fnum].bytes];
+    sum = (xorout ^ checksumMap[fnum].func(
+        reinterpret_cast<uint8_t*>(output(start)), length, init))
+        & mask[checksumMap[fnum].bytes];
 
-    debug("ChecksumConverter %s: output checksum is 0x%lX\n",
+    debug("ChecksumConverter %s: output checksum is 0x%" PRIX32 "\n",
         checksumMap[fnum].name, sum);
 
-    int i;
-    unsigned outchar;
+    uint_fast8_t i;
+    uint_fast8_t outchar;
 
+    if (format.flags & sign_flag) // decimal
+    {
+        // get number of decimal digits from number of bytes: ceil(bytes*2.5)
+        i = (checksumMap[fnum].bytes+1)*25/10-2;
+        output.print("%0*" PRIu32, i, sum);
+        debug("ChecksumConverter %s: decimal appending %0*" PRIu32 "\n",
+            checksumMap[fnum].name, i, sum);
+    }
+    else
     if (format.flags & alt_flag) // lsb first (little endian)
     {
         for (i = 0; i < checksumMap[fnum].bytes; i++)
         {
             outchar = sum & 0xff;
-            debug("ChecksumConverter %s: little endian appending 0x%X\n",
+            debug("ChecksumConverter %s: little endian appending 0x%02" PRIX8 "\n",
                 checksumMap[fnum].name, outchar);
             if (format.flags & zero_flag) // ASCII
-                output.printf("%02X", outchar);
+                output.print("%02" PRIX8, outchar);
+            else
+            if (format.flags & left_flag) // poor man's hex: 0x30 - 0x3F
+                output.print("%c%c",
+                    ((outchar>>4)&0x0f)|0x30, (outchar&0x0f)|0x30);
             else                          // binary
                 output.append(outchar);
             sum >>= 8;
@@ -572,10 +668,14 @@ printPseudo(const StreamFormat& format, StreamBuffer& output)
         for (i = 0; i < checksumMap[fnum].bytes; i++)
         {
             outchar = (sum >> 24) & 0xff;
-            debug("ChecksumConverter %s: big endian appending 0x%X\n",
+            debug("ChecksumConverter %s: big endian appending 0x02%" PRIX8 "\n",
                 checksumMap[fnum].name, outchar);
             if (format.flags & zero_flag) // ASCII
-                output.printf("%02X", outchar);
+                output.print("%02" PRIX8, outchar);
+            else
+            if (format.flags & left_flag) // poor man's hex: 0x30 - 0x3F
+                output.print("%c%c",
+                    ((outchar>>4)&0x0f)|0x30, (outchar&0x0f)|0x30);
             else                          // binary
                 output.append(outchar);
             sum <<= 8;
@@ -584,42 +684,92 @@ printPseudo(const StreamFormat& format, StreamBuffer& output)
     return true;
 }
 
-int ChecksumConverter::
-scanPseudo(const StreamFormat& format, StreamBuffer& input, long& cursor)
+ssize_t ChecksumConverter::
+scanPseudo(const StreamFormat& format, StreamBuffer& input, size_t& cursor)
 {
-    int fnum = format.info[0];
-    ulong sum;
-    int start = format.width;
-    int length = cursor-format.width;
+    uint32_t sum;
+    const char* info = format.info;
+    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;
+
     if (format.prec > 0) length -= format.prec;
 
     debug("ChecksumConverter %s: input to check: \"%s\n",
         checksumMap[fnum].name, input.expand(start,length)());
 
-    if (input.length() - cursor <
-        (format.flags & zero_flag ? 2 : 1) * checksumMap[fnum].bytes)
+    uint_fast8_t expectedLength =
+        // 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;
+
+    if (input.length() - cursor < expectedLength)
     {
-        error("Input too short for checksum\n");
+        debug("ChecksumConverter %s: Input '%s' too short for checksum\n",
+            checksumMap[fnum].name, input.expand(cursor)());
         return -1;
     }
 
-    sum = checksumMap[fnum].xorout ^ checksumMap[fnum].func(
-        reinterpret_cast<uchar*>(input(start)), length,
-        checksumMap[fnum].init) & mask[checksumMap[fnum].bytes];
+    sum = (xorout ^ checksumMap[fnum].func(
+        (uint8_t*)input(start), length, init))
+        & mask[checksumMap[fnum].bytes];
 
-    debug("ChecksumConverter %s: input checksum is 0x%0*lX\n",
+    debug("ChecksumConverter %s: input checksum is 0x%0*" PRIX32 "\n",
         checksumMap[fnum].name, 2*checksumMap[fnum].bytes, sum);
 
-    int i,j;
-    unsigned inchar;
+    uint_fast8_t inchar;
 
+    if (format.flags & sign_flag) // decimal
+    {
+        uint32_t sumin = 0;
+        size_t i;
+        for (i = 0; i < expectedLength; i++)
+        {
+            inchar = input[cursor+i];
+            if (isdigit(inchar)) sumin = sumin*10+inchar-'0';
+            else break;
+        }
+        if (sumin != sum)
+        {
+            debug("ChecksumConverter %s: Input %0*" PRIu32 " does not match checksum %0*" PRIu32 "\n",
+                checksumMap[fnum].name, (int)i, sumin, (int)expectedLength, sum);
+            return -1;
+        }
+    }
+    else
     if (format.flags & alt_flag) // lsb first (little endian)
     {
+        uint_fast8_t i;
         for (i = 0; i < checksumMap[fnum].bytes; i++)
         {
             if (format.flags & zero_flag) // ASCII
             {
-                sscanf(input(cursor+2*i), "%2X", &inchar);
+                if (sscanf(input(cursor+2*i), "%2" SCNx8, &inchar) != 1)
+                {
+                    debug("ChecksumConverter %s: Input byte '%s' is not a hex byte\n",
+                        checksumMap[fnum].name, input.expand(cursor+2*i,2)());
+                    return -1;
+                }
+            }
+            else
+            if (format.flags & left_flag) // poor man's hex: 0x30 - 0x3F
+            {
+                if ((input[cursor+2*i] & 0xf0) != 0x30)
+                {
+                    debug("ChecksumConverter %s: Input byte 0x%02" PRIX8 " is not in range 0x30 - 0x3F\n",
+                        checksumMap[fnum].name, input[cursor+2*i]);
+                    return -1;
+                }
+                if ((input[cursor+2*i+1] & 0xf0) != 0x30)
+                {
+                    debug("ChecksumConverter %s: Input byte 0x%02" PRIX8 " is not in range 0x30 - 0x3F\n",
+                        checksumMap[fnum].name, input[cursor+2*i+1]);
+                    return -1;
+                }
+                inchar = ((input[cursor+2*i] & 0x0f) << 4) | (input[cursor+2*i+1] & 0x0f);
             }
             else                          // binary
             {
@@ -627,19 +777,38 @@ scanPseudo(const StreamFormat& format, StreamBuffer& input, long& cursor)
             }
             if (inchar != ((sum >> 8*i) & 0xff))
             {
-                error("Input byte 0x%02X does not match checksum 0x%0*lX\n", 
-                    inchar, 2*checksumMap[fnum].bytes, sum);
+                debug("ChecksumConverter %s: Input byte 0x%02" PRIX8 " does not match checksum 0x%0*" PRIX32 "\n",
+                    checksumMap[fnum].name, inchar, 2*checksumMap[fnum].bytes, sum);
                 return -1;
             }
         }
     }
     else // msb first (big endian)
     {
+        int_fast8_t i;
+        uint_fast8_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), "%2x", &inchar);
+                sscanf(input(cursor+2*i), "%2" SCNx8, &inchar);
+            }
+            else
+            if (format.flags & left_flag) // poor man's hex: 0x30 - 0x3F
+            {
+                if ((input[cursor+2*i] & 0xf0) != 0x30)
+                {
+                    debug("ChecksumConverter %s: Input byte 0x%02" PRIX8 " is not in range 0x30 - 0x3F\n",
+                        checksumMap[fnum].name, input[cursor+2*i]);
+                    return -1;
+                }
+                if ((input[cursor+2*i+1] & 0xf0) != 0x30)
+                {
+                    debug("ChecksumConverter %s: Input byte 0x%02" PRIX8 " is not in range 0x30 - 0x3F\n",
+                        checksumMap[fnum].name, input[cursor+2*i+1]);
+                    return -1;
+                }
+                inchar = ((input[cursor+2*i] & 0x0f) << 4) | (input[cursor+2*i+1] & 0x0f);
             }
             else                          // binary
             {
@@ -647,15 +816,13 @@ scanPseudo(const StreamFormat& format, StreamBuffer& input, long& cursor)
             }
             if (inchar != ((sum >> 8*j) & 0xff))
             {
-                error("Input byte 0x%02X does not match checksum 0x%0*lX\n",
-                    inchar, 2*checksumMap[fnum].bytes, sum);
+                debug("ChecksumConverter %s: Input byte 0x%02" PRIX8 " does not match checksum 0x%0*" PRIX32 "\n",
+                    checksumMap[fnum].name, inchar, 2*checksumMap[fnum].bytes, sum);
                 return -1;
             }
         }
     }
-    if (format.flags & zero_flag) // ASCII
-        return 2*checksumMap[fnum].bytes;
-    return checksumMap[fnum].bytes;
+    return expectedLength;
 }
 
 RegisterConverter (ChecksumConverter, "<");

src/DebugInterface.cc

@@ -21,6 +21,8 @@
 #include "StreamError.h"
 #include "StreamBuffer.h"
 
+#define Z PRINTF_SIZE_T_PREFIX
+
 // This is a non-blocking bus interface for debugging purpose.
 // Normally, a bus interface will use blocking I/O and thus require
 // a separate thread.
@@ -35,7 +37,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, long expectedLength, bool async);
+        unsigned long readTimeout_ms, size_t expectedLength, bool async);
 
 protected:
     ~DebugInterface();
@@ -167,9 +169,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,
-    long expectedLength, bool async)
+    size_t expectedLength, bool async)
 {
-    debug("DebugInterface::readRequest(%s, %ld msec reply, %ld msec read, expect %ld bytes, asyn=%s)\n",
+    debug("DebugInterface::readRequest(%s, %ld msec reply, %ld msec read, expect %" Z "u bytes, asyn=%s)\n",
         clientName(), replyTimeout_ms, readTimeout_ms, expectedLength, async?"yes":"no");
 
     // Debug interface does not support async mode.

src/DummyInterface.cc

@@ -0,0 +1,76 @@
+/***************************************************************
+* 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.                                  *
+*                                                              *
+***************************************************************/
+
+#include "StreamBusInterface.h"
+#include "StreamError.h"
+#include "StreamBuffer.h"
+
+class DummyInterface : StreamBusInterface
+{
+    DummyInterface(Client* client);
+
+    // StreamBusInterface methods
+    bool lockRequest(unsigned long lockTimeout_ms);
+    bool unlock();
+
+protected:
+    ~DummyInterface();
+
+public:
+    // static creator method
+    static StreamBusInterface* getBusInterface(Client* client,
+        const char* busname, int addr, const char* param);
+};
+
+RegisterStreamBusInterface(DummyInterface);
+
+DummyInterface::
+DummyInterface(Client* client) : StreamBusInterface(client)
+{
+    // Nothing to do
+}
+
+DummyInterface::
+~DummyInterface()
+{
+    // Nothing to do
+}
+
+StreamBusInterface* DummyInterface::
+getBusInterface(Client* client,
+    const char* busname, int addr, const char*)
+{
+    if (strcmp(busname, "dummy") == 0)
+    {
+        DummyInterface* interface = new DummyInterface(client);
+        return interface;
+    }
+    return NULL;
+}
+
+bool DummyInterface::
+lockRequest(unsigned long lockTimeout_ms)
+{
+    return false;
+}
+
+bool DummyInterface::
+unlock()
+{
+    return false;
+}

src/EnumConverter.cc

@@ -5,7 +5,7 @@
 * (C) 2005 Dirk Zimoch (dirk.zimoch@psi.ch)                    *
 *                                                              *
 * This is the enum format converter of StreamDevice.           *
-* Please refer to the HTML files in ../doc/ for a detailed     *
+* 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   *
@@ -21,6 +21,7 @@
 #include "StreamFormatConverter.h"
 #include "StreamError.h"
 #include "StreamProtocol.h"
+#include <stdlib.h>
 
 // Enum %{string0|string1|...}
 
@@ -28,47 +29,88 @@ class EnumConverter : public StreamFormatConverter
 {
     int parse(const StreamFormat&, StreamBuffer&, const char*&, bool);
     bool printLong(const StreamFormat&, StreamBuffer&, long);
-    int scanLong(const StreamFormat&, const char*, long&);
+    ssize_t scanLong(const StreamFormat&, const char*, long&);
 };
 
+// info format: <numEnums><index><string>0<index><string>0...
+
 int EnumConverter::
 parse(const StreamFormat& fmt, StreamBuffer& info,
-    const char*& source, bool)
+    const char*& source, bool scanFormat)
 {
-    if (fmt.flags & (left_flag|sign_flag|space_flag|zero_flag|alt_flag))
+    if (fmt.flags & (left_flag|sign_flag|space_flag|zero_flag))
     {
-        error("Use of modifiers '-', '+', ' ', '0', '#'"
+        error("Use of modifiers '-', '+', ' ', '0' "
             "not allowed with %%{ conversion\n");
         return false;
     }
-    int i = info.length(); // put maxValue here later
-    info.append('\0');
-    int maxValue = 0;
+    long numEnums = 0;
+    size_t n = info.length(); // put numEnums here later
+    info.append(&numEnums, sizeof(numEnums));
+    long index = 0;
+    size_t i = 0;
+    i = info.length(); // put index here later
+    info.append(&index, sizeof(index));
     while (*source)
     {
-        switch (*source)
+        if (*source == '=' && (fmt.flags & alt_flag))
         {
-            case '|':
-                info.append('\0');
-                if (++maxValue > 255)
+            char* p;
+
+            if (*++source == '?')
             {
-                    error("Too many enums (max 256)\n");
+                // default choice
+                if (scanFormat)
+                {
+                    error("Default value only allowed in output formats\n");
                     return false;
                 }
-                break;
-            case '}':
-                source++;
-                info.append('\0');
-                info[i] = maxValue;
-                debug("EnumConverter::parse %d choices: %s\n",
-                    maxValue+1, info.expand(i+1)());
-                return enum_format;
-            case esc:
-                info.append(*source++);
-            default:
-                info.append(*source);
+                if (*++source != '}')
+                {
+                    error("Default value must be last\n");
+                    return false;
                 }
                 source++;
+                numEnums = -(numEnums+1);
+                info.append('\0');
+                memcpy(info(n), &numEnums, sizeof(numEnums));
+                debug("EnumConverter::parse %ld choices with default: %s\n",
+                    -numEnums, info.expand()());
+                return enum_format;
+            }
+
+            index = strtol(source, &p, 0);
+            if (p == source || (*p != '|' && *p != '}'))
+            {
+                error("Integer expected after '=' "
+                    "in %%{ format conversion\n");
+                return false;
+            }
+            memcpy(info(i), &index, sizeof(index));
+            source = p;
+        }
+        if (*source == '|' || *source == '}')
+        {
+            numEnums++;
+            info.append('\0');
+
+            if (*source++ == '}')
+            {
+                memcpy(info(n), &numEnums, sizeof(numEnums));
+                debug("EnumConverter::parse %ld choices: %s\n",
+                    numEnums, info.expand()());
+                return enum_format;
+            }
+            index++;
+            i = info.length();
+            info.append(&index, sizeof(index));
+        }
+        else
+        {
+            if (*source == esc)
+                info.append(*source++);
+            info.append(*source++);
+        }
     }
     error("Missing '}' after %%{ format conversion\n");
     return false;
@@ -77,14 +119,13 @@ parse(const StreamFormat& fmt, StreamBuffer& info,
 bool EnumConverter::
 printLong(const StreamFormat& fmt, StreamBuffer& output, long value)
 {
-    long maxValue = fmt.info[0]; // number of enums
-    const char* s = fmt.info+1;  // first enum string
-    if (value < 0 || value > maxValue)
-    {
-        error("Value %li out of range [0...%li]\n", value, maxValue);        
-        return false;
-    }
-    while (value--)
+    const char* s = fmt.info;
+    long numEnums = extract<long>(s);
+    long index = extract<long>(s);
+    bool noDefault = numEnums >= 0;
+
+    if (numEnums < 0) numEnums=-numEnums-1;
+    while (numEnums-- && (value != index))
     {
         while(*s)
         {
@@ -92,6 +133,12 @@ printLong(const StreamFormat& fmt, StreamBuffer& output, long value)
             s++;
         }
         s++;
+        index = extract<long>(s);
+    }
+    if (numEnums == -1 && noDefault)
+    {
+        error("Value %li not found in enum set\n", value);
+        return false;
     }
     while(*s)
     {
@@ -101,37 +148,39 @@ printLong(const StreamFormat& fmt, StreamBuffer& output, long value)
     return true;
 }
 
-int EnumConverter::
+ssize_t EnumConverter::
 scanLong(const StreamFormat& fmt, const char* input, long& value)
 {
     debug("EnumConverter::scanLong(%%%c, \"%s\")\n",
         fmt.conv, input);
-    long maxValue = fmt.info[0]; // number of enums
-    const char* s = fmt.info+1; // first enum string
-    int length;
-    long val;
+    const char* s = fmt.info;
+    long numEnums = extract<long>(s);
+    long index;
+    ssize_t consumed;
     bool match;
-    for (val = 0; val <= maxValue; val++)
+
+    while (numEnums--)
     {
-        debug("EnumConverter::scanLong: check #%ld \"%s\"\n", val, s);
-        length = 0;
+        index = extract<long>(s);
+        debug("EnumConverter::scanLong: check #%ld \"%s\"\n", index, s);
+        consumed = 0;
         match = true;
         while(*s)
         {
             if (*s == StreamProtocolParser::skip)
             {
                 s++;
-                length++;
+                consumed++;
                 continue;
             }
             if (*s == esc) s++;
-            if (*s++ != input[length++]) match = false;
+            if (*s++ != input[consumed++]) match = false;
         }
         if (match)
         {
-            debug("EnumConverter::scanLong: value %ld matches\n", val);
-            value = val;
-            return length;
+            debug("EnumConverter::scanLong: value %ld matches\n", index);
+            value = index;
+            return consumed;
         }
         s++;
     }

src/MacroMagic.h

@@ -0,0 +1,72 @@
+#ifndef _MacroMagic_h
+#define _MacroMagic_h
+
+#if defined __GNUC__ && __GNUC__ < 3
+
+/* Using old GCC variadic macros */
+
+#define _NTH_ARG(_1, _2, _3, _4, _5, _6, _7, _8, _9, _10, _11, N, args...) N
+
+#define _fe_0(_call, args...)
+#define _fe_1(_call, x) _call(x)
+#define _fe_2(_call, x, args...) _call(x) _fe_1(_call, args)
+#define _fe_3(_call, x, args...) _call(x) _fe_2(_call, args)
+#define _fe_4(_call, x, args...) _call(x) _fe_3(_call, args)
+#define _fe_5(_call, x, args...) _call(x) _fe_4(_call, args)
+#define _fe_6(_call, x, args...) _call(x) _fe_5(_call, args)
+#define _fe_7(_call, x, args...) _call(x) _fe_6(_call, args)
+#define _fe_8(_call, x, args...) _call(x) _fe_7(_call, args)
+#define _fe_9(_call, x, args...) _call(x) _fe_8(_call, args)
+#define _fe_10(_call, x, args...) _call(x) _fe_9(_call, args)
+
+#define MACRO_FOR_EACH(x, args...) \
+    _NTH_ARG(_, ##args, \
+        _fe_10, _fe_9, _fe_8, _fe_7, _fe_6, _fe_5, _fe_4, _fe_3, _fe_2, _fe_1, _fe_0) \
+        (x, ##args)
+
+/* Enum to string magic */
+
+#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";}}\
+_ENUM_CAST(type)
+
+#else
+
+/* Using ISO C variadic macros */
+
+#define _NTH_ARG(_1, _2, _3, _4, _5, _6, _7, _8, _9, _10, _11, N, ...) N
+
+#define _fe_0(_call, ...)
+#define _fe_1(_call, x) _call(x)
+#define _fe_2(_call, x, ...) _call(x) _fe_1(_call, __VA_ARGS__)
+#define _fe_3(_call, x, ...) _call(x) _fe_2(_call, __VA_ARGS__)
+#define _fe_4(_call, x, ...) _call(x) _fe_3(_call, __VA_ARGS__)
+#define _fe_5(_call, x, ...) _call(x) _fe_4(_call, __VA_ARGS__)
+#define _fe_6(_call, x, ...) _call(x) _fe_5(_call, __VA_ARGS__)
+#define _fe_7(_call, x, ...) _call(x) _fe_6(_call, __VA_ARGS__)
+#define _fe_8(_call, x, ...) _call(x) _fe_7(_call, __VA_ARGS__)
+#define _fe_9(_call, x, ...) _call(x) _fe_8(_call, __VA_ARGS__)
+#define _fe_10(_call, x, ...) _call(x) _fe_9(_call, __VA_ARGS__)
+
+#define MACRO_FOR_EACH(x, ...) \
+    _NTH_ARG(_, ##__VA_ARGS__, \
+        _fe_10, _fe_9, _fe_8, _fe_7, _fe_6, _fe_5, _fe_4, _fe_3, _fe_2, _fe_1, _fe_0) \
+        (x, ##__VA_ARGS__)
+
+/* Enum to string magic */
+
+#define ENUM(type,...) \
+enum type { __VA_ARGS__ }; \
+static inline const char* type##ToStr(int x) {switch(x){MACRO_FOR_EACH(_CASE_LINE,__VA_ARGS__) default: return "invalid";}} \
+_ENUM_CAST(type)
+#endif
+
+#define _CASE_LINE(x) case x: return #x;
+#ifdef __cplusplus
+#define _ENUM_CAST(type) ; static inline const char* toStr(type x) {return type##ToStr(x);}
+#else
+#define _ENUM_CAST(type)
+#endif
+
+#endif

src/Makefile

@@ -19,17 +19,15 @@
 ################################################################
 
 TOP = ../..
-
-# Look if we have EPICS R3.13 or R3.14
-ifeq ($(wildcard $(TOP)/configure),)
-# EPICS R3.13
+ifneq ($(wildcard ../../configure),)
+  include $(TOP)/configure/CONFIG
+else ifneq ($(wildcard ../../config),)
   include $(TOP)/config/CONFIG_APP
-# The real work is in Makefile.Vx
   include $(TOP)/config/RULES_ARCHS
 else
-
-# EPICS R3.14
+  TOP= ..
   include $(TOP)/configure/CONFIG
+endif
 
 -include CONFIG_STREAM
 -include ../CONFIG_STREAM
@@ -40,13 +38,8 @@ DBD += $(LIBRARY_DEFAULT).dbd
 
 ifdef ASYN
 LIB_LIBS += asyn
-BUSSES += AsynDriver
-endif
-
-ifdef T_A
-ifndef BUSSES
-$(error No bus interface defined! Didn't you set ASYN in your RELEASE file?)
-endif
+else
+$(warning Asyn not included! Didn't you set ASYN in your RELEASE file?)
 endif
 
 ifeq ($(LOADABLE_MODULE),YES)
@@ -54,7 +47,7 @@ SRCS += $(LIBRARY_DEFAULT)_registerRecordDeviceDriver.cpp
 endif 
 SRCS += $(BUSSES:%=%Interface.cc)
 SRCS += $(FORMATS:%=%Converter.cc)
-SRCS += $(RECORDS:%=dev%Stream.c)
+SRCS += $(RECORDTYPES:%=dev%Stream.c)
 SRCS += $(STREAM_SRCS)
 
 # find system wide or local PCRE header and library
@@ -65,49 +58,38 @@ ifdef PCRE
 LIB_LIBS += pcre
 else
 ifneq ($(words $(PCRE_LIB) $(PCRE_INCLUDE)),0)
-LIB_SYS_LIBS += pcre
+LIB_SYS_LIBS_DEFAULT += pcre
+LIB_SYS_LIBS_WIN32 += $(PCRE_LIB)\\pcre
 SHRLIB_DEPLIB_DIRS += $(PCRE_LIB)
 endif
 endif
 
-LIB_LIBS += Com dbIoc dbStaticIoc registryIoc iocsh
-
-ifeq ($(USE_MEMGUARD),YES)
-# memguard looks for memory leaks (gcc only)
-CPPFLAGS += -include ../memguard.h
-LIB_SRCS += memguard.cc
-endif
+LIB_LIBS += $(EPICS_BASE_IOC_LIBS)
 
 INC += devStream.h
 
-include $(TOP)/configure/RULES
+# switch off annoying rset warnings in 3.16+
+CPPFLAGS += -DUSE_TYPED_RSET
 
-# Update version string (contains __DATE__ and __TIME__)
-# each time make runs.
-StreamVersion$(OBJ): FORCE
-FORCE:
+-include $(TOP)/configure/RULES
+
+# Update version string whenever something changes
+StreamVersion$(OBJ): ../*.c ../*.h ../*.cc ../CONFIG_STREAM
 
 # Add references to all registrars to main file to avoid
 # missing initialization.
-StreamCore$(OBJ): streamReferences
+StreamCore$(OBJ) StreamCore$(DEP): streamReferences
 
 streamReferences: ../CONFIG_STREAM
-	@for i in $(BUSSES); \
-	do echo "extern void* ref_$${i}Interface;"; \
-           echo "void* p$$i = ref_$${i}Interface;"; \
-	done > $@
-	@for i in $(FORMATS); \
-	do echo "extern void* ref_$${i}Converter;"; \
-           echo "void* p$$i = ref_$${i}Converter;"; \
-	done >> $@
+	$(PERL) ../makeref.pl Interface $(BUSSES) > $@
+	$(PERL) ../makeref.pl Converter $(FORMATS) >> $@
 
-# create stream.dbd from all RECORDS
+# create stream.dbd from all RECORDTYPES
 $(COMMON_DIR)/$(LIBRARY_DEFAULT).dbd: ../CONFIG_STREAM
-	@for r in $(RECORDS); \
-	do echo "device($$r,INST_IO,dev$${r}Stream,\"stream\")"; \
-	done > $@
-	@echo "driver(stream)" >> $@
-	@echo "variable(streamDebug, int)" >> $@
-	@echo "registrar(streamRegistrar)" >> $@
-
+	$(PERL) ../makedbd.pl $(RECORDTYPES) > $@
+ifdef ASYN
+	echo "registrar(AsynDriverInterfaceRegistrar)" >> $@
 endif
+
+$(LIBRARY_DEFAULT).dbd$(DEP): ../CONFIG_STREAM
+	echo $(LIBRARY_DEFAULT).dbd: $< > $@

src/Makefile.Host

@@ -18,28 +18,19 @@
 #                                                              #
 ################################################################
 
+TOP = ../..
+ifneq ($(wildcard ../../../config),)
 TOP = ../../..
+endif
 
 include $(TOP)/config/CONFIG_APP
 include ../CONFIG_STREAM
 
-# In 3.13, calcout has no device support
-RECORDS_3_13 = $(filter-out calcout,$(RECORDS))
-
 DBDNAME = stream.dbd
-
 INC += devStream.h
 
-# This is the munch.pl taken from EPICS 3.14.8.2
-# Install script and rule.
-CONFIGS = RULES.munch
-SCRIPTS = munch.pl
+include $(EPICS_BASE)/config/RULES.Host
 
-include $(TOP)/config/RULES.Host
-
-# create stream.dbd from all RECORDS
+# create stream.dbd from all RECORDTYPES
 stream.dbd: ../CONFIG_STREAM
-	@for r in $(RECORDS_3_13); \
-	do echo "device($$r,INST_IO,dev$${r}Stream,\"stream\")"; \
-	done > $@
-	@echo "driver(stream)" >> $@
+	$(PERL) ../makedbd.pl -3.13 $(RECORDTYPES) > $@

src/Makefile.Vx

@@ -18,39 +18,33 @@
 #                                                              #
 ################################################################
 
+TOP = ../..
+ifneq ($(wildcard ../../../config),)
 TOP = ../../..
+endif
 
 include $(TOP)/config/CONFIG_APP
 include ../CONFIG_STREAM
 
 LIBNAME = streamLib
 
-# In 3.13, calcout has no device support
-RECORDS_3_13 = $(filter-out calcout,$(RECORDS))
-
-ifdef ASYN
-BUSSES += AsynDriver
-endif
-
-SRCS.cc += $(patsubst %,../%,$(filter %.cc,$(STREAM_SRCS)))
 SRCS.cc += $(BUSSES:%=../%Interface.cc)
 SRCS.cc += $(FORMATS:%=../%Converter.cc)
-SRCS.c += $(patsubst %,../%,$(filter %.c,$(STREAM_SRCS)))
-SRCS.c += $(RECORDS_3_13:%=../dev%Stream.c)
+SRCS.cc += $(filter %.cc,$(STREAM_SRCS:%=%../%))
+SRCS.c += $(RECORDTYPES:%=../dev%Stream.c)
+SRCS.c += $(filter %.c,$(STREAM_SRCS:%=%../%))
 
 LIBOBJS = $(patsubst ../%,%.o,$(basename $(SRCS.cc) $(SRCS.c)))
 
-include $(TOP)/config/RULES.Vx
-include $(TOP)/config/RULES.munch
-
-build:: depends
+include $(EPICS_BASE)/config/RULES.Vx
+include ../../config/RULES.munch
 
+DEPENDS: depends
 -include DEPENDS
 
-# Update version string (contains __DATE__ and __TIME__)
-# each time make runs.
-StreamVersion.o: FORCE
-FORCE:
+# Update version string whenever something changes
+StreamVersion.o: ../*.c ../*.h ../*.cc ../CONFIG_STREAM
+$(LIBNAME): StreamVersion.o
 
 StreamCore.o: streamReferences
 

src/MantissaExponentConverter.cc

@@ -1,14 +1,13 @@
 /***************************************************************
 * StreamDevice Support                                         *
 *                                                              *
-* (C) 1999 Dirk Zimoch (zimoch@delta.uni-dortmund.de)          *
-* (C) 2007 Dirk Zimoch (dirk.zimoch@psi.ch)                    *
+* (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 ../doc/ for a detailed     *
+* 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   *
@@ -32,26 +31,26 @@
 // But why not +11000-04 ?
 // For writing, I chose the following convention:
 // Format precision defines number of digits in mantissa
-// Number of digits in exponent is at least 2
 // No leading '0' in mantissa (except for 0.0 of course)
+// Number of digits in exponent is at least 2
 // Format flags +, -, and space are supported in the usual way
 // Flags #, 0 are not supported
 
-class ExponentialConverter : public StreamFormatConverter
+class MantissaExponentConverter : public StreamFormatConverter
 {
     virtual int parse(const StreamFormat&, StreamBuffer&, const char*&, bool);
-    virtual int scanDouble(const StreamFormat&, const char*, double&);
+    virtual ssize_t scanDouble(const StreamFormat&, const char*, double&);
     virtual bool printDouble(const StreamFormat&, StreamBuffer&, double);
 };
 
-int ExponentialConverter::
-parse(const StreamFormat& fmt, StreamBuffer& info,
-    const char*& source, bool scanFormat)
+int MantissaExponentConverter::
+parse(const StreamFormat&, StreamBuffer&,
+    const char*&, bool)
 {
     return double_format;
 }
 
-int ExponentialConverter::
+ssize_t MantissaExponentConverter::
 scanDouble(const StreamFormat& fmt, const char* input, double& value)
 {
     int mantissa;
@@ -61,33 +60,35 @@ scanDouble(const StreamFormat& fmt, const char* input, double& value)
     sscanf(input, "%d%d%n", &mantissa, &exponent, &length);
     if (fmt.flags & skip_flag) return length;
     if (length == -1) return -1;
-    value = (double)(mantissa) * pow(10, exponent);
+    value = (double)(mantissa) * pow(10.0, exponent);
     return length;
 }
 
-bool ExponentialConverter::
+bool MantissaExponentConverter::
 printDouble(const StreamFormat& fmt, StreamBuffer& output, double value)
 {
     // Have to divide value into mantissa and exponent
     // precision field is number of characters in mantissa
     // number of characters in exponent is at least 2
-    int spaces;
+    ssize_t spaces;
     StreamBuffer buf;
+    int prec = fmt.prec;
 
-    buf.printf("%.*e", fmt.prec-1, fabs(value));
+    if (prec < 1) prec = 6;
+    buf.print("%.*e", prec-1, fabs(value)/pow(10.0, prec-1));
     buf.remove(1,1);
     buf.remove(buf.find('e'),1);
 
     spaces = fmt.width-buf.length();
-    if (fmt.flags & (space_flag|sign_flag) || value < 0) spaces--;
+    if (fmt.flags & (space_flag|sign_flag) || value < 0.0) spaces--;
     if (spaces < 0) spaces = 0;
     if (!(fmt.flags & left_flag))
         output.append(' ', spaces);
-    if (fmt.flags & (space_flag|sign_flag) == space_flag && value >= 0)
+    if ((fmt.flags & (space_flag|sign_flag)) == space_flag && value >= 0.0)
         output.append(' ');
-    if (fmt.flags & sign_flag && value >= 0)
+    if (fmt.flags & sign_flag && value >= 0.0)
         output.append('+');
-    if (value <= 0)
+    if (value < 0.0)
         output.append('-');
     output.append(buf);
     if (fmt.flags & left_flag)
@@ -95,5 +96,5 @@ printDouble(const StreamFormat& fmt, StreamBuffer& output, double value)
     return true;
 }
 
-RegisterConverter (ExponentialConverter, "m");
+RegisterConverter (MantissaExponentConverter, "m");
 

src/RawConverter.cc

@@ -5,7 +5,7 @@
 * (C) 2005 Dirk Zimoch (dirk.zimoch@psi.ch)                    *
 *                                                              *
 * This is the raw format converter of StreamDevice.            *
-* Please refer to the HTML files in ../doc/ for a detailed     *
+* 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   *
@@ -27,25 +27,26 @@ class RawConverter : public StreamFormatConverter
 {
     int parse(const StreamFormat&, StreamBuffer&, const char*&, bool);
     bool printLong(const StreamFormat&, StreamBuffer&, long);
-    int scanLong(const StreamFormat&, const char*, long&);
+    ssize_t scanLong(const StreamFormat&, const char*, long&);
 };
 
 int RawConverter::
-parse(const StreamFormat&, StreamBuffer&,
+parse(const StreamFormat& fmt, StreamBuffer&,
     const char*&, bool)
 {
-    return long_format;
+    return (fmt.flags & zero_flag) ? unsigned_format : signed_format;
 }
 
 bool RawConverter::
-printLong(const StreamFormat& format, StreamBuffer& output, long value)
+printLong(const StreamFormat& fmt, StreamBuffer& output, long value)
 {
-    int prec = format.prec;   // number of bytes from value
-    if (prec == -1) prec = 1; // default: 1 byte
-    int width = prec;         // number of bytes in output
-    if (format.width > width) width = format.width;
+    unsigned int prec = fmt.prec < 0 ? 1 : fmt.prec; // number of bytes from value, default 1
+    unsigned long width = prec;  // number of bytes in output
+    if (prec > sizeof(long)) prec=sizeof(long);
+    if (fmt.width > width) width = fmt.width;
+
     char byte = 0;
-    if (format.flags & alt_flag) // little endian (lsb first)
+    if (fmt.flags & alt_flag) // little endian (lsb first)
     {
         while (prec--)
         {
@@ -54,7 +55,7 @@ printLong(const StreamFormat& format, StreamBuffer& output, long value)
             value >>= 8;
             width--;
         }
-        if (format.flags & zero_flag)
+        if (fmt.flags & zero_flag)
         {
             // fill with zero
             byte = 0;
@@ -71,7 +72,7 @@ printLong(const StreamFormat& format, StreamBuffer& output, long value)
     }
     else // big endian (msb first)
     {
-        if (format.flags & zero_flag)
+        if (fmt.flags & zero_flag)
         {
             // fill with zero
             byte = 0;
@@ -94,62 +95,62 @@ printLong(const StreamFormat& format, StreamBuffer& output, long value)
     return true;
 }
 
-int RawConverter::
-scanLong(const StreamFormat& format, const char* input, long& value)
+ssize_t RawConverter::
+scanLong(const StreamFormat& fmt, const char* input, long& value)
 {
-    long length = 0;
+    ssize_t consumed = 0;
     long val = 0;
-    int width = format.width;
+    unsigned long width = fmt.width;
     if (width == 0) width = 1; // default: 1 byte
-    if (format.flags & skip_flag)
+    if (fmt.flags & skip_flag)
     {
         return width; // just skip input
     }
-    if (format.flags & alt_flag)
+    if (fmt.flags & alt_flag)
     {
         // little endian (lsb first)
         unsigned int shift = 0;
         while (--width && shift < sizeof(long)*8)
         {
-            val |= ((unsigned char) input[length++]) << shift;
+            val |= (unsigned long)((unsigned char)input[consumed++]) << shift;
             shift += 8;
         }
         if (width == 0)
         {
-            if (format.flags & zero_flag)
+            if (fmt.flags & zero_flag)
             {
                 // fill with zero
-                val |= ((unsigned char) input[length++]) << shift;
+                val |= (unsigned long)((unsigned char)input[consumed++]) << shift;
             }
             else
             {
                 // fill with sign
-                val |= ((signed char) input[length++]) << shift;
+                val |= ((long)(signed char)input[consumed++]) << shift;
             }
         }
-        length += width; // ignore upper bytes not fitting in long
+        consumed += width; // ignore upper bytes not fitting in long
     }
     else
     {
         // big endian  (msb first)
-        if (format.flags & zero_flag)
+        if (fmt.flags & zero_flag)
         {
             // fill with zero
-            val = (unsigned char) input[length++];
+            val = (unsigned char)input[consumed++];
         }
         else
         {
             // fill with sign
-            val = (signed char) input[length++];
+            val = (signed char)input[consumed++];
         }
         while (--width)
         {
             val <<= 8;
-            val |= (unsigned char) input[length++];
+            val |= (unsigned char)input[consumed++];
         }
     }
     value = val;
-    return length;
+    return consumed;
 }
 
 RegisterConverter (RawConverter, "r");

src/RawFloatConverter.cc

@@ -5,7 +5,7 @@
 * (C) 2005 Dirk Zimoch (dirk.zimoch@psi.ch)                    *
 *                                                              *
 * This is the raw format converter of StreamDevice.            *
-* Please refer to the HTML files in ../doc/ for a detailed     *
+* 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   *
@@ -21,21 +21,7 @@
 #include "StreamFormatConverter.h"
 #include "StreamError.h"
 
-#ifdef vxWorks
-#include "vxWorks.h"
-#define __BYTE_ORDER _BYTE_ORDER 
-#define __LITTLE_ENDIAN _LITTLE_ENDIAN
-#define __BIG_ENDIAN _BIG_ENDIAN 
-#else
-// Let's hope all other architectures have endian.h
-#include "endian.h"
-#endif
-
-#ifndef __BYTE_ORDER
-#error define __BYTE_ORDER as __LITTLE_ENDIAN or __BIG_ENDIAN
-#endif
-
-#if (__BYTE_ORDER == __LITTLE_ENDIAN || __BYTE_ORDER == __BIG_ENDIAN)
+static int endian = 0;
 
 // Raw Float Converter %R
 
@@ -43,13 +29,24 @@ class RawFloatConverter : public StreamFormatConverter
 {
     int parse(const StreamFormat&, StreamBuffer&, const char*&, bool);
     bool printDouble(const StreamFormat&, StreamBuffer&, double);
-    int scanDouble(const StreamFormat&, const char*, double&);
+    ssize_t scanDouble(const StreamFormat&, const char*, double&);
 };
 
 int RawFloatConverter::
 parse(const StreamFormat& format, StreamBuffer&,
     const char*&, bool)
 {
+    // Find out byte order
+    if (!endian) {
+        union {long l; char c [sizeof(long)];} u;
+        u.l=1;
+        if (u.c[0]) { endian = 1234;} // little endian
+        else if (u.c[sizeof(long)-1]) { endian = 4321;} // big endian
+        else {
+            error ("Cannot find out byte order for %%R format.\n");
+            return false;
+        }
+    }
     // Assume IEEE formats with 4 or 8 bytes (default: 4)
     if (format.width==0 || format.width==4 || format.width==8)
         return double_format;
@@ -73,18 +70,13 @@ printDouble(const StreamFormat& format, StreamBuffer& output, double value)
         nbOfBytes = 4;
 
     if (nbOfBytes == 4)
-        buffer.fval = value;
+        buffer.fval = (float)value;
     else
         buffer.dval = value;
 
-#if (__BYTE_ORDER == __BIG_ENDIAN)
-    bool swap = format.flags & alt_flag;
-#else
-    bool swap = !(format.flags & alt_flag);
-#endif
-    
-    if (swap)
+    if (!(format.flags & alt_flag) ^ (endian == 4321))
     {
+        // swap if byte orders differ
     	for (n = nbOfBytes-1; n >= 0; n--)
     	{
             output.append(buffer.bytes[n]);
@@ -98,7 +90,7 @@ printDouble(const StreamFormat& format, StreamBuffer& output, double value)
     return true;
 }
 
-int RawFloatConverter::
+ssize_t RawFloatConverter::
 scanDouble(const StreamFormat& format, const char* input, double& value)
 {
     int nbOfBytes;
@@ -119,14 +111,9 @@ scanDouble(const StreamFormat& format, const char* input, double& value)
         return(nbOfBytes); // just skip input
     }
 
-#if (__BYTE_ORDER == __BIG_ENDIAN)
-    bool swap = format.flags & alt_flag;
-#else
-    bool swap = !(format.flags & alt_flag);
-#endif
-
-    if (swap)
+    if (!(format.flags & alt_flag) ^ (endian == 4321))
     {
+        // swap if byte orders differ
     	for (n = nbOfBytes-1, i = 0; n >= 0; n--, i++)
     	{
             buffer.bytes[n] = input[i];
@@ -147,5 +134,3 @@ scanDouble(const StreamFormat& format, const char* input, double& value)
 }
 
 RegisterConverter (RawFloatConverter, "R");
-
-#endif /* known byte order */

src/RegexpConverter.cc

@@ -5,7 +5,7 @@
 * (C) 2007 Dirk Zimoch (dirk.zimoch@psi.ch)                    *
 *                                                              *
 * This is the regexp format converter of StreamDevice.         *
-* Please refer to the HTML files in ../doc/ for a detailed     *
+* 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   *
@@ -22,8 +22,11 @@
 #include "StreamError.h"
 #include "string.h"
 #include "pcre.h"
+#include <limits.h>
 
-// Perl regular expressions (PCRE)   %/regexp/
+#define Z PRINTF_SIZE_T_PREFIX
+
+// Perl regular expressions (PCRE) %/regexp/ and  %#/regexp/subst/
 
 /* Notes:
  - Memory for compiled regexp is allocated in parse but never freed.
@@ -32,94 +35,239 @@
    run-time leak.
  - A maximum of 9 subexpressions is supported. Only one of them can
    be the result of the match.
- - vxWorks and maybe other OS don't have a PCRE library. Provide one?
 */
 
 class RegexpConverter : public StreamFormatConverter
 {
-    int parse (const StreamFormat&, StreamBuffer&, const char*&, bool);
-    int scanString(const StreamFormat&, const char*, char*, size_t);
+    int parse (const StreamFormat& fmt, StreamBuffer&, const char*&, bool);
+    ssize_t scanString(const StreamFormat& fmt, const char*, char*, size_t&);
+    ssize_t scanPseudo(const StreamFormat& fmt, StreamBuffer& input, size_t& cursor);
+    bool printPseudo(const StreamFormat& fmt, StreamBuffer& output);
 };
 
 int RegexpConverter::
 parse(const StreamFormat& fmt, StreamBuffer& info,
     const char*& source, bool scanFormat)
 {
-    if (!scanFormat)
+    if (!scanFormat && !(fmt.flags & alt_flag))
     {
         error("Format conversion %%/regexp/ is only allowed in input formats\n");
         return false;
     }
     if (fmt.prec > 9)
     {
-        error("Subexpression index %d too big (>9)\n", fmt.prec);
-        return false;
-    }    
-    if (fmt.flags & (left_flag|space_flag|zero_flag|alt_flag))
-    {
-        error("Use of modifiers '-', ' ', '0', '#'"
-            "not allowed with %%/regexp/ conversion\n");
+        error("Sub-expression index %ld too big (>9)\n", fmt.prec);
         return false;
     }
+
     StreamBuffer pattern;
     while (*source != '/')
     {
         if (!*source) {
-            error("Missing closing '/' after %%/ format conversion\n");
+            error("Missing closing '/' after %%/%s format conversion\n", pattern());
             return false;
         }
-        if (*source == esc) {
-            source++;
-            pattern.printf("\\x%02x", *source++ & 0xFF);
+        if (*source == esc) {          // handle escaped chars
+            if (*++source != '/')      // just un-escape /
+            {
+                pattern.append('\\');
+                if ((*source & 0x7f) < 0x30) // handle control chars
+                {
+                    pattern.print("x%02x", *source++);
                     continue;
                 }
+                // fall through for PCRE codes like \B
+            }
+        }
         pattern.append(*source++);
     }
     source++;
-    debug("regexp = \"%s\"\n", pattern());
+    debug("regexp = \"%s\"\n", pattern.expand()());
+
     const char* errormsg;
     int eoffset;
-    pcre* code = pcre_compile(pattern(), 0, 
-        &errormsg, &eoffset, NULL);
+    int nsubexpr;
+
+    pcre* code = pcre_compile(pattern(), 0, &errormsg, &eoffset, NULL);
     if (!code)
     {
         error("%s after \"%s\"\n", errormsg, pattern.expand(0, eoffset)());
         return false;
     }
+    pcre_fullinfo(code, NULL, PCRE_INFO_CAPTURECOUNT, &nsubexpr);
+    if (fmt.prec > nsubexpr)
+    {
+        error("Sub-expression index is %ld but pattern has only %d sub-expression\n", fmt.prec, nsubexpr);
+        return false;
+    }
     info.append(&code, sizeof(code));
+
+    if (fmt.flags & alt_flag)
+    {
+        StreamBuffer subst;
+
+        debug("check for subst in \"%s\"\n", StreamBuffer(source).expand()());
+        while (*source != '/')
+        {
+            if (!*source) {
+                error("Missing closing '/' after %%#/%s/%s format conversion\n", pattern(), subst());
+                return false;
+            }
+            if (*source == esc)
+                subst.append(*source++);
+            subst.append(*source++);
+        }
+        source++;
+        debug("subst = \"%s\"\n", subst.expand()());
+        info.append(subst).append('\0');
+        return pseudo_format;
+    }
     return string_format;
 }
 
-int RegexpConverter::
+ssize_t RegexpConverter::
 scanString(const StreamFormat& fmt, const char* input,
-    char* value, size_t maxlen)
+    char* value, size_t& size)
 {
-    pcre* code;
-    size_t len;
     int ovector[30];
     int rc;
-    int subexpr = 0;
+    size_t l;
+    const char* info = fmt.info;
+    pcre* code = extract<pcre*>(info);
+    size_t length = fmt.width > 0 ? fmt.width : strlen(input);
+    int subexpr = fmt.prec > 0 ? fmt.prec : 0;
 
-    memcpy (&code, fmt.info, sizeof(code));
+    if (length > INT_MAX)
+        length = INT_MAX;
+    debug("input = \"%s\"\n", input);
+    debug("length=%" Z "u\n", length);
 
-    len = fmt.width > 0 ? fmt.width : strlen(input);
-    subexpr = fmt.prec > 0 ? fmt.prec : 0;
-    rc = pcre_exec(code, NULL, input, len, 0, 0, ovector, 30);
-    if (rc < 1) return -1;
-    if (fmt.flags & skip_flag) return ovector[1];
-    len = ovector[subexpr*2+1] - ovector[subexpr*2];
-    if (len >= maxlen) {
-        if (!(fmt.flags & sign_flag)) {
-            debug("Matching string \"%s\" too long (%d>%d bytes)\n",
-                StreamBuffer(input+ovector[subexpr*2], len).expand()(),
-                len, maxlen-1);
+    rc = pcre_exec(code, NULL, input, (int)length, 0, 0, ovector, 30);
+    debug("pcre_exec match \"%.*s\" result = %d\n", (int)length, input, rc);
+    if ((subexpr && rc <= subexpr) || rc < 0)
+    {
+        // error or no match or not enough sub-expressions
         return -1;
     }
-        len = maxlen-1;
+    if (fmt.flags & skip_flag) return ovector[subexpr*2+1];
+
+    l = ovector[subexpr*2+1] - ovector[subexpr*2];
+    if (l >= size) {
+        if (!(fmt.flags & sign_flag)) {
+            error("Regexp: Matching string \"%s\" too long (%" Z "u>%" Z "u bytes). You may want to try the + flag: \"%%+/.../\"\n",
+                StreamBuffer(input + ovector[subexpr*2],l).expand()(),
+                l, size-1);
+            return -1;
         }
-    memcpy(value, input+ovector[subexpr*2], len);
-    value[len]=0;
-    return ovector[1];
+        l = size-1;
+    }
+    memcpy(value, input + ovector[subexpr*2], l);
+    value[l] = '\0';
+    size = l+1; // update number of bytes written to value
+    return ovector[1]; // consume input until end of match
+}
+
+static void regsubst(const StreamFormat& fmt, StreamBuffer& buffer, size_t start)
+{
+    const char* subst = fmt.info;
+    pcre* code = extract<pcre*>(subst);
+    size_t length, c;
+    int rc, l, r, rl, n;
+    int ovector[30];
+    StreamBuffer s;
+
+    length = buffer.length() - start;
+    if (fmt.width && fmt.width < length)
+        length = fmt.width;
+    if (length > INT_MAX)
+        length = INT_MAX;
+    if (fmt.flags & left_flag)
+        start = buffer.length() - length;
+
+    debug("regsubst buffer=\"%s\", start=%" Z "u, length=%" Z "u, subst = \"%s\"\n",
+        buffer.expand()(), start, length, StreamBuffer(subst).expand()());
+
+    for (c = 0, n = 1; c < length; n++)
+    {
+        rc = pcre_exec(code, NULL, buffer(start+c), (int)(length-c), 0, 0, ovector, 30);
+        debug("pcre_exec match \"%s\" result = %d\n", buffer.expand(start+c, length-c)(), rc);
+
+        if (rc < 0) // no match
+        {
+            debug("pcre_exec: no match\n");
+            break;
+        }
+        if (!(fmt.flags & sign_flag) && n < fmt.prec) // without + flag
+        {
+            // do not yet replace this match
+            c += ovector[1];
+            continue;
+        }
+        // replace subexpressions
+        l = ovector[1] - ovector[0];
+        debug("before [%d]= \"%s\"\n", ovector[0], buffer.expand(start+c,ovector[0])());
+        debug("match  [%d]= \"%s\"\n", l, buffer.expand(start+c+ovector[0],l)());
+        for (r = 1; r < rc; r++)
+            debug("sub%d = \"%s\"\n", r, buffer.expand(start+c+ovector[r*2], ovector[r*2+1]-ovector[r*2])());
+        debug("after     = \"%s\"\n", buffer.expand(start+c+ovector[1])());
+        s = subst;
+        debug("subs      = \"%s\"\n", s.expand()());
+        for (r = 0; r < (int)s.length(); r++)
+        {
+            debug("check \"%s\"\n", s.expand(r)());
+            if (s[r] == esc)
+            {
+                unsigned char ch = s[r+1];
+                debug("found escaped \\%u, in range 1-%d?\n", ch, rc-1);
+                if (ch != 0 && ch < rc) // escaped 1 - 9 : replace with subexpr
+                {
+                    ch *= 2;
+                    rl = ovector[ch+1] - ovector[ch];
+                    debug("yes, replace \\%d: \"%s\"\n", ch/2, buffer.expand(start+c+ovector[ch], rl)());
+                    s.replace(r, 2, buffer(start+c+ovector[ch]), rl);
+                    r += rl - 1;
+                }
+                else
+                {
+                    debug("no, use literal \\%u\n", ch);
+                    s.remove(r, 1); // just remove escape
+                }
+            }
+            else if (s[r] == '&') // unescaped & : replace with match
+            {
+                debug("replace &: \"%s\"\n", buffer.expand(start+c+ovector[0], l)());
+                s.replace(r, 1, buffer(start+c+ovector[0]), l);
+                r += l - 1;
+            }
+            else continue;
+            debug("subs = \"%s\"\n", s.expand()());
+        }
+        buffer.replace(start+c+ovector[0], l, s);
+        length += s.length() - l;
+        c += ovector[0] + s.length();
+        if (n == fmt.prec) // max match reached
+        {
+            debug("pcre_exec: max match %d reached\n", n);
+            break;
+        }
+    }
+    debug("pcre_exec converted string: %s\n", buffer.expand()());
+}
+
+ssize_t RegexpConverter::
+scanPseudo(const StreamFormat& fmt, StreamBuffer& input, size_t& cursor)
+{
+    /* re-write input buffer */
+    regsubst(fmt, input, cursor);
+    return 0;
+}
+
+bool RegexpConverter::
+printPseudo(const StreamFormat& fmt, StreamBuffer& output)
+{
+    /* re-write output buffer */
+    regsubst(fmt, output, 0);
+    return true;
 }
 
 RegisterConverter (RegexpConverter, "/");

src/StreamBuffer.cc

@@ -4,7 +4,7 @@
 * (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 ../doc/ for a detailed     *
+* 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   *
@@ -26,19 +26,20 @@
 
 #if defined(__vxworks) || defined(vxWorks) || defined(_WIN32) || defined(__rtems__)
 // These systems have no vsnprintf
-#include <epicsStdio.h>
-#define vsnprintf epicsVsnprintf
+#define vsnprintf(p,l,f,v) vsprintf(p,f,v)
 #endif
 
+#define P PRINTF_SIZE_T_PREFIX
+
 void StreamBuffer::
-init(const void* s, long minsize)
+init(const void* s, ssize_t minsize)
 {
     len = 0;
     offs = 0;
     buffer = local;
     cap = sizeof(local);
     if (minsize < 0) minsize = 0;
-    if (minsize >= cap)
+    if ((size_t)minsize >= cap)
     {
         // use allocated buffer
         grow(minsize);
@@ -46,7 +47,7 @@ init(const void* s, long minsize)
     else
     {
         // clear local buffer
-        memset(buffer+minsize, 0, cap-minsize);
+        memset(buffer, 0, cap);
     }
     if (s) {
         len = minsize;
@@ -54,12 +55,19 @@ init(const void* s, long minsize)
     }
 }
 
+// How the buffer looks like:
+// |----free-----|####used####|--------00--------|
+///|<--- offs -->|<-- len --->|<- cap-offs-len ->|
+// 0            offs      offs+len              cap
+//               |<-------------- minsize --------------->
+
+
 void StreamBuffer::
-grow(long minsize)
+grow(size_t minsize)
 {
     // make space for minsize + 1 (for termination) bytes
     char* newbuffer;
-    long newcap;
+    size_t newcap;
 #ifdef EXPLODE
     if (minsize > 1000000)
     {
@@ -102,7 +110,7 @@ grow(long minsize)
     memset(newbuffer+len, 0, newcap-len);
     if (buffer != local)
     {
-        delete buffer;
+        delete [] buffer;
     }
     buffer = newbuffer;
     cap = newcap;
@@ -110,12 +118,12 @@ grow(long minsize)
 }
 
 StreamBuffer& StreamBuffer::
-append(const void* s, long size)
+append(const void* s, ssize_t size)
 {
     if (size <= 0)
     {
         // append negative number of bytes? let's delete some
-        if (size < -len) size = -len;
+        if (size < -(ssize_t)len) size = -(ssize_t)len;
         memset (buffer+offs+len+size, 0, -size);
     }
     else
@@ -127,34 +135,34 @@ append(const void* s, long size)
     return *this;
 }
 
-long int StreamBuffer::
-find(const void* m, long size, long start) const
+ssize_t StreamBuffer::
+find(const void* m, size_t size, ssize_t start) const
 {
     if (start < 0)
     {
         start += len;
         if (start < 0) start = 0;
     }
-    if (start >= len-size+1) return -1; // find nothing after end
+    if (start+size > len) return -1; // find nothing after end
     if (!m || size <= 0) return start; // find empty string at start
     const char* s = static_cast<const char*>(m);
     char* b = buffer+offs;
     char* p = b+start;
-    long i;
+    size_t i;
     while ((p = static_cast<char*>(memchr(p, s[0], b-p+len-size+1))))
     {
-        i = 1;
-        while (p[i] == s[i])
+        for (i = 1; i < size; i++)
         {
-            if (++i >= size) return p-b;
+            if (p[i] != s[i]) goto next;
         }
-        p++;
+        return p-b;
+next:   p++;
     }
     return -1;
 }
 
 StreamBuffer& StreamBuffer::
-replace(long remstart, long remlen, const void* ins, long inslen)
+replace(ssize_t remstart, ssize_t remlen, const void* ins, ssize_t inslen)
 {
     if (remstart < 0)
     {
@@ -180,12 +188,12 @@ replace(long remstart, long remlen, const void* ins, long inslen)
         remlen += remstart;
         remstart = 0;
     }
-    if (remstart > len)
+    if ((size_t)remstart > len)
     {
         // remove begins after bufferend
         remstart = len;
     }
-    if (remlen >= len-remstart)
+    if ((size_t)remlen >= len-remstart)
     {
         // truncate remove after bufferend
         remlen = len-remstart;
@@ -198,12 +206,12 @@ replace(long remstart, long remlen, const void* ins, long inslen)
         return *this;
     }
     if (inslen < 0) inslen = 0;
-    long remend = remstart+remlen;
-    long newlen = len+inslen-remlen;
+    size_t remend = remstart+remlen;
+    size_t newlen = len+inslen-remlen;
     if (cap <= newlen)
     {
         // buffer too short
-        long newcap;
+        size_t newcap;
         for (newcap = sizeof(local)*2; newcap <= newlen; newcap *= 2);
         char* newbuffer = new char[newcap];
         memcpy(newbuffer, buffer+offs, remstart);
@@ -212,7 +220,7 @@ replace(long remstart, long remlen, const void* ins, long inslen)
         memset(newbuffer+newlen, 0, newcap-newlen);
         if (buffer != local)
         {
-            delete buffer;
+            delete [] buffer;
         }
         buffer = newbuffer;
         cap = newcap;
@@ -241,16 +249,16 @@ replace(long remstart, long remlen, const void* ins, long inslen)
 }
 
 StreamBuffer& StreamBuffer::
-printf(const char* fmt, ...)
+print(const char* fmt, ...)
 {
     va_list va;
-    int printed;
+    ssize_t printed;
     while (1)
     {
         va_start(va, fmt);
         printed = vsnprintf(buffer+offs+len, cap-offs-len, fmt, va);
         va_end(va);
-        if (printed > -1 && printed < (int)(cap-offs-len))
+        if (printed > -1 && printed < (ssize_t)(cap-offs-len))
         {
             len += printed;
             return *this;
@@ -260,60 +268,58 @@ printf(const char* fmt, ...)
     }
 }
 
-StreamBuffer StreamBuffer::expand(long start, long length) const
+StreamBuffer StreamBuffer::expand(ssize_t start, ssize_t length) const
 {
-    long end;
+    size_t end;
     if (start < 0)
     {
         start += len;
-        if (start < 0) start = 0;
     }
-    end = length >= 0 ? start+length : len;
+    if (length < 0)
+    {
+        start += length;
+        length = -length;
+    }
+    if (start < 0)
+    {
+        length += start;
+        start = 0;
+    }
+    end = start+length;
     if (end > len) end = len;
-    StreamBuffer result((end-start)*2);
+    StreamBuffer result;
     start += offs;
     end += offs;
-    long i;
+    size_t i;
     char c;
     for (i = start; i < end; i++)
     {
         c = buffer[i];
-        if ((c & 0x7f) < 0x20 || (c & 0x7f) == 0x7f)
-        {
-            result.printf("<%02x>", c & 0xff);
-        }
+        if (c < 0x20 || c >= 0x7f)
+            result.print("\033[1m<%02x>\033[22m", c & 0xff);
         else
-        {
             result.append(c);
     }
-    }
     return result;
 }
 
 StreamBuffer StreamBuffer::
 dump() const
 {
-    StreamBuffer result(256+cap*5);
-    result.append("\033[0m");
-    long i;
-    result.printf("%ld,%ld,%ld:\033[37m", offs, len, cap);
+    StreamBuffer result;
+    size_t i;
+    result.print("%" P "d,%" P "d,%" P "d:", offs, len, cap);
+    if (offs) result.print("\033[47m");
+    char c;
     for (i = 0; i < cap; i++)
     {
-        if (i == offs) result.append("\033[34m[\033[0m");
-        if ((buffer[i] & 0x7f) < 0x20 || (buffer[i] & 0x7f) == 0x7f)
-        {
-            if (i < offs || i >= offs+len)
-            result.printf(
-                "<%02x>", buffer[i] & 0xff);
+        c = buffer[i];
+        if (offs && i == offs) result.append("\033[0m");
+        if (c < 0x20 || c >= 0x7f)
+            result.print("\033[1m<%02x>\033[22m", c & 0xff);
         else
-            result.printf(
-                "\033[34m<%02x>\033[37m", buffer[i] & 0xff);
-        }
-        else
-        {
-            result.append(buffer[i]);
-        }
-        if (i == offs+len-1) result.append("\033[34m]\033[37m");
+            result.append(c);
+        if (i == offs+len-1) result.append("\033[47m");
     }
     result.append("\033[0m");
     return result;

src/StreamBuffer.h

@@ -4,7 +4,7 @@
 * (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 ../doc/ for a detailed     *
+* 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   *
@@ -21,37 +21,46 @@
 #define StreamBuffer_h
 
 #include <string.h>
-#include <stdio.h>
+#include <stdlib.h>
+#include <sys/types.h>
 
 #ifndef __GNUC__
 #define __attribute__(x)
 #endif
 
+#if defined(_WIN32)
+typedef ptrdiff_t ssize_t;
+#endif
+
 class StreamBuffer
 {
     char local[64];
-    long len;
-    long cap;
-    long offs;
+    size_t len;
+    size_t cap;
+    size_t offs;
     char* buffer;
 
-    void grow(long);
-    void init(const void*, long);
+    void init(const void* s, ssize_t minsize);
 
-    void check(long size)
+    void check(size_t size)
         {if (len+offs+size >= cap) grow(len+size);}
 
+    void grow(size_t minsize);
+
 public:
     // Hints:
-    // * Any index parameter (long) can be negative
+    // * Any index parameter (ssize_t) can be negative
     //   meaning "count from end" (-1 is the last byte)
+    // * Appending negative count deletes from end
     // * Any returned char* pointer becomes invalid when
     //   the StreamBuffer is modified.
+    // * End of StreamBuffer always contains 0x00 bytes
+    // * Deleting from start and clearing is fast
 
     StreamBuffer()
         {init(NULL, 0);}
 
-    StreamBuffer(const void*s, long size)
+    StreamBuffer(const void* s, ssize_t size)
         {init(s, size);}
 
     StreamBuffer(const char* s)
@@ -60,24 +69,24 @@ public:
     StreamBuffer(const StreamBuffer& s)
         {init(s.buffer+s.offs, s.len);}
 
-    StreamBuffer(long size)
+    StreamBuffer(ssize_t size)
         {init(NULL, size);}
 
     ~StreamBuffer()
-        {if (buffer != local) delete buffer;}
+        {if (buffer != local) delete [] buffer;}
 
     // operator (): get char* pointing to index
-    const char* operator()(long index=0) const
-        {buffer[offs+len]=0; return buffer+offs+(index<0?index+len:index);}
+    const char* operator()(ssize_t index=0) const
+        {return buffer+offs+(index<0?index+len:index);}
 
-    char* operator()(long index=0)
-        {buffer[offs+len]=0; return buffer+offs+(index<0?index+len:index);}
+    char* operator()(ssize_t index=0)
+        {return buffer+offs+(index<0?index+len:index);}
 
     // operator []: get byte at index
-    char operator[](long index) const
+    char operator[](ssize_t index) const
         {return buffer[offs+(index<0?index+len:index)];}
 
-    char& operator[](long index)
+    char& operator[](ssize_t index)
         {return buffer[offs+(index<0?index+len:index)];}
 
     // cast to bool: not empty?
@@ -85,11 +94,11 @@ public:
         {return len>0;}
 
     // length: get current data length
-    long length() const
+    size_t length() const
         {return len;}
 
     // capacity: get current max data length (spare one byte for end)
-    long capacity() const
+    size_t capacity() const
         {return cap-1;}
 
     // end: get pointer to byte after last data byte
@@ -102,14 +111,19 @@ public:
 
     // reserve: reserve size bytes of memory and return
     // pointer to that memory (for copying something to it)
-    char* reserve(long size)
-        {grow(size); char* p=buffer+len; len+=size; return p;}
+    char* reserve(size_t size)
+        {check(size); char* p=buffer+offs+len; len+=size; return p;}
 
     // append: append data at the end of the buffer
-    StreamBuffer& append(char c, long count=1)
-        {check(count); while(count-->0) buffer[offs+len++]=c; return *this;}
+    StreamBuffer& append(char c)
+        {check(1); buffer[offs+len++]=c; return *this;}
 
-    StreamBuffer& append(const void* s, long size);
+    StreamBuffer& append(char c, ssize_t count)
+        {if (count < 0) truncate(count);
+         else {check(count); memset(buffer+offs+len, c, count); len+=count;}
+         return *this;}
+
+    StreamBuffer& append(const void* s, ssize_t size);
 
     StreamBuffer& append(const char* s)
         {return append(s, s?strlen(s):0);}
@@ -117,8 +131,18 @@ public:
     StreamBuffer& append(const StreamBuffer& s)
         {return append(s.buffer+s.offs, s.len);}
 
+    // operator += alias for append
+    StreamBuffer& operator+=(char c)
+        {return append(c);}
+
+    StreamBuffer& operator+=(const char* s)
+        {return append(s);}
+
+    StreamBuffer& operator+=(const StreamBuffer& s)
+        {return append(s);}
+
     // set: clear buffer and fill with new data
-    StreamBuffer& set(const void* s, long size)
+    StreamBuffer& set(const void* s, size_t size)
         {clear(); return append(s, size);}
 
     StreamBuffer& set(const char* s)
@@ -127,7 +151,7 @@ public:
     StreamBuffer& set(const StreamBuffer& s)
         {clear(); return append(s.buffer+s.offs, s.len);}
 
-    // operator =: alias for set
+    // operator = alias for set
     StreamBuffer& operator=(const char* s)
         {return set(s);}
 
@@ -136,73 +160,86 @@ public:
 
     // replace: delete part of buffer (pos/length) and insert new data
     StreamBuffer& replace(
-        long pos, long length, const void* s, long size);
+        ssize_t pos, ssize_t length, const void* s, ssize_t size);
 
-    StreamBuffer& replace(long pos, long length, const char* s)
+    StreamBuffer& replace(ssize_t pos, ssize_t length, const char* s)
         {return replace(pos, length, s, s?strlen(s):0);}
 
-    StreamBuffer& replace(long pos, long length, const StreamBuffer& s)
+    StreamBuffer& replace(ssize_t pos, ssize_t length, const StreamBuffer& s)
         {return replace(pos, length, s.buffer+s.offs, s.len);}
 
-    // replace: delete part of buffer
-    StreamBuffer& remove(long pos, long length)
+    // remove: delete from start/pos
+    StreamBuffer& remove(ssize_t pos, ssize_t length)
         {return replace(pos, length, NULL, 0);}
 
-    StreamBuffer& remove(long length)
+    // remove from start: no memset, no function call, fast!
+    StreamBuffer& remove(size_t length)
         {if (length>len) length=len;
          offs+=length; len-=length; return *this;}
 
-    // replace: delete end of buffer
-    StreamBuffer& truncate(long pos)
+    // truncate: delete end of buffer
+    StreamBuffer& truncate(ssize_t pos)
         {return replace(pos, len, NULL, 0);}
 
     // insert: insert new data into buffer
-    StreamBuffer& insert(long pos, const void* s, long size)
+    StreamBuffer& insert(ssize_t pos, const void* s, ssize_t size)
         {return replace(pos, 0, s, size);}
 
-    StreamBuffer& insert(long pos, const char* s)
+    StreamBuffer& insert(ssize_t pos, const char* s)
         {return replace(pos, 0, s, s?strlen(s):0);}
 
-    StreamBuffer& insert(long pos, const StreamBuffer& s)
+    StreamBuffer& insert(ssize_t pos, const StreamBuffer& s)
         {return replace(pos, 0, s.buffer+s.offs, s.len);}
 
-    StreamBuffer& insert(long pos, char c)
+    StreamBuffer& insert(ssize_t pos, char c)
         {return replace(pos, 0, &c, 1);}
 
-    StreamBuffer& printf(const char* fmt, ...)
-        __attribute__ ((format(printf,2,3)));
+    StreamBuffer& print(const char* fmt, ...)
+        __attribute__((__format__(__printf__,2,3)));
 
     // find: get index of data in buffer or -1
-    long find(char c, long start=0) const
+    ssize_t find(char c, ssize_t start=0) const
         {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;}
 
-    long find(const void* s, long size, long start=0) const;
+    ssize_t find(const void* s, size_t size, ssize_t start=0) const;
 
-    long find(const char* s, long start=0) const
+    ssize_t find(const char* s, ssize_t start=0) const
         {return find(s, s?strlen(s):0, start);}
 
-    long int find(const StreamBuffer& s, long start=0) const
+    ssize_t find(const StreamBuffer& s, ssize_t start=0) const
         {return find(s.buffer+s.offs, s.len, start);}
 
-    // equals: returns true if first size bytes are equal
-    bool equals(const void* s, long size) const
+    // startswith: returns true if first size bytes are equal
+    bool startswith(const void* s, size_t size) const
         {return len>=size ? memcmp(buffer+offs, s, size) == 0 : false;}
 
-    // equals: returns true if first string is equal (empty string match)
-    bool equals(const char* s) const
+    // startswith: returns true if first string is equal (empty string matches)
+    bool startswith(const char* s) const
         {return len ? strcmp(buffer+offs, s) == 0 : !s || !*s;}
 
 // expand: create copy of StreamBuffer where all nonprintable characters
 // are replaced by <xx> with xx being the hex code of the characters
-    StreamBuffer expand(long start=0, long length=-1) const;
+    StreamBuffer expand(ssize_t start, ssize_t length) const;
+
+    StreamBuffer expand(ssize_t start=0) const
+        {return expand(start, len);}
 
 // dump: debug function, like expand but also show the 'hidden' memory
 // before and after the real data. Uses colours.
     StreamBuffer dump() const;
 };
 
+// printf size prefix for size_t and ssize_t
+#if defined (__GNUC__) && __GNUC__ >= 3
+#define PRINTF_SIZE_T_PREFIX "z"
+#elif defined (_WIN32)
+#define PRINTF_SIZE_T_PREFIX "I"
+#else
+#define PRINTF_SIZE_T_PREFIX ""
+#endif
+
 #endif

src/StreamBusInterface.cc

@@ -4,7 +4,7 @@
 * (C) 2005 Dirk Zimoch (dirk.zimoch@psi.ch)                    *
 *                                                              *
 * This is the interface to bus drivers for StreamDevice.       *
-* Please refer to the HTML files in ../doc/ for a detailed     *
+* 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   *
@@ -17,15 +17,9 @@
 *                                                              *
 ***************************************************************/
 
+#include <stdio.h>
 #include "StreamBusInterface.h"
-
-const char* StreamIoStatusStr[] = {
-    "StreamIoSuccess",
-    "StreamIoTimeout",
-    "StreamIoNoReply",
-    "StreamIoEnd",
-    "StreamIoFault"
-};
+#include "StreamError.h"
 
 StreamBusInterfaceRegistrarBase* StreamBusInterfaceRegistrarBase::first;
 
@@ -64,12 +58,31 @@ supportsAsyncRead()
 StreamBusInterface* StreamBusInterface::
 find(Client* client, const char* busname, int addr, const char* param)
 {
+    debug("StreamBusInterface::find(%s, %s, %d, \"%s\")\n",
+            client->name(), busname, addr, param);
     StreamBusInterfaceRegistrarBase* r;
     StreamBusInterface* bus;
-    for (r = r->first; r; r = r->next)
+    for (r = StreamBusInterfaceRegistrarBase::first; r; r = r->next)
     {
+    debug("StreamBusInterface::find %s check %s\n",
+            client->name(), r->name);
         bus = r->find(client, busname, addr, param);
-        if (bus) return bus;
+        debug("StreamBusInterface::find %s %s\n",
+            r->name, bus ? "matches" : "does not match");
+        if (bus)
+        {
+            if (addr >= 0)
+            {
+                bus->_name = new char[strlen(busname) + sizeof(int)*2 + sizeof(int)/2 + 2];
+                sprintf(bus->_name, "%s %d", busname, addr);
+            }
+            else
+            {
+                bus->_name = new char[strlen(busname) + 1];
+                strcpy(bus->_name, busname);
+            }
+            return bus;
+        }
     }
     return NULL;
 }
@@ -105,7 +118,7 @@ writeRequest(const void*, size_t, unsigned long)
 }
 
 bool StreamBusInterface::
-readRequest(unsigned long, unsigned long, long, bool)
+readRequest(unsigned long, unsigned long, size_t, bool)
 {
     return false;
 }
@@ -125,8 +138,8 @@ writeCallback(StreamIoStatus)
 {
 }
 
-long StreamBusInterface::Client::
-readCallback(StreamIoStatus, const void*, long)
+ssize_t StreamBusInterface::Client::
+readCallback(StreamIoStatus, const void*, size_t)
 {
     return 0;
 }

src/StreamBusInterface.h

@@ -4,7 +4,7 @@
 * (C) 2005 Dirk Zimoch (dirk.zimoch@psi.ch)                    *
 *                                                              *
 * This is the interface to bus drivers for StreamDevice.       *
-* Please refer to the HTML files in ../doc/ for a detailed     *
+* 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   *
@@ -21,13 +21,12 @@
 #define StreamBusInterface_h
 
 #include <stddef.h>
+#include "StreamBuffer.h"
+#include "MacroMagic.h"
 
-enum StreamIoStatus {
+ENUM (StreamIoStatus,
     StreamIoSuccess, StreamIoTimeout, StreamIoNoReply,
-    StreamIoEnd, StreamIoFault
-};
-
-extern const char* StreamIoStatusStr[];
+    StreamIoEnd, StreamIoFault);
 
 class StreamBusInterface
 {
@@ -35,86 +34,93 @@ public:
 
     class Client
     {
+    private:
         friend class StreamBusInterface;
+
         virtual void lockCallback(StreamIoStatus status) = 0;
         virtual void writeCallback(StreamIoStatus status);
-        virtual long readCallback(StreamIoStatus status,
-            const void* input, long size);
+        virtual ssize_t readCallback(StreamIoStatus status,
+            const void* input, size_t size);
         virtual void eventCallback(StreamIoStatus status);
         virtual void connectCallback(StreamIoStatus status);
         virtual void disconnectCallback(StreamIoStatus status);
         virtual long priority();
-        virtual const char* name() = 0;
         virtual const char* getInTerminator(size_t& length) = 0;
         virtual const char* getOutTerminator(size_t& length) = 0;
     public:
+        virtual const char* name() = 0;
         virtual ~Client();
     protected:
         StreamBusInterface* businterface;
         bool busSupportsEvent() {
-            return businterface->supportsEvent();
+            return businterface && businterface->supportsEvent();
         }
         bool busSupportsAsyncRead() {
-            return businterface->supportsAsyncRead();
+            return businterface && businterface->supportsAsyncRead();
         }
         bool busAcceptEvent(unsigned long mask,
             unsigned long replytimeout_ms) {
-            return businterface->acceptEvent(mask, replytimeout_ms);
+            return businterface && businterface->acceptEvent(mask, replytimeout_ms);
         }
         void busRelease() {
-            businterface->release();
+            if (businterface) businterface->release();
         }
         bool busLockRequest(unsigned long timeout_ms) {
-            return businterface->lockRequest(timeout_ms);
+            return businterface && businterface->lockRequest(timeout_ms);
         }
         bool busUnlock() {
-            return businterface->unlock();
+            return businterface && businterface->unlock();
         }
         bool busWriteRequest(const void* output, size_t size,
             unsigned long timeout_ms) {
-            return businterface->writeRequest(output, size, timeout_ms);
+            return businterface && businterface->writeRequest(output, size, timeout_ms);
         }
         bool busReadRequest(unsigned long replytimeout_ms,
-            unsigned long readtimeout_ms, long expectedLength,
+            unsigned long readtimeout_ms, size_t expectedLength,
             bool async) {
-            return businterface->readRequest(replytimeout_ms,
+            return businterface && businterface->readRequest(replytimeout_ms,
                     readtimeout_ms, expectedLength, async);
         }
         void busFinish() {
-            businterface->finish();
+            if (businterface) businterface->finish();
         }
         bool busConnectRequest(unsigned long timeout_ms) {
-            return businterface->connectRequest(timeout_ms);
+            return businterface && businterface->connectRequest(timeout_ms);
         }
         bool busDisconnect() {
-            return businterface->disconnectRequest();
+            return businterface && businterface->disconnectRequest();
+        }
+        void busPrintStatus(StreamBuffer& buffer) {
+            if (businterface) businterface->printStatus(buffer);
         }
     };
 
 private:
     friend class StreamBusInterfaceClass; // the iterator
     friend class Client;
+    char* _name;
 
 public:
     Client* client;
     virtual ~StreamBusInterface() {};
+    const char* name() { return _name; }
 
 protected:
     StreamBusInterface(Client* client);
 
 // map client functions into StreamBusInterface namespace
-    void lockCallback(StreamIoStatus status)
+    void lockCallback(StreamIoStatus status = StreamIoSuccess)
         { client->lockCallback(status); }
-    void writeCallback(StreamIoStatus status)
+    void writeCallback(StreamIoStatus status = StreamIoSuccess)
         { client->writeCallback(status); }
-    long readCallback(StreamIoStatus status,
-        const void* input = NULL, long size = 0)
+    ssize_t readCallback(StreamIoStatus status,
+        const void* input = NULL, size_t size = 0)
         { return client->readCallback(status, input, size); }
-    void eventCallback(StreamIoStatus status)
+    void eventCallback(StreamIoStatus status = StreamIoSuccess)
         { client->eventCallback(status); }
-    void connectCallback(StreamIoStatus status)
+    void connectCallback(StreamIoStatus status = StreamIoSuccess)
         { client->connectCallback(status); }
-    void disconnectCallback(StreamIoStatus status)
+    void disconnectCallback(StreamIoStatus status = StreamIoSuccess)
         { client->disconnectCallback(status); }
     const char* getInTerminator(size_t& length)
         { return client->getInTerminator(length); }
@@ -127,7 +133,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, long expectedLength,
+        unsigned long readtimeout_ms, size_t expectedLength,
         bool async);
     virtual bool supportsEvent(); // defaults to false
     virtual bool supportsAsyncRead(); // defaults to false
@@ -137,6 +143,7 @@ protected:
     virtual bool connectRequest(unsigned long connecttimeout_ms);
     virtual bool disconnectRequest();
     virtual void finish();
+    virtual void printStatus(StreamBuffer& buffer) {};
 
 // pure virtual
     virtual bool lockRequest(unsigned long timeout_ms) = 0;