iabort.h

Go to the documentation of this file.

/*
 * Copyright (C) 2008-2025 Global Graphics Software Ltd. All rights reserved.
 */


 
#ifndef IABORT_H
#define IABORT_H
 
#include <edl/smartptr.h>
#include <edl/ircobject.h>
 
_BEGIN_EDL_NAMESPACE
 
class IAbort;
DECL_SMART_PTR (IAbort);
class IProgressTick;
DECL_SMART_PTR (IProgressTick);
class IProgressEventHandler;
DECL_SMART_PTR (IProgressEventHandler);
class IProgressMonitor;
DECL_SMART_PTR (IProgressMonitor);

class IAbort : public IRCObject
{
    public:
        virtual ~IAbort() {}

        static EDL_API IAbortPtr create();

        virtual void resetSignal () = 0;

        virtual void signalAbort() = 0;

        virtual bool abortSignalled() = 0;
};

#define CHECKABORT(abort) THROW_IF((abort) && (abort)->abortSignalled(), EDL_ERR_ABORTED);
 

class IProgressTick : public IRCObject
{
    public:

        typedef void (*FloatProgressCallbackFunc)(void *priv, float progress);

        typedef void (*IntProgressCallbackFunc)(void *priv, uint32 currentCount, uint32 maxCount);
 
        virtual ~IProgressTick() {}

        static EDL_API IProgressTickPtr create (IntProgressCallbackFunc cbFunc, void *cbPriv);

        static EDL_API IProgressTickPtr create (FloatProgressCallbackFunc cbFunc, void *cbPriv);

        virtual void setCallback (IntProgressCallbackFunc cbFunc, void *cbPriv) = 0;

        virtual void setCallback (FloatProgressCallbackFunc cbFunc, void *cbPriv) = 0;

        virtual void tickReset () = 0;

        virtual void tick () = 0;

        virtual void tickMax () = 0;

        virtual void setTickMax (const uint32 tickMax) = 0;
 
};
#define PROGRESSTICK(progressTick)           { if (progressTick) (progressTick)->tick(); }
#define PROGRESSTICKMAX(progressTick)        { if (progressTick) (progressTick)->tickMax(); }

class IProgressEventHandler : public IRCObject
{
    public:
        typedef enum
        {
            eEvtNone = 0,
            eEvtPageWriteStart,     // Event posted at the start of writing a page
            eEvtPageWriteEnd,       // Event posted after a page is written.
            eEvtNodeWriteStart,
            eEvtNodeWriteEnd,
        } Event;
 
        virtual ~IProgressEventHandler () {};

        typedef void (*ProgressEventHandlerCallbackFunc) (void *priv, Event evt);

        virtual void handleEvent (Event evt) = 0;

        static EDL_API IProgressEventHandlerPtr create (ProgressEventHandlerCallbackFunc cbFunc, void *cbPriv);
};

class IProgressMonitor : public IRCObject
{
    public:
        virtual ~IProgressMonitor () {};

        static EDL_API IProgressMonitorPtr create (const IProgressTickPtr &progressTick, const IAbortPtr &abort);

        static EDL_API IProgressMonitorPtr create (const IProgressTickPtr &progressTick);

        static EDL_API IProgressMonitorPtr create (const IAbortPtr &abort);

        virtual IProgressTickPtr    getProgressTick () const = 0;

        virtual IAbortPtr           getAbort () const = 0;

        virtual void setProgressEventHandler (const IProgressEventHandlerPtr &progressEventHandler) = 0;

        virtual void postEvent (IProgressEventHandler::Event evt) = 0;
};
 
_END_EDL_NAMESPACE
 
#endif /* IABORT_H */