fix enum casing

experiment-games · Aug 15, 2024 · 5da75f7 · 5da75f7
1 parent d5f82a1
commit 5da75f7
Show file tree

Hide file tree

Showing 45 changed files with 47 additions and 4 deletions.
diff --git a/docs/enumerations/activation_type.md → docs/enumerations/ACTIVATION_TYPE.MD b/docs/enumerations/activation_type.md → docs/enumerations/ACTIVATION_TYPE.MD
diff --git a/docs/enumerations/activity.md → docs/enumerations/ACTIVITY.MD b/docs/enumerations/activity.md → docs/enumerations/ACTIVITY.MD
diff --git a/docs/enumerations/ai_class.md → docs/enumerations/AI_CLASS.MD b/docs/enumerations/ai_class.md → docs/enumerations/AI_CLASS.MD
diff --git a/docs/enumerations/auto_resize.md → docs/enumerations/AUTO_RESIZE.MD b/docs/enumerations/auto_resize.md → docs/enumerations/AUTO_RESIZE.MD
diff --git a/docs/enumerations/blood_color.md → docs/enumerations/BLOOD_COLOR.MD b/docs/enumerations/blood_color.md → docs/enumerations/BLOOD_COLOR.MD
diff --git a/docs/enumerations/button.md → docs/enumerations/BUTTON.MD b/docs/enumerations/button.md → docs/enumerations/BUTTON.MD
diff --git a/docs/enumerations/collide_type.md → docs/enumerations/COLLIDE_TYPE.MD b/docs/enumerations/collide_type.md → docs/enumerations/COLLIDE_TYPE.MD
diff --git a/docs/enumerations/collision_group.md → docs/enumerations/COLLISION_GROUP.MD b/docs/enumerations/collision_group.md → docs/enumerations/COLLISION_GROUP.MD
diff --git a/docs/enumerations/contents.md → docs/enumerations/CONTENTS.MD b/docs/enumerations/contents.md → docs/enumerations/CONTENTS.MD
diff --git a/docs/enumerations/dock_type.md → docs/enumerations/DOCK_TYPE.MD b/docs/enumerations/dock_type.md → docs/enumerations/DOCK_TYPE.MD
diff --git a/docs/enumerations/edict_flag.md → docs/enumerations/EDICT_FLAG.MD b/docs/enumerations/edict_flag.md → docs/enumerations/EDICT_FLAG.MD
diff --git a/docs/enumerations/engine_flag.md → docs/enumerations/ENGINE_FLAG.MD b/docs/enumerations/engine_flag.md → docs/enumerations/ENGINE_FLAG.MD
diff --git a/docs/enumerations/entity_effect.md → docs/enumerations/ENTITY_EFFECT.MD b/docs/enumerations/entity_effect.md → docs/enumerations/ENTITY_EFFECT.MD
diff --git a/docs/enumerations/entity_flag.md → docs/enumerations/ENTITY_FLAG.MD b/docs/enumerations/entity_flag.md → docs/enumerations/ENTITY_FLAG.MD
diff --git a/docs/enumerations/fcvar.md → docs/enumerations/FCVAR.MD b/docs/enumerations/fcvar.md → docs/enumerations/FCVAR.MD
diff --git a/docs/enumerations/file_warning_level.md → docs/enumerations/FILE_WARNING_LEVEL.MD b/docs/enumerations/file_warning_level.md → docs/enumerations/FILE_WARNING_LEVEL.MD
diff --git a/docs/enumerations/font_draw_type.md → docs/enumerations/FONT_DRAW_TYPE.MD b/docs/enumerations/font_draw_type.md → docs/enumerations/FONT_DRAW_TYPE.MD
diff --git a/docs/enumerations/font_flag.md → docs/enumerations/FONT_FLAG.MD b/docs/enumerations/font_flag.md → docs/enumerations/FONT_FLAG.MD
diff --git a/docs/enumerations/gesture_slot.md → docs/enumerations/GESTURE_SLOT.MD b/docs/enumerations/gesture_slot.md → docs/enumerations/GESTURE_SLOT.MD
diff --git a/docs/enumerations/input.md → docs/enumerations/INPUT.MD b/docs/enumerations/input.md → docs/enumerations/INPUT.MD
diff --git a/docs/enumerations/label_alignment.md → docs/enumerations/LABEL_ALIGNMENT.MD b/docs/enumerations/label_alignment.md → docs/enumerations/LABEL_ALIGNMENT.MD
diff --git a/docs/enumerations/life.md → docs/enumerations/LIFE.MD b/docs/enumerations/life.md → docs/enumerations/LIFE.MD
diff --git a/docs/enumerations/mask.md → docs/enumerations/MASK.MD b/docs/enumerations/mask.md → docs/enumerations/MASK.MD
diff --git a/docs/enumerations/move_collide.md → docs/enumerations/MOVE_COLLIDE.MD b/docs/enumerations/move_collide.md → docs/enumerations/MOVE_COLLIDE.MD
diff --git a/docs/enumerations/move_type.md → docs/enumerations/MOVE_TYPE.MD b/docs/enumerations/move_type.md → docs/enumerations/MOVE_TYPE.MD
diff --git a/docs/enumerations/observer_mode.md → docs/enumerations/OBSERVER_MODE.MD b/docs/enumerations/observer_mode.md → docs/enumerations/OBSERVER_MODE.MD
diff --git a/docs/enumerations/panel_alignment.md → docs/enumerations/PANEL_ALIGNMENT.MD b/docs/enumerations/panel_alignment.md → docs/enumerations/PANEL_ALIGNMENT.MD
diff --git a/docs/enumerations/pin_corner.md → docs/enumerations/PIN_CORNER.MD b/docs/enumerations/pin_corner.md → docs/enumerations/PIN_CORNER.MD
diff --git a/docs/enumerations/player_animation.md → docs/enumerations/PLAYER_ANIMATION.MD b/docs/enumerations/player_animation.md → docs/enumerations/PLAYER_ANIMATION.MD
diff --git a/docs/enumerations/render_effects.md → docs/enumerations/RENDER_EFFECTS.MD b/docs/enumerations/render_effects.md → docs/enumerations/RENDER_EFFECTS.MD
diff --git a/docs/enumerations/render_mode.md → docs/enumerations/RENDER_MODE.MD b/docs/enumerations/render_mode.md → docs/enumerations/RENDER_MODE.MD
diff --git a/docs/enumerations/search_path_add_to.md → docs/enumerations/SEARCH_PATH_ADD_TO.MD b/docs/enumerations/search_path_add_to.md → docs/enumerations/SEARCH_PATH_ADD_TO.MD
diff --git a/docs/enumerations/shadow_type.md → docs/enumerations/SHADOW_TYPE.MD b/docs/enumerations/shadow_type.md → docs/enumerations/SHADOW_TYPE.MD
diff --git a/docs/enumerations/shake_command.md → docs/enumerations/SHAKE_COMMAND.MD b/docs/enumerations/shake_command.md → docs/enumerations/SHAKE_COMMAND.MD
diff --git a/docs/enumerations/skybox_visibility.md → docs/enumerations/SKYBOX_VISIBILITY.MD b/docs/enumerations/skybox_visibility.md → docs/enumerations/SKYBOX_VISIBILITY.MD
diff --git a/docs/enumerations/solid.md → docs/enumerations/SOLID.MD b/docs/enumerations/solid.md → docs/enumerations/SOLID.MD
diff --git a/docs/enumerations/solid_flag.md → docs/enumerations/SOLID_FLAG.MD b/docs/enumerations/solid_flag.md → docs/enumerations/SOLID_FLAG.MD
diff --git a/docs/enumerations/surface.md → docs/enumerations/SURFACE.MD b/docs/enumerations/surface.md → docs/enumerations/SURFACE.MD
diff --git a/docs/enumerations/surface_feature.md → docs/enumerations/SURFACE_FEATURE.MD b/docs/enumerations/surface_feature.md → docs/enumerations/SURFACE_FEATURE.MD
diff --git a/docs/enumerations/vgui_panel.md → docs/enumerations/VGUI_PANEL.MD b/docs/enumerations/vgui_panel.md → docs/enumerations/VGUI_PANEL.MD
diff --git a/game/experiment/scripts/lua/utilities/portal_generate_enumerations.lua b/game/experiment/scripts/lua/utilities/portal_generate_enumerations.lua
@@ -80,8 +80,8 @@ end
 
 local function GenerateAllEnumerationsMarkdown()
 	if (CLIENT) then
-		for _, file in ipairs(Files.Find("docs/lua/enumerations/*", "DATA")) do
-			Files.RemoveFile("docs/lua/enumerations/" .. file, "DATA")
+		for _, file in ipairs(Files.Find("docs/enumerations/*", "DATA")) do
+			Files.RemoveFile("docs/enumerations/" .. file, "DATA")
 		end
 	end
 

diff --git a/src/game/shared/luamanager.h b/src/game/shared/luamanager.h
@@ -48,6 +48,8 @@
 #define LUA_PATH_GAMEUI LUA_ROOT "\\gameui"
 #define LUA_PATH_WEAPONS LUA_ROOT "\\weapons"
 
+#define LUA_PATH_DATA "data"
+
 #define LUA_BASE_ENTITY_CLASS "prop_scripted"
 #define LUA_BASE_ENTITY_FACTORY "CBaseAnimating"
 #define LUA_BASE_WEAPON "weapon_experimentbase_scriptedweapon"

diff --git a/src/lib/public/vgui_controls.lib b/src/lib/public/vgui_controls.lib
diff --git a/src/public/lfilesystem.cpp b/src/public/lfilesystem.cpp
@@ -328,6 +328,22 @@ LUA_BINDING_BEGIN( Files, Open, "library", "Open a file." )
 
     readMode = luaL_checkstring( L, 2 );
 
+    // For now We will support writing only to DATA, we will allow reading only in GAME, and DATA
+    if ( readMode[0] == 'w' )
+    {
+        if ( !V_stristr( pathId, "data" ) )
+        {
+            luaL_argerror( L, 3, "Invalid pathId for writing (DATA expected)" );
+        }
+    }
+    else if ( readMode[0] == 'r' )
+    {
+        if ( !V_stristr( pathId, "game" ) && !V_stristr( pathId, "data" ) )
+        {
+            luaL_argerror( L, 3, "Invalid pathId for reading (GAME or DATA expected)" );
+        }
+    }
+
     lua_pushfilehandle( L, filesystem->Open( filePath, readMode, pathId ) );
     return 1;
 }

diff --git a/tools/docs-build-enumerations.js b/tools/docs-build-enumerations.js
@@ -1 +1,26 @@
-// See /game/experiment/scripts/lua/utilities/portal_generate_enumerations.lua
+/*
+  See `/game/experiment/scripts/lua/utilities/portal_generate_enumerations.lua`
+  for the script that generates markdown files to the game data folder.
+
+  Due to how source engine writes, the path is forced lowercase.
+
+  After running the Lua script, run this script to copy the files to the final
+  destination, fixing the casing to be SCREAMING_SNAKE_CASE.
+
+  node ./tools/docs-build-enumerations.js
+*/
+
+const fs = require('fs');
+const path = require('path');
+
+const srcDir = path.join('game', 'experiment', 'data', 'docs', 'enumerations');
+const outputDir = path.join('docs', 'enumerations');
+
+const files = fs.readdirSync(srcDir);
+
+for (const file of files) {
+  const srcPath = path.join(srcDir, file);
+  const outputPath = path.join(outputDir, file.toUpperCase());
+
+  fs.copyFileSync(srcPath, outputPath);
+}