forked from r-lib/cpp11
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathsource.R
More file actions
257 lines (223 loc) · 8.24 KB
/
source.R
File metadata and controls
257 lines (223 loc) · 8.24 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
#' Compile C++ code
#'
#' [cpp_source()] compiles and loads a single C++ file for use in R.
#' [cpp_function()] compiles and loads a single function for use in R.
#' [cpp_eval()] evaluates a single C++ expression and returns the result.
#'
#' Within C++ code you can use `[[cpp11::linking_to("pkgxyz")]]` to link to
#' external packages. This is equivalent to putting those packages in the
#' `LinkingTo` field in a package DESCRIPTION.
#'
#' Custom types, if any, should be declared in `<basename>_types.h` or
#' `<basename>_types.hpp`. If such file exists it will be automatically included
#' into the routine registration file (`cpp11.cpp`) during compilation.
#'
#' @param file A file containing C++ code to compile
#' @param code If non-null, the C++ code to compile
#' @param env The R environment where the R wrapping functions should be defined.
#' @param clean If `TRUE`, cleanup the files after sourcing
#' @param quiet If 'TRUE`, do not show compiler output
#' @param cxx_std The C++ standard to use, the `CXX_STD` make macro is set to
#' this value. The default value queries the `CXX_STD` environment variable, or
#' uses 'CXX11' if unset.
#' @param dir The directory to store the generated source files. `tempfile()` is
#' used by default. The directory will be removed if `clean` is `TRUE`.
#' @return For [cpp_source()] and `[cpp_function()]` the results of
#' [dyn.load()] (invisibly). For `[cpp_eval()]` the results of the evaluated
#' expression.
#' @examples
#'
#' cpp_source(
#' code = '#include "cpp11/integers.hpp"
#'
#' [[cpp11::register]]
#' int num_odd(cpp11::integers x) {
#' int total = 0;
#' for (int val : x) {
#' if ((val % 2) == 1) {
#' ++total;
#' }
#' }
#' return total;
#' }
#' ')
#'
#' num_odd(as.integer(c(1:10, 15, 23)))
#'
#' if (interactive() && require("progress")) {
#'
#' cpp_source(
#' code = '
#' #include <cpp11/R.hpp>
#' #include <RProgress.h>
#'
#' [[cpp11::linking_to("progress")]]
#'
#' [[cpp11::register]] void
#' show_progress() {
#' RProgress::RProgress pb("Processing [:bar] ETA: :eta");
#'
#' pb.tick(0);
#' for (int i = 0; i < 100; i++) {
#' usleep(2.0 / 100 * 1000000);
#' pb.tick();
#' }
#' }
#' ')
#'
#' show_progress()
#' }
#'
#' @export
cpp_source <- function(file, code = NULL, env = parent.frame(), clean = TRUE, quiet = TRUE, cxx_std = Sys.getenv("CXX_STD", "CXX11"), dir = tempfile()) {
stop_unless_installed(c("brio", "callr", "cli", "decor", "desc", "glue", "tibble", "vctrs"))
dir.create(dir, showWarnings = FALSE, recursive = TRUE)
dir.create(file.path(dir, "R"), showWarnings = FALSE)
dir.create(file.path(dir, "src"), showWarnings = FALSE)
if (!is.null(code)) {
tf <- tempfile(pattern = "code_", fileext = ".cpp")
file <- tf
if (isTRUE(clean)) {
on.exit(unlink(tf))
}
brio::write_lines(code, file)
}
if (!any(tools::file_ext(file) %in% c("cpp", "cc"))) {
stop("`file` must have a `.cpp` or `.cc` extension")
}
# In order to preserve error links to the original location we do the
# following:
# 1) We compile with the original base name in a tmp location
# 2) In case of an error replace all tmp locations with original location ()
# 3) Load schlib with a package name suffixed with _N where N is incremented
# on each compilation
name <- basename(file)
if (identical(name, "cpp11.cpp"))
name <- "cpp11x.cpp" # corner case
package <- tools::file_path_sans_ext(generate_cpp_name(file))
orig_dir <- normalizePath(dirname(file), winslash = "/")
new_dir <- normalizePath(file.path(dir, "src"), winslash = "/")
# file now points to another location
file.copy(file, file.path(new_dir, name))
#change variable name to reflect this
new_file_path <- file.path(new_dir, name)
new_file_name <- basename(new_file_path)
orig_file_path <- file.path(orig_dir, new_file_name)
suppressWarnings(
all_decorations <- decor::cpp_decorations(dir, is_attribute = TRUE)
)
#provide original path for error messages
check_valid_attributes(all_decorations, file = orig_file_path)
cli_suppress(
funs <- get_registered_functions(all_decorations, "cpp11::register")
)
cpp_functions_definitions <- generate_cpp_functions(funs, package = package)
basename <- tools::file_path_sans_ext(basename(file))
type_paths <- file.path(orig_dir, paste0(basename, "_", c("types.h", "types.hpp")))
type_paths <- type_paths[file.exists(type_paths)]
cpp_path <- file.path(dirname(new_file_path), "cpp11.cpp")
brio::write_lines(c(sprintf('#include "%s"', type_paths),
'#include "cpp11/declarations.hpp"',
"using namespace ::cpp11;",
cpp_functions_definitions),
cpp_path)
linking_to <- union(get_linking_to(all_decorations), "cpp11")
includes <- c(generate_include_paths(linking_to),
sprintf("-I'%s'", orig_dir))
if (isTRUE(clean)) {
on.exit(unlink(dir, recursive = TRUE), add = TRUE)
}
r_functions <- generate_r_functions(funs, package = package, use_package = TRUE)
makevars_content <- generate_makevars(includes, cxx_std)
brio::write_lines(makevars_content, file.path(new_dir, "Makevars"))
source_files <- normalizePath(c(new_file_path, cpp_path), winslash = "/")
res <- callr::rcmd("SHLIB", source_files, user_profile = TRUE, show = !quiet, wd = new_dir)
if (res$status != 0) {
error_messages <- res$stderr
# Substitute temporary file path with original file path
error_messages <- gsub(tools::file_path_sans_ext(new_file_path),
tools::file_path_sans_ext(orig_file_path),
error_messages, fixed = TRUE)
cat(error_messages)
stop("Compilation failed.", call. = FALSE)
}
# During compilation we keep original file name, but the name of the package
# and shared lib is suffixed with _N where N is incremented on every
# cpp_source.
slib_orig <- file.path(dir, "src", paste0(tools::file_path_sans_ext(name), .Platform$dynlib.ext))
slib_new <- file.path(dir, "src", paste0(package, .Platform$dynlib.ext))
file.rename(slib_orig, slib_new)
r_path <- file.path(dir, "R", "cpp11.R")
brio::write_lines(r_functions, r_path)
source(r_path, local = env)
dyn.load(slib_new, local = TRUE, now = TRUE)
}
the <- new.env(parent = emptyenv())
the$count <- 0L
generate_cpp_name <- function(name, loaded_dlls = c("cpp11", names(getLoadedDLLs()))) {
ext <- tools::file_ext(name)
root <- tools::file_path_sans_ext(basename(name))
count <- 2
new_name <- root
while(new_name %in% loaded_dlls) {
new_name <- sprintf("%s_%i", root, count)
count <- count + 1
}
sprintf("%s.%s", new_name, ext)
}
generate_include_paths <- function(packages) {
out <- character(length(packages))
for (i in seq_along(packages)) {
path <- system.file(package = packages[[i]], "include")
if (is_windows()) {
path <- utils::shortPathName(path)
}
out[[i]] <- paste0("-I", shQuote(path))
}
out
}
generate_makevars <- function(includes, cxx_std) {
c(sprintf("CXX_STD=%s", cxx_std), sprintf("PKG_CPPFLAGS=%s", paste0(includes, collapse = " ")))
}
#' @rdname cpp_source
#' @export
cpp_function <- function(code, env = parent.frame(), clean = TRUE, quiet = TRUE, cxx_std = Sys.getenv("CXX_STD", "CXX11")) {
cpp_source(code = paste(c('#include "cpp11.hpp"',
"using namespace ::cpp11;",
"namespace writable = ::cpp11::writable;",
"[[cpp11::register]]",
code),
collapse = "\n"),
env = env,
clean = clean,
quiet = quiet,
cxx_std = cxx_std
)
}
utils::globalVariables("f")
#' @rdname cpp_source
#' @export
cpp_eval <- function(code, env = parent.frame(), clean = TRUE, quiet = TRUE, cxx_std = Sys.getenv("CXX_STD", "CXX11")) {
cpp_source(code = paste(c('#include "cpp11.hpp"',
"using namespace ::cpp11;",
"namespace writable = ::cpp11::writable;",
"[[cpp11::register]]",
"SEXP f() { return as_sexp(",
code,
");",
"}"),
collapse = "\n"),
env = env,
clean = clean,
quiet = quiet,
cxx_std = cxx_std
)
f()
}
get_linking_to <- function(decorations) {
out <- decorations[decorations$decoration == "cpp11::linking_to", ]
if (NROW(decorations) == 0) {
return(character())
}
gsub("\"", "", as.character(unlist(out$params)))
}