third_party/WebKit/Source/platform/text/TextChecking.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.
 *     * 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.
 *     * 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 TextChecking_h
#define TextChecking_h

#include "platform/heap/Handle.h"
#include "platform/text/TextDecoration.h"
#include "platform/wtf/Allocator.h"
#include "platform/wtf/Vector.h"
#include "platform/wtf/text/WTFString.h"

namespace blink {

struct GrammarDetail {
  DISALLOW_NEW_EXCEPT_PLACEMENT_NEW();
  int location;
  int length;
  Vector<String> guesses;
  String user_description;
};

struct TextCheckingResult {
  DISALLOW_NEW_EXCEPT_PLACEMENT_NEW();
  TextDecorationType decoration;
  int location;
  int length;
  Vector<GrammarDetail> details;
  Vector<String> replacements;
};

const int kUnrequestedTextCheckingSequence = -1;

class TextCheckingRequestData final {
  DISALLOW_NEW();
 public:
  TextCheckingRequestData(const String& text)
      : sequence_(kUnrequestedTextCheckingSequence), text_(text) {}

  void SetSequence(int sequence) { sequence_ = sequence; }
  int Sequence() const { return sequence_; }
  String GetText() const { return text_; }

 private:
  int sequence_;
  String text_;
};

class PLATFORM_EXPORT TextCheckingRequest
    : public GarbageCollectedFinalized<TextCheckingRequest> {
 public:
  virtual ~TextCheckingRequest() {}
  DEFINE_INLINE_VIRTUAL_TRACE() {}

  virtual const TextCheckingRequestData& Data() const = 0;
  virtual void DidSucceed(const Vector<TextCheckingResult>&) = 0;
  virtual void DidCancel() = 0;
};

}  // namespace blink

#endif  // TextChecking_h