Add Group & Wrapper source XML line in errors

src/coreComponents/common/DataTypes.hpp

@@ -61,6 +61,7 @@
 #include <unordered_map>
 #include <vector>
 #include <set>
+#include <string_view>
 
 /**
  * top level geosx namespace contains all code that is specific to GEOSX
@@ -129,6 +130,9 @@ using globalIndex = GEOSX_GLOBALINDEX_TYPE;
 /// String type.
 using string      = std::string;
 
+/// String type.
+using string_view = std::string_view;
+
 /// 32-bit floating point type.
 using real32 = float;
 /// 64-bit floating point type.

src/coreComponents/common/Logger.hpp

@@ -479,9 +479,9 @@ struct InputError : public std::runtime_error
   {}
 
   /**
-   * @brief Construct an InputError from an underlying exception.
-   * @param subException An exception to base this new one on.
-   * @param msgToInsert The error message. It will be inserted into the one inside of subException.
+   * @brief Constructs an InputError from an underlying exception.
+   * @param subException The exception on which the created one is based.
+   * @param msgToInsert The error message that will be inserted in the subException error message.
    */
   InputError( std::exception const & subException, std::string const & msgToInsert );
 };

src/coreComponents/constitutive/unitTests/testDruckerPrager.cpp

@@ -72,17 +72,16 @@ void testDruckerPragerDriver()
                                                                   "</Constitutive>";
 
   xmlWrapper::xmlDocument xmlDocument;
-  xmlWrapper::xmlResult xmlResult = xmlDocument.load_buffer( inputStream.c_str(),
-                                                             inputStream.size() );
+  xmlWrapper::xmlResult xmlResult = xmlDocument.loadString( inputStream );
   if( !xmlResult )
   {
     GEOS_LOG_RANK_0( "XML parsed with errors!" );
     GEOS_LOG_RANK_0( "Error description: " << xmlResult.description());
     GEOS_LOG_RANK_0( "Error offset: " << xmlResult.offset );
   }
 
-  xmlWrapper::xmlNode xmlConstitutiveNode = xmlDocument.child( "Constitutive" );
-  constitutiveManager.processInputFileRecursive( xmlConstitutiveNode );
+  xmlWrapper::xmlNode xmlConstitutiveNode = xmlDocument.getChild( "Constitutive" );
+  constitutiveManager.processInputFileRecursive( xmlDocument, xmlConstitutiveNode );
   constitutiveManager.postProcessInputRecursive();
 
   localIndex constexpr numElem = 2;
@@ -189,17 +188,16 @@ void testDruckerPragerExtendedDriver()
                                 "</Constitutive>";
 
   xmlWrapper::xmlDocument xmlDocument;
-  xmlWrapper::xmlResult xmlResult = xmlDocument.load_buffer( inputStream.c_str(),
-                                                             inputStream.size() );
+  xmlWrapper::xmlResult xmlResult = xmlDocument.loadString( inputStream );
   if( !xmlResult )
   {
     GEOS_LOG_RANK_0( "XML parsed with errors!" );
     GEOS_LOG_RANK_0( "Error description: " << xmlResult.description());
     GEOS_LOG_RANK_0( "Error offset: " << xmlResult.offset );
   }
 
-  xmlWrapper::xmlNode xmlConstitutiveNode = xmlDocument.child( "Constitutive" );
-  constitutiveManager.processInputFileRecursive( xmlConstitutiveNode );
+  xmlWrapper::xmlNode xmlConstitutiveNode = xmlDocument.getChild( "Constitutive" );
+  constitutiveManager.processInputFileRecursive( xmlDocument, xmlConstitutiveNode );
   constitutiveManager.postProcessInputRecursive();
 
   localIndex constexpr numElem = 2;

src/coreComponents/constitutive/unitTests/testElasticIsotropic.cpp

@@ -71,16 +71,16 @@ TEST( ElasticIsotropicTests, testStateUpdatePoint )
                                                                                                                  "</Constitutive>";
 
   xmlWrapper::xmlDocument xmlDocument;
-  xmlWrapper::xmlResult xmlResult = xmlDocument.load_buffer( inputStream.c_str(), inputStream.size() );
+  xmlWrapper::xmlResult xmlResult = xmlDocument.loadString( inputStream );
   if( !xmlResult )
   {
     GEOS_LOG_RANK_0( "XML parsed with errors!" );
     GEOS_LOG_RANK_0( "Error description: " << xmlResult.description());
     GEOS_LOG_RANK_0( "Error offset: " << xmlResult.offset );
   }
 
-  xmlWrapper::xmlNode xmlConstitutiveNode = xmlDocument.child( "Constitutive" );
-  constitutiveManager.processInputFileRecursive( xmlConstitutiveNode );
+  xmlWrapper::xmlNode xmlConstitutiveNode = xmlDocument.getChild( "Constitutive" );
+  constitutiveManager.processInputFileRecursive( xmlDocument, xmlConstitutiveNode );
   constitutiveManager.postProcessInputRecursive();
 
   dataRepository::Group disc( "discretization", &rootGroup );

src/coreComponents/constitutive/unitTests/testModifiedCamClay.cpp

@@ -86,17 +86,16 @@ void testModifiedCamClayDriver()
     "</Constitutive>";
 
   xmlWrapper::xmlDocument xmlDocument;
-  xmlWrapper::xmlResult xmlResult = xmlDocument.load_buffer( inputStream.c_str(),
-                                                             inputStream.size() );
+  xmlWrapper::xmlResult xmlResult = xmlDocument.loadString( inputStream );
   if( !xmlResult )
   {
     GEOS_LOG_RANK_0( "XML parsed with errors!" );
     GEOS_LOG_RANK_0( "Error description: " << xmlResult.description());
     GEOS_LOG_RANK_0( "Error offset: " << xmlResult.offset );
   }
 
-  xmlWrapper::xmlNode xmlConstitutiveNode = xmlDocument.child( "Constitutive" );
-  constitutiveManager.processInputFileRecursive( xmlConstitutiveNode );
+  xmlWrapper::xmlNode xmlConstitutiveNode = xmlDocument.getChild( "Constitutive" );
+  constitutiveManager.processInputFileRecursive( xmlDocument, xmlConstitutiveNode );
   constitutiveManager.postProcessInputRecursive();
 
   localIndex constexpr numElem = 2;

src/coreComponents/dataRepository/CMakeLists.txt

@@ -22,7 +22,10 @@ set( dataRepository_headers
      WrapperBase.hpp
      wrapperHelpers.hpp
      xmlWrapper.hpp
-   )
+     DataContext.hpp
+     GroupContext.hpp
+     WrapperContext.hpp
+     )
 
 #
 # Specify all sources
@@ -35,7 +38,10 @@ set( dataRepository_sources
      Utilities.cpp
      WrapperBase.cpp
      xmlWrapper.cpp
-   )
+     DataContext.cpp
+     GroupContext.cpp
+     WrapperContext.cpp
+     )
 
 set( dependencyList ${parallelDeps} codingUtilities pugixml )
 
@@ -56,11 +62,11 @@ blt_add_library( NAME       dataRepository
                  HEADERS    ${dataRepository_headers}
                  DEPENDS_ON ${dependencyList}
                  OBJECT     ${GEOSX_BUILD_OBJ_LIBS}
-               )
+                 )
 
 target_include_directories( dataRepository PUBLIC ${CMAKE_SOURCE_DIR}/coreComponents )
 
-geosx_add_code_checks(PREFIX dataRepository )
+geosx_add_code_checks( PREFIX dataRepository )
 
 
 if( GEOS_ENABLE_TESTS )

src/coreComponents/dataRepository/DataContext.cpp

@@ -0,0 +1,107 @@
+/*
+ * ------------------------------------------------------------------------------------------------------------
+ * SPDX-License-Identifier: LGPL-2.1-only
+ *
+ * Copyright (c) 2018-2020 Lawrence Livermore National Security LLC
+ * Copyright (c) 2018-2020 The Board of Trustees of the Leland Stanford Junior University
+ * Copyright (c) 2018-2020 TotalEnergies
+ * Copyright (c) 2019-     GEOSX Contributors
+ * All rights reserved
+ *
+ * See top level LICENSE, COPYRIGHT, CONTRIBUTORS, NOTICE, and ACKNOWLEDGEMENTS files for details.
+ * ------------------------------------------------------------------------------------------------------------
+ */
+
+/**
+ * @file DataContext.cpp
+ */
+
+#include "DataContext.hpp"
+
+namespace geos
+{
+namespace dataRepository
+{
+
+
+DataContext::DataContext( string const & targetName ):
+  m_targetName( targetName )
+{}
+
+std::ostream & operator<<( std::ostream & os, DataContext const & ctx )
+{
+  os << ctx.toString();
+  return os;
+}
+
+DataContext::ToStringInfo::ToStringInfo( string const & targetName, string const & filePath, size_t line ):
+  m_targetName( targetName ),
+  m_filePath( filePath ),
+  m_line( line )
+{}
+DataContext::ToStringInfo::ToStringInfo( string const & targetName ):
+  m_targetName( targetName )
+{}
+
+
+/**
+ * @return the node 'name' attribute if it exists, return the node tag name otherwise.
+ * @param node the target node.
+ */
+string getNodeName( xmlWrapper::xmlNode const & node )
+{
+  xmlWrapper::xmlAttribute const nameAtt = node.attribute( "name" );
+  if( !nameAtt.empty() )
+  {
+    return string( node.attribute( "name" ).value() );
+  }
+  else
+  {
+    return string( node.name() );
+  }
+}
+
+DataFileContext::DataFileContext( xmlWrapper::xmlNode const & targetNode,
+                                  xmlWrapper::xmlNodePos const & nodePos ):
+  DataContext( getNodeName( targetNode ) ),
+  m_typeName( targetNode.name() ),
+  m_filePath( nodePos.filePath ),
+  m_line( nodePos.line ),
+  m_offsetInLine( nodePos.offsetInLine ),
+  m_offset( nodePos.offset )
+{}
+
+DataFileContext::DataFileContext( xmlWrapper::xmlNode const & targetNode,
+                                  xmlWrapper::xmlAttribute const & att,
+                                  xmlWrapper::xmlAttributePos const & attPos ):
+  DataContext( getNodeName( targetNode ) + '/' + att.name() ),
+  m_typeName( att.name() ),
+  m_filePath( attPos.filePath ),
+  m_line( attPos.line ),
+  m_offsetInLine( attPos.offsetInLine ),
+  m_offset( attPos.offset )
+{}
+
+string DataFileContext::toString() const
+{
+  if( m_line != xmlWrapper::xmlDocument::npos )
+  {
+    return GEOS_FMT( "{} ({}, l.{})", m_targetName, splitPath( m_filePath ).second, m_line );
+  }
+  else if( m_offset != xmlWrapper::xmlDocument::npos )
+  {
+    return GEOS_FMT( "{} ({}, offset {})", m_targetName, splitPath( m_filePath ).second, m_offset );
+  }
+  else
+  {
+    return GEOS_FMT( "{} (Source file not found)", m_targetName );
+  }
+}
+
+DataContext::ToStringInfo DataFileContext::getToStringInfo() const
+{ return ToStringInfo( m_targetName, m_filePath, m_line ); }
+
+
+
+} /* namespace dataRepository */
+} /* namespace geos */