/*
 *  The Mana World
 *  Copyright (C) 2004  The Mana World Development Team
 *
 *  This file is part of The Mana World.
 *
 *  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, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

#ifndef SERVERDIALOG_H
#define SERVERDIALOG_H

#include "gui/widgets/window.h"

#include "guichanfwd.h"

#include "net/serverinfo.h"

#include <guichan/actionlistener.hpp>
#include <guichan/listmodel.hpp>
#include <guichan/selectionlistener.hpp>

#include <string>
#include <vector>

class ListBox;

/**
 * Server and Port List Model
 */
class ServersListModel : public gcn::ListModel
{
    public:
        /**
         * Used to get number of line in the list
         */
        int getNumberOfElements();

        /**
         * Used to get an element from the list
         */
        std::string getElementAt(int elementIndex);

        /**
         * Used to get the corresponding Server struct
         */
        ServerInfo getServer(int elementIndex) const
        { return servers[elementIndex]; }

        /**
         * Add an Element at the end of the server list
         */
        void addElement(ServerInfo server);

        /**
         * Add an Element at the end of the server list if it
         * doesn't exist yet. Otherwise overwrite its properties
         * in the list.
         *
         * @param server ServerInfo to merge into the list.
         */
        void mergeElement(ServerInfo server);

        /**
         * Add an Element at the beginning of the server list
         */
        void addFirstElement(ServerInfo server);

        /**
         * Returns wheter the given server is already in the list.
         * @param server Server to search in the list.
         * @return True, if the server is in the list, false otherwise.
         */
        bool contains(ServerInfo server);

    private:
        std::vector<ServerInfo> servers;
};

/**
 * The server choice dialog.
 *
 * \ingroup Interface
 */
class ServerDialog : public Window,
                     public gcn::ActionListener,
                     public gcn::SelectionListener
{
    public:
        /**
         * Constructor
         *
         * @see Window::Window
         */
        ServerDialog(ServerInfo *serverInfo);

        /**
         * Destructor
         */
        ~ServerDialog();

        /**
         * Called when receiving actions from the widgets.
         */
        void action(const gcn::ActionEvent &event);

        /**
         * Called when the selected value changed in the servers list box.
         */
        void valueChanged(const gcn::SelectionEvent &event);

    private:
        /**
         * Called to load a list of available server from an online xml file.
         */
        void loadServerlist();

        gcn::TextField *mServerNameField;
        gcn::TextField *mPortField;
        gcn::Label  *mServerDescription;
        gcn::Button *mQuitButton;
        gcn::Button *mConnectButton;

        ListBox *mMostUsedServersList;
        ServersListModel *mMostUsedServersListModel;

        ServerInfo *mServerInfo;
};

#endif