Experimental SDL Console

CMakeLists.txt

@@ -42,6 +42,7 @@ endif(CMAKE_CONFIGURATION_TYPES)
 option(BUILD_DOCS "Choose whether to build the documentation (requires python and Sphinx)." OFF)
 option(BUILD_DOCS_NO_HTML "Don't build the HTML docs, only the in-game docs." OFF)
 option(REMOVE_SYMBOLS_FROM_DF_STUBS "Remove debug symbols from DF stubs. (Reduces libdfhack size to about half but removes a few useful symbols)" ON)
+option(DFHACK_SDL_CONSOLE "Use experimental SDL console" ON)
 
 macro(CHECK_GCC compiler_path)
     execute_process(COMMAND ${compiler_path} -dumpversion OUTPUT_VARIABLE GCC_VERSION_OUT)

library/CMakeLists.txt

@@ -9,6 +9,8 @@ if(UNIX)
     option(CONSOLE_NO_CATCH "Make the console not catch 'CTRL+C' events for easier debugging." OFF)
 endif()
 
+option(DFHACK_SDL_CONSOLE "Use experimental SDL console" ON)
+
 # Generation
 set(CODEGEN_OUT ${dfapi_SOURCE_DIR}/include/df/codegen.out.xml)
 
@@ -115,14 +117,24 @@ set(MAIN_SOURCES
 file(GLOB_RECURSE TEST_SOURCES
     LIST_DIRECTORIES false
     *test.cpp)
+
+if (DFHACK_SDL_CONSOLE)
+    list(APPEND TEST_SOURCES SDLConsole_impl.cpp)
+endif()
 dfhack_test(dfhack-test "${TEST_SOURCES}")
 
 if(WIN32)
-    set(CONSOLE_SOURCES Console-windows.cpp)
+        set(CONSOLE_SOURCES Console-windows.cpp)
 else()
-    set(CONSOLE_SOURCES Console-posix.cpp)
+        set(CONSOLE_SOURCES Console-posix.cpp)
+endif()
+list(APPEND CONSOLE_SOURCES Console.cpp)
+if (DFHACK_SDL_CONSOLE)
+    list(APPEND CONSOLE_SOURCES Console-sdl.cpp SDLConsole_impl.cpp)
 endif()
 
+set(DFCLIENT_CONSOLE_SOURCES Console.cpp)
+
 set(MAIN_SOURCES_WINDOWS
     ${CONSOLE_SOURCES}
     Hooks.cpp
@@ -374,8 +386,10 @@ target_include_directories(dfhack PRIVATE ${xlsxio_INCLUDES} ${SDL2_INCLUDE_DIRS
 add_dependencies(dfhack generate_proto_core)
 add_dependencies(dfhack generate_headers)
 
-add_library(dfhack-client SHARED RemoteClient.cpp ColorText.cpp MiscUtils.cpp Error.cpp ${PROJECT_PROTO_SRCS} ${CONSOLE_SOURCES})
+add_library(dfhack-client SHARED RemoteClient.cpp ColorText.cpp MiscUtils.cpp Error.cpp ${PROJECT_PROTO_SRCS} ${DFCLIENT_CONSOLE_SOURCES})
 target_include_directories(dfhack-client PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/include ${CMAKE_CURRENT_SOURCE_DIR}/proto)
+target_compile_definitions(dfhack-client PUBLIC BUILD_DFHACK_CLIENT)
+
 add_dependencies(dfhack-client dfhack)
 
 add_executable(dfhack-run dfhack-run.cpp)
@@ -384,6 +398,8 @@ target_include_directories(dfhack-run PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/includ
 add_executable(binpatch binpatch.cpp)
 target_link_libraries(binpatch dfhack-md5)
 
+target_include_directories(dfhack-test PRIVATE ${SDL2_INCLUDE_DIRS})
+
 if(WIN32)
     set_target_properties(dfhack PROPERTIES OUTPUT_NAME "dfhooks_dfhack" )
     set_target_properties(dfhack PROPERTIES COMPILE_FLAGS "/FI\"Export.h\"" )

library/Console-posix.cpp

@@ -75,7 +75,8 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
         _res; })
 #endif
 
-#include "Console.h"
+#include "PosixConsole.h"
+
 #include "Hooks.h"
 using namespace DFHack;
 
@@ -91,51 +92,6 @@ static int isUnsupportedTerm(void)
     return 0;
 }
 
-const char * ANSI_CLS = "\033[2J";
-const char * ANSI_BLACK = "\033[22;30m";
-const char * ANSI_RED = "\033[22;31m";
-const char * ANSI_GREEN = "\033[22;32m";
-const char * ANSI_BROWN = "\033[22;33m";
-const char * ANSI_BLUE = "\033[22;34m";
-const char * ANSI_MAGENTA = "\033[22;35m";
-const char * ANSI_CYAN = "\033[22;36m";
-const char * ANSI_GREY = "\033[22;37m";
-const char * ANSI_DARKGREY = "\033[01;30m";
-const char * ANSI_LIGHTRED = "\033[01;31m";
-const char * ANSI_LIGHTGREEN = "\033[01;32m";
-const char * ANSI_YELLOW = "\033[01;33m";
-const char * ANSI_LIGHTBLUE = "\033[01;34m";
-const char * ANSI_LIGHTMAGENTA = "\033[01;35m";
-const char * ANSI_LIGHTCYAN = "\033[01;36m";
-const char * ANSI_WHITE = "\033[01;37m";
-const char * RESETCOLOR = "\033[0m";
-
-const char * getANSIColor(const int c)
-{
-    switch (c)
-    {
-        case -1: return RESETCOLOR; // HACK! :P
-        case 0 : return ANSI_BLACK;
-        case 1 : return ANSI_BLUE; // non-ANSI
-        case 2 : return ANSI_GREEN;
-        case 3 : return ANSI_CYAN; // non-ANSI
-        case 4 : return ANSI_RED; // non-ANSI
-        case 5 : return ANSI_MAGENTA;
-        case 6 : return ANSI_BROWN;
-        case 7 : return ANSI_GREY;
-        case 8 : return ANSI_DARKGREY;
-        case 9 : return ANSI_LIGHTBLUE; // non-ANSI
-        case 10: return ANSI_LIGHTGREEN;
-        case 11: return ANSI_LIGHTCYAN; // non-ANSI;
-        case 12: return ANSI_LIGHTRED; // non-ANSI;
-        case 13: return ANSI_LIGHTMAGENTA;
-        case 14: return ANSI_YELLOW; // non-ANSI
-        case 15: return ANSI_WHITE;
-        default: return "";
-    }
-}
-
-
 #ifdef HAVE_CUCHAR
 // Use u32string for GCC 6 and later and msvc to allow potable implementation
 using u32string = std::u32string;
@@ -330,10 +286,10 @@ namespace DFHack
         void color(Console::color_value index)
         {
             if(!rawmode)
-                fprintf(dfout_C, "%s", getANSIColor(index));
+                fprintf(dfout_C, "%s", Console::getANSIColor(index));
             else
             {
-                const char * colstr = getANSIColor(index);
+                const char * colstr = Console::getANSIColor(index);
                 int lstr = strlen(colstr);
                 if (::write(STDIN_FILENO,colstr,lstr) == -1)
                     ;
@@ -833,14 +789,14 @@ namespace DFHack
     };
 }
 
-Console::Console()
+PosixConsole::PosixConsole() : Console(this)
 {
-    d = 0;
+    d = nullptr;
     inited = false;
     // we can't create the mutex at this time. the SDL functions aren't hooked yet.
     wlock = new std::recursive_mutex();
 }
-Console::~Console()
+PosixConsole::~PosixConsole()
 {
     assert(!inited);
     if(wlock)
@@ -849,7 +805,7 @@ Console::~Console()
         delete d;
 }
 
-bool Console::init(bool dont_redirect)
+bool PosixConsole::init(bool dont_redirect)
 {
     d = new Private();
     // make our own weird streams so our IO isn't redirected
@@ -882,7 +838,12 @@ bool Console::init(bool dont_redirect)
     return true;
 }
 
-bool Console::shutdown(void)
+bool PosixConsole::is_supported()
+{
+    return !isUnsupportedTerm() && isatty(STDIN_FILENO);
+}
+
+bool PosixConsole::shutdown(void)
 {
     if(!d)
         return true;
@@ -894,7 +855,7 @@ bool Console::shutdown(void)
     return true;
 }
 
-void Console::begin_batch()
+void PosixConsole::begin_batch()
 {
     //color_ostream::begin_batch();
 
@@ -904,22 +865,22 @@ void Console::begin_batch()
         d->begin_batch();
 }
 
-void Console::end_batch()
+void PosixConsole::end_batch()
 {
     if (inited)
         d->end_batch();
 
     wlock->unlock();
 }
 
-void Console::flush_proxy()
+void PosixConsole::flush_proxy()
 {
     std::lock_guard<std::recursive_mutex> lock{*wlock};
     if (inited)
         d->flush();
 }
 
-void Console::add_text(color_value color, const std::string &text)
+void PosixConsole::add_text(color_value color, const std::string &text)
 {
     std::lock_guard<std::recursive_mutex> lock{*wlock};
     if (inited)
@@ -928,7 +889,7 @@ void Console::add_text(color_value color, const std::string &text)
         fwrite(text.data(), 1, text.size(), stderr);
 }
 
-int Console::get_columns(void)
+int PosixConsole::get_columns(void)
 {
     std::lock_guard<std::recursive_mutex> lock{*wlock};
     int ret = Console::FAILURE;
@@ -937,7 +898,7 @@ int Console::get_columns(void)
     return ret;
 }
 
-int Console::get_rows(void)
+int PosixConsole::get_rows(void)
 {
     std::lock_guard<std::recursive_mutex> lock{*wlock};
     int ret = Console::FAILURE;
@@ -946,28 +907,28 @@ int Console::get_rows(void)
     return ret;
 }
 
-void Console::clear()
+void PosixConsole::clear()
 {
     std::lock_guard<std::recursive_mutex> lock{*wlock};
     if(inited)
         d->clear();
 }
 
-void Console::gotoxy(int x, int y)
+void PosixConsole::gotoxy(int x, int y)
 {
     std::lock_guard<std::recursive_mutex> lock{*wlock};
     if(inited)
         d->gotoxy(x,y);
 }
 
-void Console::cursor(bool enable)
+void PosixConsole::cursor(bool enable)
 {
     std::lock_guard<std::recursive_mutex> lock{*wlock};
     if(inited)
         d->cursor(enable);
 }
 
-int Console::lineedit(const std::string & prompt, std::string & output, CommandHistory & ch)
+int PosixConsole::lineedit(const std::string & prompt, std::string & output, CommandHistory & ch)
 {
     std::lock_guard<std::recursive_mutex> lock{*wlock};
     int ret = Console::SHUTDOWN;
@@ -984,19 +945,13 @@ int Console::lineedit(const std::string & prompt, std::string & output, CommandH
     return ret;
 }
 
-void Console::msleep (unsigned int msec)
-{
-    if (msec > 1000) sleep(msec/1000000);
-    usleep((msec % 1000000) * 1000);
-}
-
-bool Console::hide()
+bool PosixConsole::hide()
 {
     //Warmist: don't know if it's possible...
     return false;
 }
 
-bool Console::show()
+bool PosixConsole::show()
 {
     //Warmist: don't know if it's possible...
     return false;