OP_CloneManager.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * NAME:        OP_CloneManager.h (C++)
 */

#ifndef _OP_CloneManager_h_
#define _OP_CloneManager_h_

#include "OP_API.h"
#include <UT/UT_Function.h>
#include <UT/UT_Map.h>
#include <UT/UT_StringHolder.h>
#include <iosfwd>

class UT_Options;

#define OP_CLONE_CPIO_PACKET    ".clones"

extern OP_API const UT_StringHolder OP_CLONEFUNC_NODE_GETORCREATEOUTPUT;

typedef UT_Function<void(const UT_StringRef &)> OP_CloneChangeCallback;
typedef UT_Function<void(const UT_StringRef &,
                         const UT_StringRef &,
                         const UT_StringRef &)> OP_CloneImageChangeCallback;

class OP_API OP_CloneManager
{
public:
    OP_CloneManager();
    virtual ~OP_CloneManager();

    static bool              hasInstance()
                             { return theCloneManager != nullptr; }
    static OP_CloneManager  *getInstance()
                             { return theCloneManager; }
    static void              setRunningAsClone(bool running_as_clone)
                             { theRunningAsClone = running_as_clone; }
    static bool              isRunningAsClone()
                             { return theRunningAsClone; }

    virtual void             remoteExecute(const UT_StringHolder &function,
                                 const UT_Options &parameters) = 0;
    virtual void             saveClones(std::ostream &os) const = 0;
    virtual void             deleteAllClones() = 0;

    // The returned id will always be >= 0.
    static int   addConnectionChangeCallback(OP_CloneChangeCallback cb);
    static void  removeConnectionChangeCallback(int id);

    // The returned id will always be >= 0.
    static int   addImageChangeCallback(OP_CloneImageChangeCallback cb);
    static void  removeImageChangeCallback(int id);

protected:
    void         runCallbacks(const UT_StringRef &id);
    void         runImageCallbacks(const UT_StringRef &id,
                        const UT_StringRef &galleryid,
                        const UT_StringRef &imagepath);

private:
    static OP_CloneManager                               *theCloneManager;
    static UT_SortedMap<int, OP_CloneChangeCallback>      theCallbacks;
    static UT_SortedMap<int, OP_CloneImageChangeCallback> theImageCallbacks;
    static int                                            theUniqueCallbackId;
    static bool                                           theRunningAsClone;
};

#endif