DispatchQueue.hpp

/******************************************************************************
 
  nomlib - C++11 cross-platform game engine
 
Copyright (c) 2013, 2014 Jeffrey Carpenter <i8degrees@gmail.com>
All rights reserved.
 
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.
 
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.
 
******************************************************************************/
#ifndef NOMLIB_ACTIONS_DISPATCH_QUEUE_HPP
#define NOMLIB_ACTIONS_DISPATCH_QUEUE_HPP
 
#include <memory>
#include <functional>
#include <vector>
 
#include "nomlib/config.hpp"
#include "nomlib/core/unique_ptr.hpp"
 
namespace nom {
 
// Forward declarations
class IActionObject;
struct DispatchEnqueue;
 
typedef std::function<void()> action_callback_func;

class DispatchQueue
{
  public:
    typedef DispatchQueue self_type;

    enum State
    {
      IDLING = 0,
      RUNNING,
    };
 
    DispatchQueue();
 
    ~DispatchQueue();

    nom::size_type num_actions() const;

    bool enqueue_action(  const std::shared_ptr<IActionObject>& action,
                          const action_callback_func& completion_func );

    DispatchQueue::State
    update(uint32 player_state, real32 delta_time);
 
  private:
    static const char* DEBUG_CLASS_NAME;
 
    typedef std::vector<std::unique_ptr<DispatchEnqueue>> container_type;
    typedef container_type::iterator iterator_type;

    container_type actions_;
    iterator_type actions_iterator_;

    nom::size_type num_actions_ = 0;
};

template<typename ObjectType, typename... ObjectArgs>
std::unique_ptr<ObjectType> create_dispatch_queue(ObjectArgs&&... args)
{
  auto dispatch_queue =
    nom::make_unique<ObjectType>( std::forward<ObjectArgs>(args) ... );
 
  return std::move(dispatch_queue);
}
 
} // namespace nom
 
#endif // include guard defined