// libvle -- library for building Vim-like applications
// Copyright (C) 2019 xaizek <xaizek@posteo.net>
//
// This file is part of libvle.
//
// libvle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// libvle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with libvle.  If not, see <https://www.gnu.org/licenses/>.

#ifndef LIBVLE__KEYS_HPP__
#define LIBVLE__KEYS_HPP__

#include <string>

namespace vle {

// Represents a single key to provide operations on it.
class Key
{
public:
    // Remembers the key value.  Throws `std::invalid_argument` if `key` is
    // L'\0'.
    explicit Key(wchar_t key);

public:
    // Adds Control modifier to the key.  Throws `std::logic_error` if `key` is
    // not one of []\[a-zA-Z_^].
    Key & ctrl();

    // Returns the key as a wide string.
    operator std::wstring() const;

private:
    wchar_t key; // The key.
};

}

#endif // LIBVLE__KEYS_HPP__