mirror of
https://github.com/espressif/openthread.git
synced 2026-07-08 13:20:25 +00:00
[common] adding Array class (#6853)
This commit adds a generic `Array<Type, kMaxSize>` class which represents a fixed size array of elements of template `Type` which tracks its current length. Entries can be appended to the array (`PushBack()`) and removed from the end of array (`PopBack()`). This simple data model is used in some other modules, so having a generic version can help simplify the code. This commit also adds a unit test to verify `Array` methods.
This commit is contained in:
Abtin Keshavarzian
committed by
Jonathan Hui
Jonathan Hui
parent
6236d0838a
commit
44bf2f1818
@@ -0,0 +1,255 @@
|
||||
/*
|
||||
* Copyright (c) 2021, The OpenThread Authors.
|
||||
* All rights reserved.
|
||||
*
|
||||
* Redistribution and use in source and binary forms, with or without
|
||||
* modification, are permitted provided that the following conditions are met:
|
||||
* 1. Redistributions of source code must retain the above copyright
|
||||
* notice, this list of conditions and the following disclaimer.
|
||||
* 2. Redistributions in binary form must reproduce the above copyright
|
||||
* notice, this list of conditions and the following disclaimer in the
|
||||
* documentation and/or other materials provided with the distribution.
|
||||
* 3. Neither the name of the copyright holder nor the
|
||||
* names of its contributors may be used to endorse or promote products
|
||||
* derived from this software without specific prior written permission.
|
||||
*
|
||||
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
||||
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
||||
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
|
||||
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
||||
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
||||
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
||||
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
||||
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
||||
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
||||
* POSSIBILITY OF SUCH DAMAGE.
|
||||
*/
|
||||
|
||||
#include <stdarg.h>
|
||||
#include <string.h>
|
||||
|
||||
#include "test_platform.h"
|
||||
|
||||
#include <openthread/config.h>
|
||||
|
||||
#include "common/array.hpp"
|
||||
#include "common/debug.hpp"
|
||||
#include "common/instance.hpp"
|
||||
|
||||
#include "test_util.h"
|
||||
|
||||
namespace ot {
|
||||
|
||||
void TestArray(void)
|
||||
{
|
||||
constexpr uint16_t kMaxSize = 10;
|
||||
constexpr uint16_t kStartValue = 100;
|
||||
|
||||
Array<uint16_t, kMaxSize> array;
|
||||
uint16_t index;
|
||||
uint16_t seed;
|
||||
|
||||
// All methods after constructor
|
||||
VerifyOrQuit(array.IsEmpty());
|
||||
VerifyOrQuit(!array.IsFull());
|
||||
VerifyOrQuit(array.GetLength() == 0);
|
||||
VerifyOrQuit(array.GetMaxSize() == kMaxSize);
|
||||
VerifyOrQuit(array.At(0) == nullptr);
|
||||
VerifyOrQuit(array.Front() == nullptr);
|
||||
VerifyOrQuit(array.Back() == nullptr);
|
||||
VerifyOrQuit(array.PopBack() == nullptr);
|
||||
|
||||
seed = kStartValue;
|
||||
|
||||
for (uint16_t len = 1; len <= kMaxSize; len++)
|
||||
{
|
||||
for (uint8_t iter = 0; iter < 2; iter++)
|
||||
{
|
||||
// On `iter == 0` use `PushBack(aEntry)` and on `iter == 1`
|
||||
// `PushBack()` version which returns a pointer to the newly
|
||||
// added entry.
|
||||
|
||||
if (iter == 0)
|
||||
{
|
||||
SuccessOrQuit(array.PushBack(seed + len));
|
||||
}
|
||||
else
|
||||
{
|
||||
uint16_t *entry = array.PushBack();
|
||||
|
||||
VerifyOrQuit(entry != nullptr);
|
||||
*entry = seed + len;
|
||||
}
|
||||
|
||||
VerifyOrQuit(!array.IsEmpty());
|
||||
VerifyOrQuit(array.IsFull() == (len == kMaxSize));
|
||||
VerifyOrQuit(array.GetLength() == len);
|
||||
|
||||
VerifyOrQuit(array.Front() != nullptr);
|
||||
VerifyOrQuit(*array.Front() == seed + 1);
|
||||
VerifyOrQuit(array.Back() != nullptr);
|
||||
VerifyOrQuit(*array.Back() == seed + len);
|
||||
|
||||
for (index = 0; index < len; index++)
|
||||
{
|
||||
VerifyOrQuit(array[index] == seed + index + 1);
|
||||
VerifyOrQuit(array.At(index) != nullptr);
|
||||
VerifyOrQuit(*array.At(index) == seed + index + 1);
|
||||
|
||||
VerifyOrQuit(array.Contains(seed + index + 1));
|
||||
VerifyOrQuit(array.Find(seed + index + 1) == &array[index]);
|
||||
|
||||
VerifyOrQuit(!array.Contains(seed));
|
||||
VerifyOrQuit(array.Find(seed) == nullptr);
|
||||
}
|
||||
|
||||
index = 0;
|
||||
|
||||
for (uint16_t value : array)
|
||||
{
|
||||
VerifyOrQuit(value == array[index]);
|
||||
index++;
|
||||
}
|
||||
|
||||
index = 0;
|
||||
|
||||
for (uint16_t &entry : array)
|
||||
{
|
||||
// Uddate the value stored at the entry
|
||||
entry++;
|
||||
|
||||
VerifyOrQuit(entry == array[index]);
|
||||
VerifyOrQuit(array.IndexOf(entry) == index);
|
||||
|
||||
index++;
|
||||
}
|
||||
|
||||
seed++;
|
||||
|
||||
// On `iter == 0` we verify `PopBack()` and remove the
|
||||
// last entry. It will be added again from next `iter`
|
||||
// loop (on `iter == 1`).
|
||||
|
||||
if (iter == 0)
|
||||
{
|
||||
uint16_t *entry = array.PopBack();
|
||||
|
||||
VerifyOrQuit(entry != nullptr);
|
||||
VerifyOrQuit(*entry == seed + len);
|
||||
VerifyOrQuit(array.GetLength() == len - 1);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
VerifyOrQuit(array.IsFull());
|
||||
VerifyOrQuit(array.PushBack(0) == kErrorNoBufs);
|
||||
VerifyOrQuit(array.PushBack() == nullptr);
|
||||
|
||||
for (uint16_t len = kMaxSize; len >= 1; len--)
|
||||
{
|
||||
uint16_t *entry;
|
||||
|
||||
VerifyOrQuit(array.GetLength() == len);
|
||||
VerifyOrQuit(array.Back() == &array[len - 1]);
|
||||
|
||||
entry = array.PopBack();
|
||||
VerifyOrQuit(entry != nullptr);
|
||||
VerifyOrQuit(*entry == seed + len);
|
||||
|
||||
VerifyOrQuit(array.GetLength() == len - 1);
|
||||
VerifyOrQuit(!array.IsFull());
|
||||
}
|
||||
|
||||
VerifyOrQuit(array.IsEmpty());
|
||||
|
||||
SuccessOrQuit(array.PushBack(seed));
|
||||
VerifyOrQuit(!array.IsEmpty());
|
||||
|
||||
array.Clear();
|
||||
VerifyOrQuit(array.IsEmpty());
|
||||
}
|
||||
|
||||
void TestArrayCopy(void)
|
||||
{
|
||||
constexpr uint16_t kMaxSize = 10;
|
||||
|
||||
struct Entry
|
||||
{
|
||||
Entry(void) = default;
|
||||
|
||||
Entry(const char *aName, uint16_t aYear)
|
||||
: mName(aName)
|
||||
, mYear(aYear)
|
||||
{
|
||||
}
|
||||
|
||||
bool operator==(const Entry &aOther) { return (mName == aOther.mName) && (mYear == aOther.mYear); }
|
||||
|
||||
const char *mName;
|
||||
uint16_t mYear;
|
||||
};
|
||||
|
||||
Entry ps1("PS", 1994);
|
||||
Entry ps2("PS2", 2000);
|
||||
Entry ps3("PS3", 2006);
|
||||
Entry ps4("PS4", 2013);
|
||||
Entry ps5("PS5", 2020);
|
||||
|
||||
Array<Entry, kMaxSize> array1;
|
||||
Array<Entry, kMaxSize> array2;
|
||||
Array<Entry, kMaxSize> array3(array1);
|
||||
|
||||
VerifyOrQuit(array1.IsEmpty());
|
||||
VerifyOrQuit(array2.IsEmpty());
|
||||
VerifyOrQuit(array3.IsEmpty());
|
||||
|
||||
SuccessOrQuit(array1.PushBack(ps1));
|
||||
SuccessOrQuit(array1.PushBack(ps2));
|
||||
SuccessOrQuit(array1.PushBack(ps3));
|
||||
SuccessOrQuit(array1.PushBack(ps4));
|
||||
VerifyOrQuit(array1.GetLength() == 4);
|
||||
|
||||
SuccessOrQuit(array2.PushBack(ps3));
|
||||
SuccessOrQuit(array2.PushBack(ps5));
|
||||
VerifyOrQuit(array2.GetLength() == 2);
|
||||
|
||||
array3 = array2 = array1;
|
||||
|
||||
VerifyOrQuit(array1.GetLength() == 4);
|
||||
VerifyOrQuit(array2.GetLength() == 4);
|
||||
VerifyOrQuit(array3.GetLength() == 4);
|
||||
|
||||
for (uint8_t index = 0; index < array1.GetLength(); index++)
|
||||
{
|
||||
VerifyOrQuit(array1[index] == array2[index]);
|
||||
VerifyOrQuit(array1[index] == array3[index]);
|
||||
}
|
||||
|
||||
array3.Clear();
|
||||
|
||||
array1 = array3;
|
||||
VerifyOrQuit(array1.IsEmpty());
|
||||
VerifyOrQuit(array1.GetLength() == 0);
|
||||
|
||||
{
|
||||
Array<Entry, kMaxSize> array4(array2);
|
||||
|
||||
VerifyOrQuit(array4.GetLength() == 4);
|
||||
|
||||
for (uint8_t index = 0; index < array1.GetLength(); index++)
|
||||
{
|
||||
VerifyOrQuit(array2[index] == array4[index]);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
} // namespace ot
|
||||
|
||||
int main(void)
|
||||
{
|
||||
ot::TestArray();
|
||||
ot::TestArrayCopy();
|
||||
printf("All tests passed\n");
|
||||
return 0;
|
||||
}
|
||||
Reference in New Issue
Block a user