application.h

Go to the documentation of this file.

/*
 * application.h
 *
 * Copyright (C) 2008,2009  Thomas A. Vaughan
 * All rights reserved.
 *
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * 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.
 *     * Neither the name of the <organization> 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 THOMAS A. VAUGHAN ''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 THOMAS A. VAUGHAN 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 AESOP_APPLICATION_H__
#define AESOP_APPLICATION_H__

// includes --------------------------------------------------------------------
#include "client-game-logic.h"

#include "aesop-clib/aesop-client.h"
#include "gamepad/gamepad.h"
#include "glut/glut.h"
#include "story/story.h"


// forward declarations
class Datahash;


namespace aesop {

/// \ingroup aesop_client_lib
/// \defgroup glut_app AESOP Glut Application
///
/// \n
/// This is a reference application, using glut for rendering.
/*@{*/


/// handy for constructing player dialogs
struct player_stats_t {
        // constructor, manipulators
        player_stats_t(void) throw() { this->clear(); }
        void clear(void) throw() {
                        haveKeyboard = false;
                        clientState = eClientState_Invalid;
                        gamepad = NULL;
                        server = serverInfo = "";
                }

        // data fields
        bool            haveKeyboard;   // does player own keyboard?
        eClientState    clientState;
        smart_ptr<gamepad::Gamepad> gamepad;
        std::string     server;         // raw server data
        std::string     serverInfo;     // server info
};



/// The Application object manages all local terminals (user input/output
/// sessions) as well as communications with the server, and state management
/// for the local host and users.
class Application : public glut::Host {
public:
        // virtual destructor --------------------------------------------------
        virtual ~Application(void) throw();

        // aesop::Application class interface methods -------------------------
        virtual story::Story * getStory(void) = 0;
        virtual bool getPlayerStats(IN int playerId,
                                OUT player_stats_t& stats) = 0;
        virtual void takeKeyboard(IN int playerId) = 0;
        virtual void newGame(IN int playerId) = 0;
        virtual void addPlayer(void) = 0;
        virtual bool dropPlayer(IN int playerId) = 0;
        virtual void configureControls(IN int playerId) = 0;
        virtual const server_map_t& getServers(void) = 0;
        virtual bool requestConnect(IN const char * serverKey) = 0;

        // static factory methods ----------------------------------------------
        static smart_ptr<Application> create(IN const char * config_dir,
                                IN smart_ptr<Datahash>& params,
                                IN smart_ptr<ClientGameLogic>& gameLogic,
                                IN smart_ptr<story::Story>& story);
};


};

#endif  // AESOP_APPLICATION_H__