AttributeBossList.h

//========================================================================================
// 
// $File$
// 
// Owner: Eric_Menninga
// 
// $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 __AttributeBossList__
#define __AttributeBossList__

#include "K2Vector.h"
#include "KeyValuePair.h"
#include "K2SmartPtr.h"

class IPMUnknown;
class IObjectModel;
class IPMStream;
class IClassInfo;
class IAttrBossReferencing;

 // sorted list by ClassID
 // each value has a pointer to the boss, and whether the boss can be 
 // copied to other AttributeBossLists (is it "missing").
typedef KeyValuePair<ClassID, std::pair<IPMUnknown*, bool16> > BossInfo;
typedef K2Vector<BossInfo > BossLookup;



class AttributeBossList
{
 public:
 typedef object_type data_type;
 AttributeBossList();
 AttributeBossList(const AttributeBossList& copy);
 ~AttributeBossList();

 AttributeBossList& operator=(const AttributeBossList& other);

 enum ReadWriteStatus { kSuccess, kListChangedOnRead };
 ReadWriteStatus ReadWrite(IPMStream* stream);
 
 AttributeBossList(AttributeBossList&& copy) noexcept
#ifdef DEBUG
 :fMirror(nil)
#endif
 {
 swap(*this, copy);
 }
 
 AttributeBossList &operator =(AttributeBossList&& copy) noexcept
 {
 swap(*this, copy);
 
 return *this;
 }
 
 friend inline void swap(AttributeBossList &a, AttributeBossList &b) noexcept
 {
 using std::swap;
 swap(a.fBosses, b.fBosses);
#ifdef DEBUG
 swap(a.fMirror, b.fMirror);
#endif
#ifdef INTERFACEPROXIES_SUPPORTED
 swap(a.fTokens, b.fTokens);
#endif
 }
 
 int32 CountBosses() const;

 ClassID GetClassN(int32 n) const;
 
 const IPMUnknown* QueryBossN(int32 n, PMIID id) const;

 const IPMUnknown* QueryByClassID(ClassID c, PMIID id) const;

 void ApplyAttribute(const IPMUnknown *newone, const ClassID attrClass = kInvalidClass);

 void ApplyAttributes(const AttributeBossList *list);

 void ClearOverride(ClassID id);

 void ClearOverrides(const AttributeBossList *list);

 void ClearNonStyleOverrides();

 void ClearAllOverrides();
 
 AttributeBossList* Duplicate() const;

 AttributeBossList* CopyTheseAttributes(const AttributeBossList *filter) const;
 
 bool16 ContainsAttribute(ClassID klas) const;

 bool16 ContainsExact(IDataBase *db, const IPMUnknown *check, ClassID klas = kInvalidClass) const; 

 bool16 IsEqual(IDataBase *db, const AttributeBossList* other) const; 

 bool16 Intersects(const AttributeBossList* other) const; 

 bool16 IntersectionContainsDifferences(IDataBase * db, const AttributeBossList * other) const;

 static uint32 ConvertAttributeList(IPMStream *inStream, IPMStream *outStream, ImplementationID context);

 static uint32 CopyAttributeList(IPMStream *inStream, IPMStream *outStream);

#ifdef DEBUG
 static bool16 ts_DebugAttributeBossList;

 bool16 CheckAttributeBossList() const;
 inline bool16 IsChecking() const { return fMirror != nil; }
 
 private:
 AttributeBossList *fMirror;
#endif

 protected:
 ReadWriteStatus DoWrite(IPMStream* stream);
 ReadWriteStatus DoRead(IPMStream* stream);

 void CopyInto(AttributeBossList *) const; 

 bool16 AllowCopy(ClassID attrClass, IPMUnknown *boss) const;
 
#ifdef DEBUG
 void _ReferenceAttribute(ClassID cls, IPMUnknown *attr);
 void _DereferenceAttribute(ClassID cls, IPMUnknown *attr);
#endif

 private:
 BossLookup fBosses;
#ifdef INTERFACEPROXIES_SUPPORTED
 BossLookup fTokens;
#endif

private:
 void StripMissingAttributes();

 bool16 operator==(const AttributeBossList& other) const;
 bool16 operator!=(const AttributeBossList& other) const;

public:
 static boost::shared_ptr<AttributeBossList> kNil_shared_ptr;
};

/* IDAttributeList class is used to also associate a data base with attribute boss list */
class IDAttributeList {
public:
 typedef object_type data_type;

 IDAttributeList() : fAttributeList(nil), fDB(nil) {}

 IDAttributeList(const AttributeBossList * attrList, IDataBase * db) : fAttributeList(attrList), fDB(db) {}

 const AttributeBossList * GetAttributeList() const { return fAttributeList; }
 IDataBase * GetDataBase() const { return fDB; }

private:
 IDataBase * fDB;
 const AttributeBossList * fAttributeList;
};


#endif
 // __AttributeBossList__