Update documentation for 5.2.0 release

create travis files

.ci/travis-build.sh

@@ -0,0 +1,21 @@
+#!/bin/sh
+set -e -x
+
+# set RTEMS to eg. "4.9" or "4.10"
+# requires qemu, bison, flex, texinfo, install-info
+if [ -n "$RTEMS" ]
+then
+  # find local qemu-system-i386
+  export PATH="$HOME/.cache/qemu/usr/bin:$PATH"
+  echo -n "Using QEMU: "
+  type qemu-system-i386 || echo "Missing qemu"
+  EXTRA=RTEMS_QEMU_FIXUPS=YES
+fi
+
+make -j2 $EXTRA
+
+if [ "$TEST" != "NO" ]
+then
+  make tapfiles
+  make -s test-results
+fi

.ci/travis-prepare.sh

@@ -0,0 +1,172 @@
+#!/bin/sh
+set -e -x
+
+CURDIR="$PWD"
+
+QDIR="$HOME/.cache/qemu"
+
+if [ -n "$RTEMS" -a "$TEST" = "YES" ]
+then
+  git clone --quiet --branch vme --depth 10 https://github.com/mdavidsaver/qemu.git "$HOME/.build/qemu"
+  cd "$HOME/.build/qemu"
+
+  HEAD=`git log -n1 --pretty=format:%H`
+  echo "HEAD revision $HEAD"
+
+  [ -e "$HOME/.cache/qemu/built" ] && BUILT=`cat "$HOME/.cache/qemu/built"`
+  echo "Cached revision $BUILT"
+
+  if [ "$HEAD" != "$BUILT" ]
+  then
+    echo "Building QEMU"
+    git submodule --quiet update --init
+
+    install -d "$HOME/.build/qemu/build"
+    cd         "$HOME/.build/qemu/build"
+
+    "$HOME/.build/qemu/configure" --prefix="$HOME/.cache/qemu/usr" --target-list=i386-softmmu --disable-werror
+    make -j2
+    make install
+
+    echo "$HEAD" > "$HOME/.cache/qemu/built"
+  fi
+fi
+
+cat << EOF > $CURDIR/configure/RELEASE.local
+EPICS_BASE=$HOME/.source/epics-base
+EOF
+
+install -d "$HOME/.source"
+cd "$HOME/.source"
+
+add_base_module() {
+  MODULE=$1
+  BRANCH=$2
+  ( cd epics-base/modules && \
+  git clone --quiet --depth 5 --branch $MODULE/$BRANCH https://github.com/${REPOBASE:-epics-base}/epics-base.git $MODULE && \
+  cd $MODULE && git log -n1 )
+}
+
+add_gh_module() {
+  MODULE=$1
+  REPOOWNER=$2
+  REPONAME=$3
+  BRANCH=$4
+  ( cd epics-base/modules && \
+  git clone --quiet --depth 5 --branch $BRANCH https://github.com/$REPOOWNER/$REPONAME.git $MODULE && \
+  cd $MODULE && git log -n1 )
+}
+
+add_gh_flat() {
+  MODULE=$1
+  REPOOWNER=$2
+  REPONAME=$3
+  BRANCH=$4
+  MODULE_UC=$(echo $MODULE | tr 'a-z' 'A-Z')
+  ( git clone --quiet --depth 5 --branch $BRANCH https://github.com/$REPOOWNER/$REPONAME.git $MODULE && \
+  cd $MODULE && git log -n1 )
+  cat < $CURDIR/configure/RELEASE.local > $MODULE/configure/RELEASE.local
+  cat << EOF >> $CURDIR/configure/RELEASE.local
+${MODULE_UC}=$HOME/.source/$MODULE
+EOF
+}
+
+if [ "$BRBASE" ]
+then
+  git clone --quiet --depth 5 --branch "$BRBASE" https://github.com/${REPOBASE:-epics-base}/epics-base.git epics-base
+  (cd epics-base && git log -n1 )
+  add_gh_flat pvData ${REPOPVD:-epics-base} pvDataCPP ${BRPVD:-master}
+else
+  git clone --quiet --depth 5 --branch core/"${BRCORE:-master}" https://github.com/${REPOBASE:-epics-base}/epics-base.git epics-base
+  ( cd epics-base && git log -n1 )
+  add_base_module libcom "${BRLIBCOM:-master}"
+  add_gh_module pvData ${REPOPVD:-epics-base} pvDataCPP ${BRPVD:-master}
+fi
+
+if [ -e $CURDIR/configure/RELEASE.local ]
+then
+  cat $CURDIR/configure/RELEASE.local
+fi
+
+EPICS_HOST_ARCH=`sh epics-base/startup/EpicsHostArch`
+
+# requires wine and g++-mingw-w64-i686
+if [ "$WINE" = "32" ]
+then
+  echo "Cross mingw32"
+  sed -i -e '/CMPLR_PREFIX/d' epics-base/configure/os/CONFIG_SITE.linux-x86.win32-x86-mingw
+  cat << EOF >> epics-base/configure/os/CONFIG_SITE.linux-x86.win32-x86-mingw
+CMPLR_PREFIX=i686-w64-mingw32-
+EOF
+  cat << EOF >> epics-base/configure/CONFIG_SITE
+CROSS_COMPILER_TARGET_ARCHS+=win32-x86-mingw
+EOF
+fi
+
+if [ "$STATIC" = "YES" ]
+then
+  echo "Build static libraries/executables"
+  cat << EOF >> epics-base/configure/CONFIG_SITE
+SHARED_LIBRARIES=NO
+STATIC_BUILD=YES
+EOF
+fi
+
+case "$CMPLR" in
+clang)
+  echo "Host compiler is clang"
+  cat << EOF >> epics-base/configure/os/CONFIG_SITE.Common.$EPICS_HOST_ARCH
+GNU         = NO
+CMPLR_CLASS = clang
+CC          = clang
+CCC         = clang++
+EOF
+
+  # hack
+  sed -i -e 's/CMPLR_CLASS = gcc/CMPLR_CLASS = clang/' epics-base/configure/CONFIG.gnuCommon
+
+  clang --version
+  ;;
+*)
+  echo "Host compiler is default"
+  gcc --version
+  ;;
+esac
+
+cat <<EOF >> epics-base/configure/CONFIG_SITE
+USR_CPPFLAGS += $USR_CPPFLAGS
+USR_CFLAGS += $USR_CFLAGS
+USR_CXXFLAGS += $USR_CXXFLAGS
+EOF
+
+# set RTEMS to eg. "4.9" or "4.10"
+# requires qemu, bison, flex, texinfo, install-info
+if [ -n "$RTEMS" ]
+then
+  echo "Cross RTEMS${RTEMS} for pc386"
+  install -d /home/travis/.cache
+  curl -L "https://github.com/mdavidsaver/rsb/releases/download/travis-20160306-2/rtems${RTEMS}-i386-trusty-20190306-2.tar.gz" \
+  | tar -C /home/travis/.cache -xj
+
+  sed -i -e '/^RTEMS_VERSION/d' -e '/^RTEMS_BASE/d' epics-base/configure/os/CONFIG_SITE.Common.RTEMS
+  cat << EOF >> epics-base/configure/os/CONFIG_SITE.Common.RTEMS
+RTEMS_VERSION=$RTEMS
+RTEMS_BASE=/home/travis/.cache/rtems${RTEMS}-i386
+EOF
+  cat << EOF >> epics-base/configure/CONFIG_SITE
+CROSS_COMPILER_TARGET_ARCHS+=RTEMS-pc386
+EOF
+
+  # find local qemu-system-i386
+  export PATH="$HOME/.cache/qemu/usr/bin:$PATH"
+  echo -n "Using QEMU: "
+  type qemu-system-i386 || echo "Missing qemu"
+  EXTRA=RTEMS_QEMU_FIXUPS=YES
+fi
+
+make -j2 -C epics-base $EXTRA
+
+if [ "$BRBASE" ]
+then
+  make -j2 -C pvData $EXTRA
+fi

.gitignore

@@ -1,10 +1,14 @@
-bin/
-include/
-lib/
-db/
-dbd/
-configure/*.local
-html/
-**/O.*
-**/**/O.*
-QtC-*
+/cfg/
+/bin/
+/lib/
+/db/
+/dbd/
+/html/
+/include/
+/templates/
+/configure/*.local
+O.*/
+/QtC-*
+*.orig
+*.log
+.*.swp

.travis.yml

@@ -0,0 +1,29 @@
+sudo: false
+dist: trusty
+language: c++
+compiler:
+  - gcc
+addons:
+  apt:
+    packages:
+    - libreadline6-dev
+    - libncurses5-dev
+    - perl
+    - clang
+    - g++-mingw-w64-i686
+install:
+ - ./.ci/travis-prepare.sh
+script:
+ - ./.ci/travis-build.sh
+env:
+ - BRCORE=master BRLIBCOM=master BRPVD=master
+ - CMPLR=clang
+ - USR_CXXFLAGS=-std=c++11
+ - CMPLR=clang USR_CXXFLAGS=-std=c++11
+ - WINE=32 TEST=NO STATIC=YES
+ - WINE=32 TEST=NO STATIC=NO
+ - RTEMS=4.10 TEST=NO
+ - RTEMS=4.9 TEST=NO
+ - BRBASE=3.16
+ - BRBASE=3.15
+ - BRBASE=3.14

configure/RELEASE

@@ -1,32 +1,40 @@
-#RELEASE Location of external products
+# RELEASE - Location of external support modules
 #
-# IF YOU MAKE ANY CHANGES to this file you MUST at least run
-# "gnumake" in this directory afterwards; you usually need
-# to run "gnumake rebuild" in the application's top level
-# directory each time this file is changed.
+# IF YOU CHANGE ANY PATHS in this file or make API changes to
+# any modules it refers to, you should do a "make rebuild" in
+# this application's top level directory.
 #
-# NOTE: The build does not check dependencies against files
-# that are outside this application, thus you should run
-# "gnumake distclean install" in the top directory each time
-# EPICS_BASE, SNCSEQ, or any other external module defined
-# in the RELEASE file is rebuilt.
+# The EPICS build process does not check dependencies against
+# any files from outside the application, so it is safest to
+# rebuild it completely if any modules it depends on change.
 #
-# Host/target specific settings can be specified in files named
+# Host- or target-specific settings can be given in files named
 #  RELEASE.$(EPICS_HOST_ARCH).Common
 #  RELEASE.Common.$(T_A)
 #  RELEASE.$(EPICS_HOST_ARCH).$(T_A)
+#
+# This file is parsed by both GNUmake and an EPICS Perl script,
+# so it may ONLY contain definititions of paths to other support
+# modules, variable definitions that are used in module paths,
+# and include statements that pull in other RELEASE files.
+# Variables may be used before their values have been set.
+# Build variables that are NOT used in paths should be set in
+# the CONFIG_SITE file.
 
-TEMPLATE_TOP=$(EPICS_BASE)/templates/makeBaseApp/top
+# Variables and paths to dependent modules:
+#MODULES = /path/to/modules
+#MYMODULE = $(MODULES)/my-module
 
-#If using the sequencer, point SNCSEQ at its top directory:
-#SNCSEQ=$(EPICS_BASE)/../modules/soft/seq
+# If building the EPICS modules individually, set these:
+#EPICS_PVDATA = $(MODULES)/pvData-7.0.0
+#EPICS_LIBCOM = $(MODULES)/libcom-3.17.0
+#EPICS_BASE = $(MODULES)/core-7.0.1
 
-# EPICS_BASE usually appears last so other apps can override stuff:
-#EPICS_BASE=/opt/epics/base
-
-#Capfast users may need the following definitions
-#CAPFAST_TEMPLATES=
-#SCH2EDIF_PATH=
+# Set RULES here if you want to use build rules from elsewhere:
+#RULES = $(MODULES)/build-rules
 
+# These allow developers to override the RELEASE variable settings
+# without having to modify the configure/RELEASE file itself.
 -include $(TOP)/../RELEASE.local
+-include $(TOP)/../RELEASE.$(EPICS_HOST_ARCH).local
 -include $(TOP)/configure/RELEASE.local

documentation/RELEASE_NOTES.html

@@ -1,4 +1,34 @@
-<h1>Release 5.1.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 Normative Types Release Notes</title>
+  <link rel="stylesheet" type="text/css" href="../../base.css" />
+  <link rel="stylesheet" type="text/css" href="../../epicsv4.css" />
+
+</head>
+
+<body>
+
+<h1>Release 5.2.0</h1>
+
+<p>This release contains bug fixes and minor source updates needed to
+build against the latest version of pvData.</p>
+
+<h1>Release 5.1.2</h1>
+
+<p>The main changes since release 5.1.1 are:</p>
+
+<ul>
+<li>NTUnionBuilder: Add missing value() function</li>
+<li>Updated document: Now document all Normative Types</li>
+</ul>
+
+<h1>Release 5.1.1</h1>
 
 <p>The main changes since release 5.0 are:</p>
 
@@ -111,3 +141,7 @@ added and options such as choice of scalar type can be made.</p>
 NTUtils for type IDs.</li>
 <li>Unit tests for the implemented classes.</li>
 </ul>
+
+
+</body>
+</html>

documentation/RELEASE_NOTES.md

@@ -1,4 +1,19 @@
-Release 5.1.0
+Release 5.2.0
+=============
+
+This release contains bug fixes and minor source updates needed to
+build against the latest version of pvData.
+
+Release 5.1.2
+=============
+
+The main changes since release 5.1.1 are:
+
+* NTUnionBuilder: Add missing value() function
+* Updated document: Now document all Normative Types
+
+
+Release 5.1.1
 =============
 
 The main changes since release 5.0 are:

jenkins/cloudbees_build

@@ -21,28 +21,20 @@ installE4 () {
     local module=$1
     local branch=$2
 
-    # If microbench version does not exist, try without
-    if [ "${MB}" = "WITH_MICROBENCH" ]; then
-        if ! wget -nv https://openepics.ci.cloudbees.com/job/e4-cpp-${module}-${branch}-build/BASE=${BASE},MB=WITH_MICROBENCH/lastSuccessfulBuild/artifact/${module}.CB-dist.tar.gz; then
-            wget -nv https://openepics.ci.cloudbees.com/job/e4-cpp-${module}-${branch}-build/BASE=${BASE},MB=NO_MICROBENCH/lastSuccessfulBuild/artifact/${module}.CB-dist.tar.gz
-        fi
-    else
-        wget -nv https://openepics.ci.cloudbees.com/job/e4-cpp-${module}-${branch}-build/BASE=${BASE},MB=NO_MICROBENCH/lastSuccessfulBuild/artifact/${module}.CB-dist.tar.gz
-    fi
+    wget -nv https://openepics.ci.cloudbees.com/job/e4-cpp-${module}-${branch}-build/BASE=${BASE}/lastSuccessfulBuild/artifact/${module}.CB-dist.tar.gz
     tar -xzf ${module}.CB-dist.tar.gz
 }
 
 ###########################################
-# Defaults for EPICS Base and MB
+# Defaults for EPICS Base
 
 DEFAULT_BASE=3.15.4
 BASE=${BASE:-${DEFAULT_BASE}}
-MB=${MB:-"NO_MICROBENCH"}
 
 ###########################################
 # Dependent module branches
 
-PVDATA_BRANCH="release-6.0"
+PVDATA_BRANCH="master"
 
 ###########################################
 # Fetch and unpack dependencies

jenkins/cloudbees_doc

@@ -65,9 +65,10 @@ doxygen
 ###########################################
 # Publish
 
-if [ "${PUBLISH}" != "NO" ]; then
+if [ "${PUBLISH}" != "DONT" ]; then
     # Upload explicit dummy to ensure target directory exists
     echo "Created by CloudBees Jenkins upload job. Should be deleted as part of the job." > DUMMY
     rsync -q -e ssh DUMMY epics-jenkins@web.sourceforge.net:/home/project-web/epics-pvdata/htdocs/docbuild/normativeTypesCPP/${PUBLISH}/
+
     rsync -aqP --delete -e ssh documentation epics-jenkins@web.sourceforge.net:/home/project-web/epics-pvdata/htdocs/docbuild/normativeTypesCPP/${PUBLISH}/
 fi

src/Makefile

@@ -47,7 +47,7 @@ LIBRARY = nt
 nt_LIBS += pvData Com
 
 # shared library ABI version.
-SHRLIB_VERSION ?= 5.1
+SHRLIB_VERSION ?= 5.2
 
 include $(TOP)/configure/RULES
 

src/ntndarray.cpp

@@ -6,6 +6,8 @@
 
 #include <algorithm>
 
+#include <pv/lock.h>
+
 #define epicsExportSharedSymbols
 #include <pv/ntndarray.h>
 #include <pv/ntndarrayAttribute.h>
@@ -350,10 +352,10 @@ bool NTNDArray::isCompatible(StructureConstPtr const &structure)
 
 
     StructureArrayConstPtr attributeField = structure->getField<StructureArray>( "attribute");
+    if (!attributeField)
+        return false;
 
-    StructureConstPtr attributeElementStruc = attributeField->getStructure();
-
-    if (!NTNDArrayAttribute::isCompatible(attributeElementStruc))
+    if (!NTNDArrayAttribute::isCompatible(attributeField->getStructure()))
         return false;
 
 
@@ -361,7 +363,7 @@ bool NTNDArray::isCompatible(StructureConstPtr const &structure)
     if (field.get())
     {
         ScalarConstPtr descriptorField = structure->getField<Scalar>("descriptor");
-        if (!descriptorField.get() || descriptorField->getScalarType() != pvString)
+        if (!descriptorField || descriptorField->getScalarType() != pvString)
             return false;
     }
 

src/ntndarrayAttribute.cpp

@@ -93,6 +93,7 @@ NTNDArrayAttributeBuilder::NTNDArrayAttributeBuilder()
 
 void NTNDArrayAttributeBuilder::reset()
 {
+    tags = false;
     descriptor = false;
     alarm = false;
     timeStamp = false;

src/ntunion.cpp

@@ -18,6 +18,12 @@ static NTFieldPtr ntField = NTField::get();
 namespace detail {
 
 
+NTUnionBuilder::shared_pointer NTUnionBuilder::value(UnionConstPtr unionType)
+{
+    valueType = unionType;
+    return shared_from_this();
+}
+
 StructureConstPtr NTUnionBuilder::createStructure()
 {
     FieldBuilderPtr builder =

src/pv/ntunion.h

@@ -40,6 +40,14 @@ namespace detail {
     public:
         POINTER_DEFINITIONS(NTUnionBuilder);
 
+        /**
+         * Specifies the union for the value field.
+         * If this is not called then a variant union is the default.
+         * @param unionType  the introspection object for the union value field
+         * @return this      instance of  NTUnionBuilder
+         */
+        shared_pointer value(epics::pvData::UnionConstPtr unionType);
+
         /**
          * Adds descriptor field to the NTUnion.
          * @return this instance of <b>NTUnionBuilder</b>.

test/ntunionTest.cpp

@@ -47,7 +47,6 @@ void test_builder()
     testOk(valueField.get() != 0, "value is enum");
 
     std::cout << *structure << std::endl;
-
 }
 
 void test_ntunion()
@@ -158,11 +157,43 @@ void test_wrap()
     testOk(ptr.get() != 0, "wrapUnsafe OK");
 }
 
+
+void test_variant_union()
+{
+    StructureConstPtr structure = NTUnion::createBuilder()->
+            addDescriptor()->
+            addAlarm()->
+            addTimeStamp()->
+            createStructure();
+    testOk1(structure->getField<Union>("value")->isVariant());
+}
+
+void test_regular_union()
+{
+    UnionConstPtr u = getFieldCreate()->createFieldBuilder()->
+        add("x", pvDouble)->
+        add("i", pvInt)->
+        createUnion();
+
+    StructureConstPtr structure = NTUnion::createBuilder()->
+            value(u)->
+            addDescriptor()->
+            addAlarm()->
+            addTimeStamp()->
+            createStructure();
+    testOk1(!structure->getField<Union>("value")->isVariant());
+    testOk1(structure->getField<Union>("value") == u);
+}
+
+
+
 MAIN(testNTUnion) {
-    testPlan(29);
+    testPlan(32);
     test_builder();
     test_ntunion();
     test_wrap();
+    test_variant_union();
+    test_regular_union();
     return testDone();
 }