src/third_party/WebKit/Source/core/editing/DOMSelection.h

   1 /*
   2  * Copyright (C) 2007 Apple Inc.  All rights reserved.
   3  * Copyright (C) 2012 Google Inc.  All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  *
   9  * 1.  Redistributions of source code must retain the above copyright
  10  *     notice, this list of conditions and the following disclaimer.
  11  * 2.  Redistributions in binary form must reproduce the above copyright
  12  *     notice, this list of conditions and the following disclaimer in the
  13  *     documentation and/or other materials provided with the distribution.
  14  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
  15  *     its contributors may be used to endorse or promote products derived
  16  *     from this software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
  19  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  20  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  21  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
  22  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  23  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  24  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  25  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28  */
  29
  30
  31 #ifndef DOMSelection_h
  32 #define DOMSelection_h
  33
  34 #include "bindings/core/v8/ScriptWrappable.h"
  35 #include "core/frame/DOMWindowProperty.h"
  36 #include "platform/heap/Handle.h"
  37 #include "wtf/Forward.h"
  38 #include "wtf/PassRefPtr.h"
  39 #include "wtf/RefCounted.h"
  40
  41 namespace blink {
  42
  43 class ExceptionState;
  44 class Node;
  45 class Position;
  46 class Range;
  47 class TreeScope;
  48 class VisibleSelection;
  49
  50 class DOMSelection final : public RefCountedWillBeGarbageCollected<DOMSelection>, public ScriptWrappable, public DOMWindowProperty {
  51     DEFINE_WRAPPERTYPEINFO();
  52     WILL_BE_USING_GARBAGE_COLLECTED_MIXIN(DOMSelection);
  53 public:
  54     static PassRefPtrWillBeRawPtr<DOMSelection> create(const TreeScope* treeScope)
  55     {
  56         return adoptRefWillBeNoop(new DOMSelection(treeScope));
  57     }
  58
  59     void clearTreeScope();
  60
  61     // Safari Selection Object API
  62     // These methods return the valid equivalents of internal editing positions.
  63     Node* baseNode() const;
  64     int baseOffset() const;
  65     Node* extentNode() const;
  66     int extentOffset() const;
  67     String type() const;
  68     void setBaseAndExtent(Node* baseNode, int baseOffset, Node* extentNode, int extentOffset, ExceptionState&);
  69     void modify(const String& alter, const String& direction, const String& granularity);
  70
  71     // Mozilla Selection Object API
  72     // In Firefox, anchor/focus are the equal to the start/end of the selection,
  73     // but reflect the direction in which the selection was made by the user. That does
  74     // not mean that they are base/extent, since the base/extent don't reflect
  75     // expansion.
  76     // These methods return the valid equivalents of internal editing positions.
  77     Node* anchorNode() const;
  78     int anchorOffset() const;
  79     Node* focusNode() const;
  80     int focusOffset() const;
  81     bool isCollapsed() const;
  82     int rangeCount() const;
  83     void collapse(Node*, int offset, ExceptionState&);
  84     void collapseToEnd(ExceptionState&);
  85     void collapseToStart(ExceptionState&);
  86     void extend(Node*, int offset, ExceptionState&);
  87     PassRefPtrWillBeRawPtr<Range> getRangeAt(int, ExceptionState&);
  88     void removeAllRanges();
  89     void addRange(Range*);
  90     void deleteFromDocument();
  91     bool containsNode(const Node*, bool partlyContained) const;
  92     void selectAllChildren(Node*, ExceptionState&);
  93
  94     String toString();
  95
  96     // Microsoft Selection Object API
  97     void empty();
  98
  99     virtual void trace(Visitor*) override;
 100
 101 private:
 102     explicit DOMSelection(const TreeScope*);
 103
 104     // Convenience method for accessors, does not check m_frame present.
 105     const VisibleSelection& visibleSelection() const;
 106
 107     Node* shadowAdjustedNode(const Position&) const;
 108     int shadowAdjustedOffset(const Position&) const;
 109
 110     bool isValidForPosition(Node*) const;
 111
 112     void addConsoleError(const String& message);
 113
 114     RawPtrWillBeMember<const TreeScope> m_treeScope;
 115 };
 116
 117 } // namespace blink
 118
 119 #endif // DOMSelection_h