refactor: add rpcName to LEDGER_ENTRY macro
#5202
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## develop #5202 +/- ##
=========================================
- Coverage 77.9% 77.8% -0.1%
=========================================
Files 783 783
Lines 66707 66707
Branches 8140 8139 -1
=========================================
- Hits 51964 51929 -35
- Misses 14743 14778 +35
... and 10 files with indirect coverage changes |
|
Looks like Windows tests are failing. I'm not sure how to resolve that. |
thejohnfreeman
suggested changes
Dec 4, 2024
include/xrpl/protocol/jss.h
Outdated
Comment on lines
701
to
717
| #pragma push_macro("LEDGER_ENTRY") | ||
| #pragma push_macro("LEDGER_ENTRY_DUPLICATE") | ||
| #undef LEDGER_ENTRY | ||
| #undef LEDGER_ENTRY_DUPLICATE | ||
|
|
||
| #define LEDGER_ENTRY(tag, value, name, rpcName, fields) \ | ||
| JSS(name); \ | ||
| JSS(rpcName); | ||
|
|
||
| #define LEDGER_ENTRY_DUPLICATE(tag, value, name, rpcName, fields) JSS(rpcName); | ||
|
|
||
| #include <xrpl/protocol/detail/ledger_entries.macro> | ||
|
|
||
| #undef LEDGER_ENTRY | ||
| #undef LEDGER_ENTRY_DUPLICATE | ||
| #pragma pop_macro("LEDGER_ENTRY") | ||
| #pragma pop_macro("LEDGER_ENTRY_DUPLICATE") |
There was a problem hiding this comment.
The pattern we're going with is this:
#pragma push_macro
#undef
#pragma push_macro
#undef
#define
#define
#include
#undef
#pragma pop_macro
#undef
#pragma pop_macro
@Bronek feels more strongly about this pattern, but I agree it should be consistent everywhere.
|
The Windows error is this bug. Below is the fix, to go in #ifndef LEDGER_ENTRY_DUPLICATE
#define EXPAND(x) x
#define LEDGER_ENTRY_DUPLICATE(...) EXPAND(LEDGER_ENTRY(__VA_ARGS__))
#endif
...
#undef EXPAND
#undef LEDGER_ENTRY_DUPLICATE |
thejohnfreeman
approved these changes
Dec 5, 2024
godexsoft
approved these changes
Dec 31, 2024
|
@bthomee this PR is ready to merge |
bthomee
approved these changes
Jan 2, 2025
ximinez
pushed a commit
to ximinez/rippled
that referenced
this pull request
Jan 13, 2025
The LEDGER_ENTRY macro now takes an additional parameter, which makes it easier to avoid missing including the new field in jss.h and to the list of account_objects/ledger_data filters.
2 tasks
q73zhao
pushed a commit
that referenced
this pull request
Feb 24, 2025
The LEDGER_ENTRY macro now takes an additional parameter, which makes it easier to avoid missing including the new field in jss.h and to the list of account_objects/ledger_data filters.
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.
High Level Overview of Change
The new
LEDGER_ENTRYmacro now takes one additional parameter,rpcName. This makes it easier to avoid missing including the new field injss.hand to the list ofaccount_objects/ledger_datafilters.Context of Change
Prevent easy bugs.
Type of Change
API Impact
No change to the user.
Test Plan
All tests still pass.