shared_object_internal.hpp

/*
 *    This file is part of CasADi.
 *
 *    CasADi -- A symbolic framework for dynamic optimization.
 *    Copyright (C) 2010-2023 Joel Andersson, Joris Gillis, Moritz Diehl,
 *                            KU Leuven. All rights reserved.
 *    Copyright (C) 2011-2014 Greg Horn
 *
 *    CasADi is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License as published by the Free Software Foundation; either
 *    version 3 of the License, or (at your option) any later version.
 *
 *    CasADi is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *    Lesser General Public License for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with CasADi; if not, write to the Free Software
 *    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 *
 */
 
 
#ifndef CASADI_SHARED_OBJECT_INTERNAL_HPP
#define CASADI_SHARED_OBJECT_INTERNAL_HPP
 
#include "shared_object.hpp"
 
#ifdef CASADI_WITH_THREAD
#include <atomic>
#endif // CASADI_WITH_THREAD
 
namespace casadi {
 
  class CASADI_EXPORT SharedObjectInternal {
    friend class SharedObject;
    friend class Memory;
    friend class UniversalNodeOwner;
  public:
 
    SharedObjectInternal();
 
    SharedObjectInternal(const SharedObjectInternal& node);
 
    SharedObjectInternal& operator=(const SharedObjectInternal& node);
 
    virtual ~SharedObjectInternal() = 0;
 
    casadi_int getCount() const;
 
    virtual std::string class_name() const = 0;
 
    virtual void disp(std::ostream& stream, bool more) const = 0;
 
    WeakRef* weak();
 
  protected:
    void initSingleton() {
      casadi_assert_dev(count==0);
      count++;
    }
 
    void destroySingleton() {
      count--;
    }
 
    template<class B>
    B shared_from_this();
 
    template<class B>
    const B shared_from_this() const;
 
  private:
#ifdef CASADI_WITH_THREAD
    std::atomic<casadi_int> count;
#else // CASADI_WITH_THREAD
    casadi_int count;
#endif
    WeakRef* weak_ref_;
  };
 
  class CASADI_EXPORT WeakRefInternal : public SharedObjectInternal {
  public:
    // Constructor
    WeakRefInternal(SharedObjectInternal* raw);
 
    // Destructor
    ~WeakRefInternal() override;
 
    std::string class_name() const override {return "WeakRefInternal";}
 
    void disp(std::ostream& stream, bool more) const override;
 
    // Raw pointer to the cached object
    SharedObjectInternal* raw_;
  };
 
 
  template<class A>
  A getcopy(const A& a, std::map<SharedObjectInternal*, SharedObject>& already_copied) {
    A ret;
    if (!a.is_null()) {
      std::map<SharedObjectInternal*, SharedObject>::iterator it =
          already_copied.find(const_cast<SharedObjectInternal*>(a.get()));
      if (it!=already_copied.end()) {
        ret.own(it->second.get());
      }
    }
    return ret;
  }
 
  template<class B>
  B SharedObjectInternal::shared_from_this() {
    casadi_assert_dev(B::test_cast(this));
    B ret;
    ret.own(this);
    return ret;
  }
 
  template<class B>
  const B SharedObjectInternal::shared_from_this() const {
    casadi_assert_dev(B::test_cast(this));
    B ret;
    ret.own(const_cast<SharedObjectInternal*>(this));
    return ret;
  }
 
 
} // namespace casadi
 
 
#endif // CASADI_SHARED_OBJECT_INTERNAL_HPP