Implement SLIME_RESULT

[ConnorY97]

Implement SLIME_RESULT Error Handling System

Objective

Implement a consistent error handling system using SLIME_RESULT throughout the engine to improve error reporting, debugging, and overall code robustness.

Description

We need to replace the current error handling system with a new SLIME_RESULT enum-based approach. This will provide more detailed error information and allow for consistent error handling across the entire codebase.

Tasks

1. Update slime_common.h:

   • Define the SLIME_RESULT enum with appropriate error codes.
   • Add include guards or #pragma once to prevent redefinition errors.

2. Create SlimeErrorUtils.h:

   • Implement the errcheck function template for standardized error checking and logging.
   • Ensure the function is marked as inline to prevent multiple definition errors.

3. Update existing functions:

   • Modify function signatures to return SLIME_RESULT instead of bool/void where appropriate.
   • Replace error-prone patterns (e.g., returning nullptr) with SLIME_RESULT.
   • Update function bodies to use the new SLIME_RESULT system.

4. Update ModelManager:

   • Modify LoadModel to return SLIME_RESULT and use an out parameter for the model resource.

5. Update Resource Loading Functions:

   • Modify LoadBunny, LoadMonkey, LoadCube, and similar functions to use SLIME_RESULT and errcheck.

6. Error Logging:

   • Ensure spdlog is properly integrated for error logging.
   • Review and update error messages for clarity and consistency.

7. Documentation:

   • Update documentation to reflect the new error handling system.
   • Provide examples of how to use SLIME_RESULT and errcheck in the codebase.

8. Testing:

   • Create unit tests for the new error handling system.
   • Update existing tests to work with SLIME_RESULT.

9. Code Review:

   • Conduct a thorough code review to ensure consistent implementation across the codebase.

Acceptance Criteria

• All relevant functions in the engine return SLIME_RESULT.
• errcheck is used consistently for error checking and logging.
• No compilation errors related to SLIME_RESULT or errcheck.
• Error messages are clear and provide useful information for debugging.
• Documentation is updated to reflect the new error handling system.
• All tests pass with the new implementation.

Additional Notes

• This change will require updates across multiple files in the project.
• We may need to update our build system to include the new headers.
• Consider creating a migration guide for any external code that interacts with our engine.

Related Issues

• #XXX: Previous error handling improvement discussion
• #YYY: spdlog integration

Please update this issue with any additional tasks or considerations as the implementation progresses.

[ConnorY97]

Ive decided that I dont want it to return a result, I think we should make it crash nicely and log it better instead For this specific case you could just check the string if its empty and then fail the test, Then check your logs as to why Returning a result to something like this just adds so much boiler plate for every function call that will be identical in every call I just dont like the idea of being like, "I want this shader file, Sweet now let me wrap all of this call in a if check, and add different outputs for each result case" where you could do all of this from inside the manager it self