Openworld: Convert room_generate() into a general purpose, single-room loading + connecting function

[Justin08784]

Currently, the room_generate() function is only able to generate rooms around the room_t* curr_room field specified in game_t–– the unusual specificity of room_generate() is restricting its widespread usage. room_generate() should be converted into a general-purpose function for generating a single room around any given room in the game–– a functionality needed by higher-level functions like recursive_generate() and multi_room_generate().

Subtasks include:

1. Update all room_generate() function calls,
2. Simplify recursive_generate() by replacing its redundant code with a call to room_generate().

A new branch (openworld/refactor-room-generate) will be created for these changes and merged into dev using a PR.

[Justin08784]

Finished adding room_t *curr_room parameter to room_generate(). Modified dependent documentation, function calls, and tests.

[wmingyan]

Justin and I met on Zoom today. We discussed how to transform room_generate into a helper function that can be used by both multi_room_generate and recursive_generate to reduce redundant code. To achieve this, we will

• add parameters for curr_room (to specify which room to build off of) and directions to room_generate
• move random direction picking and path_exists_in_dir checking functionalities out of room_generate and into multi_room_generate (we realized that they would be incompatible with recursive_generate())
• modify the tests to accommodate the changes

[Justin08784]

Summary of 28793b3:

• recursive_generate() now takes a gencontext instead of a speclist parameter
• room_generate() no longer takes a gencontext; it now takes char* dir_to_new (direction to to-be-generated room) and char* dir_to_curr (reverse)
• moved random dir picking/path checking functionality out of room_generate() and into a new helper called pick_random_dir()
• multi_room_generate() now calls pick_random_dir() and room_generate() ; recursive_generate() calls room_generate()

Openworld library compiles fine.

To-do:

• Tests haven't been updated yet so they do not compile.
• Need to create tests for pick_random_dir().

[Justin08784]

Summary of ef2d4d9:

Modifications:

• tests updated to make use of new room_generate() and recursive_generate() functions (all pass now)
• added recursive_gen test case for radius 2

Bug Fixes:

1. random_items() Passing a roomspec_t whose item_hash_t *items field is NULL (i.e. no items) to random_items() caused it to crash. cause + fix

2. room_generate() In test room_generate_failure, trying to generate a room in a direction that is already full (full as in a path exists for that direction) crashed the program. cause + fix

3. recursive_generate() recursive_gen tests for radii ≥ 2 were crashing and/or failing. cause + fix

[Justin08784]

Tests for pick_random_dir() added.

[Justin08784]

Closing Statement: The relevant pull request (#1077) has been approved, and the refactored room_generate() function as well as the new helper pick_random_direction() (along with relevant tests), has been merged into the dev branch. This marks the end of this issue.

Follow-ups:

• Simplify/reorganize test_autogenerate.c tests so that next year's team don't have a migraine. This is going to be a LONG task.
• Redefining a direction array in multi_room_generate() and recursive_generate() is a poor solution (especially in the latter, whose call stack grows exponentially with each step of recursion), and not sustainable practice when implementing various other higher-level generation functions. Is there a way to define a direction array global variable, with each direction mapping to its inverse, that can be quickly referenced?

Note: Please ignore the commits below. They were caused by a series of reverts/rollbacks relevant to another issue (#1035).

[MaxineK36]

Issue Score: ✔️++

Comments: Excellent work! Your summary did a particularly good job noting the specific subtasks being accomplished in this issue.