// 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.

// Parser of key events

#ifndef MOZC_COMPOSER_KEY_PARSER_H_
#define MOZC_COMPOSER_KEY_PARSER_H_

#include <string>

#include "absl/strings/string_view.h"
#include "absl/types/span.h"
#include "protocol/commands.pb.h"

namespace mozc {

class KeyParser {
 public:
  // Disallow implicit constructors.
  KeyParser() = delete;
  KeyParser(const KeyParser&) = delete;
  KeyParser& operator=(const KeyParser&) = delete;

  static bool ParseKey(absl::string_view key_string,
                       commands::KeyEvent* key_event);
  static bool ParseKeyVector(absl::Span<const std::string> keys,
                             commands::KeyEvent* key_event);

  // Returns corresponding string of SpecialKey (e.g. PAGE_UP → pageup).
  static std::string GetSpecialKeyString(commands::KeyEvent::SpecialKey key);
};

}  // namespace mozc

#endif  // MOZC_COMPOSER_KEY_PARSER_H_
