berryCommandManager.h

Go to the documentation of this file.

/*============================================================================
 
The Medical Imaging Interaction Toolkit (MITK)
 
Copyright (c) German Cancer Research Center (DKFZ)
All rights reserved.
 
Use of this source code is governed by a 3-clause BSD license that can be
found in the LICENSE file.
 
============================================================================*/
 
#ifndef BERRYCOMMANDMANAGER_H_
#define BERRYCOMMANDMANAGER_H_
 
#include "common/berryHandleObjectManager.h"
 
#include "berryIExecutionListenerWithChecks.h"
#include "berryICommandListener.h"
#include "berryIParameterTypeListener.h"
#include "berryICommandCategoryListener.h"
#include "berryICommandManagerListener.h"
 
#include <QScopedPointer>
 
 
namespace berry
{
 
struct IParameter;
struct IHandler;
class ParameterType;
class ParameterizedCommand;
class Parameterization;
class Command;
class CommandCategory;
 
class BERRY_COMMANDS CommandManager: public HandleObjectManager
{
 
private:
 
  typedef HandleObjectManager::HandleObjectsSet HandleObjectsSet;
  typedef HandleObjectManager::HandleObjectsByIdMap HandleObjectsByIdMap;
 
  struct ExecutionListener: public IExecutionListenerWithChecks
  {
 
    ExecutionListener(CommandManager* commandManager);
 
    void NotDefined(const QString& commandId,
        const NotDefinedException* exception) override;
 
    void NotEnabled(const QString& commandId,
        const NotEnabledException* exception) override;
 
    void NotHandled(const QString& commandId,
        const NotHandledException* exception) override;
 
    void PostExecuteFailure(const QString& commandId,
        const ExecutionException* exception) override;
 
    void PostExecuteSuccess(const QString& commandId,
        const Object::Pointer& returnValue) override;
 
    void PreExecute(const QString& commandId, const SmartPointer<
        const ExecutionEvent>& event) override;
 
  private:
 
    CommandManager* commandManager;
  };
 
  struct CommandCategoryListener: public ICommandCategoryListener
  {
 
    CommandCategoryListener(CommandManager* commandManager);
 
    void CategoryChanged(
        const SmartPointer<const CommandCategoryEvent>& categoryEvent) override;
 
  private:
 
    CommandManager* commandManager;
  };
 
  QScopedPointer<ICommandCategoryListener> categoryListener;
 
  struct CommandListener: public ICommandListener
  {
 
    CommandListener(CommandManager* commandManager);
 
    void CommandChanged(const SmartPointer<const CommandEvent>& commandEvent) override;
 
  private:
 
    CommandManager* commandManager;
 
  };
 
  QScopedPointer<ICommandListener> commandListener;
 
  struct ParameterTypeListener: public IParameterTypeListener
  {
 
    ParameterTypeListener(CommandManager* commandManager);
 
    void ParameterTypeChanged(
        const SmartPointer<const ParameterTypeEvent>& parameterTypeEvent) override;
 
  private:
 
    CommandManager* commandManager;
 
  };
 
  QScopedPointer<IParameterTypeListener> parameterTypeListener;
 
public:
 
  static const QString AUTOGENERATED_CATEGORY_ID; // = "org.blueberry.core.commands.categories.autogenerated";
 
  CommandManager();
 
  void AddCommandManagerListener(ICommandManagerListener* listener);
 
  void AddExecutionListener(IExecutionListener* listener);
 
  void DefineUncategorizedCategory(const QString& name,
                                   const QString& description);
 
  SmartPointer<ParameterizedCommand> Deserialize(const QString& serializedParameterizedCommand);
 
  QList<SmartPointer<Command> > GetAllCommands() const;
 
  SmartPointer<CommandCategory> GetCategory(const QString& categoryId);
 
  SmartPointer<Command> GetCommand(const QString& commandId);
 
  QList<SmartPointer<CommandCategory> > GetDefinedCategories();
 
  QSet<QString> GetDefinedCategoryIds() const;
 
  QSet<QString> GetDefinedCommandIds() const;
 
 QList<SmartPointer<Command> > GetDefinedCommands() const;
 
  QSet<QString> GetDefinedParameterTypeIds() const;
 
  QList<SmartPointer<ParameterType> > GetDefinedParameterTypes();
 
  QString GetHelpContextId(const SmartPointer<const Command> command) const;
 
  SmartPointer<ParameterType> GetParameterType(const QString& parameterTypeId);
 
  void RemoveCommandManagerListener(ICommandManagerListener* listener);
 
  void RemoveExecutionListener(IExecutionListener* listener);
 
  void SetHandlersByCommandId(
      const QHash<QString, SmartPointer<IHandler> >& handlersByCommandId);
 
  void SetHelpContextId(const SmartPointer<IHandler> handler,
                        const QString& helpContextId);
 
  void FireNotEnabled(const QString& commandId,
                      const NotEnabledException* exception);
 
  void FireNotDefined(const QString& commandId,
                      const NotDefinedException* exception);
 
  void FirePreExecute(const QString& commandId, const SmartPointer<
                      const ExecutionEvent> event);
 
  void FirePostExecuteSuccess(const QString& commandId,
                              Object::Pointer returnValue);
 
  void FirePostExecuteFailure(const QString& commandId,
                              const ExecutionException* exception);
 
protected:
 
  static const char ESCAPE_CHAR; // = '%';
 
  static const char ID_VALUE_CHAR; // = '=';
 
  static const char PARAMETER_END_CHAR; // = ')';
 
  static const char PARAMETER_SEPARATOR_CHAR; // = ',';
 
  static const char PARAMETER_START_CHAR; // = '(';
 
  friend class ParameterizedCommand;
 
private:
 
  static QString Unescape(const QString& escapedText);
 
  QHash<QString, SmartPointer<CommandCategory> > categoriesById;
 
  QSet<QString> definedCategoryIds;
 
  QSet<QString> definedParameterTypeIds;
 
  QScopedPointer<IExecutionListenerWithChecks> executionListener;
 
  IExecutionListenerWithChecks::Events executionEvents;
 
  ICommandManagerListener::Events commandManagerEvents;
 
  QHash<WeakPointer<IHandler>, QString> helpContextIdsByHandler;
 
  QHash<QString, SmartPointer<ParameterType> > parameterTypesById;
 
  void FireCommandManagerChanged(
      const SmartPointer<const CommandManagerEvent> event);
 
  QList<Parameterization> GetParameterizations(
      const QString& serializedParameters,
      const QList<SmartPointer<IParameter> >& parameters) const;
 
  int UnescapedIndexOf(const QString& escapedText, const char ch) const;
 
};
 
}
 
#endif /* BERRYCOMMANDMANAGER_H_ */