IFocusCache.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.
// 
// 
// This is an interface that assumes that it has access to an ITextFocus
// interface. It's purpose is to cache every value for every text attribute
// and style that is in the range described by the ITextFocus.
// The cache, once built, is time stamped so that the system can tell
// if the cache has changed.
// 
//========================================================================================

#ifndef __IFocusCache__
#define __IFocusCache__


#include "IPMUnknown.h"
#include "IPMFont.h"
#include "TextID.h"
#include "TextAttrID.h"

class PMString;
class AttributeBossList;
class ITextModel;
class IAttrReport;

//--------------------------------------------------

struct PMFontData
{
 typedef object_type data_type;
 PMFontData() : fNumAxes(0), fIncorrectFace(0), fFamilyUID(kInvalidUID), fAxes(nil)
 {}
 ~PMFontData(){
 if(fAxes)
 delete [] fAxes;
 fAxes = nil;
 }

 int operator==(const PMFontData& other) const
 { if (fName != other.fName || fNumAxes != other.fNumAxes)
 return kFalse;
 else
 return (std::memcmp(fAxes, other.fAxes, fNumAxes * sizeof(Fixed)) == 0);
 }

 PMString fName;
 PMString fFaceName;
 UID fFamilyUID;
 Fixed *fAxes;
 int16 fNumAxes;
 bool16 fIncorrectFace;
};


class IFocusCache : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_IFOCUSCACHE };

 //-------------------------------------------------------------------------------------
 virtual int32 CountParagraphStyles() const = 0;
 virtual int32 CountCharacterStyles() const = 0;
 virtual int32 CountCharacterStylesFromRunIns() const = 0;

 virtual UID GetNthParagraphStyle(int32 n) const = 0;
 virtual UID GetNthCharacterStyle(int32 n) const = 0;
 virtual UID GetNthCharacterStyleFromRunIn(int32 n) const = 0;

 virtual bool16 IsStyleOverridden(UID style) const = 0;

 //-------------------------------------------------------------------------------------
 virtual int32 CountSelectedRuns() const = 0;

 virtual int32 CountAttributes(const ClassID& attr) const = 0;

 virtual const IPMUnknown* QueryAttributeN(int32 which, const ClassID& attr, const PMIID& interfaceID) const = 0;

 //-------------------------------------------------------------------------------------
 virtual int32 CountFonts(ClassID fontUIDBoss = kTextAttrFontUIDBoss) const = 0;

 virtual UID GetNthFamilyUIDAndFace(int32 nthFont, PMString *faceName, ClassID fontUIDBoss = kTextAttrFontUIDBoss) const = 0;

 virtual const PMString& GetNthFont(int32 nthFont, bool16 *incorrectFace = nil, ClassID fontUIDBoss = kTextAttrFontUIDBoss) const = 0;

 virtual const Fixed* GetNthMMAxes(int32 nthFont, int32 *numaxes) const = 0;

 virtual bool16 GetOverrideList(K2Vector<PMString>& overrideStrings, bool16 getForParaStyle) const = 0;


 //-------------------------------------------------------------------------------------
 virtual void InvalidateCache() = 0;
 virtual void ResetCache_NoNotify() = 0;
 virtual void Inserted(TextIndex where, int32 howmuch) = 0;
 virtual void Deleted(TextIndex where, int32 howmuch) = 0;
 virtual void FocusWasMoved(const ITextModel * model, TextIndex start, TextIndex end, bool16 excludeCacheEnd = kTrue) = 0;

 virtual bool16 CacheAlreadyBuilt() const = 0;
 virtual uint32 GetTimeStamp() const = 0;

 virtual void CopyToAttributeLists(AttributeBossList *attrList, AttributeBossList *mixedList = nil) const = 0;

 virtual bool16 IsRubyApplied() const = 0;
};

#endif
 // __IFocusCache__