1999-03-29 06:21:01 +00:00
|
|
|
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
|
|
|
|
*
|
1999-11-06 03:43:54 +00:00
|
|
|
* The contents of this file are subject to the Netscape 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/NPL/
|
1999-03-29 06:21:01 +00:00
|
|
|
*
|
1999-11-06 03:43:54 +00:00
|
|
|
* 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.
|
1999-03-29 06:21:01 +00:00
|
|
|
*
|
1999-11-06 03:43:54 +00:00
|
|
|
* The Original Code is mozilla.org code.
|
|
|
|
*
|
|
|
|
* The Initial Developer of the Original Code is Netscape
|
1999-03-29 06:21:01 +00:00
|
|
|
* Communications Corporation. Portions created by Netscape are
|
1999-11-06 03:43:54 +00:00
|
|
|
* Copyright (C) 1998 Netscape Communications Corporation. All
|
|
|
|
* Rights Reserved.
|
|
|
|
*
|
|
|
|
* Contributor(s):
|
1999-03-29 06:21:01 +00:00
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef nsHTMLEditRules_h__
|
|
|
|
#define nsHTMLEditRules_h__
|
|
|
|
|
|
|
|
#include "nsTextEditRules.h"
|
1999-11-25 00:19:45 +00:00
|
|
|
#include "nsIEditActionListener.h"
|
1999-07-01 23:41:29 +00:00
|
|
|
#include "nsISupportsArray.h"
|
1999-04-12 12:01:32 +00:00
|
|
|
#include "nsCOMPtr.h"
|
1999-11-25 00:19:45 +00:00
|
|
|
#include "nsString.h"
|
1999-03-29 06:21:01 +00:00
|
|
|
|
1999-06-16 05:02:43 +00:00
|
|
|
class nsISupportsArray;
|
1999-07-01 13:42:03 +00:00
|
|
|
class nsVoidArray;
|
1999-11-25 00:19:45 +00:00
|
|
|
class nsIDOMElement;
|
1999-06-16 05:02:43 +00:00
|
|
|
|
1999-03-29 06:21:01 +00:00
|
|
|
class nsHTMLEditRules : public nsTextEditRules
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
|
1999-08-09 18:39:49 +00:00
|
|
|
nsHTMLEditRules();
|
1999-08-09 01:37:50 +00:00
|
|
|
virtual ~nsHTMLEditRules();
|
1999-03-29 06:21:01 +00:00
|
|
|
|
1999-04-05 17:21:59 +00:00
|
|
|
// nsEditRules methods
|
1999-12-07 08:30:19 +00:00
|
|
|
NS_IMETHOD BeforeEdit(PRInt32 action, nsIEditor::EDirection aDirection);
|
|
|
|
NS_IMETHOD AfterEdit(PRInt32 action, nsIEditor::EDirection aDirection);
|
1999-11-25 00:19:45 +00:00
|
|
|
NS_IMETHOD Init(nsHTMLEditor *aEditor, PRUint32 aFlags);
|
1999-10-06 19:34:09 +00:00
|
|
|
NS_IMETHOD WillDoAction(nsIDOMSelection *aSelection, nsRulesInfo *aInfo, PRBool *aCancel, PRBool *aHandled);
|
1999-04-12 12:01:32 +00:00
|
|
|
NS_IMETHOD DidDoAction(nsIDOMSelection *aSelection, nsRulesInfo *aInfo, nsresult aResult);
|
1999-04-05 17:21:59 +00:00
|
|
|
|
|
|
|
protected:
|
|
|
|
|
1999-06-16 05:02:43 +00:00
|
|
|
enum RulesEndpoint
|
|
|
|
{
|
|
|
|
kStart,
|
|
|
|
kEnd
|
|
|
|
};
|
|
|
|
|
|
|
|
|
1999-04-05 17:21:59 +00:00
|
|
|
// nsHTMLEditRules implementation methods
|
1999-11-01 15:15:35 +00:00
|
|
|
nsresult WillInsertText( PRInt32 aAction,
|
|
|
|
nsIDOMSelection *aSelection,
|
|
|
|
PRBool *aCancel,
|
|
|
|
PRBool *aHandled,
|
|
|
|
const nsString *inString,
|
|
|
|
nsString *outString,
|
|
|
|
TypeInState typeInState,
|
|
|
|
PRInt32 aMaxLength);
|
1999-10-06 19:34:09 +00:00
|
|
|
nsresult WillInsertBreak(nsIDOMSelection *aSelection, PRBool *aCancel, PRBool *aHandled);
|
1999-12-07 08:30:19 +00:00
|
|
|
nsresult WillDeleteSelection(nsIDOMSelection *aSelection, nsIEditor::EDirection aAction,
|
1999-10-06 19:34:09 +00:00
|
|
|
PRBool *aCancel, PRBool *aHandled);
|
|
|
|
nsresult WillMakeList(nsIDOMSelection *aSelection, PRBool aOrderd, PRBool *aCancel, PRBool *aHandled);
|
|
|
|
nsresult WillRemoveList(nsIDOMSelection *aSelection, PRBool aOrderd, PRBool *aCancel, PRBool *aHandled);
|
|
|
|
nsresult WillIndent(nsIDOMSelection *aSelection, PRBool *aCancel, PRBool *aHandled);
|
|
|
|
nsresult WillOutdent(nsIDOMSelection *aSelection, PRBool *aCancel, PRBool *aHandled);
|
|
|
|
nsresult WillAlign(nsIDOMSelection *aSelection, const nsString *alignType, PRBool *aCancel, PRBool *aHandled);
|
|
|
|
nsresult WillMakeBasicBlock(nsIDOMSelection *aSelection, const nsString *aBlockType, PRBool *aCancel, PRBool *aHandled);
|
1999-04-12 12:01:32 +00:00
|
|
|
|
1999-10-06 19:34:09 +00:00
|
|
|
nsresult InsertTab(nsIDOMSelection *aSelection, nsString *outString);
|
|
|
|
nsresult InsertSpace(nsIDOMSelection *aSelection, nsString *outString);
|
1999-04-12 12:01:32 +00:00
|
|
|
|
1999-04-26 14:08:52 +00:00
|
|
|
nsresult ReturnInHeader(nsIDOMSelection *aSelection, nsIDOMNode *aHeader, nsIDOMNode *aTextNode, PRInt32 aOffset);
|
1999-10-06 19:34:09 +00:00
|
|
|
nsresult ReturnInParagraph(nsIDOMSelection *aSelection, nsIDOMNode *aHeader, nsIDOMNode *aTextNode, PRInt32 aOffset, PRBool *aCancel, PRBool *aHandled);
|
1999-04-26 14:08:52 +00:00
|
|
|
nsresult ReturnInListItem(nsIDOMSelection *aSelection, nsIDOMNode *aHeader, nsIDOMNode *aTextNode, PRInt32 aOffset);
|
|
|
|
|
1999-04-12 12:01:32 +00:00
|
|
|
// helper methods
|
1999-04-21 14:49:58 +00:00
|
|
|
static nsresult GetTabAsNBSPs(nsString *outString);
|
|
|
|
static nsresult GetTabAsNBSPsAndSpace(nsString *outString);
|
1999-05-28 21:17:30 +00:00
|
|
|
|
1999-04-26 14:08:52 +00:00
|
|
|
static PRBool IsHeader(nsIDOMNode *aNode);
|
|
|
|
static PRBool IsParagraph(nsIDOMNode *aNode);
|
|
|
|
static PRBool IsListItem(nsIDOMNode *aNode);
|
1999-11-25 00:19:45 +00:00
|
|
|
static PRBool IsTableCell(nsIDOMNode *aNode);
|
1999-08-18 08:13:06 +00:00
|
|
|
static PRBool IsList(nsIDOMNode *aNode);
|
1999-06-16 05:02:43 +00:00
|
|
|
static PRBool IsUnorderedList(nsIDOMNode *aNode);
|
|
|
|
static PRBool IsOrderedList(nsIDOMNode *aNode);
|
|
|
|
static PRBool IsBlockquote(nsIDOMNode *aNode);
|
1999-09-29 20:08:15 +00:00
|
|
|
static PRBool IsAnchor(nsIDOMNode *aNode);
|
1999-06-25 09:33:02 +00:00
|
|
|
static PRBool IsDiv(nsIDOMNode *aNode);
|
1999-09-29 20:08:15 +00:00
|
|
|
static PRBool IsNormalDiv(nsIDOMNode *aNode);
|
|
|
|
static PRBool IsMozDiv(nsIDOMNode *aNode);
|
1999-09-06 19:51:59 +00:00
|
|
|
static PRBool IsMailCite(nsIDOMNode *aNode);
|
1999-09-09 22:22:14 +00:00
|
|
|
|
|
|
|
|
1999-11-01 15:15:35 +00:00
|
|
|
nsresult IsEmptyBlock(nsIDOMNode *aNode,
|
|
|
|
PRBool *outIsEmptyBlock,
|
|
|
|
PRBool aMozBRDoesntCount = PR_FALSE,
|
|
|
|
PRBool aListItemsNotEmpty = PR_FALSE);
|
|
|
|
nsresult IsEmptyNode(nsIDOMNode *aNode,
|
|
|
|
PRBool *outIsEmptyBlock,
|
|
|
|
PRBool aMozBRDoesntCount = PR_FALSE,
|
|
|
|
PRBool aListItemsNotEmpty = PR_FALSE);
|
1999-11-25 00:19:45 +00:00
|
|
|
PRBool IsDescendantOf(nsIDOMNode *aNode, nsIDOMNode *aParent);
|
1999-07-01 18:42:28 +00:00
|
|
|
PRBool IsFirstNode(nsIDOMNode *aNode);
|
|
|
|
PRBool IsLastNode(nsIDOMNode *aNode);
|
1999-09-29 20:08:15 +00:00
|
|
|
PRBool AtStartOfBlock(nsIDOMNode *aNode, PRInt32 aOffset, nsIDOMNode *aBlock);
|
|
|
|
PRBool AtEndOfBlock(nsIDOMNode *aNode, PRInt32 aOffset, nsIDOMNode *aBlock);
|
1999-11-25 00:19:45 +00:00
|
|
|
|
1999-07-01 18:42:28 +00:00
|
|
|
nsresult GetPromotedPoint(RulesEndpoint aWhere, nsIDOMNode *aNode, PRInt32 aOffset,
|
|
|
|
PRInt32 actionID, nsCOMPtr<nsIDOMNode> *outNode, PRInt32 *outOffset);
|
|
|
|
nsresult GetPromotedRanges(nsIDOMSelection *inSelection,
|
|
|
|
nsCOMPtr<nsISupportsArray> *outArrayOfRanges,
|
|
|
|
PRInt32 inOperationType);
|
1999-11-25 00:19:45 +00:00
|
|
|
nsresult PromoteRange(nsIDOMRange *inRange, PRInt32 inOperationType);
|
1999-08-18 08:13:06 +00:00
|
|
|
nsresult GetNodesForOperation(nsISupportsArray *inArrayOfRanges,
|
1999-07-01 13:42:03 +00:00
|
|
|
nsCOMPtr<nsISupportsArray> *outArrayOfNodes,
|
|
|
|
PRInt32 inOperationType);
|
1999-08-18 08:13:06 +00:00
|
|
|
nsresult GetChildNodesForOperation(nsIDOMNode *inNode,
|
|
|
|
nsCOMPtr<nsISupportsArray> *outArrayOfNodes);
|
|
|
|
nsresult MakeTransitionList(nsISupportsArray *inArrayOfNodes,
|
1999-07-01 13:42:03 +00:00
|
|
|
nsVoidArray *inTransitionArray);
|
1999-08-18 08:13:06 +00:00
|
|
|
|
|
|
|
nsresult ShouldMakeEmptyBlock(nsIDOMSelection *aSelection, const nsString *blockTag, PRBool *outMakeEmpty);
|
|
|
|
nsresult ApplyBlockStyle(nsISupportsArray *arrayOfNodes, const nsString *aBlockTag);
|
|
|
|
|
|
|
|
nsresult ReplaceContainer(nsIDOMNode *inNode, nsCOMPtr<nsIDOMNode> *outNode, const nsString &aNodeType);
|
2000-01-04 03:09:41 +00:00
|
|
|
nsresult RemoveContainer(nsIDOMNode *inNode, PRBool aAddBRIfNeeded=PR_FALSE);
|
1999-09-29 20:08:15 +00:00
|
|
|
nsresult InsertContainerAbove(nsIDOMNode *inNode, nsCOMPtr<nsIDOMNode> *outNode, const nsString &aNodeType);
|
1999-06-16 05:02:43 +00:00
|
|
|
|
1999-09-01 21:23:47 +00:00
|
|
|
nsresult JoinNodesSmart( nsIDOMNode *aNodeLeft,
|
|
|
|
nsIDOMNode *aNodeRight,
|
|
|
|
nsCOMPtr<nsIDOMNode> *aOutMergeParent,
|
|
|
|
PRInt32 *aOutMergeOffset);
|
|
|
|
|
1999-09-06 19:51:59 +00:00
|
|
|
nsresult GetTopEnclosingMailCite(nsIDOMNode *aNode, nsCOMPtr<nsIDOMNode> *aOutCiteNode);
|
|
|
|
nsresult PopListItem(nsIDOMNode *aListItem, PRBool *aOutOfList);
|
|
|
|
|
1999-11-25 00:19:45 +00:00
|
|
|
nsresult AdjustSpecialBreaks();
|
1999-11-30 21:58:37 +00:00
|
|
|
nsresult AdjustWhitespace(nsIDOMSelection *aSelection);
|
1999-12-07 08:30:19 +00:00
|
|
|
nsresult AdjustSelection(nsIDOMSelection *aSelection, nsIEditor::EDirection aAction);
|
|
|
|
nsresult FindNearTextNode(nsIDOMNode *aSelNode,
|
|
|
|
PRInt32 aSelOffset,
|
|
|
|
nsIEditor::EDirection aDirection,
|
|
|
|
nsCOMPtr<nsIDOMNode> *outTextNode);
|
1999-11-25 00:19:45 +00:00
|
|
|
nsresult RemoveEmptyNodes();
|
|
|
|
nsresult DoTextNodeWhitespace(nsIDOMCharacterData *aTextNode, PRInt32 aStart, PRInt32 aEnd);
|
|
|
|
nsresult UpdateDocChangeRange(nsIDOMRange *aRange);
|
|
|
|
|
1999-11-25 00:36:34 +00:00
|
|
|
nsresult ConvertWhitespace(const nsString & inString, nsString & outString);
|
1999-11-25 00:19:45 +00:00
|
|
|
|
|
|
|
// removed from use:
|
|
|
|
#if 0
|
|
|
|
nsresult AddTrailerBR(nsIDOMNode *aNode);
|
|
|
|
nsresult CreateMozDiv(nsIDOMNode *inParent, PRInt32 inOffset, nsCOMPtr<nsIDOMNode> *outDiv);
|
|
|
|
#endif
|
|
|
|
|
|
|
|
// data members
|
|
|
|
protected:
|
|
|
|
nsCOMPtr<nsIEditActionListener> mListener;
|
|
|
|
nsCOMPtr<nsIDOMRange> mDocChangeRange;
|
|
|
|
|
|
|
|
// friends
|
|
|
|
friend class nsHTMLEditListener;
|
|
|
|
friend nsresult NS_NewEditListener(nsIEditActionListener **aResult,
|
|
|
|
nsHTMLEditor *htmlEditor,
|
|
|
|
nsHTMLEditRules *htmlRules);
|
|
|
|
|
|
|
|
};
|
|
|
|
|
|
|
|
class nsHTMLEditListener : public nsIEditActionListener
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
nsHTMLEditListener(nsHTMLEditor *htmlEditor, nsHTMLEditRules *htmlRules);
|
|
|
|
virtual ~nsHTMLEditListener();
|
|
|
|
NS_DECL_ISUPPORTS
|
|
|
|
|
|
|
|
// nsIEditActionListener methods
|
|
|
|
|
|
|
|
NS_IMETHOD WillCreateNode(const nsString& aTag, nsIDOMNode *aParent, PRInt32 aPosition);
|
|
|
|
NS_IMETHOD DidCreateNode(const nsString& aTag, nsIDOMNode *aNode, nsIDOMNode *aParent, PRInt32 aPosition, nsresult aResult);
|
|
|
|
NS_IMETHOD WillInsertNode(nsIDOMNode *aNode, nsIDOMNode *aParent, PRInt32 aPosition);
|
|
|
|
NS_IMETHOD DidInsertNode(nsIDOMNode *aNode, nsIDOMNode *aParent, PRInt32 aPosition, nsresult aResult);
|
|
|
|
NS_IMETHOD WillDeleteNode(nsIDOMNode *aChild);
|
|
|
|
NS_IMETHOD DidDeleteNode(nsIDOMNode *aChild, nsresult aResult);
|
|
|
|
NS_IMETHOD WillSplitNode(nsIDOMNode *aExistingRightNode, PRInt32 aOffset);
|
|
|
|
NS_IMETHOD DidSplitNode(nsIDOMNode *aExistingRightNode, PRInt32 aOffset, nsIDOMNode *aNewLeftNode, nsresult aResult);
|
|
|
|
NS_IMETHOD WillJoinNodes(nsIDOMNode *aLeftNode, nsIDOMNode *aRightNode, nsIDOMNode *aParent);
|
|
|
|
NS_IMETHOD DidJoinNodes(nsIDOMNode *aLeftNode, nsIDOMNode *aRightNode, nsIDOMNode *aParent, nsresult aResult);
|
|
|
|
NS_IMETHOD WillInsertText(nsIDOMCharacterData *aTextNode, PRInt32 aOffset, const nsString &aString);
|
|
|
|
NS_IMETHOD DidInsertText(nsIDOMCharacterData *aTextNode, PRInt32 aOffset, const nsString &aString, nsresult aResult);
|
|
|
|
NS_IMETHOD WillDeleteText(nsIDOMCharacterData *aTextNode, PRInt32 aOffset, PRInt32 aLength);
|
|
|
|
NS_IMETHOD DidDeleteText(nsIDOMCharacterData *aTextNode, PRInt32 aOffset, PRInt32 aLength, nsresult aResult);
|
1999-12-07 08:30:19 +00:00
|
|
|
NS_IMETHOD WillDeleteSelection(nsIDOMSelection *aSelection);
|
|
|
|
NS_IMETHOD DidDeleteSelection(nsIDOMSelection *aSelection);
|
1999-11-25 00:19:45 +00:00
|
|
|
|
|
|
|
protected:
|
|
|
|
|
|
|
|
nsresult MakeRangeFromNode(nsIDOMNode *inNode, nsCOMPtr<nsIDOMRange> *outRange);
|
|
|
|
nsresult MakeRangeFromTextOffsets(nsIDOMCharacterData *inNode,
|
|
|
|
PRInt32 inStart,
|
|
|
|
PRInt32 inEnd,
|
|
|
|
nsCOMPtr<nsIDOMRange> *outRange);
|
|
|
|
PRBool IsDescendantOfBody(nsIDOMNode *inNode) ;
|
|
|
|
|
|
|
|
// data members
|
|
|
|
nsHTMLEditor *mEditor;
|
|
|
|
nsHTMLEditRules *mRules;
|
|
|
|
nsCOMPtr<nsIDOMNode> mBody;
|
1999-03-29 06:21:01 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
#endif //nsHTMLEditRules_h__
|
|
|
|
|