interface around {fmt} for cpp11::stop() and cpp11::warning()` message formatting

NEWS.md

@@ -5,6 +5,7 @@
 * Error messages now output original file name rather than the temporary file name (@sbearrows, #194)
 * Fixed bug when running `cpp_source()` on the same file more than once (@sbearrows, #202)
 * Removed internal instances of `cpp11::stop()` and replaced with C++ exceptions (@sbearrows, #203)
+* Added optionally formatting to `stop()` and `warning()` using {fmt} library (@sbearrows, #169)
 
 # cpp11 0.3.1
 

cpp11test/R/cpp11.R

@@ -8,6 +8,30 @@ data_frame_ <- function() {
   .Call(`_cpp11test_data_frame_`)
 }
 
+my_stop <- function(mystring, myarg) {
+  invisible(.Call(`_cpp11test_my_stop`, mystring, myarg))
+}
+
+my_warning <- function(mystring, myarg) {
+  invisible(.Call(`_cpp11test_my_warning`, mystring, myarg))
+}
+
+my_stop_n1fmt <- function(mystring) {
+  invisible(.Call(`_cpp11test_my_stop_n1fmt`, mystring))
+}
+
+my_stop_n2fmt <- function(mystring, myarg) {
+  invisible(.Call(`_cpp11test_my_stop_n2fmt`, mystring, myarg))
+}
+
+my_warning_n1fmt <- function(mystring) {
+  invisible(.Call(`_cpp11test_my_warning_n1fmt`, mystring))
+}
+
+my_warning_n2fmt <- function(mystring, myarg) {
+  invisible(.Call(`_cpp11test_my_warning_n2fmt`, mystring, myarg))
+}
+
 remove_altrep <- function(x) {
   .Call(`_cpp11test_remove_altrep`, x)
 }

cpp11test/src/cpp11.cpp

@@ -20,6 +20,54 @@ extern "C" SEXP _cpp11test_data_frame_() {
     return cpp11::as_sexp(data_frame_());
   END_CPP11
 }
+// errors_fmt.cpp
+void my_stop(std::string mystring, int myarg);
+extern "C" SEXP _cpp11test_my_stop(SEXP mystring, SEXP myarg) {
+  BEGIN_CPP11
+    my_stop(cpp11::as_cpp<cpp11::decay_t<std::string>>(mystring), cpp11::as_cpp<cpp11::decay_t<int>>(myarg));
+    return R_NilValue;
+  END_CPP11
+}
+// errors_fmt.cpp
+void my_warning(std::string mystring, std::string myarg);
+extern "C" SEXP _cpp11test_my_warning(SEXP mystring, SEXP myarg) {
+  BEGIN_CPP11
+    my_warning(cpp11::as_cpp<cpp11::decay_t<std::string>>(mystring), cpp11::as_cpp<cpp11::decay_t<std::string>>(myarg));
+    return R_NilValue;
+  END_CPP11
+}
+// errors.cpp
+void my_stop_n1fmt(std::string mystring);
+extern "C" SEXP _cpp11test_my_stop_n1fmt(SEXP mystring) {
+  BEGIN_CPP11
+    my_stop_n1fmt(cpp11::as_cpp<cpp11::decay_t<std::string>>(mystring));
+    return R_NilValue;
+  END_CPP11
+}
+// errors.cpp
+void my_stop_n2fmt(std::string mystring, std::string myarg);
+extern "C" SEXP _cpp11test_my_stop_n2fmt(SEXP mystring, SEXP myarg) {
+  BEGIN_CPP11
+    my_stop_n2fmt(cpp11::as_cpp<cpp11::decay_t<std::string>>(mystring), cpp11::as_cpp<cpp11::decay_t<std::string>>(myarg));
+    return R_NilValue;
+  END_CPP11
+}
+// errors.cpp
+void my_warning_n1fmt(std::string mystring);
+extern "C" SEXP _cpp11test_my_warning_n1fmt(SEXP mystring) {
+  BEGIN_CPP11
+    my_warning_n1fmt(cpp11::as_cpp<cpp11::decay_t<std::string>>(mystring));
+    return R_NilValue;
+  END_CPP11
+}
+// errors.cpp
+void my_warning_n2fmt(std::string mystring, std::string myarg);
+extern "C" SEXP _cpp11test_my_warning_n2fmt(SEXP mystring, SEXP myarg) {
+  BEGIN_CPP11
+    my_warning_n2fmt(cpp11::as_cpp<cpp11::decay_t<std::string>>(mystring), cpp11::as_cpp<cpp11::decay_t<std::string>>(myarg));
+    return R_NilValue;
+  END_CPP11
+}
 // find-intervals.cpp
 SEXP remove_altrep(SEXP x);
 extern "C" SEXP _cpp11test_remove_altrep(SEXP x) {
@@ -321,49 +369,6 @@ extern "C" SEXP _cpp11test_sum_dbl_accumulate2_(SEXP x_sxp) {
 
 extern "C" {
 /* .Call calls */
-extern SEXP _cpp11test_cpp11_add_vec_for_(SEXP, SEXP);
-extern SEXP _cpp11test_cpp11_insert_(SEXP);
-extern SEXP _cpp11test_cpp11_release_(SEXP);
-extern SEXP _cpp11test_cpp11_safe_(SEXP);
-extern SEXP _cpp11test_data_frame_();
-extern SEXP _cpp11test_findInterval2(SEXP, SEXP);
-extern SEXP _cpp11test_findInterval2_5(SEXP, SEXP);
-extern SEXP _cpp11test_findInterval3(SEXP, SEXP);
-extern SEXP _cpp11test_findInterval4(SEXP, SEXP);
-extern SEXP _cpp11test_gibbs_cpp(SEXP, SEXP);
-extern SEXP _cpp11test_gibbs_cpp2(SEXP, SEXP);
-extern SEXP _cpp11test_gibbs_rcpp(SEXP, SEXP);
-extern SEXP _cpp11test_gibbs_rcpp2(SEXP, SEXP);
-extern SEXP _cpp11test_grow_(SEXP);
-extern SEXP _cpp11test_protect_many_(SEXP);
-extern SEXP _cpp11test_protect_many_cpp11_(SEXP);
-extern SEXP _cpp11test_protect_many_preserve_(SEXP);
-extern SEXP _cpp11test_protect_many_rcpp_(SEXP);
-extern SEXP _cpp11test_protect_many_sexp_(SEXP);
-extern SEXP _cpp11test_protect_one_(SEXP, SEXP);
-extern SEXP _cpp11test_protect_one_cpp11_(SEXP, SEXP);
-extern SEXP _cpp11test_protect_one_preserve_(SEXP, SEXP);
-extern SEXP _cpp11test_protect_one_sexp_(SEXP, SEXP);
-extern SEXP _cpp11test_rcpp_grow_(SEXP);
-extern SEXP _cpp11test_rcpp_release_(SEXP);
-extern SEXP _cpp11test_rcpp_sum_dbl_accumulate_(SEXP);
-extern SEXP _cpp11test_rcpp_sum_dbl_for_(SEXP);
-extern SEXP _cpp11test_rcpp_sum_dbl_foreach_(SEXP);
-extern SEXP _cpp11test_rcpp_sum_int_for_(SEXP);
-extern SEXP _cpp11test_remove_altrep(SEXP);
-extern SEXP _cpp11test_row_sums(SEXP);
-extern SEXP _cpp11test_sum_dbl_accumulate2_(SEXP);
-extern SEXP _cpp11test_sum_dbl_accumulate_(SEXP);
-extern SEXP _cpp11test_sum_dbl_for2_(SEXP);
-extern SEXP _cpp11test_sum_dbl_for3_(SEXP);
-extern SEXP _cpp11test_sum_dbl_for_(SEXP);
-extern SEXP _cpp11test_sum_dbl_foreach2_(SEXP);
-extern SEXP _cpp11test_sum_dbl_foreach_(SEXP);
-extern SEXP _cpp11test_sum_int_accumulate_(SEXP);
-extern SEXP _cpp11test_sum_int_for2_(SEXP);
-extern SEXP _cpp11test_sum_int_for_(SEXP);
-extern SEXP _cpp11test_sum_int_foreach_(SEXP);
-extern SEXP _cpp11test_upper_bound(SEXP, SEXP);
 extern SEXP run_testthat_tests(SEXP);
 
 static const R_CallMethodDef CallEntries[] = {
@@ -381,6 +386,12 @@ static const R_CallMethodDef CallEntries[] = {
     {"_cpp11test_gibbs_rcpp",               (DL_FUNC) &_cpp11test_gibbs_rcpp,               2},
     {"_cpp11test_gibbs_rcpp2",              (DL_FUNC) &_cpp11test_gibbs_rcpp2,              2},
     {"_cpp11test_grow_",                    (DL_FUNC) &_cpp11test_grow_,                    1},
+    {"_cpp11test_my_stop",                  (DL_FUNC) &_cpp11test_my_stop,                  2},
+    {"_cpp11test_my_stop_n1fmt",            (DL_FUNC) &_cpp11test_my_stop_n1fmt,            1},
+    {"_cpp11test_my_stop_n2fmt",            (DL_FUNC) &_cpp11test_my_stop_n2fmt,            2},
+    {"_cpp11test_my_warning",               (DL_FUNC) &_cpp11test_my_warning,               2},
+    {"_cpp11test_my_warning_n1fmt",         (DL_FUNC) &_cpp11test_my_warning_n1fmt,         1},
+    {"_cpp11test_my_warning_n2fmt",         (DL_FUNC) &_cpp11test_my_warning_n2fmt,         2},
     {"_cpp11test_protect_many_",            (DL_FUNC) &_cpp11test_protect_many_,            1},
     {"_cpp11test_protect_many_cpp11_",      (DL_FUNC) &_cpp11test_protect_many_cpp11_,      1},
     {"_cpp11test_protect_many_preserve_",   (DL_FUNC) &_cpp11test_protect_many_preserve_,   1},

cpp11test/src/errors.cpp

@@ -0,0 +1,13 @@
+#include "cpp11/protect.hpp"
+using namespace cpp11;
+
+[[cpp11::register]] void my_stop_n1fmt(std::string mystring) { cpp11::stop(mystring); }
+[[cpp11::register]] void my_stop_n2fmt(std::string mystring, std::string myarg) {
+  cpp11::stop(mystring, myarg.c_str());
+}
+[[cpp11::register]] void my_warning_n1fmt(std::string mystring) {
+  cpp11::warning(mystring);
+}
+[[cpp11::register]] void my_warning_n2fmt(std::string mystring, std::string myarg) {
+  cpp11::warning(mystring, myarg.c_str());
+}

cpp11test/src/errors_fmt.cpp

@@ -0,0 +1,10 @@
+#define CPP11_USE_FMT
+#include "cpp11/protect.hpp"
+using namespace cpp11;
+
+[[cpp11::register]] void my_stop(std::string mystring, int myarg) {
+  cpp11::stop(mystring, myarg);
+}
+[[cpp11::register]] void my_warning(std::string mystring, std::string myarg) {
+  cpp11::warning(mystring, myarg);
+}

cpp11test/src/test-as.cpp

@@ -1,11 +1,11 @@
-#include <testthat.h>
-
 #include <deque>
 #include <string>
 #include <vector>
 
 #include "cpp11/declarations.hpp"
 
+#include <testthat.h>
+
 #include "Rcpp.h"
 
 context("as_cpp-C++") {

cpp11test/src/test-data_frame.cpp

@@ -1,9 +1,10 @@
-#include <testthat.h>
 #include "cpp11/data_frame.hpp"
 #include "cpp11/function.hpp"
 #include "cpp11/integers.hpp"
 #include "cpp11/strings.hpp"
 
+#include <testthat.h>
+
 context("data_frame-C++") {
   test_that("data_frame works") {
     auto getExportedValue = cpp11::package("base")["getExportedValue"];

cpp11test/src/test-doubles.cpp

@@ -1,10 +1,11 @@
-#include <testthat.h>
 #include <cstring>
 #include "cpp11/doubles.hpp"
 #include "cpp11/integers.hpp"
 #include "cpp11/sexp.hpp"
 #include "cpp11/strings.hpp"
 
+#include <testthat.h>
+
 context("doubles-C++") {
   test_that("doubles::r_vector(SEXP)") {
     cpp11::doubles x(Rf_allocVector(REALSXP, 2));

cpp11test/src/test-environment.cpp

@@ -1,10 +1,10 @@
-#include <testthat.h>
-
 #include "cpp11/as.hpp"
 #include "cpp11/environment.hpp"
 #include "cpp11/function.hpp"
 #include "cpp11/strings.hpp"
 
+#include <testthat.h>
+
 context("environment-C++") {
   test_that("environment works") {
     auto new_env = cpp11::package("base")["new.env"];

cpp11test/src/test-external_pointer.cpp

@@ -1,7 +1,8 @@
-#include <testthat.h>
 #include <iostream>
 #include "cpp11/external_pointer.hpp"
 
+#include <testthat.h>
+
 bool deleted = false;
 
 void deleter(int* ptr) {

cpp11test/src/test-function.cpp

@@ -1,6 +1,7 @@
-#include <testthat.h>
 #include "cpp11/function.hpp"
 
+#include <testthat.h>
+
 context("function-C++") {
   test_that("functions can be called") {
     auto median = cpp11::package("stats")["median"];

cpp11test/src/test-integers.cpp

@@ -1,9 +1,10 @@
-#include <testthat.h>
 #include "Rversion.h"
 #include "cpp11/doubles.hpp"
 #include "cpp11/integers.hpp"
 #include "cpp11/strings.hpp"
 
+#include <testthat.h>
+
 context("integers-C++") {
   test_that("as_integers(doubles)") {
     // TYPEOF(x) == INTSXP

cpp11test/src/test-list.cpp

@@ -1,11 +1,12 @@
-#include <testthat.h>
 #include "cpp11/doubles.hpp"
 #include "cpp11/integers.hpp"
 #include "cpp11/list.hpp"
 #include "cpp11/logicals.hpp"
 #include "cpp11/raws.hpp"
 #include "cpp11/strings.hpp"
 
+#include <testthat.h>
+
 context("list-C++") {
   test_that("list.push_back()") {
     cpp11::writable::list x;

cpp11test/src/test-list_of.cpp

@@ -1,9 +1,10 @@
-#include <testthat.h>
 #include "cpp11/doubles.hpp"
 #include "cpp11/list.hpp"
 #include "cpp11/list_of.hpp"
 #include "cpp11/strings.hpp"
 
+#include <testthat.h>
+
 context("list_of-C++") {
   test_that("list_of works") {
     using namespace cpp11::literals;

cpp11test/src/test-logicals.cpp

@@ -1,6 +1,7 @@
-#include <testthat.h>
 #include "cpp11/logicals.hpp"
 
+#include <testthat.h>
+
 context("logicals-C++") {
   test_that("logicals.push_back()") {
     cpp11::writable::logicals x;

cpp11test/src/test-matrix.cpp

@@ -1,9 +1,10 @@
-#include <testthat.h>
 #include "cpp11/doubles.hpp"
 #include "cpp11/function.hpp"
 #include "cpp11/integers.hpp"
 #include "cpp11/matrix.hpp"
 
+#include <testthat.h>
+
 context("matrix-C++") {
   test_that("matrix dim attributes are correct for writable matrices") {
     cpp11::writable::doubles_matrix x(5, 2);

cpp11test/src/test-nas.cpp

@@ -1,9 +1,10 @@
-#include <testthat.h>
 #include "cpp11/doubles.hpp"
 #include "cpp11/integers.hpp"
 #include "cpp11/r_bool.hpp"
 #include "cpp11/r_string.hpp"
 
+#include <testthat.h>
+
 context("nas-C++") {
   test_that("na integer") { expect_true(cpp11::na<int>() == NA_INTEGER); }
   test_that("na double") { expect_true(ISNA(cpp11::na<double>())); }

cpp11test/src/test-protect.cpp

@@ -1,3 +1,4 @@
+#define CPP11_USE_FMT
 #include "cpp11/protect.hpp"
 #include "testthat.h"
 
@@ -39,7 +40,9 @@ context("unwind_protect-C++") {
 
   test_that("stop throws an unwind_exception") {
     expect_error_as(cpp11::stop("error"), cpp11::unwind_exception);
-    expect_error_as(cpp11::stop("error: %s", "message"), cpp11::unwind_exception);
+    expect_error_as(cpp11::stop("error {}", "message"), cpp11::unwind_exception);
+    expect_error_as(cpp11::stop("error {a}", fmt::arg("a", "message")),
+                    cpp11::unwind_exception);
   }
 
   test_that("safe wraps R functions and works if there is an R error") {

cpp11test/src/test-raws.cpp

@@ -1,6 +1,7 @@
-#include <testthat.h>
 #include "cpp11/raws.hpp"
 
+#include <testthat.h>
+
 context("raws-C++") {
   test_that("raws.push_back()") {
     cpp11::writable::raws x;

cpp11test/src/test-sexp.cpp

@@ -1,6 +1,7 @@
-#include <testthat.h>
 #include "cpp11/list.hpp"
 
+#include <testthat.h>
+
 context("sexp-C++") {
   test_that("sexp initializer lists work") {
     using namespace cpp11::literals;

cpp11test/src/test-string.cpp

@@ -1,6 +1,7 @@
-#include <testthat.h>
 #include "cpp11/strings.hpp"
 
+#include <testthat.h>
+
 context("string-C++") {
   test_that("is_na(string)") {
     cpp11::r_string x("foo");

cpp11test/src/test-strings.cpp

@@ -1,8 +1,9 @@
-#include <testthat.h>
 #include <cstring>
 #include "cpp11/sexp.hpp"
 #include "cpp11/strings.hpp"
 
+#include <testthat.h>
+
 context("strings-C++") {
   test_that("strings.push_back()") {
     cpp11::writable::strings x;