Problem with std::unique_ptr as callback parameter #613

ValentinaBaranova · 2022-10-07T12:21:21Z

I have problem with creating FunctionPointer for callback which receives std::unique_ptr as argument.
This is my test function:

class Stream {
public:
    using StreamId = std::int32_t;
public:
    virtual ~Stream() = default;
    [[nodiscard]] virtual StreamId getStreamId() const noexcept = 0;
};

void testOnStreamOpenCb(std::function<void(std::unique_ptr<Stream> stream)>) {
    std::cout << "testOnStreamOpenCb";
}

This is my FunctionPointer:

    public static class OnStreamOpenCbCallback extends FunctionPointer {
        // Loader.load() and allocate() are required only when explicitly creating an instance
        static {
            Loader.load();
        }

        protected OnStreamOpenCbCallback() {
            allocate();
        }

        private native void allocate();

//        public native void call(@ByVal @UniquePtr @Cast("Stream*") Pointer stream);
//        public native void call(@ByVal @Cast("std::unique_ptr<Stream>*") Pointer stream);
        public native void call(@MoveUniquePtr @Cast("Stream*") Pointer stream);
    }

    @Documented
    @Retention(RetentionPolicy.RUNTIME)
    @Target({ElementType.METHOD, ElementType.PARAMETER})
    @Cast({"std::unique_ptr", "&&"}) @Adapter("UniquePtrAdapter")
    public @interface MoveUniquePtr {
        String value() default "";
    }

I saw uning MoveUniquePtr in tensorflow preset, but there callback returns unique_ptr, not use it as argument.
Here is my map:

infoMap.put(new Info("std::function<void(std::unique_ptr<Stream>stream)>").pointerTypes("OnStreamOpenCbCallback").define());

If I remove cpp function testOnStreamOpenCb, compilation fails because of testOnStreamOpenCb.
Could you please advice me something?

The text was updated successfully, but these errors were encountered:

saudet · 2022-10-07T13:17:41Z

It might work if we force a cast on std::unique<...> instead of Stream with something like
@Cast({"", "std::unique_ptr<Stream>"}) @UniquePtr Stream

ValentinaBaranova · 2022-10-07T15:09:42Z

I've tried

public native void call(@Cast({"", "std::unique_ptr<Stream>"}) @UniquePtr Stream stream);

but got and errors

error: call to implicitly-deleted copy constructor of 'std::unique_ptr<Stream>'
    JavaCPP_com_arrival_mobility_fleetsim_telemetryd_presets_Telemetryd_00024OnStreamOpenCbCallback_instances[0](arg0);


error: call to implicitly-deleted copy constructor of 'std::unique_ptr<Stream>'
    JavaCPP_com_arrival_mobility_fleetsim_telemetryd_presets_Telemetryd_00024OnStreamOpenCbCallback_instances[1](arg0);

saudet · 2022-10-08T00:18:15Z

Ok, maybe something like @Cast({"", "std::unique_ptr<Stream>&&"}) @UniquePtr Stream?

ValentinaBaranova · 2022-10-10T16:43:15Z

I've changed code a bit to this:

class MyStream {
public:
    int id;
};

void testUniquePtrMyStreamCallback(std::function<void(std::unique_ptr<MyStream> stream)> callback) {
    std::cout << "testUniquePtrMyStreamCallback";
}

map config:

infoMap.put(new Info("std::function<void(std::unique_ptr<MyStream>stream)>").pointerTypes("UniquePtrMyStreamCallback").define());

And helper:

    public static class UniquePtrMyStreamCallback extends FunctionPointer {
        // Loader.load() and allocate() are required only when explicitly creating an instance
        static {
            Loader.load();
        }

        protected UniquePtrMyStreamCallback() {
            allocate();
        }

        private native void allocate();


//        public native void call(@Cast({"", "std::unique_ptr<MyStream>&&"}) Pointer stream);
//        public native void call(@Cast({"", "std::unique_ptr<MyStream>"}) Pointer stream);
//        public native void call(@Cast({"std::unique_ptr<MyStream>*"}) Pointer stream);
//        public native void call(@Cast({"", "std::unique_ptr<MyStream>&&"}) @MoveUniquePtr com.arrival.mobility.telemetryd.MyStream stream);
//        public native void call(@Cast({"", "std::unique_ptr<MyStream>"}) @MoveUniquePtr com.arrival.mobility.telemetryd.MyStream stream);
//        public native void call(@MoveUniquePtr com.arrival.mobility.telemetryd.MyStream stream);
//        public native void call(@Cast({"", "std::unique_ptr<MyStream>"}) @UniquePtr com.arrival.mobility.telemetryd.MyStream stream);
//        public native void call(@Cast({"", "std::unique_ptr<MyStream>&&"}) com.arrival.mobility.telemetryd.MyStream stream);
        public native void call(@Cast({"", "std::unique_ptr<MyStream>&&"}) @UniquePtr com.arrival.mobility.telemetryd.MyStream stream);
//        public native void call(@ByVal @UniquePtr com.arrival.mobility.telemetryd.MyStream stream);
    }

I've tried all these variants and they failed (

…ePtr` arguments (issue #613)

saudet · 2022-10-12T03:34:30Z

I've pushed a couple of fixes in commit b411ac6, and with that something like @Cast({"", "std::unique_ptr<Stream>", "std::unique_ptr<Stream>&&"}) @UniquePtr Stream should compile. Whether that works correctly or not is a different question though...

ValentinaBaranova · 2022-10-12T09:38:34Z

Unfortunately no, it doesn't compile

                            ^
/Users/valentina.baranova/mobility/fleetSim/telemetryd-javacpp-library/target/native/com/arrival/mobility/telemetryd/macosx-x86_64/jniTelemetryd.cpp:1381:34: error: no matching constructor for initialization of 'UniquePtrAdapter<MyStream>'
    UniquePtrAdapter< MyStream > adapter0(arg0);
                                 ^        ~~~~
/Users/valentina.baranova/mobility/fleetSim/telemetryd-javacpp-library/target/native/com/arrival/mobility/telemetryd/macosx-x86_64/jniTelemetryd.cpp:617:77: note: candidate constructor (the implicit copy constructor) not viable: no known conversion from 'MyStream' to 'const UniquePtrAdapter<MyStream>' for 1st argument
template<class T, class D = UNIQUE_PTR_NAMESPACE::default_delete<T> > class UniquePtrAdapter {
                                                                            ^
/Users/valentina.baranova/mobility/fleetSim/telemetryd-javacpp-library/target/native/com/arrival/mobility/telemetryd/macosx-x86_64/jniTelemetryd.cpp:617:77: note: candidate constructor (the implicit move constructor) not viable: no known conversion from 'MyStream' to 'UniquePtrAdapter<MyStream>' for 1st argument
template<class T, class D = UNIQUE_PTR_NAMESPACE::default_delete<T> > class UniquePtrAdapter {
                                                                            ^
/Users/valentina.baranova/mobility/fleetSim/telemetryd-javacpp-library/target/native/com/arrival/mobility/telemetryd/macosx-x86_64/jniTelemetryd.cpp:623:5: note: candidate constructor not viable: no known conversion from 'MyStream' to 'UniquePtrAdapter<MyStream>::U' (aka 'unique_ptr<MyStream, std::default_delete<MyStream>>') for 1st argument
    UniquePtrAdapter(U&& uniquePtr) : ptr(0), size(0), owner(0), uniquePtr2(UNIQUE_PTR_NAMESPACE::move(uniquePtr)), uniquePtr(uniquePtr2) { }
    ^
/Users/valentina.baranova/mobility/fleetSim/telemetryd-javacpp-library/target/native/com/arrival/mobility/telemetryd/macosx-x86_64/jniTelemetryd.cpp:624:5: note: candidate constructor not viable: no known conversion from 'MyStream' to 'const UniquePtrAdapter<MyStream>::U' (aka 'const unique_ptr<MyStream, std::default_delete<MyStream>>') for 1st argument
    UniquePtrAdapter(const U& uniquePtr) : ptr(0), size(0), owner(0), uniquePtr2(U(NULL, D())), uniquePtr((U&)uniquePtr) { }
    ^
/Users/valentina.baranova/mobility/fleetSim/telemetryd-javacpp-library/target/native/com/arrival/mobility/telemetryd/macosx-x86_64/jniTelemetryd.cpp:625:5: note: candidate constructor not viable: no known conversion from 'MyStream' to 'UniquePtrAdapter<MyStream>::U &' (aka 'unique_ptr<MyStream, std::default_delete<MyStream>> &') for 1st argument
    UniquePtrAdapter(      U& uniquePtr) : ptr(0), size(0), owner(0), uniquePtr2(U(NULL, D())), uniquePtr(uniquePtr) { }
    ^
/Users/valentina.baranova/mobility/fleetSim/telemetryd-javacpp-library/target/native/com/arrival/mobility/telemetryd/macosx-x86_64/jniTelemetryd.cpp:626:5: note: candidate constructor not viable: no known conversion from 'MyStream' to 'const UniquePtrAdapter<MyStream>::U *' (aka 'const unique_ptr<MyStream, std::default_delete<MyStream>> *') for 1st argument
    UniquePtrAdapter(const U* uniquePtr) : ptr(0), size(0), owner(0), uniquePtr2(U(NULL, D())), uniquePtr(*(U*)uniquePtr) { }
    ^
/Users/valentina.baranova/mobility/fleetSim/telemetryd-javacpp-library/target/native/com/arrival/mobility/telemetryd/macosx-x86_64/jniTelemetryd.cpp:620:5: note: candidate constructor not viable: requires 3 arguments, but 1 was provided
    UniquePtrAdapter(const T* ptr, size_t size, void* owner) : ptr((T*)ptr), size(size), owner(owner),
    ^
/Users/valentina.baranova/mobility/fleetSim/telemetryd-javacpp-library/target/native/com/arrival/mobility/telemetryd/macosx-x86_64/jniTelemetryd.cpp:1488:21: error: no viable conversion from 'UniquePtrAdapter<MyStream>' to 'MyStream'
        (*ptr->ptr)(adapter0);
                    ^~~~~~~~
/Users/valentina.baranova/mobility/fleetSim/telemetryd-javacpp-library/cppbuild/macosx-x86_64/include/test_functions.h:23:7: note: candidate constructor (the implicit copy constructor) not viable: no known conversion from 'UniquePtrAdapter<MyStream>' to 'const MyStream &' for 1st argument
class MyStream {
      ^
/Users/valentina.baranova/mobility/fleetSim/telemetryd-javacpp-library/cppbuild/macosx-x86_64/include/test_functions.h:23:7: note: candidate constructor (the implicit move constructor) not viable: no known conversion from 'UniquePtrAdapter<MyStream>' to 'MyStream &&' for 1st argument
/Users/valentina.baranova/mobility/fleetSim/telemetryd-javacpp-library/target/native/com/arrival/mobility/telemetryd/macosx-x86_64/jniTelemetryd.cpp:634:5: note: candidate function
    operator typename UNIQUE_PTR_NAMESPACE::remove_const<T>::type*() {
    ^
/Users/valentina.baranova/mobility/fleetSim/telemetryd-javacpp-library/target/native/com/arrival/mobility/telemetryd/macosx-x86_64/jniTelemetryd.cpp:642:5: note: candidate function
    operator U&() const { return uniquePtr; }
    ^
/Users/valentina.baranova/mobility/fleetSim/telemetryd-javacpp-library/target/native/com/arrival/mobility/telemetryd/macosx-x86_64/jniTelemetryd.cpp:643:5: note: candidate function
    operator U&&() { return UNIQUE_PTR_NAMESPACE::move(uniquePtr); }
    ^
/Users/valentina.baranova/mobility/fleetSim/telemetryd-javacpp-library/target/native/com/arrival/mobility/telemetryd/macosx-x86_64/jniTelemetryd.cpp:644:5: note: candidate function
    operator U*() { return &uniquePtr; }
    ^
/Users/valentina.baranova/mobility/fleetSim/telemetryd-javacpp-library/target/native/com/arrival/mobility/telemetryd/macosx-x86_64/jniTelemetryd.cpp:2186:9: error: no matching function for call to 'testUniquePtrMyStreamCallback'
        testUniquePtrMyStreamCallback(*ptr0);
        ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~
/Users/valentina.baranova/mobility/fleetSim/telemetryd-javacpp-library/cppbuild/macosx-x86_64/include/test_functions.h:28:6: note: candidate function not viable: no known conversion from 'JavaCPP_com_arrival_mobility_telemetryd_helper_TelemetrydHelper_00024UniquePtrMyStreamCallback' to 'std::function<void (std::unique_ptr<MyStream>)>' for 1st argument
void testUniquePtrMyStreamCallback(std::function<void(std::unique_ptr<MyStream> stream)> callback) {
     ^
/Users/valentina.baranova/mobility/fleetSim/telemetryd-javacpp-library/target/native/com/arrival/mobility/telemetryd/macosx-x86_64/jniTelemetryd.cpp:631:59: error: call to implicitly-deleted copy constructor of 'UniquePtrAdapter<MyStream>::U' (aka 'unique_ptr<MyStream, std::default_delete<MyStream>>')
        this->uniquePtr = owner != NULL && owner != ptr ? *(U*)owner : U((T*)ptr);
                                                          ^~~~~~~~~~
/Users/valentina.baranova/mobility/fleetSim/telemetryd-javacpp-library/target/native/com/arrival/mobility/telemetryd/macosx-x86_64/jniTelemetryd.cpp:1427:14: note: in instantiation of member function 'UniquePtrAdapter<MyStream>::assign' requested here
    adapter0.assign(rptr0, rsize0, rowner0);
             ^
/Library/Developer/CommandLineTools/SDKs/MacOSX.sdk/usr/include/c++/v1/__memory/unique_ptr.h:213:3: note: copy constructor is implicitly deleted because 'unique_ptr<MyStream>' has a user-declared move constructor
  unique_ptr(unique_ptr&& __u) _NOEXCEPT
  ^
1 warning and 4 errors generated.

ValentinaBaranova · 2022-10-12T09:40:13Z

Also when I try to use javacpp 1.5.8-SNAPSHOT (from repository) I've got errors even for worked code with other callbacks. If I try to compile it locally, I have failed test ThreadTest.testJNIThreadAttachFromNativeCallbacks

saudet · 2022-10-12T09:53:50Z

Yeah, well, you'll need to give me something to work with. Everything works fine here, I can't fix what isn't broken!

ValentinaBaranova · 2022-10-12T10:20:39Z

test-javacpp-library.tar.gz
here is my source, could you take a look?
if I use javacpp 1.5.8-SNAPSHOT, I have problems with previously worked callbacks, if I use 1.5.7 - only with unique_ptr

saudet · 2022-10-12T10:31:30Z

mvn clean package gives me the exact same error with either JavaCPP 1.5.7 or 1.5.8-SNAPSHOT:

[INFO] -------------------------------------------------------------
[ERROR] COMPILATION ERROR : 
[INFO] -------------------------------------------------------------
[ERROR] /tmp/test-javacpp-library/src/gen/java/com/arrival/mobility/telemetryd/BooleanCallback.java:[22,57] cannot find symbol
  symbol:   class boolsuccess
  location: class com.arrival.mobility.telemetryd.BooleanCallback
[ERROR] /tmp/test-javacpp-library/src/gen/java/com/arrival/mobility/telemetryd/BooleanCallback_boolsuccess.java:[18,36] cannot find symbol
  symbol:   class boolsuccess
  location: class com.arrival.mobility.telemetryd.BooleanCallback_boolsuccess
[INFO] 2 errors

ValentinaBaranova · 2022-10-12T11:10:19Z

please remove files from gen/java dir after switching. it doesn't clean automatically

saudet · 2022-10-12T11:34:10Z

I get a different error in that case, but still the same regardless of the version of JavaCPP:

[INFO] -------------------------------------------------------------
[ERROR] COMPILATION ERROR : 
[INFO] -------------------------------------------------------------
[ERROR] /tmp/test-javacpp-library/src/main/java/com/arrival/mobility/telemetryd/helper/TelemetrydHelper.java:[42,147] cannot find symbol
  symbol:   class MyStream
  location: package com.arrival.mobility.telemetryd
[INFO] 1 error

ValentinaBaranova · 2022-10-12T11:56:04Z

How I compile this preset: I go to the main directory, run mvn clean install, then run mvn clean install in platform dir. MyStream class should appear after generation. I use it in TelemetrydHelper which is in helper package so it should not be an compilation error, as you explained me here #606 (comment)

These code compiles fine for me
test-javacpp-library-2.tar.gz
To reproduce unique_ptr error please uncomment lines in test_functions.h and in TelemetrydHelper.

saudet · 2022-10-12T23:18:56Z

Ah, I see what the issue is. JavaCPP 1.5.8-SNAPSHOT adds "basic container" support for std::function, but since you're not using that in the project, you need to remove the .define() bits from the presets.

ValentinaBaranova · 2022-10-13T12:22:12Z

It works! Thanks a lot!

ValentinaBaranova · 2022-10-17T12:27:38Z

test-client-library-3.tar.gz
test-javacpp-library-3.tar.gz

When I try to call this callback with unique_ptr, I got SIGABRT error. Could you please take a look into main class in test-client-library? To make it work you also need 'mvn clean install' in main folder test-javacpp-library and for platform too.

…cks (issue #613)

saudet · 2022-10-18T12:01:40Z

This should be fixed in commit 81252dd. Please give it a try with the snapshots! Thanks

ValentinaBaranova · 2022-10-18T12:28:02Z

Great, it works! Many thanks for quick fix!

ValentinaBaranova · 2022-10-25T07:52:32Z

test-client-library-4.tar.gz
test-javacpp-library-4.tar.gz

Found one more issue with unique_ptr. This unique_ptr object (MyStream object) is passed to my callback and than I need store it for later usage. But when I try to use it later, object looks corrupted. This is test class (from test-client-library-4.tar.gz):

public class Main {

    public static void main(String[] args) {
        TestUniquePtrCallback callback = new TestUniquePtrCallback();
        testUniquePtrMyStreamCallback(callback);
        System.out.println("After callback");
        System.out.println("callback.stream.id=" + callback.stream.id());

    }
}
 class TestUniquePtrCallback extends TelemetrydHelper.UniquePtrMyStreamCallback {

    MyStream stream = null;

    @Override
    public void call(MyStream stream) {
        System.out.println("TestUniquePtrCallback: stream.id=" + stream.id());
        this.stream = stream;
        System.out.println("TestUniquePtrCallback: this.stream.id=" + this.stream.id());
    }
}

This is test output:

TestUniquePtrCallback: stream.id=5
TestUniquePtrCallback: this.stream.id=5
After callback
callback.stream.id=-973405760

Could you please help with it?

saudet · 2022-10-25T10:33:56Z

To do that, in C++, we need to create a new instance of that std::unique_ptr, but I don't see how we can do that with an adapter, that's not what it was designed to do. We probably need to create a wrapper object for that std::unique_ptr instance.

… on callbacks (issue #613)

saudet · 2022-10-26T13:06:58Z

That said, I think I managed to make it work in commit 45a6a4b.
Please give it a try with the snapshots: http://bytedeco.org/builds/

ValentinaBaranova · 2022-10-26T14:27:59Z

Looks like it works with sample code, will test it later with my library. This is great, thank you very much!

saudet · 2022-11-03T04:37:23Z

Fixes for this issue have been released with JavaCPP 1.5.8. Thanks for reporting and for testing all this!

ValentinaBaranova · 2022-11-03T07:21:44Z

Amazing! Thanks you for fixing them and for helping me and for such cool javacpp lib! I have completed writing javacpp mappings and now I'm able to use c++ functions from our company library in my kotlin code.

saudet added help wanted question labels Oct 7, 2022

saudet added a commit that referenced this issue Oct 12, 2022

* Fix Generator compiler errors for FunctionPointer with `@Uniqu…

b411ac6

…ePtr` arguments (issue #613)

ValentinaBaranova closed this as completed Oct 13, 2022

ValentinaBaranova reopened this Oct 17, 2022

saudet added a commit that referenced this issue Oct 18, 2022

* Fix UniquePtrAdapter incorrectly deallocating pointers on callba…

81252dd

…cks (issue #613)

ValentinaBaranova closed this as completed Oct 18, 2022

saudet added bug and removed help wanted labels Oct 19, 2022

ValentinaBaranova reopened this Oct 25, 2022

saudet added enhancement help wanted labels Oct 25, 2022

saudet added a commit that referenced this issue Oct 26, 2022

* Fix some more UniquePtrAdapter incorrectly deallocating pointers…

45a6a4b

… on callbacks (issue #613)

ValentinaBaranova closed this as completed Oct 26, 2022

saudet removed the help wanted label Nov 3, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Problem with std::unique_ptr as callback parameter #613

Problem with std::unique_ptr as callback parameter #613

ValentinaBaranova commented Oct 7, 2022

saudet commented Oct 7, 2022 •

edited

Loading

ValentinaBaranova commented Oct 7, 2022

saudet commented Oct 8, 2022

ValentinaBaranova commented Oct 10, 2022

saudet commented Oct 12, 2022

ValentinaBaranova commented Oct 12, 2022

ValentinaBaranova commented Oct 12, 2022

saudet commented Oct 12, 2022

ValentinaBaranova commented Oct 12, 2022 •

edited

Loading

saudet commented Oct 12, 2022

ValentinaBaranova commented Oct 12, 2022 •

edited

Loading

saudet commented Oct 12, 2022

ValentinaBaranova commented Oct 12, 2022

saudet commented Oct 12, 2022

ValentinaBaranova commented Oct 13, 2022

ValentinaBaranova commented Oct 17, 2022

saudet commented Oct 18, 2022

ValentinaBaranova commented Oct 18, 2022

ValentinaBaranova commented Oct 25, 2022 •

edited

Loading

saudet commented Oct 25, 2022

saudet commented Oct 26, 2022

ValentinaBaranova commented Oct 26, 2022

saudet commented Nov 3, 2022

ValentinaBaranova commented Nov 3, 2022

Problem with std::unique_ptr as callback parameter #613

Problem with std::unique_ptr as callback parameter #613

Comments

ValentinaBaranova commented Oct 7, 2022

saudet commented Oct 7, 2022 • edited Loading

ValentinaBaranova commented Oct 7, 2022

saudet commented Oct 8, 2022

ValentinaBaranova commented Oct 10, 2022

saudet commented Oct 12, 2022

ValentinaBaranova commented Oct 12, 2022

ValentinaBaranova commented Oct 12, 2022

saudet commented Oct 12, 2022

ValentinaBaranova commented Oct 12, 2022 • edited Loading

saudet commented Oct 12, 2022

ValentinaBaranova commented Oct 12, 2022 • edited Loading

saudet commented Oct 12, 2022

ValentinaBaranova commented Oct 12, 2022

saudet commented Oct 12, 2022

ValentinaBaranova commented Oct 13, 2022

ValentinaBaranova commented Oct 17, 2022

saudet commented Oct 18, 2022

ValentinaBaranova commented Oct 18, 2022

ValentinaBaranova commented Oct 25, 2022 • edited Loading

saudet commented Oct 25, 2022

saudet commented Oct 26, 2022

ValentinaBaranova commented Oct 26, 2022

saudet commented Nov 3, 2022

ValentinaBaranova commented Nov 3, 2022

saudet commented Oct 7, 2022 •

edited

Loading

ValentinaBaranova commented Oct 12, 2022 •

edited

Loading

ValentinaBaranova commented Oct 12, 2022 •

edited

Loading

ValentinaBaranova commented Oct 25, 2022 •

edited

Loading