// Copyright 2010-2021, 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_COMMAND_REWRITER_H_
#define MOZC_REWRITER_COMMAND_REWRITER_H_

#include <cstddef>

#include "converter/segments.h"
#include "protocol/config.pb.h"
#include "request/conversion_request.h"
#include "rewriter/rewriter_interface.h"

namespace mozc {

// CommandRewriter is a Rewriter which inserts
// "Command candidates" with which user can change the configurations
// of Suggestions and/or Incogito mode.
class CommandRewriter : public RewriterInterface {
 public:
  CommandRewriter() = default;
  ~CommandRewriter() override = default;

  bool Rewrite(const ConversionRequest &request,
               Segments *segments) const override;

 private:
  bool RewriteSegment(const config::Config &config, Segment *segment) const;

  // Insert a new IncogitoModeToggle Command candidate.
  // Use segment->candidate(base_pos) as a reference candidate.
  // |insert_pos| is the actual position where the new candidate
  // is inserted.
  void InsertIncognitoModeToggleCommand(const config::Config &config,
                                        Segment *segment, size_t reference_pos,
                                        size_t insert_pos) const;

  // Insert a new IncogitoModeToggle Command candidate.
  // Use segment->candidate(base_pos) as a reference candidate.
  // |insert_pos| is the actual position where the new candidate
  // is inserted.
  void InsertDisableAllSuggestionToggleCommand(const config::Config &config,
                                               Segment *segment,
                                               size_t reference_pos,
                                               size_t insert_pos) const;
};

}  // namespace mozc
#endif  // MOZC_REWRITER_COMMAND_REWRITER_H_
