Experimental SDL Console

CMakeLists.txt

@@ -32,6 +32,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)
 
@@ -117,12 +119,24 @@ set(MAIN_SOURCES
 file(GLOB_RECURSE TEST_SOURCES
     LIST_DIRECTORIES false
     *test.cpp)
+list(APPEND TEST_SOURCES Console-posix.cpp SDLConsole_impl.cpp)
 dfhack_test(dfhack-test "${TEST_SOURCES}")
 
-if(WIN32)
-    set(CONSOLE_SOURCES Console-windows.cpp)
+if (NOT DFHACK_SDL_CONSOLE)
+    if(WIN32)
+        set(CONSOLE_SOURCES Console-windows.cpp)
+    else()
+        set(CONSOLE_SOURCES Console-posix.cpp)
+    endif()
+    set(DFCLIENT_CONSOLE_SOURCES ${CONSOLE_SOURCES})
 else()
-    set(CONSOLE_SOURCES Console-posix.cpp)
+    if(WIN32)
+        set(DFCLIENT_CONSOLE_SOURCES Console-windows.cpp)
+    else()
+        set(DFCLIENT_CONSOLE_SOURCES Console-posix.cpp)
+    endif()
+    set(CONSOLE_SOURCES ${DFCLIENT_CONSOLE_SOURCES})
+    list(APPEND CONSOLE_SOURCES Console-sdl.cpp SDLConsole_impl.cpp)
 endif()
 
 set(MAIN_SOURCES_WINDOWS
@@ -372,7 +386,9 @@ add_library(dfhack SHARED ${PROJECT_SOURCES})
 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})
+# SDLConsole requires to be run with df
+target_compile_definitions(dfhack-client PUBLIC DISABLE_SDL_CONSOLE)
 add_dependencies(dfhack-client dfhack)
 
 add_executable(dfhack-run dfhack-run.cpp)

library/Console-posix.cpp

@@ -75,7 +75,7 @@ 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;
 
@@ -833,14 +833,14 @@ namespace DFHack
     };
 }
 
-Console::Console()
+PosixConsole::PosixConsole()
 {
-    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 +849,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 +882,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 +899,7 @@ bool Console::shutdown(void)
     return true;
 }
 
-void Console::begin_batch()
+void PosixConsole::begin_batch()
 {
     //color_ostream::begin_batch();
 
@@ -904,22 +909,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 +933,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 +942,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 +951,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 +989,19 @@ int Console::lineedit(const std::string & prompt, std::string & output, CommandH
     return ret;
 }
 
-void Console::msleep (unsigned int msec)
+void PosixConsole::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;