sidekick.h

/*
 *  Copyright (c) 2005    National Research Council
 *
 *  All rights reserved.
 *
 *  This material is confidential and proprietary information of
 *  National Research Council Canada ("Confidential Information").
 *  This Confidential Information may only be used and reproduced
 *  in accordance with the terms of the license agreement.
 *
 */

#ifndef __INCLUDED_SCOPIRA_CORE_SIDEKICK_H__
#define __INCLUDED_SCOPIRA_CORE_SIDEKICK_H__

#include <scopira/tool/export.h>
#include <scopira/tool/thread.h>
#include <scopira/tool/object.h>

namespace scopira
{
  namespace core
  {
    class sidekick_i;
    class sidekick_reactor_i;
    
    class sidekick_queue_i;

    SCOPIRA_EXPORT void enqueue_sidekick(sidekick_i *t, sidekick_reactor_i *reac = 0);

    SCOPIRA_EXPORT bool is_sidekick_running(void);
  }
}

class scopira::core::sidekick_i : public virtual scopira::tool::object,
                             public virtual scopira::tool::runnable_i
{
  public:
  protected:
    sidekick_i(void) : dm_treact(0) { }

    SCOPIRA_EXPORT void notify_reactors(void);

    //virtual void run(void);

  protected:
    // in the future, make a class sidekick_msg_window that allows
    // a window to be open the whole time during the run.
    // ... allow output too?
    // ... allow cancelability?
    // bah, make them use core?

  private:
    sidekick_reactor_i *dm_treact;

    friend class scopira::core::sidekick_queue_i;
    friend void scopira::core::enqueue_sidekick(sidekick_i *, sidekick_reactor_i *);
};

class scopira::core::sidekick_reactor_i
{
  public:
    virtual ~sidekick_reactor_i() { }
    SCOPIRA_EXPORT virtual void react_sidekick_notify(sidekick_i *t) = 0;
    SCOPIRA_EXPORT virtual void react_sidekick_done(sidekick_i *t) = 0;
};

class scopira::core::sidekick_queue_i : public virtual scopira::tool::object
{
  protected:
    SCOPIRA_EXPORT sidekick_queue_i(void);
    SCOPIRA_EXPORT virtual ~sidekick_queue_i();

    SCOPIRA_EXPORT virtual void enqueue_sidekick(sidekick_i *t) = 0;
    SCOPIRA_EXPORT virtual bool is_sidekick_running(void) = 0;

    sidekick_reactor_i * & get_reactor(sidekick_i &sk) { return sk.dm_treact; }

  protected:
    SCOPIRA_EXPORT static sidekick_queue_i *dm_instance;

    friend void scopira::core::enqueue_sidekick(sidekick_i *, sidekick_reactor_i *);
    friend bool scopira::core::is_sidekick_running(void);
};

// impls are in sidekickthread

#endif