IRunInStylesUtils.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 __IRunInStylesUtils__
#define __IRunInStylesUtils__

#include "IPMUnknown.h"

#include "K2Vector.h"
#include "TextID.h"


class ITextModel;
class ICompositionStyle;
class WideString;
class PMString;


class RunInStyleResult
{
 public:
 typedef K2Vector<UID> CharStyleList;

 RunInStyleResult() : fLength(0), fLineRuleIndex(-1), fLinesCount(0)
 { }
 RunInStyleResult(UID cs, int32 len) : fLength(len), fLineRuleIndex(-1), fLinesCount(0)
 { fCharStyles.push_back(cs); }
 RunInStyleResult(UID cs, int32 len, int32 ndx, int32 lc) : fLength(len), fLineRuleIndex(ndx), fLinesCount(lc)
 { fCharStyles.push_back(cs); }
 RunInStyleResult(const CharStyleList& cs, int32 len, int32 ndx, int32 lc) : fLength(len), fLineRuleIndex(ndx), fLinesCount(lc)
 { fCharStyles = cs; }

 UID CharStyle(uint32 i) const
 { return (i < fCharStyles.size()) ? fCharStyles[i] : kInvalidUID; }
 CharStyleList& CharStyles()
 { return fCharStyles; }
 const CharStyleList& CharStyles() const
 { return fCharStyles; }

 int32 Length() const
 { return fLength; }
 int32& Length()
 { return fLength; }

 int32 LineRuleIndex() const
 { return fLineRuleIndex; }
 int16& LineRuleIndex()
 { return fLineRuleIndex; }

 int32 LinesCount() const
 { return fLinesCount; }
 int16& LinesCount()
 { return fLinesCount; }

 typedef object_type data_type;
 private:
 CharStyleList fCharStyles;
 int32 fLength;
 int16 fLineRuleIndex;
 int16 fLinesCount;
};

class RunInStyleResults : public K2Vector<RunInStyleResult>
{
public:
 void Append(UID cs, int32 len, int32 lineRule, int32 linesCount)
 {
 if (empty() || back().LineRuleIndex() != lineRule)
 push_back(RunInStyleResult(cs, len, lineRule, linesCount));
 else
 {
 const RunInStyleResult::CharStyleList& list = back().CharStyles();
 if (list.empty() || list.size() > 1 || list[0] != cs)
 push_back(RunInStyleResult(cs, len, lineRule, linesCount));
 else
 back().Length() += len;
 }
 }

 void Append(UID cs, int32 len)
 {
 if (empty() || back().LineRuleIndex() >= 0)
 push_back(RunInStyleResult(cs, len));
 else
 {
 const RunInStyleResult::CharStyleList& list = back().CharStyles();
 if (list.empty() || list.size() > 1 || list[0] != cs)
 push_back(RunInStyleResult(cs, len));
 else
 back().Length() += len;
 }
 }

 void RemoveFirst()
 { erase(begin(), begin() + 1); }
};


class IRunInStylesUtils : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_IRUNINSTYLESUTILS };

// enum HandleUncomposedNestedLines { kIgnoreNestedLines, kRestOfParagraphNestedLines };
 virtual bool16 ParseParagraphForRunInStyles(const ITextModel *model, TextIndex position,
 const ICompositionStyle *paragraphStyle, RunInStyleResults& results, //HandleUncomposedNestedLines lines = kIgnoreNestedLines,
 int32 *pParagraphLengthLeft = nil, bool16 moveBackwards = kFalse) = 0;

 virtual void MapExpressionToPMString(const WideString& expression, PMString *pOutput, int32 *pCount, bool16 *pInclusive) = 0;

 virtual void MapPMStringToExpression(const PMString& nicePhrase, int32 count, bool16 inclusive, WideString *pExpression) = 0;

 virtual bool16 ToggleExpressionInclusion(const WideString& original, WideString *pToggled) = 0;

 virtual int32 CalculateDropCapCount(const TextIterator& beginPosition, int16 baseCharCount, WideString * dcText) = 0;
};


#endif // __IRunInStylesUtils__