feat: togglable message log window size (cataclysmbnteam#2511)

* feat: expand message log window to full height i can't believe it was this simple! * feat: widen message log display * feat: local keybind for toggling messages * feat: add local keybinding for messages * style: use for loop to load keybindings * feat: togglable messages * feat: use wide display by default, use full height * refactor: remove unnessary mark_resize in `init` * refactor: simplify `set_size` we're not providing way to customize message log dimension so using struct is overkill. * chore: remove duplicate <locale> * refactor: move all keybindings to `data/raw/keybindings/` * refactor: separate `user_keybindings` pre-step for furthur refactorings * refactor: resursively load `data/raw/` * feat: add `TOGGLE_FULL_HEIGHT_DISPLAY` * feat: keep window size persistent i doubt this is the best solution but it works * fix: use `size_t` Co-authored-by: Olanti <[email protected]> * fix: remove redundant `set_size()` Co-authored-by: olanti-p <[email protected]> * fix: clang complaint on `<set>` header inclusion * feat: persistent wide and height size * feat: make option description less verbose Co-authored-by: Olanti <[email protected]> * feat: add description for toggleable description on messages panel * refactor: use more specific name for msg window uistate Co-authored-by: olanti-p <[email protected]> --------- Co-authored-by: Olanti <[email protected]>
KheirFerrum · Apr 9, 2023 · e70c60b · e70c60b
1 parent 7945cd7
commit e70c60b
Show file tree

Hide file tree

Showing 9 changed files with 92 additions and 58 deletions.
diff --git a/data/raw/keybindings.json → data/raw/keybindings/keybindings.json b/data/raw/keybindings.json → data/raw/keybindings/keybindings.json
diff --git a/data/raw/keybindings/messages.json b/data/raw/keybindings/messages.json
@@ -0,0 +1,16 @@
+[
+  {
+    "id": "TOGGLE_WIDE_DISPLAY",
+    "type": "keybinding",
+    "category": "MESSAGE_LOG",
+    "name": "Toggle wide display",
+    "bindings": [ { "input_method": "keyboard", "key": "w" } ]
+  },
+  {
+    "id": "TOGGLE_FULL_HEIGHT_DISPLAY",
+    "type": "keybinding",
+    "category": "MESSAGE_LOG",
+    "name": "Toggle full height display",
+    "bindings": [ { "input_method": "keyboard", "key": "h" } ]
+  }
+]
diff --git a/src/input.cpp b/src/input.cpp
@@ -116,21 +116,16 @@ void input_manager::init()
     init_keycode_mapping();
     reset_timeout();
 
-    try {
-        load( PATH_INFO::keybindings(), false );
-    } catch( const JsonError &err ) {
-        throw std::runtime_error( err.what() );
-    }
-    try {
-        load( PATH_INFO::keybindings_vehicle(), false );
-    } catch( const JsonError &err ) {
-        throw std::runtime_error( err.what() );
-    }
-    try {
-        load( PATH_INFO::keybindings_edit_creature(), false );
-    } catch( const JsonError &err ) {
-        throw std::runtime_error( err.what() );
+    // recursively load all keybindings from the data/raw directory
+    for( const auto &file : get_files_from_path( ".json", PATH_INFO::keybindingsdir(), true, true ) ) {
+        try {
+            load( file, false );
+        } catch( const JsonError &err ) {
+            throw std::runtime_error( err.what() );
+        }
     }
+
+    // user keybindings are searched from separate directory
     try {
         load( PATH_INFO::user_keybindings(), true );
     } catch( const JsonError &err ) {
@@ -464,8 +459,9 @@ std::string input_manager::get_keyname( int ch, input_event_t inp_type, bool por
 const std::vector<input_event> &input_manager::get_input_for_action( const std::string
         &action_descriptor, const std::string &context, bool *overwrites_default )
 {
-    const action_attributes &attributes = get_action_attributes( action_descriptor, context,
-                                          overwrites_default );
+    const action_attributes &attributes =
+        get_action_attributes( action_descriptor, context, overwrites_default );
+
     return attributes.input_events;
 }
 
@@ -720,12 +716,10 @@ std::string input_context::key_bound_to( const std::string &action_descriptor, c
 
 std::string input_context::get_available_single_char_hotkeys( std::string requested_keys )
 {
-    for( std::vector<std::string>::const_iterator registered_action = registered_actions.begin();
-         registered_action != registered_actions.end();
-         ++registered_action ) {
+    for( const auto &registered_action : registered_actions ) {
+        const std::vector<input_event> &events =
+            inp_mngr.get_input_for_action( registered_action, category );
 
-        const std::vector<input_event> &events = inp_mngr.get_input_for_action( *registered_action,
-                category );
         for( const auto &events_event : events ) {
             // Only consider keyboard events without modifiers
             if( events_event.type == CATA_INPUT_KEYBOARD && events_event.modifiers.empty() ) {

diff --git a/src/messages.cpp b/src/messages.cpp
@@ -1,5 +1,4 @@
 #include "messages.h"
-
 #include "calendar.h"
 #include "catacharset.h"
 #include "color.h"
@@ -17,6 +16,7 @@
 #include "string_utils.h"
 #include "translations.h"
 #include "ui_manager.h"
+#include "uistate.h"
 
 #if defined(__ANDROID__)
 #include <optional>
@@ -398,17 +398,20 @@ static bool msg_type_from_name( game_message_type &type, const std::string &name
 
 namespace Messages
 {
+
 // NOLINTNEXTLINE(cata-xy)
 class dialog
 {
     public:
         dialog();
         void run();
     private:
+        void init_first_time();
         void init( ui_adaptor &ui );
         void show();
-        void input();
+        void input( const ui_adaptor &ui );
         void do_filter( const std::string &filter_str );
+        void set_size();
         static std::vector<std::string> filter_help_text( int width );
 
         const nc_color border_color;
@@ -474,29 +477,43 @@ Messages::dialog::dialog()
 {
 }
 
-void Messages::dialog::init( ui_adaptor &ui )
+inline void Messages::dialog::set_size()
 {
-    w_width = std::min( TERMX, FULL_SCREEN_WIDTH );
-    w_height = std::min( TERMY, FULL_SCREEN_HEIGHT );
+    w_width
+        = std::min( TERMX, static_cast<int>( FULL_SCREEN_WIDTH * ( uistate.msg_window_wide_display ? 1.8 :
+                    1 ) ) );
+    w_height = std::min( TERMY, uistate.msg_window_full_height_display ? TERMY : FULL_SCREEN_HEIGHT );
     w_x = ( TERMX - w_width ) / 2;
     w_y = ( TERMY - w_height ) / 2;
+}
+
+void Messages::dialog::init_first_time()
+{
+    ctxt = input_context( "MESSAGE_LOG" );
+    ctxt.register_action( "UP", to_translation( "Scroll up" ) );
+    ctxt.register_action( "DOWN", to_translation( "Scroll down" ) );
+
+    static auto actionnames = {
+        "PAGE_UP", "PAGE_DOWN", "FILTER", "RESET_FILTER",
+        "QUIT", "HELP_KEYBINDINGS", "TOGGLE_WIDE_DISPLAY", "TOGGLE_FULL_HEIGHT_DISPLAY"
+    };
+    for( const auto &actionname : actionnames ) {
+        ctxt.register_action( actionname );
+    }
+
+    // Calculate time string display width. The translated strings are expected to
+    // be aligned, so we choose an arbitrary duration here to calculate the width.
+    time_width = utf8_width( to_string_clipped( 1_turns, clipped_align::right ) );
+}
+
+void Messages::dialog::init( ui_adaptor &ui )
+{
+    set_size();
 
     w = catacurses::newwin( w_height, w_width, point( w_x, w_y ) );
 
     if( first_init ) {
-        ctxt = input_context( "MESSAGE_LOG" );
-        ctxt.register_action( "UP", to_translation( "Scroll up" ) );
-        ctxt.register_action( "DOWN", to_translation( "Scroll down" ) );
-        ctxt.register_action( "PAGE_UP" );
-        ctxt.register_action( "PAGE_DOWN" );
-        ctxt.register_action( "FILTER" );
-        ctxt.register_action( "RESET_FILTER" );
-        ctxt.register_action( "QUIT" );
-        ctxt.register_action( "HELP_KEYBINDINGS" );
-
-        // Calculate time string display width. The translated strings are expected to
-        // be aligned, so we choose an arbitrary duration here to calculate the width.
-        time_width = utf8_width( to_string_clipped( 1_turns, clipped_align::right ) );
+        init_first_time();
     }
 
     if( border_width * 2 + time_width + padding_width >= w_width ||
@@ -512,7 +529,7 @@ void Messages::dialog::init( ui_adaptor &ui )
     w_fh_width = w_width;
     w_fh_x = w_x;
     help_text = filter_help_text( w_fh_width - border_width * 2 );
-    w_fh_height = help_text.size() + border_width * 2;
+    w_fh_height = static_cast<int>( help_text.size() ) + border_width * 2;
     w_fh_y = w_y + w_height - w_fh_height;
     w_filter_help = catacurses::newwin( w_fh_height, w_fh_width, point( w_fh_x, w_fh_y ) );
 
@@ -635,8 +652,10 @@ void Messages::dialog::show()
     } else {
         if( filter_str.empty() ) {
             mvwprintz( w, point( border_width, w_height - 1 ), border_color,
-                       _( "< Press %s to filter, %s to reset >" ),
-                       ctxt.get_desc( "FILTER" ), ctxt.get_desc( "RESET_FILTER" ) );
+                       _( "< Press %s to filter, %s to reset, %s or %s to adjust size >" ),
+                       ctxt.get_desc( "FILTER" ), ctxt.get_desc( "RESET_FILTER" ),
+                       ctxt.get_desc( "TOGGLE_WIDE_DISPLAY" ), ctxt.get_desc( "TOGGLE_FULL_HEIGHT_DISPLAY" )
+                     );
         } else {
             mvwprintz( w, point( border_width, w_height - 1 ), border_color, "< %s >", filter_str );
             mvwprintz( w, point( border_width + 2, w_height - 1 ), filter_color, "%s", filter_str );
@@ -683,7 +702,7 @@ void Messages::dialog::do_filter( const std::string &filter_str )
     }
 }
 
-void Messages::dialog::input()
+void Messages::dialog::input( const ui_adaptor &ui )
 {
     canceled = false;
     if( filtering ) {
@@ -739,6 +758,13 @@ void Messages::dialog::input()
             do_filter( filter_str );
         } else if( action == "QUIT" ) {
             canceled = true;
+        } else if( action == "TOGGLE_WIDE_DISPLAY" || action == "TOGGLE_FULL_HEIGHT_DISPLAY" ) {
+            if( action == "TOGGLE_WIDE_DISPLAY" ) {
+                uistate.msg_window_wide_display = !uistate.msg_window_wide_display;
+            } else {
+                uistate.msg_window_full_height_display = !uistate.msg_window_full_height_display;
+            }
+            ui.mark_resize();
         }
     }
 }
@@ -756,7 +782,7 @@ void Messages::dialog::run()
 
     while( !errored && !canceled ) {
         ui_manager::redraw();
-        input();
+        input( ui );
     }
 }
 

diff --git a/src/options.cpp b/src/options.cpp
@@ -48,7 +48,6 @@
 #include <algorithm>
 #include <cstdlib>
 #include <exception>
-#include <locale>
 #include <memory>
 #include <sstream>
 #include <string>

diff --git a/src/path_info.cpp b/src/path_info.cpp
@@ -207,17 +207,9 @@ std::string PATH_INFO::help()
 {
     return datadir_value + "help/" + "texts.json";
 }
-std::string PATH_INFO::keybindings()
+std::string PATH_INFO::keybindingsdir()
 {
-    return datadir_value + "raw/" + "keybindings.json";
-}
-std::string PATH_INFO::keybindings_vehicle()
-{
-    return datadir_value + "raw/" + "keybindings/vehicle.json";
-}
-std::string PATH_INFO::keybindings_edit_creature()
-{
-    return datadir_value + "raw/" + "keybindings/edit_creature_effects.json";
+    return datadir_value + "raw/keybindings/";
 }
 std::string PATH_INFO::main_menu_tips()
 {

diff --git a/src/path_info.h b/src/path_info.h
@@ -31,9 +31,7 @@ std::string user_fontdir();
 std::string language_defs_file();
 std::string graveyarddir();
 std::string help();
-std::string keybindings();
-std::string keybindings_vehicle();
-std::string keybindings_edit_creature();
+std::string keybindingsdir();
 std::string main_menu_tips();
 std::string lastworld();
 std::string memorialdir();

diff --git a/src/savegame_json.cpp b/src/savegame_json.cpp
@@ -4295,6 +4295,8 @@ void uistatedata::serialize( JsonOut &json ) const
     json.member( "bionic_ui_sort_mode", bionic_sort_mode );
     json.member( "overmap_debug_weather", overmap_debug_weather );
     json.member( "overmap_visible_weather", overmap_visible_weather );
+    json.member( "msg_window_wide_display", msg_window_wide_display );
+    json.member( "msg_window_full_height_display", msg_window_full_height_display );
 
     json.member( "input_history" );
     json.start_object();
@@ -4343,6 +4345,8 @@ void uistatedata::deserialize( const JsonObject &jo )
     jo.read( "bionic_ui_sort_mode", bionic_sort_mode );
     jo.read( "overmap_debug_weather", overmap_debug_weather );
     jo.read( "overmap_visible_weather", overmap_visible_weather );
+    jo.read( "msg_window_wide_display", msg_window_wide_display );
+    jo.read( "msg_window_full_height_display", msg_window_full_height_display );
 
     if( !jo.read( "vmenu_show_items", vmenu_show_items ) ) {
         // This is an old save: 1 means view items, 2 means view monsters,

diff --git a/src/uistate.h b/src/uistate.h
@@ -4,6 +4,7 @@
 
 #include <list>
 #include <map>
+#include <set>
 #include <optional>
 #include <string>
 #include <vector>
@@ -150,6 +151,10 @@ class uistatedata
 
         std::map<ammotype, itype_id> lastreload; // id of ammo last used when reloading ammotype
 
+        // Wide and tall display for messages window
+        bool msg_window_wide_display = false;
+        bool msg_window_full_height_display = false;
+
         // internal stuff
         bool _testing_save = true; // internal: whine on json errors. set false if no complaints in 2 weeks.
         bool _really_testing_save = false; // internal: spammy