\r\n

51Degrees Device Detection C/C++  4.4

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

properties.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 
117 #ifndef FIFTYONE_DEGREES_PROPERTIES_H_INCLUDED
118 #define FIFTYONE_DEGREES_PROPERTIES_H_INCLUDED
119 
120 #include <stdint.h>
121 #ifdef _MSC_FULL_VER
122 #include <string.h>
123 #else
124 #include <strings.h>
125 #define _stricmp strcasecmp
126 #define _strnicmp strncasecmp
127 #endif
128 #include "string.h"
129 #include "list.h"
130 #include "data.h"
131 #include "collection.h"
132 #include "array.h"
133 #include "common.h"
134 
139 typedef uint32_t fiftyoneDegreesEvidencePropertyIndex;
140 
141 FIFTYONE_DEGREES_ARRAY_TYPE(fiftyoneDegreesEvidencePropertyIndex, )
142 
143 
147 typedef fiftyoneDegreesEvidencePropertyIndexArray fiftyoneDegreesEvidenceProperties;
148 
150 typedef struct fiftyone_degrees_property_available_t {
151  uint32_t propertyIndex;
153  fiftyoneDegreesCollectionItem name;
154  fiftyoneDegreesEvidenceProperties *evidenceProperties;
158  bool delayExecution;
163 } fiftyoneDegreesPropertyAvailable;
164 
165 FIFTYONE_DEGREES_ARRAY_TYPE(fiftyoneDegreesPropertyAvailable,)
166 
167 
168 typedef fiftyoneDegreesPropertyAvailableArray
169 fiftyoneDegreesPropertiesAvailable;
170 
175 EXTERNAL typedef struct fiftyone_degrees_properties_required_t {
176  const char **array;
179  int count;
180  const char *string;
182  fiftyoneDegreesPropertiesAvailable *existing;
185 } fiftyoneDegreesPropertiesRequired;
186 
195 typedef fiftyoneDegreesString*(*fiftyoneDegreesPropertiesGetMethod)(
196  void *state,
197  uint32_t index,
198  fiftyoneDegreesCollectionItem *item);
199 
213 typedef uint32_t(*fiftyoneDegreesEvidencePropertiesGetMethod)(
214  void* state,
215  fiftyoneDegreesPropertyAvailable* property,
216  fiftyoneDegreesEvidenceProperties* evidenceProperties);
217 
223 EXTERNAL_VAR fiftyoneDegreesPropertiesRequired fiftyoneDegreesPropertiesDefault;
224 
242 EXTERNAL fiftyoneDegreesPropertiesAvailable* fiftyoneDegreesPropertiesCreate(
243  fiftyoneDegreesPropertiesRequired *properties,
244  void *state,
245  fiftyoneDegreesPropertiesGetMethod getPropertyMethod,
246  fiftyoneDegreesEvidencePropertiesGetMethod getEvidencePropertiesMethod);
247 
254 EXTERNAL int fiftyoneDegreesPropertiesGetPropertyIndexFromName(
255  fiftyoneDegreesPropertiesAvailable *available,
256  const char *propertyName);
257 
266 EXTERNAL int fiftyoneDegreesPropertiesGetRequiredPropertyIndexFromName(
267  fiftyoneDegreesPropertiesAvailable *available,
268  const char *propertyName);
269 
277 EXTERNAL int fiftyoneDegreesPropertiesGetPropertyIndexFromRequiredIndex(
278  fiftyoneDegreesPropertiesAvailable *available,
279  int requiredPropertyIndex);
280 
288 EXTERNAL fiftyoneDegreesString*
289  fiftyoneDegreesPropertiesGetNameFromRequiredIndex(
290  fiftyoneDegreesPropertiesAvailable *available,
291  int requiredPropertyIndex);
292 
299 EXTERNAL bool fiftyoneDegreesPropertiesIsSetHeaderAvailable(
300  fiftyoneDegreesPropertiesAvailable* available);
301 
307 EXTERNAL void fiftyoneDegreesPropertiesFree(
308  fiftyoneDegreesPropertiesAvailable *available);
309 
314 #endif
fiftyoneDegreesPropertiesDefault
EXTERNAL_VAR fiftyoneDegreesPropertiesRequired fiftyoneDegreesPropertiesDefault
The default properties required to make all possible properties available.
Definition: properties.h:223
fiftyoneDegreesPropertiesGetPropertyIndexFromName
int fiftyoneDegreesPropertiesGetPropertyIndexFromName(fiftyoneDegreesPropertiesAvailable *available, const char *propertyName)
Gets the index of the property in the source data structure from the name.
fiftyoneDegreesPropertiesGetNameFromRequiredIndex
fiftyoneDegreesString * fiftyoneDegreesPropertiesGetNameFromRequiredIndex(fiftyoneDegreesPropertiesAvailable *available, int requiredPropertyIndex)
Gets the name as a string from the required property index.
fiftyoneDegreesPropertiesRequired::array
const char ** array
Array of required properties or NULL if all properties are required.
Definition: properties.h:176
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
fiftyoneDegreesPropertyAvailable::delayExecution
bool delayExecution
True if the execution any JavaScript returned as a value of this property should be delayed.
Definition: properties.h:158
fiftyoneDegreesPropertyAvailable::evidenceProperties
fiftyoneDegreesEvidenceProperties * evidenceProperties
Evidence properties which are required by this property.
Definition: properties.h:154
fiftyoneDegreesEvidencePropertiesGetMethod
uint32_t(* fiftyoneDegreesEvidencePropertiesGetMethod)(void *state, fiftyoneDegreesPropertyAvailable *property, fiftyoneDegreesEvidenceProperties *evidenceProperties)
Populates the evidence properties structure with the indexes of the properties required by the proper...
Definition: properties.h:213
fiftyoneDegreesPropertiesGetRequiredPropertyIndexFromName
int fiftyoneDegreesPropertiesGetRequiredPropertyIndexFromName(fiftyoneDegreesPropertiesAvailable *available, const char *propertyName)
Gets the required property index in the list of all required properties from the name.
fiftyoneDegreesPropertyAvailable::propertyIndex
uint32_t propertyIndex
Index of the property in the collection of all properties.
Definition: properties.h:151
fiftyoneDegreesPropertiesFree
void fiftyoneDegreesPropertiesFree(fiftyoneDegreesPropertiesAvailable *available)
Frees the memory and resources used by the properties results previously created using the fiftyoneDe...
fiftyoneDegreesString
String structure containing its value and size.
Definition: string.h:109
fiftyoneDegreesEvidencePropertyIndex
uint32_t fiftyoneDegreesEvidencePropertyIndex
Index in the properties collection to a property which is required to get evidence for another proper...
Definition: properties.h:139
fiftyoneDegreesPropertyAvailable::name
fiftyoneDegreesCollectionItem name
Name of the property from strings.
Definition: properties.h:153
fiftyoneDegreesPropertiesGetMethod
fiftyoneDegreesString *(* fiftyoneDegreesPropertiesGetMethod)(void *state, uint32_t index, fiftyoneDegreesCollectionItem *item)
Returns a string for the property at the index provided or NULL if there is no property available at ...
Definition: properties.h:195
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
fiftyoneDegreesPropertiesRequired::existing
fiftyoneDegreesPropertiesAvailable * existing
A pointer to an existing set of property names from another instance.
Definition: properties.h:182
fiftyoneDegreesPropertiesIsSetHeaderAvailable
bool fiftyoneDegreesPropertiesIsSetHeaderAvailable(fiftyoneDegreesPropertiesAvailable *available)
Check if the 'SetHeader' properties are included in the available required properties.
fiftyoneDegreesPropertiesRequired
Defines a set of properties which are required by a caller.
Definition: properties.h:175
fiftyoneDegreesPropertiesRequired::count
int count
Number of properties in array.
Definition: properties.h:179
fiftyoneDegreesPropertiesGetPropertyIndexFromRequiredIndex
int fiftyoneDegreesPropertiesGetPropertyIndexFromRequiredIndex(fiftyoneDegreesPropertiesAvailable *available, int requiredPropertyIndex)
Maps the required property index to the index in the source data structure.
FIFTYONE_DEGREES_ARRAY_TYPE
#define FIFTYONE_DEGREES_ARRAY_TYPE(t, m)
Simple array structure definition macro used for generic types.
Definition: array.h:48
fiftyoneDegreesPropertiesRequired::string
const char * string
Separated list of required properties or NULL if all properties are required.
Definition: properties.h:180
fiftyoneDegreesEvidencePropertyIndexArray
Array of items of type fiftyoneDegreesEvidencePropertyIndex used to easily access and track the size ...
Definition: properties.h:141
fiftyoneDegreesPropertiesCreate
fiftyoneDegreesPropertiesAvailable * fiftyoneDegreesPropertiesCreate(fiftyoneDegreesPropertiesRequired *properties, void *state, fiftyoneDegreesPropertiesGetMethod getPropertyMethod, fiftyoneDegreesEvidencePropertiesGetMethod getEvidencePropertiesMethod)
Creates a properties result instance for use with future property operations.

Generated by doxygen 1.8.15