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

/*
 * Copyright (C) 2004 Apple Computer, 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 VisibleSelection_h
#define VisibleSelection_h

#include "core/CoreExport.h"
#include "core/editing/EditingStrategy.h"
#include "core/editing/EphemeralRange.h"
#include "core/editing/SelectionTemplate.h"
#include "core/editing/SelectionType.h"
#include "core/editing/TextAffinity.h"
#include "core/editing/TextGranularity.h"
#include "core/editing/VisiblePosition.h"
#include "core/editing/VisibleUnits.h"
#include "platform/wtf/Allocator.h"

namespace blink {

class SelectionAdjuster;

const TextAffinity kSelDefaultAffinity = TextAffinity::kDownstream;
enum SelectionDirection {
  kDirectionForward,
  kDirectionBackward,
  kDirectionRight,
  kDirectionLeft
};

template <typename Strategy>
class CORE_TEMPLATE_CLASS_EXPORT VisibleSelectionTemplate {
  DISALLOW_NEW();

 public:
  VisibleSelectionTemplate();
  VisibleSelectionTemplate(const VisibleSelectionTemplate&);
  VisibleSelectionTemplate& operator=(const VisibleSelectionTemplate&);

  // Note: |create()| should be used only by |createVisibleSelection|.
  static VisibleSelectionTemplate Create(const SelectionTemplate<Strategy>&);

  SelectionType GetSelectionType() const { return selection_type_; }

  TextAffinity Affinity() const { return affinity_; }

  SelectionTemplate<Strategy> AsSelection() const;
  PositionTemplate<Strategy> Base() const { return base_; }
  PositionTemplate<Strategy> Extent() const { return extent_; }
  PositionTemplate<Strategy> Start() const { return start_; }
  PositionTemplate<Strategy> end() const { return end_; }

  VisiblePositionTemplate<Strategy> VisibleStart() const {
    return CreateVisiblePosition(
        start_, IsRange() ? TextAffinity::kDownstream : Affinity());
  }
  VisiblePositionTemplate<Strategy> VisibleEnd() const {
    return CreateVisiblePosition(
        end_, IsRange() ? TextAffinity::kUpstream : Affinity());
  }
  VisiblePositionTemplate<Strategy> VisibleBase() const {
    return CreateVisiblePosition(
        base_, IsRange() ? (IsBaseFirst() ? TextAffinity::kUpstream
                                          : TextAffinity::kDownstream)
                         : Affinity());
  }
  VisiblePositionTemplate<Strategy> VisibleExtent() const {
    return CreateVisiblePosition(
        extent_, IsRange() ? (IsBaseFirst() ? TextAffinity::kDownstream
                                            : TextAffinity::kUpstream)
                           : Affinity());
  }

  bool operator==(const VisibleSelectionTemplate&) const;
  bool operator!=(const VisibleSelectionTemplate& other) const {
    return !operator==(other);
  }

  bool IsNone() const { return GetSelectionType() == kNoSelection; }
  bool IsCaret() const { return GetSelectionType() == kCaretSelection; }
  bool IsRange() const { return GetSelectionType() == kRangeSelection; }
  bool IsNonOrphanedRange() const {
    return IsRange() && !Start().IsOrphan() && !end().IsOrphan();
  }
  bool IsNonOrphanedCaretOrRange() const {
    return !IsNone() && !Start().IsOrphan() && !end().IsOrphan();
  }

  // True if base() <= extent().
  bool IsBaseFirst() const { return base_is_first_; }
  bool IsDirectional() const { return is_directional_; }

  void AppendTrailingWhitespace();

  // TODO(yosin) Most callers probably don't want these functions, but
  // are using them for historical reasons. |toNormalizedEphemeralRange()|
  // contracts the range around text, and moves the caret most backward
  // visually equivalent position before returning the range/positions.
  EphemeralRangeTemplate<Strategy> ToNormalizedEphemeralRange() const;

  Element* RootEditableElement() const;
  bool IsContentEditable() const;
  bool HasEditableStyle() const;
  bool IsContentRichlyEditable() const;

  bool IsValidFor(const Document&) const;
  void SetWithoutValidation(const PositionTemplate<Strategy>&,
                            const PositionTemplate<Strategy>&);

  DECLARE_TRACE();

#ifndef NDEBUG
  void ShowTreeForThis() const;
#endif
  static void PrintTo(const VisibleSelectionTemplate&, std::ostream*);

 private:
  friend class SelectionAdjuster;

  VisibleSelectionTemplate(const SelectionTemplate<Strategy>&);

  void Validate(TextGranularity = kCharacterGranularity);

  // Support methods for validate()
  void SetBaseAndExtentToDeepEquivalents();
  void AdjustSelectionToAvoidCrossingShadowBoundaries();
  void AdjustSelectionToAvoidCrossingEditingBoundaries();
  void UpdateSelectionType();

  // We need to store these as Positions because VisibleSelection is
  // used to store values in editing commands for use when
  // undoing the command. We need to be able to create a selection that, while
  // currently invalid, will be valid once the changes are undone.

  // Where the first click happened
  PositionTemplate<Strategy> base_;
  // Where the end click happened
  PositionTemplate<Strategy> extent_;
  // Leftmost position when expanded to respect granularity
  PositionTemplate<Strategy> start_;
  // Rightmost position when expanded to respect granularity
  PositionTemplate<Strategy> end_;

  TextAffinity affinity_;  // the upstream/downstream affinity of the caret

  // these are cached, can be recalculated by validate()
  SelectionType selection_type_;  // None, Caret, Range
  bool base_is_first_ : 1;        // True if base is before the extent
  // Non-directional ignores m_baseIsFirst and selection always extends on shift
  // + arrow key.
  bool is_directional_ : 1;

  TextGranularity granularity_;
  // |updateIfNeeded()| uses |m_hasTrailingWhitespace| for word granularity.
  // |m_hasTrailingWhitespace| is set by |appendTrailingWhitespace()|.
  // TODO(yosin): Once we unify start/end and base/extent, we should get rid
  // of |m_hasTrailingWhitespace|.
  bool has_trailing_whitespace_ : 1;
};

extern template class CORE_EXTERN_TEMPLATE_EXPORT
    VisibleSelectionTemplate<EditingStrategy>;
extern template class CORE_EXTERN_TEMPLATE_EXPORT
    VisibleSelectionTemplate<EditingInFlatTreeStrategy>;

using VisibleSelection = VisibleSelectionTemplate<EditingStrategy>;
using VisibleSelectionInFlatTree =
    VisibleSelectionTemplate<EditingInFlatTreeStrategy>;

CORE_EXPORT VisibleSelection CreateVisibleSelection(const SelectionInDOMTree&);
CORE_EXPORT VisibleSelectionInFlatTree
CreateVisibleSelection(const SelectionInFlatTree&);

// We don't yet support multi-range selections, so we only ever have one range
// to return.
CORE_EXPORT EphemeralRange FirstEphemeralRangeOf(const VisibleSelection&);

CORE_EXPORT std::ostream& operator<<(std::ostream&, const VisibleSelection&);
CORE_EXPORT std::ostream& operator<<(std::ostream&,
                                     const VisibleSelectionInFlatTree&);

}  // namespace blink

#ifndef NDEBUG
// Outside the WebCore namespace for ease of invocation from gdb.
void showTree(const blink::VisibleSelection&);
void showTree(const blink::VisibleSelection*);
void showTree(const blink::VisibleSelectionInFlatTree&);
void showTree(const blink::VisibleSelectionInFlatTree*);
#endif

#endif  // VisibleSelection_h