panda3d/panda/src/event/asyncTask.h

// Filename: asyncTask.h
// Created by:  drose (23Aug06)
//
////////////////////////////////////////////////////////////////////
//
// PANDA 3D SOFTWARE
// Copyright (c) Carnegie Mellon University.  All rights reserved.
//
// All use of this software is subject to the terms of the revised BSD
// license.  You should have received a copy of this license along
// with this source code in a file named "LICENSE."
//
////////////////////////////////////////////////////////////////////

#ifndef ASYNCTASK_H
#define ASYNCTASK_H

#include "pandabase.h"

#include "typedReferenceCount.h"
#include "namable.h"
#include "pmutex.h"
#include "conditionVar.h"
#include "pStatCollector.h"

#ifdef HAVE_PYTHON

#undef HAVE_LONG_LONG  // NSPR and Python both define this.
#undef _POSIX_C_SOURCE
#include <Python.h>

#endif  // HAVE_PYTHON

class AsyncTaskManager;
class AsyncTaskChain;

////////////////////////////////////////////////////////////////////
//       Class : AsyncTask
// Description : This class represents a concrete task performed by an
//               AsyncManager.  Normally, you would subclass from this
//               class, and override do_task(), to define the
//               functionality you wish to have the task perform.
////////////////////////////////////////////////////////////////////
class EXPCL_PANDA_EVENT AsyncTask : public TypedReferenceCount, public Namable {
public:
  AsyncTask(const string &name = string());
  ALLOC_DELETED_CHAIN(AsyncTask);

PUBLISHED:
  virtual ~AsyncTask();

  enum DoneStatus {
    DS_done,      // normal task completion
    DS_cont,      // run task again next epoch
    DS_again,     // start the task over from the beginning
    DS_pickup,    // run task again this frame, if frame budget allows
    DS_exit,      // stop the enclosing sequence
    DS_pause,     // pause, then exit (useful within a sequence)
    DS_interrupt, // interrupt the task manager, but run task again
  };

  enum State {
    S_inactive,
    S_active,
    S_servicing,
    S_servicing_removed,  // Still servicing, but wants removal from manager.
    S_sleeping,
    S_active_nested,      // active within a sequence.
  };

  INLINE State get_state() const;
  INLINE AsyncTaskManager *get_manager() const;

  void remove();

  INLINE void set_delay(double delay);
  INLINE void clear_delay();
  INLINE bool has_delay() const;
  INLINE double get_delay() const;
  INLINE double get_wake_time() const;
  
  INLINE double get_start_time() const;
  double get_elapsed_time() const;
  INLINE int get_start_frame() const;
  int get_elapsed_frames() const;

  void set_name(const string &name);
  INLINE void clear_name();

  INLINE AtomicAdjust::Integer get_task_id() const;

  void set_task_chain(const string &chain_name);
  INLINE const string &get_task_chain() const;

  void set_sort(int sort);
  INLINE int get_sort() const;

  void set_priority(int priority);
  INLINE int get_priority() const;

  INLINE void set_done_event(const string &done_event);
  INLINE const string &get_done_event() const;

#ifdef HAVE_PYTHON
  INLINE void set_python_object(PyObject *python_object);
  INLINE PyObject *get_python_object() const;
#endif  // HAVE_PYTHON

  INLINE double get_dt() const;
  INLINE double get_max_dt() const;
  INLINE double get_average_dt() const;

  virtual void output(ostream &out) const;

protected:
  void jump_to_task_chain(AsyncTaskManager *manager);
  DoneStatus unlock_and_do_task();

  virtual bool is_runnable();
  virtual DoneStatus do_task();
  virtual void upon_birth();
  virtual void upon_death(bool clean_exit);

protected:
  AtomicAdjust::Integer _task_id;
  string _chain_name;
  double _delay;
  bool _has_delay;
  double _wake_time;
  int _sort;
  int _priority;
  string _done_event;

  State _state;
  Thread *_servicing_thread;
  AsyncTaskManager *_manager;
  AsyncTaskChain *_chain;

  double _start_time;
  int _start_frame;

  double _dt;
  double _max_dt;
  double _total_dt;
  int _num_frames;

  static AtomicAdjust::Integer _next_task_id;

  static PStatCollector _show_code_pcollector;
  PStatCollector _task_pcollector;

private:
#ifdef HAVE_PYTHON
  PyObject *_python_object;
#endif  // HAVE_PYTHON
  
public:
  static TypeHandle get_class_type() {
    return _type_handle;
  }
  static void init_type() {
    TypedReferenceCount::init_type();
    register_type(_type_handle, "AsyncTask",
                  TypedReferenceCount::get_class_type());
  }
  virtual TypeHandle get_type() const {
    return get_class_type();
  }
  virtual TypeHandle force_init_type() {init_type(); return get_class_type();}

private:
  static TypeHandle _type_handle;

  friend class AsyncTaskManager;
  friend class AsyncTaskChain;
  friend class AsyncTaskSequence;
};

INLINE ostream &operator << (ostream &out, const AsyncTask &task) {
  task.output(out);
  return out;
};

#include "asyncTask.I"

#endif