Version 1.0.0
Initial version.
This commit is contained in:
commit
899c3feed8
1
.gitignore
vendored
Normal file
1
.gitignore
vendored
Normal file
@ -0,0 +1 @@
|
|||||||
|
.DS_Store
|
||||||
1
CMakeLists.txt
Normal file
1
CMakeLists.txt
Normal file
@ -0,0 +1 @@
|
|||||||
|
idf_component_register(SRCS "zh_vector.c" INCLUDE_DIRS "include")
|
||||||
73
LICENSE
Normal file
73
LICENSE
Normal file
@ -0,0 +1,73 @@
|
|||||||
|
Apache License
|
||||||
|
Version 2.0, January 2004
|
||||||
|
http://www.apache.org/licenses/
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||||
|
|
||||||
|
1. Definitions.
|
||||||
|
|
||||||
|
"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
|
||||||
|
|
||||||
|
"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
|
||||||
|
|
||||||
|
"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
|
||||||
|
|
||||||
|
"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
|
||||||
|
|
||||||
|
"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
|
||||||
|
|
||||||
|
"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
|
||||||
|
|
||||||
|
"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
|
||||||
|
|
||||||
|
"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
|
||||||
|
|
||||||
|
"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."
|
||||||
|
|
||||||
|
"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
|
||||||
|
|
||||||
|
2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
|
||||||
|
|
||||||
|
3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
|
||||||
|
|
||||||
|
4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
|
||||||
|
|
||||||
|
(a) You must give any other recipients of the Work or Derivative Works a copy of this License; and
|
||||||
|
|
||||||
|
(b) You must cause any modified files to carry prominent notices stating that You changed the files; and
|
||||||
|
|
||||||
|
(c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
|
||||||
|
|
||||||
|
(d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.
|
||||||
|
|
||||||
|
You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.
|
||||||
|
|
||||||
|
5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
|
||||||
|
|
||||||
|
6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
|
||||||
|
|
||||||
|
7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
|
||||||
|
|
||||||
|
8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
|
||||||
|
|
||||||
|
9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
APPENDIX: How to apply the Apache License to your work.
|
||||||
|
|
||||||
|
To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives.
|
||||||
|
|
||||||
|
Copyright [yyyy] [name of copyright owner]
|
||||||
|
|
||||||
|
Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
you may not use this file except in compliance with the License.
|
||||||
|
You may obtain a copy of the License at
|
||||||
|
|
||||||
|
http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
|
||||||
|
Unless required by applicable law or agreed to in writing, software
|
||||||
|
distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
See the License for the specific language governing permissions and
|
||||||
|
limitations under the License.
|
||||||
84
README.md
Normal file
84
README.md
Normal file
@ -0,0 +1,84 @@
|
|||||||
|
# ESP32 ESP-IDF and ESP8266 RTOS SDK component for vector (dynamic array)
|
||||||
|
|
||||||
|
## Tested on
|
||||||
|
|
||||||
|
1. ESP8266 RTOS_SDK v3.4
|
||||||
|
2. ESP32 ESP-IDF v5.2
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
1. Support for any data types.
|
||||||
|
2. The maximum size of the veсtor is 65536 elements.
|
||||||
|
3. Support external SPI RAM for ESP32 with external, SPI-connected RAM only.
|
||||||
|
|
||||||
|
## Attention
|
||||||
|
|
||||||
|
1. Do not enable SPI RAM support unless you are sure that SPI RAM is present in your ESP32 module and it is properly configured via menuconfig.
|
||||||
|
2. If SPI RAM is present via menuconfig select Component Config -> ESP PSRAM -> Support for external, SPI-connected RAM and select SPI RAM config -> SPI RAM access method -> Make RAM allocatable using heap_caps_malloc(…, MALLOC_CAP_SPIRAM).
|
||||||
|
|
||||||
|
## [Function description](http://zh-vector.zh.com.ru)
|
||||||
|
|
||||||
|
## Using
|
||||||
|
|
||||||
|
In an existing project, run the following command to install the component:
|
||||||
|
|
||||||
|
```text
|
||||||
|
cd ../your_project/components
|
||||||
|
git clone https://github.com/aZholtikov/zh_vector.git
|
||||||
|
```
|
||||||
|
|
||||||
|
In the application, add the component:
|
||||||
|
|
||||||
|
```c
|
||||||
|
#include "zh_vector.h"
|
||||||
|
```
|
||||||
|
|
||||||
|
## Example
|
||||||
|
|
||||||
|
Create, add, read, modify and delete items:
|
||||||
|
|
||||||
|
```c
|
||||||
|
#include "zh_vector.h"
|
||||||
|
|
||||||
|
zh_vector_t vector = {0};
|
||||||
|
|
||||||
|
char example[10] = {0};
|
||||||
|
|
||||||
|
void app_main(void)
|
||||||
|
{
|
||||||
|
esp_log_level_set("zh_vector", ESP_LOG_NONE);
|
||||||
|
zh_vector_init(&vector, sizeof(example), false);
|
||||||
|
printf("Initial vector size is: %d\n", zh_vector_get_size(&vector));
|
||||||
|
strcpy(example, "Item 1");
|
||||||
|
zh_vector_push_back(&vector, &example);
|
||||||
|
strcpy(example, "Item 2");
|
||||||
|
zh_vector_push_back(&vector, &example);
|
||||||
|
strcpy(example, "Item 3");
|
||||||
|
zh_vector_push_back(&vector, &example);
|
||||||
|
strcpy(example, "Item 4");
|
||||||
|
zh_vector_push_back(&vector, &example);
|
||||||
|
strcpy(example, "Item 5");
|
||||||
|
zh_vector_push_back(&vector, &example);
|
||||||
|
printf("Add 5 items. New vector size is: %d\n", zh_vector_get_size(&vector));
|
||||||
|
for (uint16_t i = 0; i < zh_vector_get_size(&vector); ++i)
|
||||||
|
{
|
||||||
|
printf("Item position %d is: %s\n", i, (char *)zh_vector_get_item(&vector, i));
|
||||||
|
}
|
||||||
|
strcpy(example, "Item 6");
|
||||||
|
zh_vector_change_item(&vector, 3, &example);
|
||||||
|
printf("Change item on 3 position.\n");
|
||||||
|
for (uint16_t i = 0; i < zh_vector_get_size(&vector); ++i)
|
||||||
|
{
|
||||||
|
printf("Item position %d is: %s\n", i, (char *)zh_vector_get_item(&vector, i));
|
||||||
|
}
|
||||||
|
zh_vector_delete_item(&vector, 2);
|
||||||
|
printf("Delete item on 2 position. New vector size is: %d\n", zh_vector_get_size(&vector));
|
||||||
|
for (uint16_t i = 0; i < zh_vector_get_size(&vector); ++i)
|
||||||
|
{
|
||||||
|
printf("Item position %d is: %s\n", i, (char *)zh_vector_get_item(&vector, i));
|
||||||
|
}
|
||||||
|
zh_vector_free(&vector);
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Any [feedback](mailto:github@azholtikov.ru) will be gladly accepted.
|
||||||
0
component.mk
Normal file
0
component.mk
Normal file
132
include/zh_vector.h
Normal file
132
include/zh_vector.h
Normal file
@ -0,0 +1,132 @@
|
|||||||
|
/**
|
||||||
|
* @file
|
||||||
|
* Header file for the zh_vector component.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
|
#pragma once
|
||||||
|
|
||||||
|
#include "stdlib.h"
|
||||||
|
#include "string.h"
|
||||||
|
#include "esp_err.h"
|
||||||
|
#include "esp_log.h"
|
||||||
|
#include "esp_heap_caps.h"
|
||||||
|
|
||||||
|
#ifdef __cplusplus
|
||||||
|
extern "C"
|
||||||
|
{
|
||||||
|
#endif
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief Main structure of vector data.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
typedef struct
|
||||||
|
{
|
||||||
|
void **items; ///< Array of pointers of vector items. @note
|
||||||
|
uint16_t capacity; ///< Maximum capacity of the vector. @note Used to control the size of allocated memory for array of pointers of vector items. Usually equal to the current number of items in the vector. Automatically changes when items are added or deleted.
|
||||||
|
uint16_t size; ///< Number of items in the vector. @note Can be read with zh_vector_get_size().
|
||||||
|
uint16_t unit; ///< Vector item size. @note Possible values from 1 to 65536.
|
||||||
|
bool status; ///< Vector initialization status flag. @note Used to prevent execution of vector functions without prior vector initialization.
|
||||||
|
bool spi_ram; ///< SPI RAM using status flag. @note True - vector will be placed in SPI RAM, false - vector will be placed in RAM.
|
||||||
|
} zh_vector_t;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief Initialize vector.
|
||||||
|
*
|
||||||
|
* @param[in] vector Pointer to main structure of vector data.
|
||||||
|
* @param[in] unit Size of vector item.
|
||||||
|
* @param[in] spiram SPI RAM using (true - vector will be placed in SPI RAM, false - vector will be placed in RAM).
|
||||||
|
*
|
||||||
|
* @attention For using SPI RAM select “Make RAM allocatable using heap_caps_malloc(…, MALLOC_CAP_SPIRAM)” from CONFIG_SPIRAM_USE. For ESP32 with external, SPI-connected RAM only.
|
||||||
|
*
|
||||||
|
* @note If SPI RAM is not supported or not initialised via menuconfig vector will be placed in RAM regardless of the set spiram value.
|
||||||
|
*
|
||||||
|
* @return
|
||||||
|
* - ESP_OK if initialization was success
|
||||||
|
* - ESP_ERR_INVALID_ARG if parameter error
|
||||||
|
* - ESP_ERR_INVALID_STATE if vector already initialized with other item size
|
||||||
|
*/
|
||||||
|
esp_err_t zh_vector_init(zh_vector_t *vector, uint16_t unit, bool spiram);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief Deinitialize vector. Free all allocated memory.
|
||||||
|
*
|
||||||
|
* @param[in] vector Pointer to main structure of vector data.
|
||||||
|
*
|
||||||
|
* @return
|
||||||
|
* - ESP_OK if deinitialization was success
|
||||||
|
* - ESP_ERR_INVALID_ARG if parameter error
|
||||||
|
* - ESP_ERR_INVALID_STATE if vector not initialized
|
||||||
|
*/
|
||||||
|
esp_err_t zh_vector_free(zh_vector_t *vector);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief Get current vector size.
|
||||||
|
*
|
||||||
|
* @param[in] vector Pointer to main structure of vector data.
|
||||||
|
*
|
||||||
|
* @return
|
||||||
|
* - Vector size
|
||||||
|
* - ESP_FAIL if parameter error or vector not initialized
|
||||||
|
*/
|
||||||
|
esp_err_t zh_vector_get_size(zh_vector_t *vector);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief Add item at end of vector.
|
||||||
|
*
|
||||||
|
* @param[in] vector Pointer to main structure of vector data.
|
||||||
|
* @param[in] item Pointer to item for add.
|
||||||
|
*
|
||||||
|
* @return
|
||||||
|
* - ESP_OK if add was success
|
||||||
|
* - ESP_ERR_INVALID_ARG if parameter error
|
||||||
|
* - ESP_ERR_NO_MEM if memory allocation fail or no free memory in the heap
|
||||||
|
* - ESP_ERR_INVALID_STATE if vector not initialized
|
||||||
|
*/
|
||||||
|
esp_err_t zh_vector_push_back(zh_vector_t *vector, void *item);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief Change item by index.
|
||||||
|
*
|
||||||
|
* @param[in] vector Pointer to main structure of vector data.
|
||||||
|
* @param[in] index Index of item for change.
|
||||||
|
* @param[in] item Pointer to new data of item.
|
||||||
|
*
|
||||||
|
* @return
|
||||||
|
* - ESP_OK if change was success
|
||||||
|
* - ESP_ERR_INVALID_ARG if parameter error
|
||||||
|
* - ESP_ERR_INVALID_STATE if vector not initialized
|
||||||
|
* - ESP_FAIL if index does not exist
|
||||||
|
*/
|
||||||
|
esp_err_t zh_vector_change_item(zh_vector_t *vector, uint16_t index, void *item);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief Get item by index.
|
||||||
|
*
|
||||||
|
* @param[in] vector Pointer to main structure of vector data.
|
||||||
|
* @param[in] index Index of item for get.
|
||||||
|
*
|
||||||
|
* @return
|
||||||
|
* - Pointer to item
|
||||||
|
* - NULL if parameter error or vector not initialized or if index does not exist
|
||||||
|
*/
|
||||||
|
void *zh_vector_get_item(zh_vector_t *vector, uint16_t index);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief Delete item by index and shifts all elements in vector.
|
||||||
|
*
|
||||||
|
* @param[in] vector Pointer to main structure of vector data.
|
||||||
|
* @param[in] index Index of item for delete.
|
||||||
|
*
|
||||||
|
* @return
|
||||||
|
* - ESP_OK if delete was success
|
||||||
|
* - ESP_ERR_INVALID_ARG if parameter error
|
||||||
|
* - ESP_ERR_INVALID_STATE if vector not initialized
|
||||||
|
* - ESP_FAIL if index does not exist
|
||||||
|
*/
|
||||||
|
esp_err_t zh_vector_delete_item(zh_vector_t *vector, uint16_t index);
|
||||||
|
|
||||||
|
#ifdef __cplusplus
|
||||||
|
}
|
||||||
|
#endif
|
||||||
1
version.txt
Normal file
1
version.txt
Normal file
@ -0,0 +1 @@
|
|||||||
|
1.0.0
|
||||||
246
zh_vector.c
Normal file
246
zh_vector.c
Normal file
@ -0,0 +1,246 @@
|
|||||||
|
/**
|
||||||
|
* @file
|
||||||
|
* The main code of the zh_vector component.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
|
#include "zh_vector.h"
|
||||||
|
|
||||||
|
static const char *TAG = "zh_vector";
|
||||||
|
|
||||||
|
static esp_err_t _resize(zh_vector_t *vector, uint16_t capacity);
|
||||||
|
|
||||||
|
esp_err_t zh_vector_init(zh_vector_t *vector, uint16_t unit, bool spiram)
|
||||||
|
{
|
||||||
|
ESP_LOGI(TAG, "Vector initialization begin.");
|
||||||
|
if (vector == NULL || unit == 0)
|
||||||
|
{
|
||||||
|
ESP_LOGE(TAG, "Vector initialization fail. Invalid argument.");
|
||||||
|
return ESP_ERR_INVALID_ARG;
|
||||||
|
}
|
||||||
|
if (vector->status == true)
|
||||||
|
{
|
||||||
|
if (vector->unit == unit)
|
||||||
|
{
|
||||||
|
goto ZH_VECTOR_INIT_EXIT;
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
ESP_LOGE(TAG, "Vector initialization fail. Vector already initialized with other item size.");
|
||||||
|
return ESP_ERR_INVALID_STATE;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
vector->capacity = 0;
|
||||||
|
vector->size = 0;
|
||||||
|
vector->unit = unit;
|
||||||
|
vector->status = true;
|
||||||
|
vector->spi_ram = spiram;
|
||||||
|
if (vector->spi_ram == true)
|
||||||
|
{
|
||||||
|
#ifdef CONFIG_IDF_TARGET_ESP8266
|
||||||
|
ESP_LOGW(TAG, "SPI RAM not supported. Will be used IRAM.");
|
||||||
|
vector->spi_ram = false;
|
||||||
|
#else
|
||||||
|
#ifndef CONFIG_SPIRAM
|
||||||
|
ESP_LOGW(TAG, "SPI RAM not initialized. Will be used IRAM.");
|
||||||
|
vector->spi_ram = false;
|
||||||
|
#endif
|
||||||
|
#endif
|
||||||
|
}
|
||||||
|
ZH_VECTOR_INIT_EXIT:
|
||||||
|
if (vector->spi_ram == true)
|
||||||
|
{
|
||||||
|
ESP_LOGI(TAG, "Vector initialization success. Vector located in SPI RAM.");
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
ESP_LOGI(TAG, "Vector initialization success. Vector located in IRAM.");
|
||||||
|
}
|
||||||
|
return ESP_OK;
|
||||||
|
}
|
||||||
|
|
||||||
|
esp_err_t zh_vector_free(zh_vector_t *vector)
|
||||||
|
{
|
||||||
|
ESP_LOGI(TAG, "Vector deletion begin.");
|
||||||
|
if (vector == NULL)
|
||||||
|
{
|
||||||
|
ESP_LOGE(TAG, "Vector deletion fail. Invalid argument.");
|
||||||
|
return ESP_ERR_INVALID_ARG;
|
||||||
|
}
|
||||||
|
if (vector->status == false)
|
||||||
|
{
|
||||||
|
ESP_LOGE(TAG, "Vector deletion fail. Vector not initialized.");
|
||||||
|
return ESP_ERR_INVALID_STATE;
|
||||||
|
}
|
||||||
|
for (uint16_t i = 0; i < vector->size; ++i)
|
||||||
|
{
|
||||||
|
heap_caps_free(vector->items[i]);
|
||||||
|
}
|
||||||
|
vector->status = false;
|
||||||
|
ESP_LOGI(TAG, "Vector deletion success.");
|
||||||
|
return ESP_OK;
|
||||||
|
}
|
||||||
|
|
||||||
|
esp_err_t zh_vector_get_size(zh_vector_t *vector)
|
||||||
|
{
|
||||||
|
ESP_LOGI(TAG, "Getting vector size begin.");
|
||||||
|
if (vector == NULL || vector->status == false)
|
||||||
|
{
|
||||||
|
ESP_LOGE(TAG, "Getting vector size fail. Invalid argument or vector not initialized.");
|
||||||
|
return ESP_FAIL;
|
||||||
|
}
|
||||||
|
ESP_LOGI(TAG, "Getting vector size success. Size: %d", vector->size);
|
||||||
|
return vector->size;
|
||||||
|
}
|
||||||
|
|
||||||
|
esp_err_t zh_vector_push_back(zh_vector_t *vector, void *item)
|
||||||
|
{
|
||||||
|
ESP_LOGI(TAG, "Adding item to vector begin.");
|
||||||
|
if (vector == NULL || item == NULL)
|
||||||
|
{
|
||||||
|
ESP_LOGE(TAG, "Adding item to vector fail. Invalid argument.");
|
||||||
|
return ESP_ERR_INVALID_ARG;
|
||||||
|
}
|
||||||
|
if (vector->status == false)
|
||||||
|
{
|
||||||
|
ESP_LOGE(TAG, "Adding item to vector fail. Vector not initialized.");
|
||||||
|
return ESP_ERR_INVALID_STATE;
|
||||||
|
}
|
||||||
|
if (vector->capacity == vector->size)
|
||||||
|
{
|
||||||
|
if (_resize(vector, vector->capacity + 1) == ESP_ERR_NO_MEM)
|
||||||
|
{
|
||||||
|
ESP_LOGE(TAG, "Adding item to vector fail. Memory allocation fail or no free memory in the heap.");
|
||||||
|
return ESP_ERR_NO_MEM;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (vector->spi_ram == true)
|
||||||
|
{
|
||||||
|
vector->items[vector->size] = heap_caps_malloc(vector->unit, MALLOC_CAP_SPIRAM);
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
if (vector->unit / sizeof(void *) == 0)
|
||||||
|
{
|
||||||
|
vector->items[vector->size] = heap_caps_malloc(vector->unit, MALLOC_CAP_32BIT);
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
vector->items[vector->size] = heap_caps_malloc(vector->unit, MALLOC_CAP_8BIT);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (vector->items[vector->size] == NULL)
|
||||||
|
{
|
||||||
|
ESP_LOGE(TAG, "Adding item to vector fail. Memory allocation fail or no free memory in the heap.");
|
||||||
|
return ESP_ERR_NO_MEM;
|
||||||
|
}
|
||||||
|
memset(vector->items[vector->size], 0, vector->unit);
|
||||||
|
memcpy(vector->items[vector->size++], item, vector->unit);
|
||||||
|
ESP_LOGI(TAG, "Adding item to vector success.");
|
||||||
|
return ESP_OK;
|
||||||
|
}
|
||||||
|
|
||||||
|
esp_err_t zh_vector_change_item(zh_vector_t *vector, uint16_t index, void *item)
|
||||||
|
{
|
||||||
|
ESP_LOGI(TAG, "Changing item in vector begin.");
|
||||||
|
if (vector == NULL || item == NULL)
|
||||||
|
{
|
||||||
|
ESP_LOGE(TAG, "Changing item in vector fail. Invalid argument.");
|
||||||
|
return ESP_ERR_INVALID_ARG;
|
||||||
|
}
|
||||||
|
if (vector->status == false)
|
||||||
|
{
|
||||||
|
ESP_LOGE(TAG, "Changing item in vector fail. Vector not initialized.");
|
||||||
|
return ESP_ERR_INVALID_STATE;
|
||||||
|
}
|
||||||
|
if (index < vector->size)
|
||||||
|
{
|
||||||
|
memcpy(vector->items[index], item, vector->unit);
|
||||||
|
ESP_LOGI(TAG, "Changing item in vector success.");
|
||||||
|
return ESP_OK;
|
||||||
|
}
|
||||||
|
ESP_LOGE(TAG, "Changing item in vector fail. Index does not exist.");
|
||||||
|
return ESP_FAIL;
|
||||||
|
}
|
||||||
|
|
||||||
|
void *zh_vector_get_item(zh_vector_t *vector, uint16_t index)
|
||||||
|
{
|
||||||
|
ESP_LOGI(TAG, "Getting item from vector begin.");
|
||||||
|
if (vector == NULL)
|
||||||
|
{
|
||||||
|
ESP_LOGE(TAG, "Getting item from vector fail. Invalid argument.");
|
||||||
|
return NULL;
|
||||||
|
}
|
||||||
|
if (vector->status == false)
|
||||||
|
{
|
||||||
|
ESP_LOGE(TAG, "Getting item from vector fail. Vector not initialized.");
|
||||||
|
return NULL;
|
||||||
|
}
|
||||||
|
if (index < vector->size)
|
||||||
|
{
|
||||||
|
void *item = vector->items[index];
|
||||||
|
ESP_LOGI(TAG, "Getting item from vector success.");
|
||||||
|
return item;
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
ESP_LOGE(TAG, "Getting item from vector fail. Index does not exist.");
|
||||||
|
return NULL;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
esp_err_t zh_vector_delete_item(zh_vector_t *vector, uint16_t index)
|
||||||
|
{
|
||||||
|
ESP_LOGI(TAG, "Deleting item in vector begin.");
|
||||||
|
if (vector == NULL)
|
||||||
|
{
|
||||||
|
ESP_LOGE(TAG, "Deleting item in vector fail. Invalid argument.");
|
||||||
|
return ESP_ERR_INVALID_ARG;
|
||||||
|
}
|
||||||
|
if (vector->status == false)
|
||||||
|
{
|
||||||
|
ESP_LOGE(TAG, "Deleting item in vector fail. Vector not initialized.");
|
||||||
|
return ESP_ERR_INVALID_STATE;
|
||||||
|
}
|
||||||
|
if (index < vector->size)
|
||||||
|
{
|
||||||
|
heap_caps_free(vector->items[index]);
|
||||||
|
for (uint8_t i = index; i < (vector->size - 1); ++i)
|
||||||
|
{
|
||||||
|
vector->items[i] = vector->items[i + 1];
|
||||||
|
vector->items[i + 1] = NULL;
|
||||||
|
}
|
||||||
|
--vector->size;
|
||||||
|
_resize(vector, vector->capacity - 1);
|
||||||
|
ESP_LOGI(TAG, "Deleting item in vector success.");
|
||||||
|
return ESP_OK;
|
||||||
|
}
|
||||||
|
ESP_LOGE(TAG, "Deleting item in vector fail. Index does not exist.");
|
||||||
|
return ESP_FAIL;
|
||||||
|
}
|
||||||
|
|
||||||
|
static esp_err_t _resize(zh_vector_t *vector, uint16_t capacity)
|
||||||
|
{
|
||||||
|
ESP_LOGI(TAG, "Vector resize begin.");
|
||||||
|
if (capacity == 0)
|
||||||
|
{
|
||||||
|
goto VECTOR_RESIZE_EXIT;
|
||||||
|
}
|
||||||
|
if (vector->spi_ram == true)
|
||||||
|
{
|
||||||
|
vector->items = heap_caps_realloc(vector->items, sizeof(void *) * capacity, MALLOC_CAP_SPIRAM);
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
vector->items = heap_caps_realloc(vector->items, sizeof(void *) * capacity, MALLOC_CAP_32BIT);
|
||||||
|
}
|
||||||
|
if (vector->items == NULL)
|
||||||
|
{
|
||||||
|
ESP_LOGE(TAG, "Vector resize fail. Memory allocation fail or no free memory in the heap.");
|
||||||
|
return ESP_ERR_NO_MEM;
|
||||||
|
}
|
||||||
|
VECTOR_RESIZE_EXIT:
|
||||||
|
vector->capacity = capacity;
|
||||||
|
ESP_LOGI(TAG, "Vector resize success. New capacity: %d", vector->capacity);
|
||||||
|
return ESP_OK;
|
||||||
|
}
|
||||||
Loading…
x
Reference in New Issue
Block a user