Add rgbMapSetColors script API to be called on color change.

Author: hjtappe

engine/src/rgbscript.cpp

@@ -117,6 +117,7 @@ bool RGBScript::load(const QDir& dir, const QString& fileName)
     m_script = QScriptValue();
     m_rgbMap = QScriptValue();
     m_rgbMapStepCount = QScriptValue();
+    m_rgbMapSetColors = QScriptValue();
     m_apiVersion = 0;
 
     m_fileName = fileName;
@@ -154,6 +155,7 @@ bool RGBScript::evaluate()
 
     m_rgbMap = QScriptValue();
     m_rgbMapStepCount = QScriptValue();
+    m_rgbMapSetColors = QScriptValue();
     m_apiVersion = 0;
 
     m_script = s_engine->evaluate(m_contents, m_fileName);
@@ -184,6 +186,15 @@ bool RGBScript::evaluate()
         m_apiVersion = m_script.property("apiVersion").toInteger();
         if (m_apiVersion > 0)
         {
+            if (m_apiVersion >= 3)
+            {
+                m_rgbMapSetColors = m_script.property("rgbMapSetColors");
+                if (m_rgbMapSetColors.isFunction() == false)
+                {
+                    qWarning() << m_fileName << "is missing the rgbMapSetColors() function!";
+                    return false;
+                }
+            }
             if (m_apiVersion >= 2)
                 return loadProperties();
             return true;
@@ -249,6 +260,28 @@ int RGBScript::rgbMapStepCount(const QSize& size)
     }
 }
 
+void RGBScript::rgbMapSetColors(QVector<uint> colors)
+{
+    QMutexLocker engineLocker(s_engineMutex);
+    if (m_apiVersion <= 2)
+        return;
+    if (m_rgbMapSetColors.isValid() == false)
+        return;
+
+    int accColors = acceptColors();
+    int rawColorCount = colors.count();
+    QScriptValue jsRawColors = s_engine->newArray(accColors);
+    for (int i = 0; i < rawColorCount && i < accColors; i++)
+        jsRawColors.setProperty(i, QScriptValue(colors.at(i)));
+
+    QScriptValueList args;
+    args << jsRawColors;
+
+    QScriptValue value = m_rgbMapSetColors.call(QScriptValue(), args);
+    if (value.isError())
+        displayError(value, m_fileName);
+}
+
 void RGBScript::rgbMap(const QSize& size, uint rgb, int step, RGBMap &map, QVector<uint> &rawColors)
 {
     QMutexLocker engineLocker(s_engineMutex);

engine/src/rgbscript.h

@@ -90,6 +90,9 @@ class RGBScript : public RGBAlgorithm
     /** @reimp */
     int rgbMapStepCount(const QSize& size);
 
+    /** @reimp */
+    void rgbMapSetColors(QVector<uint> colors);
+
     /** @reimp */
     void rgbMap(const QSize& size, uint rgb, int step, RGBMap &map, QVector<uint> &rawColors);
 
@@ -119,6 +122,7 @@ class RGBScript : public RGBAlgorithm
     QScriptValue m_script;          //! The script itself
     QScriptValue m_rgbMap;          //! rgbMap() function
     QScriptValue m_rgbMapStepCount; //! rgbMapStepCount() function
+    QScriptValue m_rgbMapSetColors; //! rgbMapSetColors() function
 
     /************************************************************************
      * Properties

engine/src/rgbscriptv4.cpp

@@ -109,6 +109,7 @@ bool RGBScript::load(const QDir& dir, const QString& fileName)
     m_script = QJSValue();
     m_rgbMap = QJSValue();
     m_rgbMapStepCount = QJSValue();
+    m_rgbMapSetColors = QJSValue();
     m_apiVersion = 0;
 
     m_fileName = fileName;
@@ -137,6 +138,7 @@ bool RGBScript::evaluate()
 
     m_rgbMap = QJSValue();
     m_rgbMapStepCount = QJSValue();
+    m_rgbMapSetColors = QJSValue();
     m_apiVersion = 0;
 
     if (m_fileName.isEmpty() || m_contents.isEmpty())
@@ -169,6 +171,15 @@ bool RGBScript::evaluate()
     m_apiVersion = m_script.property("apiVersion").toInt();
     if (m_apiVersion > 0)
     {
+        if (m_apiVersion >= 3)
+        {
+            m_rgbMapSetColors = m_script.property("rgbMapSetColors");
+            if (m_rgbMapSetColors.isCallable() == false)
+            {
+                qWarning() << m_fileName << "is missing the rgbMapSetColors() function!";
+                return false;
+            }
+        }
         if (m_apiVersion >= 2)
             return loadProperties();
         return true;
@@ -233,13 +244,38 @@ int RGBScript::rgbMapStepCount(const QSize& size)
     }
 }
 
+void RGBScript::rgbMapSetColors(QVector<uint> colors)
+{
+    QMutexLocker engineLocker(s_engineMutex);
+    if (m_apiVersion <= 2)
+        return;
+    if (m_rgbMap.isUndefined() == true)
+        return;
+    if (m_rgbMapSetColors.isCallable() == false)
+        return;
+
+    int accColors = acceptColors();
+    int rawColorCount = colors.count();
+    QJSValue jsRawColors = s_engine->newArray(accColors);
+    for (int i = 0; i < rawColorCount && i < accColors; i++)
+        jsRawColors.setProperty(i, QJSValue(colors.at(i)));
+
+    QJSValueList args;
+    args << jsRawColors;
+
+    QJSValue value = m_rgbMapSetColors.call(args);
+    if (value.isError())
+        displayError(value, m_fileName);
+}
+
 void RGBScript::rgbMap(const QSize& size, uint rgb, int step, RGBMap &map, QVector<uint> &rawColors)
 {
     QMutexLocker engineLocker(s_engineMutex);
 
     if (m_rgbMap.isUndefined() == true)
         return;
 
+    // Call the rgbMap function
     QJSValueList args;
     if (m_apiVersion <= 2) {
         args << size.width() << size.height() << rgb << step;
@@ -257,6 +293,7 @@ void RGBScript::rgbMap(const QSize& size, uint rgb, int step, RGBMap &map, QVect
     if (yarray.isError())
         displayError(yarray, m_fileName);
 
+    // Check the matrix to be a valid matrix
     if (yarray.isArray())
     {
         QVariantList yvArray = yarray.toVariant().toList();

engine/src/rgbscriptv4.h

@@ -91,6 +91,9 @@ class RGBScript : public RGBAlgorithm
     /** @reimp */
     int rgbMapStepCount(const QSize& size);
 
+    /** @reimp */
+    void rgbMapSetColors(QVector<uint> colors);
+
     /** @reimp */
     void rgbMap(const QSize& size, uint rgb, int step, RGBMap &map, QVector<uint> &rawColors);
 
@@ -120,6 +123,7 @@ class RGBScript : public RGBAlgorithm
     QJSValue m_script;          //! The script itself
     QJSValue m_rgbMap;          //! rgbMap() function
     QJSValue m_rgbMapStepCount; //! rgbMapStepCount() function
+    QJSValue m_rgbMapSetColors; //! rgbMapSetColors() function
 
     /************************************************************************
      * Properties