ceInputCore.h

Go to the documentation of this file.

/* --- Source License
 * Author  : FX Programmer.
 * Contact : CorEngine@gmail.com
 *
 * Copyright (c) 2010 by FX Programmer.
 *
 * This source code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
 * (at your option) any later version.
 *
 * This source code 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 Lesser General Public
 * License for more details.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *    1. The origin of this software must not be misrepresented; you must not
 *       claim that you wrote the original software. If you use this software
 *       in a product, an acknowledgement in the product documentation would be
 *       appreciated but is not required.
 *    2. Altered source versions must be clearly marked as such, and must not
 *       be misrepresented as being the original software.
 *    3. Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this source code; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301, USA.
 */

 #ifndef _CE_INPUTCORE_H_
 #define _CE_INPUTCORE_H_ 0x1 
 #ifndef __cplusplus
 #error ceInputCore.h requires C++ compilation (use a .cpp suffix)
 #endif

 #if __GNUC__ >= 0x3
 #pragma GCC system_header
 #endif

 #if _MSC_VER > 1000
 #pragma once
 #pragma warning(disable: 4100)
 #endif

 #include "ceKeyboard.h"
 #include "ceMouse.h"
 #include "ceJoystick.h"

 #include "begin_code.h"

// ---                                                          Version --- */

 #define CE_INPUT_VERSION_MAJOR 0x0 //!< \brief Major version.
 #define CE_INPUT_VERSION_MINOR 0x0 //!< \brief Minor version.
 #define CE_INPUT_VERSION_PATCH 0x0 //!< \brief Patch number.
 #define CE_INPUT_VERSION_STRING "pre-alpha" //!< \brief Version in string.

 #define CE_INPUT_VERSION ((CE_INPUT_VERSION_MAJOR << 16)  | \
                           (CE_INPUT_VERSION_MINOR << 0x8) | \
                            CE_INPUT_VERSION_PATCH)

// ---                                                                  --- */

 namespace ce {

// ---                                              class IInputManager --- */

 // #define CE_WITHOUT_KEYBOARD 0x1
 // #define CE_WITHOUT_MOUSE    0x1
 // #define CE_WITHOUT_JOYSTICK 0x1

 class DECLSPEC IInputManager
 {
  public:

    #ifndef DOXYGEN_SHOULD_SKIP_THIS
    virtual ~IInputManager(void) { };
    #endif

      virtual short APICALL
      SetInputDriver(
        const EInputDriver driver = InputDriver_Null) = 0;

      virtual EInputDriver APICALL
      GetDriverType(void) = 0;

      virtual IInputDevice* APICALL
      GetInputDevice(const EInputDevice device) = 0;

      virtual void APICALL
      Update(void) = 0;

    #ifndef CE_WITHOUT_KEYBOARD

      virtual IKeyboardDevice* APICALL
      GetKeyboardDevice(void) = 0;

      virtual void APICALL
      UpdateKeyboar(void) = 0;
    #endif

    #ifndef CE_WITHOUT_MOUSE

      virtual IMouseDevice* APICALL
      GetMouseDevice(void) = 0;

      virtual void APICALL
      UpdateMouse(void) = 0;
    #endif

    #ifndef CE_WITHOUT_JOYSTICK

      virtual IJoystickDevice* APICALL
      GetJoystickDevice(void) = 0;

      virtual void APICALL
      UpdateJoystick(void) = 0;
    #endif

 };

// ---                                                                  --- */

// ---                                            IInputManager Factory --- */

 extern DECLSPEC IInputManager* APICALL
  CreateInputManager(void);

 extern DECLSPEC void APICALL
  DestroyInputManager(IInputManager **Instance = NULL);

// ---                                                                  --- */

 } // end namespace ce

 #include "close_code.h"

 #if _MSC_VER > 1000
 #pragma warning(default:4100)
 #endif

 #endif // _CE_INPUTCORE_H_