From 6cbeb9e745c9eb3f0b5b768fdb9ed81a98b8fb02 Mon Sep 17 00:00:00 2001 From: rubidium Date: Sat, 10 Dec 2011 08:49:42 +0000 Subject: (svn r23471) -Codechange: move the error related code out of misc_gui.cpp into error_gui.cpp --- src/misc_gui.cpp | 260 ------------------------------------------------------- 1 file changed, 260 deletions(-) (limited to 'src/misc_gui.cpp') diff --git a/src/misc_gui.cpp b/src/misc_gui.cpp index ed1933948..5e16f1185 100644 --- a/src/misc_gui.cpp +++ b/src/misc_gui.cpp @@ -12,7 +12,6 @@ #include "stdafx.h" #include "debug.h" #include "landscape.h" -#include "newgrf_text.h" #include "gui.h" #include "viewport_func.h" #include "gfx_func.h" @@ -22,12 +21,9 @@ #include "string_func.h" #include "company_base.h" #include "texteff.hpp" -#include "company_manager_face.h" #include "strings_func.h" -#include "zoom_func.h" #include "window_func.h" #include "querystring_gui.h" -#include "console_func.h" #include "core/geometry_func.hpp" #include "newgrf_debug.h" @@ -518,262 +514,6 @@ void ShowAboutWindow() new AboutWindow(); } -/** Widgets of the error message windows */ -enum ErrorMessageWidgets { - EMW_CAPTION, - EMW_FACE, - EMW_MESSAGE, -}; - -static const NWidgetPart _nested_errmsg_widgets[] = { - NWidget(NWID_HORIZONTAL), - NWidget(WWT_CLOSEBOX, COLOUR_RED), - NWidget(WWT_CAPTION, COLOUR_RED, EMW_CAPTION), SetDataTip(STR_ERROR_MESSAGE_CAPTION, STR_NULL), - EndContainer(), - NWidget(WWT_PANEL, COLOUR_RED), - NWidget(WWT_EMPTY, COLOUR_RED, EMW_MESSAGE), SetPadding(0, 2, 0, 2), SetMinimalSize(236, 32), - EndContainer(), -}; - -static const WindowDesc _errmsg_desc( - WDP_MANUAL, 0, 0, - WC_ERRMSG, WC_NONE, - 0, - _nested_errmsg_widgets, lengthof(_nested_errmsg_widgets) -); - -static const NWidgetPart _nested_errmsg_face_widgets[] = { - NWidget(NWID_HORIZONTAL), - NWidget(WWT_CLOSEBOX, COLOUR_RED), - NWidget(WWT_CAPTION, COLOUR_RED, EMW_CAPTION), SetDataTip(STR_ERROR_MESSAGE_CAPTION_OTHER_COMPANY, STR_NULL), - EndContainer(), - NWidget(WWT_PANEL, COLOUR_RED), - NWidget(NWID_HORIZONTAL), SetPIP(2, 1, 2), - NWidget(WWT_EMPTY, COLOUR_RED, EMW_FACE), SetMinimalSize(92, 119), SetFill(0, 1), SetPadding(2, 0, 1, 0), - NWidget(WWT_EMPTY, COLOUR_RED, EMW_MESSAGE), SetFill(0, 1), SetMinimalSize(238, 123), - EndContainer(), - EndContainer(), -}; - -static const WindowDesc _errmsg_face_desc( - WDP_MANUAL, 0, 0, - WC_ERRMSG, WC_NONE, - 0, - _nested_errmsg_face_widgets, lengthof(_nested_errmsg_face_widgets) -); - -/** Window class for displaying an error message window. */ -struct ErrmsgWindow : public Window { -private: - uint duration; ///< Length of display of the message. 0 means forever, - uint64 decode_params[20]; ///< Parameters of the message strings. - uint textref_stack_size; ///< Number of uint32 values to put on the #TextRefStack for the error message. - uint32 textref_stack[16]; ///< Values to put on the #TextRefStack for the error message. - StringID summary_msg; ///< General error message showed in first line. Must be valid. - StringID detailed_msg; ///< Detailed error message showed in second line. Can be #INVALID_STRING_ID. - uint height_summary; ///< Height of the #summary_msg string in pixels in the #EMW_MESSAGE widget. - uint height_detailed; ///< Height of the #detailed_msg string in pixels in the #EMW_MESSAGE widget. - Point position; ///< Position of the error message window. - CompanyID face; ///< Company belonging to the face being shown. #INVALID_COMPANY if no face present. - -public: - ErrmsgWindow(Point pt, StringID summary_msg, StringID detailed_msg, bool no_timeout, uint textref_stack_size, const uint32 *textref_stack) : Window() - { - this->position = pt; - this->duration = no_timeout ? 0 : _settings_client.gui.errmsg_duration; - CopyOutDParam(this->decode_params, 0, lengthof(this->decode_params)); - this->summary_msg = summary_msg; - this->detailed_msg = detailed_msg; - this->textref_stack_size = textref_stack_size; - if (textref_stack_size > 0) { - MemCpyT(this->textref_stack, textref_stack, textref_stack_size); - } - - CompanyID company = (CompanyID)GetDParamX(this->decode_params, 2); - this->face = (this->detailed_msg == STR_ERROR_OWNED_BY && company < MAX_COMPANIES) ? company : INVALID_COMPANY; - const WindowDesc *desc = (face == INVALID_COMPANY) ? &_errmsg_desc : &_errmsg_face_desc; - - assert(summary_msg != INVALID_STRING_ID); - - this->InitNested(desc); - } - - virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) - { - if (widget != EMW_MESSAGE) return; - - CopyInDParam(0, this->decode_params, lengthof(this->decode_params)); - if (this->textref_stack_size > 0) StartTextRefStackUsage(this->textref_stack_size, this->textref_stack); - - int text_width = max(0, (int)size->width - WD_FRAMETEXT_LEFT - WD_FRAMETEXT_RIGHT); - this->height_summary = GetStringHeight(this->summary_msg, text_width); - this->height_detailed = (this->detailed_msg == INVALID_STRING_ID) ? 0 : GetStringHeight(this->detailed_msg, text_width); - - if (this->textref_stack_size > 0) StopTextRefStackUsage(); - - uint panel_height = WD_FRAMERECT_TOP + this->height_summary + WD_FRAMERECT_BOTTOM; - if (this->detailed_msg != INVALID_STRING_ID) panel_height += this->height_detailed + WD_PAR_VSEP_WIDE; - - size->height = max(size->height, panel_height); - } - - virtual Point OnInitialPosition(const WindowDesc *desc, int16 sm_width, int16 sm_height, int window_number) - { - /* Position (0, 0) given, center the window. */ - if (this->position.x == 0 && this->position.y == 0) { - Point pt = {(_screen.width - sm_width) >> 1, (_screen.height - sm_height) >> 1}; - return pt; - } - - /* Find the free screen space between the main toolbar at the top, and the statusbar at the bottom. - * Add a fixed distance 20 to make it less cluttered. - */ - int scr_top = GetMainViewTop() + 20; - int scr_bot = GetMainViewBottom() - 20; - - Point pt = RemapCoords2(this->position.x, this->position.y); - const ViewPort *vp = FindWindowById(WC_MAIN_WINDOW, 0)->viewport; - if (this->face == INVALID_COMPANY) { - /* move x pos to opposite corner */ - pt.x = UnScaleByZoom(pt.x - vp->virtual_left, vp->zoom) + vp->left; - pt.x = (pt.x < (_screen.width >> 1)) ? _screen.width - sm_width - 20 : 20; // Stay 20 pixels away from the edge of the screen. - - /* move y pos to opposite corner */ - pt.y = UnScaleByZoom(pt.y - vp->virtual_top, vp->zoom) + vp->top; - pt.y = (pt.y < (_screen.height >> 1)) ? scr_bot - sm_height : scr_top; - } else { - pt.x = Clamp(UnScaleByZoom(pt.x - vp->virtual_left, vp->zoom) + vp->left - (sm_width / 2), 0, _screen.width - sm_width); - pt.y = Clamp(UnScaleByZoom(pt.y - vp->virtual_top, vp->zoom) + vp->top - (sm_height / 2), scr_top, scr_bot - sm_height); - } - return pt; - } - - /** - * Some data on this window has become invalid. - * @param data Information about the changed data. - * @param gui_scope Whether the call is done from GUI scope. You may not do everything when not in GUI scope. See #InvalidateWindowData() for details. - */ - virtual void OnInvalidateData(int data = 0, bool gui_scope = true) - { - /* If company gets shut down, while displaying an error about it, remove the error message. */ - if (this->face != INVALID_COMPANY && !Company::IsValidID(this->face)) delete this; - } - - virtual void SetStringParameters(int widget) const - { - if (widget == EMW_CAPTION) CopyInDParam(0, this->decode_params, lengthof(this->decode_params)); - } - - virtual void DrawWidget(const Rect &r, int widget) const - { - switch (widget) { - case EMW_FACE: { - const Company *c = Company::Get(this->face); - DrawCompanyManagerFace(c->face, c->colour, r.left, r.top); - break; - } - - case EMW_MESSAGE: - CopyInDParam(0, this->decode_params, lengthof(this->decode_params)); - if (this->textref_stack_size > 0) StartTextRefStackUsage(this->textref_stack_size, this->textref_stack); - - if (this->detailed_msg == INVALID_STRING_ID) { - DrawStringMultiLine(r.left + WD_FRAMETEXT_LEFT, r.right - WD_FRAMETEXT_RIGHT, r.top + WD_FRAMERECT_TOP, r.bottom - WD_FRAMERECT_BOTTOM, - this->summary_msg, TC_FROMSTRING, SA_CENTER); - } else { - int extra = (r.bottom - r.top + 1 - this->height_summary - this->height_detailed - WD_PAR_VSEP_WIDE) / 2; - - /* Note: NewGRF supplied error message often do not start with a colour code, so default to white. */ - int top = r.top + WD_FRAMERECT_TOP; - int bottom = top + this->height_summary + extra; - DrawStringMultiLine(r.left + WD_FRAMETEXT_LEFT, r.right - WD_FRAMETEXT_RIGHT, top, bottom, this->summary_msg, TC_WHITE, SA_CENTER); - - bottom = r.bottom - WD_FRAMERECT_BOTTOM; - top = bottom - this->height_detailed - extra; - DrawStringMultiLine(r.left + WD_FRAMETEXT_LEFT, r.right - WD_FRAMETEXT_RIGHT, top, bottom, this->detailed_msg, TC_WHITE, SA_CENTER); - } - - if (this->textref_stack_size > 0) StopTextRefStackUsage(); - break; - - default: - break; - } - } - - virtual void OnMouseLoop() - { - /* Disallow closing the window too easily, if timeout is disabled */ - if (_right_button_down && this->duration != 0) delete this; - } - - virtual void OnHundredthTick() - { - /* Timeout enabled? */ - if (this->duration != 0) { - this->duration--; - if (this->duration == 0) delete this; - } - } - - ~ErrmsgWindow() - { - SetRedErrorSquare(INVALID_TILE); - } - - virtual EventState OnKeyPress(uint16 key, uint16 keycode) - { - if (keycode != WKC_SPACE) return ES_NOT_HANDLED; - delete this; - return ES_HANDLED; - } -}; - -/** - * Display an error message in a window. - * @param summary_msg General error message showed in first line. Must be valid. - * @param detailed_msg Detailed error message showed in second line. Can be INVALID_STRING_ID. - * @param wl Message severity. - * @param x World X position (TileVirtX) of the error location. Set both x and y to 0 to just center the message when there is no related error tile. - * @param y World Y position (TileVirtY) of the error location. Set both x and y to 0 to just center the message when there is no related error tile. - * @param textref_stack_size Number of uint32 values to put on the #TextRefStack for the error message; 0 if the #TextRefStack shall not be used. - * @param textref_stack Values to put on the #TextRefStack. - */ -void ShowErrorMessage(StringID summary_msg, StringID detailed_msg, WarningLevel wl, int x, int y, uint textref_stack_size, const uint32 *textref_stack) -{ - assert(textref_stack_size == 0 || textref_stack != NULL); - if (summary_msg == STR_NULL) summary_msg = STR_EMPTY; - - if (wl != WL_INFO) { - /* Print message to console */ - char buf[DRAW_STRING_BUFFER]; - - if (textref_stack_size > 0) StartTextRefStackUsage(textref_stack_size, textref_stack); - - char *b = GetString(buf, summary_msg, lastof(buf)); - if (detailed_msg != INVALID_STRING_ID) { - b += seprintf(b, lastof(buf), " "); - GetString(b, detailed_msg, lastof(buf)); - } - - if (textref_stack_size > 0) StopTextRefStackUsage(); - - switch (wl) { - case WL_WARNING: IConsolePrint(CC_WARNING, buf); break; - default: IConsoleError(buf); break; - } - } - - bool no_timeout = wl == WL_CRITICAL; - - if (_settings_client.gui.errmsg_duration == 0 && !no_timeout) return; - - DeleteWindowById(WC_ERRMSG, 0); - - Point pt = {x, y}; - new ErrmsgWindow(pt, summary_msg, detailed_msg, no_timeout, textref_stack_size, textref_stack); -} - /** * Display estimated costs. * @param cost Estimated cost (or income if negative). -- cgit v1.2.3-54-g00ecf