Merge pull request #1012 from slaclab/ESROGUE-554

Adding C++ linter to CI
slaclab · Jul 10, 2024 · c2ddf8e · c2ddf8e
2 parents 49886b5 + bbee743
commit c2ddf8e
Show file tree

Hide file tree

Showing 270 changed files with 1,397 additions and 1,549 deletions.
diff --git a/.github/workflows/rogue_ci.yml b/.github/workflows/rogue_ci.yml
@@ -34,20 +34,26 @@ jobs:
           cache: 'pip'
           cache-dependency-path: 'pip_requirements.txt'
 
+      # Install dependencies
       - name: Install dependencies
         run: |
           sudo apt-get update
           sudo apt-get install doxygen doxygen-doc libzmq3-dev libboost-all-dev
           pip install -r pip_requirements.txt
 
-      # Flake 8 check
-      - name: Flake8 Tests
+      # Python Linter
+      - name: Python Linter
         run: |
           python -m compileall -f ./python/
           flake8 --count ./python/
           python -m compileall -f ./tests
           flake8 --count ./tests/
 
+      # C++ Linter
+      - name: C++ Linter
+        run: |
+          find . -name '*.h' -o -name '*.cpp' | xargs cpplint
+
       # Rogue
       - name: Build Rogue
         run: |

diff --git a/= b/=
diff --git a/CPPLINT.cfg b/CPPLINT.cfg
@@ -0,0 +1,34 @@
+#######################################################
+# CPPLINT.cfg
+#######################################################
+
+# Increase the max number of characters on a given line
+linelength=250
+
+# List of filters to apply
+filter=-legal/copyright
+
+# Suppress the warning for unapproved C++11 headers
+# Required for "<thread> is an unapproved C++11 header"
+filter=-build/c++11
+
+# Disable the build/include_order check
+# Required for #include "rogue/Directives.h" to be at start
+filter=-build/include_order
+
+# Disable the build/header_guard check
+# Note changing header guard has wrong style
+# E.g. from __ROGUE_UTILITIES_FILEIO_MODULE_H__ to INCLUDE_ROGUE_UTILITIES_MODULE_H_
+filter=-build/header_guard
+
+# Disable whitespace/indent check
+# private/public: indent will be based on .clang-format format"
+filter=-whitespace/indent
+
+# Disable runtime/arrays
+# TODO: We should fix in the future
+filter=-runtime/arrays
+
+# Disable runtime/references
+# TODO: We should fix in the future
+filter=-runtime/references
diff --git a/include/rogue/Directives.h b/include/rogue/Directives.h
@@ -1,9 +1,6 @@
 /**
- *-----------------------------------------------------------------------------
- * Title      : Common Directives
  * ----------------------------------------------------------------------------
- * File       : Directives.h
- * Created    : 2023-02-13
+ * Company    : SLAC National Accelerator Laboratory
  * ----------------------------------------------------------------------------
  * Description:
  * Common Directives For Rogue

diff --git a/include/rogue/EnableSharedFromThis.h b/include/rogue/EnableSharedFromThis.h
@@ -1,9 +1,6 @@
 /**
- *-----------------------------------------------------------------------------
- * Title      : Common virtual class to enable shared_from_this() calls.
  * ----------------------------------------------------------------------------
- * File       : EnableSharedFromThis.h
- * Created    : 2019-11-15
+ * Company    : SLAC National Accelerator Laboratory
  * ----------------------------------------------------------------------------
  * Description:
  * This is a common parent class that must be used instead of std::enable_shared_from_this

diff --git a/include/rogue/GeneralError.h b/include/rogue/GeneralError.h
@@ -1,9 +1,6 @@
 /**
- *-----------------------------------------------------------------------------
- * Title      : General Error
  * ----------------------------------------------------------------------------
- * File       : GeneralError.h
- * Created    : 2017-12-05
+ * Company    : SLAC National Accelerator Laboratory
  * ----------------------------------------------------------------------------
  * Description:
  * General exception for Rogue

diff --git a/include/rogue/GilRelease.h b/include/rogue/GilRelease.h
@@ -1,9 +1,6 @@
 /**
- *-----------------------------------------------------------------------------
- * Title      : Release GIL within scope.
  * ----------------------------------------------------------------------------
- * File       : GilRelease.h
- * Created    : 2017-02-28
+ * Company    : SLAC National Accelerator Laboratory
  * ----------------------------------------------------------------------------
  * Description:
  * Release GIL for the scope of this class.

diff --git a/include/rogue/Helpers.h b/include/rogue/Helpers.h
@@ -1,9 +1,6 @@
 /**
- *-----------------------------------------------------------------------------
- * Title      : Helpful Functions
  * ----------------------------------------------------------------------------
- * File       : Helpers.h
- * Created    : 2018-11-28
+ * Company    : SLAC National Accelerator Laboratory
  * ----------------------------------------------------------------------------
  * Description:
  * Helper functions for Rogue

diff --git a/include/rogue/Logging.h b/include/rogue/Logging.h
@@ -1,9 +1,6 @@
 /**
- *-----------------------------------------------------------------------------
- * Title      : Logging interface
  * ----------------------------------------------------------------------------
- * File       : Logging.h
- * Created    : 2017-02-28
+ * Company    : SLAC National Accelerator Laboratory
  * ----------------------------------------------------------------------------
  * Description:
  * Logging interface for pyrogue
@@ -73,7 +70,7 @@ class Logging {
 
     static std::shared_ptr<rogue::Logging> create(std::string name, bool quiet = false);
 
-    Logging(std::string name, bool quiet = false);
+    explicit Logging(std::string name, bool quiet = false);
     ~Logging();
 
     static void setLevel(uint32_t level);

diff --git a/include/rogue/Queue.h b/include/rogue/Queue.h
@@ -1,9 +1,6 @@
 /**
- *-----------------------------------------------------------------------------
- * Title      : General Queue
  * ----------------------------------------------------------------------------
- * File       : Queue.h
- * Created    : 2017-01-18
+ * Company    : SLAC National Accelerator Laboratory
  * ----------------------------------------------------------------------------
  * Description:
  * General queue for Rogue

diff --git a/include/rogue/ScopedGil.h b/include/rogue/ScopedGil.h
@@ -1,9 +1,6 @@
 /**
- *-----------------------------------------------------------------------------
- * Title      : Scoped GIL
  * ----------------------------------------------------------------------------
- * File       : ScopedGil.h
- * Created    : 2017-02-28
+ * Company    : SLAC National Accelerator Laboratory
  * ----------------------------------------------------------------------------
  * Description:
  * Acquire the GIL for the scope of this class.

diff --git a/include/rogue/Version.h b/include/rogue/Version.h
@@ -1,9 +1,6 @@
 /**
- *-----------------------------------------------------------------------------
- * Title      : Rogue Version
  * ----------------------------------------------------------------------------
- * File       : Version.h
- * Created    : 2017-05-17
+ * Company    : SLAC National Accelerator Laboratory
  * ----------------------------------------------------------------------------
  * Description:
  * Version helpers for Rogue

diff --git a/include/rogue/hardware/MemMap.h b/include/rogue/hardware/MemMap.h
@@ -1,9 +1,9 @@
 /**
- *-----------------------------------------------------------------------------
- * Title      : Raw Memory Mapped Access
  * ----------------------------------------------------------------------------
- * File       : MemMap.h
- * Created    : 2019-11-18
+ * Company    : SLAC National Accelerator Laboratory
+ * ----------------------------------------------------------------------------
+ * Description:
+ *      Raw Memory Mapped Access
  * ----------------------------------------------------------------------------
  * This file is part of the rogue software platform. It is subject to
  * the license terms in the LICENSE.txt file found in the top-level directory

diff --git a/include/rogue/hardware/axi/AxiMemMap.h b/include/rogue/hardware/axi/AxiMemMap.h
@@ -1,9 +1,9 @@
 /**
- *-----------------------------------------------------------------------------
- * Title      : AXI Memory Mapped Access
  * ----------------------------------------------------------------------------
- * File       : AxiMemMap.h
- * Created    : 2017-03-21
+ * Company    : SLAC National Accelerator Laboratory
+ * ----------------------------------------------------------------------------
+ * Description:
+ *      AXI Memory Mapped Access
  * ----------------------------------------------------------------------------
  * This file is part of the rogue software platform. It is subject to
  * the license terms in the LICENSE.txt file found in the top-level directory
@@ -22,6 +22,7 @@
 
 #include <memory>
 #include <mutex>
+#include <string>
 #include <thread>
 
 #include "rogue/Logging.h"
@@ -69,7 +70,7 @@ class AxiMemMap : public rogue::interfaces::memory::Slave {
     static void setup_python();
 
     // Class Creator
-    AxiMemMap(std::string path);
+    explicit AxiMemMap(std::string path);
 
     // Destructor
     ~AxiMemMap();

diff --git a/include/rogue/hardware/axi/AxiStreamDma.h b/include/rogue/hardware/axi/AxiStreamDma.h
@@ -1,6 +1,9 @@
 /**
- *-----------------------------------------------------------------------------
- * Title      : AxiStreamDma Interface Class
+ * ----------------------------------------------------------------------------
+ * Company    : SLAC National Accelerator Laboratory
+ * ----------------------------------------------------------------------------
+ * Description:
+ *      AxiStreamDma Interface Class
  * ----------------------------------------------------------------------------
  * This file is part of the rogue software platform. It is subject to
  * the license terms in the LICENSE.txt file found in the top-level directory
@@ -19,6 +22,7 @@
 
 #include <map>
 #include <memory>
+#include <string>
 #include <thread>
 
 #include "rogue/Logging.h"
@@ -32,7 +36,7 @@ namespace axi {
 //! Storage class for shared memory buffers
 class AxiStreamDmaShared {
   public:
-    AxiStreamDmaShared(std::string path);
+    explicit AxiStreamDmaShared(std::string path);
 
     //! Shared FD
     int32_t fd;

diff --git a/include/rogue/hardware/axi/module.h b/include/rogue/hardware/axi/module.h
@@ -1,9 +1,6 @@
 /**
- *-----------------------------------------------------------------------------
- * Title      : Python Module
  * ----------------------------------------------------------------------------
- * File       : module.h
- * Created    : 2017-03-21
+ * Company    : SLAC National Accelerator Laboratory
  * ----------------------------------------------------------------------------
  * Description:
  * Python module setup

diff --git a/include/rogue/hardware/drivers/DmaDriver.h b/include/rogue/hardware/drivers/DmaDriver.h
@@ -26,6 +26,7 @@
     #include <linux/types.h>
 #else
     #include <stdint.h>
+
     #include <string>
 #endif
 
@@ -634,7 +635,6 @@ static inline ssize_t dmaGetBuffCount(int32_t fd) {
     return (ioctl(fd, DMA_Get_Buff_Count, 0));
 }
 
-
 /**
  * dmaGetGitVersion - Get the DMA Driver's Git Version
  * @fd: File descriptor to use.
@@ -644,12 +644,12 @@ static inline ssize_t dmaGetBuffCount(int32_t fd) {
  * Returns: The DMA Driver's Git Version string
  */
 static inline std::string dmaGetGitVersion(int32_t fd) {
-   char gitv[32] = {0}; // Initialize with zeros to ensure null-termination
-   if (ioctl(fd, DMA_Get_GITV, gitv) < 0) {
-      return "";
-   }
-   gitv[32 - 1] = '\0'; // Ensure null-termination
-   return std::string(gitv);
+    char gitv[32] = {0};  // Initialize with zeros to ensure null-termination
+    if (ioctl(fd, DMA_Get_GITV, gitv) < 0) {
+        return "";
+    }
+    gitv[32 - 1] = '\0';  // Ensure null-termination
+    return std::string(gitv);
 }
 
 /**
@@ -676,7 +676,7 @@ static inline void** dmaMapDma(int32_t fd, uint32_t* count, uint32_t* size) {
     if (count != NULL) *count = bCount;
     if (size != NULL) *size = bSize;
 
-    if ((ret = (void**)malloc(sizeof(void*) * bCount)) == 0) return (NULL);
+    if ((ret = reinterpret_cast<void**>(malloc(sizeof(void*) * bCount))) == 0) return (NULL);
 
     // Attempt to map
     gCount = 0;

diff --git a/include/rogue/hardware/module.h b/include/rogue/hardware/module.h
@@ -1,6 +1,6 @@
 /**
- *-----------------------------------------------------------------------------
- * Title      : Python Module
+ * ----------------------------------------------------------------------------
+ * Company    : SLAC National Accelerator Laboratory
  * ----------------------------------------------------------------------------
  * Description:
  * Python module setup

diff --git a/include/rogue/interfaces/ZmqClient.h b/include/rogue/interfaces/ZmqClient.h
@@ -1,9 +1,9 @@
 /**
- *-----------------------------------------------------------------------------
- * Title      : Rogue ZMQ Control Interface
  * ----------------------------------------------------------------------------
- * File       : ZmqClient.h
- * Created    : 2019-05-02
+ * Company    : SLAC National Accelerator Laboratory
+ * ----------------------------------------------------------------------------
+ * Description:
+ *      Rogue ZMQ Control Interface
  * ----------------------------------------------------------------------------
  * This file is part of the rogue software platform. It is subject to
  * the license terms in the LICENSE.txt file found in the top-level directory
@@ -19,6 +19,7 @@
 #include "rogue/Directives.h"
 
 #include <memory>
+#include <string>
 #include <thread>
 
 #include "rogue/Logging.h"

diff --git a/include/rogue/interfaces/ZmqServer.h b/include/rogue/interfaces/ZmqServer.h
@@ -1,9 +1,9 @@
 /**
- *-----------------------------------------------------------------------------
- * Title      : Rogue ZMQ Control Interface
  * ----------------------------------------------------------------------------
- * File       : ZmqServer.h
- * Created    : 2019-05-02
+ * Company    : SLAC National Accelerator Laboratory
+ * ----------------------------------------------------------------------------
+ * Description:
+ *      Rogue ZMQ Control Interface
  * ----------------------------------------------------------------------------
  * This file is part of the rogue software platform. It is subject to
  * the license terms in the LICENSE.txt file found in the top-level directory
@@ -19,6 +19,7 @@
 #include "rogue/Directives.h"
 
 #include <memory>
+#include <string>
 #include <thread>
 
 #include "rogue/Logging.h"

diff --git a/include/rogue/interfaces/api/Bsp.h b/include/rogue/interfaces/api/Bsp.h
@@ -1,9 +1,9 @@
 /**
- *-----------------------------------------------------------------------------
- * Title      : C++ API Bsp
  * ----------------------------------------------------------------------------
- * File       : Bsp.h
- * Created    : 2023-04-17
+ * Company    : SLAC National Accelerator Laboratory
+ * ----------------------------------------------------------------------------
+ * Description:
+ *      C++ API BSP (Board Support Package)
  * ----------------------------------------------------------------------------
  * This file is part of the rogue software platform. It is subject to
  * the license terms in the LICENSE.txt file found in the top-level directory
@@ -16,7 +16,10 @@
  **/
 #ifndef __ROGUE_INTERFACE_API_BSP_H__
 #define __ROGUE_INTERFACE_API_BSP_H__
+
 #include <boost/python.hpp>
+#include <memory>
+#include <string>
 #include <vector>
 
 namespace rogue {
@@ -36,7 +39,7 @@ class Bsp {
     static std::shared_ptr<rogue::interfaces::api::Bsp> create(std::string modName, std::string rootClass);
 
     //! Create the object
-    Bsp(boost::python::object obj);
+    explicit Bsp(boost::python::object obj);
     Bsp(std::string modName, std::string rootClass);
     ~Bsp();