Switch to tempfile + dbLoadRecords as a strategy

Author: coretl

softioc/__init__.py

@@ -6,7 +6,8 @@
     iocshRegisterCommon, registerRecordDeviceDriver, pdbbase
 
 # Do this as early as possible, in case we happen to use cothread
-# as it's harmless if we don't
+# This will set the CATOOLS_LIBCA_PATH environment variable in case we use
+# cothread.catools. It works even if we don't have cothread installed
 import epicscorelibs.path.cothread  # noqa
 
 # This import will also pull in the extension, which is needed

softioc/builder.py

@@ -1,21 +1,16 @@
 import os
 import numpy
+from .softioc import dbLoadDatabase
 
 from epicsdbbuilder import *
-from epicsdbbuilder.recordset import recordset
 
 InitialiseDbd()
 LoadDbdFile(os.path.join(os.path.dirname(__file__), 'device.dbd'))
 
-from . import pythonSoftIoc, imports  # noqa
+from . import pythonSoftIoc  # noqa
 PythonDevice = pythonSoftIoc.PythonDevice()
 
 
-def dbLoadDatabase(database, path = None, substitutions = None):
-    '''Loads a database file and applies any given substitutions.'''
-    imports.dbLoadDatabase(database, path, substitutions)
-
-
 # ----------------------------------------------------------------------------
 #  Wrappers for PythonDevice record constructors.
 #
@@ -185,14 +180,6 @@ def WaveformOut(name, *value, **fields):
 
 _DatabaseWritten = False
 
-def AddDatabaseLine(line, macros={}):
-    '''Add a single line to the produced database, substituting $(k) for v for
-    each entry in macros'''
-    for k, v in macros.items():
-        line = line.replace("$(%s)" % k, v)
-    recordset.AddBodyLine(line)
-
-
 def LoadDatabase():
     '''This should be called after all the builder records have been created,
     but before calling iocInit().  The database is loaded into EPICS memory,

softioc/softioc.py

@@ -1,10 +1,11 @@
 import os
 import sys
 from ctypes import *
+from tempfile import NamedTemporaryFile
 
 from epicsdbbuilder.recordset import recordset
 
-from . import imports, device, builder
+from . import imports, device
 
 __all__ = ['dbLoadDatabase', 'iocInit', 'interactive_ioc']
 
@@ -240,35 +241,48 @@ def __call__(self):
 exit = Exiter()
 command_names.append('exit')
 
-# For backwards compatibility
-dbLoadDatabase = builder.dbLoadDatabase
+def dbLoadDatabase(database, path = None, substitutions = None):
+    '''Loads a database file and applies any given substitutions.'''
+    imports.dbLoadDatabase(database, path, substitutions)
 
 
-def _add_records_from_file(dir, file, macros):
-    # This is very naive, for instance macros are added to but never removed,
-    # but it works well enough for devIocStats
-    with open(os.path.join(dir, file)) as f:
+
+def _add_records_from_file(dirname, file, substitutions):
+    # This is very naive, it loads all includes before their parents which
+    # possibly can put them out of order, but it works well enough for
+    # devIocStats
+    with open(os.path.join(dirname, file)) as f:
+        lines, include_subs = [], ""
         for line in f.readlines():
             line = line.rstrip()
             if line.startswith('substitute'):
-                # substitute "QUEUE=scanOnce, QUEUE_CAPS=SCANONCE
-                for sub in line.split('"')[1].split(','):
-                    k, v = sub.split('=')
-                    macros[k.strip()] = v.strip()
+                # substitute "QUEUE=scanOnce, QUEUE_CAPS=SCANONCE"
+                # keep hold of the substitutions
+                include_subs = line.split('"')[1]
             elif line.startswith('include'):
                 # include "iocQueue.db"
-                _add_records_from_file(dir, line.split('"')[1], macros)
+                subs = substitutions
+                if substitutions and include_subs:
+                    subs = substitutions + ", " + include_subs
+                else:
+                    subs = substitutions + include_subs
+                _add_records_from_file(dirname, line.split('"')[1], subs)
             else:
                 # A record line
-                builder.AddDatabaseLine(line, macros)
+                lines.append(line)
+        # Write a tempfile and load it
+        with NamedTemporaryFile(suffix='.db', delete=False) as f:
+            f.write(os.linesep.join(lines).encode())
+        dbLoadDatabase(f.name, substitutions=substitutions)
+        os.unlink(f.name)
 
 
 def devIocStats(ioc_name):
     '''This will load a template for the devIocStats library with the specified
     IOC name. This should be called before `iocInit`'''
-    macros = dict(IOCNAME=ioc_name, TODFORMAT='%m/%d/%Y %H:%M:%S')
+    substitutions = 'IOCNAME=' + ioc_name + ', TODFORMAT=%m/%d/%Y %H:%M:%S'
     iocstats_dir = os.path.join(os.path.dirname(__file__), 'iocStatsDb')
-    _add_records_from_file(iocstats_dir, 'ioc.template', macros)
+    _add_records_from_file(iocstats_dir, 'ioc.template', substitutions)
 
 
 def interactive_ioc(context = {}, call_exit = True):