CollectionImpl.h

// -*- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature -*-
//-----------------------------------------------------------------------------
// Copyright 2000-2022 CEA (www.cea.fr) IFPEN (www.ifpenergiesnouvelles.com)
// See the top-level COPYRIGHT file for details.
// SPDX-License-Identifier: Apache-2.0
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* CollectionImpl.h                                            (C) 2000-2022 */
/*                                                                           */
/* Implémentation de la classe de base d'une collection.                     */
/*---------------------------------------------------------------------------*/
#ifndef ARCANE_UTILS_COLLECTIONIMPL_H
#define ARCANE_UTILS_COLLECTIONIMPL_H
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arcane/utils/ObjectImpl.h"
#include "arcane/utils/Iostream.h"
#include "arcane/utils/Event.h"
 
#include <algorithm>
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
class EnumeratorImplBase;
 
extern "C" ARCANE_UTILS_EXPORT void throwOutOfRangeException();
extern "C" ARCANE_UTILS_EXPORT void throwNullReference();
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
class CollectionEventArgs
{
 public:
 
  enum eAction
  {
    ClearComplete,
    InsertComplete,
    RemoveComplete,
    SetComplete
  };
 
 public:
 
  CollectionEventArgs(eAction aaction, void* aobject, Integer aposition)
  : m_action(aaction)
  , m_object(aobject)
  , m_position(aposition)
  {}
 
 public:
 
  eAction action() const { return m_action; }
  void* object() const { return m_object; }
  Integer position() const { return m_position; }
 
 private:
 
  eAction m_action;
  void* m_object;
  Integer m_position;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
typedef EventObservable<const CollectionEventArgs&> CollectionChangeEventHandler;
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
class CollectionImplBase
: public ObjectImpl
{
 public:
 
  typedef Integer size_type;
  typedef ptrdiff_t difference_type;
 
 public:
 
  CollectionImplBase() = default;
  explicit CollectionImplBase(Integer acount)
  : m_count(acount)
  {}
  CollectionImplBase(const CollectionImplBase& from) = delete;
 
 public:
 
  Integer count() const { return m_count; }
  virtual void clear() = 0;
 
 public:
 
  virtual void onClear() {}
  virtual void onClearComplete()
  {
    _sendEvent(CollectionEventArgs::ClearComplete, 0, 0);
  }
  virtual void onInsert() {}
  virtual void onInsertComplete(void* object, Integer position)
  {
    _sendEvent(CollectionEventArgs::InsertComplete, object, position);
  }
  virtual void onRemove() {}
  virtual void onRemoveComplete(void* object, Integer position)
  {
    _sendEvent(CollectionEventArgs::RemoveComplete, object, position);
  }
  virtual void onSet() {}
  virtual void onSetComplete(void* object, Integer position)
  {
    _sendEvent(CollectionEventArgs::SetComplete, object, position);
  }
  virtual void onValidate() {}
 
 public:
 
  virtual EnumeratorImplBase* enumerator() const = 0;
 
 public:
 
  CollectionChangeEventHandler& change() { return m_collection_handlers; }
 
 protected:
 
  void _setCount(Integer acount) { m_count = acount; }
 
 private:
 
  Integer m_count = 0;
  CollectionChangeEventHandler m_collection_handlers;
 
 private:
 
  void _sendEvent(CollectionEventArgs::eAction action, void* object, Integer position)
  {
    CollectionEventArgs args(action, object, position);
    m_collection_handlers.notify(args);
  }
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
template <class T>
class CollectionImplT
: public CollectionImplBase
{
 public:
 
  typedef const T& ObjectRef;
  typedef T* ObjectIterator;
  typedef const T* ConstObjectIterator;
 
 public:
 
  CollectionImplT()
  : CollectionImplBase()
  {}
  virtual ~CollectionImplT() {}
 
 public:
 
  virtual ObjectIterator begin() = 0;
  virtual const T* begin() const = 0;
  virtual ObjectIterator end() = 0;
  virtual const T* end() const = 0;
 
  virtual T* begin2() const = 0;
  virtual T* end2() const = 0;
 
 public:
 
  template <class Function> Function
  each(Function f)
  {
    std::for_each(begin(), end(), f);
    return f;
  }
 
 public:
 
  virtual void add(ObjectRef value) = 0;
  virtual bool remove(ObjectRef value) = 0;
  virtual void removeAt(Integer index) = 0;
  virtual bool contains(ObjectRef value) const = 0;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // namespace Arcane
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#endif