\r\n

51Degrees Device Detection C/C++  4.4

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

profile.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_PROFILE_H_INCLUDED
24 #define FIFTYONE_DEGREES_PROFILE_H_INCLUDED
25 
66 #include <stdint.h>
67 #ifdef _MSC_VER
68 #pragma warning (push)
69 #pragma warning (disable: 5105)
70 #include <windows.h>
71 #pragma warning (default: 5105)
72 #pragma warning (pop)
73 #endif
74 #include "data.h"
75 #include "exceptions.h"
76 #include "collection.h"
77 #include "string.h"
78 #include "component.h"
79 #include "property.h"
80 #include "value.h"
81 #include "common.h"
82 
87 #pragma pack(push, 1)
88 typedef struct fiftyoneDegrees_profile_t {
89  const byte componentIndex;
91  const uint32_t profileId;
92  const uint32_t valueCount;
93 } fiftyoneDegreesProfile;
94 #pragma pack(pop)
95 
102 #pragma pack(push, 4)
103 typedef struct fiftyoneDegrees_profile_offset_t {
104  const uint32_t profileId;
105  const uint32_t offset;
106 } fiftyoneDegreesProfileOffset;
107 #pragma pack(pop)
108 
116 typedef bool(*fiftyoneDegreesProfileIterateMethod)(
117  void *state,
118  fiftyoneDegreesCollectionItem *item);
119 
132 EXTERNAL fiftyoneDegreesProfile* fiftyoneDegreesProfileGetByProfileId(
133  fiftyoneDegreesCollection *profileOffsets,
134  fiftyoneDegreesCollection *profiles,
135  const uint32_t profileId,
136  fiftyoneDegreesCollectionItem *item,
137  fiftyoneDegreesException *exception);
138 
153 EXTERNAL fiftyoneDegreesProfile* fiftyoneDegreesProfileGetByIndex(
154  fiftyoneDegreesCollection *profileOffsets,
155  fiftyoneDegreesCollection *profiles,
156  uint32_t index,
157  fiftyoneDegreesCollectionItem *item,
158  fiftyoneDegreesException *exception);
159 
160 #ifndef FIFTYONE_DEGREES_MEMORY_ONLY
161 
172 void* fiftyoneDegreesProfileReadFromFile(
173  const fiftyoneDegreesCollectionFile *file,
174  uint32_t offset,
175  fiftyoneDegreesData *data,
176  fiftyoneDegreesException *exception);
177 #endif
178 
191 EXTERNAL uint32_t fiftyoneDegreesProfileIterateValuesForProperty(
192  fiftyoneDegreesCollection *values,
193  fiftyoneDegreesProfile *profile,
194  fiftyoneDegreesProperty *property,
195  void *state,
196  fiftyoneDegreesProfileIterateMethod callback,
197  fiftyoneDegreesException *exception);
198 
217 EXTERNAL uint32_t fiftyoneDegreesProfileIterateProfilesForPropertyAndValue(
218  fiftyoneDegreesCollection *strings,
219  fiftyoneDegreesCollection *properties,
220  fiftyoneDegreesCollection *values,
221  fiftyoneDegreesCollection *profiles,
222  fiftyoneDegreesCollection *profileOffsets,
223  const char *propertyName,
224  const char* valueName,
225  void *state,
226  fiftyoneDegreesProfileIterateMethod callback,
227  fiftyoneDegreesException *exception);
228 
239 uint32_t* fiftyoneDegreesProfileGetOffsetForProfileId(
240  fiftyoneDegreesCollection *profileOffsets,
241  const uint32_t profileId,
242  uint32_t *profileOffset,
243  fiftyoneDegreesException *exception);
244 
249 #endif
fiftyoneDegreesProfile::componentIndex
const byte componentIndex
The index of the component the profile relates to.
Definition: profile.h:89
fiftyoneDegreesProfileOffset::profileId
const uint32_t profileId
The unique Id of the profile.
Definition: profile.h:104
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:310
fiftyoneDegreesProfileIterateValuesForProperty
uint32_t fiftyoneDegreesProfileIterateValuesForProperty(fiftyoneDegreesCollection *values, fiftyoneDegreesProfile *profile, fiftyoneDegreesProperty *property, void *state, fiftyoneDegreesProfileIterateMethod callback, fiftyoneDegreesException *exception)
Iterate over all values contained in the profile which relate to the specified property,...
fiftyoneDegreesProfileOffset
Structure containing the unique id of the profile, and the offset needed to retrieve the actual profi...
Definition: profile.h:103
fiftyoneDegreesProfileGetByProfileId
fiftyoneDegreesProfile * fiftyoneDegreesProfileGetByProfileId(fiftyoneDegreesCollection *profileOffsets, fiftyoneDegreesCollection *profiles, const uint32_t profileId, fiftyoneDegreesCollectionItem *item, fiftyoneDegreesException *exception)
Gets the profile associated with the profileId or NULL if there is no corresponding profile.
fiftyoneDegreesCollectionFile
Type of collection where the collection is streamed from file.
Definition: collection.h:447
fiftyoneDegreesProfileIterateProfilesForPropertyAndValue
uint32_t fiftyoneDegreesProfileIterateProfilesForPropertyAndValue(fiftyoneDegreesCollection *strings, fiftyoneDegreesCollection *properties, fiftyoneDegreesCollection *values, fiftyoneDegreesCollection *profiles, fiftyoneDegreesCollection *profileOffsets, const char *propertyName, const char *valueName, void *state, fiftyoneDegreesProfileIterateMethod callback, fiftyoneDegreesException *exception)
Iterate all profiles which contain the specified value, calling the callback method for each.
fiftyoneDegreesProfileGetByIndex
fiftyoneDegreesProfile * fiftyoneDegreesProfileGetByIndex(fiftyoneDegreesCollection *profileOffsets, fiftyoneDegreesCollection *profiles, uint32_t index, fiftyoneDegreesCollectionItem *item, fiftyoneDegreesException *exception)
Gets a pointer to the profile at the index provided.
fiftyoneDegreesData
Data structure used for reusing memory which may have been allocated in a previous operation.
Definition: data.h:101
fiftyoneDegreesProfileOffset::offset
const uint32_t offset
Offset to the profile in the profiles structure.
Definition: profile.h:105
fiftyoneDegreesProperty
Property structure containing all the meta data relating to a property.
Definition: property.h:85
fiftyoneDegreesProfile::valueCount
const uint32_t valueCount
The number of values within the profile.
Definition: profile.h:92
fiftyoneDegreesProfileGetOffsetForProfileId
uint32_t * fiftyoneDegreesProfileGetOffsetForProfileId(fiftyoneDegreesCollection *profileOffsets, const uint32_t profileId, uint32_t *profileOffset, fiftyoneDegreesException *exception)
Gets the offset in the profiles collection for the profile with the profileId or NULL if there is no ...
fiftyoneDegreesException
Structure used to represent a 51Degrees exception and passed into methods that might generate excepti...
Definition: exceptions.h:111
fiftyoneDegreesProfileReadFromFile
void * fiftyoneDegreesProfileReadFromFile(const fiftyoneDegreesCollectionFile *file, uint32_t offset, fiftyoneDegreesData *data, fiftyoneDegreesException *exception)
Read a profile from the file collection provided and store in the data pointer.
fiftyoneDegreesProfileIterateMethod
bool(* fiftyoneDegreesProfileIterateMethod)(void *state, fiftyoneDegreesCollectionItem *item)
Definition of a callback function which is passed an item of a type determined by the iteration metho...
Definition: profile.h:116
fiftyoneDegreesProfile
Encapsulates a profile stored within a data set.
Definition: profile.h:88
fiftyoneDegreesProfile::profileId
const uint32_t profileId
Unique id of the profile.
Definition: profile.h:91
fiftyoneDegreesCollection
All the shared methods and fields required by file, memory and cached collections.
Definition: collection.h:410

Generated by doxygen 1.8.15