triggerStmt.h

Go to the documentation of this file.

/*********************************************************************
** Copyright (c) 2018 MaK Technologies, Inc.
** All rights reserved.
*********************************************************************/


#pragma once

#include <readerWriter/rwString.h>
#include <readerWriter/rwBoolean.h>
#include "vrfutil/simCondExpr.h"
#include "vrfutil/rwUUID.h"
#include "vrfplan/rwCondExpr.h"
#include "vrfplan/simConditionalStatement.h"
#include <tbb/spin_mutex.h>

#include <boost/unordered_map.hpp>
#include <set>

const char DtWhenStmtTypeName[] = "When";

class DtRwCondExpr;
class DtTriggerBlock;

#include "vrfplan/vrfplanDefines.h"

class DtTriggerStmt;

class DT_DLL_vrfplan DtTriggerStatementUUIDMarkingTextProvider : public DtUUIDMarkingTextProvider
{
public:
   DtTriggerStatementUUIDMarkingTextProvider(const DtString& defaultText);
   DtTriggerStatementUUIDMarkingTextProvider(const DtTriggerStatementUUIDMarkingTextProvider&);
   virtual ~DtTriggerStatementUUIDMarkingTextProvider();

   void setMarkingTextFromTriggerStatement(DtTriggerStmt*);
   void addReference();
   void removeReference();
   bool hasReference() { return (myReferenceCount > 0); };

   virtual DtString markingText() override;
   virtual DtUUIDMarkingTextProvider* clone() const;

protected:
   DtString myMarkingText;
   tbb::spin_mutex myMutex;
   int myReferenceCount = 0;
};

class DT_DLL_vrfplan DtTriggerStmt : public DtSimConditionalStatement
{
public:

   DtTriggerStmt(DtReaderWriterRegistry* parentRegistry = NULL);

   DtTriggerStmt(const DtTriggerStmt& orig,
      DtReaderWriterRegistry* parentRegistry = NULL);

   virtual ~DtTriggerStmt();

   DtTriggerStmt& operator=(const DtTriggerStmt& orig);


   virtual DtSimStatement* clone(
      DtReaderWriterRegistry* parentRegistry = NULL) const;

   virtual int type() const;

   virtual void execute(DtPlan& planContext);

   virtual int subBlockCount() const;
   virtual DtSimBlock* subBlock(int index);

   virtual DtString stringRep(int subBlockIndex = DtSR_STMT) const;

   virtual void exitFromTrigger(DtPlan& planContext);

   virtual const DtUUID& triggerUUID() const;
   virtual void setTriggerUUID(const DtUUID&);

   virtual DtString triggerName() const;

   virtual const DtSimCondExpr* condExpr() const;
   virtual void setCondExpr(const DtSimCondExpr* arg);

   virtual const DtString& option() const;
   virtual void setOption(const DtString& arg);

   virtual DtTriggerBlock* triggerBlock() const;
   virtual void setTriggerBlock(DtTriggerBlock* arg);

   virtual void setReregisterTrigger(bool);
   virtual bool reregisterTrigger() const;

   virtual int netRepSize() const;

   virtual bool setFromNet(const char* contentBuffer, 
      unsigned contentSize);

   virtual bool setToNet();

   virtual void upgradeTriggerUUID(const boost::unordered_map<DtUUID, DtUUID>&);

   virtual void reset();

   virtual void setStatementDescription(const DtString& d) override;

protected:
   virtual void addTriggerMarkingTextMapping();
   virtual void removeTriggerMarkingTextMapping();
   virtual void setupMarkingTextForTriggerStatement();

   virtual void getSelf(DtlObjPtr args, const DtReaderWriter::SearchPaths& searchPaths,
                     const DtVariableBindingsList& variableBindings);

   static DtString nextDefaultTriggerMarkingText();

public:

   static DtSimStatement * creator(DtReaderWriterRegistry* parentRegistry = NULL);

protected:

   virtual bool compare(DtSimStatement*);

protected:
   DtRwUUID myTriggerUUID;
   DtRwCondExpr myCondExpr;
   DtRwString myOption;
   DtTriggerBlock* myBlock;
   DtRwBoolean myReregisterTrigger;

   typedef boost::unordered_map<DtUUID, DtTriggerStatementUUIDMarkingTextProvider*> NamedTriggers;

   static NamedTriggers theNamedTriggers;
};