Remove out parameter from pony_os_stdin_read
#4000
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
The signature of the `pony_os_stdin_read` function has been simplified to remove the `bool* out_again` parameter. ```diff -PONY_API size_t pony_os_stdin_read(char* buffer, size_t space, bool* out_again) +PONY_API size_t pony_os_stdin_read(char* buffer, size_t space) ``` It is permitted to call the `pony_os_stdin_read` function again in a loop if the return value is greater than zero, and the platform is not windows. Given that those two conditions are enough information to make a decision, the `out_again` parameter is not needed, and can be removed. Technically this is a breaking change, because the function is prefixed with `pony_` and is thus a public API. But it is unlikely that any code out there is directly using the `pony_os_stdin_read` function, apart from the `Stdin` actor in the standard library, which has been updated in its internal implementation details to match the new signature.
ponylang-main
added
the
discuss during sync
jemc
added
changelog - changed
SeanTAllen
approved these changes
Feb 6, 2022
jemc
added a commit
to savi-lang/runtime-bitcode
that referenced
this pull request
Feb 6, 2022
This includes a mainstream acceptanc eof the objectmap patch (now removed here) as well as a simplification of the stdin reading C API (see ponylang/ponyc#4000)
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.
The signature of the
pony_os_stdin_readfunction has been simplified to remove thebool* out_againparameter.It is permitted to call the
pony_os_stdin_readfunction again in a loop if the return value is greater than zero, and the platform is not windows. Given that those two conditions are enough information to make a decision, theout_againparameter is not needed, and can be removed.Technically this is a breaking change, because the function is prefixed with
pony_and is thus a public API. But it is unlikely that any code out there is directly using thepony_os_stdin_readfunction, apart from theStdinactor in the standard library, which has been updated in its internal implementation details to match the new signature.