chore: Apply clang-format to entire codebase by githubawn · Pull Request #2820 · TheSuperHackers/GeneralsGameCode

githubawn · 2026-06-21T23:06:30Z

This PR applies a repository-wide mechanical reformatting across all project source code using clang-format.

This is the successor to the original formatting attempt in PR #2638 (submitted by @DevGeniusCode). Following up on the community poll in Discord ("Apply clang-format on all code", which passed with 53%), this PR establishes the formatting baseline. Because the output is 100% automated, if conflicts arise from other PRs landing before this one, regenerating the diff is trivial (re-run the formatter and force-push).

A follow-up PR will add a .git-blame-ignore-revs file containing the commit hash of this formatting pass so that git blame (both locally and on GitHub) automatically skips over the formatting changes and preserves the historical authorship of every line.

What Changed vs PR #2638

Three config adjustments have been applied based on review feedback and legacy toolchain compatibility:

-UseTab: AlignWithSpaces
+UseTab: ForIndentation
+SpacesInAngles: Leave
+Cpp11BracedListStyle: false

UseTab: ForIndentation: Fixes the tab-space rendering mismatch in preprocessor block comments on GitHub (where GitHub defaults to tab=8, causing space-aligned block comments inside tab-indented preprocessor blocks to look misaligned).
SpacesInAngles: Leave: Retains existing spacing inside template brackets (e.g., keeping > > rather than collapsing them to >>), which is required for legacy C++98 / VC6 compiler compatibility.
Cpp11BracedListStyle: false: Prevents the formatter from collapsing braced initializer lists to C++11 single-line style, maintaining Allman brace layout consistency.

1. `UseTab: ForIndentation` GameLogic.h 25–45

Current (Before):

#pragma once

#include "Common/GameCommon.h"	// ensure we get DUMP_PERF_STATS, or not
#include "Common/GameType.h"
#include "Common/Snapshot.h"
#include "Common/STLTypedefs.h"
#include "Common/ObjectStatusTypes.h"
#include "GameNetwork/NetworkDefs.h"
#include "GameLogic/AI.h"
#include "GameLogic/Module/UpdateModule.h"	// needed for DIRECT_UPDATEMODULE_ACCESS

#pragma once

#include "Common/GameCommon.h"    // ensure we get DUMP_PERF_STATS, or not
#include "Common/GameType.h"
#include "Common/Snapshot.h"
#include "Common/STLTypedefs.h"
#include "Common/ObjectStatusTypes.h"
#include "GameNetwork/NetworkDefs.h"
#include "GameLogic/AI.h"
#include "GameLogic/Module/UpdateModule.h"    // needed for DIRECT_UPDATEMODULE_ACCESS

2. `SpacesInAngles: Leave` PerfTimer.cpp 205–225

/*static*/ Bool AutoPerfGatherIgnore::s_ignoring = false;

//-------------------------------------------------------------------------------------------------
typedef std::vector< std::pair< AsciiString, AsciiString >/**/> StringPairVec;

/*static*/ Bool AutoPerfGatherIgnore::s_ignoring = false;

//-------------------------------------------------------------------------------------------------
typedef std::vector< std::pair< AsciiString, AsciiString > /**/> StringPairVec;

3. `Cpp11BracedListStyle: false` WOLGameSetupMenu.cpp 218–226

static GameWindow *genericPingWindow[MAX_SLOTS] = {0};

static const Image *pingImages[3] = { nullptr, nullptr, nullptr };

static GameWindow* genericPingWindow[MAX_SLOTS] = { 0 };

static const Image* pingImages[3] = { nullptr, nullptr, nullptr };

All other open review items from PR #2638 have been resolved, are hardcoded clang-format parser behaviors (such as the Doxygen Javadoc star alignment), or have since landed on main.

Key Legacy & Toolchain Compatibility Settings

To ensure the codebase continues to compile cleanly on both modern toolchains (VS2022) and the legacy target toolchain (Visual C++ 6), the following settings are established in .clang-format:

VC6 Template Compatibility (SpacesInAngles: Leave):
Prevents clang-format from collapsing nested template arguments (e.g., std::vector<std::vector<int> > to >>). VC6 and older compilers misparse >> as a right-shift operator. PR chore: Prevent conflict between clang-format and pre-C++11 nested template parsing #2760 (and its closed predecessor PR refactor: Extract nested templates into typedefs for legacy compatibility #2642) already resolved the instances where it was collapsed, and this setting ensures it stays that way.
VC6 Braced Initializer Compatibility (Cpp11BracedListStyle: false):
Prevents formatting braced-init-lists in C++11 style, which causes parsing issues on legacy compilers.
MSVC Inline Assembly Safety:
clang-format has known parser conflicts with MSVC-style inline assembly blocks when not enclosed in curly braces (which can cause the formatter to join assembly lines and break compilation). These have been pre-emptively wrapped in curly braces (__asm { ... }) in main via PR chore: Prevent conflict between clang-format and MSVC by wrapping inline assembly blocks in curly braces #2811, making the formatter pass entirely safe.
Macro-Split Assignments Resolved:
Problems regarding assignment formatting split across macros have been pre-emptively addressed by PR refactor: Eliminate macro-split assignments #2641.

Scope & Merging Strategy

The PR includes the full codebase diff across all source files.

Open to Review Rounds: This PR is open to further review rounds. If any formatting settings need adjustments, the codebase can be formatted again and the branch force-pushed.
Trivial Merge Conflict Resolution: If another pull request gets merged into main before this one, resolving conflicts is trivial: we simply re-run the formatter locally on top of the updated main branch and force-push.

Zero-Trust Verification

Reviewers can verify that this PR is 100% mechanically generated with no manual edits by running the following steps directly from main without checking out this branch:

# 1. Fetch the PR branch head natively from the repository URL
Write-Host "Fetching PR branch..."
git fetch https://github.com/TheSuperHackers/GeneralsGameCode.git pull/2820/head

# 2. Pull the .clang-format configuration from the PR commit
Write-Host "Getting .clang-format configuration..."
git checkout FETCH_HEAD -- .clang-format

# 3. Format the codebase locally
Write-Host "Formatting codebase locally..."
Get-ChildItem -Path Core, Generals, GeneralsMD, scripts, resources/gitinfo -Include *.cpp, *.h, *.inl -Recurse | ForEach-Object { clang-format -i $_.FullName }

# 4. Compare your local formatted working tree directly against the PR branch in-memory
# (We add --ignore-cr-at-eol to handle Windows CRLF line ending differences cleanly)
Write-Host "Comparing local formatting against the PR..."
git diff --ignore-cr-at-eol FETCH_HEAD -- Core Generals GeneralsMD scripts resources/gitinfo

Expected result: The diff output must be completely empty. If silent, it guarantees the PR contains only tool-generated formatting changes.

How to Migrate Existing Feature Branches

If you have an active feature branch developed before this bulk formatting pass, you can migrate it to the new formatted main branch by letting Git automatically ignore whitespace-only conflicts during the rebase. Any remaining conflicts after this step are genuine code-logic overlaps between your changes and this PR and will need to be resolved manually as usual.

git fetch upstream pull/2820/head:clang-fmt
git rebase clang-fmt -Xignore-all-space

greptile-apps · 2026-06-21T23:06:56Z

Too many files changed for review. (3000 files found, 500 file limit)

DevGeniusCode · 2026-06-22T05:52:43Z

-AlignEscapedNewlines: Left

If I remember correctly, we intentionally chose left alignment with a 4-character spacing.

githubawn · 2026-06-22T14:56:28Z

-AlignEscapedNewlines: Left
If I remember correctly, we intentionally chose left alignment with a 4-character spacing.

Thanks. Updated description, accidentally pasted older version. This line wasn't changed.

xezon · 2026-06-22T16:58:52Z

What is the correct strategy to migrate old branches to new main after the formatting was merged into main?

githubawn · 2026-06-22T17:13:18Z

removed this text, everything is in the main description

xezon · 2026-06-22T18:11:33Z

Did you test it? Does it work? This does not look as if it would work. I would expect the formatting needs to be merged into each commit of the branch?

DevGeniusCode · 2026-06-23T05:44:48Z

-UseTab: AlignWithSpaces
+UseTab: ForIndentation
+SpacesInAngles: Leave
+Cpp11BracedListStyle: false

Can you plz add short code examples before and after the changes?

githubawn · 2026-06-23T12:50:01Z

I'll update the description soon with more validating, newer guide, and code examples.

xezon · 2026-06-29T16:20:37Z

This needs progress.

githubawn · 2026-07-06T17:44:53Z

Updated PRs description. Code examples added. Tested the script from "Migrate Existing Feature Branches" between a clang-formatted main from 2026-07-06 and 10 prs. Undrafted.

Tested against 10 open PRs: the single rebase command resolves all whitespace-only conflicts automatically. Only genuine code-logic overlaps require manual resolution (1–6 hunks in the affected PRs). Per-commit formatting is not required

xezon · 2026-07-06T17:47:07Z

So now the big question is: WHEN MERGE? 👀

xezon · 2026-07-07T20:04:45Z

-		: m_offset(0)
-		, m_size(0)
+	  : m_offset(0)
+	  , m_size(0)


Leading tab and then 2 spaces, is that as intended? Naturally we would have expected leading tabs.

This was intentional to prevent Github from showing the wrong width. We can revert this to "AlignWithSpaces".

"UseTab: ForIndentation: Fixes the tab-space rendering mismatch in preprocessor block comments on GitHub (where GitHub defaults to tab=8, causing space-aligned block comments inside tab-indented preprocessor blocks to look misaligned)."

Didn't find a UseTab that wouldn't either uglify, keep github aligned or uses a single type of whitespace.

xezon · 2026-07-07T20:06:56Z

-	#define DEBUG_LOG_RAW(m)				do { { DebugLogRaw m ; } } while (0) // Log message without trailing new line character (LF)
-	#define DEBUG_LOG_LEVEL(l, m)		do { if (l & DebugLevelMask) { DebugLog m ; } } while (0)
-	#define DEBUG_LOG_LEVEL_RAW(l, m)	do { if (l & DebugLevelMask) { DebugLogRaw m ; } } while (0)
-	#define DEBUG_ASSERTLOG(c, m)		do { { if (!(c)) DebugLog m ; } } while (0)


Maybe a clang format off would be better readable for these macros

We can also try AfterControlStatement: MultiLine.

"Changing AfterControlStatement from Always to MultiLine tells clang-format to only break the { onto a new line if the controlling expression spans multiple lines. Since do has no condition, and single-line if (cond) conditions stay on one line, the { stays inline for all short macro bodies."

That does not sound ideal for this one case.

xezon · 2026-07-19T07:53:19Z

Dependencies #2883, #2885 merged

githubawn · 2026-07-29T12:32:56Z

Regenerated with:

IndentPPDirectives: None
IndentCaseLabels: false
BraceWrapping:
AfterEnum: false
AllowShortEnumsOnASingleLine: true
AllowShortCaseLabelsOnASingleLine: true

xezon

Looks almost very good

githubawn · 2026-07-30T14:55:56Z

Regenerated with:
BraceWrapping: AfterEnum: true
AllowShortEnumsOnASingleLine: false

xezon · 2026-07-30T20:46:35Z

+		//			&&(TheGameLogic->getFrame() - body->getLastHealingTimestamp()) <= HEALING_ICON_DISPLAY_TIME
+		//			)
+		if (TheGameLogic->getFrame() > HEALING_ICON_DISPLAY_TIME &&    // because so many things init health early in game
+		    (TheGameLogic->getFrame() - body->getLastHealingTimestamp() <= HEALING_ICON_DISPLAY_TIME))



Is there a way to tell clang format to remove excess empty lines like this one?

Will regenerate with:
InsertBraces: true
KeepEmptyLinesAtTheStartOfBlocks: false
MaxEmptyLinesToKeep: 1

I suggest to make InsertBraces: true a consideration for another time. For the initial format we do not need it, unless it is very needed in combination with the other 2?

Skyaero42

Overall, looks good.
I would recommend ripping of the bandaid a.s.a.p.

We also need to have checks in place that all new code follows clang format (or that the author has applied clang format).

If I understand correctly (with a bit of help from Claude), you can add the following to CI:

- name: Check formatting (diff-only)
        run: |
          git fetch origin ${{ github.base_ref }} --depth=1
          git-clang-format-18 --binary clang-format-18 --diff origin/${{ github.base_ref }} HEAD

or if git-clang-format isn't available

- name: Check formatting
  run: |
    git fetch origin ${{ github.base_ref }} --depth=1
    git diff --name-only origin/${{ github.base_ref }}...HEAD -- '*.cpp' '*.h' \
      | xargs -r clang-format --dry-run --Werror

@tintinhamans what are our options here.

Skyaero42 · 2026-08-01T14:19:56Z

 	{
 		AsciiString lowerName = name;
 		lowerName.toLower();
 		md.m_fileName = lowerName;
-//		DEBUG_LOG(("INI::parseMapCacheDefinition - adding %s to map cache", lowerName.str()));
+		//		DEBUG_LOG(("INI::parseMapCacheDefinition - adding %s to map cache", lowerName.str()));


Not sure if this is the correct formatting.

Not a big deal if there is no setting to adjust this. But looks odd indeed.

Skyaero42 · 2026-08-01T14:24:26Z

@@ -18,8 +18,7 @@

 // And please be careful of duplicates.  They are not rejected.
 // not const -- we might override from INI
-static PoolSizeRec PoolSizes[] =
-{
+static PoolSizeRec PoolSizes[] = {


I think bracket on its own line was correct here.

For consistency with other curly brace style it would make sense to make it

static PoolSizeRec PoolSizes[] = { };

Skyaero42 · 2026-08-01T14:25:32Z

 #if USE_BUFFERED_IO
 		val = fread(&c, 1, 1, m_file);
 #else
-		val = _read( m_handle, &c, 1);
+		val = _read(m_handle, &c, 1);
 #endif
 	} while ((val != 0) && (((c < '0') || (c > '9')) && (c != '-')));


shouldn't while be on a new line?

do { } while ()

makes sense

githubawn marked this pull request as draft June 23, 2026 12:49

githubawn force-pushed the chore/clang-format-codebase branch 2 times, most recently from bf5acb4 to 0a067f8 Compare July 6, 2026 17:32

githubawn marked this pull request as ready for review July 6, 2026 17:46

xezon reviewed Jul 7, 2026

View reviewed changes

xezon added the Refactor Edits the code with insignificant behavior changes, is never user facing label Jul 7, 2026

githubawn force-pushed the chore/clang-format-codebase branch from 0a067f8 to cd0af70 Compare July 17, 2026 21:44

Caball009 mentioned this pull request Jul 18, 2026

chore: Replace CPP_11(= delete) with FUNCTION_DELETE macro to help clang format #2885

Merged

githubawn force-pushed the chore/clang-format-codebase branch from cd0af70 to d65ade8 Compare July 20, 2026 21:23

xezon reviewed Jul 22, 2026

View reviewed changes

githubawn force-pushed the chore/clang-format-codebase branch from d65ade8 to f1e1de1 Compare July 29, 2026 12:32

xezon reviewed Jul 29, 2026

View reviewed changes

Comment thread Core/GameEngine/Include/GameNetwork/GameSpy/PeerThread.h Outdated

Comment thread Core/Tools/Launcher/Toolkit/Support/RefCounted.h

githubawn force-pushed the chore/clang-format-codebase branch from f1e1de1 to c8524e9 Compare July 30, 2026 14:48

xezon reviewed Jul 30, 2026

View reviewed changes

githubawn force-pushed the chore/clang-format-codebase branch 2 times, most recently from ebf1d78 to be9637b Compare July 31, 2026 21:58

githubawn force-pushed the chore/clang-format-codebase branch from be9637b to 77f0cd5 Compare July 31, 2026 22:18

chore: Apply updated clang-format rules across codebase

d698faf

githubawn force-pushed the chore/clang-format-codebase branch from 77f0cd5 to d698faf Compare August 1, 2026 12:20

Skyaero42 reviewed Aug 1, 2026

View reviewed changes

Uh oh!

Conversation

githubawn commented Jun 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

1. UseTab: ForIndentation GameLogic.h 25–45

2. SpacesInAngles: Leave PerfTimer.cpp 205–225

3. Cpp11BracedListStyle: false WOLGameSetupMenu.cpp 218–226

Key Legacy & Toolchain Compatibility Settings

Scope & Merging Strategy

Zero-Trust Verification

How to Migrate Existing Feature Branches

Uh oh!

greptile-apps Bot commented Jun 21, 2026

Uh oh!

DevGeniusCode commented Jun 22, 2026

Uh oh!

githubawn commented Jun 22, 2026

Uh oh!

xezon commented Jun 22, 2026

Uh oh!

githubawn commented Jun 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

xezon commented Jun 22, 2026

Uh oh!

DevGeniusCode commented Jun 23, 2026

Uh oh!

githubawn commented Jun 23, 2026

Uh oh!

xezon commented Jun 29, 2026

Uh oh!

githubawn commented Jul 6, 2026

Uh oh!

xezon commented Jul 6, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

xezon commented Jul 19, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

githubawn commented Jul 29, 2026

Uh oh!

xezon left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

githubawn commented Jul 30, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Skyaero42 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

githubawn commented Jun 21, 2026 •

edited

Loading

1. `UseTab: ForIndentation` GameLogic.h 25–45

2. `SpacesInAngles: Leave` PerfTimer.cpp 205–225

3. `Cpp11BracedListStyle: false` WOLGameSetupMenu.cpp 218–226

githubawn commented Jun 22, 2026 •

edited

Loading

Skyaero42 left a comment •

edited

Loading

Skyaero42 Aug 1, 2026 •

edited

Loading