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

Cleanup file structure #44

Open
pappde opened this issue Jun 3, 2023 · 0 comments
Open

Cleanup file structure #44

pappde opened this issue Jun 3, 2023 · 0 comments

Comments

@pappde
Copy link
Owner

pappde commented Jun 3, 2023

One issue with the file structure is inconsistency between classes and headers. E.g.

  1. we have "parser.h" for the BMC_Parser class, but the implementation is in bmail.cpp (should be parser.cpp)
  2. "bmai.h" (and bmai.cpp) are mega-files that include multiple classes and definitions
  3. arguably, the files should exactly match the class name. E.g. "BMC_Parser.h" instead of "parser.h"
  4. header dependencies are not consistent

REQUIREMENTS
Ideally, we would have one header and CPP per class.

NOTES:
Cleaning up the headers should be straightforward - such as splitting bmai.h into multiple headers (actually added types.h in commit 94ed97d). What is a bit more involved is cleaning up bmai.cpp. For example, there are many dependencies on global/singleton objects declared in bmai.cpp, so we would need to extern them in the header file.

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

No branches or pull requests

1 participant