martin-olivier / dylib

C++ cross-platform wrapper around dynamic loading of shared libraries (dll, so, dylib)

https://conan.io/center/recipes/dylib

MIT License

293 stars 44 forks source link

feat: add_filename_decorations and no_filename_decorations constants #52

Closed martin-olivier closed 2 years ago

martin-olivier commented 2 years ago

Description

Public members dylib::add_filename_decorations and dylib::no_filename_decorations have been added
Documentation has been updated following those changes
Tests have been updated following those changes
Private dylib members have been renamed

Changes include

[ ] Bugfix (non-breaking change that solves an issue)
[X] New feature (non-breaking change that adds functionality)
[ ] Breaking change (change that is not backwards-compatible and/or changes current functionality)

codecov[bot] commented 2 years ago

Codecov Report

Merging #52 (d4be960) into v2.X.X (657cd9f) will not change coverage. The diff coverage is 100.00%.

@@            Coverage Diff            @@
##            v2.X.X       #52   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            1         1           
  Lines           57        55    -2     
  Branches         3         3           
=========================================
- Hits            57        55    -2

Impacted Files	Coverage Δ
include/dylib.hpp	`100.00% <100.00%> (ø)`

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 657cd9f...d4be960. Read the comment docs.

eyalroz commented 2 years ago

So, let's "bikeshed" the choice of name a little. Think of someone who reads:

dylib("foo", dylib::add_decorations)

it is not obvious which decorations this regards. We know they are filename decorations, but the reader may not. It's probably better to make the name longer than it not being clear. So dylib::add_filename_decorations or dylib::decorate_filename perhaps? And dylib::no_filename_decorations?