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: Split GetItem with GetOrCreateItem. #10952

Merged
merged 1 commit into from
Jun 5, 2023

Conversation

PeterN
Copy link
Member

@PeterN PeterN commented Jun 5, 2023

Motivation / Problem

As seen in #10951, IniGroup::GetItem() returns nullptr if the item does not exist, but does not if the create parameter is set to true.

This causes a CodeQL warning as most callers need to check for nullptr, but some don't.

Description

Resolve CodeQL warnings by creating a separate GetOrCreateItem() which returns a reference to the item instead.

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

src/ini_load.cpp Outdated Show resolved Hide resolved
src/ini_load.cpp Outdated Show resolved Hide resolved
`IniGroup::GetItem()` returns nullptr if the item does not exist, but does not if the create parameter is set to true. Resolve CodeQL warnings with `GetOrCreateItem()` which returns a reference to the item instead.
@PeterN PeterN enabled auto-merge (squash) June 5, 2023 17:46
@PeterN PeterN merged commit 64d6ad5 into OpenTTD:master Jun 5, 2023
19 checks passed
@PeterN PeterN deleted the resolve-getitem-alert branch June 5, 2023 19:10
mrmbernardi pushed a commit to mrmbernardi/OpenTTD that referenced this pull request Jul 2, 2023
`IniGroup::GetItem()` returns nullptr if the item does not exist, but does not if the create parameter is set to true. Resolve CodeQL warnings with `GetOrCreateItem()` which returns a reference to the item instead.
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