BUG: Added backward-compatability. The old instantiator style will be used unless the argument USE_INSTANTIATOR_NEW is given to tell the command to make use of the instantiator new functions exported from each class's implementation file.

Source/cmVTKMakeInstantiatorCommand.cxx

@@ -36,6 +36,7 @@ cmVTKMakeInstantiatorCommand
   std::vector<cmStdString> inSourceLists;
   m_ExportMacro = "-";
   bool includesMode = false;
+  bool oldVersion = true;
   
   // Find the path of the files to be generated.
   std::string filePath = m_Makefile->GetCurrentOutputDirectory();
@@ -56,6 +57,11 @@ cmVTKMakeInstantiatorCommand
         return false;
         }
       }
+    else if(args[i] == "USE_INSTANTIATOR_NEW")
+      {
+      includesMode = false;
+      oldVersion = false;
+      }
     else if(args[i] == "EXPORT_MACRO")
       {
       includesMode = false;
@@ -120,8 +126,15 @@ cmVTKMakeInstantiatorCommand
   cmGeneratedFileStream fout(fullName.c_str());
   
   // Actually generate the code in the file.
+  if(!oldVersion)
+    {
     this->GenerateHeaderFile(fout.GetStream());
     }
+  else
+    {
+    this->OldGenerateHeaderFile(fout.GetStream());
+    }
+  }
   
   // Generate the implementation file.
   {
@@ -133,8 +146,15 @@ cmVTKMakeInstantiatorCommand
   cmGeneratedFileStream fout(fullName.c_str());
   
   // Actually generate the code in the file.
+  if(!oldVersion)
+    {
     this->GenerateImplementationFile(fout.GetStream());
     }
+  else
+    {
+    this->OldGenerateImplementationFile(fout.GetStream());
+    }
+  }
   
   // Add the generated source file into the source list.
   cmSourceFile file;
@@ -147,6 +167,46 @@ cmVTKMakeInstantiatorCommand
   sourceListValue += file.GetSourceName() + ".cxx";
   }
   
+  if(oldVersion)
+    {
+    int groupSize = 10;
+    size_t numClasses = m_Classes.size();
+    size_t numFullBlocks = numClasses / groupSize;
+    size_t lastBlockSize = numClasses % groupSize;
+    size_t numBlocks = numFullBlocks + ((lastBlockSize>0)? 1:0);
+    
+    // Generate the files with the ::New() calls to each class.  These
+    // are done in groups to keep the translation unit size smaller.
+    for(unsigned int block=0; block < numBlocks;++block)
+      {
+      std::string fileName = this->OldGenerateCreationFileName(block);    
+      std::string fullName = filePath+"/"+fileName;
+    
+      // Generate the output file with copy-if-different.
+      {
+      cmGeneratedFileStream fout(fullName.c_str());
+    
+      unsigned int thisBlockSize =
+        (block < numFullBlocks)? groupSize:lastBlockSize;
+    
+      // Actually generate the code in the file.
+      this->OldGenerateCreationFile(fout.GetStream(),
+                                    block*groupSize, thisBlockSize);
+      }
+      
+      // Add the generated source file into the source list.
+      cmSourceFile file;
+      file.SetWrapExclude(true);
+      file.SetIsAnAbstractClass(false);
+      file.SetName(fileName.c_str(), filePath.c_str(),
+                   m_Makefile->GetSourceExtensions(),
+                   m_Makefile->GetHeaderExtensions());
+      m_Makefile->AddSource(file);
+      sourceListValue += ";";
+      sourceListValue += file.GetSourceName() + ".cxx";
+      }
+    }
+  
   m_Makefile->AddDefinition(args[1].c_str(), sourceListValue.c_str());  
   return true;
 }
@@ -259,3 +319,152 @@ cmVTKMakeInstantiatorCommand
     "// Purposely not initialized.  Default is static initialization to 0.\n"
     "unsigned int " << m_ClassName.c_str() << "::Count;\n";
 }
+
+std::string
+cmVTKMakeInstantiatorCommand::OldGenerateCreationFileName(unsigned int block)
+{
+  cmStringStream nameStr;
+  nameStr << m_ClassName.c_str() << block << ".cxx";
+  std::string result = nameStr.str();
+  return result;
+}
+
+// Generates a file that includes the headers of the classes it knows
+// how to create and provides functions which create the classes with
+// the New() method.
+void
+cmVTKMakeInstantiatorCommand
+::OldGenerateCreationFile(std::ostream& os, unsigned int groupStart,
+                       unsigned int groupSize)
+{
+  // Need to include header of generated class.
+  os <<
+    "#include \"" << m_ClassName.c_str() << ".h\"\n"
+    "\n";
+  
+  // Include class files.
+  for(unsigned int i=0;i < groupSize;++i)
+    {
+    os << "#include \"" << m_Classes[groupStart+i].c_str() << ".h\"\n";
+    }
+
+  os <<
+    "\n";
+
+  // Write the create function implementations.
+  for(unsigned int i=0;i < groupSize;++i)
+    {
+    os << "vtkObject* " << m_ClassName.c_str() << "::Create_"
+       << m_Classes[groupStart+i].c_str() << "() { return "
+       << m_Classes[groupStart+i].c_str() << "::New(); }\n";
+    }
+}
+
+// Generates the class header file with the definition of the class
+// and its initializer class.
+void
+cmVTKMakeInstantiatorCommand
+::OldGenerateHeaderFile(std::ostream& os)
+{
+  os <<
+    "#ifndef __" << m_ClassName.c_str() << "_h\n"
+    "#define __" << m_ClassName.c_str() << "_h\n"
+    "\n"
+    "#include \"vtkInstantiator.h\"\n";
+  for(unsigned int i=0;i < m_Includes.size();++i)
+    {
+    os << "#include \"" << m_Includes[i].c_str() << "\"\n";
+    }
+  os <<
+    "\n"
+    "class " << m_ClassName.c_str() << "Initialize;\n"
+    "\n"
+    "class " << m_ExportMacro.c_str() << " " << m_ClassName.c_str() << "\n"
+    "{\n"
+    "  friend class " << m_ClassName.c_str() << "Initialize;\n"
+    "\n"
+    "  static void ClassInitialize();\n"
+    "  static void ClassFinalize();\n"
+    "\n";
+  
+  for(unsigned int i=0;i < m_Classes.size();++i)
+    {
+    os << "  static vtkObject* Create_" << m_Classes[i].c_str() << "();\n";
+    }
+  
+  // Write the initializer class to make sure the creation functions
+  // get registered when this generated header is included.
+  os <<
+    "};\n"
+    "\n"
+    "class " << m_ExportMacro.c_str() << " " << m_ClassName.c_str() << "Initialize\n"
+    "{\n"
+    "public:\n"
+    "  " << m_ClassName.c_str() << "Initialize();\n"
+    "  ~" << m_ClassName.c_str() << "Initialize();\n"
+    "private:\n"
+    "  static unsigned int Count;\n"
+    "};\n"
+    "\n"
+    "static " << m_ClassName.c_str() << "Initialize " << m_ClassName.c_str() << "Initializer;\n"
+    "\n"
+    "#endif\n";  
+}
+
+// Generates the file with the implementation of the class.  All
+// methods except the actual object creation functions are generated
+// here.
+void
+cmVTKMakeInstantiatorCommand
+::OldGenerateImplementationFile(std::ostream& os)
+{
+  // Write the ClassInitialize method to register all the creation functions.
+  os <<
+    "#include \"" << m_ClassName.c_str() << ".h\"\n"
+    "\n"
+    "void " << m_ClassName.c_str() << "::ClassInitialize()\n"
+    "{\n";
+    
+  for(unsigned int i=0;i < m_Classes.size();++i)
+    {
+    os << "  vtkInstantiator::RegisterInstantiator(\""
+       << m_Classes[i].c_str() << "\", " << m_ClassName.c_str() << "::Create_"
+       << m_Classes[i].c_str() << ");\n";
+    }
+  
+  // Write the ClassFinalize method to unregister all the creation functions.
+  os <<
+    "}\n"
+    "\n"
+    "void " << m_ClassName.c_str() << "::ClassFinalize()\n"
+    "{\n";
+  
+  for(unsigned int i=0;i < m_Classes.size();++i)
+    {
+    os << "  vtkInstantiator::UnRegisterInstantiator(\""
+       << m_Classes[i].c_str() << "\", " << m_ClassName.c_str() << "::Create_"
+       << m_Classes[i].c_str() << ");\n";
+    }
+  
+  // Write the constructor and destructor of the initializer class to
+  // call the ClassInitialize and ClassFinalize methods at the right
+  // time.
+  os <<
+    "}\n"
+    "\n" <<
+    m_ClassName.c_str() << "Initialize::" << m_ClassName.c_str() << "Initialize()\n"
+    "{\n"
+    "  if(++" << m_ClassName.c_str() << "Initialize::Count == 1)\n"
+    "    { " << m_ClassName.c_str() << "::ClassInitialize(); }\n"
+    "}\n"
+    "\n" <<
+    m_ClassName.c_str() << "Initialize::~" << m_ClassName.c_str() << "Initialize()\n"
+    "{\n"
+    "  if(--" << m_ClassName.c_str() << "Initialize::Count == 0)\n"
+    "    { " << m_ClassName.c_str() << "::ClassFinalize(); }\n"
+    "}\n"
+    "\n"
+    "// Number of translation units that include this class's header.\n"
+    "// Purposely not initialized.  Default is static initialization to 0.\n"
+    "unsigned int " << m_ClassName.c_str() << "Initialize::Count;\n";
+}

Source/cmVTKMakeInstantiatorCommand.h

@@ -85,6 +85,12 @@ protected:
   
   void GenerateHeaderFile(std::ostream&);
   void GenerateImplementationFile(std::ostream&);
+  
+  void OldGenerateHeaderFile(std::ostream&);
+  void OldGenerateImplementationFile(std::ostream&);
+  std::string OldGenerateCreationFileName(unsigned int group);
+  void OldGenerateCreationFile(std::ostream&, unsigned int groupStart,
+                               unsigned int groupSize);
 };