src/rewriter/usage_rewriter.h

// Copyright 2010-2015, 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 MOZC_REWRITER_USAGE_REWRITER_H_
#define MOZC_REWRITER_USAGE_REWRITER_H_

#include <list>
#include <map>
#include <string>
#include <utility>

#include "converter/segments.h"
#include "rewriter/rewriter_interface.h"
#include "rewriter/usage_rewriter_data_structs.h"
#include "testing/base/public/gunit_prod.h"  // for FRIEND_TEST()

namespace mozc {

class ConversionRequest;
class DataManagerInterface;
class DictionaryInterface;
class POSMatcher;

class UsageRewriter : public RewriterInterface  {
 public:
  UsageRewriter(const DataManagerInterface *data_manager,
                const DictionaryInterface *dictionary);
  virtual ~UsageRewriter();
  virtual bool Rewrite(const ConversionRequest &request,
                       Segments *segments) const;

  // better to show usage when user type "tab" key.
  virtual int capability(const ConversionRequest &request) const {
    return CONVERSION | PREDICTION;
  }

 private:
  FRIEND_TEST(UsageRewriterTest, GetKanjiPrefixAndOneHiragana);

  typedef pair<string, string> StrPair;
  static string GetKanjiPrefixAndOneHiragana(const string &word);

  const UsageDictItem *LookupUnmatchedUsageHeuristically(
      const Segment::Candidate &candidate) const;
  const UsageDictItem *LookupUsage(
      const Segment::Candidate &candidate) const;

  map<StrPair, const UsageDictItem *> key_value_usageitem_map_;
  const POSMatcher *pos_matcher_;
  const DictionaryInterface *dictionary_;
  const ConjugationSuffix *base_conjugation_suffix_;
};

}  // namespace mozc

#endif  // MOZC_REWRITER_USAGE_REWRITER_H_