Style unification of file info comments

.github/workflows/Validate_File_Contents.yaml

@@ -0,0 +1,29 @@
+name: Validate file contents
+
+on:
+  workflow_dispatch: # manual trigger
+
+  push:
+    paths:
+      - "plugin_*/**.h"
+      - "plugin_*/**.cpp"
+      - "shared/**.h"
+      - "shared/**.cpp"
+
+  pull_request:
+    paths:
+      - "plugin_*/**.h"
+      - "plugin_*/**.cpp"
+      - "shared/**.h"
+      - "shared/**.cpp"
+
+jobs:
+  Validate_file_contents:
+    runs-on: ubuntu-latest
+
+    steps: 
+      - name: Checkout repository
+        uses: actions/checkout@v6
+
+      - name: Check files
+        run: node .github/workflows/scripts/Validate_File_Contents.js

.github/workflows/scripts/Validate_File_Contents.js

@@ -0,0 +1,106 @@
+const fs = require("fs");
+const path = require("path");
+
+let result = true;
+//result &=  walkRecursive("./examples/");
+result &= walkRecursive("./plugin_sa/");
+
+console.log(result);
+if (!result)
+    process.exit(1); // problem found
+
+
+function walkRecursive(dir)
+{
+    let result = true;
+
+    const files = fs.readdirSync(dir, { withFileTypes: true });
+    for (const file of files)
+    {
+        let filename = path.join(dir, file.name);
+        filename = filename.split(path.sep).join('/');
+
+        if (file.isDirectory())
+            result &= walkRecursive(filename);
+        else
+            result &= processFile(filename);
+    }
+
+    return result;
+}
+
+function processFile(filename)
+{
+    let result = true;
+
+    result &= processCodeFile(filename);
+
+    return result;
+}
+
+function processCodeFile(filename)
+{
+	if (filename.includes("/rw/")) // skip Renderware files
+        return true;
+
+    const headerExtensions = [".h", ".hpp"];
+    const sourceExtensions = [".c", ".cpp"];
+    const filetype = path.extname(filename).toLowerCase();
+
+    if (!headerExtensions.includes(filetype) && !sourceExtensions.includes(filetype))
+        return true; // not code file
+
+    let result = true;
+
+    result &= verifyPluginSdkComment(filename, headerExtensions.includes(filetype));
+
+    return result;
+}
+
+function verifyPluginSdkComment(filename, isHeader)
+{
+    let expected = "/*\n";
+
+    expected += "    Plugin-SDK (Grand Theft Auto ";
+    if (filename.toLowerCase().startsWith("plugin_II"))  expected += "2";
+    if (filename.toLowerCase().startsWith("plugin_III")) expected += "3";
+    if (filename.toLowerCase().startsWith("plugin_vc"))  expected += "Vice City";
+    if (filename.toLowerCase().startsWith("plugin_sa"))  expected += "San Andreas";
+    if (filename.toLowerCase().startsWith("plugin_IV"))  expected += "IV";
+    if (filename.toLowerCase().startsWith("plugin_vc_unreal")) expected += "Vice City Unreal";
+    if (filename.toLowerCase().startsWith("plugin_sa_unreal")) expected += "San Andreas Unreal";
+    if (filename.toLowerCase().startsWith("shared")) expected += "shared";
+    expected += ") "
+
+    if (isHeader)
+        expected += "header";
+    else
+        expected += "source";
+    expected += " file\n";
+
+    expected += "    Authors: GTA Community. See more here\n";
+    expected += "    https://github.com/DK22Pac/plugin-sdk\n";
+    expected += "    Do not delete this comment block. Respect others' work!\n";
+    expected += "*/";
+
+    const buffer = Buffer.alloc(expected.length + 100);
+    const fd = fs.openSync(filename, 'r');
+    fs.readSync(fd, buffer, 0, expected.length + 100, 0);
+    fs.closeSync(fd);
+    let actual = buffer.toString('utf8');
+    actual = actual.replace(/\r\n/g, "\n");
+
+    // compare lines
+    const actualLines = actual.split('\n');
+    const expectedLines = expected.split('\n');
+    for (let i = 0; i < expectedLines.length; i++)
+    {
+        if (actualLines[i] !== expectedLines[i])
+        {            
+            console.log(`::error file=${filename},line=${i+1},title=Invalid PSDK comment header::Found "${actualLines[i]}", expected "${expectedLines[i]}"`);
+            return false;
+        }
+    }
+
+    return true;
+}

.github/workflows/scripts/run.cmd

@@ -0,0 +1,3 @@
+cd ..\..\..
+"D:\Program Files\Node\node.exe" ".github\workflows\scripts\Validate_File_Contents.js"
+pause

examples/Neon/KeyCheck.cpp

@@ -1,8 +1,8 @@
 /*
-Plugin-SDK (Grand Theft Auto) source file
-Authors: GTA Community. See more here
-https://github.com/DK22Pac/plugin-sdk
-Do not delete this comment block. Respect others' work!
+    Plugin-SDK (Grand Theft Auto) source file
+    Authors: GTA Community. See more here
+    https://github.com/DK22Pac/plugin-sdk
+    Do not delete this comment block. Respect others' work!
 */
 #include "KeyCheck.h"
 #include "plugin.h"

examples/Neon/KeyCheck.h

@@ -1,8 +1,8 @@
 /*
-Plugin-SDK (Grand Theft Auto) source file
-Authors: GTA Community. See more here
-https://github.com/DK22Pac/plugin-sdk
-Do not delete this comment block. Respect others' work!
+    Plugin-SDK (Grand Theft Auto) source file
+    Authors: GTA Community. See more here
+    https://github.com/DK22Pac/plugin-sdk
+    Do not delete this comment block. Respect others' work!
 */
 #pragma once
 

hooking/Hooking.Patterns.h

@@ -6,7 +6,6 @@
  */
 
 #pragma once
-
 #include <cassert>
 #include <vector>
 #include <string_view>

injector/gvm/translator.hpp

@@ -24,7 +24,6 @@
  *
  */
 #pragma once
-
 #if !defined(INJECTOR_GVM_HAS_TRANSLATOR)
 #error Missing INJECTOR_GVM_HAS_TRANSLATOR on compiler definitions
 #endif

plugin_II/game_II/CAudioManager.cpp

@@ -4,7 +4,6 @@
     https://github.com/DK22Pac/plugin-sdk
     Do not delete this comment block. Respect others' work!
 */
-
 #include "CAudioManager.h"
 
 CAudioManager& AudioManager = *(CAudioManager*)0x5DCBC8;

plugin_II/game_II/CAudioManager.h

@@ -4,7 +4,6 @@
     https://github.com/DK22Pac/plugin-sdk
     Do not delete this comment block. Respect others' work!
 */
-
 #pragma once
 #include "PluginBase.h"
 

plugin_II/game_II/CCar.cpp

@@ -4,7 +4,6 @@
     https://github.com/DK22Pac/plugin-sdk
     Do not delete this comment block. Respect others' work!
 */
-
 #include "CCar.h"
 
 void CCar::SetPosition(CEncodedVector pos) {

plugin_II/game_II/CCar.h

@@ -4,7 +4,6 @@
     https://github.com/DK22Pac/plugin-sdk
     Do not delete this comment block. Respect others' work!
 */
-
 #pragma once
 #include "PluginBase.h"
 #include "CSprite.h"

plugin_II/game_II/CCarManager.cpp

@@ -4,7 +4,6 @@
     https://github.com/DK22Pac/plugin-sdk
     Do not delete this comment block. Respect others' work!
 */
-
 #include "CCarManager.h"
 
 CCarManager** gCarManager = (CCarManager**)0x5E4CA0;

plugin_II/game_II/CCarManager.h

@@ -4,7 +4,6 @@
     https://github.com/DK22Pac/plugin-sdk
     Do not delete this comment block. Respect others' work!
 */
-
 #pragma once
 #include "PluginBase.h"
 #include "CCar.h"

plugin_II/game_II/CFileMgr.cpp

@@ -4,7 +4,6 @@
     https://github.com/DK22Pac/plugin-sdk
     Do not delete this comment block. Respect others' work!
 */
-
 #include "CFileMgr.h"
 
 int CFileMgr::OpenFile(const char* name) {

plugin_II/game_II/CFileMgr.h

@@ -4,7 +4,6 @@
     https://github.com/DK22Pac/plugin-sdk
     Do not delete this comment block. Respect others' work!
 */
-
 #pragma once
 #include "PluginBase.h"
 

plugin_II/game_II/CFont.h

@@ -4,7 +4,6 @@
     https://github.com/DK22Pac/plugin-sdk
     Do not delete this comment block. Respect others' work!
 */
-
 #pragma once
 #include "PluginBase.h"
 

plugin_II/game_II/CGame.cpp

@@ -4,7 +4,6 @@
     https://github.com/DK22Pac/plugin-sdk
     Do not delete this comment block. Respect others' work!
 */
-
 #include "CGame.h"
 
 CGame** gGame = (CGame**)0x5EB4FC;

plugin_II/game_II/CGame.h

@@ -4,7 +4,6 @@
     https://github.com/DK22Pac/plugin-sdk
     Do not delete this comment block. Respect others' work!
 */
-
 #pragma once
 #include "PluginBase.h"
 

plugin_II/game_II/CKeybrd.cpp

@@ -4,7 +4,6 @@
     https://github.com/DK22Pac/plugin-sdk
     Do not delete this comment block. Respect others' work!
 */
-
 #include "CKeybrd.h"
 
 CKeybrd** gKeybrd = (CKeybrd**)0x662128;

plugin_II/game_II/CKeybrd.h

@@ -4,7 +4,6 @@
     https://github.com/DK22Pac/plugin-sdk
     Do not delete this comment block. Respect others' work!
 */
-
 #pragma once
 #include "PluginBase.h"
 

plugin_II/game_II/CMenuManager.cpp

@@ -4,7 +4,6 @@
     https://github.com/DK22Pac/plugin-sdk
     Do not delete this comment block. Respect others' work!
 */
-
 #include "CMenuManager.h"
 
 CMenuManager** FrontendMenuManager = (CMenuManager**)0x5EB160;

plugin_II/game_II/CMenuManager.h

@@ -4,7 +4,6 @@
     https://github.com/DK22Pac/plugin-sdk
     Do not delete this comment block. Respect others' work!
 */
-
 #pragma once
 #include "PluginBase.h"
 #include "GBH.h"

plugin_II/game_II/CObject.cpp

@@ -4,7 +4,6 @@
     https://github.com/DK22Pac/plugin-sdk
     Do not delete this comment block. Respect others' work!
 */
-
 #include "CObject.h"
 
 int const& CObject::GetPositionX(int* x) {

plugin_II/game_II/CPed.cpp

@@ -4,7 +4,6 @@
     https://github.com/DK22Pac/plugin-sdk
     Do not delete this comment block. Respect others' work!
 */
-
 #include "CPed.h"
 
 void CPed::GiveWeapon(int id, int ammo) {

plugin_II/game_II/CPed.h

@@ -4,7 +4,6 @@
     https://github.com/DK22Pac/plugin-sdk
     Do not delete this comment block. Respect others' work!
 */
-
 #pragma once
 #include "PluginBase.h"
 #include "CCar.h"

plugin_II/game_II/CPedManager.cpp

@@ -4,7 +4,6 @@
     https://github.com/DK22Pac/plugin-sdk
     Do not delete this comment block. Respect others' work!
 */
-
 #include "CPedManager.h"
 
 CPedManager** gPedManager = (CPedManager**)0x5E5BBC;

plugin_II/game_II/CPedManager.h

@@ -4,7 +4,6 @@
     https://github.com/DK22Pac/plugin-sdk
     Do not delete this comment block. Respect others' work!
 */
-
 #pragma once
 #include "PluginBase.h"
 

plugin_II/game_II/CPhysics.cpp

@@ -4,5 +4,4 @@
     https://github.com/DK22Pac/plugin-sdk
     Do not delete this comment block. Respect others' work!
 */
-
 #include "CPhysics.h"

plugin_II/game_II/CPlayerPed.cpp

@@ -4,7 +4,6 @@
     https://github.com/DK22Pac/plugin-sdk
     Do not delete this comment block. Respect others' work!
 */
-
 #include "CPlayerPed.h"
 #include "CPed.h"
 

plugin_II/game_II/CPlayerPed.h

@@ -4,7 +4,6 @@
     https://github.com/DK22Pac/plugin-sdk
     Do not delete this comment block. Respect others' work!
 */
-
 #pragma once
 #include "PluginBase.h"
 #include "CPhysics.h"

plugin_II/game_II/CPopulation.h

@@ -4,7 +4,6 @@
     https://github.com/DK22Pac/plugin-sdk
     Do not delete this comment block. Respect others' work!
 */
-
 #pragma once
 #include "PluginBase.h"
 #include "CCar.h"

plugin_II/game_II/CRect.h

@@ -5,7 +5,6 @@
     Do not delete this comment block. Respect others' work!
 */
 #pragma once
-
 #include "PluginBase.h"
 
 class CRect {

plugin_II/game_II/CReplay.cpp

@@ -4,7 +4,6 @@
     https://github.com/DK22Pac/plugin-sdk
     Do not delete this comment block. Respect others' work!
 */
-
 #include "CReplay.h"
 
 CReplay* gReplay = (CReplay*)0x5ECAC8;

plugin_II/game_II/CReplay.h

@@ -4,7 +4,6 @@
     https://github.com/DK22Pac/plugin-sdk
     Do not delete this comment block. Respect others' work!
 */
-
 #pragma once
 #include "PluginBase.h"