clang-formatted and fixed comments, global application of clang-format

is not possible yet, the WTL macros are not formatting the way I would
like and ignoring every section sounds like a poor solution.

Author: Jan Wilmans

application/DebugViewpp/DebugView++.cpp

@@ -15,9 +15,9 @@
 #include "atleverything.h"
 
 #include <filesystem>
-#include <cstdlib>  // for std::getenv
+#include <cstdlib> // for std::getenv
 
-//#define ENABLE_CRASHPAD
+// #define ENABLE_CRASHPAD
 #ifdef ENABLE_CRASHPAD
 #include "crashpad.h"
 #endif
@@ -161,8 +161,8 @@ int Main(HINSTANCE hInstance, HINSTANCE /*hPrevInstance*/, LPWSTR /*lpstrCmdLine
         }
         else if (boost::iequals(args[i], L"/log"))
         {
-            //wndMain.SetLogging();        // todo: implement: FileWriter needs to concurrently access m_logfile, it now causes a crash if DbgMsgSrc -1 is run
-            // this should be replaced by the new streaming-to-disk feature we discussed.
+            // wndMain.SetLogging();        // todo: implement: FileWriter needs to concurrently access m_logfile, it now causes a crash if DbgMsgSrc -1 is run
+            //  this should be replaced by the new streaming-to-disk feature we discussed.
         }
         else if (boost::icontains(args[i], L"/tab:"))
         {
@@ -213,7 +213,8 @@ int Main(HINSTANCE hInstance, HINSTANCE /*hPrevInstance*/, LPWSTR /*lpstrCmdLine
 } // namespace fusion
 
 
-int WINAPI wWinMain(HINSTANCE hInstance, HINSTANCE hPrevInstance, LPWSTR lpstrCmdLine, int nCmdShow) try
+int WINAPI wWinMain(HINSTANCE hInstance, HINSTANCE hPrevInstance, LPWSTR lpstrCmdLine, int nCmdShow)
+try
 {
 #ifdef ENABLE_CRASHPAD
     initializeCrashPad();

application/DebugViewpp/DropTargetSupport.cpp

@@ -18,7 +18,6 @@ namespace debugviewpp {
  */
 
 DropTargetSupport::DropTargetSupport()
-
 {
 }
 

application/DebugViewpp/MainFrame.cpp

@@ -234,7 +234,7 @@ LRESULT CMainFrame::OnCreate(const CREATESTRUCT* /*pCreate*/)
     HWND hWndCmdBar = m_cmdBar.Create(*this, rcDefault, nullptr, ATL_SIMPLE_CMDBAR_PANE_STYLE);
     m_cmdBar.AttachMenu(GetMenu());
     m_cmdBar.LoadImages(IDR_MAINFRAME);
-    SetMenu(nullptr); //disable second menu bar
+    SetMenu(nullptr); // disable second menu bar
 
     CreateSimpleReBar(ATL_SIMPLE_REBAR_NOBORDER_STYLE);
     CReBarCtrl rebar(m_hWndToolBar);
@@ -1492,11 +1492,12 @@ void CMainFrame::Resume()
         catch (std::exception& e)
         {
             const auto message = std::format("Unable to capture Kernel Messages.\n"
-                       "({})\n\n"
-                       "Make sure you have appropriate permissions.\n"
-                       "\n"
-                       "You may need to start this application by right-clicking it and selecting\n"
-                       "'Run As Administator' even if you have administrator rights.", e.what());
+                                             "({})\n\n"
+                                             "Make sure you have appropriate permissions.\n"
+                                             "\n"
+                                             "You may need to start this application by right-clicking it and selecting\n"
+                                             "'Run As Administator' even if you have administrator rights.",
+                e.what());
             MessageBox(WStr(message), m_applicationName.c_str(), MB_ICONERROR | MB_OK);
             m_tryKernel = false;
         }
@@ -1669,10 +1670,10 @@ void CMainFrame::OnViewDuplicate(UINT /*uNotifyCode*/, int /*nID*/, CWindow /*wn
 
     AddFilterView(dlg.GetName(), dlg.GetFilters());
 
-    //auto &view = GetView();
-    //auto newLogView = std::make_shared<CLogView>(view);        // no copy constructor available
-    //newLogView->SetName(view.GetName() + L" (copy)");
-    //AddFilterView(newLogView);
+    // auto &view = GetView();
+    // auto newLogView = std::make_shared<CLogView>(view);        // no copy constructor available
+    // newLogView->SetName(view.GetName() + L" (copy)");
+    // AddFilterView(newLogView);
 
     SaveSettings();
 }

application/DebugViewppLib/Debugview_kernel_client.cpp

@@ -9,25 +9,30 @@ constexpr const char* DRIVER_SERVICE_NAME = "debugviewdriver";
 constexpr const char* DRIVER_DISPLAY_NAME = "DbgView Kernel Message Driver";
 const std::string driverPath = "C:\\Windows\\System32\\drivers\\dbgvpp.sys";
 
-bool FileExists(const std::string& path) {
+bool FileExists(const std::string& path)
+{
     DWORD fileAttributes = GetFileAttributesA(path.c_str());
     return (fileAttributes != INVALID_FILE_ATTRIBUTES &&
-        !(fileAttributes & FILE_ATTRIBUTE_DIRECTORY));
+            !(fileAttributes & FILE_ATTRIBUTE_DIRECTORY));
 }
 
 bool StartDriverSvc()
 {
     SC_HANDLE hSCManager = OpenSCManager(NULL, NULL, SC_MANAGER_ALL_ACCESS);
-    if (!hSCManager) return false;
+    if (!hSCManager)
+        return false;
 
     SC_HANDLE hService = OpenServiceA(hSCManager, DRIVER_SERVICE_NAME, SERVICE_START);
-    if (!hService) {
+    if (!hService)
+    {
         CloseServiceHandle(hSCManager);
         return false;
     }
 
-    if (!StartService(hService, 0, NULL)) {
-        if (GetLastError() == ERROR_SERVICE_ALREADY_RUNNING) {
+    if (!StartService(hService, 0, NULL))
+    {
+        if (GetLastError() == ERROR_SERVICE_ALREADY_RUNNING)
+        {
             std::cout << "Service is already running.\n";
             CloseServiceHandle(hService);
             CloseServiceHandle(hSCManager);
@@ -47,18 +52,22 @@ bool StartDriverSvc()
 bool StopDriverSvc()
 {
     SC_HANDLE hSCManager = OpenSCManager(NULL, NULL, SC_MANAGER_ALL_ACCESS);
-    if (!hSCManager) return false;
+    if (!hSCManager)
+        return false;
 
     SC_HANDLE hService = OpenServiceA(hSCManager, DRIVER_SERVICE_NAME, SERVICE_STOP);
-    if (!hService) {
+    if (!hService)
+    {
         CloseServiceHandle(hSCManager);
         return false;
     }
 
     SERVICE_STATUS status;
-    if (!ControlService(hService, SERVICE_CONTROL_STOP, &status)) {
+    if (!ControlService(hService, SERVICE_CONTROL_STOP, &status))
+    {
         DWORD err = GetLastError();
-        if (err != ERROR_SERVICE_NOT_ACTIVE) {
+        if (err != ERROR_SERVICE_NOT_ACTIVE)
+        {
             std::cout << "Failed to stop service. Error: " << err << std::endl;
         }
     }
@@ -73,12 +82,14 @@ void InstallKernelMessagesDriver(const std::string& driverLocation)
     // try to uninstall first, in case the driver is somehow still loaded.
     UninstallKernelMessagesDriver();
 
-    if (!FileExists(driverPath)) {
+    if (!FileExists(driverPath))
+    {
         std::cout << "Driver file not found at: " << driverPath << std::endl;
     }
 
     SC_HANDLE hSCManager = OpenSCManager(NULL, NULL, SC_MANAGER_ALL_ACCESS);
-    if (!hSCManager) {
+    if (!hSCManager)
+    {
         std::cout << "Failed to open Service Control Manager. Error: " << GetLastError() << std::endl;
     }
 
@@ -91,11 +102,12 @@ void InstallKernelMessagesDriver(const std::string& driverLocation)
         SERVICE_DEMAND_START,
         SERVICE_ERROR_NORMAL,
         driverLocation.c_str(),
-        NULL, NULL, NULL, NULL, NULL
-    );
+        NULL, NULL, NULL, NULL, NULL);
 
-    if (!hService) {
-        if (GetLastError() == ERROR_SERVICE_EXISTS) {
+    if (!hService)
+    {
+        if (GetLastError() == ERROR_SERVICE_EXISTS)
+        {
             std::cout << "Service already exists.\n";
             CloseServiceHandle(hSCManager);
         }

application/DebugViewppLib/KernelReader.cpp

@@ -104,7 +104,10 @@ void KernelReader::Poll()
     memset(m_pBuf, 0, kernelMessageBufferSize);
     DWORD dwOut = 0;
     ::DeviceIoControl(m_handle.get(), DBGV_READ_LOG, NULL, 0, m_pBuf, kernelMessageBufferSize, &dwOut, NULL);
-    if (dwOut == 0) return; // no messages to be read
+    if (dwOut == 0)
+    {
+        return; // no messages to be read
+    }
 
     PLOG_ITEM pNextItem = m_pBuf;
     while (pNextItem->dwIndex != 0)

application/Win32Lib/Win32Lib.cpp

@@ -300,14 +300,14 @@ void SetSecurityInfo(HANDLE hObject, SE_OBJECT_TYPE ObjectType, SECURITY_INFORMA
 
 #ifdef DACL_MODIFY
 
-//delete DACL at all, so permit Full Access for Everyone
+// delete DACL at all, so permit Full Access for Everyone
 void DeleteObjectDACL(HANDLE hObject)
 {
     Win32::SetSecurityInfo(hObject, SE_KERNEL_OBJECT, DACL_SECURITY_INFORMATION, nullptr, nullptr, nullptr, nullptr);
 }
 
-//add necessary permissions for "Authenticated Users" group (all non-anonymous users)
-//and for "All Application Packages", "All Restricted Application Packages" for UWP support
+// add necessary permissions for "Authenticated Users" group (all non-anonymous users)
+// and for "All Application Packages", "All Restricted Application Packages" for UWP support
 void AdjustObjectDACL(HANDLE hObject)
 {
     ACL* pOldDACL;

application/include/DebugViewppLib/Debugview_kernel_client.h

@@ -3,6 +3,10 @@
 // (See accompanying file LICENSE_1_0.txt or copy at
 // http://www.boost.org/LICENSE_1_0.txt)
 
+//
+// this is the dbgv.sys interface
+//
+
 #pragma once
 
 #include <windows.h>
@@ -13,9 +17,9 @@
 #include <string>
 #include <iostream>
 
-// this is the dbgv.sys interface
 #define FILE_DEVICE_DBGV 0x8305
 
+// clang-format off
 #define DBGV_CAPTURE_KERNEL          CTL_CODE(FILE_DEVICE_DBGV, DWORD(0), METHOD_BUFFERED, FILE_ANY_ACCESS)     //0x00  //enable capture kernel
 #define DBGV_UNCAPTURE_KERNEL        CTL_CODE(FILE_DEVICE_DBGV, DWORD(1), METHOD_BUFFERED, FILE_ANY_ACCESS)     //0x04  //
 #define DBGV_CLEAR_DISPLAY           CTL_CODE(FILE_DEVICE_DBGV, DWORD(2), METHOD_BUFFERED, FILE_ANY_ACCESS)     //0x08  //clear display
@@ -28,6 +32,7 @@
 #define DBGV_UNSET_CARRIAGE_RETURN   CTL_CODE(FILE_DEVICE_DBGV, DWORD(0x0e), METHOD_BUFFERED, FILE_ANY_ACCESS)  //0x38  //
 #define DBGV_SET_VERBOSE_MESSAGES    CTL_CODE(FILE_DEVICE_DBGV, DWORD(0x0f), METHOD_BUFFERED, FILE_ANY_ACCESS)  //0x3C  //enable log verbose
 #define DBGV_UNSET_VERBOSE_MESSAGES  CTL_CODE(FILE_DEVICE_DBGV, DWORD(0x10), METHOD_BUFFERED, FILE_ANY_ACCESS)  //0x40  //reset log verbose
+// clang-format on
 
 inline std::string feature_to_string(DWORD value)
 {
@@ -51,7 +56,7 @@ inline std::string feature_to_string(DWORD value)
 }
 
 // suppress the non-standard use of zero-sized array in struct/union
-#pragma warning(disable:4200)
+#pragma warning(disable : 4200)
 
 #pragma pack(1)
 typedef struct
@@ -63,7 +68,7 @@ typedef struct
 } LOG_ITEM, *PLOG_ITEM;
 #pragma pack()
 
-constexpr const wchar_t * strDbgviewKernelDriverDeviceName = L"\\\\.\\dbgv";
+constexpr const wchar_t* strDbgviewKernelDriverDeviceName = L"\\\\.\\dbgv";
 constexpr const DWORD kernelMessageBufferSize = 0x10000;
 
 void InstallKernelMessagesDriver(const std::string& driverLocation);

utils/apply-clang-format.py

@@ -30,12 +30,20 @@ def IsCppFile(fullname):
         return True
     if ext.lower().endswith(".hh"):
         return True
-    return False    
+    return False
 
 def IsIgnoredDirectory(dirname):
-    if dirname.lower().endswith("\gen"):
+    if dirname.lower().endswith("\\gen"):
+        return True
+    if dirname.lower().endswith("\\gen64"):
+        return True
+    if dirname.lower().endswith("\\nuget"):
+        return True
+    if dirname.lower().endswith("\\packages"):
         return True
-    if dirname.lower().endswith("\gen64"):
+    if "\\application\\Libraries\\" in dirname.lower():
+        return True
+    if "\\nuget\\packages\\" in dirname.lower():
         return True
     return False
 
@@ -44,22 +52,22 @@ def GetFiles(filemask, recurse):
         result = []
         path = os.path.dirname(os.path.abspath(filemask))
         for dirName, subdirList, fileList in os.walk(path):
-            if IsIgnoredDirectory(dirName): 
+            if IsIgnoredDirectory(dirName):
                 continue
             for fname in fileList:
                 filename = dirName + "\\" +  fname
-                if not IsCppFile(filename): 
+                if not IsCppFile(filename):
                     continue
                 result += [filename]
         return result
     else:
         result = []
         for filename in glob.glob(filemask):
-            if not IsCppFile(filename): 
+            if not IsCppFile(filename):
                 continue
             result += [os.path.abspath(filename)]
         return result
-    
+
 def filter(keyword):
     for line in sys.stdin:
         if not keyword in line:
@@ -80,7 +88,7 @@ def HasInvalidArgs():
     if sys.argv[1].startswith("/"):
         return True
     return False
-    
+
 def main():
     if HasInvalidArgs():
         print ("Usage: " + os.path.basename(sys.argv[0]) + " <filemask> [/s] [/f]")
@@ -105,7 +113,7 @@ def main():
     except KeyboardInterrupt:
         pass
     except Exception:
-        traceback.print_exc(file=sys.stdout) 
+        traceback.print_exc(file=sys.stdout)
     sys.exit(0)
-    
+