PDG_CommandManager.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.
 *
 * COMMENTS:
 */

#ifndef __PDG_COMMAND_MANAGER_H__
#define __PDG_COMMAND_MANAGER_H__

#include "PDG_API.h"

#include <UT/UT_Array.h>
#include <UT/UT_NonCopyable.h>
#include <UT/UT_UniquePtr.h>
#include <UT/UT_WorkBuffer.h>

class PDG_Command;
class PDG_CommandChunk;
class PDG_GraphContext;

class PDG_API PDG_CommandManager
{
public:
    PDG_CommandManager(PDG_GraphContext* context);
    virtual ~PDG_CommandManager();

    UT_NON_COPYABLE(PDG_CommandManager)

    PDG_CommandChunk * openChunk(UT_StringHolder description);
    virtual PDG_CommandChunk * openChunk(bool delayed,
                                         UT_StringHolder description);
    void enableLogging(bool enable);
    PDG_CommandChunk * currentlyOpenChunk() const;

    bool commitChunk(UT_WorkBuffer& errors);
    bool commitChunk()
    {
        UT_WorkBuffer errors;
        return commitChunk(errors);
    }

    bool rollbackChunk(UT_WorkBuffer& errors);

    bool undoIt(UT_WorkBuffer& errors);
    bool undoIt()
    {
        UT_WorkBuffer errors;
        return undoIt(errors);
    }
    bool redoIt(UT_WorkBuffer& errors);

    bool recordCommand(UT_UniquePtr<PDG_Command> cmd, UT_WorkBuffer& errors);
    bool recordCommand(UT_UniquePtr<PDG_Command> cmd);

    void clear();
    void commandDescriptions(UT_WorkBuffer& buffer) const;
    void commands(UT_Array<PDG_Command*>& commands) const;
    void commandChunks(UT_Array<PDG_Command*>& commands) const;

    int stateCount() const { return myDoneIndex + 1; }
    int chunkDepth() const { return myCommandChunkStack.size(); }

protected:
    UT_Array<UT_UniquePtr<PDG_CommandChunk>> myCommandChunkStack;

private:
    PDG_GraphContext* myContext;    
    UT_Array<UT_UniquePtr<PDG_Command>> myCommands;
    int myDoneIndex;
};

#endif /* __PDG_COMMAND_MANAGER_H__ */