consoleCommandManager.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2010 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/



#pragma once

#include "vrfutil/vrfutilDefines.h"
#include "vrfutil/vrfPrint.h"
#include <vlutil/vlString.h>
#include <vlutil/vlPrint.h>

#include <map>
#include <list>
#include <iostream>
#include <stdlib.h>

#include <boost/signals2.hpp>
#include <tbb/spin_rw_mutex.h>

class DT_DLL_vrfutil DtConsoleCommand
{
public:
   virtual ~DtConsoleCommand() {};

   virtual bool execute(const DtString& parameters) = 0;
   virtual DtString help(const DtString& parameters) {return parameters;};
   virtual bool showInHelp() const { return false; };
};

class DT_DLL_vrfutil DtConsoleCommandManager
{
private:

   DtConsoleCommandManager(const DtConsoleCommandManager& orig);
   DtConsoleCommandManager& operator=(const DtConsoleCommandManager& orig);

public:
   DtConsoleCommandManager();
   virtual ~DtConsoleCommandManager();

   boost::signals2::signal<void ()> signal_globalCommandManagerToBeDestroyed;

   virtual void addCommand(DtString commandString, DtConsoleCommand* command);


   virtual void addAlias(DtString aliasString, DtConsoleCommand* command);
   virtual void addAlias(DtString aliasString, DtString commandString);

   virtual void removeCommand(DtString commandString);
   virtual void removeCommand(DtConsoleCommand* command);

   virtual bool runCommand(DtString consoleString);
   virtual DtString helpText(const DtString& parameters) const;

   static void cleanup();

   static DtConsoleCommandManager* globalConsoleCommandManager();

protected:
   typedef std::map<DtString, DtConsoleCommand* > DtConsoleCommandMap;

   class DtHelpConsoleCommand : public DtConsoleCommand
   {
   public:
      DtHelpConsoleCommand(DtConsoleCommandManager* commandManager);
      virtual bool execute(const DtString& parameters);
      virtual DtString help(const DtString& parameters);
      virtual bool showInHelp() const { return true; };
   protected:
      DtConsoleCommandManager* myCommandManager;
   };

   virtual void removeReferencesFromMap(DtConsoleCommandMap& commandMap, DtConsoleCommand* command);
protected:
   
   DtConsoleCommandMap myCommandMap;
   DtConsoleCommandMap myAliasMap;
   tbb::spin_rw_mutex myMutex;

   DtHelpConsoleCommand* myHelpCommand;

   static DtConsoleCommandManager* theConsoleCommandManager;
};

class DT_DLL_vrfutil DtSubCommandManager : public DtConsoleCommandManager
{
public:
   DtSubCommandManager(const DtString& commandName,
      DtConsoleCommandManager* parentManager);
   virtual ~DtSubCommandManager();

protected:
   class DtRunSubCommand : public DtConsoleCommand
   {
   public:
      DtRunSubCommand(DtSubCommandManager* commandManager);
      virtual bool execute(const DtString& parameters);
      virtual DtString help(const DtString& parameters);
      virtual bool showInHelp() const { return true; };
   protected:
      DtSubCommandManager* myCommandManager;
   };

   DtConsoleCommandManager* myParentManager;
   DtRunSubCommand* myCommand;
};

class DT_DLL_vrfutil DtConsoleCommandOwner 
{
public:
   DtConsoleCommandOwner(DtConsoleCommandManager* cmdMgr);
   virtual ~DtConsoleCommandOwner();

private:

   DtConsoleCommandOwner();
   DtConsoleCommandOwner(const DtConsoleCommandOwner& orig);
   DtConsoleCommandOwner& operator=(const DtConsoleCommandOwner& orig);

public:
   virtual void addCommand(const DtString& commandString, DtConsoleCommand* command);

protected:
   DtConsoleCommandManager* myCommandManager;
};