Replace ReturnErrorCodeIf with VerifyOrReturnError #36083
Merged
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
|
Review changes with SemanticDiff. |
5c75ee5 to
6130fd8
Compare
…urnError($A == $B || $C == $D, $Z);'
…urnError($A != $B || $C != $D, $Z);'
…urnError($A != $B && $C != $D, $Z);'
…A) && !($B), $Z);' This commit was manually optimized.
…A) || !($B), $Z);' This commit was manually optimized.
6130fd8 to
c626609
Compare
Contributor
Author
|
@andy31415 , to my surprise I was able to convert everything automatically with simple DeMorgan simplifications. I hope, that right now readability will not be sacrificed. |
|
PR #36083: Size comparison from 579b1b1 to 92e76fb Full report (93 builds for bl602, bl702, bl702l, cc13x4_26x4, cc32xx, cyw30739, efr32, esp32, linux, nrfconnect, nxp, psoc6, qpg, stm32, telink, tizen)
|
Several change iterations, removing stale changes requested tag.
andy31415
approved these changes
Oct 17, 2024
Contributor
andy31415
left a comment
There was a problem hiding this comment.
Looks readable at a first glance.
saurabhst
approved these changes
Oct 18, 2024
FergusHuang
pushed a commit
to FergusHuang/connectedhomeip
that referenced
this pull request
Oct 20, 2024
* 'ReturnErrorCodeIf(!$A, $B);' -> 'VerifyOrReturnError($A, $B);' * 'ReturnErrorCodeIf($A == $B, $C);' -> 'VerifyOrReturnError($A != $B, $C);' * 'ReturnErrorCodeIf($A != $B, $C);' -> 'VerifyOrReturnError($A == $B, $C);' * 'ReturnErrorCodeIf($A < $B, $C);' -> 'VerifyOrReturnError($A >= $B, $C);' * 'ReturnErrorCodeIf($A <= $B, $C);' -> 'VerifyOrReturnError($A > $B, $C);' * 'ReturnErrorCodeIf($A > $B, $C);' -> 'VerifyOrReturnError($A <= $B, $C);' * 'ReturnErrorCodeIf($A >= $B, $C);' -> 'VerifyOrReturnError($A < $B, $C);' * 'ReturnErrorCodeIf($A($$$B), $C);' -> 'VerifyOrReturnError(!$A($$$B), $C);' * 'ReturnErrorCodeIf($A, $B);' -> 'VerifyOrReturnError(!$A, $B);' * Replace ReturnErrorCodeWithMetricIf with VerifyOrReturnErrorWithMetric * Restyled by clang-format * 'ReturnErrorCodeIf($A != $B && $C != $D, $Z);' --rewrite 'VerifyOrReturnError($A == $B || $C == $D, $Z);' * 'ReturnErrorCodeIf($A == $B && $C == $D, $Z);' --rewrite 'VerifyOrReturnError($A != $B || $C != $D, $Z);' * 'ReturnErrorCodeIf($A == $B || $C == $D, $Z);' --rewrite 'VerifyOrReturnError($A != $B && $C != $D, $Z);' * 'ReturnErrorCodeIf($A || $B, $Z);' --rewrite 'VerifyOrReturnError(!($A) && !($B), $Z);' This commit was manually optimized. * 'ReturnErrorCodeIf($A && $B, $Z);' --rewrite 'VerifyOrReturnError(!($A) || !($B), $Z);' This commit was manually optimized. * Drop support for ReturnErrorCodeIf * Restyled by clang-format --------- Co-authored-by: Restyled.io <[email protected]>
yyzhong-g
pushed a commit
to yyzhong-g/connectedhomeip
that referenced
this pull request
Dec 12, 2024
* 'ReturnErrorCodeIf(!$A, $B);' -> 'VerifyOrReturnError($A, $B);' * 'ReturnErrorCodeIf($A == $B, $C);' -> 'VerifyOrReturnError($A != $B, $C);' * 'ReturnErrorCodeIf($A != $B, $C);' -> 'VerifyOrReturnError($A == $B, $C);' * 'ReturnErrorCodeIf($A < $B, $C);' -> 'VerifyOrReturnError($A >= $B, $C);' * 'ReturnErrorCodeIf($A <= $B, $C);' -> 'VerifyOrReturnError($A > $B, $C);' * 'ReturnErrorCodeIf($A > $B, $C);' -> 'VerifyOrReturnError($A <= $B, $C);' * 'ReturnErrorCodeIf($A >= $B, $C);' -> 'VerifyOrReturnError($A < $B, $C);' * 'ReturnErrorCodeIf($A($$$B), $C);' -> 'VerifyOrReturnError(!$A($$$B), $C);' * 'ReturnErrorCodeIf($A, $B);' -> 'VerifyOrReturnError(!$A, $B);' * Replace ReturnErrorCodeWithMetricIf with VerifyOrReturnErrorWithMetric * Restyled by clang-format * 'ReturnErrorCodeIf($A != $B && $C != $D, $Z);' --rewrite 'VerifyOrReturnError($A == $B || $C == $D, $Z);' * 'ReturnErrorCodeIf($A == $B && $C == $D, $Z);' --rewrite 'VerifyOrReturnError($A != $B || $C != $D, $Z);' * 'ReturnErrorCodeIf($A == $B || $C == $D, $Z);' --rewrite 'VerifyOrReturnError($A != $B && $C != $D, $Z);' * 'ReturnErrorCodeIf($A || $B, $Z);' --rewrite 'VerifyOrReturnError(!($A) && !($B), $Z);' This commit was manually optimized. * 'ReturnErrorCodeIf($A && $B, $Z);' --rewrite 'VerifyOrReturnError(!($A) || !($B), $Z);' This commit was manually optimized. * Drop support for ReturnErrorCodeIf * Restyled by clang-format --------- Co-authored-by: Restyled.io <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 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.
Rationale
The
ReturnErrorCodeIf(expr, value)define is a C/C++ syntactic sugar for very simpleif (expr) { return value; }pattern. This define does not add any new value to plain C/C++ code. However, in case of error handling we already haveVerifyOrReturnErrorwhich optionally can get 3rd argument for some "extra code". TheVerifyOrReturnErroris widely used in the codebase. It also indicates that the "if" branch is for error handling (so it's a natural replacement for "return-error-if-something"). Instead of having two macros which basically do the same thing, how about using only one uniformly in the project?Changes
The code was automatically converted with AST search/replace (in order to avoid typos during conversion) using following patterns:
ReturnErrorCodeIf(!$A, $B);->VerifyOrReturnError($A, $B);ReturnErrorCodeIf($A == $B, $C);->VerifyOrReturnError($A != $B, $C);ReturnErrorCodeIf($A != $B, $C);->VerifyOrReturnError($A == $B, $C);ReturnErrorCodeIf($A < $B, $C);->VerifyOrReturnError($A >= $B, $C);ReturnErrorCodeIf($A <= $B, $C);->VerifyOrReturnError($A > $B, $C);ReturnErrorCodeIf($A > $B, $C);->VerifyOrReturnError($A <= $B, $C);ReturnErrorCodeIf($A >= $B, $C);->VerifyOrReturnError($A < $B, $C);ReturnErrorCodeIf($A($$$B), $C);->VerifyOrReturnError(!$A($$$B), $C);ReturnErrorCodeIf($A, $B);->VerifyOrReturnError(!($A), $B);ReturnErrorCodeIf($A != $B && $C != $D, $Z);--rewriteVerifyOrReturnError($A == $B || $C == $D, $Z);ReturnErrorCodeIf($A == $B && $C == $D, $Z);--rewriteVerifyOrReturnError($A != $B || $C != $D, $Z);ReturnErrorCodeIf($A == $B || $C == $D, $Z);--rewriteVerifyOrReturnError($A != $B && $C != $D, $Z);ReturnErrorCodeIf($A || $B, $Z);--rewriteVerifyOrReturnError(!($A) && !($B), $Z);(manually simplified)ReturnErrorCodeIf($A && $B, $Z);--rewriteVerifyOrReturnError(!($A) || !($B), $Z);(manually simplified)Testing
CI will verify.