Clear development flag for 4.5.1 release

addRecord is new

.readthedocs.yml

@@ -0,0 +1,17 @@
+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Build documentation in the documentation/ directory with Sphinx
+sphinx:
+  configuration: documentation/conf.py
+
+# Build documentation with MkDocs
+#mkdocs:
+#  configuration: mkdocs.yml
+
+# Optionally build your docs in additional formats such as PDF and ePub
+formats: all

.travis.yml

@@ -28,4 +28,4 @@ env:
  - BRBASE=7.0 RTEMS=4.9 TEST=NO
  - BRBASE=3.16
  - BRBASE=3.15
- - BRBASE=3.14
+ 

Doxyfile

@@ -38,7 +38,7 @@ PROJECT_NAME           = pvDatabaseCPP
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         =
+PROJECT_NUMBER         = 4.5.1
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a
@@ -765,7 +765,7 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = include
+INPUT                  = src
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -1035,7 +1035,7 @@ GENERATE_HTML          = YES
 # The default directory is: html.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-HTML_OUTPUT            = documentation/html
+HTML_OUTPUT            = html/doxygen
 
 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
 # generated HTML page (for example: .htm, .php, .asp).

configure/CONFIG_PVDATABASE_VERSION

@@ -1,3 +1,12 @@
+# Version number for the PV Database API and shared library
+
 EPICS_PVDATABASE_MAJOR_VERSION = 4
 EPICS_PVDATABASE_MINOR_VERSION = 5
-EPICS_PVDATABASE_MAINTENANCE_VERSION = 0
+EPICS_PVDATABASE_MAINTENANCE_VERSION = 1
+
+# Development flag, set to zero for release versions
+
+EPICS_PVDATABASE_DEVELOPMENT_FLAG = 0
+
+# Immediately after a release the MAINTENANCE_VERSION
+# will be incremented and the DEVELOPMENT_FLAG set to 1

documentation/RELEASE_NOTES.md

@@ -2,10 +2,16 @@
 
 This document summarizes the changes to the module between releases.
 
+## Release 4.5.1 (EPICS 7.0.3.1, Nov 2019)
+
+* addRecord is new.
+* Doxygen updates and read-the-docs integration.
+
+
 ## Release 4.5.0 (EPICS 7.0.3, Jul 2019)
 
-1) support is a new feature.
-2) processRecord is new
+* support is a new feature.
+* processRecord is new.
 
 
 ## Release 4.4.2 (EPICS 7.0.2.2, Apr 2019)

documentation/_static/css/custom.css

@@ -0,0 +1,7 @@
+.wy-side-nav-search {
+    background-color: #18334B;
+}
+
+.wy-side-nav-search input[type="text"] {
+    border-color: #18334b;
+}

documentation/conf.py

@@ -0,0 +1,80 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# http://www.sphinx-doc.org/en/master/config
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'normativeTypes (C++)'
+copyright = '2019, EPICS Controls.'
+author = 'EPICS'
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'sphinx.ext.intersphinx',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# Intersphinx links to subprojects
+intersphinx_mapping = {
+}
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'sphinx_rtd_theme'
+
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+html_css_files = [
+    'css/custom.css',
+]
+
+master_doc = 'index'
+
+html_theme_options = {
+    'logo_only': True,
+}
+html_logo = "images/EPICS_white_logo_v02.png"
+
+html_extra_path = [
+    '../html',
+    'pvDatabaseCPP.html',
+]
+
+
+# -- Run Doxygen ------------------------------------------------------------
+
+import subprocess
+subprocess.call('cd ..; mkdir -p html/doxygen; doxygen', shell=True)

documentation/index.rst

@@ -0,0 +1,17 @@
+pvDatabase (C++) Library
+========================
+
+.. toctree::
+   :hidden:
+
+   EPICS Website <https://epics-controls.org>
+   EPICS Documentation Home <https://docs.epics-controls.org>
+
+
+.. toctree::
+   :maxdepth: 1
+   :caption: pvDatabaseCPP
+
+   Reference Manual <https://docs.epics-controls.org/projects/pvdatabase-cpp/en/latest/pvDatabaseCPP.html>
+   API Documentation <https://docs.epics-controls.org/projects/pvdatabase-cpp/en/latest/doxygen>
+   Source Code Repository on GitHub <https://github.com/epics-base/pvDatabaseCPP>

documentation/pvDatabaseCPP.html

@@ -37,7 +37,7 @@
 <div class="head">
 <h1>pvDatabaseCPP</h1>
 <h2 class="nocount">Release ? - TBD</h2>
-Latest update 2019.06.19.
+Latest update 2019.09.11.
 
 
 <h2 class="nocount">Abstract</h2>
@@ -135,6 +135,10 @@ href="./html/index.html">doxgen</a>
    <dd>
    This is a PVRecord that periodical processes a set of PVRecords in the local PVDatabase.
    </dd>
+   <dt>addRecord.h</dt>
+   <dd>
+    This is a PVRecord that adds a new PVRecord to the local PVDatabase.
+   </dd>
    <dt>removeRecord.h</dt>
    <dd>
     This is a PVRecord that removes a PVRecord in the local PVDatabase.
@@ -174,7 +178,7 @@ href="./html/index.html">doxgen</a>
 <p>This has the pvSupport code.</p>
 <h3>src/special</h3>
 <p>
-This has the code for processRecord, removeRecord, and traceRecord.
+This has the code for processRecord, addRecord, removeRecord, and traceRecord.
 </p>
 <h3>src/copy</h3>
 <p>This has the code for pvStructureCopy and all the plugin support.

src/Makefile

@@ -25,6 +25,7 @@ INC += pv/channelProviderLocal.h
 
 INC += pv/traceRecord.h
 INC += pv/removeRecord.h
+INC += pv/addRecord.h
 INC += pv/processRecord.h
 
 INC += pv/pvSupport.h

src/pv/addRecord.h

@@ -0,0 +1,63 @@
+/* addRecord.h */
+/**
+ * Copyright - See the COPYRIGHT that is included with this distribution.
+ * EPICS pvData is distributed subject to a Software License Agreement found
+ * in file LICENSE that is included with this distribution.
+ */
+/**
+ * @author mrk
+ * @date 2013.04.18
+ */
+#ifndef ADDRECORD_H
+#define ADDRECORD_H
+
+#include <pv/channelProviderLocal.h>
+
+#include <shareLib.h>
+
+namespace epics { namespace pvDatabase { 
+
+
+class AddRecord;
+typedef std::tr1::shared_ptr<AddRecord> AddRecordPtr;
+
+/**
+ * @brief Add another record in the same database.
+ *
+ * A record to add another record
+ * It is meant to be used via a channelPutGet request.
+ * The argument has one field: recordName.
+ * The result has a field named status.
+ */
+class epicsShareClass AddRecord :
+    public PVRecord
+{
+public:
+    POINTER_DEFINITIONS(AddRecord);
+    /**
+     * Factory methods to create AddRecord.
+     * @param recordName The name for the AddRecord.
+     * @return A shared pointer to AddRecord..
+     */
+    static AddRecordPtr create(
+        std::string const & recordName);
+    /**
+     * standard init method required by PVRecord
+     * @return true unless record name already exists.
+     */
+    virtual bool init();
+    /**
+     * @brief Add the record specified by  recordName.
+     */
+    virtual void process();
+private:
+    AddRecord(
+        std::string const & recordName,
+        epics::pvData::PVStructurePtr const & pvStructure);
+    epics::pvData::PVStringPtr pvRecordName;
+    epics::pvData::PVStringPtr pvResult;
+};
+
+}}
+
+#endif  /* ADDRECORD_H */

src/special/Makefile

@@ -4,12 +4,15 @@ SRC_DIRS += $(PVDATABASE_SRC)/special
 
 LIBSRCS += traceRecord.cpp
 LIBSRCS += removeRecord.cpp
+LIBSRCS += addRecord.cpp
 LIBSRCS += processRecord.cpp
 
 DBD += traceRecordRegister.dbd
 DBD += removeRecordRegister.dbd
+DBD += addRecordRegister.dbd
 DBD += processRecordRegister.dbd
 
 LIBSRCS += traceRecordRegister.cpp
 LIBSRCS += removeRecordRegister.cpp
+LIBSRCS += addRecordRegister.cpp
 LIBSRCS += processRecordRegister.cpp

src/special/addRecord.cpp

@@ -0,0 +1,118 @@
+/* addRecord.cpp */
+/**
+ * Copyright - See the COPYRIGHT that is included with this distribution.
+ * EPICS pvData is distributed subject to a Software License Agreement found
+ * in file LICENSE that is included with this distribution.
+ */
+/**
+ * @author mrk
+ * @date 2013.04.18
+ */
+
+#include <string>
+#include <cstring>
+#include <stdexcept>
+#include <memory>
+#include <set>
+
+#include <pv/lock.h>
+#include <pv/pvType.h>
+#include <pv/pvData.h>
+#include <pv/standardField.h>
+#include <pv/pvTimeStamp.h>
+#include <pv/timeStamp.h>
+#include <pv/rpcService.h>
+#include <pv/pvAccess.h>
+#include <pv/status.h>
+#include <pv/serverContext.h>
+
+
+#define epicsExportSharedSymbols
+#include "pv/pvStructureCopy.h"
+#include "pv/pvDatabase.h"
+#include "pv/addRecord.h"
+
+using std::tr1::static_pointer_cast;
+using namespace epics::pvData;
+using namespace epics::pvAccess;
+using namespace std;
+
+namespace epics { namespace pvDatabase { 
+
+AddRecordPtr AddRecord::create(
+    std::string const & recordName)
+{
+    FieldCreatePtr fieldCreate = getFieldCreate();
+    PVDataCreatePtr pvDataCreate = getPVDataCreate();
+    StructureConstPtr  topStructure = fieldCreate->createFieldBuilder()->
+        addNestedStructure("argument")->
+            add("recordName",pvString)->
+            addNestedUnion("union") ->
+                endNested()->
+            endNested()->
+        addNestedStructure("result") ->
+            add("status",pvString) ->
+            endNested()->
+        createStructure();
+    PVStructurePtr pvStructure = pvDataCreate->createPVStructure(topStructure);
+    AddRecordPtr pvRecord(
+        new AddRecord(recordName,pvStructure));
+    if(!pvRecord->init()) pvRecord.reset();
+    return pvRecord;
+}
+
+AddRecord::AddRecord(
+    std::string const & recordName,
+    epics::pvData::PVStructurePtr const & pvStructure)
+: PVRecord(recordName,pvStructure)
+{
+}
+
+bool AddRecord::init()
+{
+    initPVRecord();
+    PVStructurePtr pvStructure = getPVStructure();
+    pvRecordName = pvStructure->getSubField<PVString>("argument.recordName");
+    if(!pvRecordName) return false;
+    pvResult = pvStructure->getSubField<PVString>("result.status");
+    if(!pvResult) return false;
+    return true;
+}
+
+void AddRecord::process()
+{
+    PVDataCreatePtr pvDataCreate = getPVDataCreate();
+    string name = pvRecordName->get();
+    PVRecordPtr pvRecord = PVDatabase::getMaster()->findRecord(name);
+    if(pvRecord) {
+        pvResult->put(name + " already exists");
+        return;
+    }
+    PVUnionPtr pvUnion = getPVStructure()->getSubField<PVUnion>("argument.union");
+    if(!pvUnion) {
+        pvResult->put(name + " argument.union is NULL");
+        return;
+    }
+    PVFieldPtr pvField(pvUnion->get());
+    if(!pvField) {
+        pvResult->put(name + " union has no value");
+        return;
+    }
+    if(pvField->getField()->getType()!=epics::pvData::structure) {
+        pvResult->put(name + " union most be a structure");
+        return;
+    }
+    StructureConstPtr st = static_pointer_cast<const Structure>(pvField->getField());
+    PVStructurePtr pvStructure = pvDataCreate->createPVStructure(st);
+    PVRecordPtr pvRec = PVRecord::create(name,pvStructure);
+    bool result = PVDatabase::getMaster()->addRecord(pvRec);
+    if(result) {
+        pvResult->put("success");
+    } else {
+        pvResult->put("failure");
+    }
+}
+
+
+}}
+

src/special/addRecordRegister.cpp

@@ -0,0 +1,62 @@
+/*
+ * Copyright information and license terms for this software can be
+ * found in the file LICENSE that is included with the distribution
+ */
+
+/**
+ * @author mrk
+ * @date 2013.07.24
+ */
+
+
+/* Author: Marty Kraimer */
+#include <epicsThread.h>
+#include <iocsh.h>
+#include <pv/event.h>
+#include <pv/pvAccess.h>
+#include <pv/serverContext.h>
+#include <pv/pvData.h>
+#include <pv/pvTimeStamp.h>
+#include <pv/rpcService.h>
+
+// The following must be the last include for code pvDatabase uses
+#include <epicsExport.h>
+#define epicsExportSharedSymbols
+#include "pv/pvStructureCopy.h"
+#include "pv/pvDatabase.h"
+#include "pv/addRecord.h"
+
+using namespace epics::pvData;
+using namespace epics::pvAccess;
+using namespace epics::pvDatabase;
+using namespace std;
+
+static const iocshArg testArg0 = { "recordName", iocshArgString };
+static const iocshArg *testArgs[] = {
+    &testArg0};
+
+static const iocshFuncDef addRecordFuncDef = {"addRecordCreate", 1,testArgs};
+
+static void addRecordCallFunc(const iocshArgBuf *args)
+{
+    char *recordName = args[0].sval;
+    if(!recordName) {
+        throw std::runtime_error("addRecordCreate invalid number of arguments");
+    }
+    AddRecordPtr record = AddRecord::create(recordName);
+    bool result = PVDatabase::getMaster()->addRecord(record);
+    if(!result) cout << "recordname" << " not added" << endl;
+}
+
+static void addRecordRegister(void)
+{
+    static int firstTime = 1;
+    if (firstTime) {
+        firstTime = 0;
+        iocshRegister(&addRecordFuncDef, addRecordCallFunc);
+    }
+}
+
+extern "C" {
+    epicsExportRegistrar(addRecordRegister);
+}

src/special/addRecordRegister.dbd

@@ -0,0 +1 @@
+registrar("addRecordRegister")