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 "wtf/Allocator.h"
#include "wtf/Vector.h"
#include "wtf/text/WTFString.h"

namespace blink {

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

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

const int unrequestedTextCheckingSequence = -1;

class TextCheckingRequestData final {
  DISALLOW_NEW();
  friend class SpellCheckRequest;  // For access to m_sequence.
 public:
  TextCheckingRequestData() : m_sequence(unrequestedTextCheckingSequence) {}
  TextCheckingRequestData(int sequence,
                          const String& text,
                          const Vector<uint32_t>& markers,
                          const Vector<unsigned>& offsets)
      : m_sequence(sequence),
        m_text(text),
        m_markers(markers),
        m_offsets(offsets) {}

  int sequence() const { return m_sequence; }
  String text() const { return m_text; }
  const Vector<uint32_t>& markers() const { return m_markers; }
  const Vector<unsigned>& offsets() const { return m_offsets; }

 private:
  int m_sequence;
  String m_text;
  Vector<uint32_t> m_markers;
  Vector<unsigned> m_offsets;
};

class 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