DataContext.hpp

Go to the documentation of this file.

/*
 * ------------------------------------------------------------------------------------------------------------
 * SPDX-License-Identifier: LGPL-2.1-only
 *
 * Copyright (c) 2016-2024 Lawrence Livermore National Security LLC
 * Copyright (c) 2018-2024 TotalEnergies
 * Copyright (c) 2018-2024 The Board of Trustees of the Leland Stanford Junior University
 * Copyright (c) 2023-2024 Chevron
 * Copyright (c) 2019-     GEOS/GEOSX Contributors
 * All rights reserved
 *
 * See top level LICENSE, COPYRIGHT, CONTRIBUTORS, NOTICE, and ACKNOWLEDGEMENTS files for details.
 * ------------------------------------------------------------------------------------------------------------
 */
 
#ifndef GEOS_DATAREPOSITORY_DATACONTEXT_HPP_
#define GEOS_DATAREPOSITORY_DATACONTEXT_HPP_
 
#include "common/DataTypes.hpp"
#include "common/logger/Logger.hpp"
#include "xmlWrapper.hpp"
#include "common/format/Format.hpp"
#include "common/logger/ErrorHandling.hpp"
 
namespace geos
{
namespace dataRepository
{
 
 
class DataContext
{
public:
 
  DataContext( string_view targetName );
 
  virtual ~DataContext() {}
 
  virtual string toString() const = 0;
 
  virtual ErrorLogger::ErrorContext getContextInfo() const = 0;
 
  explicit operator ErrorLogger::ErrorContext() const {
    return getContextInfo();
  }
 
  string getTargetName() const
  { return m_targetName; }
  friend std::ostream & operator<<( std::ostream & os, const DataContext & ctx );
 
protected:
  // GroupContext & WrapperContext are friend class to be able to access to the protected method on other instances.
  friend class GroupContext;
  friend class WrapperContext;
 
  string const m_targetName;
 
  struct ToStringInfo
  {
    string m_targetName;
    string m_filePath;
    size_t m_line = xmlWrapper::xmlDocument::npos;
 
    ToStringInfo( string_view targetName, string_view filePath, size_t line );
    ToStringInfo( string_view targetName );
    bool hasInputFileInfo() const
    { return !m_filePath.empty() && m_line != xmlWrapper::xmlDocument::npos; }
  };
 
  virtual ToStringInfo getToStringInfo() const = 0;
 
};
 
class DataFileContext final : public DataContext
{
public:
 
  DataFileContext( xmlWrapper::xmlNode const & targetNode, xmlWrapper::xmlNodePos const & nodePos );
  DataFileContext( xmlWrapper::xmlNode const & targetNode, xmlWrapper::xmlAttribute const & att,
                   xmlWrapper::xmlAttributePos const & attPos );
 
  DataFileContext( string_view targetName, string_view file, size_t line );
 
  string toString() const override;
 
  ErrorLogger::ErrorContext getContextInfo() const override;
 
  string getTypeName() const
  { return m_typeName; }
 
  string getFilePath() const
  { return m_filePath; }
 
  size_t getLine() const
  { return m_line; }
 
  size_t getOffsetInLine() const
  { return m_offsetInLine; }
 
  size_t getOffset() const
  { return m_offset; }
 
private:
 
  string const m_typeName;
  string const m_filePath;
  size_t const m_line;
  size_t const m_offsetInLine;
  size_t const m_offset;
 
  ToStringInfo getToStringInfo() const override;
 
};
 
 
} /* namespace dataRepository */
} /* namespace geos */
 
 
 
template<>
struct GEOS_FMT_NS::formatter< geos::dataRepository::DataContext > : GEOS_FMT_NS::formatter< std::string >
{
  auto format( geos::dataRepository::DataContext const & dataContext, format_context & ctx ) const
  {
    return GEOS_FMT_NS::formatter< std::string >::format( dataContext.toString(), ctx );
  }
};
 
#endif /* GEOS_DATAREPOSITORY_DATACONTEXT_HPP_ */