Repository navigation
Module(): analyse reference class once and reuse C++Class objects #1515
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,24 @@ | ||
| 2026-10-21 Michael Sumner <[email protected]> | ||
|
|
||
| * R/Module.R (Module): Supply the 'initialize' method to setRefClass() with | ||
| the other methods instead of adding it in a second generator$methods() | ||
| call, which repeated the reference class analysis of every exposed | ||
| method, and reuse the C++Class objects returned by | ||
| Module__classes_info() rather than rebuilding each of them via | ||
| .get_Module_Class(); both reduce the time spent loading a module (#1515) | ||
| * R/Module.R (Module): Take the class representation from the generator | ||
| rather than looking it up by name with methods::getClass(), which | ||
| ignores 'where' and can return another loaded package's class of the same | ||
| name | ||
| * R/Module.R (Module): Register as(FROM, TO) converters after the loop | ||
| that populates 'storage' rather than once per function inside it | ||
| * R/Module.R (Module): Match the 'show' method name exactly rather than as | ||
| a substring, so a class exposing e.g. 'showInfo' keeps the C++Object show | ||
| method | ||
|
|
||
| * DESCRIPTION (Version, Date): Roll micro version and date | ||
| * inst/include/Rcpp/config.h: Idem | ||
|
|
||
| 2026-10-13 Dirk Eddelbuettel <[email protected]> | ||
|
|
||
| * DESCRIPTION (Version, Date): Roll micro version and date | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,7 @@ | ||
| Package: Rcpp | ||
| Title: Seamless R and C++ Integration | ||
| Version: 1.1.2.5 | ||
| Date: 2026-10-13 | ||
| Version: 1.1.2.6 | ||
| Date: 2026-10-21 | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We usually do this on our end but this is also a reasonable snapshot so thanks here too. |
||
| Authors@R: c(person("Dirk", "Eddelbuettel", role = c("aut", "cre"), email = "[email protected]", | ||
| comment = c(ORCID = "0000-0001-6419-907X")), | ||
| person("Romain", "Francois", role = "aut", | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -222,26 +222,28 @@ Module <- function( module, PACKAGE = methods::getPackageName(where), where = to | |
|
|
||
| fields <- cpp_fields( CLASS, where ) | ||
| methods <- cpp_refMethods(CLASS, where) | ||
| generator <- methods::setRefClass( clname, | ||
| fields = fields, | ||
| contains = "C++Object", | ||
| methods = methods, | ||
| where = where | ||
| ) | ||
| # just to make codetools happy | ||
| .self <- .refClassDef <- NULL | ||
| generator$methods(initialize = | ||
| # Supply 'initialize' together with the other methods so that the | ||
| # reference class is analysed once, instead of a second full pass | ||
| # through refClassInformation() in generator$methods(...) | ||
| methods[["initialize"]] <- | ||
| if (cpp_hasDefaultConstructor(CLASS)) | ||
| function(...) Rcpp::cpp_object_initializer(.self,.refClassDef, ...) | ||
| else | ||
| function(...) { | ||
| if (nargs()) Rcpp::cpp_object_initializer(.self,.refClassDef, ...) | ||
| else Rcpp::cpp_object_dummy(.self, .refClassDef) # #nocov | ||
| } | ||
| ) | ||
| rm( .self, .refClassDef ) | ||
| generator <- methods::setRefClass( clname, | ||
| fields = fields, | ||
| contains = "C++Object", | ||
| methods = methods, | ||
| where = where | ||
| ) | ||
|
|
||
| classDef <- methods::getClass(clname) | ||
| classDef <- generator$def | ||
| ## non-public (static) fields in class representation | ||
| ## <fixme> Should these become real fields? </fixme> | ||
| fields <- classDef@fieldPrototypes | ||
|
|
@@ -268,7 +270,7 @@ Module <- function( module, PACKAGE = methods::getPackageName(where), where = to | |
| } # #nocov end | ||
|
|
||
| # promoting show to S4 | ||
| if( any( grepl( "show", names(CLASS@methods) ) ) ){ | ||
| if( "show" %in% names(CLASS@methods) ){ | ||
| setMethod( "show", clname, function(object) object$show(), where = where ) # #nocov | ||
| } | ||
|
|
||
|
|
@@ -281,7 +283,10 @@ Module <- function( module, PACKAGE = methods::getPackageName(where), where = to | |
| CLASS <- classes[[i]] | ||
| clname <- [email protected] | ||
| demangled_name <- sub( "^Rcpp_", "", clname ) | ||
| .classes_map[[ CLASS@typeid ]] <- storage[[ demangled_name ]] <- .get_Module_Class( module, demangled_name, xp ) | ||
| # reuse the C++Class object already built by Module__classes_info | ||
| # rather than rebuilding it (and all of its method/field objects) | ||
| CLASS@generator <- generators[[ clname ]] | ||
| .classes_map[[ CLASS@typeid ]] <- storage[[ demangled_name ]] <- CLASS | ||
|
|
||
| # exposing enums values as CLASS.VALUE | ||
| # (should really be CLASS$value but I don't know how to do it) | ||
|
|
@@ -299,24 +304,21 @@ Module <- function( module, PACKAGE = methods::getPackageName(where), where = to | |
| functions <- .Call( Module__functions_names, xp ) | ||
| for( fun in functions ){ | ||
| storage[[ fun ]] <- .get_Module_function( module, fun, xp ) | ||
|
|
||
| # register as(FROM, TO) methods | ||
| converter_rx <- "^[.]___converter___(.*)___(.*)$" | ||
| if( length( matches <- grep( converter_rx, functions ) ) ){ # #nocov start | ||
| for( i in matches ){ | ||
| fun <- functions[i] | ||
| from <- sub( converter_rx, "\\1", fun ) | ||
| to <- sub( converter_rx, "\\2", fun ) | ||
| converter <- function( from ){} | ||
| body( converter ) <- substitute( { CONVERT(from) }, | ||
| list( CONVERT = storage[[fun]] ) | ||
| ) | ||
| setAs( from, to, converter, where = where ) | ||
| } | ||
| } # #nocov end | ||
|
|
||
| } | ||
|
|
||
| # register as(FROM, TO) methods once storage holds every function: the | ||
| # converter body captures storage[[fun]] by value via substitute() | ||
| converter_rx <- "^[.]___converter___(.*)___(.*)$" | ||
| for( fun in grep( converter_rx, functions, value = TRUE ) ){ # #nocov start | ||
| from <- sub( converter_rx, "\\1", fun ) | ||
| to <- sub( converter_rx, "\\2", fun ) | ||
| converter <- function( from ){} | ||
| body( converter ) <- substitute( { CONVERT(from) }, | ||
| list( CONVERT = storage[[fun]] ) | ||
| ) | ||
| setAs( from, to, converter, where = where ) | ||
| } # #nocov end | ||
|
|
||
| assign( "storage", storage, envir = as.environment(module) ) | ||
| module | ||
| } | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Always appreciate additions to ChangeLog; I try to keep each bullet point to two lines but we can do that in a post-processing step.