Preparing first revision.

Author: dave

README.md

@@ -114,6 +114,18 @@ Where the size is the initial capacity of the list, and the grow by mode is one
 
     bsize_t capacity() // the current allocated size of the array
 
+## Platforms known to work
+
+| Platform | Board / Arch   | State            |
+|----------|----------------|------------------|
+| Arduino  | Nano 33 BLE    | Examples run     |
+| Arduino  | Uno, MEGA, AVR | Examples run     |
+| Arduino  | SAMD MKR1300   | Examples run     |
+| Arduino  | SAMD Seeed     | Examples run     |
+| Arduino  | ESP8266        | Awaiting         |
+| Arduino  | ESP32          | Awaiting         |
+| mbed     | STM32F4        | Ran mbed example |
+
 ## Making changes to SimpleCollections
 
 We welcome people rolling up their sleeves and helping out, but please do reach out to us before starting any work, so we can ensure its in sync with our development. We use platformIO for development and have a specific project available to help you get started, along with tests that check many elements still work as expected. See [https://github.com/davetcc/tcLibraryDev]

examples/mbedExample/mbedExample.cpp

@@ -0,0 +1,85 @@
+/**
+ * This list is not designed to replace the collections in the standard library, it is a fairly light collection
+ * that works across a very wide range of boards. It is the underpinnings of IoAbstraction, and we use it the mbed
+ * support too. So it is very much production ready.
+ *
+ * Here we create a class that we are going to store in the btree list, items in btree lists are ordered so
+ * insertion is a little slow, but retrieval, even by key is very quick - Log(NumItems). It dynamically reallocates
+ * if needed too, so there's no need in most cases to fiddle directly with the sizes.
+ *
+ * The only limitation of putting an item into the btree is that the method getKey() must be implemented by the type
+ * that is stored. You can see the default sizes of the list and other parameters in file SimpleCollections.h for
+ * advanced users.
+ *
+ * It is only designed to store small, simple class types that are not polymorphic, however, you can wrap a more dynamic
+ * class type if you needed too as a field of this class.
+ *
+ * Important note for advanced users: This list is not thread safe. If you use it within task manager only this is not
+ * an issue, but if you use it elsewhere too, it must be protected by some kind of mutex or atomic block.
+ */
+
+#include <mbed.h>
+#include <SimpleCollections.h>
+
+BufferedSerial console(USBTX, USBRX, 115200);
+
+class MbedStorage {
+private:
+    uint32_t hash;
+    char mbedData[20];
+public:
+    MbedStorage() = default;
+    MbedStorage(const MbedStorage& other) = default;
+    MbedStorage& operator=(const MbedStorage& other) = default;
+    MbedStorage(const char* sz) {
+        uint32_t h = 9348451;
+        for(size_t i=0; i<strlen(sz); i++) {
+            h *= sz[i];
+        }
+        hash = h;
+        strncpy(mbedData, sz, sizeof(mbedData));
+    }
+
+    uint32_t getKey() const { return hash; }
+
+    const char* getData() const { return mbedData; }
+};
+
+BtreeList<uint32_t, MbedStorage> myList;
+
+
+void log(const char* toLog) {
+    console.write(toLog, strlen(toLog));
+    console.write("\n", 1);
+}
+
+int main() {
+    auto frenchWelcome = MbedStorage("Bienvenue");
+    myList.add(MbedStorage("Hello world"));
+    myList.add(MbedStorage("Hello mbed"));
+    myList.add(MbedStorage("Aloha"));
+    myList.add(MbedStorage(frenchWelcome));
+
+    while(1) {
+        log("Iterate list using C++ range");
+        for (auto d: myList) {
+            log(d.getData());
+        }
+
+        log("Iterate list using forEach");
+        myList.forEachItem([](MbedStorage *storage) {
+            log(storage->getData());
+        });
+
+        log("Find an item by key");
+        auto toCheck = myList.getByKey(frenchWelcome.getKey());
+        if (toCheck && toCheck->getKey() == frenchWelcome.getKey()) {
+            log("Found item using key");
+        } else {
+            log("Find by key failed");
+        }
+
+        ThisThread::sleep_for(2000ms);
+    }
+    return 0;
+}

src/SimpleCollections.cpp

@@ -3,7 +3,11 @@
  * This product is licensed under an Apache license, see the LICENSE file in the top-level directory.
  */
 
+#ifdef __AVR__
+#include <Arduino.h>
+#else
 #include <malloc.h>
+#endif
 #include "SimpleCollections.h"
 
 using namespace ioaTreeInternal;

src/SimpleCollections.h

@@ -89,7 +89,7 @@ namespace ioaTreeInternal {
 template<class T> class BtreeIterator {
 private:
     bsize_t currentPosition;
-    ioaTreeInternal::BtreeStorage storage;
+    ioaTreeInternal::BtreeStorage& storage;
 public:
     BtreeIterator(bsize_t position, ioaTreeInternal::BtreeStorage& storage) : currentPosition(position), storage(storage){}
     void operator++() { ++currentPosition; }