#ifndef ELADMINISTRATOR_H
#define ELADMINISTRATOR_H


// ----------------------------------------------------------------------
//
// ELadminstrator.h  provides the singleton class that the framework uses to
//		     control logger behavior including attaching destinations.
//		Includes the methods used by ErrorLog to evoke the logging
//		behavior in the destinations owned by the ELadminstrator.
//
// ----------------------------------------------------------------------
//
// ELadministrator   The singleton logger class.  One does not instantiate
//		     an ELadministrator.  Instead, do
//			ELadministrator * logger = ELadministrator::instance();
//		     to get a pointer to the (unique) ELadministrator.
//
//	Only the framework should use ELadministrator directly.
//	Physicist users get at it indirectly through using an ErrorLog
//	set up in their Module class.
//
// ELadminDestroyer  A class whose sole purpose is the destruction of the
//                   ELadministrator when the program is over.  Right now,
//                   we do not have anything that needs to be done when the
//                   ELadministrator (and thus the error logger) goes away;
//                   but since by not deleting the copies of ELdestination's
//                   that were attached we would be left with an apparent
//                   memory leak, we include a protected destructor which will
//                   clean up.  ELadminDestroyer provides the only way for
//                   this destructor to be called.
//
// ----------------------------------------------------------------------
//
// 7/2/98 mf	Created file.
// 2/29/00 mf	Added method swapContextSupplier for ELrecv to use.
// 4/5/00 mf	Added method swapProcess for same reason:  ELrecv wants to
//		be able to mock up the process and reset it afterward.
// 6/6/00 web	Consolidate ELadministrator/X; adapt to consolidated
//		ELcout/X.
// 6/14/00 web	Declare classes before granting friendship.
// 6/4/01  mf	Grant friedship to ELtsErrorLog
// 3/6/02  mf   Items for recovering handles to attached destinations:
//		the attachedDestinations map, 
//		an additional signature for attach(), 
//		and getELdestControl() method
// 3/17/04 mf	exitThreshold and setExitThreshold
// ----------------------------------------------------------------------


#ifndef ZMENVIRONMENT_H
  #include "ZMutility/ZMenvironment.h"
#endif

#ifndef ELSTRING_H
  #include "ErrorLogger/ELstring.h"
#endif

#ifndef ELDESTCONTROL_H
  #include "ErrorLogger/ELdestControl.h"
#endif

#ifndef ELLIST_H
  #include "ErrorLogger/ELlist.h"
#endif

#ifndef ELADMINISTRATOR_H
  #include "ErrorLogger/ELadministrator.h"
#endif

#ifndef ELSEVERITYLEVEL_H
  #include "ErrorLogger/ELseverityLevel.h"
#endif

#ifndef ERROROBJ_H
  #include "ErrorLogger/ErrorObj.h"
#endif

#ifndef MAP_INCLUDED
  #include "ZMutility/map"
#endif


ZM_BEGIN_NAMESPACE( zmel )      /*  namespace zmel  {  */


// ----------------------------------------------------------------------
// Prerequisite classes:
// ----------------------------------------------------------------------

class ELcontextSupplier;
class ELdestination;
class ELadminDestroyer;
class ErrorLog;
class ELtsErrorLog;
class ELcout;


// ----------------------------------------------------------------------
// ELadministrator:
// ----------------------------------------------------------------------

class ELadministrator  {	// *** Destructable Singleton Pattern ***

  friend class ELadminDestroyer;	// proper ELadministrator cleanup
  friend class ErrorLog;		// ELadministrator user behavior
  friend class ELcout;			// ELcout behavior
  friend class ELtsErrorLog;		// which walks sink list

// *** Error Logger Functionality ***

public:

  // ---  birth via a surrogate:
  //
  static ELadministrator * instance(); 		// *** Singleton Pattern

  // ---  get/set fundamental properties:
  //
  void setProcess( const ELstring & process );
  ELstring swapProcess( const ELstring & process );
  void setContextSupplier( const ELcontextSupplier & supplier );
  const ELcontextSupplier & getContextSupplier() const;
  ELcontextSupplier & swapContextSupplier( ELcontextSupplier & cs );
  void setAbortThreshold( const ELseverityLevel & sev );
  void setExitThreshold ( const ELseverityLevel & sev );

  // ---  furnish/recall destinations:
  //
  ELdestControl attach( const ELdestination & sink );
  ELdestControl attach( const ELdestination & sink, const ELstring & name );
  bool getELdestControl ( const ELstring & name, ELdestControl & theControl );

  // ---  handle severity information:
  //
  ELseverityLevel  checkSeverity();
  int severityCount( const ELseverityLevel & sev ) const;
  int severityCount( const ELseverityLevel & from,
	 	     const ELseverityLevel & to ) const;
  void resetSeverityCount( const ELseverityLevel & sev );
  void resetSeverityCount( const ELseverityLevel & from,
	 	           const ELseverityLevel & to );
  void resetSeverityCount();			// reset all

  // ---  apply the following actions to all attached destinations:
  //
  void setThresholds( const ELseverityLevel & sev );
  void setLimits    ( const ELstring        & id,  int limit );
  void setLimits    ( const ELseverityLevel & sev, int limit );
  void setTimespans ( const ELstring        & id,  int seconds );
  void setTimespans ( const ELseverityLevel & sev, int seconds );
  void wipe();

protected:
  // ---  member data accessors:
  //
  const ELstring        & process() const;
  ELcontextSupplier     & context() const;
  const ELseverityLevel & abortThreshold() const;
  const ELseverityLevel &  exitThreshold() const;
  ELlist_dest           & sinks();
  const ELseverityLevel & highSeverity() const;
  int                     severityCounts( int lev ) const;

  // ---  actions on messages:
  //
  void finishMsg();
  void clearMsg();

protected:
  // ---  traditional birth/death, but disallowed to users:
  //
  ELadministrator();
  virtual ~ELadministrator();

private:
  // ---  reach the actual (single) ELadministrator's instantiation
  // ---  (the instance() method records the ELadminDestroyer object):
  //
  static ELadministrator * instance_;

  // ---  traditional member data:
  //
  ELstring            process_;
  ELcontextSupplier * context_;
  ELseverityLevel     abortThreshold_;
  ELseverityLevel      exitThreshold_;
  ELlist_dest         sinks_;		// e.g., list<ELdestination *>
  ELseverityLevel     highSeverity_;
  int                 severityCounts_[ ELseverityLevel::nLevels ];
  ErrorObj            msg;
  bool                msgIsActive;

  std::map < ELstring, ELdestination* > attachedDestinations;

  int                 xxxxInt;          // Testing purposes only

public:
  // ---  Maintenance and testing methods, not for user invocation:
  //
  void xxxxSet( int i );// Testing purposes only - not for users to invoke
  void xxxxShout();     // Testing purposes only - not for users to invoke

};  // ELadministrator


// ----------------------------------------------------------------------
// ELadminDestroyer:
// ----------------------------------------------------------------------

class ELadminDestroyer  {

public:
  // ---  birth/death:
  //
  ELadminDestroyer( ELadministrator * ad = 0 );
 ~ELadminDestroyer();

  // ---  record our (single) self:
  //
  void setELadmin( ELadministrator * ad );

private:
  // ---  member data:
  //
  ELadministrator * admin_;	// keep track of our (single) self

};  // ELadminDestroyer


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


ZM_END_NAMESPACE( zmel )        /*  }  // namespace zmel  */


#endif  // ELADMINISTRATOR_H