pret / pokeheartgold

Decompilation of Pokemon HeartGold/SoulSilver
310 stars 97 forks source link

Decide consensus on SDK filenames #237

Open luckytyphlosion opened 1 year ago

luckytyphlosion commented 1 year ago

I didn't realize this was a contention point, but apparently it is. Don't waste time thinking about this issue, I just wanted to get these thoughts down while they were in my head.

Option 1: Use the SDK names as-is, regardless of inconsistency

Option 2: Use the SDK names as-is, except prefix each filename with the "module" folder name if the file does not already have a prefix

TODO: what to do with these weird examples

Option 3: Do our own thing

Currently unknown what possible "our things" we could do.

Option 3A: Replace or add each file prefix with the prefix used in the file functions, capitalization included. Preserve the module descriptor.

This is what @red031000 wants, but there are a few unknowns even from her description of what she wanted.

It is unknown how to handle the case where a prefix ends with i. E.g. NitroSDK/rtc and NitroDWC/base/ use both RTCi? and DWCi? respectively. The i does not imply static; functions with an i suffix in the prefix are still part of the public API. For now, assume don't use i.

Additionally, some modules have some kind of "sub-prefix". E.g. in NitroDWC/ilobby/dwci_lobbyBase.cpp, all functions are prefixed with DWCi_Lobby<rest of function name>, without a space before the <rest of function name>. The same applies to NitroSystem/fnd/heapcommon.c (NNSi?_Fnd) and NitroSystem/g2d/g2d_CellTransferManager.c (NNSi?_G2d). Files which have this "sub-prefix" will be marked as such, and conversions will be given for both the first prefix and sub-prefix.

TODO: what to do with nested directory libraries

github-actions[bot] commented 1 month ago

This issue has had no activity for 60 days and will be marked stale. If there is no further activity, it will be closed in 30 days.