Skip to content

Commit 3c4734d

Browse files
kahrlkahrl
committedSep 10, 2013
Change mainmenu texture handling + small misc changes
Texture names must now be escaped in formspec elements image[], background[], image_button[], image_button_exit[]. Instead of special-case handling of texture loading (and unloading which was missing) in guiFormSpecMenu.cpp, use the newly created ISimpleTextureSource interface which is a minimal subset of ITextureSource. There is an implementation of this interface used by GUIEngine (MenuTextureSource). Fix an off-by-one bug in unescape_string; it caused requests for a texture called "\0".
·
5.11.00.4.8
1 parent da9fe64 commit 3c4734d

11 files changed

+150
-90
lines changed
 

‎builtin/gamemgr.lua

+4-2
Original file line numberDiff line numberDiff line change
@@ -225,7 +225,8 @@ function gamemgr.tab()
225225
if current_game.menuicon_path ~= nil and
226226
current_game.menuicon_path ~= "" then
227227
retval = retval ..
228-
"image[5.8,-0.25;2,2;" .. current_game.menuicon_path .. "]"
228+
"image[5.8,-0.25;2,2;" ..
229+
engine.formspec_escape(current_game.menuicon_path) .. "]"
229230
end
230231

231232
retval = retval ..
@@ -251,7 +252,8 @@ function gamemgr.dialog_edit_game()
251252
if current_game.menuicon_path ~= nil and
252253
current_game.menuicon_path ~= "" then
253254
retval = retval ..
254-
"image[5.25,0;2,2;" .. current_game.menuicon_path .. "]"
255+
"image[5.25,0;2,2;" ..
256+
engine.formspec_escape(current_game.menuicon_path) .. "]"
255257
end
256258

257259
retval = retval ..

‎builtin/mainmenu.lua

+3-2
Original file line numberDiff line numberDiff line change
@@ -1047,16 +1047,17 @@ function tabbuilder.tab_texture_packs()
10471047
return retval ..
10481048
menu.render_texture_pack_list(list) ..
10491049
";" .. index .. "]" ..
1050-
"image[0.65,0.25;4.0,3.7;"..(screenfile or no_screenshot).."]"..
1050+
"image[0.65,0.25;4.0,3.7;"..engine.formspec_escape(screenfile or no_screenshot).."]"..
10511051
"textarea[1.0,3.25;3.7,1.5;;"..engine.formspec_escape(infotext or "")..";]"
10521052
end
10531053

10541054
--------------------------------------------------------------------------------
10551055
function tabbuilder.tab_credits()
1056+
local logofile = menu.defaulttexturedir .. "logo.png"
10561057
return "vertlabel[0,-0.5;CREDITS]" ..
10571058
"label[0.5,3;Minetest " .. engine.get_version() .. "]" ..
10581059
"label[0.5,3.3;http://minetest.net]" ..
1059-
"image[0.5,1;" .. menu.defaulttexturedir .. "logo.png]" ..
1060+
"image[0.5,1;" .. engine.formspec_escape(logofile) .. "]" ..
10601061
"textlist[3.5,-0.25;8.5,5.8;list_credits;" ..
10611062
"#FFFF00" .. fgettext("Core Developers") .."," ..
10621063
"Perttu Ahola (celeron55) <celeron55@gmail.com>,"..

‎builtin/mm_menubar.lua

+3-2
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,8 @@ function menubar.refresh()
5151

5252
menubar.formspec = menubar.formspec ..
5353
"image_button[" .. buttonpos .. ",5.7;1.3,1.3;" ..
54-
gamemgr.games[i].menuicon_path .. ";" .. btn_name .. ";;true;false]"
54+
engine.formspec_escape(gamemgr.games[i].menuicon_path) .. ";" ..
55+
btn_name .. ";;true;false]"
5556
else
5657

5758
local part1 = gamemgr.games[i].id:sub(1,5)
@@ -75,4 +76,4 @@ function menubar.refresh()
7576

7677
table.insert(menubar.buttons,toadd)
7778
end
78-
end
79+
end

‎builtin/modstore.lua

+1-1
Original file line numberDiff line numberDiff line change
@@ -227,7 +227,7 @@ function modstore.getmodlist(list)
227227
end
228228

229229
retval = retval .. "image[0,".. screenshot_ypos .. ";3,2;" ..
230-
list.data[i].texturename .. "]"
230+
engine.formspec_escape(list.data[i].texturename) .. "]"
231231

232232
--title + author
233233
retval = retval .."label[2.75," .. screenshot_ypos .. ";" ..

‎src/game.cpp

+3-3
Original file line numberDiff line numberDiff line change
@@ -1720,7 +1720,7 @@ void the_game(
17201720
GUIFormSpecMenu *menu =
17211721
new GUIFormSpecMenu(device, guiroot, -1,
17221722
&g_menumgr,
1723-
&client, gamedef);
1723+
&client, gamedef, tsrc);
17241724

17251725
InventoryLocation inventoryloc;
17261726
inventoryloc.setCurrentPlayer();
@@ -2259,7 +2259,7 @@ void the_game(
22592259
GUIFormSpecMenu *menu =
22602260
new GUIFormSpecMenu(device, guiroot, -1,
22612261
&g_menumgr,
2262-
&client, gamedef);
2262+
&client, gamedef, tsrc);
22632263
menu->setFormSource(current_formspec);
22642264
menu->setTextDest(current_textdest);
22652265
menu->drop();
@@ -2755,7 +2755,7 @@ void the_game(
27552755
GUIFormSpecMenu *menu =
27562756
new GUIFormSpecMenu(device, guiroot, -1,
27572757
&g_menumgr,
2758-
&client, gamedef);
2758+
&client, gamedef, tsrc);
27592759
menu->setFormSpec(meta->getString("formspec"),
27602760
inventoryloc);
27612761
menu->setFormSource(new NodeMetadataFormSource(

‎src/guiEngine.cpp

+46-2
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ with this program; if not, write to the Free Software Foundation, Inc.,
2828
#include "guiMainMenu.h"
2929
#include "sound.h"
3030
#include "sound_openal.h"
31+
#include "clouds.h"
3132

3233
#include <IGUIStaticText.h>
3334
#include <ICameraSceneNode.h>
@@ -36,6 +37,8 @@ with this program; if not, write to the Free Software Foundation, Inc.,
3637
#include <curl/curl.h>
3738
#endif
3839

40+
/******************************************************************************/
41+
/** TextDestGuiEngine */
3942
/******************************************************************************/
4043
TextDestGuiEngine::TextDestGuiEngine(GUIEngine* engine)
4144
{
@@ -54,6 +57,38 @@ void TextDestGuiEngine::gotText(std::wstring text)
5457
m_engine->getScriptIface()->handleMainMenuEvent(wide_to_narrow(text));
5558
}
5659

60+
/******************************************************************************/
61+
/** MenuTextureSource */
62+
/******************************************************************************/
63+
MenuTextureSource::MenuTextureSource(video::IVideoDriver *driver)
64+
{
65+
m_driver = driver;
66+
}
67+
68+
/******************************************************************************/
69+
MenuTextureSource::~MenuTextureSource()
70+
{
71+
for (std::set<std::string>::iterator it = m_to_delete.begin();
72+
it != m_to_delete.end(); ++it) {
73+
const char *tname = (*it).c_str();
74+
video::ITexture *texture = m_driver->getTexture(tname);
75+
m_driver->removeTexture(texture);
76+
}
77+
}
78+
79+
/******************************************************************************/
80+
video::ITexture* MenuTextureSource::getTexture(const std::string &name, u32 *id)
81+
{
82+
if(id)
83+
*id = 0;
84+
if(name.empty())
85+
return NULL;
86+
m_to_delete.insert(name);
87+
return m_driver->getTexture(name.c_str());
88+
}
89+
90+
/******************************************************************************/
91+
/** MenuMusicFetcher */
5792
/******************************************************************************/
5893
void MenuMusicFetcher::fetchSounds(const std::string &name,
5994
std::set<std::string> &dst_paths,
@@ -74,6 +109,8 @@ void MenuMusicFetcher::fetchSounds(const std::string &name,
74109
dst_paths.insert(base + DIR_DELIM + name + "."+itos(i)+".ogg");
75110
}
76111

112+
/******************************************************************************/
113+
/** GUIEngine */
77114
/******************************************************************************/
78115
GUIEngine::GUIEngine( irr::IrrlichtDevice* dev,
79116
gui::IGUIElement* parent,
@@ -86,6 +123,7 @@ GUIEngine::GUIEngine( irr::IrrlichtDevice* dev,
86123
m_menumanager(menumgr),
87124
m_smgr(smgr),
88125
m_data(data),
126+
m_texture_source(NULL),
89127
m_sound_manager(NULL),
90128
m_formspecgui(0),
91129
m_buttonhandler(0),
@@ -105,6 +143,9 @@ GUIEngine::GUIEngine( irr::IrrlichtDevice* dev,
105143
// is deleted by guiformspec!
106144
m_buttonhandler = new TextDestGuiEngine(this);
107145

146+
//create texture source
147+
m_texture_source = new MenuTextureSource(m_device->getVideoDriver());
148+
108149
//create soundmanager
109150
MenuMusicFetcher soundfetcher;
110151
#if USE_SOUND
@@ -132,7 +173,8 @@ GUIEngine::GUIEngine( irr::IrrlichtDevice* dev,
132173
-1,
133174
m_menumanager,
134175
0 /* &client */,
135-
0 /* gamedef */);
176+
0 /* gamedef */,
177+
m_texture_source);
136178

137179
m_menu->allowClose(false);
138180
m_menu->lockSize(true,v2u32(800,600));
@@ -264,11 +306,13 @@ GUIEngine::~GUIEngine()
264306

265307
m_irr_toplefttext->setText(L"");
266308

267-
//initialize texture pointers
309+
//clean up texture pointers
268310
for (unsigned int i = 0; i < TEX_LAYER_MAX; i++) {
269311
if (m_textures[i] != 0)
270312
driver->removeTexture(m_textures[i]);
271313
}
314+
315+
delete m_texture_source;
272316

273317
if (m_cloud.clouds)
274318
m_cloud.clouds->drop();

‎src/guiEngine.h

+47-8
Original file line numberDiff line numberDiff line change
@@ -25,17 +25,13 @@ with this program; if not, write to the Free Software Foundation, Inc.,
2525
/******************************************************************************/
2626
#include "irrlichttypes.h"
2727
#include "modalMenu.h"
28-
#include "clouds.h"
2928
#include "guiFormSpecMenu.h"
3029
#include "sound.h"
30+
#include "tile.h"
3131

3232
/******************************************************************************/
3333
/* Typedefs and macros */
3434
/******************************************************************************/
35-
#define MAX_MENUBAR_BTN_COUNT 10
36-
#define MAX_MENUBAR_BTN_ID 256
37-
#define MIN_MENUBAR_BTN_ID (MAX_MENUBAR_BTN_ID - MAX_MENUBAR_BTN_COUNT)
38-
3935
/** texture layer ids */
4036
typedef enum {
4137
TEX_LAYER_BACKGROUND = 0,
@@ -50,8 +46,8 @@ typedef enum {
5046
/******************************************************************************/
5147
class GUIEngine;
5248
class MainMenuScripting;
49+
class Clouds;
5350
struct MainMenuData;
54-
struct SimpleSoundSpec;
5551

5652
/******************************************************************************/
5753
/* declarations */
@@ -66,6 +62,7 @@ class TextDestGuiEngine : public TextDest
6662
* @param engine the engine data is transmitted for further processing
6763
*/
6864
TextDestGuiEngine(GUIEngine* engine);
65+
6966
/**
7067
* receive fields transmitted by guiFormSpecMenu
7168
* @param fields map containing formspec field elements currently active
@@ -77,18 +74,58 @@ class TextDestGuiEngine : public TextDest
7774
* @param text textual representation of event
7875
*/
7976
void gotText(std::wstring text);
77+
8078
private:
8179
/** target to transmit data to */
8280
GUIEngine* m_engine;
8381
};
8482

83+
/** GUIEngine specific implementation of ISimpleTextureSource */
84+
class MenuTextureSource : public ISimpleTextureSource
85+
{
86+
public:
87+
/**
88+
* default constructor
89+
* @param driver the video driver to load textures from
90+
*/
91+
MenuTextureSource(video::IVideoDriver *driver);
92+
93+
/**
94+
* destructor, removes all loaded textures
95+
*/
96+
virtual ~MenuTextureSource();
97+
98+
/**
99+
* get a texture, loading it if required
100+
* @param name path to the texture
101+
* @param id receives the texture ID, always 0 in this implementation
102+
*/
103+
video::ITexture* getTexture(const std::string &name, u32 *id = NULL);
104+
105+
private:
106+
/** driver to get textures from */
107+
video::IVideoDriver *m_driver;
108+
/** set of texture names to delete */
109+
std::set<std::string> m_to_delete;
110+
};
111+
112+
/** GUIEngine specific implementation of OnDemandSoundFetcher */
85113
class MenuMusicFetcher: public OnDemandSoundFetcher
86114
{
87-
std::set<std::string> m_fetched;
88115
public:
116+
/**
117+
* get sound file paths according to sound name
118+
* @param name sound name
119+
* @param dst_paths receives possible paths to sound files
120+
* @param dst_datas receives binary sound data (not used here)
121+
*/
89122
void fetchSounds(const std::string &name,
90123
std::set<std::string> &dst_paths,
91124
std::set<std::string> &dst_datas);
125+
126+
private:
127+
/** set of fetched sound names */
128+
std::set<std::string> m_fetched;
92129
};
93130

94131
/** implementation of main menu based uppon formspecs */
@@ -150,6 +187,8 @@ class GUIEngine {
150187
scene::ISceneManager* m_smgr;
151188
/** pointer to data beeing transfered back to main game handling */
152189
MainMenuData* m_data;
190+
/** pointer to texture source */
191+
ISimpleTextureSource* m_texture_source;
153192
/** pointer to soundmanager*/
154193
ISoundManager* m_sound_manager;
155194

@@ -167,7 +206,7 @@ class GUIEngine {
167206
bool m_startgame;
168207

169208
/** scripting interface */
170-
MainMenuScripting* m_script;
209+
MainMenuScripting* m_script;
171210

172211
/** script basefolder */
173212
std::string m_scriptdir;

0 commit comments

Comments
 (0)
Please sign in to comment.