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_COMPONENT_H_INCLUDED

24#define FIFTYONE_DEGREES_COMPONENT_H_INCLUDED

25

26#ifdef FIFTYONE_DEGREES_IPI_SYMBOLS

27#include "ipiSymbols.h"

28#endif

29

52

53#include <stdint.h>

54#ifdef _MSC_VER

55#pragma warning (push)

56#pragma warning (disable: 5105)

57#include <windows.h>

58#pragma warning (default: 5105)

59#pragma warning (pop)

60#endif

61#include "data.h"

62#include "exceptions.h"

63#include "collection.h"

64#include "list.h"

65#include "string.h"

66#include "common.h"

67#include "headers.h"

68

74typedef struct fiftyoneDegrees_component_keyvaluepair_t {

75 uint32_t key;

76 uint32_t value;

77} fiftyoneDegreesComponentKeyValuePair;

78

83#pragma pack(push, 1)

84typedef struct fiftyoneDegrees_component_t {

85 const byte componentId;

86 const int32_t nameOffset;

88 const int32_t defaultProfileOffset;

90 const uint16_t keyValuesCount;

92 const fiftyoneDegreesComponentKeyValuePair firstKeyValuePair;

95} fiftyoneDegreesComponent;

96#pragma pack(pop)

97

103EXTERNAL uint32_t fiftyoneDegreesComponentGetFinalSize(

104 const void *initial,

105 fiftyoneDegreesException *exception);

117EXTERNAL const fiftyoneDegreesString* fiftyoneDegreesComponentGetName(

118 fiftyoneDegreesCollection *stringsCollection,

119 fiftyoneDegreesComponent *component,

120 fiftyoneDegreesCollectionItem *item,

121 fiftyoneDegreesException *exception);

122

133const fiftyoneDegreesComponentKeyValuePair*

134fiftyoneDegreesComponentGetKeyValuePair(

135 fiftyoneDegreesComponent *component,

136 uint16_t index,

137 fiftyoneDegreesException *exception);

138

148void fiftyoneDegreesComponentInitList(

149 fiftyoneDegreesCollection *components,

150 fiftyoneDegreesList *list,

151 uint32_t count,

152 fiftyoneDegreesException *exception);

153

154#ifndef FIFTYONE_DEGREES_MEMORY_ONLY

155

166EXTERNAL void* fiftyoneDegreesComponentReadFromFile(

167 const fiftyoneDegreesCollectionFile *file,

168 const fiftyoneDegreesCollectionKey *key,

169 fiftyoneDegreesData *data,

170 fiftyoneDegreesException *exception);

171

172#endif

173

182EXTERNAL uint32_t fiftyoneDegreesComponentGetDefaultProfileId(

183 fiftyoneDegreesCollection *profiles,

184 fiftyoneDegreesComponent *component,

185 fiftyoneDegreesException *exception);

186

195EXTERNAL fiftyoneDegreesHeaderPtrs* fiftyoneDegreesComponentGetHeaders(

196 fiftyoneDegreesComponent* component,

197 fiftyoneDegreesHeaders* headers,

198 fiftyoneDegreesException* exception);

199

203

204#endif

fiftyoneDegreesComponentGetFinalSize

uint32_t fiftyoneDegreesComponentGetFinalSize(const void *initial, fiftyoneDegreesException *exception)

Gets size of Component with trailing key-value pair.

fiftyoneDegreesComponentInitList

void fiftyoneDegreesComponentInitList(fiftyoneDegreesCollection *components, fiftyoneDegreesList *list, uint32_t count, fiftyoneDegreesException *exception)

Initialises the list of components.

fiftyoneDegreesComponentGetName

const fiftyoneDegreesString * fiftyoneDegreesComponentGetName(fiftyoneDegreesCollection *stringsCollection, fiftyoneDegreesComponent *component, fiftyoneDegreesCollectionItem *item, fiftyoneDegreesException *exception)

Returns the string name of the component using the item provided.

fiftyoneDegreesComponentReadFromFile

void * fiftyoneDegreesComponentReadFromFile(const fiftyoneDegreesCollectionFile *file, const fiftyoneDegreesCollectionKey *key, fiftyoneDegreesData *data, fiftyoneDegreesException *exception)

Read a component from the file collection provided and store in the data pointer.

fiftyoneDegreesComponentGetHeaders

fiftyoneDegreesHeaderPtrs * fiftyoneDegreesComponentGetHeaders(fiftyoneDegreesComponent *component, fiftyoneDegreesHeaders *headers, fiftyoneDegreesException *exception)

Where the component's key value pairs relate to headers creates an array of pointers to the relevant ...

fiftyoneDegreesComponentGetKeyValuePair

const fiftyoneDegreesComponentKeyValuePair * fiftyoneDegreesComponentGetKeyValuePair(fiftyoneDegreesComponent *component, uint16_t index, fiftyoneDegreesException *exception)

Get a pointer to the key value pair at the specified index within the component's key value pairs lis...

fiftyoneDegreesComponentGetDefaultProfileId

uint32_t fiftyoneDegreesComponentGetDefaultProfileId(fiftyoneDegreesCollection *profiles, fiftyoneDegreesComponent *component, fiftyoneDegreesException *exception)

Get the default profile id for the component provided.

fiftyoneDegreesHeaders

fiftyoneDegreesHeaderArray fiftyoneDegreesHeaders

Array of headers used to easily access and track the size of the array.

Definition headers.h:171

fiftyoneDegreesCollectionFile

Type of collection where the collection is streamed from file.

Definition collection.h:456

fiftyoneDegreesCollection

All the shared methods and fields required by file, memory and cached collections.

Definition collection.h:408

fiftyoneDegreesCollectionItem