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: Ensure SDLK mappings stay in the expected order. #12608

Merged
merged 1 commit into from May 2, 2024

Conversation

PeterN
Copy link
Member

@PeterN PeterN commented May 1, 2024

Motivation / Problem

#12596 found an issue with SDLK mappings that we did not know about, but we can make the compiler tell us.

Description

Add a constexpr constructor that ensures at compile-time that the source SDLK range matches the target range.

Therefore, it is no longer possible (fingers-crossed...) for the key ranges to be incorrect.

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 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, game_changelog.hpp need updating.
    • The compatibility wrappers (compat_*.nut) need updating.
  • This PR affects the NewGRF API? (label 'needs review: NewGRF')

Add a constexpr constructor that ensures at compile-time that the source SDLK range matches the target range.
Copy link
Contributor

@rubidium42 rubidium42 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Something similar can also be done for Allegro and Windows.
For MacOS the mapping is fully 1:1.

@PeterN PeterN merged commit 90029be into OpenTTD:master May 2, 2024
14 checks passed
@PeterN PeterN deleted the ensure-sdlk-order branch May 2, 2024 22:19
JGRennison added a commit to JGRennison/Upstream-OpenTTD that referenced this pull request May 6, 2024
rubidium42 pushed a commit that referenced this pull request May 7, 2024
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