Rework in terms of an affirming -DHaveBlp and streamline code

Author: eddelbuettel

ChangeLog

@@ -1,3 +1,26 @@
+2025-03-14  Dirk Eddelbuettel  <edd@debian.org>
+
+	* src/authenticate.cpp: Redefine in terms of -DHaveBlp flag and bring
+	if/else inside the function itself
+        * src/bdh.cpp: Idem
+        * src/bdp.cpp: Idem
+        * src/bds.cpp: Idem
+        * src/beqs.cpp: Idem
+        * src/blpConnect.cpp: Idem
+        * src/blpVersion.cpp: Idem
+        * src/blpapi_utils.cpp: Idem
+        * src/bsrch.cpp: Idem
+        * src/fieldsearch.cpp: Idem
+        * src/getBars.cpp: Idem
+        * src/getFieldInfo.cpp: Idem
+        * src/getTicks.cpp: Idem
+        * src/lookup.cpp: Idem
+        * src/subscribe.cpp: Idem
+
+	* src/blpVersion.cpp: Define simple haveBlp() helper
+	* man/haveBlp.Rd: Documentation for haveBlp()
+	* R/init.R: Use more explicit haveBlp()
+
 2025-03-13  Dirk Eddelbuettel  <edd@debian.org>
 
 	* DESCRIPTION (Version, Date): Roll micro version and date

R/RcppExports.R

@@ -59,6 +59,15 @@ getRuntimeVersion <- function() {
     .Call(`_Rblpapi_getRuntimeVersion`)
 }
 
+#' This function returns a boolean indicating whether Blp support is available.
+#'
+#' @title Get Blp availability in current build
+#' @return A logical indicating whether Blp was available at build.
+#' @author Dirk Eddelbuettel
+haveBlp <- function() {
+    .Call(`_Rblpapi_haveBlp`)
+}
+
 bsrch_Impl <- function(con, domain, limit, verbose = FALSE) {
     .Call(`_Rblpapi_bsrch_Impl`, con, domain, limit, verbose)
 }

R/init.R

@@ -21,16 +21,12 @@
 .pkgenv <- new.env(parent=emptyenv())
 
 .onAttach <- function(libname, pkgname) {
-    hrd <- getHeaderVersion()
-    rtm <- getRuntimeVersion()
-    if (nchar(hrd) + nchar(rtm) == 0) {
-        packageStartupMessage("No Blp available so no Rblapi functionality.")
-    } else {
+    if (haveBlp()) {
         packageStartupMessage(paste0("Rblpapi version ", packageVersion("Rblpapi"),
-                                     " using Blpapi headers ", hrd, " and run-time ", rtm, "."))
+                                     " using Blpapi headers ", getHeaderVersion(),
+                                     " and run-time ", getRuntimeVersion(), "."))
         packageStartupMessage(paste0("Please respect the Bloomberg licensing agreement ",
                                      "and terms of service."))
-
         if (getOption("blpAutoConnect", FALSE)) {
             con <- blpConnect()
             if (getOption("blpVerbose", FALSE)) {
@@ -49,5 +45,7 @@
         }
         assign("con", con, envir=.pkgenv)
         assign("blpAuth", blpAuth, envir=.pkgenv)
+    } else {
+        packageStartupMessage("No Blp available so no Rblapi functionality.")
     }
 }

man/blpAuthenticate.Rd

@@ -2,7 +2,7 @@
 ##
 ##  Makefile.win -- Windows build system
 ##
-##  Copyright (C) 2015 - 2024  Whit Armstrong and Dirk Eddelbuettel
+##  Copyright (C) 2015 - 2025  Whit Armstrong and Dirk Eddelbuettel
 ##
 ##  This file is part of Rblpapi
 ##
@@ -28,8 +28,7 @@ else
 endif
 
 ## Standard compiler / linker flags including windows flavor
-# CXX_STD = CXX11
-PKG_CPPFLAGS = -I../inst/include -I.
+PKG_CPPFLAGS = -I../inst/include -I. -DHaveBlp
 PKG_LIBS = -lblpapi3_${WIN} -L${FLV}
 
 

man/getTicks.Rd

@@ -98,7 +98,7 @@ BEGIN_RCPP
 END_RCPP
 }
 // beqs_Impl
-DataFrame beqs_Impl(SEXP con, std::string screenName, std::string screenType, std::string group, std::string pitdate, std::string languageId, bool verbose);
+Rcpp::DataFrame beqs_Impl(SEXP con, std::string screenName, std::string screenType, std::string group, std::string pitdate, std::string languageId, bool verbose);
 RcppExport SEXP _Rblpapi_beqs_Impl(SEXP conSEXP, SEXP screenNameSEXP, SEXP screenTypeSEXP, SEXP groupSEXP, SEXP pitdateSEXP, SEXP languageIdSEXP, SEXP verboseSEXP) {
 BEGIN_RCPP
     Rcpp::RObject rcpp_result_gen;
@@ -148,8 +148,18 @@ BEGIN_RCPP
     return rcpp_result_gen;
 END_RCPP
 }
+// haveBlp
+bool haveBlp();
+RcppExport SEXP _Rblpapi_haveBlp() {
+BEGIN_RCPP
+    Rcpp::RObject rcpp_result_gen;
+    Rcpp::RNGScope rcpp_rngScope_gen;
+    rcpp_result_gen = Rcpp::wrap(haveBlp());
+    return rcpp_result_gen;
+END_RCPP
+}
 // bsrch_Impl
-DataFrame bsrch_Impl(SEXP con, std::string domain, std::string limit, bool verbose);
+Rcpp::DataFrame bsrch_Impl(SEXP con, std::string domain, std::string limit, bool verbose);
 RcppExport SEXP _Rblpapi_bsrch_Impl(SEXP conSEXP, SEXP domainSEXP, SEXP limitSEXP, SEXP verboseSEXP) {
 BEGIN_RCPP
     Rcpp::RObject rcpp_result_gen;
@@ -264,6 +274,7 @@ static const R_CallMethodDef CallEntries[] = {
     {"_Rblpapi_blpConnect_Impl", (DL_FUNC) &_Rblpapi_blpConnect_Impl, 4},
     {"_Rblpapi_getHeaderVersion", (DL_FUNC) &_Rblpapi_getHeaderVersion, 0},
     {"_Rblpapi_getRuntimeVersion", (DL_FUNC) &_Rblpapi_getRuntimeVersion, 0},
+    {"_Rblpapi_haveBlp", (DL_FUNC) &_Rblpapi_haveBlp, 0},
     {"_Rblpapi_bsrch_Impl", (DL_FUNC) &_Rblpapi_bsrch_Impl, 4},
     {"_Rblpapi_fieldSearch_Impl", (DL_FUNC) &_Rblpapi_fieldSearch_Impl, 2},
     {"_Rblpapi_getBars_Impl", (DL_FUNC) &_Rblpapi_getBars_Impl, 8},

man/haveBlp.Rd

@@ -20,8 +20,7 @@
 //  You should have received a copy of the GNU General Public License
 //  along with Rblpapi.  If not, see <http://www.gnu.org/licenses/>.
 
-#if !defined(NoBlpHere)
-
+#if defined(HaveBlp)
 #include <string>
 #include <blpapi_defs.h>
 #include <blpapi_element.h>
@@ -32,7 +31,6 @@
 #include <blpapi_session.h>
 #include <blpapi_event.h>
 #include <blpapi_message.h>
-#include <Rcpp.h>
 #include <finalizers.h>
 #include <blpapi_utils.h>
 
@@ -180,27 +178,26 @@ Identity* authenticateWithApp(SEXP con_) {
     }
     return identity_p;
 }
+#else
+#include <Rcpp/Lightest>
+#endif
 
 // Simpler interface
 //
 // [[Rcpp::export]]
-SEXP authenticate_Impl(SEXP con_, SEXP uuid_, SEXP ip_address_, SEXP is_auth_id_,
-                       SEXP app_name_) {
+SEXP authenticate_Impl(SEXP con_, SEXP uuid_, SEXP ip_address_, SEXP is_auth_id_, SEXP app_name_) {
+#if defined(HaveBlp)
     Identity* identity_p = NULL;
     if (uuid_ == R_NilValue) {
         identity_p = authenticateWithApp(con_);
     } else {
         identity_p = authenticateWithId(con_, uuid_, ip_address_, is_auth_id_, app_name_);
     }
-    if(identity_p == NULL) { Rcpp::stop("Identity pointer is null\n"); }
+    if (identity_p == NULL) {
+        Rcpp::stop("Identity pointer is null\n");
+    }
     return createExternalPointer<Identity>(identity_p, identityFinalizer, "blpapi::Identity*");
-}
-
-#else // ie if defined(NoBlpHere)
-
-#include <Rcpp/Lightest>
-SEXP authenticate_Impl(SEXP con_, SEXP uuid_, SEXP ip_address_, SEXP is_auth_id_, SEXP app_name_) {
+#else // ie no Blp
     return R_NilValue;
-}
-
 #endif
+}

src/Makevars.win

@@ -19,8 +19,7 @@
 //  You should have received a copy of the GNU General Public License
 //  along with Rblpapi.  If not, see <http://www.gnu.org/licenses/>.
 
-#if !defined(NoBlpHere)
-
+#if defined(HaveBlp)
 #include <vector>
 #include <string>
 #include <blpapi_session.h>
@@ -29,7 +28,6 @@
 #include <blpapi_event.h>
 #include <blpapi_message.h>
 #include <blpapi_element.h>
-#include <Rcpp.h>
 #include <blpapi_utils.h>
 
 using BloombergLP::blpapi::Session;
@@ -89,6 +87,9 @@ Rcpp::List HistoricalDataResponseToDF(Event& event, const std::vector<std::strin
     }
     return res;
 }
+#else
+#include <Rcpp/Lightest>
+#endif
 
 // Simpler interface with std::vector<std::string> thanks to Rcpp::Attributes
 // [[Rcpp::export]]
@@ -100,6 +101,8 @@ Rcpp::List bdh_Impl(SEXP con_,
                     bool verbose, SEXP identity_,
                     bool int_as_double) {
 
+#if defined(HaveBlp)
+
     Session* session =
         reinterpret_cast<Session*>(checkExternalPointer(con_,"blpapi::Session*"));
 
@@ -189,19 +192,8 @@ Rcpp::List bdh_Impl(SEXP con_,
     }
     ans.attr("names") = ans_names;
     return ans;
-}
 
-#else // ie if defined(NoBlpHere)
-
-#include <Rcpp/Lightest>
-Rcpp::List bdh_Impl(SEXP con_,
-                    std::vector<std::string> securities,
-                    std::vector<std::string> fields,
-                    std::string start_date_, SEXP end_date_,
-                    SEXP options_, SEXP overrides_,
-                    bool verbose, SEXP identity_,
-                    bool int_as_double) {
+#else // ie no Blp
     return Rcpp::List();
-}
-
 #endif
+}