// $Id: ZQueen.h 2486 2011-06-25 04:07:48Z matevz $

// Copyright (C) 1999-2008, Matevz Tadel. All rights reserved.
// This file is part of GLED, released under GNU General Public License version 2.
// For the licensing terms see $GLEDSYS/LICENSE or http://www.gnu.org/.

#ifndef GledCore_ZQueen_H
#define GledCore_ZQueen_H

#include <Glasses/ZNameMap.h>
#include <Gled/GTime.h>

class ZKing; class ZQueen;
class ZHashList;
class SaturnInfo; class EyeInfo; class Ray; class EyeInfoVector;
class ZComet;

class ZQueen : public ZNameMap,
	       public An_ID_Demangler,
	       public MIR_Priest
{
  MAC_RNR_FRIENDS(ZQueen);

  friend class ZKing;
  friend class Saturn;

public:
  //enum Contents_e { QC_Static = 0, QT_Dynamic = 1 };

  enum AuthMode_e { AM_None=0, AM_Queen, AM_Lens,
		    AM_QueenThenLens, AM_LensThenQueen };
  enum Align_e    { A_Good=0, A_Evil };

  enum QueenState_e { QS_Sleeping, QS_Awakening,
		      QS_Dreaming, QS_Nightmare,
		      QS_AwaitingSceptre, QS_Ruling,
		      QS_RelinquishingSceptre };

  enum ZeroRCPolicy_e { ZRCP_Delete, ZRCP_ToOrphanage, ZRCP_Ignore };

  enum LensState_e    { LS_Undef, LS_Alive, LS_Purged, LS_Dead };

  struct LensDetails
  {
    ZGlass*	mLens;
    LensState_e mState;
    GTime	mCreationTime;
    GTime	mDeletionTime;

    LensDetails(ZGlass* l, LensState_e ls=LS_Alive) :
      mLens(l), mState(ls), mCreationTime(GTime::I_Now) {}
  };

private:
  void _init();

protected:

  ZKing*	mKing;		  //! X{g}

  Bool_t	bMandatory;	  //  X{gS} 7 Bool(-join=>1)
  Bool_t	bFollowDeps;	  //  X{gS} 7 Bool() Used by fire-space queens

  Bool_t	bRuling;	  //! X{gS} 7 BoolOut(-join=>1)
  Bool_t	bAwaitingSceptre; //! X{gS} 7 BoolOut()
  QueenState_e	mState;	          //! X{gS} 7 PhonyEnum(-const=>1, -width=>12)

  ID_t		mMinID;		// X{g} 7 ValOut(-range=>[0,MAX_ID], -width=>8, -join=>1)
  ID_t		mMaxID;		// X{g} 7 ValOut(-range=>[0,MAX_ID], -width=>8)
  ID_t		mIDSpan;	// X{g} 7 ValOut(-join=>1)
  ID_t		mIDsUsed;	// X{g} 7 ValOut()
  ID_t		mIDsPurged;	// X{g} 7 ValOut(-join=>1)
  ID_t		mIDsFree;	// X{g} 7 ValOut()

  typedef map<ID_t, LensDetails*>		QueenIDMap_t;
  typedef map<ID_t, LensDetails*>::iterator	QueenIDMap_i;

  QueenIDMap_t  mIDMap;		//!

  ID_t		mCreationID;	//  Creation point ID
  lID_t		mPurgatory;	//  List of released but still reserved ids
  lpZGlass_t	mZombies;	//! Lenses that are dead but still need to be deleted.

  UShort_t	mAvgPurgLen;	// X{gS} 7 Value(-range=>[1,65000,1], -width=>5, -join=>1)
  Float_t	mSgmPurgLen;	// X{gS} 7 Value(-range=>[0,1,1,100], -width=>5)
  UInt_t	mPurgedMS;	// X{gS} 7 Value(-range=>[100,1e6,10], -width=>7, -join=>1)
  UInt_t	mDeletedMS;	// X{gS} 7 Value(-range=>[100,1e6,10], -width=>7)

  ZeroRCPolicy_e mZeroRCPolicy; // X{gS} 7 PhonyEnum()

  Bool_t	bStamping;	// X{GS} 7 Bool(-join=>1)
  Bool_t	bStampIdOps;	// X{GS} 7 Bool()

  UChar_t	mAuthMode;      // X{gS} 7 PhonyEnum(-type=>AuthMode_e, -width=>12)
  UChar_t	mAlignment;     // X{gS} 7 PhonyEnum(-type=>Align_e)
  UChar_t	mMapNoneTo;     // X{gS} 7 PhonyEnum(-type=>ZMirFilter::Result_e,
                                //                   -names=>[R_Allow,R_Deny])

  ZLink<ZMirFilter>	mProtector;     // X{gS} L{}

  ZLink<ZHashList>	mDeps;          // X{gS} L{}
  ZLink<ZHashList>	mOrphans;       // X{gS} L{}

  typedef list<SaturnInfo*>           lpSaturnInfo_t;
  typedef list<SaturnInfo*>::iterator lpSaturnInfo_i;

  lpSaturnInfo_t  mReflectors;	//!
  EyeInfoVector  *mObservers;   //!

  // Mutexen
  GMutex mSubjectWriteMutex;    //!
  GMutex mSubjectRefCntMutex;   //!
  GMutex mRayMutex;             //!

  virtual void bootstrap();
  virtual void embrace_of_life(ZComet& comet);

  bool                 has_free_ids(ID_t n_needed);
  ID_t                 next_free_id(QueenIDMap_i i);
  ID_t                 assign_id(ZGlass* lens);
  virtual LensDetails* produce_lens_details(ID_t id, ZGlass* lens);
  void                 release_purgatory(ID_t n_needed);
  void                 release_moon_purgatory(ID_t n_to_release); // X{E}
  int		       release_zombies();

  virtual ZGlass* instantiate(FID_t fid,
		    const Text_t* name=0, const Text_t* title=0); // X{E}

  // reflector handling; called by Saturn
  void add_reflector(SaturnInfo* moon);
  void remove_reflector(SaturnInfo* moon);

  void put_lens_to_purgatory(ZGlass* lens);
  void remove_lens(ZGlass* lens);
  void remove_lenses(AList* list, Bool_t recurse, Bool_t syncmode);

public:
  ZQueen(const Text_t* n="ZQueen", const Text_t* t=0);
  ZQueen(ID_t span, const Text_t* n="ZQueen", const Text_t* t=0);
  virtual ~ZQueen();

  // Subject Write/RefCnt locks.
  void SubjectWriteLock()    { mSubjectWriteMutex.Lock(); }
  void SubjectWriteUnlock()  { mSubjectWriteMutex.Unlock(); }
  void SubjectRefCntLock()   { mSubjectRefCntMutex.Lock(); }
  void SubjectRefCntUnlock() { mSubjectRefCntMutex.Unlock(); }

  // ID & Lens management
  virtual ZGlass* DemangleID(ID_t id);
  ID_t CheckIn(ZGlass* lens);

  // MIR blessing
  virtual void BlessMIR(ZMIR& mir);
  virtual void DepCheckMIR(ZMIR& mir);

  // Instantiation methods
  ID_t InstantiateWAttach(LID_t new_lid, CID_t new_cid,
			  const Text_t* name=0, const Text_t* title=0
			  ); // X{E} T{ZQueen::Instantiate}

  ID_t IncarnateWAttach();   // X{E} T{ZQueen::Instantiate}

  // instantiate URL

  // Lens mir-activity
  void MIRActivateLens(ZGlass* lens);                   // X{E}  C{1}
  void MIRDeactivateLens(ZGlass* lens);                 // X{E}  C{1}

  // Lens deletion
 protected:
  void PutLensToPurgatory(ZGlass* lens);                // X{E}  C{1}
  void PutListElementsToPurgatory(AList* list);         // X{E}  C{1}
  void PutLensToVoid(ID_t lens_id);                     // X{E}
 public:
  void RemoveLens(ZGlass* lens);                        // X{E}  C{1}
  void RemoveLenses(AList* list, Bool_t recurse=false); // X{Ed} C{1}

  // ZeroRefCount and management of Orphans
  void ZeroRefCount(ZGlass* lens);
  void CleanOrphanage();           // X{E} 7 MButt()

  // Mandatory queens are pushed to all lower Saturns
  // being processed ...
  // void SetMandatory(Bool_t mandp);

  // Dependencies
  void AddDependency(ZQueen* new_dep);  // X{E} C{1}
  //void RemoveDependency(ZQueen* dep); // X{E} C{1}
  Bool_t DependsOn(ZQueen* some_queen);

  // Reflections ... operated by Kings
  virtual void CreateReflection(TBuffer& buf);
  virtual void InvokeReflection(TBuffer& buf);
  virtual void RevokeReflection();

  // Comet operations
  ZComet* MakeComet();
  void AdoptComet(AList* top_dest, AList* orphan_dest, ZComet* comet); // X{E} C{2}
  virtual void UnfoldFrom(ZComet& comet);

  // Maintenance of non-ruling queen reflections
  void BroadcastMIRToNonRulingReflections(ZMIR& mir);
  void BasicQueenChange(ZMIR& mir);

  // lens stamping
  void AddObserver(EyeInfo* ei);
  void RemoveObserver(EyeInfo* ei);
  void EmitRay(auto_ptr<Ray>& ray);
  void PrintEyeConnections();                        //! X{E} 7 MButt(-join=>1)
  void PrintObservedLenses(Bool_t dump_views=false); //! X{E} 7 MCWButt()

  // tmp
  void ListAll(); //! X{E} 7 MButt()

#include "ZQueen.h7"
  ClassDef(ZQueen, 1);
}; // endclass ZQueen


// Attempt at server exec + broadcast
#ifndef __CINT__
#define CALL_AND_BROADCAST(_lens_, _method_, ...) \
  _lens_->_method_(__VA_ARGS__); \
  { auto_ptr<ZMIR> _mir_(_lens_->S_##_method_(__VA_ARGS__)); \
    mSaturn->markup_posted_mir(*_mir_); \
    mSaturn->BroadcastMIR(*_mir_, mReflectors); }
#endif

#endif