Apply consistent formatting to C code within codebase

.clang-format

@@ -0,0 +1,213 @@
+---
+Language:        Cpp
+# BasedOnStyle:  Google
+AccessModifierOffset: -1
+AlignAfterOpenBracket: Align
+AlignArrayOfStructures: None
+AlignConsecutiveMacros: None
+AlignConsecutiveAssignments: None
+AlignConsecutiveBitFields: None
+AlignConsecutiveDeclarations: None
+AlignEscapedNewlines: Left
+AlignOperands:   Align
+AlignTrailingComments: true
+AllowAllArgumentsOnNextLine: true
+AllowAllParametersOfDeclarationOnNextLine: true
+AllowShortEnumsOnASingleLine: true
+AllowShortBlocksOnASingleLine: Never
+AllowShortCaseLabelsOnASingleLine: false
+AllowShortFunctionsOnASingleLine: All
+AllowShortLambdasOnASingleLine: Inline
+AllowShortIfStatementsOnASingleLine: WithoutElse
+AllowShortLoopsOnASingleLine: true
+AlwaysBreakAfterDefinitionReturnType: None
+AlwaysBreakAfterReturnType: None
+AlwaysBreakBeforeMultilineStrings: true
+AlwaysBreakTemplateDeclarations: Yes
+AttributeMacros:
+  - __capability
+BinPackArguments: true
+BinPackParameters: true
+BraceWrapping:
+  AfterCaseLabel:  false
+  AfterClass:      false
+  AfterControlStatement: Never
+  AfterEnum:       false
+  AfterFunction:   false
+  AfterNamespace:  false
+  AfterObjCDeclaration: false
+  AfterStruct:     false
+  AfterUnion:      false
+  AfterExternBlock: false
+  BeforeCatch:     false
+  BeforeElse:      false
+  BeforeLambdaBody: false
+  BeforeWhile:     false
+  IndentBraces:    false
+  SplitEmptyFunction: true
+  SplitEmptyRecord: true
+  SplitEmptyNamespace: true
+BreakBeforeBinaryOperators: None
+BreakBeforeConceptDeclarations: true
+BreakBeforeBraces: Attach
+BreakBeforeInheritanceComma: false
+BreakInheritanceList: BeforeColon
+BreakBeforeTernaryOperators: true
+BreakConstructorInitializersBeforeComma: false
+BreakConstructorInitializers: BeforeColon
+BreakAfterJavaFieldAnnotations: false
+BreakStringLiterals: true
+ColumnLimit:     100
+CommentPragmas:  '^ IWYU pragma:'
+QualifierAlignment: Leave
+CompactNamespaces: false
+ConstructorInitializerIndentWidth: 4
+ContinuationIndentWidth: 4
+Cpp11BracedListStyle: true
+DeriveLineEnding: true
+DerivePointerAlignment: true
+DisableFormat:   false
+EmptyLineAfterAccessModifier: Never
+EmptyLineBeforeAccessModifier: LogicalBlock
+ExperimentalAutoDetectBinPacking: false
+PackConstructorInitializers: NextLine
+BasedOnStyle:    ''
+ConstructorInitializerAllOnOneLineOrOnePerLine: false
+AllowAllConstructorInitializersOnNextLine: true
+FixNamespaceComments: true
+ForEachMacros:
+  - foreach
+  - Q_FOREACH
+  - BOOST_FOREACH
+IfMacros:
+  - KJ_IF_MAYBE
+IncludeBlocks:   Regroup
+IncludeCategories:
+  - Regex:           '^<ext/.*\.h>'
+    Priority:        2
+    SortPriority:    0
+    CaseSensitive:   false
+  - Regex:           '^<.*\.h>'
+    Priority:        1
+    SortPriority:    0
+    CaseSensitive:   false
+  - Regex:           '^<.*'
+    Priority:        2
+    SortPriority:    0
+    CaseSensitive:   false
+  - Regex:           '.*'
+    Priority:        3
+    SortPriority:    0
+    CaseSensitive:   false
+IncludeIsMainRegex: '([-_](test|unittest))?$'
+IncludeIsMainSourceRegex: ''
+IndentAccessModifiers: false
+IndentCaseLabels: true
+IndentCaseBlocks: false
+IndentGotoLabels: true
+IndentPPDirectives: None
+IndentExternBlock: AfterExternBlock
+IndentRequires:  false
+IndentWidth:     2
+IndentWrappedFunctionNames: false
+InsertTrailingCommas: None
+JavaScriptQuotes: Leave
+JavaScriptWrapImports: true
+KeepEmptyLinesAtTheStartOfBlocks: false
+LambdaBodyIndentation: Signature
+MacroBlockBegin: ''
+MacroBlockEnd:   ''
+MaxEmptyLinesToKeep: 1
+NamespaceIndentation: None
+ObjCBinPackProtocolList: Never
+ObjCBlockIndentWidth: 2
+ObjCBreakBeforeNestedBlockParam: true
+ObjCSpaceAfterProperty: false
+ObjCSpaceBeforeProtocolList: true
+PenaltyBreakAssignment: 2
+PenaltyBreakBeforeFirstCallParameter: 1
+PenaltyBreakComment: 300
+PenaltyBreakFirstLessLess: 120
+PenaltyBreakString: 1000
+PenaltyBreakTemplateDeclaration: 10
+PenaltyExcessCharacter: 1000000
+PenaltyReturnTypeOnItsOwnLine: 200
+PenaltyIndentedWhitespace: 0
+PointerAlignment: Left
+PPIndentWidth:   -1
+RawStringFormats:
+  - Language:        Cpp
+    Delimiters:
+      - cc
+      - CC
+      - cpp
+      - Cpp
+      - CPP
+      - 'c++'
+      - 'C++'
+    CanonicalDelimiter: ''
+    BasedOnStyle:    google
+  - Language:        TextProto
+    Delimiters:
+      - pb
+      - PB
+      - proto
+      - PROTO
+    EnclosingFunctions:
+      - EqualsProto
+      - EquivToProto
+      - PARSE_PARTIAL_TEXT_PROTO
+      - PARSE_TEST_PROTO
+      - PARSE_TEXT_PROTO
+      - ParseTextOrDie
+      - ParseTextProtoOrDie
+      - ParseTestProto
+      - ParsePartialTestProto
+    CanonicalDelimiter: pb
+    BasedOnStyle:    google
+ReferenceAlignment: Pointer
+ReflowComments:  false
+ShortNamespaceLines: 1
+SortIncludes:    CaseSensitive
+SortJavaStaticImport: Before
+SortUsingDeclarations: true
+SpaceAfterCStyleCast: false
+SpaceAfterLogicalNot: false
+SpaceAfterTemplateKeyword: true
+SpaceBeforeAssignmentOperators: true
+SpaceBeforeCaseColon: false
+SpaceBeforeCpp11BracedList: false
+SpaceBeforeCtorInitializerColon: true
+SpaceBeforeInheritanceColon: true
+SpaceBeforeParens: ControlStatements
+SpaceAroundPointerQualifiers: Default
+SpaceBeforeRangeBasedForLoopColon: true
+SpaceInEmptyBlock: false
+SpaceInEmptyParentheses: false
+SpacesBeforeTrailingComments: 2
+SpacesInAngles:  Never
+SpacesInConditionalStatement: false
+SpacesInContainerLiterals: true
+SpacesInCStyleCastParentheses: false
+SpacesInLineCommentPrefix:
+  Minimum:         1
+  Maximum:         -1
+SpacesInParentheses: false
+SpacesInSquareBrackets: false
+SpaceBeforeSquareBrackets: false
+BitFieldColonSpacing: Both
+Standard:        Auto
+StatementAttributeLikeMacros:
+  - Q_EMIT
+StatementMacros:
+  - Q_UNUSED
+  - QT_REQUIRE_VERSION
+TabWidth:        8
+UseCRLF:         false
+UseTab:          Never
+WhitespaceSensitiveMacros:
+  - STRINGIZE
+  - PP_STRINGIZE
+  - BOOST_PP_STRINGIZE
+  - NS_SWIFT_NAME
+  - CF_SWIFT_NAME

.devcontainer/Dockerfile

@@ -11,6 +11,7 @@ RUN apt-get update && \
   apt-get install --yes --no-install-recommends \
     build-essential \
     ca-certificates \
+    clang-format \
     cmake \
     curl \
     g++-14 \

.devcontainer/devcontainer.json

@@ -14,7 +14,8 @@
   "customizations": {
     "vscode": {
       "extensions": [
-        "jakebecker.elixir-ls"
+        "jakebecker.elixir-ls",
+        "xaver.clang-format"
       ]
     }
   },

CHANGELOG.md

@@ -5,6 +5,23 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## UNRELEASED
+
+### Added
+
+- `clang-format` command added to dev container Dockerfile.
+- `.clang-format` file from `xgboost` Github repo itself added as the default formatting of C files in this repo.
+- `xaver.clang-format"` vscode extension added to repo.
+
+### Updated
+
+- Formatting pass across all source and header files in `c/exgboost` directory - formatting change only no code changes.
+- Formatting information added to `CHANGELOG.md`.
+
+### Removed
+
+- Nothing.
+
 ## 0.10.2
 
 ### Added

CONTRIBUTING.md

@@ -356,11 +356,12 @@ Large-data tests can reveal memory issues, but they do not prove that no memory
 ## Pull Request Checklist
 
 - [ ] Tests pass: `mix test`
-- [ ] Code formatted: `mix format`
+- [ ] Code formatted, for Elixir use `mix format` and for C use `clang-format`.  If you are developing using VSCode make
+      use of the extensions inside the supplied devcontainer and ensure you `formatOnSave`.
 - [ ] No compiler warnings: `mix compile --warnings-as-errors`
 - [ ] Added tests for new functionality
 - [ ] Added invalid-input and boundary tests for NIF changes
-- [ ] Updated CHANGELOG.md
+- [ ] Updated `CHANGELOG.md`
 - [ ] NIF changes validated with safety tests
 - [ ] Native code tested under AddressSanitizer or Valgrind where supported
 - [ ] No native addresses are exposed or reused across NIF calls

Makefile

@@ -32,7 +32,7 @@ EXGBOOST_SO = $(PRIV_DIR)/libexgboost.so
 EXGBOOST_LIB_DIR = $(PRIV_DIR)/lib
 
 # Build flags
-CFLAGS = -I$(EXGBOOST_DIR)/include -I$(XGBOOST_LIB_DIR)/include -I$(XGBOOST_DIR) $(if $(ERTS_INCLUDE_DIR),-I$(ERTS_INCLUDE_DIR)) -fPIC -O3 --verbose -shared -std=c11
+CFLAGS = -I$(EXGBOOST_DIR)/include -I$(XGBOOST_LIB_DIR)/include -I$(XGBOOST_DIR) $(if $(ERTS_INCLUDE_DIR),-I$(ERTS_INCLUDE_DIR)) -fPIC -O3 -shared -std=c11
 
 C_SRCS = $(wildcard $(EXGBOOST_DIR)/src/*.c) $(wildcard $(EXGBOOST_DIR)/include/*.h)
 
@@ -110,4 +110,4 @@ clean:
 	rm -rf $(EXGBOOST_SO)
 	rm -rf $(EXGBOOST_LIB_DIR)
 	rm -rf $(XGBOOST_DIR)
-	rm -rf $(XGBOOST_LIB_DIR_FLAG)
+	rm -rf $(XGBOOST_LIB_DIR_FLAG)

c/exgboost/include/booster.h

@@ -3,56 +3,30 @@
 
 #include "utils.h"
 
-ERL_NIF_TERM EXGBoosterCreate(ErlNifEnv *env, int argc,
-                              const ERL_NIF_TERM argv[]);
-ERL_NIF_TERM EXGBoosterBoostedRounds(ErlNifEnv *env, int argc,
-                                     const ERL_NIF_TERM argv[]);
-ERL_NIF_TERM EXGBoosterSlice(ErlNifEnv *env, int argc,
-                             const ERL_NIF_TERM argv[]);
-ERL_NIF_TERM EXGBoosterSetParam(ErlNifEnv *env, int argc,
-                                const ERL_NIF_TERM argv[]);
-ERL_NIF_TERM EXGBoosterGetNumFeature(ErlNifEnv *env, int argc,
-                                     const ERL_NIF_TERM argv[]);
-ERL_NIF_TERM EXGBoosterUpdateOneIter(ErlNifEnv *env, int argc,
-                                     const ERL_NIF_TERM argv[]);
-ERL_NIF_TERM EXGBoosterBoostOneIter(ErlNifEnv *env, int argc,
-                                    const ERL_NIF_TERM argv[]);
-ERL_NIF_TERM EXGBoosterEvalOneIter(ErlNifEnv *env, int argc,
-                                   const ERL_NIF_TERM argv[]);
-ERL_NIF_TERM EXGBoosterGetAttrNames(ErlNifEnv *env, int argc,
-                                    const ERL_NIF_TERM argv[]);
-ERL_NIF_TERM EXGBoosterGetAttr(ErlNifEnv *env, int argc,
-                               const ERL_NIF_TERM argv[]);
-ERL_NIF_TERM EXGBoosterSetAttr(ErlNifEnv *env, int argc,
-                               const ERL_NIF_TERM argv[]);
-ERL_NIF_TERM EXGBoosterSetStrFeatureInfo(ErlNifEnv *env, int argc,
-                                         const ERL_NIF_TERM argv[]);
-ERL_NIF_TERM EXGBoosterGetStrFeatureInfo(ErlNifEnv *env, int argc,
-                                         const ERL_NIF_TERM argv[]);
-ERL_NIF_TERM EXGBoosterFeatureScore(ErlNifEnv *env, int argc,
-                                    const ERL_NIF_TERM argv[]);
-ERL_NIF_TERM EXGBoosterPredictFromDMatrix(ErlNifEnv *env, int argc,
-                                          const ERL_NIF_TERM argv[]);
-ERL_NIF_TERM EXGBoosterPredictFromDense(ErlNifEnv *env, int argc,
-                                        const ERL_NIF_TERM argv[]);
-ERL_NIF_TERM EXGBoosterPredictFromCSR(ErlNifEnv *env, int argc,
-                                      const ERL_NIF_TERM argv[]);
-ERL_NIF_TERM EXGBoosterLoadModel(ErlNifEnv *env, int argc,
-                                 const ERL_NIF_TERM argv[]);
-ERL_NIF_TERM EXGBoosterSaveModel(ErlNifEnv *env, int argc,
-                                 const ERL_NIF_TERM argv[]);
-ERL_NIF_TERM EXGBoosterSerializeToBuffer(ErlNifEnv *env, int argc,
-                                         const ERL_NIF_TERM argv[]);
-ERL_NIF_TERM EXGBoosterDeserializeFromBuffer(ErlNifEnv *env, int argc,
-                                             const ERL_NIF_TERM argv[]);
-ERL_NIF_TERM EXGBoosterLoadModelFromBuffer(ErlNifEnv *env, int argc,
-                                           const ERL_NIF_TERM argv[]);
-ERL_NIF_TERM EXGBoosterSaveModelToBuffer(ErlNifEnv *env, int argc,
-                                         const ERL_NIF_TERM argv[]);
-ERL_NIF_TERM EXGBoosterSaveJsonConfig(ErlNifEnv *env, int argc,
-                                      const ERL_NIF_TERM argv[]);
-ERL_NIF_TERM EXGBoosterLoadJsonConfig(ErlNifEnv *env, int argc,
-                                      const ERL_NIF_TERM argv[]);
-ERL_NIF_TERM EXGBoosterDumpModelEx(ErlNifEnv *env, int argc,
-                                   const ERL_NIF_TERM argv[]);
+ERL_NIF_TERM EXGBoosterCreate(ErlNifEnv *env, int argc, const ERL_NIF_TERM argv[]);
+ERL_NIF_TERM EXGBoosterBoostedRounds(ErlNifEnv *env, int argc, const ERL_NIF_TERM argv[]);
+ERL_NIF_TERM EXGBoosterSlice(ErlNifEnv *env, int argc, const ERL_NIF_TERM argv[]);
+ERL_NIF_TERM EXGBoosterSetParam(ErlNifEnv *env, int argc, const ERL_NIF_TERM argv[]);
+ERL_NIF_TERM EXGBoosterGetNumFeature(ErlNifEnv *env, int argc, const ERL_NIF_TERM argv[]);
+ERL_NIF_TERM EXGBoosterUpdateOneIter(ErlNifEnv *env, int argc, const ERL_NIF_TERM argv[]);
+ERL_NIF_TERM EXGBoosterBoostOneIter(ErlNifEnv *env, int argc, const ERL_NIF_TERM argv[]);
+ERL_NIF_TERM EXGBoosterEvalOneIter(ErlNifEnv *env, int argc, const ERL_NIF_TERM argv[]);
+ERL_NIF_TERM EXGBoosterGetAttrNames(ErlNifEnv *env, int argc, const ERL_NIF_TERM argv[]);
+ERL_NIF_TERM EXGBoosterGetAttr(ErlNifEnv *env, int argc, const ERL_NIF_TERM argv[]);
+ERL_NIF_TERM EXGBoosterSetAttr(ErlNifEnv *env, int argc, const ERL_NIF_TERM argv[]);
+ERL_NIF_TERM EXGBoosterSetStrFeatureInfo(ErlNifEnv *env, int argc, const ERL_NIF_TERM argv[]);
+ERL_NIF_TERM EXGBoosterGetStrFeatureInfo(ErlNifEnv *env, int argc, const ERL_NIF_TERM argv[]);
+ERL_NIF_TERM EXGBoosterFeatureScore(ErlNifEnv *env, int argc, const ERL_NIF_TERM argv[]);
+ERL_NIF_TERM EXGBoosterPredictFromDMatrix(ErlNifEnv *env, int argc, const ERL_NIF_TERM argv[]);
+ERL_NIF_TERM EXGBoosterPredictFromDense(ErlNifEnv *env, int argc, const ERL_NIF_TERM argv[]);
+ERL_NIF_TERM EXGBoosterPredictFromCSR(ErlNifEnv *env, int argc, const ERL_NIF_TERM argv[]);
+ERL_NIF_TERM EXGBoosterLoadModel(ErlNifEnv *env, int argc, const ERL_NIF_TERM argv[]);
+ERL_NIF_TERM EXGBoosterSaveModel(ErlNifEnv *env, int argc, const ERL_NIF_TERM argv[]);
+ERL_NIF_TERM EXGBoosterSerializeToBuffer(ErlNifEnv *env, int argc, const ERL_NIF_TERM argv[]);
+ERL_NIF_TERM EXGBoosterDeserializeFromBuffer(ErlNifEnv *env, int argc, const ERL_NIF_TERM argv[]);
+ERL_NIF_TERM EXGBoosterLoadModelFromBuffer(ErlNifEnv *env, int argc, const ERL_NIF_TERM argv[]);
+ERL_NIF_TERM EXGBoosterSaveModelToBuffer(ErlNifEnv *env, int argc, const ERL_NIF_TERM argv[]);
+ERL_NIF_TERM EXGBoosterSaveJsonConfig(ErlNifEnv *env, int argc, const ERL_NIF_TERM argv[]);
+ERL_NIF_TERM EXGBoosterLoadJsonConfig(ErlNifEnv *env, int argc, const ERL_NIF_TERM argv[]);
+ERL_NIF_TERM EXGBoosterDumpModelEx(ErlNifEnv *env, int argc, const ERL_NIF_TERM argv[]);
 #endif