Update style guide and DLL C stubs to follow new format

Author: Francessco121

dino.py

@@ -433,7 +433,14 @@ def setup(self):
         print()
         print(f"Done! Run '{self.__get_invoked_as()} build' to build the ROM.")
 
-    def setup_dll(self, number: int, dll_dir: str):
+    def setup_dll(self, number: int, file: str, prefix: str | None):
+        filepath = Path(file)
+        if len(filepath.suffix) == 0:
+            print(f"Filepath option must be a path to a C file.")
+            sys.exit(1)
+        dll_dir = filepath.parent.as_posix()
+        filename = filepath.name
+        
         dlls_txt_path = SRC_PATH.joinpath("dlls/dlls.txt")
         assert dlls_txt_path.exists(), f"Missing dlls.txt file at {dlls_txt_path.absolute()}"
 
@@ -466,7 +473,7 @@ def setup_dll(self, number: int, dll_dir: str):
 
         # Extract DLL
         print("Extracting DLL...")
-        self.__extract_dlls([number], quiet=True)
+        self.__setup_dll(number, filename, prefix)
 
         # Re-configure build script
         self.configure()
@@ -555,9 +562,30 @@ def __extract_dlls(self, dlls: "list[str | int]"=[], quiet: bool=False, disassem
         if disassemble_all:
             args.append("--disassemble-all")
 
+        args.append("split")
         args.extend([str(dll) for dll in dlls])
 
         self.__run_cmd(args)
+
+    def __setup_dll(self, dll: str | int, filename: str, prefix: str | None):
+        args = [
+            sys.executable, str(DLL_SPLIT_PY),
+            "--base-dir", str(SCRIPT_DIR),
+            "--quiet"
+        ]
+
+        if self.verbose:
+            args.append("--verbose")
+
+        args.extend([
+            "split-single", str(dll),
+            "--filename", filename
+        ])
+
+        if prefix != None:
+            args.extend(["--prefix", prefix])
+
+        self.__run_cmd(args)
 
     def __get_invoked_as(self):
         invoked_as = sys.argv[0]
@@ -577,7 +605,8 @@ def main():
 
     setup_dll_cmd = subparsers.add_parser("setup-dll", help="Set up a new environment for decomping a DLL.")
     setup_dll_cmd.add_argument("number", type=int, help="The number of the DLL.")
-    setup_dll_cmd.add_argument("dir", type=str, help="Directory name to set up the DLL under.")
+    setup_dll_cmd.add_argument("file", type=str, help="Path to the DLL C file.")
+    setup_dll_cmd.add_argument("--prefix", type=str, help="Function prefix.")
 
     extract_cmd = subparsers.add_parser("extract", help="Split ROM and extract DLLs.")
     extract_cmd.add_argument("--use-cache", action="store_true", dest="use_cache", help="Only split changed segments in splat config.", default=False)
@@ -631,7 +660,7 @@ def main():
         if cmd == "setup":
             runner.setup()
         elif cmd == "setup-dll":
-            runner.setup_dll(number=args.number, dll_dir=args.dir)
+            runner.setup_dll(number=args.number, file=args.file, prefix=args.prefix)
         elif cmd == "extract":
             runner.extract(core_only=False, use_cache=args.use_cache, disassemble_all=args.disassemble_all)
         elif cmd == "extract-core":

docs/StyleGuide.md

@@ -2,10 +2,11 @@
 
 The Dinosaur Planet decompilation style guide.
 
+For cases not covered by this guide, prefer the existing style currently used throughout the codebase.
+
 - [Naming](#naming)
-    - [Global Functions (core code)](#global-functions-core-code)
-    - [Global Functions (DLL code)](#global-functions-dll-code)
-    - [Static Functions](#static-functions)
+    - [Functions (core code)](#functions-core-code)
+    - [Functions (DLL code)](#functions-dll-code)
     - [Variables](#variables)
     - [Types](#types)
     - [Macros/Defines](#macrosdefines)
@@ -15,7 +16,7 @@ The Dinosaur Planet decompilation style guide.
 
 ## Naming
 
-### Global Functions (core code)
+### Functions (core code)
 
 `camelCase` with a prefix. The prefix should be short and identify the subsystem/file.
 
@@ -24,34 +25,34 @@ Examples:
 - `texLoadTexture`
 - `mainGetBits`
 
-Official function names and prefixes should be used where possible. These will be in the same style. If an official name is particularly confusing, a custom name may be used instead.
+Official function names and prefixes should be used where possible. For global functions these will be in the same style. If an official name is particularly confusing, a custom name may be used instead.
+
+Note that **static** functions should also start with a prefix, **except** for:
+- Library code (use the official function names regardless of format).
+- Functions where the official name is known (if the official name is not particularly unique, a custom prefixed name may be used instead.)
 
-### Global Functions (DLL code)
+### Functions (DLL code)
 
-Exports:
-`<prefix>[_subPrefix]_<FuncName>` where:
-- `prefix` - A (generally) `camelCase` prefix that represents the name of the DLL (this is similar to core code global functions). Example: `amSfx`.
+**Exports:** `<prefix>[_subPrefix]_<FuncName>` where:
+- `prefix` - A prefix that represents the name of the DLL (this is similar to core code global functions). Example: `amSfx`. May be `PascalCase`.
 - `_subPrefix`- For exports that implement a nested interface (i.e. a more generic interface not specific to that DLL), the sub prefix is a `camelCase` prefix identifying that interface. Examples: `_obj`, `_vehicle`.
 - `FuncName` - The rest of the function name in `PascalCase`.
 - Examples:
-    - `amSfx_Play` (self interface)
-    - `BWlog_obj_Setup` (object interface)
-    - `BWlog_vehicle_GetRacePosition` (vehicle interface)
+    - `amSfx_Play` (own interface)
+    - `BWlog_obj_Setup` (generic object interface)
+    - `BWlog_vehicle_GetRacePosition` (generic vehicle interface)
 
-Constructors/destructors:
-`<prefix>_<ctor or dtor>`.
+**Constructors/destructors:** `<prefix>_<ctor or dtor>`.
 - `prefix` - The same prefix used by exports.
 - Examples: `amSfx_ctor`, `amSfx_dtor`.
 
-Global DLL functions are special as they represent DLL constructors, destructors, and exports. Export functions implement a DLL interface and as such the name of the interface should be included in the function name. In cases where an export implements a nested interface, an identifier for that interface is also included.
-
-Official function names should be adapted to this format where possible. For example: `amSfxPlay` (official) -> `amSfx_Play`.
-
-### Static Functions
+**Statics:** `<prefix>_<funcName>` where:
+- `prefix` - The same prefix used by exports.
+- `funcName` - The rest of the function name in `camelCase`. Note that static functions start this segment with a lowercase character and global (export) functions start with an uppercase character.
 
-`camelCase` *without* a prefix. Avoid starting the name with a word that may collide with the prefix of global functions (e.g. don't start a static function name with `obj`).
+Global DLL functions are special as they represent DLL constructors, destructors, and exports. Export functions implement a DLL interface and as such the naming convention states which interface is being implemented when relevant (i.e. when not a DLL's own interface).
 
-Note that for core code, it is generally not recommended to mark functions as static even if the function logically should be static. In those cases, the global function naming style should be preferred, unless the official function name is known.
+Official function names should be adapted to this format where possible. For example: `amSfxPlay` (official, export) -> `amSfx_Play`.
 
 ### Variables