Warn or error if Rcpp.h (and R.h) was included

Open
#142 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
45/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
cpp, r
Domain
tooling

Research direction

Start in RcppEigen.h and inspect how the Rcpp and R header guards are detected before Eigen is included. Trace the include order described in the issue, then confirm that including R.h or Rcpp.h before RcppEigen.h produces the intended warning without changing the normal direct-include path.

Written by the indexing model from the issue text.

Description

As discussed over in Rcpp in https://github.com/RcppCore/Rcpp/pull/1402 we are seeing some side effects from some package including R.h and later including possible also Rcpp.h and then RcppEigen.h leaving some of the masking of R's own error() function as Rf_error() to not be effective so that it later clashes with Eigen function error().

In general, it is always cleanest to just include RcppEigen.h as it does take care of both the others. For RcppArmadillo this once lead to issues to that it (very early on) switch to an actual compile error. We may do that one day but for now it might be a good idea to at least warn from RcppEigen.h if the header guards for either or both of Rcpp and R are seen.

Dominant language
C++
Stars
118
Forks
43
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from RcppCore/RcppEigen

All issues in RcppCore/RcppEigen

Similar issues

More C++ issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.