Implement a clean facade API #19
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Buffer::OutOfMemoryError has exactly the same semantics as standard C++ std::bad_alloc. ancient can already throw std::bad_alloc (it is thrown by e.g. std::make_unique) and thus client code already has to catch std::bad_alloc if it wants to deal with out-of-memory situations anyway. Splitting out-of-memory condition into 2 different exceptions only complicates client code for no obvious gain.
* Add a new single public API header <ancient/ancient.hpp>.
* Use inline namespace APIv2, just in case this ever needs to be reworked without breaking old ABI.
* Namespace all internal symbols into namespace ancient::internal (mainly to avoid name conflict between public Decompressor wrapper and internal Decompressor).
* Move Decompressor.hpp and Buffer.hpp back to their original locations.
* Move exception classes out of public Decompressor class (retain internal aliases in order to reduce diff noise).
* Completely shield external API from internal Decompressor API or ABI changes by using a pimpl-idiom with a publicly opaque type.
* In the public interface, do not expose a static create function, but instead handle construction in the constructor because the only failure case for create() is an exception anyway. We can do that externally now, as the externally visible Decompressor is not a polymorphic type anymore.
* Add a WrappedVectorBuffer that implements a Buffer interface around a reference to std::vector<uint8_t>.
* Avoid exposing any internal Buffer class and only use std::vector<uint8_t> or (const uint8_t*,size_t) tuples in public API.
* Add a new and simpler Decompressor::decompress() that handles allocation internally and returns the data instead of filling a pre-allocated out parameter.
This is efficient since C++11 even in the case where the compiler does not do named return value optimization because C++11 specifies that returned data is moved if possible, and std::vector<uint8_t> is moveable.
* Remove old Decompressor::decompress() from public interface.
* Use std::optional<size_t> for getPackedSize(), getRawSize(), getImageSize(), and getImageOffset() in order to allow distinguishing actual 0 from "information not available/applicable".
* Rewrite main.cpp to new API.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #18.