Compare commits

...

22 Commits
2.8.6 ... 2.8.9

Author SHA1 Message Date
880a399e4e fix for commit cb4d49: needed to add SUPPORT=, not RELEASE= for SynApps 2019-05-29 08:48:35 +02:00
592146a648 Have separate dbd file without scalcout support (by Martin Konrad) 2019-05-21 16:58:41 +02:00
e03285b9a9 Merge branch 'master' of github.com:paulscherrerinstitute/StreamDevice 2019-05-21 11:40:30 +02:00
fb3d20bfd9 Merge pull request #37 from shadowguy/master
Update some EPICS related links
2019-05-21 11:39:52 +02:00
3363f4f525 add new record types to the pdf 2019-05-21 11:36:19 +02:00
ed300116bd add tolower and toupper to regsubst 2019-05-21 09:50:53 +02:00
f912e0b370 Update some EPICS related links 2019-05-02 11:24:18 +02:00
b84655e4de Support %% in protocol just like in printf/scanf. (Suggested by Klemen Vodopivec) 2019-02-26 16:30:20 +01:00
ece1e01d21 Fix incosistent readRequst() function signature in documentation. 2019-02-26 15:17:53 +01:00
26877dedbd move enum Commands into class StreamCore to avoid collisions of enum state wait with function pid_t wait(int*) 2019-02-20 15:11:07 +01:00
7aa1802ec6 link streamApp with sscan if SSCAN is defined in RELEASE 2019-02-19 16:14:45 +01:00
eb9f565aec don't mess with asynTraceMask any more 2019-02-18 13:54:43 +01:00
04906a5835 regsub converter: empty match advances by 1 byte to avoid loops 2019-02-18 11:08:21 +01:00
acf7efcff2 fix hanging 'in' command when it is the first command of the protocol and the device is offline 2018-11-27 13:45:27 +01:00
d873d220dc fix broken version detection 2018-11-27 13:41:49 +01:00
9ef1653e73 Use inverse instead of fat for hex byte output because not all terminals support fat off 2018-11-16 15:26:33 +01:00
d1d65344af define feature test macro to ensure vsnprintf is available 2018-11-16 12:02:33 +01:00
a76adc31ab Implement needed vsnprintf for vxWorks 5. (vxWorks 6 has it already) 2018-11-16 11:49:25 +01:00
a2fcbc81c8 RTEMS has vsnprintf at least since 4.5.1-pre3 2018-11-16 11:22:45 +01:00
fa51c376c1 Windows has vsnprintf at least since 2003 2018-11-16 10:59:32 +01:00
483530f053 enable rendering of ANSI term colors on Windows console 2018-11-16 10:40:04 +01:00
8f34dd2c84 avoid problems with echo and quotes in Windows 2018-11-16 10:28:46 +01:00
18 changed files with 258 additions and 94 deletions

View File

@ -11,12 +11,8 @@ DOCUDIR = docs
PCRE=1
ASYN=1
ifdef EPICSVERSION
ifndef RECORDTYPES
include src/CONFIG_STREAM
export RECORDTYPES BUSSES FORMATS
endif
endif
-include ../src/CONFIG_STREAM
-include src/CONFIG_STREAM
SOURCES += $(RECORDTYPES:%=src/dev%Stream.c)
SOURCES += $(FORMATS:%=src/%Converter.cc)

View File

@ -15,7 +15,7 @@ TEMPLATE_TOP=$(EPICS_BASE)/templates/makeBaseApp/top
#INSTALL_LOCATION_APP=<fullpathname>
# For SynApps:
RELEASE=
SUPPORT=
EPICS_BASE=/usr/local/epics/base-7.0.1
ASYN=~/top-7/asyn4-33

View File

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

View File

@ -37,6 +37,14 @@ A format converter consists of
<li>Additional information required by some converters</li>
</ul>
<p class="new">
An exception is the sequence <code>%%</code> which stands for a single
literal <code>%</code>.
This has been added for compatibility with the C functions
<em>printf()</em> and <em>scanf()</em>.
It behaves the same as the escaped percent <code>\%</code>.
</p>
<p>
The flags <code>*# +0-</code> work like in the C functions
<em>printf()</em> and <em>scanf()</em>.
@ -83,8 +91,6 @@ formatted (like for output) and then compared to the input.
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>
@ -118,6 +124,14 @@ This feature has been added by Klemen Vodopivec, SNS.
<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>
<tr>
<td><code>in "%!5d";</code></td>
<td>Expect exactly 5 decimal digits. Fewer digits are considered loss of data and make the format fail.
</tr>
<tr>
<td><code>in "%d%%";</code></td>
<td>Read a decimal number followed by a % sign</td>
</tr>
</table>
<a name="types"></a>
@ -587,7 +601,7 @@ It is only available if a PCRE library is installed.
<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>
the sourcecode from <a target="ex" href="https://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.
@ -642,6 +656,13 @@ Matches of the <em>regex</em> are replaced by the string <em>subst</em> with 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.
Occurrences of <code>\U<i>n</i></code>, <code>\L<i>n</i></code>, <code>\u<i>n</i></code>,
or <code>\l<i>n</i></code> with <code><i>n</i></code> being a number <code>0</code>
through <code>9</code> or <code>&</code> are replaced with the corresponding sub-expression
converted to all upper case, all lower case, first letter upper case, or first letter lower
case, respectively.</span>
</p>
<p><span class="new">
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!)
@ -666,6 +687,13 @@ Otherwise <em>precision</em> is the index (counting from 1) of the match to repl
Without <em>precision</em> (or 0), all matches are replaced.
</p>
<p>
When replacing multiple matches, the next match is searched directly after the currently
replaced string, so that the <em>subst</em> string itself will never be modified recursively.
<span class="new">
However if an empty string is matched, searching advances by 1 character in order to
avoid matching the same empty string again.</span>
</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.
@ -701,6 +729,9 @@ which is not at the end of a word.
<code>%#/([^+-])*([+-])/\2\1/</code> moves a postfix sign to the front.
(<code>1.23-</code> becomes <code>-1.23</code>)<br>
</div>
<div class="indent">
<code>%#-2/.*/\U0/</code> converts the previous 2 characters to upper case.
</div>
<a name="mantexp"></a>
<h2>15. MantissaExponent DOUBLE converter (<code>%m</code>)</h2>
<p>

View File

@ -99,9 +99,9 @@ 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/6-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>
target="ex">R3.15.6</a>,
<a href="https://epics.anl.gov/base/R3-16/2-docs/AppDevGuide/AppDevGuide.html"
target="ex">R3.16.2</a>
</p>
<p>
<a href="https://wiki-ext.aps.anl.gov/epics/index.php/RRM_3-14"

View File

@ -20,17 +20,21 @@ ai.html
ao.html
bi.html
bo.html
mbbi.html
mbbo.html
mbbiDirect.html
mbboDirect.html
stringin.html
stringout.html
calcout.html
int64in.html
int64out.html
longin.html
longout.html
waveform.html
calcout.html
lsi.html
lso.html
mbbiDirect.html
mbboDirect.html
mbbi.html
mbbo.html
scalcout.html
stringin.html
stringout.html
waveform.html
tipsandtricks.html
recordinterface.html
businterface.html

View File

@ -19,7 +19,7 @@
<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>
<a href="https://epics.anl.gov/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>.

View File

@ -69,6 +69,10 @@ h4 {
margin-bottom:0.25ex;
}
h1, h2, h3, h4 {
page-break-after:avoid;
}
p {
margin-top:0.75ex;
margin-bottom:0.75ex;

View File

@ -457,10 +457,6 @@ connectToBus(const char* portname, int addr)
return false;
}
// disable asyn errors to avoid flooding when device is disconnected
// user can re-enable later
pasynTrace->setTraceMask(pasynUser, 0);
asynInterface* pasynInterface;
// find the asynCommon interface

View File

@ -35,6 +35,10 @@ endif
LIBRARY_DEFAULT = stream
DBD += $(LIBRARY_DEFAULT).dbd
DBD += $(LIBRARY_DEFAULT)-base.dbd
ifdef CALC
DBD += $(LIBRARY_DEFAULT)-scalcout.dbd
endif
ifdef ASYN
LIB_LIBS += asyn
@ -84,12 +88,29 @@ streamReferences: ../CONFIG_STREAM
$(PERL) ../makeref.pl Interface $(BUSSES) > $@
$(PERL) ../makeref.pl Converter $(FORMATS) >> $@
# create stream.dbd from all RECORDTYPES
$(COMMON_DIR)/$(LIBRARY_DEFAULT).dbd: ../CONFIG_STREAM
$(PERL) ../makedbd.pl $(RECORDTYPES) > $@
ifdef ASYN
echo "registrar(AsynDriverInterfaceRegistrar)" >> $@
# create stream-base.dbd from all RECORDTYPES except scalcout record
$(COMMON_DIR)/$(LIBRARY_DEFAULT)-base.dbd: ../CONFIG_STREAM
$(PERL) ../makedbd.pl $(if $(ASYN),--with-asyn) $(if $(BASE_3_14),,-3.13) $(filter-out scalcout, $(RECORDTYPES)) > $@
$(LIBRARY_DEFAULT)-base.dbd$(DEP): ../CONFIG_STREAM
echo $(LIBRARY_DEFAULT)-base.dbd: $< > $@
STREAM_DBD_FILES = $(LIBRARY_DEFAULT)-base.dbd
ifdef CALC
# create stream-scalcout.dbd for scalcout record
$(COMMON_DIR)/$(LIBRARY_DEFAULT)-scalcout.dbd: ../CONFIG_STREAM
$(PERL) ../makedbd.pl $(if $(ASYN),--with-asyn) $(if $(BASE_3_14),,-3.13) scalcout > $@
$(LIBRARY_DEFAULT)-scalcout.dbd$(DEP): ../CONFIG_STREAM
echo $(LIBRARY_DEFAULT)-scalcout.dbd: $< > $@
STREAM_DBD_FILES += $(LIBRARY_DEFAULT)-scalcout.dbd
endif
$(LIBRARY_DEFAULT).dbd$(DEP): ../CONFIG_STREAM
echo $(LIBRARY_DEFAULT).dbd: $< > $@
# create stream.dbd for all record types
$(COMMON_DIR)/$(LIBRARY_DEFAULT).dbd: $(addprefix $(COMMON_DIR)/, $(STREAM_DBD_FILES))
cat $? > $@
$(LIBRARY_DEFAULT).dbd$(DEP):
echo "$(LIBRARY_DEFAULT).dbd: $(STREAM_DBD_FILES)" > $@

View File

@ -20,9 +20,10 @@
#include "StreamFormatConverter.h"
#include "StreamError.h"
#include "string.h"
#include "pcre.h"
#include <string.h>
#include <limits.h>
#include <ctype.h>
#define Z PRINTF_SIZE_T_PREFIX
@ -197,14 +198,15 @@ static void regsubst(const StreamFormat& fmt, StreamBuffer& buffer, size_t start
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];
// no prec: replace all matches
// prec with + flag: replace first prec matches
// prec without + flag: replace only match number prec
if ((fmt.flags & sign_flag) || n >= fmt.prec)
{
// replace subexpressions
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++)
@ -218,9 +220,40 @@ static void regsubst(const StreamFormat& fmt, StreamBuffer& buffer, size_t start
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
if (strchr("ulUL", ch))
{
unsigned char br = s[r+2] - '0';
if (br == (unsigned char)('&'-'0')) br = 0;
debug("found case conversion \\%c%u\n", ch, br);
if (br >= rc)
{
s.remove(r, 1);
continue;
}
br *= 2;
rl = ovector[br+1] - ovector[br];
s.replace(r, 3, buffer(start+c+ovector[br]), rl);
switch (ch)
{
case 'u':
if (islower(s[r])) s[r] = toupper(s[r]);
break;
case 'l':
if (isupper(s[r])) s[r] = tolower(s[r]);
break;
case 'U':
for (int i = 0; i < rl; i++)
if (islower(s[r+i])) s[r+i] = toupper(s[r+i]);
break;
case 'L':
for (int i = 0; i < rl; i++)
if (isupper(s[r+i])) s[r+i] = tolower(s[r+i]);
break;
}
}
else if (ch != 0 && ch < rc) // escaped 1 - 9 : replace with subexpr
{
debug("found escaped \\%u\n", ch);
ch *= 2;
rl = ovector[ch+1] - ovector[ch];
debug("yes, replace \\%d: \"%s\"\n", ch/2, buffer.expand(start+c+ovector[ch], rl)());
@ -229,7 +262,7 @@ static void regsubst(const StreamFormat& fmt, StreamBuffer& buffer, size_t start
}
else
{
debug("no, use literal \\%u\n", ch);
debug("use literal \\%u\n", ch);
s.remove(r, 1); // just remove escape
}
}
@ -243,8 +276,16 @@ static void regsubst(const StreamFormat& fmt, StreamBuffer& buffer, size_t start
debug("subs = \"%s\"\n", s.expand()());
}
buffer.replace(start+c+ovector[0], l, s);
length += s.length() - l;
c += ovector[0] + s.length();
length -= l;
length += s.length();
c += s.length();
}
c += ovector[0];
if (l == 0)
{
debug("pcre_exec: empty match\n");
c++; // Empty strings may lead to an endless loop. Match them only once.
}
if (n == fmt.prec) // max match reached
{
debug("pcre_exec: max match %d reached\n", n);

View File

@ -17,6 +17,11 @@
* *
***************************************************************/
// Make sure that vsnprintf is available
#ifndef _BSD_SOURCE
#define _BSD_SOURCE
#endif
#include "StreamBuffer.h"
#include "StreamError.h"
@ -24,10 +29,47 @@
#include <stdarg.h>
#include <stdlib.h>
#if defined(__vxworks) || defined(vxWorks) || defined(_WIN32) || defined(__rtems__)
// These systems have no vsnprintf
#define vsnprintf(p,l,f,v) vsprintf(p,f,v)
#endif
#ifdef vxWorks
#include <version.h>
#ifndef _WRS_VXWORKS_MAJOR
// VxWorks 5 has no vsnprintf
// Implementation taken from EPICS 3.14
#include <vxWorks.h>
#include <fioLib.h>
struct outStr_s {
char *str;
int free;
};
static STATUS outRoutine(char *buffer, int nchars, int outarg) {
struct outStr_s *poutStr = (struct outStr_s *) outarg;
int free = poutStr->free;
int len;
if (free < 1) { /*let fioFormatV continue to count length*/
return OK;
} else if (free > 1) {
len = min(free-1, nchars);
strncpy(poutStr->str, buffer, len);
poutStr->str += len;
poutStr->free -= len;
}
/*make sure final string is null terminated*/
*poutStr->str = 0;
return OK;
}
int vsnprintf(char *str, size_t size, const char *format, va_list ap) {
struct outStr_s outStr;
outStr.str = str;
outStr.free = size;
return fioFormatV(format, ap, (FUNCPTR)outRoutine, (int)&outStr);
}
#endif // ! _WRS_VXWORKS_MAJOR
#endif // vxWorks
#define P PRINTF_SIZE_T_PREFIX
@ -296,7 +338,7 @@ StreamBuffer StreamBuffer::expand(ssize_t start, ssize_t length) const
{
c = buffer[i];
if (c < 0x20 || c >= 0x7f)
result.print("\033[1m<%02x>\033[22m", c & 0xff);
result.print("\033[7m<%02x>\033[27m", c & 0xff);
else
result.append(c);
}
@ -316,7 +358,7 @@ dump() const
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);
result.print("\033[7m<%02x>\033[27m", c & 0xff);
else
result.append(c);
if (i == offs+len-1) result.append("\033[47m");

View File

@ -25,12 +25,10 @@
#define Z PRINTF_SIZE_T_PREFIX
ENUM (Commands,
end, in, out, wait, event, exec, connect, disconnect);
/// debug functions /////////////////////////////////////////////
static char* printCommands(StreamBuffer& buffer, const char* c)
char* StreamCore::
printCommands(StreamBuffer& buffer, const char* c)
{
unsigned long timeout;
unsigned long eventnumber;
@ -919,14 +917,12 @@ evalIn()
busUnlock();
flags &= ~BusOwner;
}
busReadRequest(pollPeriod, readTimeout,
return busReadRequest(pollPeriod, readTimeout,
expectedInput, true);
return true;
}
busReadRequest(replyTimeout, readTimeout,
return busReadRequest(replyTimeout, readTimeout,
expectedInput, false);
// continue with readCallback() in another thread
return true;
}
ssize_t StreamCore::

View File

@ -107,6 +107,9 @@ protected:
ENUM(StartMode,
StartNormal, StartInit, StartAsync);
ENUM (Commands,
end, in, out, wait, event, exec, connect, disconnect);
class MutexLock
{
StreamCore* stream;
@ -221,6 +224,9 @@ public:
void printProtocol(FILE* = stdout);
const char* name() { return streamname; }
void printStatus(StreamBuffer& buffer);
private:
char* printCommands(StreamBuffer& buffer, const char* c);
};
#endif

View File

@ -18,6 +18,9 @@
***************************************************************/
#include "StreamError.h"
#ifdef _WIN32
#include <windows.h>
#endif
#include <string.h>
#include <time.h>
#include <stdio.h>
@ -39,6 +42,18 @@ FILE *StreamDebugFile = NULL;
#ifdef _WIN32
#define localtime_r(timet,tm) localtime_s(tm,timet)
/* Enable ANSI colors in Windows console */
static int win_console_init() {
DWORD dwMode = 0;
HANDLE hCons = GetStdHandle(STD_ERROR_HANDLE);
GetConsoleMode(hCons, &dwMode);
dwMode |= ENABLE_VIRTUAL_TERMINAL_PROCESSING;
SetConsoleMode(hCons, dwMode);
return 0;
}
static int s = win_console_init();
#endif
/* You can globally change the printTimestamp function
@ -115,4 +130,3 @@ print(const char* fmt, ...)
va_end(args);
return 1;
}

View File

@ -1124,6 +1124,13 @@ compileString(StreamBuffer& buffer, const char*& source,
continue;
}
if (c == '%') {
if (buffer[formatpos+1] == '%') {
// treat %% as literal % like printf/scanf do
// replace with escaped %
buffer[formatpos] = esc;
formatpos+=2;
continue;
}
debug("StreamProtocolParser::Protocol::compileString "
"format=\"%s\"\n", buffer.expand(formatpos)());
nformats++;

View File

@ -1,9 +1,14 @@
if (@ARGV[0] == "-3.13") {
if (@ARGV[0] eq "--with-asyn") {
shift;
$asyn = 1;
}
if (@ARGV[0] eq "-3.13") {
shift;
} else {
print "variable(streamDebug, int)\n";
print "variable(streamError, int)\n";
print "registrar(streamRegistrar)\n";
if ($asyn) { print "registrar(AsynDriverInterfaceRegistrar)\n"; }
}
print "driver(stream)\n";
for (@ARGV) {

View File

@ -40,8 +40,9 @@ ifneq ($(words $(CALC) $(SYNAPPS)), 0)
# With synApps scalcout record
streamApp_DBD += calcSupport.dbd
PROD_LIBS += calc
# older calc versions require sscan
#PROD_LIBS += sscan
ifneq ($(words $(SSCAN) $(SYNAPPS)), 0)
PROD_LIBS += sscan
endif
endif
streamApp_DBD += stream.dbd