shared_object.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_HPP
#define CASADI_SHARED_OBJECT_HPP
 
#include "casadi_common.hpp"
#include "exception.hpp"
#include <map>
#include <vector>
 
namespace casadi {
 
  // Forward declaration of weak reference class
  class WeakRef;
 
  // Forward declaration of internal classes
  class SharedObjectInternal;
  class WeakRefInternal;
 
  class CASADI_EXPORT SharedObject {
#ifndef SWIG
    template<class B> friend B shared_cast(SharedObject& A);
    template<class B> friend const B shared_cast(const SharedObject& A);
#endif // SWIG
 
  public:
#ifndef SWIG
    SharedObject();
 
    SharedObject(const SharedObject& ref);
 
    ~SharedObject();
 
    SharedObject& operator=(const SharedObject& ref);
 
    void own(SharedObjectInternal* node);
 
    void assign(SharedObjectInternal* node);
 
    SharedObjectInternal* get() const;
 
    casadi_int getCount() const;
 
    void swap(SharedObject& other);
 
    SharedObjectInternal* operator->() const;
#endif // SWIG
 
    std::string class_name() const;
 
    void disp(std::ostream& stream, bool more=false) const;
 
    std::string get_str(bool more=false) const {
      std::stringstream ss;
      disp(ss, more);
      return ss.str();
    }
 
    void print_ptr(std::ostream &stream=casadi::uout()) const;
 
    bool is_null() const;
 
    casadi_int __hash__() const;
 
#ifndef SWIG
    WeakRef* weak();
  protected:
    void count_up(); // increase counter of the node
    void count_down(); // decrease counter of the node
  private:
    SharedObjectInternal *node;
#endif // SWIG
  };
 
  class CASADI_EXPORT WeakRef : public SharedObject {
  public:
    friend class SharedObjectInternal;
 
    WeakRef(int dummy=0);
 
    WeakRef(SharedObject shared);
 
    SharedObject shared();
 
    bool alive() const;
 
    WeakRefInternal* operator->();
 
    const WeakRefInternal* operator->() const;
 
#ifndef SWIG
  private:
    explicit WeakRef(SharedObjectInternal* raw);
 
    void kill();
#endif // SWIG
  };
 
#ifndef SWIG
 
  template<class B>
  B shared_cast(SharedObject& A) {
 
    SharedObjectInternal* ptr = A.get();
 
    B ret;
 
    if (!B::test_cast(ptr)) return ret;
 
    ret.own(ptr);
    return ret;
  }
 
  template<class B>
  const B shared_cast(const SharedObject& A) {
    SharedObject A_copy = A;
    return shared_cast<B>(A_copy);
  }
 
#endif // SWIG
 
 
} // namespace casadi
 
 
#endif // CASADI_SHARED_OBJECT_HPP