PlugModificationTracker.h

Go to the documentation of this file.

/*
             *
            ***
           *****
   *********************       Mercenaries Engineering SARL
     *****************              Copyright (C) 2020
       *************
         *********        http://www.mercenaries-engineering.com
        ***********
       ****     ****
      **           **
*/
#pragma once
#include "Impl.h"
#include "Ptr.h"

#include <initializer_list>

namespace maquina
{
  class Plug;
  class PartialInvalidation;
  using PartialInvalidationPtr = Ptr<const PartialInvalidation>;

  class PlugModificationTracker
  {
  public:
    MAQUINA_EXPORT PlugModificationTracker( std::initializer_list<const Plug> plugs );
    MAQUINA_EXPORT PlugModificationTracker() : _implementation{nullptr}{}

    // This constructor and copy operator are deleted as having multiple instances wrapping the same
    // tracker will lead to inconsistencies in is_modified() and reset(), while having another tracker
    // tracking the same plug collection can be done with the given constructors.
    PlugModificationTracker( const PlugModificationTracker& ) = delete;
    PlugModificationTracker& operator=( const PlugModificationTracker& ) = delete;

    PlugModificationTracker( PlugModificationTracker&& other ) : _implementation{ std::move( other._implementation ) } {}
    PlugModificationTracker& operator=( PlugModificationTracker&& other ) {
      _implementation = std::move(other._implementation);
      return *this;
    }

    ~PlugModificationTracker() = default;

    MAQUINA_EXPORT bool is_modified() const;

    MAQUINA_EXPORT PartialInvalidationPtr partial_invalidation() const;

    MAQUINA_EXPORT void touch();

    MAQUINA_EXPORT void reset();

  private:
    std::unique_ptr<Impl> _implementation;
  };
}