Merge pull request #16 from pauldotknopf/feature/delete-qplayer

Auto delete qpPattern when deactivated.

Author: brimshot

qpLayer.cpp

@@ -16,8 +16,20 @@ void qpLayer::draw(CRGB *targetLeds, int numLeds) {
   if(this->continualFadeAmount) //conceivably we prevent a loop applying 0 to each led with this check
     fadeToBlackBy(this->leds, this->numLeds, this->continualFadeAmount);
 
-  while(qpPattern *currentPattern = this->patterns.fetch())
-        patternsRendered |= currentPattern->render();
+  while(qpPattern *currentPattern = this->patterns.fetch()) {
+    bool isActive = currentPattern->render();
+    patternsRendered |= isActive;
+
+    // If this pattern isn't active and it's configured to auto delete when finished,
+    // then destroy and remove from the patterns linked list.
+    if(!isActive && currentPattern->shouldRemoveWhenDecativated()) {
+      // If this is considered the lastReferencedPattern, updated it.
+        if(currentPattern == this->lastReferencedPattern) {
+          this->lastReferencedPattern = nullptr;
+        }
+        this->patterns.remove(currentPattern);
+    }
+  }
 
   if(patternsRendered || this->bPersistWhenPatternsInactive)
     (this->*applyLeds)(targetLeds, this->leds, numLeds);

qpLinkedList.h

@@ -23,6 +23,16 @@ class qpLinkedList {
 
 public:
 
+    ~qpLinkedList() {
+      qpListNode <T> *cur = firstElement;
+      while(cur) {
+        qpListNode <T> *next = cur->next;
+        delete cur->item;
+        delete cur;
+        cur = next;
+      }
+    }
+
     byte numElements = 0;
 
     T *getItem(int index) {
@@ -74,6 +84,44 @@ class qpLinkedList {
 
     }
 
+    // Removes an item from the linked list.
+    bool remove(T *itemToRemove) {
+      qpListNode <T> *current = this->firstElement;
+      qpListNode <T> *previous = nullptr;
+
+      while(current) {
+
+        if(current->item == itemToRemove) {
+          // If this node is currently marked as the "current node", update it.
+          if(this->currentElement == current) {
+            this->currentElement = current->next;
+          }
+
+          // update the previous node to point to the new item
+          if(previous) {
+            previous->next = current->next;
+          }
+
+          // Update the first/last items
+          if(current == this->firstElement) {
+            this->firstElement = previous;
+          }
+          if(current == this->lastElement) {
+            this->lastElement = current->next;
+          }
+
+          delete current->item;
+          delete current;
+          return true;
+        }
+
+        previous = current;
+        current = current->next;
+      }
+
+      return false;
+    }
+
 };
 
 #endif

qpPattern.cpp

@@ -95,6 +95,10 @@ void qpPattern::deactivateIfActivePeriodComplete() {
 
 }
 
+bool qpPattern::shouldRemoveWhenDecativated() {
+  return this->removeOnDeactivation;
+}
+
 //direct external control
 void qpPattern::deactivate() {
 
@@ -125,6 +129,12 @@ CRGBPalette16 qpPattern::_getPalette(byte index) {
 
 // ~ Periodic activation config
 
+qpPattern &qpPattern::removeWhenDeactivated(bool value) {
+  this->removeOnDeactivation = value;
+  
+  return *this;
+}
+
 qpPattern &qpPattern::activatePeriodicallyEveryNTicks(int minTicks, int maxTicks) {
 
   this->isActive = false;

qpPattern.h

@@ -41,6 +41,7 @@ class qpPattern {
 
     // ~ Periodic activation
 
+    bool removeOnDeactivation = false;
     unsigned int minTicksBetweenActivations = 0;
     unsigned int maxTicksBetweenActivations = 0;
     unsigned int ticksUntilActive = 0;
@@ -112,7 +113,7 @@ class qpPattern {
 
 
     // ~ Periodic activation
-
+    qpPattern &removeWhenDeactivated(bool value);
     qpPattern &activatePeriodicallyEveryNTicks(int minTicks, int maxTicks = 0);
 
     qpPattern &stayActiveForNTicks(int minTicks, int maxTicks = 0);
@@ -148,7 +149,7 @@ class qpPattern {
 
     bool activate();
     void deactivate();
-
+    bool shouldRemoveWhenDecativated();
 };
 
 #endif

quickPatterns.cpp

@@ -9,6 +9,9 @@ quickPatterns::quickPatterns(CRGB *leds, int numLeds) {
   random16_add_entropy(analogRead(0));
 }
 
+quickPatterns::~quickPatterns() {
+  delete this->lightStrand;
+}
 
 // Render
 

quickPatterns.h

@@ -48,7 +48,8 @@ class quickPatterns {
   public:
 
     quickPatterns(CRGB *leds, int numLeds);
-
+    ~quickPatterns();
+    
     // ~ Rendering
 
     bool draw();