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

133

134#ifndef FIFTYONE_DEGREES_PROPERTIES_H_INCLUDED

135#define FIFTYONE_DEGREES_PROPERTIES_H_INCLUDED

136

137#ifdef FIFTYONE_DEGREES_IPI_SYMBOLS

138#include "ipiSymbols.h"

139#endif

140

141#include <stdint.h>

142#ifdef _MSC_FULL_VER

143#include <string.h>

144#else

145#include <strings.h>

146#define _stricmp strcasecmp

147#define _strnicmp strncasecmp

148#endif

149#include "string.h"

150#include "list.h"

151#include "data.h"

152#include "collection.h"

153#include "array.h"

154#include "common.h"

155

157#define FIFTYONE_DEGREES_PROPERTIES_SEPARATORS "|, "

158

163typedef uint32_t fiftyoneDegreesEvidencePropertyIndex;

164

165FIFTYONE_DEGREES_ARRAY_TYPE(fiftyoneDegreesEvidencePropertyIndex, )

166

167

171typedef fiftyoneDegreesEvidencePropertyIndexArray fiftyoneDegreesEvidenceProperties;

172

174typedef struct fiftyone_degrees_property_available_t {

175 uint32_t propertyIndex;

177 fiftyoneDegreesCollectionItem name;

178 fiftyoneDegreesEvidenceProperties *evidenceProperties;

182 bool delayExecution;

187 byte componentIndex;

191 int32_t requiredPropertyIndex;

197} fiftyoneDegreesPropertyAvailable;

198

202typedef struct fiftyone_degrees_property_named_t {

203 int32_t availableIndex;

206 const fiftyoneDegreesString *name;

207} fiftyoneDegreesPropertyNamed;

208

209FIFTYONE_DEGREES_ARRAY_TYPE(

210 fiftyoneDegreesPropertyAvailable,

211 bool allComponentsRequired;

216 bool namesFromDataSet;

221 uint32_t namedCount;

224 fiftyoneDegreesPropertyNamed *named;

230)

231

233typedef fiftyoneDegreesPropertyAvailableArray

234fiftyoneDegreesPropertiesAvailable;

235

240EXTERNAL typedef struct fiftyone_degrees_properties_required_t {

241 const char **array;

244 int count;

245 const char *string;

247 fiftyoneDegreesPropertiesAvailable *existing;

250} fiftyoneDegreesPropertiesRequired;

251

260typedef const fiftyoneDegreesString*(*fiftyoneDegreesPropertiesGetMethod)(

261 void *state,

262 uint32_t index,

263 fiftyoneDegreesCollectionItem *item);

264

278typedef uint32_t(*fiftyoneDegreesEvidencePropertiesGetMethod)(

279 void* state,

280 fiftyoneDegreesPropertyAvailable* property,

281 fiftyoneDegreesEvidenceProperties* evidenceProperties);

282

288EXTERNAL_VAR fiftyoneDegreesPropertiesRequired fiftyoneDegreesPropertiesDefault;

289

310EXTERNAL fiftyoneDegreesPropertiesAvailable* fiftyoneDegreesPropertiesCreate(

311 fiftyoneDegreesPropertiesRequired *properties,

312 void *state,

313 fiftyoneDegreesPropertiesGetMethod getPropertyMethod,

314 fiftyoneDegreesEvidencePropertiesGetMethod getEvidencePropertiesMethod);

315

322EXTERNAL int fiftyoneDegreesPropertiesGetPropertyIndexFromName(

323 fiftyoneDegreesPropertiesAvailable *available,

324 const char *propertyName);

325

336EXTERNAL int fiftyoneDegreesPropertiesGetRequiredPropertyIndexFromName(

337 fiftyoneDegreesPropertiesAvailable *available,

338 const char *propertyName);

339

348EXTERNAL int fiftyoneDegreesPropertiesGetPropertyIndexFromRequiredIndex(

349 fiftyoneDegreesPropertiesAvailable *available,

350 int requiredPropertyIndex);

351

361EXTERNAL fiftyoneDegreesString*

362 fiftyoneDegreesPropertiesGetNameFromRequiredIndex(

363 fiftyoneDegreesPropertiesAvailable *available,

364 int requiredPropertyIndex);

365

369#if defined(_MSC_VER)

370#define FIFTYONE_DEGREES_PROPERTIES_INLINE static __inline

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

372#define FIFTYONE_DEGREES_PROPERTIES_INLINE static __inline__

373#else

374#define FIFTYONE_DEGREES_PROPERTIES_INLINE static inline

375#endif

376

386FIFTYONE_DEGREES_PROPERTIES_INLINE uint32_t

387 fiftyoneDegreesPropertiesGetRequiredPropertyCount(

388 const fiftyoneDegreesPropertiesAvailable *available) {

389 if (available == NULL) {

390 return 0;

391 }

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

393}

394

403FIFTYONE_DEGREES_PROPERTIES_INLINE int fiftyoneDegreesPropertiesGetAvailableIndex(

404 const fiftyoneDegreesPropertiesAvailable *available,

405 int requiredPropertyIndex) {

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

407 return -1;

408 }

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

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

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

412 -1;

413 }

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

415 requiredPropertyIndex :

416 -1;

417}

418

426FIFTYONE_DEGREES_PROPERTIES_INLINE int

427 fiftyoneDegreesPropertiesGetAvailableIndexFromName(

428 fiftyoneDegreesPropertiesAvailable *available,

429 const char *propertyName) {

430 return fiftyoneDegreesPropertiesGetAvailableIndex(

431 available,

432 fiftyoneDegreesPropertiesGetRequiredPropertyIndexFromName(

433 available,

434 propertyName));

435}

436

444FIFTYONE_DEGREES_PROPERTIES_INLINE int

445 fiftyoneDegreesPropertiesGetPropertyIndexFromAvailableIndex(

446 const fiftyoneDegreesPropertiesAvailable *available,

447 int availableIndex) {

448 if (available == NULL ||

449 availableIndex < 0 ||

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

451 return -1;

452 }

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

454}

455

462EXTERNAL bool fiftyoneDegreesPropertiesIsSetHeaderAvailable(

463 fiftyoneDegreesPropertiesAvailable* available);

464

472EXTERNAL bool fiftyoneDegreesPropertiesRequiredNamesFewerThan(

473 const fiftyoneDegreesPropertiesRequired *properties,

474 uint32_t total);

475

481EXTERNAL void fiftyoneDegreesPropertiesFree(

482 fiftyoneDegreesPropertiesAvailable *available);

483

487

488#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:374

fiftyoneDegreesPropertiesRequiredNamesFewerThan

bool fiftyoneDegreesPropertiesRequiredNamesFewerThan(const fiftyoneDegreesPropertiesRequired *properties, uint32_t total)

Checks whether the properties required name some properties, and fewer than the data file has.

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

fiftyoneDegreesEvidenceProperties

fiftyoneDegreesEvidencePropertyIndexArray fiftyoneDegreesEvidenceProperties

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

Definition properties.h:171

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

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

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

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

fiftyoneDegreesEvidencePropertyIndex

uint32_t fiftyoneDegreesEvidencePropertyIndex

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

Definition properties.h:163

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

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

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

fiftyoneDegreesEvidencePropertyIndexArray

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

Definition properties.h:165

fiftyoneDegreesPropertiesRequired

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

Definition properties.h:240

fiftyoneDegreesPropertiesRequired::count

int count

Number of properties in array.

Definition properties.h:244

fiftyoneDegreesPropertiesRequired::string

const char * string

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

Definition properties.h:245

fiftyoneDegreesPropertiesRequired::existing

fiftyoneDegreesPropertiesAvailable * existing

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

Definition properties.h:247

fiftyoneDegreesPropertiesRequired::array

const char ** array

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

Definition properties.h:241

fiftyoneDegreesPropertyAvailableArray

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

Definition properties.h:215

fiftyoneDegreesPropertyAvailableArray::named

fiftyoneDegreesPropertyNamed * named

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

Definition properties.h:225

fiftyoneDegreesPropertyAvailableArray::namesFromDataSet

bool namesFromDataSet

True when the caller named no property, so the names are those of the first data set loaded.

Definition properties.h:219

fiftyoneDegreesPropertyAvailableArray::count

uint32_t count

Number of used items.

Definition properties.h:215

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

fiftyoneDegreesPropertyAvailableArray::items

fiftyoneDegreesPropertyAvailable * items

Pointer to the first item.

Definition properties.h:215

fiftyoneDegreesPropertyAvailable

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

Definition properties.h:174

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

fiftyoneDegreesPropertyAvailable::name

fiftyoneDegreesCollectionItem name

Name of the property from strings.

Definition properties.h:177

fiftyoneDegreesPropertyAvailable::propertyIndex

uint32_t propertyIndex

Index of the property in the collection of all properties.

Definition properties.h:175

fiftyoneDegreesPropertyAvailable::delayExecution

bool delayExecution

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

Definition properties.h:182

fiftyoneDegreesPropertyAvailable::componentIndex

byte componentIndex

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

Definition properties.h:187

fiftyoneDegreesPropertyAvailable::evidenceProperties

fiftyoneDegreesEvidenceProperties * evidenceProperties

Evidence properties which are required by this property.

Definition properties.h:178

fiftyoneDegreesPropertyNamed

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

Definition properties.h:202

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

fiftyoneDegreesPropertyNamed::name

const fiftyoneDegreesString * name

The name as the caller gave it.

Definition properties.h:206

fiftyoneDegreesString

Definition string.h:97