FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kInfo.h
Go to the documentation of this file.
1 
8 #ifndef K_FIRESYNC_INFO_H
9 #define K_FIRESYNC_INFO_H
10 
11 #include <kFireSync/kFsDef.h>
12 
13 kBeginHeader()
14 
15 
29 typedef k32s kViolation;
30 
31 #define kVIOLATION_NONE (0x00)
32 #define kVIOLATION_BOUNDS (0x01)
33 #define kVIOLATION_GRANULARITY (0x02)
34 #define kVIOLATION_UNIQUENESS (0x04)
35 #define kVIOLATION_EXISTENCE (0x08)
36 #define kVIOLATION_GROUP (0x10)
37 #define kVIOLATION_INVALID (0x20)
38 
39 
45 typedef struct kInfo
46 {
49  kViolation violations;
50 } kInfo;
51 
59 kFsFx(kStatus) kInfo_Init(kInfo* info);
60 
71 kFsFx(kStatus) kInfo_AppendErrors(const kInfo* info, kArrayList list, const kChar* source, const kChar* field);
72 
79 typedef struct kInfo32u
80 {
88  kViolation violations;
90 } kInfo32u;
91 
102 kFsFx(kStatus) kInfo32u_Init(kInfo32u* info, k32u min, k32u max, k32u granularity);
103 
112 kFsFx(kStatus) kInfo32u_Validate(kInfo32u* info, k32u value);
113 
125 kFsFx(kStatus) kInfo32u_AppendErrors(const kInfo32u* info, kArrayList list, const kChar* source, const kChar* field, k32u value);
126 
133 typedef struct kInfo32s
134 {
142  kViolation violations;
144 } kInfo32s;
145 
156 kFsFx(kStatus) kInfo32s_Init(kInfo32s* info, k32s min, k32s max, k32s granularity);
157 
166 kFsFx(kStatus) kInfo32s_Validate(kInfo32s* info, k32s value);
167 
179 kFsFx(kStatus) kInfo32s_AppendErrors(const kInfo32s* info, kArrayList list, const kChar* source, const kChar* field, k32s value);
180 
187 typedef struct kInfo64u
188 {
196  kViolation violations;
198 } kInfo64u;
199 
210 kFsFx(kStatus) kInfo64u_Init(kInfo64u* info, k64u min, k64u max, k64u granularity);
211 
220 kFsFx(kStatus) kInfo64u_Validate(kInfo64u* info, k64u value);
221 
233 kFsFx(kStatus) kInfo64u_AppendErrors(const kInfo64u* info, kArrayList list, const kChar* source, const kChar* field, k64u value);
234 
241 typedef struct kInfo64s
242 {
250  kViolation violations;
252 } kInfo64s;
253 
264 kFsFx(kStatus) kInfo64s_Init(kInfo64s* info, k64s min, k64s max, k64s granularity);
265 
274 kFsFx(kStatus) kInfo64s_Validate(kInfo64s* info, k64s value);
275 
287 kFsFx(kStatus) kInfo64s_AppendErrors(const kInfo64s* info, kArrayList list, const kChar* source, const kChar* field, k64s value);
288 
295 typedef struct kInfoSize
296 {
304  kViolation violations;
306 } kInfoSize;
307 
318 kFsFx(kStatus) kInfoSize_Init(kInfoSize* info, kSize min, kSize max, kSize granularity);
319 
328 kFsFx(kStatus) kInfoSize_Validate(kInfoSize* info, kSize value);
329 
341 kFsFx(kStatus) kInfoSize_AppendErrors(const kInfoSize* info, kArrayList list, const kChar* source, const kChar* field, kSize value);
342 
349 typedef struct kInfo64f
350 {
359  kViolation violations;
361 } kInfo64f;
362 
372 kFsFx(kStatus) kInfo64f_Init(kInfo64f* info, k64f min, k64f max);
373 
382 kFsFx(kStatus) kInfo64f_Validate(kInfo64f* info, k64f value);
383 
395 kFsFx(kStatus) kInfo64f_AppendErrors(const kInfo64f* info, kArrayList list, const kChar* source, const kChar* field, k64f value);
396 
403 typedef struct kInfoBool
404 {
411  kViolation violations;
412 } kInfoBool;
413 
423 kFsFx(kStatus) kInfoBool_Init(kInfoBool* info, kBool min, kBool max);
424 
433 kFsFx(kStatus) kInfoBool_Validate(kInfoBool* info, kBool value);
434 
446 kFsFx(kStatus) kInfoBool_AppendErrors(const kInfoBool* info, kArrayList list, const kChar* source, const kChar* field, kBool value);
447 
454 typedef struct kInfoBits
455 {
460  kViolation violations;
461 } kInfoBits;
462 
471 kFsFx(kStatus) kInfoBits_Init(kInfoBits* info, k32u options);
472 
483 kFsFx(kStatus) kInfoBits_ValidateOne(kInfoBits* info, k32u option);
484 
495 kFsFx(kStatus) kInfoBits_ValidateAtLeastOne(kInfoBits* info, k32u options);
496 
508 kFsFx(kStatus) kInfoBits_AppendErrors(const kInfoBits* info, kArrayList list, const kChar* source, const kChar* field, k32u value);
509 
510 kEndHeader()
511 
512 #include <kFireSync/Utils/kInfo.x.h>
513 
514 #endif
kBool isReadOnly
Value is read-only (cannot be modified).
Definition: kInfo.h:357
k64f accurate
Accurate representation of current value, typically used for display in meaningful units (optional)...
Definition: kInfo.h:143
k32s granularity
Value must be evenly divisible by this number.
Definition: kInfo.h:139
kStatus kInfoBool_Validate(kInfoBool *info, kBool value)
Validates an input value against min/max values.
kStatus kInfo32s_Init(kInfo32s *info, k32s min, k32s max, k32s granularity)
Initializes a kInfo32s structure to default values.
kBool isReadOnly
Value is read-only (cannot be modified).
Definition: kInfo.h:140
kStatus kInfo64s_AppendErrors(const kInfo64s *info, kArrayList list, const kChar *source, const kChar *field, k64s value)
Appends violation descriptions to the given list.
kBool isReadOnly
Value is read-only (cannot be modified).
Definition: kInfo.h:409
kStatus kInfo_Init(kInfo *info)
Initializes a kInfo structure to default values.
k64s absoluteMax
Maximum valid value under any circumstances.
Definition: kInfo.h:244
kStatus kInfo32u_AppendErrors(const kInfo32u *info, kArrayList list, const kChar *source, const kChar *field, k32u value)
Appends violation descriptions to the given list.
k64f accurate
Accurate representation of current value, typically used for display in meaningful units (optional)...
Definition: kInfo.h:89
kSize absoluteMin
Minimum valid value under any circumstances.
Definition: kInfo.h:297
kBool isGrouped
Value is constrained to be the same as its peers within a group. (e.g. periods of states belonging to...
Definition: kInfo.h:195
kBool relativeMin
Minimum valid value, limited by current values of other (more dominant) settings. ...
Definition: kInfo.h:407
kBool isGrouped
Value is constrained to be the same as its peers within a group.
Definition: kInfo.h:459
k64u absoluteMin
Minimum valid value under any circumstances.
Definition: kInfo.h:189
kSize absoluteMax
Maximum valid value under any circumstances.
Definition: kInfo.h:298
k64f absoluteMin
Minimum valid value under any circumstances.
Definition: kInfo.h:351
kStatus kInfo64f_AppendErrors(const kInfo64f *info, kArrayList list, const kChar *source, const kChar *field, k64f value)
Appends violation descriptions to the given list.
k32u granularity
Value must be evenly divisible by this number.
Definition: kInfo.h:85
kViolation violations
Constraints violated by the current value.
Definition: kInfo.h:88
Represents constraint and validity information for a bit flag setting.
Definition: kInfo.h:454
k64u relativeMin
Minimum valid value, limited by current values of other (more dominant) settings. ...
Definition: kInfo.h:191
kBool isGrouped
Value is constrained to be the same as its peers within a group. (e.g. periods of states belonging to...
Definition: kInfo.h:303
kViolation violations
Constraints violated by the current value.
Definition: kInfo.h:250
k32u relativeMax
Maximum valid value, limited by current values of other (more dominant) settings. ...
Definition: kInfo.h:84
Represents constraint and validity information for a 64-bit signed integer setting.
Definition: kInfo.h:241
kStatus kInfo64f_Init(kInfo64f *info, k64f min, k64f max)
Initializes a kInfo64f structure to default values.
kStatus kInfoBool_AppendErrors(const kInfoBool *info, kArrayList list, const kChar *source, const kChar *field, kBool value)
Appends violation descriptions to the given list.
k64s granularity
Value must be evenly divisible by this number.
Definition: kInfo.h:247
k64u granularity
Value must be evenly divisible by this number.
Definition: kInfo.h:193
kStatus kInfo64s_Validate(kInfo64s *info, k64s value)
Validates an input value against min/max/granularity values.
k32u relativeOptions
Set of valid options, limited by current values of other (more dominant) settings.
Definition: kInfo.h:457
kStatus kInfo64u_Validate(kInfo64u *info, k64u value)
Validates an input value against min/max/granularity values.
k32s absoluteMin
Minimum valid value under any circumstances.
Definition: kInfo.h:135
Represents constraint and validity information for a double setting.
Definition: kInfo.h:349
k32u absoluteMax
Maximum valid value under any circumstances.
Definition: kInfo.h:82
k64f accurate
Accurate representation of current value, typically used for display in meaningful units (optional)...
Definition: kInfo.h:197
kBool isReadOnly
Value is read-only (cannot be modified).
Definition: kInfo.h:47
Represents constraint and validity information for a 32-bit signed integer setting.
Definition: kInfo.h:133
kStatus kInfoSize_AppendErrors(const kInfoSize *info, kArrayList list, const kChar *source, const kChar *field, kSize value)
Appends violation descriptions to the given list.
kBool absoluteMin
Minimum valid value under any circumstances.
Definition: kInfo.h:405
k32s relativeMax
Maximum valid value, limited by current values of other (more dominant) settings. ...
Definition: kInfo.h:138
kBool isGrouped
Value is constrained to be the same as its peers within a group. (e.g. periods of states belonging to...
Definition: kInfo.h:358
k64u relativeMax
Maximum valid value, limited by current values of other (more dominant) settings. ...
Definition: kInfo.h:192
k64s relativeMax
Maximum valid value, limited by current values of other (more dominant) settings. ...
Definition: kInfo.h:246
kStatus kInfoBits_AppendErrors(const kInfoBits *info, kArrayList list, const kChar *source, const kChar *field, k32u value)
Appends violation descriptions to the given list.
kBool isGrouped
Value is constrained to be the same as its peers within a group. (e.g. periods of states belonging to...
Definition: kInfo.h:249
kViolation violations
Constraints violated by the current value.
Definition: kInfo.h:196
kStatus kInfo64s_Init(kInfo64s *info, k64s min, k64s max, k64s granularity)
Initializes a kInfo64s structure to default values.
k64s relativeMin
Minimum valid value, limited by current values of other (more dominant) settings. ...
Definition: kInfo.h:245
kViolation violations
Constraints violated by the current value.
Definition: kInfo.h:49
kBool isReadOnly
Value is read-only (cannot be modified).
Definition: kInfo.h:248
kStatus kInfo64f_Validate(kInfo64f *info, k64f value)
Validates an input value against min/max values.
kSize granularity
Value must be evenly divisible by this number.
Definition: kInfo.h:301
k64f accurate
Accurate representation of current value, typically used for display in meaningful units (optional)...
Definition: kInfo.h:360
kBool relativeMax
Maximum valid value, limited by current values of other (more dominant) settings. ...
Definition: kInfo.h:408
k64f accurate
Accurate representation of current value, typically used for display in meaningful units (optional)...
Definition: kInfo.h:251
kBool isReadOnly
Value is read-only (cannot be modified).
Definition: kInfo.h:86
k32u absoluteMin
Minimum valid value under any circumstances.
Definition: kInfo.h:81
Essential API declarations for the kFireSync library.
kStatus kInfo32u_Validate(kInfo32u *info, k32u value)
Validates an input value against min/max/granularity values.
kStatus kInfo64u_AppendErrors(const kInfo64u *info, kArrayList list, const kChar *source, const kChar *field, k64u value)
Appends violation descriptions to the given list.
kBool isGrouped
Value is constrained to be the same as its peers within a group. (e.g. periods of states belonging to...
Definition: kInfo.h:87
Represents types of constraint violations.
kBool isReadOnly
Value is read-only (cannot be modified).
Definition: kInfo.h:302
kViolation violations
Constraints violated by the current value.
Definition: kInfo.h:304
kViolation violations
Constraints violated by the current value.
Definition: kInfo.h:359
k32u relativeMin
Minimum valid value, limited by current values of other (more dominant) settings. ...
Definition: kInfo.h:83
k64s absoluteMin
Minimum valid value under any circumstances.
Definition: kInfo.h:243
k64f accurate
Accurate representation of current value, typically used for display in meaningful units (optional)...
Definition: kInfo.h:305
k64f relativeMax
Maximum valid value, limited by current values of other (more dominant) settings. ...
Definition: kInfo.h:354
kBool isGrouped
Value is constrained to be the same as its peers within a group.
Definition: kInfo.h:48
kStatus kInfo_AppendErrors(const kInfo *info, kArrayList list, const kChar *source, const kChar *field)
Appends violation descriptions to the given list.
kBool isReadOnly
Value is read-only (cannot be modified).
Definition: kInfo.h:194
Represents constraint and validity information for a 64-bit unsigned integer setting.
Definition: kInfo.h:187
kStatus kInfoBits_Init(kInfoBits *info, k32u options)
Initializes a kInfoBits structure to default values.
kStatus kInfo32s_Validate(kInfo32s *info, k32s value)
Validates an input value against min/max/granularity values.
k64u absoluteMax
Maximum valid value under any circumstances.
Definition: kInfo.h:190
kViolation violations
Constraints violated by the current value.
Definition: kInfo.h:460
kViolation violations
Constraints violated by the current value.
Definition: kInfo.h:142
k32s relativeMin
Minimum valid value, limited by current values of other (more dominant) settings. ...
Definition: kInfo.h:137
k32s absoluteMax
Maximum valid value under any circumstances.
Definition: kInfo.h:136
kViolation violations
Constraints violated by the current value.
Definition: kInfo.h:411
kStatus kInfoSize_Validate(kInfoSize *info, kSize value)
Validates an input value against min/max/granularity values.
kSize relativeMax
Maximum valid value, limited by current values of other (more dominant) settings. ...
Definition: kInfo.h:300
Represents constraint and validity information for a 32-bit unsigned integer setting.
Definition: kInfo.h:79
kBool isGrouped
Value is constrained to be the same as its peers within a group. (e.g. periods of states belonging to...
Definition: kInfo.h:141
kStatus kInfo32s_AppendErrors(const kInfo32s *info, kArrayList list, const kChar *source, const kChar *field, k32s value)
Appends violation descriptions to the given list.
kBool isGrouped
Value is constrained to be the same as its peers within a group.
Definition: kInfo.h:410
Represents constraint and validity information for a kSize setting.
Definition: kInfo.h:295
kStatus kInfoBits_ValidateOne(kInfoBits *info, k32u option)
Checks whether the specified option is valid.
k32u absoluteOptions
Set of valid options under any circumstances.
Definition: kInfo.h:456
kSize relativeMin
Minimum valid value, limited by current values of other (more dominant) settings. ...
Definition: kInfo.h:299
kStatus kInfoSize_Init(kInfoSize *info, kSize min, kSize max, kSize granularity)
Initializes a kInfoSize structure to default values.
kStatus kInfo32u_Init(kInfo32u *info, k32u min, k32u max, k32u granularity)
Initializes a kInfo32u structure to default values.
k64f absoluteMax
Maximum valid value under any circumstances.
Definition: kInfo.h:352
kBool isReadOnly
Value is read-only (cannot be modified).
Definition: kInfo.h:458
Represents constraint and validity information for a general setting.
Definition: kInfo.h:45
k64f relativeMin
Minimum valid value, limited by current values of other (more dominant) settings. ...
Definition: kInfo.h:353
kStatus kInfo64u_Init(kInfo64u *info, k64u min, k64u max, k64u granularity)
Initializes a kInfo64u structure to default values.
k64f next
Next valid value.
Definition: kInfo.h:356
Represents constraint and validity information for a boolean setting.
Definition: kInfo.h:403
kStatus kInfoBool_Init(kInfoBool *info, kBool min, kBool max)
Initializes a kInfoBool structure to default values.
kStatus kInfoBits_ValidateAtLeastOne(kInfoBits *info, k32u options)
Checks whether the specified options are valid, setting appropriate violation flags.
k64f previous
Previous valid value.
Definition: kInfo.h:355
kBool absoluteMax
Maximum valid value under any circumstances.
Definition: kInfo.h:406