fix: replace defines with constexpr/const and use more absolute paths…

… for includes (#5527) bye bye nuuls
Chatterino · Aug 3, 2024 · aed55ac · aed55ac
1 parent 5ee5abf
commit aed55ac
Show file tree

Hide file tree

Showing 83 changed files with 376 additions and 370 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -58,6 +58,7 @@
 - Dev: The running Qt version is now shown in the about page if it differs from the compiled version. (#5501)
 - Dev: `FlagsEnum` is now `constexpr`. (#5510)
 - Dev: Documented and added tests to RTL handling. (#5473)
+- Dev: Refactored a few `#define`s into `const(expr)` and cleaned includes. (#5527)
 
 ## 2.5.1
 

diff --git a/src/common/ChannelChatters.cpp b/src/common/ChannelChatters.cpp
@@ -1,4 +1,4 @@
-#include "ChannelChatters.hpp"
+#include "common/ChannelChatters.hpp"
 
 #include "common/Channel.hpp"
 #include "messages/Message.hpp"

diff --git a/src/common/Common.hpp b/src/common/Common.hpp
@@ -5,39 +5,32 @@
 #include <QWidget>
 
 #include <memory>
-#include <optional>
-#include <string>
-
-#define LINK_CHATTERINO_WIKI "https://wiki.chatterino.com"
-#define LINK_CHATTERINO_DISCORD "https://discord.gg/7Y5AYhAK4z"
-#define LINK_CHATTERINO_SOURCE "https://github.com/Chatterino/chatterino2"
 
 namespace chatterino {
 
-const inline auto TWITCH_PLAYER_URL =
-    QStringLiteral("https://player.twitch.tv/?channel=%1&parent=twitch.tv");
+constexpr QStringView LINK_CHATTERINO_WIKI = u"https://wiki.chatterino.com";
+constexpr QStringView LINK_CHATTERINO_DISCORD =
+    u"https://discord.gg/7Y5AYhAK4z";
+constexpr QStringView LINK_CHATTERINO_SOURCE =
+    u"https://github.com/Chatterino/chatterino2";
+
+constexpr QStringView TWITCH_PLAYER_URL =
+    u"https://player.twitch.tv/?channel=%1&parent=twitch.tv";
 
 enum class HighlightState {
     None,
     Highlighted,
     NewMessage,
 };
 
-const Qt::KeyboardModifiers showSplitOverlayModifiers =
+constexpr Qt::KeyboardModifiers SHOW_SPLIT_OVERLAY_MODIFIERS =
     Qt::ControlModifier | Qt::AltModifier;
-const Qt::KeyboardModifiers showAddSplitRegions =
+constexpr Qt::KeyboardModifiers SHOW_ADD_SPLIT_REGIONS =
     Qt::ControlModifier | Qt::AltModifier;
-const Qt::KeyboardModifiers showResizeHandlesModifiers = Qt::ControlModifier;
-
-#ifndef ATTR_UNUSED
-#    ifdef Q_OS_WIN
-#        define ATTR_UNUSED
-#    else
-#        define ATTR_UNUSED __attribute__((unused))
-#    endif
-#endif
+constexpr Qt::KeyboardModifiers SHOW_RESIZE_HANDLES_MODIFIERS =
+    Qt::ControlModifier;
 
-static const char *ANONYMOUS_USERNAME_LABEL ATTR_UNUSED = " - anonymous - ";
+constexpr const char *ANONYMOUS_USERNAME_LABEL = " - anonymous - ";
 
 template <typename T>
 std::weak_ptr<T> weakOf(T *element)

diff --git a/src/common/Credentials.cpp b/src/common/Credentials.cpp
@@ -11,6 +11,7 @@
 #include <QJsonDocument>
 #include <QJsonObject>
 #include <QSaveFile>
+#include <QStringBuilder>
 
 #include <variant>
 
@@ -26,16 +27,16 @@
 #    endif
 #endif
 
-#define FORMAT_NAME                                                  \
-    ([&] {                                                           \
-        assert(!provider.contains(":"));                             \
-        return QString("chatterino:%1:%2").arg(provider).arg(name_); \
-    })()
-
 namespace {
 
 using namespace chatterino;
 
+QString formatName(const QString &provider, const QString &name)
+{
+    assert(!provider.contains(":"));
+    return u"chatterino:" % provider % u':' % name;
+}
+
 bool useKeyring()
 {
 #ifdef NO_QTKEYCHAIN
@@ -184,7 +185,7 @@ void Credentials::get(const QString &provider, const QString &name_,
 {
     assertInGuiThread();
 
-    auto name = FORMAT_NAME;
+    auto name = formatName(provider, name_);
 
     if (useKeyring())
     {
@@ -219,7 +220,7 @@ void Credentials::set(const QString &provider, const QString &name_,
     /// On linux, we try to use a keychain but show a message to disable it when it fails.
     /// XXX: add said message
 
-    auto name = FORMAT_NAME;
+    auto name = formatName(provider, name_);
 
     if (useKeyring())
     {
@@ -242,7 +243,7 @@ void Credentials::erase(const QString &provider, const QString &name_)
 {
     assertInGuiThread();
 
-    auto name = FORMAT_NAME;
+    auto name = formatName(provider, name_);
 
     if (useKeyring())
     {

diff --git a/src/common/Modes.cpp b/src/common/Modes.cpp
@@ -1,4 +1,4 @@
-#include "Modes.hpp"
+#include "common/Modes.hpp"
 
 #include "util/CombinePath.hpp"
 

diff --git a/src/common/Version.hpp b/src/common/Version.hpp
@@ -1,7 +1,8 @@
 #pragma once
 
 #include <QString>
-#include <QtGlobal>
+
+namespace chatterino {
 
 /**
  * Valid version formats, in order of latest to oldest
@@ -24,21 +25,7 @@
  *  - 2.4.0-alpha.2
  *  - 2.4.0-alpha
  **/
-#define CHATTERINO_VERSION "2.5.1"
-
-#if defined(Q_OS_WIN)
-#    define CHATTERINO_OS "win"
-#elif defined(Q_OS_MACOS)
-#    define CHATTERINO_OS "macos"
-#elif defined(Q_OS_LINUX)
-#    define CHATTERINO_OS "linux"
-#elif defined(Q_OS_FREEBSD)
-#    define CHATTERINO_OS "freebsd"
-#else
-#    define CHATTERINO_OS "unknown"
-#endif
-
-namespace chatterino {
+inline const QString CHATTERINO_VERSION = QStringLiteral("2.5.1");
 
 class Version
 {

diff --git a/src/controllers/accounts/Account.cpp b/src/controllers/accounts/Account.cpp
@@ -1,4 +1,4 @@
-#include "Account.hpp"
+#include "controllers/accounts/Account.hpp"
 
 #include <tuple>
 

diff --git a/src/controllers/accounts/AccountModel.cpp b/src/controllers/accounts/AccountModel.cpp
@@ -1,4 +1,4 @@
-#include "AccountModel.hpp"
+#include "controllers/accounts/AccountModel.hpp"
 
 #include "controllers/accounts/Account.hpp"
 #include "util/StandardItemHelper.hpp"

diff --git a/src/controllers/commands/Command.cpp b/src/controllers/commands/Command.cpp
@@ -1,4 +1,4 @@
-#include "Command.hpp"
+#include "controllers/commands/Command.hpp"
 
 namespace chatterino {
 

diff --git a/src/controllers/highlights/HighlightBadge.cpp b/src/controllers/highlights/HighlightBadge.cpp
@@ -1,4 +1,4 @@
-#include "HighlightBadge.hpp"
+#include "controllers/highlights/HighlightBadge.hpp"
 
 #include "messages/SharedMessageBuilder.hpp"
 #include "providers/twitch/TwitchBadge.hpp"

diff --git a/src/controllers/notifications/NotificationModel.cpp b/src/controllers/notifications/NotificationModel.cpp
@@ -1,4 +1,4 @@
-#include "NotificationModel.hpp"
+#include "controllers/notifications/NotificationModel.hpp"
 
 #include "Application.hpp"
 #include "singletons/Settings.hpp"

diff --git a/src/controllers/pings/MutedChannelModel.cpp b/src/controllers/pings/MutedChannelModel.cpp
@@ -1,4 +1,4 @@
-#include "MutedChannelModel.hpp"
+#include "controllers/pings/MutedChannelModel.hpp"
 
 #include "Application.hpp"
 #include "singletons/Settings.hpp"

diff --git a/src/debug/Benchmark.cpp b/src/debug/Benchmark.cpp
@@ -1,4 +1,4 @@
-#include "Benchmark.hpp"
+#include "debug/Benchmark.hpp"
 
 #include "common/QLogging.hpp"
 

diff --git a/src/messages/Emote.cpp b/src/messages/Emote.cpp
@@ -1,4 +1,4 @@
-#include "Emote.hpp"
+#include "messages/Emote.hpp"
 
 #include <unordered_map>
 

diff --git a/src/messages/MessageBuilder.cpp b/src/messages/MessageBuilder.cpp
@@ -1,4 +1,4 @@
-#include "MessageBuilder.hpp"
+#include "messages/MessageBuilder.hpp"
 
 #include "Application.hpp"
 #include "common/IrcColors.hpp"

diff --git a/src/messages/MessageColor.cpp b/src/messages/MessageColor.cpp
@@ -1,4 +1,4 @@
-#include "MessageColor.hpp"
+#include "messages/MessageColor.hpp"
 
 #include "singletons/Theme.hpp"
 

diff --git a/src/messages/layouts/MessageLayout.cpp b/src/messages/layouts/MessageLayout.cpp
@@ -19,12 +19,6 @@
 #include <QtGlobal>
 #include <QThread>
 
-#define MARGIN_LEFT (int)(8 * this->scale)
-#define MARGIN_RIGHT (int)(8 * this->scale)
-#define MARGIN_TOP (int)(4 * this->scale)
-#define MARGIN_BOTTOM (int)(4 * this->scale)
-#define COMPACT_EMOTES_OFFSET 6
-
 namespace chatterino {
 
 namespace {

diff --git a/src/messages/layouts/MessageLayoutContainer.cpp b/src/messages/layouts/MessageLayoutContainer.cpp
@@ -18,13 +18,17 @@
 
 #include <optional>
 
-#define COMPACT_EMOTES_OFFSET 4
-#define MAX_UNCOLLAPSED_LINES \
-    (getSettings()->collpseMessagesMinLines.getValue())
-
 namespace {
 
-constexpr const QMargins MARGIN{8, 4, 8, 4};
+using namespace chatterino;
+
+constexpr QMargins MARGIN{8, 4, 8, 4};
+constexpr int COMPACT_EMOTES_OFFSET = 4;
+
+int maxUncollapsedLines()
+{
+    return getSettings()->collpseMessagesMinLines.getValue();
+}
 
 }  // namespace
 
@@ -208,7 +212,7 @@ void MessageLayoutContainer::breakLine()
     this->lineStart_ = this->elements_.size();
     //    this->currentX = (int)(this->scale * 8);
 
-    if (this->canCollapse() && this->line_ + 1 >= MAX_UNCOLLAPSED_LINES)
+    if (this->canCollapse() && this->line_ + 1 >= maxUncollapsedLines())
     {
         this->canAddMessages_ = false;
         return;
@@ -568,8 +572,9 @@ int MessageLayoutContainer::remainingWidth() const
 {
     return (this->width_ - int(MARGIN.left() * this->scale_) -
             int(MARGIN.right() * this->scale_) -
-            (this->line_ + 1 == MAX_UNCOLLAPSED_LINES ? this->dotdotdotWidth_
-                                                      : 0)) -
+            (static_cast<int>(this->line_ + 1) == maxUncollapsedLines()
+                 ? this->dotdotdotWidth_
+                 : 0)) -
            this->currentX_;
 }
 

diff --git a/src/messages/search/RegexPredicate.cpp b/src/messages/search/RegexPredicate.cpp
@@ -1,4 +1,4 @@
-#include "RegexPredicate.hpp"
+#include "messages/search/RegexPredicate.hpp"
 
 #include "messages/Message.hpp"
 

diff --git a/src/messages/search/RegexPredicate.hpp b/src/messages/search/RegexPredicate.hpp
@@ -1,8 +1,8 @@
 #pragma once
 
 #include "messages/search/MessagePredicate.hpp"
-#include "QRegularExpression"
 
+#include <QRegularExpression>
 #include <QString>
 
 namespace chatterino {

diff --git a/src/providers/IvrApi.cpp b/src/providers/IvrApi.cpp
@@ -1,4 +1,4 @@
-#include "IvrApi.hpp"
+#include "providers/IvrApi.hpp"
 
 #include "common/network/NetworkResult.hpp"
 #include "common/QLogging.hpp"

diff --git a/src/providers/IvrApi.hpp b/src/providers/IvrApi.hpp
@@ -64,9 +64,7 @@ struct IvrEmote {
         : code(root.value("code").toString())
         , id(root.value("id").toString())
         , setId(root.value("setID").toString())
-        , url(QString(TWITCH_EMOTE_TEMPLATE)
-                  .replace("{id}", this->id)
-                  .replace("{scale}", "3.0"))
+        , url(TWITCH_EMOTE_TEMPLATE.arg(this->id, u"3.0"))
         , emoteType(root.value("type").toString())
         , imageType(root.value("assetType").toString())
     {

diff --git a/src/providers/irc/AbstractIrcServer.cpp b/src/providers/irc/AbstractIrcServer.cpp
@@ -1,4 +1,4 @@
-#include "AbstractIrcServer.hpp"
+#include "providers/irc/AbstractIrcServer.hpp"
 
 #include "common/Channel.hpp"
 #include "common/QLogging.hpp"

diff --git a/src/providers/irc/Irc2.cpp b/src/providers/irc/Irc2.cpp
@@ -1,4 +1,4 @@
-#include "Irc2.hpp"
+#include "providers/irc/Irc2.hpp"
 
 #include "Application.hpp"
 #include "common/Credentials.hpp"

diff --git a/src/providers/irc/IrcAccount.cpp b/src/providers/irc/IrcAccount.cpp
@@ -1,4 +1,4 @@
-#include "IrcAccount.hpp"
+#include "providers/irc/IrcAccount.hpp"
 
 // namespace chatterino {
 //

diff --git a/src/providers/irc/IrcChannel2.cpp b/src/providers/irc/IrcChannel2.cpp
@@ -1,4 +1,4 @@
-#include "IrcChannel2.hpp"
+#include "providers/irc/IrcChannel2.hpp"
 
 #include "common/Channel.hpp"
 #include "debug/AssertInGuiThread.hpp"

diff --git a/src/providers/irc/IrcCommands.cpp b/src/providers/irc/IrcCommands.cpp
@@ -1,4 +1,4 @@
-#include "IrcCommands.hpp"
+#include "providers/irc/IrcCommands.hpp"
 
 #include "messages/MessageBuilder.hpp"
 #include "providers/irc/IrcChannel2.hpp"

diff --git a/src/providers/irc/IrcConnection2.cpp b/src/providers/irc/IrcConnection2.cpp
@@ -1,4 +1,4 @@
-#include "IrcConnection2.hpp"
+#include "providers/irc/IrcConnection2.hpp"
 
 #include "common/QLogging.hpp"
 #include "common/Version.hpp"
@@ -11,7 +11,7 @@ namespace chatterino {
 
 namespace {
 
-    const auto payload = QString("chatterino/" CHATTERINO_VERSION);
+    const auto payload = "chatterino/" + CHATTERINO_VERSION;
 
 }  // namespace
 

diff --git a/src/providers/irc/IrcServer.cpp b/src/providers/irc/IrcServer.cpp
@@ -1,4 +1,4 @@
-#include "IrcServer.hpp"
+#include "providers/irc/IrcServer.hpp"
 
 #include "Application.hpp"
 #include "common/QLogging.hpp"