utils.h: add doxygen doc and move bsl and bsr utils to it
#1916
Conversation
This file contains hidden or 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
bettio
force-pushed
the
utils-cleanup-and-doc
branch
from
d31ec20 to
756d3ca
Compare
bettio
changed the title
utils.h: add doxygen doc and move to it bsl and bsr utils
bettio
changed the title
utils.h: add doxygen doc and move to it bsl and bsr utilsutils.h: add doxygen doc and move bsl and bsr utils to it
pguyot
reviewed
Oct 23, 2025
src/libAtomVM/utils.h
Outdated
| } | ||
|
|
||
| /** | ||
| * @brief Perform arithmetic right shift on 32-bit signed integer (/c int32_t) |
There was a problem hiding this comment.
Suggested change
| * @brief Perform arithmetic right shift on 32-bit signed integer (/c int32_t) | |
| * @brief Perform arithmetic right shift on 32-bit signed integer (\c int32_t) |
src/libAtomVM/utils.h
Outdated
| } | ||
|
|
||
| /** | ||
| * @brief Safely perform arithmetic right shift on 32-bit signed integer (/c int32_t) |
There was a problem hiding this comment.
Suggested change
| * @brief Safely perform arithmetic right shift on 32-bit signed integer (/c int32_t) | |
| * @brief Safely perform arithmetic right shift on 32-bit signed integer (\c int32_t) |
These functions are general purpose helpers to avoid undefined behaviours, so they can be used also outside of bif.c. Signed-off-by: Davide Bettio <[email protected]>
Add doxygen documentation for functions such as int64_is_negative, etc... Signed-off-by: Davide Bettio <[email protected]>
Keep variants (int32,int64) of the same function close together. Signed-off-by: Davide Bettio <[email protected]>
Since avm_int_t is widely used around, such as for the shift parameter in bsr and bsl, it is a safer option accepting size_t: a positive avm_int_t can always be converted to size_t. Also, make this assumption clear in term_typedef.h. Signed-off-by: Davide Bettio <[email protected]>
bettio
force-pushed
the
utils-cleanup-and-doc
branch
from
756d3ca to
b0db34a
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
utils.hfunctions that have been introduced with feature/bigint branch.utils.h.boperand ina bsr banda bsl bThese changes are made under both the "Apache 2.0" and the "GNU Lesser General
Public License 2.1 or later" license terms (dual license).
SPDX-License-Identifier: Apache-2.0 OR LGPL-2.1-or-later