Rcpp icon indicating copy to clipboard operation
Rcpp copied to clipboard

Enhance XPtr to set and check type info

Open eddelbuettel opened this issue 3 years ago • 6 comments
trafficstars

The XPtr class wraps somewhat narrowly around R's own external pointers. The class actually has three fields: the pointer, a tag and a protect field. WRE, Section 5.13.1 has an example of setting the tag (of type SEXP, so can be anything) to a string. Searching the CRAN org here at GitHub (with its effective CRAN mirror) shows a few packages using this ... for various purposes, sometimes even second payloads.

Now, because the external pointer is effectively a naked C pointer, it would be useful to also offer some type checking. Following some initial discussion (thanks, @ihnorton) I am currently prototyping use with the tiledb package. But as this is generally useful we should support it here in time (maybe the July release, maybe next January).

Among the obvious missing features are

  • a tag getter in the XPtr class
  • an alternate XPtr creation helper setting pointer and tag
  • and likely more

Following some quick discussion with @Enchufa2 there is also an idea to automate this further via typeid() and std::type_info() (though that may not work for user-defined classes, where I also ran into some potholes on initial probing with C++17-ish features).

In any event, this seems like a fruitful avenue to venture down so opening this ticket to collect more ideas.

eddelbuettel avatar Apr 02 '22 15:04 eddelbuettel

On second thought, a drawback of automatic type checking is that it wouldn't work with polymorphism. And I use this quite a lot.

Enchufa2 avatar Apr 02 '22 18:04 Enchufa2

Good catch. Optional extension in derived class as we riffed may be the way to go.

eddelbuettel avatar Apr 02 '22 18:04 eddelbuettel

FWIW that is now in release 0.12.0 of package tiledb -- but we use C++17 there and I haven't checked if what I use there can be used with older compilation standards too.

eddelbuettel avatar Apr 14 '22 02:04 eddelbuettel

This issue is stale (365 days without activity) and will be closed in 31 days unless new activity is seen. Please feel free to re-open it is still a concern, possibly with additional data.

github-actions[bot] avatar Apr 15 '23 02:04 github-actions[bot]

Still on the TODO list...

eddelbuettel avatar Apr 16 '23 00:04 eddelbuettel

The tagging idea I had (and use in tiledb does not fully generalise. Package nanoarrow for example uses the SEXP field to store another external pointer (!!) as Arrow data structures prefer to come in pair: 'data' (usually called 'array') along with 'schema'.

So maybe a better idea is to use an additional attribute?

eddelbuettel avatar Jan 13 '24 13:01 eddelbuettel