Fix: emf uri: surround by " "
[babeltrace.git] / types / variant.c
index 3c2244be88bc8c934e123d63ba5785d351a9ad24..faf70dde200e6bbff757ecc889e1132e5dca5cde 100644 (file)
@@ -3,7 +3,9 @@
  *
  * BabelTrace - Variant Type Converter
  *
- * Copyright 2011 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
+ * Copyright 2010-2011 EfficiOS Inc. and Linux Foundation
+ *
+ * Author: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
 
 #include <babeltrace/compiler.h>
 #include <babeltrace/format.h>
+#include <babeltrace/types.h>
 #include <errno.h>
 
 static
-struct declaration *_variant_declaration_new(struct type *type,
-                               struct declaration_scope *parent_scope);
+struct definition *_variant_definition_new(struct declaration *declaration,
+                               struct definition_scope *parent_scope,
+                               GQuark field_name, int index,
+                               const char *root_name);
 static
-void _variant_declaration_free(struct declaration *declaration);
+void _variant_definition_free(struct definition *definition);
 
-void variant_copy(struct stream_pos *dest, const struct format *fdest, 
-                 struct stream_pos *src, const struct format *fsrc,
-                 struct declaration *declaration)
+int variant_rw(struct stream_pos *ppos, struct definition *definition)
 {
-       struct declaration_variant *variant =
-               container_of(declaration, struct declaration_variant, p);
-       struct type_variant *variant_type = variant->type;
-       struct field *field;
-       struct type *field_type;
-
-       fsrc->variant_begin(src, variant_type);
-       fdest->variant_begin(dest, variant_type);
+       struct definition_variant *variant_definition =
+               container_of(definition, struct definition_variant, p);
+       struct definition *field;
 
-       field = variant_get_current_field(variant);
-       field_type = field->declaration->type;
-       field_type->copy(dest, fdest, src, fsrc, field->declaration);
-
-       fsrc->variant_end(src, variant_type);
-       fdest->variant_end(dest, variant_type);
+       field = variant_get_current_field(variant_definition);
+       return generic_rw(ppos, field);
 }
 
 static
-void _variant_type_free(struct type *type)
+void _untagged_variant_declaration_free(struct declaration *declaration)
 {
-       struct type_variant *variant_type =
-               container_of(type, struct type_variant, p);
+       struct declaration_untagged_variant *untagged_variant_declaration =
+               container_of(declaration, struct declaration_untagged_variant, p);
        unsigned long i;
 
-       g_hash_table_destroy(variant_type->fields_by_tag);
+       free_declaration_scope(untagged_variant_declaration->scope);
+       g_hash_table_destroy(untagged_variant_declaration->fields_by_tag);
 
-       for (i = 0; i < variant_type->fields->len; i++) {
-               struct type_field *type_field =
-                       &g_array_index(variant_type->fields,
-                                      struct type_field, i);
-               type_unref(type_field->type);
+       for (i = 0; i < untagged_variant_declaration->fields->len; i++) {
+               struct declaration_field *declaration_field =
+                       &g_array_index(untagged_variant_declaration->fields,
+                                      struct declaration_field, i);
+               declaration_unref(declaration_field->declaration);
        }
-       g_array_free(variant_type->fields, true);
-       g_free(variant_type);
+       g_array_free(untagged_variant_declaration->fields, true);
+       g_free(untagged_variant_declaration);
 }
 
-struct type_variant *variant_type_new(const char *name)
+struct declaration_untagged_variant *untagged_variant_declaration_new(
+                                     struct declaration_scope *parent_scope)
 {
-       struct type_variant *variant_type;
-       struct type *type;
+       struct declaration_untagged_variant *untagged_variant_declaration;
+       struct declaration *declaration;
 
-       variant_type = g_new(struct type_variant, 1);
-       type = &variant_type->p;
-       variant_type->fields_by_tag = g_hash_table_new(g_direct_hash,
+       untagged_variant_declaration = g_new(struct declaration_untagged_variant, 1);
+       declaration = &untagged_variant_declaration->p;
+       untagged_variant_declaration->fields_by_tag = g_hash_table_new(g_direct_hash,
                                                       g_direct_equal);
-       variant_type->fields = g_array_sized_new(FALSE, TRUE,
-                                                sizeof(struct type_field),
+       untagged_variant_declaration->fields = g_array_sized_new(FALSE, TRUE,
+                                                sizeof(struct declaration_field),
                                                 DEFAULT_NR_STRUCT_FIELDS);
-       type->name = g_quark_from_string(name);
-       type->alignment = 1;
-       type->copy = variant_copy;
-       type->type_free = _variant_type_free;
-       type->declaration_new = _variant_declaration_new;
-       type->declaration_free = _variant_declaration_free;
-       type->ref = 1;
-       return variant_type;
-}
-
-static
-struct declaration *
-       _variant_declaration_new(struct type *type,
-                                struct declaration_scope *parent_scope)
-{
-       struct type_variant *variant_type =
-               container_of(type, struct type_variant, p);
-       struct declaration_variant *variant;
-       unsigned long i;
-
-       variant = g_new(struct declaration_variant, 1);
-       type_ref(&variant_type->p);
-       variant->p.type = type;
-       variant->type = variant_type;
-       variant->p.ref = 1;
-       variant->scope = new_declaration_scope(parent_scope);
-       variant->fields = g_array_sized_new(FALSE, TRUE,
-                                           sizeof(struct field),
-                                           DEFAULT_NR_STRUCT_FIELDS);
-       g_array_set_size(variant->fields, variant_type->fields->len);
-       for (i = 0; i < variant_type->fields->len; i++) {
-               struct type_field *type_field =
-                       &g_array_index(variant_type->fields,
-                                      struct type_field, i);
-               struct field *field = &g_array_index(variant->fields,
-                                                    struct field, i);
-
-               field->name = type_field->name;
-               field->declaration =
-                       type_field->type->declaration_new(type_field->type,
-                                                         variant->scope);
-       }
-       variant->current_field = NULL;
-       return &variant->p;
+       untagged_variant_declaration->scope = new_declaration_scope(parent_scope);
+       declaration->id = CTF_TYPE_UNTAGGED_VARIANT;
+       declaration->alignment = 1;
+       declaration->declaration_free = _untagged_variant_declaration_free;
+       declaration->definition_new = NULL;
+       declaration->definition_free = NULL;
+       declaration->ref = 1;
+       return untagged_variant_declaration;
 }
 
 static
 void _variant_declaration_free(struct declaration *declaration)
 {
-       struct declaration_variant *variant =
+       struct declaration_variant *variant_declaration =
                container_of(declaration, struct declaration_variant, p);
-       unsigned long i;
-
-       assert(variant->fields->len == variant->type->fields->len);
-       for (i = 0; i < variant->fields->len; i++) {
-               struct field *field = &g_array_index(variant->fields,
-                                                    struct field, i);
-               declaration_unref(field->declaration);
-       }
-       free_declaration_scope(variant->scope);
-       type_unref(variant->p.type);
-       g_free(variant);
-}
-
-void variant_type_add_field(struct type_variant *variant_type,
-                           const char *tag_name,
-                           struct type *tag_type)
-{
-       struct type_field *field;
-       unsigned long index;
 
-       g_array_set_size(variant_type->fields, variant_type->fields->len + 1);
-       index = variant_type->fields->len - 1;  /* last field (new) */
-       field = &g_array_index(variant_type->fields, struct type_field, index);
-       field->name = g_quark_from_string(tag_name);
-       type_ref(tag_type);
-       field->type = tag_type;
-       /* Keep index in hash rather than pointer, because array can relocate */
-       g_hash_table_insert(variant_type->fields_by_tag,
-                           (gpointer) (unsigned long) field->name,
-                           (gpointer) index);
-       /*
-        * Alignment of variant is based on the alignment of its currently
-        * selected choice, so we leave variant alignment as-is (statically
-        * speaking).
-        */
+       _untagged_variant_declaration_free(&variant_declaration->untagged_variant->p);
+       g_array_free(variant_declaration->tag_name, TRUE);
 }
 
-struct type_field *
-struct_type_get_field_from_tag(struct type_variant *variant_type, GQuark tag)
+struct declaration_variant *
+       variant_declaration_new(struct declaration_untagged_variant *untagged_variant, const char *tag)
 {
-       unsigned long index;
+       struct declaration_variant *variant_declaration;
+       struct declaration *declaration;
 
-       index = (unsigned long) g_hash_table_lookup(variant_type->fields_by_tag,
-                                                   (gconstpointer) (unsigned long) tag);
-       return &g_array_index(variant_type->fields, struct type_field, index);
+       variant_declaration = g_new(struct declaration_variant, 1);
+       declaration = &variant_declaration->p;
+       variant_declaration->untagged_variant = untagged_variant;
+       declaration_ref(&untagged_variant->p);
+       variant_declaration->tag_name = g_array_new(FALSE, TRUE, sizeof(GQuark));
+       append_scope_path(tag, variant_declaration->tag_name);
+       declaration->id = CTF_TYPE_VARIANT;
+       declaration->alignment = 1;
+       declaration->declaration_free = _variant_declaration_free;
+       declaration->definition_new = _variant_definition_new;
+       declaration->definition_free = _variant_definition_free;
+       declaration->ref = 1;
+       return variant_declaration;
 }
 
 /*
  * tag_instance is assumed to be an enumeration.
+ * Returns 0 if OK, < 0 if error.
  */
-int variant_declaration_set_tag(struct declaration_variant *variant,
-                               struct declaration *enum_tag)
+static
+int check_enum_tag(struct definition_variant *variant,
+                  struct definition *enum_tag)
 {
-       struct declaration_enum *_enum =
-               container_of(variant->enum_tag, struct declaration_enum, p);
-       struct type_enum *enum_type = _enum->type;
+       struct definition_enum *_enum =
+               container_of(enum_tag, struct definition_enum, p);
+       struct declaration_enum *enum_declaration = _enum->declaration;
        int missing_field = 0;
        unsigned long i;
 
@@ -194,14 +135,14 @@ int variant_declaration_set_tag(struct declaration_variant *variant,
         * variant choice map to an enumerator too. We then validate that the
         * number of enumerators equals the number of variant choices.
         */
-       if (variant->type->fields->len != enum_get_nr_enumerators(enum_type))
+       if (variant->declaration->untagged_variant->fields->len != enum_get_nr_enumerators(enum_declaration))
                return -EPERM;
 
-       for (i = 0; i < variant->type->fields->len; i++) {
-               struct type_field *field_type =
-                       &g_array_index(variant->type->fields,
-                                      struct type_field, i);
-               if (!enum_quark_to_range_set(enum_type, field_type->name)) {
+       for (i = 0; i < variant->declaration->untagged_variant->fields->len; i++) {
+               struct declaration_field *field_declaration =
+                       &g_array_index(variant->declaration->untagged_variant->fields,
+                                      struct declaration_field, i);
+               if (!enum_quark_to_range_set(enum_declaration, field_declaration->name)) {
                        missing_field = 1;
                        break;
                }
@@ -214,22 +155,147 @@ int variant_declaration_set_tag(struct declaration_variant *variant,
         * enumerator tag.
         * TODO: we should also check that each range map to one and only one
         * tag. For the moment, we will simply check this dynamically in
-        * variant_type_get_current_field().
+        * variant_declaration_get_current_field().
         */
-
-       /* Set the enum tag field */
-       variant->enum_tag = enum_tag;
        return 0;
 }
 
+
+
+static
+struct definition *
+       _variant_definition_new(struct declaration *declaration,
+                               struct definition_scope *parent_scope,
+                               GQuark field_name, int index,
+                               const char *root_name)
+{
+       struct declaration_variant *variant_declaration =
+               container_of(declaration, struct declaration_variant, p);
+       struct definition_variant *variant;
+       unsigned long i;
+       int ret;
+
+       variant = g_new(struct definition_variant, 1);
+       declaration_ref(&variant_declaration->p);
+       variant->p.declaration = declaration;
+       variant->declaration = variant_declaration;
+       variant->p.ref = 1;
+       /*
+        * Use INT_MAX order to ensure that all fields of the parent
+        * scope are seen as being prior to this scope.
+        */
+       variant->p.index = root_name ? INT_MAX : index;
+       variant->p.name = field_name;
+       variant->p.path = new_definition_path(parent_scope, field_name, root_name);
+       variant->p.scope = new_definition_scope(parent_scope, field_name, root_name);
+
+       ret = register_field_definition(field_name, &variant->p,
+                                       parent_scope);
+       assert(!ret);
+
+       variant->enum_tag = lookup_path_definition(variant->p.scope->scope_path,
+                                                  variant_declaration->tag_name,
+                                                  parent_scope);
+                                             
+       if (!variant->enum_tag
+           || check_enum_tag(variant, variant->enum_tag) < 0)
+               goto error;
+       definition_ref(variant->enum_tag);
+       variant->fields = g_ptr_array_sized_new(variant_declaration->untagged_variant->fields->len);
+       g_ptr_array_set_size(variant->fields, variant_declaration->untagged_variant->fields->len);
+       for (i = 0; i < variant_declaration->untagged_variant->fields->len; i++) {
+               struct declaration_field *declaration_field =
+                       &g_array_index(variant_declaration->untagged_variant->fields,
+                                      struct declaration_field, i);
+               struct definition **field =
+                       (struct definition **) &g_ptr_array_index(variant->fields, i);
+
+               /*
+                * All child definition are at index 0, because they are
+                * various choices of the same field.
+                */
+               *field = declaration_field->declaration->definition_new(declaration_field->declaration,
+                                                 variant->p.scope,
+                                                 declaration_field->name, 0, NULL);
+               if (!*field)
+                       goto error;
+       }
+       variant->current_field = NULL;
+       return &variant->p;
+error:
+       free_definition_scope(variant->p.scope);
+       declaration_unref(&variant_declaration->p);
+       g_free(variant);
+       return NULL;
+}
+
+static
+void _variant_definition_free(struct definition *definition)
+{
+       struct definition_variant *variant =
+               container_of(definition, struct definition_variant, p);
+       unsigned long i;
+
+       assert(variant->fields->len == variant->declaration->untagged_variant->fields->len);
+       for (i = 0; i < variant->fields->len; i++) {
+               struct definition *field = g_ptr_array_index(variant->fields, i);
+               definition_unref(field);
+       }
+       definition_unref(variant->enum_tag);
+       free_definition_scope(variant->p.scope);
+       declaration_unref(variant->p.declaration);
+       g_free(variant);
+}
+
+void untagged_variant_declaration_add_field(struct declaration_untagged_variant *untagged_variant_declaration,
+                           const char *field_name,
+                           struct declaration *field_declaration)
+{
+       struct declaration_field *field;
+       unsigned long index;
+
+       g_array_set_size(untagged_variant_declaration->fields, untagged_variant_declaration->fields->len + 1);
+       index = untagged_variant_declaration->fields->len - 1;  /* last field (new) */
+       field = &g_array_index(untagged_variant_declaration->fields, struct declaration_field, index);
+       field->name = g_quark_from_string(field_name);
+       declaration_ref(field_declaration);
+       field->declaration = field_declaration;
+       /* Keep index in hash rather than pointer, because array can relocate */
+       g_hash_table_insert(untagged_variant_declaration->fields_by_tag,
+                           (gpointer) (unsigned long) field->name,
+                           (gpointer) index);
+       /*
+        * Alignment of variant is based on the alignment of its currently
+        * selected choice, so we leave variant alignment as-is (statically
+        * speaking).
+        */
+}
+
+struct declaration_field *
+untagged_variant_declaration_get_field_from_tag(struct declaration_untagged_variant *untagged_variant_declaration, GQuark tag)
+{
+       gpointer index;
+       gboolean found;
+
+       found = g_hash_table_lookup_extended(
+                               untagged_variant_declaration->fields_by_tag,
+                               (gconstpointer) (unsigned long) tag, NULL, &index);
+
+       if (!found) {
+               return NULL;
+       }
+
+       return &g_array_index(untagged_variant_declaration->fields, struct declaration_field, (unsigned long)index);
+}
+
 /*
  * field returned only valid as long as the field structure is not appended to.
  */
-struct field *variant_get_current_field(struct declaration_variant *variant)
+struct definition *variant_get_current_field(struct definition_variant *variant)
 {
-       struct declaration_enum *_enum =
-               container_of(variant->enum_tag, struct declaration_enum, p);
-       struct type_variant *variant_type = variant->type;
+       struct definition_enum *_enum =
+               container_of(variant->enum_tag, struct definition_enum, p);
+       struct declaration_variant *variant_declaration = variant->declaration;
        unsigned long index;
        GArray *tag_array;
        GQuark tag;
@@ -241,8 +307,8 @@ struct field *variant_get_current_field(struct declaration_variant *variant)
         */
        assert(tag_array->len == 1);
        tag = g_array_index(tag_array, GQuark, 0);
-       index = (unsigned long) g_hash_table_lookup(variant_type->fields_by_tag,
+       index = (unsigned long) g_hash_table_lookup(variant_declaration->untagged_variant->fields_by_tag,
                                                    (gconstpointer) (unsigned long) tag);
-       variant->current_field = &g_array_index(variant->fields, struct field, index);
+       variant->current_field = g_ptr_array_index(variant->fields, index);
        return variant->current_field;
 }
This page took 0.028914 seconds and 4 git commands to generate.