include/babeltrace/format.h

   1 #ifndef _BABELTRACE_FORMAT_H
   2 #define _BABELTRACE_FORMAT_H
   3
   4 /*
   5  * BabelTrace
   6  *
   7  * Trace Format Header
   8  *
   9  * Copyright 2010, 2011 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
  10  *
  11  * Permission is hereby granted, free of charge, to any person obtaining a copy
  12  * of this software and associated documentation files (the "Software"), to deal
  13  * in the Software without restriction, including without limitation the rights
  14  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  15  * copies of the Software, and to permit persons to whom the Software is
  16  * furnished to do so, subject to the following conditions:
  17  *
  18  * The above copyright notice and this permission notice shall be included in
  19  * all copies or substantial portions of the Software.
  20  */
  21
  22 #include <babeltrace/types.h>
  23 #include <stdint.h>
  24 #include <stdio.h>
  25 #include <glib.h>
  26
  27 struct format {
  28         GQuark name;
  29
  30         uint64_t (*uint_read)(struct stream_pos *pos,
  31                 const struct declaration_integer *integer_declaration);
  32         int64_t (*int_read)(struct stream_pos *pos,
  33                 const struct declaration_integer *integer_declaration);
  34         void (*uint_write)(struct stream_pos *pos,
  35                 const struct declaration_integer *integer_declaration,
  36                 uint64_t v);
  37         void (*int_write)(struct stream_pos *pos,
  38                 const struct declaration_integer *integer_declaration,
  39                 int64_t v);
  40
  41         void (*float_copy)(struct stream_pos *destp,
  42                 struct stream_pos *srcp,
  43                 const struct declaration_float *float_declaration);
  44         double (*double_read)(struct stream_pos *pos,
  45                 const struct declaration_float *float_declaration);
  46         void (*double_write)(struct stream_pos *pos,
  47                 const struct declaration_float *float_declaration,
  48                 double v);
  49
  50         void (*string_copy)(struct stream_pos *dest, struct stream_pos *src,
  51                 const struct declaration_string *string_declaration);
  52         void (*string_read)(char **dest, struct stream_pos *src,
  53                 const struct declaration_string *string_declaration);
  54         void (*string_write)(struct stream_pos *dest, const char *src,
  55                 const struct declaration_string *string_declaration);
  56         void (*string_free_temp)(char *string);
  57
  58         /*
  59          * enum_read returns a GArray of GQuark. Must be released with
  60          * g_array_unref().
  61          */
  62         GArray *(*enum_read)(struct stream_pos *pos,
  63                 const struct declaration_enum *src);
  64         void (*enum_write)(struct stream_pos *pos,
  65                 const struct declaration_enum *dest,
  66                 GQuark q);
  67         void (*struct_begin)(struct stream_pos *pos,
  68                 const struct declaration_struct *struct_declaration);
  69         void (*struct_end)(struct stream_pos *pos,
  70                 const struct declaration_struct *struct_declaration);
  71         void (*variant_begin)(struct stream_pos *pos,
  72                 const struct declaration_variant *variant_declaration);
  73         void (*variant_end)(struct stream_pos *pos,
  74                 const struct declaration_variant *variant_declaration);
  75         void (*array_begin)(struct stream_pos *pos,
  76                 const struct declaration_array *array_declaration);
  77         void (*array_end)(struct stream_pos *pos,
  78                 const struct declaration_array *array_declaration);
  79         void (*sequence_begin)(struct stream_pos *pos,
  80                 const struct declaration_sequence *sequence_declaration);
  81         void (*sequence_end)(struct stream_pos *pos,
  82                 const struct declaration_sequence *sequence_declaration);
  83 };
  84
  85 struct format *bt_lookup_format(GQuark qname);
  86 void bt_fprintf_format_list(FILE *fp);
  87 int bt_register_format(struct format *format);
  88
  89 /* TBD: format unregistration */
  90
  91 #endif /* _BABELTRACE_FORMAT_H */