Rcpp Version 0.12.12
Promise.h
Go to the documentation of this file.
1 // -*- mode: C++; c-indent-level: 4; c-basic-offset: 4; indent-tabs-mode: nil; -*-
2 //
3 // Promise.h: Rcpp R/C++ interface class library -- promises (PROMSXP)
4 //
5 // Copyright (C) 2010 - 2013 Dirk Eddelbuettel and Romain Francois
6 //
7 // This file is part of Rcpp.
8 //
9 // Rcpp is free software: you can redistribute it and/or modify it
10 // under the terms of the GNU General Public License as published by
11 // the Free Software Foundation, either version 2 of the License, or
12 // (at your option) any later version.
13 //
14 // Rcpp is distributed in the hope that it will be useful, but
15 // WITHOUT ANY WARRANTY; without even the implied warranty of
16 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 // GNU General Public License for more details.
18 //
19 // You should have received a copy of the GNU General Public License
20 // along with Rcpp. If not, see <http://www.gnu.org/licenses/>.
21 
22 #ifndef Rcpp_Promise_h
23 #define Rcpp_Promise_h
24 
25 namespace Rcpp{
26 
27  RCPP_API_CLASS(Promise_Impl) {
28  public:
29  RCPP_GENERATE_CTOR_ASSIGN(Promise_Impl)
30 
31  Promise_Impl( SEXP x){
32  if( TYPEOF(x) != PROMSXP) {
33  const char* fmt = "Not a promise: [type = %s].";
34  throw not_compatible(fmt, Rf_type2char(TYPEOF(x)));
35  }
36 
37  Storage::set__(x) ;
38  }
39 
43  int seen() const {
44  return PRSEEN(Storage::get__());
45  }
46 
50  SEXP value() const{
51  SEXP val = PRVALUE( Storage::get__() ) ;
52  if( val == R_UnboundValue ) throw unevaluated_promise() ;
53  return val ;
54  }
55 
56  bool was_evaluated() const {
57  return PRVALUE(Storage::get__()) != R_UnboundValue ;
58  }
59 
63  ExpressionVector expression() const {
64  return ExpressionVector(PRCODE( Storage::get__() )) ;
65  }
66 
70  Environment environment() const {
71  return Environment( PRENV(Storage::get__() ) ) ;
72  }
73 
74  inline void update(SEXP data){}
75 
76  } ;
77 
78  typedef Promise_Impl<PreserveStorage> Promise ;
79 
80 } // namespace
81 
82 #endif
#define RCPP_GENERATE_CTOR_ASSIGN(__CLASS__)
Definition: interface.h:21
Vector< EXPRSXP > ExpressionVector
Definition: instantiation.h:38
RCPP_API_CLASS(DottedPair_Impl)
Rcpp API.
Definition: algo.h:28
Environment_Impl< PreserveStorage > Environment
Definition: Environment.h:401
void update(SEXP)
Definition: Environment.h:400
Promise_Impl< PreserveStorage > Promise
Definition: Promise.h:76