Merge branch 'master' of github.com:RcppCore/Rcpp

Author: eddelbuettel

ChangeLog

@@ -6,6 +6,19 @@
 	* vignettes/Rcpp-extending.Rnw: Idem 
 	* vignettes/Rcpp-sugar.Rnw: Idem 
 
+2014-01-31  JJ Allaire  <[email protected]>
+
+        * R/Attributes.R: Embedded R code chunks in sourceCpp are now
+	executed within the working directory of the C++ source file.
+
+2014-01-31  Dirk Eddelbuettel  <[email protected]>
+
+	* man/Rcpp.package.skeleton.Rd: Also updated
+
+2014-01-30  Dirk Eddelbuettel  <[email protected]>
+
+	* vignettes/Rcpp-package.Rnw: Updates for upcoming release
+
 2014-01-28  Dirk Eddelbuettel  <[email protected]>
 
 	* vignettes/Rcpp-FAQ.Rnw: Some updates for upcoming release

R/Attributes.R

@@ -24,12 +24,16 @@ sourceCpp <- function(file = "",
                       showOutput = verbose,
                       verbose = getOption("verbose")) {
 
-    # resolve code into a file if necessary
+    # resolve code into a file if necessary. also track the working
+    # directory to source the R embedded code chunk within
     if (!missing(code)) {
+        rWorkingDir <- getwd() 
         file <- tempfile(fileext = ".cpp")
         con <- file(file, open = "w")
         writeLines(code, con)
         close(con)
+    } else {
+        rWorkingDir <- dirname(file)
     }
 
     # resolve the file path
@@ -167,6 +171,7 @@ sourceCpp <- function(file = "",
     # source the embeddedR
     if (length(context$embeddedR) > 0) {
         srcConn <- textConnection(context$embeddedR)
+        setwd(rWorkingDir) # will be reset by previous on.exit handler
         source(file=srcConn, echo=TRUE)
     }
 

inst/NEWS.Rd

@@ -29,9 +29,14 @@
       \item New \code{checkUserInterrupt()} function that provides a C++ friendly 
       implementation of \code{R_CheckUserInterrupt}.
     }
+    \item Changes in Rcpp attributes:
+    \itemize{
+      \item Embedded R code chunks in sourceCpp are now executed within
+      the working directory of the C++ source file.
+    }
     \item Changes in Rcpp documentation:
     \itemize{
-      \item The Rcpp-FAQ vignette have been updated and expanded.
+      \item The Rcpp-FAQ and Rcpp-package vignettes have been updated and expanded.
       \item Vignettes are now typeset with grey background for code boxes.
     }
   }

inst/skeleton/rcpp_hello_world.R

@@ -1,5 +1,5 @@
 
-rcpp_hello_world <- function(){
-	.Call( "rcpp_hello_world", PACKAGE = "@PKG@" )
+rcpp_hello_world <- function() {
+    .Call("rcpp_hello_world", PACKAGE = "@PKG@")
 }
 

inst/skeleton/rcpp_module.cpp

@@ -25,29 +25,29 @@ std::string hello() {
     throw std::range_error( "boom" ) ;
 }
 
-int bar( int x){
-    return x*2 ;
+int bar(int x) {
+    return x*2;
 }
 
-double foo( int x, double y){
-    return x * y ;
+double foo(int x, double y) {
+    return x * y;
 }
 
-void bla( ){
-    Rprintf( "hello\\n" ) ;
+void bla() {
+    Rprintf("hello\\n");
 }
 
-void bla1( int x){
-    Rprintf( "hello (x = %d)\\n", x ) ;
+void bla1(int x) {
+    Rprintf("hello (x = %d)\\n", x);
 }
 
-void bla2( int x, double y){
-    Rprintf( "hello (x = %d, y = %5.2f)\\n", x, y ) ;
+void bla2( int x, double y) {
+    Rprintf("hello (x = %d, y = %5.2f)\\n", x, y);
 }
 
 class World {
 public:
-    World() : msg("hello"){}
+    World() : msg("hello") {}
     void set(std::string msg) { this->msg = msg; }
     std::string greet() { return msg; }
 
@@ -60,25 +60,25 @@ class World {
 RCPP_MODULE(yada){
     using namespace Rcpp ;
 
-    function( "hello" , &hello  , "documentation for hello " );
-    function( "bla"   , &bla    , "documentation for bla " );
-    function( "bla1"  , &bla1   , "documentation for bla1 " );
-    function( "bla2"  , &bla2   , "documentation for bla2 " );
+    function("hello" , &hello  , "documentation for hello ");
+    function("bla"   , &bla    , "documentation for bla ");
+    function("bla1"  , &bla1   , "documentation for bla1 ");
+    function("bla2"  , &bla2   , "documentation for bla2 ");
 
     // with formal arguments specification
-    function( "bar"   , &bar    , 
-              List::create( _["x"] = 0.0 ), 
-              "documentation for bar " ) ;
-    function( "foo"   , &foo    , 
-              List::create( _["x"] = 1, _["y"] = 1.0 ),
-              "documentation for foo " ) ;	
+    function("bar"   , &bar    , 
+             List::create( _["x"] = 0.0), 
+             "documentation for bar ");
+    function("foo"   , &foo    , 
+             List::create( _["x"] = 1, _["y"] = 1.0),
+             "documentation for foo ");	
 
-    class_<World>( "World" )
+    class_<World>("World")
     // expose the default constructor
     .constructor()    
 
-    .method( "greet", &World::greet , "get the message" )
-    .method( "set", &World::set     , "set the message" )
+    .method("greet", &World::greet , "get the message")
+    .method("set", &World::set     , "set the message")
     ;
 }                     
 

man/Rcpp.package.skeleton.Rd

@@ -40,11 +40,12 @@ Rcpp.package.skeleton(name = "anRpackage", list = character(),
 \details{
 	In addition to \link[utils]{package.skeleton} : 
 
-	The \samp{DESCRIPTION} file gains a Depends line requesting that 
+	The \samp{DESCRIPTION} file gains an Imports line requesting that 
 	the package depends on Rcpp and a LinkingTo line so that the package
 	finds Rcpp header files.
 
-	The \samp{NAMESPACE}, if any, gains a \code{useDynLib} directive.
+	The \samp{NAMESPACE} gains a \code{useDynLib} directive as well
+	as an \code{importFrom(Rcpp, evalCpp} to ensure instantiation of Rcpp.
 
 	The \samp{src} directory is created if it does not exists and 
 	a \samp{Makevars} file is added setting the environment variables

vignettes/Rcpp-FAQ.Rnw

@@ -318,7 +318,7 @@ against.
 
 On the Linux command-line, you can do the following:\newline
 <<lang=bash>>=
-$ export PKG_LIBS=`Rscript -e "Rcpp:::LdFlags()"`
+$ export PKG_LIBS=`Rscript -e "Rcpp:::LdFlags()"`  # if Rcpp older than 0.11.0
 $ export PKG_CXXFLAGS=`Rscript -e "Rcpp:::CxxFlags()"`
 $ R CMD SHLIB myfile.cpp
 @
@@ -332,6 +332,20 @@ Dirk's older 'Intro to HPC with R' tutorial slides).  It is still not
 recommended as there are tools and automation mechanisms that can do the work
 for you.
 
+\pkg{Rcpp} versions 0.11.0 or later can do with the definition of
+\code{PKG\_LIBS} as a user-facing library is no longer needed (and hence no
+longer shipped with the package).  One still needs to set \code{PKG\_CXXFLAGS}
+to tell R where the \pkg{Rcpp} headers files are located.  
+
+Once \code{R CMD SHLIB} has created the dyanmically-loadable file (with
+extension \code{.so} on Linux, \code{.dylib} on OS X or \code{.dll} on
+Windows), it can be loaded in an R session via \rdoc{base}{dyn.load}, and the
+function can be executed via \rdoc{base}{.Call}.  Needless to say, we
+\emph{strongly} recommend using a package, or at least Rcpp Attributes as
+either approach takes care of a lot of these tedious and error-prone manual
+steps.
+
+
 \subsection{But R CMD SHLIB still does not work !}
 
 We have had reports in the past where build failures occurred when users had
@@ -387,13 +401,14 @@ complain to its vendor if you are still upset.
 OS X used to be a little more conservative with compiler versions as Apple
 stuck with gcc-4.2. Following the 'Mavericks' release, it is the opposite as
 only llvm is provide in Xcode---while the R build provided by CRAN still has
-hardwired settings for the gcc/g++ combination. Until that is resolved, users
-either need to create softlinks (say, in, \code{/usr/local/bin}) or override
-the \code{CC} and \code{CXX} variables via a file \code{~/.R/Makevars} or its
-system-equivalent in R's \code{etc/} directory.
+hardwired settings for the gcc/g++ combination. 
+
+Until that is resolved, users either need to create softlinks (say, in,
+\code{/usr/local/bin}) or override the \code{CC} and \code{CXX} variables via
+a file \code{~/.R/Makevars} or its system-equivalent in R's \code{etc/}
+directory. See the \code{r-sig-mac} mailing for further details.
 
-Compilation from source is recommended.  See the \code{r-sig-mac} mailing for
-further details. 
+Compilation from source is recommended.  
 %At the time of writing this paragraph (in the spring of 2011), \pkg{Rcpp}
 %(just like CRAN) supports all OS X releases greater or equal to 10.5.
 %However, building \pkg{Rcpp} from source (or building packages using