cannam@134: // Copyright (c) 2013-2014 Sandstorm Development Group, Inc. and contributors
cannam@134: // Licensed under the MIT License:
cannam@134: //
cannam@134: // Permission is hereby granted, free of charge, to any person obtaining a copy
cannam@134: // of this software and associated documentation files (the "Software"), to deal
cannam@134: // in the Software without restriction, including without limitation the rights
cannam@134: // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
cannam@134: // copies of the Software, and to permit persons to whom the Software is
cannam@134: // furnished to do so, subject to the following conditions:
cannam@134: //
cannam@134: // The above copyright notice and this permission notice shall be included in
cannam@134: // all copies or substantial portions of the Software.
cannam@134: //
cannam@134: // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
cannam@134: // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
cannam@134: // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
cannam@134: // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
cannam@134: // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
cannam@134: // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
cannam@134: // THE SOFTWARE.
cannam@134: 
cannam@134: #include "memory.h"
cannam@134: 
cannam@134: #ifndef KJ_REFCOUNT_H_
cannam@134: #define KJ_REFCOUNT_H_
cannam@134: 
cannam@134: #if defined(__GNUC__) && !KJ_HEADER_WARNINGS
cannam@134: #pragma GCC system_header
cannam@134: #endif
cannam@134: 
cannam@134: namespace kj {
cannam@134: 
cannam@134: class Refcounted: private Disposer {
cannam@134:   // Subclass this to create a class that contains a reference count. Then, use
cannam@134:   // `kj::refcounted<T>()` to allocate a new refcounted pointer.
cannam@134:   //
cannam@134:   // Do NOT use this lightly.  Refcounting is a crutch.  Good designs should strive to make object
cannam@134:   // ownership clear, so that refcounting is not necessary.  All that said, reference counting can
cannam@134:   // sometimes simplify code that would otherwise become convoluted with explicit ownership, even
cannam@134:   // when ownership relationships are clear at an abstract level.
cannam@134:   //
cannam@134:   // NOT THREADSAFE:  This refcounting implementation assumes that an object's references are
cannam@134:   // manipulated only in one thread, because atomic (thread-safe) refcounting is surprisingly slow.
cannam@134:   //
cannam@134:   // In general, abstract classes should _not_ subclass this.  The concrete class at the bottom
cannam@134:   // of the hierarchy should be the one to decide how it implements refcounting.  Interfaces should
cannam@134:   // expose only an `addRef()` method that returns `Own<InterfaceType>`.  There are two reasons for
cannam@134:   // this rule:
cannam@134:   // 1. Interfaces would need to virtually inherit Refcounted, otherwise two refcounted interfaces
cannam@134:   //    could not be inherited by the same subclass.  Virtual inheritance is awkward and
cannam@134:   //    inefficient.
cannam@134:   // 2. An implementation may decide that it would rather return a copy than a refcount, or use
cannam@134:   //    some other strategy.
cannam@134:   //
cannam@134:   // TODO(cleanup):  Rethink above.  Virtual inheritance is not necessarily that bad.  OTOH, a
cannam@134:   //   virtual function call for every refcount is sad in its own way.  A Ref<T> type to replace
cannam@134:   //   Own<T> could also be nice.
cannam@134: 
cannam@134: public:
cannam@134:   virtual ~Refcounted() noexcept(false);
cannam@134: 
cannam@134:   inline bool isShared() const { return refcount > 1; }
cannam@134:   // Check if there are multiple references to this object. This is sometimes useful for deciding
cannam@134:   // whether it's safe to modify the object vs. make a copy.
cannam@134: 
cannam@134: private:
cannam@134:   mutable uint refcount = 0;
cannam@134:   // "mutable" because disposeImpl() is const.  Bleh.
cannam@134: 
cannam@134:   void disposeImpl(void* pointer) const override;
cannam@134:   template <typename T>
cannam@134:   static Own<T> addRefInternal(T* object);
cannam@134: 
cannam@134:   template <typename T>
cannam@134:   friend Own<T> addRef(T& object);
cannam@134:   template <typename T, typename... Params>
cannam@134:   friend Own<T> refcounted(Params&&... params);
cannam@134: };
cannam@134: 
cannam@134: template <typename T, typename... Params>
cannam@134: inline Own<T> refcounted(Params&&... params) {
cannam@134:   // Allocate a new refcounted instance of T, passing `params` to its constructor.  Returns an
cannam@134:   // initial reference to the object.  More references can be created with `kj::addRef()`.
cannam@134: 
cannam@134:   return Refcounted::addRefInternal(new T(kj::fwd<Params>(params)...));
cannam@134: }
cannam@134: 
cannam@134: template <typename T>
cannam@134: Own<T> addRef(T& object) {
cannam@134:   // Return a new reference to `object`, which must subclass Refcounted and have been allocated
cannam@134:   // using `kj::refcounted<>()`.  It is suggested that subclasses implement a non-static addRef()
cannam@134:   // method which wraps this and returns the appropriate type.
cannam@134: 
cannam@134:   KJ_IREQUIRE(object.Refcounted::refcount > 0, "Object not allocated with kj::refcounted().");
cannam@134:   return Refcounted::addRefInternal(&object);
cannam@134: }
cannam@134: 
cannam@134: template <typename T>
cannam@134: Own<T> Refcounted::addRefInternal(T* object) {
cannam@134:   Refcounted* refcounted = object;
cannam@134:   ++refcounted->refcount;
cannam@134:   return Own<T>(object, *refcounted);
cannam@134: }
cannam@134: 
cannam@134: }  // namespace kj
cannam@134: 
cannam@134: #endif  // KJ_REFCOUNT_H_