Merge pull request #5 from nkaaf/fix_mutability_of_lists

Fix immutability of lists

Author: nkaaf

Doxyfile

@@ -38,7 +38,7 @@ PROJECT_NAME           = "Arduino List Library"
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = 1.0.0
+PROJECT_NUMBER         = 1.0.1
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a

library.properties

@@ -1,5 +1,5 @@
 name=List
-version=1.0.0
+version=1.0.1
 author=Niklas Kaaf <[email protected]>
 maintainer=Niklas Kaaf <[email protected]>
 sentence=The Ultimate Collection of Lists

src/AbstractList.hpp

@@ -89,7 +89,9 @@ template <typename T> class AbstractList {
   virtual void remove(int index) = 0;
 
   /*!
-   * @brief Get a pointer to the entry at the given index.
+   * @brief Get a pointer to the entry at the given index. If the given index
+   * does not exists in the list or the list is immutable, null will be
+   * returned.
    * @note  If you only want to get the value, use getValue().
    *
    * @param index   Index of the element to get.
@@ -99,7 +101,10 @@ template <typename T> class AbstractList {
 
   /*!
    * @brief Get the plain value at the given index.
+   * @note  Be safe, that the given index exists and the list is mutable,
+   * otherwise the program will crash here!
    * @see   get()
+   * @todo  Rewrite this to let the program not crash!
    *
    * @param index   Index of element to get.
    * @return    Value.

src/SingleLinkedList.hpp

@@ -209,7 +209,7 @@ template <typename T> class SingleLinkedList : public AbstractList<T> {
   }
 
   T *get(int index) override {
-    if (this->isIndexOutOfBounds(index)) {
+    if (!this->isMutable() || this->isIndexOutOfBounds(index)) {
       return nullptr;
     }