gui.h

Go to the documentation of this file.

/*
 *  The ManaPlus Client
 *  Copyright (C) 2004-2009  The Mana World Development Team
 *  Copyright (C) 2009-2010  The Mana Developers
 *  Copyright (C) 2011-2019  The ManaPlus Developers
 *  Copyright (C) 2019-2021  Andrei Karas
 *
 *  This file is part of The ManaPlus Client.
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  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 General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
/*      _______   __   __   __   ______   __   __   _______   __   __
 *     / _____/\ / /\ / /\ / /\ / ____/\ / /\ / /\ / ___  /\ /  |\/ /\
 *    / /\____\// / // / // / // /\___\// /_// / // /\_/ / // , |/ / /
 *   / / /__   / / // / // / // / /    / ___  / // ___  / // /| ' / /
 *  / /_// /\ / /_// / // / // /_/_   / / // / // /\_/ / // / |  / /
 * /______/ //______/ //_/ //_____/\ /_/ //_/ //_/ //_/ //_/ /|_/ /
 * \______\/ \______\/ \_\/ \_____\/ \_\/ \_\/ \_\/ \_\/ \_\/ \_\/
 *
 * Copyright (c) 2004 - 2008 Olof Naessén and Per Larsson
 *
 *
 * Per Larsson a.k.a finalman
 * Olof Naessén a.k.a jansem/yakslem
 *
 * Visit: http://guichan.sourceforge.net
 *
 * License: (BSD)
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 * 3. Neither the name of Guichan nor the names of its contributors may
 *    be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
 * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
#ifndef GUI_GUI_H
#define GUI_GUI_H
 
#include "gui/color.h"
 
#include "enums/events/mousebutton.h"
#include "enums/events/mouseeventtype.h"
 
#include "enums/resources/cursor.h"
 
#include <deque>
#include <list>
 
#include "localconsts.h"
 
class Event;
class FocusHandler;
class FocusListener;
class Graphics;
class GuiConfigListener;
class ImageSet;
class KeyEvent;
class KeyListener;
class MouseEvent;
class MouseInput;
class Font;
class SDLInput;
class Widget;
class Window;
 
#ifdef USE_SDL2
#define MouseStateType uint32_t
#else  // USE_SDL2
#define MouseStateType uint8_t
#endif  // USE_SDL2
 
class Gui final
{
    public:
        Gui();
 
        A_DELETE_COPY(Gui)
 
        
        ~Gui();
 
        void postInit(Graphics *const graphics) A_NONNULL(2);
 
        void logic();
 
        void slowLogic();
 
        void clearFonts();
 
        void draw();
 
        void videoResized() const;
 
        FocusHandler *getFocusHandler() const noexcept2 A_WARN_UNUSED
        { return mFocusHandler; }
 
        Font *getFont() const RETURNS_NONNULL A_WARN_UNUSED
        { return mGuiFont; }
 
        Font *getHelpFont() const RETURNS_NONNULL A_WARN_UNUSED
        { return mHelpFont; }
 
        Font *getSecureFont() const RETURNS_NONNULL A_WARN_UNUSED
        { return mSecureFont; }
 
        Font *getNpcFont() const RETURNS_NONNULL A_WARN_UNUSED
        { return mNpcFont; }
 
        Font *getInfoParticleFont() const RETURNS_NONNULL A_WARN_UNUSED
        { return mInfoParticleFont; }
 
        void setUseCustomCursor(const bool customCursor);
 
        void setCursorType(const CursorT index)
        { mCursorType = index; }
 
        void setDoubleClick(const bool b)
        { mDoubleClick = b; }
 
        void updateFonts();
 
        bool handleInput();
 
        bool handleKeyInput();
 
        void resetClickCount();
 
        MouseEvent *createMouseEvent(Window *const widget) A_WARN_UNUSED;
 
        static void getAbsolutePosition(Widget *restrict widget,
                                        int &restrict x,
                                        int &restrict y);
 
        void addGlobalFocusListener(FocusListener* focusListener);
 
        void removeGlobalFocusListener(FocusListener* focusListener);
 
        void distributeGlobalFocusGainedEvent(const Event &focusEvent);
 
        void removeDragged(const Widget *const widget);
 
        int getLastMouseX() const
        { return mLastMouseX; }
 
        int getLastMouseY() const
        { return mLastMouseY; }
 
        static MouseStateType getMouseState(int &x, int &y);
 
        void setTop(Widget *const top);
 
        Widget* getTop() const noexcept2 A_WARN_UNUSED
        { return mTop; }
 
        void setGraphics(Graphics *const graphics) A_NONNULL(2);
 
        Graphics* getGraphics() const RETURNS_NONNULL A_WARN_UNUSED;
 
        void setInput(SDLInput *const input) A_NONNULL(2);
 
        SDLInput* getInput() const A_WARN_UNUSED;
 
        void addGlobalKeyListener(KeyListener *const keyListener);
 
        void removeGlobalKeyListener(KeyListener *const keyListener);
 
        bool isLongPress() const
        { return getMousePressLength() > 250; }
 
        int getMousePressLength() const;
 
    protected:
        void handleMouseMoved(const MouseInput &mouseInput);
 
        void handleMouseReleased(const MouseInput &mouseInput);
 
        void handleMousePressed(const MouseInput &mouseInput);
 
        void handleMouseInput();
 
        void distributeMouseEvent(Widget *const source,
                                  const MouseEventTypeT type,
                                  const MouseButtonT button,
                                  const int x, const int y,
                                  const bool force,
                                  const bool toSourceOnly);
 
        void handleMouseWheelMovedDown(const MouseInput& mouseInput);
 
        void handleMouseWheelMovedUp(const MouseInput& mouseInput);
 
        Widget* getWidgetAt(const int x, const int y) const A_WARN_UNUSED;
 
        Widget* getMouseEventSource(const int x,
                                    const int y) const A_WARN_UNUSED;
 
        Widget* getKeyEventSource() const A_WARN_UNUSED;
 
        void distributeKeyEvent(KeyEvent &event) const;
 
        void distributeKeyEventToGlobalKeyListeners(KeyEvent& event);
 
        void handleModalMouseInputFocus();
 
        void handleModalFocus();
 
        void handleModalFocusGained();
 
        void handleModalFocusReleased();
 
    private:
        Widget* mTop;
 
        Graphics* mGraphics A_NONNULLPOINTER;
 
        SDLInput* mInput A_NONNULLPOINTER;
 
        FocusHandler* mFocusHandler A_NONNULLPOINTER;
 
        typedef std::list<KeyListener*> KeyListenerList;
 
        typedef KeyListenerList::iterator KeyListenerListIterator;
 
        KeyListenerList mKeyListeners;
 
        MouseButtonT mLastMousePressButton;
 
        unsigned int mLastMousePressTimeStamp;
 
        int mLastMouseX;
 
        int mLastMouseY;
 
        int mClickCount;
 
        MouseButtonT mLastMouseDragButton;
 
        std::deque<Widget*> mWidgetWithMouseQueue;
 
        GuiConfigListener *mConfigListener;
        Font *mGuiFont A_NONNULLPOINTER;
        Font *mInfoParticleFont A_NONNULLPOINTER;
        Font *mHelpFont A_NONNULLPOINTER;
        Font *mSecureFont A_NONNULLPOINTER;
        Font *mNpcFont A_NONNULLPOINTER;
        ImageSet *mMouseCursors;
        float mMouseCursorAlpha;
        int mMouseInactivityTimer;
        CursorT mCursorType;
#ifdef ANDROID
        uint16_t mLastMouseRealX;
        uint16_t mLastMouseRealY;
#endif  // ANDROID
 
        typedef std::list<FocusListener*> FocusListenerList;
        typedef FocusListenerList::iterator FocusListenerIterator;
        FocusListenerList mFocusListeners;
        Color mForegroundColor;
        Color mForegroundColor2;
        time_t mTime;
        time_t mTime10;
        bool mCustomCursor;                 
        bool mDoubleClick;
};
 
extern Gui *gui;                            
extern Font *boldFont A_NONNULLPOINTER;
 
#endif  // GUI_GUI_H