PDG_Command.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_H__
#define __PDG_COMMAND_H__

#include "PDG_API.h"

#include <UT/UT_NonCopyable.h>
#include <UT/UT_StringHolder.h>
#include <UT/UT_WorkBuffer.h>

#include <time.h>

class PDG_GraphContext;

enum PDG_CommandType
{
    PDG_COMMAND_CHUNK,
    PDG_USER_COMMAND,
    PDG_RUNTIME_COMMAND
};

class PDG_API PDG_Command
{
public:
    PDG_Command();
    virtual ~PDG_Command();
    UT_NON_COPYABLE(PDG_Command)

    bool hasDoneIt() const;
    bool hasFailed() const;
    bool result() const { return !hasFailed(); }

    bool doIt(PDG_GraphContext* context);
    bool undoIt(PDG_GraphContext* context);
    virtual bool doIt(PDG_GraphContext* context, UT_WorkBuffer& errors);
    virtual bool undoIt(PDG_GraphContext* context, UT_WorkBuffer& errors);
    virtual bool canDoIt();
    virtual bool canUndoIt();
    virtual PDG_CommandType commandType() = 0;
    virtual PDG_CommandType baseCommandType();
    virtual void description(UT_WorkBuffer& buffer, int depth=0);
    virtual void fullDescription(UT_WorkBuffer& buffer);

    UT_StringHolder timeAsString() const;
    time_t creationTime() const { return myTime; }

protected:
    virtual bool doCommand(PDG_GraphContext*, UT_WorkBuffer&) = 0;
    virtual bool undoCommand(PDG_GraphContext*, UT_WorkBuffer&) = 0;

private:
    bool myHasDoneIt;
    bool myHasFailed;
    time_t myTime;
};

#endif /* __PDG_COMMAND_H__ */