IParagraphComposer.h

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

#include "IPMUnknown.h"
#include "ParcelKey.h"
#include "OwnedItemDataList.h"
#include "CTextEnum.h"
#include "PMRect.h" // for PMRectCollection
#include "PMMatrix.h"
#include "TextID.h"
#include "AttributeBossList.h"

class IDataBase;
class IParcelList;
class ITextParcelList;
class ITextModel;
class IParcel;
class IComposeScanner;
class IWaxLine;
class IWaxIterator;
class IdleTimer;
class ITextOptions;
class IStoryOptions;
class IPairKernDict;
class IEdgeAlignDict;
class IHyphenationExceptions;
class IHyphenationService;
class ILanguage;

class IParagraphComposer : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IPARAGRAPHCOMPOSER };
 enum { kDefaultServiceID = kTextEngineService };

 class Tiler
 {
 protected:
 Tiler();

 private:
 Tiler(const Tiler& copy);
 Tiler& operator=(const Tiler& copy);

 public:
 virtual ~Tiler() { }

 virtual IParcelList* GetParcelList() const = 0;

 virtual ParcelKey GetFirstParcelKey() const = 0;

 virtual ParcelKey GetNextParcelKey(ParcelKey key) const = 0;

 virtual bool16 GetHasAnyValidStartBreakLocation() const = 0;

 virtual bool16 GetParcelIsValidStartBreakLocation(ParcelKey key,
 Text::StartBreakLocation mode) const = 0;

 virtual ParcelKey GetNextParcelKeyByBreak(ParcelKey key,
 Text::StartBreakLocation mode) const = 0;

 virtual ParcelKey GetPreviousParcelKey(ParcelKey key) const = 0;

 //
 // This method will adjust the specified ParcelKeys and YPosition to
 // the top of the desired break location. If the specified key and
 // position is already at the top of the desired break location then
 // they are unchanged. Returns kTrue if the position changed.
 //
 virtual bool16 MoveToTopNextParcelByBreak(Text::StartBreakLocation mode,
 ParcelKey* pKey,
 PMReal* pYPosition) const = 0;

 virtual PMRect GetParcelContentBounds(ParcelKey key) const = 0;

 virtual bool16 GetParcelContentIsAnArea(ParcelKey key) const = 0;

 virtual bool16 GetHasAnyIntrusionsAt(ParcelKey key) const = 0;

 //
 // The Parcel itself can have a grid or the grid can bleed through
 // from the PageGrid. Either way we return the effective vertical
 // spacing of 0.0 if no grid is active.
 //
 virtual PMReal GetParcelEffectiveVerticalSpacing(ParcelKey key) const = 0;

 virtual UID GetParcelFrameUID(ParcelKey key) const = 0;

 virtual PMMatrix GetParcelContentToFrameMatrix(ParcelKey key) const = 0;

 virtual bool16 GetParcelAppearsMultiplePlaces(ParcelKey key) const = 0;

 // Returns
 // kFalse Tile is at top of the Parcel but the specified top of Parcel
 // alignment doesn't match the Parcel's.
 //
 // pParcelKey set the Parcel Key
 // pYOffset set to the top of the Parcel
 // pTOPAlignment set to the Parcel TOP alignment value
 // pAtTOP set to kTrue
 //
 // The caller should simply re-call the method with the same
 // values returned for ParcelIndex and yPosition but specify
 // a TOP alignment compatible with the Parcel.
 //
 // kTrue A tile was found that fits the desired criteria.
 //
 // pParcelKey set to the Parcel Key (invalid if overset)
 // pYOffset set to bottom of the returned tile
 // pTOPAlignment set to the Parcel TOP alignment value
 // pAtTOP set to kTrue if tile is at the top of
 // the Parcel, kFalse otherwise.
 // pParcelPositionDependent set to kTrue if the position of
 // the tile was dependent on the
 // position of the Parcel.
 // Typically indicates that the
 // tile was aligned to a non-
 // Parcel relative grid.
 // pLeftMargin set to the left margin of the Parcel
 // pRightMargin set to the right margin of the Parcel
 // tiles has the returned tile(s)
 //
 virtual bool16 GetTiles(PMReal minWidth,
 PMReal height,
 PMReal TOPHeight,
 Text::GridAlignmentMetric gridAlignment,
 PMReal gridAlignmentAdj,
 Text::LeadingModel leadingModel,
 PMReal leading,
 PMReal leadingModelOffset,
 PMReal minHeightLeadingDiff,
 TextIndex nCurrentPosition,
 bool16 affectedByVerticalJustification,
 ParcelKey *pParcelKey,
 PMReal *pYOffset,
 Text::FirstLineOffsetMetric *pTOPHeightMetric,
 PMRectCollection& tiles,
 bool16 *pAtTOP,
 bool16 *pParcelPositionDependent,
 PMReal *pLeftMargin,
 PMReal *pRightMargin) const = 0;

 virtual PMReal GetParcelGrowableContentBottom(ParcelKey key) const = 0;

 //
 // In the context of the composing paragraph
 //
 // This method will return the Parcel Content Top plus any skipped area
 // due to active TileableTopAdj. Note that Content Top will allready
 // include any EffectiveTopAdj.
 //
 virtual PMReal GetParcelTileableContentTop(ParcelKey key) const = 0;

 //
 // In the context of the composing paragraph
 //
 // This method will return the GrowableContentBottom minus any skipped
 // ranges.
 //
 // Note: This method may only be called during composition and only by
 // composers that have committed to compose their WaxLine in the
 // specified or later Parcel. The internal composition support
 // code will consider this call notification that the composing
 // WaxLine wishes to do so and will resolve pending composing,
 // such as footnotes at the time of this call.
 //
 virtual PMReal GetParcelTileableContentBottom(ParcelKey key) const = 0;

 virtual bool16 GetParcelShouldInvalNewWax(ParcelKey key) const = 0;

 };


 class RecomposeHelper : public Tiler
 {
 protected:
 RecomposeHelper();

 private:
 RecomposeHelper(const RecomposeHelper& copy);
 RecomposeHelper& operator=(const RecomposeHelper& copy);

 public:
 virtual ~RecomposeHelper() { }

 virtual IDataBase* GetDataBase() const = 0;

 virtual IComposeScanner* GetComposeScanner() const = 0;

 virtual TextIndex GetThreadStart() const = 0;

 virtual int32 GetThreadSpan() const = 0;

 virtual TextIndex GetThreadEnd() const = 0;

 virtual TextIndex GetParagraphStart() const = 0;

 virtual int32 GetParagraphSpan() const = 0;

 virtual TextIndex GetParagraphEnd() const = 0;

 virtual const ITextParcelList* GetTextParcelList() const = 0;

 virtual bool16 ShouldFakeTabAlignToChar() const = 0;

 virtual const ITextOptions* GetTextOptions() const = 0;

 virtual const IStoryOptions* GetStoryOptions() const = 0;

 virtual bool16 GetIsVertical() const = 0;

 virtual IPairKernDict* GetPairKernDict(ClassID whichAlgorithm) const = 0;

 virtual IEdgeAlignDict* GetEdgeAlignDict(ClassID whichAlgorithm) const = 0;

 virtual IHyphenationService* GetSimpleHyphenator() const = 0;

 virtual IHyphenationService* GetHyphenator(const ILanguage* pLanguage) const = 0;

 virtual IHyphenationExceptions* GetHyphenationExceptions(bool16 *pCheckUserDictionary) const = 0;

 virtual IdleTimer* GetIdleTimer() const = 0;

 virtual const OwnedItemDataList::const_iterator GetOwnedItemBeginIter() const = 0;

 virtual const OwnedItemDataList::const_iterator GetOwnedItemEndIter() const = 0;

 virtual bool16 GetOwnedItemsHaveStandOffsIn(TextIndex start, TextIndex end) const = 0;

 virtual TextIndex GetStartingTextIndex() const = 0;

 virtual ParcelKey GetStartingParcelKey() const = 0;

 virtual PMReal GetStartingYPosition() const = 0;

 virtual bool16 GetKeptWithPrevByNextNLines() const = 0;

 virtual bool16 GetKeptWithPrevByFirstNLines() const = 0;

 virtual bool16 GetKeptWithPrevByAllLines() const = 0;

 virtual bool16 GetIsContentDamaged() const = 0;

 virtual bool16 GetIsKeepsDamaged() const = 0;

 virtual bool16 GetParagraphCalculatedStateInvalid() const = 0;

 virtual TextIndex GetWaxLineTextIndex() const = 0;

 virtual ParcelKey GetWaxLineParcelKey() const = 0;

 virtual PMReal GetWaxLineCompositionYPosition() const = 0;

 virtual PMReal GetWaxLineLineHeightLeadingDiff() const = 0;

 virtual bool16 GetWaxLineKeepsViolation() const = 0;

 virtual int32 GetWaxLineTextSpan() const = 0;

 virtual const IWaxLine* GetPreviousWaxLine() const = 0;

 virtual TextIndex GetPreviousWaxLineTextIndex() const = 0;

 virtual uchar GetPreviousHyphenLadderPattern() const = 0;

 virtual IWaxIterator * NewWaxIterator(bool16 changeAware = kFalse) const = 0;

 virtual bool16 BackupTowardsParagraphStart() = 0;

 virtual bool16 BackupOneLineTowardsParagraphStart() = 0;

 virtual bool16 DestroyAllWaxLinesInParagraph() = 0;

 virtual void OwnedItemsChanged() = 0;

 virtual IWaxLine* QueryNewWaxLine() const = 0;

 virtual void ApplyComposedLine(IWaxLine* newWaxLine,
 int32 newTextSpan,
 bool16 disableApplyDamage = kFalse,
 bool16 disableApplyInval = kFalse,
 bool16 forceInkCache = kFalse) = 0;

 virtual void SetNoShuffle() = 0;

 virtual void MarkContentDamage(int32 nChars) = 0;

 virtual void ResetDamageToContent() = 0;

 virtual void MarkContentDamagePreviousAt(TextIndex at) = 0;

 virtual void SetDeferredCompositionDueToKeeps() = 0;

 virtual TextIndex GetNoDamageBackTextIndex() = 0;

 virtual int32 GetShapingEngine() const = 0;

 virtual void SetShapingEngine(int32 shapingEngine) = 0;
 };

 virtual bool16 Recompose(RecomposeHelper* helper) = 0;


 class RebuildHelper
 {
 protected:
 RebuildHelper();

 private:
 RebuildHelper(const RebuildHelper& copy);
 RebuildHelper& operator=(const RebuildHelper& copy);

 public:
 virtual ~RebuildHelper() { }

 virtual IDataBase* GetDataBase() const = 0;

 virtual IComposeScanner* GetComposeScanner() const = 0;

 virtual TextIndex GetThreadStart() const = 0;

 virtual int32 GetThreadSpan() const = 0;

 virtual TextIndex GetThreadEnd() const = 0;

 virtual TextIndex GetParagraphStart() const = 0;

 virtual int32 GetParagraphSpan() const = 0;

 virtual TextIndex GetParagraphEnd() const = 0;

 virtual const IParcelList* GetParcelList() const = 0;

 virtual const ITextParcelList* GetTextParcelList() const = 0;

 virtual bool16 ShouldFakeTabAlignToChar() const = 0;

 virtual const ITextOptions* GetTextOptions() const = 0;

 virtual const IStoryOptions* GetStoryOptions() const = 0;

 virtual bool16 GetIsVertical() const = 0;

 virtual IPairKernDict* GetPairKernDict(ClassID whichAlgorithm) const = 0;

 virtual IEdgeAlignDict* GetEdgeAlignDict(ClassID whichAlgorithm) const = 0;

 virtual IHyphenationService* GetSimpleHyphenator() const = 0;

 virtual IHyphenationService* GetHyphenator(const ILanguage* pLanguage) const = 0;

 virtual IHyphenationExceptions* GetHyphenationExceptions(bool16 *pCheckUserDictionary) const = 0;

 virtual TextIndex GetTextIndex() const = 0;

 virtual const IWaxLine* GetWaxLine() const = 0;

 virtual const IWaxLine* GetPreviousWaxLine() const = 0;

 virtual UID GetParcelFrameUID() const = 0;

 virtual PMRect GetParcelContentBounds() const = 0;
 virtual bool16 IsParcelContentAnArea() const = 0;
 virtual PMReal GetParcelEffectiveVerticalSpacing() const = 0;

 virtual const OwnedItemDataList::const_iterator GetOwnedItemBeginIter() const = 0;

 virtual const OwnedItemDataList::const_iterator GetOwnedItemEndIter() const = 0;

 virtual int32 GetShapingEngine() const = 0;

 virtual void SetShapingEngine(int32 shapingEngine) = 0;

 };

 virtual bool16 RebuildLineToFit(RebuildHelper* helper) = 0;

 virtual bool16 RebuildLineWithOverrides(IParagraphComposer::RebuildHelper* helper, const AttributeBossList *overrides, bool16 clearOverrides=kFalse) = 0;

};

#endif