Skip to content
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.

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

Cleanup: nested_array should not be accessed directly. #9373

Merged
merged 1 commit into from Jun 14, 2021

Conversation

@PeterN
Copy link
Member

@PeterN PeterN commented Jun 14, 2021

Motivation / Problem

Window::nested_array is specifically documented with Do not access directly, use #Window::GetWidget() instead.

Description

Replace accesses with GetWidget() as documented.

Limitations

Checklist for review

Some things are not automated, and forgotten often. This list is a reminder for the reviewers.

  • The bug fix is important enough to be backported? (label: 'backport requested')
  • This PR affects the save game format? (label 'savegame upgrade')
  • This PR affects the GS/AI API? (label 'needs review: Script API')
    • ai_changelog.hpp, gs_changelog.hpp need updating.
    • The compatibility wrappers (compat_*.nut) need updating.
  • This PR affects the NewGRF API? (label 'needs review: NewGRF')
Replace accesses with GetWidget() as documented.
Copy link
Member

@TrueBrain TrueBrain left a comment

Guess one more entry is violating the description, but using GetWidget won't work there :P

src/network/network_gui.cpp:         w->nested_array[WID_NG_HEADER] = this;

Loading

@TrueBrain
Copy link
Member

@TrueBrain TrueBrain commented Jun 14, 2021

And as @LordAro doesn't appreciate me asking this on IRC: can't we make nested_array private to prevent this in the future? :)

(sorry @LordAro , just teasing you :P)

Loading

@PeterN
Copy link
Member Author

@PeterN PeterN commented Jun 14, 2021

Guess one more entry is violating the description, but using GetWidget won't work there :P

src/network/network_gui.cpp:         w->nested_array[WID_NG_HEADER] = this;

Yes, this one is rather "internal widget code" that happens to be in a standard GUI file.

Loading

@PeterN
Copy link
Member Author

@PeterN PeterN commented Jun 14, 2021

And as @LordAro doesn't appreciate me asking this on IRC: can't we make nested_array private to prevent this in the future? :)

Not without some major refactoring, a lot of this code is very C-style and isn't part of the Window class.

Loading

@PeterN PeterN merged commit 7385e78 into OpenTTD:master Jun 14, 2021
14 checks passed
Loading
@PeterN PeterN deleted the nested-array-access branch Jun 14, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

2 participants