IXMLUtils.h

//========================================================================================
// 
// $File$
// 
// Owner: robin briggs
// 
// $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 __IXMLUtils__
#define __IXMLUtils__

#include "K2Vector.h"
#include "Utils.h"
#include "XMLID.h"
#include "TableTypes.h"

class IDataBase;
class IDocument;
class IIDXMLElement;
class ITextModel;
class IXMLAccess;
class IXMLHandler;
class IXMLOutStream;
class IXMLReferenceData;
class IXMLStyleToTagMap;
class IXMLTagList;
class IXMLTagToStyleMap;
class UIDList;
class XMLDTDValidationError;
class XMLReference;

class IXMLUtils : public IPMUnknown
{
 public:
 enum {kDefaultIID = IID_IXMLUTILS};

 virtual UIDRef GetBackingStore(IDocument *doc) = 0;
 virtual UIDRef GetBackingStore(IDataBase *db) = 0;
 
 virtual IIDXMLElement* QueryDocElement(IDocument* document) = 0;

 virtual IIDXMLElement* QueryDocElement(IDataBase* db) = 0;

 virtual IIDXMLElement* QueryRootElement(IIDXMLElement* xmlDocElement) = 0;


 virtual IIDXMLElement* QueryRootElement(IDocument* document) = 0;

 virtual IIDXMLElement* QueryRootElement(IDataBase* db) = 0;


 virtual IXMLTagList* QueryXMLTagList(IDataBase* db) = 0;

 virtual IXMLStyleToTagMap* QueryXMLStyleToTagMap(IDataBase* db) = 0;

 virtual IXMLTagToStyleMap* QueryXMLTagToStyleMap(IDataBase* db) = 0;

 virtual ITextModel* QueryTextModel(const IIDXMLElement* element) = 0;


 virtual IXMLReferenceData* QueryXMLReferenceData(IPMUnknown* item, bool16 allowTOP = kFalse) = 0;

 virtual IXMLReferenceData* QueryXMLReferenceData(const UIDRef& item, bool16 allowTOP = kFalse) = 0;

 virtual IXMLReferenceData* QueryXMLReferenceData(const UIDRef& storyUIDRef, TextIndex textIndex, bool16 allowTOP = kFalse) = 0;

 virtual IXMLReferenceData* QueryXMLReferenceData(ITextModel *textModel, TextIndex textIndex, bool16 allowTOP = kFalse) = 0;

 virtual IXMLReferenceData* QueryXMLReferenceData(const XMLReference& xmlReference) = 0;

 virtual bool16 GetElementIndices(const IIDXMLElement* element, TextIndex* startPos, TextIndex* endPos) = 0;
 
 virtual void GetElementMarkerPositions(IIDXMLElement* element, TextIndex* startPos, TextIndex* endPos) = 0;

 virtual bool16 CalculateStartEndTextIndex(IIDXMLElement *element, int32 beforeChildIndex, TextIndex &startTextIndex, TextIndex &endTextIndex) = 0;

 virtual ErrorCode UpdateAutoAttrib(const XMLReference& ref) = 0;

 virtual XMLReference GetStoryXMLReference(const UIDRef& storyRef) = 0;

 virtual XMLReference GetStoryThreadXMLReference(const UIDRef& storyUIDRef, TextIndex textIndex) = 0;

 virtual XMLReference GetStoryThreadXMLReference(ITextModel *textModel, TextIndex textIndex) = 0;

 enum CalcXMLParent_Result {
 kSuccessCalc = 0,
 kStartUnmatched = 1,
 kEndUnmatched = 2,
 kBothUnmatched = kStartUnmatched+kEndUnmatched
 };
 
 virtual int32 CalcXMLParent(XMLReference& startParentXMLRef, int32& startIndexInParent, K2Vector<XMLReference>& childRefList, 
 XMLReference& endParentXMLRef, int32& endIndexInParent,
 TextIndex startTextIndex, TextIndex endTextIndex, ITextModel* iTextModel, bool16 useReverseSearch = kTrue) = 0;

 virtual void CalcXMLElementsInTextRange(ITextModel *iTextModel, TextIndex startTextIndex, TextIndex endTextIndex, XMLReference& parentXMLRef, K2Vector<XMLReference>& childRefList) = 0;

 virtual ErrorCode AssignTagUID(const WideString& strTag, IDataBase* db, UID colorUID, UID& tagUID) = 0;

 virtual bool16 IsTagValid(const WideString& tag) = 0;

 virtual bool16 IsNmtoken(const PMString& token) = 0;

 virtual bool16 IsValidXMLComment(const PMString& comment) = 0;

 virtual bool16 IsValidXMLPITarget(const PMString& piTarget) = 0;

 virtual bool16 IsValidXMLPIData(const PMString& piData) = 0;

 virtual bool16 IsTaggablePageItem(IPMUnknown* item) = 0;

 virtual void FindUnusedTags(UIDList& unusedTag) = 0;

 virtual UID ImportHREF(IDataBase* db, const PMString& href, const IDFile* relativeTo, bool16& useFrame, UIFlags uiFlags = kFullUI ) = 0;

 virtual bool16 IsElementLocked( const IIDXMLElement* element ) = 0;

 virtual bool16 IsStoryLocked(const UIDRef& storyRef) = 0;
 
 virtual bool HasUnlockedStory (IDataBase *db) = 0;

 virtual bool16 LinkElementInTextRange(const UIDRef& storyUIDRef, TextIndex start, int32 numChars) = 0;
 
 virtual UID GetGraphicFrame(const UIDRef& contentUID) = 0;

 virtual bool16 IsElementAGraphic(IIDXMLElement* element) const = 0;

 virtual bool16 GetActualContent(UIDRef& contentRef) = 0;

 virtual void ValidateXML(const XMLReference& startXMLRef, K2Vector<XMLDTDValidationError>& errors, int32 maxErrors = 250, bool16 treatAsRoot = kFalse, bool16 checkHasDTD = kFalse) = 0;

 virtual ErrorCode ExportElement(IIDXMLElement *element, bool16 includeHeader, IXMLAccess* access, 
 IXMLHandler* exportHandler, const IDFile& sysFile, IDocument* doc, const PMString& formatName, UIFlags uiFlags) const = 0;

 virtual void ExportDTDToStream(const XMLReference& xmlRef, IXMLOutStream *s, bool16 internalSubsetOnly = kFalse) = 0;

#ifdef DEBUG

 virtual void VerifyXMLStructure(IDocument* targetDocument) = 0;
#endif

 virtual bool16 IsExportableInCopyStory(const UIDRef& storyUIDRef) = 0;

 virtual bool16 FindMissingFile(PMString filename, IDFile& fileToImport) = 0;

 virtual XMLReference GetImportedRootXMLReference(IPMUnknown* importer) = 0;

 class IXMLCallback
 {
 public:
 typedef enum { kKeepIterating = 0, kSkipChildren, kStopIterating } ContinuationCode;
 
 virtual ContinuationCode Visit(IIDXMLElement *element) = 0;
 };
 
 virtual void ForEachElement(IIDXMLElement* root, IXMLCallback *callback) = 0;

 virtual bool16 IsParentCellWithType(IIDXMLElement* childElement, CellType cellType) = 0;

 virtual ErrorCode SetShouldDeleteElementOnContentDeletion(const bool16 shouldDelete = kTrue) const = 0;

 virtual bool16 ShouldDeleteElementOnContentDeletion() const = 0;

 virtual ErrorCode SetLayoutTag(const UIDList& itemList, const UIDRef& tag, bool16 retag, bool16 allowPresetUI) = 0; 
};
 
#endif // __IXMLUtils__