index db7a295a1450bf3850464fda67102da17edd5218..3200bfdf357276ae1db19777abb6f8abc05cbf1c 100644 (file)
// License: GPLv2 - http://www.gnu.org/licenses/gpl-2.0.html
//
+/**
+ * @file
+ * Common routines used by the TIC parsers.
+ * The code making use of the parsers must provide extra functions as mentioned in the header.
+ */
+
#include <stdlib.h>
#include <string.h>
index 2c66d6b2f295ae2c9cf961c986143319aab1dbc4..b09a775e97094366cb6ee2be3e09e04197b12acb 100644 (file)
// License: GPLv2 - http://www.gnu.org/licenses/gpl-2.0.html
//
+/**
+ * @file
+ * Interface for TIC parsers
+ * Users of this interface must implement the functions listed at the bottom:
+ * - print_field()
+ * - frame_sep()
+ * - frame_err()
+ */
+
#ifndef tic_h
#define tic_h
#define pr_err(format, ...) fprintf(stderr, "ERREUR: " format, ## __VA_ARGS__)
#endif
-// The code assumes this fits on 4 bits
+/**
+ * TIC units.
+ * @warning The code assumes this fits on 4 bits
+ */
enum tic_unit {
U_SANS = 0x00,
U_WH,
U_MIN,
};
-// this is to be packed in the upper 4 bits of a byte: must increment by 0x10
-// by default everything is an int
-enum data_type {
+/**
+ * TIC data types.
+ * By default everything is an int.
+ * @warning The code assumes this is packed in the upper 4 bits of a byte: must increment by 0x10.
+ */
+ enum data_type {
T_STRING = 0x10,
T_HEX = 0x20,
};
@@ -59,8 +74,24 @@ void make_field(struct tic_field *field, const struct tic_etiquette *etiq, char
void free_field(struct tic_field *field);
// The following functions must be provided by the output interface
+
+/**
+ * Called for each valid dataset.
+ * Used to print a TIC dataset in the desired output format.
+ * @param field the dataset to print
+ */
void print_field(const struct tic_field *field);
+
+/**
+ * Called after each frame, valid or not.
+ * Used to print a frame separator in the desired output format.
+ */
void frame_sep(void);
+
+/**
+ * Called whenever a frame error condition occurs.
+ * When frames or datasets have errors.
+ */
void frame_err(void);
#endif /* tic_h */