misc_gui.cpp

Go to the documentation of this file.

/* $Id: misc_gui.cpp 14555 2008-11-02 11:20:15Z skidd13 $ */

#include "stdafx.h"
#include "openttd.h"
#include "heightmap.h"
#include "debug.h"
#include "landscape.h"
#include "newgrf.h"
#include "newgrf_text.h"
#include "saveload.h"
#include "tile_map.h"
#include "gui.h"
#include "window_gui.h"
#include "station_gui.h"
#include "textbuf_gui.h"
#include "viewport_func.h"
#include "gfx_func.h"
#include "station_func.h"
#include "command_func.h"
#include "company_func.h"
#include "company_base.h"
#include "town.h"
#include "network/network.h"
#include "variables.h"
#include "cheat_func.h"
#include "train.h"
#include "tgp.h"
#include "cargotype.h"
#include "company_manager_face.h"
#include "strings_func.h"
#include "fileio_func.h"
#include "fios.h"
#include "tile_cmd.h"
#include "zoom_func.h"
#include "functions.h"
#include "window_func.h"
#include "date_func.h"
#include "sound_func.h"
#include "string_func.h"
#include "company_gui.h"
#include "settings_type.h"
#include "newgrf_cargo.h"
#include "rail_gui.h"
#include "tilehighlight_func.h"
#include "querystring_gui.h"
#include "company_base.h"

#include "table/sprites.h"
#include "table/strings.h"

/* Variables to display file lists */
SaveLoadDialogMode _saveload_mode;


static bool _fios_path_changed;
static bool _savegame_sort_dirty;

static const Widget _land_info_widgets[] = {
{   WWT_CLOSEBOX,   RESIZE_NONE,  COLOUR_GREY,     0,    10,     0,    13, STR_00C5,                       STR_018B_CLOSE_WINDOW},
{    WWT_CAPTION,   RESIZE_NONE,  COLOUR_GREY,    11,   299,     0,    13, STR_01A3_LAND_AREA_INFORMATION, STR_018C_WINDOW_TITLE_DRAG_THIS},
{      WWT_PANEL, RESIZE_BOTTOM,  COLOUR_GREY,     0,   299,    14,    99, 0x0,                            STR_NULL},
{    WIDGETS_END},
};

static const WindowDesc _land_info_desc = {
  WDP_AUTO, WDP_AUTO, 300, 100, 300, 100,
  WC_LAND_INFO, WC_NONE,
  WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET,
  _land_info_widgets,
};

class LandInfoWindow : public Window {
  enum {
    LAND_INFO_CENTERED_LINES   = 12,                       
    LAND_INFO_MULTICENTER_LINE = LAND_INFO_CENTERED_LINES, 
    LAND_INFO_LINE_END,

    LAND_INFO_LINE_BUFF_SIZE = 512,
  };

public:
  char landinfo_data[LAND_INFO_LINE_END][LAND_INFO_LINE_BUFF_SIZE];

  virtual void OnPaint()
  {
    this->DrawWidgets();

    uint y = 21;
    for (uint i = 0; i < LAND_INFO_CENTERED_LINES; i++) {
      if (StrEmpty(this->landinfo_data[i])) break;

      DoDrawStringCentered(150, y, this->landinfo_data[i], i == 0 ? TC_LIGHT_BLUE : TC_FROMSTRING);
      y += i == 0 ? 16 : 12;
    }

    y += 6;

    if (!StrEmpty(this->landinfo_data[LAND_INFO_MULTICENTER_LINE])) {
      SetDParamStr(0, this->landinfo_data[LAND_INFO_MULTICENTER_LINE]);
      DrawStringMultiCenter(150, y, STR_JUST_RAW_STRING, this->width - 4);
    }
  }

  LandInfoWindow(TileIndex tile) : Window(&_land_info_desc) {
    Company *c = GetCompany(IsValidCompanyID(_local_company) ? _local_company : COMPANY_FIRST);
    Town *t = ClosestTownFromTile(tile, _settings_game.economy.dist_local_authority);

    Money old_money = c->money;
    c->money = INT64_MAX;
    CommandCost costclear = DoCommand(tile, 0, 0, 0, CMD_LANDSCAPE_CLEAR);
    c->money = old_money;

    /* Because build_date is not set yet in every TileDesc, we make sure it is empty */
    TileDesc td;
    AcceptedCargo ac;

    td.build_date = INVALID_DATE;

    /* Most tiles have only one owner, but
     *  - drivethrough roadstops can be build on town owned roads (up to 2 owners) and
     *  - roads can have up to four owners (railroad, road, tram, 3rd-roadtype "highway").
     */
    td.owner_type[0] = STR_01A7_OWNER; // At least one owner is displayed, though it might be "N/A".
    td.owner_type[1] = STR_NULL;       // STR_NULL results in skipping the owner
    td.owner_type[2] = STR_NULL;
    td.owner_type[3] = STR_NULL;
    td.owner[0] = OWNER_NONE;
    td.owner[1] = OWNER_NONE;
    td.owner[2] = OWNER_NONE;
    td.owner[3] = OWNER_NONE;

    td.station_class = STR_NULL;
    td.station_name = STR_NULL;

    td.grf = NULL;

    GetAcceptedCargo(tile, ac);
    GetTileDesc(tile, &td);

    uint line_nr = 0;

    /* Tiletype */
    SetDParam(0, td.dparam[0]);
    GetString(this->landinfo_data[line_nr], td.str, lastof(this->landinfo_data[line_nr]));
    line_nr++;

    /* Up to four owners */
    for (uint i = 0; i < 4; i++) {
      if (td.owner_type[i] == STR_NULL) continue;

      SetDParam(0, STR_01A6_N_A);
      if (td.owner[i] != OWNER_NONE && td.owner[i] != OWNER_WATER) GetNameOfOwner(td.owner[i], tile);
      GetString(this->landinfo_data[line_nr], td.owner_type[i], lastof(this->landinfo_data[line_nr]));
      line_nr++;
    }

    /* Cost to clear */
    StringID str = STR_01A4_COST_TO_CLEAR_N_A;
    if (CmdSucceeded(costclear)) {
      SetDParam(0, costclear.GetCost());
      str = STR_01A5_COST_TO_CLEAR;
    }
    GetString(this->landinfo_data[line_nr], str, lastof(this->landinfo_data[line_nr]));
    line_nr++;

    /* Location */
    char tmp[16];
    snprintf(tmp, lengthof(tmp), "0x%.4X", tile);
    SetDParam(0, TileX(tile));
    SetDParam(1, TileY(tile));
    SetDParam(2, TileHeight(tile));
    SetDParamStr(3, tmp);
    GetString(this->landinfo_data[line_nr], STR_LANDINFO_COORDS, lastof(this->landinfo_data[line_nr]));
    line_nr++;

    /* Local authority */
    SetDParam(0, STR_01A9_NONE);
    if (t != NULL && t->IsValid()) {
      SetDParam(0, STR_TOWN);
      SetDParam(1, t->index);
    }
    GetString(this->landinfo_data[line_nr], STR_01A8_LOCAL_AUTHORITY, lastof(this->landinfo_data[line_nr]));
    line_nr++;

    /* Build date */
    if (td.build_date != INVALID_DATE) {
      SetDParam(0, td.build_date);
      GetString(this->landinfo_data[line_nr], STR_BUILD_DATE, lastof(this->landinfo_data[line_nr]));
      line_nr++;
    }

    /* Station class */
    if (td.station_class != STR_NULL) {
      SetDParam(0, td.station_class);
      GetString(this->landinfo_data[line_nr], STR_TILEDESC_STATION_CLASS, lastof(this->landinfo_data[line_nr]));
      line_nr++;
    }

    /* Station type name */
    if (td.station_name != STR_NULL) {
      SetDParam(0, td.station_name);
      GetString(this->landinfo_data[line_nr], STR_TILEDESC_STATION_TYPE, lastof(this->landinfo_data[line_nr]));
      line_nr++;
    }

    /* NewGRF name */
    if (td.grf != NULL) {
      SetDParamStr(0, td.grf);
      GetString(this->landinfo_data[line_nr], STR_TILEDESC_NEWGRF_NAME, lastof(this->landinfo_data[line_nr]));
      line_nr++;
    }

    assert(line_nr < LAND_INFO_CENTERED_LINES);

    /* Mark last line empty */
    this->landinfo_data[line_nr][0] = '\0';

    /* Cargo acceptance is displayed in a extra multiline */
    char *strp = GetString(this->landinfo_data[LAND_INFO_MULTICENTER_LINE], STR_01CE_CARGO_ACCEPTED, lastof(this->landinfo_data[LAND_INFO_MULTICENTER_LINE]));
    bool found = false;

    for (CargoID i = 0; i < NUM_CARGO; ++i) {
      if (ac[i] > 0) {
        /* Add a comma between each item. */
        if (found) {
          *strp++ = ',';
          *strp++ = ' ';
        }
        found = true;

        /* If the accepted value is less than 8, show it in 1/8:ths */
        if (ac[i] < 8) {
          SetDParam(0, ac[i]);
          SetDParam(1, GetCargo(i)->name);
          strp = GetString(strp, STR_01D1_8, lastof(this->landinfo_data[LAND_INFO_MULTICENTER_LINE]));
        } else {
          strp = GetString(strp, GetCargo(i)->name, lastof(this->landinfo_data[LAND_INFO_MULTICENTER_LINE]));
        }
      }
    }
    if (!found) this->landinfo_data[LAND_INFO_MULTICENTER_LINE][0] = '\0';

    if (found) line_nr += 2;

    if (line_nr > 6) ResizeWindow(this, 0, 12 * (line_nr - 6));

    this->FindWindowPlacementAndResize(&_land_info_desc);

#if defined(_DEBUG)
# define LANDINFOD_LEVEL 0
#else
# define LANDINFOD_LEVEL 1
#endif
    DEBUG(misc, LANDINFOD_LEVEL, "TILE: %#x (%i,%i)", tile, TileX(tile), TileY(tile));
    DEBUG(misc, LANDINFOD_LEVEL, "type_height  = %#x", _m[tile].type_height);
    DEBUG(misc, LANDINFOD_LEVEL, "m1           = %#x", _m[tile].m1);
    DEBUG(misc, LANDINFOD_LEVEL, "m2           = %#x", _m[tile].m2);
    DEBUG(misc, LANDINFOD_LEVEL, "m3           = %#x", _m[tile].m3);
    DEBUG(misc, LANDINFOD_LEVEL, "m4           = %#x", _m[tile].m4);
    DEBUG(misc, LANDINFOD_LEVEL, "m5           = %#x", _m[tile].m5);
    DEBUG(misc, LANDINFOD_LEVEL, "m6           = %#x", _m[tile].m6);
    DEBUG(misc, LANDINFOD_LEVEL, "m7           = %#x", _me[tile].m7);
#undef LANDINFOD_LEVEL
  }
};

static void Place_LandInfo(TileIndex tile)
{
  DeleteWindowById(WC_LAND_INFO, 0);
  new LandInfoWindow(tile);
}

void PlaceLandBlockInfo()
{
  if (_cursor.sprite == SPR_CURSOR_QUERY) {
    ResetObjectToPlace();
  } else {
    _place_proc = Place_LandInfo;
    SetObjectToPlace(SPR_CURSOR_QUERY, PAL_NONE, VHM_RECT, WC_MAIN_TOOLBAR, 0);
  }
}

static const Widget _about_widgets[] = {
{   WWT_CLOSEBOX,   RESIZE_NONE,  COLOUR_GREY,     0,    10,     0,    13, STR_00C5,         STR_018B_CLOSE_WINDOW},
{    WWT_CAPTION,   RESIZE_NONE,  COLOUR_GREY,    11,   419,     0,    13, STR_015B_OPENTTD, STR_NULL},
{      WWT_PANEL,   RESIZE_NONE,  COLOUR_GREY,     0,   419,    14,   271, 0x0,              STR_NULL},
{      WWT_FRAME,   RESIZE_NONE,  COLOUR_GREY,     5,   414,    40,   245, STR_NULL,         STR_NULL},
{    WIDGETS_END},
};

static const WindowDesc _about_desc = {
  WDP_CENTER, WDP_CENTER, 420, 272, 420, 272,
  WC_GAME_OPTIONS, WC_NONE,
  WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET,
  _about_widgets,
};

struct AboutWindow : public Window {
  int scroll_height;
  uint16 counter;

  AboutWindow() : Window(&_about_desc)
  {
    this->counter = 5;
    this->scroll_height = this->height - 40;
    this->FindWindowPlacementAndResize(&_about_desc);
  }

  virtual void OnPaint()
  {
    static const char *credits[] = {
      /*************************************************************************
       *                      maximum length of string which fits in window   -^*/
      "Original design by Chris Sawyer",
      "Original graphics by Simon Foster",
      "",
      "The OpenTTD team (in alphabetical order):",
      "  Jean-Francois Claeys (Belugas) - GUI, newindustries and more",
      "  Bjarni Corfitzen (Bjarni) - MacOSX port, coder and vehicles",
      "  Matthijs Kooijman (blathijs) - Pathfinder-guru, pool rework",
      "  Victor Fischer (Celestar) - Programming everywhere you need him to",
      "  Christoph Elsenhans (frosch) - General coding",
      "  Loïc Guilloux (glx) - General coding",
      "  Jaroslav Mazanec (KUDr) - YAPG (Yet Another Pathfinder God) ;)",
      "  Jonathan Coome (Maedhros) - High priest of the newGRF Temple",
      "  Attila Bán (MiHaMiX) - WebTranslator, Nightlies, Wiki and bugtracker host",
      "  Owen Rudge (orudge) - Forum host, OS/2 port",
      "  Peter Nelson (peter1138) - Spiritual descendant from newGRF gods",
      "  Remko Bijker (Rubidium) - Lead coder and way more",
      "  Benedikt Brüggemeier (skidd13) - Bug fixer and code reworker",
      "  Zdenek Sojka (SmatZ) - Bug finder and fixer",
      "",
      "Inactive Developers:",
      "  Tamás Faragó (Darkvater) - Ex-Lead coder",
      "  Christoph Mallon (Tron) - Programmer, code correctness police",
      "",
      "Retired Developers:",
      "  Ludvig Strigeus (ludde) - OpenTTD author, main coder (0.1 - 0.3.3)",
      "  Serge Paquet (vurlix) - Assistant project manager, coder (0.1 - 0.3.3)",
      "  Dominik Scherer (dominik81) - Lead programmer, GUI expert (0.3.0 - 0.3.6)",
      "  Patric Stout (TrueLight) - Programmer, webhoster (0.3 - pre0.6)",
      "",
      "Special thanks go out to:",
      "  Josef Drexler - For his great work on TTDPatch",
      "  Marcin Grzegorczyk - For his documentation of TTD internals",
      "  Petr Baudis (pasky) - Many patches, newGRF support",
      "  Stefan Meißner (sign_de) - For his work on the console",
      "  Simon Sasburg (HackyKid) - Many bugfixes he has blessed us with",
      "  Cian Duffy (MYOB) - BeOS port / manual writing",
      "  Christian Rosentreter (tokai) - MorphOS / AmigaOS port",
      "  Richard Kempton (richK) - additional airports, initial TGP implementation",
      "",
      "  Michael Blunck - Pre-Signals and Semaphores © 2003",
      "  George - Canal/Lock graphics © 2003-2004",
      "  David Dallaston - Tram tracks",
      "  Marcin Grzegorczyk - Foundations for Tracks on Slopes",
      "  All Translators - Who made OpenTTD a truly international game",
      "  Bug Reporters - Without whom OpenTTD would still be full of bugs!",
      "",
      "",
      "And last but not least:",
      "  Chris Sawyer - For an amazing game!"
    };

    this->DrawWidgets();

    /* Show original copyright and revision version */
    DrawStringCentered(210, 17, STR_00B6_ORIGINAL_COPYRIGHT, TC_FROMSTRING);
    DrawStringCentered(210, 17 + 10, STR_00B7_VERSION, TC_FROMSTRING);

    int y = this->scroll_height;

    /* Show all scrolling credits */
    for (uint i = 0; i < lengthof(credits); i++) {
      if (y >= 50 && y < (this->height - 40)) {
        DoDrawString(credits[i], 10, y, TC_BLACK);
      }
      y += 10;
    }

    /* If the last text has scrolled start a new from the start */
    if (y < 50) this->scroll_height = this->height - 40;

    DoDrawStringCentered(210, this->height - 25, "Website: http://www.openttd.org", TC_BLACK);
    DrawStringCentered(210, this->height - 15, STR_00BA_COPYRIGHT_OPENTTD, TC_FROMSTRING);
  }

  virtual void OnTick()
  {
    if (--this->counter == 0) {
      this->counter = 5;
      this->scroll_height--;
      this->SetDirty();
    }
  }
};

void ShowAboutWindow()
{
  DeleteWindowById(WC_GAME_OPTIONS, 0);
  new AboutWindow();
}

static const Widget _errmsg_widgets[] = {
{   WWT_CLOSEBOX,   RESIZE_NONE,    COLOUR_RED,     0,    10,     0,    13, STR_00C5,         STR_018B_CLOSE_WINDOW},
{    WWT_CAPTION,   RESIZE_NONE,    COLOUR_RED,    11,   239,     0,    13, STR_00B2_MESSAGE, STR_NULL},
{      WWT_PANEL,   RESIZE_BOTTOM,  COLOUR_RED,     0,   239,    14,    45, 0x0,              STR_NULL},
{    WIDGETS_END},
};

static const Widget _errmsg_face_widgets[] = {
{   WWT_CLOSEBOX,   RESIZE_NONE,    COLOUR_RED,     0,    10,     0,    13, STR_00C5,              STR_018B_CLOSE_WINDOW},
{    WWT_CAPTION,   RESIZE_NONE,    COLOUR_RED,    11,   333,     0,    13, STR_00B3_MESSAGE_FROM, STR_NULL},
{      WWT_PANEL,   RESIZE_BOTTOM,  COLOUR_RED,     0,   333,    14,   136, 0x0,                   STR_NULL},
{   WIDGETS_END},
};

struct ErrmsgWindow : public Window {
private:
  uint duration;
  uint64 decode_params[20];
  StringID message_1;
  StringID message_2;
  bool show_company_manager_face;

  int y[2];

public:
  ErrmsgWindow(Point pt, int width, int height, StringID msg1, StringID msg2, const Widget *widget, bool show_company_manager_face) :
      Window(pt.x, pt.y, width, height, WC_ERRMSG, widget),
      show_company_manager_face(show_company_manager_face)
  {
    this->duration = _settings_client.gui.errmsg_duration;
    CopyOutDParam(this->decode_params, 0, lengthof(this->decode_params));
    this->message_1 = msg1;
    this->message_2 = msg2;
    this->desc_flags = WDF_STD_BTN | WDF_DEF_WIDGET;

    SwitchToErrorRefStack();
    RewindTextRefStack();

    assert(msg2 != INVALID_STRING_ID);

    int h2 = 3 + GetStringHeight(msg2, width - 2); // msg2 is printed first
    int h1 = (msg1 == INVALID_STRING_ID) ? 0 : 3 + GetStringHeight(msg1, width - 2);

    SwitchToNormalRefStack();

    int h = 15 + h1 + h2;
    height = max<int>(height, h);

    if (msg1 == INVALID_STRING_ID) {
      /* only 1 line will be printed */
      y[1] = (height - 15) / 2 + 15 - 5;
    } else {
      int over = (height - h) / 4;

      y[1] = 15 + h2 / 2 + 1 - 5 + over;
      y[0] = height - 3 - h1 / 2 - 5 - over;
    }

    this->FindWindowPlacementAndResize(width, height);
  }

  virtual void OnPaint()
  {
    CopyInDParam(0, this->decode_params, lengthof(this->decode_params));
    this->DrawWidgets();
    CopyInDParam(0, this->decode_params, lengthof(this->decode_params));

    /* If the error message comes from a NewGRF, we must use the text ref. stack reserved for error messages.
     * If the message doesn't come from a NewGRF, it won't use the TTDP-style text ref. stack, so we won't hurt anything
     */
    SwitchToErrorRefStack();
    RewindTextRefStack();

    if (this->show_company_manager_face) {
      const Company *c = GetCompany((CompanyID)GetDParamX(this->decode_params, 2));
      DrawCompanyManagerFace(c->face, c->colour, 2, 16);
    }

    DrawStringMultiCenter(this->width - 120, y[1], this->message_2, this->width - 2);
    if (this->message_1 != INVALID_STRING_ID) DrawStringMultiCenter(this->width - 120, y[0], this->message_1, this->width - 2);

    /* Switch back to the normal text ref. stack for NewGRF texts */
    SwitchToNormalRefStack();
  }

  virtual void OnMouseLoop()
  {
    if (_right_button_down) delete this;
  }

  virtual void OnHundredthTick()
  {
    if (--this->duration == 0) delete this;
  }

  ~ErrmsgWindow()
  {
    SetRedErrorSquare(0);
    extern StringID _switch_mode_errorstr;
    _switch_mode_errorstr = INVALID_STRING_ID;
  }

  virtual EventState OnKeyPress(uint16 key, uint16 keycode)
  {
    if (keycode != WKC_SPACE) return ES_NOT_HANDLED;
    delete this;
    return ES_HANDLED;
  }
};

void ShowErrorMessage(StringID msg_1, StringID msg_2, int x, int y)
{
  DeleteWindowById(WC_ERRMSG, 0);

  if (!_settings_client.gui.errmsg_duration) return;

  if (msg_2 == STR_NULL) msg_2 = STR_EMPTY;

  Point pt;
  const ViewPort *vp;

  if (msg_1 != STR_013B_OWNED_BY || GetDParam(2) >= 8) {
    if ((x | y) != 0) {
      pt = RemapCoords2(x, y);
      vp = FindWindowById(WC_MAIN_WINDOW, 0)->viewport;

      /* 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 - 260 : 20;

      /* 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)) ? _screen.height - 80 : 100;

    } else {
      pt.x = (_screen.width - 240) >> 1;
      pt.y = (_screen.height - 46) >> 1;
    }
    new ErrmsgWindow(pt, 240, 46, msg_1, msg_2, _errmsg_widgets, false);
  } else {
    if ((x | y) != 0) {
      pt = RemapCoords2(x, y);
      vp = FindWindowById(WC_MAIN_WINDOW, 0)->viewport;
      pt.x = Clamp(UnScaleByZoom(pt.x - vp->virtual_left, vp->zoom) + vp->left - (334 / 2),  0, _screen.width  - 334);
      pt.y = Clamp(UnScaleByZoom(pt.y - vp->virtual_top,  vp->zoom) + vp->top  - (137 / 2), 22, _screen.height - 137);
    } else {
      pt.x = (_screen.width  - 334) >> 1;
      pt.y = (_screen.height - 137) >> 1;
    }
    new ErrmsgWindow(pt, 334, 137, msg_1, msg_2, _errmsg_face_widgets, true);
  }
}

void ShowEstimatedCostOrIncome(Money cost, int x, int y)
{
  StringID msg = STR_0805_ESTIMATED_COST;

  if (cost < 0) {
    cost = -cost;
    msg = STR_0807_ESTIMATED_INCOME;
  }
  SetDParam(0, cost);
  ShowErrorMessage(INVALID_STRING_ID, msg, x, y);
}

void ShowCostOrIncomeAnimation(int x, int y, int z, Money cost)
{
  Point pt = RemapCoords(x,y,z);
  StringID msg = STR_0801_COST;

  if (cost < 0) {
    cost = -cost;
    msg = STR_0803_INCOME;
  }
  SetDParam(0, cost);
  AddTextEffect(msg, pt.x, pt.y, 0x250, TE_RISING);
}

void ShowFeederIncomeAnimation(int x, int y, int z, Money cost)
{
  Point pt = RemapCoords(x,y,z);

  SetDParam(0, cost);
  AddTextEffect(STR_FEEDER, pt.x, pt.y, 0x250, TE_RISING);
}

TextEffectID ShowFillingPercent(int x, int y, int z, uint8 percent, StringID string)
{
  Point pt = RemapCoords(x, y, z);

  assert(string != STR_NULL);

  SetDParam(0, percent);
  return AddTextEffect(string, pt.x, pt.y, 0xFFFF, TE_STATIC);
}

void UpdateFillingPercent(TextEffectID te_id, uint8 percent, StringID string)
{
  assert(string != STR_NULL);

  SetDParam(0, percent);
  UpdateTextEffect(te_id, string);
}

void HideFillingPercent(TextEffectID *te_id)
{
  if (*te_id == INVALID_TE_ID) return;

  RemoveTextEffect(*te_id);
  *te_id = INVALID_TE_ID;
}

static const Widget _tooltips_widgets[] = {
{      WWT_PANEL,   RESIZE_NONE,  COLOUR_GREY,     0,   199,     0,    31, 0x0, STR_NULL},
{   WIDGETS_END},
};

struct TooltipsWindow : public Window
{
  StringID string_id;
  byte paramcount;
  uint64 params[5];
  bool use_left_mouse_button;

  TooltipsWindow(int x, int y, int width, int height, const Widget *widget,
                 StringID str, uint paramcount, const uint64 params[], bool use_left_mouse_button) :
      Window(x, y, width, height, WC_TOOLTIPS, widget)
  {
    this->string_id = str;
    assert(sizeof(this->params[0]) == sizeof(params[0]));
    assert(paramcount <= lengthof(this->params));
    memcpy(this->params, params, sizeof(this->params[0]) * paramcount);
    this->paramcount = paramcount;
    this->use_left_mouse_button = use_left_mouse_button;

    this->flags4 &= ~WF_WHITE_BORDER_MASK; // remove white-border from tooltip
    this->widget[0].right = width;
    this->widget[0].bottom = height;

    FindWindowPlacementAndResize(width, height);
  }

  virtual void OnPaint()
  {
    GfxFillRect(0, 0, this->width - 1, this->height - 1, 0);
    GfxFillRect(1, 1, this->width - 2, this->height - 2, 0x44);

    for (uint arg = 0; arg < this->paramcount; arg++) {
      SetDParam(arg, this->params[arg]);
    }
    DrawStringMultiCenter((this->width >> 1), (this->height >> 1) - 5, this->string_id, this->width - 2);
  }

  virtual void OnMouseLoop()
  {
    /* We can show tooltips while dragging tools. These are shown as long as
     * we are dragging the tool. Normal tooltips work with rmb */
    if (this->use_left_mouse_button ? !_left_button_down : !_right_button_down) delete this;
  }
};

void GuiShowTooltips(StringID str, uint paramcount, const uint64 params[], bool use_left_mouse_button)
{
  DeleteWindowById(WC_TOOLTIPS, 0);

  if (str == STR_NULL) return;

  for (uint i = 0; i != paramcount; i++) SetDParam(i, params[i]);
  char buffer[512];
  GetString(buffer, str, lastof(buffer));

  Dimension br = GetStringBoundingBox(buffer);
  br.width += 6; br.height += 4; // increase slightly to have some space around the box

  /* Cut tooltip length to 200 pixels max, wrap to new line if longer */
  if (br.width > 200) {
    br.height += ((br.width - 4) / 176) * 10;
    br.width = 200;
  }

  /* Correctly position the tooltip position, watch out for window and cursor size
   * Clamp value to below main toolbar and above statusbar. If tooltip would
   * go below window, flip it so it is shown above the cursor */
  int y = Clamp(_cursor.pos.y + _cursor.size.y + _cursor.offs.y + 5, 22, _screen.height - 12);
  if (y + br.height > _screen.height - 12) y = _cursor.pos.y + _cursor.offs.y - br.height - 5;
  int x = Clamp(_cursor.pos.x - (br.width >> 1), 0, _screen.width - br.width);

  new TooltipsWindow(x, y, br.width, br.height, _tooltips_widgets, str, paramcount, params, use_left_mouse_button);
}


static int DrawStationCoverageText(const AcceptedCargo cargo,
  int str_x, int str_y, StationCoverageType sct, bool supplies)
{
  bool first = true;

  char string[512];
  char *b = InlineString(string, supplies ? STR_SUPPLIES : STR_000D_ACCEPTS);

  for (CargoID i = 0; i < NUM_CARGO; i++) {
    if (b >= lastof(string) - (1 + 2 * 4)) break; // ',' or ' ' and two calls to Utf8Encode()
    switch (sct) {
      case SCT_PASSENGERS_ONLY: if (!IsCargoInClass(i, CC_PASSENGERS)) continue; break;
      case SCT_NON_PASSENGERS_ONLY: if (IsCargoInClass(i, CC_PASSENGERS)) continue; break;
      case SCT_ALL: break;
      default: NOT_REACHED();
    }
    if (cargo[i] >= (supplies ? 1U : 8U)) {
      if (first) {
        first = false;
      } else {
        /* Add a comma if this is not the first item */
        *b++ = ',';
        *b++ = ' ';
      }
      b = InlineString(b, GetCargo(i)->name);
    }
  }

  /* If first is still true then no cargo is accepted */
  if (first) b = InlineString(b, STR_00D0_NOTHING);

  *b = '\0';

  /* Make sure we detect any buffer overflow */
  assert(b < endof(string));

  SetDParamStr(0, string);
  return DrawStringMultiLine(str_x, str_y, STR_JUST_RAW_STRING, 144);
}

int DrawStationCoverageAreaText(int sx, int sy, StationCoverageType sct, int rad, bool supplies)
{
  TileIndex tile = TileVirtXY(_thd.pos.x, _thd.pos.y);
  AcceptedCargo cargo;
  if (tile < MapSize()) {
    if (supplies) {
      GetProductionAroundTiles(cargo, tile, _thd.size.x / TILE_SIZE, _thd.size.y / TILE_SIZE , rad);
    } else {
      GetAcceptanceAroundTiles(cargo, tile, _thd.size.x / TILE_SIZE, _thd.size.y / TILE_SIZE , rad);
    }
    return sy + DrawStationCoverageText(cargo, sx, sy, sct, supplies);
  }

  return sy;
}

void CheckRedrawStationCoverage(const Window *w)
{
  if (_thd.dirty & 1) {
    _thd.dirty &= ~1;
    SetWindowDirty(w);
  }
}

/* Delete a character at the caret position in a text buf.
 * If backspace is set, delete the character before the caret,
 * else delete the character after it. */
static void DelChar(Textbuf *tb, bool backspace)
{
  WChar c;
  char *s = tb->buf + tb->caretpos;

  if (backspace) s = Utf8PrevChar(s);

  uint16 len = (uint16)Utf8Decode(&c, s);
  uint width = GetCharacterWidth(FS_NORMAL, c);

  tb->width  -= width;
  if (backspace) {
    tb->caretpos   -= len;
    tb->caretxoffs -= width;
  }

  /* Move the remaining characters over the marker */
  memmove(s, s + len, tb->size - (s - tb->buf) - len);
  tb->size -= len;
}

bool DeleteTextBufferChar(Textbuf *tb, int delmode)
{
  if (delmode == WKC_BACKSPACE && tb->caretpos != 0) {
    DelChar(tb, true);
    return true;
  } else if (delmode == WKC_DELETE && tb->caretpos < tb->size - 1) {
    DelChar(tb, false);
    return true;
  }

  return false;
}

void DeleteTextBufferAll(Textbuf *tb)
{
  memset(tb->buf, 0, tb->maxsize);
  tb->size = 1;
  tb->width = tb->caretpos = tb->caretxoffs = 0;
}

bool InsertTextBufferChar(Textbuf *tb, WChar key)
{
  const byte charwidth = GetCharacterWidth(FS_NORMAL, key);
  uint16 len = (uint16)Utf8CharLen(key);
  if (tb->size + len <= tb->maxsize && (tb->maxwidth == 0 || tb->width + charwidth <= tb->maxwidth)) {
    memmove(tb->buf + tb->caretpos + len, tb->buf + tb->caretpos, tb->size - tb->caretpos);
    Utf8Encode(tb->buf + tb->caretpos, key);
    tb->size  += len;
    tb->width += charwidth;

    tb->caretpos   += len;
    tb->caretxoffs += charwidth;
    return true;
  }
  return false;
}

bool MoveTextBufferPos(Textbuf *tb, int navmode)
{
  switch (navmode) {
    case WKC_LEFT:
      if (tb->caretpos != 0) {
        WChar c;
        const char *s = Utf8PrevChar(tb->buf + tb->caretpos);
        Utf8Decode(&c, s);
        tb->caretpos    = s - tb->buf; // -= (tb->buf + tb->caretpos - s)
        tb->caretxoffs -= GetCharacterWidth(FS_NORMAL, c);

        return true;
      }
      break;

    case WKC_RIGHT:
      if (tb->caretpos < tb->size - 1) {
        WChar c;

        tb->caretpos   += (uint16)Utf8Decode(&c, tb->buf + tb->caretpos);
        tb->caretxoffs += GetCharacterWidth(FS_NORMAL, c);

        return true;
      }
      break;

    case WKC_HOME:
      tb->caretpos = 0;
      tb->caretxoffs = 0;
      return true;

    case WKC_END:
      tb->caretpos = tb->size - 1;
      tb->caretxoffs = tb->width;
      return true;

    default:
      break;
  }

  return false;
}

void InitializeTextBuffer(Textbuf *tb, char *buf, uint16 maxsize, uint16 maxwidth)
{
  assert(maxsize != 0);

  tb->buf      = buf;
  tb->maxsize  = maxsize;
  tb->maxwidth = maxwidth;
  tb->caret    = true;
  UpdateTextBufferSize(tb);
}

void UpdateTextBufferSize(Textbuf *tb)
{
  const char *buf = tb->buf;

  tb->width = 0;
  tb->size = 1; // terminating zero

  WChar c;
  while ((c = Utf8Consume(&buf)) != '\0') {
    tb->width += GetCharacterWidth(FS_NORMAL, c);
    tb->size += Utf8CharLen(c);
  }

  assert(tb->size <= tb->maxsize);

  tb->caretpos = tb->size - 1;
  tb->caretxoffs = tb->width;
}

bool HandleCaret(Textbuf *tb)
{
  /* caret changed? */
  bool b = !!(_caret_timer & 0x20);

  if (b != tb->caret) {
    tb->caret = b;
    return true;
  }
  return false;
}

HandleEditBoxResult QueryString::HandleEditBoxKey(Window *w, int wid, uint16 key, uint16 keycode, Window::EventState &state)
{
  state = Window::ES_HANDLED;

  switch (keycode) {
    case WKC_ESC: return HEBR_CANCEL;

    case WKC_RETURN: case WKC_NUM_ENTER: return HEBR_CONFIRM;

    case (WKC_CTRL | 'V'):
      if (InsertTextBufferClipboard(&this->text)) w->InvalidateWidget(wid);
      break;

    case (WKC_CTRL | 'U'):
      DeleteTextBufferAll(&this->text);
      w->InvalidateWidget(wid);
      break;

    case WKC_BACKSPACE: case WKC_DELETE:
      if (DeleteTextBufferChar(&this->text, keycode)) w->InvalidateWidget(wid);
      break;

    case WKC_LEFT: case WKC_RIGHT: case WKC_END: case WKC_HOME:
      if (MoveTextBufferPos(&this->text, keycode)) w->InvalidateWidget(wid);
      break;

    default:
      if (IsValidChar(key, this->afilter)) {
        if (InsertTextBufferChar(&this->text, key)) w->InvalidateWidget(wid);
      } else { // key wasn't caught. Continue only if standard entry specified
        state = (this->afilter == CS_ALPHANUMERAL) ? Window::ES_HANDLED : Window::ES_NOT_HANDLED;
      }
  }

  return HEBR_EDITING;
}

void QueryString::HandleEditBox(Window *w, int wid)
{
  if (HandleCaret(&this->text)) w->InvalidateWidget(wid);
}

void QueryString::DrawEditBox(Window *w, int wid)
{
  const Widget *wi = &w->widget[wid];

  assert((wi->type & WWT_MASK) == WWT_EDITBOX);

  GfxFillRect(wi->left + 1, wi->top + 1, wi->right - 1, wi->bottom - 1, 215);

  DrawPixelInfo dpi;
  int delta;

  /* Limit the drawing of the string inside the widget boundaries */
  if (!FillDrawPixelInfo(&dpi,
      wi->left + 4,
      wi->top + 1,
      wi->right - wi->left - 4,
      wi->bottom - wi->top - 1)) {
    return;
  }

  DrawPixelInfo *old_dpi = _cur_dpi;
  _cur_dpi = &dpi;

  /* We will take the current widget length as maximum width, with a small
   * space reserved at the end for the caret to show */
  const Textbuf *tb = &this->text;

  delta = (wi->right - wi->left) - tb->width - 10;
  if (delta > 0) delta = 0;

  if (tb->caretxoffs + delta < 0) delta = -tb->caretxoffs;

  DoDrawString(tb->buf, delta, 0, TC_YELLOW);
  if (tb->caret) DoDrawString("_", tb->caretxoffs + delta, 0, TC_WHITE);

  _cur_dpi = old_dpi;
}

int QueryStringBaseWindow::HandleEditBoxKey(int wid, uint16 key, uint16 keycode, EventState &state)
{
  return this->QueryString::HandleEditBoxKey(this, wid, key, keycode, state);
}

void QueryStringBaseWindow::HandleEditBox(int wid)
{
  this->QueryString::HandleEditBox(this, wid);
}

<