/***************************************************************************** * Copyright (c) 2014-2018 OpenRCT2 developers * * For a complete list of all authors, please refer to contributors.md * Interested in contributing? Visit https://github.com/OpenRCT2/OpenRCT2 * * OpenRCT2 is licensed under the GNU General Public License version 3. *****************************************************************************/ #include "../interface/Dropdown.h" #include "ScUi.hpp" #include "ScWindow.hpp" #include #include #include #include #include #include #include #include #include #include using namespace OpenRCT2; using namespace OpenRCT2::Scripting; namespace OpenRCT2::Ui::Windows { enum { WIDX_BACKGROUND, WIDX_TITLE, WIDX_CLOSE, WIDX_CONTENT_PANEL, WIDX_CUSTOM_BEGIN, }; static rct_widget CustomDefaultWidgets[] = { { WWT_FRAME, 0, 0, 0, 0, 0, 0xFFFFFFFF, STR_NONE }, // panel / background { WWT_CAPTION, 0, 1, 0, 1, 14, STR_STRING, STR_WINDOW_TITLE_TIP }, // title bar { WWT_CLOSEBOX, 0, 0, 0, 2, 13, STR_CLOSE_X, STR_CLOSE_WINDOW_TIP }, // close x button { WWT_RESIZE, 1, 0, 0, 14, 0, 0xFFFFFFFF, STR_NONE }, // content panel }; static void window_custom_close(rct_window* w); static void window_custom_mouseup(rct_window* w, rct_widgetindex widgetIndex); static void window_custom_mousedown(rct_window* w, rct_widgetindex widgetIndex, rct_widget* widget); static void window_custom_resize(rct_window* w); static void window_custom_dropdown(rct_window* w, rct_widgetindex widgetIndex, int32_t dropdownIndex); static void window_custom_invalidate(rct_window* w); static void window_custom_paint(rct_window* w, rct_drawpixelinfo* dpi); static rct_window_event_list window_custom_events = { window_custom_close, window_custom_mouseup, window_custom_resize, window_custom_mousedown, window_custom_dropdown, nullptr, nullptr, nullptr, nullptr, nullptr, nullptr, nullptr, nullptr, nullptr, nullptr, nullptr, nullptr, nullptr, nullptr, nullptr, nullptr, nullptr, nullptr, nullptr, nullptr, window_custom_invalidate, window_custom_paint, nullptr }; struct CustomWidgetDesc { // Properties std::string Type; int32_t X{}; int32_t Y{}; int32_t Width{}; int32_t Height{}; std::string Text; std::vector Items; int32_t SelectedIndex{}; bool IsChecked{}; bool IsDisabled{}; // Event handlers DukValue OnClick; DukValue OnChange; static std::string ProcessString(const DukValue& value) { if (value.type() == DukValue::Type::STRING) return ProcessString(value.as_string()); return {}; } static std::string ProcessString(const std::string_view& s) { std::string result; result.reserve(s.size()); for (char c : s) { if (c == '\n') { result.push_back(FORMAT_NEWLINE); } else { result.push_back(c); } } return result; } static CustomWidgetDesc FromDukValue(DukValue desc) { CustomWidgetDesc result; result.Type = desc["type"].as_string(); result.X = desc["x"].as_int(); result.Y = desc["y"].as_int(); result.Width = desc["width"].as_int(); result.Height = desc["height"].as_int(); if (result.Type == "button") { result.Text = ProcessString(desc["text"]); result.OnClick = desc["onClick"]; } else if (result.Type == "checkbox") { result.Text = ProcessString(desc["text"]); auto dukIsChecked = desc["isChecked"]; if (dukIsChecked.type() == DukValue::Type::BOOLEAN) { result.IsChecked = dukIsChecked.as_bool(); } result.OnChange = desc["onChange"]; } else if (result.Type == "dropdown") { auto dukItems = desc["items"].as_array(); for (const auto& dukItem : dukItems) { result.Items.push_back(ProcessString(dukItem)); } result.SelectedIndex = desc["selectedIndex"].as_int(); result.OnChange = desc["onChange"]; } else if (result.Type == "groupbox" || result.Type == "label") { result.Text = ProcessString(desc["text"]); } return result; } }; struct CustomWindowDesc { std::string Classification; std::optional X; std::optional Y; int32_t Width{}; int32_t Height{}; std::optional MinWidth; std::optional MinHeight; std::optional MaxWidth; std::optional MaxHeight; std::string Title; std::optional Id; std::vector Widgets; CustomWindowDesc() = default; bool IsResizable() const { return MinWidth || MinHeight || MaxWidth || MaxHeight; } static CustomWindowDesc FromDukValue(DukValue desc) { CustomWindowDesc result; result.Classification = desc["classification"].as_string(); result.X = GetOptionalInt(desc["x"]); result.Y = GetOptionalInt(desc["y"]); result.Width = desc["width"].as_int(); result.Height = desc["height"].as_int(); result.MinWidth = GetOptionalInt(desc["minWidth"]); result.MaxWidth = GetOptionalInt(desc["maxWidth"]); result.MinHeight = GetOptionalInt(desc["minHeight"]); result.MaxHeight = GetOptionalInt(desc["maxHeight"]); result.Title = desc["title"].as_string(); result.Id = GetOptionalInt(desc["id"]); if (desc["widgets"].is_array()) { auto dukWidgets = desc["widgets"].as_array(); std::transform(dukWidgets.begin(), dukWidgets.end(), std::back_inserter(result.Widgets), [](const DukValue& w) { return CustomWidgetDesc::FromDukValue(w); }); } return std::move(result); } static std::optional GetOptionalInt(DukValue input) { return input.type() == DukValue::Type::NUMBER ? std::make_optional(input.as_int()) : std::nullopt; } }; class CustomWindowInfo { private: rct_windowclass _class; rct_windownumber _number; public: std::shared_ptr Owner; CustomWindowDesc Desc; std::vector Widgets; std::vector WidgetIndexMap; CustomWindowInfo( rct_windowclass cls, rct_windownumber number, std::shared_ptr owner, const CustomWindowDesc& desc) : _class(cls) , _number(number) , Owner(owner) , Desc(desc) { } CustomWindowInfo(const CustomWindowInfo&) = delete; const CustomWidgetDesc* GetCustomWidgetDesc(size_t widgetIndex) const { if (widgetIndex < WidgetIndexMap.size()) { auto widgetDescIndex = WidgetIndexMap[widgetIndex]; if (widgetDescIndex < Desc.Widgets.size()) { return &Desc.Widgets[widgetDescIndex]; } } return nullptr; } CustomWidgetDesc* GetCustomWidgetDesc(size_t widgetIndex) { return const_cast(std::as_const(*this).GetCustomWidgetDesc(widgetIndex)); } }; static rct_windownumber _nextWindowNumber; static CustomWindowInfo& GetInfo(rct_window* w); static rct_windownumber GetNewWindowNumber(); static void RefreshWidgets(rct_window* w); static void InvokeEventHandler(std::shared_ptr owner, const DukValue& dukHandler); static void InvokeEventHandler( std::shared_ptr owner, const DukValue& dukHandler, const std::vector& args); rct_window* window_custom_open(std::shared_ptr owner, DukValue dukDesc) { auto desc = CustomWindowDesc::FromDukValue(dukDesc); uint16_t windowFlags = 0; if (desc.IsResizable()) { windowFlags |= WF_RESIZABLE; } rct_window* window; if (desc.X && desc.Y) { window = window_create( { desc.X.value(), desc.Y.value() }, desc.Width, desc.Height, &window_custom_events, WC_CUSTOM, windowFlags); } else { window = window_create_auto_pos(desc.Width, desc.Height, &window_custom_events, WC_CUSTOM, windowFlags); } window->number = GetNewWindowNumber(); window->custom_info = new CustomWindowInfo(window->classification, window->number, owner, desc); window->enabled_widgets = (1 << WIDX_CLOSE); window->colours[0] = COLOUR_GREY; window->colours[1] = COLOUR_GREY; window->colours[2] = COLOUR_GREY; if (desc.IsResizable()) { window->min_width = desc.MinWidth.value_or(0); window->min_height = desc.MinHeight.value_or(0); window->max_width = desc.MaxWidth.value_or(std::numeric_limits::max()); window->max_height = desc.MaxHeight.value_or(std::numeric_limits::max()); } RefreshWidgets(window); window_init_scroll_widgets(window); return window; } static void window_custom_close(rct_window* w) { delete static_cast(w->custom_info); w->custom_info = nullptr; } static void window_custom_mouseup(rct_window* w, rct_widgetindex widgetIndex) { switch (widgetIndex) { case WIDX_CLOSE: window_close(w); break; default: { const auto& info = GetInfo(w); const auto widgetDesc = info.GetCustomWidgetDesc(widgetIndex); if (widgetDesc != nullptr) { if (widgetDesc->Type == "button") { InvokeEventHandler(info.Owner, widgetDesc->OnClick); } else if (widgetDesc->Type == "checkbox") { auto& widget = w->widgets[widgetIndex]; widget.flags ^= WIDGET_FLAGS::IS_PRESSED; bool isChecked = widget.flags & WIDGET_FLAGS::IS_PRESSED; widget_set_checkbox_value(w, widgetIndex, isChecked); std::vector args; auto ctx = widgetDesc->OnChange.context(); duk_push_boolean(ctx, isChecked); args.push_back(DukValue::take_from_stack(ctx)); InvokeEventHandler(info.Owner, widgetDesc->OnChange, args); } } break; } } } static void window_custom_resize(rct_window* w) { const auto& desc = GetInfo(w).Desc; if (desc.IsResizable()) { if (w->width < w->min_width) { w->Invalidate(); w->width = w->min_width; } if (w->height < w->min_height) { w->Invalidate(); w->height = w->min_height; } } } static void window_custom_mousedown(rct_window* w, rct_widgetindex widgetIndex, rct_widget* widget) { const auto& info = GetInfo(w); const auto widgetDesc = info.GetCustomWidgetDesc(widgetIndex); if (widgetDesc != nullptr) { if (widgetDesc->Type == "dropdown") { widget--; const auto& items = widgetDesc->Items; const auto numItems = std::min(items.size(), DROPDOWN_ITEMS_MAX_SIZE); for (size_t i = 0; i < numItems; i++) { gDropdownItemsFormat[i] = STR_STRING; set_format_arg_on((uint8_t*)&gDropdownItemsArgs[i], 0, const char*, items[i].c_str()); } window_dropdown_show_text_custom_width( w->x + widget->left, w->y + widget->top, widget->bottom - widget->top + 1, w->colours[widget->colour], 0, DROPDOWN_FLAG_STAY_OPEN, numItems, widget->right - widget->left - 3); } } } static void window_custom_dropdown(rct_window* w, rct_widgetindex widgetIndex, int32_t dropdownIndex) { if (dropdownIndex == -1) return; const auto& info = GetInfo(w); const auto widgetDesc = info.GetCustomWidgetDesc(widgetIndex); if (widgetDesc != nullptr) { if (widgetDesc->Type == "dropdown") { if (dropdownIndex >= 0 && (size_t)dropdownIndex < widgetDesc->Items.size()) { std::vector args; auto ctx = widgetDesc->OnChange.context(); duk_push_int(ctx, dropdownIndex); args.push_back(DukValue::take_from_stack(ctx)); InvokeEventHandler(info.Owner, widgetDesc->OnChange, args); auto& widget = w->widgets[widgetIndex - 1]; widget.string = (utf8*)widgetDesc->Items[dropdownIndex].c_str(); } } } } static void window_custom_invalidate(rct_window* w) { w->widgets[WIDX_BACKGROUND].right = w->width - 1; w->widgets[WIDX_BACKGROUND].bottom = w->height - 1; w->widgets[WIDX_TITLE].right = w->width - 2; w->widgets[WIDX_CLOSE].left = w->width - 13; w->widgets[WIDX_CLOSE].right = w->width - 3; w->widgets[WIDX_CONTENT_PANEL].right = w->width - 1; w->widgets[WIDX_CONTENT_PANEL].bottom = w->height - 1; const auto& desc = GetInfo(w).Desc; set_format_arg(0, void*, desc.Title.c_str()); } static void window_custom_paint(rct_window* w, rct_drawpixelinfo* dpi) { window_draw_widgets(w, dpi); } static CustomWindowInfo& GetInfo(rct_window* w) { return *(static_cast(w->custom_info)); } static rct_windownumber GetNewWindowNumber() { auto result = _nextWindowNumber++; while (window_find_by_number(WC_CUSTOM, result) != nullptr) { result++; } return result; } static void CreateWidget(std::vector& widgetList, const CustomWidgetDesc& desc) { rct_widget widget{}; widget.colour = 1; widget.left = desc.X; widget.top = desc.Y; widget.right = desc.X + desc.Width; widget.bottom = desc.Y + desc.Height; widget.tooltip = STR_NONE; widget.flags = WIDGET_FLAGS::IS_ENABLED; if (desc.IsDisabled) widget.flags |= WIDGET_FLAGS::IS_DISABLED; if (desc.Type == "button") { widget.type = WWT_BUTTON; widget.string = (utf8*)desc.Text.c_str(); widget.flags |= WIDGET_FLAGS::TEXT_IS_STRING; widgetList.push_back(widget); } else if (desc.Type == "checkbox") { widget.type = WWT_CHECKBOX; widget.string = (utf8*)desc.Text.c_str(); widget.flags |= WIDGET_FLAGS::TEXT_IS_STRING; if (desc.IsChecked) { widget.flags |= WIDGET_FLAGS::IS_PRESSED; } widgetList.push_back(widget); } else if (desc.Type == "dropdown") { widget.type = WWT_DROPDOWN; if (desc.SelectedIndex >= 0 && (size_t)desc.SelectedIndex < desc.Items.size()) { widget.string = (utf8*)desc.Items[desc.SelectedIndex].c_str(); } widget.flags |= WIDGET_FLAGS::TEXT_IS_STRING; widgetList.push_back(widget); // Add the dropdown button widget = {}; widget.type = WWT_BUTTON; widget.colour = 1; widget.left = desc.X + desc.Width - 11; widget.right = desc.X + desc.Width - 1; widget.top = desc.Y + 1; widget.bottom = desc.Y + desc.Height - 1; widget.text = STR_DROPDOWN_GLYPH; widget.tooltip = STR_NONE; widget.flags |= WIDGET_FLAGS::IS_ENABLED; widgetList.push_back(widget); } else if (desc.Type == "groupbox") { widget.type = WWT_GROUPBOX; widget.string = (utf8*)desc.Text.c_str(); widget.flags |= WIDGET_FLAGS::TEXT_IS_STRING; widgetList.push_back(widget); } else if (desc.Type == "label") { widget.type = WWT_LABEL; widget.string = (utf8*)desc.Text.c_str(); widget.flags |= WIDGET_FLAGS::TEXT_IS_STRING; widgetList.push_back(widget); } } static void RefreshWidgets(rct_window* w) { auto& info = GetInfo(w); auto& widgets = info.Widgets; widgets.clear(); // Add default widgets (window shim) widgets.insert(widgets.begin(), std::begin(CustomDefaultWidgets), std::end(CustomDefaultWidgets)); for (size_t i = 0; i < widgets.size(); i++) { info.WidgetIndexMap.push_back(std::numeric_limits::max()); } // Add custom widgets for (size_t widgetDescIndex = 0; widgetDescIndex < info.Desc.Widgets.size(); widgetDescIndex++) { const auto& widgetDesc = info.Desc.Widgets[widgetDescIndex]; auto preWidgetSize = widgets.size(); CreateWidget(widgets, widgetDesc); auto numWidetsAdded = widgets.size() - preWidgetSize; for (size_t i = 0; i < numWidetsAdded; i++) { info.WidgetIndexMap.push_back(widgetDescIndex); } } widgets.push_back({ WIDGETS_END }); w->widgets = widgets.data(); // Enable widgets w->enabled_widgets = 1ULL << WIDX_CLOSE; for (size_t i = 0; i < std::min(widgets.size(), 64); i++) { auto mask = 1ULL << i; auto flags = widgets[i].flags; if (flags & WIDGET_FLAGS::IS_ENABLED) { w->enabled_widgets |= mask; } if (flags & WIDGET_FLAGS::IS_PRESSED) { w->pressed_widgets |= mask; } if (flags & WIDGET_FLAGS::IS_DISABLED) { w->disabled_widgets |= mask; } } } static void InvokeEventHandler(std::shared_ptr owner, const DukValue& dukHandler) { std::vector args; InvokeEventHandler(owner, dukHandler, args); } static void InvokeEventHandler(std::shared_ptr owner, const DukValue& dukHandler, const std::vector& args) { if (dukHandler.is_function()) { auto& scriptEngine = GetContext()->GetScriptEngine(); auto& execInfo = scriptEngine.GetExecInfo(); { ScriptExecutionInfo::PluginScope scope(execInfo, owner); dukHandler.push(); for (const auto& arg : args) { arg.push(); } duk_pcall(dukHandler.context(), (duk_idx_t)args.size()); duk_pop(dukHandler.context()); } } } void UpdateWidgetText(rct_window* w, rct_widgetindex widgetIndex, const std::string& value) { if (w->custom_info != nullptr) { auto &customInfo = GetInfo(w); auto customWidgetInfo = customInfo.GetCustomWidgetDesc(widgetIndex); if (customWidgetInfo != nullptr) { customWidgetInfo->Text = CustomWidgetDesc::ProcessString(value); w->widgets[widgetIndex].string = customWidgetInfo->Text.data(); } } } } // namespace OpenRCT2::Ui::Windows