AnnotationItem.h

//========================================================================================
// 
// $File$
//
// Owner: Souvik Sinha Deb
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// ADOBE CONFIDENTIAL
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: All information contained herein is, and remains
// the property of Adobe Systems Incorporated and its suppliers,
// if any. The intellectual and technical concepts contained
// herein are proprietary to Adobe Systems Incorporated and its
// suppliers and may be covered by U.S. and Foreign Patents,
// patents in process, and are protected by trade secret or copyright law.
// Dissemination of this information or reproduction of this material
// is strictly forbidden unless prior written permission is obtained
// from Adobe Systems Incorporated.
// 
//========================================================================================

#ifndef __AnnotationItem__
#define __AnnotationItem__


#include "PMRect.h"
#include "IDTime.h"
#include "AnnotationConstants.h"
#include "IPathGeometry.h"
#include <map>
/*
typedef unsigned int AnnotationID;
#define kInvalidAnnotationID 0;
*/

namespace AnnotMapOrDrawType
{
 //Indicates how annotation should be mapped to indesign document
 enum eAnnotMappingType { kBBoxMapping, kPointMapping, kTextMapping, kUnknownMapping };
 //Indicates how annotation should be drawn on indesign document
 enum eAnnotDrawingType { kPathDrawing, kIconDrawing, kTextDrawing, kUnknownDrawing };
}
// Store for each annotation whats kind of mapping and drawing it supports. Populated once from AnnoationItem class constructor
typedef std::map<AnnotationType,std::pair<AnnotMapOrDrawType::eAnnotMappingType, AnnotMapOrDrawType::eAnnotDrawingType>> AnnotationMappingAndDrawingTypeMap;

//Structure for storing segregated mapping textual data, valid only for InDesign exported tagged PDFs
class SegregatedTextualData
{
public:
 std::vector<UTF32TextChar> precedingContextText, succeedingContextText, targetContextText;
 std::vector<PMRect> quadRects;
 SegregatedTextualData(std::vector<UTF32TextChar> _targetContextText, std::vector<UTF32TextChar> _precedingContextText, std::vector<UTF32TextChar> _succeedingContextText, std::vector<PMRect> _rangeRects) :
 targetContextText(_targetContextText), precedingContextText(_precedingContextText), succeedingContextText(_succeedingContextText), quadRects(_rangeRects) {}
};

// Annotation Body Class -- contains mapping and drawing information.
//See the comments in AnnoationItem on how to fill this structure.

class AnnotationBody
{
public :
 AnnotationBody() : fDrawingPath(NULL), fInsertCommentIsAfterPrecedingContextText(kFalse) {}

 //To get more details about these API see the comments written in AnnotationItem.
 virtual void ApplyTransformAnnotation(const PMMatrix& transformationMatrix);

 virtual void SetMappingBBoxData(const PMRect& bBox);

 virtual void GetMappingBBoxData(PMRect& bBox) const;

 virtual void SetMappingPointData(const PMRect& bBox, const PMPoint& point);

 virtual void GetMappingPointData(PMRect& bBox, PMPoint& point) const;

 virtual void SetMappingTextData(const PMRect& bBox, const std::vector<UTF32TextChar>& targetContextText, const std::vector<UTF32TextChar>& precedingContextText, const std::vector<UTF32TextChar>& succeedingContextText, const bool& insertCommentAfterSucceedingText);

 virtual void GetMappingTextData(PMRect& bBox, std::vector<UTF32TextChar>& targetContextText, std::vector<UTF32TextChar>& precedingContextText, std::vector<UTF32TextChar>& succeedingContextText, bool16& insertCommentAfterSucceedingText) const;

 virtual void SetTextRectsForMappingTextData(const std::vector<PMRect>& mappingTextRects);

 virtual void GetTextRectsForMappingTextData(std::vector<PMRect>& mappingTextRects) const;

 virtual void SetDrawingDataForPathDrawing(IPathGeometry *path);

 virtual void GetDrawingDataForPathDrawing(IPathGeometry *&path) const;

 virtual void SetDrawingDataForIconDrawing(const PMRsrcID &iconId);

 virtual void GetDrawingDataForIconDrawing(PMRsrcID &iconId) const;

 virtual void SetSegregatedTextualContentData(const std::vector<std::shared_ptr<SegregatedTextualData>> &segregatedTextualData);

 virtual void GetSegregatedTextualContentData(std::vector<std::shared_ptr<SegregatedTextualData>> &segregatedTextualData) const;

 virtual PMRect GetBoundingBox() const;

private : 
 PMRect fMappingBBox;
 PMPoint fMappingPoint;
 std::vector<UTF32TextChar> fMappingContextText;
 std::vector<UTF32TextChar> fMappingPrecedingContextText;
 std::vector<UTF32TextChar> fMappingSucceedingContextText;

 std::vector<PMRect> fMappingTextRects;

 InterfacePtr<IPathGeometry> fDrawingPath;

 PMRsrcID fDrawingIcon;

 std::vector<std::shared_ptr<SegregatedTextualData>> fSegregatedMappingData;

 bool16 fInsertCommentIsAfterPrecedingContextText;
};

// Annotation Reply Class -- implements a reply to an annotation.
class AnnotationReply
{
 
public:
 AnnotationReply();
 
 virtual void SetReplyContent(const PMString& content);
 
 virtual PMString GetReplyContent() const;
 
 //virtual void SetAnnotationStatus(const AnnotationStatus& status);
 
 //virtual void GetAnnotationStatus(AnnotationStatus& status) const;
 
 virtual void SetReplyCreator(const PMString& creator);
 
 virtual PMString GetReplyCreator() const;
 
 virtual void SetReplyModified(const IDTime& modified);
 
 virtual IDTime GetReplyModified() const;
 
private:
 
 PMString fContent;
 //AnnotationStatus fStatus;
 PMString fCreator;
 IDTime fModified;
};

// Annotation Item Class -- implements an annotation supported by InDesign.
class AnnotationItem
{
public:
 AnnotationItem();
 
 virtual void SetAnnotationContent(const PMString& content);
 
 virtual PMString GetAnnotationContent() const;
 
 virtual void SetAnnotationType(const AnnotationType& annotType);
 
 virtual AnnotationType GetAnnotationType() const;

 //virtual void SetAnnotationID(const AnnotationID& annotid);
 
 //virtual void GetAnnotationID(AnnotationID& annotid) const;
 
 virtual void SetAnnotationStatus(const AnnotationStatus& status);
 
 virtual AnnotationStatus GetAnnotationStatus() const;

 virtual void SetAnnotationCreator(const PMString& creator);
 
 virtual PMString GetAnnotationCreator() const;
 
 virtual void SetAnnotationSource(const PMString& filepath);
 
 virtual PMString GetAnnotationSource() const;

 //virtual void SetAnnotationTargetPageIndex(const int& targetPageIndex);

 //virtual void GetAnnotationTargetPageIndex(int& targetPageIndex) const;

 virtual void SetAnnotationReplies(const std::vector<std::shared_ptr<AnnotationReply>>& replies);

 virtual void GetAnnotationReplies(std::vector<std::shared_ptr<AnnotationReply>>& replies) const;

 virtual void AppendAnnotationReplies(const std::vector<std::shared_ptr<AnnotationReply>>& replies);

 virtual void SetAnnotationModified(const IDTime& modified);

 virtual IDTime GetAnnotationModified() const;

 virtual void ApplyTransformAnnotation(const PMMatrix& transformationMatrix);
 
 //Set mapping information. See structure AnnotationBody for more details

 virtual bool SetMappingBBoxData(const PMRect& bBox);

 virtual bool GetMappingBBoxData(PMRect& bBox) const;

 virtual bool SetMappingPointData(const PMRect& bBox, const PMPoint& point);

 virtual bool GetMappingPointData(PMRect& bBox, PMPoint& point) const;

 virtual bool SetMappingTextData(const PMRect& bBox, const std::vector<UTF32TextChar>& targetContextText, const std::vector<UTF32TextChar>& precedingContextText, const std::vector<UTF32TextChar>& succeedingContextText, const bool &insertCommentAfterSucceedingText);

 virtual bool GetMappingTextData(PMRect& bBox, std::vector<UTF32TextChar>& targetContextText, std::vector<UTF32TextChar>& precedingContextText, std::vector<UTF32TextChar>& succeedingContextText, bool16& insertCommentAfterSucceedingText) const;

 virtual bool SetTextRectsForMappingTextData(const std::vector<PMRect>& mappingTextRects);

 virtual bool GetTextRectsForMappingTextData(std::vector<PMRect>& mappingTextRects) const;

 virtual AnnotMapOrDrawType::eAnnotMappingType GetMappingTypeForAnnotation();

 virtual AnnotMapOrDrawType::eAnnotDrawingType GetDrawingTypeForAnnotation();

 //Set drawing information. See structure AnnotationBody for more details

 
 virtual bool SetDrawingDataForPathDrawing(IPathGeometry *path);

 virtual bool GetDrawingDataForPathDrawing(IPathGeometry *&path) const;

 virtual bool SetDrawingDataForIconDrawing(const PMRsrcID &iconId);

 virtual bool GetDrawingDataForIconDrawing(PMRsrcID &iconId) const;

 virtual bool SetSegregatedTextualMappingData(const std::vector<std::shared_ptr<SegregatedTextualData>> &segregatedTextualData);

 virtual bool GetSegregatedTextualMappingData(std::vector<std::shared_ptr<SegregatedTextualData>> &segregatedTextualData) const;

 virtual PMRect GetBoundingBox() const;

private:
 
 //AnnotationID fAnnotid;
 PMString fContent;
 //AnnotationStatus fStatus;
 PMString fCreator;
 PMString fPath;
 AnnotationBody fBody;
 //int fTargetPageIndex;
 std::vector<std::shared_ptr<AnnotationReply>> fReplies;
 AnnotationType fAnnotType;
 IDTime fModified;
 AnnotationStatus fStatus;

 static AnnotationMappingAndDrawingTypeMap annotMappingAndDrawingTypeMap;

 static void PopulateAnnotationMappingAndDrawingTypeMap();
};

#endif //__AnnotationItem__