eventbase.h

// © Copyright 2010 - 2016 BlackTopp Studios Inc.
/* This file is part of The Mezzanine Engine.

    The Mezzanine Engine 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 3 of the License, or
    (at your option) any later version.

    The Mezzanine Engine 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 The Mezzanine Engine.  If not, see <http://www.gnu.org/licenses/>.
*/
/* The original authors have included a copy of the license specified above in the
   'Docs' folder. See 'gpl.txt'
*/
/* We welcome the use of the Mezzanine engine to anyone, including companies who wish to
   Build professional software and charge for their product.

   However there are some practical restrictions, so if your project involves
   any of the following you should contact us and we will try to work something
   out:
    - DRM or Copy Protection of any kind(except Copyrights)
    - Software Patents You Do Not Wish to Freely License
    - Any Kind of Linking to Non-GPL licensed Works
    - Are Currently In Violation of Another Copyright Holder's GPL License
    - If You want to change our code and not add a few hundred MB of stuff to
        your distribution

   These and other limitations could cause serious legal problems if you ignore
   them, so it is best to simply contact us or the Free Software Foundation, if
   you have any questions.

   Joseph Toppi - toppij@gmail.com
   John Blackwood - makoenergy02@gmail.com
*/
#ifndef EVENTBASE_H
#define EVENTBASE_H

#include "datatypes.h"

///////////////////////////////////////////////////////////////////////////////
// This is a parent class that all events must derive from. This exists solely
//to normalize the output of the event manager class.
///////////////////////////////////////

namespace Mezzanine
{

    ///////////////////////////////////////////////////////////////////////////////
    /// @class EventBase
    /// @headerfile eventbase.h
    /// @brief The base class for all events.
    /// @details All Events used in the Event Manager, will inherit from this. While
    /// not absolutely required by the game programmer to write their own events, it
    /// it could be useful. Instances of this class cannot be made, and all classes
    /// that inherit from this are expected to implement getEventType().
    class MEZZ_LIB EventBase
    {
        public:
            /// @brief A listing of values that can be used to identify Events.
            /// @details A listing of values that can be used to identify Events.
            enum EventType
            {
                GameWindow,     /**< Indicates the Event is a Game Window Management Event. */
                QuitMessage,    /**< Indicates the Event is a Mezzanine::EventQuit. */
                UserInput,      /**< Indicates the Event is a EventUserInput. */
                //SystemMessage,  /**< Indicates the Event has not been coded yet */
                Other
            };
            // If you add an eventtype do not forget to add the appropriate functions tot he event manager and update these functions
            //void operator >> (const Mezzanine::XML::Node& OneNode, Mezzanine::EventManager& Mgr);
            //std::ostream& MEZZ_LIB operator << (std::ostream& stream, const Mezzanine::EventBase& Ev);




            /// @brief This will aid in identifying all classes that inherit from this class.
            /// @details All Classes derived form this calls will return an Event::EventType that correspond the
            /// the data/class type they actually are.
            /// @return This returns an eventype that will correspend with the actual event type. This can be used on all
            /// Mezzanine provided class to safely cast a pointer to the correct event type.
            virtual EventBase::EventType GetType() const = 0;

            /// @brief Virtual Deconstructor
            virtual ~EventBase()
                {}

    };
}

#if !(defined(SWIG) && defined(MEZZLUA51)) // Stop Swig from making lua bindings but allow other languages
    /// @brief Serializes the passed Mezzanine::Event to XML
    /// @param stream The ostream to send the xml to.
    /// @param Ev the Mezzanine::Event to be serialized
    /// @return this returns the ostream, now with the serialized data
    std::ostream& MEZZ_LIB operator << (std::ostream& stream, const Mezzanine::EventBase& Ev);
#endif // \!SWIG && LUA


#endif