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

130

131#ifndef FIFTYONE_DEGREES_PROPERTIES_H_INCLUDED

132#define FIFTYONE_DEGREES_PROPERTIES_H_INCLUDED

133

134#ifdef FIFTYONE_DEGREES_IPI_SYMBOLS

135#include "ipiSymbols.h"

136#endif

137

138#include <stdint.h>

139#ifdef _MSC_FULL_VER

140#include <string.h>

141#else

142#include <strings.h>

143#define _stricmp strcasecmp

144#define _strnicmp strncasecmp

145#endif

146#include "string.h"

147#include "list.h"

148#include "data.h"

149#include "collection.h"

150#include "array.h"

151#include "common.h"

152

154#define FIFTYONE_DEGREES_PROPERTIES_SEPARATORS "|, "

155

160typedef uint32_t fiftyoneDegreesEvidencePropertyIndex;

161

162FIFTYONE_DEGREES_ARRAY_TYPE(fiftyoneDegreesEvidencePropertyIndex, )

163

164

168typedef fiftyoneDegreesEvidencePropertyIndexArray fiftyoneDegreesEvidenceProperties;

169

171typedef struct fiftyone_degrees_property_available_t {

172 uint32_t propertyIndex;

174 fiftyoneDegreesCollectionItem name;

175 fiftyoneDegreesEvidenceProperties *evidenceProperties;

179 bool delayExecution;

184 byte componentIndex;

188 int32_t requiredPropertyIndex;

192} fiftyoneDegreesPropertyAvailable;

193

197typedef struct fiftyone_degrees_property_named_t {

198 int32_t availableIndex;

201 const fiftyoneDegreesString *name;

202} fiftyoneDegreesPropertyNamed;

203

204FIFTYONE_DEGREES_ARRAY_TYPE(

205 fiftyoneDegreesPropertyAvailable,

206 bool allComponentsRequired;

211 uint32_t namedCount;

214 fiftyoneDegreesPropertyNamed *named;

219)

220

222typedef fiftyoneDegreesPropertyAvailableArray

223fiftyoneDegreesPropertiesAvailable;

224

229EXTERNAL typedef struct fiftyone_degrees_properties_required_t {

230 const char **array;

233 int count;

234 const char *string;

236 fiftyoneDegreesPropertiesAvailable *existing;

239} fiftyoneDegreesPropertiesRequired;

240

249typedef const fiftyoneDegreesString*(*fiftyoneDegreesPropertiesGetMethod)(

250 void *state,

251 uint32_t index,

252 fiftyoneDegreesCollectionItem *item);

253

267typedef uint32_t(*fiftyoneDegreesEvidencePropertiesGetMethod)(

268 void* state,

269 fiftyoneDegreesPropertyAvailable* property,

270 fiftyoneDegreesEvidenceProperties* evidenceProperties);

271

277EXTERNAL_VAR fiftyoneDegreesPropertiesRequired fiftyoneDegreesPropertiesDefault;

278

299EXTERNAL fiftyoneDegreesPropertiesAvailable* fiftyoneDegreesPropertiesCreate(

300 fiftyoneDegreesPropertiesRequired *properties,

301 void *state,

302 fiftyoneDegreesPropertiesGetMethod getPropertyMethod,

303 fiftyoneDegreesEvidencePropertiesGetMethod getEvidencePropertiesMethod);

304

311EXTERNAL int fiftyoneDegreesPropertiesGetPropertyIndexFromName(

312 fiftyoneDegreesPropertiesAvailable *available,

313 const char *propertyName);

314

325EXTERNAL int fiftyoneDegreesPropertiesGetRequiredPropertyIndexFromName(

326 fiftyoneDegreesPropertiesAvailable *available,

327 const char *propertyName);

328

337EXTERNAL int fiftyoneDegreesPropertiesGetPropertyIndexFromRequiredIndex(

338 fiftyoneDegreesPropertiesAvailable *available,

339 int requiredPropertyIndex);

340

350EXTERNAL fiftyoneDegreesString*

351 fiftyoneDegreesPropertiesGetNameFromRequiredIndex(

352 fiftyoneDegreesPropertiesAvailable *available,

353 int requiredPropertyIndex);

354

358#if defined(_MSC_VER)

359#define FIFTYONE_DEGREES_PROPERTIES_INLINE static __inline

360#elif defined(__GNUC__) || defined(__clang__)

361#define FIFTYONE_DEGREES_PROPERTIES_INLINE static __inline__

362#else

363#define FIFTYONE_DEGREES_PROPERTIES_INLINE static inline

364#endif

365

375FIFTYONE_DEGREES_PROPERTIES_INLINE uint32_t

376 fiftyoneDegreesPropertiesGetRequiredPropertyCount(

377 const fiftyoneDegreesPropertiesAvailable *available) {

378 if (available == NULL) {

379 return 0;

380 }

381 return available->named != NULL ? available->namedCount : available->count;

382}

383

392FIFTYONE_DEGREES_PROPERTIES_INLINE int fiftyoneDegreesPropertiesGetAvailableIndex(

393 const fiftyoneDegreesPropertiesAvailable *available,

394 int requiredPropertyIndex) {

395 if (available == NULL || requiredPropertyIndex < 0) {

396 return -1;

397 }

398 if (available->named != NULL) {

399 return (uint32_t)requiredPropertyIndex < available->namedCount ?

400 (int)available->named[requiredPropertyIndex].availableIndex :

401 -1;

402 }

403 return (uint32_t)requiredPropertyIndex < available->count ?

404 requiredPropertyIndex :

405 -1;

406}

407

415FIFTYONE_DEGREES_PROPERTIES_INLINE int

416 fiftyoneDegreesPropertiesGetAvailableIndexFromName(

417 fiftyoneDegreesPropertiesAvailable *available,

418 const char *propertyName) {

419 return fiftyoneDegreesPropertiesGetAvailableIndex(

420 available,

421 fiftyoneDegreesPropertiesGetRequiredPropertyIndexFromName(

422 available,

423 propertyName));

424}

425

433FIFTYONE_DEGREES_PROPERTIES_INLINE int

434 fiftyoneDegreesPropertiesGetPropertyIndexFromAvailableIndex(

435 const fiftyoneDegreesPropertiesAvailable *available,

436 int availableIndex) {

437 if (available == NULL ||

438 availableIndex < 0 ||

439 (uint32_t)availableIndex >= available->count) {

440 return -1;

441 }

442 return (int)available->items[availableIndex].propertyIndex;

443}

444

451EXTERNAL bool fiftyoneDegreesPropertiesIsSetHeaderAvailable(

452 fiftyoneDegreesPropertiesAvailable* available);

453

459EXTERNAL void fiftyoneDegreesPropertiesFree(

460 fiftyoneDegreesPropertiesAvailable *available);

461

465

466#endif

FIFTYONE_DEGREES_ARRAY_TYPE

#define FIFTYONE_DEGREES_ARRAY_TYPE(t, m)

Simple array structure definition macro used for generic types.

Definition array.h:55

FIFTYONE_DEGREES_PROPERTIES_INLINE

#define FIFTYONE_DEGREES_PROPERTIES_INLINE

The functions below are inline, so they add no name to the library.

Definition properties.h:363

fiftyoneDegreesPropertiesGetRequiredPropertyCount

FIFTYONE_DEGREES_PROPERTIES_INLINE uint32_t fiftyoneDegreesPropertiesGetRequiredPropertyCount(const fiftyoneDegreesPropertiesAvailable *available)

Gets the number of required property indexes, which is the number of names the caller gave,...

Definition properties.h:376

fiftyoneDegreesEvidenceProperties

fiftyoneDegreesEvidencePropertyIndexArray fiftyoneDegreesEvidenceProperties

Array of properties which are required to fetch additional evidence for a specific property.

Definition properties.h:168

fiftyoneDegreesPropertiesGetNameFromRequiredIndex

fiftyoneDegreesString * fiftyoneDegreesPropertiesGetNameFromRequiredIndex(fiftyoneDegreesPropertiesAvailable *available, int requiredPropertyIndex)

Gets the name as a string from the required property index.

fiftyoneDegreesPropertiesGetMethod

const 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:249

fiftyoneDegreesPropertiesGetRequiredPropertyIndexFromName

int fiftyoneDegreesPropertiesGetRequiredPropertyIndexFromName(fiftyoneDegreesPropertiesAvailable *available, const char *propertyName)

Gets the required property index of the property named, which is its place in the names the caller ga...

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:267

fiftyoneDegreesPropertiesGetAvailableIndex

FIFTYONE_DEGREES_PROPERTIES_INLINE int fiftyoneDegreesPropertiesGetAvailableIndex(const fiftyoneDegreesPropertiesAvailable *available, int requiredPropertyIndex)

Gets the available index of the property at the required property index.

Definition properties.h:392

fiftyoneDegreesPropertiesGetPropertyIndexFromAvailableIndex

FIFTYONE_DEGREES_PROPERTIES_INLINE int fiftyoneDegreesPropertiesGetPropertyIndexFromAvailableIndex(const fiftyoneDegreesPropertiesAvailable *available, int availableIndex)

Maps the available index to the index in the source data structure.

Definition properties.h:434

fiftyoneDegreesEvidencePropertyIndex

uint32_t fiftyoneDegreesEvidencePropertyIndex

Index in the properties collection to a property which is required to get evidence for another proper...

Definition properties.h:160

fiftyoneDegreesPropertiesGetPropertyIndexFromRequiredIndex

int fiftyoneDegreesPropertiesGetPropertyIndexFromRequiredIndex(fiftyoneDegreesPropertiesAvailable *available, int requiredPropertyIndex)

Maps the required property index to the index in the source data structure.

fiftyoneDegreesPropertiesAvailable

fiftyoneDegreesPropertyAvailableArray fiftyoneDegreesPropertiesAvailable

Array of properties which are available in a data set.

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.

fiftyoneDegreesPropertiesGetAvailableIndexFromName

FIFTYONE_DEGREES_PROPERTIES_INLINE int fiftyoneDegreesPropertiesGetAvailableIndexFromName(fiftyoneDegreesPropertiesAvailable *available, const char *propertyName)

Gets the available index of the property named.

Definition properties.h:416

fiftyoneDegreesPropertiesIsSetHeaderAvailable

bool fiftyoneDegreesPropertiesIsSetHeaderAvailable(fiftyoneDegreesPropertiesAvailable *available)

Check if the 'SetHeader' properties are included in the available required properties.

fiftyoneDegreesPropertiesCreate

fiftyoneDegreesPropertiesAvailable * fiftyoneDegreesPropertiesCreate(fiftyoneDegreesPropertiesRequired *properties, void *state, fiftyoneDegreesPropertiesGetMethod getPropertyMethod, fiftyoneDegreesEvidencePropertiesGetMethod getEvidencePropertiesMethod)

Creates a properties result instance for use with future property operations.

fiftyoneDegreesPropertiesFree

void fiftyoneDegreesPropertiesFree(fiftyoneDegreesPropertiesAvailable *available)

Frees the memory and resources used by the properties results previously created using the fiftyoneDe...

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:315

fiftyoneDegreesEvidencePropertyIndexArray

Array of items of type fiftyoneDegreesEvidencePropertyIndex used to easily access and track the size ...

Definition properties.h:162

fiftyoneDegreesPropertiesRequired

Defines a set of properties which are required by a caller.

Definition properties.h:229

fiftyoneDegreesPropertiesRequired::count

int count

Number of properties in array.

Definition properties.h:233

fiftyoneDegreesPropertiesRequired::string

const char * string

Separated list of required properties or NULL if all properties are required.

Definition properties.h:234

fiftyoneDegreesPropertiesRequired::existing

fiftyoneDegreesPropertiesAvailable * existing

A pointer to an existing set of property names from another instance.

Definition properties.h:236

fiftyoneDegreesPropertiesRequired::array

const char ** array

Array of required properties or NULL if all properties are required.

Definition properties.h:230

fiftyoneDegreesPropertyAvailableArray

Array of items of type fiftyoneDegreesPropertyAvailable used to easily access and track the size of t...

Definition properties.h:209

fiftyoneDegreesPropertyAvailableArray::named

fiftyoneDegreesPropertyNamed * named

The names the caller gave, in the caller's order, or NULL when the caller named no property.

Definition properties.h:215

fiftyoneDegreesPropertyAvailableArray::count

uint32_t count

Number of used items.

Definition properties.h:209

fiftyoneDegreesPropertyAvailableArray::namedCount

uint32_t namedCount

Number of names the caller gave, which is the number of required property indexes when the caller nam...

Definition properties.h:213

fiftyoneDegreesPropertyAvailableArray::items

fiftyoneDegreesPropertyAvailable * items

Pointer to the first item.

Definition properties.h:209

fiftyoneDegreesPropertyAvailable

Used to access the property item quickly without the need to search.

Definition properties.h:171

fiftyoneDegreesPropertyAvailable::requiredPropertyIndex

int32_t requiredPropertyIndex

Index of the property in the names the caller gave, the first if the name was given more than once.

Definition properties.h:188

fiftyoneDegreesPropertyAvailable::name

fiftyoneDegreesCollectionItem name

Name of the property from strings.

Definition properties.h:174

fiftyoneDegreesPropertyAvailable::propertyIndex

uint32_t propertyIndex

Index of the property in the collection of all properties.

Definition properties.h:172

fiftyoneDegreesPropertyAvailable::delayExecution

bool delayExecution

True if the execution any JavaScript returned as a value of this property should be delayed.

Definition properties.h:179

fiftyoneDegreesPropertyAvailable::componentIndex

byte componentIndex

Index in the data set's component list of the component the property belongs to.

Definition properties.h:184

fiftyoneDegreesPropertyAvailable::evidenceProperties

fiftyoneDegreesEvidenceProperties * evidenceProperties

Evidence properties which are required by this property.

Definition properties.h:175

fiftyoneDegreesPropertyNamed

A property name the caller gave, in the place the caller gave it.

Definition properties.h:197

fiftyoneDegreesPropertyNamed::availableIndex

int32_t availableIndex

Index of the property in the available properties, or -1 when the data does not have the property.

Definition properties.h:198

fiftyoneDegreesPropertyNamed::name

const fiftyoneDegreesString * name

The name as the caller gave it.

Definition properties.h:201

fiftyoneDegreesString

Definition string.h:97