/* *********************************************************************
 * This Source Code Form is copyright of 51Degrees Mobile Experts Limited.
 * Copyright 2017 51Degrees Mobile Experts Limited, 5 Charlotte Close,
 * Caversham, Reading, Berkshire, United Kingdom RG4 7BY
 *
 * This Source Code Form is the subject of the following patents and patent
 * applications, owned by 51Degrees Mobile Experts Limited of 5 Charlotte
 * Close, Caversham, Reading, Berkshire, United Kingdom RG4 7BY:
 * European Patent No. 2871816;
 * European Patent Application No. 17184134.9;
 * United States Patent Nos. 9,332,086 and 9,350,823; and
 * United States Patent Application No. 15/686,066.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0.
 *
 * If a copy of the MPL was not distributed with this file, You can obtain
 * one at http://mozilla.org/MPL/2.0/.
 *
 * This Source Code Form is "Incompatible With Secondary Licenses", as
 * defined by the Mozilla Public License, v. 2.0.
 ********************************************************************** */

/**
 * \defgroup FiftyOneDegreesFunctions
 * These functions are the core that all 51Degrees
 * C based API's build on. All the detections happen
 * here.
 */
#ifndef FIFTYONEDEGREES_H_INCLUDED
#define FIFTYONEDEGREES_H_INCLUDED

#ifndef FIFTYONEDEGREES_H_PATTERN_INCLUDED
#define FIFTYONEDEGREES_H_PATTERN_INCLUDED
#endif

#ifdef _MSC_VER
#define _INTPTR 0
#endif

#ifdef __cplusplus
#define EXTERNAL extern "C"
#else
#define EXTERNAL
#endif

#ifdef _MSC_VER
/* Needs to be set to __cdecl to prevent optimiser problems */
#define FIFTYONEDEGREES_CALL_CONV __cdecl
#else
#define FIFTYONEDEGREES_CALL_CONV
#endif

#include <stdint.h>
#include <limits.h>
#include <time.h>
#ifndef FIFTYONEDEGREES_NO_THREADING
#include "../threading.h"
#endif

/* Used to represent bytes */
typedef unsigned char byte;

/* Used to return the match method */
typedef enum e_fiftyoneDegrees_MatchMethod {
	NONE,
	EXACT,
	NUMERIC,
	NEAREST,
	CLOSEST
} fiftyoneDegreesMatchMethod;

/* Used to indicate what state the result set is in the User-Agent cache */
typedef enum e_fiftyoneDegrees_Resultset_CacheState {
	ACTIVE_CACHE_LIST_ONLY,
	BOTH_CACHE_LISTS
} fiftyoneDegreesResultsetCacheState;

/* Used to provide the status of the data set initialisation */
typedef enum e_fiftyoneDegrees_DataSetInitStatus {
	DATA_SET_INIT_STATUS_SUCCESS, // All okay
	DATA_SET_INIT_STATUS_INSUFFICIENT_MEMORY, // Lack of memory
	DATA_SET_INIT_STATUS_CORRUPT_DATA, // Data structure not readable
	DATA_SET_INIT_STATUS_INCORRECT_VERSION, // Data not the required version
	DATA_SET_INIT_STATUS_FILE_NOT_FOUND, // The data file couldn't be found
	DATA_SET_INIT_STATUS_NOT_SET, // Should never be returned to the caller
	/* Working pointer exceeded the amount of memory containing the data */
	DATA_SET_INIT_STATUS_POINTER_OUT_OF_BOUNDS,
	DATA_SET_INIT_STATUS_NULL_POINTER // A key pointer was not set
} fiftyoneDegreesDataSetInitStatus;

typedef struct fiftyoneDegreesRange_t {
	const int16_t lower;
	const int16_t upper;
} fiftyoneDegreesRange;

/**
 * DATA FILE MAPPED STRUCTURES - DO NOT ALTER
 */

#define FIFTYONE_DEGREES_COMMON_SET_FIELDS \
	/* A pointer to the data set to use for the match */ \
	const fiftyoneDegreesDataSet *dataSet; \
	/* An array of bytes representing the target user agent */ \
	byte *targetUserAgentArray; \
	/* The length of the target user agent */ \
	uint16_t targetUserAgentArrayLength; \
	/* The hash code of the target user agent */ \
	uint64_t targetUserAgentHashCode; \
	/* 0 if the hash code has not been calculated */ \
	byte hashCodeSet; \
	/* The method used to provide the match result */ \
	fiftyoneDegreesMatchMethod method; \
	/* The difference score between the signature found and the target */ \
	int32_t difference; \
	/* The number of root nodes evaluated */ \
	int32_t rootNodesEvaluated; \
	/* The number of strings read */ \
	int32_t stringsRead; \
	/* The number of nodes read during the detection */ \
	int32_t nodesEvaluated; \
	/* The number of signatures read in full and compared to the target */ \
	int32_t signaturesCompared; \
	/* The number of signatures read in full */ \
	int32_t signaturesRead; \
	/* The total number of closest signatures available */ \
	int32_t closestSignatures; \
	/* Pointer to a list of profiles returned for the match */ \
	const fiftyoneDegreesProfile **profiles; \
	/* The number of profiles the match contains */ \
	int32_t profileCount; \
	/* The signature found if only one exists */ \
	byte *signature; \
	/* Pointer to the User-Agent cache associated with the set */ \
	const struct fiftyoneDegrees_resultset_cache_t *cache;

#pragma pack(push, 1)
typedef struct fiftyoneDegrees_ascii_string_t {
	const int16_t length;
	const char firstByte;
} fiftyoneDegreesAsciiString;
#pragma pack(pop)

#pragma pack(push, 1)
typedef struct fiftyoneDegrees_component_t {
	const byte componentId; /* The unique Id of the component. */
	const int32_t nameOffset; /* Offset in the strings data structure to the name */
	const int32_t defaultProfileOffset; /* Offset in the profiles data structure to the default profile */
	const uint16_t httpHeaderCount; /* The number of HTTP header offsets at httpHeaderFirstOffset */
} fiftyoneDegreesComponent;
#pragma pack(pop)

#pragma pack(push, 4)
typedef struct fiftyoneDegrees_map_t {
	const int32_t nameOffset; /* Offset in the strings data structure to the name */
} fiftyoneDegreesMap;
#pragma pack(pop)

#pragma pack(push, 2)
typedef struct fiftyoneDegrees_node_numeric_index_t {
	const int16_t value; /* The numeric value of the index */
	const int32_t relatedNodeOffset; /* The node offset which the numeric value relates to */
} fiftyoneDegreesNodeNumericIndex;
#pragma pack(pop)

#pragma pack(push, 4)
typedef union fiftyoneDegrees_node_index_value_t {
	const byte characters[4]; /* If not a string the characters to be used */
	const int32_t integer; /* If a string the offset in the strings data structure of the characters */
} fiftyoneDegreesNodeIndexValue;
#pragma pack(pop)

#pragma pack(push, 1)
typedef struct fiftyoneDegrees_node_index_t {
	const int32_t relatedNodeOffset; /* The node offset which the value relates to. Must be converted to absolute value. */
	union {
		const byte characters[4];
		const int32_t integer;
	} value; /* The value of the index as either an integer or character array */
} fiftyoneDegreesNodeIndex;
#pragma pack(pop)

#pragma pack(push, 2)
typedef struct fiftyoneDegrees_string_t {
	byte* value;
	int16_t length;
} fiftyoneDegreesString;
#pragma pack(pop)

typedef struct fiftyoneDegrees_strings_t {
	const fiftyoneDegreesString *firstString;
	const int32_t count;
} fiftyoneDegreesStrings;

#pragma pack(push, 2)
typedef struct fiftyoneDegrees_node_t {
	const int16_t position;
	const int16_t nextCharacterPosition;
	const int32_t parentOffset;
	const int32_t characterStringOffset;
	const int16_t childrenCount;
	const int16_t numericChildrenCount;
	const uint16_t signatureCount;
} fiftyoneDegreesNode;
#pragma pack(pop)

#pragma pack(push, 4)
typedef struct fiftyoneDegrees_profile_offset_t {
	const int32_t profileId; /* The unique Id of the profile */
	const int32_t offset; /* Offset to the profile in the profiles structure */
} fiftyoneDegreesProfileOffset;
#pragma pack(pop)

#pragma pack(push, 1)
typedef struct property_t {
	const byte componentIndex; /* Index of the component */
	const byte displayOrder; /* The order the property should be displayed in relative to other properties */
	const byte isMandatory; /* True if the property is mandatory and must be provided */
	const byte isList; /* True if the property is a list can return multiple values */
	const byte showValues; /* True if the values should be shown in GUIs */
	const byte isObsolete; /* True if the property is obsolete and will be removed from future data sets */
	const byte show; /* True if the property should be shown in GUIs */
	const byte valueType; /* The type of value the property represents */
	const int32_t defaultValueIndex; /* The default value index for the property */
	const int32_t nameOffset; /* The offset in the strings structure to the property name */
	const int32_t descriptionOffset; /* The offset in the strings structure to the property description */
	const int32_t categoryOffset; /* The offset in the strings structure to the property category */
	const int32_t urlOffset; /* The offset in the strings structure to the property URL */
	const int32_t firstValueIndex; /* Index of the first possible value */
	const int32_t lastValueIndex; /* Index of the last possible value */
	const int32_t mapCount; /* Number of maps the property is associated with */
	const int32_t firstMapIndex; /* The first index in the list of maps the property is associated with */
} fiftyoneDegreesProperty;
#pragma pack(pop)

#pragma pack(push, 2)
typedef struct fiftyoneDegrees_value_t {
	const int16_t propertyIndex; /* Index of the property the value relates to */
	const int32_t nameOffset; /* The offset in the strings structure to the value name */
	const int32_t descriptionOffset; /* The offset in the strings structure to the value description */
	const int32_t urlOffset; /* The offset in the strings structure to the value URL */
} fiftyoneDegreesValue;
#pragma pack(pop)

#pragma pack(push, 1)
typedef struct fiftyoneDegrees_profile_t {
	const byte componentIndex;
	const int32_t profileId;
	const int32_t valueCount;
	const int32_t signatureCount;
} fiftyoneDegreesProfile;
#pragma pack(pop)

#pragma pack(push, 2)
typedef struct fiftyoneDegrees_date_t {
	const int16_t year;
	const byte month;
	const byte day;
} fiftyoneDegreesDate;
#pragma pack(pop)

#pragma pack(push, 4)
typedef struct fiftyoneDegrees_entity_header_t {
	const int32_t startPosition; /* Start position in the data file of the entities */
	const int32_t length; /* Length in bytes of all the entities */
	const int32_t count; /* Number of entities in the collection */
} fiftyoneDegreesEntityHeader;
#pragma pack(pop)

#pragma pack(push, 2)
typedef struct fiftyoneDegrees_numeric_node_state {
	int32_t target;
	const fiftyoneDegreesNode *node;
	const fiftyoneDegreesNodeNumericIndex *firstNodeNumericIndex;
	const fiftyoneDegreesRange *range;
	int32_t startIndex;
	int32_t lowIndex;
	int32_t highIndex;
	byte lowInRange;
	byte highInRange;
} fiftyoneDegreesNumericNodeState;
#pragma pack(pop)

#pragma pack(push, 1)
typedef struct fiftyoneDegrees_dataset_header_t {
	const int32_t versionMajor;
	const int32_t versionMinor;
	const int32_t versionBuild;
	const int32_t versionRevision;
	const byte tag[16];
	const byte exportTag[16];
	const int32_t copyrightOffset;
	const int16_t age;
	const int32_t minUserAgentCount;
	const int32_t nameOffset;
	const int32_t formatOffset;
	const fiftyoneDegreesDate published;
	const fiftyoneDegreesDate nextUpdate;
	const int32_t deviceCombinations;
	const int16_t maxUserAgentLength;
	const int16_t minUserAgentLength;
	const char lowestCharacter;
	const char highestCharacter;
	const int32_t maxSignatures;
	const int32_t signatureProfilesCount;
	const int32_t signatureNodesCount;
	const int16_t maxValues;
	const int32_t csvBufferLength;
	const int32_t jsonBufferLength;
	const int32_t xmlBufferLength;
	const int32_t maxSignaturesClosest;
	const int32_t maxRank;
	const fiftyoneDegreesEntityHeader strings;
	const fiftyoneDegreesEntityHeader components;
	const fiftyoneDegreesEntityHeader maps;
	const fiftyoneDegreesEntityHeader properties;
	const fiftyoneDegreesEntityHeader values;
	const fiftyoneDegreesEntityHeader profiles;
	const fiftyoneDegreesEntityHeader signatures;
	const fiftyoneDegreesEntityHeader signatureNodeOffsets;
	const fiftyoneDegreesEntityHeader nodeRankedSignatureIndexes;
	const fiftyoneDegreesEntityHeader rankedSignatureIndexes;
	const fiftyoneDegreesEntityHeader nodes;
	const fiftyoneDegreesEntityHeader rootNodes;
	const fiftyoneDegreesEntityHeader profileOffsets;
} fiftyoneDegreesDataSetHeader;
#pragma pack(pop)

#pragma pack(push, 1)
typedef struct fiftyoneDegrees_signature_t {
	const byte nodeCount;
	const int32_t firstNodeOffsetIndex;
	const int32_t rank;
	const byte flags;
} fiftyoneDegreesSignature;
#pragma pack(pop)

/**
 * OPERATIONAL DATA STRUCTURES
 */

#pragma pack(push, 4)
typedef struct fiftyoneDegrees_http_header_t {
	int32_t headerNameOffset; /* Offset to the string with the header name */
	const char *headerName; /* Pointer to the header name string information */
} fiftyoneDegreesHttpHeader;
#pragma pack(pop)

typedef struct fiftyoneDegrees_profile_struct_t {
	int32_t count;
	fiftyoneDegreesProfile **profiles;
	int32_t *indexes;
} fiftyoneDegreesProfilesStruct;

typedef struct fiftyoneDegrees_profile_index_struct_t {
	int32_t count;
	int32_t *indexes;
} fiftyoneDegreesProfileIndexesStruct;

typedef struct fiftyoneDegrees_profile_struct_array_t{
	int32_t initialised;
	fiftyoneDegreesProfileIndexesStruct *profilesStructs;
#ifndef FIFTYONEDEGREES_NO_THREADING
	FIFTYONEDEGREES_MUTEX lock;
#endif
} fiftyoneDegreesProfilesStructArray;

#pragma pack(push, 1)
typedef struct fiftyoneDegrees_dataset_t {
	const fiftyoneDegreesDataSetHeader header;
	const void* memoryToFree; /* Pointer to the memory space allocated to the data set which will be free when the data set is freed if set */
	int32_t sizeOfSignature; /* The length in bytes of each signature record */
	int32_t signatureStartOfStruct; /* The number of bytes to ignore before the signature structure is found */
	const fiftyoneDegreesProperty **requiredProperties; /* Pointer to properties to be returned */
	int32_t requiredPropertyCount; /* Number of properties to return */
	const byte *strings;
	const byte *componentsData;
	const fiftyoneDegreesComponent **components;
	const fiftyoneDegreesMap *maps;
	const fiftyoneDegreesProperty *properties;
	const fiftyoneDegreesValue *values;
	const byte *profiles;
	const byte *signatures;
	const int32_t *signatureNodeOffsets;
	const int32_t *nodeRankedSignatureIndexes;
	const int32_t *rankedSignatureIndexes;
	const byte *nodes;
	const fiftyoneDegreesNode **rootNodes; /* Array of root nodes equal to the size of the max user agent length */
	const fiftyoneDegreesProfileOffset *profileOffsets;
	int32_t httpHeadersCount; /* Number of unique HTTP headers in the array */
	fiftyoneDegreesHttpHeader *httpHeaders; /* Array of HTTP headers the data set can process */
	const char **prefixedUpperHttpHeaders; /* Array of HTTP header strings in upper case form prefixed with HTTP_ */
	fiftyoneDegreesProfilesStructArray *valuePointersArray;
	int32_t *maxPropertyValueLength;
	const char *fileName; /* Path to the data file used to create the data set */
} fiftyoneDegreesDataSet;
#pragma pack(pop)

typedef struct fiftyoneDegrees_linked_signature_list_item_t {
	struct fiftyoneDegrees_linked_signature_list_item_t *next;
	struct fiftyoneDegrees_linked_signature_list_item_t *previous;
	int32_t rankedSignatureIndex;
	int32_t frequency;
} fiftyoneDegreesLinkedSignatureListItem;

typedef struct fiftyoneDegrees_linked_signature_list_t {
	const fiftyoneDegreesLinkedSignatureListItem *items; /* List of signatures that are being evaluated by Closest match */
	fiftyoneDegreesLinkedSignatureListItem *first; /* Pointer to the first signature in the linked list */
	fiftyoneDegreesLinkedSignatureListItem *last; /* Pointer to the last signature in the linked list */
	int32_t count; /* The number of signatures pointed to by signatures */
	fiftyoneDegreesLinkedSignatureListItem *current; /* Pointer to the current item in the list when navigating */
} fiftyoneDegreesLinkedSignatureList;

#pragma pack(push, 1)
typedef struct fiftyoneDegrees_resultset_t {
	FIFTYONE_DEGREES_COMMON_SET_FIELDS
	struct fiftyoneDegrees_resultset_t *listPrevious; /* The previous item in the linked list, or NULL if first */
	struct fiftyoneDegrees_resultset_t *listNext; /* The next item in the linked list, or NULL if last */
	struct fiftyoneDegrees_resultset_t *treeParent; /* Pointer to the parent item, or NULL if the root */
	struct fiftyoneDegrees_resultset_t *treeLeft; /* Pointer to the item to the left of this one, or NULL if none */
	struct fiftyoneDegrees_resultset_t *treeRight; /* Pointer to the item to the right of this one, or NULL if none */
	byte colour; /* The colour of the resultset in the red black tree */
} fiftyoneDegreesResultset;
#pragma pack(pop)

#pragma pack(push, 4)
typedef struct fiftyoneDegrees_resultset_cache_t {
	const fiftyoneDegreesDataSet *dataSet; /* A pointer to the data set to use with the User-Agent cache */
	const fiftyoneDegreesResultset *resultSets; /* Pointer to the array of result sets */
	const byte *targetUserAgentArrays; /* Pointer to memory used to store target user agents */
	const fiftyoneDegreesProfile **profiles; /* Pointer to memory used to store profile pointers */
	fiftyoneDegreesResultset *listFirst; /* Pointer to the first resultset in the linked list */
	fiftyoneDegreesResultset *listLast; /* Pointer to the last resultset in the linked list */
	fiftyoneDegreesResultset root; /* Root resultset of the red black tree */
	fiftyoneDegreesResultset empty; /* Empty resultset - set to black */
	int32_t total; /* Capacity of the User-Agent cache */
	int32_t allocated; /* Number of resultsets currently used in the User-Agent cache */
	int32_t hits; /* The number of times a User-Agent was found in the cache */
	int32_t misses; /* The number of times a User-Agent was not found in the cache */
	int32_t switches; /* Always xero and no longer used */
	int32_t maxIterations; /* The maximum number of iterations needed to fetch */
#ifndef FIFTYONEDEGREES_NO_THREADING
	FIFTYONEDEGREES_MUTEX lock; /* Used to lock access to the User-Agent cache */
#endif
} fiftyoneDegreesResultsetCache;
#pragma pack(pop)

#pragma pack(push, 4)
typedef struct fiftyoneDegrees_http_header_workset_t {
	fiftyoneDegreesHttpHeader *header; /* Pointer to information about the header name and offset */
	const char *headerValue; /* Pointer to the header value */
	int headerValueLength; /* The length of the header value */
} fiftyoneDegreesHttpHeaderWorkset;
#pragma pack(pop)

#pragma pack(push, 4)
typedef struct fiftyoneDegrees_workset_pool_t fiftyoneDegreesWorksetPool;
#pragma pack(pop)

#pragma pack(push, 1)
typedef struct fiftyoneDegrees_workset_t {
	FIFTYONE_DEGREES_COMMON_SET_FIELDS
	const fiftyoneDegreesValue **values; /* Pointers to values associated with the property requested */
	int32_t valuesCount; /* Number of values available */
	char *input; /* An input buffer large enough to store the User-Agent to be matched */
	char *targetUserAgent; /* A pointer to the user agent string */
	char *relevantNodes; /* Pointer to a char array containing the relevant nodes */
	char *closestNodes; /* Pointer to a char array containing the closest nodes */
	char *signatureAsString; /* The signature as a string */
	char *tempheaderlowercase; /* temp variable to store HTTP header name */
	const fiftyoneDegreesNode **nodes; /* Pointer to a list of nodes related to the match */
	const fiftyoneDegreesNode **orderedNodes; /* Pointer to a list of nodes in ascending order of signature count */
	int32_t nodeCount; /* The number of nodes referenced by **nodes */
	int32_t closestNodeRankedSignatureIndex; /* If a single node is returned the index of the ranked signature to be processed */
	fiftyoneDegreesLinkedSignatureList linkedSignatureList; /* Linked list of signatures used by Closest match */
	int16_t nextCharacterPositionIndex;
	byte startWithInitialScore; /* True if the NEAREST and CLOSEST methods should start with an initial score */
	int(*functionPtrGetScore)(struct fiftyoneDegrees_workset_t *ws, const fiftyoneDegreesNode *node); /* Returns scores for each different node between signature and match */
	const byte* (*functionPtrNextClosestSignature)(struct fiftyoneDegrees_workset_t *ws); /* Returns the next closest signature */
	const fiftyoneDegreesProfile **tempProfiles; /* Pointer to a list of working profiles used during a multi header match */
	int32_t importantHeadersCount; /* Number of elements included in the important headers array */
	fiftyoneDegreesHttpHeaderWorkset *importantHeaders; /* Array of headers that are available and are important to detection */
	const fiftyoneDegreesWorksetPool *associatedPool; /* The pool the workset is associated with */
} fiftyoneDegreesWorkset;
#pragma pack(pop)

#pragma pack(push, 4)
typedef struct fiftyoneDegrees_provider_t fiftyoneDegreesProvider;
#pragma pack(pop)

#pragma pack(push, 4)
struct fiftyoneDegrees_workset_pool_t {
	const fiftyoneDegreesDataSet *dataSet; /* Pointer to the dataset the pool relates to */
	fiftyoneDegreesResultsetCache *cache; /* Pointer to the User-Agent cache to be used by the worksets */
	const fiftyoneDegreesProvider *provider; /* Provider the pool is associated with, or NULL if not */
	int32_t size; /* The maximum number of worksets the pool can contain */
	int32_t available; /* The number of worksets that are available in the pool */
	fiftyoneDegreesWorkset **worksets; /* Pointer to the array of work sets */
#ifndef FIFTYONEDEGREES_NO_THREADING
	FIFTYONEDEGREES_SIGNAL *signalPtr; /* Pointer to the signal inidicating a work set has been returned to the pool */
	FIFTYONEDEGREES_MUTEX *lockPtr; /* Pointer to the lock used to limit access to the pool */
	FIFTYONEDEGREES_SIGNAL signal; /* Signals when a work set is back in the pool */
	FIFTYONEDEGREES_MUTEX lock; /* Used to limit access to the pool */
#endif
};
#pragma pack(pop)

#pragma pack(push, 4)
struct fiftyoneDegrees_provider_t {
#ifndef FIFTYONEDEGREES_NO_THREADING
	volatile fiftyoneDegreesWorksetPool *activePool;
	FIFTYONEDEGREES_SIGNAL signal; /* Signals when a work set is back in the pool */
	FIFTYONEDEGREES_MUTEX lock; /* Used to lock critical regions where mutable variables are written to */
#else
	fiftyoneDegreesWorksetPool *activePool;
#endif
};
#pragma pack(pop)

/**
 * \cond
 * EXTERNAL METHODS
 * \endcond
 */

/**
 * \ingroup FiftyOneDegreesFunctions
 * Initialises the provider passed to the method with a data set initialised
 * from the file provided. If required properties is provided the associated
 * data set will only return properties contained in the array.
 * @param fileName of the data source to use for initialisation
 * @param provider pointer to the work set pool to be initialised
 * @param properties array of strings containing the property names
 * @param count the number of elements in the requiredProperties array
 * @param poolSize number of work sets to hold in the pool
 * @param cacheSize maximum number of items that the User-Agent cache should store
 * @return fiftyoneDegreesDataSetInitStatus indicating the result of creating
 *		   the new dataset, pool and cache. If status is anything other than
 *		   DATA_SET_INIT_STATUS_SUCCESS, then the initialization has failed.
 */
EXTERNAL fiftyoneDegreesDataSetInitStatus fiftyoneDegreesInitProviderWithPropertyArray(
	const char *fileName,
	fiftyoneDegreesProvider *provider,
	const char** properties,
	int32_t count,
	int poolSize,
	int cacheSize);

/**
 * \ingroup FiftyOneDegreesFunctions
 * Initialises the provider passed to the method with a data set initialised
 * from the file provided. If required properties is provided the associated
 * data set will only return properties contained between separators.
 * @param fileName of the data source to use for initialisation
 * @param provider pointer to the work set pool to be initialised
 * @param properties char array to the separated list of properties
 *        the dataSet can return
 * @param poolSize number of work sets to hold in the pool
 * @param cacheSize maximum number of items that the User-Agent cache should store
 * @return fiftyoneDegreesDataSetInitStatus indicating the result of creating
 *		   the new dataset, pool and cache. If status is anything other than
 *		   DATA_SET_INIT_STATUS_SUCCESS, then the initialization has failed.
 */
EXTERNAL fiftyoneDegreesDataSetInitStatus fiftyoneDegreesInitProviderWithPropertyString(
	const char *fileName,
	fiftyoneDegreesProvider *provider,
	const char* properties,
	int poolSize,
	int cacheSize);


/**
 * \ingroup FiftyOneDegreesFunctions
 * Creates a new dataset, work set pool and User-Agent cache using the same
 * configuration options as the current data set, pool and cache associated
 * with the provider. The original file location is used to create the new data
 * set.
 * The exisitng data set, pool and cache are marked to be freed if worksets are
 * being used by other threads, or if no work sets are in use they are freed
 * immediately.
 * @param provider pointer to the provider whose data set should be reloaded
 * @return fiftyoneDegreesDataSetInitStatus indicating the result of the reload
 * 	   operation.
 */
EXTERNAL fiftyoneDegreesDataSetInitStatus fiftyoneDegreesProviderReloadFromFile(
	fiftyoneDegreesProvider *provider);

/**
 * \ingroup FiftyOneDegreesFunctions
 * Creates a new dataset, work set pool and User-Agent cache using the same
 * configuration options as the current data set, pool and cache associated
 * with the provider. The memory located at the source pointer is used to
 * create the new data set.
 * The exisitng data set, pool and cache are marked to be freed if worksets are
 * being used by other threads, or if no work sets are in use they are freed
 * immediately.
 * Important: The memory pointed to by source will NOT be freed by 51Degrees
 * when the associated data set is freed. The caller is responsible for
 * releasing the memory. If 51Degrees should release the memory then the
 * caller should set the memoryToFree field of the data set associated with
 * the returned pool to source. 51Degrees will then free this memory when the
 * pool, data set and cache are freed after the last work set is returned to
 * the pool.
 * @param provider pointer to the provider whose data set should be reloaded
 * @param provider pointer to the provider whose data set should be reloaded.
 * @param length number of bytes that the file occupies in memory.
 * @return fiftyoneDegreesDataSetInitStatus indicating the result of the reload
 * 	   operation.
 */
EXTERNAL fiftyoneDegreesDataSetInitStatus fiftyoneDegreesProviderReloadFromMemory(
	fiftyoneDegreesProvider *provider,
	void *source,
	long length);

/**
 * \ingroup FiftyOneDegreesFunctions
 * Releases all the resources used by the provider. The provider can not be
 * used without being reinitialised after calling this method.
 * @param provider pointer to the provider to be freed
 */
EXTERNAL void fiftyoneDegreesProviderFree(fiftyoneDegreesProvider *provider);

/**
 * \ingroup FiftyOneDegreesFunctions
 * Retrieves a work set from the pool associated with the provider. In multi
 * threaded operation will always return a work set. In single threaded
 * operation may return NULL if no work sets are available in the pool.
 * The work set returned must be released back to the provider by calling
 * fiftyoneDegreesWorksetRelease when finished with.
 * @param provider pointer to the provider to return the work set from
 * @return pointer to a work set ready to be used for device detection
 */
EXTERNAL fiftyoneDegreesWorkset* fiftyoneDegreesProviderWorksetGet(
	fiftyoneDegreesProvider *provider);

/**
 * \ingroup FiftyOneDegreesFunctions
 * Returns the work set back to the pool it was created from.
 * Worksets created without a pool should be freed using the method
 * fiftyoneDegreesWorksetFree.
 * @param ws a workset that was created from a pool or provider.
 */
 EXTERNAL void fiftyoneDegreesWorksetRelease(fiftyoneDegreesWorkset *ws);

/**
 * \ingroup FiftyOneDegreesFunctions
 * Initialises the data set passed to the method with the data from
 * the file provided. If required properties is provided the data set
 * will only return those contained in the array.
 * @param fileName of the data source to use for initialisation
 * @param dataSet pointer that will be set to the data set created
 * @param properties array of strings containing the property names
 * @param count the number of elements in the properties array
 * @return fiftyoneDegreesDataSetInitStatus indicating the result of creating
 *		   the new dataset, work set pool and User-Agent cache. If status is
 *         anything other than DATA_SET_INIT_STATUS_SUCCESS, then the
 *         initialization has failed.
 */
EXTERNAL fiftyoneDegreesDataSetInitStatus fiftyoneDegreesInitWithPropertyArray(
	const char *fileName,
	fiftyoneDegreesDataSet *dataSet,
	const char** properties,
	int32_t count);

/**
 * \ingroup FiftyOneDegreesFunctions
 * Initialises the data set passed to the method with the data from
 * the file provided. If required properties is provided the data set
 * will only return those listed and separated by comma, pipe, space
 * or tab.
 * @param fileName of the data source to use for initialisation
 * @param dataSet pointer that will be set to the data set created
 * @param properties char array to the separated list of properties
 *        the dataSet can return
 * @return fiftyoneDegreesDataSetInitStatus indicating the result of creating
 *		   the new dataset, work set pool and User-Agent cache. If status is
 *         anything other than DATA_SET_INIT_STATUS_SUCCESS, then the
 *         initialization has failed.
 */
EXTERNAL fiftyoneDegreesDataSetInitStatus fiftyoneDegreesInitWithPropertyString(
	const char *fileName,
	fiftyoneDegreesDataSet *dataSet,
	const char* properties);

/**
 * \ingroup FiftyOneDegreesFunctions
 * Destroys the data set releasing all memory available. Ensure all work sets,
 * cache and pool structs are freed prior to calling this method.
 * @param dataSet pointer to the data set being destroyed
 */
EXTERNAL void fiftyoneDegreesDataSetFree(const fiftyoneDegreesDataSet *dataSet);

/**
 * \ingroup FiftyOneDegreesFunctions
 * Creates a new User-Agent cache used to speed up duplicate detections.
 * The cache must be destroyed with the fiftyoneDegreesFreeCache method.
 * If the cache size is lower then 2 then no cache is created.
 * @param dataSet pointer to the data set
 * @param size maximum number of items that the cache should store
 * @returns a pointer to the resultset cache created, or NULL
 */
EXTERNAL fiftyoneDegreesResultsetCache *fiftyoneDegreesResultsetCacheCreate(
	const fiftyoneDegreesDataSet *dataSet,
	int32_t size);

/**
 * \ingroup FiftyOneDegreesFunctions
 * Releases the memory used by the User-Agent cache.
 * @param pointer to the cache created previously
 */
EXTERNAL void fiftyoneDegreesResultsetCacheFree(
	const fiftyoneDegreesResultsetCache *rsc);

/**
 * \ingroup FiftyOneDegreesFunctions
 * Creates a new work set pool for the data set and User-Agent cache provided.
 * @param dataset pointer to a data set structure
 * @param cache pointer to a User-Agent cache, or NULL if no cache to be used
 * @param size number of work sets to hold in the pool
 * @return a pointer to a new work set pool
 */
EXTERNAL fiftyoneDegreesWorksetPool *fiftyoneDegreesWorksetPoolCreate(
	fiftyoneDegreesDataSet *dataSet,
	fiftyoneDegreesResultsetCache *cache,
	int32_t size);

/**
 * \ingroup FiftyOneDegreesFunctions
 * Frees all work sets in the pool and releases all memory. Ensure all work sets
 * have been released back to the pool before calling this method.
 * @param pool pointer to the pool created by fiftyoneDegreesWorksetPoolCreate
 */
EXTERNAL void fiftyoneDegreesWorksetPoolFree(
	const fiftyoneDegreesWorksetPool *pool);

/**
 * \ingroup FiftyOneDegreesFunctions
 * Frees the work set pool and it's associated User-Agent cache and dataset if
 * set.
 * @param pool pointer to the pool created by fiftyoneDegreesWorksetPoolCreate
 */
EXTERNAL void fiftyoneDegreesWorksetPoolCacheDataSetFree(
	const fiftyoneDegreesWorksetPool *pool);

/**
 * \ingroup FiftyOneDegreesFunctions
 * Gets a work set from the pool. When operating in multi threaded mode the
 * methods waits for a work set to be returned from another thread. If in
 * single threaded operation NULL will be returned if the pool is exhausted.
 * Using a pool makes less sense in single threaded operation.
 * @param pool pointer to the work set pool to get the work set from
 * @returns pointer to a work set that is free and ready for use, or NULL if
 *          none are available.
 */
EXTERNAL fiftyoneDegreesWorkset *fiftyoneDegreesWorksetPoolGet(
	fiftyoneDegreesWorksetPool *pool);

/**
 * \ingroup FiftyOneDegreesFunctions
 * Creates a new workset to perform matches using the dataset provided.
 * The workset must be destroyed using the freeWorkset method when it's
 * finished with to release memory.
 * @param dataSet pointer to the data set
 * @param cache pointer or NULL if not used
 * @returns a pointer to the workset created
 */
EXTERNAL fiftyoneDegreesWorkset* fiftyoneDegreesWorksetCreate(
	const fiftyoneDegreesDataSet *dataSet,
	const fiftyoneDegreesResultsetCache *cache);

/**
 * \ingroup FiftyOneDegreesFunctions
 * Releases the memory used by the workset.
 * If the work set is associated with a pool then the
 * fiftyOneDegreesWorksetRelease method should be used to return the workset
 * to the pool its associated with.
 * @param pointer to the workset created previously
 */
EXTERNAL void fiftyoneDegreesWorksetFree(
	const fiftyoneDegreesWorkset *ws);

/**
 * \ingroup FiftyOneDegreesFunctions
 * Allocates memory sufficiently large to store JSON results.
 * @param ws pointer to a workset with the results to return in JSON
 * @returns pointer to memory space to store JSON results
 */
EXTERNAL char* fiftyoneDegreesJSONCreate(fiftyoneDegreesWorkset *ws);

/**
 * \ingroup FiftyOneDegreesFunctions
 * Frees the memory space previously allocated by fiftyoneDegreesJSONCreate.
 * @param json pointer to the memory space to be freed
 */
EXTERNAL void fiftyoneDegreesJSONFree(void* json);

/**
 * \ingroup FiftyOneDegreesFunctions
 * Allocates memory sufficiently large to store CSV results.
 * @param ws pointer to a workset with the results to return in CSV
 * @returns pointer to memory space to store CSV results
 */
EXTERNAL char* fiftyoneDegreesCSVCreate(fiftyoneDegreesWorkset *ws);

/**
 * \ingroup FiftyOneDegreesFunctions
 * Frees the memory space previously allocated by fiftyoneDegreesCSVCreate.
 * @param csv pointer to the memory space to be freed
 */
EXTERNAL void fiftyoneDegreesCSVFree(void* csv);

/**
 * \ingroup FiftyOneDegreesFunctions
 * Main entry method used for perform a match. First the User-Agent cache is
 * checked to determine if the User-Agent has already been found. If not then
 * detection is performed. The cache is then updated before the resultset is
 * returned.
 * @param ws pointer to a work set to be used for the match created via
 *        createWorkset function
 * @param userAgent pointer to the target user agent
 */
EXTERNAL void fiftyoneDegreesMatch(
	fiftyoneDegreesWorkset *ws,
	const char* userAgent);

/**
 * \ingroup FiftyOneDegreesFunctions
 * Passed array of HTTP header names and values. Sets the workset to
 * the results for these headers.
 * @param ws pointer to a work set to be used for the match created via
 *        createWorkset function
 * @param httpHeaderNames array of HTTP header names i.e. User-Agent
 * @param httpHeaderValues array of HTTP header values
 * @param the number of entires in each array
 */
EXTERNAL void fiftyoneDegreesMatchWithHeadersArray(
	fiftyoneDegreesWorkset *ws,
	const char **httpHeaderNames,
	const char **httpHeaderValues,
	int httpHeaderCount);

/**
 * \ingroup FiftyOneDegreesFunctions
 * Passed a string where each line contains the HTTP header name and value.
 * The first space character seperates the HTTP header name at the beginning of
 * the line and the value.
 * @param ws pointer to a work set to be used for the match created via
 *        createWorkset function
 * @param httpHeaders is a list of HTTP headers and values on each line
 * @param length number of characters in the headers array to consider
 */
EXTERNAL void fiftyoneDegreesMatchWithHeadersString(
	fiftyoneDegreesWorkset *ws,
	const char *httpHeaders,
	size_t length);

/**
 * \ingroup FiftyOneDegreesFunctions
 * Passed a string where each line contains the HTTP header name and value.
 * The first space character and/or colon seperates the HTTP header name
 * at the beginning of the line and the value. Does not perform a device
 * detection. Use fiftyoneDegreesMatchForHttpHeaders to complete a match.
 * @param ws pointer to a work set to have important headers set
 * @param httpHeaders is a list of HTTP headers and values on each line
 * @param length number of characters in the headers array to consider
 */
EXTERNAL int32_t fiftyoneDegreesSetHttpHeaders(
	fiftyoneDegreesWorkset *ws,
	const char *httpHeaders,
	size_t length);

/**
 * \ingroup FiftyOneDegreesFunctions
 * Sets the workset for the important headers included in the workset.
 * @param ws pointer to a work set to be used for the match created via
 *        createWorkset function
 */
EXTERNAL void fiftyoneDegreesMatchForHttpHeaders(fiftyoneDegreesWorkset *ws);

/**
 * \ingroup FiftyOneDegreesFunctions
 * Sets the values associated with the require property index in the workset
 * so that an array of values can be read.
 * @param ws pointer to the work set associated with the match
 * @param requiredPropertyIndex index of the property required from the array of
 *        require properties
 * @return the number of values that were set.
 */
EXTERNAL int32_t fiftyoneDegreesSetValues(
	fiftyoneDegreesWorkset *ws,
	int32_t requiredPropertyIndex);

/**
 * \ingroup FiftyOneDegreesFunctions
 * Returns a pointer to the ascii string at the byte offset provided
 * @param dataSet pointer to the data set
 * @param offset to the ascii string required
 * @return a pointer to the AsciiString at the offset
 */
EXTERNAL const fiftyoneDegreesAsciiString* fiftyoneDegreesGetString(
	const fiftyoneDegreesDataSet *dataSet,
	int32_t offset);

/**
 * \ingroup FiftyOneDegreesFunctions
 * Sets the values character array to the values of the required property
 * provided. If the values character array is too small then only the values
 * that can be fitted in are added.
 * @param ws pointer to a workset configured with the match results
 * @param requiredPropertyIndex index of the required property
 * @param values pointer to allocated memory to store the values
 * @param size the size of the values memory
 * @return the number of characters written to the values memory
 */
EXTERNAL int32_t fiftyoneDegreesGetValues(
	fiftyoneDegreesWorkset *ws,
	int32_t requiredPropertyIndex,
	char *values,
	int32_t size);

/**
 * \ingroup FiftyOneDegreesFunctions
 * Returns the name of the value provided.
 * @param dataSet pointer to the data set containing the value
 * @param value pointer whose name is required
 * @return pointer to the char string of the name
 */
EXTERNAL const char* fiftyoneDegreesGetValueName(
	const fiftyoneDegreesDataSet *dataSet,
	const fiftyoneDegreesValue *value);

/**
 * \ingroup FiftyOneDegreesFunctions
 * Returns the name of the property provided.
 * @param dataSet pointer to the data set containing the property
 * @param property pointer whose name is required
 * @return pointer to the char string of the name
 */
EXTERNAL const char* fiftyoneDegreesGetPropertyName(
	const fiftyoneDegreesDataSet *dataSet,
	const fiftyoneDegreesProperty *property);

/**
* \ingroup FiftyOneDegreesFunctions
* Returns whether or not the property is a list property or not as an integer
* i.e. 1=true 0=false, or -1 if the property cannot be found.
* @param dataSet pointer to an initialised dataset.
* @param propertyName pointer to the name of the property required.
* @return 1 if the property can return a list, 0 if not, or -1 if the property
*         does not exist.
*/
EXTERNAL int32_t fiftyoneDegreesGetPropertyIsList(
	const fiftyoneDegreesDataSet *dataSet,
	char *propertyName);

/**
 * \ingroup FiftyOneDegreesFunctions
 * Gets the required property name at the index provided.
 * @param dataset pointer to an initialised dataset
 * @param index of the property required
 * @param propertyName pointer to memory to place the property name
 * @param size of the memory allocated for the name
 * @return the number of bytes written for the property
 */
EXTERNAL int32_t fiftyoneDegreesGetRequiredPropertyName(
	const fiftyoneDegreesDataSet *dataSet,
	int requiredPropertyIndex,
	char *propertyName,
	int size);

/**
 * \ingroup FiftyOneDegreesFunctions
 * Gets the http header name at the index provided.
 * @param dataset pointer to an initialised dataset
 * @param index of the http header required
 * @param httpHeader pointer to memory to place the http header name
 * @param size of the memory allocated for the name
 * @return the number of bytes written for the http header
 */
EXTERNAL int32_t fiftyoneDegreesGetHttpHeaderName(
	const fiftyoneDegreesDataSet *dataSet,
	int httpHeaderIndex,
	char *httpHeader,
	int size);

/**
 * \ingroup FiftyOneDegreesFunctions
 * Returns the name of the header in prefixed upper case form at the index
 * provided, or NULL if the index is not valid.
 * @param dataSet pointer to an initialised dataset
 * @param httpHeaderIndex index of the HTTP header name required
 * @returns name of the header, or NULL if index not valid
 */
EXTERNAL const char* fiftyoneDegreesGetPrefixedUpperHttpHeaderName(
	const fiftyoneDegreesDataSet *dataSet,
	int httpHeaderIndex);

/**
 * \ingroup FiftyOneDegreesFunctions
 * Gets the required property index of the property provided, or -1 if the
 * property is not available in the dataset.
 * @param dataset pointer to an initialised dataset
 * @param propertyName pointer to the name of the property required
 * @return the index of the property, or -1 if the property does not exist
 */
EXTERNAL int32_t fiftyoneDegreesGetRequiredPropertyIndex(
	const fiftyoneDegreesDataSet *dataSet,
	const char *propertyName);

/**
 * \ingroup FiftyOneDegreesFunctions
 * Process the workset results into a CSV string.
 * @param ws pointer to a workset with the results to return in CSV
 * @param csv pointer to memory allocated with fiftyoneDegreesCSVCreate
 */
EXTERNAL int32_t fiftyoneDegreesProcessDeviceCSV(
	fiftyoneDegreesWorkset *ws,
	char* csv);

/**
 * \ingroup FiftyOneDegreesFunctions
 * Process the workset results into a JSON string.
 * @param ws pointer to a workset with the results to return in JSON
 * @param json pointer to memory allocated with fiftyoneDegreesJSONCreate
 */
EXTERNAL int32_t fiftyoneDegreesProcessDeviceJSON(
	fiftyoneDegreesWorkset *ws,
	char* json);

/**
 * \ingroup FiftyOneDegreesFunctions
 * Returns the rank of the signature set in the workset.
 * @param ws pointer to the work set associated with the match
 * @returns the rank of the signature if available, or INT_MAX
 */
EXTERNAL int32_t fiftyoneDegreesGetSignatureRank(fiftyoneDegreesWorkset *ws);

/**
 * \ingroup FiftyOneDegreesFunctions
 * Gets the signature as a string representing relevent user agent characters.
 * @param ws pointer to the work set associated with the match
 * @param signatureAsString pointer to memory to place the signature
 * @param size of the memory allocated for the signature
 * @return the number of bytes written for the signature
 */
EXTERNAL int32_t fiftyoneDegreesGetSignatureAsString(
	fiftyoneDegreesWorkset *ws,
	char *signatureAsString,
	int size);

/**
 * \ingroup FiftyOneDegreesFunctions
 * Gets the device id as a string.
 * @param ws pointer to the work set associated with the match
 * @param deviceId pointer to memory to place the device id
 * @param size of the memory allocated for the device id
 * @return the number of bytes written for the device id
 */
EXTERNAL int32_t fiftyoneDegreesGetDeviceId(
	fiftyoneDegreesWorkset *ws,
	char *deviceId,
	int size);

/**
 * \ingroup FiftyOneDegreesFunctions
 * Sets the workset for the device Id provided.
 * @param ws pointer to the work set associated with the match.
 * @param deviceId string representation of the device id to use for the match.
 */
EXTERNAL void fiftyoneDegreesMatchForDeviceId(
	fiftyoneDegreesWorkset *ws,
	const char *deviceId);

/**
 * \ingroup FiftyOneDegreesFunctions
 * Gets all the profiles within the data set
 * that relate to the supplied property value pair.
 * @param dataSet pointer to a 51Degrees data set.
 * @param propertyName the name of the property to match as a string.
 * @param valueName the name of the property's value to match as a string.
 * @param profilesList a pointer to the profiles structure to filter.
 * @returns fiftyoneDegreesProfilesStruct* pointer to a profiles structure.
 */
EXTERNAL fiftyoneDegreesProfilesStruct *fiftyoneDegreesFindProfiles(
	const fiftyoneDegreesDataSet *dataSet,
	const char *propertyName,
	const char *valueName);

/**
 * \ingroup FiftyOneDegreesFunctions
 * Gets all the profiles within the supplied profiles list
 * that relate to the supplied property value pair.
 * @param dataSet pointer to a 51Degrees data set.
 * @param propertyName the name of the property to match as a string.
 * @param valueName the name of the property's value to match as a string.
 * @param profilesList a pointer to the profiles structure to filter.
 * @returns fiftyoneDegreesProfilesStruct* pointer to a profiles structure.
 */
EXTERNAL fiftyoneDegreesProfilesStruct *fiftyoneDegreesFindProfilesInProfiles(
	const fiftyoneDegreesDataSet *dataSet,
	const char *propertyName,
	const char *valueName,
	fiftyoneDegreesProfilesStruct *profilesList);

/**
 * \ingroup FiftyOneDegreesFunctions
 * Frees a profiles structure returned from either the
 * fiftyoneDegreesFindProfiles or fiftyoneDegreesFindProfilesInProfiles
 * function.
 * @param profiles the profiles list to be freed.
 */
EXTERNAL void fiftyoneDegreesFreeProfilesStruct(
	fiftyoneDegreesProfilesStruct *profiles);

/**
 * \ingroup FiftyOneDegreesFunctions
 * Malloc function, defaults to malloc.
 * @param __size the size of memory to allocate.
 * @returns void* pointer to allocated memory.
 */
EXTERNAL void *(FIFTYONEDEGREES_CALL_CONV *fiftyoneDegreesMalloc)(size_t __size);

/**
 * \ingroup FiftyOneDegreesFunctions
 * Calloc function, defaults to calloc.
 * @param __nmemb the number of elements to allocate.
 * @param __size the size of memory to allocate for each element.
 * @returns void* pointer to allocated memory.
 */
EXTERNAL void *(FIFTYONEDEGREES_CALL_CONV *fiftyoneDegreesCalloc)(size_t __nmemb, size_t __size);

/**
 * \ingroup FiftyOneDegreesFunctions
 * Free function, defaults to free.
 * @param __ptr the pointer to memory to be freed.
 */
EXTERNAL void (FIFTYONEDEGREES_CALL_CONV *fiftyoneDegreesFree)(void *__ptr);

/**
* \ingroup FiftyOneDegreesFunctions
* Calculates the amount of memory that the provider will need to allocate for
* the given data file and initialisation parameters. This should be used with
* the fiftyoneDegreesInitProviderWithPropertyString function.
* NOTE: This function will over estimate by about 10 bytes to account for a
* possible increase in http headers.
* @param fileName the file path of the data file.
* @param properties the comma separated string of properties that will be
* initialised.
* @param poolSize the number of work sets the pool will contain.
* @param cacheSize the size of the User-Agent cache.
* @return size_t the total size in bytes that is needed to initilaise the
* provider with the given parameters.
*/
EXTERNAL size_t fiftyoneDegreesGetProviderSizeWithPropertyString(
	const char *fileName,
	const char *properties,
	int poolSize,
	int cacheSize);

/**
* \ingroup FiftyOneDegreesFunctions
* Calculates the amount of memory that the provider will need to allocate for
* the given data file and initialisation parameters. This should be used with
* the fiftyoneDegreesInitProviderWithPropertyArray function.
* NOTE: This function will over estimate by about 10 bytes to account for a
* possible increase in http headers.
* @param fileName the file path of the data file.
* @param propertyCount the number of properties in the properties array.
* @param poolSize the number of work sets the pool will contain.
* @param cacheSize the size of the User-Agent cache.
* @return size_t the total size in bytes that is needed to initialise the
* provider with the given parameters.
*/
EXTERNAL size_t fiftyoneDegreesGetProviderSizeWithPropertyCount(
	const char *fileName,
	int propertyCount,
	int poolSize,
	int cacheSize);

/**
* \ingroup FiftyOneDegreesFunctions
* Finds the maximum string length of the values associated with the given
* property name.
* @param dataSet pointer to a fiftyoneDegreesDataSet.
* @param propertyName the name of the property to find the value length for.
* @returns int32_t the maximum string length of the values associated with the
* given property or -1 if the property was not found.
*/
EXTERNAL int32_t fiftyoneDegreesGetMaxPropertyValueLength(const fiftyoneDegreesDataSet *dataSet, char *propertyName);

/**
 * OBSOLETE METHODS - RETAINED FOR BACKWARDS COMPAITABILITY
 */

EXTERNAL fiftyoneDegreesWorkset* fiftyoneDegreesCreateWorkset(const fiftyoneDegreesDataSet *dataSet);

EXTERNAL void fiftyoneDegreesFreeWorkset(const fiftyoneDegreesWorkset *ws);

EXTERNAL void fiftyoneDegreesDestroy(const fiftyoneDegreesDataSet *dataSet);

/**
 * \ingroup FiftyOneDegreesFunctions
 * Releases the workset provided back to the pool making it available for future
 * use.
 *
 * The method is obsolete as all worksets now have a pool associated with them
 * which used when returning the work set to the pool.
 *
 * @param pool containing work sets
 * @param ws workset to be placed back on the queue
 */
EXTERNAL void fiftyoneDegreesWorksetPoolRelease(fiftyoneDegreesWorksetPool *pool, fiftyoneDegreesWorkset *ws);

/**
* \ingroup FiftyOneDegreesFunctions
* Determines if the compiled code supports multi threading.
* @return boolean where true means multi threading is supported.
*/
EXTERNAL int fiftyoneDegreesGetIsThreadSafe();

#endif // 51DEGREES_H_INCLUDED