Update release notes and release date.

testTypeCast: mangle values to be printable
print (u)int8 as integer instead of character (cherry picked from commit da8ba56dd1)
2016-09-14 17:01:51 -05:00 · 2016-09-14 16:43:53 -05:00 · 2016-09-14 16:33:37 -05:00 · 2016-09-14 11:25:30 +01:00 · 2016-09-13 22:44:11 +01:00 · 2016-09-13 22:33:28 +01:00
7 changed files with 284 additions and 31 deletions
--- a/documentation/RELEASE_NOTES.html
+++ b/documentation/RELEASE_NOTES.html
@@ -1,6 +1,129 @@
-<h1>Release 5.0</h1>
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+      "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+  <meta http-equiv="Content-Type" content="text/html;" />
+  <meta name="keywords" content="EPICS, EPICSv4" />
+  <title>EPICS V4 pvData C++ Release Notes</title>
+  <link rel="stylesheet" type="text/css" href="../../base.css" />
+  <link rel="stylesheet" type="text/css" href="../../epicsv4.css" />

-<p>The main changes since release 4.0 are:</p>
+</head>
+
+<body>
+
+<h1>Release 6.0.1</h1>
+
+<p>The changes since release 6.0.0 are:</p>
+
+<ul>
+<li>Fix "Problem building pvDataCPP for win32-x86-mingw" (issue #42)</li>
+<li>In src/misc/bitSet.cpp #include <algorithm> required for MSVS 2015</li>
+<li>In testApp/misc/testTypeCast.cpp print (u)int8 values as integers</li>
+<li>Minor documentation updates</li>
+</ul>
+
+<h1>Release 6.0.0</h1>
+
+<p>The main changes since release 5.0.4 are:</p>
+
+<ul>
+<li>Linux shared library version added</li>
+<li>Headers have been moved into pv directories</li>
+<li>Bitset functions declared const where possible</li>
+<li>Bitset::swap added</li>
+<li>Requester::message has default implementation</li>
+<li>Serialization/deserialization helpers added</li>
+<li>Non-template getSubField char* overload added</li>
+<li>MonitorPlugin deprecated</li>
+<li>Field name validation performed</li>
+<li>Now builds for Cygwin and MinGW targets</li>
+<li>Fix for debug build issue.</li>
+<li>New license file replaces LICENSE and COPYRIGHT</li>
+</ul>
+
+<h2>Shared library version added</h2>
+
+<p>Linux shared library version numbers have been added by setting SHRLIB_VERSION
+(to 6.0 in this case). So shared object will be libpvData.so.6.0 instead of
+libpvData.so.</p>
+
+<h2>Headers have been moved into pv directories</h2>
+
+<p>E.g. src/property/alarm.h -> src/property/pv/alarm.h</p>
+
+<p>This facilitates using some IDEs such as Qt Creator.</p>
+
+<h2>Requester::message has default implementation</h2>
+
+<p>Requester::message is no longer pure virtual. Default implementation sends
+string to std::cerr.</p>
+
+<h2>Serialization/deserialization helpers added</h2>
+
+<p>A helper function, serializeToVector, has been added which serializes a 
+Serializable object into a standard vector of UInt8s.</p>
+
+<p>Similarly a function deserializeFromVector deserializes a standard vector into
+a Deserializable object.</p>
+
+<p>A function deserializeFromBuffer deserializes a ByteBuffer into a 
+Deserializable object.</p>
+
+<h2>Field name validation performed</h2>
+
+<p>On creating a Structure or Union the field names are now validated.</p>
+
+<p>Valid characters for a field name are upper or lowercase letters, numbers and
+underscores and intial numbers are invalid, i.e. names must be of the form
+[A-Za-z<em>][A-Za-z0-9</em>]*.</p>
+
+<h2>Now builds for Cygwin and MinGW targets</h2>
+
+<p>Includes cross-compiling MinGW on Linux.</p>
+
+<h1>Release 5.0.4</h1>
+
+<p>The changes since release 5.0.3 are:</p>
+
+<ul>
+<li>Fixed bitset serialization (issue #24)</li>
+<li>Fixed truncation in BitSet::or_and (issue #27)</li>
+</ul>
+
+<h2>Fixed bitset serialization (issue #24)</h2>
+
+<p>C++ bitset serialization was not consistent with the C++ deserialization and
+Java code in some instances (depending on the endianness of the serializer and
+deserializer) when the number of bits was 56-63 modulo 64. C++ serialization
+has been fixed.</p>
+
+<p>Fix exposed issue in deserialization on 32-bit platforms which
+has also been corrected. </p>
+
+<h2>Fixed truncation in BitSet::or_and (issue #27)</h2>
+
+<p>If n, n1 and n2 words are used to store the values of the bitsets bitset,
+bitset1 and bitset2 respectively then max(n, min(n1,n2)) words are needed
+to store bitset.or_(bitset1, bitset2).</p>
+
+<p>Previously min(n1,n2) words were used and the result would be truncated in
+some instances. This has been fixed.</p>
+
+<h1>Release 5.0.3</h1>
+
+<p>The only change since release 5.0.2 is:</p>
+
+<h2>Fixed buffer overflow in PVUnion::serialize() (issue #20)</h2>
+
+<p>A PVUnion whose stored value was null was serialized without checking 
+whether the buffer had sufficient capacity. This has been fixed by calling
+ensureBuffer().</p>
+
+<h1>Release 5.0.2</h1>
+
+<p>The main changes since release 4.0.3 are:</p>

 <ul>
 <li>Deprecated getXXXField() methods have been removed from PVStructure</li>
@@ -114,8 +237,8 @@ it was necessary to have code like:</p>

 <p>A new template getField method has been added to Structure</p>

-<p>template<typename FT >
-std::tr1::shared_ptr&lt; const FT > getField(std::string const &amp;fieldName) const </p>
+<p>template&lt;typename FT-&gt;
+std::tr1::shared_ptr&lt; const FT-&gt; getField(std::string const &amp;fieldName) const </p>

 <p>Can be used, for example, as follows:</p>

@@ -133,7 +256,7 @@ pvData had issues due to PVStructure::DEFAULT_ID being used before being initial
 This has been changed so the it returns a null pvStructure
 and provides an error.</p>

-<h1>Release 4.0</h1>
+<h1>Release 4.0.3</h1>

 <p>The main changes since release 3.0.2 are:</p>

@@ -216,3 +339,7 @@ This is prototype and is subject to debate.</p>
 <h1>Release 3.0.2</h1>

 <p>This was the starting point for RELEASE_NOTES</p>
+
+
+</body>
+</html>
--- a/documentation/RELEASE_NOTES.md
+++ b/documentation/RELEASE_NOTES.md
@@ -1,7 +1,125 @@
-Release 5.0
-===========
+Release 6.0.1
+=============

-The main changes since release 4.0 are:
+The changes since release 6.0.0 are:
+
+* Fix "Problem building pvDataCPP for win32-x86-mingw" (issue #42)
+* In src/misc/bitSet.cpp #include <algorithm> required for MSVS 2015
+* In testApp/misc/testTypeCast.cpp print (u)int8 values as integers
+* Minor documentation updates
+
+Release 6.0.0
+=============
+
+The main changes since release 5.0.4 are:
+
+* Linux shared library version added
+* Headers have been moved into pv directories
+* Bitset functions declared const where possible
+* Bitset::swap added
+* Requester::message has default implementation
+* Serialization/deserialization helpers added
+* Non-template getSubField char* overload added
+* MonitorPlugin deprecated
+* Field name validation performed
+* Now builds for Cygwin and MinGW targets
+* Fix for debug build issue.
+* New license file replaces LICENSE and COPYRIGHT
+
+Shared library version added
+----------------------------
+
+Linux shared library version numbers have been added by setting SHRLIB_VERSION
+(to 6.0 in this case). So shared object will be libpvData.so.6.0 instead of
+libpvData.so.
+
+Headers have been moved into pv directories
+-------------------------------------------
+
+E.g. src/property/alarm.h -> src/property/pv/alarm.h
+
+This facilitates using some IDEs such as Qt Creator.
+
+Requester::message has default implementation
+---------------------------------------------
+
+Requester::message is no longer pure virtual. Default implementation sends
+string to std::cerr.
+
+Serialization/deserialization helpers added
+-------------------------------------------
+
+A helper function, serializeToVector, has been added which serializes a 
+Serializable object into a standard vector of UInt8s.
+
+Similarly a function deserializeFromVector deserializes a standard vector into
+a Deserializable object.
+
+A function deserializeFromBuffer deserializes a ByteBuffer into a 
+Deserializable object.
+
+Field name validation performed
+-------------------------------
+
+On creating a Structure or Union the field names are now validated.
+
+Valid characters for a field name are upper or lowercase letters, numbers and
+underscores and intial numbers are invalid, i.e. names must be of the form
+[A-Za-z_][A-Za-z0-9_]*.
+
+Now builds for Cygwin and MinGW targets
+---------------------------------------
+
+Includes cross-compiling MinGW on Linux.
+
+
+Release 5.0.4
+=============
+
+The changes since release 5.0.3 are:
+
+* Fixed bitset serialization (issue #24)
+* Fixed truncation in BitSet::or_and (issue #27)
+
+Fixed bitset serialization (issue #24)
+--------------------------------------
+
+C++ bitset serialization was not consistent with the C++ deserialization and
+Java code in some instances (depending on the endianness of the serializer and
+deserializer) when the number of bits was 56-63 modulo 64. C++ serialization
+has been fixed.
+
+Fix exposed issue in deserialization on 32-bit platforms which
+has also been corrected. 
+
+Fixed truncation in BitSet::or_and (issue #27)
+----------------------------------------------
+
+If n, n1 and n2 words are used to store the values of the bitsets bitset,
+bitset1 and bitset2 respectively then max(n, min(n1,n2)) words are needed
+to store bitset.or_(bitset1, bitset2).
+
+Previously min(n1,n2) words were used and the result would be truncated in
+some instances. This has been fixed.
+
+
+Release 5.0.3
+=============
+
+The only change since release 5.0.2 is:
+
+Fixed buffer overflow in PVUnion::serialize() (issue #20)
+---------------------------------------------------------
+
+A PVUnion whose stored value was null was serialized without checking 
+whether the buffer had sufficient capacity. This has been fixed by calling
+ensureBuffer().
+
+
+Release 5.0.2
+=============
+
+The main changes since release 4.0.3 are:

 * Deprecated getXXXField() methods have been removed from PVStructure
 * Convert copy methods and equals operators (re)moved
@@ -15,7 +133,7 @@ The main changes since release 4.0 are:


 Deprecated getXXXField methods have been removed from PVStructure
-------------------------------------------------------------------
+-----------------------------------------------------------------

 The following methods have been removed from PVStructure

@@ -141,8 +259,8 @@ This has been changed so the it returns a null pvStructure
 and provides an error.


-Release 4.0
-===========
+Release 4.0.3
+=============

 The main changes since release 3.0.2 are:

--- a/documentation/pvDataCPP.html
+++ b/documentation/pvDataCPP.html
@@ -36,7 +36,7 @@
 <div class="head">
 <h1>EPICS pvDataCPP</h1>

-<h2 class="nocount">Release 5.1-DEV - 2016.03.18</h2>
+<h2 class="nocount">Release 6.0.1 - 2016-09-14</h2>

  <dl>
    <dt>Editors:</dt>
@@ -45,10 +45,6 @@
    <dd>Matej Sekoranja, CosyLab</dd>
    <dd>David Hickin, Diamond Light Source</dd>
  </dl>
-
-  <p class="copyright">This product is made available subject to acceptance of the <a
-href="http://epics-pvdata.sourceforge.net/LICENSE.html">EPICS open source
-license.</a></p>
 <hr />
 </div>

@@ -66,7 +62,7 @@ V4 control system programming environment:<br />

 <h2 class="nocount">Status of this Document</h2>

-<p>This is the 18-March-2016 version for the 5.1-development release of the
+<p>This is the 14-September-2016 version for the 6.0.1 release of the
 C++ implementation of pvData.
 </p>

@@ -4875,7 +4871,7 @@ Monitor provides:
    monitor. It, together with the queue facility, provides support for
    monitor queues.
    </dd>
-  <dt>monitorPlugin</dt>
+  <dt>monitorPlugin [Deprecated]</dt>
    <dd>This is support for implementing monitor plugins.
     A monitor plugin can be developed that has no knowledge
     of pvAccess but only pvData.
@@ -5057,7 +5053,7 @@ where
 <dl>
   <dt>monitor</dt>
     <dd>Used by code that implements pvAccess monitors.</dd>
-   <dt>monitorPlugin</dt>
+   <dt>monitorPlugin [Deprecated]</dt>
      <dd>Code that provides special semantics for monitors.</dd>
 </dl>
 <h3>monitor</h3>
@@ -5173,6 +5169,8 @@ It has the methods:</p>
 </dl>

 <h3>monitorPlugin</h3>
+<p>[ MonitorPlugin and related classes MonitorPluginCreator and 
+MonitorPluginManager are deprecated.]</p>
 <pre>
 class MonitorPlugin
 {
--- a/jenkins/cloudbees_build
+++ b/jenkins/cloudbees_build
@@ -75,4 +75,4 @@ make runtests
 ###########################################
 # Create distribution

-tar czf pvData.CB-dist.tar.gz lib include COPYRIGHT LICENSE
+tar czf pvData.CB-dist.tar.gz lib include LICENSE
--- a/src/misc/bitSet.cpp
+++ b/src/misc/bitSet.cpp
@@ -10,6 +10,7 @@
 #include <stdio.h>
 #include <iostream>
 #include <stdexcept>
+#include <algorithm>

 #include <epicsMutex.h>

--- a/src/misc/pv/templateMeta.h
+++ b/src/misc/pv/templateMeta.h
@@ -10,7 +10,9 @@
 // gently nudge the compiler to inline our wrappers
 // Warning: Only use this when the template body is *small*.
 //          You have been warned!
-#if defined(__GNUC__) && __GNUC__>=3
+#if defined(__MINGW32__) 
+# define FORCE_INLINE inline
+#elif defined(__GNUC__) && __GNUC__>=3
 # define FORCE_INLINE __attribute__((always_inline)) inline
 #elif defined(_MSC_VER)
 # define FORCE_INLINE __forceinline
--- a/testApp/misc/testTypeCast.cpp
+++ b/testApp/misc/testTypeCast.cpp
@@ -29,6 +29,13 @@
 using std::string;

 namespace {
+    // Mangle value to be printable as per print_convolute<>
+    template<typename T>
+    inline
+    typename epics::pvData::detail::print_convolute<T>::return_t
+    print(T v) {
+        return epics::pvData::detail::print_convolute<T>::op(v);
+    }

    template<typename T>
    struct testequal {
@@ -54,24 +61,24 @@ namespace {
                //actual = ::epics::pvData::detail::cast_helper<TO,FROM>::op(inp);
            } catch(std::runtime_error& e) {
                msg<<"Failed to cast "
-                   <<inp<<" ("<<typeid(FROM).name()<<") -> "
-                   <<expect<<" ("<<typeid(TO).name()<<")\n Error: "
+                   <<print(inp)<<" ("<<typeid(FROM).name()<<") -> "
+                   <<print(expect)<<" ("<<typeid(TO).name()<<")\n Error: "
                   <<typeid(e).name()<<"("<<e.what()<<")";
                testFail("%s", msg.str().c_str());
                return;
            }
            if(!testequal<TO>::op(actual, expect)) {
                msg<<"Failed cast gives unexpected value "
-                   <<inp<<" ("<<typeid(FROM).name()<<") -> "
-                   <<expect<<" ("<<typeid(TO).name()<<") yields: "
-                   <<actual;
+                   <<print(inp)<<" ("<<typeid(FROM).name()<<") -> "
+                   <<print(expect)<<" ("<<typeid(TO).name()<<") yields: "
+                   <<print(actual);
                testFail("%s", msg.str().c_str());
                return;
            }
            msg<<"cast "
-               <<inp<<" ("<<typeid(FROM).name()<<") -> "
-               <<expect<<" ("<<typeid(TO).name()<<") yields: "
-               <<actual;
+               <<print(inp)<<" ("<<typeid(FROM).name()<<") -> "
+               <<print(expect)<<" ("<<typeid(TO).name()<<") yields: "
+               <<print(actual);
            testPass("%s", msg.str().c_str());
            return;
        }
@@ -86,14 +93,14 @@ namespace {
            try {
                actual = ::epics::pvData::castUnsafe<TO,FROM>(inp);
                msg<<"Failed to generate expected error "
-                   <<inp<<" ("<<typeid(FROM).name()<<") -> ("
+                   <<print(inp)<<" ("<<typeid(FROM).name()<<") -> ("
                   <<typeid(TO).name()<<") yields: "
                   <<actual;
                testFail("%s", msg.str().c_str());
                return;
            } catch(std::runtime_error& e) {
                msg<<"Got expected error "
-                   <<inp<<" ("<<typeid(FROM).name()<<") -> ("
+                   <<print(inp)<<" ("<<typeid(FROM).name()<<") -> ("
                   <<typeid(TO).name()<<") fails with: "
                   <<e.what();
                testPass("%s", msg.str().c_str());
Author	SHA1	Message	Date
Andrew Johnson	e0367a2dd7	Update release notes and release date.	2016-09-14 17:01:51 -05:00
Andrew Johnson	1e0f1119e2	testTypeCast: mangle values to be printable print (u)int8 as integer instead of character (cherry picked from commit `da8ba56dd1`)	2016-09-14 16:43:53 -05:00
Andrew Johnson	6d6314a924	#include <algorithm> required for MSVS 2015 (cherry picked from commit `4555f69733`)	2016-09-14 16:33:37 -05:00
Dave Hickin	e0b881d036	Correction to documentation for 6.0.1	2016-09-14 11:25:30 +01:00
Dave Hickin	d24ff6c3d2	Update documentation for 6.0.1	2016-09-13 22:44:11 +01:00
Dave Hickin	ef17aac046	Update release notes for 6.0.1	2016-09-13 22:33:28 +01:00
Dave Hickin	83b63a9138	Fix for MinGW Fixes #42	2016-09-07 15:14:17 +01:00
Dave Hickin	0a5ab8625d	Update documentation for 6.0.0	2016-08-01 17:25:12 +01:00
Dave Hickin	a115c9cd15	Add release notes for 6.0.0	2016-08-01 17:23:11 +01:00
Dave Hickin	6ba40803d8	Add 5.0.x release notes	2016-08-01 15:00:36 +01:00
Dave Hickin	8d6094c55a	jenkins: Remove COPYRIGHT from tar	2016-07-22 16:08:27 +01:00