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

Codechange: replace StringParameters' GetDataPointer #11005

Merged
merged 3 commits into from Jun 13, 2023

Conversation

rubidium42
Copy link
Contributor

Motivation / Problem

StringParameters' GetDataPointer gives direct access to an array of data. This makes it harder to replace the underlying container.

Description

Replace manually setting the offset to 0 and then calling GetDataPointer to GetPointerToOffset(0).

Replace a custom copy of all remaining parameters with just a StringParameters of size 0 for {STRING}. Those must not have any parameters, so just enforce that.

Remove the now unused GetDataPointer.

Limitations

Without #11003 there are a few (common) places that will not show the right data, and debug-spam that an "invalid string parameter" is tried to be read.

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 touches english.txt or translations? Check the guidelines
  • 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')

@rubidium42 rubidium42 merged commit 43f91bc into OpenTTD:master Jun 13, 2023
18 checks passed
@rubidium42 rubidium42 deleted the data-pointer branch June 13, 2023 21:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants