third_party/WebKit/Source/core/editing/SelectionController.h

/*
 * Copyright (C) 2006, 2007, 2009, 2010, 2011 Apple Inc. All rights reserved.
 * Copyright (C) 2015 Google Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef SelectionController_h
#define SelectionController_h

#include "core/CoreExport.h"
#include "core/dom/SynchronousMutationObserver.h"
#include "core/editing/FrameSelection.h"
#include "core/editing/TextGranularity.h"
#include "core/editing/VisibleSelection.h"
#include "core/page/EventWithHitTestResults.h"
#include "platform/heap/Handle.h"

namespace blink {

class HitTestResult;
class LocalFrame;

class CORE_EXPORT SelectionController final
    : public GarbageCollectedFinalized<SelectionController>,
      public SynchronousMutationObserver {
  WTF_MAKE_NONCOPYABLE(SelectionController);
  USING_GARBAGE_COLLECTED_MIXIN(SelectionController);

 public:
  static SelectionController* create(LocalFrame&);
  virtual ~SelectionController();
  DECLARE_TRACE();

  void handleMousePressEvent(const MouseEventWithHitTestResults&);
  bool handleMousePressEventSingleClick(const MouseEventWithHitTestResults&);
  bool handleMousePressEventDoubleClick(const MouseEventWithHitTestResults&);
  bool handleMousePressEventTripleClick(const MouseEventWithHitTestResults&);
  void handleMouseDraggedEvent(const MouseEventWithHitTestResults&,
                               const IntPoint&,
                               const LayoutPoint&,
                               Node*,
                               const IntPoint&);
  bool handleMouseReleaseEvent(const MouseEventWithHitTestResults&,
                               const LayoutPoint&);
  bool handlePasteGlobalSelection(const WebMouseEvent&);
  bool handleGestureLongPress(const WebGestureEvent&, const HitTestResult&);
  void handleGestureTwoFingerTap(const GestureEventWithHitTestResults&);
  void handleGestureLongTap(const GestureEventWithHitTestResults&);

  void updateSelectionForMouseDrag(Node*, const LayoutPoint&, const IntPoint&);
  void updateSelectionForMouseDrag(const HitTestResult&,
                                   Node*,
                                   const LayoutPoint&,
                                   const IntPoint&);
  void sendContextMenuEvent(const MouseEventWithHitTestResults&,
                            const LayoutPoint&);
  void passMousePressEventToSubframe(const MouseEventWithHitTestResults&);

  void initializeSelectionState();
  void setMouseDownMayStartSelect(bool);
  bool mouseDownMayStartSelect() const;
  bool mouseDownWasSingleClickInSelection() const;
  void notifySelectionChanged();
  bool hasExtendedSelection() const {
    return m_selectionState == SelectionState::ExtendedSelection;
  }

 private:
  friend class SelectionControllerTest;

  explicit SelectionController(LocalFrame&);

  enum class AppendTrailingWhitespace { ShouldAppend, DontAppend };
  enum class SelectInputEventType { Touch, Mouse };
  enum EndPointsAdjustmentMode {
    AdjustEndpointsAtBidiBoundary,
    DoNotAdjustEndpoints
  };

  Document& document() const;

  // Returns |true| if a word was selected.
  bool selectClosestWordFromHitTestResult(const HitTestResult&,
                                          AppendTrailingWhitespace,
                                          SelectInputEventType);
  void selectClosestMisspellingFromHitTestResult(const HitTestResult&,
                                                 AppendTrailingWhitespace);
  void selectClosestWordFromMouseEvent(const MouseEventWithHitTestResults&);
  void selectClosestMisspellingFromMouseEvent(
      const MouseEventWithHitTestResults&);
  void selectClosestWordOrLinkFromMouseEvent(
      const MouseEventWithHitTestResults&);
  void setNonDirectionalSelectionIfNeeded(const SelectionInFlatTree&,
                                          TextGranularity,
                                          EndPointsAdjustmentMode,
                                          HandleVisibility);
  void setCaretAtHitTestResult(const HitTestResult&);
  bool updateSelectionForMouseDownDispatchingSelectStart(
      Node*,
      const VisibleSelectionInFlatTree&,
      TextGranularity,
      HandleVisibility);

  FrameSelection& selection() const;

  // Implements |SynchronousMutationObserver|.
  // TODO(yosin): We should relocate |m_originalBaseInFlatTree| when DOM tree
  // changed.
  void contextDestroyed(Document*) final;

  Member<LocalFrame> const m_frame;
  // TODO(yosin): We should use |PositionWIthAffinityInFlatTree| since we
  // should reduce usage of |VisibleSelectionInFlatTree|.
  // Used to store base before the adjustment at bidi boundary
  VisiblePositionInFlatTree m_originalBaseInFlatTree;
  bool m_mouseDownMayStartSelect;
  bool m_mouseDownWasSingleClickInSelection;
  bool m_mouseDownAllowsMultiClick;
  enum class SelectionState {
    HaveNotStartedSelection,
    PlacedCaret,
    ExtendedSelection
  };
  SelectionState m_selectionState;
};

bool isSelectionOverLink(const MouseEventWithHitTestResults&);
bool isExtendingSelection(const MouseEventWithHitTestResults&);

}  // namespace blink

#endif  // SelectionController_h