third_party/WebKit/Source/core/editing/markers/TextMatchMarker.h

/*
 * Copyright (C) 2011 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:
 *
 *     * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *     * Neither the name of Google Inc. nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "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 THE COPYRIGHT
 * OWNER 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 TextMatchMarker_h
#define TextMatchMarker_h

#include "core/editing/markers/DocumentMarker.h"
#include "platform/geometry/LayoutRect.h"

namespace blink {

// A subclass of DocumentMarker used to store information specific to TextMatch
// markers. We store whether or not the match is active, a LayoutRect used for
// rendering the marker, and whether or not the LayoutRect is currently
// up-to-date.
class TextMatchMarker final : public DocumentMarker {
 private:
  enum class State { kInvalid, kValidNull, kValidNotNull };

 public:
  enum class MatchStatus { kInactive, kActive };

  TextMatchMarker(unsigned start_offset,
                  unsigned end_offset,
                  MatchStatus status)
      : DocumentMarker(DocumentMarker::kTextMatch, start_offset, end_offset),
        match_status_(status) {
    layout_state_ = State::kInvalid;
  }

  bool IsActiveMatch() const { return match_status_ == MatchStatus::kActive; }
  void SetIsActiveMatch(bool active) {
    match_status_ = active ? MatchStatus::kActive : MatchStatus::kInactive;
  }

  bool IsRendered() const { return layout_state_ == State::kValidNotNull; }
  bool Contains(const LayoutPoint& point) const {
    DCHECK_EQ(layout_state_, State::kValidNotNull);
    return rendered_rect_.Contains(point);
  }
  void SetRenderedRect(const LayoutRect& rect) {
    if (layout_state_ == State::kValidNotNull && rect == rendered_rect_)
      return;
    layout_state_ = State::kValidNotNull;
    rendered_rect_ = rect;
  }

  const LayoutRect& RenderedRect() const {
    DCHECK_EQ(layout_state_, State::kValidNotNull);
    return rendered_rect_;
  }

  void NullifyRenderedRect() {
    layout_state_ = State::kValidNull;
    // Now |m_renderedRect| can not be accessed until |setRenderedRect| is
    // called.
  }

  void Invalidate() { layout_state_ = State::kInvalid; }
  bool IsValid() const { return layout_state_ != State::kInvalid; }

 private:
  MatchStatus match_status_;
  LayoutRect rendered_rect_;
  State layout_state_;

  DISALLOW_COPY_AND_ASSIGN(TextMatchMarker);
};

DEFINE_TYPE_CASTS(TextMatchMarker,
                  DocumentMarker,
                  marker,
                  marker->GetType() == DocumentMarker::kTextMatch,
                  marker.GetType() == DocumentMarker::kTextMatch);

}  // namespace blink

#endif