namespace the enum functions
[babeltrace.git] / include / babeltrace / types.h
index 41f70383c254af13d1f1a8d03fbee4652f00389c..15bbef36c328ffcb970d6027d8dafc62bc86c214 100644 (file)
  *
  * The above copyright notice and this permission notice shall be included in
  * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
  */
 
 #include <babeltrace/align.h>
 #include <babeltrace/list.h>
+#include <babeltrace/ctf/events.h>
 #include <stdbool.h>
 #include <stdint.h>
 #include <limits.h>
 /* Preallocate this many fields for structures */
 #define DEFAULT_NR_STRUCT_FIELDS 8
 
-struct ctf_stream;
+struct ctf_stream_definition;
 struct stream_pos;
 struct format;
 struct definition;
+struct ctf_clock;
 
 /* type scope */
 struct declaration_scope {
@@ -68,20 +78,6 @@ struct definition_scope {
        GArray *scope_path;     /* array of GQuark */
 };
 
-enum ctf_type_id {
-       CTF_TYPE_UNKNOWN = 0,
-       CTF_TYPE_INTEGER,
-       CTF_TYPE_FLOAT,
-       CTF_TYPE_ENUM,
-       CTF_TYPE_STRING,
-       CTF_TYPE_STRUCT,
-       CTF_TYPE_UNTAGGED_VARIANT,
-       CTF_TYPE_VARIANT,
-       CTF_TYPE_ARRAY,
-       CTF_TYPE_SEQUENCE,
-       NR_CTF_TYPES,
-};
-
 struct declaration {
        enum ctf_type_id id;
        size_t alignment;       /* type alignment, in bits */
@@ -118,7 +114,7 @@ struct stream_pos {
        /* read/write dispatch table. Specific to plugin used for stream. */
        rw_dispatch *rw_table;  /* rw dispatch table */
        int (*event_cb)(struct stream_pos *pos,
-                       struct ctf_stream *stream);
+                       struct ctf_stream_definition *stream);
 };
 
 static inline
@@ -132,13 +128,6 @@ int generic_rw(struct stream_pos *pos, struct definition *definition)
        return call(pos, definition);
 }
 
-enum ctf_string_encoding {
-       CTF_STRING_NONE = 0,
-       CTF_STRING_UTF8,
-       CTF_STRING_ASCII,
-       CTF_STRING_UNKNOWN,
-};
-
 /*
  * Because we address in bits, bitfields end up being exactly the same as
  * integers, except that their read/write functions must be able to deal with
@@ -151,6 +140,7 @@ struct declaration_integer {
        int signedness;
        int base;               /* Base for pretty-printing: 2, 8, 10, 16 */
        enum ctf_string_encoding encoding;
+       struct ctf_clock *clock;
 };
 
 struct definition_integer {
@@ -197,7 +187,7 @@ struct enum_range {
 };
 
 struct enum_range_to_quark {
-       struct cds_list_head node;
+       struct bt_list_head node;
        struct enum_range range;
        GQuark quark;
 };
@@ -216,7 +206,7 @@ struct enum_range_to_quark {
  */
 struct enum_table {
        GHashTable *value_to_quark_set;         /* (value, GQuark GArray) */
-       struct cds_list_head range_to_quark;    /* (range, GQuark) */
+       struct bt_list_head range_to_quark;     /* (range, GQuark) */
        GHashTable *quark_to_range_set;         /* (GQuark, range GArray) */
 };
 
@@ -374,17 +364,23 @@ int compare_definition_path(struct definition *definition, GQuark path)
        return definition->path == path;
 }
 
-void declaration_ref(struct declaration *declaration);
-void declaration_unref(struct declaration *declaration);
+void bt_declaration_ref(struct declaration *declaration);
+void bt_declaration_unref(struct declaration *declaration);
 
-void definition_ref(struct definition *definition);
-void definition_unref(struct definition *definition);
+void bt_definition_ref(struct definition *definition);
+void bt_definition_unref(struct definition *definition);
 
 struct declaration_integer *integer_declaration_new(size_t len, int byte_order,
                                  int signedness, size_t alignment,
-                                 int base, enum ctf_string_encoding encoding);
-uint64_t get_unsigned_int(struct definition *field);
-int64_t get_signed_int(struct definition *field);
+                                 int base, enum ctf_string_encoding encoding,
+                                 struct ctf_clock *clock);
+uint64_t get_unsigned_int(const struct definition *field);
+int64_t get_signed_int(const struct definition *field);
+int get_int_signedness(const struct definition *field);
+int get_int_byte_order(const struct definition *field);
+int get_int_base(const struct definition *field);
+size_t get_int_len(const struct definition *field);    /* in bits */
+enum ctf_string_encoding get_int_encoding(const struct definition *field);
 
 /*
  * mantissa_len is the length of the number of bytes represented by the mantissa
@@ -403,14 +399,14 @@ struct declaration_float *float_declaration_new(size_t mantissa_len,
  * Returns a GArray of GQuark or NULL.
  * Caller must release the GArray with g_array_unref().
  */
-GArray *enum_uint_to_quark_set(const struct declaration_enum *enum_declaration,
+GArray *bt_enum_uint_to_quark_set(const struct declaration_enum *enum_declaration,
                               uint64_t v);
 
 /*
  * Returns a GArray of GQuark or NULL.
  * Caller must release the GArray with g_array_unref().
  */
-GArray *enum_int_to_quark_set(const struct declaration_enum *enum_declaration,
+GArray *bt_enum_int_to_quark_set(const struct declaration_enum *enum_declaration,
                              int64_t v);
 
 /*
@@ -418,19 +414,21 @@ GArray *enum_int_to_quark_set(const struct declaration_enum *enum_declaration,
  * Callers do _not_ own the returned GArray (and therefore _don't_ need to
  * release it).
  */
-GArray *enum_quark_to_range_set(const struct declaration_enum *enum_declaration,
+GArray *bt_enum_quark_to_range_set(const struct declaration_enum *enum_declaration,
                                GQuark q);
-void enum_signed_insert(struct declaration_enum *enum_declaration,
+void bt_enum_signed_insert(struct declaration_enum *enum_declaration,
                         int64_t start, int64_t end, GQuark q);
-void enum_unsigned_insert(struct declaration_enum *enum_declaration,
+void bt_enum_unsigned_insert(struct declaration_enum *enum_declaration,
                          uint64_t start, uint64_t end, GQuark q);
-size_t enum_get_nr_enumerators(struct declaration_enum *enum_declaration);
+size_t bt_enum_get_nr_enumerators(struct declaration_enum *enum_declaration);
 
 struct declaration_enum *
-       enum_declaration_new(struct declaration_integer *integer_declaration);
+       bt_enum_declaration_new(struct declaration_integer *integer_declaration);
 
 struct declaration_string *
        string_declaration_new(enum ctf_string_encoding encoding);
+char *get_string(const struct definition *field);
+enum ctf_string_encoding get_string_encoding(const struct definition *field);
 
 struct declaration_struct *
        struct_declaration_new(struct declaration_scope *parent_scope,
@@ -490,12 +488,13 @@ int variant_rw(struct stream_pos *pos, struct definition *definition);
  * array.
  */
 struct declaration_array *
-       array_declaration_new(size_t len, struct declaration *elem_declaration,
+       bt_array_declaration_new(size_t len, struct declaration *elem_declaration,
                struct declaration_scope *parent_scope);
-uint64_t array_len(struct definition_array *array);
-struct definition *array_index(struct definition_array *array, uint64_t i);
-int array_rw(struct stream_pos *pos, struct definition *definition);
-GString *get_char_array(struct definition *field);
+uint64_t bt_array_len(struct definition_array *array);
+struct definition *bt_array_index(struct definition_array *array, uint64_t i);
+int bt_array_rw(struct stream_pos *pos, struct definition *definition);
+GString *bt_get_char_array(const struct definition *field);
+int bt_get_array_len(const struct definition *field);
 
 /*
  * int_declaration and elem_declaration passed as parameter now belong
@@ -512,20 +511,29 @@ int sequence_rw(struct stream_pos *pos, struct definition *definition);
 /*
  * in: path (dot separated), out: q (GArray of GQuark)
  */
-void append_scope_path(const char *path, GArray *q);
+void bt_append_scope_path(const char *path, GArray *q);
 
 /*
  * Lookup helpers.
  */
-struct definition *lookup_definition(struct definition *definition,
+struct definition *lookup_definition(const struct definition *definition,
                                     const char *field_name);
-struct definition_integer *lookup_integer(struct definition *definition,
+struct definition_integer *lookup_integer(const struct definition *definition,
                                          const char *field_name,
                                          int signedness);
-struct definition_enum *lookup_enum(struct definition *definition,
+struct definition_enum *bt_lookup_enum(const struct definition *definition,
                                    const char *field_name,
                                    int signedness);
-struct definition *lookup_variant(struct definition *definition,
+struct definition *lookup_variant(const struct definition *definition,
                                  const char *field_name);
 
+static inline
+const char *rem_(const char *str)
+{
+       if (str[0] == '_')
+               return &str[1];
+       else
+               return str;
+}
+
 #endif /* _BABELTRACE_TYPES_H */
This page took 0.029748 seconds and 4 git commands to generate.