tweak clang-format for better include grouping

MUME · Jun 16, 2024 · 3907375 · 3907375
1 parent 48690b8
commit 3907375
Show file tree

Hide file tree

Showing 343 changed files with 1,729 additions and 1,346 deletions.
diff --git a/.clang-format b/.clang-format
@@ -70,9 +70,24 @@ ForEachMacros:
   - foreach
   - Q_FOREACH
   - BOOST_FOREACH
+IncludeBlocks: Regroup
 IncludeCategories:
-  - Regex:           '^<Q.*'
-    Priority:        200
+  # Headers in ""
+  - Regex:           '^"'
+    Priority:        1
+    SortPriority:    1
+  # Headers in <>
+  - Regex:           '^<[^Q][^/]*>$'
+    Priority:        2
+    SortPriority:    2
+  # Headers in <>
+  - Regex:           '^<[^Q].*[/]'
+    Priority:        3
+    SortPriority:    3
+  # Qt headers
+  - Regex:           '^<Q[^>]'
+    Priority:        4
+    SortPriority:    4
 IncludeIsMainRegex: '(Test)?$'
 IndentCaseLabels: false
 IndentWidth:     4
@@ -97,7 +112,7 @@ PenaltyExcessCharacter: 50
 PenaltyReturnTypeOnItsOwnLine: 300
 PointerAlignment: Right
 ReflowComments:  false
-SortIncludes:    true
+SortIncludes:    CaseSensitive
 SortUsingDeclarations: true
 SpaceAfterCStyleCast: true
 SpaceAfterTemplateKeyword: false

diff --git a/src/adventure/adventuresession.h b/src/adventure/adventuresession.h
@@ -3,10 +3,11 @@
 // Copyright (C) 2023 The MMapper Authors
 // Author: Mike Repass <[email protected]> (Taryn)
 
+#include "../../tests/testadventure.h"
+
 #include <chrono>
-#include <QString>
 
-#include "../../tests/testadventure.h"
+#include <QString>
 
 class AdventureSession
 {

diff --git a/src/adventure/adventuretracker.h b/src/adventure/adventuretracker.h
@@ -3,12 +3,12 @@
 // Copyright (C) 2023 The MMapper Authors
 // Author: Mike Repass <[email protected]> (Taryn)
 
-#include <QObject>
-
 #include "../observer/gameobserver.h"
 #include "adventuresession.h"
 #include "lineparsers.h"
 
+#include <QObject>
+
 class AdventureTracker final : public QObject
 {
     Q_OBJECT

diff --git a/src/adventure/adventurewidget.cpp b/src/adventure/adventurewidget.cpp
@@ -4,12 +4,12 @@
 
 #include "adventurewidget.h"
 
-#include <QtCore>
-#include <QtWidgets>
-
 #include "../configuration/configuration.h"
 #include "adventuresession.h"
 
+#include <QtCore>
+#include <QtWidgets>
+
 AdventureWidget::AdventureWidget(AdventureTracker &at, QWidget *const parent)
     : QWidget{parent}
     , m_adventureTracker{at}

diff --git a/src/adventure/adventurewidget.h b/src/adventure/adventurewidget.h
@@ -3,13 +3,13 @@
 // Copyright (C) 2023 The MMapper Authors
 // Author: Mike Repass <[email protected]> (Taryn)
 
+#include "adventuretracker.h"
+
 #include <QString>
 #include <QWidget>
 #include <QtCore>
 #include <QtWidgets>
 
-#include "adventuretracker.h"
-
 class AdventureWidget : public QWidget
 {
     Q_OBJECT

diff --git a/src/adventure/xpstatuswidget.h b/src/adventure/xpstatuswidget.h
@@ -3,12 +3,12 @@
 // Copyright (C) 2023 The MMapper Authors
 // Author: Mike Repass <[email protected]> (Taryn)
 
+#include "adventuretracker.h"
+
 #include <QLabel>
 #include <QPushButton>
 #include <QStatusBar>
 
-#include "adventuretracker.h"
-
 class XPStatusWidget : public QPushButton
 {
     Q_OBJECT

diff --git a/src/client/ClientTelnet.cpp b/src/client/ClientTelnet.cpp
@@ -5,19 +5,20 @@
 
 #include "ClientTelnet.h"
 
+#include "../configuration/configuration.h"
+#include "../global/io.h"
+#include "../global/utils.h"
+#include "../proxy/TextCodec.h"
+
 #include <limits>
+
 #include <QApplication>
 #include <QByteArray>
 #include <QHostAddress>
 #include <QMessageLogContext>
 #include <QObject>
 #include <QString>
 
-#include "../configuration/configuration.h"
-#include "../global/io.h"
-#include "../global/utils.h"
-#include "../proxy/TextCodec.h"
-
 ClientTelnet::ClientTelnet(QObject *const parent)
     : AbstractTelnet(TextCodecStrategyEnum::FORCE_LATIN_1, parent, "MMapper")
 {

diff --git a/src/client/ClientTelnet.h b/src/client/ClientTelnet.h
@@ -4,13 +4,13 @@
 // Copyright (C) 2019 The MMapper Authors
 // Author: Nils Schimmelmann <[email protected]> (Jahara)
 
+#include "../global/io.h"
+#include "../proxy/AbstractTelnet.h"
+
 #include <QAbstractSocket>
 #include <QObject>
 #include <QTcpSocket>
 
-#include "../global/io.h"
-#include "../proxy/AbstractTelnet.h"
-
 class ClientTelnet final : public AbstractTelnet
 {
     Q_OBJECT

diff --git a/src/client/ClientWidget.cpp b/src/client/ClientWidget.cpp
@@ -4,16 +4,16 @@
 
 #include "ClientWidget.h"
 
-#include <QString>
-#include <QTimer>
-#include <QtWidgets>
-
 #include "../configuration/configuration.h"
 #include "ClientTelnet.h"
 #include "displaywidget.h"
 #include "stackedinputwidget.h"
 #include "ui_ClientWidget.h"
 
+#include <QString>
+#include <QTimer>
+#include <QtWidgets>
+
 ClientWidget::ClientWidget(QWidget *const parent)
     : QWidget(parent)
     , ui(new Ui::ClientWidget)

diff --git a/src/client/ClientWidget.h b/src/client/ClientWidget.h
@@ -3,13 +3,13 @@
 // Copyright (C) 2019 The MMapper Authors
 // Author: Nils Schimmelmann <[email protected]> (Jahara)
 
+#include "../global/macros.h"
+
 #include <QPointer>
 #include <QString>
 #include <QWidget>
 #include <QtCore>
 
-#include "../global/macros.h"
-
 class QObject;
 class QEvent;
 class ClientTelnet;

diff --git a/src/client/displaywidget.cpp b/src/client/displaywidget.cpp
@@ -4,6 +4,9 @@
 
 #include "displaywidget.h"
 
+#include "../configuration/configuration.h"
+#include "../global/AnsiColor.h"
+
 #include <QMessageLogContext>
 #include <QRegularExpression>
 #include <QScrollBar>
@@ -12,9 +15,6 @@
 #include <QToolTip>
 #include <QtGui>
 
-#include "../configuration/configuration.h"
-#include "../global/AnsiColor.h"
-
 static const constexpr int SCROLLBAR_BUFFER = 1;
 static const constexpr int TAB_WIDTH_SPACES = 8;
 

diff --git a/src/client/displaywidget.h b/src/client/displaywidget.h
@@ -3,6 +3,8 @@
 // Copyright (C) 2019 The MMapper Authors
 // Author: Nils Schimmelmann <[email protected]> (Jahara)
 
+#include "../global/macros.h"
+
 #include <QColor>
 #include <QFont>
 #include <QSize>
@@ -13,8 +15,6 @@
 #include <QtCore>
 #include <QtGui>
 
-#include "../global/macros.h"
-
 class QObject;
 class QResizeEvent;
 class QTextDocument;

diff --git a/src/client/inputwidget.cpp b/src/client/inputwidget.cpp
@@ -4,6 +4,8 @@
 
 #include "inputwidget.h"
 
+#include "../configuration/configuration.h"
+
 #include <QLinkedList>
 #include <QMessageLogContext>
 #include <QRegularExpression>
@@ -12,8 +14,6 @@
 #include <QtGui>
 #include <QtWidgets>
 
-#include "../configuration/configuration.h"
-
 static constexpr const int MIN_WORD_LENGTH = 3;
 
 static const QRegularExpression s_whitespaceRx(R"(\W+)");

diff --git a/src/client/inputwidget.h b/src/client/inputwidget.h
@@ -3,8 +3,11 @@
 // Copyright (C) 2019 The MMapper Authors
 // Author: Nils Schimmelmann <[email protected]> (Jahara)
 
+#include "../global/macros.h"
+
 #include <iterator>
 #include <list>
+
 #include <QEvent>
 #include <QObject>
 #include <QPlainTextEdit>
@@ -13,8 +16,6 @@
 #include <QWidget>
 #include <QtCore>
 
-#include "../global/macros.h"
-
 class QKeyEvent;
 class QObject;
 class QWidget;

diff --git a/src/client/stackedinputwidget.cpp b/src/client/stackedinputwidget.cpp
@@ -4,11 +4,11 @@
 
 #include "stackedinputwidget.h"
 
+#include "inputwidget.h"
+
 #include <QLineEdit>
 #include <QString>
 
-#include "inputwidget.h"
-
 class QWidget;
 
 StackedInputWidget::StackedInputWidget(QWidget *const parent)

diff --git a/src/clock/mumeclock.cpp b/src/clock/mumeclock.cpp
@@ -4,17 +4,18 @@
 
 #include "mumeclock.h"
 
+#include "../global/Array.h"
+#include "../proxy/GmcpMessage.h"
+#include "mumemoment.h"
+
 #include <cassert>
+
 #include <QDebug>
 #include <QMetaEnum>
 #include <QObject>
 #include <QRegularExpression>
 #include <QString>
 
-#include "../global/Array.h"
-#include "../proxy/GmcpMessage.h"
-#include "mumemoment.h"
-
 static constexpr const int DEFAULT_MUME_START_EPOCH = 1517443173;
 static constexpr const int DEFAULT_TOLERANCE_LIMIT = 10;
 static constexpr const int ONE_RL_DAY_IN_SECONDS = 86400;

diff --git a/src/clock/mumeclock.h b/src/clock/mumeclock.h
@@ -3,17 +3,18 @@
 // Copyright (C) 2019 The MMapper Authors
 // Author: Nils Schimmelmann <[email protected]> (Jahara)
 
+#include "../global/macros.h"
+#include "../observer/gameobserver.h"
+#include "mumemoment.h"
+
 #include <cstdint>
+
 #include <QList>
 #include <QMetaEnum>
 #include <QObject>
 #include <QString>
 #include <QtCore>
 
-#include "../global/macros.h"
-#include "../observer/gameobserver.h"
-#include "mumemoment.h"
-
 class GmcpMessage;
 class QMetaEnum;
 

diff --git a/src/clock/mumeclockwidget.cpp b/src/clock/mumeclockwidget.cpp
@@ -4,17 +4,18 @@
 
 #include "mumeclockwidget.h"
 
+#include "../configuration/configuration.h"
+#include "mumeclock.h"
+#include "mumemoment.h"
+
 #include <cassert>
 #include <memory>
+
 #include <QDateTime>
 #include <QLabel>
 #include <QMouseEvent>
 #include <QString>
 
-#include "../configuration/configuration.h"
-#include "mumeclock.h"
-#include "mumemoment.h"
-
 MumeClockWidget::MumeClockWidget(MumeClock *const clock, QWidget *const parent)
     : QWidget(parent)
     , m_clock(clock)

diff --git a/src/clock/mumeclockwidget.h b/src/clock/mumeclockwidget.h
@@ -3,15 +3,16 @@
 // Copyright (C) 2019 The MMapper Authors
 // Author: Nils Schimmelmann <[email protected]> (Jahara)
 
+#include "mumeclock.h"
+#include "mumemoment.h"
+#include "ui_mumeclockwidget.h"
+
 #include <memory>
+
 #include <QString>
 #include <QWidget>
 #include <QtCore>
 
-#include "mumeclock.h"
-#include "mumemoment.h"
-#include "ui_mumeclockwidget.h"
-
 class QMouseEvent;
 class QObject;
 class QTimer;

diff --git a/src/clock/mumemoment.cpp b/src/clock/mumemoment.cpp
@@ -4,11 +4,11 @@
 
 #include "mumemoment.h"
 
-#include <iostream>
-
 #include "../global/Debug.h"
 #include "mumeclock.h"
 
+#include <iostream>
+
 static void maybe_warn_if_not_clamped(
     const char *const name, bool &warned, const int val, const int lo, const int hi)
 {