aboutsummaryrefslogtreecommitdiff
path: root/src/util/basic_macros.h
blob: 334e342e095e08a9e6b05c6ea3831913c40b5250 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
/*
Minetest
Copyright (C) 2010-2013 celeron55, Perttu Ahola <celeron55@gmail.com>

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/

#pragma once

#define ARRLEN(x) (sizeof(x) / sizeof((x)[0]))

#define MYMIN(a, b) ((a) < (b) ? (a) : (b))

#define MYMAX(a, b) ((a) > (b) ? (a) : (b))

// Requires <algorithm>
#define CONTAINS(c, v) (std::find((c).begin(), (c).end(), (v)) != (c).end())

// To disable copy constructors and assignment operations for some class
// 'Foobar', add the macro DISABLE_CLASS_COPY(Foobar) as a private member.
// Note this also disables copying for any classes derived from 'Foobar' as well
// as classes having a 'Foobar' member.
#define DISABLE_CLASS_COPY(C)        \
	C(const C &) = delete;           \
	C &operator=(const C &) = delete;

#ifndef _MSC_VER
	#define UNUSED_ATTRIBUTE __attribute__ ((unused))
#else
	#define UNUSED_ATTRIBUTE
#endif

// Fail compilation if condition expr is not met.
// Note that 'msg' must follow the format of a valid identifier, e.g.
// STATIC_ASSERT(sizeof(foobar_t) == 40), foobar_t_is_wrong_size);
#define STATIC_ASSERT(expr, msg) \
	UNUSED_ATTRIBUTE typedef char msg[!!(expr) * 2 - 1]

// Macros to facilitate writing position vectors to a stream
// Usage:
//	v3s16 pos(1,2,3);
//	mystream << "message " << PP(pos) << std::endl;

#define PP(x) "("<<(x).X<<","<<(x).Y<<","<<(x).Z<<")"

#define PP2(x) "("<<(x).X<<","<<(x).Y<<")"
#include "game.h" using namespace irr; class Client; class GUIChatConsole; struct MapDrawControl; /* * This object intend to contain the core UI elements * It includes: * - status texts * - debug texts * - chat texts * - hud flags */ class GameUI { // Temporary between coding time to move things here friend class Game; // Permit unittests to access members directly friend class TestGameUI; public: GameUI(); ~GameUI() = default; // Flags that can, or may, change during main game loop struct Flags { bool show_chat = true; bool show_hud = true; bool show_minimap = false; bool show_debug = true; bool show_profiler_graph = false; }; void init(); void update(const RunStats &stats, Client *client, MapDrawControl *draw_control, const CameraOrientation &cam, const PointedThing &pointed_old, const GUIChatConsole *chat_console, float dtime); void initFlags(); const Flags &getFlags() const { return m_flags; } void showMinimap(bool show); inline void setInfoText(const std::wstring &str) { m_infotext = str; } inline void clearInfoText() { m_infotext.clear(); } inline void showStatusText(const std::wstring &str) { m_statustext = str; m_statustext_time = 0.0f; } void showTranslatedStatusText(const char *str); inline void clearStatusText() { m_statustext.clear(); } const bool isChatVisible() { return m_flags.show_chat && m_recent_chat_count != 0 && m_profiler_current_page == 0; } void setChatText(const EnrichedString &chat_text, u32 recent_chat_count); void updateProfiler(); void toggleChat(); void toggleHud(); void toggleProfiler(); GUIFormSpecMenu *&updateFormspec(const std::string &formname) { m_formname = formname; return m_formspec; } const std::string &getFormspecName() { return m_formname; } GUIFormSpecMenu *&getFormspecGUI() { return m_formspec; } void deleteFormspec(); private: Flags m_flags; gui::IGUIStaticText *m_guitext = nullptr; // First line of debug text gui::IGUIStaticText *m_guitext2 = nullptr; // Second line of debug text gui::IGUIStaticText *m_guitext_info = nullptr; // At the middle of the screen std::wstring m_infotext; gui::IGUIStaticText *m_guitext_status = nullptr; std::wstring m_statustext; float m_statustext_time = 0.0f; video::SColor m_statustext_initial_color; gui::IGUIStaticText *m_guitext_chat = nullptr; // Chat text u32 m_recent_chat_count = 0; gui::IGUIStaticText *m_guitext_profiler = nullptr; // Profiler text u8 m_profiler_current_page = 0; const u8 m_profiler_max_page = 3; // Default: "". If other than "": Empty show_formspec packets will only // close the formspec when the formname matches std::string m_formname; GUIFormSpecMenu *m_formspec = nullptr; };