Improve C++ linting (#443)

Author: vkucera

.clang-format

@@ -54,3 +54,8 @@ UseTab:          Never
 # Do not format protobuf files
 Language: Proto
 DisableFormat: true
+# ---
+# # Since clang-format 13.0.0
+# Language: Json
+# # O2 dumps JSON files with 4-space indents.
+# IndentWidth: 4

.github/workflows/clang-format-lint.yml

@@ -1,20 +1,70 @@
 ---
 # https://github.com/marketplace/actions/clang-format-lint
-name: Clang Format Linter
+name: ClangFormat
 on: [push, pull_request]
-permissions: {}
+permissions:
+  # Give the default GITHUB_TOKEN write permission to commit and push, comment issues & post new PR
+  # Remove the ones you do not need
+  contents: write
+  issues: write
+  pull-requests: write
+concurrency:
+  group: ${{ github.ref }}-${{ github.workflow }}
+  cancel-in-progress: true
 jobs:
-  build:
-    name: Clang Format Linter
+  clang-format:
+    name: Clang Format
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Code
         uses: actions/checkout@v3
+
       - name: Clang Format
-        uses: DoozyX/[email protected]
+        id: clang
+        uses: DoozyX/[email protected]
         with:
           #source: '.'
           #exclude: './third_party ./external'
-          #extensions: 'h,cpp,cxx,C'
-          clangFormatVersion: 11
+          extensions: 'C,c,c++,cc,cl,cpp,cu,cuh,cxx,cxx.in,h,h++,hh,h.in,hpp,hxx,inc,inl,macro'
+          clangFormatVersion: 16
           style: file
+          inplace: true
+
+      # Set a results status = 0 if no changes, = 1 if formatted
+      - name: Set result status
+        id: clang-result
+        run: |
+          status=0
+          if ! git diff --quiet; then
+            status=1
+          fi
+          echo "status=$status" >> "$GITHUB_OUTPUT"
+
+        # Create pull request if applicable (for now works only on PR from same repository, not from forks)
+      - name: Print PR condition
+        run: |
+          # Print the condition
+          echo "${{ github.event_name }} == 'push'"
+      - name: Create Pull Request with applied fixes
+        id: cpr
+        if: github.event_name == 'push'
+        uses: peter-evans/create-pull-request@v5
+        with:
+          token: ${{ secrets.PAT || secrets.GITHUB_TOKEN }}
+          commit-message: "[Clang format] Apply linters automatic fixes"
+          title: "[Clang format] Apply linters automatic fixes"
+          body: "Please merge this pull request to apply automatic fixes by Clang format."
+          labels: bot
+          branch: patch-${{ github.workflow }}-${{ github.ref_name }}
+          delete-branch: true
+      - name: Create PR output
+        if: steps.clang-result.outputs.status == 1
+        run: |
+          echo "::error::Files need formatting."
+          if [ ${{ github.event_name }} == 'push' ]; then
+            echo "::error::Merge pull request ${{ steps.cpr.outputs.pull-request-url }} to apply automatic fixes."
+          elif [ ${{ github.event_name }} == 'pull_request' ]; then
+            echo "::error::Check ${{ github.event.pull_request.head.repo.html_url }}/pulls to apply automatic fixes."
+            echo "::notice::Actions must be allowed in your repository. See ${{ github.event.pull_request.head.repo.html_url }}/settings/actions"
+          fi
+          exit 1

.github/workflows/mega-linter.yml

@@ -33,7 +33,7 @@ jobs:
     steps:
       # Git Checkout
       - name: Checkout Code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           token: ${{ secrets.PAT || secrets.GITHUB_TOKEN }}
           fetch-depth: 0 # If you use VALIDATE_ALL_CODEBASE = true, you can remove this line to improve performances
@@ -54,8 +54,8 @@ jobs:
 
       # Upload MegaLinter artifacts
       - name: Archive production artifacts
-        if: ${{ success() }} || ${{ failure() }}
-        uses: actions/upload-artifact@v3
+        if: success() || failure()
+        uses: actions/upload-artifact@v4
         with:
           name: MegaLinter reports
           path: |
@@ -66,10 +66,10 @@ jobs:
       - name: Print PR condition
         run: |
           # Print the condition
-          echo "${{ steps.ml.outputs.has_updated_sources }} == 1 && (${{ env.APPLY_FIXES_EVENT }} == 'all' || ${{ env.APPLY_FIXES_EVENT }} == ${{ github.event_name }}) && ${{ env.APPLY_FIXES_MODE }} == 'pull_request' && (${{ github.event_name }} == 'push' || ${{ github.event.pull_request.head.repo.full_name }} == ${{ github.repository }})"
+          echo "(${{ env.APPLY_FIXES_EVENT }} == 'all' || ${{ env.APPLY_FIXES_EVENT }} == ${{ github.event_name }}) && ${{ env.APPLY_FIXES_MODE }} == 'pull_request' && (${{ github.event_name }} == 'push' || ${{ github.event.pull_request.head.repo.full_name }} == ${{ github.repository }})"
       - name: Create Pull Request with applied fixes
         id: cpr
-        if: steps.ml.outputs.has_updated_sources == 1 && (env.APPLY_FIXES_EVENT == 'all' || env.APPLY_FIXES_EVENT == github.event_name) && env.APPLY_FIXES_MODE == 'pull_request' && (github.event_name == 'push' || github.event.pull_request.head.repo.full_name == github.repository)
+        if: (env.APPLY_FIXES_EVENT == 'all' || env.APPLY_FIXES_EVENT == github.event_name) && env.APPLY_FIXES_MODE == 'pull_request' && (github.event_name == 'push' || github.event.pull_request.head.repo.full_name == github.repository)
         uses: peter-evans/create-pull-request@v5
         with:
           token: ${{ secrets.PAT || secrets.GITHUB_TOKEN }}
@@ -80,9 +80,15 @@ jobs:
           branch: patch-${{ github.workflow }}-${{ github.ref_name }}
           delete-branch: true
       - name: Create PR output
-        if: steps.ml.outputs.has_updated_sources == 1 && (env.APPLY_FIXES_EVENT == 'all' || env.APPLY_FIXES_EVENT == github.event_name) && env.APPLY_FIXES_MODE == 'pull_request' && (github.event_name == 'push' || github.event.pull_request.head.repo.full_name == github.repository)
+        if: steps.ml.outputs.has_updated_sources == 1
         run: |
-          echo "::error::Merge pull request ${{ steps.cpr.outputs.pull-request-url }} to apply automatic fixes."
+          echo "::error::MegaLinter has fixed some files."
+          if [ ${{ github.event_name }} == 'push' ]; then
+            echo "::error::Merge pull request ${{ steps.cpr.outputs.pull-request-url }} to apply automatic fixes."
+          elif [ ${{ github.event_name }} == 'pull_request' ]; then
+            echo "::error::Check ${{ github.event.pull_request.head.repo.html_url }}/pulls to apply automatic fixes."
+            echo "::notice::Actions must be allowed in your repository. See ${{ github.event.pull_request.head.repo.html_url }}/settings/actions"
+          fi
           exit 1
 
       # Push new commit if applicable (for now works only on PR from same repository, not from forks)

.mega-linter.yml

@@ -32,4 +32,6 @@ FLAVOR_SUGGESTIONS: false # Don't show suggestions about different MegaLinter fl
 PYTHON_ISORT_CONFIG_FILE: pyproject.toml
 PYTHON_PYRIGHT_CONFIG_FILE: pyproject.toml
 PYTHON_RUFF_CONFIG_FILE: pyproject.toml
-FILTER_REGEX_EXCLUDE: (codeQA/)
+CPP_CPPLINT_FILE_EXTENSIONS: [".C", ".c", ".c++", ".cc", ".cl", ".cpp", ".cu", ".cuh", ".cxx", ".cxx.in", ".h", ".h++", ".hh", ".h.in", ".hpp", ".hxx", ".inc", ".inl", ".macro"]
+CPP_CLANG_FORMAT_FILE_EXTENSIONS: [".C", ".c", ".c++", ".cc", ".cl", ".cpp", ".cu", ".cuh", ".cxx", ".cxx.in", ".h", ".h++", ".hh", ".h.in", ".hpp", ".hxx", ".inc", ".inl", ".macro"]
+FILTER_REGEX_EXCLUDE: (codeQA/|Upgrade/)

CPPLINT.cfg

@@ -1,2 +1 @@
-linelength=160
-filter=-whitespace/braces,-whitespace/comments,-build/namespaces,-runtime/references
+filter=-build/c++11,-build/namespaces,-readability/fn_size,-readability/todo,-runtime/references,-whitespace/blank_line,-whitespace/braces,-whitespace/comments,-whitespace/line_length,-whitespace/semicolon,-whitespace/todo

FirstAnalysis/Correlations/doPhiProjections.C

@@ -1,3 +1,14 @@
+// Copyright 2019-2020 CERN and copyright holders of ALICE O2.
+// See https://alice-o2.web.cern.ch/copyright for details of the copyright holders.
+// All rights not expressly granted are reserved.
+//
+// This software is distributed under the terms of the GNU General Public
+// License v3 (GPL Version 3), copied verbatim in the file "COPYING".
+//
+// In applying this license CERN does not waive the privileges and immunities
+// granted to it by virtue of its status as an Intergovernmental Organization
+// or submit itself to any jurisdiction.
+
 //////////////////////////////////////////////////////////////
 //  Macro to obtain projections of two-particle correlations for flow studies
 //
@@ -50,7 +61,7 @@ void doPhiProjections(
   static Double_t Nch[] = {0, 10, 20, 30, 40, 50, 60, 80, 100, 200};
   //  Nbins is the number of multiplicity bins
   static const uint Nbins = 9;
-  //static const uint Nbins = sizeof(Nch) / sizeof(Nch[0]);
+  // static const uint Nbins = sizeof(Nch) / sizeof(Nch[0]);
   const double absDeltaPhi = 1.3; // y-projection range (it is only needed for jet yield calculation from delta eta projection)
 
   TFile* infile = new TFile(inFileName, "read");
@@ -64,7 +75,7 @@ void doPhiProjections(
     //  do reference flow
 
     // 2D histogram of two-particle correlation: same/mixed event ratio (normalised as it should be: Ntrig, B(0,0))
-    TH2D* hdphidetaRidge_ref = (TH2D*)infile->Get(Form("dphi_ref_%u", imult));
+    TH2D* hdphidetaRidge_ref = reinterpret_cast<TH2D*>(infile->Get(Form("dphi_ref_%u", imult)));
     if (!hdphidetaRidge_ref) {
       printf("No histograms corresponding mult bin %u \n", imult);
       continue;
@@ -85,7 +96,7 @@ void doPhiProjections(
     hdphiRidgeN_ref->Write();
 
     //  add the projections positive + negative
-    TH1D* hdphiRidge_ref = (TH1D*)hdphiRidgeP_ref->Clone(Form("proj_dphi_ref_%u", imult));
+    TH1D* hdphiRidge_ref = reinterpret_cast<TH1D*>(hdphiRidgeP_ref->Clone(Form("proj_dphi_ref_%u", imult)));
     hdphiRidge_ref->Add(hdphiRidgeP_ref, hdphiRidgeN_ref, 0.5, 0.5);
 
     outfile->cd();
@@ -127,14 +138,14 @@ void doPhiProjections(
       for (uint iassoc = 0; iassoc < assocCount; ++iassoc) {
 
         // 2D histogram of two-particle correlation: same/mixed event ratio (normalised as it should be: Ntrig, B(0,0))
-        TH2D* hdphidetaRidge = (TH2D*)infile->Get(Form("dphi_%u_%u_%u", itrig, iassoc, imult));
+        TH2D* hdphidetaRidge = reinterpret_cast<TH2D*>(infile->Get(Form("dphi_%u_%u_%u", itrig, iassoc, imult)));
         if (!hdphidetaRidge) {
           printf("No histograms corresponding mult bin %u. (itrig=%u, iassoc=%u)\n", imult, itrig, iassoc);
           continue;
         } // if histogram not existing
 
         // Clone hdphidetaJet: hdphidetaRidge will be used for phi projection; hdphidetaJet for eta projection
-        TH2D* hdphidetaJet = (TH2D*)hdphidetaRidge->Clone("hdphidetaJet");
+        TH2D* hdphidetaJet = reinterpret_cast<TH2D*>(hdphidetaRidge->Clone("hdphidetaJet"));
 
         //  Normalise hdphidetaRidge used for delta phi projection with the width of the long-range region
         double norm = 2.0 * (absDeltaEtaMax - absDeltaEtaMin);
@@ -188,7 +199,7 @@ void doPhiProjections(
         hdphiRidgeN->Write();
 
         //  add the projections positive + negative
-        TH1D* hdphiRidge = (TH1D*)hdphiRidgeP->Clone(Form("proj_dphi_%u_%u_%u", itrig, iassoc, imult));
+        TH1D* hdphiRidge = reinterpret_cast<TH1D*>(hdphiRidgeP->Clone(Form("proj_dphi_%u_%u_%u", itrig, iassoc, imult)));
         hdphiRidge->Add(hdphiRidgeP, hdphiRidgeN, 0.5, 0.5);
 
         outfile->cd();

FirstAnalysis/Correlations/doTemplate.C

@@ -1,3 +1,14 @@
+// Copyright 2019-2020 CERN and copyright holders of ALICE O2.
+// See https://alice-o2.web.cern.ch/copyright for details of the copyright holders.
+// All rights not expressly granted are reserved.
+//
+// This software is distributed under the terms of the GNU General Public
+// License v3 (GPL Version 3), copied verbatim in the file "COPYING".
+//
+// In applying this license CERN does not waive the privileges and immunities
+// granted to it by virtue of its status as an Intergovernmental Organization
+// or submit itself to any jurisdiction.
+
 ///////////////////////////////////////////////////////////////////////////
 //  Macro to perform a template fit on 1D histograms of projected correlations on delta phi
 //
@@ -65,8 +76,8 @@ void doTemplate(
     //  get the histograms projected to delta phi,
     //  we need to distinguish histogram with desired (high) multiplicity
     //  from a histogram with low multiplicity used as the peripheral baseline
-    hminuit = (TH1D*)inFile->Get(Form("proj_dphi_ref_%d", iMult))->Clone("hminuit");
-    hminuit_periph = (TH1D*)inFile->Get("proj_dphi_ref_0")->Clone("hminuit_periph");
+    hminuit = reinterpret_cast<TH1D*>(inFile->Get(Form("proj_dphi_ref_%d", iMult))->Clone("hminuit"));
+    hminuit_periph = reinterpret_cast<TH1D*>(inFile->Get("proj_dphi_ref_0")->Clone("hminuit_periph"));
 
     //  do the template fit
     double par[4], parerr[4];
@@ -82,10 +93,10 @@ void doTemplate(
       //  F*Y_peripheral(deltaphi) + Y_ridge = template fit
       TF1* fTemplate = new TF1("fTemplate", templateFitFunction, -0.5 * TMath::Pi() + 1e-6, 1.5 * TMath::Pi() - 1e-6, 4);
       fTemplate->SetParameters(par); //  set the parameters obtained from template fit above using tempMinuit()
-      //fTemplate->SetLineStyle(kSolid);
-      //fTemplate->SetLineColor(kBlue+1);
+      // fTemplate->SetLineStyle(kSolid);
+      // fTemplate->SetLineColor(kBlue+1);
 
-      TH1F* hTemplate = (TH1F*)hminuit->Clone();
+      TH1F* hTemplate = reinterpret_cast<TH1F*>(hminuit->Clone());
       hTemplate->Reset();
       for (int iBin = 1; iBin < hTemplate->GetNbinsX() + 1; iBin++) {
         hTemplate->SetBinContent(iBin, fTemplate->Eval(hTemplate->GetBinCenter(iBin)));
@@ -131,7 +142,7 @@ void doTemplate(
       fPeripheral->SetLineWidth(3);
       fPeripheral->SetLineColor(kGreen + 2);
 
-      TH1F* hPeripheral = (TH1F*)hminuit->Clone();
+      TH1F* hPeripheral = reinterpret_cast<TH1F*>(hminuit->Clone());
       hPeripheral->Reset();
       for (int iBin = 1; iBin < hPeripheral->GetNbinsX() + 1; iBin++) {
         hPeripheral->SetBinContent(iBin, fPeripheral->Eval(hPeripheral->GetBinCenter(iBin)));
@@ -184,7 +195,7 @@ void doTemplate(
       latex->DrawLatex(0.3, 0.93, "pp #sqrt{s} = 13 TeV");
       latex->DrawLatex(0.3, 0.86, Form("%.1f < p_{T, trig, assoc} < %.1f", binspTref[0], binspTref[1]));
       latex->DrawLatex(0.3, 0.79, Form("%.1f < N_{ch} < %.1f", binsMult[iMult], binsMult[iMult + 1]));
-      //latex->DrawLatex(0.3,0.72,Form("%.1f < #Delta#eta < %.1f",etaMin,etaMax));
+      // latex->DrawLatex(0.3,0.72,Form("%.1f < #Delta#eta < %.1f",etaMin,etaMax));
 
       if (savePlots)
         cTemplate->SaveAs(Form("%s/template_ref_%d.png", outputPlotsName, iMult));
@@ -199,8 +210,8 @@ void doTemplate(
       //  get the histograms projected to delta phi,
       //  we need to distinguish histogram with desired (high) multiplicity
       //  from a histogram with low multiplicity used as the peripheral baseline
-      hminuit = (TH1D*)inFile->Get(Form("proj_dphi_%d_0_%d", ipTtrig, iMult))->Clone("hminuit");
-      hminuit_periph = (TH1D*)inFile->Get(Form("proj_dphi_%d_0_0", ipTtrig))->Clone("hminuit_periph");
+      hminuit = reinterpret_cast<TH1D*>(inFile->Get(Form("proj_dphi_%d_0_%d", ipTtrig, iMult))->Clone("hminuit"));
+      hminuit_periph = reinterpret_cast<TH1D*>(inFile->Get(Form("proj_dphi_%d_0_0", ipTtrig))->Clone("hminuit_periph"));
 
       //  do the template fit
       double par[4], parerr[4];
@@ -219,7 +230,7 @@ void doTemplate(
         fTemplate->SetLineStyle(kSolid);
         fTemplate->SetLineColor(kRed);
 
-        TH1F* hTemplate = (TH1F*)hminuit->Clone();
+        TH1F* hTemplate = reinterpret_cast<TH1F*>(hminuit->Clone());
         hTemplate->Reset();
         for (int iBin = 1; iBin < hTemplate->GetNbinsX() + 1; iBin++) {
           hTemplate->SetBinContent(iBin, fTemplate->Eval(hTemplate->GetBinCenter(iBin)));
@@ -247,7 +258,7 @@ void doTemplate(
         fPeripheral->SetLineStyle(kSolid);
         fPeripheral->SetLineColor(kMagenta);
 
-        TH1F* hPeripheral = (TH1F*)hminuit->Clone();
+        TH1F* hPeripheral = reinterpret_cast<TH1F*>(hminuit->Clone());
         hPeripheral->Reset();
         for (int iBin = 1; iBin < hPeripheral->GetNbinsX() + 1; iBin++) {
           hPeripheral->SetBinContent(iBin, fPeripheral->Eval(hPeripheral->GetBinCenter(iBin)));
@@ -297,7 +308,7 @@ void doTemplate(
         latex->DrawLatex(0.3, 0.93, "pp #sqrt{s} = 13 TeV");
         latex->DrawLatex(0.3, 0.86, Form("%.1f < p_{T, trig} < %.1f", binspTtrig[ipTtrig], binspTtrig[ipTtrig + 1]));
         latex->DrawLatex(0.3, 0.79, Form("%.1f < N_{ch} < %.1f", binsMult[iMult], binsMult[iMult + 1]));
-        //latex->DrawLatex(0.3,0.72,Form("%.1f < #Delta#eta < %.1f",etaMin,etaMax));
+        // latex->DrawLatex(0.3,0.72,Form("%.1f < #Delta#eta < %.1f",etaMin,etaMax));
 
         if (savePlots)
           cTemplate->SaveAs(Form("%s/template_%d_%d.png", outputPlotsName, ipTtrig, iMult));
@@ -340,8 +351,8 @@ double templateFitFunction(double* x, double* par)
 ///////////////////////////////////////////////////////////////////////////
 void minuitFunction(int& npar, double* gin, double& ff, double* par, int iflag)
 {
-  TH1D* h = (TH1D*)hminuit->Clone("h");
-  TH1D* hperi = (TH1D*)hminuit_periph->Clone("hperi");
+  TH1D* h = reinterpret_cast<TH1D*>(hminuit->Clone("h"));
+  TH1D* hperi = reinterpret_cast<TH1D*>(hminuit_periph->Clone("hperi"));
 
   double f = par[0];
   double gv = par[1];