34

I recently started porting lots of my existing C++ application code to over to C++11 and now that I am converting to the new smart pointers std::unique_ptr and std::shared_ptr, I have a specific question about custom deleters. I want to add a lambda logger to see where my deletes are being called but I cannot get the array specialization version to compile. Advice would be very much appreciated.

I have been searching in vain for an example of a custom deleter for array specialization unique_ptr for VC++10 or GCC 4.5.2+. I would like to print a log message when the deleters are called in a lambda - mainly to make sure that all the pointers that I think are going out of scope are doing so. Is this possible for the array version of the specialization? I can get it to work with the non array version, and I can also get it to work with an array specialization if I pass an external struct "MyArrayDeleter" as the second argument. One more thing, would it be possible to remove the ugly std::function as I thought that I could let the lambda signature figure that out.

struct MySimpleDeleter {
    void operator()(int* ptr) const {
        printf("Deleting int pointer!\n");
        delete ptr;
    }
};
struct MyArrayDeleter {
    void operator()(int* ptr) const {
        printf("Deleting Array[]!\n");
        delete [] ptr;
    }
};
{
    // example 1 - calls MySimpleDeleter where delete simple pointer is called
    std::unique_ptr<int, MySimpleDeleter> ptr1(new int(5));

    // example 2 - correctly calls MyArrayDeleter where delete[] is called
    std::unique_ptr<int[], MyArrayDeleter> ptr2(new int[5]);

    // example 3 - this works (but default_delete<int[]> would have been passed
    // even if I did not specialize it as it is the default second arg
    // I only show it here to highlight the problem I am trying to solve
    std::unique_ptr<int[], std::default_delete<int[]>> ptr2(new int[100]);

    // example 3 - this lambda is called correctly - I want to do this for arrays
    std::unique_ptr<int, std::function<void (int *)>> ptr3(
        new int(3), [&](int *ptr){ 
            delete ptr; std::cout << "delete int* called" << std::endl; 
        });

    // example 4 - I cannot get the following like to compile
    // PLEASE HELP HERE - I cannot get this to compile
    std::unique_ptr<int[], std::function<void (int *)>> ptr4(
        new int[4], [&](int *ptr){  
            delete []ptr; std::cout << "delete [] called" << std::endl; 
        });
}

The compiler error is as follows:

The error from the compiler (which complains about the new int[4] for ptr4 below is:
'std::unique_ptr<_Ty,_Dx>::unique_ptr' : cannot access private member declared in class 'std::unique_ptr<_Ty,_Dx>'
1>          with
1>          [
1>              _Ty=int [],
1>              _Dx=std::tr1::function<void (int *)>
1>          ]
1>          c:\program files (x86)\microsoft visual studio 10.0\vc\include\memory(2513) : see declaration of 'std::unique_ptr<_Ty,_Dx>::unique_ptr'
1>          with
1>          [
1>              _Ty=int [],
1>              _Dx=std::tr1::function<void (int *)>
1>          ]
ROMANIA_engineer
  • 54,432
  • 29
  • 203
  • 199
johnco3
  • 2,401
  • 4
  • 35
  • 67

2 Answers2

51

What about:

auto deleter=[&](int* ptr){...};
std::unique_ptr<int[], decltype(deleter)> ptr4(new int[4], deleter);
ildjarn
  • 62,044
  • 9
  • 127
  • 211
Managu
  • 8,849
  • 2
  • 30
  • 36
  • 2
    Your deleter's argument type is wrong -- that should be `int* ptr` rather than `int (*ptr)[]`. – ildjarn Apr 26 '12 at 17:13
  • @ildjarn: why is `int (*ptr)[]` wrong? Shouldn't I expect `std::unique_ptr` to pass `deleter` a pointer to an array of `int`s instead of a pointer to a single int? Or is that spelled `int *(ptr[])`? – Managu Apr 26 '12 at 22:18
  • 4
    In C++, a dynamic array of `int`s is represented as an `int*`; i.e., the type of `new int[4]` is `int*`. Consequently, the deleter expects an `int*` -- why would an extra level of indirection be useful/needed? This is easily demonstrated by actually trying to _compile_ your code..: [doesn't work](http://ideone.com/fujAk), [does work](http://ideone.com/JeXYD). In no context is `int (*ptr)[]` valid syntax; at the least it would have to be `int (*ptr)[N]` for some known `N`, to act as a pointer to a _statically_ sized array. – ildjarn Apr 26 '12 at 22:30
  • I'm much more confused after the edit than before; when you make a custom deleter for a non-pointer object, unique_ptr expects that custom deleter to take an argument that is the raw pointer to that object. Why, then, would it not be the same for this? I would expect unique_ptr to take a custom deleter with parameter int*, and unique_ptr to take a custom deleter with parameter int*[] or at least int**. Why is that not so? – codetaku Jul 02 '15 at 20:58
4

First of first, I use VC2010 with SP1, Mingw g++ 4.7.1

For array new, unique_ptr already support it in a clean way:

struct X
{
    X()   { puts("ctor"); }
   ~X()   { puts("dtor"); }
};

unique_ptr<X[]>  xp(new X[3]);

The output is:

ctor
ctor
ctor
dtor
dtor
dtor

For customized deleter, unfortunately, it's inconsistent between VC2010 and g++:

VC2010:

  unique_ptr<FILE, function<void (FILE*)> > fp(fopen("tmp.txt", "w"), [](FILE *fp){
    puts("close file now");
    fclose(fp);
  });

g++:

  unique_ptr<FILE, void (*)(FILE*) > fp(fopen("tmp.txt", "w"), [](FILE *fp){
    puts("close file now");
    fclose(fp);
  });

The method by Managu is very well, because inline lambda is cool but hurt readability IMHO. It also emphsize that release resource before acquisition(RAII).

Here I suggest a declartive way to separate resource acquisition and release(Scope Guard, works for both VC2010 and g++ 4.7.1):

template<typename T>
struct ScopeGuard
{
    T deleter_;
    ScopeGuard( T deleter) : deleter_(deleter) {}
    ~ScopeGuard() { deleter_() ; }
};
#define UNI_NAME(name, line) name ## line
#define ON_OUT_OF_SCOPE_2(lambda_body, line) auto UNI_NAME(deleter_lambda_, line) = [&]() {    lambda_body; } ; \
       ScopeGuard<decltype(UNI_NAME(deleter_lambda_, line))> \
       UNI_NAME(scope_guard_, line)  ( UNI_NAME(deleter_lambda_, line ));
#define ON_OUT_OF_SCOPE(lambda_body) ON_OUT_OF_SCOPE_2(lambda_body, __LINE__)

FILE * fp = fopen("tmp.txt", "w");
ON_OUT_OF_SCOPE( { puts("close file now"); fclose(fp); } );

The point is you can get a resource in the old, clear way, and declare the statement to release the resource immediately following the resource-acquisition line.

The drawback is you cannot forward a single object around along with it's deleter.

For FILE *, shared_ptr can be used as an alternative pointer for the same purpose(maybe a little heavy-weight, but works well for both VC2010 and g++)

shared_ptr fp2 ( fopen("tmp.txt", "w"), [](FILE * fp) { fclose(fp); puts("close file"); } );

zhaorufei
  • 2,045
  • 19
  • 18