Compare commits

..

238 Commits

Author SHA1 Message Date
1b0e890ddd Treat ENUM as signed to allow things like %#{A=-1|B=0|C=1} 2018-08-20 15:05:55 +02:00
eb4e4b08ff Update README.md 2018-08-14 11:28:53 +02:00
ed00d8eee4 Create README.md 2018-08-14 11:28:03 +02:00
1bb3614e80 moved documentation to docs/ directory to fit github convention 2018-08-14 09:56:24 +02:00
9bd89318bb bugfix in regsub 2018-08-13 10:46:48 +02:00
fa122460fd add re-init support to aao 2018-08-07 18:04:50 +02:00
81ce1dfc62 header usage in record interfaces simplified 2018-08-07 15:21:32 +02:00
53d7129ec3 record interface documentation added 2018-08-07 14:59:04 +02:00
bb66a49ec1 documentation update 2018-08-06 17:40:49 +02:00
03d6d9672e fix several signed/unsigned problems 2018-08-06 11:39:59 +02:00
9891a75bcd improved documentation 2018-07-31 18:17:30 +02:00
b011c286aa add streamReinit function 2018-07-31 17:03:40 +02:00
fb58a80b0c re-init record when 2 is written to .PROC 2018-07-30 15:37:37 +02:00
9e6f2d593d fix spurious error messages when asyncronous protocols get aborted (e.g. from reload) 2018-07-26 17:44:40 +02:00
2cf0c017e2 bugfix: ignore space after last protocol argument 2018-07-26 16:56:39 +02:00
93db87cc07 improved error messages 2018-07-26 16:45:54 +02:00
dace4e5638 make monitors trigger when @init updates output records 2018-07-26 15:10:16 +02:00
cd0ab98602 update docu 2018-07-26 15:09:11 +02:00
170298b123 mention new data types in docu 2018-07-26 14:29:03 +02:00
3d22d2205f description for new record types added 2018-07-26 14:10:45 +02:00
845d8bc1a3 convert doc to html5 2018-07-26 14:09:44 +02:00
3f8483eca1 Update Setup docu page: new configure, github, update links, improve example 2018-07-25 17:48:04 +02:00
8e92be073d Improve docu about serial device setup 2018-07-25 16:15:44 +02:00
57ad547df6 allow spaces around protocol parameters 2018-07-24 18:04:31 +02:00
ca2e6f4a8b bugfix in reloading protocols 2018-07-24 18:04:12 +02:00
4fc619f9a4 make StreamBuffer::dump nicer 2018-07-24 16:10:16 +02:00
8e02c65b09 bugfix: after streamReload handlers and variables that existed before but do not exist any more had not been deleted 2018-07-24 11:42:53 +02:00
fe44bf4fde allow redirection of protocol dump from ioc shell 2018-07-24 11:14:25 +02:00
4b97e4f2df Fix bug in parser when command reference was followed by } without ; 2018-07-19 11:26:49 +02:00
cad3c25079 re-run @init in iocRun after iocPause and streamReload 2018-07-19 09:50:05 +02:00
04d0eb6361 remove noisy debug message 2018-07-18 17:52:09 +02:00
c49fe2e31a allow output redirect of shell functions 2018-07-18 15:27:06 +02:00
a327714907 use static wrappers instead of friend functions where possible 2018-07-18 15:23:20 +02:00
2494f32288 new connection handling: run @init at each re-connect 2018-07-18 14:34:39 +02:00
7de7e48c98 save name/address of bus interface 2018-07-18 14:29:00 +02:00
b18fbeb9ab mark hex bytes in debug output 2018-07-18 14:27:45 +02:00
bd3e430966 make streamError settable before iocInit 2018-07-17 13:51:04 +02:00
fe075c3bbd Do some macro magic to convert enums to strings 2018-07-17 10:09:00 +02:00
d22955a1c5 if write fails because device has disconnected, try to re-connect and re-do write once 2018-07-13 15:36:17 +02:00
8679dd543b clean up error messages 2018-07-13 14:48:27 +02:00
b594f94b0c drop support for buggy cygnus-2.7.2 compiler 2018-07-13 14:12:57 +02:00
5c68e117fd code formatting 2018-07-12 17:12:55 +02:00
f10514db6b merge with 2-7 branch 2018-07-12 17:00:20 +02:00
d5dc15e321 version updated 2018-07-12 16:16:34 +02:00
cfa777d718 added missing output convertion from ULONG in waveform record 2018-07-12 16:11:38 +02:00
54bc78f7c7 fix bug that leads to infinite callback loop when first command (typically 'out') fails 2018-07-12 16:07:48 +02:00
3b30e9acb9 Merge branch '2-7' 2018-07-12 14:51:07 +02:00
77d110de70 fix for 'skip' and '?' in 'in' command 2018-07-11 18:00:08 +02:00
c349c209b0 merge with 2-7 branch 2018-07-11 17:57:30 +02:00
19467bd5d5 allow literal \0 - \9 in regsub if there is no matching sub-expression 2018-07-10 11:08:36 +02:00
d69c74bc8f update version 2018-07-06 17:03:40 +02:00
e09506c2bb always enable error messages when loading protocol files 2018-07-06 17:02:34 +02:00
7b7f319c2f Merge branch 'master' into 2-8 2018-07-06 16:50:50 +02:00
343eef324b bugfix: in quoted strings do not mis-interpret double backslash before quote or $ as escape char 2018-07-06 16:48:15 +02:00
a798cf2f21 buxfix: in regsub continue scanning only after last substitution 2018-07-06 14:37:18 +02:00
a9d89cd195 improve build system 2018-06-22 15:11:22 +02:00
b98f76ece4 use typedef instead of define 2018-06-20 14:33:18 +02:00
1f74040f96 use localtime_s instead of localtime in Windows 2018-06-19 17:19:19 +02:00
6156260ad4 build with 3.16 2018-06-19 16:17:52 +02:00
774efecd40 fixed bug in signed octal and hex recogition 2018-06-19 16:14:42 +02:00
5bb231d8e8 compare performance of different data types 2018-06-19 15:39:09 +02:00
162fa7b329 test aai and aao together with waveform 2018-06-19 14:58:06 +02:00
f94e8bc746 simplify most commonly uses test commands 2018-06-19 14:41:25 +02:00
f462a35db3 somewhat better debug output 2018-06-19 14:17:23 +02:00
1120651daa fixed bug with arrays introduced in commit 9f6d4ab63f 2018-06-19 14:16:28 +02:00
3b26bca69a do not depend on . in PATH for tests 2018-06-18 17:52:19 +02:00
89d3801a5f escape all chars higher than 127 in debug output to <..> to avoid problems with unicode terminals 2018-06-18 17:51:36 +02:00
710a442d31 removed invalid test 2018-06-18 17:49:44 +02:00
f7d5cbf5ce added negative bcd test 2018-06-18 17:48:57 +02:00
c1144cf277 made BCD code compacter 2018-06-18 17:48:01 +02:00
9481b95b30 bug fixed with negative BCD values 2018-06-18 17:16:58 +02:00
18a0e54033 bugfix in %D: output was 1 byte too short 2018-06-18 15:26:59 +02:00
c1b89cb087 allow some time to read the web page 2018-06-18 10:42:28 +02:00
6f4383cd10 use types with defined size for checksums 2018-06-15 14:23:53 +02:00
e9db72de72 new checksums added 2018-06-15 10:44:28 +02:00
827e6eace9 new function streamSetLogfile to set debug log file in script or at run-time 2018-06-14 14:03:13 +02:00
4d3960c599 make git ignore log files 2018-06-14 12:01:22 +02:00
a3d6e9d908 make examples executable from (Linux) command line 2018-06-14 12:00:03 +02:00
4e290413d1 make Makefile's compatible with newer EPICS versions 2018-06-14 11:52:41 +02:00
54eb0b215c increase Windows happyness even more 2018-06-13 11:13:18 +02:00
6d422c4259 remove some old stuff and escape sub-includes from epicsExportSharedSymbols to increase happyness of Windows 2018-06-13 10:45:51 +02:00
9d1084cdf8 put extern "C" around all epicsExport* to increase happyness of Windows 2018-06-13 10:44:14 +02:00
cd5811f59d make script compatible with older sh versions 2018-06-13 10:43:14 +02:00
13cda13ef1 fix comments 2018-06-13 10:42:47 +02:00
6ff52fcc94 remove unneeded headers 2018-06-13 10:41:44 +02:00
ff058547e8 include devStream.h last to increase happyness of Windows 2018-06-13 10:39:52 +02:00
ded9bd2b4d more type cleanup 2018-06-12 17:33:43 +02:00
8dde86dae7 fix warnings on Linux introduced by previous changes on Windows 2018-06-11 17:16:06 +02:00
0c5227dfc5 change all length agruments and return types to size_t or ssize_t 2018-06-11 14:19:21 +02:00
7cdf39d61c Merge branch '2-8' of git.psi.ch:epics_driver_modules/StreamDevice into 2-8
# Conflicts:
#	src/devwaveformStream.c
2018-06-11 14:11:14 +02:00
5a23b89087 change all length agruments and return types to size_t or ssize_t 2018-06-11 14:08:10 +02:00
7e2d414021 change all length agruments and return types to size_t or ssize_t 2018-06-11 13:48:06 +02:00
b91f087736 bugfix in devscalcoutStream.c 2018-06-08 14:05:05 +02:00
136e2ce779 Merge branch '2-7' into 2-8 2018-06-08 11:19:47 +02:00
ed7a537395 moved all epicsExport.h to one place 2018-06-08 11:13:33 +02:00
23f3e806e2 removed unfiltered debug message 2018-06-08 10:54:21 +02:00
1d6d23b444 support for lsi and lso records added 2018-06-07 17:44:04 +02:00
9f6d4ab63f changed streamScanfN to return number of read bytes 2018-06-07 17:42:26 +02:00
0dfcc0f511 explicitly test streamPrintf and streamPrintfN for ERROR 2018-06-06 11:57:14 +02:00
90d657c687 clean up some whitespace 2018-06-06 11:35:32 +02:00
20b3d081e0 merge with master 2018-06-06 10:54:12 +02:00
56b6c9a627 fix for 3.16+ 2018-06-06 10:51:18 +02:00
485d2f128f clean up some 'extern "C"' calls 2018-05-25 16:17:30 +02:00
409c109972 finally fix problems with driver.makefile build using include src/CONFIG_STREAM 2018-05-25 16:14:50 +02:00
7156aee723 support for new 64-bit records 2018-05-23 17:52:09 +02:00
f09a304204 improve how calcout support is built depending on EPICS version 2018-05-23 17:51:31 +02:00
1302db017b fixes for 3.16+ 2018-05-23 17:49:41 +02:00
9a5ac6380d do not assume any particualr size of VAL field 2018-05-23 14:36:30 +02:00
7c8388af2f minor cosmetics 2018-05-23 14:15:48 +02:00
0d7cf3074f made function attributes immune to macros like printf 2018-05-23 13:53:42 +02:00
3fdca6cf1d for all non-system headers use #include "" instead of include <> 2018-05-23 11:55:22 +02:00
cbc549f355 some cleanup after manual merge 2018-05-23 11:19:20 +02:00
099585fa91 merged with github/master 2018-05-23 11:17:44 +02:00
b0c8a14071 start Version 2.8 2018-05-23 11:05:27 +02:00
a9e0fb7beb add new utility function streamReportRecord 2018-03-20 17:33:53 +01:00
943787bc0c fix bug printing status of unprocessed records 2018-03-20 17:07:05 +01:00
0d5ababe55 fix bug in protocol printing 2018-03-20 16:54:34 +01:00
2a1f53a07a fix off-by-one error 2018-03-20 16:10:41 +01:00
7e2305c34d Move scalcout support to src dir 2018-03-20 11:56:07 +01:00
8000f41de8 handle new 64 bit data types 2018-03-19 17:12:57 +01:00
f0a1839548 Merge branch 'master' into cleanup_for_windows 2018-03-13 14:07:39 +01:00
76115ae959 silence C++11 compiler warning 2018-03-13 14:05:37 +01:00
091cfde2a2 silence compiler warning 2018-03-13 14:04:28 +01:00
b77ca836b2 cleanup header usage for windows 2018-03-13 09:47:17 +01:00
35edb61f9c cosmetic changes 2018-02-28 12:05:56 +01:00
a1561af520 Merge pull request #8 from krisztianloki/master
Fix for 'Not interpreted format conversions' accepted.
2018-02-28 12:01:07 +01:00
da174b099e Do not encode formats during recursion
Encoding a format involves replacing it with binary encoded information
that contains a NULL byte. This null byte terminates the search for
subsequent formats. This means that if the encoding is done when
the recursion depth is greater than 0, no format will be recognized as
such when the recursion depth decreases.

A real life manifestation of this bug:

wont_work {
  prefix = "@" "%3c" "ACK";
  in $prefix "%s";
}

The "%s" will be interpreted as literal '%' followed by 's'.
What happens here is that the variable $prefix will be replaced (by
recursively calling compileString()) with "@%3cACK" in the first step
and in the second step the format conversion will be replaced with a
binary encoding (sg like "<03>3c<00>..."). That NUL byte will cause the
search for '%' (in the parent compileString()) to stop, leaving the "%s" intact.

The fix is simple; defer the format encode until everything else is done.
To preserve binary compatibility a new private function is introduced
instead of changing the signature of the exising one.
2018-02-27 16:43:13 +01:00
bcbe749d80 Print the mismatching characters to ease debugging 2018-02-26 16:35:54 +01:00
524aad05a0 Merge pull request #5 from bfrk/master
avoid repeated messages for errors from asyn layer
2018-01-08 09:23:27 +01:00
ca01ba7c35 Avoid repeated messages for errors from asyn layer
This is done by remembering the last asynStatus in the AsynDriverInterface
object. In certain selected places, namely when pasynManager->queueRequest
or pasynCommon->connect is called, we report an error only if the new status
differs from the last one. This gives us just one message when the failure
occurs (or when the operation is tried for the first time) and another
message when the status returns back to asynSuccess.

Note this is currently limited to AsynDriverInterface. If a device is online
but responds in unexpected ways (including not at all) StreamDevice will
still report errors repeatedly whenever records are processed. Fixing this
is very well possible but beyond the scope of this patch.
2017-11-27 19:03:26 +01:00
f2ceb71c2b Fixed indentation of a do-while loop in AsynDriverInterface.cc 2017-11-27 19:03:18 +01:00
4feb14ea35 Merge branch 'master' into 2-8 2017-11-03 15:29:45 +01:00
2830f07324 update version number 2017-11-03 13:46:08 +01:00
abd8daafc3 escape all non-ascii chars to avoid problems with UTF terminals 2017-11-03 13:41:38 +01:00
489e783872 Don't change EOS if not necessary. And some improved diagnostics 2017-11-03 13:40:47 +01:00
10d1fa8b02 do not run exceprion handlers from @init 2017-11-02 09:18:24 +01:00
c8bffebfc6 fix version number 2017-11-02 09:17:47 +01:00
97f6beb3ae add rule to install PDF 2017-08-16 10:52:48 +02:00
b80261ba16 source code repo ignore generated pdf file 2017-06-14 17:10:15 +02:00
6a114b2c2c check if wkhtmltopdf is installed, else print message 2017-06-14 17:07:38 +02:00
bf29238762 fix page break in <pre> boxes 2017-06-14 17:07:03 +02:00
13d1fb2ca0 fix formatting problem 2017-06-14 17:06:38 +02:00
cc1ab5685c update documentation 2017-03-21 15:03:13 +01:00
370b3cd8c4 Merge branch 'master' of /tmp/StreamDevice 2017-01-30 16:47:53 +01:00
3a034f843d add examples for 3.14.8 and 3.13.10 to RELEASE 2017-01-30 16:43:27 +01:00
2de8e916b2 add standalone stuff for 3.13 build 2017-01-30 16:41:03 +01:00
6044edfdd9 Merge branch 'master' of github.com:paulscherrerinstitute/StreamDevice 2017-01-30 12:03:24 +01:00
836388cd22 Merge pull request #4 from hhslepicka/write_mbbo_fix
Removing conflict at write in devmmboDirectStream.c
2017-01-30 12:01:47 +01:00
2685a43760 Format %0s pads with null bytes instead of spaces 2017-01-30 11:58:04 +01:00
0eed3ee9c7 for 3.13 compatibility don't use epicsVsnprintf 2017-01-30 11:55:13 +01:00
c5e3e89e44 remove compiler warning 2017-01-30 11:54:43 +01:00
1f27983505 Removing conflict at write in devmmboDirectStream.c 2017-01-27 12:07:19 -08:00
146a8c895f old compilers complain about comma at end of enum list 2017-01-25 17:17:42 +01:00
efd5a0cbcd some compatibility work 2017-01-25 16:40:58 +01:00
2968231b60 renamed doc to documentation so that make distclean does not delete it 2017-01-25 16:13:18 +01:00
ea2238aa53 fix for previous change 2017-01-25 15:57:24 +01:00
d22e1a5f4a make compatible to 3.14.8- and remove duplicate code 2017-01-25 15:28:46 +01:00
31189ebecf move scalcout to src 2017-01-25 15:02:24 +01:00
d42e5a7a9e fixes for 3.13 2017-01-25 14:58:35 +01:00
e13aa2a96f add external modules 2017-01-25 14:42:35 +01:00
ae021ffeab update .gitignore with generated directories 2017-01-25 13:59:12 +01:00
5a9d89822f change macroname to simplify PSI GNUmakefile 2017-01-25 12:04:40 +01:00
054b0c0e3f remove compiler warning 2017-01-25 11:37:41 +01:00
ac07ac3dcf fix standard EPICS build system 2017-01-25 11:37:15 +01:00
0195386606 add format error checking to exec command 2017-01-25 10:35:58 +01:00
0026959b1e fix waveform records printing unsigned integer formats like %c 2017-01-25 10:35:17 +01:00
450e88d9a9 typo in docu fixed 2017-01-24 09:24:59 +01:00
a4888634b6 make compatible to standard EPICS build system 2017-01-19 16:55:28 +01:00
46a68831c2 get isnan and isinf for old 3.13 (vxWorks only) as well as for 3.14+ EPICS 2017-01-19 16:52:02 +01:00
537d573983 Windows does not like macros after strings without space 2017-01-19 16:43:43 +01:00
96450e7010 Merge branch 'master' of github.com:paulscherrerinstitute/StreamDevice 2017-01-19 09:49:49 +01:00
31e1243eed Merge pull request #2 from MarkRivers/master
Fixes to build on Visual Studio 2010
2017-01-19 09:44:40 +01:00
0a90eb3d9c fix ai/ao conversion when using LINR=NO CONVERSION together with ASLO or AOFF 2017-01-18 16:03:02 +01:00
65f46aec36 New file to ignore generated files 2017-01-13 11:12:37 -06:00
37d14caa5b Use epicsMath.h to define isnan and isinf if needed; would not compile on Visual Studio 2010 2017-01-13 11:11:58 -06:00
384474f6fd Merge pull request #1 from mesamike/patch-1
Add missing include in StreamBuffer.h
2016-11-22 09:20:49 +01:00
17d8592574 Update StreamBuffer.h 2016-11-17 14:24:08 -03:00
0936ac7840 version update 2016-08-05 12:04:07 +02:00
704ece6231 Disable error messages by default in order to prevent filling the log. Set variable streamDebug to 1 to enable error messages. 2016-08-05 12:03:50 +02:00
5c6e98127e typo fixed 2016-08-05 12:01:52 +02:00
8805437c68 remove unneeded file 2016-08-02 11:18:15 +02:00
3acf791409 make docu for %r converer more specific about %.2r versus %2r 2016-07-01 10:56:46 +02:00
0ba674a341 workaround for mbboDirect bug 2016-07-01 10:38:38 +02:00
40c33abac7 workaround for mbboDirect bug 2016-07-01 10:18:34 +02:00
bc67317b0b change the meaning of pre for regsub slightly 2016-06-15 14:52:45 +02:00
06e212c66e version macros updated 2016-06-14 12:06:30 +02:00
7b314ccffd bugfix in regsub 2016-06-14 12:00:02 +02:00
1d84986ee8 do not fill log files with lock errors 2016-06-14 11:43:30 +02:00
2ca8a129f7 regsub converter added 2016-06-14 11:36:36 +02:00
126da8c499 "No reply from device" error message removed because it only fills the log files 2016-06-08 15:15:12 +02:00
ea110d5047 improved error message 2016-04-28 11:58:23 +02:00
b37fad41c6 use local variable for fieldBuffer because on some arch (Moxa ARM5) 64 bit (double) values are corrupted otherwise 2016-04-07 11:05:51 +02:00
74775996db find clean way to create dbd file 2015-12-07 17:22:40 +01:00
74426aab66 provide local strncasecmp for 3.13 2015-12-07 17:21:44 +01:00
690bbb13d4 version macros updated 2015-12-07 15:15:06 +01:00
871fbed2b0 checksums updated 2015-10-19 13:58:06 +02:00
85c68d2ae6 uppercase 2015-10-19 13:58:06 +02:00
8870611d4d modbus checksum added 2015-10-19 13:58:06 +02:00
67af7fc1bf links updated 2015-10-19 13:58:06 +02:00
93bea174e4 highlinting of new featured removed 2015-10-19 13:58:06 +02:00
84fc6aabc8 fixed witdth flag ! added 2015-10-19 13:58:06 +02:00
38c4f5bcb6 renamed to make Windows happy 2015-09-17 14:13:01 +02:00
e2af7e3149 typo fixed 2015-09-15 07:21:41 +00:00
950d75ba43 Split long_format into signed_format and unsigned_format to hangle sign extension from EPICS LONG or ULONG to long or unsigned long correctly on systems with 64 bit long. 2015-08-31 15:25:23 +00:00
e651c99697 fix tests 2015-08-18 14:34:11 +00:00
9694628d3f limit number of significant half bytes in %x formats to avoid problems on 64 bit machines 2015-08-18 14:33:48 +00:00
046582d1a0 add default choice in enum output 2015-08-18 14:32:24 +00:00
f6f0ea9ae5 fix redirection of strings to char arrays 2015-08-18 14:30:54 +00:00
018547cdf3 allow and document direct conversion from VAL/OVAL to integer to get more bits on 64 bit systems 2015-08-18 14:28:26 +00:00
d763a64f03 fix for 64 bit machines 2015-08-17 13:34:00 +00:00
cefa460a0d find correct object code 2015-08-17 13:33:35 +00:00
cc5948ad0b If ai uses no conversion, transport long i/o to and from val directly. This preverves more bits on 64 bit systems than going through the 32 bit rval field. 2015-07-17 13:24:37 +00:00
be1943a66d fix for version check 2015-06-25 16:06:39 +00:00
d9acb47afe make it work with old and new version of driver.makefile 2015-06-25 16:03:49 +00:00
b721d26fb8 avoid buffer overflow 2015-04-08 09:35:00 +00:00
7530c7c67d check for error condifiton 2015-04-08 09:34:46 +00:00
824cd4d283 debug message improved 2015-04-02 13:16:22 +00:00
2e30e7aee6 fix message when INP/OUT link is empty
fix bug with formatting arrays of char as strings in redirect
2015-04-02 13:15:46 +00:00
3a5a3e22b9 Stupid error: Minutes and seconds start from 0, not 1. 2015-02-10 16:48:39 +00:00
51bd766ba6 Fix or rather workaround for MinGW and maybe other systems without localtime_r function 2014-06-24 13:20:19 +00:00
0ab0d6db07 function pointer type problem fixed 2014-06-24 13:19:36 +00:00
a12de614d6 script to make a pdf from the hrml pages 2014-05-02 15:10:18 +00:00
240abd2788 new logo and design cleanup, printing improved 2014-05-02 15:09:49 +00:00
e131fcb32f new logo, png instead of gif, better quality 2014-05-02 15:08:36 +00:00
f88f594e87 shorter header, better for printing 2014-05-02 15:07:06 +00:00
56ef0651f2 fix for BSD Linux 2014-04-07 11:55:36 +00:00
9b9726b800 patchlevel fixed 2013-11-06 13:29:42 +00:00
b139221f0b error messages improved 2013-11-06 10:22:51 +00:00
b0ab8a7a8b write error message on write timeout 2013-11-06 09:52:39 +00:00
ddac589676 newline in report output fixed 2013-11-06 09:44:18 +00:00
5b380cdaad No connection checking before locking device. Multi-devices (GPIB) behave strangely. Get an error when device is disconnected. 2013-11-05 14:48:53 +00:00
cc9adc77fa patchlevel updated 2013-10-23 14:38:28 +00:00
2b38f7bcfa . 2013-10-23 14:36:35 +00:00
0ceada70b5 status information added 2013-10-23 14:35:08 +00:00
7bf91b403d status information added
error messages improved
dont mark device as BusOwner when locking fails
2013-10-23 14:34:53 +00:00
bf5c359649 status information added
use class for status strings to make array overrun impossible
2013-10-23 14:33:15 +00:00
c41ac44bd1 typo in comment 2013-10-23 14:31:35 +00:00
e36013d64e error messages improved
Do not queue lock request when not connected
Do not call lock callback when unlock fails
2013-10-23 14:31:00 +00:00
170 changed files with 6964 additions and 3647 deletions

7
.cvsignore Normal file
View File

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

8
.gitignore vendored Normal file
View File

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

53
GNUmakefile Normal file
View File

@ -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

5
MODULE
View File

@ -1,5 +0,0 @@
# Please change the following email with yours.
Email: dirk.zimoch@psi.ch
Module-Name: StreamDevice2
Description: StreamDevice2
Project-Name:

View File

@ -1,24 +1,26 @@
TOP = ..
DIRS = src
streamApp_DEPEND_DIRS = src
# Look if we have EPICS R3.13 or R3.14
ifeq ($(wildcard $(TOP)/configure),)
# EPICS R3.13
include $(TOP)/config/CONFIG_APP
CONFIG = $(TOP)/config
else
# EPICS R3.14
ifneq ($(wildcard ../configure),)
# We are in an EPICS R3.14+ <TOP> location
include $(TOP)/configure/CONFIG
else ifneq ($(wildcard ../config),)
# We are in an EPICS R3.13 <TOP> location
CONFIG = $(TOP)/config
include $(TOP)/config/CONFIG_APP
else
# Using our own local configuration
TOP = .
DIRS = config configure
src_DEPEND_DIRS := $(DIRS)
include $(TOP)/configure/CONFIG
ifneq ($(words $(CALC) $(SYNAPPS)), 0)
# with synApps calc module (contains scalcout)
DIRS += srcSynApps
srcSynApps_DEPEND_DIRS = src
streamApp_DEPEND_DIRS += srcSynApps
endif
endif
DIRS += src
DIRS += streamApp
streamApp_DEPEND_DIRS = src
include $(CONFIG)/RULES_DIRS
include $(CONFIG)/RULES_TOP
docs/stream.pdf: docs/*.html docs/*.css docs/*.png
cd docs; makepdf
pdf: docs/stream.pdf

20
README.md Normal file
View File

@ -0,0 +1,20 @@
# StreamDevice
_StreamDevice_ is a generic [EPICS](https://www.aps.anl.gov/epics)
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.

12
config/CONFIG_APP Normal file
View File

@ -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

7
config/Makefile Normal file
View File

@ -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

20
config/Makefile.Host Normal file
View File

@ -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)

15
config/Makefile.Vx Normal file
View File

@ -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) $@

3
config/RULES.Host Normal file
View File

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

View File

@ -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

2
config/RULES_ARCHS Normal file
View File

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

2
config/RULES_DIRS Normal file
View File

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

186
config/convertRelease.pl Normal file
View File

@ -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;
}

View File

@ -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;

14
configure/CONFIG Normal file
View File

@ -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>

27
configure/CONFIG_APP Normal file
View File

@ -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

15
configure/Makefile Normal file
View File

@ -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

43
configure/RELEASE Normal file
View File

@ -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

9
configure/RULES Normal file
View File

@ -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

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.6 KiB

View File

@ -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="favicon.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>
<iframe src="nav.html" id="navleft"></iframe>
<h1>StreamDevice: Operating System API</h1>
<h2>Sorry, this documentation is still missing.</h2>
<hr>
<p><small>Dirk Zimoch, 2006</small></p>
</body>
</html>

View File

@ -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="favicon.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>
<iframe src="nav.html" id="navleft"></iframe>
<h1>StreamDevice: Record API</h1>
<h2>Sorry, this documentation is still missing.</h2>
<hr>
<p><small>Dirk Zimoch, 2006</small></p>
</body>
</html>

BIN
docs/PSI.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.2 KiB

View File

@ -1,25 +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="favicon.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>StreamDevice: aai Records</h1>
<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
@ -40,14 +39,19 @@ 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>
<dl>
<dt>DOUBLE format (e.g. <code>%f</code>):</dt>
<dd>
<u>Output:</u><code><i>x[i]</i>=double(VAL[i])</code><br>
<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>
@ -58,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>
@ -65,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>
@ -105,24 +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>
<a href="waveform.html">waveform</a>
</nav>
Dirk Zimoch, 2018
</footer>
</body>
</html>

View File

@ -1,25 +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="favicon.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>StreamDevice: aao Records</h1>
<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
@ -40,14 +39,19 @@ 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>
<dl>
<dt>DOUBLE format (e.g. <code>%f</code>):</dt>
<dd>
<u>Output:</u><code><i>x[i]</i>=double(VAL[i])</code><br>
<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>
@ -58,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>
@ -65,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>
@ -105,24 +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>
<a href="waveform.html">waveform</a>
</nav>
Dirk Zimoch, 2018
</footer>
</body>
</html>

View File

@ -1,16 +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="favicon.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>StreamDevice: ai Records</h1>
<h1>ai Records</h1>
<h2>Normal Operation</h2>
<p>
@ -41,6 +41,12 @@ written or read value.
(=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>
@ -59,25 +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>
</nav>
Dirk Zimoch, 2018
</footer>
</body>
</html>

View File

@ -1,16 +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="favicon.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>StreamDevice: ao Records</h1>
<h1>ao Records</h1>
<h2>Normal Operation</h2>
<p>
@ -31,7 +31,7 @@ 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>
@ -40,6 +40,12 @@ written or read value.
(=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>
@ -57,28 +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>
</nav>
Dirk Zimoch, 2018
</footer>
</body>
</html>

View File

@ -1,16 +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="favicon.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>StreamDevice: bi Records</h1>
<h1>bi Records</h1>
<h2>Normal Operation</h2>
<p>
@ -53,25 +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>
</nav>
Dirk Zimoch, 2018
</footer>
</body>
</html>

View File

@ -1,16 +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="favicon.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>StreamDevice: bo Records</h1>
<h1>bo Records</h1>
<h2>Normal Operation</h2>
<p>
@ -52,25 +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>
</nav>
Dirk Zimoch, 2018
</footer>
</body>
</html>

View File

@ -1,12 +1,12 @@
<!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="favicon.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>
@ -19,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>
@ -68,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:
@ -132,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>();
@ -157,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>
@ -197,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>
@ -276,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>
@ -313,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>.
@ -326,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();
@ -348,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>.
@ -369,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.
@ -385,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);
@ -404,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,
@ -417,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).
@ -450,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);
@ -487,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>
@ -559,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>
@ -606,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
@ -627,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>
@ -639,7 +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>
<footer>
Dirk Zimoch, 2018
</footer>
</body>
</html>

View File

@ -1,16 +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="favicon.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>StreamDevice: calcout Records</h1>
<h1>calcout Records</h1>
<p>
<b>Note:</b> Device support for calcout records is only available for
@ -59,25 +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>
</nav>
Dirk Zimoch, 2018
</footer>
</body>
</html>

View File

@ -1,16 +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="favicon.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>StreamDevice: Using EPICS 3.13</h1>
<h1>Using EPICS 3.13</h1>
<a name="pre"></a>
<h2>1. Prerequisites</h2>
@ -218,7 +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>
<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>

View File

Before

Width:  |  Height:  |  Size: 187 B

After

Width:  |  Height:  |  Size: 187 B

View File

Before

Width:  |  Height:  |  Size: 187 B

After

Width:  |  Height:  |  Size: 187 B

View File

Before

Width:  |  Height:  |  Size: 1.1 KiB

After

Width:  |  Height:  |  Size: 1.1 KiB

View File

@ -1,16 +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: Format Converter API</title>
<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=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>StreamDevice: Format Converter API</h1>
<h1>Format Converter API</h1>
<a name="class"></a>
<h2>Converter Class</h2>
@ -44,7 +44,7 @@ class MyConverter : 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&);
};
RegisterConverter(MyConverter,"Q");
@ -73,17 +73,17 @@ Provide multiple classes, that's more efficient.
<a name="parsing"></a>
<h3>Parsing</h3>
<div class="indent"><code>
int parse (const&nbsp;StreamFormat&&nbsp;fmt, StreamBuffer&&nbsp;info,
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;char&nbsp;flags;
short&nbsp;prec;
unsigned&nbsp;short&nbsp;width;
unsigned&nbsp;short&nbsp;infolen;
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>
@ -124,12 +124,12 @@ flags set:
</ul>
<p>
It is not necessary that these flags have exactly the same meaning in your
formats, but a similar and intuitive meaning helpful for the user.
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>
int the format, that are handled internally by <em>StreamDevice</em> and
in the format, that are handled internally by <em>StreamDevice</em> and
are not of interest to the converter class.
</p>
<p>
@ -163,13 +163,13 @@ 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>long_format</code>, <em>double_format</em>,
<em>string_format</em>, or <code>enum_format</code> depending on the
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,
but I can't imagine why anyone should do that.
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
@ -178,7 +178,8 @@ 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.
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>
@ -191,7 +192,45 @@ 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
@ -203,19 +242,25 @@ The length of the info string can be found in <code>fmt.infolen</code>.
<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).
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.
In the string version, don't write more bytes than <code>maxlen</code>!
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.
Return <code>-1</code> on failure.
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>
<hr>
<p><small>Dirk Zimoch, 2007</small></p>
<footer>
Dirk Zimoch, 2018
</footer>
</body>
</html>

View File

@ -1,16 +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: Format Converters</title>
<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=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>StreamDevice: Format Converters</h1>
<h1>Format Converters</h1>
<a name="syntax"></a>
<h2>1. Format Syntax</h2>
@ -28,8 +28,8 @@ A format converter consists of
</p>
<ul>
<li>The <code>%</code> character</li>
<li>Optionally a field <span class="new">or record</span> name in <code>()</code></li>
<li>Optionally flags out of the characters <code>*# +0-<span class="new">?=</span></code></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>
@ -40,7 +40,7 @@ A format converter consists of
<p>
The flags <code>*# +0-</code> work like in the C functions
<em>printf()</em> and <em>scanf()</em>.
The flags <code>?</code> and <code>=</code> are extensions.
The flags <code>?</code>, <code>=</code> and <code>!</code> are extensions.
</p>
<p>
The <code>*</code> flag skips data in input formats.
@ -55,58 +55,68 @@ 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
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 says that numbers should be left padded with
<code>0</code> if <em>width</em> is larger than required.
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 specifies that output is left justified if
<em>width</em> is larger than required.
</p>
<p class="new">
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 class="new">
<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>float</td>
<td>Read a float value</td>
</tr>
<tr>
<td><code>out "%(HOPR)7.4f";</code></td>
<td>the HOPR field as 7 char float with precision 4</td>
<td>Write 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>
<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>string of chars out of a charset</td>
<td>Read a string of alphanumerical chars or underscores</td>
</tr>
<tr>
<td><code>in "%*i";</code></td>
<td>skipped integer number</td>
<td>Skip over an integer number</td>
</tr>
<tr>
<td><code>in "%?d";</code></td>
<td>decimal number or nothing (read as 0)</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>compare input to the current value formatted as a float with precision 3</td>
<td>Assure that the input is equal to the current value formatted as a float with precision 3</td>
</tr>
</table>
@ -115,9 +125,9 @@ formatted (like for output) and then compared to the input.
<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.
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.
@ -133,42 +143,72 @@ exist in <em>StreamDevice</em> formats.
</p>
<a name="redirection"></a>
<h3>Redirection</h3>
<h3>I/O Redirection to other records or fields</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>.RVAL)f";</code> to write the floating
point input value into the <code>RVAL</code> field of
<code><i>otherrecord</i></code>.
<span class="new">
If no field is given for an other record .VAL is assumed.
When a record name conflicts with a field name use .VAL explicitly.
</span>
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>
This feature 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
<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.
Note that using this syntax is by far not as efficient as using the
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 <code>otherrecord</code> to an alarm
state when anything fails.
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>.
<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>
@ -189,17 +229,17 @@ With the <code>#</code> flag, output always contains a period character.
<p>
<b>Input:</b> All these formats are equivalent. Leading whitespaces are skipped.
</p>
<p class="new">
<p>
With the <code>#</code> flag additional whitespace between sign and number
is accepted.
</p>
<p class="new">
<p>
When a maximum field width is given, leading whitespace only counts to the
field witdth when the space flag is given.
field witdth when the space flag is used.
</p>
<a name="stdl"></a>
<h2>4. Standard LONG Converters (<code>%d</code>, <code>%i</code>,
<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,
@ -210,6 +250,10 @@ field witdth when the space flag is given.
<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
@ -221,16 +265,16 @@ Octal and hexadecimal values can optionally be prefixed.
hexadecimal notation.
Leading whitespaces are skipped.
</p>
<p class="new">
<p>
With the <code>-</code> negative octal and hexadecimal values are accepted.
</p>
<p class="new">
<p>
With the <code>#</code> flag additional whitespace between sign and number
is accepted.
</p>
<p class="new">
<p>
When a maximum field width is given, leading whitespace only counts to the
field witdth when the space flag is given.
field witdth when the space flag is used.
</p>
<a name="stds"></a>
@ -246,16 +290,19 @@ 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>
<span class="new">
except when the space flag is given</span>
but not with <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 class="new">
<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>
@ -286,9 +333,21 @@ to the value 0, <code>STANDBY</code> to 1 and <code>ON</code> to 2.
<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>
Example: <code>%#{neg=-1|stop=0|pos=1|fast=10}</code>.
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>
@ -296,14 +355,15 @@ If one of the strings contains <code>|</code> or <code>}</code>
a <code>\</code> must be used to escape the character.
</p>
<p>
In output, depending on the value, one of the strings is printed.
<b>Output:</b> Depending on the value, one of the strings is printed,
or the default if given and no value matches.
</p>
<p>
In input, if any of the strings matches the value is set accordingly.
<b>Input:</b> 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>
<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).
@ -333,7 +393,7 @@ one character.
</p>
<a name="raw"></a>
<h2>9. Raw LONG Converter (<code>%r</code>)</h2>
<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
@ -345,9 +405,12 @@ 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>prec</em> (or sizeof(long) whatever is less) least
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.
@ -358,7 +421,7 @@ the value is sign extended or zero extended, depending on the
<code>0</code> flag.
</p>
<p>
Example: <code>out "%.2r"</code>
Examples: <code>out "%.2r"; in "%02r";</code>
</p>
<a name="rawdouble"></a>
@ -375,7 +438,7 @@ 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 Converter (<code>%D</code>)</h2>
<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>).
@ -412,7 +475,7 @@ 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).
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>.
@ -424,8 +487,17 @@ 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).
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.
@ -466,21 +538,24 @@ In input, the next byte or bytes must match the 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>
(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).</dd>
(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://www.joegeluso.com/software/articles/ccitt.htm">wrong?</a>)
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://www.joegeluso.com/software/articles/ccitt.htm">correct?</a>)
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>
@ -491,10 +566,10 @@ In input, the next byte or bytes must match the 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>
(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).</dd>
(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>
@ -503,41 +578,49 @@ In input, the next byte or bytes must match the checksum.
</dl>
<a name="regex"></a>
<h2>12. Regular Expresion STRING Converter (<code>%/<em>regex</em>/</code>)</h2>
<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 application.
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 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.
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.
<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>prec</em> is given, it specifies the sub-expression whose match
is retuned.
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.
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
@ -545,8 +628,81 @@ 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>13. MantissaExponent DOUBLE converter (<code>%m</code>)</h2>
<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
@ -565,9 +721,8 @@ 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>
<div class="new">
<a name="timestamp"></a>
<h2>14. Timestamp DOUBLE converter (<code>%T(<em>timeformat</em>)</code>)</h2>
<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).
@ -604,7 +759,7 @@ 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> used its own implementation because many
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>
@ -618,9 +773,10 @@ 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>
</div>
<hr>
<p align="right"><a href="processing.html">Next: Record Processing</a></p>
<p><small>Dirk Zimoch, 2011</small></p>
<footer>
<a href="processing.html">Next: Record Processing</a>
Dirk Zimoch, 2018
</footer>
</body>
</html>

View File

@ -1,12 +1,12 @@
<!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</title>
<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=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>
@ -15,7 +15,7 @@
<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>
<a href="https://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
@ -52,7 +52,7 @@ It does not provide loops or branches.
</p>
<p>
<em>StreamDevice</em> comes with an interface to<a target="ex"
href="http://www.aps.anl.gov/epics/modules/soft/asyn/">
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>.
@ -82,14 +82,26 @@ 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
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>
<a href="http://www.aps.anl.gov/epics/base/R3-14/12-docs/AppDevGuide"
target="ex">IOC Application Developer's Guide</a>
IOC Application Developer's Guide:
<a href="https://www.aps.anl.gov/epics/base/R3-14/12-docs/AppDevGuide"
target="ex">R3.14.12</a>,
<a href="https://www.aps.anl.gov/epics/base/R3-16/1-docs/AppDevGuide"
target="ex">R3.15.5</a>,
<a href="https://www.aps.anl.gov/epics/base/R3-15/5-docs/AppDevGuide"
target="ex">R3.16.1</a>
</p>
<p>
<a href="https://wiki-ext.aps.anl.gov/epics/index.php/RRM_3-14"
@ -104,13 +116,32 @@ This marks text you typically type in configuration files etc.
<pre>
Longer code segments are often set in a box.
</pre>
<p>
Important modifications and new features are
<span class="new">highlighted with a yellow background</span>.
Obsolete features are <strike class="new">highlighted and crossed out</strike>.
</p>
<hr>
<p align="right"><a href="setup.html">Next: Setup</a></p>
<p><small>Dirk Zimoch, 2011</small></p>
<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>

78
docs/int64in.html Normal file
View File

@ -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>

78
docs/int64out.html Normal file
View File

@ -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>

View File

@ -1,16 +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="favicon.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>StreamDevice: longin Records</h1>
<h1>longin Records</h1>
<h2>Normal Operation</h2>
<p>
@ -46,25 +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>
</nav>
Dirk Zimoch, 2018
</footer>
</body>
</html>

View File

@ -1,16 +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="favicon.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>StreamDevice: longout Records</h1>
<h1>longout Records</h1>
<h2>Normal Operation</h2>
<p>
@ -46,25 +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>
</nav>
Dirk Zimoch, 2018
</footer>
</body>
</html>

79
docs/lsi.html Normal file
View File

@ -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>

79
docs/lso.html Normal file
View File

@ -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>

43
docs/makepdf Executable file
View File

@ -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

View File

@ -1,16 +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="favicon.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>StreamDevice: mbbi Records</h1>
<h1>mbbi Records</h1>
<h2>Normal Operation</h2>
<p>
@ -70,25 +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>
</nav>
Dirk Zimoch, 2018
</footer>
</body>
</html>

View File

@ -1,16 +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="favicon.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>StreamDevice: mbbiDirect Records</h1>
<h1>mbbiDirect Records</h1>
<h2>Normal Operation</h2>
<p>
@ -56,25 +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>
</nav>
Dirk Zimoch, 2018
</footer>
</body>
</html>

View File

@ -1,16 +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="favicon.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>StreamDevice: mbbo Records</h1>
<h1>mbbo Records</h1>
<h2>Normal Operation</h2>
<p>
@ -33,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>
@ -66,30 +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>
</nav>
Dirk Zimoch, 2018
</footer>
</body>
</html>

View File

@ -1,16 +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="favicon.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>StreamDevice: mbboDirect Records</h1>
<h1>mbboDirect Records</h1>
<h2>Normal Operation</h2>
<p>
@ -23,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>
@ -53,30 +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>
</nav>
Dirk Zimoch, 2018
</footer>
</body>
</html>

View File

@ -1,10 +1,10 @@
<!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>Navbar</title>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<meta name="author" content="Dirk Zimoch">
<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;
@ -132,6 +132,7 @@ div div div a {list-style-type:circle;}
<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>
@ -155,17 +156,21 @@ div div div a {list-style-type:circle;}
<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="mbbi.html">mbbi</a>
<a target="_parent" href="mbbo.html">mbbo</a>
<a target="_parent" href="mbbiDirect.html">mbbiDirect</a>
<a target="_parent" href="mbboDirect.html">mbboDirect</a>
<a target="_parent" href="stringin.html">stringin</a>
<a target="_parent" href="stringout.html">stringout</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="waveform.html">waveform</a>
<a target="_parent" href="calcout.html">calcout</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>
@ -205,6 +210,15 @@ div div div a {list-style-type:circle;}
</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>

22
docs/osinterface.html Normal file
View File

@ -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>

View File

@ -1,16 +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 Processing</title>
<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=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>StreamDevice: Record Processing</h1>
<h1>Record Processing</h1>
<a name="proc"></a>
<h2>1. Normal Processing</h2>
@ -54,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>
@ -95,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
@ -119,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
@ -146,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>
@ -237,8 +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>
<footer>
<a href="recordtypes.html">Next: Supported Record Types</a>
Dirk Zimoch, 2018
</footer>
</body>
</html>

View File

@ -1,16 +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="favicon.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>StreamDevice: Protocol Files</h1>
<h1>Protocol Files</h1>
<a name="gen"></a>
<h2>1. General Information</h2>
<p>
@ -556,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>
@ -577,8 +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, 2011</small></p>
<footer>
<a href="formats.html">Next: Format Converters</a>
Dirk Zimoch, 2018
</footer>
</body>
</html>

328
docs/recordinterface.html Normal file
View File

@ -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>

View File

@ -1,16 +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="favicon.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>StreamDevice: Record Types</h1>
<h1>Record Types</h1>
<h2>Supported Record Types</h2>
<p>
@ -18,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>
@ -48,7 +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>
<footer>
Dirk Zimoch, 2018
</footer>
</body>
</html>

View File

@ -1,16 +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: scalcout Records</title>
<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=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>StreamDevice: scalcout Records</h1>
<h1>scalcout Records</h1>
<p>
<b>Note:</b> The scalcout record is part of the <i>calc</i> module of
@ -29,7 +29,7 @@ before the final <code>return(0)</code>:
</p>
<pre class="box">
if(pscalcoutDSET->init_record ) {
return (*pscalcoutDSET->init_record)(pcalc);
return (*pscalcoutDSET->init_record)(pcalc);
}
</pre>
@ -77,25 +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>
</nav>
Dirk Zimoch, 2018
</footer>
</body>
</html>

View File

@ -1,27 +1,31 @@
<!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: Setup</title>
<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=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>StreamDevice: Setup</h1>
<h1>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
<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>
@ -34,107 +38,116 @@ and rebuild base.
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>
<em>StreamDevice</em> does not come with its own <kbd>&lt;top&gt;</kbd>
location and <kbd>&lt;top&gt;/configure</kbd> directory.
It expects to be put into an already existing <kbd>&lt;top&gt;</kbd>
directory structure.
You can simply create one with <code>makeBaseApp.pl</code>
(which is part of EPICS base):
</p>
<p>
<code>mkdir top</code><br>
<code>cd top</code><br>
<code>makeBaseApp.pl -t support</code>
</p>
<p>
When asked for "Application names" just hit Enter.
Then go to the newly created <kbd>configure</kbd> subdirectory and
edit the <kbd>RELEASE</kbd> file you find there according to the
instructions below.
</p>
<p>
After changing any configuration, you should run <code>make</code>
in this directory.
</p>
<p>
For details on <kbd>&lt;top&gt;</kbd> directories and <kbd>RELEASE</kbd>
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 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 <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="http://www.aps.anl.gov/epics/modules/soft/asyn/"
target="ex"><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-17.
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>RELEASE</kbd> file:
<kbd>configure/RELEASE</kbd> file:
<pre>
ASYN=/home/epics/asyn4-17
ASYN=/home/epics/asyn4-30
</pre>
<h4>Support for sCalcout record</h4>
<h4>Support for <em>sCalcout</em> record</h4>
<p>
The <a target="ex"
href="http://www.aps.anl.gov/bcda/synApps/calc/R2-8/sCalcoutRecord.html"
><em>sCalcout</em></a> record is part of <a target="ex"
href="http://www.aps.anl.gov/aod/bcda/synApps/index.php"
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 the <em>calc</em> module from <em>SynApps</em> first.
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-2-8
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> modue had dependencies on other <em>SynApps</em>
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 scalcout is optional. <em>StreamDevice</em> works
as well without scalcout or SynApps.
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 add the locations you have to make the locations of the
<em>PCRE</em> header file and library known.
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).
Note that different Linux distributions may locate the files in different directories.
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="http://sourceforge.net/projects/gnuwin32/files/pcre/7.0/pcre-7.0.exe/download"
target="ex">sourceforge</a>
<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 application.
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 target=ex href="http://www.pcre.org">www.pcre.org</a>.
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
@ -142,9 +155,9 @@ Extract the <em>PCRE</em> package in the <kbd>&lt;top&gt;</kbd> directory of
<code>makeBaseApp.pl</code>.
</li>
<li>
Download this <a target=ex href="http://epics.web.psi.ch/software/streamdevice/pcre/Makefile"
Download this <a href="http://epics.web.psi.ch/software/streamdevice/pcre/Makefile"
>Makefile</a> and this
<a target=ex href="http://epics.web.psi.ch/software/streamdevice/pcre/fixforvxworks.pl"
<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>
@ -165,34 +178,29 @@ Regular expressions are optional. If you don't want them, you don't need this.
</p>
<a name="lib"></a>
<h2>2. Build the <em>StreamDevice</em> Library</h2>
<h2>2. Building <em>StreamDevice</em></h2>
<p>
Unpack the
<a href="http://epics.web.psi.ch/software/streamdevice/StreamDevice-2.tgz"
><em>StreamDevice</em> package</a> in the <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
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.
<kbd>stream.dbd</kbd> file and an example IOC application.
</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>.
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 Makefile:
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 xxxAppInclude.dbd file to use
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>
@ -210,7 +218,7 @@ subdirectory.
</p>
<a name="sta"></a>
<h2>4. The Startup Script</h2>
<h2>3. The Startup Script</h2>
<p>
<em>StreamDevice</em> is based on <a
href="protocol.html"><em>protocol files</em></a>.
@ -231,14 +239,14 @@ 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>.
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 must contain lines like this:
Then the startup script may look like this:
</p>
<pre>
epicsEnvSet ("STREAM_PROTOCOL_PATH", ".:../protocols")
@ -252,9 +260,28 @@ asynSetOption ("PS1", 0, "clocal", "Y")
asynSetOption ("PS1", 0, "crtscts", "N")
</pre>
<p>If the power supply was connected via telnet-style TCP/IP
<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 startupscript would contain:
the startup script would contain:
</p>
<pre>
epicsEnvSet ("STREAM_PROTOCOL_PATH", ".:../protocols")
@ -274,7 +301,7 @@ vxi11Configure ("PS1","192.168.164.10",1,1000,"hpib")
<a name="pro"></a>
<h2>5. The Protocol File</h2>
<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.
@ -300,17 +327,21 @@ the last set value in a string like <code>"CURRENT 5.13 A"</code>.
<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>.
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 {
out "CURRENT?";
in "CURRENT %f A";
getCurent;
}
}
</pre>
@ -322,8 +353,13 @@ 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
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>
@ -336,21 +372,26 @@ 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>6. Configure the Records</h2>
<h2>5. Configuring the Records</h2>
<p>
To make a record use <em>StreamDevice</em>, set its <code>DTYP</code> field to
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>file&nbsp;protocol&nbsp;bus</var>&nbsp;[<var>address</var>&nbsp;[<var>parameters</var>]]"</code>.
<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>
Here, <code><var>file</var></code> is the name of the protocol file and
(Elements in <code>[]</code> are optional. To 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>
@ -358,22 +399,38 @@ Here, <code><var>file</var></code> is the name of the protocol file and
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> is dispensable.
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 output record to set the current of <tt>PS1</tt>.
Use protocol <em>setCurrent</em> from file <em>ExamplePS.proto</em>.
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")
@ -388,8 +445,9 @@ record (ao, "PS1:I-set")
}
</pre>
<hr>
<p align="right"><a href="protocol.html">Next: Protocol Files</a></p>
<p><small>Dirk Zimoch, 2011</small></p>
<footer>
<a href="protocol.html">Next: Protocol Files</a>
Dirk Zimoch, 2018
</footer>
</body>
</html>

View File

@ -5,9 +5,10 @@ a:hover {color: #FF0000;}
body {
margin-right:1em;
margin-left:15em;
margin-top:11ex;
font-family: "HelveticaNeue-Light", "Helvetica Neue Light", "Helvetica Neue", Helvetica, Arial, "Lucida Grande", sans-serif;
font-size:14px;
margin-top:75px;
padding-top:1px;
font-family: Helvetica, Arial, sans-serif;
font-size: 100%;
background-color:#ffffff;
}
@ -19,6 +20,7 @@ pre {
border:1px solid #000000;
white-space:pre;
margin:2ex;
page-break-inside:avoid;
}
kbd {
@ -30,26 +32,26 @@ dt {
}
h1 {
font-size:225%;
font-size:250%;
margin-top:0;
font-style:italic;
font-family:serif;
font-weight:bold;
font-family:"Times New Roman", serif;
text-align:center;
position:fixed;
top:0;
left:0;
width:100%;
min-height:60px;
height: 4ex;
line-height:190%;
background-color:white;
border-top:6px solid #1b4486;
border-bottom:4px solid #1b4486;
border-width:0;
border-bottom:3px solid #1b4486;
white-space:nowrap;
background-image:url(PSI.gif);
background-image:url(PSI.png);
background-repeat:no-repeat;
background-position:10px 2px;
text-shadow: .1em .1em .1em lightgray;
background-position:10px 5px;
text-shadow:.1em .1em .1em darkgray;
box-shadow:0 .3em .1em -.2em darkgray;
}
h2 {
@ -72,11 +74,30 @@ p {
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;
}
@ -87,11 +108,21 @@ code {
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:9ex;
padding-top:70px;
width:14em;
height:100%;
border-style:solid;
@ -115,13 +146,9 @@ a[target=ex]:hover:after {
}
@media print {
a:link {color: black; text-decoration:none;}
a:visited {color: black; text-decoration:none;}
a:hover {color: black; text-decoration:none;}
a[target=ex] {text-decoration:underline;}
a:link {text-decoration:none;}
a[target=ex]:after {content:" [" attr(href) "]";}
code {color: black; }
body {margin-left:10px;}
h1 {position:absolute;}
body {margin:0 4em;}
h1 {position:relative; background-position:0 0;}
#navleft {display:none;}
}

View File

@ -1,16 +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="favicon.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>StreamDevice: stringin Records</h1>
<h1>stringin Records</h1>
<h2>Normal Operation</h2>
<p>
@ -43,25 +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>
</nav>
Dirk Zimoch, 2018
</footer>
</body>
</html>

View File

@ -1,16 +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="favicon.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>StreamDevice: stringout Records</h1>
<h1>stringout Records</h1>
<h2>Normal Operation</h2>
<p>
@ -43,25 +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>
<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>

View File

@ -1,16 +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="favicon.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>StreamDevice: Tips and Tricks</h1>
<h1>Tips and Tricks</h1>
<a name="argvar"></a>
<h2>I have many almost identical protocols</h2>
@ -260,7 +260,7 @@ When asked "<code>CURRENT?</code>", the device send something like
</p>
<p>
<code>
read_current {out "CURRENT?"; in "CURRENT %f A"; @mismatch {in "%(\1)39c";}}
read_current {out "CURRENT?"; in "CURRENT %f A"; @mismatch {in "%(\$1)39c";}}
</code>
</p>
<p>
@ -281,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>
@ -406,7 +406,9 @@ 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, 2012</small></p>
<footer>
Dirk Zimoch, 2018
</footer>
</body>
</html>

View File

@ -1,21 +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="favicon.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>StreamDevice: waveform Records</h1>
<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.
@ -37,14 +37,19 @@ 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>
<dl>
<dt>DOUBLE format (e.g. <code>%f</code>):</dt>
<dd>
<u>Output:</u><code><i>x[i]</i>=double(VAL[i])</code><br>
<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>
@ -55,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>
@ -62,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>
@ -102,25 +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>
<a href="waveform.html">waveform</a>
</nav>
Dirk Zimoch, 2018
</footer>
</body>
</html>

View File

@ -1,58 +0,0 @@
include /ioc/tools/driver.makefile
EXCLUDE_VERSIONS = 3.13.2
PROJECT=stream2
BUILDCLASSES += Linux
#DOCUDIR = doc
DBDS = stream.dbd
BUSSES += AsynDriver
BUSSES += Dummy
FORMATS += Enum
FORMATS += BCD
FORMATS += Raw
FORMATS += RawFloat
FORMATS += Binary
FORMATS += Checksum
FORMATS += Regexp
FORMATS += MantissaExponent
FORMATS += Timestamp
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
HEADERS += devStream.h
HEADERS += StreamFormat.h
HEADERS += StreamFormatConverter.h
HEADERS += StreamBuffer.h
HEADERS += StreamError.h
ifeq (${EPICS_BASETYPE},3.13)
USR_INCLUDES += -include $(INSTALL_INCLUDE)/compat3_13.h
endif
ifeq (${EPICS_BASETYPE},3.14)
RECORDTYPES += calcout
endif
StreamCore.o: streamReferences
streamReferences:
perl ../src/makeref.pl Interface $(BUSSES) > $@
perl ../src/makeref.pl Converter $(FORMATS) >> $@
stream.dbd:
perl ../src/makedbd.pl $(RECORDTYPES) > $@

File diff suppressed because it is too large Load Diff

View File

@ -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++)
i = -1;
d = -1;
s = -(long)width;
}
while (width && prec)
{
width--;
bcd = val%10;
if (--prec)
{
output.append('\0');
--prec;
val /= 10;
bcd |= (val%10)<<4;
val /= 10;
}
for (i = (prec - 1) / 2; i >= 0; i--)
{
output.append(bcd[i]);
}
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");

View File

@ -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,58 +29,66 @@ 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')
{
// user defined characters for %B (next 2 in source)
// default characters 0 and 1 for %b
info.append("01");
return unsigned_format;
}
// user defined characters for %B (next 2 in source)
if (*source)
{
if (*source == esc) source++;
info.append(*source++);
if (*source)
{
if (*source == esc) source++;
info.append(*source++);
if (*source)
{
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;
error("Missing characters after %%B format conversion\n");
return false;
}
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 & (1L << (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 significant bit first)
if (!(format.flags & left_flag))
if (!(fmt.flags & left_flag))
{
// pad left
while (width > prec)
while (width > (unsigned int)prec)
{
output.append(' ');
width--;
@ -100,10 +109,10 @@ printLong(const StreamFormat& format, StreamBuffer& output, long value)
else
{
// big endian (most significant bit first)
if (!(format.flags & left_flag))
if (!(fmt.flags & left_flag))
{
// pad left
while (width > prec)
while (width > (unsigned int)prec)
{
output.append(fill);
width--;
@ -123,39 +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;
char zero = format.info[0];
char one = format.info[1];
size_t consumed = 0;
char zero = fmt.info[0];
char one = fmt.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)
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");

View File

@ -1,29 +1,38 @@
# 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
@ -33,6 +42,9 @@ SYNAPPS_RECORDS += scalcout
BUSSES += Debug
BUSSES += Dummy
ifdef ASYN
BUSSES += AsynDriver
endif
# You may add more format converters
# This requires the naming convention
@ -63,7 +75,7 @@ ifneq ($(words $(PCRE) $(PCRE_LIB) $(PCRE_INCLUDE)),0)
FORMATS += Regexp
endif
# Want a loadable module?
# Want a loadable module?
# For Tornado 2.0.2, a fix is needed in the
# registerRecordDeviceDriver.pl script in base:
# at the end replace the line "IoccrfReg iocshReg;"

View File

@ -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,16 +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 int (*checksumFunc)(const unsigned char* data, unsigned int len, unsigned int init);
typedef uint32_t (*checksumFunc)(const uint8_t* data, size_t len, uint32_t init);
static unsigned int sum(const unsigned char* data, unsigned int len, unsigned int sum)
static uint32_t sum(const uint8_t* data, size_t len, uint32_t sum)
{
while (len--)
{
@ -38,7 +62,7 @@ static unsigned int sum(const unsigned char* data, unsigned int len, unsigned in
return sum;
}
static unsigned int xor8(const unsigned char* data, unsigned int len, unsigned int sum)
static uint32_t xor8(const uint8_t* data, size_t len, uint32_t sum)
{
while (len--)
{
@ -47,15 +71,15 @@ static unsigned int xor8(const unsigned char* data, unsigned int len, unsigned i
return sum;
}
static unsigned int xor7(const unsigned char* data, unsigned int len, unsigned int sum)
static uint32_t xor7(const uint8_t* data, size_t len, uint32_t sum)
{
return xor8(data, len, sum) & 0x7F;
}
static unsigned int crc_0x07(const unsigned char* data, unsigned int len, unsigned int 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 unsigned char 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,
@ -93,10 +117,10 @@ static unsigned int crc_0x07(const unsigned char* data, unsigned int len, unsign
return crc;
}
static unsigned int crc_0x31(const unsigned char* data, unsigned int len, unsigned int 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 unsigned char 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,
@ -134,93 +158,93 @@ static unsigned int crc_0x31(const unsigned char* data, unsigned int len, unsign
return crc;
}
static unsigned int crc_0x8005(const unsigned char* data, unsigned int len, unsigned int 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] = {
0x0000,0x8005,0x800f,0x000a,0x801b,0x001e,0x0014,0x8011,
0x8033,0x0036,0x003c,0x8039,0x0028,0x802d,0x8027,0x0022,
0x8063,0x0066,0x006c,0x8069,0x0078,0x807d,0x8077,0x0072,
0x0050,0x8055,0x805f,0x005a,0x804b,0x004e,0x0044,0x8041,
0x80c3,0x00c6,0x00cc,0x80c9,0x00d8,0x80dd,0x80d7,0x00d2,
0x00f0,0x80f5,0x80ff,0x00fa,0x80eb,0x00ee,0x00e4,0x80e1,
0x00a0,0x80a5,0x80af,0x00aa,0x80bb,0x00be,0x00b4,0x80b1,
0x8093,0x0096,0x009c,0x8099,0x0088,0x808d,0x8087,0x0082,
0x8183,0x0186,0x018c,0x8189,0x0198,0x819d,0x8197,0x0192,
0x01b0,0x81b5,0x81bf,0x01ba,0x81ab,0x01ae,0x01a4,0x81a1,
0x01e0,0x81e5,0x81ef,0x01ea,0x81fb,0x01fe,0x01f4,0x81f1,
0x81d3,0x01d6,0x01dc,0x81d9,0x01c8,0x81cd,0x81c7,0x01c2,
0x0140,0x8145,0x814f,0x014a,0x815b,0x015e,0x0154,0x8151,
0x8173,0x0176,0x017c,0x8179,0x0168,0x816d,0x8167,0x0162,
0x8123,0x0126,0x012c,0x8129,0x0138,0x813d,0x8137,0x0132,
0x0110,0x8115,0x811f,0x011a,0x810b,0x010e,0x0104,0x8101,
0x8303,0x0306,0x030c,0x8309,0x0318,0x831d,0x8317,0x0312,
0x0330,0x8335,0x833f,0x033a,0x832b,0x032e,0x0324,0x8321,
0x0360,0x8365,0x836f,0x036a,0x837b,0x037e,0x0374,0x8371,
0x8353,0x0356,0x035c,0x8359,0x0348,0x834d,0x8347,0x0342,
0x03c0,0x83c5,0x83cf,0x03ca,0x83db,0x03de,0x03d4,0x83d1,
0x83f3,0x03f6,0x03fc,0x83f9,0x03e8,0x83ed,0x83e7,0x03e2,
0x83a3,0x03a6,0x03ac,0x83a9,0x03b8,0x83bd,0x83b7,0x03b2,
0x0390,0x8395,0x839f,0x039a,0x838b,0x038e,0x0384,0x8381,
0x0280,0x8285,0x828f,0x028a,0x829b,0x029e,0x0294,0x8291,
0x82b3,0x02b6,0x02bc,0x82b9,0x02a8,0x82ad,0x82a7,0x02a2,
0x82e3,0x02e6,0x02ec,0x82e9,0x02f8,0x82fd,0x82f7,0x02f2,
0x02d0,0x82d5,0x82df,0x02da,0x82cb,0x02ce,0x02c4,0x82c1,
0x8243,0x0246,0x024c,0x8249,0x0258,0x825d,0x8257,0x0252,
0x0270,0x8275,0x827f,0x027a,0x826b,0x026e,0x0264,0x8261,
0x0220,0x8225,0x822f,0x022a,0x823b,0x023e,0x0234,0x8231,
0x8213,0x0216,0x021c,0x8219,0x0208,0x820d,0x8207,0x0202 };
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,
0x0050, 0x8055, 0x805f, 0x005a, 0x804b, 0x004e, 0x0044, 0x8041,
0x80c3, 0x00c6, 0x00cc, 0x80c9, 0x00d8, 0x80dd, 0x80d7, 0x00d2,
0x00f0, 0x80f5, 0x80ff, 0x00fa, 0x80eb, 0x00ee, 0x00e4, 0x80e1,
0x00a0, 0x80a5, 0x80af, 0x00aa, 0x80bb, 0x00be, 0x00b4, 0x80b1,
0x8093, 0x0096, 0x009c, 0x8099, 0x0088, 0x808d, 0x8087, 0x0082,
0x8183, 0x0186, 0x018c, 0x8189, 0x0198, 0x819d, 0x8197, 0x0192,
0x01b0, 0x81b5, 0x81bf, 0x01ba, 0x81ab, 0x01ae, 0x01a4, 0x81a1,
0x01e0, 0x81e5, 0x81ef, 0x01ea, 0x81fb, 0x01fe, 0x01f4, 0x81f1,
0x81d3, 0x01d6, 0x01dc, 0x81d9, 0x01c8, 0x81cd, 0x81c7, 0x01c2,
0x0140, 0x8145, 0x814f, 0x014a, 0x815b, 0x015e, 0x0154, 0x8151,
0x8173, 0x0176, 0x017c, 0x8179, 0x0168, 0x816d, 0x8167, 0x0162,
0x8123, 0x0126, 0x012c, 0x8129, 0x0138, 0x813d, 0x8137, 0x0132,
0x0110, 0x8115, 0x811f, 0x011a, 0x810b, 0x010e, 0x0104, 0x8101,
0x8303, 0x0306, 0x030c, 0x8309, 0x0318, 0x831d, 0x8317, 0x0312,
0x0330, 0x8335, 0x833f, 0x033a, 0x832b, 0x032e, 0x0324, 0x8321,
0x0360, 0x8365, 0x836f, 0x036a, 0x837b, 0x037e, 0x0374, 0x8371,
0x8353, 0x0356, 0x035c, 0x8359, 0x0348, 0x834d, 0x8347, 0x0342,
0x03c0, 0x83c5, 0x83cf, 0x03ca, 0x83db, 0x03de, 0x03d4, 0x83d1,
0x83f3, 0x03f6, 0x03fc, 0x83f9, 0x03e8, 0x83ed, 0x83e7, 0x03e2,
0x83a3, 0x03a6, 0x03ac, 0x83a9, 0x03b8, 0x83bd, 0x83b7, 0x03b2,
0x0390, 0x8395, 0x839f, 0x039a, 0x838b, 0x038e, 0x0384, 0x8381,
0x0280, 0x8285, 0x828f, 0x028a, 0x829b, 0x029e, 0x0294, 0x8291,
0x82b3, 0x02b6, 0x02bc, 0x82b9, 0x02a8, 0x82ad, 0x82a7, 0x02a2,
0x82e3, 0x02e6, 0x02ec, 0x82e9, 0x02f8, 0x82fd, 0x82f7, 0x02f2,
0x02d0, 0x82d5, 0x82df, 0x02da, 0x82cb, 0x02ce, 0x02c4, 0x82c1,
0x8243, 0x0246, 0x024c, 0x8249, 0x0258, 0x825d, 0x8257, 0x0252,
0x0270, 0x8275, 0x827f, 0x027a, 0x826b, 0x026e, 0x0264, 0x8261,
0x0220, 0x8225, 0x822f, 0x022a, 0x823b, 0x023e, 0x0234, 0x8231,
0x8213, 0x0216, 0x021c, 0x8219, 0x0208, 0x820d, 0x8207, 0x0202 };
while (len--) crc = table[((crc>>8) ^ *data++) & 0xFF] ^ (crc << 8);
return crc;
}
static unsigned int crc_0x8005_r(const unsigned char* data, unsigned int len, unsigned int 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] = {
0x0000,0xC0C1,0xC181,0x0140,0xC301,0x03C0,0x0280,0xC241,
0xC601,0x06C0,0x0780,0xC741,0x0500,0xC5C1,0xC481,0x0440,
0xCC01,0x0CC0,0x0D80,0xCD41,0x0F00,0xCFC1,0xCE81,0x0E40,
0x0A00,0xCAC1,0xCB81,0x0B40,0xC901,0x09C0,0x0880,0xC841,
0xD801,0x18C0,0x1980,0xD941,0x1B00,0xDBC1,0xDA81,0x1A40,
0x1E00,0xDEC1,0xDF81,0x1F40,0xDD01,0x1DC0,0x1C80,0xDC41,
0x1400,0xD4C1,0xD581,0x1540,0xD701,0x17C0,0x1680,0xD641,
0xD201,0x12C0,0x1380,0xD341,0x1100,0xD1C1,0xD081,0x1040,
0xF001,0x30C0,0x3180,0xF141,0x3300,0xF3C1,0xF281,0x3240,
0x3600,0xF6C1,0xF781,0x3740,0xF501,0x35C0,0x3480,0xF441,
0x3C00,0xFCC1,0xFD81,0x3D40,0xFF01,0x3FC0,0x3E80,0xFE41,
0xFA01,0x3AC0,0x3B80,0xFB41,0x3900,0xF9C1,0xF881,0x3840,
0x2800,0xE8C1,0xE981,0x2940,0xEB01,0x2BC0,0x2A80,0xEA41,
0xEE01,0x2EC0,0x2F80,0xEF41,0x2D00,0xEDC1,0xEC81,0x2C40,
0xE401,0x24C0,0x2580,0xE541,0x2700,0xE7C1,0xE681,0x2640,
0x2200,0xE2C1,0xE381,0x2340,0xE101,0x21C0,0x2080,0xE041,
0xA001,0x60C0,0x6180,0xA141,0x6300,0xA3C1,0xA281,0x6240,
0x6600,0xA6C1,0xA781,0x6740,0xA501,0x65C0,0x6480,0xA441,
0x6C00,0xACC1,0xAD81,0x6D40,0xAF01,0x6FC0,0x6E80,0xAE41,
0xAA01,0x6AC0,0x6B80,0xAB41,0x6900,0xA9C1,0xA881,0x6840,
0x7800,0xB8C1,0xB981,0x7940,0xBB01,0x7BC0,0x7A80,0xBA41,
0xBE01,0x7EC0,0x7F80,0xBF41,0x7D00,0xBDC1,0xBC81,0x7C40,
0xB401,0x74C0,0x7580,0xB541,0x7700,0xB7C1,0xB681,0x7640,
0x7200,0xB2C1,0xB381,0x7340,0xB101,0x71C0,0x7080,0xB041,
0x5000,0x90C1,0x9181,0x5140,0x9301,0x53C0,0x5280,0x9241,
0x9601,0x56C0,0x5780,0x9741,0x5500,0x95C1,0x9481,0x5440,
0x9C01,0x5CC0,0x5D80,0x9D41,0x5F00,0x9FC1,0x9E81,0x5E40,
0x5A00,0x9AC1,0x9B81,0x5B40,0x9901,0x59C0,0x5880,0x9841,
0x8801,0x48C0,0x4980,0x8941,0x4B00,0x8BC1,0x8A81,0x4A40,
0x4E00,0x8EC1,0x8F81,0x4F40,0x8D01,0x4DC0,0x4C80,0x8C41,
0x4400,0x84C1,0x8581,0x4540,0x8701,0x47C0,0x4680,0x8641,
0x8201,0x42C0,0x4380,0x8341,0x4100,0x81C1,0x8081,0x4040 };
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,
0x0A00, 0xCAC1, 0xCB81, 0x0B40, 0xC901, 0x09C0, 0x0880, 0xC841,
0xD801, 0x18C0, 0x1980, 0xD941, 0x1B00, 0xDBC1, 0xDA81, 0x1A40,
0x1E00, 0xDEC1, 0xDF81, 0x1F40, 0xDD01, 0x1DC0, 0x1C80, 0xDC41,
0x1400, 0xD4C1, 0xD581, 0x1540, 0xD701, 0x17C0, 0x1680, 0xD641,
0xD201, 0x12C0, 0x1380, 0xD341, 0x1100, 0xD1C1, 0xD081, 0x1040,
0xF001, 0x30C0, 0x3180, 0xF141, 0x3300, 0xF3C1, 0xF281, 0x3240,
0x3600, 0xF6C1, 0xF781, 0x3740, 0xF501, 0x35C0, 0x3480, 0xF441,
0x3C00, 0xFCC1, 0xFD81, 0x3D40, 0xFF01, 0x3FC0, 0x3E80, 0xFE41,
0xFA01, 0x3AC0, 0x3B80, 0xFB41, 0x3900, 0xF9C1, 0xF881, 0x3840,
0x2800, 0xE8C1, 0xE981, 0x2940, 0xEB01, 0x2BC0, 0x2A80, 0xEA41,
0xEE01, 0x2EC0, 0x2F80, 0xEF41, 0x2D00, 0xEDC1, 0xEC81, 0x2C40,
0xE401, 0x24C0, 0x2580, 0xE541, 0x2700, 0xE7C1, 0xE681, 0x2640,
0x2200, 0xE2C1, 0xE381, 0x2340, 0xE101, 0x21C0, 0x2080, 0xE041,
0xA001, 0x60C0, 0x6180, 0xA141, 0x6300, 0xA3C1, 0xA281, 0x6240,
0x6600, 0xA6C1, 0xA781, 0x6740, 0xA501, 0x65C0, 0x6480, 0xA441,
0x6C00, 0xACC1, 0xAD81, 0x6D40, 0xAF01, 0x6FC0, 0x6E80, 0xAE41,
0xAA01, 0x6AC0, 0x6B80, 0xAB41, 0x6900, 0xA9C1, 0xA881, 0x6840,
0x7800, 0xB8C1, 0xB981, 0x7940, 0xBB01, 0x7BC0, 0x7A80, 0xBA41,
0xBE01, 0x7EC0, 0x7F80, 0xBF41, 0x7D00, 0xBDC1, 0xBC81, 0x7C40,
0xB401, 0x74C0, 0x7580, 0xB541, 0x7700, 0xB7C1, 0xB681, 0x7640,
0x7200, 0xB2C1, 0xB381, 0x7340, 0xB101, 0x71C0, 0x7080, 0xB041,
0x5000, 0x90C1, 0x9181, 0x5140, 0x9301, 0x53C0, 0x5280, 0x9241,
0x9601, 0x56C0, 0x5780, 0x9741, 0x5500, 0x95C1, 0x9481, 0x5440,
0x9C01, 0x5CC0, 0x5D80, 0x9D41, 0x5F00, 0x9FC1, 0x9E81, 0x5E40,
0x5A00, 0x9AC1, 0x9B81, 0x5B40, 0x9901, 0x59C0, 0x5880, 0x9841,
0x8801, 0x48C0, 0x4980, 0x8941, 0x4B00, 0x8BC1, 0x8A81, 0x4A40,
0x4E00, 0x8EC1, 0x8F81, 0x4F40, 0x8D01, 0x4DC0, 0x4C80, 0x8C41,
0x4400, 0x84C1, 0x8581, 0x4540, 0x8701, 0x47C0, 0x4680, 0x8641,
0x8201, 0x42C0, 0x4380, 0x8341, 0x4100, 0x81C1, 0x8081, 0x4040 };
while (len--) crc = table[(crc ^ *data++) & 0xFF] ^ (crc >> 8);
return crc;
}
static unsigned int crc_0x1021(const unsigned char* data, unsigned int len, unsigned int 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,
@ -258,11 +282,11 @@ static unsigned int crc_0x1021(const unsigned char* data, unsigned int len, unsi
return crc;
}
static unsigned int crc_0x04C11DB7(const unsigned char* data, unsigned int len, unsigned int 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 unsigned int table[] = {
const uint32_t table[] = {
0x00000000, 0x04c11db7, 0x09823b6e, 0x0d4326d9,
0x130476dc, 0x17c56b6b, 0x1a864db2, 0x1e475005,
0x2608edb8, 0x22c9f00f, 0x2f8ad6d6, 0x2b4bcb61,
@ -332,12 +356,12 @@ static unsigned int crc_0x04C11DB7(const unsigned char* data, unsigned int len,
return crc;
}
static unsigned int crc_0x04C11DB7_r(const unsigned char* data, unsigned int len, unsigned int 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 unsigned int table[] = {
const uint32_t table[] = {
0x00000000, 0x77073096, 0xee0e612c, 0x990951ba,
0x076dc419, 0x706af48f, 0xe963a535, 0x9e6495a3,
0x0edb8832, 0x79dcb8a4, 0xe0d5e91e, 0x97d2d988,
@ -407,13 +431,13 @@ static unsigned int crc_0x04C11DB7_r(const unsigned char* data, unsigned int len
return crc;
}
static unsigned int adler32(const unsigned char* data, unsigned int len, unsigned int init)
static uint32_t adler32(const uint8_t* data, size_t len, uint32_t init)
{
unsigned int a = init & 0xFFFF;
unsigned int b = (init >> 16) & 0xFFFF;
uint32_t a = init & 0xFFFF;
uint32_t b = (init >> 16) & 0xFFFF;
while (len) {
unsigned int tlen = len > 5550 ? 5550 : len;
size_t tlen = len > 5550 ? 5550 : len;
len -= tlen;
do {
a += *data++;
@ -421,17 +445,17 @@ static unsigned int adler32(const unsigned char* data, unsigned int len, unsigne
} while (--tlen);
a = (a & 0xFFFF) + (a >> 16) * 15;
b = (b & 0xFFFF) + (b >> 16) * 15;
}
if (a >= 65521) a -= 65521;
b = (b & 0xFFFF) + (b >> 16) * 15;
if (b >= 65521) b -= 65521;
return b << 16 | a;
}
if (a >= 65521) a -= 65521;
b = (b & 0xFFFF) + (b >> 16) * 15;
if (b >= 65521) b -= 65521;
return b << 16 | a;
}
static unsigned int hexsum(const unsigned char* data, unsigned int len, unsigned int sum)
static uint32_t hexsum(const uint8_t* data, size_t len, uint32_t sum)
{
// Add all hex digits, ignore all other bytes.
unsigned int d;
uint32_t d;
while (len--)
{
d = toupper(*data++);
@ -445,13 +469,42 @@ static unsigned int hexsum(const unsigned char* data, unsigned int len, unsigned
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;
unsigned int init;
unsigned int xorout;
signed char bytes;
uint32_t init;
uint32_t xorout;
uint8_t bytes;
};
static checksum checksumMap[] =
@ -469,6 +522,7 @@ 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
@ -478,16 +532,18 @@ static checksum checksumMap[] =
{"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 unsigned int 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::
@ -522,9 +578,9 @@ parse(const StreamFormat&, StreamBuffer& info, const char*& source, bool)
source+=3;
notflag = true;
}
unsigned fnum;
int len = p-source;
unsigned int init, xorout;
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, len) == 0) ||
@ -549,54 +605,54 @@ parse(const StreamFormat&, StreamBuffer& info, const char*& source, bool)
}
}
error ("Unknown checksum algorithm \"%.*s\"\n", len, source);
error ("Unknown checksum algorithm \"%.*s\"\n", (int)len, source);
return false;
}
bool ChecksumConverter::
printPseudo(const StreamFormat& format, StreamBuffer& output)
{
unsigned int sum;
uint32_t sum;
const char* info = format.info;
unsigned int init = extract<unsigned int>(info);
unsigned int xorout = extract<unsigned int>(info);
int fnum = extract<char>(info);
uint32_t init = extract<uint32_t>(info);
uint32_t xorout = extract<uint32_t>(info);
uint_fast8_t fnum = extract<uint8_t>(info);
int start = format.width;
int length = output.length()-format.width;
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 = (xorout ^ checksumMap[fnum].func(
reinterpret_cast<unsigned char*>(output(start)), length, init))
reinterpret_cast<uint8_t*>(output(start)), length, init))
& mask[checksumMap[fnum].bytes];
debug("ChecksumConverter %s: output checksum is 0x%X\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(xbytes*2.5)
// get number of decimal digits from number of bytes: ceil(bytes*2.5)
i = (checksumMap[fnum].bytes+1)*25/10-2;
output.print("%0*d", i, sum);
debug("ChecksumConverter %s: decimal appending %0*d\n",
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.print("%02X", outchar);
output.print("%02" PRIX8, outchar);
else
if (format.flags & left_flag) // poor man's hex: 0x30 - 0x3F
output.print("%c%c",
@ -612,10 +668,10 @@ 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.print("%02X", outchar);
output.print("%02" PRIX8, outchar);
else
if (format.flags & left_flag) // poor man's hex: 0x30 - 0x3F
output.print("%c%c",
@ -628,28 +684,28 @@ 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)
{
unsigned int sum;
uint32_t sum;
const char* info = format.info;
unsigned int init = extract<unsigned int>(info);
unsigned int xorout = extract<unsigned int>(info);
int start = format.width;
int fnum = extract<char>(info);
int length = cursor-format.width;
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)());
int expectedLength =
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)
{
debug("ChecksumConverter %s: Input '%s' too short for checksum\n",
@ -658,18 +714,18 @@ scanPseudo(const StreamFormat& format, StreamBuffer& input, long& cursor)
}
sum = (xorout ^ checksumMap[fnum].func(
reinterpret_cast<unsigned char*>(input(start)), length, init))
(uint8_t*)input(start), length, init))
& mask[checksumMap[fnum].bytes];
debug("ChecksumConverter %s: input checksum is 0x%0*X\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
{
unsigned int sumin = 0;
uint32_t sumin = 0;
size_t i;
for (i = 0; i < expectedLength; i++)
{
inchar = input[cursor+i];
@ -678,21 +734,22 @@ scanPseudo(const StreamFormat& format, StreamBuffer& input, long& cursor)
}
if (sumin != sum)
{
debug("ChecksumConverter %s: Input %0*u does not match checksum %0*u\n",
checksumMap[fnum].name, i, sumin, expectedLength, 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
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
{
if (sscanf(input(cursor+2*i), "%2X", &inchar) != 1)
if (sscanf(input(cursor+2*i), "%2" SCNx8, &inchar) != 1)
{
debug("ChecksumConverter %s: Input byte '%s' is not a hex byte\n",
debug("ChecksumConverter %s: Input byte '%s' is not a hex byte\n",
checksumMap[fnum].name, input.expand(cursor+2*i,2)());
return -1;
}
@ -702,13 +759,13 @@ scanPseudo(const StreamFormat& format, StreamBuffer& input, long& cursor)
{
if ((input[cursor+2*i] & 0xf0) != 0x30)
{
debug("ChecksumConverter %s: Input byte 0x%02X is not in range 0x30 - 0x3F\n",
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%02X is not in range 0x30 - 0x3F\n",
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;
}
@ -720,7 +777,7 @@ scanPseudo(const StreamFormat& format, StreamBuffer& input, long& cursor)
}
if (inchar != ((sum >> 8*i) & 0xff))
{
debug("ChecksumConverter %s: Input byte 0x%02X does not match checksum 0x%0*X\n",
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;
}
@ -728,24 +785,26 @@ scanPseudo(const StreamFormat& format, StreamBuffer& input, long& cursor)
}
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%02X is not in range 0x30 - 0x3F\n",
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%02X is not in range 0x30 - 0x3F\n",
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;
}
@ -757,7 +816,7 @@ scanPseudo(const StreamFormat& format, StreamBuffer& input, long& cursor)
}
if (inchar != ((sum >> 8*j) & 0xff))
{
debug("ChecksumConverter %s: Input byte 0x%02X does not match checksum 0x%0*X\n",
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;
}

View File

@ -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.

View File

@ -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 *
@ -29,14 +29,14 @@ 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))
{
@ -45,10 +45,10 @@ parse(const StreamFormat& fmt, StreamBuffer& info,
return false;
}
long numEnums = 0;
int n = info.length(); // put numEnums here later
size_t n = info.length(); // put numEnums here later
info.append(&numEnums, sizeof(numEnums));
long index = 0;
int i = 0;
size_t i = 0;
i = info.length(); // put index here later
info.append(&index, sizeof(index));
while (*source)
@ -56,7 +56,30 @@ parse(const StreamFormat& fmt, StreamBuffer& info,
if (*source == '=' && (fmt.flags & alt_flag))
{
char* p;
index = strtol(++source, &p, 0);
if (*++source == '?')
{
// default choice
if (scanFormat)
{
error("Default value only allowed in output formats\n");
return false;
}
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 '=' "
@ -70,7 +93,7 @@ parse(const StreamFormat& fmt, StreamBuffer& info,
{
numEnums++;
info.append('\0');
if (*source++ == '}')
{
memcpy(info(n), &numEnums, sizeof(numEnums));
@ -78,7 +101,7 @@ parse(const StreamFormat& fmt, StreamBuffer& info,
numEnums, info.expand()());
return enum_format;
}
index ++;
index++;
i = info.length();
info.append(&index, sizeof(index));
}
@ -99,6 +122,9 @@ printLong(const StreamFormat& fmt, StreamBuffer& output, long 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)
@ -109,7 +135,7 @@ printLong(const StreamFormat& fmt, StreamBuffer& output, long value)
s++;
index = extract<long>(s);
}
if (numEnums == -1)
if (numEnums == -1 && noDefault)
{
error("Value %li not found in enum set\n", value);
return false;
@ -122,7 +148,7 @@ 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",
@ -130,31 +156,31 @@ scanLong(const StreamFormat& fmt, const char* input, long& value)
const char* s = fmt.info;
long numEnums = extract<long>(s);
long index;
int length;
ssize_t consumed;
bool match;
while (numEnums--)
{
index = extract<long>(s);
debug("EnumConverter::scanLong: check #%ld \"%s\"\n", index, s);
length = 0;
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", index);
value = index;
return length;
return consumed;
}
s++;
}

72
src/MacroMagic.h Normal file
View File

@ -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

View File

@ -18,18 +18,16 @@
# #
################################################################
TOP=../..
# Look if we have EPICS R3.13 or R3.14
ifeq ($(wildcard $(TOP)/configure),)
# EPICS R3.13
include $(TOP)/config/CONFIG_APP
# The real work is in Makefile.Vx
include $(TOP)/config/RULES_ARCHS
TOP = ../..
ifneq ($(wildcard ../../configure),)
include $(TOP)/configure/CONFIG
else ifneq ($(wildcard ../../config),)
include $(TOP)/config/CONFIG_APP
include $(TOP)/config/RULES_ARCHS
else
# EPICS R3.14
include $(TOP)/configure/CONFIG
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
@ -75,11 +68,13 @@ 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): ../*.c ../*.h ../*.cc ../CONFIG_STREAM ../Makefile
-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.
@ -89,11 +84,12 @@ streamReferences: ../CONFIG_STREAM
$(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
$(PERL) ../makedbd.pl $(RECORDS) > $@
$(PERL) ../makedbd.pl $(RECORDTYPES) > $@
ifdef ASYN
echo "registrar(AsynDriverInterfaceRegistrar)" >> $@
endif
$(LIBRARY_DEFAULT).dbd$(DEP): ../CONFIG_STREAM
echo $(LIBRARY_DEFAULT).dbd: $< > $@
endif

View File

@ -18,25 +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
$(PERL) ../makedbd.pl -3.13 $(RECORDS_3_13) > $@
$(PERL) ../makedbd.pl -3.13 $(RECORDTYPES) > $@

View File

@ -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

View File

@ -3,11 +3,11 @@
* *
* (C) 2008 Dirk Zimoch (dirk.zimoch@psi.ch) *
* *
* This is a custom exponential format converter for *
* 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 *
@ -39,7 +39,7 @@
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);
};
@ -50,13 +50,13 @@ parse(const StreamFormat&, StreamBuffer&,
return double_format;
}
int MantissaExponentConverter::
ssize_t MantissaExponentConverter::
scanDouble(const StreamFormat& fmt, const char* input, double& value)
{
int mantissa;
int exponent;
int length = -1;
sscanf(input, "%d%d%n", &mantissa, &exponent, &length);
if (fmt.flags & skip_flag) return length;
if (length == -1) return -1;
@ -70,15 +70,15 @@ 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;
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.0) spaces--;
if (spaces < 0) spaces = 0;

View File

@ -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,27 +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 (prec > (int)sizeof(long)) prec=sizeof(long);
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--)
{
@ -56,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;
@ -73,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;
@ -96,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");

View File

@ -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 *
@ -29,7 +29,7 @@ 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::
@ -90,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;

View File

@ -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.print("\\x%02x", *source++ & 0xFF);
continue;
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;
memcpy (&code, fmt.info, sizeof(code));
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) {
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;
if (length > INT_MAX)
length = INT_MAX;
debug("input = \"%s\"\n", input);
debug("length=%" Z "u\n", length);
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;
}
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 (%d>%d bytes). You may want to try the + flag: \"%%+/.../\"\n",
StreamBuffer(input+ovector[subexpr*2], len).expand()(),
(int)len, (int)maxlen-1);
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;
}
len = maxlen-1;
l = size-1;
}
memcpy(value, input+ovector[subexpr*2], len);
value[len]=0;
return ovector[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, "/");

View File

@ -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,8 +26,7 @@
#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
@ -288,7 +287,7 @@ StreamBuffer StreamBuffer::expand(ssize_t start, ssize_t length) const
}
end = start+length;
if (end > len) end = len;
StreamBuffer result((end-start)*2);
StreamBuffer result;
start += offs;
end += offs;
size_t i;
@ -296,14 +295,10 @@ StreamBuffer StreamBuffer::expand(ssize_t start, ssize_t length) const
for (i = start; i < end; i++)
{
c = buffer[i];
if ((c & 0x7f) < 0x20 || (c & 0x7f) == 0x7f)
{
result.print("<%02x>", c & 0xff);
}
if (c < 0x20 || c >= 0x7f)
result.print("\033[1m<%02x>\033[22m", c & 0xff);
else
{
result.append(c);
}
}
return result;
}
@ -311,27 +306,20 @@ StreamBuffer StreamBuffer::expand(ssize_t start, ssize_t length) const
StreamBuffer StreamBuffer::
dump() const
{
StreamBuffer result(256+cap*5);
result.append("\033[0m");
StreamBuffer result;
size_t i;
result.print("%"P"d,%"P"d,%"P"d:\033[37m", offs, len, cap);
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.print(
"<%02x>", buffer[i] & 0xff);
else
result.print(
"\033[34m<%02x>\033[37m", 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.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;

View File

@ -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 *
@ -22,13 +22,14 @@
#include <string.h>
#include <stdlib.h>
#include <sys/types.h>
#ifndef __GNUC__
#define __attribute__(x)
#endif
#ifdef _WIN32
#define ssize_t ptrdiff_t
#if defined(_WIN32)
typedef ptrdiff_t ssize_t;
#endif
class StreamBuffer
@ -93,11 +94,11 @@ public:
{return len>0;}
// length: get current data length
ssize_t length() const
size_t length() const
{return len;}
// capacity: get current max data length (spare one byte for end)
ssize_t capacity() const
size_t capacity() const
{return cap-1;}
// end: get pointer to byte after last data byte
@ -129,8 +130,8 @@ public:
StreamBuffer& append(const StreamBuffer& s)
{return append(s.buffer+s.offs, s.len);}
// operator += alias for set
// operator += alias for append
StreamBuffer& operator+=(char c)
{return append(c);}
@ -194,7 +195,7 @@ public:
{return replace(pos, 0, &c, 1);}
StreamBuffer& print(const char* fmt, ...)
__attribute__ ((format(printf,2,3)));
__attribute__((__format__(__printf__,2,3)));
// find: get index of data in buffer or -1
ssize_t find(char c, ssize_t start=0) const
@ -223,7 +224,7 @@ public:
// expand: create copy of StreamBuffer where all nonprintable characters
// are replaced by <xx> with xx being the hex code of the characters
StreamBuffer expand(ssize_t start, ssize_t length) const;
StreamBuffer expand(ssize_t start=0) const
{return expand(start, len);}

View File

@ -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,17 +17,10 @@
* *
***************************************************************/
#include <stdio.h>
#include "StreamBusInterface.h"
#include "StreamError.h"
const char* StreamIoStatusStr[] = {
"StreamIoSuccess",
"StreamIoTimeout",
"StreamIoNoReply",
"StreamIoEnd",
"StreamIoFault"
};
StreamBusInterfaceRegistrarBase* StreamBusInterfaceRegistrarBase::first;
StreamBusInterfaceRegistrarBase::
@ -76,7 +69,20 @@ find(Client* client, const char* busname, int addr, const char* param)
bus = r->find(client, busname, addr, param);
debug("StreamBusInterface::find %s %s\n",
r->name, bus ? "matches" : "does not match");
if (bus) return bus;
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;
}
@ -112,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;
}
@ -132,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;
}

View File

@ -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,11 +34,13 @@ 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);
@ -75,7 +76,7 @@ public:
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 && businterface->readRequest(replytimeout_ms,
readtimeout_ms, expectedLength, async);
@ -89,32 +90,37 @@ public:
bool busDisconnect() {
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;
@ -161,7 +168,7 @@ protected:
StreamBusInterfaceRegistrarBase(const char* name);
virtual ~StreamBusInterfaceRegistrarBase();
};
template <class C>
class StreamBusInterfaceRegistrar : protected StreamBusInterfaceRegistrarBase
{

File diff suppressed because it is too large Load Diff

View File

@ -5,7 +5,7 @@
* (C) 2005 Dirk Zimoch (dirk.zimoch@psi.ch) *
* *
* This is the kernel 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 *
@ -70,25 +70,28 @@ void acceptEvent(unsigned short mask, unsigned short timeout)
***************************************/
enum Flags {
// 0x00FFFFFF reserved for StreamCore
None = 0x0000,
IgnoreExtraInput = 0x0001,
InitRun = 0x0002,
AsyncMode = 0x0004,
GotValue = 0x0008,
BusOwner = 0x0010,
Separator = 0x0020,
ScanTried = 0x0040,
AcceptInput = 0x0100,
AcceptEvent = 0x0200,
LockPending = 0x0400,
WritePending = 0x0800,
WaitPending = 0x1000,
BusPending = LockPending|WritePending|WaitPending,
ClearOnStart = InitRun|AsyncMode|GotValue|BusOwner|Separator|ScanTried|
AcceptInput|AcceptEvent|BusPending
};
#include "MacroMagic.h"
// Flags: 0x00FFFFFF reserved for StreamCore
const unsigned long None = 0x0000;
const unsigned long IgnoreExtraInput = 0x0001;
const unsigned long InitRun = 0x0002;
const unsigned long AsyncMode = 0x0004;
const unsigned long GotValue = 0x0008;
const unsigned long BusOwner = 0x0010;
const unsigned long Separator = 0x0020;
const unsigned long ScanTried = 0x0040;
const unsigned long AcceptInput = 0x0100;
const unsigned long AcceptEvent = 0x0200;
const unsigned long LockPending = 0x0400;
const unsigned long WritePending = 0x0800;
const unsigned long WaitPending = 0x1000;
const unsigned long Aborted = 0x2000;
const unsigned long BusPending = LockPending|WritePending|WaitPending;
const unsigned long ClearOnStart = InitRun|AsyncMode|GotValue|Aborted|
BusOwner|Separator|ScanTried|
AcceptInput|AcceptEvent|BusPending;
struct StreamFormat;
@ -97,14 +100,12 @@ class StreamCore :
StreamBusInterface::Client
{
protected:
enum ProtocolResult {
Success, LockTimeout, WriteTimeout, ReplyTimeout, ReadTimeout,
ScanError, FormatError, Abort, Fault
};
enum StartMode {
StartNormal, StartInit, StartAsync
};
ENUM(ProtocolResult,
Success, LockTimeout, WriteTimeout, ReplyTimeout, ReadTimeout, ScanError, FormatError, Abort, Fault, Offline);
ENUM(StartMode,
StartNormal, StartInit, StartAsync);
class MutexLock
{
@ -135,10 +136,10 @@ protected:
bool printValue(const StreamFormat& format, long value);
bool printValue(const StreamFormat& format, double value);
bool printValue(const StreamFormat& format, char* value);
long scanValue(const StreamFormat& format, long& value);
long scanValue(const StreamFormat& format, double& value);
long scanValue(const StreamFormat& format, char* value, long maxlen);
long scanValue(const StreamFormat& format);
ssize_t scanValue(const StreamFormat& format, long& value);
ssize_t scanValue(const StreamFormat& format, double& value);
ssize_t scanValue(const StreamFormat& format, char* value, size_t& size);
ssize_t scanValue(const StreamFormat& format);
StreamBuffer protocolname;
unsigned long lockTimeout;
@ -159,11 +160,11 @@ protected:
StreamBuffer onReadTimeout; // error handler (optional)
StreamBuffer onMismatch; // error handler (optional)
const char* commandIndex; // current position
const char* activeCommand; // start of current command
char activeCommand; // current command
StreamBuffer outputLine;
StreamBuffer inputBuffer;
StreamBuffer inputLine;
long consumedInput;
size_t consumedInput;
ProtocolResult runningHandler;
StreamBuffer fieldAddress;
@ -194,8 +195,8 @@ protected:
// StreamBusInterface::Client methods
void lockCallback(StreamIoStatus status);
void writeCallback(StreamIoStatus status);
long readCallback(StreamIoStatus status,
const void* input, long size);
ssize_t readCallback(StreamIoStatus status,
const void* input, size_t size);
void eventCallback(StreamIoStatus status);
void execCallback(StreamIoStatus status);
void connectCallback(StreamIoStatus status);
@ -217,8 +218,9 @@ public:
StreamCore();
virtual ~StreamCore();
bool parse(const char* filename, const char* protocolname);
void printProtocol();
void printProtocol(FILE* = stdout);
const char* name() { return streamname; }
void printStatus(StreamBuffer& buffer);
};
#endif

File diff suppressed because it is too large Load Diff

View File

@ -4,7 +4,7 @@
* (C) 2005 Dirk Zimoch (dirk.zimoch@psi.ch) *
* *
* This is error and debug message handling 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 *
@ -23,6 +23,7 @@
#include <stdio.h>
int streamDebug = 0;
int streamError = 0;
extern "C" {
#ifdef _WIN32
__declspec(dllexport)
@ -36,24 +37,24 @@ FILE *StreamDebugFile = NULL;
#endif
#endif
#ifdef _WIN32
#define localtime_r(timet,tm) localtime_s(tm,timet)
#endif
/* You can globally change the printTimestamp function
by setting the StreamPrintTimestampFunction variable
to your own function.
*/
static void printTimestamp(char* buffer, int size)
static void printTimestamp(char* buffer, size_t size)
{
time_t t;
struct tm tm;
time(&t);
#ifdef _WIN32
tm = *localtime(&t);
#else
localtime_r(&t, &tm);
#endif
strftime(buffer, size, "%Y/%m/%d %H:%M:%S", &tm);
}
void (*StreamPrintTimestampFunction)(char* buffer, int size) = printTimestamp;
void (*StreamPrintTimestampFunction)(char* buffer, size_t size) = printTimestamp;
void StreamError(const char* fmt, ...)
{
@ -74,6 +75,7 @@ void StreamError(int line, const char* file, const char* fmt, ...)
void StreamVError(int line, const char* file, const char* fmt, va_list args)
{
char timestamp[40];
if (!streamError) return; // Error logging disabled
StreamPrintTimestampFunction(timestamp, 40);
#ifdef va_copy
if (StreamDebugFile)

View File

@ -4,7 +4,7 @@
* (C) 2005 Dirk Zimoch (dirk.zimoch@psi.ch) *
* *
* This is error and debug message handling 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 *
@ -28,20 +28,21 @@
#endif
extern int streamDebug;
extern void (*StreamPrintTimestampFunction)(char* buffer, int size);
extern int streamError;
extern void (*StreamPrintTimestampFunction)(char* buffer, size_t size);
void StreamError(int line, const char* file, const char* fmt, ...)
__attribute__ ((format(printf,3,4)));
__attribute__((__format__(__printf__,3,4)));
void StreamVError(int line, const char* file, const char* fmt, va_list args)
__attribute__ ((format(printf,3,0)));
__attribute__((__format__(__printf__,3,0)));
void StreamError(const char* fmt, ...)
__attribute__ ((format(printf,1,2)));
__attribute__((__format__(__printf__,1,2)));
inline void StreamVError(const char* fmt, va_list args)
{
StreamVError(0, NULL, fmt, args);
StreamVError(0, NULL, fmt, args);
}
class StreamDebugClass
@ -52,7 +53,7 @@ public:
StreamDebugClass(const char* file, int line) :
file(file), line(line) {}
int print(const char* fmt, ...)
__attribute__ ((format(printf,2,3)));
__attribute__((__format__(__printf__,2,3)));
};
inline StreamDebugClass
@ -62,9 +63,4 @@ StreamDebugObject(const char* file, int line)
#define error StreamError
#define debug (!streamDebug)?0:StreamDebugObject(__FILE__,__LINE__).print
#if (__GNUC__ == 2 && __GNUC_MINOR__ == 7)
/* Bug in cygnus-2.7.2 compiler: temporary objects crash the compiler */
#define NO_TEMPORARY
#endif
#endif

View File

@ -6,7 +6,7 @@
* *
* This header defines the format stucture used to interface *
* format converters and record interfaces to 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 *
@ -30,15 +30,17 @@ typedef enum {
zero_flag = 0x10,
skip_flag = 0x20,
default_flag = 0x40,
compare_flag = 0x80
compare_flag = 0x80,
fix_width_flag = 0x100
} StreamFormatFlag;
typedef enum {
long_format = 1,
enum_format = 2,
double_format = 3,
string_format = 4,
pseudo_format = 5
unsigned_format = 1,
signed_format,
enum_format,
double_format,
string_format,
pseudo_format
} StreamFormatType;
extern const char* StreamFormatTypeStr[];
@ -47,10 +49,10 @@ typedef struct StreamFormat
{
char conv;
StreamFormatType type;
unsigned char flags;
short prec;
unsigned short width;
unsigned short infolen;
unsigned short flags;
long prec;
unsigned long width;
unsigned long infolen;
const char* info;
} StreamFormat;

View File

@ -6,7 +6,7 @@
* *
* This is the format converter base and includes the standard *
* format converters 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,6 +21,7 @@
#include <stdlib.h>
#include <ctype.h>
#include <limits.h>
#include "StreamFormatConverter.h"
#include "StreamError.h"
@ -37,7 +38,7 @@ parseFormat(const char*& source, FormatType formatType, StreamFormat& streamForm
{
/*
source := [flags] [width] ['.' prec] conv [extra]
flags := '-' | '+' | ' ' | '#' | '0' | '*' | '?' | '='
flags := '-' | '+' | ' ' | '#' | '0' | '*' | '?' | '=' | '!'
width := integer
prec := integer
conv := character
@ -84,6 +85,15 @@ parseFormat(const char*& source, FormatType formatType, StreamFormat& streamForm
}
streamFormat.flags |= default_flag;
break;
case '!':
if (formatType != ScanFormat)
{
error("Use of fixed width modifier '!' "
"only allowed in input formats\n");
return false;
}
streamFormat.flags |= fix_width_flag;
break;
case '=':
if (formatType != ScanFormat)
{
@ -103,12 +113,12 @@ parseFormat(const char*& source, FormatType formatType, StreamFormat& streamForm
char* p;
val = strtoul (source, &p, 10);
source = p;
if (val > 0xFFFF)
if (val > LONG_MAX)
{
error("Field width %ld out of range\n", val);
return false;
}
streamFormat.width = (unsigned short)val;
streamFormat.width = val;
// look for prec
streamFormat.prec = -1;
if (*source == '.')
@ -122,7 +132,7 @@ parseFormat(const char*& source, FormatType formatType, StreamFormat& streamForm
return false;
}
source = p;
if (val > 0x7FFF)
if (val > SHRT_MAX)
{
error("Precision %ld out of range\n", val);
return false;
@ -195,7 +205,7 @@ printPseudo(const StreamFormat& fmt, StreamBuffer&)
return false;
}
int StreamFormatConverter::
ssize_t StreamFormatConverter::
scanLong(const StreamFormat& fmt, const char*, long&)
{
error("Unimplemented scanLong method for %%%c format\n",
@ -203,7 +213,7 @@ scanLong(const StreamFormat& fmt, const char*, long&)
return -1;
}
int StreamFormatConverter::
ssize_t StreamFormatConverter::
scanDouble(const StreamFormat& fmt, const char*, double&)
{
error("Unimplemented scanDouble method for %%%c format\n",
@ -211,16 +221,16 @@ scanDouble(const StreamFormat& fmt, const char*, double&)
return -1;
}
int StreamFormatConverter::
scanString(const StreamFormat& fmt, const char*, char*, size_t)
ssize_t StreamFormatConverter::
scanString(const StreamFormat& fmt, const char*, char*, size_t&)
{
error("Unimplemented scanString method for %%%c format\n",
fmt.conv);
return -1;
}
int StreamFormatConverter::
scanPseudo(const StreamFormat& fmt, StreamBuffer&, long&)
ssize_t StreamFormatConverter::
scanPseudo(const StreamFormat& fmt, StreamBuffer&, size_t&)
{
error("Unimplemented scanPseudo method for %%%c format\n",
fmt.conv);
@ -245,20 +255,20 @@ static void copyFormatString(StreamBuffer& info, const char* source)
// Standard Long Converter for 'diouxX'
static int prepareval(const StreamFormat& fmt, const char*& input, bool& neg)
static ssize_t prepareval(const StreamFormat& fmt, const char*& input, bool& neg)
{
int length = 0;
size_t consumed = 0;
neg = false;
while (isspace(*input)) { input++; length++; }
while (isspace(*input)) { input++; consumed++; }
if (fmt.width)
{
// take local copy because strto* don't have width parameter
int width = fmt.width;
size_t width = fmt.width;
if (fmt.flags & space_flag)
{
// normally whitespace does not count to width
// but do so if space flag is present
width -= length;
width -= consumed;
}
strncpy((char*)fmt.info, input, width);
((char*)fmt.info)[width] = 0;
@ -273,21 +283,21 @@ static int prepareval(const StreamFormat& fmt, const char*& input, bool& neg)
neg = true;
skipsign:
input++;
length++;
consumed++;
}
if (isspace(*input))
{
// allow space after sign only if # flag is set
if (!(fmt.flags & alt_flag)) return -1;
}
return length;
return consumed;
}
class StdLongConverter : public StreamFormatConverter
{
int parse(const StreamFormat& fmt, StreamBuffer& output, const char*& value, bool scanFormat);
bool printLong(const StreamFormat& fmt, StreamBuffer& output, long value);
int scanLong(const StreamFormat& fmt, const char* input, long& value);
ssize_t scanLong(const StreamFormat& fmt, const char* input, long& value);
};
int StdLongConverter::
@ -296,7 +306,7 @@ parse(const StreamFormat& fmt, StreamBuffer& info,
{
if (scanFormat && fmt.prec >= 0)
{
error("Use of precision field '.%d' not allowed with %%%c input conversion\n",
error("Use of precision field '.%ld' not allowed with %%%c input conversion\n",
fmt.prec, fmt.conv);
return false;
}
@ -310,40 +320,44 @@ parse(const StreamFormat& fmt, StreamBuffer& info,
info.append('l');
info.append(fmt.conv);
}
return long_format;
if (fmt.conv == 'd' || fmt.conv == 'i'
|| ((fmt.conv == 'x' || fmt.conv == 'o') && fmt.flags & (left_flag | sign_flag)))
return signed_format;
return unsigned_format;
}
bool StdLongConverter::
printLong(const StreamFormat& fmt, StreamBuffer& output, long value)
{
// limits %x/%X formats to number of half bytes in width.
if (fmt.width && (fmt.conv == 'x' || fmt.conv == 'X') && fmt.width < 2*sizeof(long))
value &= ~(-1L << (fmt.width*4));
output.print(fmt.info, value);
return true;
}
int StdLongConverter::
ssize_t StdLongConverter::
scanLong(const StreamFormat& fmt, const char* input, long& value)
{
char* end;
int length;
ssize_t consumed;
bool neg;
int base;
long v;
length = prepareval(fmt, input, neg);
if (length < 0) return -1;
consumed = prepareval(fmt, input, neg);
if (consumed < 0) return -1;
switch (fmt.conv)
{
case 'd':
base = 10;
break;
case 'o':
base = 8;
goto signcheck;
case 'x':
case 'X':
base = 16;
signcheck:
// allow negative hex and oct numbers with - flag
// allow negative hex and oct numbers with - flag
if (neg && !(fmt.flags & left_flag)) return -1;
base = (fmt.conv == 'o') ? 8 : 16;
break;
case 'u':
if (neg) return -1;
@ -352,11 +366,11 @@ signcheck:
default:
base = 0;
}
value = strtoul(input, &end, base);
if (neg) value = -value;
v = strtoul(input, &end, base);
if (end == input) return -1;
length += end-input;
return length;
consumed += end-input;
value = neg ? -v : v;
return consumed;
}
RegisterConverter (StdLongConverter, "diouxX");
@ -367,7 +381,7 @@ class StdDoubleConverter : public StreamFormatConverter
{
virtual int parse(const StreamFormat&, StreamBuffer&, const char*&, bool);
virtual bool printDouble(const StreamFormat&, StreamBuffer&, double);
virtual int scanDouble(const StreamFormat&, const char*, double&);
virtual ssize_t scanDouble(const StreamFormat&, const char*, double&);
};
int StdDoubleConverter::
@ -376,7 +390,7 @@ parse(const StreamFormat& fmt, StreamBuffer& info,
{
if (scanFormat && fmt.prec >= 0)
{
error("Use of precision field '.%d' not allowed with %%%c input conversion\n",
error("Use of precision field '.%ld' not allowed with %%%c input conversion\n",
fmt.prec, fmt.conv);
return false;
}
@ -399,20 +413,20 @@ printDouble(const StreamFormat& fmt, StreamBuffer& output, double value)
return true;
}
int StdDoubleConverter::
ssize_t StdDoubleConverter::
scanDouble(const StreamFormat& fmt, const char* input, double& value)
{
char* end;
int length;
ssize_t consumed;
bool neg;
length = prepareval(fmt, input, neg);
if (length < 0) return -1;
consumed = prepareval(fmt, input, neg);
if (consumed < 0) return -1;
value = strtod(input, &end);
if (neg) value = -value;
if (end == input) return -1;
length += end-input;
return length;
consumed += end-input;
return consumed;
}
RegisterConverter (StdDoubleConverter, "feEgG");
@ -423,22 +437,23 @@ class StdStringConverter : public StreamFormatConverter
{
virtual int parse(const StreamFormat&, StreamBuffer&, const char*&, bool);
virtual bool printString(const StreamFormat&, StreamBuffer&, const char*);
virtual int scanString(const StreamFormat&, const char*, char*, size_t);
virtual ssize_t scanString(const StreamFormat&, const char*, char*, size_t&);
};
int StdStringConverter::
parse(const StreamFormat& fmt, StreamBuffer& info,
const char*& source, bool scanFormat)
{
if (fmt.flags & (sign_flag|zero_flag))
if (fmt.flags & sign_flag)
{
error("Use of modifiers '+', '0'"
"not allowed with %%s conversion\n");
error("Use of modifier '+'"
"not allowed with %%%c conversion\n",
fmt.conv);
return false;
}
if (scanFormat && fmt.prec >= 0)
{
error("Use of precision field '.%d' not allowed with %%%c input conversion\n",
error("Use of precision field '.%ld' not allowed with %%%c input conversion\n",
fmt.prec, fmt.conv);
return false;
}
@ -451,21 +466,36 @@ parse(const StreamFormat& fmt, StreamBuffer& info,
bool StdStringConverter::
printString(const StreamFormat& fmt, StreamBuffer& output, const char* value)
{
output.print(fmt.info, value);
if (fmt.flags & zero_flag && fmt.width)
{
size_t l;
if (fmt.prec > -1)
{
char* p = (char*)memchr(value, 0, fmt.prec);
if (p) l = p - value;
else l = fmt.prec;
}
else l = strlen(value);
if (!(fmt.flags & left_flag)) output.append('\0', fmt.width-l);
output.append(value, l);
if (fmt.flags & left_flag) output.append('\0', fmt.width-l);
}
else
output.print(fmt.info, value);
return true;
}
int StdStringConverter::
ssize_t StdStringConverter::
scanString(const StreamFormat& fmt, const char* input,
char* value, size_t maxlen)
char* value, size_t& size)
{
int length = 0;
ssize_t consumed = 0;
size_t space_left = size;
ssize_t width = fmt.width;
int width = fmt.width;
if ((fmt.flags & skip_flag) || value == NULL) space_left = 0;
if ((fmt.flags & skip_flag) || value == NULL) maxlen = 0;
// if user does not specify width assume "ininity" (-1)
// if user does not specify width assume "infinity" (-1)
if (width == 0)
{
if (fmt.conv == 'c') width = 1;
@ -478,14 +508,14 @@ scanString(const StreamFormat& fmt, const char* input,
// but do so if space flag is present
if (fmt.flags & space_flag)
{
if (maxlen > 1)
if (space_left > 1) // keep space for terminal null byte
{
*value++ = *input;
maxlen--;
space_left--;
}
width--;
}
length++;
consumed++;
input++;
}
while (*input && width)
@ -493,20 +523,22 @@ scanString(const StreamFormat& fmt, const char* input,
// normally whitespace ends string
// but don't end if # flag is present
if (!(fmt.flags & alt_flag) && isspace(*input)) break;
if (maxlen > 1)
if (space_left > 1)
{
*value++ = *input;
maxlen--;
space_left--;
}
length++;
consumed++;
width--;
input++;
}
if (maxlen > 0)
if (space_left)
{
*value = '\0';
space_left--;
size -= space_left; // update number of bytes copied to value
}
return length;
return consumed;
}
RegisterConverter (StdStringConverter, "s");
@ -517,7 +549,7 @@ class StdCharsConverter : public StreamFormatConverter
{
virtual int parse(const StreamFormat&, StreamBuffer&, const char*&, bool);
virtual bool printLong(const StreamFormat&, StreamBuffer&, long);
virtual int scanString(const StreamFormat&, const char*, char*, size_t);
virtual ssize_t scanString(const StreamFormat&, const char*, char*, size_t&);
};
int StdCharsConverter::
@ -532,7 +564,7 @@ parse(const StreamFormat& fmt, StreamBuffer& info,
}
if (scanFormat && fmt.prec >= 0)
{
error("Use of precision field '.%d' not allowed with %%%c input conversion\n",
error("Use of precision field '.%ld' not allowed with %%%c input conversion\n",
fmt.prec, fmt.conv);
return false;
}
@ -543,7 +575,7 @@ parse(const StreamFormat& fmt, StreamBuffer& info,
info.append("%n");
return string_format;
}
return long_format;
return unsigned_format;
}
bool StdCharsConverter::
@ -553,35 +585,37 @@ printLong(const StreamFormat& fmt, StreamBuffer& output, long value)
return true;
}
int StdCharsConverter::
ssize_t StdCharsConverter::
scanString(const StreamFormat& fmt, const char* input,
char* value, size_t maxlen)
char* value, size_t& size)
{
int length = 0;
size_t consumed = 0;
size_t width = fmt.width;
size_t space_left = size;
int width = fmt.width;
if ((fmt.flags & skip_flag) || value == NULL) maxlen = 0;
if ((fmt.flags & skip_flag) || value == NULL) space_left = 0;
// if user does not specify width assume 1
if (width == 0) width = 1;
while (*input && width)
{
if (maxlen > 1)
if (space_left > 1) // keep space for terminal null byte
{
*value++ = *input;
maxlen--;
space_left--;
}
length++;
consumed++;
width--;
input++;
}
if (maxlen > 0)
if (space_left)
{
*value = '\0';
space_left--;
size -= space_left; // update number of bytes written to value
}
return length;
return consumed; // return number of bytes consumed from input
}
RegisterConverter (StdCharsConverter, "c");
@ -591,7 +625,7 @@ RegisterConverter (StdCharsConverter, "c");
class StdCharsetConverter : public StreamFormatConverter
{
virtual int parse(const StreamFormat&, StreamBuffer&, const char*&, bool);
virtual int scanString(const StreamFormat&, const char*, char*, size_t);
virtual ssize_t scanString(const StreamFormat&, const char*, char*, size_t&);
// no print method, %[ is readonly
};
@ -623,7 +657,7 @@ parse(const StreamFormat& fmt, StreamBuffer& info,
}
if (scanFormat && fmt.prec >= 0)
{
error("Use of precision field '.%d' not allowed with %%%c input conversion\n",
error("Use of precision field '.%ld' not allowed with %%%c input conversion\n",
fmt.prec, fmt.conv);
return false;
}
@ -670,35 +704,38 @@ parse(const StreamFormat& fmt, StreamBuffer& info,
return string_format;
}
int StdCharsetConverter::
ssize_t StdCharsetConverter::
scanString(const StreamFormat& fmt, const char* input,
char* value, size_t maxlen)
char* value, size_t& size)
{
int length = 0;
int width = fmt.width;
ssize_t consumed = 0;
ssize_t width = fmt.width;
size_t space_left = size;
if ((fmt.flags & skip_flag) || value == NULL) maxlen = 0;
if ((fmt.flags & skip_flag) || value == NULL) space_left = 0;
// if user does not specify width assume "ininity" (-1)
// if user does not specify width assume "infinity" (-1)
if (width == 0) width = -1;
while (*input && width)
{
if (fmt.info[*input>>3] & 1<<(*input&7)) break;
if (maxlen > 1)
if (space_left > 1) // keep space for terminal null byte
{
*value++ = *input;
maxlen--;
space_left--;
}
length++;
consumed++;
width--;
input++;
}
if (maxlen > 0)
if (space_left)
{
*value = '\0';
space_left--;
size -= space_left; // update number of bytes written to value
}
return length;
return consumed;
}
RegisterConverter (StdCharsetConverter, "[");

View File

@ -4,7 +4,7 @@
* (C) 2005 Dirk Zimoch (dirk.zimoch@psi.ch) *
* *
* This is the format converter header 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 *
@ -56,14 +56,14 @@ public:
StreamBuffer& output, const char* value);
virtual bool printPseudo(const StreamFormat& fmt,
StreamBuffer& output);
virtual int scanLong(const StreamFormat& fmt,
virtual ssize_t scanLong(const StreamFormat& fmt,
const char* input, long& value);
virtual int scanDouble(const StreamFormat& fmt,
virtual ssize_t scanDouble(const StreamFormat& fmt,
const char* input, double& value);
virtual int scanString(const StreamFormat& fmt,
const char* input, char* value, size_t maxlen);
virtual int scanPseudo(const StreamFormat& fmt,
StreamBuffer& inputLine, long& cursor);
virtual ssize_t scanString(const StreamFormat& fmt,
const char* input, char* value, size_t& size);
virtual ssize_t scanPseudo(const StreamFormat& fmt,
StreamBuffer& inputLine, size_t& cursor);
};
inline StreamFormatConverter* StreamFormatConverter::
@ -130,8 +130,8 @@ void* ref_##converter = &registrar_##converter\
* You only need to implement the flavour of print and/or scan suitable for
* the datatype returned by parse().
*
* Now, fmt.type contains the value returned by parse(). With fmt.info()
* you will get the string you have written to info in parse() (null terminated).
* Now, fmt.type contains the value returned by parse(). With fmt.info() you
* will get the string you have written to info in parse() (null terminated).
* The length of the info string can be found in fmt.infolen.
*
* In print*(), append the converted value to output. Do not modify what is
@ -139,9 +139,14 @@ void* ref_##converter = &registrar_##converter\
* Return true on success, false on failure.
*
* In scan*(), read the value from input and return the number of consumed
* bytes. In the string version, don't write more bytes than maxlen! If the
* skip_flag is set, you don't need to write to value, since the value will be
* discarded anyway. Return -1 on failure.
* bytes.
* In the string version, don't write more bytes than size including a
* mandatory terminating null byte. Update size with the number of bytes
* written into the value, wich may differ from the number of bytes consumed
* from the input (e.g. due to leading space). If the skip_flag is set, the
* input will be discarded. Thus, don't write to value. You also don't need
* to update size.
* Return -1 on failure.
*
*
* Register your class

View File

@ -5,7 +5,7 @@
* (C) 2005 Dirk Zimoch (dirk.zimoch@psi.ch) *
* *
* This is the protocol parser 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 *
@ -26,7 +26,8 @@
#include "StreamError.h"
const char* StreamFormatTypeStr[] = {
"none", "long", "enum", "double", "string", "pseudo"
// must match the order in StreamFormat.h
"none", "unsigned", "signed", "enum", "double", "string", "pseudo"
};
class StreamProtocolParser::Protocol::Variable
@ -280,20 +281,27 @@ parseProtocol(Protocol& protocol, StreamBuffer* commands)
// end of protocol or handler definition
return true;
}
error(line, filename(), "Stray '}' in global context\n");
error(line, filename(), "Unexpected '}' (no matching '{') in global context\n");
return false;
}
if (strchr("{=", token[0]))
if (token[0] == '{')
{
error(line, filename(), "Expect name before '%c'\n", token[0]);
error(line, filename(), "Expect %s name before '%c'\n",
isGlobalContext(commands) ? "protocol" : "handler",
token[0]);
return false;
}
if (token[0] == '=')
{
error(line, filename(), "Expect variable name before '%c'\n", token[0]);
return false;
}
if (token[0] != '@' && !isalpha(token[0]))
{
error(line, filename(), "Unexpected '%s'\n", token());
return false;
}
do op = readChar(); while (op == ' '); // what comes after token?
if (op == EOF)
{
error(line, filename(), "Unexpected end of file after: %s\n", token());
return false;
}
if (op == '=')
{
// variable assignment
@ -366,16 +374,20 @@ parseProtocol(Protocol& protocol, StreamBuffer* commands)
*ppP = pP;
continue;
}
if (token[0] == '@')
{
error(line, filename(), "Expect '{' after handler '%s'\n", token());
return false;
}
// Must be a command or a protocol reference.
if (isGlobalContext(commands))
{
error(line, filename(), "Expect '=' or '{' instead of '%c' after '%s'\n",
op, token());
error(line, filename(), "Expect '=' or '{' instead after '%s'\n",
token());
return false;
}
if (op == ';' || op == '}') // no arguments
{
if (op == '}') ungetc(op, file);
// Check for protocol reference
Protocol* p;
for (p = protocols; p; p = p->next)
@ -383,14 +395,16 @@ parseProtocol(Protocol& protocol, StreamBuffer* commands)
if (p->protocolname.startswith(token()))
{
commands->append(*p->commands);
if (op == '}') ungetc(op, file);
break;
}
}
if (p) continue;
// Fall through for commands without arguments
}
// must be a command (validity will be checked later)
commands->append(token); // is null separated
ungetc(op, file); // put back first char of value
ungetc(op, file); // put back first char after command
if (parseValue(*commands, true) == false)
{
line = startline;
@ -445,7 +459,7 @@ terminated and the line number is stored for later use.
Each time newline is read, line is incremented.
*/
if (!specialchars) specialchars = specialChars;
long token = buffer.length();
size_t token = buffer.length();
int l = line;
int c = readChar();
@ -483,7 +497,7 @@ Each time newline is read, line is incremented.
}
if (c == EOF)
{
error(line, filename(), "Unexpected end of file after '$'\n");
error(line, filename(), "Unexpected end of file after '$' (looking for '}')\n");
return false;
}
if (strchr (specialchars, c))
@ -511,20 +525,31 @@ Each time newline is read, line is incremented.
buffer(token));
return false;
}
if (c == '$' && buffer[-1] == '\\')
{
// quoted variable reference
// terminate string here and do variable in next pass
buffer[-1] = quote;
ungetc(c, file);
break;
}
buffer.append(c);
if (c == quote && buffer[-2] != '\\')
if (c == quote)
{
quote = false;
break;
}
if (c == '\\')
{
c = getc(file);
if (c == '$')
{
// quoted variable reference
// terminate string here and do variable in next pass
buffer[-1] = quote;
ungetc(c, file);
break;
}
if (c == EOF || c == '\n')
{
error(line, filename(), "Backslash at end of line: %s\n",
buffer(token));
return false;
}
buffer.append(c);
}
c = getc(file);
}
buffer.append('\0').append(&l, sizeof(l)); // append line number
@ -535,7 +560,7 @@ Each time newline is read, line is incremented.
// end of file
if (!eofAllowed)
{
error(line, filename(), "Unexpected end of file\n");
error(line, filename(), "Unexpected end of file (looking for '}')\n");
return false;
}
buffer.append('\0');
@ -579,7 +604,7 @@ parseAssignment(const char* name, Protocol& protocol)
bool StreamProtocolParser::
parseValue(StreamBuffer& buffer, bool lazy)
{
long token;
size_t token;
int c;
do c = readChar(); while (c == ' '); // skip leading spaces
@ -593,7 +618,7 @@ parseValue(StreamBuffer& buffer, bool lazy)
c = buffer[token];
if (c == '$') // a variable
{
long varname = token+1;
size_t varname = token+1;
if (buffer[varname] == '"') varname++; // quoted variable
if (lazy || (buffer[varname] >= '0' && buffer[varname] <= '9'))
{
@ -655,11 +680,15 @@ printString(StreamBuffer& buffer, const char* s)
buffer.append("\\\\");
break;
case format_field:
// <format_field> field <eos> addrLength AddressStructure formatstr <eos> StreamFormat [info <eos>]
unsigned short fieldSize;
buffer.print("%%(%s)", ++s);
while (*s++);
s += extract<unsigned short>(s); // skip fieldaddress
fieldSize = extract<unsigned short>(s);
s += fieldSize; // skip fieldAddress
goto format;
case format:
// <format> formatstr <eos> StreamFormat [info <eos>]
buffer.append('%');
s++;
format: {
@ -865,12 +894,12 @@ getEnumVariable(const char* varname, unsigned short& value, const char** enumstr
bool StreamProtocolParser::Protocol::
getStringVariable(const char* varname, StreamBuffer& value, bool* defined)
{
value.clear();
const Variable* pvar = getVariable(varname);
if (!pvar) return true;
if (defined) *defined = true;
const StreamBuffer* pvalue = &pvar->value;
const char* source = (*pvalue)();
value.clear();
if (!compileString(value, source))
{
error("in string variable '%s' in protocol file '%s' line %d\n",
@ -890,12 +919,12 @@ getStringVariable(const char* varname, StreamBuffer& value, bool* defined)
}
bool StreamProtocolParser::Protocol::
getCommands(const char* handlername,StreamBuffer& code, Client* client)
getCommands(const char* handlername, StreamBuffer& code, Client* client)
{
code.clear();
const Variable* pvar = getVariable(handlername);
if (!pvar) return true;
if (!pvar->value) return true;
code.clear();
const char* source = pvar->value();
debug("StreamProtocolParser::Protocol::getCommands"
"(handlername=\"%s\", client=\"%s\"): source=%s\n",
@ -973,7 +1002,7 @@ replaceVariable(StreamBuffer& buffer, const char* varname)
}
// quoted
buffer.append('"');
long i;
size_t i;
bool escaped = false;
for (i = 0; i < v->value.length(); i++)
{
@ -1018,7 +1047,7 @@ compileNumber(unsigned long& number, const char*& source, unsigned long max)
{
buffer.append(source);
}
source += strlen(source)+1+sizeof(int); // skip eos + line
source += strlen(source) + 1 + sizeof(int); // skip eos + line
};
n = strtoul(buffer(), &end, 0);
if (end == buffer())
@ -1056,17 +1085,17 @@ compileNumber(unsigned long& number, const char*& source, unsigned long max)
bool StreamProtocolParser::Protocol::
compileString(StreamBuffer& buffer, const char*& source,
FormatType formatType, Client* client, int quoted)
FormatType formatType, Client* client, int quoted, int recursionDepth)
{
bool escaped = false;
int newline = 0;
StreamBuffer formatbuffer;
int formatpos = buffer.length();
size_t formatpos = buffer.length();
line = getLineNumber(source);
debug("StreamProtocolParser::Protocol::compileString "
"line %d source=\"%s\"\n",
line, source);
"line %d source=\"%s\" formatType=%s quoted=%i recursionDepth=%d\n",
line, source, ::toStr(formatType), quoted, recursionDepth);
// coding is done in two steps:
// 1) read a line from protocol source and code quoted strings,
@ -1076,19 +1105,18 @@ compileString(StreamBuffer& buffer, const char*& source,
while (1)
{
debug("StreamProtocolParser::Protocol::compileString "
"buffer so far: %s\n", buffer.expand()());
// this is step 2: replacing the formats
if (!*source || (newline = getLineNumber(source)) != line)
{
debug("StreamProtocolParser::Protocol::compileString line %i: %s\n", line, buffer.expand()());
// compile all formats in this line
// We do this here after all variables in this line
// have been replaced and after string has been coded.
if (formatType != NoFormat)
if (recursionDepth == 0 && formatType != NoFormat)
{
int nformats=0;
char c;
while ((c = buffer[formatpos]) != '\0')
while (formatpos < buffer.length() && (c = buffer[formatpos]) != '\0')
{
if (c == esc) {
// ignore escaped %
@ -1111,7 +1139,7 @@ compileString(StreamBuffer& buffer, const char*& source,
formatbuffer());
return false;
}
int formatlen = p - buffer(formatpos);
size_t formatlen = p - buffer(formatpos);
buffer.replace(formatpos, formatlen, formatbuffer);
debug("StreamProtocolParser::Protocol::compileString "
"replaced by: \"%s\"\n", buffer.expand(formatpos)());
@ -1246,10 +1274,10 @@ compileString(StreamBuffer& buffer, const char*& source,
{
StreamBuffer value;
if (!replaceVariable(value, source)) return false;
source += strlen(source)+1+sizeof(int);
source += strlen(source) + 1 + sizeof(int);
p = value();
int saveline = line;
if (!compileString(buffer, p, formatType, client))
if (!compileString(buffer, p, formatType, client, false, recursionDepth + 1))
return false;
line = saveline;
continue;
@ -1331,7 +1359,7 @@ compileString(StreamBuffer& buffer, const char*& source,
{"gs", 0x1D},
{"rs", 0x1E},
{"us", 0x1F},
{"del", 0x7f}
{"del", 0x7F}
};
size_t i;
c=-1;
@ -1347,19 +1375,20 @@ compileString(StreamBuffer& buffer, const char*& source,
source);
return false;
}
if (formatType != NoFormat)
if (formatType != NoFormat &&
i > 2 /* do not escape skip */)
{
buffer.append(esc);
}
buffer.append(c);
source += strlen(source)+1+sizeof(int);
source += strlen(source) + 1 + sizeof(int);
break;
}
}
if (c >= 0) continue;
// source may contain a function name
error(line, filename(),
"Unexpected word: \"%s\"\n", source);
"Unexpected '%s' in string\n", source);
return false;
}
debug("StreamProtocolParser::Protocol::compileString buffer=%s\n", buffer.expand()());
@ -1387,7 +1416,7 @@ compileFormat(StreamBuffer& buffer, const char*& formatstr,
*/
const char* source = formatstr;
StreamFormat streamFormat;
int fieldname = 0;
size_t fieldname = 0;
// look for fieldname
if (source[1] == '(')
{
@ -1427,18 +1456,18 @@ compileFormat(StreamBuffer& buffer, const char*& formatstr,
buffer.append(format);
}
const char* formatstart = source + 1;
// parse format and get info string
StreamBuffer infoString;
int type = StreamFormatConverter::parseFormat(source,
formatType, streamFormat, infoString);
if (!type)
{
// parsing failed
return false;
}
if (type < long_format && type > pseudo_format)
if (type < 1 && type > pseudo_format)
{
error(line, filename(),
"Illegal format type %d returned from '%%%c' converter\n",
@ -1469,17 +1498,15 @@ compileFormat(StreamBuffer& buffer, const char*& formatstr,
// add formatstr for debug purpose
buffer.append(formatstart, source-formatstart).append(eos);
#ifndef NO_TEMPORARY
debug("StreamProtocolParser::Protocol::compileFormat: formatstring=\"%s\"\n",
StreamBuffer(formatstart, source-formatstart).expand()());
#endif
// add streamFormat structure and info
buffer.append(&streamFormat, sizeof(streamFormat));
buffer.append(infoString);
debug("StreamProtocolParser::Protocol::compileFormat: format.type=%s, "
"infolen=%d infostring=\"%s\"\n",
"infolen=%ld infostring=\"%s\"\n",
StreamFormatTypeStr[streamFormat.type],
streamFormat.infolen, infoString.expand()());
formatstr = source; // move pointer after parsed format
@ -1495,7 +1522,7 @@ compileCommands(StreamBuffer& buffer, const char*& source, Client* client)
while (*source)
{
command = source;
args = source + strlen(source)+1+sizeof(int);
args = source + strlen(source) + 1 + sizeof(int);
if (!client->compileCommand(this, buffer, command, args))
{
error(getLineNumber(source), filename(),

View File

@ -5,7 +5,7 @@
* (C) 2005 Dirk Zimoch (dirk.zimoch@psi.ch) *
* *
* This is the protocol parser 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,19 +21,19 @@
#ifndef StreamProtocol_h
#define StreamProtocol_h
#include "StreamBuffer.h"
#include <stdio.h>
#include "StreamBuffer.h"
#include "MacroMagic.h"
enum FormatType {NoFormat, ScanFormat, PrintFormat};
ENUM (FormatType,
NoFormat, ScanFormat, PrintFormat);
class StreamProtocolParser
{
public:
enum Codes
{
eos = 0, skip, whitespace, format, format_field, last_function_code
};
ENUM (Codes,
eos, skip, whitespace, format, format_field, last_function_code);
class Client;
@ -59,6 +59,8 @@ public:
bool compileCommands(StreamBuffer&, const char*& source, Client*);
bool replaceVariable(StreamBuffer&, const char* varname);
const Variable* getVariable(const char* name);
bool compileString(StreamBuffer& buffer, const char*& source,
FormatType formatType, Client*, int quoted, int recursionDepth);
public:
@ -73,7 +75,9 @@ public:
bool compileNumber(unsigned long& number, const char*& source,
unsigned long max = 0xFFFFFFFF);
bool compileString(StreamBuffer& buffer, const char*& source,
FormatType formatType = NoFormat, Client* = NULL, int quoted = false);
FormatType formatType = NoFormat, Client* client = NULL, int quoted = false) {
return compileString(buffer, source, formatType, client, quoted, 0);
}
bool checkUnused();
~Protocol();
void report();
@ -114,7 +118,7 @@ private:
bool parseAssignment(const char* variable, Protocol&);
bool parseValue(StreamBuffer& buffer, bool lazy = false);
protected:
protected:
~StreamProtocolParser(); // get rid of cygnus-2.7.2 compiler warning
public:

View File

@ -5,7 +5,7 @@
* (C) 2005 Dirk Zimoch (dirk.zimoch@psi.ch) *
* *
* This provides a version string 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 *

View File

@ -5,7 +5,7 @@
* (C) 2010 Dirk Zimoch (dirk.zimoch@psi.ch) *
* *
* This is the time stamp 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 *
@ -26,10 +26,28 @@
#include <stdlib.h>
#include <errno.h>
/* timezone in UNIX contains the seconds between UTC and local time,
but not in Free-BSD! Here timezone() is a function delivering
the time zone abbreviation (e.g. CET). Alternatively, the timezone
value can also be gained from tm_gmtoff of the tm-structure.
HJK, 4.4.14 */
/* The same seems to be true for other BSDs. DZ. */
#if defined(__FreeBSD__) || \
defined(__NetBSD__) || \
defined(__OpenBSD__) || \
defined(__bsdi__ ) || \
defined(__DragonFly__)
static int timezone_bsd=0;
#define timezone timezone_bsd
#define tzset() { struct tm tm; time_t timet; tzset(); time(&timet); \
localtime_r(&timet, &tm); timezone=tm.tm_gmtoff; }
#endif
#ifdef _WIN32
#define tzset() _tzset()
#define timezone _timezone
#define localtime_r(timet,tm) localtime_s(tm,timet) /* Windows sucks */
#define localtime_r(timet,tm) localtime_s(tm,timet)
#endif
#ifdef __rtems__
@ -46,11 +64,18 @@ int timezone = 0;
} while (0)
#endif
#if defined(__MINGW32__)
/* MinGW has no re-entrant localtime. How about other environments? */
/* Just let's hope for the best */
#undef localtime_r
#define localtime_r(timet,tm) (*(tm)=*localtime(timet))
#endif
class TimestampConverter : 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 TimestampConverter::
@ -126,10 +151,11 @@ printDouble(const StreamFormat& format, StreamBuffer& output, double value)
struct tm brokenDownTime;
char buffer [40];
char fracbuffer [15];
int length;
size_t length;
time_t sec;
double frac;
int i, n;
ssize_t i;
size_t n;
char* c;
char* p;
@ -147,7 +173,7 @@ printDouble(const StreamFormat& format, StreamBuffer& output, double value)
n = strtol(output(i+1), &c, 10);
if (*c++ != 'f') return false;
/* print fractional part */
sprintf(fracbuffer, "%.*f", n, frac);
sprintf(fracbuffer, "%.*f", (int)n, frac);
p = strchr(fracbuffer, '.')+1;
output.replace(i, c-output(i), p);
}
@ -158,10 +184,10 @@ printDouble(const StreamFormat& format, StreamBuffer& output, double value)
all fields, e.g. %z.
*/
static int strmatch(const char*& input, const char** strings, int minlen)
static int strmatch(const char*& input, const char** strings, size_t minlen)
{
int i;
int c;
size_t c;
for (i=0; strings[i]; i++) {
for (c=0; ; c++)
@ -366,7 +392,7 @@ startover:
debug ("TimestampConverter::scantime: %s hour = %d\n", pm?"PM":"AM", tm->tm_hour);
break;
case 'M': /* minute */
i = nummatch(input, 1, 59);
i = nummatch(input, 0, 59);
if (i < 0)
{
error ("error parsing minute: '%.20s'\n", input);
@ -376,7 +402,7 @@ startover:
debug ("TimestampConverter::scantime: min = %d\n", tm->tm_min);
break;
case 'S': /* second */
i = nummatch(input, 1, 60);
i = nummatch(input, 0, 60);
if (i < 0)
{
error ("error parsing week second: '%.20s'\n", input);
@ -491,9 +517,7 @@ startover:
return input;
}
int TimestampConverter::
ssize_t TimestampConverter::
scanDouble(const StreamFormat& format, const char* input, double& value)
{
struct tm brokenDownTime;

View File

@ -5,7 +5,7 @@
* (C) 2005 Dirk Zimoch (dirk.zimoch@psi.ch) *
* *
* This is the header for the EPICS interface to StreamDevice. *
* Please refer to the HTML files in ../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,14 +21,19 @@
#ifndef devStream_h
#define devStream_h
#define STREAM_MAJOR 2
#define STREAM_MINOR 6
#define STREAM_PATCHLEVEL 3
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <sys/types.h>
#if defined(__vxworks) || defined(vxWorks)
#include <vxWorks.h>
#if defined(__cplusplus)
extern "C" {
#endif
#define STREAM_MAJOR 2
#define STREAM_MINOR 8
#define STREAM_PATCHLEVEL 0
#ifndef OK
#define OK 0
#endif
@ -40,83 +45,69 @@
#define DO_NOT_CONVERT 2
#define INIT_RUN (!interruptAccept)
#include <epicsVersion.h>
#include "epicsVersion.h"
#ifdef BASE_VERSION
#define EPICS_3_13
#endif
#if defined(__cplusplus) && defined(EPICS_3_13)
extern "C" {
#endif
#ifdef epicsExportSharedSymbols
# define devStream_epicsExportSharedSymbols
# undef epicsExportSharedSymbols
#endif
#include <stdio.h>
#include <dbCommon.h>
#include <dbScan.h>
#include <devSup.h>
/* #include <dbFldTypes.h> */
#include <dbAccess.h>
#include "dbCommon.h"
#include "dbScan.h"
#include "devSup.h"
#include "dbAccess.h"
#include "errlog.h"
#include "alarm.h"
#include "recGbl.h"
#include "dbEvent.h"
#include "epicsMath.h"
#ifdef devStream_epicsExportSharedSymbols
# define epicsExportSharedSymbols
# include "shareLib.h"
#endif
#if defined(__cplusplus) && defined(EPICS_3_13)
}
#if defined(_WIN32)
typedef ptrdiff_t ssize_t;
#endif
typedef const struct format_s {
unsigned char type;
const struct StreamFormat* priv;
} format_t;
#ifdef __cplusplus
extern "C" {
#endif
epicsShareExtern FILE* StreamDebugFile;
extern const char StreamVersion [];
typedef long (*streamIoFunction) (dbCommon*, format_t*);
epicsShareFunc long streamInit(int after);
epicsShareFunc long streamInitRecord(dbCommon *record,
long streamInit(int after);
long streamInitRecord(dbCommon *record,
const struct link *ioLink,
streamIoFunction readData, streamIoFunction writeData);
epicsShareFunc long streamReport(int interest);
epicsShareFunc long streamReadWrite(dbCommon *record);
epicsShareFunc long streamGetIointInfo(int cmd,
long streamReport(int interest);
long streamReadWrite(dbCommon *record);
long streamGetIointInfo(int cmd,
dbCommon *record, IOSCANPVT *ppvt);
epicsShareFunc long streamPrintf(dbCommon *record, format_t *format, ...);
epicsShareFunc long streamScanfN(dbCommon *record, format_t *format,
long streamPrintf(dbCommon *record, format_t *format, ...);
ssize_t streamScanfN(dbCommon *record, format_t *format,
void*, size_t maxStringSize);
/* backward compatibility stuff */
#define devStreamIoFunction streamIoFunction
#define devStreamInit streamInit
#define devStreamInitRecord streamInitRecord
#define devStreamReport streamReport
#define devStreamRead streamReadWrite
#define devStreamWrite streamReadWrite
#define devStreamGetIointInfo streamGetIointInfo
#define devStreamPrintf streamPrintf
#define devStreamPrintSep(record) (0)
#define devStreamScanSep (0)
#define devStreamScanf(record, format, value) \
streamScanfN(record, format, value, MAX_STRING_SIZE)
#define streamScanf(record, format, value) \
streamScanfN(record, format, value, MAX_STRING_SIZE)
#define streamRead streamReadWrite
#define streamWrite streamReadWrite
#define streamReport NULL
#ifdef EPICS_3_13
#define epicsExportAddress(a,b) extern int dummy
#else
#include "epicsExport.h"
#endif
#ifdef __cplusplus
}
#endif

View File

@ -5,7 +5,7 @@
* (C) 2006 Dirk Zimoch (dirk.zimoch@psi.ch) *
* *
* This is an EPICS record Interface 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 *
@ -18,16 +18,12 @@
* *
***************************************************************/
#include <string.h>
#include <stdlib.h>
#include "aaiRecord.h"
#include "devStream.h"
#include <aaiRecord.h>
#include <errlog.h>
#include <epicsExport.h>
static long readData (dbCommon *record, format_t *format)
static long readData(dbCommon *record, format_t *format)
{
aaiRecord *aai = (aaiRecord *) record;
aaiRecord *aai = (aaiRecord *)record;
double dval;
long lval;
@ -37,7 +33,7 @@ static long readData (dbCommon *record, format_t *format)
{
case DBF_DOUBLE:
{
if (streamScanf (record, format, &dval) != OK)
if (streamScanf(record, format, &dval) == ERROR)
{
return aai->nord ? OK : ERROR;
}
@ -50,17 +46,18 @@ static long readData (dbCommon *record, format_t *format)
((epicsFloat32 *)aai->bptr)[aai->nord] = (epicsFloat32)dval;
break;
default:
errlogSevPrintf (errlogFatal,
errlogSevPrintf(errlogFatal,
"readData %s: can't convert from double to %s\n",
record->name, pamapdbfType[aai->ftvl].strvalue);
return ERROR;
}
break;
}
case DBF_ULONG:
case DBF_LONG:
case DBF_ENUM:
{
if (streamScanf (record, format, &lval) != OK)
if (streamScanf(record, format, &lval) == ERROR)
{
return aai->nord ? OK : ERROR;
}
@ -72,6 +69,12 @@ static long readData (dbCommon *record, format_t *format)
case DBF_FLOAT:
((epicsFloat32 *)aai->bptr)[aai->nord] = (epicsFloat32)lval;
break;
#ifdef DBF_INT64
case DBF_INT64:
case DBF_UINT64:
((epicsInt64 *)aai->bptr)[aai->nord] = (epicsInt64)lval;
break;
#endif
case DBF_LONG:
case DBF_ULONG:
((epicsInt32 *)aai->bptr)[aai->nord] = (epicsInt32)lval;
@ -86,7 +89,7 @@ static long readData (dbCommon *record, format_t *format)
((epicsInt8 *)aai->bptr)[aai->nord] = (epicsInt8)lval;
break;
default:
errlogSevPrintf (errlogFatal,
errlogSevPrintf(errlogFatal,
"readData %s: can't convert from long to %s\n",
record->name, pamapdbfType[aai->ftvl].strvalue);
return ERROR;
@ -98,30 +101,38 @@ static long readData (dbCommon *record, format_t *format)
switch (aai->ftvl)
{
case DBF_STRING:
if (streamScanfN (record, format,
if (streamScanfN(record, format,
(char *)aai->bptr + aai->nord * MAX_STRING_SIZE,
MAX_STRING_SIZE) != OK)
MAX_STRING_SIZE) == ERROR)
{
return aai->nord ? OK : ERROR;
}
break;
case DBF_CHAR:
case DBF_UCHAR:
memset (aai->bptr, 0, aai->nelm);
{
ssize_t length;
aai->nord = 0;
if (streamScanfN (record, format,
(char *)aai->bptr, aai->nelm) != OK)
if ((length = streamScanfN(record, format,
(char *)aai->bptr, aai->nelm)) == ERROR)
{
memset(aai->bptr, 0, aai->nelm);
return ERROR;
}
((char*)aai->bptr)[aai->nelm] = 0;
for (lval = aai->nelm;
lval >= 0 && ((char*)aai->bptr)[lval] == 0;
lval--);
aai->nord = lval+1;
if (lval < (ssize_t)aai->nelm)
{
memset(((char*)aai->bptr)+lval , 0, aai->nelm-lval);
lval++;
}
else
{
((char*)aai->bptr)[aai->nelm-1] = 0;
}
aai->nord = (long)length;
return OK;
}
default:
errlogSevPrintf (errlogFatal,
errlogSevPrintf(errlogFatal,
"readData %s: can't convert from string to %s\n",
record->name, pamapdbfType[aai->ftvl].strvalue);
return ERROR;
@ -130,7 +141,7 @@ static long readData (dbCommon *record, format_t *format)
}
default:
{
errlogSevPrintf (errlogMajor,
errlogSevPrintf(errlogMajor,
"readData %s: can't convert from %s to %s\n",
record->name, pamapdbfType[format->type].strvalue,
pamapdbfType[aai->ftvl].strvalue);
@ -141,9 +152,9 @@ static long readData (dbCommon *record, format_t *format)
return OK;
}
static long writeData (dbCommon *record, format_t *format)
static long writeData(dbCommon *record, format_t *format)
{
aaiRecord *aai = (aaiRecord *) record;
aaiRecord *aai = (aaiRecord *)record;
double dval;
long lval;
unsigned long nowd;
@ -162,6 +173,14 @@ static long writeData (dbCommon *record, format_t *format)
case DBF_FLOAT:
dval = ((epicsFloat32 *)aai->bptr)[nowd];
break;
#ifdef DBF_INT64
case DBF_INT64:
dval = ((epicsInt64 *)aai->bptr)[nowd];
break;
case DBF_UINT64:
dval = ((epicsUInt64 *)aai->bptr)[nowd];
break;
#endif
case DBF_LONG:
dval = ((epicsInt32 *)aai->bptr)[nowd];
break;
@ -169,10 +188,10 @@ static long writeData (dbCommon *record, format_t *format)
dval = ((epicsUInt32 *)aai->bptr)[nowd];
break;
case DBF_SHORT:
case DBF_ENUM:
dval = ((epicsInt16 *)aai->bptr)[nowd];
break;
case DBF_USHORT:
case DBF_ENUM:
dval = ((epicsUInt16 *)aai->bptr)[nowd];
break;
case DBF_CHAR:
@ -182,20 +201,29 @@ static long writeData (dbCommon *record, format_t *format)
dval = ((epicsUInt8 *)aai->bptr)[nowd];
break;
default:
errlogSevPrintf (errlogFatal,
errlogSevPrintf(errlogFatal,
"writeData %s: can't convert from %s to double\n",
record->name, pamapdbfType[aai->ftvl].strvalue);
return ERROR;
}
if (streamPrintf (record, format, dval))
if (streamPrintf(record, format, dval))
return ERROR;
break;
}
case DBF_ULONG:
case DBF_LONG:
case DBF_ENUM:
{
switch (aai->ftvl)
{
#ifdef DBF_INT64
case DBF_INT64:
lval = ((epicsInt64 *)aao->bptr)[nowd];
break;
case DBF_UINT64:
lval = ((epicsUInt64 *)aao->bptr)[nowd];
break;
#endif
case DBF_LONG:
lval = ((epicsInt32 *)aai->bptr)[nowd];
break;
@ -203,10 +231,10 @@ static long writeData (dbCommon *record, format_t *format)
lval = ((epicsUInt32 *)aai->bptr)[nowd];
break;
case DBF_SHORT:
case DBF_ENUM:
lval = ((epicsInt16 *)aai->bptr)[nowd];
break;
case DBF_USHORT:
case DBF_ENUM:
lval = ((epicsUInt16 *)aai->bptr)[nowd];
break;
case DBF_CHAR:
@ -216,12 +244,12 @@ static long writeData (dbCommon *record, format_t *format)
lval = ((epicsUInt8 *)aai->bptr)[nowd];
break;
default:
errlogSevPrintf (errlogFatal,
errlogSevPrintf(errlogFatal,
"writeData %s: can't convert from %s to long\n",
record->name, pamapdbfType[aai->ftvl].strvalue);
return ERROR;
}
if (streamPrintf (record, format, lval))
if (streamPrintf(record, format, lval))
return ERROR;
break;
}
@ -230,7 +258,7 @@ static long writeData (dbCommon *record, format_t *format)
switch (aai->ftvl)
{
case DBF_STRING:
if (streamPrintf (record, format,
if (streamPrintf(record, format,
((char *)aai->bptr) + nowd * MAX_STRING_SIZE))
return ERROR;
break;
@ -245,12 +273,12 @@ static long writeData (dbCommon *record, format_t *format)
{
((char *)aai->bptr)[aai->nelm-1] = 0;
}
if (streamPrintf (record, format,
if (streamPrintf(record, format,
((char *)aai->bptr)))
return ERROR;
return OK;
default:
errlogSevPrintf (errlogFatal,
errlogSevPrintf(errlogFatal,
"writeData %s: can't convert from %s to string\n",
record->name, pamapdbfType[aai->ftvl].strvalue);
return ERROR;
@ -259,7 +287,7 @@ static long writeData (dbCommon *record, format_t *format)
}
default:
{
errlogSevPrintf (errlogFatal,
errlogSevPrintf(errlogFatal,
"writeData %s: can't convert from %s to %s\n",
record->name, pamapdbfType[aai->ftvl].strvalue,
pamapdbfType[format->type].strvalue);
@ -270,20 +298,19 @@ static long writeData (dbCommon *record, format_t *format)
return OK;
}
static long initRecord (dbCommon *record)
static long initRecord(dbCommon *record)
{
static const int typesize[] = {MAX_STRING_SIZE,1,1,2,2,4,4,4,8,2};
aaiRecord *aai = (aaiRecord *) record;
aaiRecord *aai = (aaiRecord *)record;
aai->bptr = calloc(aai->nelm, typesize[aai->ftvl]);
aai->bptr = calloc(aai->nelm, dbValueSize(aai->ftvl));
if (aai->bptr == NULL)
{
errlogSevPrintf (errlogFatal,
errlogSevPrintf(errlogFatal,
"initRecord %s: can't allocate memory for data array\n",
record->name);
return ERROR;
}
return streamInitRecord (record, &aai->inp, readData, writeData) == ERROR ?
return streamInitRecord(record, &aai->inp, readData, writeData) == ERROR ?
ERROR : OK;
}

View File

@ -5,7 +5,7 @@
* (C) 2006 Dirk Zimoch (dirk.zimoch@psi.ch) *
* *
* This is an EPICS record Interface 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 *
@ -18,18 +18,17 @@
* *
***************************************************************/
#include <string.h>
#include <stdlib.h>
#include <stdio.h>
#include "epicsString.h"
#include "aaoRecord.h"
#include "devStream.h"
#include <aaoRecord.h>
#include <errlog.h>
#include <epicsExport.h>
static long readData (dbCommon *record, format_t *format)
static long readData(dbCommon *record, format_t *format)
{
aaoRecord *aao = (aaoRecord *) record;
aaoRecord *aao = (aaoRecord *)record;
double dval;
long lval;
unsigned short monitor_mask;
for (aao->nord = 0; aao->nord < aao->nelm; aao->nord++)
{
@ -37,10 +36,8 @@ static long readData (dbCommon *record, format_t *format)
{
case DBF_DOUBLE:
{
if (streamScanf (record, format, &dval) != OK)
{
return aao->nord ? OK : ERROR;
}
if (streamScanf(record, format, &dval) == ERROR)
goto end;
switch (aao->ftvl)
{
case DBF_DOUBLE:
@ -50,20 +47,19 @@ static long readData (dbCommon *record, format_t *format)
((epicsFloat32 *)aao->bptr)[aao->nord] = (epicsFloat32)dval;
break;
default:
errlogSevPrintf (errlogFatal,
errlogSevPrintf(errlogFatal,
"readData %s: can't convert from double to %s\n",
record->name, pamapdbfType[aao->ftvl].strvalue);
return ERROR;
}
break;
}
case DBF_ULONG:
case DBF_LONG:
case DBF_ENUM:
{
if (streamScanf (record, format, &lval) != OK)
{
return aao->nord ? OK : ERROR;
}
if (streamScanf(record, format, &lval) == ERROR)
goto end;
switch (aao->ftvl)
{
case DBF_DOUBLE:
@ -72,6 +68,12 @@ static long readData (dbCommon *record, format_t *format)
case DBF_FLOAT:
((epicsFloat32 *)aao->bptr)[aao->nord] = (epicsFloat32)lval;
break;
#ifdef DBF_INT64
case DBF_INT64:
case DBF_UINT64:
((epicsInt64 *)aao->bptr)[aao->nord] = (epicsInt64)lval;
break;
#endif
case DBF_LONG:
case DBF_ULONG:
((epicsInt32 *)aao->bptr)[aao->nord] = (epicsInt32)lval;
@ -86,7 +88,7 @@ static long readData (dbCommon *record, format_t *format)
((epicsInt8 *)aao->bptr)[aao->nord] = (epicsInt8)lval;
break;
default:
errlogSevPrintf (errlogFatal,
errlogSevPrintf(errlogFatal,
"readData %s: can't convert from long to %s\n",
record->name, pamapdbfType[aao->ftvl].strvalue);
return ERROR;
@ -98,30 +100,36 @@ static long readData (dbCommon *record, format_t *format)
switch (aao->ftvl)
{
case DBF_STRING:
if (streamScanfN (record, format,
if (streamScanfN(record, format,
(char *)aao->bptr + aao->nord * MAX_STRING_SIZE,
MAX_STRING_SIZE) != OK)
{
return aao->nord ? OK : ERROR;
}
MAX_STRING_SIZE) == ERROR)
goto end;
break;
case DBF_CHAR:
case DBF_UCHAR:
memset (aao->bptr, 0, aao->nelm);
{
ssize_t length;
aao->nord = 0;
if (streamScanfN (record, format,
(char *)aao->bptr, aao->nelm) != OK)
if ((length = streamScanfN(record, format,
(char *)aao->bptr, aao->nelm)) == ERROR)
{
memset(aao->bptr, 0, aao->nelm);
return ERROR;
}
((char*)aao->bptr)[aao->nelm] = 0;
for (lval = aao->nelm;
lval >= 0 && ((char*)aao->bptr)[lval] == 0;
lval--);
aao->nord = lval+1;
return OK;
if (length < (ssize_t)aao->nelm)
{
memset(((char*)aao->bptr)+lval , 0, aao->nelm-lval);
lval++;
}
else
{
((char*)aao->bptr)[aao->nelm-1] = 0;
}
aao->nord = (long)length;
goto end_no_check;
}
default:
errlogSevPrintf (errlogFatal,
errlogSevPrintf(errlogFatal,
"readData %s: can't convert from string to %s\n",
record->name, pamapdbfType[aao->ftvl].strvalue);
return ERROR;
@ -130,7 +138,7 @@ static long readData (dbCommon *record, format_t *format)
}
default:
{
errlogSevPrintf (errlogMajor,
errlogSevPrintf(errlogMajor,
"readData %s: can't convert from %s to %s\n",
record->name, pamapdbfType[format->type].strvalue,
pamapdbfType[aao->ftvl].strvalue);
@ -138,12 +146,44 @@ static long readData (dbCommon *record, format_t *format)
}
}
}
end:
if (aao->nord == 0) return ERROR;
end_no_check:
if (record->pact) return OK;
/* In @init handler, no processing, enforce monitor updates. */
monitor_mask = recGblResetAlarms(aao);
#if defined(VERSION_INT) || EPICS_MODIFICATION >= 12
if (aao->mpst == aaoPOST_Always)
monitor_mask |= DBE_VALUE;
if (aao->apst == aaoPOST_Always)
monitor_mask |= DBE_LOG;
if ((aao->mpst == aaoPOST_OnChange) ||
(aao->apst == aaoPOST_OnChange))
{
unsigned int hash = epicsMemHash(aao->bptr,
aao->nord * dbValueSize(aao->ftvl), 0);
if (hash != aao->hash)
{
if (aao->mpst == aaoPOST_OnChange)
monitor_mask |= DBE_VALUE;
if (aao->apst == aaoPOST_OnChange)
monitor_mask |= DBE_LOG;
aao->hash = hash;
db_post_events(aao, &aao->hash, DBE_VALUE);
}
}
#else
monitor_mask |= DBE_VALUE | DBE_LOG;
#endif
if (monitor_mask)
db_post_events(aao, aao->bptr, monitor_mask);
return OK;
}
static long writeData (dbCommon *record, format_t *format)
static long writeData(dbCommon *record, format_t *format)
{
aaoRecord *aao = (aaoRecord *) record;
aaoRecord *aao = (aaoRecord *)record;
double dval;
long lval;
unsigned long nowd;
@ -162,6 +202,14 @@ static long writeData (dbCommon *record, format_t *format)
case DBF_FLOAT:
dval = ((epicsFloat32 *)aao->bptr)[nowd];
break;
#ifdef DBF_INT64
case DBF_INT64:
dval = ((epicsInt64 *)aao->bptr)[nowd];
break;
case DBF_UINT64:
dval = ((epicsUInt64 *)aao->bptr)[nowd];
break;
#endif
case DBF_LONG:
dval = ((epicsInt32 *)aao->bptr)[nowd];
break;
@ -169,10 +217,10 @@ static long writeData (dbCommon *record, format_t *format)
dval = ((epicsUInt32 *)aao->bptr)[nowd];
break;
case DBF_SHORT:
case DBF_ENUM:
dval = ((epicsInt16 *)aao->bptr)[nowd];
break;
case DBF_USHORT:
case DBF_ENUM:
dval = ((epicsUInt16 *)aao->bptr)[nowd];
break;
case DBF_CHAR:
@ -182,20 +230,29 @@ static long writeData (dbCommon *record, format_t *format)
dval = ((epicsUInt8 *)aao->bptr)[nowd];
break;
default:
errlogSevPrintf (errlogFatal,
errlogSevPrintf(errlogFatal,
"writeData %s: can't convert from %s to double\n",
record->name, pamapdbfType[aao->ftvl].strvalue);
return ERROR;
}
if (streamPrintf (record, format, dval))
if (streamPrintf(record, format, dval))
return ERROR;
break;
}
case DBF_ULONG:
case DBF_LONG:
case DBF_ENUM:
{
switch (aao->ftvl)
{
#ifdef DBF_INT64
case DBF_INT64:
lval = ((epicsInt64 *)aao->bptr)[nowd];
break;
case DBF_UINT64:
lval = ((epicsUInt64 *)aao->bptr)[nowd];
break;
#endif
case DBF_LONG:
lval = ((epicsInt32 *)aao->bptr)[nowd];
break;
@ -203,10 +260,10 @@ static long writeData (dbCommon *record, format_t *format)
lval = ((epicsUInt32 *)aao->bptr)[nowd];
break;
case DBF_SHORT:
case DBF_ENUM:
lval = ((epicsInt16 *)aao->bptr)[nowd];
break;
case DBF_USHORT:
case DBF_ENUM:
lval = ((epicsUInt16 *)aao->bptr)[nowd];
break;
case DBF_CHAR:
@ -216,12 +273,12 @@ static long writeData (dbCommon *record, format_t *format)
lval = ((epicsUInt8 *)aao->bptr)[nowd];
break;
default:
errlogSevPrintf (errlogFatal,
errlogSevPrintf(errlogFatal,
"writeData %s: can't convert from %s to long\n",
record->name, pamapdbfType[aao->ftvl].strvalue);
return ERROR;
}
if (streamPrintf (record, format, lval))
if (streamPrintf(record, format, lval))
return ERROR;
break;
}
@ -230,7 +287,7 @@ static long writeData (dbCommon *record, format_t *format)
switch (aao->ftvl)
{
case DBF_STRING:
if (streamPrintf (record, format,
if (streamPrintf(record, format,
((char *)aao->bptr) + nowd * MAX_STRING_SIZE))
return ERROR;
break;
@ -245,12 +302,12 @@ static long writeData (dbCommon *record, format_t *format)
{
((char *)aao->bptr)[aao->nelm-1] = 0;
}
if (streamPrintf (record, format,
if (streamPrintf(record, format,
((char *)aao->bptr)))
return ERROR;
return OK;
default:
errlogSevPrintf (errlogFatal,
errlogSevPrintf(errlogFatal,
"writeData %s: can't convert from %s to string\n",
record->name, pamapdbfType[aao->ftvl].strvalue);
return ERROR;
@ -259,7 +316,7 @@ static long writeData (dbCommon *record, format_t *format)
}
default:
{
errlogSevPrintf (errlogFatal,
errlogSevPrintf(errlogFatal,
"writeData %s: can't convert from %s to %s\n",
record->name, pamapdbfType[aao->ftvl].strvalue,
pamapdbfType[format->type].strvalue);
@ -270,20 +327,19 @@ static long writeData (dbCommon *record, format_t *format)
return OK;
}
static long initRecord (dbCommon *record)
static long initRecord(dbCommon *record)
{
static const int typesize[] = {MAX_STRING_SIZE,1,1,2,2,4,4,4,8,2};
aaoRecord *aao = (aaoRecord *) record;
aaoRecord *aao = (aaoRecord *)record;
aao->bptr = calloc(aao->nelm, typesize[aao->ftvl]);
aao->bptr = calloc(aao->nelm, dbValueSize(aao->ftvl));
if (aao->bptr == NULL)
{
errlogSevPrintf (errlogFatal,
errlogSevPrintf(errlogFatal,
"initRecord %s: can't allocate memory for data array\n",
record->name);
return ERROR;
}
return streamInitRecord (record, &aao->out, readData, writeData) == ERROR ?
return streamInitRecord(record, &aao->out, readData, writeData) == ERROR ?
ERROR : OK;
}

Some files were not shown because too many files have changed in this diff Show More