version update

doc/formats.html

@@ -132,6 +132,7 @@ 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>Redirection</h3>
 <p>
 To use other fields of the record or even fields of other records on the

doc/nav.html

@@ -178,6 +178,7 @@ div div div a {list-style-type:circle;}
   <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>
 

doc/tipsandtricks.html

@@ -103,7 +103,7 @@ an array: (3.14, 17.30, -12.34)
 <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>
@@ -128,7 +128,7 @@ record (calcout, "$(RECORD)") {<br>
 </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>
@@ -216,7 +216,7 @@ 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>
@@ -244,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>
@@ -289,9 +289,124 @@ record (stringout, "$(DEVICE):clean_2") {<br>
 &nbsp;&nbsp;field (VAL, "OK")<br>
 &nbsp;&nbsp;field (OUT,  "$(DEVICE):message PP")<br>
 }<br>
-
 </code>
+<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>
 <hr>
-<p><small>Dirk Zimoch, 2007</small></p>
+<p><small>Dirk Zimoch, 2012</small></p>
 </body>
 </html>

makefile

@@ -35,6 +35,7 @@ SOURCES += $(BUSSES:%=src/%Interface.cc)
 SOURCES += $(wildcard src/Stream*.cc)
 SOURCES += src/StreamVersion.c
 
+HEADERS += devStream.h
 HEADERS += StreamFormat.h
 HEADERS += StreamFormatConverter.h
 HEADERS += StreamBuffer.h

src/AsynDriverInterface.cc

@@ -22,14 +22,19 @@
 #include "StreamError.h"
 #include "StreamBuffer.h"
 
-#ifdef EPICS_3_14
-#include <epicsAssert.h>
-#include <epicsTime.h>
-#include <epicsTimer.h>
-#else
+#include <epicsVersion.h>
+#ifdef BASE_VERSION
+#define EPICS_3_13
+#endif
+
+#ifdef EPICS_3_13
 #include <assert.h>
 #include <wdLib.h>
 #include <sysLib.h>
+#else
+#include <epicsAssert.h>
+#include <epicsTime.h>
+#include <epicsTimer.h>
 extern "C" {
 #include <callback.h>
 }
@@ -126,7 +131,7 @@ static const char* ioActionStr[] = {
 };
 
 static const char* asynStatusStr[] = {
-    "asynSuccess", "asynTimeout", "asynOverflow", "asynError"
+    "asynSuccess", "asynTimeout", "asynOverflow", "asynError", "asynDisconnected", "asynDisabled"
 };
 
 static const char* eomReasonStr[] = {
@@ -134,7 +139,7 @@ static const char* eomReasonStr[] = {
 };
 
 class AsynDriverInterface : StreamBusInterface
-#ifdef EPICS_3_14
+#ifndef EPICS_3_13
  , epicsTimerNotify
 #endif
 {
@@ -164,12 +169,12 @@ class AsynDriverInterface : StreamBusInterface
     const char* outputBuffer;
     size_t outputSize;
     int peeksize;
-#ifdef EPICS_3_14
-    epicsTimerQueueActive* timerQueue;
-    epicsTimer* timer;
-#else
+#ifdef EPICS_3_13
     WDOG_ID timer;
     CALLBACK timeoutCallback;
+#else
+    epicsTimerQueueActive* timerQueue;
+    epicsTimer* timer;
 #endif
 
     AsynDriverInterface(Client* client);
@@ -189,11 +194,11 @@ class AsynDriverInterface : StreamBusInterface
     bool disconnectRequest();
     void finish();
 
-#ifdef EPICS_3_14
+#ifdef EPICS_3_13
+    static void expire(CALLBACK *pcallback);
+#else
     // epicsTimerNotify methods
     epicsTimerNotify::expireStatus expire(const epicsTime &);
-#else
-    static void expire(CALLBACK *pcallback);
 #endif
 
     // local methods
@@ -211,20 +216,22 @@ class AsynDriverInterface : StreamBusInterface
             (StreamBusInterface::priority());
     }
     void startTimer(double timeout) {
-#ifdef EPICS_3_14
-        timer->start(*this, timeout);
-#else
+#ifdef EPICS_3_13
         callbackSetPriority(priority(), &timeoutCallback);
         wdStart(timer, (int)((timeout+1)*sysClkRateGet())-1,
             reinterpret_cast<FUNCPTR>(callbackRequest),
             reinterpret_cast<int>(&timeoutCallback));
+#else
+        timer->start(*this, timeout
+            +epicsThreadSleepQuantum()*0.5
+        );
 #endif
     }
     void cancelTimer() {
-#ifdef EPICS_3_14
-        timer->cancel();
-#else
+#ifdef EPICS_3_13
         wdCancel(timer);
+#else
+        timer->cancel();
 #endif
     }
 
@@ -263,15 +270,15 @@ AsynDriverInterface(Client* client) : StreamBusInterface(client)
         handleTimeout);
     assert(pasynUser);
     pasynUser->userPvt = this;
-#ifdef EPICS_3_14
+#ifdef EPICS_3_13
+    timer = wdCreate();
+    callbackSetCallback(expire, &timeoutCallback);
+    callbackSetUser(this, &timeoutCallback);
+#else
     timerQueue = &epicsTimerQueueActive::allocate(true);
     assert(timerQueue);
     timer = &timerQueue->createTimer();
     assert(timer);
-#else
-    timer = wdCreate();
-    callbackSetCallback(expire, &timeoutCallback);
-    callbackSetUser(this, &timeoutCallback);
 #endif
 }
 
@@ -306,11 +313,11 @@ AsynDriverInterface::
     }
     // Now, no handler is running any more and none will start.
 
-#ifdef EPICS_3_14
+#ifdef EPICS_3_13
+    wdDelete(timer);
+#else
     timer->destroy();
     timerQueue->release();
-#else
-    wdDelete(timer);
 #endif
     pasynManager->disconnect(pasynUser);
     pasynManager->freeAsynUser(pasynUser);
@@ -516,7 +523,7 @@ connectToAsynPort()
         status = pasynOctet->read(pvtOctet, pasynUser,
             buffer, 0, &received, &eomReason);
         debug("AsynDriverInterface::connectToAsynPort(%s): "
-            "read(..., 0, ...) [timeout=%f seconds] = %s\n",
+            "read(..., 0, ...) [timeout=%g sec] = %s\n",
             clientName(), pasynUser->timeout,
             asynStatusStr[status]);
         pasynManager->isConnected(pasynUser, &connected);
@@ -610,19 +617,26 @@ writeHandler()
         clientName());
     asynStatus status;
     size_t written = 0;
-    pasynUser->timeout = writeTimeout;
 
-    // discard any early input or early events
-    status = pasynOctet->flush(pvtOctet, pasynUser);
+    // discard any early input, but forward it to potential async records
+    // thus do not use pasynOctet->flush()
+    pasynUser->timeout = 0;
+    do {
+        char buffer [256];
+        size_t received = sizeof(buffer);
+        int eomReason = 0;
+        status = pasynOctet->read(pvtOctet, pasynUser,
+            buffer, received, &received, &eomReason);
+#ifndef NO_TEMPORARY
+        if (received) debug("AsynDriverInterface::writeHandler(%s): flushing %ld bytes: \"%s\"\n",
+            clientName(), (long)received, StreamBuffer(buffer, received).expand()());
+#endif
+    } while (status != asynTimeout);
+        
+    // discard any early events
     receivedEvent = 0;
-
-    if (status != asynSuccess)
-    {
-        error("%s: pasynOctet->flush() failed: %s\n",
-                clientName(), pasynUser->errorMessage);
-        writeCallback(StreamIoFault);
-        return;
-    }
+    
+    pasynUser->timeout = writeTimeout;
     
     // has stream already added a terminator or should
     // asyn do so?
@@ -648,7 +662,7 @@ writeHandler()
         outputBuffer, outputSize, &written);
     debug("AsynDriverInterface::writeHandler(%s): "
         "write(..., outputSize=%ld, written=%ld) "
-        "[timeout=%f seconds] = %s\n",
+        "[timeout=%g sec] = %s\n",
         clientName(), (long)outputSize,  (long)written,
         pasynUser->timeout, asynStatusStr[status]);
 
@@ -732,7 +746,7 @@ readRequest(unsigned long replyTimeout_ms, unsigned long readTimeout_ms,
     long _expectedLength, bool async)
 {
     debug("AsynDriverInterface::readRequest(%s, %ld msec reply, "
-        "%ld msec read, expect %ld bytes, asyn=%s)\n",
+        "%ld msec read, expect %ld bytes, async=%s)\n",
         clientName(), replyTimeout_ms, readTimeout_ms,
         _expectedLength, async?"yes":"no");
         
@@ -756,8 +770,20 @@ readRequest(unsigned long replyTimeout_ms, unsigned long readTimeout_ms,
     }
     status = pasynManager->queueRequest(pasynUser,
         priority(), queueTimeout);
-    if (status != asynSuccess && !async)
+    debug("AsynDriverInterface::readRequest %s: "
+        "queueRequest(..., priority=%d, queueTimeout=%g sec) = %s [async=%s] %s\n",
+        clientName(), priority(), queueTimeout,
+        asynStatusStr[status], async? "true" : "false",
+        status!=asynSuccess ? pasynUser->errorMessage : "");
+    if (status != asynSuccess)
     {
+        // Not queued for some reason (e.g. disconnected / already queued)
+        if (async)
+        {
+            // silently try again later
+            startTimer(replyTimeout);
+            return true;
+        }
         error("%s readRequest: pasynManager->queueRequest() failed: %s\n",
             clientName(), pasynUser->errorMessage);
         return false;
@@ -863,27 +889,26 @@ readHandler()
         received = 0;
         eomReason = 0;
         
+        debug("AsynDriverInterface::readHandler(%s): ioAction=%s "
+            "read(..., bytesToRead=%ld, ...) "
+            "[timeout=%g sec]\n",
+            clientName(), ioActionStr[ioAction],
+            bytesToRead, pasynUser->timeout);
         status = pasynOctet->read(pvtOctet, pasynUser,
             buffer, bytesToRead, &received, &eomReason);
-        if (ioAction == Read || status != asynTimeout)
-        {
-            debug("AsynDriverInterface::readHandler(%s): "
-                "read(..., bytesToRead=%ld, received=%ld...) "
-                "[timeout=%f seconds] = %s\n",
-                clientName(), bytesToRead, (long)received,
-                pasynUser->timeout, asynStatusStr[status]);
-        }
+        debug("AsynDriverInterface::readHandler(%s): "
+            "read returned %s: ioAction=%s received=%ld, eomReason=%s, buffer=\"%s\"\n",
+            clientName(), asynStatusStr[status], ioActionStr[ioAction],
+            (long)received,eomReasonStr[eomReason&0x7],
+            StreamBuffer(buffer, received).expand()());
+
         pasynManager->isConnected(pasynUser, &connected);
         debug("AsynDriverInterface::readHandler(%s): "
-            "device is %sconnected\n",
-            clientName(),connected?"":"dis");
-        if (!connected) {
-            error("%s: connection closed in read\n",
-                clientName());
-            readCallback(StreamIoFault);
-            return;
-        }
-        // pasynOctet->read() has already cut off terminator.
+            "device is now %sconnected\n",
+            clientName(),connected?"":"dis");        
+        // asyn 4.16 sets reason to ASYN_EOM_END when device disconnects.
+        // What about earlier versions?
+        if (!connected) eomReason |= ASYN_EOM_END;
         
         if (status == asynTimeout &&
             pasynUser->timeout == 0.0 &&
@@ -910,6 +935,7 @@ readHandler()
 #endif
                     // ignore what we got from here.
                     // input was already handeled by asynReadHandler()
+
                     // read until no more input is available
                     readMore = -1;
                     break;
@@ -959,6 +985,9 @@ readHandler()
                     // reply timeout
                     if (ioAction == AsyncRead)
                     {
+                        debug("AsynDriverInterface::readHandler(%s): "
+                            "no async input, retry in in %g seconds\n",
+                            clientName(), replyTimeout);
                         // start next poll after timer expires
                         if (replyTimeout != 0.0) startTimer(replyTimeout);
                         // continues with:
@@ -975,7 +1004,7 @@ readHandler()
                 // read timeout
 #ifndef NO_TEMPORARY
                 debug("AsynDriverInterface::readHandler(%s): "
-                        "ioAction=%s, timeout [%f seconds] "
+                        "ioAction=%s, timeout [%g sec] "
                         "after %ld of %ld bytes \"%s\"\n",
                     clientName(), ioActionStr[ioAction], pasynUser->timeout,
                     (long)received, bytesToRead,
@@ -1236,6 +1265,9 @@ timerExpired()
     int autoconnect, connected;
     switch (ioAction)
     {
+        case None:
+            // Timeout of async poll crossed with parasitic input
+            return;
         case ReceiveEvent:
             // timeout while waiting for event
             ioAction = None;
@@ -1254,6 +1286,8 @@ timerExpired()
             // queueRequest might fail if another request was just queued
             pasynManager->isAutoConnect(pasynUser, &autoconnect);
             pasynManager->isConnected(pasynUser, &connected);
+            debug("%s: polling for I/O Intr: autoconnected: %d, connect: %d\n",
+                clientName(), autoconnect, connected);
             if (autoconnect && !connected)
             {
                 // has explicitely been disconnected
@@ -1264,8 +1298,14 @@ timerExpired()
             else
             {
                 // queue for read poll (no timeout)
-                pasynManager->queueRequest(pasynUser,
+                asynStatus status = pasynManager->queueRequest(pasynUser,
                     asynQueuePriorityLow, -1.0);
+                // if this fails, we are already queued by another thread
+                debug("AsynDriverInterface::timerExpired %s: "
+                    "queueRequest(..., priority=Low, queueTimeout=-1) = %s %s\n",
+                    clientName(), asynStatusStr[status],
+                    status!=asynSuccess ? pasynUser->errorMessage : "");
+                if (status != asynSuccess) startTimer(replyTimeout);
                 // continues with:
                 //    handleRequest() -> readHandler() -> readCallback()
             }
@@ -1277,14 +1317,7 @@ timerExpired()
     }
 }
 
-#ifdef EPICS_3_14
-epicsTimerNotify::expireStatus AsynDriverInterface::
-expire(const epicsTime &)
-{
-    timerExpired();
-    return noRestart;
-}
-#else
+#ifdef EPICS_3_13
 void AsynDriverInterface::
 expire(CALLBACK *pcallback)
 {
@@ -1292,6 +1325,13 @@ expire(CALLBACK *pcallback)
         static_cast<AsynDriverInterface*>(pcallback->user);
     interface->timerExpired();
 }
+#else
+epicsTimerNotify::expireStatus AsynDriverInterface::
+expire(const epicsTime &)
+{
+    timerExpired();
+    return noRestart;
+}
 #endif
 
 bool AsynDriverInterface::
@@ -1390,6 +1430,7 @@ void handleRequest(asynUser* pasynUser)
 {
     AsynDriverInterface* interface =
         static_cast<AsynDriverInterface*>(pasynUser->userPvt);
+    interface->cancelTimer();
     debug("AsynDriverInterface::handleRequest(%s) %s\n",
         interface->clientName(), ioActionStr[interface->ioAction]);
     switch (interface->ioAction)

src/BinaryConverter.cc

@@ -130,9 +130,10 @@ scanLong(const StreamFormat& format, const char* input, long& value)
     int width = format.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 (!isspace(zero) && !isspace(one))
+        while (isspace(input[length])) length++; // skip whitespaces
     if (input[length] != zero && input[length] != one) return -1;
     if (format.flags & alt_flag)
     {

src/Makefile

@@ -79,12 +79,11 @@ include $(TOP)/configure/RULES
 
 # Update version string (contains __DATE__ and __TIME__)
 # each time make runs.
-StreamVersion$(OBJ): FORCE
-FORCE:
+StreamVersion$(OBJ): ../*.c ../*.h ../*.cc ../CONFIG_STREAM ../Makefile
 
 # Add references to all registrars to main file to avoid
 # missing initialization.
-StreamCore$(OBJ): streamReferences
+StreamCore$(OBJ) StreamCore$(DEP): streamReferences
 
 streamReferences: ../CONFIG_STREAM
 	$(PERL) ../makeref.pl Interface $(BUSSES) > $@
@@ -94,4 +93,7 @@ streamReferences: ../CONFIG_STREAM
 $(COMMON_DIR)/$(LIBRARY_DEFAULT).dbd: ../CONFIG_STREAM
 	$(PERL) ../makedbd.pl $(RECORDS) > $@
 
+$(LIBRARY_DEFAULT).dbd$(DEP): ../CONFIG_STREAM
+	echo $(LIBRARY_DEFAULT).dbd: $< > $@
+
 endif

src/Makefile.Host

@@ -39,7 +39,4 @@ include $(TOP)/config/RULES.Host
 
 # create stream.dbd from all RECORDS
 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 $(RECORDS_3_13) > $@

src/RegexpConverter.cc

@@ -110,7 +110,7 @@ scanString(const StreamFormat& fmt, const char* input,
     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",
+            error("Regexp: Matching string \"%s\" too long (%d>%d bytes). You may want to try the + flag: \"%%+/.../\"\n",
                 StreamBuffer(input+ovector[subexpr*2], len).expand()(),
                 (int)len, (int)maxlen-1);
             return -1;

src/StreamBusInterface.h

@@ -52,42 +52,62 @@ public:
     protected:
         StreamBusInterface* businterface;
         bool busSupportsEvent() {
-            return businterface->supportsEvent();
+            if (businterface)
+                return businterface->supportsEvent();
+            else return false;
         }
         bool busSupportsAsyncRead() {
-            return businterface->supportsAsyncRead();
+            if (businterface)
+                return businterface->supportsAsyncRead();
+            else return false;
         }
         bool busAcceptEvent(unsigned long mask,
             unsigned long replytimeout_ms) {
-            return businterface->acceptEvent(mask, replytimeout_ms);
+            if (businterface)
+                return businterface->acceptEvent(mask, replytimeout_ms);
+            else return false;
         }
         void busRelease() {
-            businterface->release();
+            if (businterface)
+                businterface->release();
         }
         bool busLockRequest(unsigned long timeout_ms) {
-            return businterface->lockRequest(timeout_ms);
+            if (businterface)
+                return businterface->lockRequest(timeout_ms);
+            else return false;
         }
         bool busUnlock() {
-            return businterface->unlock();
+            if (businterface)
+                return businterface->unlock();
+            else return false;
         }
         bool busWriteRequest(const void* output, size_t size,
             unsigned long timeout_ms) {
-            return businterface->writeRequest(output, size, timeout_ms);
+            if (businterface)
+                return businterface->writeRequest(output, size, timeout_ms);
+            else return false;
         }
         bool busReadRequest(unsigned long replytimeout_ms,
             unsigned long readtimeout_ms, long expectedLength,
             bool async) {
-            return businterface->readRequest(replytimeout_ms,
-                readtimeout_ms, expectedLength, async);
+            if (businterface)
+                return businterface->readRequest(replytimeout_ms,
+                    readtimeout_ms, expectedLength, async);
+            else return false;
         }
         void busFinish() {
-            businterface->finish();
+            if (businterface)
+                businterface->finish();
         }
         bool busConnectRequest(unsigned long timeout_ms) {
-            return businterface->connectRequest(timeout_ms);
+            if (businterface)
+                return businterface->connectRequest(timeout_ms);
+            else return false;
         }
         bool busDisconnect() {
-            return businterface->disconnectRequest();
+            if (businterface)
+                return businterface->disconnectRequest();
+            else return false;
         }
     };
 

src/StreamCore.cc

@@ -118,7 +118,6 @@ printProtocol()
     if (onMismatch)
         printf("  @Mismatch {\n%s  }\n",
         printCommands(buffer.clear(), onMismatch()));
-    debug("StreamCore::printProtocol: commands=%s\n", commands.expand()());
     printf("\n%s}\n",
         printCommands(buffer.clear(), commands()));
 }
@@ -1159,8 +1158,7 @@ matchInput()
     */
     char command;
     const char* fieldName = NULL;
-    const char* formatstring;
-    int formatstringlen;
+    StreamBuffer formatstring;
     
     consumedInput = 0;
     
@@ -1186,22 +1184,14 @@ normal_format:
                 int consumed;
                 // code layout:
                 // formatstring <eos> StreamFormat [info]
-                formatstring = commandIndex;
-                // jump after <eos>
-                while (*commandIndex)
-                {
-                    if (*commandIndex == esc) commandIndex++;
-                    commandIndex++;
-                }
-                formatstringlen = commandIndex-formatstring;
-                commandIndex++;
+                commandIndex = StreamProtocolParser::printString(formatstring, commandIndex);
                 
                 StreamFormat fmt = extract<StreamFormat>(commandIndex);
                 fmt.info = commandIndex; // point to info string
                 commandIndex += fmt.infolen;
 #ifndef NO_TEMPORARY
-                debug("StreamCore::matchInput(%s): format = %%%s\n",
-                    name(), StreamBuffer(formatstring, formatstringlen).expand()());
+                debug("StreamCore::matchInput(%s): format = \"%%%s\"\n",
+                    name(), formatstring());
 #endif
 
                 if (fmt.flags & skip_flag || fmt.type == pseudo_format)
@@ -1243,10 +1233,10 @@ normal_format:
                         {
                             if (!(flags & AsyncMode) && onMismatch[0] != in_cmd)
                             {
-                                error("%s: Input \"%s%s\" does not match format %%%s\n",
+                                error("%s: Input \"%s%s\" does not match format \"%%%s\"\n",
                                     name(), inputLine.expand(consumedInput, 20)(),
                                     inputLine.length()-consumedInput > 20 ? "..." : "",
-                                    formatstring);
+                                    formatstring());
                             }
                             return false;
                         }
@@ -1260,13 +1250,12 @@ normal_format:
                     flags &= ~Separator;
                     if (!formatValue(fmt, fieldAddress ? fieldAddress() : NULL))
                     {
-                        StreamBuffer formatstr(formatstring, formatstringlen);
                         if (fieldAddress)
-                            error("%s: Cannot format field '%s' with '%%%s'\n",
-                                name(), fieldName, formatstr.expand()());
+                            error("%s: Cannot format variable \"%s\" with \"%%%s\"\n",
+                                name(), fieldName, formatstring());
                         else
-                            error("%s: Cannot format value with '%%%s'\n",
-                                name(), formatstr.expand()());
+                            error("%s: Cannot format value with \"%%%s\"\n",
+                                name(), formatstring());
                         return false;
                     }
 #ifndef NO_TEMPORARY
@@ -1279,11 +1268,11 @@ normal_format:
                         if (!(flags & AsyncMode) && onMismatch[0] != in_cmd)
                         {
                             error("%s: Input \"%s%s\" too short."
-                                  " No match for format %%%s (\"%s\")\n",
+                                  " No match for format \"%%%s\" (\"%s\")\n",
                                 name(), 
                                 inputLine.length() > 20 ? "..." : "",
                                 inputLine.expand(-20)(),
-                                formatstring,
+                                formatstring(),
                                 outputLine.expand()());
                         }
                         return false;
@@ -1292,11 +1281,10 @@ normal_format:
                     {
                         if (!(flags & AsyncMode) && onMismatch[0] != in_cmd)
                         {
-                            error("%s: Input \"%s%s\" does not match"
-                                  " format %%%s (\"%s\")\n",
+                            error("%s: Input \"%s%s\" does not match format \"%%%s\" (\"%s\")\n",
                                 name(), inputLine.expand(consumedInput, 20)(),
                                 inputLine.length()-consumedInput > 20 ? "..." : "",
-                                formatstring,
+                                formatstring(),
                                 outputLine.expand()());
                         }
                         return false;
@@ -1310,13 +1298,13 @@ normal_format:
                     if (!(flags & AsyncMode) && onMismatch[0] != in_cmd)
                     {
                         if (flags & ScanTried)
-                            error("%s: Input \"%s%s\" does not match format %%%s\n",
+                            error("%s: Input \"%s%s\" does not match format \"%%%s\"\n",
                                 name(), inputLine.expand(consumedInput, 20)(),
                                 inputLine.length()-consumedInput > 20 ? "..." : "",
-                                formatstring);
+                                formatstring());
                         else
-                            error("%s: Format %%%s has data type %s which does not match this variable.\n",
-                                name(), formatstring, StreamFormatTypeStr[fmt.type] );
+                            error("%s: Format \"%%%s\" has data type %s which does not match variable \"%s\".\n",
+                                name(), formatstring(), StreamFormatTypeStr[fmt.type], fieldName);
                     }
                     return false;
                 }

src/StreamEpics.cc

@@ -18,11 +18,16 @@
 *                                                              *
 ***************************************************************/
 
+#include "devStream.h"
 #include "StreamCore.h"
 #include "StreamError.h"
-#include "devStream.h"
 
-#ifndef EPICS_3_14
+#include <epicsVersion.h>
+#ifdef BASE_VERSION
+#define EPICS_3_13
+#endif
+
+#ifdef EPICS_3_13
 extern "C" {
 #endif
 
@@ -34,10 +39,11 @@ extern "C" {
 #include <recSup.h>
 #include <recGbl.h>
 #include <devLib.h>
+#define epicsAlarmGLOBAL
 #include <alarm.h>
 #include <callback.h>
 
-#ifndef EPICS_3_14
+#ifdef EPICS_3_13
 
 #include <semLib.h>
 #include <wdLib.h>
@@ -87,24 +93,24 @@ extern "C" void streamRecordProcessCallback(CALLBACK *pcallback);
 extern "C" long streamReload(char* recordname);
 
 class Stream : protected StreamCore
-#ifdef EPICS_3_14
+#ifndef EPICS_3_13
     , epicsTimerNotify
 #endif
 {
     dbCommon* record;
-    struct link *ioLink;
+    const struct link *ioLink;
     streamIoFunction readData;
     streamIoFunction writeData;
-#ifdef EPICS_3_14
-    epicsTimerQueueActive* timerQueue;
-    epicsTimer* timer;
-    epicsMutex mutex;
-    epicsEvent initDone;
-#else
+#ifdef EPICS_3_13
     WDOG_ID timer;
     CALLBACK timeoutCallback;
     SEM_ID mutex;
     SEM_ID initDone;
+#else
+    epicsTimerQueueActive* timerQueue;
+    epicsTimer* timer;
+    epicsMutex mutex;
+    epicsEvent initDone;
 #endif
     StreamBuffer fieldBuffer;
     int status;
@@ -115,11 +121,11 @@ class Stream : protected StreamCore
     CALLBACK processCallback;
 
 
-#ifdef EPICS_3_14
+#ifdef EPICS_3_13
+    static void expire(CALLBACK *pcallback);
+#else
 // epicsTimerNotify method
     expireStatus expire(const epicsTime&);
-#else
-    static void expire(CALLBACK *pcallback);
 #endif
 
 // StreamCore methods
@@ -139,16 +145,19 @@ class Stream : protected StreamCore
     friend void streamRecordProcessCallback(CALLBACK *pcallback);
 
 // Stream Epics methods
-    long initRecord();
-    Stream(dbCommon* record, struct link *ioLink,
+    Stream(dbCommon* record, const struct link *ioLink,
         streamIoFunction readData, streamIoFunction writeData);
     ~Stream();
+    long parseLink(const struct link *ioLink, char* filename, char* protocol,
+        char* busname, int* addr, char* busparam);
+    long initRecord(const char* filename, const char* protocol,
+        const char* busname, int addr, const char* busparam);
     bool print(format_t *format, va_list ap);
     bool scan(format_t *format, void* pvalue, size_t maxStringSize);
     bool process();
 
 // device support functions
-    friend long streamInitRecord(dbCommon *record, struct link *ioLink,
+    friend long streamInitRecord(dbCommon *record, const struct link *ioLink,
         streamIoFunction readData, streamIoFunction writeData);
     friend long streamReadWrite(dbCommon *record);
     friend long streamGetIointInfo(int cmd, dbCommon *record,
@@ -166,7 +175,7 @@ public:
 
 
 // shell functions ///////////////////////////////////////////////////////
-#ifdef EPICS_3_14
+#ifndef EPICS_3_13
 extern "C" {
 epicsExportAddress(int, streamDebug);
 }
@@ -225,7 +234,7 @@ extern "C" long streamReload(char* recordname)
     return OK;
 }
 
-#ifdef EPICS_3_14
+#ifndef EPICS_3_13
 static const iocshArg streamReloadArg0 =
     { "recordname", iocshArgString };
 static const iocshArg * const streamReloadArgs[] =
@@ -251,7 +260,7 @@ static void streamRegistrar ()
 extern "C" {
 epicsExportRegistrar(streamRegistrar);
 }
-#endif // EPICS_3_14
+#endif
 
 // driver support ////////////////////////////////////////////////////////
 
@@ -265,19 +274,13 @@ struct stream_drvsup {
     Stream::drvInit
 };
 
-#ifdef EPICS_3_14
+#ifndef EPICS_3_13
 extern "C" {
 epicsExportAddress(drvet, stream);
 }
+#endif
 
-void streamEpicsPrintTimestamp(char* buffer, int size)
-{
-    int tlen;
-    epicsTime tm = epicsTime::getCurrent();
-    tlen = tm.strftime(buffer, size, "%Y/%m/%d %H:%M:%S.%03f");
-    sprintf(buffer+tlen, " %.*s", size-tlen-2, epicsThreadGetNameSelf());
-}
-#else
+#ifdef EPICS_3_13
 void streamEpicsPrintTimestamp(char* buffer, int size)
 {
     int tlen;
@@ -292,6 +295,14 @@ void streamEpicsPrintTimestamp(char* buffer, int size)
     tlen = strlen(buffer);
     sprintf(buffer+tlen, " %.*s", size-tlen-2, taskName(0));
 }
+#else
+void streamEpicsPrintTimestamp(char* buffer, int size)
+{
+    int tlen;
+    epicsTime tm = epicsTime::getCurrent();
+    tlen = tm.strftime(buffer, size, "%Y/%m/%d %H:%M:%S.%06f");
+    sprintf(buffer+tlen, " %.*s", size-tlen-2, epicsThreadGetNameSelf());
+}
 #endif
 
 long Stream::
@@ -393,9 +404,16 @@ long streamInit(int after)
     return OK;
 }
 
-long streamInitRecord(dbCommon* record, struct link *ioLink,
+long streamInitRecord(dbCommon* record, const struct link *ioLink,
     streamIoFunction readData, streamIoFunction writeData)
 {
+    char filename[80];
+    char protocol[80];
+    char busname[80];
+    int addr = -1;
+    char busparam[80];
+    memset(busparam, 0 ,sizeof(busparam));
+
     debug("streamInitRecord(%s): SEVR=%d\n", record->name, record->sevr);
     Stream* pstream = (Stream*)record->dpvt;
     if (!pstream)
@@ -407,8 +425,12 @@ long streamInitRecord(dbCommon* record, struct link *ioLink,
         // stop any running protocol
         pstream->finishProtocol(Stream::Abort);
     }
+    // scan the i/o link
+    pstream->parseLink(ioLink, filename, protocol,
+        busname, &addr, busparam);
     // (re)initialize bus and protocol
-    long status = pstream->initRecord();
+    long status = pstream->initRecord(filename, protocol,
+        busname, addr, busparam);
     if (status != OK && status != DO_NOT_CONVERT)
     {
         error("%s: Record initialization failed\n", record->name);
@@ -436,7 +458,8 @@ long streamGetIointInfo(int cmd, dbCommon *record, IOSCANPVT *ppvt)
 {
     Stream* pstream = (Stream*)record->dpvt;
     debug("streamGetIointInfo(%s,cmd=%d): pstream=%p, ioscanpvt=%p\n",
-        record->name, cmd, (void*)pstream, pstream ? pstream->ioscanpvt : NULL);
+        record->name, cmd,
+        (void*)pstream, pstream ? pstream->ioscanpvt : NULL);
     if (!pstream)
     {
         error("streamGetIointInfo called without stream instance\n");
@@ -495,20 +518,20 @@ long streamScanfN(dbCommon* record, format_t *format,
 // Stream methods ////////////////////////////////////////////////////////
 
 Stream::
-Stream(dbCommon* _record, struct link *ioLink,
+Stream(dbCommon* _record, const struct link *ioLink,
     streamIoFunction readData, streamIoFunction writeData)
 :record(_record), ioLink(ioLink), readData(readData), writeData(writeData)
 {
     streamname = record->name;
-#ifdef EPICS_3_14
-    timerQueue = &epicsTimerQueueActive::allocate(true);
-    timer = &timerQueue->createTimer();
-#else
+#ifdef EPICS_3_13
     timer = wdCreate();
     mutex = semMCreate(SEM_INVERSION_SAFE | SEM_Q_PRIORITY);
     initDone = semBCreate(SEM_Q_FIFO, SEM_EMPTY);
     callbackSetCallback(expire, &timeoutCallback);
     callbackSetUser(this, &timeoutCallback);
+#else
+    timerQueue = &epicsTimerQueueActive::allocate(true);
+    timer = &timerQueue->createTimer();
 #endif
     callbackSetCallback(streamExecuteCommand, &commandCallback);
     callbackSetUser(this, &commandCallback);
@@ -532,57 +555,57 @@ Stream::
         record->dpvt = NULL;
         debug("~Stream(%s): dpvt cleared\n", name());
     }
-#ifdef EPICS_3_14
+#ifdef EPICS_3_13
+    wdDelete(timer);
+    debug("~Stream(%s): watchdog destroyed\n", name());
+#else
     timer->destroy();
     debug("~Stream(%s): timer destroyed\n", name());
     timerQueue->release();
     debug("~Stream(%s): timer queue released\n", name());
-#else
-    wdDelete(timer);
-    debug("~Stream(%s): watchdog destroyed\n", name());
 #endif
     releaseMutex();
 }
 
 long Stream::
-initRecord()
+parseLink(const struct link *ioLink, char* filename,
+    char* protocol, char* busname, int* addr, char* busparam)
 {
-    // scan link parameters: filename protocol busname addr busparam
-    // It is safe to call this function again with different
-    // link text or different protocol file.
-
-    char filename[80];
-    char protocol[80];
-    char busname[80];
-    int addr = -1;
-    char busparam[80];
+    // parse link parameters: filename protocol busname addr busparam
     int n;
-
     if (ioLink->type != INST_IO)
     {
-        error("%s: Wrong link type %s\n", name(),
+        error("%s: Wrong I/O link type %s\n", name(),
             pamaplinkType[ioLink->type].strvalue);
         return S_dev_badInitRet;
     }
-    int items = sscanf(ioLink->value.instio.string, "%79s%79s%79s%n%i%n",
-        filename, protocol, busname, &n, &addr, &n);
+    int items = sscanf(ioLink->value.instio.string, "%s%s%s%n%i%n",
+        filename, protocol, busname, &n, addr, &n);
     if (items <= 0)
     {
-        error("%s: Empty link. Forgot the leading '@' or confused INP with OUT ?\n",
+        error("%s: Empty I/O link. "
+            "Forgot the leading '@' or confused INP with OUT ?\n",
             name());
         return S_dev_badInitRet;
     }
     if (items < 3)
     {
-        error("%s: Wrong link format\n"
+        error("%s: Wrong I/O link format\n"
             "  expect \"@file protocol bus addr params\"\n"
             "  in \"@%s\"\n", name(),
             ioLink->value.instio.string);
         return S_dev_badInitRet;
     }
-    memset(busparam, 0 ,80);
-    for (n = 0; isspace((unsigned char)ioLink->value.instio.string[n]); n++);
-    strncpy (busparam, ioLink->value.constantStr+n, 79);
+    while (isspace((unsigned char)ioLink->value.instio.string[n])) n++;
+    strcpy (busparam, ioLink->value.constantStr+n);
+    return OK;
+}
+
+long Stream::
+initRecord(const char* filename, const char* protocol,
+    const char* busname, int addr, const char* busparam)
+{
+    // It is safe to call this function again with different arguments
 
     // attach to bus interface
     if (!attachBus(busname, addr, busparam))
@@ -610,7 +633,8 @@ initRecord()
             name());
         if (record->scan == SCAN_IO_EVENT)
         {
-            debug("Stream::initRecord %s: restarting \"I/O Intr\" after reload\n",
+            debug("Stream::initRecord %s: "
+                "restarting \"I/O Intr\" after reload\n",
                 name());
             if (!startProtocol(StartAsync))
             {
@@ -635,10 +659,10 @@ initRecord()
     }
     debug("Stream::initRecord %s: waiting for initDone\n",
         name());
-#ifdef EPICS_3_14
-    initDone.wait();
-#else
+#ifdef EPICS_3_13
     semTake(initDone, WAIT_FOREVER);
+#else
+    initDone.wait();
 #endif
     debug("Stream::initRecord %s: initDone\n",
         name());
@@ -664,8 +688,11 @@ process()
     {
         if (status != NO_ALARM)
         {
-            debug("Stream::process(%s) error status=%d\n",
-                name(), status);
+            debug("Stream::process(%s) error status=%s (%d)\n",
+                name(),
+                status >= 0 && status < ALARM_NSTATUS ? 
+                    epicsAlarmConditionStrings[status] : "ERROR",
+                status);
             (void) recGblSetSevr(record, status, INVALID_ALARM);
             return false;
         }
@@ -744,7 +771,8 @@ scan(format_t *format, void* value, size_t maxStringSize)
             break;
         case DBF_STRING:
             sptr = (char*)value;
-            currentValueLength  = scanValue(*format->priv, sptr, maxStringSize);
+            currentValueLength  = scanValue(*format->priv, sptr,
+                maxStringSize);
             break;
         default:
             error("INTERNAL ERROR (%s): Illegal format type\n", name());
@@ -762,20 +790,20 @@ scan(format_t *format, void* value, size_t maxStringSize)
 
 // epicsTimerNotify virtual method ///////////////////////////////////////
 
-#ifdef EPICS_3_14
-epicsTimerNotify::expireStatus Stream::
-expire(const epicsTime&)
-{
-    timerCallback();
-    return noRestart;
-}
-#else
+#ifdef EPICS_3_13
 void Stream::
 expire(CALLBACK *pcallback)
 {
     Stream* pstream = static_cast<Stream*>(pcallback->user);
     pstream->timerCallback();
 }
+#else
+epicsTimerNotify::expireStatus Stream::
+expire(const epicsTime&)
+{
+    timerCallback();
+    return noRestart;
+}
 #endif
 
 // StreamCore virtual methods ////////////////////////////////////////////
@@ -835,10 +863,10 @@ protocolFinishHook(ProtocolResult result)
     }
     if (flags & InitRun)
     {
-#ifdef EPICS_3_14
-        initDone.signal();
-#else
+#ifdef EPICS_3_13
         semGive(initDone);
+#else
+        initDone.signal();
 #endif
         return;
     }
@@ -891,13 +919,13 @@ startTimer(unsigned long timeout)
 {
     debug("Stream::startTimer(stream=%s, timeout=%lu) = %f seconds\n",
         name(), timeout, timeout * 0.001);
-#ifdef EPICS_3_14
-    timer->start(*this, timeout * 0.001);
-#else
+#ifdef EPICS_3_13
     callbackSetPriority(priority(), &timeoutCallback);
     wdStart(timer, (timeout+1)*sysClkRateGet()/1000-1,
         reinterpret_cast<FUNCPTR>(callbackRequest),
         reinterpret_cast<int>(&timeoutCallback));
+#else
+    timer->start(*this, timeout * 0.001);
 #endif
 }
 
@@ -957,7 +985,8 @@ formatValue(const StreamFormat& format, const void* fieldaddress)
             
             if (format.type != double_format)
             {
-                error ("%s: can only read double values from TIME field\n", name());
+                error ("%s: can only read double values from TIME field\n",
+                    name());
                 return false;
             }
             if (pdbaddr->precord == record)
@@ -965,8 +994,10 @@ formatValue(const StreamFormat& format, const void* fieldaddress)
                 /* if getting time from own record, update timestamp first */
                 recGblGetTimeStamp(record);
             }
-            time = pdbaddr->precord->time.secPastEpoch + 631152000u + pdbaddr->precord->time.nsec * 1e-9;
-            debug("Stream::formatValue(%s): read %f from TIME field\n", name(), time);
+            time = pdbaddr->precord->time.secPastEpoch +
+                631152000u + pdbaddr->precord->time.nsec * 1e-9;
+            debug("Stream::formatValue(%s): read %f from TIME field\n",
+                name(), time);
             return printValue(format, time);
         }
 
@@ -1004,7 +1035,8 @@ formatValue(const StreamFormat& format, const void* fieldaddress)
                         return false;
                     break;
                 case pseudo_format:
-                    error("%s: %%(FIELD) syntax not allowed with pseudo formats\n",
+                    error("%s: %%(FIELD) syntax not allowed "
+                        "with pseudo formats\n",
                         name());
                 default:
                     error("INTERNAL ERROR %s: Illegal format.type=%d\n",
@@ -1054,7 +1086,8 @@ matchValue(const StreamFormat& format, const void* fieldaddress)
         buffer = fieldBuffer.clear().reserve(size);
         for (nord = 0; nord < nelem; nord++)
         {
-            debug("Stream::matchValue(%s): buffer before: %s\n", name(), fieldBuffer.expand()());
+            debug("Stream::matchValue(%s): buffer before: %s\n",
+                name(), fieldBuffer.expand()());
             switch (format.type)
             {
                 case long_format:
@@ -1068,7 +1101,8 @@ matchValue(const StreamFormat& format, const void* fieldaddress)
                 case enum_format:
                 {
                     consumed = scanValue(format, lval);
-                    if (consumed >= 0) ((epicsUInt16*)buffer)[nord] = (epicsUInt16)lval;
+                    if (consumed >= 0)
+                        ((epicsUInt16*)buffer)[nord] = (epicsUInt16)lval;
                     debug("Stream::matchValue(%s): %s[%li] = %li\n",
                             name(), pdbaddr->precord->name, nord, lval);
                     break;
@@ -1076,10 +1110,13 @@ matchValue(const StreamFormat& format, const void* fieldaddress)
                 case double_format:
                 {
                     consumed = scanValue(format, dval);
-                    // Direct assignment to buffer fails fith gcc 3.4.3 for xscale_be
+                    // Direct assignment to buffer fails with
+                    // gcc 3.4.3 for xscale_be
                     // Optimization bug?
                     epicsFloat64 f64=dval;
-                    if (consumed >= 0) memcpy(((epicsFloat64*)buffer)+nord, &f64, sizeof(f64));
+                    if (consumed >= 0)
+                        memcpy(((epicsFloat64*)buffer)+nord,
+                            &f64, sizeof(f64));
                     debug("Stream::matchValue(%s): %s[%li] = %#g %#g\n",
                             name(), pdbaddr->precord->name, nord, dval,
                             ((epicsFloat64*)buffer)[nord]);
@@ -1090,7 +1127,8 @@ matchValue(const StreamFormat& format, const void* fieldaddress)
                     consumed = scanValue(format,
                         buffer+MAX_STRING_SIZE*nord, MAX_STRING_SIZE);
                     debug("Stream::matchValue(%s): %s[%li] = \"%.*s\"\n",
-                            name(), pdbaddr->precord->name, nord, MAX_STRING_SIZE, buffer+MAX_STRING_SIZE*nord);
+                            name(), pdbaddr->precord->name, nord,
+                            MAX_STRING_SIZE, buffer+MAX_STRING_SIZE*nord);
                     break;
                 }
                 default:
@@ -1098,7 +1136,8 @@ matchValue(const StreamFormat& format, const void* fieldaddress)
                         "Illegal format type\n", name());
                     return false;
             }
-            debug("Stream::matchValue(%s): buffer after: %s\n", name(), fieldBuffer.expand()());
+            debug("Stream::matchValue(%s): buffer after: %s\n",
+                name(), fieldBuffer.expand()());
             if (consumed < 0) break;
             consumedInput += consumed;
         }
@@ -1107,7 +1146,8 @@ matchValue(const StreamFormat& format, const void* fieldaddress)
             // scan error: set other record to alarm status
             if (pdbaddr->precord != record)
             {
-                (void) recGblSetSevr(pdbaddr->precord, CALC_ALARM, INVALID_ALARM);
+                (void) recGblSetSevr(pdbaddr->precord,
+                    CALC_ALARM, INVALID_ALARM);
                 if (!INIT_RUN)
                 {
                     // process other record to send alarm monitor
@@ -1121,19 +1161,24 @@ matchValue(const StreamFormat& format, const void* fieldaddress)
 #ifdef epicsTimeEventDeviceTime
             if (format.type != double_format)
             {
-                error ("%s: can only write double values to TIME field\n", name());
+                error ("%s: can only write double values to TIME field\n",
+                    name());
                 return false;
             }
             dval = dval-631152000u;
             pdbaddr->precord->time.secPastEpoch = (long)dval;
-            /* rouding: we don't have 9 digits precision in a double of today's number of seconds */
+            // rouding: we don't have 9 digits precision
+            // in a double of today's number of seconds
             pdbaddr->precord->time.nsec = (long)((dval-(long)dval)*1e6)*1000;
-            debug("Stream::matchValue(%s): writing %i.%i to TIME field\n", name(),
-                pdbaddr->precord->time.secPastEpoch, pdbaddr->precord->time.nsec);
+            debug("Stream::matchValue(%s): writing %i.%i to TIME field\n",
+                name(),
+                pdbaddr->precord->time.secPastEpoch,
+                pdbaddr->precord->time.nsec);
             pdbaddr->precord->tse = epicsTimeEventDeviceTime;
             return true;
 #else
-            error ("%s: writing TIME field is not supported in this EPICS version\n", name());
+            error ("%s: writing TIME field is not supported "
+                "in this EPICS version\n", name());
             return false;
 #endif
         }
@@ -1166,7 +1211,8 @@ matchValue(const StreamFormat& format, const void* fieldaddress)
                 ((dbFldDes*)pdbaddr->pfldDes)->name,
                 fieldBuffer.expand()());
             putfunc = "dbPutField";
-            status = dbPutField(pdbaddr, dbfMapping[format.type], buffer, nord);
+            status = dbPutField(pdbaddr, dbfMapping[format.type],
+                buffer, nord);
         }
         if (status != 0)
         {
@@ -1229,13 +1275,15 @@ matchValue(const StreamFormat& format, const void* fieldaddress)
     return true;
 }
 
-#ifdef EPICS_3_14
-// Pass command to iocsh
+#ifdef EPICS_3_13
+// Pass command to vxWorks shell
+extern "C" int execute(const char *cmd);
+
 void streamExecuteCommand(CALLBACK *pcallback)
 {
     Stream* pstream = static_cast<Stream*>(pcallback->user);
 
-    if (iocshCmd(pstream->outputLine()) != OK)
+    if (execute(pstream->outputLine()) != OK)
     {
         pstream->execCallback(StreamIoFault);
     }
@@ -1245,14 +1293,12 @@ void streamExecuteCommand(CALLBACK *pcallback)
     }
 }
 #else
-// Pass command to vxWorks shell
-extern "C" int execute(const char *cmd);
-
+// Pass command to iocsh
 void streamExecuteCommand(CALLBACK *pcallback)
 {
     Stream* pstream = static_cast<Stream*>(pcallback->user);
 
-    if (execute(pstream->outputLine()) != OK)
+    if (iocshCmd(pstream->outputLine()) != OK)
     {
         pstream->execCallback(StreamIoFault);
     }
@@ -1274,19 +1320,19 @@ execute()
 void Stream::
 lockMutex()
 {
-#ifdef EPICS_3_14
-    mutex.lock();
-#else
+#ifdef EPICS_3_13
     semTake(mutex, WAIT_FOREVER);
+#else
+    mutex.lock();
 #endif
 }
 
 void Stream::
 releaseMutex()
 {
-#ifdef EPICS_3_14
-    mutex.unlock();
-#else
+#ifdef EPICS_3_13
     semGive(mutex);
+#else
+    mutex.unlock();
 #endif
 }

src/StreamProtocol.cc

@@ -1059,7 +1059,6 @@ compileString(StreamBuffer& buffer, const char*& source,
     FormatType formatType, Client* client, int quoted)
 {
     bool escaped = false;
-    int n;
     int newline = 0;
     StreamBuffer formatbuffer;
     int formatpos = buffer.length();
@@ -1136,7 +1135,8 @@ compileString(StreamBuffer& buffer, const char*& source,
         if (escaped)   // char after \ in quoted text
         {
             escaped = false;
-            unsigned int temp;
+            unsigned int c;
+            int n=1;
             switch (*source)
             {
                 case '$': // can't be: readToken would have made a token from this
@@ -1145,61 +1145,50 @@ compileString(StreamBuffer& buffer, const char*& source,
                     return false;
                 case '?':
                     buffer.append(skip);
-                    break;
+                    source++;
+                    continue;
                 case '_':
                     buffer.append(whitespace);
-                    break;
+                    source++;
+                    continue;
                 case 'a':
-                    buffer.append(7);
+                    c=7;
                     break;
                 case 'b':
-                    buffer.append(8);
+                    c=8;
                     break;
                 case 't':
-                    buffer.append(9);
+                    c=9;
                     break;
                 case 'n':
-                    buffer.append('\n');
+                    c='\n';
                     break;
                 case 'r':
-                    buffer.append('\r');
+                    c='\r';
                     break;
                 case 'e':
-                    buffer.append(esc).append(esc);
+                    c=esc;
                     break;
-                case '0':  // octal numbers (max 3 digits after 0)
-                    sscanf (source, "%3o%n", &temp, &n);
-                    if (temp > 0xFF)
+                case '0':  // octal numbers (max 4 digits)
+                    sscanf (source, "%4o%n", &c, &n); //cannot fail
+                    if (c > 0xFF)
                     {
                         error(line, filename(),
-                            "Octal source %#o does not fit in byte: %s\n",
-                            temp, source-1);
+                            "Octal number %#o does not fit in byte: \"%s\"\n",
+                            c, source-1);
                         return false;
                     }
-                    if (formatType != NoFormat &&
-                        (temp < last_function_code || temp == esc))
-                    {
-                        buffer.append(esc);
-                    }
-                    buffer.append(temp);
-                    source += n;
-                    continue;
-                case 'x':  // hex numbers (max 2 digits after 0)
-                    if (sscanf (source+1, "%2x%n", &temp, &n) < 1)
+                    break;
+                case 'x':  // hex numbers (max 2 digits after x)
+                    if (sscanf (source+1, "%2x%n", &c, &n) < 1)
                     {
                         error(line, filename(),
-                            "Hex digit expected after \\x: %s\n",
+                            "Hex digit expected after \\x: \"%s\"\n",
                             source-1);
                         return false;
                     }
-                    if (formatType != NoFormat &&
-                        (temp < last_function_code || temp == esc))
-                    {
-                        buffer.append(esc);
-                    }
-                    buffer.append(temp);
-                    source += n+1;
-                    continue;
+                    n++;
+                    break;
                 case '1': // decimal numbers (max 3 digits)
                 case '2':
                 case '3':
@@ -1209,26 +1198,24 @@ compileString(StreamBuffer& buffer, const char*& source,
                 case '7':
                 case '8':
                 case '9':
-                    sscanf (source, "%3u%n", &temp, &n);
-                    if (temp > 0xFF)
+                    sscanf (source, "%3u%n", &c, &n); //cannot fail
+                    if (c > 0xFF)
                     {
                         error(line, filename(),
-                            "Decimal source %d does not fit in byte: %s\n",
-                            temp, source-1);
+                            "Decimal number %d does not fit in byte: \"%s\"\n",
+                            c, source-1);
                         return false;
                     }
-                    if (formatType != NoFormat &&
-                        (temp < last_function_code || temp == esc))
-                    {
-                        buffer.append(esc);
-                    }
-                    buffer.append(temp);
-                    source += n;
-                    continue;
+                    break;
                 default:  // escaped literals
-                    buffer.append(esc).append(*source);
+                    c=*source;
             }
-            source++;
+            source+=n;
+            if (formatType != NoFormat)
+            {
+                buffer.append(esc);
+            }
+            buffer.append(c);
             continue;
         }
         if (quoted) // look for ending quotes and escapes
@@ -1281,7 +1268,7 @@ compileString(StreamBuffer& buffer, const char*& source,
         }
         // try numeric byte value
         char* p;
-        int temp = strtol(source, &p, 0);
+        int c = strtol(source, &p, 0);
         if (p != source)
         {
             if (*p != 0)
@@ -1290,18 +1277,17 @@ compileString(StreamBuffer& buffer, const char*& source,
                     "Garbage after numeric source: %s", source);
                 return false;
             }
-            if (temp > 0xFF || temp < -0x80)
+            if (c > 0xFF || c < -0x80)
             {
                 error(line, filename(),
                     "Value %s does not fit in byte\n", source);
                 return false;
             }
-            if (formatType != NoFormat &&
-                (temp < last_function_code || temp == esc))
+            if (formatType != NoFormat)
             {
                 buffer.append(esc);
             }
-            buffer.append(temp);
+            buffer.append(c);
             source = p+1+sizeof(int);
             continue;
         }
@@ -1348,7 +1334,7 @@ compileString(StreamBuffer& buffer, const char*& source,
             {"del",  0x7f}
         };
         size_t i;
-        char c = 0;
+        c=-1;
         for (i = 0; i < sizeof(codes)/sizeof(*codes); i++)
         {
             if (strcmp(source, codes[i].name) == 0)
@@ -1361,8 +1347,7 @@ compileString(StreamBuffer& buffer, const char*& source,
                         source);
                     return false;
                 }
-                if (formatType != NoFormat &&
-                    (temp < last_function_code || temp == esc))
+                if (formatType != NoFormat)
                 {
                     buffer.append(esc);
                 }
@@ -1371,10 +1356,10 @@ compileString(StreamBuffer& buffer, const char*& source,
                 break;
             }
         }
-        if (c) continue;
+        if (c >= 0) continue;
         // source may contain a function name
         error(line, filename(),
-            "Unexpected word: %s\n", source);
+            "Unexpected word: \"%s\"\n", source);
         return false;
     }
     debug("StreamProtocolParser::Protocol::compileString buffer=%s\n", buffer.expand()());
@@ -1493,8 +1478,10 @@ compileFormat(StreamBuffer& buffer, const char*& formatstr,
     buffer.append(&streamFormat, sizeof(streamFormat));
     buffer.append(infoString);
 
-    debug("StreamProtocolParser::Protocol::compileFormat: format.type=%s, infolen=%d\n",
-        StreamFormatTypeStr[streamFormat.type], streamFormat.infolen);
+    debug("StreamProtocolParser::Protocol::compileFormat: format.type=%s, "
+        "infolen=%d infostring=\"%s\"\n",
+        StreamFormatTypeStr[streamFormat.type],
+        streamFormat.infolen, infoString.expand()());
     formatstr = source; // move pointer after parsed format
     return true;
 }

src/StreamVersion.c

@@ -23,6 +23,7 @@
 #define STR2(x) #x
 #define STR(x) STR2(x)
 const char StreamVersion [] =
-    "StreamDevice " STR(STREAM_MAJOR) "." STR(STREAM_MINOR)
+    "StreamDevice " STR(STREAM_MAJOR)
+    "." STR(STREAM_MINOR)
+    "." STR(STREAM_PATCHLEVEL)
     " built " __DATE__ " " __TIME__;
-

src/devStream.h

@@ -22,7 +22,8 @@
 #define devStream_h
 
 #define STREAM_MAJOR 2
-#define STREAM_MINOR 4
+#define STREAM_MINOR 5
+#define STREAM_PATCHLEVEL 12
 
 #if defined(__vxworks) || defined(vxWorks)
 #include <vxWorks.h>
@@ -40,11 +41,11 @@
 #define INIT_RUN (!interruptAccept)
 
 #include <epicsVersion.h>
-#if (EPICS_VERSION == 3 && EPICS_REVISION == 14)
-#define EPICS_3_14
+#ifdef BASE_RELEASE
+#define EPICS_3_13
 #endif
 
-#if defined(__cplusplus) && !defined(EPICS_3_14)
+#if defined(__cplusplus) && defined(EPICS_3_13)
 extern "C" {
 #endif
 
@@ -55,7 +56,7 @@ extern "C" {
 /* #include <dbFldTypes.h> */
 #include <dbAccess.h>
 
-#if defined(__cplusplus) && !defined(EPICS_3_14)
+#if defined(__cplusplus) && defined(EPICS_3_13)
 }
 #endif
 
@@ -69,23 +70,22 @@ typedef const struct format_s {
 extern "C" {
 #endif
 
-#ifdef _WIN32
-__declspec(dllimport)
-#endif
-extern FILE* StreamDebugFile;
+epicsShareExtern FILE* StreamDebugFile;
 
 extern const char StreamVersion [];
 
 typedef long (*streamIoFunction) (dbCommon*, format_t*);
 
-long streamInit(int after);
-long streamInitRecord(dbCommon *record, struct link *ioLink,
+epicsShareExtern long streamInit(int after);
+epicsShareExtern long streamInitRecord(dbCommon *record,
+    const struct link *ioLink,
     streamIoFunction readData, streamIoFunction writeData);
-long streamReport(int interest);
-long streamReadWrite(dbCommon *record);
-long streamGetIointInfo(int cmd, dbCommon *record, IOSCANPVT *ppvt);
-long streamPrintf(dbCommon *record, format_t *format, ...);
-long streamScanfN(dbCommon *record, format_t *format,
+epicsShareExtern long streamReport(int interest);
+epicsShareExtern long streamReadWrite(dbCommon *record);
+epicsShareExtern long streamGetIointInfo(int cmd,
+    dbCommon *record, IOSCANPVT *ppvt);
+epicsShareExtern long streamPrintf(dbCommon *record, format_t *format, ...);
+epicsShareExtern long streamScanfN(dbCommon *record, format_t *format,
     void*, size_t maxStringSize);
 
 /* backward compatibility stuff */

src/makedbd.pl

@@ -1,6 +1,10 @@
+if (@ARGV[0] == "-3.13") {
+    shift;
+} else {
+    print "variable(streamDebug, int)\n";
+    print "registrar(streamRegistrar)\n";
+}
+print "driver(stream)\n";
 for (@ARGV) {
      print "device($_,INST_IO,dev${_}Stream,\"stream\")\n";
 }
-print "driver(stream)\n";
-print "variable(streamDebug, int)\n";
-print "registrar(streamRegistrar)\n";

streamApp/Makefile

@@ -29,17 +29,10 @@ PROD_SRCS_vxWorks = -nil-
 PROD_LIBS = stream
 
 ifdef ASYN
-# Which types of asyn busses do you have?
-
-# asynDriver up to version 4-16 does not support serial port for Windows!
-#ifneq ($(OS_CLASS), WIN32)
-streamApp_DBD += drvAsynSerialPort.dbd
-#endif
-
-streamApp_DBD += drvAsynIPPort.dbd
-#streamApp_DBD += drvGsIP488.dbd
-#streamApp_DBD += drvNi1014.dbd
-streamApp_DBD += drvVxi11.dbd
+# edit asynRegistrars.dbd if necessary
+streamApp_DBD += asynRegistrars.dbd
+# add asyn.dbd if you want to have asyn Record and asyn device supports
+# streamApp_DBD += asyn.dbd
 PROD_LIBS += asyn
 endif
 
@@ -73,7 +66,11 @@ CPPFLAGS += -DDEBUGFILE=StreamDebug.log
 
 include $(TOP)/configure/RULES
 
+ifeq ($(EPICS_REVISION),14)
 clean:: myclean
+else
+clean: myclean
+endif
 
 myclean:
 	$(RM) core* StreamDebug.log

streamApp/asynRegistrars.dbd

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

streamApp/terminal.tcl

@@ -1,7 +1,5 @@
 #!/usr/bin/env wish
 
-wm iconify .
-
 proc createTerm {sock} {
     global socket port
     toplevel .$sock
@@ -19,16 +17,8 @@ proc createTerm {sock} {
     wm title .$sock "port $port <-> [fconfigure $sock -peername]" 
 }
 
-set port [lindex $argv 0]
-if {$port == ""} { set port 40000 }
-if [catch {
-    socket -server connect $port
-} msg ] {
-    return -code error "$msg (port $port)"
-}
-
 proc connect {sock addr port} {
-    fconfigure $sock -blocking 0 -buffering none
+    fconfigure $sock -blocking 0 -buffering none -translation binary
     createTerm $sock
     fileevent $sock readable "receiveHandler $sock"
 }
@@ -84,6 +74,10 @@ proc receiveHandler {sock} {
             "echo" {
                 sendReply $sock [string range $a 5 end]
             }
+            "binary" {
+                set x [checkNum [lindex $l 1]]
+                sendReply $sock  [format %c $x]
+            }
             "longmsg" {
                 set length [checkNum [lindex $l 1]]
                 sendReply $sock "[string range x[string repeat 0123456789abcdefghijklmnopqrstuvwxyz [expr $length / 36 + 1]] 1 $length]\n"
@@ -95,7 +89,7 @@ proc receiveHandler {sock} {
             "start" {
                 set wait [checkNum [lindex $l 1]]
                 set ::counter 0
-                after $wait sendAsync $wait [list [lindex $l 2]]
+                after $wait sendAsync $wait [list [lrange $l 2 end-1]]
                 sendReply $sock "Started\n"
             }
             "stop" {
@@ -116,12 +110,16 @@ proc receiveHandler {sock} {
             "help" {
                 sendReply $sock "help             this text\n"
                 sendReply $sock "echo string      reply string\n"
-                sendReply $sock "wait msec        reply Done after some time\n"
+                sendReply $sock "binary number    reply byte with value number\n"
+                sendReply $sock "longmsg length   reply string with length characters\n"
+                sendReply $sock "wait msec        reply \"Done\" after some time\n"
                 sendReply $sock "start msec       start sending messages priodically\n"
                 sendReply $sock "stop             stop sending messages\n"
-                sendReply $sock "set key value    set a value\n"
-                sendReply $sock "get key          reply value\n"
+                sendReply $sock "set key value    store a value into variable key\n"
+                sendReply $sock "get key          reply previously stored value from key\n"
                 sendReply $sock "disconnect       close connection\n"
+                sendReply $sock "exit             kill terminal server\n"
+                
             }
         }
     } msg] {
@@ -153,7 +151,6 @@ rename $paste tkTextPaste_org
 rename $pastesel tkTextPasteSel_org
 
 proc $insert {w s} {
-    puts [list insert $w $s]
     global socket
     if {[string equal $s ""] || [string equal [$w cget -state] "disabled"]} {
         return
@@ -191,8 +188,20 @@ for {set ascii 0x61} {$ascii <= 0x7a} {incr ascii} {
     bind Text <Control-[format %c $ascii]> ""
 }
 #remove bindings on symbolic tags
-foreach tag {Clear Paste Copy Cut } {
+foreach tag {Clear Paste Copy Cut} {
     bind Text <<$tag>> ""
 }
 
 bind Text <Control-Key> [list $insert %W %A]
+
+set port [lindex $argv 0]
+if {$port == ""} { set port 40000 }
+if [catch {
+    socket -server connect $port
+} msg ] {
+    return -code error "$msg (port $port)"
+}
+
+label .info -text "Accepting connections on port $port"
+button .exit -text "Exit" -command exit
+pack .info .exit -expand yes -fill x

streamApp/test.db

@@ -2,17 +2,20 @@ record (stringout, "$(P):cmd")
 {
     field (DTYP, "stream")
     field (OUT,  "@test.proto command terminal")
+    field (PRIO, "HIGH")
     field (VAL, "")
 }
 record (stringout, "$(P):info")
 {
     field (DTYP, "stream")
     field (OUT,  "@test.proto info terminal")
+    field (PRIO, "HIGH")
 }
 record (stringout, "$(P):request")
 {
     field (DTYP, "stream")
     field (OUT,  "@test.proto request($(P):reply.VAL) terminal")
+    field (PRIO, "HIGH")
 }
 record (stringin, "$(P):reply")
 {

streamApp/test.proto

@@ -1,5 +1,5 @@
-terminator = CR LF;
-readtimeout = 1000;
+terminator = LF;
+readtimeout = 10;
 pollperiod = 10;
 replytimeout = 1000;
 command {

streamApp/tests/streamtestlib.tcl

@@ -52,7 +52,7 @@ proc startioc {} {
     
     if [info exists streamversion] {
         puts $fd "#!/usr/local/bin/iocsh"
-        puts $fd "require stream,$streamversion"
+        puts $fd "require stream2,$streamversion"
     } else {
         puts $fd "#!../O.$env(EPICS_HOST_ARCH)/streamApp"
         puts $fd "dbLoadDatabase ../O.Common/streamApp.dbd"

streamApp/tests/testFormats

@@ -7,6 +7,11 @@ source streamtestlib.tcl
 # Send commands to the ioc shell with ioccmd
 
 set records {
+    record (bo, "DZ:percent")
+    {
+        field (DTYP, "stream")
+        field (OUT,  "@test.proto percent device")
+    }
     record (ao, "DZ:ao")
     {
         field (DTYP, "stream")
@@ -34,6 +39,7 @@ set records {
 
 set protocol {
     Terminator = LF;
+    percent {out "\%\x25\37\045" 0x25 37 045;}
     ao {out "%.2f %.2e %.2E %.2g %.2G %i %d %u %o %04x %#.2f %#.2e %#.2E %#.2g %#.2G %#i %#d %#u %#o %#06x";}
     lo {out "%d %(VAL)d %06d %x %06X %b %06b %.6b %B.! %06B.!";}
     bcd {out "%D %6D %.2D %.4D %.6D %.8D %#D %#6D %#.2D %#.4D %#.6D";}
@@ -58,6 +64,8 @@ startioc
 # This is normal. E.g. -1 HAS a different number of 1 bits.
 # Specify the width field in the format if this is a problem.
 
+ioccmd {dbpf DZ:percent 1}
+assure "%%%%%%%\n"
 ioccmd {dbpf DZ:ao 0}
 assure "0.00 0.00e+00 0.00E+00 0 0 32767 32767 32767 77777 7fff 0.00 0.00e+00 0.00E+00 0.0 0.0 32767 32767 32767 077777 0x7fff\n"
 ioccmd {dbpf DZ:ao 10}