BDSGDMLPreprocessor.cc

/* 
Beam Delivery Simulation (BDSIM) Copyright (C) BDSIM Collaboration, 2001 - 2026.
 
This file is part of BDSIM.
 
BDSIM is free software: you can redistribute it and/or modify 
it under the terms of the GNU General Public License as published 
by the Free Software Foundation version 3 of the License.
 
BDSIM is distributed in the hope that it will be useful, but 
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
 
You should have received a copy of the GNU General Public License
along with BDSIM.  If not, see <http://www.gnu.org/licenses/>.
*/
#ifdef USE_GDML
#include "BDSDebug.hh"
#include "BDSException.hh"
#include "BDSGDMLPreprocessor.hh"
#include "BDSTemporaryFiles.hh"
#include "BDSUtilities.hh"
 
#include <xercesc/dom/DOM.hpp>
#include <xercesc/framework/LocalFileFormatTarget.hpp>
#include <xercesc/framework/StdOutFormatTarget.hpp>
#include <xercesc/parsers/XercesDOMParser.hpp>
#include <xercesc/sax/HandlerBase.hpp>
#include <xercesc/util/PlatformUtils.hpp>
#include <xercesc/util/XMLString.hpp>
 
#include "globals.hh"
#include "G4String.hh"
#include "G4Version.hh"
 
#include <algorithm>
#include <fstream>
#include <istream>
#include <map>
#include <ostream>
#include <sstream>
#include <string>
#include <vector>
#include <regex>
 
using namespace xercesc;
 
G4String BDS::PreprocessGDML(const G4String& file,
                             const G4String& prefix,
                             G4bool          preprocessSchema)
{
  if (BDS::EndsWith(file, ".gmad"))
    {throw BDSException(__METHOD_NAME__, "trying to read a GMAD file (\"" + file + "\") as a GDML file - check file or change extension.");}
  BDSGDMLPreprocessor processor;
  G4String processedFile = processor.PreprocessFile(file,
                                                    prefix,
                                                    preprocessSchema);
  return processedFile;
}
 
G4String BDS::PreprocessGDMLSchemaOnly(const G4String& file)
{
  // open file
  if (BDS::EndsWith(file, ".gmad"))
    {throw BDSException(__METHOD_NAME__, "trying to read a GMAD file (\"" + file + "\") as a GDML file - check file or change extension.");}
  std::ifstream inputFile;
  inputFile.open(file.c_str());
  if (!inputFile.is_open())
    {throw BDSException(__METHOD_NAME__, "Invalid file \"" + file + "\"");}
  else
    {G4cout << __METHOD_NAME__ << "updating GDML Schema to local copy for file:\n \"" << file << "\"" << G4endl;}
 
  // create new temporary file that modified gdml can be written to.
  G4String newFile = BDSTemporaryFiles::Instance()->CreateTemporaryFile(file);
 
  std::ofstream outFile;
  outFile.open(newFile);
 
  G4String localSchema = BDS::GDMLSchemaLocation();
  int i = 0;
  std::regex gdmlTag("\\<gdml");
  std::string line;
  while (std::getline(inputFile, line))
    {
      if (i < 10)
        { // expect schema in first 10 lines of file - efficiency
          if (std::regex_search(line, gdmlTag))
            {
              std::regex schema("xsi:noNamespaceSchemaLocation=\"(\\S+)\"");
              std::string newLine;
              std::string prefix = "xsi:noNamespaceSchemaLocation=\"";
              std::regex_replace(std::back_inserter(newLine), line.begin(), line.end(), schema, prefix+localSchema+"\"$2");
              outFile << newLine;
            }
          else
            {outFile << line;}
        }
      else
        {outFile << line;}
      outFile << "\n";
      i++;
    }
  outFile.close();
  return newFile;
}
 
G4String BDS::GDMLSchemaLocation()
{
  G4String result;
  G4String bdsimExecPath = BDS::GetBDSIMExecPath();
  G4String localPath = bdsimExecPath + "src-external/gdml/schema/gdml.xsd";
  G4String installPath = bdsimExecPath + "../share/bdsim/gdml/schema/gdml.xsd";
  if (FILE *file = fopen(localPath.c_str(), "r"))
    {
      fclose(file);
      return localPath;
    }
  else if ( (file = fopen(installPath.c_str(), "r")) )
    {
      fclose(file);
      return installPath;
    }
  else
    {
      G4String bdsimLibraryPath = BDS::GetBDSIMLibraryPath();
      G4String libraryInstallPath = bdsimLibraryPath + "../share/bdsim/gdml/schema/gdml.xsd";
      if ( (file = fopen(libraryInstallPath.c_str(), "r")) )
        {
          fclose(file);
          return libraryInstallPath;
        }
      else
        {throw BDSException(__METHOD_NAME__, "ERROR: local GDML schema could not be found!");}
    }
}
 
BDSGDMLPreprocessor::BDSGDMLPreprocessor()
{
  //ignoreNodes = {"setup"};
  ignoreAttrs = {"formula"};
}
 
BDSGDMLPreprocessor::~BDSGDMLPreprocessor()
{;}
 
G4String BDSGDMLPreprocessor::PreprocessFile(const G4String& file,
                                             const G4String& prefix,
                                             G4bool preprocessSchema)
{
  G4cout << __METHOD_NAME__ << "Preprocessing GDML file " << file << G4endl;
  
  try
    {XMLPlatformUtils::Initialize();}
  catch (const XMLException& toCatch)
    {
      char* message = XMLString::transcode(toCatch.getMessage());
      std::stringstream messageSS;
      messageSS << "Error during initialization! :\n" << message << "\n";
      XMLString::release(&message);
      throw BDSException(__METHOD_NAME__, messageSS.str());
    }
 
  G4String filename;
  BDS::SplitPathAndFileName(file, parentDir, filename);
  
  XercesDOMParser* parser = new XercesDOMParser();
  parser->setValidationScheme(XercesDOMParser::Val_Always);
  parser->setDoNamespaces(true);    // optional
 
  ErrorHandler* errHandler = (ErrorHandler*) new HandlerBase();
  parser->setErrorHandler(errHandler);
 
  try
    {parser->parse(file.c_str());}
  catch (const XMLException& toCatch)
    {
      char* message = XMLString::transcode(toCatch.getMessage());
      std::stringstream messageSS;
      messageSS << "Exception message is: \n" << message << "\n";
      XMLString::release(&message);
      throw BDSException(__METHOD_NAME__, messageSS.str());
    }
  catch (const DOMException& toCatch)
    {
      char* message = XMLString::transcode(toCatch.msg);
      std::stringstream messageSS;
      messageSS << "Exception message is: \n" << message << "\n";
      XMLString::release(&message);
      throw BDSException(__METHOD_NAME__, messageSS.str());
    }
  catch (...)
    {throw BDSException(__METHOD_NAME__, "Unexpected Exception - possibly malformed GDML file: " + filename);}
  
  // walk through all nodes to extract names and attributes
  DOMDocument* doc           = parser->getDocument();
  DOMElement* docRootNode    = doc->getDocumentElement();
  DOMNodeIterator* docWalker = doc->createNodeIterator(docRootNode, DOMNodeFilter::SHOW_ELEMENT,nullptr,true);
  // map structure and all names used
  ReadDoc(docWalker, preprocessSchema);
 
  // reset iterator
  docWalker->detach();
  docWalker = doc->createNodeIterator(docRootNode, DOMNodeFilter::SHOW_ELEMENT,nullptr,true);
  
  // rewrite all names in loaded structure.
  ProcessDoc(docWalker, prefix);
 
  // create new temporary file that modified gdml can be written to.
  G4String newFile = BDSTemporaryFiles::Instance()->CreateTemporaryFile(file, prefix);
  
  // write file from DOM
  DOMImplementation* pImplement        = DOMImplementationRegistry::getDOMImplementation(XMLString::transcode("LS"));
  DOMLSSerializer*   pSerializer       = (static_cast<DOMImplementationLS*>(pImplement))->createLSSerializer();
  DOMConfiguration*  pDomConfiguration = pSerializer->getDomConfig();
  pDomConfiguration->setParameter(XMLUni::fgDOMWRTFormatPrettyPrint, true);
  XMLFormatTarget*   pTarget           = new LocalFileFormatTarget(newFile);
  DOMLSOutput*       pDomLsOutput      = (static_cast<DOMImplementationLS*>(pImplement))->createLSOutput();
  pDomLsOutput->setByteStream(pTarget);  
  pSerializer->write(doc, pDomLsOutput);
  pSerializer->release();
 
  G4cout << __METHOD_NAME__ << "Preprocessing complete" << G4endl;
 
  delete pTarget;
  delete parser;
  delete errHandler;
 
  return newFile;
}
 
void BDSGDMLPreprocessor::ReadDoc(DOMNodeIterator* docIterator,
                                  G4bool processSchema)
{
  for (DOMNode* currentNode = docIterator->nextNode(); currentNode != 0; currentNode = docIterator->nextNode())
    {ReadNode(currentNode, processSchema);}
}
 
void BDSGDMLPreprocessor::ReadNode(DOMNode* node,
                                   G4bool processSchema)
{
  if (!node)
    {return;}
 
  std::string thisNodeName = XMLString::transcode(node->getNodeName());
  if (thisNodeName == "gdml" && processSchema)
    {// to update location of schema
      ProcessGDMLNode(node->getAttributes());
      return;
    }
  auto search = std::find(ignoreNodes.begin(), ignoreNodes.end(), thisNodeName);
  if (search != ignoreNodes.end())
    {return;} // ignore this node
  else
    {ReadAttributes(node->getAttributes());}
}
 
void BDSGDMLPreprocessor::ProcessGDMLNode(DOMNamedNodeMap* attributeMap)
{
  if (!attributeMap)
  {return;}
 
  for (XMLSize_t i = 0; i < attributeMap->getLength(); i++)
    {
      DOMNode* attr = attributeMap->item(i);
      std::string nodeName = XMLString::transcode(attr->getNodeName());
      if (nodeName == "xsi:noNamespaceSchemaLocation")
        {
          G4String nodeValue = G4String(XMLString::transcode(attr->getNodeValue()));
          G4String newNodeValue;
          if (nodeValue.substr(0,2) == "./")
            {
              G4String remainder = nodeValue.substr(2); // strip off ./
#if G4VERSION_NUMBER > 1099
        newNodeValue = parentDir + remainder;
#else
              newNodeValue = remainder.prepend(parentDir); // prepend parent directory
#endif
            }
          else
            {newNodeValue = BDS::GDMLSchemaLocation();}
          attr->setNodeValue(XMLString::transcode(newNodeValue.c_str()));
        } 
    }
}
 
void BDSGDMLPreprocessor::ReadAttributes(DOMNamedNodeMap* attributeMap)
{
  if (!attributeMap)
    {return;}
  
  for (XMLSize_t i = 0; i < attributeMap->getLength(); i++)
    {
      DOMNode* attr = attributeMap->item(i);
      std::string name = XMLString::transcode(attr->getNodeValue());
      auto search = std::find(ignoreAttrs.begin(), ignoreAttrs.end(), name);
      if (search != ignoreAttrs.end())
        {continue;} // ignore this attribute
      if (XMLString::compareIString(attr->getNodeName(), XMLString::transcode("name")) == 0)
        {
          names.push_back(name);
          count[name] = 0;
        }
    }
}
 
void BDSGDMLPreprocessor::ProcessDoc(DOMNodeIterator* docIterator,
                                     const G4String&  prefix)
{
  for (DOMNode* currentNode = docIterator->nextNode(); currentNode != 0; currentNode = docIterator->nextNode())
    {ProcessNode(currentNode, prefix);}
}
 
void BDSGDMLPreprocessor::ProcessNode(DOMNode*        node,
                                      const G4String& prefix)
{
  if (!node)
    {return;}
 
  std::string thisNodeName = XMLString::transcode(node->getNodeName());
  auto search = std::find(ignoreNodes.begin(), ignoreNodes.end(), thisNodeName);
  if (search != ignoreNodes.end())
    {return;} // ignore this node
  else if (thisNodeName == "property")
    {
      ProcessAttributes(node->getAttributes(), prefix, true);
    }
  else
    {ProcessAttributes(node->getAttributes(), prefix);}
}
 
G4String BDSGDMLPreprocessor::ProcessedNodeName(const G4String& nodeName,
                                                const G4String& prefix)
{return prefix + "_" + nodeName;}
 
void BDSGDMLPreprocessor::ProcessAttributes(DOMNamedNodeMap* attributeMap,
                                            const G4String&  prefix,
                                            bool             property)
{
  if (!attributeMap)
    {return;}
 
  for (XMLSize_t i = 0; i < attributeMap->getLength(); i++)
    {
      DOMNode* attr = attributeMap->item(i);
      std::string name = XMLString::transcode(attr->getNodeValue());
 
      auto search = std::find(ignoreAttrs.begin(), ignoreAttrs.end(), name);
      if (search != ignoreAttrs.end())
        {continue;} // ignore this attribute
 
      // the property names should be not appended as Geant4 is expecting RINDEX etc,
      // not prefix_RINDEX
      if (XMLString::compareIString(attr->getNodeName(),
                                    XMLString::transcode("name")) == 0 && property)
        {continue;}
 
      if (XMLString::compareIString(attr->getNodeName(),
                                    XMLString::transcode("name")) == 0)
        {
          std::string newName = ProcessedNodeName(name, prefix);
          attr->setNodeValue(XMLString::transcode(newName.c_str()));
        }
      else
        {
          std::string expression = XMLString::transcode(attr->getNodeValue());
          // Iterate over all the names that have been defined.
          for (const auto& defined_name : names)
            {
              // Check if whole name is found (don't match substrings).
              // \\b = word boundary.  $& = the matched string.
              std::regex whole_name(std::string("\\b") + defined_name + "\\b");
              expression = std::regex_replace(expression, whole_name, prefix + "_$&");
            }
          attr->setNodeValue(XMLString::transcode((expression).c_str()));
        }
    }
}
 
#else
// insert empty function to avoid no symbols warning
void _SymbolToPreventWarningGDML(){;}
#endif