Modernize client code (#6250)
[oweals/minetest.git] / src / guiEngine.h
index 3987b52c73dc50df9e6446e86b6f54f3153ccdb6..9f59051e8bc4f1cbd700ea16d58c9c52653bc6b3 100644 (file)
@@ -25,17 +25,14 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 /******************************************************************************/
 #include "irrlichttypes.h"
 #include "modalMenu.h"
-#include "clouds.h"
 #include "guiFormSpecMenu.h"
 #include "sound.h"
+#include "client/tile.h"
+#include "util/enriched_string.h"
 
 /******************************************************************************/
 /* Typedefs and macros                                                        */
 /******************************************************************************/
-#define MAX_MENUBAR_BTN_COUNT  10
-#define MAX_MENUBAR_BTN_ID             256
-#define MIN_MENUBAR_BTN_ID             (MAX_MENUBAR_BTN_ID - MAX_MENUBAR_BTN_COUNT)
-
 /** texture layer ids */
 typedef enum {
        TEX_LAYER_BACKGROUND = 0,
@@ -45,13 +42,19 @@ typedef enum {
        TEX_LAYER_MAX
 } texture_layer;
 
+typedef struct {
+       video::ITexture *texture = nullptr;
+       bool             tile;
+       unsigned int     minsize;
+} image_definition;
+
 /******************************************************************************/
 /* forward declarations                                                       */
 /******************************************************************************/
 class GUIEngine;
 class MainMenuScripting;
+class Clouds;
 struct MainMenuData;
-struct SimpleSoundSpec;
 
 /******************************************************************************/
 /* declarations                                                               */
@@ -65,36 +68,78 @@ public:
         * default constructor
         * @param engine the engine data is transmitted for further processing
         */
-       TextDestGuiEngine(GUIEngine* engine);
+       TextDestGuiEngine(GUIEngine* engine) : m_engine(engine) {};
+
        /**
         * receive fields transmitted by guiFormSpecMenu
         * @param fields map containing formspec field elements currently active
         */
-       void gotText(std::map<std::string, std::string> fields);
+       void gotText(const StringMap &fields);
 
        /**
         * receive text/events transmitted by guiFormSpecMenu
         * @param text textual representation of event
         */
-       void gotText(std::wstring text);
+       void gotText(const std::wstring &text);
+
 private:
        /** target to transmit data to */
-       GUIEngine* m_engine;
+       GUIEngine *m_engine = nullptr;
+};
+
+/** GUIEngine specific implementation of ISimpleTextureSource */
+class MenuTextureSource : public ISimpleTextureSource
+{
+public:
+       /**
+        * default constructor
+        * @param driver the video driver to load textures from
+        */
+       MenuTextureSource(video::IVideoDriver *driver) : m_driver(driver) {};
+
+       /**
+        * destructor, removes all loaded textures
+        */
+       virtual ~MenuTextureSource();
+
+       /**
+        * get a texture, loading it if required
+        * @param name path to the texture
+        * @param id receives the texture ID, always 0 in this implementation
+        */
+       video::ITexture *getTexture(const std::string &name, u32 *id = NULL);
+
+private:
+       /** driver to get textures from */
+       video::IVideoDriver *m_driver = nullptr;
+       /** set of texture names to delete */
+       std::set<std::string> m_to_delete;
 };
 
+/** GUIEngine specific implementation of OnDemandSoundFetcher */
 class MenuMusicFetcher: public OnDemandSoundFetcher
 {
-       std::set<std::string> m_fetched;
 public:
+       /**
+        * get sound file paths according to sound name
+        * @param name sound name
+        * @param dst_paths receives possible paths to sound files
+        * @param dst_datas receives binary sound data (not used here)
+        */
        void fetchSounds(const std::string &name,
                        std::set<std::string> &dst_paths,
                        std::set<std::string> &dst_datas);
+
+private:
+       /** set of fetched sound names */
+       std::set<std::string> m_fetched;
 };
 
 /** implementation of main menu based uppon formspecs */
 class GUIEngine {
        /** grant ModApiMainMenu access to private members */
        friend class ModApiMainMenu;
+       friend class ModApiSound;
 
 public:
        /**
@@ -105,11 +150,11 @@ public:
         * @param smgr scene manager to add scene elements to
         * @param data struct to transfer data to main game handling
         */
-       GUIEngine(      irr::IrrlichtDevice* dev,
-                               gui::IGUIElement* parent,
-                               IMenuManager *menumgr,
-                               scene::ISceneManager* smgr,
-                               MainMenuData* data);
+       GUIEngine(JoystickController *joystick,
+                       gui::IGUIElement *parent,
+                       IMenuManager *menumgr,
+                       MainMenuData *data,
+                       bool &kill);
 
        /** default destructor */
        virtual ~GUIEngine();
@@ -117,17 +162,23 @@ public:
        /**
         * return MainMenuScripting interface
         */
-       MainMenuScripting* getScriptIface() {
+       MainMenuScripting *getScriptIface()
+       {
                return m_script;
        }
 
        /**
         * return dir of current menuscript
         */
-       std::string getScriptDir() {
+       std::string getScriptDir()
+       {
                return m_scriptdir;
        }
 
+       /** pass async callback to scriptengine **/
+       unsigned int queueAsync(const std::string &serialized_fct,
+                       const std::string &serialized_params);
+
 private:
 
        /** find and run the main menu script */
@@ -136,87 +187,90 @@ private:
        /** run main menu loop */
        void run();
 
-       /** handler to limit frame rate within main menu */
-       void limitFrameRate();
+       /** update size of topleftext element */
+       void updateTopLeftTextSize();
 
-       /** device to draw at */
-       irr::IrrlichtDevice*    m_device;
        /** parent gui element */
-       gui::IGUIElement*               m_parent;
+       gui::IGUIElement        *m_parent = nullptr;
        /** manager to add menus to */
-       IMenuManager*                   m_menumanager;
+       IMenuManager            *m_menumanager = nullptr;
        /** scene manager to add scene elements to */
-       scene::ISceneManager*   m_smgr;
+       scene::ISceneManager    *m_smgr = nullptr;
        /** pointer to data beeing transfered back to main game handling */
-       MainMenuData*                   m_data;
+       MainMenuData            *m_data = nullptr;
+       /** pointer to texture source */
+       ISimpleTextureSource    *m_texture_source = nullptr;
        /** pointer to soundmanager*/
-       ISoundManager*                  m_sound_manager;
+       ISoundManager           *m_sound_manager = nullptr;
 
        /** representation of form source to be used in mainmenu formspec */
-       FormspecFormSource*             m_formspecgui;
+       FormspecFormSource      *m_formspecgui = nullptr;
        /** formspec input receiver */
-       TextDestGuiEngine*              m_buttonhandler;
+       TextDestGuiEngine       *m_buttonhandler = nullptr;
        /** the formspec menu */
-       GUIFormSpecMenu*                m_menu;
+       GUIFormSpecMenu         *m_menu = nullptr;
+
+       /** reference to kill variable managed by SIGINT handler */
+       bool                    &m_kill;
 
        /** variable used to abort menu and return back to main game handling */
-       bool                                    m_startgame;
+       bool                     m_startgame = false;
 
        /** scripting interface */
-       MainMenuScripting*                      m_script;
+       MainMenuScripting       *m_script = nullptr;
 
        /** script basefolder */
-       std::string                             m_scriptdir;
+       std::string              m_scriptdir = "";
 
        /**
         * draw background layer
         * @param driver to use for drawing
         */
-       void drawBackground(video::IVideoDriverdriver);
+       void drawBackground(video::IVideoDriver *driver);
        /**
         * draw overlay layer
         * @param driver to use for drawing
         */
-       void drawOverlay(video::IVideoDriverdriver);
+       void drawOverlay(video::IVideoDriver *driver);
        /**
         * draw header layer
         * @param driver to use for drawing
         */
-       void drawHeader(video::IVideoDriverdriver);
+       void drawHeader(video::IVideoDriver *driver);
        /**
         * draw footer layer
         * @param driver to use for drawing
         */
-       void drawFooter(video::IVideoDriverdriver);
+       void drawFooter(video::IVideoDriver *driver);
 
        /**
         * load a texture for a specified layer
         * @param layer draw layer to specify texture
         * @param texturepath full path of texture to load
         */
-       bool setTexture(texture_layer layer,std::string texturepath);
+       bool setTexture(texture_layer layer, std::string texturepath,
+                       bool tile_image, unsigned int minsize);
 
        /**
         * download a file using curl
         * @param url url to download
         * @param target file to store to
         */
-       bool downloadFile(std::string url,std::string target);
+       static bool downloadFile(const std::string &url, const std::string &target);
 
        /** array containing pointers to current specified texture layers */
-       video::ITexture*                m_textures[TEX_LAYER_MAX];
-
-       /** draw version string in topleft corner */
-       void drawVersion();
+       image_definition m_textures[TEX_LAYER_MAX];
 
        /**
-        * specify text to be appended to version string
+        * specify text to appear as top left string
         * @param text to set
         */
-       void setTopleftText(std::string append);
+       void setTopleftText(const std::string &text);
 
        /** pointer to gui element shown at topleft corner */
-       irr::gui::IGUIStaticText*       m_irr_toplefttext;
+       irr::gui::IGUIStaticText *m_irr_toplefttext = nullptr;
+       /** and text that is in it */
+       EnrichedString m_toplefttext;
 
        /** initialize cloud subsystem */
        void cloudInit();
@@ -228,19 +282,19 @@ private:
        /** internam data required for drawing clouds */
        struct clouddata {
                /** delta time since last cloud processing */
-               f32             dtime;
+               f32     dtime;
                /** absolute time of last cloud processing */
-               u32             lasttime;
+               u32     lasttime;
                /** pointer to cloud class */
-               Clouds* clouds;
+               Clouds *clouds = nullptr;
                /** camera required for drawing clouds */
-               scene::ICameraSceneNode* camera;
+               scene::ICameraSceneNode *camera = nullptr;
        };
 
        /** is drawing of clouds enabled atm */
-       bool                                    m_clouds_enabled;
+       bool        m_clouds_enabled = true;
        /** data used to draw clouds */
-       clouddata                               m_cloud;
+       clouddata   m_cloud;
 
        /** start playing a sound and return handle */
        s32 playSound(SimpleSoundSpec spec, bool looped);
@@ -250,6 +304,4 @@ private:
 
 };
 
-
-
 #endif /* GUI_ENGINE_H_ */