\r\n

51Degrees Device Detection C/C++  4.4

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

overrides.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_OVERRIDES_INCLUDED
24 #define FIFTYONE_DEGREES_OVERRIDES_INCLUDED
25 
70 #include <stdint.h>
71 #include <stdbool.h>
72 #include "data.h"
73 #include "string.h"
74 #include "collection.h"
75 #include "properties.h"
76 #include "evidence.h"
77 #include "array.h"
78 #include "common.h"
79 
83 typedef struct fiftyone_degrees_override_property_t {
84  uint32_t requiredPropertyIndex;
86  fiftyoneDegreesPropertyAvailable *available;
87 } fiftyoneDegreesOverrideProperty;
88 
93 typedef struct fiftyone_degrees_override_value_t {
94  uint32_t requiredPropertyIndex;
96  fiftyoneDegreesData string;
97 } fiftyoneDegreesOverrideValue;
98 
99 FIFTYONE_DEGREES_ARRAY_TYPE(
100  fiftyoneDegreesOverrideProperty,
101  bool prefix;
103 );
104 
108 FIFTYONE_DEGREES_ARRAY_TYPE(fiftyoneDegreesOverrideValue,);
109 
114 typedef fiftyoneDegreesOverridePropertyArray fiftyoneDegreesOverridable;
115 
122 typedef void(*fiftyoneDegreesOverrideProfileIdMethod)(
123  void *state,
124  uint32_t profileId);
125 
134 typedef bool(*fiftyoneDegreesOverridesFilterMethod)(
135  void *state,
136  uint32_t requiredPropertyIndex);
137 
143 EXTERNAL fiftyoneDegreesOverrideValueArray* fiftyoneDegreesOverrideValuesCreate(
144  uint32_t capacity);
145 
156 fiftyoneDegreesOverridePropertyArray*
157 fiftyoneDegreesOverridePropertiesCreate(
158  fiftyoneDegreesPropertiesAvailable *available,
159  bool prefix,
160  void *state,
161  fiftyoneDegreesOverridesFilterMethod filter);
162 
167 void fiftyoneDegreesOverridePropertiesFree(
168  fiftyoneDegreesOverridePropertyArray *properties);
169 
177  uint32_t fiftyoneDegreesOverridesExtractFromEvidence(
178  fiftyoneDegreesOverridePropertyArray *properties,
179  fiftyoneDegreesOverrideValueArray *values,
180  fiftyoneDegreesEvidenceKeyValuePairArray *evidence);
181 
192  bool fiftyoneDegreesOverrideHasValueForRequiredPropertyIndex(
193  fiftyoneDegreesOverrideValueArray *values,
194  uint32_t requiredPropertyIndex);
195 
203 uint32_t fiftyoneDegreesOverrideValuesAdd(
204  fiftyoneDegreesOverrideValueArray *values,
205  uint32_t requiredPropertyIndex,
206  fiftyoneDegreesList *list);
207 
216 EXTERNAL bool fiftyoneDegreesOverridesAdd(
217  fiftyoneDegreesOverrideValueArray *values,
218  int requiredPropertyIndex,
219  const char *value);
220 
229 fiftyoneDegreesString* fiftyoneDegreesOverrideValuesGetFirst(
230  fiftyoneDegreesOverrideValueArray *values,
231  uint32_t requiredPropertyIndex,
232  fiftyoneDegreesCollectionItem *item);
233 
243 int fiftyoneDegreesOverridesGetOverridingRequiredPropertyIndex(
244  fiftyoneDegreesPropertiesAvailable *available,
245  uint32_t requiredPropertyIndex);
246 
251 EXTERNAL void fiftyoneDegreesOverrideValuesFree(
252  fiftyoneDegreesOverrideValueArray *values);
253 
259 EXTERNAL void fiftyoneDegreesOverrideValuesReset(
260  fiftyoneDegreesOverrideValueArray *values);
261 
269 EXTERNAL void fiftyoneDegreesOverrideProfileIds(
270  fiftyoneDegreesEvidenceKeyValuePairArray *evidence,
271  void *state,
272  fiftyoneDegreesOverrideProfileIdMethod override);
273 
278 #endif
fiftyoneDegreesOverrideValueArray
An array of properties and values to use when getting override values.
Definition: overrides.h:108
fiftyoneDegreesOverrideHasValueForRequiredPropertyIndex
bool fiftyoneDegreesOverrideHasValueForRequiredPropertyIndex(fiftyoneDegreesOverrideValueArray *values, uint32_t requiredPropertyIndex)
Gets whether or not the override values contain an override relating to the property identified by th...
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
fiftyoneDegreesOverridesGetOverridingRequiredPropertyIndex
int fiftyoneDegreesOverridesGetOverridingRequiredPropertyIndex(fiftyoneDegreesPropertiesAvailable *available, uint32_t requiredPropertyIndex)
Gets the required property index of a property that MIGHT provide logic such as JavaScript or Regular...
fiftyoneDegreesOverridesFilterMethod
bool(* fiftyoneDegreesOverridesFilterMethod)(void *state, uint32_t requiredPropertyIndex)
Determines if the required property index is eligible for overriding considering the configuration of...
Definition: overrides.h:134
fiftyoneDegreesOverrideProperty::requiredPropertyIndex
uint32_t requiredPropertyIndex
Index in the available properties structure.
Definition: overrides.h:84
fiftyoneDegreesOverrideValue
String value which should override the value for the property indicated by the required property inde...
Definition: overrides.h:93
fiftyoneDegreesString
String structure containing its value and size.
Definition: string.h:109
fiftyoneDegreesOverrideValuesFree
void fiftyoneDegreesOverrideValuesFree(fiftyoneDegreesOverrideValueArray *values)
Frees the memory used for the override values.
fiftyoneDegreesData
Data structure used for reusing memory which may have been allocated in a previous operation.
Definition: data.h:101
fiftyoneDegreesOverrideProfileIds
void fiftyoneDegreesOverrideProfileIds(fiftyoneDegreesEvidenceKeyValuePairArray *evidence, void *state, fiftyoneDegreesOverrideProfileIdMethod override)
Extracts the profile overrides from the evidence and overrides them using the override method supplie...
fiftyoneDegreesOverridePropertiesFree
void fiftyoneDegreesOverridePropertiesFree(fiftyoneDegreesOverridePropertyArray *properties)
Frees the resources used by the override properties.
fiftyoneDegreesOverridesExtractFromEvidence
uint32_t fiftyoneDegreesOverridesExtractFromEvidence(fiftyoneDegreesOverridePropertyArray *properties, fiftyoneDegreesOverrideValueArray *values, fiftyoneDegreesEvidenceKeyValuePairArray *evidence)
Extracts override values from evidence.
fiftyoneDegreesOverrideValue::string
fiftyoneDegreesData string
Overridden value.
Definition: overrides.h:96
fiftyoneDegreesPropertyAvailableArray
Array of items of type fiftyoneDegreesPropertyAvailable used to easily access and track the size of t...
Definition: properties.h:165
fiftyoneDegreesPropertyAvailable
Used to access the property item quickly without the need to search.
Definition: properties.h:150
fiftyoneDegreesOverridePropertiesCreate
fiftyoneDegreesOverridePropertyArray * fiftyoneDegreesOverridePropertiesCreate(fiftyoneDegreesPropertiesAvailable *available, bool prefix, void *state, fiftyoneDegreesOverridesFilterMethod filter)
Returns a list of the evidence keys that are available to support overriding property values.
fiftyoneDegreesOverrideValuesReset
void fiftyoneDegreesOverrideValuesReset(fiftyoneDegreesOverrideValueArray *values)
Reset override array.
fiftyoneDegreesOverrideProfileIdMethod
void(* fiftyoneDegreesOverrideProfileIdMethod)(void *state, uint32_t profileId)
Called when a profile Id has been found and should override the one found from another source such as...
Definition: overrides.h:122
fiftyoneDegreesOverrideValuesAdd
uint32_t fiftyoneDegreesOverrideValuesAdd(fiftyoneDegreesOverrideValueArray *values, uint32_t requiredPropertyIndex, fiftyoneDegreesList *list)
Adds values from the overrides data structure into the results.
fiftyoneDegreesList
List structure which contains a list of collection items.
Definition: list.h:112
fiftyoneDegreesEvidenceKeyValuePairArray
Array of items of type fiftyoneDegreesEvidenceKeyValuePair used to easily access and track the size o...
Definition: evidence.h:172
fiftyoneDegreesOverrideValuesCreate
fiftyoneDegreesOverrideValueArray * fiftyoneDegreesOverrideValuesCreate(uint32_t capacity)
Creates a fresh array of override values with the given capacity.
fiftyoneDegreesOverridesAdd
bool fiftyoneDegreesOverridesAdd(fiftyoneDegreesOverrideValueArray *values, int requiredPropertyIndex, const char *value)
Add an value override to the override values array.
fiftyoneDegreesOverrideProperty::available
fiftyoneDegreesPropertyAvailable * available
Pointer to the property.
Definition: overrides.h:86
fiftyoneDegreesOverrideValuesGetFirst
fiftyoneDegreesString * fiftyoneDegreesOverrideValuesGetFirst(fiftyoneDegreesOverrideValueArray *values, uint32_t requiredPropertyIndex, fiftyoneDegreesCollectionItem *item)
Returns the first value for the required property index or NULL of no value exists for the property i...
evidence
Definition: GettingStarted.c:63
FIFTYONE_DEGREES_ARRAY_TYPE
#define FIFTYONE_DEGREES_ARRAY_TYPE(t, m)
Simple array structure definition macro used for generic types.
Definition: array.h:48
fiftyoneDegreesOverrideProperty
Index and pointer to a property which can be overridden.
Definition: overrides.h:83
fiftyoneDegreesOverridable
fiftyoneDegreesOverridePropertyArray fiftyoneDegreesOverridable
Array of overridable properties.
Definition: overrides.h:108
fiftyoneDegreesOverridePropertyArray
Array of items of type fiftyoneDegreesOverrideProperty used to easily access and track the size of th...
Definition: overrides.h:103
fiftyoneDegreesOverrideValue::requiredPropertyIndex
uint32_t requiredPropertyIndex
Index in the available properties structure.
Definition: overrides.h:94

Generated by doxygen 1.8.15