third_party/WebKit/Source/core/editing/spellcheck/SpellCheckRequester.h

/*
 * Copyright (C) 2010 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 SpellCheckRequester_h
#define SpellCheckRequester_h

#include "base/macros.h"
#include "base/memory/scoped_refptr.h"
#include "core/dom/Element.h"
#include "core/dom/Range.h"
#include "core/editing/Forward.h"
#include "core/editing/spellcheck/TextChecking.h"
#include "platform/Timer.h"
#include "platform/wtf/Deque.h"
#include "platform/wtf/Vector.h"
#include "platform/wtf/text/WTFString.h"

namespace blink {

class LocalFrame;
class SpellCheckRequester;
class WebTextCheckClient;

class CORE_EXPORT SpellCheckRequest
    : public GarbageCollectedFinalized<SpellCheckRequest> {
 public:
  static const int kUnrequestedTextCheckingSequence = -1;

  static SpellCheckRequest* Create(const EphemeralRange& checking_range,
                                   int request_number);

  ~SpellCheckRequest();
  void Dispose();

  Range* CheckingRange() const { return checking_range_; }
  Element* RootEditableElement() const { return root_editable_element_; }

  void SetCheckerAndSequence(SpellCheckRequester*, int sequence);
  int Sequence() const { return sequence_; }
  String GetText() const { return text_; }

  bool IsValid() const;
  void DidSucceed(const Vector<TextCheckingResult>&);
  void DidCancel();

  int RequestNumber() const { return request_number_; }

  void Trace(blink::Visitor*);

 private:
  SpellCheckRequest(Range* checking_range, const String&, int request_number);

  Member<SpellCheckRequester> requester_;
  Member<Range> checking_range_;
  Member<Element> root_editable_element_;
  int sequence_ = kUnrequestedTextCheckingSequence;
  String text_;
  int request_number_;
};

class CORE_EXPORT SpellCheckRequester final
    : public GarbageCollectedFinalized<SpellCheckRequester> {
 public:
  static SpellCheckRequester* Create(LocalFrame& frame) {
    return new SpellCheckRequester(frame);
  }

  ~SpellCheckRequester();
  void Trace(blink::Visitor*);

  void RequestCheckingFor(const EphemeralRange&);
  void RequestCheckingFor(const EphemeralRange&, int request_num);
  void CancelCheck();

  int LastRequestSequence() const { return last_request_sequence_; }

  int LastProcessedSequence() const { return last_processed_sequence_; }

  // Exposed for leak detector only, see comment for corresponding
  // SpellChecker method.
  void PrepareForLeakDetection();

 private:
  friend class SpellCheckRequest;

  explicit SpellCheckRequester(LocalFrame&);

  WebTextCheckClient* GetTextCheckerClient() const;
  void TimerFiredToProcessQueuedRequest(TimerBase*);
  void InvokeRequest(SpellCheckRequest*);
  void EnqueueRequest(SpellCheckRequest*);
  bool EnsureValidRequestQueueFor(int sequence);
  void DidCheckSucceed(int sequence, const Vector<TextCheckingResult>&);
  void DidCheckCancel(int sequence);
  void DidCheck(int sequence);

  void ClearProcessingRequest();

  Member<LocalFrame> frame_;
  LocalFrame& GetFrame() const {
    DCHECK(frame_);
    return *frame_;
  }

  int last_request_sequence_;
  int last_processed_sequence_;
  double last_request_time_;

  TaskRunnerTimer<SpellCheckRequester> timer_to_process_queued_request_;

  Member<SpellCheckRequest> processing_request_;

  typedef HeapDeque<Member<SpellCheckRequest>> RequestQueue;
  RequestQueue request_queue_;

  DISALLOW_COPY_AND_ASSIGN(SpellCheckRequester);
};

}  // namespace blink

#endif  // SpellCheckRequester_h