Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove pybind11 dependency from cpp library #40

Merged
merged 3 commits into from
Feb 23, 2022

Conversation

liambenson
Copy link
Contributor

Fixes: DATA-622

Description of Changes

The library shouldn't be dependent on pybind11, only the python bindings should.

Test Plan

Unit tests.

lib/ros_value.h Outdated
Comment on lines 14 to 17
namespace pybind11 {
struct buffer_info;
}

Copy link

@jaredjxyz jaredjxyz Feb 18, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm forward declarations can be a dangerous hole to go down - Our style guide says to avoid them whenever possible https://google.github.io/styleguide/cppguide.html#Forward_Declarations

Why do you need the forward declaration here? Can you structure this in a way that doesn't need it?

Copy link

@kashish-jain kashish-jain Feb 18, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed! Since this is a 3rd party library, it might just be better to not have a forward declaration. Do you need RosValue::getPrimitiveArrayBufferInfo() declaration in this file @liamembark? If not, then we can delete this forward declaration, I think.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ya so the underlying need for this is that the buffer_info object needs access to the underlying memory buffer, but this is a private member.
As a result, whatever is going to access this memory buffer needs to be declared along with the RosValue.
AFAIK this is always going to require forward declaration (if not let me know), but one alternative to forward declaring a piece of a third party library, I could instead forward declare a friend function that will be defined in the python library to provide access!

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Liam I'll DM you to discuss this a bit, I think I understand the problem but want to dig in just a little more

Copy link

@kashish-jain kashish-jain left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@liambenson liambenson merged commit 9942998 into master Feb 23, 2022
@liambenson liambenson deleted the liam/remove_pybind11_dep branch February 23, 2022 07:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants