| /* |
| * (C) 1999 Lars Knoll (knoll@kde.org) |
| * (C) 2000 Gunnstein Lye (gunnstein@netcom.no) |
| * (C) 2000 Frederik Holljen (frederik.holljen@hig.no) |
| * (C) 2001 Peter Kelly (pmk@post.com) |
| * Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009 Apple Inc. All rights |
| * reserved. |
| * |
| * This library is free software; you can redistribute it and/or |
| * modify it under the terms of the GNU Library General Public |
| * License as published by the Free Software Foundation; either |
| * version 2 of the License, or (at your option) any later version. |
| * |
| * This library is distributed in the hope that it will be useful, |
| * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
| * Library General Public License for more details. |
| * |
| * You should have received a copy of the GNU Library General Public License |
| * along with this library; see the file COPYING.LIB. If not, write to |
| * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, |
| * Boston, MA 02110-1301, USA. |
| * |
| */ |
| |
| #ifndef Range_h |
| #define Range_h |
| |
| #include "bindings/core/v8/ExceptionStatePlaceholder.h" |
| #include "bindings/core/v8/ScriptWrappable.h" |
| #include "core/CoreExport.h" |
| #include "core/dom/RangeBoundaryPoint.h" |
| #include "platform/geometry/FloatRect.h" |
| #include "platform/geometry/IntRect.h" |
| #include "platform/heap/Handle.h" |
| #include "wtf/Forward.h" |
| |
| namespace blink { |
| |
| class ClientRect; |
| class ClientRectList; |
| class ContainerNode; |
| class Document; |
| class DocumentFragment; |
| class ExceptionState; |
| class FloatQuad; |
| class Node; |
| class NodeWithIndex; |
| class Text; |
| |
| class CORE_EXPORT Range final : public GarbageCollected<Range>, |
| public ScriptWrappable { |
| DEFINE_WRAPPERTYPEINFO(); |
| |
| public: |
| static Range* create(Document&); |
| static Range* create(Document&, |
| Node* startContainer, |
| int startOffset, |
| Node* endContainer, |
| int endOffset); |
| static Range* create(Document&, const Position&, const Position&); |
| static Range* createAdjustedToTreeScope(const TreeScope&, const Position&); |
| |
| void dispose(); |
| |
| Document& ownerDocument() const { |
| DCHECK(m_ownerDocument); |
| return *m_ownerDocument.get(); |
| } |
| Node* startContainer() const { return m_start.container(); } |
| int startOffset() const { return m_start.offset(); } |
| Node* endContainer() const { return m_end.container(); } |
| int endOffset() const { return m_end.offset(); } |
| |
| bool collapsed() const { return m_start == m_end; } |
| bool isConnected() const; |
| |
| Node* commonAncestorContainer() const; |
| static Node* commonAncestorContainer(const Node* containerA, |
| const Node* containerB); |
| void setStart(Node* container, |
| int offset, |
| ExceptionState& = ASSERT_NO_EXCEPTION); |
| void setEnd(Node* container, |
| int offset, |
| ExceptionState& = ASSERT_NO_EXCEPTION); |
| void collapse(bool toStart); |
| bool isNodeFullyContained(Node&) const; |
| bool isPointInRange(Node* refNode, int offset, ExceptionState&) const; |
| short comparePoint(Node* refNode, int offset, ExceptionState&) const; |
| enum CompareResults { |
| NODE_BEFORE, |
| NODE_AFTER, |
| NODE_BEFORE_AND_AFTER, |
| NODE_INSIDE |
| }; |
| enum CompareHow { kStartToStart, kStartToEnd, kEndToEnd, kEndToStart }; |
| short compareBoundaryPoints(unsigned how, |
| const Range* sourceRange, |
| ExceptionState&) const; |
| static short compareBoundaryPoints(Node* containerA, |
| int offsetA, |
| Node* containerB, |
| int offsetB, |
| ExceptionState&); |
| static short compareBoundaryPoints(const RangeBoundaryPoint& boundaryA, |
| const RangeBoundaryPoint& boundaryB, |
| ExceptionState&); |
| bool boundaryPointsValid() const; |
| bool intersectsNode(Node* refNode, ExceptionState&); |
| static bool intersectsNode(Node* refNode, |
| const Position& start, |
| const Position& end, |
| ExceptionState&); |
| void deleteContents(ExceptionState&); |
| DocumentFragment* extractContents(ExceptionState&); |
| DocumentFragment* cloneContents(ExceptionState&); |
| void insertNode(Node*, ExceptionState&); |
| String toString() const; |
| |
| String text() const; |
| |
| DocumentFragment* createContextualFragment(const String& html, |
| ExceptionState&); |
| |
| void detach(); |
| Range* cloneRange() const; |
| |
| void setStartAfter(Node*, ExceptionState& = ASSERT_NO_EXCEPTION); |
| void setEndBefore(Node*, ExceptionState& = ASSERT_NO_EXCEPTION); |
| void setEndAfter(Node*, ExceptionState& = ASSERT_NO_EXCEPTION); |
| void selectNode(Node*, ExceptionState& = ASSERT_NO_EXCEPTION); |
| void selectNodeContents(Node*, ExceptionState&); |
| static bool selectNodeContents(Node*, Position&, Position&); |
| void surroundContents(Node*, ExceptionState&); |
| void setStartBefore(Node*, ExceptionState& = ASSERT_NO_EXCEPTION); |
| |
| const Position startPosition() const { return m_start.toPosition(); } |
| const Position endPosition() const { return m_end.toPosition(); } |
| void setStart(const Position&, ExceptionState& = ASSERT_NO_EXCEPTION); |
| void setEnd(const Position&, ExceptionState& = ASSERT_NO_EXCEPTION); |
| |
| Node* firstNode() const; |
| Node* pastLastNode() const; |
| |
| // Not transform-friendly |
| void textRects(Vector<IntRect>&, bool useSelectionHeight = false) const; |
| IntRect boundingBox() const; |
| |
| // Transform-friendly |
| void textQuads(Vector<FloatQuad>&, bool useSelectionHeight = false) const; |
| void getBorderAndTextQuads(Vector<FloatQuad>&) const; |
| FloatRect boundingRect() const; |
| |
| void nodeChildrenWillBeRemoved(ContainerNode&); |
| void nodeWillBeRemoved(Node&); |
| |
| void didInsertText(Node*, unsigned offset, unsigned length); |
| void didRemoveText(Node*, unsigned offset, unsigned length); |
| void didMergeTextNodes(const NodeWithIndex& oldNode, unsigned offset); |
| void didSplitTextNode(Text& oldNode); |
| void updateOwnerDocumentIfNeeded(); |
| |
| // Expand range to a unit (word or sentence or block or document) boundary. |
| // Please refer to https://bugs.webkit.org/show_bug.cgi?id=27632 comment #5 |
| // for details. |
| void expand(const String&, ExceptionState&); |
| |
| ClientRectList* getClientRects() const; |
| ClientRect* getBoundingClientRect() const; |
| |
| static Node* checkNodeWOffset(Node*, int offset, ExceptionState&); |
| |
| DECLARE_TRACE(); |
| |
| private: |
| explicit Range(Document&); |
| Range(Document&, |
| Node* startContainer, |
| int startOffset, |
| Node* endContainer, |
| int endOffset); |
| |
| void setDocument(Document&); |
| |
| void checkNodeBA(Node*, ExceptionState&) const; |
| void checkExtractPrecondition(ExceptionState&); |
| |
| enum ActionType { DELETE_CONTENTS, EXTRACT_CONTENTS, CLONE_CONTENTS }; |
| DocumentFragment* processContents(ActionType, ExceptionState&); |
| static Node* processContentsBetweenOffsets(ActionType, |
| DocumentFragment*, |
| Node*, |
| unsigned startOffset, |
| unsigned endOffset, |
| ExceptionState&); |
| static void processNodes(ActionType, |
| HeapVector<Member<Node>>&, |
| Node* oldContainer, |
| Node* newContainer, |
| ExceptionState&); |
| enum ContentsProcessDirection { |
| ProcessContentsForward, |
| ProcessContentsBackward |
| }; |
| static Node* processAncestorsAndTheirSiblings(ActionType, |
| Node* container, |
| ContentsProcessDirection, |
| Node* clonedContainer, |
| Node* commonRoot, |
| ExceptionState&); |
| |
| Member<Document> m_ownerDocument; // Cannot be null. |
| RangeBoundaryPoint m_start; |
| RangeBoundaryPoint m_end; |
| }; |
| |
| CORE_EXPORT bool areRangesEqual(const Range*, const Range*); |
| |
| using RangeVector = HeapVector<Member<Range>>; |
| |
| } // namespace blink |
| |
| #ifndef NDEBUG |
| // Outside the WebCore namespace for ease of invocation from gdb. |
| void showTree(const blink::Range*); |
| #endif |
| |
| #endif // Range_h |
