Add skia::RefPtr class to wrap ref counted classes from Skia.

skia/ext/refptr.h

Index: skia/ext/refptr.h
diff --git a/skia/ext/refptr.h b/skia/ext/refptr.h
new file mode 100644
index 0000000000000000000000000000000000000000..795f4fea59846f21cc7d82b200f044daee44d6c7
--- /dev/null
+++ b/skia/ext/refptr.h
@@ -0,0 +1,98 @@
+// Copyright 2012 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+#ifndef SKIA_EXT_REFPTR_H_
+#define SKIA_EXT_REFPTR_H_
+
+#include "third_party/skia/include/core/SkRefCnt.h"
+
+namespace skia {
+
+// When creating/receiving a ref-counted pointer from Skia, wrap that pointer in
+// this class to avoid dealing with the ref-counting and prevent leaks/crashes
+// due to ref-counting bugs.
+//
+// Example of Creating an SkShader* and setting it on a SkPaint:
+//   skia::RefPtr<SkShader> shader = skia::AdoptRef(SkGradientShader::Create());
+//   paint.setShader(shader.get());
+//
+// When passing around a ref-counted pointer to methods outside of Skia, always
+// pass around the skia::RefPtr instead of the raw pointer. An example method
+// that takes a SkShader* parameter and saves the SkShader* in the class.
+//   void AMethodThatSavesAShader(const skia::RefPtr<SkShader>& shader) {
+//     member_refptr_ = shader;
+//   }
+//   skia::RefPtr<SkShader> member_refptr_;
+//
+// When returning a ref-counted ponter, also return the skia::RefPtr instead. An
+// example method that creates an SkShader* and returns it:
+//   skia::RefPtr<SkShader> MakeAShader() {
+//     return skia::AdoptRef(SkGradientShader::Create());
+//   }
+//
+// Never call ref() or unref() on the underlying ref-counted pointer. If you
+// wrap the raw pointer immediately in a skia::RefPtr and always work with
+// skia::RefPtr instances instead, the ref-counting will be taken care of for
+// you.
+template<typename T>
+class RefPtr {
+ public:
+  RefPtr() : ptr_(NULL) {}
+
+  RefPtr(const RefPtr<T>& other)

[awong, 2012/11/30 00:10:25]

Remove the <T>

[danakj, 2012/11/30 00:25:09]

Done.

+      : ptr_(other.get()) {
+    SkSafeRef(ptr_);
+  }
+
+  template<typename U>
+  RefPtr(const RefPtr<U>& other)
+      : ptr_(other.get()) {
+    SkSafeRef(ptr_);
+  }
+
+  ~RefPtr() {
+    clear();
+  }
+
+  RefPtr& operator=(const RefPtr<T>& other) {

[awong, 2012/11/30 00:10:25]

Remove the <T>

[danakj, 2012/11/30 00:25:09]

Done.

+    SkRefCnt_SafeAssign(ptr_, other.get());
+    return *this;
+  }
+
+  template<typename U>
+  RefPtr& operator=(const RefPtr<U>& other) {
+    SkRefCnt_SafeAssign(ptr_, other.get());
+    return *this;
+  }
+
+  void clear() {
+    T* to_unref = ptr_;
+    ptr_ = NULL;
+    SkSafeUnref(to_unref);
+  }
+
+  T* get() const { return ptr_; }
+  T& operator*() const { return static_cast<T&>(*ptr_); }

[awong, 2012/11/30 00:10:25]

Why are we doing a static_cast<>?

[danakj, 2012/11/30 00:25:09]

oh, i was toying with hiding ref() and unref() in the T* when returning it here.
I'll remove those.

+  T* operator->() const { return static_cast<T*>(ptr_); }
+
+  typedef T* RefPtr::*unspecified_bool_type;
+  operator unspecified_bool_type() const {
+    return ptr_ ? &RefPtr::ptr_ : NULL;
+  }
+
+ private:
+  T* ptr_;
+
+  explicit RefPtr(T* ptr) : ptr_(ptr) {}
+
+  template<typename U>
+  friend RefPtr<U> AdoptRef(U* ptr);
+};
+
+template<typename T>
+RefPtr<T> AdoptRef(T* ptr) { return RefPtr<T>(ptr); }
+
+}  // namespace skia
+
+#endif  // SKIA_EXT_REFPTR_H_