Merge branch 'next' of ssh://git.openpilot.org/OpenPilot into next

ground/openpilotgcs/src/plugins/uavobjectbrowser/treeitem.cpp

@@ -27,6 +27,77 @@
 
 #include "treeitem.h"
 
+/* Constructor */
+HighLightManager::HighLightManager(long checkingInterval)
+{
+    // Start the timer and connect it to the callback
+    m_expirationTimer.start(checkingInterval);
+    connect(&m_expirationTimer, SIGNAL(timeout()), this, SLOT(checkItemsExpired()));
+}
+
+/*
+ * Called to add item to list. Item is only added if absent.
+ * Returns true if item was added, otherwise false.
+ */
+bool HighLightManager::add(TreeItem *itemToAdd)
+{
+    // Lock to ensure thread safety
+    QMutexLocker locker(&m_listMutex);
+
+    // Check so that the item isn't already in the list
+    if(!m_itemsList.contains(itemToAdd))
+    {
+        m_itemsList.append(itemToAdd);
+        return true;
+    }
+    return false;
+}
+
+/*
+ * Called to remove item from list.
+ * Returns true if item was removed, otherwise false.
+ */
+bool HighLightManager::remove(TreeItem *itemToRemove)
+{
+    // Lock to ensure thread safety
+    QMutexLocker locker(&m_listMutex);
+
+    // Remove item and return result
+    return m_itemsList.removeOne(itemToRemove);
+}
+
+/*
+ * Callback called periodically by the timer.
+ * This method checks for expired highlights and
+ * removes them if they are expired.
+ * Expired highlights are restored.
+ */
+void HighLightManager::checkItemsExpired()
+{
+    // Lock to ensure thread safety
+    QMutexLocker locker(&m_listMutex);
+
+    // Get a mutable iterator for the list
+    QMutableLinkedListIterator<TreeItem*> iter(m_itemsList);
+
+    // This is the timestamp to compare with
+    QTime now = QTime::currentTime();
+
+    // Loop over all items, check if they expired.
+    while(iter.hasNext())
+    {
+        TreeItem* item = iter.next();
+        if(item->getHiglightExpires() < now)
+        {
+            // If expired, call removeHighlight
+            item->removeHighlight();
+
+            // Remove from list since it is restored.
+            iter.remove();
+        }
+    }
+}
+
 int TreeItem::m_highlightTimeMs = 500;
 
 TreeItem::TreeItem(const QList<QVariant> &data, TreeItem *parent) :
@@ -36,7 +107,6 @@ TreeItem::TreeItem(const QList<QVariant> &data, TreeItem *parent) :
         m_highlight(false),
         m_changed(false)
 {
-    connect(&m_timer, SIGNAL(timeout()), this, SLOT(removeHighlight()));
 }
 
 TreeItem::TreeItem(const QVariant &data, TreeItem *parent) :
@@ -46,7 +116,6 @@ TreeItem::TreeItem(const QVariant &data, TreeItem *parent) :
         m_changed(false)
 {
     m_data << data << "" << "";
-    connect(&m_timer, SIGNAL(timeout()), this, SLOT(removeHighlight()));
 }
 
 TreeItem::~TreeItem()
@@ -108,21 +177,50 @@ void TreeItem::apply() {
         child->apply();
 }
 
+/*
+ * Called after a value has changed to trigger highlightning of tree item.
+ */
 void TreeItem::setHighlight(bool highlight) {
     m_highlight = highlight;
     m_changed = false;
     if (highlight) {
-        if (m_timer.isActive()) {
-            m_timer.stop();
+        // Update the expires timestamp
+        m_highlightExpires = QTime::currentTime().addMSecs(m_highlightTimeMs);
+
+        // Add to highlightmanager
+        if(m_highlightManager->add(this))
+        {
+            // Only emit signal if it was added
+            emit updateHighlight(this);
         }
-        m_timer.setSingleShot(true);
-        m_timer.start(m_highlightTimeMs);
     }
-    emit updateHighlight(this);
+    else if(m_highlightManager->remove(this))
+    {
+        // Only emit signal if it was removed
+        emit updateHighlight(this);
+    }
+
+    // If we have a parent, call recursively to update highlight status of parents.
+    // This will ensure that the root of a leaf that is changed also is highlighted.
+    // Only updates that really changes values will trigger highlight of parents.
+    if(m_parent)
+    {
+        m_parent->setHighlight(highlight);
+    }
 }
 
 void TreeItem::removeHighlight() {
     m_highlight = false;
-    update();
+    //update();
     emit updateHighlight(this);
 }
+
+void TreeItem::setHighlightManager(HighLightManager *mgr)
+{
+    m_highlightManager = mgr;
+}
+
+QTime TreeItem::getHiglightExpires()
+{
+    return m_highlightExpires;
+}

ground/openpilotgcs/src/plugins/uavobjectbrowser/treeitem.h

@@ -32,10 +32,58 @@
 #include "uavmetaobject.h"
 #include "uavobjectfield.h"
 #include <QtCore/QList>
+#include <QtCore/QLinkedList>
 #include <QtCore/QVariant>
+#include <QTCore/QTime>
 #include <QtCore/QTimer>
 #include <QtCore/QObject>
+#include <QtCore/QDebug>
 
+class TreeItem;
+
+/*
+* Small utility class that handles the higlighting of
+* tree grid items.
+* Basicly it maintains all items due to be restored to
+* non highlighted state in a linked list.
+* A timer traverses this list periodically to find out
+* if any of the items should be restored. All items are
+* updated withan expiration timestamp when they expires.
+* An item that is beeing restored is removed from the
+* list and its removeHighlight() method is called. Items
+* that are not expired are left in the list til next time.
+* Items that are updated during the expiration time are
+* left untouched in the list. This reduces unwanted emits
+* of signals to the repaint/update function.
+*/
+class HighLightManager : public QObject
+{
+Q_OBJECT
+public:
+    // Constructor taking the checking interval in ms.
+    HighLightManager(long checkingInterval);
+
+    // This is called when an item has been set to
+    // highlighted = true.
+    bool add(TreeItem* itemToAdd);
+
+    //This is called when an item is set to highlighted = false;
+    bool remove(TreeItem* itemToRemove);
+
+private slots:
+    // Timer callback method.
+    void checkItemsExpired();
+
+private:
+    // The timer checking highlight expiration.
+    QTimer m_expirationTimer;
+
+    // The list holding all items due to be updated.
+    QLinkedList<TreeItem*> m_itemsList;
+
+    //Mutex to lock when accessing list.
+    QMutex m_listMutex;
+};
 
 class TreeItem : public QObject
 {
@@ -77,11 +125,16 @@ public:
     inline bool changed() { return m_changed; }
     inline void setChanged(bool changed) { m_changed = changed; }
 
+    virtual void setHighlightManager(HighLightManager* mgr);
+
+    QTime getHiglightExpires();
+
+    virtual void removeHighlight();
+
 signals:
     void updateHighlight(TreeItem*);
 
 private slots:
-    void removeHighlight();
 
 private:
     QList<TreeItem*> m_children;
@@ -91,7 +144,8 @@ private:
     TreeItem *m_parent;
     bool m_highlight;
     bool m_changed;
-    QTimer m_timer;
+    QTime m_highlightExpires;
+    HighLightManager* m_highlightManager;
 public:
     static const int dataColumn = 1;
 private:

ground/openpilotgcs/src/plugins/uavobjectbrowser/uavobjecttreemodel.cpp

@@ -47,6 +47,8 @@ UAVObjectTreeModel::UAVObjectTreeModel(QObject *parent) :
     ExtensionSystem::PluginManager *pm = ExtensionSystem::PluginManager::instance();
     UAVObjectManager *objManager = pm->getObject<UAVObjectManager>();
 
+    // Create highlight manager, let it run every 300 ms.
+    m_highlightManager = new HighLightManager(300);
     connect(objManager, SIGNAL(newObject(UAVObject*)), this, SLOT(newObject(UAVObject*)));
     connect(objManager, SIGNAL(newInstance(UAVObject*)), this, SLOT(newObject(UAVObject*)));
 
@@ -56,6 +58,7 @@ UAVObjectTreeModel::UAVObjectTreeModel(QObject *parent) :
 
 UAVObjectTreeModel::~UAVObjectTreeModel()
 {
+    delete m_highlightManager;
     delete m_rootItem;
 }
 
@@ -67,9 +70,12 @@ void UAVObjectTreeModel::setupModelData(UAVObjectManager *objManager)
     m_rootItem = new TreeItem(rootData);
 
     m_settingsTree = new TopTreeItem(tr("Settings"), m_rootItem);
+    m_settingsTree->setHighlightManager(m_highlightManager);
     m_rootItem->appendChild(m_settingsTree);
     m_nonSettingsTree = new TopTreeItem(tr("Data Objects"), m_rootItem);
+    m_nonSettingsTree->setHighlightManager(m_highlightManager);
     m_rootItem->appendChild(m_nonSettingsTree);
+    m_rootItem->setHighlightManager(m_highlightManager);
     connect(m_settingsTree, SIGNAL(updateHighlight(TreeItem*)), this, SLOT(updateHighlight(TreeItem*)));
     connect(m_nonSettingsTree, SIGNAL(updateHighlight(TreeItem*)), this, SLOT(updateHighlight(TreeItem*)));
 
@@ -96,6 +102,7 @@ void UAVObjectTreeModel::addDataObject(UAVDataObject *obj)
         addInstance(obj, root->child(index));
     } else {
         DataObjectTreeItem *data = new DataObjectTreeItem(obj->getName() + " (" + QString::number(obj->getNumBytes()) + " bytes)");
+        data->setHighlightManager(m_highlightManager);
         connect(data, SIGNAL(updateHighlight(TreeItem*)), this, SLOT(updateHighlight(TreeItem*)));
         int index = root->nameIndex(obj->getName());
         root->insert(index, data);
@@ -110,6 +117,7 @@ void UAVObjectTreeModel::addMetaObject(UAVMetaObject *obj, TreeItem *parent)
 {
     connect(obj, SIGNAL(objectUpdated(UAVObject*)), this, SLOT(highlightUpdatedObject(UAVObject*)));
     MetaObjectTreeItem *meta = new MetaObjectTreeItem(obj, tr("Meta Data"));
+    meta->setHighlightManager(m_highlightManager);
     connect(meta, SIGNAL(updateHighlight(TreeItem*)), this, SLOT(updateHighlight(TreeItem*)));
     foreach (UAVObjectField *field, obj->getFields()) {
         if (field->getNumElements() > 1) {
@@ -132,6 +140,7 @@ void UAVObjectTreeModel::addInstance(UAVObject *obj, TreeItem *parent)
     } else {
         QString name = tr("Instance") +  " " + QString::number(obj->getInstID());
         item = new InstanceTreeItem(obj, name);
+        item->setHighlightManager(m_highlightManager);
         connect(item, SIGNAL(updateHighlight(TreeItem*)), this, SLOT(updateHighlight(TreeItem*)));
         parent->appendChild(item);
     }
@@ -148,6 +157,7 @@ void UAVObjectTreeModel::addInstance(UAVObject *obj, TreeItem *parent)
 void UAVObjectTreeModel::addArrayField(UAVObjectField *field, TreeItem *parent)
 {
     TreeItem *item = new ArrayFieldTreeItem(field->getName());
+    item->setHighlightManager(m_highlightManager);
     connect(item, SIGNAL(updateHighlight(TreeItem*)), this, SLOT(updateHighlight(TreeItem*)));
     for (uint i = 0; i < field->getNumElements(); ++i) {
         addSingleField(i, field, item);
@@ -192,6 +202,7 @@ void UAVObjectTreeModel::addSingleField(int index, UAVObjectField *field, TreeIt
     default:
         Q_ASSERT(false);
     }
+    item->setHighlightManager(m_highlightManager);
     connect(item, SIGNAL(updateHighlight(TreeItem*)), this, SLOT(updateHighlight(TreeItem*)));
     parent->appendChild(item);
 }
@@ -352,7 +363,6 @@ void UAVObjectTreeModel::highlightUpdatedObject(UAVObject *obj)
     Q_ASSERT(obj);
     ObjectTreeItem *item = findObjectTreeItem(obj);
     Q_ASSERT(item);
-    item->setHighlight(true);
     item->update();
     QModelIndex itemIndex = index(item);
     Q_ASSERT(itemIndex != QModelIndex());

ground/openpilotgcs/src/plugins/uavobjectbrowser/uavobjecttreemodel.h

@@ -97,6 +97,9 @@ private:
     int m_recentlyUpdatedTimeout;
     QColor m_recentlyUpdatedColor;
     QColor m_manuallyChangedColor;
+
+    // Highlight manager to handle highlighting of tree items.
+    HighLightManager *m_highlightManager;
 };
 
 #endif // UAVOBJECTTREEMODEL_H