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

Refactor reader and writer functions #398

Open
katajakasa opened this issue Oct 18, 2021 · 0 comments
Open

Refactor reader and writer functions #398

katajakasa opened this issue Oct 18, 2021 · 0 comments

Comments

@katajakasa
Copy link
Member

Libshadowdive had its internal memreader/reader/memwriter/writer functions in internal/ subdirectory (formats/internal/). We should move those to the openomf projects general utility directory (utils/) and refactor them to match openomf coding style.

  • Remove "sd_" prefix from functions
  • Rename mwriter to memwriter in function and struct names (etc).
  • Rename mreader to memreader in functio nand struct names (etc).
  • Drop the pointless struct names in all of these readers and writers -- just keep the typedeffed name.
  • Remove the "SD_" prefix from guards, and make sure the guards match the filenames
  • Add consts where possible
  • Check that docs are in order, and add some new ones if possible.

Verify afterwards:

  • Everything compiles
  • Unit-tests
  • Game still starts :)
  • Utilities (aftool, bktool, ... ) should still work
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

No branches or pull requests

1 participant