51Degrees Device Detection C/C++  4.2

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

property.h

1 /* *********************************************************************
2  * This Original Work is copyright of 51 Degrees Mobile Experts Limited.
3  * Copyright 2019 51 Degrees Mobile Experts Limited, 5 Charlotte Close,
4  * Caversham, Reading, Berkshire, United Kingdom RG4 7BY.
5  *
6  * This Original Work is licensed under the European Union Public Licence (EUPL)
7  * 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_PROPERTY_H_INCLUDED
24 #define FIFTYONE_DEGREES_PROPERTY_H_INCLUDED
25 
52 #include <stdint.h>
53 #ifdef _MSC_VER
54 #include <windows.h>
55 #endif
56 #include "data.h"
57 #include "exceptions.h"
58 #include "collection.h"
59 #include "string.h"
60 
61 #ifdef __cplusplus
62 #define EXTERNAL extern "C"
63 #else
64 #define EXTERNAL
65 #endif
66 
70 typedef enum e_fiftyone_degrees_property_value_type {
71  FIFTYONE_DEGREES_PROPERTY_VALUE_TYPE_STRING = 0,
72  FIFTYONE_DEGREES_PROPERTY_VALUE_TYPE_INTEGER = 1,
73  FIFTYONE_DEGREES_PROPERTY_VALUE_TYPE_DOUBLE = 2,
74  FIFTYONE_DEGREES_PROPERTY_VALUE_TYPE_BOOLEAN = 3,
75  FIFTYONE_DEGREES_PROPERTY_VALUE_TYPE_JAVASCRIPT = 4,
76  FIFTYONE_DEGREES_PROPERTY_VALUE_SINGLE_PRECISION_FLOAT = 5,
77  FIFTYONE_DEGREES_PROPERTY_VALUE_SINGLE_BYTE = 6,
78  FIFTYONE_DEGREES_PROPERTY_VALUE_TYPE_COORDINATE = 7,
79  FIFTYONE_DEGREES_PROPERTY_VALUE_TYPE_IP_ADDRESS = 8
80 } fiftyoneDegreesPropertyValueType;
81 
85 #pragma pack(push, 1)
86 typedef struct property_t {
87  const byte componentIndex;
88  const byte displayOrder;
90  const byte isMandatory;
92  const byte isList;
94  const byte showValues;
95  const byte isObsolete;
97  const byte show;
98  const byte valueType;
99  const uint32_t defaultValueIndex;
101  const uint32_t nameOffset;
103  const uint32_t descriptionOffset;
105  const uint32_t categoryOffset;
107  const uint32_t urlOffset;
109  const uint32_t firstValueIndex;
110  const uint32_t lastValueIndex;
111  const uint32_t mapCount;
112  const uint32_t firstMapIndex;
114 } fiftyoneDegreesProperty;
115 #pragma pack(pop)
116 
128 EXTERNAL fiftyoneDegreesString* fiftyoneDegreesPropertyGetName(
129  fiftyoneDegreesCollection *stringsCollection,
130  fiftyoneDegreesProperty *property,
131  fiftyoneDegreesCollectionItem *item,
132  fiftyoneDegreesException *exception);
133 
145 EXTERNAL fiftyoneDegreesString* fiftyoneDegreesPropertyGetDescription(
146  fiftyoneDegreesCollection *stringsCollection,
147  fiftyoneDegreesProperty *property,
148  fiftyoneDegreesCollectionItem *item,
149  fiftyoneDegreesException *exception);
150 
162 EXTERNAL fiftyoneDegreesString* fiftyoneDegreesPropertyGetCategory(
163  fiftyoneDegreesCollection *stringsCollection,
164  fiftyoneDegreesProperty *property,
165  fiftyoneDegreesCollectionItem *item,
166  fiftyoneDegreesException *exception);
167 
179 EXTERNAL fiftyoneDegreesString* fiftyoneDegreesPropertyGetUrl(
180  fiftyoneDegreesCollection *stringsCollection,
181  fiftyoneDegreesProperty *property,
182  fiftyoneDegreesCollectionItem *item,
183  fiftyoneDegreesException *exception);
184 
193 EXTERNAL byte fiftyoneDegreesPropertyGetValueType(
194  fiftyoneDegreesCollection *properties,
195  uint32_t index,
196  fiftyoneDegreesException *exception);
197 
208 EXTERNAL fiftyoneDegreesProperty* fiftyoneDegreesPropertyGet(
209  fiftyoneDegreesCollection *properties,
210  uint32_t index,
211  fiftyoneDegreesCollectionItem *item,
212  fiftyoneDegreesException *exception);
213 
225 EXTERNAL fiftyoneDegreesProperty* fiftyoneDegreesPropertyGetByName(
226  fiftyoneDegreesCollection *properties,
227  fiftyoneDegreesCollection *strings,
228  const char *requiredPropertyName,
229  fiftyoneDegreesCollectionItem *item,
230  fiftyoneDegreesException *exception);
231 
236 #endif
fiftyoneDegreesProperty::valueType
const byte valueType
The type of value the property represents.
Definition: property.h:98
FIFTYONE_DEGREES_PROPERTY_VALUE_TYPE_COORDINATE
Coordinate.
Definition: property.h:78
FIFTYONE_DEGREES_PROPERTY_VALUE_TYPE_JAVASCRIPT
JavaScript string.
Definition: property.h:75
FIFTYONE_DEGREES_PROPERTY_VALUE_SINGLE_BYTE
Single byte value.
Definition: property.h:77
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:309
fiftyoneDegreesPropertyGetCategory
fiftyoneDegreesString * fiftyoneDegreesPropertyGetCategory(fiftyoneDegreesCollection *stringsCollection, fiftyoneDegreesProperty *property, fiftyoneDegreesCollectionItem *item, fiftyoneDegreesException *exception)
Returns the string category of the property using the item provided.
FIFTYONE_DEGREES_PROPERTY_VALUE_TYPE_DOUBLE
Double.
Definition: property.h:73
fiftyoneDegreesProperty::componentIndex
const byte componentIndex
Index of the component.
Definition: property.h:87
fiftyoneDegreesProperty::isList
const byte isList
True if the property is a list can return multiple values.
Definition: property.h:92
FIFTYONE_DEGREES_PROPERTY_VALUE_TYPE_STRING
String.
Definition: property.h:71
fiftyoneDegreesPropertyGetDescription
fiftyoneDegreesString * fiftyoneDegreesPropertyGetDescription(fiftyoneDegreesCollection *stringsCollection, fiftyoneDegreesProperty *property, fiftyoneDegreesCollectionItem *item, fiftyoneDegreesException *exception)
Returns the string description of the property using the item provided.
fiftyoneDegreesProperty::urlOffset
const uint32_t urlOffset
The offset in the strings structure to the property URL.
Definition: property.h:107
fiftyoneDegreesProperty::firstValueIndex
const uint32_t firstValueIndex
Index of the first possible value.
Definition: property.h:109
fiftyoneDegreesString
String structure containing its value and size.
Definition: string.h:114
fiftyoneDegreesPropertyValueType
fiftyoneDegreesPropertyValueType
Enum of property types.
Definition: property.h:70
fiftyoneDegreesProperty::show
const byte show
True if the property should be shown in GUIs.
Definition: property.h:97
fiftyoneDegreesProperty::firstMapIndex
const uint32_t firstMapIndex
The first index in the list of maps the property is associated with.
Definition: property.h:112
FIFTYONE_DEGREES_PROPERTY_VALUE_TYPE_INTEGER
Integer.
Definition: property.h:72
FIFTYONE_DEGREES_PROPERTY_VALUE_SINGLE_PRECISION_FLOAT
Single precision floating point value.
Definition: property.h:76
fiftyoneDegreesProperty::descriptionOffset
const uint32_t descriptionOffset
The offset in the strings structure to the property description.
Definition: property.h:103
fiftyoneDegreesProperty::nameOffset
const uint32_t nameOffset
The offset in the strings structure to the property name.
Definition: property.h:101
fiftyoneDegreesProperty::isObsolete
const byte isObsolete
True if the property is obsolete and will be removed from future data sets.
Definition: property.h:95
fiftyoneDegreesPropertyGet
fiftyoneDegreesProperty * fiftyoneDegreesPropertyGet(fiftyoneDegreesCollection *properties, uint32_t index, fiftyoneDegreesCollectionItem *item, fiftyoneDegreesException *exception)
Gets the property at the requested index from the properties collection provided.
fiftyoneDegreesProperty
Property structure containing all the meta data relating to a property.
Definition: property.h:86
fiftyoneDegreesPropertyGetName
fiftyoneDegreesString * fiftyoneDegreesPropertyGetName(fiftyoneDegreesCollection *stringsCollection, fiftyoneDegreesProperty *property, fiftyoneDegreesCollectionItem *item, fiftyoneDegreesException *exception)
Returns the string name of the property using the item provided.
fiftyoneDegreesProperty::isMandatory
const byte isMandatory
True if the property is mandatory and must be provided.
Definition: property.h:90
fiftyoneDegreesProperty::showValues
const byte showValues
True if the values should be shown in GUIs.
Definition: property.h:94
fiftyoneDegreesPropertyGetUrl
fiftyoneDegreesString * fiftyoneDegreesPropertyGetUrl(fiftyoneDegreesCollection *stringsCollection, fiftyoneDegreesProperty *property, fiftyoneDegreesCollectionItem *item, fiftyoneDegreesException *exception)
Returns the string URL of the property using the item provided.
fiftyoneDegreesProperty::categoryOffset
const uint32_t categoryOffset
The offset in the strings structure to the property category.
Definition: property.h:105
fiftyoneDegreesProperty::defaultValueIndex
const uint32_t defaultValueIndex
The default value index for the property.
Definition: property.h:99
fiftyoneDegreesException
Structure used to represent a 51Degrees exception and passed into methods that might generate excepti...
Definition: exceptions.h:116
fiftyoneDegreesPropertyGetByName
fiftyoneDegreesProperty * fiftyoneDegreesPropertyGetByName(fiftyoneDegreesCollection *properties, fiftyoneDegreesCollection *strings, const char *requiredPropertyName, fiftyoneDegreesCollectionItem *item, fiftyoneDegreesException *exception)
Gets the property with the requested name from the properties collection provided.
fiftyoneDegreesPropertyGetValueType
byte fiftyoneDegreesPropertyGetValueType(fiftyoneDegreesCollection *properties, uint32_t index, fiftyoneDegreesException *exception)
Gets the value type for the property at the index in the collection.
FIFTYONE_DEGREES_PROPERTY_VALUE_TYPE_BOOLEAN
Boolean.
Definition: property.h:74
FIFTYONE_DEGREES_PROPERTY_VALUE_TYPE_IP_ADDRESS
Ip Range.
Definition: property.h:79
fiftyoneDegreesProperty::lastValueIndex
const uint32_t lastValueIndex
Index of the last possible value.
Definition: property.h:110
fiftyoneDegreesProperty::mapCount
const uint32_t mapCount
Number of maps the property is associated with.
Definition: property.h:111
fiftyoneDegreesProperty::displayOrder
const byte displayOrder
The order the property should be displayed in relative to other properties.
Definition: property.h:88
fiftyoneDegreesCollection
All the shared methods and fields required by file, memory and cached collections.
Definition: collection.h:408

Generated by doxygen 1.8.15