ISelectionMessages.h

//========================================================================================
// 
// $File$
// 
// Owner: Michael Martz
// 
// $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.
// 
// 
// Note: This is not intended as an interface header. These are abstract C++ classes
// which are used to communicate information from subjects to observers within the
// selection architecture.
// 
//========================================================================================

#ifndef _ISelectionMessages_
#define _ISelectionMessages_

//________________________________________________________________________________________________
// INCLUDES
//________________________________________________________________________________________________
 //.......Interface headers....................................................................
 #include "IPMUnknown.h" // for the definition of 

 //.......Other headers........................................................................
 #include "K2SmartPtr.h"
 #include "K2Vector.h"
 #include "KeyValuePair.h"
 #include "TableTypes.h"
//________________________________________________________________________________________________
// CLASS FORWARDS
//________________________________________________________________________________________________
 class ISubject;
 class SelectionSuiteData;
 class UIDList;
 class ITableModel;
 class XMLReference;
 class XMLAttributeReference;
 namespace InDesign { class TextRange;}
 class RangeData;
 class ITextSelectionSuite;
//________________________________________________________________________________________________
// TYPEDEFS
//________________________________________________________________________________________________
 typedef K2Vector<KeyValuePair<PMIID, boost::shared_ptr<SelectionSuiteData> > > SuiteBroadcastData; // sorted

 namespace Selection 
 {
 enum Action { kReplace, kAddTo, kRemoveFrom, kSetKeyObject };
 enum ScrollChoice { kDontScrollSelection, kScrollIntoView};
 enum LayoutScrollChoice { kDontScrollLayoutSelection, kScrollIntoViewIfNecessary, kAlwaysCenterInView };
 }


//________________________________________________________________________________________________
// COMPILER DIRECTIVES
//________________________________________________________________________________________________
 #ifdef PUBLIC_BUILD
#endif // PUBLIC_BUILD
//================================================================================================
//________________________________________________________________________________________________
// CLASS DECLARATIONS
//________________________________________________________________________________________________ 
class IInternalSelectionMessage
 {
 //____________________________________________________________________________________________
 // Data Types
 //____________________________________________________________________________________________
 public:
 enum SelectionMessageType { kClientMessage, kASB_SuiteMessage, kSelectionChanged, kCSB_NeedsNotify };

 public:
 virtual ~IInternalSelectionMessage (void) {}
 virtual SelectionMessageType GetMessageType (void) const = 0;

 virtual PMIID GetASB_SuiteIID (void) const = 0;

 virtual void* GetMessage (void) const = 0;
 
 virtual ClassID GetCSB_ClassID (void) const = 0;

 };

class SelectionSuiteData
 {
 public:
 typedef object_type data_type;
 virtual ~SelectionSuiteData (void);
 };
class ISelectionMessage
 {
 //____________________________________________________________________________________________
 // Data Types
 //____________________________________________________________________________________________
 public:
 virtual ~ISelectionMessage (void) {}
 /* 
 ISelectionMessage had no explicit destructor, so the compiler created an empty **non-virtual** destructor for it.
 The derived class SelectionMessage had a virtual destructor that deleted it's member suiteBroadcastData. This set up a nasty bug. 
 If a SelectionMessage was deleted through a ISelectionMessage pointer the empty non-virtual destructor was called and the suiteBroadcastData 
 was not freed. Sadly downstream code relied on it *not* being deleted. 
 
 Apple's clang compiler warns about deleting an object with a non virtual destructor, so I tried to fix the compiler warning by giving ISelectionMessage 
 a virtual destructor, but then we started crashing in downstream code since the suiteBroadcastData was now being deleted.
 
 As far as I could tell, the SelectionMessage destructor was *never* called. In our codebase SelectionMessage instances are always allocated via operator new, are held
 via an ISelectionMessage pointer and are deleted through that pointer. 
 Allocation ony happens in SelectionManager.cpp, CConcreteSelection.cpp, and Default_CSB.cpp.
 
 As a result. I could work around this problem by declaring that SelectionMessage only holds a reference to the member suiteBroadcastData, rather than owning it.
 Then I could add the missing virtual destructor to ISelectionMessage, make an empty destructor for SelectionMessage, and keep the compiler and downstream code happy.
 
 We really shouldnt be passing a naked ptr type for suiteBroadcastData through so many layers of code, with no clear indication (or an incorrect one) of who is responsible for deleting it.
 Allocations like this should be wrapped in a boost::shared_ptr<ISelectionMessage> and then passed as a shared_ptr rather than passing the raw pointer. 
 Practically though even fixing this one case is hard to retrofit into something as big as InDesign, and well beyond the scope of my clang compiler warnings task.
 
 In fact none of the abstract message classes in this file had declared virtual destructors, so I added one to each of them.
 Thankfully this was the only one where a derived instance was being deleted through a pointer to the abstract baseclass.
 
 --djb 6/17/2012
 */
 
 enum SelectionMessageType { kSelectionChanged, kSelectionAttributeChanged, kSelectionChanged_Frequent};

 public:
 virtual SelectionMessageType GetMessageType (void) const = 0;

 virtual bool16 WasSuiteAffected (const PMIID&) const = 0;

 virtual SelectionSuiteData* GetSuiteBroadcastData (const PMIID&) const = 0;

 virtual SuiteBroadcastData* GetSuiteBroadcastDataList (void) = 0;
 };

class ISelectionHighlightMessage
 {
 public:
 virtual ~ISelectionHighlightMessage (void) {}
 virtual ClassID GetCSB (void) const = 0;

 virtual void* GetMessage (void) const = 0;
 };

class ILayoutSelectionHighlightMessage
 {
 public:
 virtual ~ILayoutSelectionHighlightMessage (void) {}
 virtual UIDList GetItemsToRemove (void) const = 0;

 virtual UIDList GetItemsToAdd (void) const = 0;

 virtual bool16 IsPathSelection (void) const = 0;

 virtual Selection::LayoutScrollChoice GetAutoScroll (void) const = 0;
 };


class ISpreadSelectionHighlightMessage
 {//SpreadSelectionSuite
 public:
 enum SpreadSelectionMessageType { kSelectionChanged, kKeyObjectChanged };
 
 public:
 virtual ~ISpreadSelectionHighlightMessage (void) {}
 virtual UIDList GetItemsToRemove (void) const = 0;

 virtual UIDList GetItemsToAdd (void) const = 0;

 virtual Selection::LayoutScrollChoice GetAutoScroll (void) const = 0;
 
 
 virtual SpreadSelectionMessageType GetMessageType(void) const = 0;
 };
 
 
class SelectionExtension
 {
 public:
 SelectionExtension() : fLeftExtension(kInvalidUID), fRightExtension(kInvalidUID) { }
 SelectionExtension (UID leftExtension, UID rightExtension) { SetExtension (leftExtension, rightExtension); }
 
 
 inline void SetExtension (UID leftExtension, UID rightExtension) { fLeftExtension = leftExtension; fRightExtension = rightExtension; }
 
 inline UID GetLeftExtension () const { return fLeftExtension; }
 inline UID GetRightExtension () const { return fRightExtension; }
 
 private:
 UID fLeftExtension;
 UID fRightExtension;
 }; 

class ITextSelectionHighlightMessage
 {
 public:
 virtual ~ITextSelectionHighlightMessage (void) {}
 virtual InDesign::TextRange GetOldRange (void) const = 0;

 virtual InDesign::TextRange GetNewRange (void) const = 0;


 enum ScrollChoice { kDontScrollSelection, kScrollIntoView};
 virtual ScrollChoice GetAutoScroll( RangeData* ) const = 0;

 virtual ITextSelectionSuite* GetSelection(void) const = 0;
 
 virtual SelectionExtension GetOldSelectionExtension() const = 0;
 virtual SelectionExtension GeNewSelectionExtension() const = 0;
 };
 
class ITableSelectionHighlightMessage
 {
 public:
 virtual ~ITableSelectionHighlightMessage (void) {}
 virtual const ITableModel* GetPrevTableModel (void) const = 0;
 virtual const GridArea GetPrevSelectedCells (void) const = 0;

 virtual const ITableModel* GetNewTableModel (void) const = 0;
 virtual const GridArea GetNewSelectedCells (void) const = 0;
 };

class IXMLSelectionHighlightMessage
 {
 public:
 virtual ~IXMLSelectionHighlightMessage (void) {}
 virtual const K2Vector<XMLReference>* GetElementsToAdd (void) const = 0;
 virtual const K2Vector<XMLReference>* GetElementsToRemove (void) const = 0;

 virtual const K2Vector<XMLAttributeReference>* GetAttributesToAdd (void) const = 0;
 virtual const K2Vector<XMLAttributeReference>* GetAttributesToRemove (void) const = 0;

 };

class ISelectionChangedISuiteMessage
 {
 //____________________________________________________________________________________________
 // Data Types
 //____________________________________________________________________________________________
 public:
 enum MessageType { kActiveCSBsChangedMessage };

 public:
 virtual ~ISelectionChangedISuiteMessage (void) {}
 virtual MessageType GetMessageType (void) const = 0;

 virtual const K2Vector<KeyValuePair<ClassID, bool16> >* GetEnabledCSBs (void) const = 0;

 virtual const K2Vector<PMIID>* GetEnabledSuiteInterfaces (void) const = 0;
 };


#endif // _ISelectionMessages_