wrapper for common subset of auto_ptr and unique_ptr API












1












$begingroup$


I read an interesting old question on the Software Engineering SE about how to transition away from std::auto_ptr. So I wrote a wrapper around the common subset of std::auto_ptr and std::unique_ptr.



The wrapper's mission in life at runtime is to clean up pointers created with new when the scope ends regardless of how the scope is exited. Its job at compile time is to make compilation fail as informatively as possible when fake_autoptr is used in a non-lowest-common-denominator way.



fake_autoptr is supposed to make it easier to transition away from std::auto_ptr and support both C++11 and C++03 until support for C++03 is dropped. It should behave the same way whether it is backed by an auto_ptr or a unique_ptr.



The example given in the old question is this. This example is not leveraging many of the things that an autoptr can do. I think, but am not 100% certain that the autoptr's job here is just to run delete when its destructor is called and not to steal resources from other autoptrs.



// NOT MINE DO NOT REVIEW

Foo* GetFoo()
{
autoptr<Foo> ptr(new Foo);

// Initialize Foo
ptr->Initialize(...);

// Now configure remaining attributes
ptr->SomeSetting(...);

return ptr.release();
}


Here is the wrapper I came up with.



#ifndef FAKE_AUTOPTR_FAKE_AUTOPTR_INCLUDED
#define FAKE_AUTOPTR_FAKE_AUTOPTR_INCLUDED 1

#include <memory>
#if __cplusplus >= 201103L
#include <type_traits>
#endif

namespace fake_autoptr_ns {
namespace detail {
template <class T>
void destroy(T* goner) {
delete goner;
}
}

template <class T>
class fake_autoptr {
public:
#if __cplusplus >= 201103L
std::unique_ptr<T, decltype(&detail::destroy<T>)> smartptr_;
typedef decltype(smartptr_) smartptr_type;
#else
std::auto_ptr<T> smartptr_;
typedef std::auto_ptr<T> smartptr_type;
#endif


#if __cplusplus >= 201103L
fake_autoptr() = delete;
~fake_autoptr() = default;
#else
private:
fake_autoptr();
public:
#endif


#if __cplusplus >= 201103L
template <class CtorArg>
explicit fake_autoptr(CtorArg something) : smartptr_(something, detail::destroy<T>) {
static_assert(std::is_same<T*, CtorArg>::value, "constructor argument must be T*");
}
#else
template <class CtorArg>
explicit fake_autoptr(CtorArg something) : smartptr_(something) {}
#endif


// delete special member functions
#if __cplusplus >= 201103L
explicit fake_autoptr(const fake_autoptr<T>&) = delete;
explicit fake_autoptr(fake_autoptr<T>&&) = delete;
fake_autoptr& operator=(const fake_autoptr<T>&) = delete;
fake_autoptr& operator=(fake_autoptr<T> &&) = delete;
#else
private:
explicit fake_autoptr(const fake_autoptr<T>&);
fake_autoptr& operator=(const fake_autoptr<T>&);
public:
#endif

#if __cplusplus >= 201103L
T& operator*() = delete;
T* get() = delete;
#endif

const smartptr_type& operator->() const {
return smartptr_;
}

smartptr_type& operator->() {
return smartptr_;
}

T* release() {
return smartptr_.release();
}

#if __cplusplus >= 201103L
const T* release() const = delete;

void reset() = delete;

void reset() const = delete;
#endif
};
}

#endif // FAKE_AUTOPTR_FAKE_AUTOPTR_INCLUDED


This is less interesting, but here's a smoke test to make sure it works



#include "fake_autoptr.hpp"
#include <cstdio>

struct TwoInts {
int int1;
int int2;
void print_first_int() {
printf("1st %dn", int1);
}
void print_second_int() {
printf("2nd %dn", int2);
}
};


TwoInts* GetInt()
{
using namespace fake_autoptr_ns;
TwoInts *t = new TwoInts();
t->int1 = 3;
t->int2 = 7;
fake_autoptr<TwoInts> ptr(t);
ptr->print_first_int();
ptr->print_second_int();
return ptr.release();
}

int main() {
TwoInts *t = GetInt();
delete t;
return 0;
}









share|improve this question











$endgroup$












  • $begingroup$
    Can you explain your use-case better? When would I want to use fake_autoptr<T> in preference to std::unique_ptr<T>? The only advantage to std::auto_ptr is that it compiles as C++03... but your fake_autoptr is C++11-only, so that's not why you're using it. Why not just use std::unique_ptr?
    $endgroup$
    – Quuxplusone
    2 hours ago










  • $begingroup$
    @Quuxplusone, I've edited the code so it compiles as either C++11 or C++03 ...
    $endgroup$
    – Gregory Nisbet
    1 hour ago
















1












$begingroup$


I read an interesting old question on the Software Engineering SE about how to transition away from std::auto_ptr. So I wrote a wrapper around the common subset of std::auto_ptr and std::unique_ptr.



The wrapper's mission in life at runtime is to clean up pointers created with new when the scope ends regardless of how the scope is exited. Its job at compile time is to make compilation fail as informatively as possible when fake_autoptr is used in a non-lowest-common-denominator way.



fake_autoptr is supposed to make it easier to transition away from std::auto_ptr and support both C++11 and C++03 until support for C++03 is dropped. It should behave the same way whether it is backed by an auto_ptr or a unique_ptr.



The example given in the old question is this. This example is not leveraging many of the things that an autoptr can do. I think, but am not 100% certain that the autoptr's job here is just to run delete when its destructor is called and not to steal resources from other autoptrs.



// NOT MINE DO NOT REVIEW

Foo* GetFoo()
{
autoptr<Foo> ptr(new Foo);

// Initialize Foo
ptr->Initialize(...);

// Now configure remaining attributes
ptr->SomeSetting(...);

return ptr.release();
}


Here is the wrapper I came up with.



#ifndef FAKE_AUTOPTR_FAKE_AUTOPTR_INCLUDED
#define FAKE_AUTOPTR_FAKE_AUTOPTR_INCLUDED 1

#include <memory>
#if __cplusplus >= 201103L
#include <type_traits>
#endif

namespace fake_autoptr_ns {
namespace detail {
template <class T>
void destroy(T* goner) {
delete goner;
}
}

template <class T>
class fake_autoptr {
public:
#if __cplusplus >= 201103L
std::unique_ptr<T, decltype(&detail::destroy<T>)> smartptr_;
typedef decltype(smartptr_) smartptr_type;
#else
std::auto_ptr<T> smartptr_;
typedef std::auto_ptr<T> smartptr_type;
#endif


#if __cplusplus >= 201103L
fake_autoptr() = delete;
~fake_autoptr() = default;
#else
private:
fake_autoptr();
public:
#endif


#if __cplusplus >= 201103L
template <class CtorArg>
explicit fake_autoptr(CtorArg something) : smartptr_(something, detail::destroy<T>) {
static_assert(std::is_same<T*, CtorArg>::value, "constructor argument must be T*");
}
#else
template <class CtorArg>
explicit fake_autoptr(CtorArg something) : smartptr_(something) {}
#endif


// delete special member functions
#if __cplusplus >= 201103L
explicit fake_autoptr(const fake_autoptr<T>&) = delete;
explicit fake_autoptr(fake_autoptr<T>&&) = delete;
fake_autoptr& operator=(const fake_autoptr<T>&) = delete;
fake_autoptr& operator=(fake_autoptr<T> &&) = delete;
#else
private:
explicit fake_autoptr(const fake_autoptr<T>&);
fake_autoptr& operator=(const fake_autoptr<T>&);
public:
#endif

#if __cplusplus >= 201103L
T& operator*() = delete;
T* get() = delete;
#endif

const smartptr_type& operator->() const {
return smartptr_;
}

smartptr_type& operator->() {
return smartptr_;
}

T* release() {
return smartptr_.release();
}

#if __cplusplus >= 201103L
const T* release() const = delete;

void reset() = delete;

void reset() const = delete;
#endif
};
}

#endif // FAKE_AUTOPTR_FAKE_AUTOPTR_INCLUDED


This is less interesting, but here's a smoke test to make sure it works



#include "fake_autoptr.hpp"
#include <cstdio>

struct TwoInts {
int int1;
int int2;
void print_first_int() {
printf("1st %dn", int1);
}
void print_second_int() {
printf("2nd %dn", int2);
}
};


TwoInts* GetInt()
{
using namespace fake_autoptr_ns;
TwoInts *t = new TwoInts();
t->int1 = 3;
t->int2 = 7;
fake_autoptr<TwoInts> ptr(t);
ptr->print_first_int();
ptr->print_second_int();
return ptr.release();
}

int main() {
TwoInts *t = GetInt();
delete t;
return 0;
}









share|improve this question











$endgroup$












  • $begingroup$
    Can you explain your use-case better? When would I want to use fake_autoptr<T> in preference to std::unique_ptr<T>? The only advantage to std::auto_ptr is that it compiles as C++03... but your fake_autoptr is C++11-only, so that's not why you're using it. Why not just use std::unique_ptr?
    $endgroup$
    – Quuxplusone
    2 hours ago










  • $begingroup$
    @Quuxplusone, I've edited the code so it compiles as either C++11 or C++03 ...
    $endgroup$
    – Gregory Nisbet
    1 hour ago














1












1








1





$begingroup$


I read an interesting old question on the Software Engineering SE about how to transition away from std::auto_ptr. So I wrote a wrapper around the common subset of std::auto_ptr and std::unique_ptr.



The wrapper's mission in life at runtime is to clean up pointers created with new when the scope ends regardless of how the scope is exited. Its job at compile time is to make compilation fail as informatively as possible when fake_autoptr is used in a non-lowest-common-denominator way.



fake_autoptr is supposed to make it easier to transition away from std::auto_ptr and support both C++11 and C++03 until support for C++03 is dropped. It should behave the same way whether it is backed by an auto_ptr or a unique_ptr.



The example given in the old question is this. This example is not leveraging many of the things that an autoptr can do. I think, but am not 100% certain that the autoptr's job here is just to run delete when its destructor is called and not to steal resources from other autoptrs.



// NOT MINE DO NOT REVIEW

Foo* GetFoo()
{
autoptr<Foo> ptr(new Foo);

// Initialize Foo
ptr->Initialize(...);

// Now configure remaining attributes
ptr->SomeSetting(...);

return ptr.release();
}


Here is the wrapper I came up with.



#ifndef FAKE_AUTOPTR_FAKE_AUTOPTR_INCLUDED
#define FAKE_AUTOPTR_FAKE_AUTOPTR_INCLUDED 1

#include <memory>
#if __cplusplus >= 201103L
#include <type_traits>
#endif

namespace fake_autoptr_ns {
namespace detail {
template <class T>
void destroy(T* goner) {
delete goner;
}
}

template <class T>
class fake_autoptr {
public:
#if __cplusplus >= 201103L
std::unique_ptr<T, decltype(&detail::destroy<T>)> smartptr_;
typedef decltype(smartptr_) smartptr_type;
#else
std::auto_ptr<T> smartptr_;
typedef std::auto_ptr<T> smartptr_type;
#endif


#if __cplusplus >= 201103L
fake_autoptr() = delete;
~fake_autoptr() = default;
#else
private:
fake_autoptr();
public:
#endif


#if __cplusplus >= 201103L
template <class CtorArg>
explicit fake_autoptr(CtorArg something) : smartptr_(something, detail::destroy<T>) {
static_assert(std::is_same<T*, CtorArg>::value, "constructor argument must be T*");
}
#else
template <class CtorArg>
explicit fake_autoptr(CtorArg something) : smartptr_(something) {}
#endif


// delete special member functions
#if __cplusplus >= 201103L
explicit fake_autoptr(const fake_autoptr<T>&) = delete;
explicit fake_autoptr(fake_autoptr<T>&&) = delete;
fake_autoptr& operator=(const fake_autoptr<T>&) = delete;
fake_autoptr& operator=(fake_autoptr<T> &&) = delete;
#else
private:
explicit fake_autoptr(const fake_autoptr<T>&);
fake_autoptr& operator=(const fake_autoptr<T>&);
public:
#endif

#if __cplusplus >= 201103L
T& operator*() = delete;
T* get() = delete;
#endif

const smartptr_type& operator->() const {
return smartptr_;
}

smartptr_type& operator->() {
return smartptr_;
}

T* release() {
return smartptr_.release();
}

#if __cplusplus >= 201103L
const T* release() const = delete;

void reset() = delete;

void reset() const = delete;
#endif
};
}

#endif // FAKE_AUTOPTR_FAKE_AUTOPTR_INCLUDED


This is less interesting, but here's a smoke test to make sure it works



#include "fake_autoptr.hpp"
#include <cstdio>

struct TwoInts {
int int1;
int int2;
void print_first_int() {
printf("1st %dn", int1);
}
void print_second_int() {
printf("2nd %dn", int2);
}
};


TwoInts* GetInt()
{
using namespace fake_autoptr_ns;
TwoInts *t = new TwoInts();
t->int1 = 3;
t->int2 = 7;
fake_autoptr<TwoInts> ptr(t);
ptr->print_first_int();
ptr->print_second_int();
return ptr.release();
}

int main() {
TwoInts *t = GetInt();
delete t;
return 0;
}









share|improve this question











$endgroup$




I read an interesting old question on the Software Engineering SE about how to transition away from std::auto_ptr. So I wrote a wrapper around the common subset of std::auto_ptr and std::unique_ptr.



The wrapper's mission in life at runtime is to clean up pointers created with new when the scope ends regardless of how the scope is exited. Its job at compile time is to make compilation fail as informatively as possible when fake_autoptr is used in a non-lowest-common-denominator way.



fake_autoptr is supposed to make it easier to transition away from std::auto_ptr and support both C++11 and C++03 until support for C++03 is dropped. It should behave the same way whether it is backed by an auto_ptr or a unique_ptr.



The example given in the old question is this. This example is not leveraging many of the things that an autoptr can do. I think, but am not 100% certain that the autoptr's job here is just to run delete when its destructor is called and not to steal resources from other autoptrs.



// NOT MINE DO NOT REVIEW

Foo* GetFoo()
{
autoptr<Foo> ptr(new Foo);

// Initialize Foo
ptr->Initialize(...);

// Now configure remaining attributes
ptr->SomeSetting(...);

return ptr.release();
}


Here is the wrapper I came up with.



#ifndef FAKE_AUTOPTR_FAKE_AUTOPTR_INCLUDED
#define FAKE_AUTOPTR_FAKE_AUTOPTR_INCLUDED 1

#include <memory>
#if __cplusplus >= 201103L
#include <type_traits>
#endif

namespace fake_autoptr_ns {
namespace detail {
template <class T>
void destroy(T* goner) {
delete goner;
}
}

template <class T>
class fake_autoptr {
public:
#if __cplusplus >= 201103L
std::unique_ptr<T, decltype(&detail::destroy<T>)> smartptr_;
typedef decltype(smartptr_) smartptr_type;
#else
std::auto_ptr<T> smartptr_;
typedef std::auto_ptr<T> smartptr_type;
#endif


#if __cplusplus >= 201103L
fake_autoptr() = delete;
~fake_autoptr() = default;
#else
private:
fake_autoptr();
public:
#endif


#if __cplusplus >= 201103L
template <class CtorArg>
explicit fake_autoptr(CtorArg something) : smartptr_(something, detail::destroy<T>) {
static_assert(std::is_same<T*, CtorArg>::value, "constructor argument must be T*");
}
#else
template <class CtorArg>
explicit fake_autoptr(CtorArg something) : smartptr_(something) {}
#endif


// delete special member functions
#if __cplusplus >= 201103L
explicit fake_autoptr(const fake_autoptr<T>&) = delete;
explicit fake_autoptr(fake_autoptr<T>&&) = delete;
fake_autoptr& operator=(const fake_autoptr<T>&) = delete;
fake_autoptr& operator=(fake_autoptr<T> &&) = delete;
#else
private:
explicit fake_autoptr(const fake_autoptr<T>&);
fake_autoptr& operator=(const fake_autoptr<T>&);
public:
#endif

#if __cplusplus >= 201103L
T& operator*() = delete;
T* get() = delete;
#endif

const smartptr_type& operator->() const {
return smartptr_;
}

smartptr_type& operator->() {
return smartptr_;
}

T* release() {
return smartptr_.release();
}

#if __cplusplus >= 201103L
const T* release() const = delete;

void reset() = delete;

void reset() const = delete;
#endif
};
}

#endif // FAKE_AUTOPTR_FAKE_AUTOPTR_INCLUDED


This is less interesting, but here's a smoke test to make sure it works



#include "fake_autoptr.hpp"
#include <cstdio>

struct TwoInts {
int int1;
int int2;
void print_first_int() {
printf("1st %dn", int1);
}
void print_second_int() {
printf("2nd %dn", int2);
}
};


TwoInts* GetInt()
{
using namespace fake_autoptr_ns;
TwoInts *t = new TwoInts();
t->int1 = 3;
t->int2 = 7;
fake_autoptr<TwoInts> ptr(t);
ptr->print_first_int();
ptr->print_second_int();
return ptr.release();
}

int main() {
TwoInts *t = GetInt();
delete t;
return 0;
}






c++ c++11 pointers c++03






share|improve this question















share|improve this question













share|improve this question




share|improve this question








edited 19 mins ago







Gregory Nisbet

















asked 5 hours ago









Gregory NisbetGregory Nisbet

133111




133111












  • $begingroup$
    Can you explain your use-case better? When would I want to use fake_autoptr<T> in preference to std::unique_ptr<T>? The only advantage to std::auto_ptr is that it compiles as C++03... but your fake_autoptr is C++11-only, so that's not why you're using it. Why not just use std::unique_ptr?
    $endgroup$
    – Quuxplusone
    2 hours ago










  • $begingroup$
    @Quuxplusone, I've edited the code so it compiles as either C++11 or C++03 ...
    $endgroup$
    – Gregory Nisbet
    1 hour ago


















  • $begingroup$
    Can you explain your use-case better? When would I want to use fake_autoptr<T> in preference to std::unique_ptr<T>? The only advantage to std::auto_ptr is that it compiles as C++03... but your fake_autoptr is C++11-only, so that's not why you're using it. Why not just use std::unique_ptr?
    $endgroup$
    – Quuxplusone
    2 hours ago










  • $begingroup$
    @Quuxplusone, I've edited the code so it compiles as either C++11 or C++03 ...
    $endgroup$
    – Gregory Nisbet
    1 hour ago
















$begingroup$
Can you explain your use-case better? When would I want to use fake_autoptr<T> in preference to std::unique_ptr<T>? The only advantage to std::auto_ptr is that it compiles as C++03... but your fake_autoptr is C++11-only, so that's not why you're using it. Why not just use std::unique_ptr?
$endgroup$
– Quuxplusone
2 hours ago




$begingroup$
Can you explain your use-case better? When would I want to use fake_autoptr<T> in preference to std::unique_ptr<T>? The only advantage to std::auto_ptr is that it compiles as C++03... but your fake_autoptr is C++11-only, so that's not why you're using it. Why not just use std::unique_ptr?
$endgroup$
– Quuxplusone
2 hours ago












$begingroup$
@Quuxplusone, I've edited the code so it compiles as either C++11 or C++03 ...
$endgroup$
– Gregory Nisbet
1 hour ago




$begingroup$
@Quuxplusone, I've edited the code so it compiles as either C++11 or C++03 ...
$endgroup$
– Gregory Nisbet
1 hour ago










0






active

oldest

votes











Your Answer





StackExchange.ifUsing("editor", function () {
return StackExchange.using("mathjaxEditing", function () {
StackExchange.MarkdownEditor.creationCallbacks.add(function (editor, postfix) {
StackExchange.mathjaxEditing.prepareWmdForMathJax(editor, postfix, [["\$", "\$"]]);
});
});
}, "mathjax-editing");

StackExchange.ifUsing("editor", function () {
StackExchange.using("externalEditor", function () {
StackExchange.using("snippets", function () {
StackExchange.snippets.init();
});
});
}, "code-snippets");

StackExchange.ready(function() {
var channelOptions = {
tags: "".split(" "),
id: "196"
};
initTagRenderer("".split(" "), "".split(" "), channelOptions);

StackExchange.using("externalEditor", function() {
// Have to fire editor after snippets, if snippets enabled
if (StackExchange.settings.snippets.snippetsEnabled) {
StackExchange.using("snippets", function() {
createEditor();
});
}
else {
createEditor();
}
});

function createEditor() {
StackExchange.prepareEditor({
heartbeatType: 'answer',
autoActivateHeartbeat: false,
convertImagesToLinks: false,
noModals: true,
showLowRepImageUploadWarning: true,
reputationToPostImages: null,
bindNavPrevention: true,
postfix: "",
imageUploader: {
brandingHtml: "Powered by u003ca class="icon-imgur-white" href="https://imgur.com/"u003eu003c/au003e",
contentPolicyHtml: "User contributions licensed under u003ca href="https://creativecommons.org/licenses/by-sa/3.0/"u003ecc by-sa 3.0 with attribution requiredu003c/au003e u003ca href="https://stackoverflow.com/legal/content-policy"u003e(content policy)u003c/au003e",
allowUrls: true
},
onDemand: true,
discardSelector: ".discard-answer"
,immediatelyShowMarkdownHelp:true
});


}
});














draft saved

draft discarded


















StackExchange.ready(
function () {
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fcodereview.stackexchange.com%2fquestions%2f215798%2fwrapper-for-common-subset-of-auto-ptr-and-unique-ptr-api%23new-answer', 'question_page');
}
);

Post as a guest















Required, but never shown

























0






active

oldest

votes








0






active

oldest

votes









active

oldest

votes






active

oldest

votes
















draft saved

draft discarded




















































Thanks for contributing an answer to Code Review Stack Exchange!


  • Please be sure to answer the question. Provide details and share your research!

But avoid



  • Asking for help, clarification, or responding to other answers.

  • Making statements based on opinion; back them up with references or personal experience.


Use MathJax to format equations. MathJax reference.


To learn more, see our tips on writing great answers.




draft saved


draft discarded














StackExchange.ready(
function () {
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fcodereview.stackexchange.com%2fquestions%2f215798%2fwrapper-for-common-subset-of-auto-ptr-and-unique-ptr-api%23new-answer', 'question_page');
}
);

Post as a guest















Required, but never shown





















































Required, but never shown














Required, but never shown












Required, but never shown







Required, but never shown

































Required, but never shown














Required, but never shown












Required, but never shown







Required, but never shown







Popular posts from this blog

Сан-Квентин

8-я гвардейская общевойсковая армия

Алькесар