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

C API symbols should be prefixed #172

Open
0u812 opened this issue Aug 21, 2015 · 3 comments
Open

C API symbols should be prefixed #172

0u812 opened this issue Aug 21, 2015 · 3 comments

Comments

@0u812
Copy link
Member

0u812 commented Aug 21, 2015

C APIs typically "solve" the namespace pollution problem by prefixing their functions and types with some epithet for the library. In our case it's rr. So, getNumRegisteredIntegrators becomes rr_getNumRegisteredIntegrators, simulate becomes rr_simulate. I suppose RRHandle can remain the same.

It's a shame this wasn't done already, mainly because we don't have much C expertise on the team. If a C programmer ever got hold of this code, they'd probably be offended by its namespace pollution. Every single symbol in the C API should be prefixed in some future release.

@0u812
Copy link
Member Author

0u812 commented Aug 21, 2015

Just to state the obvious: this breaks backwards compatibility.

@hsauro
Copy link

hsauro commented Aug 21, 2015

Hence we cannot change it at the moment. We can revisit this in version 2.0
of libroadrunner. I need some stability at the moment in the API since its
been too fluid in the last few years.

@hsauro
Copy link

hsauro commented Aug 21, 2015

PS One possibilityis to create a parrallel API with the rr prefix and to
deprecate the non-rr api in version 2.0 of libroadrunner.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants