FLMDEF.h File Reference

FLMDEF - External FLAM definitions. More...

Go to the source code of this file.

Data Structures
struct	FlmElmRec0
	FLAM 5 serialized element structure (version 0) More...

Macros
#define	FLMOUT_FORMAT_NON   0
	Default format (FLMOUT_FORMAT_LST)
#define	FLMOUT_FORMAT_LST   1
	Simple list of lines with each line separated by '\n' and the whole string terminated by 0x00.
#define	FLMOUT_FORMAT_XML   2
	As XML-formatted, null-terminated string (in local charset) with each line separated by '\n'.
#define	FLC_READ_FILE
	File definition strings in read mode.
#define	FLC_READ_FORMAT
	Format data strings in read mode.
#define	FLC_WRITE_FILE
	File definition strings in write mode.
#define	FLC_WRITE_FORMAT
	Format data strings in write mode.
#define	FLC_CONV_READ
	Data conversion strings in read mode.
#define	FLC_CONV_WRITE
	Data conversion strings in write mode.
#define	FLC_CONV_FROM_TO
	Data conversion string in from-to mode.
#define	FLC_INPUT_FILE
	File definition strings in input mode.
#define	FLC_OUTPUT_FILE
	File definition strings in output mode.
#define	FLC_INFO   1
	Definition of the info string.
#define	FLC_STATE   1
	Definition of the state string.
#define	FLC_LOG   1
	Definition of the memory log string.
#define	FLCHSH_ALGO_NON   0
	No valid hash method.
#define	FLCHSH_ALGO_MD5   1
	MD5 method.
#define	FLCHSH_ALGO_RMD128   2
	RipeMd-128 method.
#define	FLCHSH_ALGO_RMD160   3
	RipeMd-160 method.
#define	FLCHSH_ALGO_SHA1   10
	SHA1 method.
#define	FLCHSH_ALGO_SHA160   10
	SHA1 method.
#define	FLCHSH_ALGO_SHA224   20
	SHA224 (SHA2 variant) method.
#define	FLCHSH_ALGO_SHA256   21
	SHA256 (SHA2 variant) method.
#define	FLCHSH_ALGO_SHA384   22
	SHA384 (SHA2 variant) method.
#define	FLCHSH_ALGO_SHA512   23
	SHA512 (SHA2 variant) method.
#define	FLCHSH_ALGO_SHA3_224   30
	SHA3-224 method.
#define	FLCHSH_ALGO_SHA3_256   31
	SHA3-256 method.
#define	FLCHSH_ALGO_SHA3_384   32
	SHA3-384 method.
#define	FLCHSH_ALGO_SHA3_512   33
	SHA3-512 method.
#define	FLCHSH_ALGO_CRC08   100
	8 Bit CRC checksum (no crypto quality)
#define	FLCHSH_ALGO_CRC16   101
	16 Bit CRC checksum (no crypto quality)
#define	FLCHSH_ALGO_CRC24   102
	24 Bit CRC checksum (no crypto quality)
#define	FLCHSH_ALGO_CRC32   103
	32 Bit CRC checksum (no crypto quality)
#define	FLCHSH_ALGO_CRC32C   104
	32 Bit CRC checksum (no crypto quality)
#define	FLCHSH_ALGO_CRC40   105
	40 Bit CRC checksum (no crypto quality)
#define	FLCHSH_ALGO_CRC64   106
	64 Bit CRC checksum (no crypto quality)
#define	FLCMAC_ALGO_NON   0
	No valid hash method.
#define	FLCMAC_ALGO_HMAC   1
	HMAC conform to RFC 2104.
#define	FLC_INBOUND_COUNT
	Use input values.
#define	FLC_OUTBOUND_COUNT
	Use output values.
#define	FLC_FIO_COUNT
	Use values from File I/O.
#define	FLC_FMT_COUNT
	Use values from formatting.
#define	FLC_BYTE_COUNT
	Determine byte counts.
#define	FLC_UNIT_COUNT
	Determine unit (block or record) counts.
#define	FLMMAT_TYP_NON   0x00
	Unknown/undefined matrix type.
#define	FLMMAT_TYP_DATBLK   0x80
	Data blocks, 1 element type, no attributes.
#define	FLMMAT_TYP_STDREC   0x81
	Standard record, 1 element type, no attributes.
#define	FLMMAT_TYP_STDASAREC   0x82
	Standard record, 1 element type, with 1 byte ASA control character as attribute.
#define	FLMMAT_TYP_STDMCCREC   0x83
	Standard record, 1 element type, with 1 byte machine control character as attribute.
#define	FLMMAT_TYP_RELREC   0x84
	Relative record, 1 element type, with 8 byte integer (slot number) as attribute.
#define	FLMMAT_TYP_RELASAREC   0x85
	Relative record, 1 element type, with 8 byte slot number and 1 byte ASA as attribute.
#define	FLMMAT_TYP_RELMCCREC   0x86
	Relative record, 1 element type, with 8 byte slot number and 1 byte MCC as attribute.
#define	FLMMAT_TYP_TXTREC   0x87
	Text record, 1 element type, no attributes (like standard record, but text is known)
#define	FLMMAT_TYP_TXTDLM   0x88
	Text record with delimiter at the end, 1 element type, no attributes.
#define	FLMMAT_TYP_TXTRST   0x90
	Text record and rest element (suppressed trailing whitespace and original delimiter), 2 elements, no attributes.
#define	FLMMAT_TYP_XMLELM   0x91
	XML elements, no attributes.
#define	FLMMAT_TYP_TABELM   0x92
	Table elements, no attributes.
#define	FLMELM_NOSKIP   -1
	Use this value for an element type if no skip of an element type required at read.
#define	FLMELM_TYPBLK_STANDARD   0
	Simple data block element type (may contain binary data)
#define	FLMELM_TYPREC_STANDARD   0
	Record element type for record matrix types.
#define	FLMELM_TYPTXT_RECORD   0
	Text element type of a TXTRST matrix.
#define	FLMELM_TYPTXT_REST   1
	Rest element type of a TXTRST matrix.
#define	FLMELM_TYPXML_DATA   0
	XML data element type.
#define	FLMELM_TYPXML_STARTELM   1
	Start of opening XML tag element type.
#define	FLMELM_TYPXML_ENDSTRTELM   2
	End of opening XML tag element type.
#define	FLMELM_TYPXML_ENDELM   3
	Closing XML tag element type.
#define	FLMELM_TYPXML_ATTNAME   4
	Attribute name element type.
#define	FLMELM_TYPXML_ATTRVAL   5
	Attribute value element type.
#define	FLMELM_TYPXML_XML   6
	XML prolog element type.
#define	FLMELM_TYPXML_SKIPENT   7
	General skipped entity element type.
#define	FLMELM_TYPXML_SKIPPARMENT   8
	Skipped parameter entity element type.
#define	FLMELM_TYPXML_STARTDTD   9
	Start of a DTD (Document Type Definition) element type.
#define	FLMELM_TYPXML_ENDDTD   10
	End of a DTD element type.
#define	FLMELM_TYPXML_ELMDECL   11
	DTD element type declaration element type.
#define	FLMELM_TYPXML_ATTLDECL   12
	DTD attribute list declaration element type.
#define	FLMELM_TYPXML_INTENTDECL   13
	Internal entity declaration element type.
#define	FLMELM_TYPXML_SYSENTDECL   14
	External entity declaration element type with system identifier.
#define	FLMELM_TYPXML_PUBENTDECL   15
	External entity declaration element type with public identifier.
#define	FLMELM_TYPXML_NOTDECLS   16
	Notation declaration element type with a system identifier.
#define	FLMELM_TYPXML_NOTDECLP   17
	Notation declaration element type with a public identifier.
#define	FLMELM_TYPXML_NOTDECLPS   18
	Notation declaration element type with a public and system identifier.
#define	FLMELM_TYPXML_PROCINST   19
	Processing instruction element type.
#define	FLMELM_TYPXML_STARTCD   20
	Start of CDATA section element type.
#define	FLMELM_TYPXML_ENDCD   21
	Start of CDATA section element type.
#define	FLMELM_TYPXML_COMMENT   22
	Comment element type.
#define	FLMELM_TYPXML_DEFAULT   23
	Element type for all other data in a document.
#define	FLMELM_TYPXML_STARTNS   24
	Start declaration name space handler.
#define	FLMELM_TYPXML_ENDNS   25
	End declaration name space handler.
#define	FLMELM_TYPTAB_NONE   0
	No element type.
#define	FLMELM_TYPTAB_FLAG_NULLID   0x00010000
	Flag for null indication.
#define	FLMELM_TYPTAB_FLAG_EMPTID   0x00020000
	Flag for empty indication.
#define	FLMELM_TYPTAB_BINARY   0x00000001
	Binary element type.
#define	FLMELM_TYPTAB_BINARY_NI   (FLMELM_TYPTAB_BINARY | FLMELM_TYPTAB_FLAG_NULLID)
#define	FLMELM_TYPTAB_BINARY_EI   (FLMELM_TYPTAB_BINARY | FLMELM_TYPTAB_FLAG_EMPTID)
#define	FLMELM_TYPTAB_BINARY_EINI   (FLMELM_TYPTAB_BINARY | FLMELM_TYPTAB_FLAG_EMPTID | FLMELM_TYPTAB_FLAG_NULLID)
#define	FLMELM_TYPTAB_STRING   0x00000002
	String element type.
#define	FLMELM_TYPTAB_STRING_NI   (FLMELM_TYPTAB_STRING | FLMELM_TYPTAB_FLAG_NULLID)
#define	FLMELM_TYPTAB_STRING_EI   (FLMELM_TYPTAB_STRING | FLMELM_TYPTAB_FLAG_EMPTID)
#define	FLMELM_TYPTAB_STRING_EINI   (FLMELM_TYPTAB_STRING | FLMELM_TYPTAB_FLAG_EMPTID | FLMELM_TYPTAB_FLAG_NULLID)
#define	FLMELM_TYPTAB_INTEGER   0x00000003
	Integer element type.
#define	FLMELM_TYPTAB_INTEGER_NI   (FLMELM_TYPTAB_INTEGER | FLMELM_TYPTAB_FLAG_NULLID)
#define	FLMELM_TYPTAB_INTEGER_EI   (FLMELM_TYPTAB_INTEGER | FLMELM_TYPTAB_FLAG_EMPTID)
#define	FLMELM_TYPTAB_INTEGER_EINI   (FLMELM_TYPTAB_INTEGER | FLMELM_TYPTAB_FLAG_EMPTID | FLMELM_TYPTAB_FLAG_NULLID)
#define	FLMELM_TYPTAB_FLOAT   0x00000004
	Float element type.
#define	FLMELM_TYPTAB_FLOAT_NI   (FLMELM_TYPTAB_FLOAT | FLMELM_TYPTAB_FLAG_NULLID)
#define	FLMELM_TYPTAB_FLOAT_EI   (FLMELM_TYPTAB_FLOAT | FLMELM_TYPTAB_FLAG_EMPTID)
#define	FLMELM_TYPTAB_FLOAT_EINI   (FLMELM_TYPTAB_FLOAT | FLMELM_TYPTAB_FLAG_EMPTID | FLMELM_TYPTAB_FLAG_NULLID)
#define	FLMELM_TYPTAB_HEADER   0x0000000A
	Column name element type.
#define	FLMELMREC0_LENGTH(element)
	Macro that calculates the length of an element of type FlmElmRec0.
#define	FLMELMREC0_ATTRPTR(element)
	Convenience macro that calculates the correct starting address of the attribute data within FlmElmRec0::buffer.
#define	FLMELMREC0_DATAPTR(element)
	Convenience macro that calculates the correct starting address of the element's data payload within FlmElmRec0::buffer.
#define	FLMELMREC0_HASHPTR(element)
	Convenience macro that calculates the correct starting address of the hash data within FlmElmRec0::buffer.

Detailed Description

FLMDEF - External FLAM definitions.

Author

limes datentechnik gmbh

Date

11.01.2016

Copyright

limes datentechnik gmbh

This header contains different global defines for FLAM application programming interfaces.

Macro Definition Documentation

FLMELM_TYPTAB_BINARY_NI

#define FLMELM_TYPTAB_BINARY_NI   (FLMELM_TYPTAB_BINARY | FLMELM_TYPTAB_FLAG_NULLID)

FLMELM_TYPTAB_BINARY_EI

#define FLMELM_TYPTAB_BINARY_EI   (FLMELM_TYPTAB_BINARY | FLMELM_TYPTAB_FLAG_EMPTID)

FLMELM_TYPTAB_BINARY_EINI

#define FLMELM_TYPTAB_BINARY_EINI   (FLMELM_TYPTAB_BINARY | FLMELM_TYPTAB_FLAG_EMPTID | FLMELM_TYPTAB_FLAG_NULLID)

FLMELM_TYPTAB_STRING_NI

#define FLMELM_TYPTAB_STRING_NI   (FLMELM_TYPTAB_STRING | FLMELM_TYPTAB_FLAG_NULLID)

FLMELM_TYPTAB_STRING_EI

#define FLMELM_TYPTAB_STRING_EI   (FLMELM_TYPTAB_STRING | FLMELM_TYPTAB_FLAG_EMPTID)

FLMELM_TYPTAB_STRING_EINI

#define FLMELM_TYPTAB_STRING_EINI   (FLMELM_TYPTAB_STRING | FLMELM_TYPTAB_FLAG_EMPTID | FLMELM_TYPTAB_FLAG_NULLID)

FLMELM_TYPTAB_INTEGER_NI

#define FLMELM_TYPTAB_INTEGER_NI   (FLMELM_TYPTAB_INTEGER | FLMELM_TYPTAB_FLAG_NULLID)

FLMELM_TYPTAB_INTEGER_EI

#define FLMELM_TYPTAB_INTEGER_EI   (FLMELM_TYPTAB_INTEGER | FLMELM_TYPTAB_FLAG_EMPTID)

FLMELM_TYPTAB_INTEGER_EINI

#define FLMELM_TYPTAB_INTEGER_EINI   (FLMELM_TYPTAB_INTEGER | FLMELM_TYPTAB_FLAG_EMPTID | FLMELM_TYPTAB_FLAG_NULLID)

FLMELM_TYPTAB_FLOAT_NI

#define FLMELM_TYPTAB_FLOAT_NI   (FLMELM_TYPTAB_FLOAT | FLMELM_TYPTAB_FLAG_NULLID)

FLMELM_TYPTAB_FLOAT_EI

#define FLMELM_TYPTAB_FLOAT_EI   (FLMELM_TYPTAB_FLOAT | FLMELM_TYPTAB_FLAG_EMPTID)

FLMELM_TYPTAB_FLOAT_EINI

#define FLMELM_TYPTAB_FLOAT_EINI   (FLMELM_TYPTAB_FLOAT | FLMELM_TYPTAB_FLAG_EMPTID | FLMELM_TYPTAB_FLAG_NULLID)