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_STORED_BINARY_VALUE_H_INCLUDED

24#define FIFTYONE_DEGREES_STORED_BINARY_VALUE_H_INCLUDED

25

26#ifdef FIFTYONE_DEGREES_IPI_SYMBOLS

27#include "ipiSymbols.h"

28#endif

29

38

39#include <stdint.h>

40#include <ctype.h>

41#include "exceptions.h"

42#include "collection.h"

43#include "float.h"

44#include "common.h"

45#include "ip.h"

46#include "propertyValueType.h"

47#include "string.h"

48

74#pragma pack(push, 1)

75typedef struct fiftyone_degrees_var_length_byte_array_t {

76 uint16_t size;

77 unsigned char firstByte;

78} fiftyoneDegreesVarLengthByteArray;

79#pragma pack(pop)

80

84#pragma pack(push, 1)

85typedef union fiftyone_degrees_stored_binary_value_t {

86 fiftyoneDegreesString stringValue;

87 fiftyoneDegreesVarLengthByteArray byteArrayValue;

88 fiftyoneDegreesFloat floatValue;

89 int32_t intValue;

90 int16_t shortValue;

91 byte byteValue;

92} fiftyoneDegreesStoredBinaryValue;

93#pragma pack(pop)

94

95#ifndef FIFTYONE_DEGREES_MEMORY_ONLY

96

109EXTERNAL void* fiftyoneDegreesStoredBinaryValueRead(

110 const fiftyoneDegreesCollectionFile *file,

111 const fiftyoneDegreesCollectionKey *key,

112 fiftyoneDegreesData *data,

113 fiftyoneDegreesException *exception);

114

115#endif

116

127EXTERNAL const fiftyoneDegreesStoredBinaryValue* fiftyoneDegreesStoredBinaryValueGet(

128 const fiftyoneDegreesCollection *strings,

129 uint32_t offset,

130 fiftyoneDegreesPropertyValueType storedValueType,

131 fiftyoneDegreesCollectionItem *item,

132 fiftyoneDegreesException *exception);

133

144EXTERNAL int fiftyoneDegreesStoredBinaryValueCompareWithString(

145 const fiftyoneDegreesStoredBinaryValue *value,

146 fiftyoneDegreesPropertyValueType storedValueType,

147 const char *target,

148 fiftyoneDegreesStringBuilder *tempBuilder,

149 fiftyoneDegreesException *exception);

150

159EXTERNAL int fiftyoneDegreesStoredBinaryValueToIntOrDefault(

160 const fiftyoneDegreesStoredBinaryValue *value,

161 fiftyoneDegreesPropertyValueType storedValueType,

162 int defaultValue);

163

172EXTERNAL double fiftyoneDegreesStoredBinaryValueToDoubleOrDefault(

173 const fiftyoneDegreesStoredBinaryValue *value,

174 fiftyoneDegreesPropertyValueType storedValueType,

175 double defaultValue);

176

185EXTERNAL bool fiftyoneDegreesStoredBinaryValueToBoolOrDefault(

186 const fiftyoneDegreesStoredBinaryValue *value,

187 fiftyoneDegreesPropertyValueType storedValueType,

188 bool defaultValue);

189

193

194#endif

fiftyoneDegreesStoredBinaryValueCompareWithString

int fiftyoneDegreesStoredBinaryValueCompareWithString(const fiftyoneDegreesStoredBinaryValue *value, fiftyoneDegreesPropertyValueType storedValueType, const char *target, fiftyoneDegreesStringBuilder *tempBuilder, fiftyoneDegreesException *exception)

Function to compare the current binary value to the target string value using the text format.

fiftyoneDegreesStoredBinaryValueToDoubleOrDefault

double fiftyoneDegreesStoredBinaryValueToDoubleOrDefault(const fiftyoneDegreesStoredBinaryValue *value, fiftyoneDegreesPropertyValueType storedValueType, double defaultValue)

Function to convert the binary value to double when possible.

fiftyoneDegreesStoredBinaryValueToIntOrDefault

int fiftyoneDegreesStoredBinaryValueToIntOrDefault(const fiftyoneDegreesStoredBinaryValue *value, fiftyoneDegreesPropertyValueType storedValueType, int defaultValue)

Function to convert the binary value to int when possible.

fiftyoneDegreesStoredBinaryValueRead

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

Reads a binary value from the source file at the offset within the string structure.

fiftyoneDegreesStoredBinaryValueToBoolOrDefault

bool fiftyoneDegreesStoredBinaryValueToBoolOrDefault(const fiftyoneDegreesStoredBinaryValue *value, fiftyoneDegreesPropertyValueType storedValueType, bool defaultValue)

Function to convert the binary value to bool when possible.

fiftyoneDegreesStoredBinaryValueGet

const fiftyoneDegreesStoredBinaryValue * fiftyoneDegreesStoredBinaryValueGet(const fiftyoneDegreesCollection *strings, uint32_t offset, fiftyoneDegreesPropertyValueType storedValueType, fiftyoneDegreesCollectionItem *item, fiftyoneDegreesException *exception)

Gets the binary value at the required offset from the collection provided.

fiftyoneDegreesFloat

fiftyoneDegreesFloatInternal fiftyoneDegreesFloat

For some compilers such as clang and Microsoft C or computers where the IEEE single precision standar...

Definition float.h:191

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