OpenRCT2/src/openrct2-ui/windows/Changelog.cpp

288 lines
8.1 KiB
C++

/*****************************************************************************
* Copyright (c) 2014-2019 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 <algorithm>
#include <fstream>
#include <openrct2-ui/interface/Widget.h>
#include <openrct2-ui/windows/Window.h>
#include <openrct2/Context.h>
#include <openrct2/OpenRCT2.h>
#include <openrct2/PlatformEnvironment.h>
#include <openrct2/core/String.hpp>
#include <openrct2/drawing/Drawing.h>
#include <openrct2/localisation/Localisation.h>
#include <openrct2/platform/platform.h>
#include <openrct2/util/Util.h>
#include <vector>
using namespace OpenRCT2;
// clang-format off
enum {
WIDX_BACKGROUND,
WIDX_TITLE,
WIDX_CLOSE,
WIDX_CONTENT_PANEL,
WIDX_SCROLL
};
constexpr int32_t WW = 500;
constexpr int32_t WH = 400;
static constexpr const rct_string_id WINDOW_TITLE = STR_CHANGELOG_TITLE;
constexpr int32_t MIN_WW = 300;
constexpr int32_t MIN_WH = 200;
static rct_widget window_changelog_widgets[] = {
{ WINDOW_SKELETON(WINDOW_TITLE, WW, WH) },
{ WWT_RESIZE, 1, 0, WW - 1, 14, WH - 1, 0xFFFFFFFF, STR_NONE }, // content panel
{ WWT_SCROLL, 1, 3, WW - 3, 16, WH - 15, SCROLL_BOTH, STR_NONE }, // scroll area
{ WIDGETS_END },
};
static void window_changelog_close(rct_window *w);
static void window_changelog_mouseup(rct_window *w, rct_widgetindex widgetIndex);
static void window_changelog_resize(rct_window *w);
static void window_changelog_scrollgetsize(rct_window *w, int32_t scrollIndex, int32_t *width, int32_t *height);
static void window_changelog_invalidate(rct_window *w);
static void window_changelog_paint(rct_window *w, rct_drawpixelinfo *dpi);
static void window_changelog_scrollpaint(rct_window *w, rct_drawpixelinfo *dpi, int32_t scrollIndex);
static rct_window_event_list window_changelog_events = {
window_changelog_close,
window_changelog_mouseup,
window_changelog_resize,
nullptr,
nullptr,
nullptr,
nullptr,
nullptr,
nullptr,
nullptr,
nullptr,
nullptr,
nullptr,
nullptr,
nullptr,
window_changelog_scrollgetsize,
nullptr,
nullptr,
nullptr,
nullptr,
nullptr,
nullptr,
nullptr,
nullptr,
nullptr,
window_changelog_invalidate,
window_changelog_paint,
window_changelog_scrollpaint
};
// clang-format on
static bool window_changelog_read_file();
static void window_changelog_dispose_file();
static std::string _changelogText;
static std::vector<const char*> _changelogLines;
static int32_t _changelogLongestLineWidth = 0;
rct_window* window_changelog_open()
{
rct_window* window;
window = window_bring_to_front_by_class(WC_CHANGELOG);
if (window != nullptr)
return window;
if (!window_changelog_read_file())
return nullptr;
int32_t screenWidth = context_get_width();
int32_t screenHeight = context_get_height();
window = window_create_centred(
screenWidth * 4 / 5, screenHeight * 4 / 5, &window_changelog_events, WC_CHANGELOG, WF_RESIZABLE);
window->widgets = window_changelog_widgets;
window->enabled_widgets = (1 << WIDX_CLOSE);
window_init_scroll_widgets(window);
window->min_width = MIN_WW;
window->min_height = MIN_WH;
window->max_width = MIN_WW;
window->max_height = MIN_WH;
return window;
}
static void window_changelog_close([[maybe_unused]] rct_window* w)
{
window_changelog_dispose_file();
}
static void window_changelog_mouseup(rct_window* w, rct_widgetindex widgetIndex)
{
switch (widgetIndex)
{
case WIDX_CLOSE:
window_close(w);
break;
}
}
static void window_changelog_resize(rct_window* w)
{
int32_t screenWidth = context_get_width();
int32_t screenHeight = context_get_height();
w->max_width = (screenWidth * 4) / 5;
w->max_height = (screenHeight * 4) / 5;
w->min_width = MIN_WW;
w->min_height = MIN_WH;
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_changelog_scrollgetsize(
[[maybe_unused]] rct_window* w, [[maybe_unused]] int32_t scrollIndex, int32_t* width, int32_t* height)
{
*width = _changelogLongestLineWidth + 4;
const int32_t lineHeight = font_get_line_height(gCurrentFontSpriteBase);
*height = static_cast<int32_t>(_changelogLines.size() * lineHeight);
}
static void window_changelog_invalidate(rct_window* w)
{
window_changelog_widgets[WIDX_BACKGROUND].right = w->width - 1;
window_changelog_widgets[WIDX_BACKGROUND].bottom = w->height - 1;
window_changelog_widgets[WIDX_TITLE].right = w->width - 2;
window_changelog_widgets[WIDX_CLOSE].left = w->width - 13;
window_changelog_widgets[WIDX_CLOSE].right = w->width - 3;
window_changelog_widgets[WIDX_CONTENT_PANEL].right = w->width - 1;
window_changelog_widgets[WIDX_CONTENT_PANEL].bottom = w->height - 1;
window_changelog_widgets[WIDX_SCROLL].right = w->width - 3;
window_changelog_widgets[WIDX_SCROLL].bottom = w->height - 15;
}
static void window_changelog_paint(rct_window* w, rct_drawpixelinfo* dpi)
{
window_draw_widgets(w, dpi);
}
static void window_changelog_scrollpaint(rct_window* w, rct_drawpixelinfo* dpi, [[maybe_unused]] int32_t scrollIndex)
{
gCurrentFontFlags = 0;
gCurrentFontSpriteBase = FONT_SPRITE_BASE_MEDIUM;
const int32_t lineHeight = font_get_line_height(gCurrentFontSpriteBase);
int32_t x = 3;
int32_t y = 3 - lineHeight;
for (auto line : _changelogLines)
{
y += lineHeight;
if (y + lineHeight < dpi->y || y >= dpi->y + dpi->height)
continue;
gfx_draw_string(dpi, static_cast<const char*>(line), w->colours[0], x, y);
}
}
static std::string GetChangelogPath()
{
auto env = GetContext()->GetPlatformEnvironment();
return env->GetFilePath(PATHID::CHANGELOG);
}
static std::string GetChangelogText()
{
auto path = GetChangelogPath();
#if defined(_WIN32) && !defined(__MINGW32__)
auto pathW = String::ToWideChar(path);
auto fs = std::ifstream(pathW, std::ios::in);
#else
auto fs = std::ifstream(path, std::ios::in);
#endif
if (!fs.is_open())
{
throw std::runtime_error("Unable to open " + path);
}
return std::string((std::istreambuf_iterator<char>(fs)), std::istreambuf_iterator<char>());
}
static bool window_changelog_read_file()
{
try
{
_changelogText = GetChangelogText();
}
catch (const std::bad_alloc&)
{
log_error("Unable to allocate memory for changelog.txt");
return false;
}
catch (const std::exception&)
{
log_error("Unable to read changelog.txt");
return false;
}
// Non-const cast required until C++17 is enabled
auto* start = static_cast<char*>(_changelogText.data());
if (_changelogText.size() >= 3 && utf8_is_bom(start))
{
start += 3;
}
_changelogLines.clear();
_changelogLines.push_back(start);
auto ch = start;
while (*ch != '\0')
{
uint8_t c = *ch;
if (c == '\n')
{
*ch++ = 0;
_changelogLines.push_back(ch);
}
else if (utf8_is_format_code(c))
{
*ch++ = FORMAT_OUTLINE_OFF;
}
else
{
ch++;
}
}
gCurrentFontSpriteBase = FONT_SPRITE_BASE_MEDIUM;
_changelogLongestLineWidth = 0;
for (auto line : _changelogLines)
{
auto width = gfx_get_string_width(line);
_changelogLongestLineWidth = std::max(width, _changelogLongestLineWidth);
}
return true;
}
static void window_changelog_dispose_file()
{
_changelogText = std::string();
_changelogLines.clear();
_changelogLines.shrink_to_fit();
}