change SKIN_WARNING to show the skin file:line first, then c++ context

mixxxdj · Nov 4, 2023 · 2f8b5c2 · 2f8b5c2
1 parent e3e0f6e
commit 2f8b5c2
Show file tree

Hide file tree

Showing 19 changed files with 179 additions and 102 deletions.
diff --git a/src/skin/legacy/legacyskinparser.cpp b/src/skin/legacy/legacyskinparser.cpp
diff --git a/src/skin/legacy/skincontext.cpp b/src/skin/legacy/skincontext.cpp
@@ -135,14 +135,19 @@ PixmapSource SkinContext::getPixmapSourceInner(const QString& filename) const {
     return PixmapSource();
 }
 
-QDebug SkinContext::logWarning(const char* file, const int line,
-                               const QDomNode& node) const {
-    return qWarning() << QString("%1:%2 SKIN ERROR at %3:%4 <%5>:")
-                             .arg(file, QString::number(line), m_xmlPath,
-                                  QString::number(node.lineNumber()),
-                                  node.nodeName())
-                             .toUtf8()
-                             .constData();
+QDebug SkinContext::logWarning(const char* file,
+        const int line,
+        const QDomNode& node,
+        const QString& message) const {
+    return qWarning() << QString("SKIN ERROR at %1:%2 <%3>: %4 | %5:%6")
+                                 .arg(m_xmlPath,
+                                         QString::number(node.lineNumber()),
+                                         node.nodeName(),
+                                         message,
+                                         file,
+                                         QString::number(line))
+                                 .toUtf8()
+                                 .constData();
 }
 
 int SkinContext::scaleToWidgetSize(QString& size) const {

diff --git a/src/skin/legacy/skincontext.h b/src/skin/legacy/skincontext.h
@@ -15,7 +15,8 @@
 #include "widget/wpixmapstore.h"
 #include "widget/wsingletoncontainer.h"
 
-#define SKIN_WARNING(node, context) (context).logWarning(__FILE__, __LINE__, (node))
+#define SKIN_WARNING(node, context, message) \
+    (context).logWarning(__FILE__, __LINE__, (node), (message))
 
 // A class for managing the current context/environment when processing a
 // skin. Used hierarchically by LegacySkinParser to create new contexts and
@@ -225,7 +226,10 @@ class SkinContext {
         return defaultDrawMode;
     }
 
-    QDebug logWarning(const char* file, const int line, const QDomNode& node) const;
+    QDebug logWarning(const char* file,
+            const int line,
+            const QDomNode& node,
+            const QString& message) const;
 
     void defineSingleton(const QString& objectName, QWidget* widget) {
         m_pSharedState->singletons.insertSingleton(objectName, widget);

diff --git a/src/widget/wcombobox.cpp b/src/widget/wcombobox.cpp
@@ -25,8 +25,10 @@ void WComboBox::setup(const QDomNode& node, const SkinContext& context) {
                 QString icon = context.selectString(state, "Icon");
                 addItem(QIcon(icon), text, QVariant(iState));
             } else {
-                SKIN_WARNING(state, context)
-                        << "WComboBox ignoring <State> without <Number> node.";
+                SKIN_WARNING(state,
+                        context,
+                        QStringLiteral("WComboBox ignoring <State> without "
+                                       "<Number> node."));
             }
         }
         state = state.nextSibling();

diff --git a/src/widget/weffectbuttonparametername.cpp b/src/widget/weffectbuttonparametername.cpp
@@ -22,8 +22,10 @@ void WEffectButtonParameterName::setup(const QDomNode& node, const SkinContext&
             EffectWidgetUtils::getButtonParameterSlotFromNode(
                     node, context, m_pEffectSlot);
     VERIFY_OR_DEBUG_ASSERT(m_pParameterSlot) {
-        SKIN_WARNING(node, context)
-                << "EffectButtonParameter node could not attach to effect parameter";
+        SKIN_WARNING(node,
+                context,
+                QStringLiteral("EffectButtonParameter node could not attach to "
+                               "effect parameter"));
     }
     setEffectParameterSlot(m_pParameterSlot);
 }
diff --git a/src/widget/weffectchain.cpp b/src/widget/weffectchain.cpp
@@ -19,8 +19,10 @@ void WEffectChain::setup(const QDomNode& node, const SkinContext& context) {
     if (pChainSlot) {
         setEffectChain(pChainSlot);
     } else {
-        SKIN_WARNING(node, context)
-                << "EffectChain node could not attach to effect chain slot.";
+        SKIN_WARNING(node,
+                context,
+                QStringLiteral("EffectChain node could not attach to effect "
+                               "chain slot."));
     }
 }
 

diff --git a/src/widget/weffectchainpresetbutton.cpp b/src/widget/weffectchainpresetbutton.cpp
@@ -26,8 +26,10 @@ void WEffectChainPresetButton::setup(const QDomNode& node, const SkinContext& co
     m_pChain = EffectWidgetUtils::getEffectChainFromNode(
             node, context, m_pEffectsManager);
     VERIFY_OR_DEBUG_ASSERT(m_pChain) {
-        SKIN_WARNING(node, context)
-                << "EffectChainPresetButton node could not attach to effect chain";
+        SKIN_WARNING(node,
+                context,
+                QStringLiteral("EffectChainPresetButton node could not attach "
+                               "to effect chain"));
         return;
     }
     connect(m_pChain.get(),

diff --git a/src/widget/weffectchainpresetselector.cpp b/src/widget/weffectchainpresetselector.cpp
@@ -31,8 +31,10 @@ void WEffectChainPresetSelector::setup(const QDomNode& node, const SkinContext&
             node, context, m_pEffectsManager);
 
     VERIFY_OR_DEBUG_ASSERT(m_pChain != nullptr) {
-        SKIN_WARNING(node, context)
-                << "EffectChainPresetSelector node could not attach to EffectChain";
+        SKIN_WARNING(node,
+                context,
+                QStringLiteral("EffectChainPresetSelector node could not "
+                               "attach to EffectChain"));
         return;
     }
 

diff --git a/src/widget/weffectknobparametername.cpp b/src/widget/weffectknobparametername.cpp
@@ -22,8 +22,10 @@ void WEffectKnobParameterName::setup(const QDomNode& node, const SkinContext& co
             EffectWidgetUtils::getParameterSlotFromNode(
                     node, context, m_pEffectSlot);
     VERIFY_OR_DEBUG_ASSERT(m_pParameterSlot) {
-        SKIN_WARNING(node, context)
-                << "EffectParameter node could not attach to effect parameter";
+        SKIN_WARNING(node,
+                context,
+                QStringLiteral("EffectParameter node could not attach to "
+                               "effect parameter"));
     }
     setEffectParameterSlot(m_pParameterSlot);
 }
diff --git a/src/widget/weffectname.cpp b/src/widget/weffectname.cpp
@@ -22,8 +22,10 @@ void WEffectName::setup(const QDomNode& node, const SkinContext& context) {
     if (pEffectSlot) {
         setEffectSlot(pEffectSlot);
     } else {
-        SKIN_WARNING(node, context)
-                << "EffectName node could not attach to effect slot.";
+        SKIN_WARNING(node,
+                context,
+                QStringLiteral(
+                        "EffectName node could not attach to effect slot."));
     }
 }
 

diff --git a/src/widget/weffectparameterknob.cpp b/src/widget/weffectparameterknob.cpp
@@ -12,7 +12,7 @@ void WEffectParameterKnob::setup(const QDomNode& node, const SkinContext& contex
     m_pEffectParameterSlot = EffectWidgetUtils::getParameterSlotFromNode(
             node, context, pEffectSlot);
     VERIFY_OR_DEBUG_ASSERT(m_pEffectParameterSlot) {
-        SKIN_WARNING(node, context) << "Could not find effect parameter slot";
+        SKIN_WARNING(node, context, QStringLiteral("Could not find effect parameter slot"));
         return;
     }
     connect(m_pEffectParameterSlot.data(),

diff --git a/src/widget/weffectparameterknobcomposed.cpp b/src/widget/weffectparameterknobcomposed.cpp
@@ -12,7 +12,7 @@ void WEffectParameterKnobComposed::setup(const QDomNode& node, const SkinContext
     m_pEffectParameterSlot = EffectWidgetUtils::getParameterSlotFromNode(
             node, context, pEffectSlot);
     VERIFY_OR_DEBUG_ASSERT(m_pEffectParameterSlot) {
-        SKIN_WARNING(node, context) << "Could not find effect parameter slot";
+        SKIN_WARNING(node, context, QStringLiteral("Could not find effect parameter slot"));
         return;
     }
     connect(m_pEffectParameterSlot.data(),

diff --git a/src/widget/weffectpushbutton.cpp b/src/widget/weffectpushbutton.cpp
@@ -23,7 +23,7 @@ void WEffectPushButton::setup(const QDomNode& node, const SkinContext& context)
     m_pEffectParameterSlot = EffectWidgetUtils::getButtonParameterSlotFromNode(
             node, context, pEffectSlot);
     if (!m_pEffectParameterSlot) {
-        SKIN_WARNING(node, context) << "Could not find effect parameter slot";
+        SKIN_WARNING(node, context, QStringLiteral("Could not find effect parameter slot"));
         DEBUG_ASSERT(false);
     }
     connect(m_pEffectParameterSlot.data(),

diff --git a/src/widget/weffectselector.cpp b/src/widget/weffectselector.cpp
@@ -42,8 +42,10 @@ void WEffectSelector::setup(const QDomNode& node, const SkinContext& context) {
                 this,
                 &WEffectSelector::slotEffectSelected);
     } else {
-        SKIN_WARNING(node, context)
-                << "EffectSelector node could not attach to effect slot.";
+        SKIN_WARNING(node,
+                context,
+                QStringLiteral("EffectSelector node could not attach to effect "
+                               "slot."));
     }
 
     populate();

diff --git a/src/widget/whotcuebutton.cpp b/src/widget/whotcuebutton.cpp
@@ -33,7 +33,10 @@ void WHotcueButton::setup(const QDomNode& node, const SkinContext& context) {
     if (ok && hotcue > 0) {
         m_hotcue = hotcue - 1;
     } else {
-        SKIN_WARNING(node, context) << "Hotcue value invalid";
+        SKIN_WARNING(node,
+                context,
+                QStringLiteral("Hotcue index %1 invalid")
+                        .arg(context.selectString(node, QStringLiteral("Hotcue"))));
     }
 
     bool okay;
@@ -84,7 +87,7 @@ void WHotcueButton::setup(const QDomNode& node, const SkinContext& context) {
 
     QDomNode con = context.selectNode(node, QStringLiteral("Connection"));
     if (!con.isNull()) {
-        SKIN_WARNING(node, context) << "Additional Connections are not allowed";
+        SKIN_WARNING(node, context, QStringLiteral("Additional Connections are not allowed"));
     }
 }
 

diff --git a/src/widget/wpushbutton.cpp b/src/widget/wpushbutton.cpp
@@ -195,9 +195,13 @@ void WPushButton::setup(const QDomNode& node, const SkinContext& context) {
                 if (m_rightButtonMode != ControlPushButton::PUSH &&
                         m_rightButtonMode != ControlPushButton::TOGGLE &&
                         m_rightButtonMode != ControlPushButton::TRIGGER) {
-                    SKIN_WARNING(node, context)
-                            << "WPushButton::setup: Connecting a Pushbutton not in PUSH, TRIGGER or TOGGLE mode is not implemented\n"
-                            << "Please consider to set <RightClickIsPushButton>true</RightClickIsPushButton>";
+                    SKIN_WARNING(node,
+                            context,
+                            "WPushButton::setup: Connecting a Pushbutton not "
+                            "in PUSH, TRIGGER or TOGGLE mode is not "
+                            "implemented\n Please consider to set "
+                            "<RightClickIsPushButton>true</"
+                            "RightClickIsPushButton>");
                 }
             }
         }

diff --git a/src/widget/wsingletoncontainer.cpp b/src/widget/wsingletoncontainer.cpp
@@ -20,19 +20,19 @@ void WSingletonContainer::setup(const QDomNode& node, const SkinContext& context
     QDomElement containerNode = node.toElement();
     QString objectName;
     if (!context.hasNodeSelectString(node, "ObjectName", &objectName)) {
-        SKIN_WARNING(node, context)
-                << "Need objectName attribute for Singleton tag";
+        SKIN_WARNING(node, context, QStringLiteral("Need objectName attribute for Singleton tag"));
         return;
     }
     if (objectName.isEmpty()) {
-        SKIN_WARNING(node, context)
-                << "Singleton tag's ObjectName is empty";
+        SKIN_WARNING(node, context, QStringLiteral("Singleton tag's ObjectName is empty"));
         return;
     }
     m_pWidget = context.getSingletonWidget(objectName);
     if (m_pWidget == nullptr) {
-        SKIN_WARNING(node, context)
-                << "Asked for an unknown singleton widget:" << objectName;
+        SKIN_WARNING(node,
+                context,
+                QStringLiteral("Asked for an unknown singleton widget: %1")
+                        .arg(objectName));
     }
 }
 

diff --git a/src/widget/wsplitter.cpp b/src/widget/wsplitter.cpp
@@ -65,7 +65,7 @@ void WSplitter::setup(const QDomNode& node, const SkinContext& context) {
             }
         }
         if (sizesList.length() != this->count()) {
-            SKIN_WARNING(node, context) << msg;
+            SKIN_WARNING(node, context, msg);
             ok = false;
         }
         if (ok) {
@@ -90,7 +90,7 @@ void WSplitter::setup(const QDomNode& node, const SkinContext& context) {
                             + collapsibleJoined
                             + ") does not match the number of children nodes:"
                             + QString::number(this->count());
-            SKIN_WARNING(node, context) << msg;
+            SKIN_WARNING(node, context, msg);
             ok = false;
         }
         if (ok) {

diff --git a/src/widget/wvumeterbase.cpp b/src/widget/wvumeterbase.cpp
@@ -80,8 +80,10 @@ void WVuMeterBase::setup(const QDomNode& node, const SkinContext& context) {
     if (height() < 2 || width() < 2) {
         // This triggers a QT bug and displays a white widget instead.
         // We warn here, because the skin designer may not use the affected mode.
-        SKIN_WARNING(node, context)
-                << "VuMeterBase needs to have 2 pixel in all extents to be visible on all targets.";
+        SKIN_WARNING(node,
+                context,
+                QStringLiteral("VuMeterBase needs to have 2 pixel in all "
+                               "extents to be visible on all targets."));
     }
 
     setFocusPolicy(Qt::NoFocus);