move exguichan files into gui/base/

1 files changed, 571 insertions, 0 deletions

diff --git a/src/gui/base/focushandler.cpp b/src/gui/base/focushandler.cpp
new file mode 100644
index 000000000..6984d1fcd
--- /dev/null
+++ b/src/gui/base/focushandler.cpp
@@ -0,0 +1,571 @@
+/*
+ *  The ManaPlus Client
+ *  Copyright (C) 2011-2014  The ManaPlus Developers
+ *
+ *  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.
+ */
+
+/*
+ * For comments regarding functions please see the header file.
+ */
+
+#include "gui/base/focushandler.hpp"
+
+#include "gui/base/focuslistener.hpp"
+#include "gui/base/exception.hpp"
+#include "gui/base/widget.hpp"
+
+#include "debug.h"
+
+namespace gcn
+{
+    FocusHandler::FocusHandler() :
+        mWidgets(),
+        mFocusedWidget(nullptr),
+        mModalFocusedWidget(nullptr),
+        mModalMouseInputFocusedWidget(nullptr),
+        mDraggedWidget(nullptr),
+        mLastWidgetWithMouse(nullptr),
+        mLastWidgetWithModalFocus(nullptr),
+        mLastWidgetWithModalMouseInputFocus(nullptr),
+        mLastWidgetPressed(nullptr)
+    {
+    }
+
+    void FocusHandler::requestFocus(Widget* widget)
+    {
+        if (!widget || widget == mFocusedWidget)
+            return;
+
+        int toBeFocusedIndex = -1;
+        for (unsigned int i = 0, sz = static_cast<unsigned int>(
+             mWidgets.size()); i < sz; ++i)
+        {
+            if (mWidgets[i] == widget)
+            {
+                toBeFocusedIndex = i;
+                break;
+            }
+        }
+
+        if (toBeFocusedIndex < 0)
+            throw GCN_EXCEPTION("Trying to focus a none existing widget.");
+
+        Widget *const oldFocused = mFocusedWidget;
+
+        if (oldFocused != widget)
+        {
+            mFocusedWidget = mWidgets.at(toBeFocusedIndex);
+
+            if (oldFocused)
+            {
+                Event focusEvent(oldFocused);
+                distributeFocusLostEvent(focusEvent);
+            }
+
+            Event focusEvent(mWidgets.at(toBeFocusedIndex));
+            distributeFocusGainedEvent(focusEvent);
+        }
+    }
+
+    void FocusHandler::requestModalFocus(Widget* widget)
+    {
+        if (mModalFocusedWidget && mModalFocusedWidget != widget)
+            throw GCN_EXCEPTION("Another widget already has modal focus.");
+
+        mModalFocusedWidget = widget;
+
+        if (mFocusedWidget && !mFocusedWidget->isModalFocused())
+            focusNone();
+    }
+
+    void FocusHandler::requestModalMouseInputFocus(Widget* widget)
+    {
+        if (mModalMouseInputFocusedWidget
+            && mModalMouseInputFocusedWidget != widget)
+        {
+            throw GCN_EXCEPTION("Another widget already has "
+                "modal input focus.");
+        }
+
+        mModalMouseInputFocusedWidget = widget;
+    }
+
+    void FocusHandler::releaseModalFocus(Widget* widget)
+    {
+        if (mModalFocusedWidget == widget)
+            mModalFocusedWidget = nullptr;
+    }
+
+    void FocusHandler::releaseModalMouseInputFocus(Widget* widget)
+    {
+        if (mModalMouseInputFocusedWidget == widget)
+            mModalMouseInputFocusedWidget = nullptr;
+    }
+
+    Widget* FocusHandler::getFocused() const
+    {
+        return mFocusedWidget;
+    }
+
+    Widget* FocusHandler::getModalFocused() const
+    {
+        return mModalFocusedWidget;
+    }
+
+    Widget* FocusHandler::getModalMouseInputFocused() const
+    {
+        return mModalMouseInputFocusedWidget;
+    }
+
+    void FocusHandler::focusNext()
+    {
+        int i;
+        int focusedWidget = -1;
+        const int sz = static_cast<int>(mWidgets.size());
+        for (i = 0; i < sz; ++i)
+        {
+            if (mWidgets[i] == mFocusedWidget)
+                focusedWidget = i;
+        }
+        const int focused = focusedWidget;
+
+        // i is a counter that ensures that the following loop
+        // won't get stuck in an infinite loop
+        i = sz;
+        do
+        {
+            ++ focusedWidget;
+
+            if (i == 0)
+            {
+                focusedWidget = -1;
+                break;
+            }
+
+            -- i;
+
+            if (focusedWidget >= sz)
+                focusedWidget = 0;
+
+            if (focusedWidget == focused)
+                return;
+        }
+        while (!mWidgets.at(focusedWidget)->isFocusable());
+
+        if (focusedWidget >= 0)
+        {
+            mFocusedWidget = mWidgets.at(focusedWidget);
+
+            Event focusEvent(mFocusedWidget);
+            distributeFocusGainedEvent(focusEvent);
+        }
+
+        if (focused >= 0)
+        {
+            Event focusEvent(mWidgets.at(focused));
+            distributeFocusLostEvent(focusEvent);
+        }
+    }
+
+    void FocusHandler::focusPrevious()
+    {
+        if (mWidgets.empty())
+        {
+            mFocusedWidget = nullptr;
+            return;
+        }
+
+        int i;
+        int focusedWidget = -1;
+        const int sz = static_cast<int>(mWidgets.size());
+        for (i = 0; i < sz; ++ i)
+        {
+            if (mWidgets[i] == mFocusedWidget)
+                focusedWidget = i;
+        }
+        const int focused = focusedWidget;
+
+        // i is a counter that ensures that the following loop
+        // won't get stuck in an infinite loop
+        i = sz;
+        do
+        {
+            -- focusedWidget;
+
+            if (i == 0)
+            {
+                focusedWidget = -1;
+                break;
+            }
+
+            -- i;
+
+            if (focusedWidget <= 0)
+                focusedWidget = sz - 1;
+
+            if (focusedWidget == focused)
+                return;
+        }
+        while (!mWidgets.at(focusedWidget)->isFocusable());
+
+        if (focusedWidget >= 0)
+        {
+            mFocusedWidget = mWidgets.at(focusedWidget);
+            Event focusEvent(mFocusedWidget);
+            distributeFocusGainedEvent(focusEvent);
+        }
+
+        if (focused >= 0)
+        {
+            Event focusEvent(mWidgets.at(focused));
+            distributeFocusLostEvent(focusEvent);
+        }
+    }
+
+    bool FocusHandler::isFocused(const Widget* widget) const
+    {
+        return mFocusedWidget == widget;
+    }
+
+    void FocusHandler::add(Widget* widget)
+    {
+        mWidgets.push_back(widget);
+    }
+
+    void FocusHandler::remove(Widget* widget)
+    {
+        if (isFocused(widget))
+            mFocusedWidget = nullptr;
+
+        for (WidgetIterator iter = mWidgets.begin();
+             iter != mWidgets.end(); ++iter)
+        {
+            if ((*iter) == widget)
+            {
+                mWidgets.erase(iter);
+                break;
+            }
+        }
+
+        if (mDraggedWidget == widget)
+        {
+            mDraggedWidget = nullptr;
+            return;
+        }
+
+        if (mLastWidgetWithMouse == widget)
+        {
+            mLastWidgetWithMouse = nullptr;
+            return;
+        }
+
+        if (mLastWidgetWithModalFocus == widget)
+        {
+            mLastWidgetWithModalFocus = nullptr;
+            return;
+        }
+
+        if (mLastWidgetWithModalMouseInputFocus == widget)
+        {
+            mLastWidgetWithModalMouseInputFocus = nullptr;
+            return;
+        }
+
+        if (mLastWidgetPressed == widget)
+        {
+            mLastWidgetPressed = nullptr;
+            return;
+        }
+    }
+
+    void FocusHandler::focusNone()
+    {
+        if (mFocusedWidget)
+        {
+            Widget *const focused = mFocusedWidget;
+            mFocusedWidget = nullptr;
+
+            Event focusEvent(focused);
+            distributeFocusLostEvent(focusEvent);
+        }
+    }
+
+    void FocusHandler::tabNext()
+    {
+        if (mFocusedWidget)
+        {
+            if (!mFocusedWidget->isTabOutEnabled())
+                return;
+        }
+
+        if (mWidgets.empty())
+        {
+            mFocusedWidget = nullptr;
+            return;
+        }
+
+        int i;
+        int focusedWidget = -1;
+        const int sz = static_cast<int>(mWidgets.size());
+        for (i = 0; i < sz; ++ i)
+        {
+            if (mWidgets[i] == mFocusedWidget)
+                focusedWidget = i;
+        }
+        const int focused = focusedWidget;
+        bool done = false;
+
+        // i is a counter that ensures that the following loop
+        // won't get stuck in an infinite loop
+        i = sz;
+        do
+        {
+            ++ focusedWidget;
+
+            if (i == 0)
+            {
+                focusedWidget = -1;
+                break;
+            }
+
+            -- i;
+
+            if (focusedWidget >= sz)
+                focusedWidget = 0;
+
+            if (focusedWidget == focused)
+                return;
+
+            const Widget *const widget = mWidgets.at(focusedWidget);
+            if (widget->isFocusable() && widget->isTabInEnabled() &&
+                (!mModalFocusedWidget || widget->isModalFocused()))
+            {
+                done = true;
+            }
+        }
+        while (!done);
+
+        if (focusedWidget >= 0)
+        {
+            mFocusedWidget = mWidgets.at(focusedWidget);
+            Event focusEvent(mFocusedWidget);
+            distributeFocusGainedEvent(focusEvent);
+        }
+
+        if (focused >= 0)
+        {
+            Event focusEvent(mWidgets.at(focused));
+            distributeFocusLostEvent(focusEvent);
+        }
+    }
+
+    void FocusHandler::tabPrevious()
+    {
+        if (mFocusedWidget)
+        {
+            if (!mFocusedWidget->isTabOutEnabled())
+                return;
+        }
+
+        if (mWidgets.empty())
+        {
+            mFocusedWidget = nullptr;
+            return;
+        }
+
+        int i;
+        int focusedWidget = -1;
+        const int sz = static_cast<int>(mWidgets.size());
+        for (i = 0; i < sz; ++ i)
+        {
+            if (mWidgets[i] == mFocusedWidget)
+                focusedWidget = i;
+        }
+        const int focused = focusedWidget;
+        bool done = false;
+
+        // i is a counter that ensures that the following loop
+        // won't get stuck in an infinite loop
+        i = sz;
+        do
+        {
+            -- focusedWidget;
+
+            if (i == 0)
+            {
+                focusedWidget = -1;
+                break;
+            }
+
+            -- i;
+
+            if (focusedWidget <= 0)
+                focusedWidget = sz - 1;
+
+            if (focusedWidget == focused)
+                return;
+
+            const Widget *const widget = mWidgets.at(focusedWidget);
+            if (widget->isFocusable() && widget->isTabInEnabled() &&
+                (!mModalFocusedWidget || widget->isModalFocused()))
+            {
+                done = true;
+            }
+        }
+        while (!done);
+
+        if (focusedWidget >= 0)
+        {
+            mFocusedWidget = mWidgets.at(focusedWidget);
+            Event focusEvent(mFocusedWidget);
+            distributeFocusGainedEvent(focusEvent);
+        }
+
+        if (focused >= 0)
+        {
+            Event focusEvent(mWidgets.at(focused));
+            distributeFocusLostEvent(focusEvent);
+        }
+    }
+
+    void FocusHandler::distributeFocusLostEvent(const Event& focusEvent)
+    {
+        Widget *const sourceWidget = focusEvent.getSource();
+
+        std::list<FocusListener*> focusListeners
+            = sourceWidget->_getFocusListeners();
+
+        // Send the event to all focus listeners of the widget.
+        for (std::list<FocusListener*>::const_iterator
+             it = focusListeners.begin();
+             it != focusListeners.end();
+             ++ it)
+        {
+            (*it)->focusLost(focusEvent);
+        }
+    }
+
+    void FocusHandler::distributeFocusGainedEvent(const Event& focusEvent)
+    {
+        Widget *const sourceWidget = focusEvent.getSource();
+
+        std::list<FocusListener*> focusListeners
+            = sourceWidget->_getFocusListeners();
+
+        // Send the event to all focus listeners of the widget.
+        for (std::list<FocusListener*>::const_iterator
+             it = focusListeners.begin();
+             it != focusListeners.end();
+             ++ it)
+        {
+            (*it)->focusGained(focusEvent);
+        }
+    }
+
+    Widget* FocusHandler::getDraggedWidget()
+    {
+        return mDraggedWidget;
+    }
+
+    void FocusHandler::setDraggedWidget(Widget* draggedWidget)
+    {
+        mDraggedWidget = draggedWidget;
+    }
+
+    Widget* FocusHandler::getLastWidgetWithMouse()
+    {
+        return mLastWidgetWithMouse;
+    }
+
+    void FocusHandler::setLastWidgetWithMouse(Widget* lastWidgetWithMouse)
+    {
+        mLastWidgetWithMouse = lastWidgetWithMouse;
+    }
+
+    Widget* FocusHandler::getLastWidgetWithModalFocus()
+    {
+        return mLastWidgetWithModalFocus;
+    }
+
+    void FocusHandler::setLastWidgetWithModalFocus(Widget* widget)
+    {
+        mLastWidgetWithModalFocus = widget;
+    }
+
+    Widget* FocusHandler::getLastWidgetWithModalMouseInputFocus()
+    {
+        return mLastWidgetWithModalMouseInputFocus;
+    }
+
+    void FocusHandler::setLastWidgetWithModalMouseInputFocus(Widget* widget)
+    {
+        mLastWidgetWithModalMouseInputFocus = widget;
+    }
+
+    Widget* FocusHandler::getLastWidgetPressed()
+    {
+        return mLastWidgetPressed;
+    }
+
+    void FocusHandler::setLastWidgetPressed(Widget* lastWidgetPressed)
+    {
+        mLastWidgetPressed = lastWidgetPressed;
+    }
+}  // namespace gcn