sdlconsole: Console overhaul. Hacks.

Author: dhthwy

library/CMakeLists.txt

@@ -119,7 +119,7 @@ set(MAIN_SOURCES
 file(GLOB_RECURSE TEST_SOURCES
     LIST_DIRECTORIES false
     *test.cpp)
-list(APPEND TEST_SOURCES SDLConsole_impl.cpp)
+list(APPEND TEST_SOURCES Console-posix.cpp SDLConsole_impl.cpp)
 dfhack_test(dfhack-test "${TEST_SOURCES}")
 
 if (NOT DFHACK_SDL_CONSOLE)
@@ -135,7 +135,8 @@ else()
     else()
         set(DFCLIENT_CONSOLE_SOURCES Console-posix.cpp)
     endif()
-    set(CONSOLE_SOURCES Console-sdl.cpp SDLConsole_impl.cpp)
+    set(CONSOLE_SOURCES ${DFCLIENT_CONSOLE_SOURCES})
+    list(APPEND CONSOLE_SOURCES Console-sdl.cpp SDLConsole_impl.cpp)
 endif()
 
 set(MAIN_SOURCES_WINDOWS
@@ -386,6 +387,8 @@ 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} ${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)
@@ -433,10 +436,6 @@ set_target_properties(dfhack PROPERTIES INTERFACE_LINK_LIBRARIES "")
 target_link_libraries(dfhack-client protobuf-lite clsocket jsoncpp_static)
 target_link_libraries(dfhack-run dfhack-client)
 
-# FIXME: to remove
-#target_link_libraries(dfhack SDL2_image)
-#target_link_libraries(dfhack-client SDL2_image)
-
 if(APPLE)
     add_custom_command(TARGET dfhack-run COMMAND ${dfhack_SOURCE_DIR}/package/darwin/fix-libs.sh WORKING_DIRECTORY ../ COMMENT "Fixing library dependencies...")
 endif()

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;

library/Console-sdl.cpp

@@ -53,7 +53,7 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 #include "df/renderer_2d.h"
 #include <VTableInterpose.h>
 
-#include "Console.h"
+#include "SDLConsoleDriver.h"
 #include "SDLConsole.h"
 
 using namespace DFHack;
@@ -232,14 +232,14 @@ namespace DFHack
     };
 }
 
-Console::Console()
+SDLConsoleDriver::SDLConsoleDriver()
 {
     d = new Private();
     inited.store(false);
     // we can't create the mutex at this time. the SDL functions aren't hooked yet.
     wlock = new std::recursive_mutex();
 }
-Console::~Console()
+SDLConsoleDriver::~SDLConsoleDriver()
 {
     assert(!inited);
     if(wlock)
@@ -252,7 +252,7 @@ Console::~Console()
  * FIXME: Two-stage init because we need to initialize on
  * the main thread, but interpose isn't available until later.
  */
-bool Console::init(bool dont_redirect)
+bool SDLConsoleDriver::init(bool dont_redirect)
 {
     static int init_stage = 0;
 
@@ -276,7 +276,7 @@ bool Console::init(bool dont_redirect)
     return inited.load();
 }
 
-bool Console::shutdown(void)
+bool SDLConsoleDriver::shutdown(void)
 {
     if (!inited.load()) return true;
     d->con.shutdown();
@@ -288,22 +288,22 @@ bool Console::shutdown(void)
  * This should be for guarding against interleaving prints to the console.
  * The begin_batch() and end_batch() pair does the job on its own.
  */
-void Console::begin_batch()
+void SDLConsoleDriver::begin_batch()
 {
     wlock->lock();
 }
 
-void Console::end_batch()
+void SDLConsoleDriver::end_batch()
 {
     wlock->unlock();
 }
 
 /* Don't think we need this? */
-void Console::flush_proxy()
+void SDLConsoleDriver::flush_proxy()
 {
 }
 
-void Console::add_text(color_value color, const std::string &text)
+void SDLConsoleDriver::add_text(color_value color, const std::string &text)
 {
     // I don't think this lock is needed, unless to prevent
     // interleaving prints. But we have batch for that?
@@ -314,33 +314,33 @@ void Console::add_text(color_value color, const std::string &text)
         fwrite(text.data(), 1, text.size(), stderr);
 }
 
-int Console::get_columns(void)
+int SDLConsoleDriver::get_columns(void)
 {
     // returns Console::FAILURE if inactive
     return d->con.get_columns();
 }
 
-int Console::get_rows(void)
+int SDLConsoleDriver::get_rows(void)
 {
     // returns Console::FAILURE if inactive
     return d->con.get_rows();
 }
 
-void Console::clear()
+void SDLConsoleDriver::clear()
 {
     d->con.clear();
 }
 /* XXX: Not implemented */
-void Console::gotoxy(int x, int y)
+void SDLConsoleDriver::gotoxy(int x, int y)
 {
 }
 /* XXX: Not implemented */
-void Console::cursor(bool enable)
+void SDLConsoleDriver::cursor(bool enable)
 {
     d->cursor(enable);
 }
 
-int Console::lineedit(const std::string & prompt, std::string & output, CommandHistory & ch)
+int SDLConsoleDriver::lineedit(const std::string & prompt, std::string & output, CommandHistory & ch)
 {
     // Tell fiothread we are done.
     if(!inited.load())
@@ -349,18 +349,18 @@ int Console::lineedit(const std::string & prompt, std::string & output, CommandH
     return d->lineedit(prompt,output,ch);
 }
 
-void Console::msleep (unsigned int msec)
+void SDLConsoleDriver::msleep (unsigned int msec)
 {
     std::this_thread::sleep_for(std::chrono::milliseconds(msec));
 }
 
-bool Console::hide()
+bool SDLConsoleDriver::hide()
 {
     d->con.hide_window();
     return true;
 }
 
-bool Console::show()
+bool SDLConsoleDriver::show()
 {
     d->con.show_window();
     return true;
@@ -373,7 +373,7 @@ bool Console::show()
  * NOTE: We do not absolutely have to clean up here. It can be done at exit.
  * This is for the ability to shutdown and restart the console at run time.
  */
-bool Console::sdl_event_hook(SDL_Event &e)
+bool SDLConsoleDriver::sdl_event_hook(SDL_Event &e)
 {
     auto& con = d->con;
     if (con.state.is_active()) {
@@ -388,7 +388,7 @@ bool Console::sdl_event_hook(SDL_Event &e)
  * Cleanup must be done from the main thread.
  * NOTE: may be able to do this in the destructor instead.
  */
-void Console::cleanup()
+void SDLConsoleDriver::cleanup()
 {
     INTERPOSE_HOOK(con_render_hook,render).apply(false);
     // destroy() will change console's state to inactive