Skip to content

Refactor into a unified state handling system #97

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.

Sign up for GitHub

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

Merged
mborland merged 4 commits into from
Nov 11, 2024
Merged

Refactor into a unified state handling system #97

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
03c9d4b
Add unified state enum class to utility
mborland Nov 11, 2024
f108f9b
Add state to docs
mborland Nov 11, 2024
e368343
Update useage of new states
mborland Nov 11, 2024
bb076b4
Update docs
mborland Nov 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/crypt.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ include::crypt/overview.adoc[]

include::crypt/api_reference.adoc[]

include::crypt/hasher_state.adoc[]
include::crypt/state.adoc[]

include::crypt/md5.adoc[]

Expand Down
2 changes: 1 addition & 1 deletion doc/crypt/api_reference.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ https://www.boost.org/LICENSE_1_0.txt

== Enums

- <<hasher_state, `hasher_state`>>
- <<state, `state`>>

== Constants

Expand Down
37 changes: 0 additions & 37 deletions doc/crypt/hasher_state.adoc
View file
Open in desktop

This file was deleted.

16 changes: 8 additions & 8 deletions doc/crypt/md5.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,34 +120,34 @@ class md5_hasher
void init();

template <typename ByteType>
BOOST_CRYPT_GPU_ENABLED inline auto process_byte(ByteType byte) noexcept -> hasher_state;
BOOST_CRYPT_GPU_ENABLED inline auto process_byte(ByteType byte) noexcept -> state;

template <typename ForwardIter>
BOOST_CRYPT_GPU_ENABLED inline auto process_bytes(ForwardIter buffer, size_t byte_count) noexcept -> hasher_state;
BOOST_CRYPT_GPU_ENABLED inline auto process_bytes(ForwardIter buffer, size_t byte_count) noexcept -> state;

#ifdef BOOST_CRYPT_HAS_STRING_VIEW

inline auto process_bytes(std::string_view str) noexcept -> hasher_state;
inline auto process_bytes(std::string_view str) noexcept -> state;

inline auto process_bytes(std::u16string_view str) noexcept -> hasher_state;
inline auto process_bytes(std::u16string_view str) noexcept -> state;

inline auto process_bytes(std::u32string_view str) noexcept -> hasher_state;
inline auto process_bytes(std::u32string_view str) noexcept -> state;

inline auto process_bytes(std::wstring_view str) noexcept -> hasher_state;
inline auto process_bytes(std::wstring_view str) noexcept -> state;

#endif // BOOST_CRYPT_HAS_STRING_VIEW

#ifdef BOOST_CRYPT_HAS_SPAN

template <typename T, boost::crypt::size_t extent>
inline auto process_bytes(std::span<T, extent> data) noexcept -> hasher_state;
inline auto process_bytes(std::span<T, extent> data) noexcept -> state;

#endif // BOOST_CRYPT_HAS_SPAN

#ifdef BOOST_CRYPT_HAS_CUDA

template <typename T, boost::crypt::size_t extent>
BOOST_CRYPT_GPU_ENABLED inline auto process_bytes(cuda::std::span<T, extent> data) noexcept -> hasher_state;
BOOST_CRYPT_GPU_ENABLED inline auto process_bytes(cuda::std::span<T, extent> data) noexcept -> state;

#endif // BOOST_CRYPT_HAS_CUDA

Expand Down
16 changes: 8 additions & 8 deletions doc/crypt/sha1.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,34 +118,34 @@ class sha1_hasher
void init();

template <typename ByteType>
BOOST_CRYPT_GPU_ENABLED inline auto process_byte(ByteType byte) noexcept -> hasher_state;
BOOST_CRYPT_GPU_ENABLED inline auto process_byte(ByteType byte) noexcept -> state;

template <typename ForwardIter>
BOOST_CRYPT_GPU_ENABLED inline auto process_bytes(ForwardIter buffer, size_t byte_count) noexcept -> hasher_state;
BOOST_CRYPT_GPU_ENABLED inline auto process_bytes(ForwardIter buffer, size_t byte_count) noexcept -> state;

#ifdef BOOST_CRYPT_HAS_STRING_VIEW

inline auto process_bytes(std::string_view str) noexcept -> hasher_state;
inline auto process_bytes(std::string_view str) noexcept -> state;

inline auto process_bytes(std::u16string_view str) noexcept -> hasher_state;
inline auto process_bytes(std::u16string_view str) noexcept -> state;

inline auto process_bytes(std::u32string_view str) noexcept -> hasher_state;
inline auto process_bytes(std::u32string_view str) noexcept -> state;

inline auto process_bytes(std::wstring_view str) noexcept -> hasher_state;
inline auto process_bytes(std::wstring_view str) noexcept -> state;

#endif // BOOST_CRYPT_HAS_STRING_VIEW

#ifdef BOOST_CRYPT_HAS_SPAN

template <typename T, boost::crypt::size_t extent>
inline auto process_bytes(std::span<T, extent> data) noexcept -> hasher_state;
inline auto process_bytes(std::span<T, extent> data) noexcept -> state;

#endif // BOOST_CRYPT_HAS_SPAN

#ifdef BOOST_CRYPT_HAS_CUDA

template <typename T, boost::crypt::size_t extent>
BOOST_CRYPT_GPU_ENABLED inline auto process_bytes(cuda::std::span<T, extent> data) noexcept -> hasher_state;
BOOST_CRYPT_GPU_ENABLED inline auto process_bytes(cuda::std::span<T, extent> data) noexcept -> state;

#endif // BOOST_CRYPT_HAS_CUDA

Expand Down
16 changes: 8 additions & 8 deletions doc/crypt/sha224.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,34 +118,34 @@ class sha224_hasher
void init();

template <typename ByteType>
BOOST_CRYPT_GPU_ENABLED inline auto process_byte(ByteType byte) noexcept -> hasher_state;
BOOST_CRYPT_GPU_ENABLED inline auto process_byte(ByteType byte) noexcept -> state;

template <typename ForwardIter>
BOOST_CRYPT_GPU_ENABLED inline auto process_bytes(ForwardIter buffer, size_t byte_count) noexcept -> hasher_state;
BOOST_CRYPT_GPU_ENABLED inline auto process_bytes(ForwardIter buffer, size_t byte_count) noexcept -> state;

#ifdef BOOST_CRYPT_HAS_STRING_VIEW

inline auto process_bytes(std::string_view str) noexcept -> hasher_state;
inline auto process_bytes(std::string_view str) noexcept -> state;

inline auto process_bytes(std::u16string_view str) noexcept -> hasher_state;
inline auto process_bytes(std::u16string_view str) noexcept -> state;

inline auto process_bytes(std::u32string_view str) noexcept -> hasher_state;
inline auto process_bytes(std::u32string_view str) noexcept -> state;

inline auto process_bytes(std::wstring_view str) noexcept -> hasher_state;
inline auto process_bytes(std::wstring_view str) noexcept -> state;

#endif // BOOST_CRYPT_HAS_STRING_VIEW

#ifdef BOOST_CRYPT_HAS_SPAN

template <typename T, boost::crypt::size_t extent>
inline auto process_bytes(std::span<T, extent> data) noexcept -> hasher_state;
inline auto process_bytes(std::span<T, extent> data) noexcept -> state;

#endif // BOOST_CRYPT_HAS_SPAN

#ifdef BOOST_CRYPT_HAS_CUDA

template <typename T, boost::crypt::size_t extent>
BOOST_CRYPT_GPU_ENABLED inline auto process_bytes(cuda::std::span<T, extent> data) noexcept -> hasher_state;
BOOST_CRYPT_GPU_ENABLED inline auto process_bytes(cuda::std::span<T, extent> data) noexcept -> state;

#endif // BOOST_CRYPT_HAS_CUDA

Expand Down
16 changes: 8 additions & 8 deletions doc/crypt/sha256.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,34 +118,34 @@ class sha256_hasher
void init();

template <typename ByteType>
BOOST_CRYPT_GPU_ENABLED inline auto process_byte(ByteType byte) noexcept -> hasher_state;
BOOST_CRYPT_GPU_ENABLED inline auto process_byte(ByteType byte) noexcept -> state;

template <typename ForwardIter>
BOOST_CRYPT_GPU_ENABLED inline auto process_bytes(ForwardIter buffer, size_t byte_count) noexcept -> hasher_state;
BOOST_CRYPT_GPU_ENABLED inline auto process_bytes(ForwardIter buffer, size_t byte_count) noexcept -> state;

#ifdef BOOST_CRYPT_HAS_STRING_VIEW

inline auto process_bytes(std::string_view str) noexcept -> hasher_state;
inline auto process_bytes(std::string_view str) noexcept -> state;

inline auto process_bytes(std::u16string_view str) noexcept -> hasher_state;
inline auto process_bytes(std::u16string_view str) noexcept -> state;

inline auto process_bytes(std::u32string_view str) noexcept -> hasher_state;
inline auto process_bytes(std::u32string_view str) noexcept -> state;

inline auto process_bytes(std::wstring_view str) noexcept -> hasher_state;
inline auto process_bytes(std::wstring_view str) noexcept -> state;

#endif // BOOST_CRYPT_HAS_STRING_VIEW

#ifdef BOOST_CRYPT_HAS_SPAN

template <typename T, boost::crypt::size_t extent>
inline auto process_bytes(std::span<T, extent> data) noexcept -> hasher_state;
inline auto process_bytes(std::span<T, extent> data) noexcept -> state;

#endif // BOOST_CRYPT_HAS_SPAN

#ifdef BOOST_CRYPT_HAS_CUDA

template <typename T, boost::crypt::size_t extent>
BOOST_CRYPT_GPU_ENABLED inline auto process_bytes(cuda::std::span<T, extent> data) noexcept -> hasher_state;
BOOST_CRYPT_GPU_ENABLED inline auto process_bytes(cuda::std::span<T, extent> data) noexcept -> state;

#endif // BOOST_CRYPT_HAS_CUDA

Expand Down
16 changes: 8 additions & 8 deletions doc/crypt/sha384.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,34 +118,34 @@ class sha384_hasher
void init();

template <typename ByteType>
BOOST_CRYPT_GPU_ENABLED inline auto process_byte(ByteType byte) noexcept -> hasher_state;
BOOST_CRYPT_GPU_ENABLED inline auto process_byte(ByteType byte) noexcept -> state;

template <typename ForwardIter>
BOOST_CRYPT_GPU_ENABLED inline auto process_bytes(ForwardIter buffer, size_t byte_count) noexcept -> hasher_state;
BOOST_CRYPT_GPU_ENABLED inline auto process_bytes(ForwardIter buffer, size_t byte_count) noexcept -> state;

#ifdef BOOST_CRYPT_HAS_STRING_VIEW

inline auto process_bytes(std::string_view str) noexcept -> hasher_state;
inline auto process_bytes(std::string_view str) noexcept -> state;

inline auto process_bytes(std::u16string_view str) noexcept -> hasher_state;
inline auto process_bytes(std::u16string_view str) noexcept -> state;

inline auto process_bytes(std::u32string_view str) noexcept -> hasher_state;
inline auto process_bytes(std::u32string_view str) noexcept -> state;

inline auto process_bytes(std::wstring_view str) noexcept -> hasher_state;
inline auto process_bytes(std::wstring_view str) noexcept -> state;

#endif // BOOST_CRYPT_HAS_STRING_VIEW

#ifdef BOOST_CRYPT_HAS_SPAN

template <typename T, boost::crypt::size_t extent>
inline auto process_bytes(std::span<T, extent> data) noexcept -> hasher_state;
inline auto process_bytes(std::span<T, extent> data) noexcept -> state;

#endif // BOOST_CRYPT_HAS_SPAN

#ifdef BOOST_CRYPT_HAS_CUDA

template <typename T, boost::crypt::size_t extent>
BOOST_CRYPT_GPU_ENABLED inline auto process_bytes(cuda::std::span<T, extent> data) noexcept -> hasher_state;
BOOST_CRYPT_GPU_ENABLED inline auto process_bytes(cuda::std::span<T, extent> data) noexcept -> state;

#endif // BOOST_CRYPT_HAS_CUDA

Expand Down
16 changes: 8 additions & 8 deletions doc/crypt/sha3_224.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,34 +118,34 @@ class sha3_224_hasher
void init();

template <typename ByteType>
BOOST_CRYPT_GPU_ENABLED inline auto process_byte(ByteType byte) noexcept -> hasher_state;
BOOST_CRYPT_GPU_ENABLED inline auto process_byte(ByteType byte) noexcept -> state;

template <typename ForwardIter>
BOOST_CRYPT_GPU_ENABLED inline auto process_bytes(ForwardIter buffer, size_t byte_count) noexcept -> hasher_state;
BOOST_CRYPT_GPU_ENABLED inline auto process_bytes(ForwardIter buffer, size_t byte_count) noexcept -> state;

#ifdef BOOST_CRYPT_HAS_STRING_VIEW

inline auto process_bytes(std::string_view str) noexcept -> hasher_state;
inline auto process_bytes(std::string_view str) noexcept -> state;

inline auto process_bytes(std::u16string_view str) noexcept -> hasher_state;
inline auto process_bytes(std::u16string_view str) noexcept -> state;

inline auto process_bytes(std::u32string_view str) noexcept -> hasher_state;
inline auto process_bytes(std::u32string_view str) noexcept -> state;

inline auto process_bytes(std::wstring_view str) noexcept -> hasher_state;
inline auto process_bytes(std::wstring_view str) noexcept -> state;

#endif // BOOST_CRYPT_HAS_STRING_VIEW

#ifdef BOOST_CRYPT_HAS_SPAN

template <typename T, boost::crypt::size_t extent>
inline auto process_bytes(std::span<T, extent> data) noexcept -> hasher_state;
inline auto process_bytes(std::span<T, extent> data) noexcept -> state;

#endif // BOOST_CRYPT_HAS_SPAN

#ifdef BOOST_CRYPT_HAS_CUDA

template <typename T, boost::crypt::size_t extent>
BOOST_CRYPT_GPU_ENABLED inline auto process_bytes(cuda::std::span<T, extent> data) noexcept -> hasher_state;
BOOST_CRYPT_GPU_ENABLED inline auto process_bytes(cuda::std::span<T, extent> data) noexcept -> state;

#endif // BOOST_CRYPT_HAS_CUDA

Expand Down
16 changes: 8 additions & 8 deletions doc/crypt/sha3_256.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,34 +118,34 @@ class sha3_256_hasher
void init();

template <typename ByteType>
BOOST_CRYPT_GPU_ENABLED inline auto process_byte(ByteType byte) noexcept -> hasher_state;
BOOST_CRYPT_GPU_ENABLED inline auto process_byte(ByteType byte) noexcept -> state;

template <typename ForwardIter>
BOOST_CRYPT_GPU_ENABLED inline auto process_bytes(ForwardIter buffer, size_t byte_count) noexcept -> hasher_state;
BOOST_CRYPT_GPU_ENABLED inline auto process_bytes(ForwardIter buffer, size_t byte_count) noexcept -> state;

#ifdef BOOST_CRYPT_HAS_STRING_VIEW

inline auto process_bytes(std::string_view str) noexcept -> hasher_state;
inline auto process_bytes(std::string_view str) noexcept -> state;

inline auto process_bytes(std::u16string_view str) noexcept -> hasher_state;
inline auto process_bytes(std::u16string_view str) noexcept -> state;

inline auto process_bytes(std::u32string_view str) noexcept -> hasher_state;
inline auto process_bytes(std::u32string_view str) noexcept -> state;

inline auto process_bytes(std::wstring_view str) noexcept -> hasher_state;
inline auto process_bytes(std::wstring_view str) noexcept -> state;

#endif // BOOST_CRYPT_HAS_STRING_VIEW

#ifdef BOOST_CRYPT_HAS_SPAN

template <typename T, boost::crypt::size_t extent>
inline auto process_bytes(std::span<T, extent> data) noexcept -> hasher_state;
inline auto process_bytes(std::span<T, extent> data) noexcept -> state;

#endif // BOOST_CRYPT_HAS_SPAN

#ifdef BOOST_CRYPT_HAS_CUDA

template <typename T, boost::crypt::size_t extent>
BOOST_CRYPT_GPU_ENABLED inline auto process_bytes(cuda::std::span<T, extent> data) noexcept -> hasher_state;
BOOST_CRYPT_GPU_ENABLED inline auto process_bytes(cuda::std::span<T, extent> data) noexcept -> state;

#endif // BOOST_CRYPT_HAS_CUDA

Expand Down
16 changes: 8 additions & 8 deletions doc/crypt/sha3_384.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,34 +118,34 @@ class sha3_384_hasher
void init();

template <typename ByteType>
BOOST_CRYPT_GPU_ENABLED inline auto process_byte(ByteType byte) noexcept -> hasher_state;
BOOST_CRYPT_GPU_ENABLED inline auto process_byte(ByteType byte) noexcept -> state;

template <typename ForwardIter>
BOOST_CRYPT_GPU_ENABLED inline auto process_bytes(ForwardIter buffer, size_t byte_count) noexcept -> hasher_state;
BOOST_CRYPT_GPU_ENABLED inline auto process_bytes(ForwardIter buffer, size_t byte_count) noexcept -> state;

#ifdef BOOST_CRYPT_HAS_STRING_VIEW

inline auto process_bytes(std::string_view str) noexcept -> hasher_state;
inline auto process_bytes(std::string_view str) noexcept -> state;

inline auto process_bytes(std::u16string_view str) noexcept -> hasher_state;
inline auto process_bytes(std::u16string_view str) noexcept -> state;

inline auto process_bytes(std::u32string_view str) noexcept -> hasher_state;
inline auto process_bytes(std::u32string_view str) noexcept -> state;

inline auto process_bytes(std::wstring_view str) noexcept -> hasher_state;
inline auto process_bytes(std::wstring_view str) noexcept -> state;

#endif // BOOST_CRYPT_HAS_STRING_VIEW

#ifdef BOOST_CRYPT_HAS_SPAN

template <typename T, boost::crypt::size_t extent>
inline auto process_bytes(std::span<T, extent> data) noexcept -> hasher_state;
inline auto process_bytes(std::span<T, extent> data) noexcept -> state;

#endif // BOOST_CRYPT_HAS_SPAN

#ifdef BOOST_CRYPT_HAS_CUDA

template <typename T, boost::crypt::size_t extent>
BOOST_CRYPT_GPU_ENABLED inline auto process_bytes(cuda::std::span<T, extent> data) noexcept -> hasher_state;
BOOST_CRYPT_GPU_ENABLED inline auto process_bytes(cuda::std::span<T, extent> data) noexcept -> state;

#endif // BOOST_CRYPT_HAS_CUDA

Expand Down
Loading