UIDListInternal.h

//========================================================================================
// 
// $File$
// 
// Owner: Robin_Briggs 
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
//========================================================================================

#ifndef __UIDLISTINTERNAL__
#define __UIDLISTINTERNAL__

class IDataBase;
class SortedUIDList;

const int32 kUIDDefaultChunkSize = 8;

class UIDListInternal
{
 friend class SortedUIDList;
 friend class UIDList;
 
#if defined(DEBUG) && defined(MACINTOSH)

 friend void GetUIDListDescriptionHelper(void* uidListInternalArg, char* buffer, uint32 bufferSize);

#endif

private:
 UIDListInternal(IDataBase *db) :fRefCount(1), fArray(), fDB(db)
 { fArray.reserve(kUIDDefaultChunkSize); }

 UIDListInternal(const UIDListInternal& copy) :fRefCount(1), fArray(copy.fArray), fDB(copy.fDB)
 {;}
 UIDListInternal(IDataBase *db, const UID singleEntry) : fRefCount(1), fArray(), fDB(db)
 { fArray.push_back(singleEntry); ;}
 UIDListInternal(const IPMUnknown *obj) : fRefCount(1), fArray(), fDB(::GetDataBase(obj))
 { fArray.push_back(::GetUID(obj)); ;}
 UIDListInternal(const UIDRef& obj) : fRefCount(1), fArray(), fDB(obj.GetDataBase())
 { fArray.push_back(obj.GetUID()); ;} 
public:
 void AddRef() { fRefCount++; }

 void Release();

 ~UIDListInternal() 
 {;}

private:
 // Types
 typedef K2Vector<UID> UIDArray;
 typedef UIDArray::value_type value_type;
 typedef UIDArray::size_type size_type;
 typedef UIDArray::const_reference const_reference;
 typedef UIDArray::reference reference;
 typedef UIDArray::difference_type difference_type;
 typedef UIDArray::pointer pointer;
 typedef UIDArray::const_pointer const_pointer;
 
 UIDListInternal& operator=(const UIDListInternal& other)
 { fArray = other.fArray; fDB = other.fDB; return *this; }
 bool16 operator==(const UIDListInternal& other) const
 { return fArray == other.fArray; }
 bool16 operator!=(const UIDListInternal& other) const
 { return fArray != other.fArray; }
 
 const_reference operator[](int32 i) const
 { return fArray[i]; }

 reference operator[](int32 i)
 { return (fArray[i]); }

 void SetChunkSize(int32 chunk)
 { fArray.reserve(chunk); }

 bool16 Preallocate(int32 newlen)
 { fArray.reserve(newlen); return kTrue; }

 void Clear()
 { fArray.clear(); }

 void Insert(const UID t)
 { fArray.insert(fArray.begin(),t); }

 void Insert(const UID t, int32 before)
 { fArray.insert(fArray.begin() + before, t); }

 void Insert(const UIDListInternal& list, int32 before);

 void Append(const UID t)
 { fArray.push_back(t); }

 void Append(const UID t, int32 after)
 { fArray.insert(fArray.begin() + after + 1, t); }

 void Append(const UIDListInternal& list);

 void Remove(int32 at)
 { fArray.erase(fArray.begin() + at); }

 void Replace(int32 at, const UID t)
 { fArray[at] = t; }
 
 int32 ChunkSize() const
 { return 8; } //AW_TODO: Possibly deprecate this?

 int32 Length() const
 { return fArray.size(); }

 bool16 IsEmpty() const
 { return fArray.empty(); }

 const_reference First() const
 { return fArray.front(); }

 reference First()
 { return fArray.front(); }

 const_reference Last() const
 { return fArray.back(); }

 reference Last()
 { return fArray.back(); }

 int32 Location(UID t) const
 { 
 UIDArray::const_iterator iter = K2find(fArray, t); 
 return (iter != fArray.end() ? iter - fArray.begin() : -1);
 }
 
 IDataBase *GetDataBase() const { return fDB; }
 
 UIDRef GetRef(int32 at) const
 { return UIDRef(fDB, fArray[at]); }

 int32 GetReferenceCount() { return fRefCount;}

 // Data
 int32 fRefCount;
 UIDArray fArray;
 IDataBase *fDB;
}; 

#if defined(DEBUG) && defined(MACINTOSH)
void GetUIDListDescriptionHelper(void* uidListInternalArg, char* buffer, uint32 bufferSize);
#endif

#endif // __UIDLISTINTERNAL__