The Tor Browser: comparison editor/libeditor/base/nsEditorUtils.h

--1:000000000000
+:d84c30560c42
+/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/* This Source Code Form is subject to the terms of the Mozilla Public
+* License, v. 2.0. If a copy of the MPL was not distributed with this
+* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+#ifndef nsEditorUtils_h__
+#define nsEditorUtils_h__
+#include "nsCOMPtr.h"
+#include "nsDebug.h"
+#include "nsEditor.h"
+#include "nsIDOMNode.h"
+#include "nsIEditor.h"
+#include "nscore.h"
+class nsIAtom;
+class nsIContentIterator;
+class nsIDOMDocument;
+class nsIDOMRange;
+class nsISelection;
+template <class E> class nsCOMArray;
+/***************************************************************************
+* stack based helper class for batching a collection of txns inside a
+* placeholder txn.
+*/
+class MOZ_STACK_CLASS nsAutoPlaceHolderBatch
+{
+private:
+nsCOMPtr<nsIEditor> mEd;
+public:
+nsAutoPlaceHolderBatch( nsIEditor *aEd, nsIAtom *atom) : mEd(do_QueryInterface(aEd))
+{ if (mEd) mEd->BeginPlaceHolderTransaction(atom); }
+~nsAutoPlaceHolderBatch() { if (mEd) mEd->EndPlaceHolderTransaction(); }
+};
+/***************************************************************************
+* stack based helper class for batching a collection of txns.
+* Note: I changed this to use placeholder batching so that we get
+* proper selection save/restore across undo/redo.
+*/
+class MOZ_STACK_CLASS nsAutoEditBatch : public nsAutoPlaceHolderBatch
+{
+public:
+nsAutoEditBatch( nsIEditor *aEd) : nsAutoPlaceHolderBatch(aEd,nullptr)  {}
+~nsAutoEditBatch() {}
+};
+/***************************************************************************
+* stack based helper class for saving/restoring selection.  Note that this
+* assumes that the nodes involved are still around afterwards!
+*/
+class MOZ_STACK_CLASS nsAutoSelectionReset
+{
+private:
+/** ref-counted reference to the selection that we are supposed to restore */
+nsRefPtr<mozilla::dom::Selection> mSel;
+nsEditor *mEd;  // non-owning ref to nsEditor
+public:
+/** constructor responsible for remembering all state needed to restore aSel */
+nsAutoSelectionReset(mozilla::dom::Selection* aSel, nsEditor* aEd);
+/** destructor restores mSel to its former state */
+~nsAutoSelectionReset();
+/** Abort: cancel selection saver */
+void Abort();
+};
+/***************************************************************************
+* stack based helper class for StartOperation()/EndOperation() sandwich
+*/
+class MOZ_STACK_CLASS nsAutoRules
+{
+public:
+nsAutoRules(nsEditor *ed, EditAction action,
+nsIEditor::EDirection aDirection) :
+mEd(ed), mDoNothing(false)
+{
+if (mEd && !mEd->mAction) // mAction will already be set if this is nested call
+{
+mEd->StartOperation(action, aDirection);
+}
+else mDoNothing = true; // nested calls will end up here
+}
+~nsAutoRules()
+{
+if (mEd && !mDoNothing)
+{
+mEd->EndOperation();
+}
+}
+protected:
+nsEditor *mEd;
+bool mDoNothing;
+};
+/***************************************************************************
+* stack based helper class for turning off active selection adjustment
+* by low level transactions
+*/
+class MOZ_STACK_CLASS nsAutoTxnsConserveSelection
+{
+public:
+nsAutoTxnsConserveSelection(nsEditor *ed) : mEd(ed), mOldState(true)
+{
+if (mEd)
+{
+mOldState = mEd->GetShouldTxnSetSelection();
+mEd->SetShouldTxnSetSelection(false);
+}
+}
+~nsAutoTxnsConserveSelection()
+{
+if (mEd)
+{
+mEd->SetShouldTxnSetSelection(mOldState);
+}
+}
+protected:
+nsEditor *mEd;
+bool mOldState;
+};
+/***************************************************************************
+* stack based helper class for batching reflow and paint requests.
+*/
+class MOZ_STACK_CLASS nsAutoUpdateViewBatch
+{
+public:
+nsAutoUpdateViewBatch(nsEditor *ed) : mEd(ed)
+{
+NS_ASSERTION(mEd, "null mEd pointer!");
+if (mEd)
+mEd->BeginUpdateViewBatch();
+}
+~nsAutoUpdateViewBatch()
+{
+if (mEd)
+mEd->EndUpdateViewBatch();
+}
+protected:
+nsEditor *mEd;
+};
+/******************************************************************************
+* some helper classes for iterating the dom tree
+*****************************************************************************/
+class nsBoolDomIterFunctor
+{
+public:
+virtual bool operator()(nsIDOMNode* aNode)=0;
+};
+class MOZ_STACK_CLASS nsDOMIterator
+{
+public:
+nsDOMIterator();
+virtual ~nsDOMIterator();
+nsresult Init(nsIDOMRange* aRange);
+nsresult Init(nsIDOMNode* aNode);
+nsresult AppendList(nsBoolDomIterFunctor& functor,
+nsCOMArray<nsIDOMNode>& arrayOfNodes) const;
+protected:
+nsCOMPtr<nsIContentIterator> mIter;
+};
+class MOZ_STACK_CLASS nsDOMSubtreeIterator : public nsDOMIterator
+{
+public:
+nsDOMSubtreeIterator();
+virtual ~nsDOMSubtreeIterator();
+nsresult Init(nsIDOMRange* aRange);
+};
+class nsTrivialFunctor : public nsBoolDomIterFunctor
+{
+public:
+virtual bool operator()(nsIDOMNode* aNode)  // used to build list of all nodes iterator covers
+{
+return true;
+}
+};
+/******************************************************************************
+* general dom point utility struct
+*****************************************************************************/
+struct MOZ_STACK_CLASS DOMPoint
+{
+nsCOMPtr<nsIDOMNode> node;
+int32_t offset;
+DOMPoint() : node(0),offset(0) {}
+DOMPoint(nsIDOMNode *aNode, int32_t aOffset) :
+node(aNode),offset(aOffset) {}
+void SetPoint(nsIDOMNode *aNode, int32_t aOffset)
+{
+node = aNode; offset = aOffset;
+}
+void GetPoint(nsCOMPtr<nsIDOMNode> &aNode, int32_t &aOffset)
+{
+aNode = node; aOffset = offset;
+}
+};
+class nsEditorUtils
+{
+public:
+static bool IsDescendantOf(nsIDOMNode *aNode, nsIDOMNode *aParent, int32_t *aOffset = 0);
+static bool IsLeafNode(nsIDOMNode *aNode);
+};
+class nsIDOMEvent;
+class nsISimpleEnumerator;
+class nsITransferable;
+class nsEditorHookUtils
+{
+public:
+static bool     DoInsertionHook(nsIDOMDocument *aDoc, nsIDOMEvent *aEvent,
+nsITransferable *aTrans);
+private:
+static nsresult GetHookEnumeratorFromDocument(nsIDOMDocument *aDoc,
+nsISimpleEnumerator **aEnumerator);
+};
+#endif // nsEditorUtils_h__

The Tor Browser / file comparison

comparison: editor/libeditor/base/nsEditorUtils.h

editor/libeditor/base/nsEditorUtils.h