// @HEADER
// *****************************************************************************
//        MueLu: A package for multigrid based preconditioning
//
// Copyright 2012 NTESS and the MueLu contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER

#ifndef MUELU_MONITOR_HPP
#define MUELU_MONITOR_HPP

#include <string>
#include <algorithm>                 // for swap
#include <ostream>                   // for basic_ostream, operator<<, etc
#include "Teuchos_FancyOStream.hpp"  // for OSTab, FancyOStream
#include "Teuchos_RCPDecl.hpp"       // for RCP
#include "Teuchos_RCP.hpp"           // for RCP::RCP<T>, RCP::operator=, etc
#include "Teuchos_Utils.hpp"         // for Utils
#include "MueLu_VerbosityLevel.hpp"  // for MsgType, MsgType::Runtime0, etc
#include "MueLu_BaseClass.hpp"
#include "MueLu_FactoryBase_fwd.hpp"
#include "MueLu_Level.hpp"
#include "MueLu_TimeMonitor.hpp"

namespace MueLu {

struct FormattingHelper {
  //! Helper function for object label
  static std::string getColonLabel(const std::string& label) {
    if (label != "")
      return label + ": ";
    else
      return "";
  }
};

/*! @class PrintMonitor
  Manages indentation of output using Teuchos::OSTab and verbosity level
*/
class PrintMonitor : public BaseClass {
 public:
  //! Constructor
  PrintMonitor(const BaseClass& object, const std::string& msg, MsgType msgLevel = Runtime0);
  ~PrintMonitor();

 private:
  PrintMonitor();

  bool tabbed;
  const BaseClass& object_;
};

/*! @class Monitor
   @brief Timer to be used in non-factories.

   A timer is created only if 'timerLevel' (Timings0 by default) is enabled.
   This class manages verbosity, as well as times this object and all its children over all levels.

   The timer yields output such as
    \verbatim
     MueLu: SaPFactory: Prolongator smoothing (total)             6.508 (6)        6.551 (6)        6.557 (6)        1.092 (6)
    \endverbatim
   Note that the keyword \a total denotes timing of the object and its children.

   @ingroup MueLuTimerClasses
*/
class Monitor : public BaseClass {
 public:
  /*! @brief Constructor.

      @param[in] object      Reference to the class instance that is creating this Monitor.
      @param[in] msg         String that indicates what the Monitor is monitoring, e.g., "Build"
      @param[in] msgLevel    Governs whether information should be printed.
      @param[in] timerLevel  Governs whether timing information should be *gathered*.  Setting this to NoTimeReport prevents the creation of timers.
  */
  Monitor(const BaseClass& object, const std::string& msg, MsgType msgLevel = Runtime0, MsgType timerLevel = Timings0);

  /*! @brief Constructor.

      @param[in] object      Reference to the class instance that is creating this Monitor.
      @param[in] msg         String that indicates what the Monitor is monitoring, e.g., "Build"
      @param[in] msgLevel    Governs whether information should be printed.
      @param[in] timerLevel  Governs whether timing information should be *gathered*.  Setting this to NoTimeReport prevents the creation of timers.
      @param[in] label       An optional prefix label.
  */
  Monitor(const BaseClass& object, const std::string& msg, const std::string& label, MsgType msgLevel = Runtime0, MsgType timerLevel = Timings0);

  virtual ~Monitor() = default;

 private:
  //! Manages printing.
  PrintMonitor printMonitor_;
  //! Records total time spent  in this object and all its children, over all levels.
  TimeMonitor timerMonitor_;
};

//---------------------------------------------------------------------------------------------------

/*! @class SubMonitor
  @brief Timer to be used in non-factories.  Similar to Monitor, but doesn't print object description.

  Should be used in non-factory setting.
  Times object and all its children over all levels.
  A timer is created only if 'timerLevel' (Timings1 by default) is enabled.

  The timer yields output such as
   \verbatim
   MueLu: SaPFactory: Eigenvalue estimate (sub, total)        0.149 (6)        0.1615 (6)       0.1643 (6)       0.02692 (6)
   \endverbatim
   Note that the keyword \a sub denotes that this is output from a SubFactoryMonitor.
   Note that the keyword \a total denotes timing of the object and its children.

   @ingroup MueLuTimerClasses
*/
class SubMonitor : public BaseClass {
 public:
  /*! @brief Constructor.

      @param[in] object      Reference to the class instance that is creating this SubMonitor.
      @param[in] msg         String that indicates what the SubMonitor is monitoring, e.g., "Build"
      @param[in] msgLevel    Governs whether information should be printed.
      @param[in] timerLevel  Governs whether timing information should be *gathered*.  Setting this to NoTimeReport prevents the creation of timers.
  */
  SubMonitor(const BaseClass& object, const std::string& msg, MsgType msgLevel = Runtime1, MsgType timerLevel = Timings1);

  /*! @brief Constructor.

      @param[in] object      Reference to the class instance that is creating this SubMonitor.
      @param[in] msg         String that indicates what the SubMonitor is monitoring, e.g., "Build"
      @param[in] label       An optional prefix label.
      @param[in] msgLevel    Governs whether information should be printed.
      @param[in] timerLevel  Governs whether timing information should be *gathered*.  Setting this to NoTimeReport prevents the creation of timers.
  */
  SubMonitor(const BaseClass& object, const std::string& msg, const std::string& label, MsgType msgLevel = Runtime1, MsgType timerLevel = Timings1);

 private:
  PrintMonitor printMonitor_;
  TimeMonitor timerMonitor_;
};

//---------------------------------------------------------------------------------------------------

/*! @class FactoryMonitor
    @brief Timer to be used in factories.  Similar to Monitor but with additional timers.

   This class provides the following three timers for an object:
   - Timer for this object over all levels, excluding calls to children.
   - Timer for this object per level, excluding calls to children.
   - Timer for this object over all levels, including calls to children.

   The three timers above yield output like the following:
   \verbatim
     MueLu: SaPFactory: Prolongator smoothing                     2.599 (6)        2.602 (6)        2.607 (6)        0.4336 (6)
     MueLu: SaPFactory: Prolongator smoothing (level=5)           0.4731 (1)       0.4735 (1)       0.4736 (1)       0.4735 (1)
     MueLu: SaPFactory: Prolongator smoothing (total)             6.508 (6)        6.551 (6)        6.557 (6)        1.092 (6)
   \endverbatim

   Note that the keyword \a total denotes timing of the object and its children.

   @ingroup MueLuTimerClasses
*/
class FactoryMonitor : public Monitor {
 public:
  static int timerIdentifier_;

  /*! @brief Constructor

      @param[in] object      Reference to the class instance that is creating this SubMonitor.
      @param[in] msg         String that indicates what the SubMonitor is monitoring, e.g., "Build"
      @param[in] levelID     The MueLu Level number.
      @param[in] msgLevel    Governs whether information should be printed.
      @param[in] timerLevel  Governs whether timing information should be *gathered*.  Setting this to NoTimeReport prevents the creation of timers.
  */
  FactoryMonitor(const BaseClass& object, const std::string& msg, int levelID, MsgType msgLevel = static_cast<MsgType>(Test | Runtime0), MsgType timerLevel = Timings0);

  /*! @brief Constructor

      @param[in] object      Reference to the class instance that is creating this SubMonitor.
      @param[in] msg         String that indicates what the SubMonitor is monitoring, e.g., "Build".
      @param[in] level       The MueLu Level object.
      @param[in] msgLevel    Governs whether information should be printed.
      @param[in] timerLevel  Governs whether timing information should be *gathered*.  Setting this to NoTimeReport prevents the creation of timers.

    TODO: code factorization
  */
  FactoryMonitor(const BaseClass& object, const std::string& msg, const Level& level, MsgType msgLevel = static_cast<MsgType>(Test | Runtime0), MsgType timerLevel = Timings0);

 private:
  //! Total time spent on this level in this object and all its children.
  RCP<TimeMonitor> levelTimeMonitor_;
  //! Total time spent on all levels in this object only, excluding all children.
  MutuallyExclusiveTimeMonitor<FactoryBase> timerMonitorExclusive_;
  //! Total time spent on this level in this object only, excluding all children.
  RCP<MutuallyExclusiveTimeMonitor<Level> > levelTimeMonitorExclusive_;
};

//---------------------------------------------------------------------------------------------------

/*! @class SubFactoryMonitor
  @brief Timer to be used in factories.  Similar to SubMonitor but adds a timer level by level.

  Times an object and all its children on a level-by-level basis.

  This timer is useful for timing just a part of a factory; the keyword \a sub denotes that this is output from a SubFactoryMonitor.
  The timer yields output such as
   \verbatim
     MueLu: SaPFactory: Eigenvalue estimate (sub, total, level=4)    0.01999 (1)      0.02103 (1)      0.02121 (1)      0.02103 (1)
   \endverbatim
   Note that the keyword \a total denotes timing of the object and its children.

   @ingroup MueLuTimerClasses
*/
class SubFactoryMonitor : public SubMonitor {
 public:
  /*! @brief Constructor

      @param[in] object      Reference to the class instance that is creating this SubMonitor.
      @param[in] msg         String that indicates what the SubMonitor is monitoring, e.g., "Build"
      @param[in] levelID     The Level number.
      @param[in] msgLevel    Governs whether information should be printed.
      @param[in] timerLevel  Governs whether timing information should be *gathered*.  Setting this to NoTimeReport prevents the creation of timers.
  */
  SubFactoryMonitor(const BaseClass& object, const std::string& msg, int levelID, MsgType msgLevel = Runtime1, MsgType timerLevel = Timings1);

  /*! @brief Constructor

      @param[in] object      Reference to the class instance that is creating this SubMonitor.
      @param[in] msg         String that indicates what the SubMonitor is monitoring, e.g., "Build"
      @param[in] level       The MueLu Level object.
      @param[in] msgLevel    Governs whether information should be printed.
      @param[in] timerLevel  Governs whether timing information should be *gathered*.  Setting this to NoTimeReport prevents the creation of timers.
  */
  SubFactoryMonitor(const BaseClass& object, const std::string& msg, const Level& level, MsgType msgLevel = Runtime1, MsgType timerLevel = Timings1);

 private:
  //! Total time spent on this level in this object and all children.
  RCP<TimeMonitor> levelTimeMonitor_;
};

}  // namespace MueLu

#endif  // MUELU_MONITOR_HPP
