diasurgical/devilutionX

Prefer scoped enums where possible

Open

#2,300 opened on Jul 4, 2021

View on GitHub
 (4 comments) (1 reaction) (0 assignees)C++ (743 forks)batch import
help wanted

Repository metrics

Stars
 (7,255 stars)
PR merge metrics
 (Avg merge 2d 12h) (15 merged PRs in 30d)

Description

Many of the unscoped enums used in devilutionX can use enum class instead. This gives stronger type safety for things like Direction and allows unambiguous constructors/conversion functions in related classes (e.g. Displacement).

This does make it more difficult to cast back to an integral type so the usage of some enums (such as _item_indexes) will need to be evaluated to see if it's worth changing those from unscoped to scoped.

Contributor guide

Research direction
Check each unscoped enum in the codebase and evaluate if they can be converted to enum class without breaking changes, paying attention to integer casts.
Tech stack
cpp
Domain
desktop
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C++
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70