\r\n

51Degrees Device Detection C/C++  4.4

A device detection library that is used natively or by 51Degrees products

list.h

1 /* *********************************************************************
2  * This Original Work is copyright of 51 Degrees Mobile Experts Limited.
3  * Copyright 2023 51 Degrees Mobile Experts Limited, Davidson House,
4  * Forbury Square, Reading, Berkshire, United Kingdom RG1 3EU.
5  *
6  * This Original Work is licensed under the European Union Public Licence
7  * (EUPL) v.1.2 and is subject to its terms as set out below.
8  *
9  * If a copy of the EUPL was not distributed with this file, You can obtain
10  * one at https://opensource.org/licenses/EUPL-1.2.
11  *
12  * The 'Compatible Licences' set out in the Appendix to the EUPL (as may be
13  * amended by the European Commission) shall be deemed incompatible for
14  * the purposes of the Work and the provisions of the compatibility
15  * clause in Article 5 of the EUPL shall not apply.
16  *
17  * If using the Work as, or as part of, a network application, by
18  * including the attribution notice(s) required under Article 5 of the EUPL
19  * in the end user terms of the application under an appropriate heading,
20  * such notice(s) shall fulfill the requirements of that article.
21  * ********************************************************************* */
22 
23 #ifndef FIFTYONE_DEGREES_LIST_H_INCLUDED
24 #define FIFTYONE_DEGREES_LIST_H_INCLUDED
25 
105 #include "collection.h"
106 #include "string.h"
107 #include "common.h"
108 
112 typedef struct fiftyone_degrees_list_t {
113  fiftyoneDegreesCollectionItem *items;
114  uint32_t capacity;
115  uint32_t count;
116 } fiftyoneDegreesList;
117 
124 EXTERNAL fiftyoneDegreesList* fiftyoneDegreesListInit(
125  fiftyoneDegreesList *list,
126  uint32_t capacity);
127 
134 EXTERNAL void fiftyoneDegreesListAdd(
135  fiftyoneDegreesList *list,
136  fiftyoneDegreesCollectionItem *item);
137 
144 EXTERNAL fiftyoneDegreesString* fiftyoneDegreesListGetAsString(
145  fiftyoneDegreesList *list,
146  int index);
147 
153 EXTERNAL void fiftyoneDegreesListFree(fiftyoneDegreesList *list);
154 
159 EXTERNAL void fiftyoneDegreesListReset(fiftyoneDegreesList *list);
160 
165 EXTERNAL void fiftyoneDegreesListRelease(fiftyoneDegreesList *list);
166 
171 #endif
fiftyoneDegreesListGetAsString
fiftyoneDegreesString * fiftyoneDegreesListGetAsString(fiftyoneDegreesList *list, int index)
Gets the item at the index provided as a string.
fiftyoneDegreesListReset
void fiftyoneDegreesListReset(fiftyoneDegreesList *list)
Resets a newly allocated list to a clean empty state.
fiftyoneDegreesListFree
void fiftyoneDegreesListFree(fiftyoneDegreesList *list)
Frees the memory allocated to the list structure and release all items stored in it.
fiftyoneDegreesCollectionItem
Used to store a handle to the underlying item that could be used to release the item when it's finish...
Definition: collection.h:308
fiftyoneDegreesList::items
fiftyoneDegreesCollectionItem * items
Array of items.
Definition: list.h:113
fiftyoneDegreesList::capacity
uint32_t capacity
Capacity of the list to store items.
Definition: list.h:114
fiftyoneDegreesListInit
fiftyoneDegreesList * fiftyoneDegreesListInit(fiftyoneDegreesList *list, uint32_t capacity)
Initialise the list by allocating space for the items in the list structure.
fiftyoneDegreesListRelease
void fiftyoneDegreesListRelease(fiftyoneDegreesList *list)
Releases all the items stored in the list.
fiftyoneDegreesString
String structure containing its value and size.
Definition: string.h:109
fiftyoneDegreesList
List structure which contains a list of collection items.
Definition: list.h:112
fiftyoneDegreesListAdd
void fiftyoneDegreesListAdd(fiftyoneDegreesList *list, fiftyoneDegreesCollectionItem *item)
Adds a collection item to a list.
fiftyoneDegreesList::count
uint32_t count
Number of items currently in the list.
Definition: list.h:115

Generated by doxygen 1.8.15