1/* *********************************************************************

2 * This Original Work is copyright of 51 Degrees Mobile Experts Limited.

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

26#ifdef FIFTYONE_DEGREES_IPI_SYMBOLS

27#include "ipiSymbols.h"

28#endif

29

108

109#include "collection.h"

110#include "string.h"

111#include "common.h"

112

116typedef struct fiftyone_degrees_list_t {

117 fiftyoneDegreesCollectionItem *items;

118 uint32_t capacity;

119 uint32_t count;

120} fiftyoneDegreesList;

121

128EXTERNAL fiftyoneDegreesList* fiftyoneDegreesListInit(

129 fiftyoneDegreesList *list,

130 uint32_t capacity);

131

138EXTERNAL void fiftyoneDegreesListAdd(

139 fiftyoneDegreesList *list,

140 fiftyoneDegreesCollectionItem *item);

141

148EXTERNAL fiftyoneDegreesString* fiftyoneDegreesListGetAsString(

149 fiftyoneDegreesList *list,

150 int index);

151

157EXTERNAL void fiftyoneDegreesListFree(fiftyoneDegreesList *list);

158

163EXTERNAL void fiftyoneDegreesListReset(fiftyoneDegreesList *list);

164

169EXTERNAL void fiftyoneDegreesListRelease(fiftyoneDegreesList *list);

170

174

175#endif

fiftyoneDegreesListRelease

void fiftyoneDegreesListRelease(fiftyoneDegreesList *list)

Releases all the items stored in the list.

fiftyoneDegreesListInit

fiftyoneDegreesList * fiftyoneDegreesListInit(fiftyoneDegreesList *list, uint32_t capacity)

Initialise the list by allocating space for the items in the list structure.

fiftyoneDegreesListAdd

void fiftyoneDegreesListAdd(fiftyoneDegreesList *list, fiftyoneDegreesCollectionItem *item)

Adds a collection item to a list.

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:315

fiftyoneDegreesList

List structure which contains a list of collection items.

Definition list.h:116

fiftyoneDegreesList::items

fiftyoneDegreesCollectionItem * items

Array of items.

Definition list.h:117

fiftyoneDegreesList::count

uint32_t count

Number of items currently in the list.

Definition list.h:119

fiftyoneDegreesList::capacity

uint32_t capacity

Capacity of the list to store items.

Definition list.h:118

fiftyoneDegreesString

Definition string.h:97