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 LocalFrame;
  45 class Node;
  46 class Position;
  47 class Range;
  48 class TreeScope;
  49 class VisibleSelection;
  50
  51 class DOMSelection FINAL : public RefCountedWillBeGarbageCollectedFinalized<DOMSelection>, public ScriptWrappable, public DOMWindowProperty {
  52 public:
  53     static PassRefPtrWillBeRawPtr<DOMSelection> create(const TreeScope* treeScope)
  54     {
  55         return adoptRefWillBeNoop(new DOMSelection(treeScope));
  56     }
  57
  58     void clearTreeScope();
  59
  60     // Safari Selection Object API
  61     // These methods return the valid equivalents of internal editing positions.
  62     Node* baseNode() const;
  63     int baseOffset() const;
  64     Node* extentNode() const;
  65     int extentOffset() const;
  66     String type() const;
  67     void setBaseAndExtent(Node* baseNode, int baseOffset, Node* extentNode, int extentOffset, ExceptionState&);
  68     void modify(const String& alter, const String& direction, const String& granularity);
  69
  70     // Mozilla Selection Object API
  71     // In Firefox, anchor/focus are the equal to the start/end of the selection,
  72     // but reflect the direction in which the selection was made by the user. That does
  73     // not mean that they are base/extent, since the base/extent don't reflect
  74     // expansion.
  75     // These methods return the valid equivalents of internal editing positions.
  76     Node* anchorNode() const;
  77     int anchorOffset() const;
  78     Node* focusNode() const;
  79     int focusOffset() const;
  80     bool isCollapsed() const;
  81     int rangeCount() const;
  82     void collapse(Node*, int offset, ExceptionState&);
  83     void collapse(Node*, ExceptionState&);
  84     void collapseToEnd(ExceptionState&);
  85     void collapseToStart(ExceptionState&);
  86     void extend(Node*, int offset, ExceptionState&);
  87     void extend(Node*, ExceptionState&);
  88     PassRefPtrWillBeRawPtr<Range> getRangeAt(int, ExceptionState&);
  89     void removeAllRanges();
  90     void addRange(Range*);
  91     void deleteFromDocument();
  92     bool containsNode(const Node*, bool partlyContained) const;
  93     void selectAllChildren(Node*, ExceptionState&);
  94
  95     String toString();
  96
  97     // Microsoft Selection Object API
  98     void empty();
  99
 100     void trace(Visitor* visitor) { visitor->trace(m_treeScope); }
 101
 102 private:
 103     explicit DOMSelection(const TreeScope*);
 104
 105     // Convenience method for accessors, does not check m_frame present.
 106     const VisibleSelection& visibleSelection() const;
 107
 108     Node* shadowAdjustedNode(const Position&) const;
 109     int shadowAdjustedOffset(const Position&) const;
 110
 111     bool isValidForPosition(Node*) const;
 112
 113     void addConsoleError(const String& message);
 114
 115     RawPtrWillBeMember<const TreeScope> m_treeScope;
 116 };
 117
 118 } // namespace blink
 119
 120 #endif // DOMSelection_h