long-term maintenance improvement for runTime selection tables

Reworked selection infrastructure to support reporting version changes for particular lookup methods. For this to work, all raw lookups in the selection tables need to be passed through an accessor method. Independent of this, the old implementation for runTime selection could be modernized to use unique_ptr for the memory management instead of the clunkier manual deletion mechanisms.

The result is a slightly cleaner calling interface, but it is also possible to continue with table-based lookups as before. Does not break existing code APIs, but is not ABI identical.

src/OpenFOAM/db/runTimeSelection/construction/addToRunTimeSelectionTable.H

@@ -6,6 +6,7 @@
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
     Copyright (C) 2011-2016 OpenFOAM Foundation
+    Copyright (C) 2021 OpenCFD Ltd.
 -------------------------------------------------------------------------------
 License
     This file is part of OpenFOAM.
@@ -26,6 +27,10 @@ License
 Description
     Macros for easy insertion into run-time selection tables
 
+Note
+    The helper class names used here must remain synchronized with the
+    definitions in runTimeSelectionTables.H
+
 \*---------------------------------------------------------------------------*/
 
 #ifndef addToRunTimeSelectionTable_H
@@ -33,88 +38,88 @@ Description
 
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
-//- Add to hash-table of functions with typename as the key
+//- Add to construction table with typeName as the key
 #define addToRunTimeSelectionTable\
 (baseType,thisType,argNames)                                                   \
                                                                                \
-    /* Add the thisType constructor function to the table */                   \
+    /* Add thisType constructor function to the table */                       \
     baseType::add##argNames##ConstructorToTable<thisType>                      \
         add##thisType##argNames##ConstructorTo##baseType##Table_
 
 
-//- Add to hash-table of functions with 'lookup' as the key
+//- Add to construction table with 'lookup' as the key
 #define addNamedToRunTimeSelectionTable\
 (baseType,thisType,argNames,lookup)                                            \
                                                                                \
-    /* Add the thisType constructor function to the table, find by lookup */   \
+    /* Add thisType constructor function to the table, find by lookup */       \
     baseType::add##argNames##ConstructorToTable<thisType>                      \
-        add_##lookup##_##thisType##argNames##ConstructorTo##baseType##Table_   \
-        (#lookup)
+        add##thisType##argNames##ConstructorTo##baseType## \
+        Table_##lookup##_(#lookup)
 
 
-//- Add to hash-table of functions with typename as the key
+//- Add to construction table with typeName as the key
 #define addRemovableToRunTimeSelectionTable\
 (baseType,thisType,argNames)                                                   \
                                                                                \
-    /* Add the thisType constructor function to the table */                   \
+    /* Add thisType constructor function to the table */                       \
     baseType::addRemovable##argNames##ConstructorToTable<thisType>             \
         addRemovable##thisType##argNames##ConstructorTo##baseType##Table_
 
 
-//- Add to hash-table of functions with 'lookup' as the key
+//- Add to construction table with 'lookup' as the key
 #define addRemovableNamedToRunTimeSelectionTable\
 (baseType,thisType,argNames,lookup)                                            \
                                                                                \
-    /* Add the thisType constructor function to the table, find by lookup */   \
+    /* Add thisType constructor function to the table, find by lookup */       \
     baseType::addRemovable##argNames##ConstructorToTable<thisType>             \
-        addRemovable_##lookup##_##thisType##argNames##ConstructorTo            \
-        ##baseType##Table_(#lookup)
+        addRemovable##thisType##argNames##ConstructorTo##baseType## \
+        Table_##lookup##_(#lookup)
 
 
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
-//- Add to hash-table of functions with typename as the key.
+//- Add to construction table with typeName as the key.
 //  Use when baseType doesn't need a template argument (eg, is a typedef)
 #define addTemplateToRunTimeSelectionTable\
 (baseType,thisType,Targ,argNames)                                              \
                                                                                \
-    /* Add the thisType constructor function to the table */                   \
+    /* Add thisType constructor function to the table */                       \
     baseType::add##argNames##ConstructorToTable<thisType<Targ>>                \
         add##thisType##Targ##argNames##ConstructorTo##baseType##Table_
 
 
-//- Add to hash-table of functions with 'lookup' as the key.
+//- Add to construction table with 'lookup' as the key.
 //  Use when baseType doesn't need a template argument (eg, is a typedef)
 #define addNamedTemplateToRunTimeSelectionTable\
 (baseType,thisType,Targ,argNames,lookup)                                       \
                                                                                \
-    /* Add the thisType constructor function to the table, find by lookup */   \
+    /* Add thisType constructor function to the table, find by lookup */       \
     baseType::add##argNames##ConstructorToTable<thisType<Targ>>                \
-        add_##lookup##_##thisType##Targ##argNames##ConstructorTo##baseType     \
-        ##Table_(#lookup)
+        add##thisType##Targ##argNames##ConstructorTo##baseType## \
+        Table_##lookup##_(#lookup)
 
 
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
-//- Add to hash-table of functions with typename as the key.
+//- Add to construction table with typeName as the key.
 //  Use when baseType requires the Targ template argument as well
 #define addTemplatedToRunTimeSelectionTable\
 (baseType,thisType,Targ,argNames)                                              \
                                                                                \
-    /* Add the thisType constructor function to the table */                   \
+    /* Add thisType constructor function to the table */                       \
     baseType<Targ>::add##argNames##ConstructorToTable<thisType<Targ>>          \
         add##thisType##Targ##argNames##ConstructorTo##baseType##Targ##Table_
 
 
-//- Add to hash-table of functions with 'lookup' as the key.
+//- Add to construction table with 'lookup' as the key.
 //  Use when baseType requires the Targ template argument as well
 #define addNamedTemplatedToRunTimeSelectionTable\
 (baseType,thisType,Targ,argNames,lookup)                                       \
                                                                                \
-    /* Add the thisType constructor function to the table, find by lookup */   \
+    /* Add thisType constructor function to the table, find by lookup */       \
     baseType<Targ>::add##argNames##ConstructorToTable<thisType<Targ>>          \
-        add_##lookup##_##thisType##Targ##argNames##ConstructorTo##baseType##   \
-        Targ##Table_(#lookup)
+        add##thisType##Targ##argNames##ConstructorTo##baseType##Targ## \
+        Table_##lookup##_(#lookup)
 
 
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //