ItemPrinter.h

// -*- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature -*-
//-----------------------------------------------------------------------------
// Copyright 2000-2026 CEA (www.cea.fr) IFPEN (www.ifpenergiesnouvelles.com)
// See the top-level COPYRIGHT file for details.
// SPDX-License-Identifier: Apache-2.0
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* ItemPrinter.h                                               (C) 2000-2025 */
/*                                                                           */
/* Routines for printing an entity.                                          */
/*---------------------------------------------------------------------------*/
#ifndef ARCANE_CORE_ITEMPRINTER_H
#define ARCANE_CORE_ITEMPRINTER_H
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arcane/utils/Iostream.h"
 
#include "arcane/core/ArcaneTypes.h"
#include "arcane/core/Item.h"
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
/*!
 * \brief Utility class for printing information about an entity.
 */
class ARCANE_CORE_EXPORT ItemPrinter
{
 public:
 
  ItemPrinter(ItemInternal* item, eItemKind ik)
  : m_item(item)
  , m_item_kind(ik)
  , m_has_item_kind(true)
  {}
  ItemPrinter(ItemInternal* item)
  : m_item(item)
  , m_item_kind(IK_Unknown)
  , m_has_item_kind(false)
  {}
  ItemPrinter(const Item& item)
  : m_item(item.itemBase())
  , m_item_kind(IK_Unknown)
  , m_has_item_kind(false)
  {}
  ItemPrinter(const Item& item, eItemKind ik)
  : m_item(item.itemBase())
  , m_item_kind(ik)
  , m_has_item_kind(true)
  {}
  ItemPrinter(const Node& item)
  : m_item(item.itemBase())
  , m_item_kind(IK_Node)
  , m_has_item_kind(true)
  {}
  ItemPrinter(const Edge& item)
  : m_item(item.itemBase())
  , m_item_kind(IK_Edge)
  , m_has_item_kind(true)
  {}
  ItemPrinter(const Face& item)
  : m_item(item.itemBase())
  , m_item_kind(IK_Face)
  , m_has_item_kind(true)
  {}
  ItemPrinter(const Cell& item)
  : m_item(item.itemBase())
  , m_item_kind(IK_Cell)
  , m_has_item_kind(true)
  {}
  ItemPrinter(const Particle& item)
  : m_item(item.itemBase())
  , m_item_kind(IK_Particle)
  , m_has_item_kind(true)
  {}
 
 public:
 
  //! Write to stream of the current Item
  void print(std::ostream& o) const;
 
 public:
 
  impl::ItemBase m_item;
  eItemKind m_item_kind;
  bool m_has_item_kind;
 
 public:
 
  struct Internal;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
class ARCANE_CORE_EXPORT FullItemPrinter
{
 public:
 
  explicit FullItemPrinter(const Item& item)
  : m_item(item.itemBase())
  {}
 
  //! Write to stream of the current Item and its sub-items
  void print(std::ostream& o) const;
 
 private:
 
  impl::ItemBase m_item;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
class ARCANE_CORE_EXPORT NeighborItemPrinter
{
 public:
 
  explicit NeighborItemPrinter(Item item, const Integer levelmax = 1)
  : m_item(item.itemBase())
  , m_level_max(levelmax)
  {}
 
  //! Write to stream of the current Item and its sub-items
  void print(std::ostream& o) const { print(o, m_item, m_level_max, m_level_max); }
 
 private:
 
  impl::ItemBase m_item;
  Integer m_level_max;
 
 private:
 
  static std::ostream& indent(std::ostream& o, Integer n);
  static void print(std::ostream& o, Item item, Integer level, Integer levelmax);
  static void _printSubItems(std::ostream& ostr, Integer level, Integer levelmax,
                             ItemVectorView sub_items, const char* name);
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
inline std::ostream&
operator<<(std::ostream& o, const ItemPrinter& ip)
{
  ip.print(o);
  return o;
}
 
inline std::ostream&
operator<<(std::ostream& o, const FullItemPrinter& ip)
{
  ip.print(o);
  return o;
}
 
inline std::ostream&
operator<<(std::ostream& o, const NeighborItemPrinter& ip)
{
  ip.print(o);
  return o;
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // namespace Arcane
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#endif