UTTask.h

Go to the documentation of this file.

//==================================================================================================
// Copyright (C) 2010  Brian Tietz    sdbtietz at yahoo dot com
//
// This program 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, version 2.0 of the
// License.
//
// This program 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 this program; if
// not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
// 02110-1301, USA.
//
// For commercial software, the copyright holder (Brian Tietz, email sdbtietz at yahoo dot com)
// reserves the right and is willing to waive the proprietary source code disclosure aspects of that
// license as applied to the UT library in exchange for either substantial contributions to the
// development of the UT library or other forms of compensation.  Any such waiver must be
// established in writing between the copyright holder and the commercial entity obtaining such a
// waiver.
//==================================================================================================


#ifndef _UT_TASK_H_
#define _UT_TASK_H_


//==================================================================================================
//=== Project headers
//==================================================================================================
#include "UTLists.h"


//==================================================================================================
//=== Forward name declarations
//==================================================================================================
class MessageLoop_t;
class AbstractMessageReceiver_t;


//==================================================================================================
//=== Constants
//==================================================================================================
enum quit_response_t
{
    eQUIT_allowed,
    eQUIT_deferred,
    eQUIT_denied
};


//==================================================================================================
class UT_EXPORT Task_t
//==================================================================================================
: private BTreeNode_t< Task_t, Task_t* >
{
    //----------------------------------------------------------------------------------------------
    public:
    //----------------------------------------------------------------------------------------------
                                        Task_t();

    virtual                             ~Task_t();

    inline int32                        Token() const;

    inline MessageLoop_t*               MessageLoop() const;

    //----------------------------------------------------------------------------------------------
    protected:
    //----------------------------------------------------------------------------------------------
    virtual void                        AddedToMessageLoop(MessageLoop_t* message_loop);
    
    virtual void                        RemovedFromMessageLoop(MessageLoop_t* message_loop);

    virtual quit_response_t             QuitRequested();

    void                                ResumeQuit();

    void                                CancelQuit();

    virtual void                        Quit();

    //----------------------------------------------------------------------------------------------
    private:
    //----------------------------------------------------------------------------------------------
    inline int                          Compare(Task_t* address) const;
    inline                              operator Task_t*() const;

    //----------------------------------------------------------------------------------------------
    private:
    //----------------------------------------------------------------------------------------------
    int32                               m_task_token;
    MessageLoop_t*                      m_message_loop;
    bool                                m_quit_notified;

    friend class BTreeNode_t< Task_t, Task_t* >;
    friend class BTree_t< Task_t, Task_t* >;
    friend class MessageLoop_t;
};




//==================================================================================================
//==================================================================================================
//===
//=== Inline function implementations: class Task_t
//===
//==================================================================================================
//==================================================================================================
inline int32
Task_t::Token() const
{
    return m_task_token;
}


inline MessageLoop_t*
Task_t::MessageLoop() const
{
    return m_message_loop;
}


inline int
Task_t::Compare(Task_t* address) const
{
    if(this < address)
        return -1;
    else if(this > address)
        return 1;
    else
        return 0;
}


inline
Task_t::operator Task_t*() const
{
    return const_cast<Task_t*>(this);
}


#endif // _UT_TASK_H_