read_write_monitor_handle.h

//
// Copyright (c) 2014 Limit Point Systems, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//

// Interface for class read_write_monitor_handle

#ifndef READ_WRITE_MONITOR_HANDLE_H
#define READ_WRITE_MONITOR_HANDLE_H

#ifndef SHEAF_DLL_SPEC_H
#include "SheafSystem/sheaf_dll_spec.h"
#endif

#ifndef ANY_H
#include "SheafSystem/any.h"
#endif

// class read_write_monitor;

#ifndef READ_WRITE_MONITOR_H
#include "SheafSystem/read_write_monitor.h"
#endif

namespace sheaf
{
  
class SHEAF_DLL_SPEC read_write_monitor_handle : public any
{

public:

  virtual bool is_ancestor_of(const any* xother) const;


  virtual read_write_monitor_handle* clone() const;

  virtual ~read_write_monitor_handle();

  // ===========================================================
  // ===========================================================

public:

  static bool access_control_disabled();

  //   ///
  //   /// Disables access control.
  //   /// Disabled (true) is equivalent to having read-write access
  //   /// at all times, irrespective of any access control requests.
  //   /// Synonym for read_write_monitor::disable_access_control().
  //   /// Should only be invoked once at beginning of a program, before any
  //   /// other SheafSystem calls. Once disabled, access control can not be re-enabled.
  //   ///
  //   static void disable_access_control();

  static void enable_access_control();

protected:

private:


public:

  // ===========================================================
  // PER-THREAD STATE ACCESS CONTROL FACET
  // ===========================================================

  virtual bool is_attached() const;

  bool state_is_read_only_accessible() const;

  bool state_is_not_read_only_accessible() const;

  bool state_is_read_accessible() const;

  bool state_is_not_read_accessible() const;

  bool state_is_auto_read_accessible(bool xauto_access) const;

  bool state_is_read_write_accessible() const;

  bool state_is_not_read_write_accessible() const;

  bool state_is_auto_read_write_accessible(bool xauto_access) const;

  int access_request_depth() const;

  virtual void get_read_access() const;

  virtual void get_read_write_access(bool xrelease_read_only_access = false);

  virtual void release_access(bool xall = false) const;

  // ===========================================================
  // MODE LOCK CONTROL FACET
  // ===========================================================

  bool state_is_mode_locked() const;

  int mode_lock_ct() const;

  void get_mode_lock() const;

  void release_mode_lock();

  // ===========================================================
  // NOTIFICATION FACET
  // ===========================================================

  bool state_is_modified() const;

  void clear_state_is_modified();

protected:

  virtual read_write_monitor* state_obj() const = 0;

  inline bool access_guards_disabled() const
  {
    return state_obj()->access_guards_disabled();
  };

  inline void disable_access_guards()
  {
    state_obj()->disable_access_guards();
  };

  inline void enable_access_guards()
  {
    state_obj()->enable_access_guards();
  };
};

} // namespace sheaf

#endif // ifndef READ_WRITE_MONITOR_HANDLE_H