objectIdentificationResolver.h

Go to the documentation of this file.

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


#pragma once

#include <vrfutil/uuid.h>
#include <vrfutil/vrfutilDefines.h>

#include <vlutil/vlUuid.h>

#include <unordered_set>
#include <tuple>

#include <boost/archive/xml_iarchive.hpp>
#include <boost/archive/xml_oarchive.hpp>
#include <boost/serialization/access.hpp>
#include <boost/uuid/uuid_io.hpp>
#include <boost/uuid/uuid_serialize.hpp>
#include <boost/unordered_map.hpp>
#include <boost/signals2.hpp>

#include <mutex>


class DT_DLL_vrfutil DtObjectIdentificationResolver
{
public:
   typedef boost::unordered_map<DtUUID, DtUUIDMarkingTextProvider*> UUIDToMarkingTextMap;
   typedef boost::unordered_map<DtString, DtUUID> EntityIdentifierToUUIDMap;
   typedef boost::unordered_map<DtUUID, DtString> UUIDToEntityIdentifierMap;
   typedef boost::unordered_map<DtString, DtUUID> MarkingTextToUUIDMap;
   typedef boost::unordered_map<DtUUID, DtUUID> UUIDToUUIDMap;
   typedef boost::unordered_map<DtString, DtString> MarkingTextToMarkingTextMap;
   typedef std::unordered_set<DtUUID*> UUIDsForUpgrade;

   DtObjectIdentificationResolver();

   virtual ~DtObjectIdentificationResolver();

   virtual void clear();

   virtual void setResolveMarkingTextToUUIDMapping(bool);
   virtual bool resolveMarkingTextToUUIDMapping() const;

   virtual void setResolveUUIDToUUIDMapping(bool);

   virtual bool resolveUUIDToUUIDMapping() const;

   virtual void resolveUUIDMapping(bool clearWhenDone = false);

   virtual bool addUUIDForUpgrade(DtUUID*);
   virtual void removeUUIDForUpgrade(DtUUID*);

   virtual void objectUUIDChanged(const DtUUID& oldUUID, const DtUUID& newUUID);

   virtual void objectNameChanged(const DtString& oldName, const DtString& newName, const DtUUID& newNameUUID);

   virtual DtUUIDMarkingTextProvider* addMarkingTextToUUIDMapping(const DtUUIDMarkingTextProvider&, const DtUUID&);
   virtual DtUUIDMarkingTextProvider* uuidToMarkingTextProvider(const DtUUID&) const;

   virtual void removeUUIDToMarkingTextMapping(const DtUUID&);

   virtual void addUUIDToUUIDMapping(const DtUUID& old, const DtUUID& newUUID);

   virtual void addEntityIdentifierToUUIDMapping(const DtString& eid, const DtUUID&);
   virtual void removeEntityIdentifierMapping(const DtString& eid);
   virtual const DtUUID& entityIdentifierToUUIDMapping(const DtString& eid) const;
   virtual const DtString& uuidToEntityIdentifierMapping(const DtUUID& uuid) const;

   virtual bool hasUUID(const DtUUID&) const;

   virtual void addMarkingTextToMarkingTextMapping(const DtString& oldMarkingText, const DtString& newMarkingText);

   virtual DtUUID mapMarkingTextToUUID(const DtString&) const;

   virtual bool hasMarkingText(const DtString&) const;

   virtual DtString mapUUIDToMarkingText(const DtUUID&) const;

   virtual void pushMappingContext();

   virtual void popMappingContext(bool merge = false);

   virtual DtString markingText(const DtUUID&, bool* found = nullptr) const;

   MarkingTextToUUIDMap& markingTextToUUIDMapForImport(int context = -1);
   const MarkingTextToUUIDMap& markingTextToUUIDMapForImport(int context = -1) const;

   MarkingTextToUUIDMap& liveMarkingTextToUUIDMap(int context = -1);
   const MarkingTextToUUIDMap& liveMarkingTextToUUIDMap(int context = -1) const;
   virtual void markingTextUpdated(const DtString& oldText, const DtString& newText);

   UUIDsForUpgrade& uuidsForMarkingTextUpgrade(int context = -1);
   const UUIDsForUpgrade& uuidsForMarkingTextUpgrade(int context = -1) const;

   UUIDsForUpgrade& uuidsForUUIDUpgrade(int context = -1);
   const UUIDsForUpgrade& uuidsForUUIDUpgrade(int context = -1) const;

   UUIDToMarkingTextMap& uuidToMarkingTextMap(int context = -1);
   const UUIDToMarkingTextMap& uuidToMarkingTextMap(int context = -1) const;

   UUIDToUUIDMap& uuidToUUIDMap(int context = -1);
   const UUIDToUUIDMap& uuidToUUIDMap(int context = -1) const;

   MarkingTextToMarkingTextMap& markingTextToMarkingTextMap(int context = -1);
   const MarkingTextToMarkingTextMap& markingTextToMarkingTextMap(int context = -1) const;

   EntityIdentifierToUUIDMap& entityIdentifierToUUIDMap(int context = -1);
   const EntityIdentifierToUUIDMap& entityIdentifierToUUIDMap(int context = -1) const;

   UUIDToEntityIdentifierMap& uuidToEntityIdentifierMap(int context = -1);
   const UUIDToEntityIdentifierMap& uuidToEntityIdentifierMap(int context = -1) const;

   MarkingTextToUUIDMap markingTextToUUIDMap() const;

   virtual void resolveToMarkingTextMapping();

   virtual boost::unordered_map<DtString, DtString> resolveToUUIDMapping(bool clearWhenDone = false);

   virtual DtUUID upgradeUUID(const DtUUID&) const;

   virtual bool hasMarkingTextToUUIDMapForImport(const DtString&) const;

   boost::signals2::signal<void (const DtUUID& oldUUID, const DtUUID& newUUID)> signal_uuidUpgradedTo;

protected:
   struct MappingContext
   {
      UUIDToMarkingTextMap myUUIDToMarkingTextMap;
      EntityIdentifierToUUIDMap myEntityIdentifierToUUIDMap;
      UUIDToEntityIdentifierMap myUUIDToEntityIdentifierMap;
      UUIDToUUIDMap myUUIDToUUIDMap;
      MarkingTextToMarkingTextMap myMarkingTextToMarkingTextMap;
      MarkingTextToUUIDMap myMarkingTextToUUIDMapForImport;
      MarkingTextToUUIDMap myMarkingTextToUUIDMap;

      UUIDsForUpgrade myUUIDsForMarkingTextUpgrade;
      UUIDsForUpgrade myUUIDsForUUIDUpgrade;
   };

   mutable std::recursive_mutex myMutex;

   typedef std::vector<MappingContext> MappingContexts;
   MappingContexts myMappingContexts;
   bool myDestructingFlag;

   mutable bool myResolveMarkingTextToUUIDMapping;
   mutable bool myResolveUUIDToUUIDMapping;
   mutable bool myPushingContext;
   mutable bool myPoppingContext;
};