gecko/editor/libeditor/base/nsSelectionState.h
2012-01-10 15:19:54 +01:00

298 lines
9.3 KiB
C++

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is mozilla.org code.
*
* The Initial Developer of the Original Code is
* Netscape Communications Corporation.
* Portions created by the Initial Developer are Copyright (C) 1998
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
*
* Alternatively, the contents of this file may be used under the terms of
* either of the GNU General Public License Version 2 or later (the "GPL"),
* or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
#ifndef __selectionstate_h__
#define __selectionstate_h__
#include "nsCOMPtr.h"
#include "nsTArray.h"
#include "nsIDOMNode.h"
#include "nsIDOMRange.h"
#include "nsCycleCollectionParticipant.h"
class nsIDOMCharacterData;
class nsISelection;
class nsRange;
/***************************************************************************
* class for recording selection info. stores selection as collection of
* { {startnode, startoffset} , {endnode, endoffset} } tuples. Can't store
* ranges since dom gravity will possibly change the ranges.
*/
// first a helper struct for saving/setting ranges
struct nsRangeStore
{
nsRangeStore();
~nsRangeStore();
nsresult StoreRange(nsIDOMRange *aRange);
nsresult GetRange(nsRange** outRange);
nsCOMPtr<nsIDOMNode> startNode;
PRInt32 startOffset;
nsCOMPtr<nsIDOMNode> endNode;
PRInt32 endOffset;
// DEBUG: static PRInt32 n;
};
class nsSelectionState
{
public:
nsSelectionState();
~nsSelectionState();
void DoTraverse(nsCycleCollectionTraversalCallback &cb);
void DoUnlink() { MakeEmpty(); }
nsresult SaveSelection(nsISelection *aSel);
nsresult RestoreSelection(nsISelection *aSel);
bool IsCollapsed();
bool IsEqual(nsSelectionState *aSelState);
void MakeEmpty();
bool IsEmpty();
protected:
nsTArray<nsRangeStore> mArray;
friend class nsRangeUpdater;
};
class nsRangeUpdater
{
public:
nsRangeUpdater();
~nsRangeUpdater();
void RegisterRangeItem(nsRangeStore *aRangeItem);
void DropRangeItem(nsRangeStore *aRangeItem);
nsresult RegisterSelectionState(nsSelectionState &aSelState);
nsresult DropSelectionState(nsSelectionState &aSelState);
// editor selection gravity routines. Note that we can't always depend on
// DOM Range gravity to do what we want to the "real" selection. For instance,
// if you move a node, that corresponds to deleting it and reinserting it.
// DOM Range gravity will promote the selection out of the node on deletion,
// which is not what you want if you know you are reinserting it.
nsresult SelAdjCreateNode(nsIDOMNode *aParent, PRInt32 aPosition);
nsresult SelAdjInsertNode(nsIDOMNode *aParent, PRInt32 aPosition);
nsresult SelAdjDeleteNode(nsIDOMNode *aNode);
nsresult SelAdjSplitNode(nsIDOMNode *aOldRightNode, PRInt32 aOffset, nsIDOMNode *aNewLeftNode);
nsresult SelAdjJoinNodes(nsIDOMNode *aLeftNode,
nsIDOMNode *aRightNode,
nsIDOMNode *aParent,
PRInt32 aOffset,
PRInt32 aOldLeftNodeLength);
nsresult SelAdjInsertText(nsIDOMCharacterData *aTextNode, PRInt32 aOffset, const nsAString &aString);
nsresult SelAdjDeleteText(nsIDOMCharacterData *aTextNode, PRInt32 aOffset, PRInt32 aLength);
// the following gravity routines need will/did sandwiches, because the other gravity
// routines will be called inside of these sandwiches, but should be ignored.
nsresult WillReplaceContainer();
nsresult DidReplaceContainer(nsIDOMNode *aOriginalNode, nsIDOMNode *aNewNode);
nsresult WillRemoveContainer();
nsresult DidRemoveContainer(nsIDOMNode *aNode, nsIDOMNode *aParent, PRInt32 aOffset, PRUint32 aNodeOrigLen);
nsresult WillInsertContainer();
nsresult DidInsertContainer();
nsresult WillMoveNode();
nsresult DidMoveNode(nsIDOMNode *aOldParent, PRInt32 aOldOffset, nsIDOMNode *aNewParent, PRInt32 aNewOffset);
protected:
nsTArray<nsRangeStore*> mArray;
bool mLock;
};
/***************************************************************************
* helper class for using nsSelectionState. stack based class for doing
* preservation of dom points across editor actions
*/
class NS_STACK_CLASS nsAutoTrackDOMPoint
{
private:
nsRangeUpdater &mRU;
nsCOMPtr<nsIDOMNode> *mNode;
PRInt32 *mOffset;
nsRangeStore mRangeItem;
public:
nsAutoTrackDOMPoint(nsRangeUpdater &aRangeUpdater, nsCOMPtr<nsIDOMNode> *aNode, PRInt32 *aOffset) :
mRU(aRangeUpdater)
,mNode(aNode)
,mOffset(aOffset)
{
mRangeItem.startNode = *mNode;
mRangeItem.endNode = *mNode;
mRangeItem.startOffset = *mOffset;
mRangeItem.endOffset = *mOffset;
mRU.RegisterRangeItem(&mRangeItem);
}
~nsAutoTrackDOMPoint()
{
mRU.DropRangeItem(&mRangeItem);
*mNode = mRangeItem.startNode;
*mOffset = mRangeItem.startOffset;
}
};
/***************************************************************************
* another helper class for nsSelectionState. stack based class for doing
* Will/DidReplaceContainer()
*/
class NS_STACK_CLASS nsAutoReplaceContainerSelNotify
{
private:
nsRangeUpdater &mRU;
nsIDOMNode *mOriginalNode;
nsIDOMNode *mNewNode;
public:
nsAutoReplaceContainerSelNotify(nsRangeUpdater &aRangeUpdater, nsIDOMNode *aOriginalNode, nsIDOMNode *aNewNode) :
mRU(aRangeUpdater)
,mOriginalNode(aOriginalNode)
,mNewNode(aNewNode)
{
mRU.WillReplaceContainer();
}
~nsAutoReplaceContainerSelNotify()
{
mRU.DidReplaceContainer(mOriginalNode, mNewNode);
}
};
/***************************************************************************
* another helper class for nsSelectionState. stack based class for doing
* Will/DidRemoveContainer()
*/
class NS_STACK_CLASS nsAutoRemoveContainerSelNotify
{
private:
nsRangeUpdater &mRU;
nsIDOMNode *mNode;
nsIDOMNode *mParent;
PRInt32 mOffset;
PRUint32 mNodeOrigLen;
public:
nsAutoRemoveContainerSelNotify(nsRangeUpdater &aRangeUpdater,
nsIDOMNode *aNode,
nsIDOMNode *aParent,
PRInt32 aOffset,
PRUint32 aNodeOrigLen) :
mRU(aRangeUpdater)
,mNode(aNode)
,mParent(aParent)
,mOffset(aOffset)
,mNodeOrigLen(aNodeOrigLen)
{
mRU.WillRemoveContainer();
}
~nsAutoRemoveContainerSelNotify()
{
mRU.DidRemoveContainer(mNode, mParent, mOffset, mNodeOrigLen);
}
};
/***************************************************************************
* another helper class for nsSelectionState. stack based class for doing
* Will/DidInsertContainer()
*/
class NS_STACK_CLASS nsAutoInsertContainerSelNotify
{
private:
nsRangeUpdater &mRU;
public:
nsAutoInsertContainerSelNotify(nsRangeUpdater &aRangeUpdater) :
mRU(aRangeUpdater)
{
mRU.WillInsertContainer();
}
~nsAutoInsertContainerSelNotify()
{
mRU.DidInsertContainer();
}
};
/***************************************************************************
* another helper class for nsSelectionState. stack based class for doing
* Will/DidMoveNode()
*/
class NS_STACK_CLASS nsAutoMoveNodeSelNotify
{
private:
nsRangeUpdater &mRU;
nsIDOMNode *mOldParent;
nsIDOMNode *mNewParent;
PRInt32 mOldOffset;
PRInt32 mNewOffset;
public:
nsAutoMoveNodeSelNotify(nsRangeUpdater &aRangeUpdater,
nsIDOMNode *aOldParent,
PRInt32 aOldOffset,
nsIDOMNode *aNewParent,
PRInt32 aNewOffset) :
mRU(aRangeUpdater)
,mOldParent(aOldParent)
,mNewParent(aNewParent)
,mOldOffset(aOldOffset)
,mNewOffset(aNewOffset)
{
mRU.WillMoveNode();
}
~nsAutoMoveNodeSelNotify()
{
mRU.DidMoveNode(mOldParent, mOldOffset, mNewParent, mNewOffset);
}
};
#endif