featuresDebugger.h

Go to the documentation of this file.

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


#pragma once

#include <features/featureSet.h>
#include <features/featureSetList.h>

#include <vrfutil/consoleCommandManager.h>

#include <tbb/queuing_rw_mutex.h>
#include <mutex>

#include <boost/ptr_container/ptr_map.hpp>

#include <ostream>

class DtSubCommandManager;
class DtConsoleCommandOwner;
class DtConsoleCommandManager;

namespace MAKVRinTerra
{
   template <typename FS>
   class DtPagingFeatureSet;

   class DT_DLL_features DtFeaturesDebugger
      : public std::enable_shared_from_this<DtFeaturesDebugger>
      , public DtSubCommandManager
   {
   public:
      typedef std::shared_ptr<DtFeaturesDebugger> Ptr;

      DtFeaturesDebugger(const std::string& name, DtConsoleCommandManager* manager = 0);

      virtual ~DtFeaturesDebugger() override;


      DtFeaturesDebugger& operator[](const std::string& key);
      const DtFeaturesDebugger& operator[](const std::string& key) const;

      virtual bool executeCommands(const std::string&);

      class DT_DLL_features Record
      {
      public:
         friend class DtFeaturesDebugger;

         typedef std::shared_ptr<Record> Ptr;

         typedef std::vector<std::string>        CommandSequence;
         typedef CommandSequence::const_iterator CommandIterator;

         explicit Record(DtFeatureSet*, bool enable=true);

         virtual ~Record();

         virtual const DtFeatureSet& featureSet() const;
         virtual std::string name() const;

         virtual CommandIterator executeCommand(
            CommandIterator, CommandIterator, std::ostream&);
         virtual bool executeCommand(const std::string&, std::ostream&);

         virtual void executeListCommand(std::ostream&);

         virtual CommandIterator executeInfoCommand(
            CommandIterator, CommandIterator, std::ostream&);
         virtual void executeInfoCommand(std::ostream&);
         virtual bool executeInfoCommand(const std::string&, std::ostream&);

         virtual void clear();

         Record& command(const std::string&);
         Record& command(const std::string&, std::ostream&);

      protected:
         typedef std::recursive_mutex Mutex;
         mutable Mutex mutex;

         std::unique_ptr<DtFeatureSet> myFeatureSet;

      private:
         int myListIndex;
      };

      virtual Record::Ptr add(Record*);

      template <typename F>
      Record& add(DtFeatureSetTemplate<F>* fs, bool enable = true)
      {
         return *add(new Record(DtFeatureSet::Wrap(fs), enable));
      }

      virtual bool runCommand(DtString) override;

      virtual DtString helpText(const DtString&) const override;

   protected:
      typedef std::vector<Record::Ptr> RecordVector;

      virtual RecordVector getMatchingRecords(
         Record::CommandIterator& i, Record::CommandIterator end) const;

      typedef tbb::queuing_rw_mutex Mutex;
      mutable Mutex myMutex;

      RecordVector myFeatureSets;
      DtConsoleCommandOwner myCommandOwner;

      typedef std::map<std::string, Ptr> SubDebuggers;
      SubDebuggers mySubDebuggers;
   };
}