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 "generic_shared_internal.hpp"
 
namespace casadi {
 
  // Forward declaration of internal classes
  class SharedObjectInternal;
  class WeakRefInternal;
 
  class CASADI_EXPORT SharedObject :
      public GenericShared<SharedObject, SharedObjectInternal> {
    public:
 
      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;
 
      using internal_base_type = SharedObjectInternal;
      using base_type = SharedObject;
 
  };
 
  class CASADI_EXPORT WeakRef :
      public GenericWeakRef<SharedObject, SharedObjectInternal> {
  public:
    WeakRef(int dummy=0) : GenericWeakRef<SharedObject, SharedObjectInternal>(dummy) {
    }
    WeakRef(SharedObject shared) : GenericWeakRef<SharedObject, SharedObjectInternal>(shared) {
    }
  /*private:
    explicit WeakRef(SharedObjectInternal* raw) : GenericWeakRef<SharedObject, SharedObjectInternal>(raw) {
    };*/
  };
 
#ifndef SWIG
  class CASADI_EXPORT SharedObjectInternal :
    public GenericSharedInternal<SharedObject, SharedObjectInternal> {
    friend class GenericShared<SharedObject, SharedObjectInternal>;
    friend class SharedObject;
    friend class GenericWeakRef<SharedObject, SharedObjectInternal>;
    friend class GenericSharedInternal<SharedObject, SharedObjectInternal>;
    friend class Memory;
    friend class UniversalNodeOwner;
  public:
    SharedObjectInternal() : GenericSharedInternal<SharedObject, SharedObjectInternal>() {
    }
    SharedObjectInternal(const SharedObjectInternal& node) :
      GenericSharedInternal<SharedObject, SharedObjectInternal>(node) {
    }
 
    virtual std::string class_name() const = 0;
 
    virtual void disp(std::ostream& stream, bool more) const = 0;
 
    using weak_ref_type = WeakRefInternal;
 
  private:
#ifdef CASADI_WITH_THREAD
    std::atomic<casadi_int> count;
#else // CASADI_WITH_THREAD
    casadi_int count;
#endif
 
  };
 
  class CASADI_EXPORT WeakRefInternal :
      public GenericWeakRefInternal<SharedObject, SharedObjectInternal> {
    public:
    void disp(std::ostream& stream, bool more) const override;
 
    std::string class_name() const override {return "WeakRefInternal";}
 
    using GenericWeakRefInternal<SharedObject, SharedObjectInternal>::GenericWeakRefInternal;
 
  };
 
 
#endif // SWIG
 
} // namespace casadi
 
#endif // CASADI_SHARED_OBJECT_HPP