berryCommand.h

Go to the documentation of this file.

/*===================================================================

BlueBerry Platform

Copyright (c) German Cancer Research Center,
Division of Medical and Biological Informatics.
All rights reserved.

This software is distributed WITHOUT ANY WARRANTY; without
even the implied warranty of MERCHANTABILITY or FITNESS FOR
A PARTICULAR PURPOSE.

See LICENSE.txt or http://www.mitk.org for details.

===================================================================*/

#ifndef BERRYCOMMAND_H_
#define BERRYCOMMAND_H_

#include "berryNamedHandleObjectWithState.h"

#include <berryICommandListener.h>
#include <berryIHandlerListener.h>
#include <berryIExecutionListenerWithChecks.h>
#include <berryIParameter.h>

#include <berryParameterType.h>

namespace berry
{

class CommandCategory;
class ExecutionEvent;
struct IHandler;

class BERRY_COMMANDS Command : public NamedHandleObjectWithState, private IHandlerListener
{ // implements Comparable {

public:

  berryObjectMacro(Command);

  static bool DEBUG_COMMAND_EXECUTION;

  static bool DEBUG_HANDLERS;

  static QString DEBUG_HANDLERS_COMMAND_ID;

private:

  SmartPointer<CommandCategory> category;

  IExecutionListenerWithChecks::Events executionEvents;
  //ListenerList executionListeners;

  ICommandListener::Events commandEvents;

  SmartPointer<IHandler> handler;

  QString helpContextId;

  QList<SmartPointer<IParameter> > parameters;

  SmartPointer<ParameterType> returnType;

protected:

  Command(const QString& id);

  friend class CommandManager;

public:

  void AddCommandListener(ICommandListener* commandListener);

  void AddExecutionListener(IExecutionListener* executionListener);

  void AddState(const QString& id, const SmartPointer<State>& state) override;

  bool operator<(const Object* object) const override;

  void Define(const QString& name, const QString& description,
              const SmartPointer<CommandCategory> category,
              const QList<SmartPointer<IParameter> >& parameters = QList<SmartPointer<IParameter> >(),
              const SmartPointer<ParameterType>& returnType = SmartPointer<ParameterType>(nullptr),
              const QString& helpContextId = "");

  Object::Pointer ExecuteWithChecks(const SmartPointer<const ExecutionEvent> event);

private:

  void FireCommandChanged(const SmartPointer<const CommandEvent> commandEvent);

  void FireNotDefined(const NotDefinedException* e);

  void FireNotEnabled(const NotEnabledException* e);

  void FireNotHandled(const NotHandledException* e);

  void FirePostExecuteFailure(const ExecutionException* e);

  void FirePostExecuteSuccess(const Object::Pointer returnValue);

  void FirePreExecute(const SmartPointer<const ExecutionEvent> event);

public:

  SmartPointer<IHandler> GetHandler() const;

  QString GetHelpContextId() const;

  SmartPointer<IParameter> GetParameter(const QString& parameterId) const;

  QList<SmartPointer<IParameter> > GetParameters() const;

  SmartPointer<ParameterType> GetParameterType(const QString& parameterId) const;

  SmartPointer<ParameterType> GetReturnType() const;

  bool IsEnabled() const;

  void SetEnabled(const Object::Pointer& evaluationContext);

  bool IsHandled() const;

  void RemoveCommandListener(ICommandListener* commandListener);

  void RemoveExecutionListener(IExecutionListener* executionListener);

  void RemoveState(const QString& stateId) override;

  bool SetHandler(const SmartPointer<IHandler> handler);

private:

  IHandlerListener* GetHandlerListener();

  void HandlerChanged(const SmartPointer<HandlerEvent>& handlerEvent) override;


public:

  QString ToString() const override;

  void Undefine() override;
};

}
#endif /*BERRYCOMMAND_H_*/