Merge branch 'master' into resizing

Author: flagarde

.github/workflows/macOS.yml

@@ -91,7 +91,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        version: [ 9, 10, 11 ]
+        version: [ 10, 11, 12 ]
         standard: [ 11, 14, 17, 20 ]
 
     steps:

cpp-terminal/CMakeLists.txt

@@ -4,13 +4,13 @@ configure_file(version.hpp.in version.hpp)
 add_subdirectory(platforms)
 
 # create and configure library target
-add_library(cpp-terminal base.cpp prompt.cpp window.cpp input.cpp terminal.cpp color.cpp key.cpp event.cpp screen.cpp)
+add_library(cpp-terminal base.cpp prompt.cpp window.cpp input.cpp terminal.cpp color.cpp key.cpp event.cpp screen.cpp options.cpp)
 target_link_libraries(cpp-terminal PRIVATE Warnings::Warnings cpp-terminal::cpp-terminal-platforms)
 target_compile_options(cpp-terminal PRIVATE $<$<CXX_COMPILER_ID:MSVC>:/utf-8>)
 target_include_directories(cpp-terminal PUBLIC $<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}> $<BUILD_INTERFACE:${PROJECT_BINARY_DIR}> $<INSTALL_INTERFACE:include>)
 
 set_target_properties(cpp-terminal PROPERTIES
-        PUBLIC_HEADER "${CMAKE_CURRENT_SOURCE_DIR}/event.hpp;${CMAKE_CURRENT_SOURCE_DIR}/key.hpp;${CMAKE_CURRENT_SOURCE_DIR}/tty.hpp;${CMAKE_CURRENT_SOURCE_DIR}/terminal.hpp;${CMAKE_CURRENT_SOURCE_DIR}/base.hpp;${CMAKE_CURRENT_SOURCE_DIR}/prompt.hpp;${CMAKE_CURRENT_SOURCE_DIR}/window.hpp;${CMAKE_CURRENT_BINARY_DIR}/version.hpp"
+        PUBLIC_HEADER "${CMAKE_CURRENT_SOURCE_DIR}/options.hpp;${CMAKE_CURRENT_SOURCE_DIR}/event.hpp;${CMAKE_CURRENT_SOURCE_DIR}/key.hpp;${CMAKE_CURRENT_SOURCE_DIR}/tty.hpp;${CMAKE_CURRENT_SOURCE_DIR}/terminal.hpp;${CMAKE_CURRENT_SOURCE_DIR}/base.hpp;${CMAKE_CURRENT_SOURCE_DIR}/prompt.hpp;${CMAKE_CURRENT_SOURCE_DIR}/window.hpp;${CMAKE_CURRENT_BINARY_DIR}/version.hpp"
         PRIVATE_HEADER "${CMAKE_CURRENT_SOURCE_DIR}/platforms/conversion.hpp;${CMAKE_CURRENT_SOURCE_DIR}/platforms/macros.hpp")
 
 add_library(cpp-terminal::cpp-terminal ALIAS cpp-terminal)

cpp-terminal/options.cpp

@@ -0,0 +1,12 @@
+#include "cpp-terminal/options.hpp"
+
+#include <algorithm>
+Term::Options::Options(const std::vector<Option>& options) : m_Options(options) {}
+
+// Return true is the option is set and not its opposite (* + No* = false)
+bool Term::Options::has(const Option& option)
+{
+  if(std::find(m_Options.begin(), m_Options.end(), option) != m_Options.end() && std::find(m_Options.begin(), m_Options.end(), static_cast<Options::Option>(-1 * static_cast<std::int16_t>(option))) == m_Options.end()) return true;
+  else
+    return false;
+}

cpp-terminal/options.hpp

@@ -0,0 +1,32 @@
+#pragma once
+
+#include <cstdint>
+#include <vector>
+
+namespace Term
+{
+
+class Options
+{
+public:
+  enum class Option : int
+  {
+    // Don't use 0!
+    ClearScreen   = 1,
+    NoClearScreen = -1,
+    SignalKeys    = 2,
+    NoSignalKeys  = -2,
+    Cursor        = 3,
+    NoCursor      = -3,
+  };
+  Options(const std::vector<Option>& options);
+  bool has(const Option& option);
+  ~Options() {}
+
+private:
+  std::vector<Option> m_Options;
+};
+
+typedef Term::Options::Option Option;
+
+}  // namespace Term

cpp-terminal/platforms/terminal.cpp

@@ -51,7 +51,7 @@ void Term::Terminal::store_and_restore()
     CloseHandle(hConIn);
   }
 #else
-  static termios orig_termios;
+  static termios orig_termios{};
   static int     fd{open("/dev/tty", O_RDWR, O_NOCTTY)};
   if(!enabled)
   {
@@ -91,7 +91,7 @@ void Term::Terminal::setRawMode()
   flags = {0};
   if(!GetConsoleMode(hConIn, &flags)) { throw Term::Exception("GetConsoleMode() failed"); }
   if(m_terminfo.hasANSIEscapeCode()) { flags |= ENABLE_VIRTUAL_TERMINAL_INPUT; }
-  if(disable_signal_keys) { flags &= ~ENABLE_PROCESSED_INPUT; }
+  if(m_options.has(Option::NoSignalKeys)) { flags &= ~ENABLE_PROCESSED_INPUT; }
   flags &= ~(ENABLE_LINE_INPUT | ENABLE_ECHO_INPUT);
   if(!SetConsoleMode(hConIn, flags)) { throw Term::Exception("SetConsoleMode() failed"); }
   CloseHandle(hConOut);
@@ -110,7 +110,7 @@ void Term::Terminal::setRawMode()
     // raw.c_oflag &= ~(OPOST);
     raw.c_cflag |= CS8;
     raw.c_lflag &= ~(ECHO | ICANON | IEXTEN);
-    if(disable_signal_keys) { raw.c_lflag &= ~ISIG; }
+    if(m_options.has(Option::NoSignalKeys)) { raw.c_lflag &= ~ISIG; }
     raw.c_cc[VMIN]  = 0;
     raw.c_cc[VTIME] = 0;
     if(tcsetattr(fd, TCSAFLUSH, &raw) == -1) { throw Term::Exception("tcsetattr() failed"); }

cpp-terminal/prompt.cpp

@@ -10,7 +10,7 @@
 
 Term::Result Term::prompt(const std::string& message, const std::string& first_option, const std::string& second_option, const std::string& prompt_indicator, bool immediate)
 {
-  Terminal term(false, true, false);
+  Terminal term({Option::NoClearScreen, Option::NoSignalKeys, Option::Cursor});
   std::cout << message << " [" << first_option << '/' << second_option << ']' << prompt_indicator << ' ' << std::flush;
 
   if(!Term::is_stdin_a_tty())

cpp-terminal/terminal.cpp

@@ -4,29 +4,28 @@
 
 #include <iostream>
 
-Term::Terminal::Terminal(const bool& _clear_screen, const bool& _disable_signal_keys, const bool& _hide_cursor) : clear_screen{_clear_screen}, disable_signal_keys{_disable_signal_keys}, hide_cursor{_hide_cursor}
+Term::Terminal::Terminal(const std::vector<Term::Options::Option>& options) : m_options(options)
 {
   attachConsole();
   store_and_restore();
   setRawMode();
-  if(clear_screen)
+  if(m_options.has(Option::ClearScreen))
   {
     // Fix consoles that ignore save_screen()
     std::cout << screen_save() << clear_buffer() << style(Style::RESET) << cursor_move(1, 1);
   }
-  if(hide_cursor) std::cout << cursor_off();
-  // flush stdout
+  if(m_options.has(Option::NoCursor)) std::cout << cursor_off();
   std::cout << std::flush;
 }
 
 Term::Terminal::~Terminal()
 {
-  if(clear_screen)
+  if(m_options.has(Option::ClearScreen))
   {
     // Fix consoles that ignore save_screen()
-    std::cout << clear_buffer() << style(Style::RESET) << cursor_move(1, 1) << screen_load();
+    std::cout << clear_buffer() << style(Style::RESET) << cursor_move(1, 1) << screen_load() << std::flush;
   }
-  if(hide_cursor) std::cout << cursor_on();
+  if(m_options.has(Option::NoCursor)) std::cout << cursor_on() << std::flush;
   // flush the output stream
   std::cout << std::flush;
   detachConsole();

cpp-terminal/terminal.hpp

@@ -1,5 +1,6 @@
 #pragma once
 
+#include "cpp-terminal/options.hpp"
 #include "cpp-terminal/terminfo.hpp"
 
 #include <cstdio>
@@ -12,10 +13,11 @@ namespace Term
  * terminal will not be left in a good state. Terminal uses exceptions when
  * something goes wrong.
  */
+
 class Terminal
 {
 public:
-  Terminal(const bool& _clear_screen = false, const bool& _disable_signal_keys = true, const bool& _hide_cursor = false);
+  Terminal(const std::vector<Term::Options::Option>& options = {});
   ~Terminal();
 
 private:
@@ -26,11 +28,9 @@ class Terminal
   void           setRawMode();
   void           attachConsole();
   void           detachConsole();
-  bool           clear_screen{};
-  bool           disable_signal_keys{true};
-  bool           hide_cursor{};
   bool           has_allocated_console{false};
   Term::Terminfo m_terminfo;
+  Term::Options  m_options;
 };
 
 }  // namespace Term

examples/keys.cpp

@@ -22,7 +22,7 @@ int main()
       std::cout << "The terminal is not attached to a TTY and therefore can't catch user input. Exiting...\n";
       return 1;
     }
-    Term::Terminal                      term(true, true, false);
+    Term::Terminal                      term({Term::Option::NoClearScreen, Term::Option::NoSignalKeys, Term::Option::Cursor});
     std::pair<std::size_t, std::size_t> term_size{Term::get_size()};
     std::cout << Term::cursor_move(1, 1);
     std::cout << "Dimension:" << std::get<1>(term_size) << " " << std::get<0>(term_size) << std::endl;

examples/kilo.cpp

@@ -924,7 +924,7 @@ int main(int argc, char* argv[])
       std::cout << "The terminal is not attached to a TTY and therefore can't catch user input. Exiting...\n";
       return 1;
     }
-    Term::Terminal term(true, true, false);
+    Term::Terminal term({Term::Option::ClearScreen, Term::Option::NoSignalKeys, Term::Option::NoCursor});
     initEditor();
     if(argc >= 2) { editorOpen(argv[1]); }