event.cpp

Go to the documentation of this file.

// Copyright 2020 Arthur Sonzogni. All rights reserved.
// Use of this source code is governed by the MIT license that can be found in
// the LICENSE file.
#include <utility>  // for move
 
#include "ftxui/component/event.hpp"
#include "ftxui/component/mouse.hpp"  // for Mouse
#include "ftxui/screen/string.hpp"    // for to_wstring
 
namespace ftxui {
 
/// @brief An event corresponding to a given typed character.
/// @param input The character typed by the user.
/// @ingroup component
// static
Event Event::Character(std::string input) {
  Event event;
  event.input_ = std::move(input);
  event.type_ = Type::Character;
  return event;
}
 
/// @brief An event corresponding to a given typed character.
/// @param c The character typed by the user.
/// @ingroup component
// static
Event Event::Character(char c) {
  return Event::Character(std::string{c});
}
 
/// @brief An event corresponding to a given typed character.
/// @param c The character typed by the user.
/// @ingroup component
// static
Event Event::Character(wchar_t c) {
  return Event::Character(to_string(std::wstring{c}));
}
 
/// @brief An event corresponding to a given typed character.
/// @param input The sequence of character send by the terminal.
/// @param mouse The mouse state.
/// @ingroup component
// static
Event Event::Mouse(std::string input, struct Mouse mouse) {
  Event event;
  event.input_ = std::move(input);
  event.type_ = Type::Mouse;
  event.data_.mouse = mouse;  // NOLINT
  return event;
}
 
/// @brief An event corresponding to a terminal DCS (Device Control String).
// static
Event Event::CursorShape(std::string input, int shape) {
  Event event;
  event.input_ = std::move(input);
  event.type_ = Type::CursorShape;
  event.data_.cursor_shape = shape;  // NOLINT
  return event;
}
 
/// @brief An custom event whose meaning is defined by the user of the library.
/// @param input An arbitrary sequence of character defined by the developer.
/// @ingroup component.
// static
Event Event::Special(std::string input) {
  Event event;
  event.input_ = std::move(input);
  return event;
}
 
/// @internal
// static
Event Event::CursorPosition(std::string input, int x, int y) {
  Event event;
  event.input_ = std::move(input);
  event.type_ = Type::CursorPosition;
  event.data_.cursor = {x, y};  // NOLINT
  return event;
}
 
// --- Arrow ---
const Event Event::ArrowLeft = Event::Special("\x1B[D");          // NOLINT
const Event Event::ArrowRight = Event::Special("\x1B[C");         // NOLINT
const Event Event::ArrowUp = Event::Special("\x1B[A");            // NOLINT
const Event Event::ArrowDown = Event::Special("\x1B[B");          // NOLINT
const Event Event::ArrowLeftCtrl = Event::Special("\x1B[1;5D");   // NOLINT
const Event Event::ArrowRightCtrl = Event::Special("\x1B[1;5C");  // NOLINT
const Event Event::ArrowUpCtrl = Event::Special("\x1B[1;5A");     // NOLINT
const Event Event::ArrowDownCtrl = Event::Special("\x1B[1;5B");   // NOLINT
const Event Event::Backspace = Event::Special({127});             // NOLINT
const Event Event::Delete = Event::Special("\x1B[3~");            // NOLINT
const Event Event::Escape = Event::Special("\x1B");               // NOLINT
const Event Event::Return = Event::Special({10});                 // NOLINT
const Event Event::Tab = Event::Special({9});                     // NOLINT
const Event Event::TabReverse = Event::Special({27, 91, 90});     // NOLINT
 
// See https://invisible-island.net/xterm/xterm-function-keys.html
// We follow xterm-new / vterm-xf86-v4 / mgt / screen
const Event Event::F1 = Event::Special("\x1BOP");     // NOLINT
const Event Event::F2 = Event::Special("\x1BOQ");     // NOLINT
const Event Event::F3 = Event::Special("\x1BOR");     // NOLINT
const Event Event::F4 = Event::Special("\x1BOS");     // NOLINT
const Event Event::F5 = Event::Special("\x1B[15~");   // NOLINT
const Event Event::F6 = Event::Special("\x1B[17~");   // NOLINT
const Event Event::F7 = Event::Special("\x1B[18~");   // NOLINT
const Event Event::F8 = Event::Special("\x1B[19~");   // NOLINT
const Event Event::F9 = Event::Special("\x1B[20~");   // NOLINT
const Event Event::F10 = Event::Special("\x1B[21~");  // NOLINT
const Event Event::F11 = Event::Special("\x1B[23~");  // NOLINT
const Event Event::F12 = Event::Special("\x1B[24~");  // NOLINT
 
const Event Event::Insert = Event::Special("\x1B[2~");            // NOLINT
const Event Event::Home = Event::Special({27, 91, 72});           // NOLINT
const Event Event::End = Event::Special({27, 91, 70});            // NOLINT
const Event Event::PageUp = Event::Special({27, 91, 53, 126});    // NOLINT
const Event Event::PageDown = Event::Special({27, 91, 54, 126});  // NOLINT
const Event Event::Custom = Event::Special({0});                  // NOLINT
 
}  // namespace ftxui