// $Header: /cvs/gled-1.2/GledCore/Glasses/ZList.h,v 1.16 2005/04/08 11:20:13 matevz Exp $

// Copyright (C) 1999-2005, 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_ZList_H
#define GledCore_ZList_H

#include <Glasses/ZGlass.h>

class ZList;
typedef void (*zlist_stampadd_f)(ZList*, ZGlass*, ZGlass*, void*);
typedef void (*zlist_stampremove_f)(ZList*, ZGlass*, void*);
typedef void (*zlist_stamprebuild_f)(ZList*, void*);
typedef void (*zlist_stampclear_f)(ZList*, void*);

class ZList : public ZGlass {

  // **** Custom Streamer ****
  MAC_RNR_FRIENDS(ZList);

  friend class Saturn;
  friend class ZQueen;

private:
  lID_t		mIDs;	                       //! Temporary store for Streaming
  void	       _init();

protected:
  UInt_t		mSize;
  lpZGlass_t		mGlasses;

  LID_t			mLid;			// X{GS} 7 Value(-join=>1)
  CID_t			mCid;			// X{GS} 7 Value()

  GMutex	 	mListMutex;	   	//!
  zlist_stampadd_f	mStampListAdd_CB;    	//! called if non-null
  void*			mStampListAdd_CBarg; 	//!
  zlist_stampremove_f	mStampListRemove_CB;    //! called if non-null
  void*			mStampListRemove_CBarg; //!
  zlist_stamprebuild_f	mStampListRebuild_CB;    //! called if non-null
  void*			mStampListRebuild_CBarg; //!
  zlist_stampclear_f	mStampListClear_CB;      //! called if non-null
  void*			mStampListClear_CBarg;   //!

  virtual void reference_all();
  virtual void unreference_all();

  virtual void clear_list();

  virtual Int_t remove_references_to(ZGlass* lens);

  virtual void new_element_check(ZGlass* g);

public:
  ZList(const Text_t* n="ZList", const Text_t* t=0) :
    ZGlass(n,t), mListMutex(GMutex::recursive) { _init(); }
  virtual ~ZList() {}

  void BeginIteration(lpZGlass_i& beg, lpZGlass_i& end)
  { mListMutex.Lock(); beg = mGlasses.begin(); end = mGlasses.end(); }
  void EndIteration()
  { mListMutex.Unlock(); }

  virtual TimeStamp_t Copy(lpZGlass_t& dest);
  template <class GLASS>
  TimeStamp_t CopyByGlass(list<GLASS>& dest) {
    GMutexHolder _lstlck(mListMutex);
    for(lpZGlass_i i=mGlasses.begin(); i!=mGlasses.end(); ++i) {
      GLASS g = dynamic_cast<GLASS>(*i);
      if(g) dest.push_back(g);
    }
    return mTimeStamp;
  }

  ZGlass* First();
  ZGlass* Last();
  virtual ZGlass* GetElementByName(const Text_t* name);
  virtual ZGlass* GetElementByName(const string& name);
  template <class GLASS>
  GLASS GetElementByGlass() {
    GLASS g;
    mListMutex.Lock();
    for(lpZGlass_i i=mGlasses.begin(); i!=mGlasses.end(); ++i) {
      g = dynamic_cast<GLASS>(*i);
      if(g) { mListMutex.Unlock(); return g; }
    }
    mListMutex.Unlock();
    return 0;
  }

  ZList* AssertPath(const Text_t* path,
                    const Text_t* new_el_type="ZList"); // X{Ed}
  void Swallow(ZGlass* entry, Bool_t replace_p=true,
	       const Text_t* path="",
	       const Text_t* new_el_type="ZList");
  void Swallow(const Text_t* path, ZGlass* entry);

  void         SetElementFID(FID_t fid);
  virtual void Add(ZGlass* g);			     // X{E} C{1}
  virtual void AddBefore(ZGlass* g, ZGlass* before); // X{E} C{2}
  virtual void AddFirst(ZGlass* g);		     // X{E} C{1}
  virtual void Remove(ZGlass* g);		     // X{E} C{1}
  virtual void RemoveLast(ZGlass* g);		     // X{E} C{1}

  void         ClearList();                   	     // X{E}
  virtual void ClearAllReferences();

  void         RemoveLensesViaQueen(Bool_t recurse=false); // X{Ed}

  virtual Int_t  Size() { return mSize; }
  virtual Bool_t IsEmpty() { return mSize==0; }
  virtual Bool_t Has(ZGlass* g);

  virtual void   SortByName();                       // X{ED} 7 MButt()

  virtual TimeStamp_t	StampListAdd(ZGlass* g, ZGlass* b4);
  virtual TimeStamp_t	StampListRemove(ZGlass* g);
  virtual TimeStamp_t	StampListRebuild();
  virtual TimeStamp_t	StampListClear();

  void SetStampListAdd_CB(zlist_stampadd_f foo, void* arg);
  void SetStampListRemove_CB(zlist_stampremove_f foo, void* arg);
  void SetStampListRebuild_CB(zlist_stamprebuild_f foo, void* arg);
  void SetStampListClear_CB(zlist_stampclear_f foo, void* arg);

  virtual Int_t RebuildAllRefs(An_ID_Demangler* idd);
  virtual Int_t RebuildListRefs(An_ID_Demangler* idd);

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

GlassIODef(ZList);

#endif