IXMLImportMatchRecorder.h

//========================================================================================
// 
// $File$
// 
// Owner: Will Lin
// 
// $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 __IXMLImportMatchRecorder__
#define __IXMLImportMatchRecorder__


#include "KeyValuePair.h"
#include "XMLID.h"
#include "XMLReference.h"


class IIDXMLDOMNode;

class IXMLImportMatchRecorder : public IPMUnknown {
 public:
 enum { kDefaultIID = IID_IXMLIMPORTMATCHRECORDER };

 typedef KeyValuePair<IIDXMLDOMNode*, XMLReference> MatchRecord;

 virtual void RecordMatch(IIDXMLDOMNode *leftNode, const XMLReference& rightNode, bool16 rightNodeIsNew, bool16 recordAsLastMatch = kTrue) = 0;

 virtual bool16 MatchMade(void) const = 0;

 virtual MatchRecord GetLastMatch(void) const = 0;

 virtual bool16 FindMatch(IIDXMLDOMNode *leftNode, XMLReference *rightNode = nil, bool16 *rightNodeIsNew = nil) const = 0;

 /* the following are for internal use only */

 virtual bool16 FindMatchRight(const XMLReference& rightNode, IIDXMLDOMNode **leftNode = nil, bool16 *rightNodeIsNew = nil) const = 0;

 virtual void ReplaceRightNode(const XMLReference& oldRightNode, const XMLReference& newRightNode, bool16 rightNodeIsNew) = 0;

 virtual void PushMatchMade(bool16 matchMade = kFalse) = 0;

 virtual bool16 PopMatchMade(void) = 0;

 virtual void PushLevel(void) = 0;

 virtual void PopLevel(void) = 0;
};

const IXMLImportMatchRecorder::MatchRecord kInvalidMatchRecord;


#endif //__IXMLImportMatchRecorder__