LAR Library: format.h Source File

LAR Library

previous page next page
format.h
Go to the documentation of this file.
1 #ifndef LARLIB_FORMAT_H
2 #define LARLIB_FORMAT_H
3 
323 #include <larlib/base.h>
324 
325 /*
326  * Typedefs
327  */
328 typedef struct format_t format_t;
329 typedef struct formatField_t formatField_t;
330 
335 enum formatDirection_t {
336  FORMAT_PACK,
337  FORMAT_UNPACK
338 };
339 
340 typedef enum formatDirection_t formatDirection_t;
341 
345 struct format_t {
347  formatField_t *fields;
348 
350  int nfields;
351 
364  int (*filter)(const format_t *fmt, const formatField_t *field);
365 
370  void *fieldMap;
371 
373  int errorCode;
374 
380  formatField_t *errorField;
381 };
382 
386 struct formatField_t {
387 
392  int index;
393 
397  int (*prefix)(uint8_t *buffer, int limit, formatDirection_t direction, format_t *fmt, formatField_t *field);
398 
402  int (*body)(uint8_t *buffer, int limit, formatDirection_t direction, format_t *fmt, formatField_t *field);
403 
407  int (*suffix)(uint8_t *buffer, int limit, formatDirection_t direction, format_t *fmt, formatField_t *field);
408 
412  int size;
413 
417  void *data;
418 
423  int bodySize;
424 };
425 
436 int formatPack(format_t *fmt, uint8_t *output, int maxOutput);
437 
448 int formatUnpack(format_t *fmt, uint8_t *input, int inputSize);
449 
473 int formatFilterISO8583(const format_t *fmt, const formatField_t *field);
474 
490 int formatBodyISO8583(uint8_t *buffer, int limit, formatDirection_t direction, format_t *fmt, formatField_t *field);
491 
508 int formatBodyPacked(uint8_t *buffer, int limit, formatDirection_t direction, format_t *fmt, formatField_t *field);
509 
522 int formatBodySkip (uint8_t *buffer, int limit, formatDirection_t direction, format_t *fmt, formatField_t *field);
523 
536 int formatBodyMemcpy(uint8_t *buffer, int limit, formatDirection_t direction, format_t *fmt, formatField_t *field);
537 
550 int formatBodyStrcpy(uint8_t *buffer, int limit, formatDirection_t direction, format_t *fmt, formatField_t *field);
551 
571 int formatBodyUint64Dec(uint8_t *buffer, int limit, formatDirection_t direction, format_t *fmt, formatField_t *field);
572 
592 int formatBodyUint32Dec(uint8_t *buffer, int limit, formatDirection_t direction, format_t *fmt, formatField_t *field);
593 
613 int formatBodyUint16Dec(uint8_t *buffer, int limit, formatDirection_t direction, format_t *fmt, formatField_t *field);
614 
634 int formatBodyUint8Dec(uint8_t *buffer, int limit, formatDirection_t direction, format_t *fmt, formatField_t *field);
635 
651 int formatBodyUint64Buf(uint8_t *buffer, int limit, formatDirection_t direction, format_t *fmt, formatField_t *field);
652 
671 int formatBodyBufHex(uint8_t *buffer, int limit, formatDirection_t direction, format_t *fmt, formatField_t *field);
672 
685 int formatSizeAsc2(uint8_t *buffer, int limit, formatDirection_t direction, format_t *fmt, formatField_t *field);
686 
699 int formatSizeAsc3(uint8_t *buffer, int limit, formatDirection_t direction, format_t *fmt, formatField_t *field);
700 
713 int formatSizeBcd2(uint8_t *buffer, int limit, formatDirection_t direction, format_t *fmt, formatField_t *field);
714 
727 int formatSizeBcd3(uint8_t *buffer, int limit, formatDirection_t direction, format_t *fmt, formatField_t *field);
728 
741 int formatPadSpaces(uint8_t *buffer, int limit, formatDirection_t direction, format_t *fmt, formatField_t *field);
742 
755 int formatPadZeroes(uint8_t *buffer, int limit, formatDirection_t direction, format_t *fmt, formatField_t *field);
756 
769 int formatPadZeroBytes(uint8_t *buffer, int limit, formatDirection_t direction, format_t *fmt, formatField_t *field);
770 
784 int formatPadSkip(uint8_t *buffer, int limit, formatDirection_t direction, format_t *fmt, formatField_t *field);
785 
786 /* @} */
787 
788 /* @} */
789 
790 #endif
FORMAT_UNPACK
Read from buffer.
Definition: format.h:337
formatBodyUint64Dec
int formatBodyUint64Dec(uint8_t *buffer, int limit, formatDirection_t direction, format_t *fmt, formatField_t *field)
Format an uint64_t field as a decimal string.
formatPadSkip
int formatPadSkip(uint8_t *buffer, int limit, formatDirection_t direction, format_t *fmt, formatField_t *field)
Skip exactly field->size - field->bodySize bytes.
formatDirection_t
formatDirection_t
Used as parameter to the formatting functions to inform if they should handle packing or unpacking...
Definition: format.h:335
formatField_t::data
void * data
Pointer to actual field data.
Definition: format.h:417
formatSizeAsc3
int formatSizeAsc3(uint8_t *buffer, int limit, formatDirection_t direction, format_t *fmt, formatField_t *field)
Read or write the value of bodySize as a 3-digit base-10 string.
formatBodyUint32Dec
int formatBodyUint32Dec(uint8_t *buffer, int limit, formatDirection_t direction, format_t *fmt, formatField_t *field)
Format an uint32_t field as a decimal string.
formatSizeAsc2
int formatSizeAsc2(uint8_t *buffer, int limit, formatDirection_t direction, format_t *fmt, formatField_t *field)
Read or write the value of bodySize as a 2-digit base-10 string.
formatBodyUint8Dec
int formatBodyUint8Dec(uint8_t *buffer, int limit, formatDirection_t direction, format_t *fmt, formatField_t *field)
Format an uint8_t field as a decimal string.
format_t::errorField
formatField_t * errorField
Pointer to formatField_t where error was detected.
Definition: format.h:380
formatBodyUint16Dec
int formatBodyUint16Dec(uint8_t *buffer, int limit, formatDirection_t direction, format_t *fmt, formatField_t *field)
Format an uint16_t field as a decimal string.
format_t
Overall parameters of a format session.
Definition: format.h:345
formatPack
int formatPack(format_t *fmt, uint8_t *output, int maxOutput)
Write to output the packed values as described in fmt.
format_t::fieldMap
void * fieldMap
Should point to an array with the information that is read by filter to decide if a field is or not a...
Definition: format.h:370
formatBodySkip
int formatBodySkip(uint8_t *buffer, int limit, formatDirection_t direction, format_t *fmt, formatField_t *field)
Skip field->size bytes from message.
FORMAT_PACK
Write to buffer.
Definition: format.h:336
formatSizeBcd3
int formatSizeBcd3(uint8_t *buffer, int limit, formatDirection_t direction, format_t *fmt, formatField_t *field)
Read of write the value of bodySize as a 3-digit BCD number (2 bytes).
formatField_t::index
int index
Index of this field (usually on fieldMap in the parent format_t).
Definition: format.h:392
formatBodyISO8583
int formatBodyISO8583(uint8_t *buffer, int limit, formatDirection_t direction, format_t *fmt, formatField_t *field)
Read/write the bitmap of a ISO8583 message.
formatField_t::size
int size
Default size of the field.
Definition: format.h:412
format_t::errorCode
int errorCode
Last error code during pack / unpack.
Definition: format.h:373
formatBodyPacked
int formatBodyPacked(uint8_t *buffer, int limit, formatDirection_t direction, format_t *fmt, formatField_t *field)
Format a field as a recursive call to formatPack() and formatUnpack().
formatPadZeroBytes
int formatPadZeroBytes(uint8_t *buffer, int limit, formatDirection_t direction, format_t *fmt, formatField_t *field)
Write or skip field->size - field->bodySize 0x00 bytes.
formatBodyStrcpy
int formatBodyStrcpy(uint8_t *buffer, int limit, formatDirection_t direction, format_t *fmt, formatField_t *field)
Formatting for variable-sized zero-terminated strings.
formatField_t::body
int(* body)(uint8_t *buffer, int limit, formatDirection_t direction, format_t *fmt, formatField_t *field)
Pack/unpack actual field contents.
Definition: format.h:402
format_t::fields
formatField_t * fields
Pointer to array of fields to be processed.
Definition: format.h:347
formatUnpack
int formatUnpack(format_t *fmt, uint8_t *input, int inputSize)
Read from input and unpack the fields to fmt.
formatField_t
Information about each field to be read or written.
Definition: format.h:386
formatBodyMemcpy
int formatBodyMemcpy(uint8_t *buffer, int limit, formatDirection_t direction, format_t *fmt, formatField_t *field)
Copy field->size bytes of field->data to/from buffer.
formatPadZeroes
int formatPadZeroes(uint8_t *buffer, int limit, formatDirection_t direction, format_t *fmt, formatField_t *field)
Write or skip field->size - field->bodySize ASCII '0' chars.
format_t::nfields
int nfields
Number of entries in fields.
Definition: format.h:350
base.h
Larlib basic definitions.
formatBodyUint64Buf
int formatBodyUint64Buf(uint8_t *buffer, int limit, formatDirection_t direction, format_t *fmt, formatField_t *field)
Format an uint64_t field as a sequence of bytes.
formatField_t::prefix
int(* prefix)(uint8_t *buffer, int limit, formatDirection_t direction, format_t *fmt, formatField_t *field)
Pack/unpack prefix of field.
Definition: format.h:397
formatField_t::suffix
int(* suffix)(uint8_t *buffer, int limit, formatDirection_t direction, format_t *fmt, formatField_t *field)
Pack/unpack suffix of field.
Definition: format.h:407
formatPadSpaces
int formatPadSpaces(uint8_t *buffer, int limit, formatDirection_t direction, format_t *fmt, formatField_t *field)
Write or skip field->size - field->bodySize spaces.
formatBodyBufHex
int formatBodyBufHex(uint8_t *buffer, int limit, formatDirection_t direction, format_t *fmt, formatField_t *field)
Format an buffer field as a hexadecimal string.
formatField_t::bodySize
int bodySize
Actual size of the field, as returned by body.
Definition: format.h:423
format_t::filter
int(* filter)(const format_t *fmt, const formatField_t *field)
This function is called before each field is processed, receiving a pointer to the field being proces...
Definition: format.h:364
formatFilterISO8583
int formatFilterISO8583(const format_t *fmt, const formatField_t *field)
Use this function as the filter function for a ISO8583 buffer.
formatSizeBcd2
int formatSizeBcd2(uint8_t *buffer, int limit, formatDirection_t direction, format_t *fmt, formatField_t *field)
Read of write the value of bodySize as a 2-digit BCD number (1 byte).
uint8_t
unsigned char uint8_t
Unsigned 8-bit integer.
Definition: base.h:162
Generated on Mon Mar 27 2017 15:42:52 for LAR Library by   doxygen 1.8.9.1
previous page start next page