21218532072

Committed 21 Jan 2026 05:04PM UTC coverage: 50.717% (+0.05%) from 50.663%

Build # 21218532072

Build Type

Pull #1679

github

Committed by

web-flow

Commit Message

Merge 3777db6bb into 12da8bf44

Pull Request Pull Request #1679: Add all classic S2 cheats and a few more

Run Details

92 of 168 new or added lines in 12 files covered. (54.76%)

7 existing lines in 5 files now uncovered.

22788 of 44932 relevant lines covered (50.72%)

42042.91 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

9.38

/extras/videoDrivers/SDL2/VideoSDL2.cpp

// Copyright (C) 2005 - 2025 Settlers Freaks (sf-team at siedler25.org)
//
// SPDX-License-Identifier: GPL-2.0-or-later

#include "VideoSDL2.h"
#include "driver/Interface.h"
#include "driver/VideoDriverLoaderInterface.h"
#include "driver/VideoInterface.h"
#include "enum_cast.hpp"
#include "helpers/LSANUtils.h"
#include "helpers/containerUtils.h"
#include "icon.h"
#include "openglCfg.hpp"
#include <s25util/utf8.h>
#include <boost/nowide/iostream.hpp>
#include <SDL.h>
#include <SDL_hints.h>
#include <SDL_video.h>
#include <algorithm>
#include <memory>

#ifdef _WIN32
#    include <boost/nowide/convert.hpp>
#    ifndef WIN32_LEAN_AND_MEAN
#        define WIN32_LEAN_AND_MEAN
#    endif
#    include <windows.h> // Avoid "Windows headers require the default packing option" due to SDL2
#    include <SDL_syswm.h>
#endif // _WIN32
#if RTTR_OGL_GL4ES
#    include <gl4esinit.h>
#endif

#define CHECK_SDL(call)                 \
    ([&]() -> bool {                    \
        if((call) < 0)                  \
        {                               \
            PrintError(SDL_GetError()); \
            return false;               \
        }                               \
        return true;                    \
    })()

namespace {
template<typename T>
struct SDLMemoryDeleter
{
    void operator()(T* p) const { SDL_free(p); }
};

template<typename T>
using SDL_memory = std::unique_ptr<T, SDLMemoryDeleter<T>>;

void setSpecialKeys(KeyEvent& ke, const SDL_Keymod mod)
{
    ke.ctrl = (mod & KMOD_CTRL);
    ke.shift = (mod & KMOD_SHIFT);
    ke.alt = (mod & KMOD_ALT);
}
void setSpecialKeys(KeyEvent& ke)
{
    setSpecialKeys(ke, SDL_GetModState());
}
} // namespace

IVideoDriver* CreateVideoInstance(VideoDriverLoaderInterface* CallBack)
{
    return new VideoSDL2(CallBack);
}

void FreeVideoInstance(IVideoDriver* driver)
{
    delete driver;
}

const char* GetDriverName()
{
#if RTTR_OGL_GL4ES
    return "(SDL2) OpenGL-ES gl4es via SDL2-Library";
#else
    return "(SDL2) OpenGL via SDL2-Library";
#endif
}

VideoSDL2::VideoSDL2(VideoDriverLoaderInterface* CallBack) : VideoDriver(CallBack), window(nullptr), context(nullptr) {}

VideoSDL2::~VideoSDL2()
{
    CleanUp();
}

const char* VideoSDL2::GetName() const
{
    return GetDriverName();
}

bool VideoSDL2::Initialize()
{
    initialized = false;
    rttr::ScopedLeakDisabler _;
    // Do not emulate mouse events using touch
    SDL_SetHint(SDL_HINT_TOUCH_MOUSE_EVENTS, "0");
    if(SDL_InitSubSystem(SDL_INIT_VIDEO) < 0)
    {
        PrintError(SDL_GetError());
        return false;
    }

    initialized = true;
    return initialized;
}

void VideoSDL2::CleanUp()
{
    if(!initialized)
        return;

    if(context)
        SDL_GL_DeleteContext(context);
    if(window)
        SDL_DestroyWindow(window);
    SDL_QuitSubSystem(SDL_INIT_VIDEO);
    SDL_Quit();
    initialized = false;
}

void VideoSDL2::UpdateCurrentSizes()
{
    int w, h, w2, h2;
    SDL_GetWindowSize(window, &w, &h);
    SDL_GL_GetDrawableSize(window, &w2, &h2);
    SetNewSize(VideoMode(w, h), Extent(w2, h2));
}

bool VideoSDL2::CreateScreen(const std::string& title, const VideoMode& size, bool fullscreen)
{
    if(!initialized)
        return false;

    // GL-Attributes
    CHECK_SDL(SDL_GL_SetAttribute(SDL_GL_CONTEXT_MAJOR_VERSION, RTTR_OGL_MAJOR));
    CHECK_SDL(SDL_GL_SetAttribute(SDL_GL_CONTEXT_MINOR_VERSION, RTTR_OGL_MINOR));
    SDL_GLprofile profile;
    if(RTTR_OGL_ES || RTTR_OGL_GL4ES)
        profile = SDL_GL_CONTEXT_PROFILE_ES;
    else if(RTTR_OGL_COMPAT)
        profile = SDL_GL_CONTEXT_PROFILE_COMPATIBILITY;
    else
        profile = SDL_GL_CONTEXT_PROFILE_CORE;

    CHECK_SDL(SDL_GL_SetAttribute(SDL_GL_CONTEXT_PROFILE_MASK, profile));

    CHECK_SDL(SDL_GL_SetAttribute(SDL_GL_RED_SIZE, 8));
    CHECK_SDL(SDL_GL_SetAttribute(SDL_GL_GREEN_SIZE, 8));
    CHECK_SDL(SDL_GL_SetAttribute(SDL_GL_BLUE_SIZE, 8));
    CHECK_SDL(SDL_GL_SetAttribute(SDL_GL_DOUBLEBUFFER, 1));

    int wndPos = SDL_WINDOWPOS_CENTERED;

    const auto requestedSize = fullscreen ? FindClosestVideoMode(size) : size;
    unsigned commonFlags = SDL_WINDOW_OPENGL;
    // TODO: Fix GUI scaling with High DPI support enabled.
    // See https://github.com/Return-To-The-Roots/s25client/issues/1621
    // commonFlags |= SDL_WINDOW_ALLOW_HIGHDPI;

    window = SDL_CreateWindow(title.c_str(), wndPos, wndPos, requestedSize.width, requestedSize.height,
                              commonFlags | (fullscreen ? SDL_WINDOW_FULLSCREEN : SDL_WINDOW_RESIZABLE));

    // Fallback to non-fullscreen
    if(!window && fullscreen)
    {
        window = SDL_CreateWindow(title.c_str(), wndPos, wndPos, requestedSize.width, requestedSize.height,
                                  commonFlags | SDL_WINDOW_RESIZABLE);
    }

    if(!window)
    {
        PrintError(SDL_GetError());
        return false;
    }

    isFullscreen_ = (SDL_GetWindowFlags(window) & SDL_WINDOW_FULLSCREEN) != 0;
    UpdateCurrentSizes();

    if(!isFullscreen_)
        MoveWindowToCenter();

    SDL_Surface* iconSurf =
      SDL_CreateRGBSurfaceFrom(image.data(), 48, 48, 32, 48 * 4, 0xFF000000, 0x00FF0000, 0x0000FF00, 0x000000FF);
    if(iconSurf)
    {
        SDL_SetWindowIcon(window, iconSurf);
        SDL_FreeSurface(iconSurf);
    } else
        PrintError(SDL_GetError());

    context = SDL_GL_CreateContext(window);

#ifdef _WIN32
    SetWindowTextW(GetConsoleWindow(), boost::nowide::widen(title).c_str());
#endif

    std::fill(keyboard.begin(), keyboard.end(), false);

    SDL_ShowCursor(0);

    return true;
}

bool VideoSDL2::ResizeScreen(const VideoMode& newSize, bool fullscreen)
{
    if(!initialized)
        return false;

    if(isFullscreen_ != fullscreen)
    {
        SDL_SetWindowFullscreen(window, fullscreen ? SDL_WINDOW_FULLSCREEN : 0);
        isFullscreen_ = (SDL_GetWindowFlags(window) & SDL_WINDOW_FULLSCREEN) != 0;
        if(!isFullscreen_)
        {
            SDL_SetWindowResizable(window, SDL_TRUE);
            MoveWindowToCenter();
        }
    }

    if(newSize != GetWindowSize())
    {
        if(isFullscreen_)
        {
            auto const targetMode = FindClosestVideoMode(newSize);
            SDL_DisplayMode target;
            target.w = targetMode.width;
            target.h = targetMode.height;
            target.format = 0;           // don't care
            target.refresh_rate = 0;     // don't care
            target.driverdata = nullptr; // initialize to 0
            // Explicitly change the window size to avoid a bug with SDL reporting the wrong size until alt+tab
            SDL_SetWindowSize(window, target.w, target.h);
            if(SDL_SetWindowDisplayMode(window, &target) < 0)
            {
                PrintError(SDL_GetError());
                return false;
            }
        } else
        {
            SDL_SetWindowSize(window, newSize.width, newSize.height);
        }
        UpdateCurrentSizes();
    }
    return true;
}

void VideoSDL2::PrintError(const std::string& msg) const
{
    boost::nowide::cerr << msg << std::endl;
}

void VideoSDL2::ShowErrorMessage(const std::string& title, const std::string& message)
{
    // window==nullptr is okay too ("no parent")
#ifdef __linux__
    // When using window, SDL will try to use a system tool like "zenity" which isn't always installed on every distro
    // so rttr will crash. But without a window it will use an x11 backend that should be available on x11 AND wayland
    // for compatibility reasons
    SDL_ShowSimpleMessageBox(SDL_MESSAGEBOX_ERROR, title.c_str(), message.c_str(), nullptr);
#else
    SDL_ShowSimpleMessageBox(SDL_MESSAGEBOX_ERROR, title.c_str(), message.c_str(), window);
#endif
}

void VideoSDL2::HandlePaste()
{
    if(!SDL_HasClipboardText())
        return;

    SDL_memory<char> text(SDL_GetClipboardText());
    if(!text || *text == '\0') // empty string indicates error
        PrintError(text ? SDL_GetError() : "Paste failed.");

    for(const char32_t c : s25util::utf8to32(text.get()))
        CallBack->Msg_KeyDown(KeyEvent(c));
}

void VideoSDL2::DestroyScreen()
{
    CleanUp();
}

bool VideoSDL2::SwapBuffers()
{
    SDL_GL_SwapWindow(window);
    return true;
}

bool VideoSDL2::MessageLoop()
{
    SDL_Event ev;
    while(SDL_PollEvent(&ev))
    {
        switch(ev.type)
        {
            default: break;

            case SDL_QUIT: return false;
            case SDL_WINDOWEVENT:
            {
                switch(ev.window.event)
                {
                    case SDL_WINDOWEVENT_RESIZED:
                    {
                        isFullscreen_ = (SDL_GetWindowFlags(window) & SDL_WINDOW_FULLSCREEN) != 0;
                        VideoMode newSize(ev.window.data1, ev.window.data2);
                        if(newSize != GetWindowSize())
                        {
                            UpdateCurrentSizes();
                            CallBack->WindowResized();
                        }
                    }
                    break;
                }
            }
            break;

            case SDL_KEYDOWN:
            {
                KeyEvent ke;

                switch(ev.key.keysym.sym)
                {
                    default:
                    {
                        // Die 12 F-Tasten
                        if(ev.key.keysym.sym >= SDLK_F1 && ev.key.keysym.sym <= SDLK_F12)
                            ke.kt = static_cast<KeyType>(rttr::enum_cast(KeyType::F1) + ev.key.keysym.sym - SDLK_F1);

                        if((SDL_GetModState() & KMOD_ALT) && isdigit(ev.key.keysym.sym))
                        {
                            ke.kt = KeyType::Char;
                            ke.c = ev.key.keysym.sym;
                        }
                    }
                    break;
                    case SDLK_RETURN: ke.kt = KeyType::Return; break;
                    case SDLK_SPACE: ke.kt = KeyType::Space; break;
                    case SDLK_LEFT: ke.kt = KeyType::Left; break;
                    case SDLK_RIGHT: ke.kt = KeyType::Right; break;
                    case SDLK_UP: ke.kt = KeyType::Up; break;
                    case SDLK_DOWN: ke.kt = KeyType::Down; break;
                    case SDLK_BACKSPACE: ke.kt = KeyType::Backspace; break;
                    case SDLK_DELETE: ke.kt = KeyType::Delete; break;
                    case SDLK_LSHIFT:
                    case SDLK_RSHIFT: ke.kt = KeyType::Shift; break;
                    case SDLK_TAB: ke.kt = KeyType::Tab; break;
                    case SDLK_HOME: ke.kt = KeyType::Home; break;
                    case SDLK_END: ke.kt = KeyType::End; break;
                    case SDLK_ESCAPE: ke.kt = KeyType::Escape; break;
                    case SDLK_PRINTSCREEN: ke.kt = KeyType::Print; break;
                    // case SDLK_BACKQUOTE: ev.key.keysym.scancode = '^'; break;
                    case SDLK_v:
                        if(SDL_GetModState() & KMOD_CTRL)
                        {
                            HandlePaste();
                            continue;
                        }
                        break;
                }

                setSpecialKeys(ke, SDL_Keymod(ev.key.keysym.mod));

                if(ke.kt != KeyType::Invalid)
                    CallBack->Msg_KeyDown(ke);
                else if(ke.alt || ke.ctrl)
                {
                    // Handle shortcuts (CTRL+x, ALT+y)
                    // but not possible combinations (ALT+0054)
                    const SDL_Keycode keycode = ev.key.keysym.sym;
                    if(keycode >= 'a' && keycode <= 'z')
                    {
                        ke.kt = KeyType::Char;
                        ke.c = static_cast<char32_t>(keycode);
                        CallBack->Msg_KeyDown(ke);
                    }
                }
            }
            break;
            case SDL_TEXTINPUT:
            {
                const std::u32string text = s25util::utf8to32(ev.text.text);
                KeyEvent ke(0);
                setSpecialKeys(ke);
                for(char32_t c : text)
                {
                    ke.c = c;
                    CallBack->Msg_KeyDown(ke);
                }
                break;
            }
            case SDL_MOUSEBUTTONDOWN:
                mouse_xy.pos = getGuiScale().screenToView(Position(ev.button.x, ev.button.y));

                if(/*!mouse_xy.ldown && */ ev.button.button == SDL_BUTTON_LEFT)
                {
                    mouse_xy.ldown = true;
                    CallBack->Msg_LeftDown(mouse_xy);
                }
                if(/*!mouse_xy.rdown &&*/ ev.button.button == SDL_BUTTON_RIGHT)
                {
                    mouse_xy.rdown = true;
                    CallBack->Msg_RightDown(mouse_xy);
                }
                break;
            case SDL_MOUSEBUTTONUP:
                mouse_xy.pos = getGuiScale().screenToView(Position(ev.button.x, ev.button.y));

                if(/*mouse_xy.ldown &&*/ ev.button.button == SDL_BUTTON_LEFT)
                {
                    mouse_xy.ldown = false;
                    CallBack->Msg_LeftUp(mouse_xy);
                }
                if(/*mouse_xy.rdown &&*/ ev.button.button == SDL_BUTTON_RIGHT)
                {
                    mouse_xy.rdown = false;
                    CallBack->Msg_RightUp(mouse_xy);
                }
                break;
            case SDL_MOUSEWHEEL:
            {
                int y = ev.wheel.y;
                if(ev.wheel.direction == SDL_MOUSEWHEEL_FLIPPED)
                    y = -y;
                if(y > 0)
                    CallBack->Msg_WheelUp(mouse_xy);
                else if(y < 0)
                    CallBack->Msg_WheelDown(mouse_xy);
            }
            break;
            case SDL_MOUSEMOTION:
            {
                const auto newPos = getGuiScale().screenToView(Position(ev.motion.x, ev.motion.y));
                // Avoid duplicate events especially when warping the mouse
                if(newPos != mouse_xy.pos)
                {
                    mouse_xy.pos = newPos;
                    CallBack->Msg_MouseMove(mouse_xy);
                }
            }
            break;
            case SDL_FINGERDOWN:
            {
                VideoMode wnSize = GetWindowSize();
                mouse_xy.pos = getGuiScale().screenToView(Position(static_cast<int>(ev.tfinger.x * wnSize.width),
                                                                   static_cast<int>(ev.tfinger.y * wnSize.height)));
                mouse_xy.ldown = true;
                mouse_xy.num_tfingers++;
                CallBack->Msg_LeftDown(mouse_xy);
                break;
            }
            case SDL_FINGERUP:
            {
                VideoMode wnSize = GetWindowSize();
                mouse_xy.pos = getGuiScale().screenToView(Position(static_cast<int>(ev.tfinger.x * wnSize.width),
                                                                   static_cast<int>(ev.tfinger.y * wnSize.height)));
                mouse_xy.ldown = false;
                CallBack->Msg_LeftUp(mouse_xy);
                mouse_xy.num_tfingers--; // Dirty way to count leftUp as touch event without extra isTouch bool
                break;
            }
            case SDL_FINGERMOTION:
            {
                VideoMode wnSize = GetWindowSize();
                const auto newPos = getGuiScale().screenToView(Position(
                  static_cast<int>(ev.tfinger.x * wnSize.width), static_cast<int>(ev.tfinger.y * wnSize.height)));

                if(newPos != mouse_xy.pos)
                {
                    mouse_xy.pos = newPos;
                    CallBack->Msg_MouseMove(mouse_xy);
                }
                break;
            }
            case SDL_MULTIGESTURE:
            {
                if(std::fabs(ev.mgesture.dDist) > 0.001)
                {
                    if(ev.mgesture.dDist > 0)
                        CallBack->Msg_WheelUp(mouse_xy);
                    else
                        CallBack->Msg_WheelDown(mouse_xy);
                }
                break;
            }
        }
    }

    return true;
}

unsigned long VideoSDL2::GetTickCount() const
{
    return SDL_GetTicks();
}

void VideoSDL2::ListVideoModes(std::vector<VideoMode>& video_modes) const
{
    int display = SDL_GetWindowDisplayIndex(window);
    if(display < 0)
        display = 0;
    for(int i = SDL_GetNumDisplayModes(display) - 1; i >= 0; --i)
    {
        SDL_DisplayMode mode;
        if(SDL_GetDisplayMode(display, i, &mode) != 0)
            PrintError(SDL_GetError());
        else
        {
            VideoMode vm(mode.w, mode.h);
            if(!helpers::contains(video_modes, vm))
                video_modes.push_back(vm);
        }
    }
}

OpenGL_Loader_Proc VideoSDL2::GetLoaderFunction() const
{
#if RTTR_OGL_GL4ES
    return gl4es_GetProcAddress;
#else
    return SDL_GL_GetProcAddress;
#endif
}

void VideoSDL2::SetMousePos(Position pos)
{
    const auto screenPos = getGuiScale().viewToScreen(pos);
    mouse_xy.pos = pos;
    SDL_WarpMouseInWindow(window, screenPos.x, screenPos.y);
}

KeyEvent VideoSDL2::GetModKeyState() const
{
    KeyEvent ke;
    setSpecialKeys(ke);
    return ke;
}

void* VideoSDL2::GetMapPointer() const
{
#ifdef WIN32
    SDL_SysWMinfo wmInfo;
    SDL_VERSION(&wmInfo.version);
    SDL_GetWindowWMInfo(window, &wmInfo);
    // return (void*)wmInfo.info.win.window;
    return (void*)wmInfo.info.win.window;
#else
    return nullptr;
#endif
}

void VideoSDL2::MoveWindowToCenter()
{
    SDL_Rect usableBounds;
    CHECK_SDL(SDL_GetDisplayUsableBounds(SDL_GetWindowDisplayIndex(window), &usableBounds));
    int top, left, bottom, right;
    if(CHECK_SDL(SDL_GetWindowBordersSize(window, &top, &left, &bottom, &right)) != 0)
        top = left = bottom = right = 0;
    usableBounds.w -= left + right;
    usableBounds.h -= top + bottom;
    if(usableBounds.w < GetWindowSize().width || usableBounds.h < GetWindowSize().height)
    {
        SDL_SetWindowSize(window, usableBounds.w, usableBounds.h);
        UpdateCurrentSizes();
    }
    SDL_SetWindowPosition(window, SDL_WINDOWPOS_CENTERED, SDL_WINDOWPOS_CENTERED);
}

1	// Copyright (C) 2005 - 2025 Settlers Freaks (sf-team at siedler25.org)
2	//
3	// SPDX-License-Identifier: GPL-2.0-or-later
4
5	#include "VideoSDL2.h"
6	#include "driver/Interface.h"
7	#include "driver/VideoDriverLoaderInterface.h"
8	#include "driver/VideoInterface.h"
9	#include "enum_cast.hpp"
10	#include "helpers/LSANUtils.h"
11	#include "helpers/containerUtils.h"
12	#include "icon.h"
13	#include "openglCfg.hpp"
14	#include <s25util/utf8.h>
15	#include <boost/nowide/iostream.hpp>
16	#include <SDL.h>
17	#include <SDL_hints.h>
18	#include <SDL_video.h>
19	#include <algorithm>
20	#include <memory>
21
22	#ifdef _WIN32
23	# include <boost/nowide/convert.hpp>
24	# ifndef WIN32_LEAN_AND_MEAN
25	# define WIN32_LEAN_AND_MEAN
26	# endif
27	# include <windows.h> // Avoid "Windows headers require the default packing option" due to SDL2
28	# include <SDL_syswm.h>
29	#endif // _WIN32
30	#if RTTR_OGL_GL4ES
31	# include <gl4esinit.h>
32	#endif
33
34	#define CHECK_SDL(call) \
35	([&]() -> bool { \
36	if((call) < 0) \
37	{ \
38	PrintError(SDL_GetError()); \
39	return false; \
40	} \
41	return true; \
42	})()
43
44	namespace {
45	template<typename T>
46	struct SDLMemoryDeleter
47	{
48	void operator()(T* p) const { SDL_free(p); }	×
49	};
50
51	template<typename T>
52	using SDL_memory = std::unique_ptr<T, SDLMemoryDeleter<T>>;
53
54	void setSpecialKeys(KeyEvent& ke, const SDL_Keymod mod)	×
55	{
56	ke.ctrl = (mod & KMOD_CTRL);	×
57	ke.shift = (mod & KMOD_SHIFT);	×
58	ke.alt = (mod & KMOD_ALT);	×
59	}	×
60	void setSpecialKeys(KeyEvent& ke)	×
61	{
62	setSpecialKeys(ke, SDL_GetModState());	×
63	}	×
64	} // namespace
65
66	IVideoDriver* CreateVideoInstance(VideoDriverLoaderInterface* CallBack)	1✔
67	{
68	return new VideoSDL2(CallBack);	1✔
69	}
70
71	void FreeVideoInstance(IVideoDriver* driver)	1✔
72	{
73	delete driver;	1✔
74	}	1✔
75
76	const char* GetDriverName()	5✔
77	{
78	#if RTTR_OGL_GL4ES
79	return "(SDL2) OpenGL-ES gl4es via SDL2-Library";
80	#else
81	return "(SDL2) OpenGL via SDL2-Library";	5✔
82	#endif
83	}
84
85	VideoSDL2::VideoSDL2(VideoDriverLoaderInterface* CallBack) : VideoDriver(CallBack), window(nullptr), context(nullptr) {}	1✔
86
87	VideoSDL2::~VideoSDL2()	2✔
88	{
89	CleanUp();	1✔
90	}	2✔
91
92	const char* VideoSDL2::GetName() const	2✔
93	{
94	return GetDriverName();	2✔
95	}
96
97	bool VideoSDL2::Initialize()	1✔
98	{
99	initialized = false;	1✔
100	rttr::ScopedLeakDisabler _;	1✔
101	// Do not emulate mouse events using touch
102	SDL_SetHint(SDL_HINT_TOUCH_MOUSE_EVENTS, "0");	1✔
103	if(SDL_InitSubSystem(SDL_INIT_VIDEO) < 0)	1✔
104	{
105	PrintError(SDL_GetError());	×
106	return false;	×
107	}
108
109	initialized = true;	1✔
110	return initialized;	1✔
111	}
112
113	void VideoSDL2::CleanUp()	1✔
114	{
115	if(!initialized)	1✔
116	return;	×
117
118	if(context)	1✔
119	SDL_GL_DeleteContext(context);	×
120	if(window)	1✔
121	SDL_DestroyWindow(window);	×
122	SDL_QuitSubSystem(SDL_INIT_VIDEO);	1✔
123	SDL_Quit();	1✔
124	initialized = false;	1✔
125	}
126
127	void VideoSDL2::UpdateCurrentSizes()	×
128	{
129	int w, h, w2, h2;
130	SDL_GetWindowSize(window, &w, &h);	×
131	SDL_GL_GetDrawableSize(window, &w2, &h2);	×
132	SetNewSize(VideoMode(w, h), Extent(w2, h2));	×
133	}	×
134
135	bool VideoSDL2::CreateScreen(const std::string& title, const VideoMode& size, bool fullscreen)	×
136	{
137	if(!initialized)	×
138	return false;	×
139
140	// GL-Attributes
141	CHECK_SDL(SDL_GL_SetAttribute(SDL_GL_CONTEXT_MAJOR_VERSION, RTTR_OGL_MAJOR));	×
142	CHECK_SDL(SDL_GL_SetAttribute(SDL_GL_CONTEXT_MINOR_VERSION, RTTR_OGL_MINOR));	×
143	SDL_GLprofile profile;
144	if(RTTR_OGL_ES \|\| RTTR_OGL_GL4ES)
145	profile = SDL_GL_CONTEXT_PROFILE_ES;
146	else if(RTTR_OGL_COMPAT)
147	profile = SDL_GL_CONTEXT_PROFILE_COMPATIBILITY;	×
148	else
149	profile = SDL_GL_CONTEXT_PROFILE_CORE;
150
151	CHECK_SDL(SDL_GL_SetAttribute(SDL_GL_CONTEXT_PROFILE_MASK, profile));	×
152
153	CHECK_SDL(SDL_GL_SetAttribute(SDL_GL_RED_SIZE, 8));	×
154	CHECK_SDL(SDL_GL_SetAttribute(SDL_GL_GREEN_SIZE, 8));	×
155	CHECK_SDL(SDL_GL_SetAttribute(SDL_GL_BLUE_SIZE, 8));	×
156	CHECK_SDL(SDL_GL_SetAttribute(SDL_GL_DOUBLEBUFFER, 1));	×
157
158	int wndPos = SDL_WINDOWPOS_CENTERED;	×
159
160	const auto requestedSize = fullscreen ? FindClosestVideoMode(size) : size;	×
161	unsigned commonFlags = SDL_WINDOW_OPENGL;	×
162	// TODO: Fix GUI scaling with High DPI support enabled.
163	// See https://github.com/Return-To-The-Roots/s25client/issues/1621
164	// commonFlags \|= SDL_WINDOW_ALLOW_HIGHDPI;
165
166	window = SDL_CreateWindow(title.c_str(), wndPos, wndPos, requestedSize.width, requestedSize.height,	×
167	commonFlags \| (fullscreen ? SDL_WINDOW_FULLSCREEN : SDL_WINDOW_RESIZABLE));	×
168
169	// Fallback to non-fullscreen
170	if(!window && fullscreen)	×
171	{
172	window = SDL_CreateWindow(title.c_str(), wndPos, wndPos, requestedSize.width, requestedSize.height,	×
173	commonFlags \| SDL_WINDOW_RESIZABLE);
174	}
175
176	if(!window)	×
177	{
178	PrintError(SDL_GetError());	×
179	return false;	×
180	}
181
182	isFullscreen_ = (SDL_GetWindowFlags(window) & SDL_WINDOW_FULLSCREEN) != 0;	×
183	UpdateCurrentSizes();	×
184
185	if(!isFullscreen_)	×
186	MoveWindowToCenter();	×
187
188	SDL_Surface* iconSurf =
189	SDL_CreateRGBSurfaceFrom(image.data(), 48, 48, 32, 48 * 4, 0xFF000000, 0x00FF0000, 0x0000FF00, 0x000000FF);	×
190	if(iconSurf)	×
191	{
192	SDL_SetWindowIcon(window, iconSurf);	×
193	SDL_FreeSurface(iconSurf);	×
194	} else
195	PrintError(SDL_GetError());	×
196
197	context = SDL_GL_CreateContext(window);	×
198
199	#ifdef _WIN32
200	SetWindowTextW(GetConsoleWindow(), boost::nowide::widen(title).c_str());
201	#endif
202
203	std::fill(keyboard.begin(), keyboard.end(), false);	×
204
205	SDL_ShowCursor(0);	×
206
207	return true;	×
208	}
209
210	bool VideoSDL2::ResizeScreen(const VideoMode& newSize, bool fullscreen)	×
211	{
212	if(!initialized)	×
213	return false;	×
214
215	if(isFullscreen_ != fullscreen)	×
216	{
217	SDL_SetWindowFullscreen(window, fullscreen ? SDL_WINDOW_FULLSCREEN : 0);	×
218	isFullscreen_ = (SDL_GetWindowFlags(window) & SDL_WINDOW_FULLSCREEN) != 0;	×
219	if(!isFullscreen_)	×
220	{
221	SDL_SetWindowResizable(window, SDL_TRUE);	×
222	MoveWindowToCenter();	×
223	}
224	}
225
226	if(newSize != GetWindowSize())	×
227	{
228	if(isFullscreen_)	×
229	{
230	auto const targetMode = FindClosestVideoMode(newSize);	×
231	SDL_DisplayMode target;
232	target.w = targetMode.width;	×
233	target.h = targetMode.height;	×
234	target.format = 0; // don't care	×
235	target.refresh_rate = 0; // don't care	×
236	target.driverdata = nullptr; // initialize to 0	×
237	// Explicitly change the window size to avoid a bug with SDL reporting the wrong size until alt+tab
238	SDL_SetWindowSize(window, target.w, target.h);	×
239	if(SDL_SetWindowDisplayMode(window, &target) < 0)	×
240	{
241	PrintError(SDL_GetError());	×
242	return false;	×
243	}
244	} else
245	{
246	SDL_SetWindowSize(window, newSize.width, newSize.height);	×
247	}
248	UpdateCurrentSizes();	×
249	}
250	return true;	×
251	}
252
253	void VideoSDL2::PrintError(const std::string& msg) const	×
254	{
255	boost::nowide::cerr << msg << std::endl;	×
256	}	×
257
258	void VideoSDL2::ShowErrorMessage(const std::string& title, const std::string& message)	×
259	{
260	// window==nullptr is okay too ("no parent")
261	#ifdef __linux__
262	// When using window, SDL will try to use a system tool like "zenity" which isn't always installed on every distro
263	// so rttr will crash. But without a window it will use an x11 backend that should be available on x11 AND wayland
264	// for compatibility reasons
265	SDL_ShowSimpleMessageBox(SDL_MESSAGEBOX_ERROR, title.c_str(), message.c_str(), nullptr);	×
266	#else
267	SDL_ShowSimpleMessageBox(SDL_MESSAGEBOX_ERROR, title.c_str(), message.c_str(), window);
268	#endif
269	}	×
270
271	void VideoSDL2::HandlePaste()	×
272	{
273	if(!SDL_HasClipboardText())	×
274	return;	×
275
276	SDL_memory<char> text(SDL_GetClipboardText());	×
277	if(!text \|\| *text == '\0') // empty string indicates error	×
278	PrintError(text ? SDL_GetError() : "Paste failed.");	×
279
280	for(const char32_t c : s25util::utf8to32(text.get()))	×
281	CallBack->Msg_KeyDown(KeyEvent(c));	×
282	}
283
284	void VideoSDL2::DestroyScreen()	×
285	{
286	CleanUp();	×
287	}	×
288
289	bool VideoSDL2::SwapBuffers()	×
290	{
291	SDL_GL_SwapWindow(window);	×
292	return true;	×
293	}
294
295	bool VideoSDL2::MessageLoop()	×
296	{
297	SDL_Event ev;
298	while(SDL_PollEvent(&ev))	×
299	{
300	switch(ev.type)	×
301	{
302	default: break;	×
303
304	case SDL_QUIT: return false;	×
305	case SDL_WINDOWEVENT:	×
306	{
307	switch(ev.window.event)	×
308	{
309	case SDL_WINDOWEVENT_RESIZED:	×
310	{
311	isFullscreen_ = (SDL_GetWindowFlags(window) & SDL_WINDOW_FULLSCREEN) != 0;	×
312	VideoMode newSize(ev.window.data1, ev.window.data2);	×
313	if(newSize != GetWindowSize())	×
314	{
315	UpdateCurrentSizes();	×
316	CallBack->WindowResized();	×
317	}
318	}
319	break;	×
320	}
321	}
322	break;	×
323
324	case SDL_KEYDOWN:	×
325	{
326	KeyEvent ke;	×
327
328	switch(ev.key.keysym.sym)	×
329	{
330	default:	×
331	{
332	// Die 12 F-Tasten
333	if(ev.key.keysym.sym >= SDLK_F1 && ev.key.keysym.sym <= SDLK_F12)	×
334	ke.kt = static_cast<KeyType>(rttr::enum_cast(KeyType::F1) + ev.key.keysym.sym - SDLK_F1);	×
335
NEW 336	if((SDL_GetModState() & KMOD_ALT) && isdigit(ev.key.keysym.sym))	×
337	{
NEW 338	ke.kt = KeyType::Char;	×
NEW 339	ke.c = ev.key.keysym.sym;	×
340	}
341	}
342	break;	×
343	case SDLK_RETURN: ke.kt = KeyType::Return; break;	×
344	case SDLK_SPACE: ke.kt = KeyType::Space; break;	×
345	case SDLK_LEFT: ke.kt = KeyType::Left; break;	×
346	case SDLK_RIGHT: ke.kt = KeyType::Right; break;	×
347	case SDLK_UP: ke.kt = KeyType::Up; break;	×
348	case SDLK_DOWN: ke.kt = KeyType::Down; break;	×
349	case SDLK_BACKSPACE: ke.kt = KeyType::Backspace; break;	×
350	case SDLK_DELETE: ke.kt = KeyType::Delete; break;	×
351	case SDLK_LSHIFT:	×
352	case SDLK_RSHIFT: ke.kt = KeyType::Shift; break;	×
353	case SDLK_TAB: ke.kt = KeyType::Tab; break;	×
354	case SDLK_HOME: ke.kt = KeyType::Home; break;	×
355	case SDLK_END: ke.kt = KeyType::End; break;	×
356	case SDLK_ESCAPE: ke.kt = KeyType::Escape; break;	×
357	case SDLK_PRINTSCREEN: ke.kt = KeyType::Print; break;	×
358	// case SDLK_BACKQUOTE: ev.key.keysym.scancode = '^'; break;
359	case SDLK_v:	×
360	if(SDL_GetModState() & KMOD_CTRL)	×
361	{
362	HandlePaste();	×
363	continue;	×
364	}
365	break;	×
366	}
367
368	setSpecialKeys(ke, SDL_Keymod(ev.key.keysym.mod));	×
369
370	if(ke.kt != KeyType::Invalid)	×
371	CallBack->Msg_KeyDown(ke);	×
372	else if(ke.alt \|\| ke.ctrl)	×
373	{
374	// Handle shortcuts (CTRL+x, ALT+y)
375	// but not possible combinations (ALT+0054)
376	const SDL_Keycode keycode = ev.key.keysym.sym;	×
377	if(keycode >= 'a' && keycode <= 'z')	×
378	{
379	ke.kt = KeyType::Char;	×
380	ke.c = static_cast<char32_t>(keycode);	×
381	CallBack->Msg_KeyDown(ke);	×
382	}
383	}
384	}
385	break;	×
386	case SDL_TEXTINPUT:	×
387	{
388	const std::u32string text = s25util::utf8to32(ev.text.text);	×
389	KeyEvent ke(0);	×
390	setSpecialKeys(ke);	×
391	for(char32_t c : text)	×
392	{
393	ke.c = c;	×
394	CallBack->Msg_KeyDown(ke);	×
395	}
396	break;	×
397	}
398	case SDL_MOUSEBUTTONDOWN:	×
399	mouse_xy.pos = getGuiScale().screenToView(Position(ev.button.x, ev.button.y));	×
400
401	if(/!mouse_xy.ldown && / ev.button.button == SDL_BUTTON_LEFT)	×
402	{
403	mouse_xy.ldown = true;	×
404	CallBack->Msg_LeftDown(mouse_xy);	×
405	}
406	if(/!mouse_xy.rdown &&/ ev.button.button == SDL_BUTTON_RIGHT)	×
407	{
408	mouse_xy.rdown = true;	×
409	CallBack->Msg_RightDown(mouse_xy);	×
410	}
411	break;	×
412	case SDL_MOUSEBUTTONUP:	×
413	mouse_xy.pos = getGuiScale().screenToView(Position(ev.button.x, ev.button.y));	×
414
415	if(/mouse_xy.ldown &&/ ev.button.button == SDL_BUTTON_LEFT)	×
416	{
417	mouse_xy.ldown = false;	×
418	CallBack->Msg_LeftUp(mouse_xy);	×
419	}
420	if(/mouse_xy.rdown &&/ ev.button.button == SDL_BUTTON_RIGHT)	×
421	{
422	mouse_xy.rdown = false;	×
423	CallBack->Msg_RightUp(mouse_xy);	×
424	}
425	break;	×
426	case SDL_MOUSEWHEEL:	×
427	{
428	int y = ev.wheel.y;	×
429	if(ev.wheel.direction == SDL_MOUSEWHEEL_FLIPPED)	×
430	y = -y;	×
431	if(y > 0)	×
432	CallBack->Msg_WheelUp(mouse_xy);	×
433	else if(y < 0)	×
434	CallBack->Msg_WheelDown(mouse_xy);	×
435	}
436	break;	×
437	case SDL_MOUSEMOTION:	×
438	{
439	const auto newPos = getGuiScale().screenToView(Position(ev.motion.x, ev.motion.y));	×
440	// Avoid duplicate events especially when warping the mouse
441	if(newPos != mouse_xy.pos)	×
442	{
443	mouse_xy.pos = newPos;	×
444	CallBack->Msg_MouseMove(mouse_xy);	×
445	}
446	}
447	break;	×
448	case SDL_FINGERDOWN:	×
449	{
450	VideoMode wnSize = GetWindowSize();	×
451	mouse_xy.pos = getGuiScale().screenToView(Position(static_cast<int>(ev.tfinger.x * wnSize.width),	×
452	static_cast<int>(ev.tfinger.y * wnSize.height)));	×
453	mouse_xy.ldown = true;	×
454	mouse_xy.num_tfingers++;	×
455	CallBack->Msg_LeftDown(mouse_xy);	×
456	break;	×
457	}
458	case SDL_FINGERUP:	×
459	{
460	VideoMode wnSize = GetWindowSize();	×
461	mouse_xy.pos = getGuiScale().screenToView(Position(static_cast<int>(ev.tfinger.x * wnSize.width),	×
462	static_cast<int>(ev.tfinger.y * wnSize.height)));	×
463	mouse_xy.ldown = false;	×
464	CallBack->Msg_LeftUp(mouse_xy);	×
465	mouse_xy.num_tfingers--; // Dirty way to count leftUp as touch event without extra isTouch bool	×
466	break;	×
467	}
468	case SDL_FINGERMOTION:	×
469	{
470	VideoMode wnSize = GetWindowSize();	×
471	const auto newPos = getGuiScale().screenToView(Position(	×
472	static_cast<int>(ev.tfinger.x * wnSize.width), static_cast<int>(ev.tfinger.y * wnSize.height)));	×
473
474	if(newPos != mouse_xy.pos)	×
475	{
476	mouse_xy.pos = newPos;	×
477	CallBack->Msg_MouseMove(mouse_xy);	×
478	}
479	break;	×
480	}
481	case SDL_MULTIGESTURE:	×
482	{
483	if(std::fabs(ev.mgesture.dDist) > 0.001)	×
484	{
485	if(ev.mgesture.dDist > 0)	×
486	CallBack->Msg_WheelUp(mouse_xy);	×
487	else
488	CallBack->Msg_WheelDown(mouse_xy);	×
489	}
490	break;	×
491	}
492	}
493	}
494
495	return true;	×
496	}
497
498	unsigned long VideoSDL2::GetTickCount() const	×
499	{
500	return SDL_GetTicks();	×
501	}
502
503	void VideoSDL2::ListVideoModes(std::vector<VideoMode>& video_modes) const	×
504	{
505	int display = SDL_GetWindowDisplayIndex(window);	×
506	if(display < 0)	×
507	display = 0;	×
508	for(int i = SDL_GetNumDisplayModes(display) - 1; i >= 0; --i)	×
509	{
510	SDL_DisplayMode mode;
511	if(SDL_GetDisplayMode(display, i, &mode) != 0)	×
512	PrintError(SDL_GetError());	×
513	else
514	{
515	VideoMode vm(mode.w, mode.h);	×
516	if(!helpers::contains(video_modes, vm))	×
517	video_modes.push_back(vm);	×
518	}
519	}
520	}	×
521
522	OpenGL_Loader_Proc VideoSDL2::GetLoaderFunction() const	×
523	{
524	#if RTTR_OGL_GL4ES
525	return gl4es_GetProcAddress;
526	#else
527	return SDL_GL_GetProcAddress;	×
528	#endif
529	}
530
531	void VideoSDL2::SetMousePos(Position pos)	×
532	{
533	const auto screenPos = getGuiScale().viewToScreen(pos);	×
534	mouse_xy.pos = pos;	×
535	SDL_WarpMouseInWindow(window, screenPos.x, screenPos.y);	×
536	}	×
537
538	KeyEvent VideoSDL2::GetModKeyState() const	×
539	{
540	KeyEvent ke;	×
541	setSpecialKeys(ke);	×
542	return ke;	×
543	}
544
545	void* VideoSDL2::GetMapPointer() const	×
546	{
547	#ifdef WIN32
548	SDL_SysWMinfo wmInfo;
549	SDL_VERSION(&wmInfo.version);
550	SDL_GetWindowWMInfo(window, &wmInfo);
551	// return (void*)wmInfo.info.win.window;
552	return (void*)wmInfo.info.win.window;
553	#else
554	return nullptr;	×
555	#endif
556	}
557
558	void VideoSDL2::MoveWindowToCenter()	×
559	{
560	SDL_Rect usableBounds;
561	CHECK_SDL(SDL_GetDisplayUsableBounds(SDL_GetWindowDisplayIndex(window), &usableBounds));	×
562	int top, left, bottom, right;
563	if(CHECK_SDL(SDL_GetWindowBordersSize(window, &top, &left, &bottom, &right)) != 0)	×
564	top = left = bottom = right = 0;	×
565	usableBounds.w -= left + right;	×
566	usableBounds.h -= top + bottom;	×
567	if(usableBounds.w < GetWindowSize().width \|\| usableBounds.h < GetWindowSize().height)	×
568	{
569	SDL_SetWindowSize(window, usableBounds.w, usableBounds.h);	×
570	UpdateCurrentSizes();	×
571	}
572	SDL_SetWindowPosition(window, SDL_WINDOWPOS_CENTERED, SDL_WINDOWPOS_CENTERED);	×
573	}	×

Return-To-The-Roots / s25client / 21218532072

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous