Add support for cpp11::linking_to

Fixes #48

Author: jimhester

DESCRIPTION

@@ -36,6 +36,7 @@ Suggests:
     knitr,
     lobstr,
     mockery,
+    progress,
     rmarkdown,
     scales,
     testthat,

NEWS.md

@@ -1,5 +1,7 @@
 # cpp11 (development version)
 
+* `cpp_source()`, `cpp_function()` and `cpp_eval()` now support `[[cpp11::linking_to()]]` syntax to link to third party packages with C++ headers. (#48)
+
 * `safe[]` can now work with functions that return any type (#70, @bkietz)
 
 * cpp11 is now able to compile on gcc 4.8.5 (#69, @bkietz)

R/source.R

@@ -4,6 +4,10 @@
 #' [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.
+#'
 #' @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.
@@ -30,6 +34,30 @@
 #'   ')
 #'
 #' num_odd(as.integer(c(1:10, 15, 23)))
+#'
+#' if (require("progress")) {
+#'
+#' cpp_source(
+#'   code = '
+#' #include <cpp11/R.hpp>
+#' #include <RProgress.h>
+#'
+#' [[cpp11::linking_to(progress)]]
+#'
+#' [[cpp11::register]] void
+#' show_progress() {
+#'   RProgress::RProgress pb("Downloading [: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) {
@@ -65,7 +93,9 @@ cpp_source <- function(file, code = NULL, env = parent.frame(), clean = TRUE, qu
   cpp_path <- file.path(dir, "src", "cpp11.cpp")
   brio::write_lines(c('#include "cpp11/declarations.hpp"', "using namespace cpp11;", cpp_functions_definitions), cpp_path)
 
-  includes <- generate_include_paths("cpp11")
+  linking_to <- union(get_linking_to(all_decorations), "cpp11")
+
+  includes <- generate_include_paths(linking_to)
 
   if (isTRUE(clean)) {
     on.exit(unlink(dir, recursive = TRUE))
@@ -142,3 +172,13 @@ cpp_eval <- function(code, env = parent.frame(), clean = TRUE, quiet = TRUE) {
     quiet = quiet)
   f()
 }
+
+get_linking_to <- function(decorations) {
+  out <- decorations[decorations$decoration == "cpp11::linking_to", ]
+
+  if (NROW(decorations) == 0) {
+    return(character())
+  }
+
+  as.character(unlist(out$params))
+}

cpp11test/src/sum.cpp

@@ -1,7 +1,10 @@
 #include <numeric>
 #include "cpp11/doubles.hpp"
 
-[[cpp11::register]] double sum_dbl_for_(cpp11::doubles x) {
+[[cpp11::linking_to(foo)]]
+
+[[cpp11::register]] double
+sum_dbl_for_(cpp11::doubles x) {
   double sum = 0.;
   R_xlen_t n = x.size();
   for (R_xlen_t i = 0; i < n; ++i) {