jyapayne/swig
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

R shared_ptr fixes

Browse source 
Fix problems in shared_ptr wrappers where the class names were
not consistent when using the shared_ptr template or the actual
underlying type. Move $R_class substitution to typemaps.

Issue #2386
This commit is contained in:
William S Fulton 2022-10-24 08:38:17 +01:00
commit 6c4dcbb8fe
4 changed files with 57 additions and 73 deletions
Download patch file Download diff file Expand all files Collapse all files

5
CHANGES.current
View file

@ -7,6 +7,11 @@ the issue number to the end of the URL: https://github.com/swig/swig/issues/
Version 4.1.0 (in progress) Version 4.1.0 (in progress)
=========================== ===========================
2022-10-24: wsfulton, AndLLA
[R] #2386 Fix problems in shared_ptr wrappers where the class names
were not consistent when using the shared_ptr template or the actual
underlying type.
2022-10-24: wsfulton 2022-10-24: wsfulton
[R] Add support for special variable replacement in the $typemap() [R] Add support for special variable replacement in the $typemap()
special variable macro for R specific typemaps (rtype, rtypecheck, special variable macro for R specific typemaps (rtype, rtypecheck,

66
Examples/test-suite/r/li_boost_shared_ptr_runme.R
View file

@ -83,7 +83,7 @@ testSuite <- function() {
if (FALSE) { if (FALSE) {
# pass by shared_ptr pointer reference # pass by shared_ptr pointer reference
k = Klass("me oh my") k = Klass("me oh my")
kret = smartpointerpointerreftest(k) # undefined class _p_p_SwigBoost__shared_ptrT_Space__Klass_t kret = smartpointerpointerreftest(k)
val = kret$getValue() val = kret$getValue()
unittest("me oh my smartpointerpointerreftest", val) unittest("me oh my smartpointerpointerreftest", val)
testSuite_verifyCount(2, k) testSuite_verifyCount(2, k)
@ -93,7 +93,7 @@ testSuite <- function() {
if (FALSE) { if (FALSE) {
# pass by shared_ptr pointer reference # pass by shared_ptr pointer reference
k = Klass("me oh my"); k = Klass("me oh my");
kret = smartpointerpointerreftest(k); # undefined class _p_p_SwigBoost__shared_ptrT_Space__Klass_t kret = smartpointerpointerreftest(k);
val = kret$getValue() val = kret$getValue()
unittest("me oh my smartpointerpointerreftest", val); unittest("me oh my smartpointerpointerreftest", val);
testSuite_verifyCount(2, k); testSuite_verifyCount(2, k);
@ -104,10 +104,10 @@ testSuite <- function() {
{ {
k = Klass("me oh my"); k = Klass("me oh my");
kret = constsmartpointertest(k); kret = constsmartpointertest(k);
val = Klass_getValue(kret) # kret$getValue(); - method not defined val = Klass_getValue(kret);
unittest("me oh my", val); unittest("me oh my", val);
testSuite_verifyCount(2, k); testSuite_verifyCount(2, k);
# testSuite_verifyCount(2, kret); # -> use_count not defined on _p_SwigBoost__shared_ptrT_Space__Klass_const_t testSuite_verifyCount(2, kret);
} }
# const pass by shared_ptr pointer # const pass by shared_ptr pointer
@ -117,7 +117,7 @@ testSuite <- function() {
val = Klass_getValue(kret) val = Klass_getValue(kret)
unittest("me oh my", val) unittest("me oh my", val)
testSuite_verifyCount(2, k) testSuite_verifyCount(2, k)
# testSuite_verifyCount(2, kret) # -> use_count not defined on _p_SwigBoost__shared_ptrT_Space__Klass_const_t testSuite_verifyCount(2, kret)
} }
# const pass by shared_ptr reference # const pass by shared_ptr reference
@ -127,7 +127,7 @@ testSuite <- function() {
val = Klass_getValue(kret) val = Klass_getValue(kret)
unittest("me oh my", val) unittest("me oh my", val)
testSuite_verifyCount(2, k) testSuite_verifyCount(2, k)
# testSuite_verifyCount(2, kret) # -> use_count not defined for _p_SwigBoost__shared_ptrT_Space__Klass_const_t testSuite_verifyCount(2, kret)
} }
# pass by value # pass by value
@ -137,7 +137,7 @@ testSuite <- function() {
val = kret$getValue(); val = kret$getValue();
unittest("me oh my valuetest", val); unittest("me oh my valuetest", val);
testSuite_verifyCount(1, k); testSuite_verifyCount(1, k);
# testSuite_verifyCount(1, kret); # -> use_count not defined on _p_Space__Klass testSuite_verifyCount(1, kret);
} }
# pass by pointer # pass by pointer
@ -147,7 +147,7 @@ testSuite <- function() {
val = kret$getValue(); val = kret$getValue();
unittest("me oh my pointertest", val); unittest("me oh my pointertest", val);
testSuite_verifyCount(1, k); testSuite_verifyCount(1, k);
# testSuite_verifyCount(1, kret); # -> use_count not defined on _p_Space__Klass testSuite_verifyCount(1, kret);
} }
# pass by reference # pass by reference
@ -157,17 +157,17 @@ testSuite <- function() {
val = kret$getValue(); val = kret$getValue();
unittest("me oh my reftest", val); unittest("me oh my reftest", val);
testSuite_verifyCount(1, k); testSuite_verifyCount(1, k);
#testSuite_verifyCount(1, kret); # -> use_count not defined on _p_Space__Klass testSuite_verifyCount(1, kret);
} }
# pass by pointer reference # pass by pointer reference
{ {
k = Klass("me oh my"); k = Klass("me oh my");
kret = pointerreftest(k); # -> class not defined _p_p_Space__Klass kret = pointerreftest(k);
val = kret$getValue(); val = kret$getValue();
unittest("me oh my pointerreftest", val); unittest("me oh my pointerreftest", val);
testSuite_verifyCount(1, k); testSuite_verifyCount(1, k);
# testSuite_verifyCount(1, kret); # -> use_count not defined on _p_Space__Klass testSuite_verifyCount(1, kret);
} }
# null tests # null tests
@ -239,7 +239,7 @@ testSuite <- function() {
k = pointerownertest(); k = pointerownertest();
val = k$getValue(); val = k$getValue();
unittest("pointerownertest", val); unittest("pointerownertest", val);
# testSuite_verifyCount(1, k); # -> use_count not defined for _p_Space__Klass testSuite_verifyCount(1, k);
} }
{ {
@ -286,7 +286,7 @@ testSuite <- function() {
# pass by shared_ptr pointer reference (mixed) # pass by shared_ptr pointer reference (mixed)
if (FALSE) { if (FALSE) {
k = KlassDerived("me oh my"); k = KlassDerived("me oh my");
kret = smartpointerpointerreftest(k); # undefined class _p_p_SwigBoost__shared_ptrT_Space__Klass_t kret = smartpointerpointerreftest(k);
val = kret$getValue(); val = kret$getValue();
unittest("me oh my derivedsmartptrpointerreftest-Derived", val); unittest("me oh my derivedsmartptrpointerreftest-Derived", val);
testSuite_verifyCount(2, k); # includes two extra references for upcasts in the proxy classes testSuite_verifyCount(2, k); # includes two extra references for upcasts in the proxy classes
@ -313,7 +313,7 @@ testSuite <- function() {
val = kret$getValue(); val = kret$getValue();
unittest("me oh my derivedpointertest-Derived", val); unittest("me oh my derivedpointertest-Derived", val);
testSuite_verifyCount(1, k); testSuite_verifyCount(1, k);
# testSuite_verifyCount(1, kret); -> use_count not defined for _p_Space__KlassDerived testSuite_verifyCount(1, kret);
} }
# pass by ref (mixed) # pass by ref (mixed)
@ -340,12 +340,12 @@ testSuite <- function() {
unittest(overload_rawbyval(k), "rawbyval") unittest(overload_rawbyval(k), "rawbyval")
unittest(overload_rawbyref(k), "rawbyref") unittest(overload_rawbyref(k), "rawbyref")
unittest(overload_rawbyptr(k), "rawbyptr") unittest(overload_rawbyptr(k), "rawbyptr")
# unittest(overload_rawbyptrref(k), "rawbyptrref") --> undefined for _p_SwigBoost__shared_ptrT_Space__Klass_t unittest(overload_rawbyptrref(k), "rawbyptrref")
unittest(overload_smartbyval(k), "smartbyval") unittest(overload_smartbyval(k), "smartbyval")
unittest(overload_smartbyref(k), "smartbyref") unittest(overload_smartbyref(k), "smartbyref")
unittest(overload_smartbyptr(k), "smartbyptr") unittest(overload_smartbyptr(k), "smartbyptr")
# unittest(overload_smartbyptrref(k), "smartbyptrref") --> undefined for _p_SwigBoost__shared_ptrT_Space__Klass_t unittest(overload_smartbyptrref(k), "smartbyptrref")
} }
# Derived class # Derived class
@ -355,12 +355,12 @@ testSuite <- function() {
unittest(overload_rawbyval(k), "rawbyval") unittest(overload_rawbyval(k), "rawbyval")
unittest(overload_rawbyref(k), "rawbyref") unittest(overload_rawbyref(k), "rawbyref")
unittest(overload_rawbyptr(k), "rawbyptr") unittest(overload_rawbyptr(k), "rawbyptr")
# unittest(overload_rawbyptrref(k), "rawbyptrref") --> undefined for _p_SwigBoost__shared_ptrT_Space__KlassDerived_t unittest(overload_rawbyptrref(k), "rawbyptrref")
unittest(overload_smartbyval(k), "smartbyval") unittest(overload_smartbyval(k), "smartbyval")
unittest(overload_smartbyref(k), "smartbyref") unittest(overload_smartbyref(k), "smartbyref")
unittest(overload_smartbyptr(k), "smartbyptr") unittest(overload_smartbyptr(k), "smartbyptr")
# unittest(overload_smartbyptrref(k), "smartbyptrref") --> undefined for _p_SwigBoost__shared_ptrT_Space__KlassDerived_t unittest(overload_smartbyptrref(k), "smartbyptrref")
} }
# 3rd derived class # 3rd derived class
@ -370,12 +370,12 @@ testSuite <- function() {
unittest(overload_rawbyval(k), "rawbyval") unittest(overload_rawbyval(k), "rawbyval")
unittest(overload_rawbyref(k), "rawbyref") unittest(overload_rawbyref(k), "rawbyref")
unittest(overload_rawbyptr(k), "rawbyptr") unittest(overload_rawbyptr(k), "rawbyptr")
# unittest(overload_rawbyptrref(k), "rawbyptrref") --> undefined for _p_SwigBoost__shared_ptrT_Space__Klass3rdDerived_t unittest(overload_rawbyptrref(k), "rawbyptrref")
unittest(overload_smartbyval(k), "smartbyval") unittest(overload_smartbyval(k), "smartbyval")
unittest(overload_smartbyref(k), "smartbyref") unittest(overload_smartbyref(k), "smartbyref")
unittest(overload_smartbyptr(k), "smartbyptr") unittest(overload_smartbyptr(k), "smartbyptr")
# unittest(overload_smartbyptrref(k), "smartbyptrref") --> undefined for _p_SwigBoost__shared_ptrT_Space__Klass3rdDerived_t unittest(overload_smartbyptrref(k), "smartbyptrref")
} }
# #
@ -573,7 +573,7 @@ testSuite <- function() {
kglobal = GlobalValue_get(); kglobal = GlobalValue_get();
val = kglobal$getValue(); val = kglobal$getValue();
unittest("global value", val); unittest("global value", val);
# testSuite_verifyCount(1, kglobal); # -> use_count undefined for _p_Space__Klass testSuite_verifyCount(1, kglobal);
testSuite_verifyCount(1, k); testSuite_verifyCount(1, k);
unittest("global value", GlobalValue_get()$getValue()); unittest("global value", GlobalValue_get()$getValue());
@ -600,7 +600,7 @@ testSuite <- function() {
kglobal = GlobalPointer_get(); kglobal = GlobalPointer_get();
val = kglobal$getValue(); val = kglobal$getValue();
unittest("global pointer", val); unittest("global pointer", val);
# testSuite_verifyCount(1, kglobal); -> use_count undefined for _p_Space__Klass testSuite_verifyCount(1, kglobal);
testSuite_verifyCount(1, k); testSuite_verifyCount(1, k);
GlobalPointer_set(NULL); GlobalPointer_set(NULL);
} }
@ -614,7 +614,7 @@ testSuite <- function() {
kglobal = GlobalReference_get(); kglobal = GlobalReference_get();
val = kglobal$getValue(); val = kglobal$getValue();
unittest("global reference", val); unittest("global reference", val);
# testSuite_verifyCount(1, kglobal); # -> use_count undefined for _p_Space__Klass testSuite_verifyCount(1, kglobal);
testSuite_verifyCount(1, k); testSuite_verifyCount(1, k);
bNotCatched = F bNotCatched = F
@ -652,16 +652,16 @@ for (i in 1:10) {
# wait for the GC to collect unused objects # wait for the GC to collect unused objects
for (i in 1:10) { #for (i in 1:10) {
invisible(gc(verbose = F, full = T)) # invisible(gc(verbose = F, full = T))
#
if (Klass_getTotal_count() == 1) { # if (Klass_getTotal_count() == 1) {
break # break
} # }
#
print(paste("Still waiting for GC to collect ", Klass_getTotal_count()-1, " objects, ", i)) # print(paste("Still waiting for GC to collect ", Klass_getTotal_count()-1, " objects, ", i))
Sys.sleep(1) # Sys.sleep(1)
} #}
# Expect # Expect
unittest(shared_ptr_wrapper_count(), NOT_COUNTING()) unittest(shared_ptr_wrapper_count(), NOT_COUNTING())

19
Lib/r/boost_shared_ptr.i
View file

@ -394,6 +394,25 @@
#error "typemaps for $1_type not available" #error "typemaps for $1_type not available"
%} %}
%typemap(rtype) SWIG_SHARED_PTR_QNAMESPACE::shared_ptr< CONST TYPE >,
SWIG_SHARED_PTR_QNAMESPACE::shared_ptr< CONST TYPE > &,
SWIG_SHARED_PTR_QNAMESPACE::shared_ptr< CONST TYPE > *,
SWIG_SHARED_PTR_QNAMESPACE::shared_ptr< CONST TYPE > *&
"$typemap(rtype, TYPE)"
%typemap(scoercein) SWIG_SHARED_PTR_QNAMESPACE::shared_ptr< CONST TYPE >,
SWIG_SHARED_PTR_QNAMESPACE::shared_ptr< CONST TYPE > &,
SWIG_SHARED_PTR_QNAMESPACE::shared_ptr< CONST TYPE > *,
SWIG_SHARED_PTR_QNAMESPACE::shared_ptr< CONST TYPE > *&
%{ if (inherits($input, "ExternalReference")) $input = slot($input,"ref"); %}
%typemap(scoerceout) SWIG_SHARED_PTR_QNAMESPACE::shared_ptr< CONST TYPE >,
SWIG_SHARED_PTR_QNAMESPACE::shared_ptr< CONST TYPE > &,
SWIG_SHARED_PTR_QNAMESPACE::shared_ptr< CONST TYPE > *,
SWIG_SHARED_PTR_QNAMESPACE::shared_ptr< CONST TYPE > *&
%{ $result <- if (is.null($result)) $result
else new("$typemap(rtype, TYPE)", ref=$result); %}
%template() SWIG_SHARED_PTR_QNAMESPACE::shared_ptr< CONST TYPE >; %template() SWIG_SHARED_PTR_QNAMESPACE::shared_ptr< CONST TYPE >;

40
Source/Modules/r.cxx
View file

@ -2088,21 +2088,6 @@ int R::functionWrapper(Node *n) {
/*If the user gave us something to convert the result in */ /*If the user gave us something to convert the result in */
if ((tm = Swig_typemap_lookup("scoerceout", n, Swig_cresult_name(), sfun))) { if ((tm = Swig_typemap_lookup("scoerceout", n, Swig_cresult_name(), sfun))) {
Replaceall(tm,"$result","ans"); Replaceall(tm,"$result","ans");
if (constructor) {
Node * parent = Getattr(n, "parentNode");
String * smartname = Getattr(parent, "feature:smartptr");
if (smartname) { // SmartName handling - has to be aligned to the other implementation in this file
SwigType *spt = Swig_cparse_type(smartname);
String *smart = SwigType_typedef_resolve_all(spt);
String *smart_rname = SwigType_manglestr(smart);
String *smart_rname_p = NewStringf("_p%s", smart_rname);
Replaceall(tm, "$R_class", smart_rname_p);
Delete(spt);
Delete(smart);
Delete(smart_rname);
Delete(smart_rname_p);
}
}
if (debugMode) { if (debugMode) {
Printf(stdout, "Calling replace B: %s, %s, %s\n", Getattr(n, "type"), Getattr(n, "sym:name"), getNSpace()); Printf(stdout, "Calling replace B: %s, %s, %s\n", Getattr(n, "type"), Getattr(n, "sym:name"), getNSpace());
} }
@ -2328,31 +2313,6 @@ void R::registerClass(Node *n) {
Printf(s_classes, "setClass('%s', contains = %s)\n", sname, base); Printf(s_classes, "setClass('%s', contains = %s)\n", sname, base);
Delete(base); Delete(base);
String *smartptr = Getattr(n, "feature:smartptr");
if (smartptr) {// SmartName handling - has to be aligned to the other implementation in this file
List *l = Getattr(n, "bases");
SwigType *spt = Swig_cparse_type(smartptr);
String *smart = SwigType_typedef_resolve_all(spt);
String *smart_rname = SwigType_manglestr(smart);
Printf(s_classes, "setClass('_p%s', contains = c('%s'", smart_rname, sname);
Delete(spt);
Delete(smart);
Delete(smart_rname);
for(int i = 0; i < Len(l); i++) {
Node * b = Getitem(l, i);
smartptr = Getattr(b, "feature:smartptr");
if (smartptr) {
spt = Swig_cparse_type(smartptr);
smart = SwigType_typedef_resolve_all(spt);
smart_rname = SwigType_manglestr(smart);
Printf(s_classes, ", '_p%s'", smart_rname);
Delete(spt);
Delete(smart);
Delete(smart_rname);
}
}
Printf(s_classes, "))\n");
}
} }
} }