gecko-dev/editor/libeditor/text/nsTextEditRules.h

307 lines
11 KiB
C
Raw Normal View History

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* ***** BEGIN LICENSE BLOCK *****
* Version: NPL 1.1/GPL 2.0/LGPL 2.1
*
* 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/
*
* 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 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 NPL, 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 NPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
#ifndef nsTextEditRules_h__
#define nsTextEditRules_h__
#include "nsCOMPtr.h"
#include "nsPlaintextEditor.h"
#include "nsIDOMNode.h"
#include "nsEditRules.h"
/** Object that encapsulates HTML text-specific editing rules.
*
* To be a good citizen, edit rules must live by these restrictions:
* 1. All data manipulation is through the editor.
* Content nodes in the document tree must <B>not</B> be manipulated directly.
* Content nodes in document fragments that are not part of the document itself
* may be manipulated at will. Operations on document fragments must <B>not</B>
* go through the editor.
* 2. Selection must not be explicitly set by the rule method.
* Any manipulation of Selection must be done by the editor.
*/
class nsTextEditRules : public nsIEditRules
{
public:
NS_DECL_ISUPPORTS
nsTextEditRules();
virtual ~nsTextEditRules();
// nsIEditRules methods
NS_IMETHOD Init(nsPlaintextEditor *aEditor, PRUint32 aFlags);
NS_IMETHOD BeforeEdit(PRInt32 action, nsIEditor::EDirection aDirection);
NS_IMETHOD AfterEdit(PRInt32 action, nsIEditor::EDirection aDirection);
NS_IMETHOD WillDoAction(nsISelection *aSelection, nsRulesInfo *aInfo, PRBool *aCancel, PRBool *aHandled);
NS_IMETHOD DidDoAction(nsISelection *aSelection, nsRulesInfo *aInfo, nsresult aResult);
Preparation for ender-based text control * added focus listener. Doesn't do much yet, but when focus notifications start appearing, we'll be ready for them. The code is in place to hide selection when we lose focus and paint selection when we get focus. That's probably not quite right, but it's a start. We will need to be able to determine the distinction between losing focus to another control within our app, and losing focus to another app. * added support for disabled and readonly states in the editor. This is accomplished by having flags set by the client, and letting the rules system deal with those flags. The flags I added are: TEXT_EDITOR_FLAG_PLAINTEXT 0x01 // only plain text editing is allowed TEXT_EDITOR_FLAG_SINGLELINE 0x02 // enter key and CR-LF handled specially TEXT_EDITOR_FLAG_PASSWORD 0x04 // text is not entered into content, only a representative character TEXT_EDITOR_FLAG_READONLY 0x08 // editing events are disabled. Editor may still accept focus. TEXT_EDITOR_FLAG_DISALBED 0x10 // all events are disabled (like scrolling). Editor will not accept focus. * added WillInsertBreak/DidInsertBreak into text rules, so flags could be checked. This gets us readonly, disabled, and single line behavior. * cleaned up the code that allocates, registers, and destroys event listeners. Thanks to Kin and Simon for cleaning up the ownership model on the listeners, it was a big help. * added support for a max text length. You can now tell the text editor, be no bigger than n characters.
1999-05-28 21:24:18 +00:00
NS_IMETHOD GetFlags(PRUint32 *aFlags);
NS_IMETHOD SetFlags(PRUint32 aFlags);
NS_IMETHOD DocumentIsEmpty(PRBool *aDocumentIsEmpty);
1999-04-05 17:21:59 +00:00
// nsTextEditRules action id's
enum
{
1999-09-17 23:15:12 +00:00
kDefault = 0,
// any editor that has a txn mgr
1999-09-17 23:15:12 +00:00
kUndo = 1000,
kRedo = 1001,
// text actions
1999-09-17 23:15:12 +00:00
kInsertText = 2000,
kInsertTextIME = 2001,
kDeleteSelection = 2002,
kSetTextProperty = 2003,
kRemoveTextProperty = 2004,
kOutputText = 2005,
// html only action
1999-09-17 23:15:12 +00:00
kInsertBreak = 3000,
kMakeList = 3001,
kIndent = 3002,
kOutdent = 3003,
kAlign = 3004,
kMakeBasicBlock = 3005,
kRemoveList = 3006,
kMakeDefListItem = 3007,
kInsertElement = 3008,
kLoadHTML = 3013,
kSetAbsolutePosition = 3015,
kRemoveAbsolutePosition = 3016,
kDecreaseZIndex = 3017,
kIncreaseZIndex = 3018
1999-04-05 17:21:59 +00:00
};
public:
nsresult ResetIMETextPWBuf();
1999-04-05 17:21:59 +00:00
protected:
1999-04-05 17:21:59 +00:00
// nsTextEditRules implementation methods
nsresult WillInsertText( PRInt32 aAction,
nsISelection *aSelection,
PRBool *aCancel,
PRBool *aHandled,
const nsAString *inString,
nsAString *outString,
PRInt32 aMaxLength);
nsresult DidInsertText(nsISelection *aSelection, nsresult aResult);
nsresult GetTopEnclosingPre(nsIDOMNode *aNode, nsIDOMNode** aOutPreNode);
nsresult WillInsertBreak(nsISelection *aSelection, PRBool *aCancel, PRBool *aHandled);
nsresult DidInsertBreak(nsISelection *aSelection, nsresult aResult);
Preparation for ender-based text control * added focus listener. Doesn't do much yet, but when focus notifications start appearing, we'll be ready for them. The code is in place to hide selection when we lose focus and paint selection when we get focus. That's probably not quite right, but it's a start. We will need to be able to determine the distinction between losing focus to another control within our app, and losing focus to another app. * added support for disabled and readonly states in the editor. This is accomplished by having flags set by the client, and letting the rules system deal with those flags. The flags I added are: TEXT_EDITOR_FLAG_PLAINTEXT 0x01 // only plain text editing is allowed TEXT_EDITOR_FLAG_SINGLELINE 0x02 // enter key and CR-LF handled specially TEXT_EDITOR_FLAG_PASSWORD 0x04 // text is not entered into content, only a representative character TEXT_EDITOR_FLAG_READONLY 0x08 // editing events are disabled. Editor may still accept focus. TEXT_EDITOR_FLAG_DISALBED 0x10 // all events are disabled (like scrolling). Editor will not accept focus. * added WillInsertBreak/DidInsertBreak into text rules, so flags could be checked. This gets us readonly, disabled, and single line behavior. * cleaned up the code that allocates, registers, and destroys event listeners. Thanks to Kin and Simon for cleaning up the ownership model on the listeners, it was a big help. * added support for a max text length. You can now tell the text editor, be no bigger than n characters.
1999-05-28 21:24:18 +00:00
nsresult WillInsert(nsISelection *aSelection, PRBool *aCancel);
nsresult DidInsert(nsISelection *aSelection, nsresult aResult);
nsresult WillDeleteSelection(nsISelection *aSelection,
nsIEditor::EDirection aCollapsedAction,
PRBool *aCancel,
PRBool *aHandled);
nsresult DidDeleteSelection(nsISelection *aSelection,
nsIEditor::EDirection aCollapsedAction,
1999-06-24 23:36:56 +00:00
nsresult aResult);
nsresult WillSetTextProperty(nsISelection *aSelection, PRBool *aCancel, PRBool *aHandled);
nsresult DidSetTextProperty(nsISelection *aSelection, nsresult aResult);
nsresult WillRemoveTextProperty(nsISelection *aSelection, PRBool *aCancel, PRBool *aHandled);
nsresult DidRemoveTextProperty(nsISelection *aSelection, nsresult aResult);
nsresult WillUndo(nsISelection *aSelection, PRBool *aCancel, PRBool *aHandled);
nsresult DidUndo(nsISelection *aSelection, nsresult aResult);
nsresult WillRedo(nsISelection *aSelection, PRBool *aCancel, PRBool *aHandled);
nsresult DidRedo(nsISelection *aSelection, nsresult aResult);
/** called prior to nsIEditor::OutputToString
* @param aSelection
* @param aInFormat the format requested for the output, a MIME type
* @param aOutText the string to use for output, if aCancel is set to true
* @param aOutCancel if set to PR_TRUE, the caller should cancel the operation
* and use aOutText as the result.
*/
nsresult WillOutputText(nsISelection *aSelection,
const nsAString *aInFormat,
nsAString *aOutText,
PRBool *aOutCancel,
PRBool *aHandled);
nsresult DidOutputText(nsISelection *aSelection, nsresult aResult);
1999-06-24 23:36:56 +00:00
// helper functions
/** replaces newllines with breaks, if needed. acts on doc portion in aRange */
nsresult ReplaceNewlines(nsIDOMRange *aRange);
/** creates a trailing break in the text doc if there is not one already */
nsresult CreateTrailingBRIfNeeded();
/** creates a bogus text node if the document has no editable content */
nsresult CreateBogusNodeIfNeeded(nsISelection *aSelection);
1999-06-24 23:36:56 +00:00
/** returns a truncated insertion string if insertion would place us
over aMaxLength */
nsresult TruncateInsertionIfNeeded(nsISelection *aSelection,
const nsAString *aInString,
nsAString *aOutString,
PRInt32 aMaxLength);
/** Echo's the insertion text into the password buffer, and converts
insertion text to '*'s */
nsresult EchoInsertionToPWBuff(PRInt32 aStart, PRInt32 aEnd, nsAString *aOutString);
/** Remove IME composition text from password buffer */
nsresult RemoveIMETextFromPWBuf(PRInt32 &aStart, nsAString *aIMEString);
nsresult CreateMozBR(nsIDOMNode *inParent, PRInt32 inOffset, nsCOMPtr<nsIDOMNode> *outBRNode);
nsresult CheckBidiLevelForDeletion(nsIDOMNode *aSelNode,
PRInt32 aSelOffset,
nsIEditor::EDirection aAction,
PRBool *aCancel);
// data members
nsPlaintextEditor *mEditor; // note that we do not refcount the editor
nsString mPasswordText; // a buffer we use to store the real value of password editors
nsString mPasswordIMEText; // a buffer we use to track the IME composition string
PRInt32 mPasswordIMEIndex;
nsCOMPtr<nsIDOMNode> mBogusNode; // magic node acts as placeholder in empty doc
nsCOMPtr<nsIDOMNode> mBody; // cached root node
PRUint32 mFlags;
PRUint32 mActionNesting;
PRPackedBool mLockRulesSniffing;
PRPackedBool mDidExplicitlySetInterline;
PRInt32 mTheAction; // the top level editor action
// friends
friend class nsAutoLockRulesSniffing;
};
1999-04-12 12:01:32 +00:00
class nsTextRulesInfo : public nsRulesInfo
{
public:
1999-06-24 23:36:56 +00:00
nsTextRulesInfo(int aAction) :
nsRulesInfo(aAction),
inString(0),
outString(0),
outputFormat(0),
1999-06-24 23:36:56 +00:00
maxLength(-1),
collapsedAction(nsIEditor::eNext),
bOrdered(PR_FALSE),
entireList(PR_FALSE),
bulletType(0),
1999-08-09 22:51:40 +00:00
alignType(0),
blockType(0),
1999-08-09 22:51:40 +00:00
insertElement(0)
1999-06-24 23:36:56 +00:00
{};
virtual ~nsTextRulesInfo() {};
1999-04-12 12:01:32 +00:00
// kInsertText
const nsAString *inString;
nsAString *outString;
const nsAString *outputFormat;
PRInt32 maxLength;
1999-04-26 14:08:52 +00:00
// kDeleteSelection
nsIEditor::EDirection collapsedAction;
// kMakeList
PRBool bOrdered;
PRBool entireList;
const nsAString *bulletType;
// kAlign
const nsAString *alignType;
1999-08-09 22:51:40 +00:00
// kMakeBasicBlock
const nsAString *blockType;
1999-08-09 22:51:40 +00:00
// kInsertElement
const nsIDOMElement* insertElement;
1999-04-12 12:01:32 +00:00
};
/***************************************************************************
* stack based helper class for StartOperation()/EndOperation() sandwich.
* this class sets a bool letting us know to ignore any rules sniffing
* that tries to occur reentrantly.
*/
class nsAutoLockRulesSniffing
{
public:
nsAutoLockRulesSniffing(nsTextEditRules *rules) : mRules(rules)
{if (mRules) mRules->mLockRulesSniffing = PR_TRUE;}
~nsAutoLockRulesSniffing()
{if (mRules) mRules->mLockRulesSniffing = PR_FALSE;}
protected:
nsTextEditRules *mRules;
};
/***************************************************************************
* stack based helper class for turning on/off the edit listener.
*/
class nsAutoLockListener
{
public:
nsAutoLockListener(PRPackedBool *enabled) : mEnabled(enabled)
{if (mEnabled) { mOldState=*mEnabled; *mEnabled = PR_FALSE;}}
~nsAutoLockListener()
{if (mEnabled) *mEnabled = mOldState;}
protected:
PRPackedBool *mEnabled;
PRPackedBool mOldState;
};
nsresult NS_NewTextEditRules(nsIEditRules** aInstancePtrResult);
#endif //nsTextEditRules_h__