Dynamic definition scope hierarchy
[babeltrace.git] / include / babeltrace / types.h
index fd174b08c3704be074129bd7a094da3b72bb3a66..34e49aef18b7be474fb74f7221701f5e709deae4 100644 (file)
@@ -85,26 +85,35 @@ char *get_pos_addr(struct stream_pos *pos)
 }
 
 struct format;
-struct declaration;
+struct definition;
 
 /* type scope */
-struct type_scope {
+struct declaration_scope {
        /* Hash table mapping type name GQuark to "struct declaration" */
-       GHashTable *type_declarations;
-       /* Hash table mapping struct name GQuark to "struct type_struct" */
-       GHashTable *struct_types;
-       /* Hash table mapping variant name GQuark to "struct type_variant" */
-       GHashTable *variant_types;
+       GHashTable *typedef_declarations;
+       /* Hash table mapping struct name GQuark to "struct declaration_struct" */
+       GHashTable *struct_declarations;
+       /* Hash table mapping variant name GQuark to "struct declaration_variant" */
+       GHashTable *variant_declarations;
        /* Hash table mapping enum name GQuark to "struct type_enum" */
-       GHashTable *enum_types;
-       struct type_scope *parent_scope;
+       GHashTable *enum_declarations;
+       struct declaration_scope *parent_scope;
 };
 
-/* declaration scope */
-struct declaration_scope {
-       /* Hash table mapping field name GQuark to "struct declaration" */
-       GHashTable *declarations;
-       struct declaration_scope *parent_scope;
+/* definition scope */
+struct definition_scope {
+       /* Hash table mapping field name GQuark to "struct definition" */
+       GHashTable *definitions;
+       struct definition_scope *parent_scope;
+       /*
+        * Complete "path" leading to this definition scope.
+        * Includes dynamic scope name '.' field name '.' field name '.' ....
+        * Array of GQuark elements (which are each separated by dots).
+        * The dynamic scope name can contain dots, and is encoded into
+        * a single GQuark. Thus, scope_path[0] returns the GQuark
+        * identifying the dynamic scope.
+        */
+       GArray *scope_path;     /* array of GQuark */
 };
 
 enum ctf_type_id {
@@ -120,34 +129,36 @@ enum ctf_type_id {
        NR_CTF_TYPES,
 };
 
-struct type {
+struct declaration {
        enum ctf_type_id id;
        GQuark name;            /* type name */
        size_t alignment;       /* type alignment, in bits */
        int ref;                /* number of references to the type */
-       /*
-        * type_free called with type ref is decremented to 0.
-        */
-       void (*type_free)(struct type *type);
-       struct declaration *
-               (*declaration_new)(struct type *type,
-                                  struct declaration_scope *parent_scope);
        /*
         * declaration_free called with declaration ref is decremented to 0.
         */
        void (*declaration_free)(struct declaration *declaration);
+       struct definition *
+               (*definition_new)(struct declaration *declaration,
+                                 struct definition_scope *parent_scope,
+                                 GQuark field_name, int index);
+       /*
+        * definition_free called with definition ref is decremented to 0.
+        */
+       void (*definition_free)(struct definition *definition);
        /*
-        * Declaration copy function. Knows how to find the child declaration
-        * from the parent declaration.
+        * Definition copy function. Knows how to find the child
+        * definition from the parent definition.
         */
        void (*copy)(struct stream_pos *dest, const struct format *fdest, 
                     struct stream_pos *src, const struct format *fsrc,
-                    struct declaration *declaration);
+                    struct definition *definition);
 };
 
-struct declaration {
-       struct type *type;
-       int ref;                /* number of references to the declaration */
+struct definition {
+       struct declaration *declaration;
+       int index;              /* Position of the definition in its container */
+       int ref;                /* number of references to the definition */
 };
 
 /*
@@ -155,16 +166,16 @@ struct declaration {
  * integers, except that their read/write functions must be able to deal with
  * read/write non aligned on CHAR_BIT.
  */
-struct type_integer {
-       struct type p;
+struct declaration_integer {
+       struct declaration p;
        size_t len;             /* length, in bits. */
        int byte_order;         /* byte order */
        int signedness;
 };
 
-struct declaration_integer {
-       struct declaration p;
-       struct type_integer *type;
+struct definition_integer {
+       struct definition p;
+       struct declaration_integer *declaration;
        /* Last values read */
        union {
                uint64_t _unsigned;
@@ -172,18 +183,18 @@ struct declaration_integer {
        } value;
 };
 
-struct type_float {
-       struct type p;
-       struct type_integer *sign;
-       struct type_integer *mantissa;
-       struct type_integer *exp;
+struct declaration_float {
+       struct declaration p;
+       struct declaration_integer *sign;
+       struct declaration_integer *mantissa;
+       struct declaration_integer *exp;
        int byte_order;
        /* TODO: we might want to express more info about NaN, +inf and -inf */
 };
 
-struct declaration_float {
-       struct declaration p;
-       struct type_float *type;
+struct definition_float {
+       struct definition p;
+       struct declaration_float *declaration;
        /* Last values read */
        long double value;
 };
@@ -226,154 +237,163 @@ struct enum_table {
        GHashTable *quark_to_range_set;         /* (GQuark, range GArray) */
 };
 
-struct type_enum {
-       struct type p;
-       struct type_integer *integer_type;
+struct declaration_enum {
+       struct declaration p;
+       struct declaration_integer *integer_declaration;
        struct enum_table table;
 };
 
-struct declaration_enum {
-       struct declaration p;
-       struct declaration_integer *integer;
-       struct type_enum *type;
+struct definition_enum {
+       struct definition p;
+       struct definition_integer *integer;
+       struct declaration_enum *declaration;
        /* Last GQuark values read. Keeping a reference on the GQuark array. */
        GArray *value;
 };
 
-struct type_string {
-       struct type p;
-};
-
 struct declaration_string {
        struct declaration p;
-       struct type_string *type;
-       char *value;    /* freed at declaration_string teardown */
 };
 
-struct type_field {
-       GQuark name;
-       struct type *type;
+struct definition_string {
+       struct definition p;
+       struct declaration_string *declaration;
+       char *value;    /* freed at definition_string teardown */
 };
 
-struct field {
+struct declaration_field {
        GQuark name;
        struct declaration *declaration;
 };
 
-struct type_struct {
-       struct type p;
-       GHashTable *fields_by_name;     /* Tuples (field name, field index) */
-       struct type_scope *scope;
-       GArray *fields;                 /* Array of type_field */
+struct field {
+       GQuark name;
+       struct definition *definition;
 };
 
 struct declaration_struct {
        struct declaration p;
-       struct type_struct *type;
+       GHashTable *fields_by_name;     /* Tuples (field name, field index) */
        struct declaration_scope *scope;
-       GArray *fields;                 /* Array of struct field */
+       GArray *fields;                 /* Array of declaration_field */
 };
 
-struct type_variant {
-       struct type p;
-       GHashTable *fields_by_tag;      /* Tuples (field tag, field index) */
-       struct type_scope *scope;
-       GArray *fields;                 /* Array of type_field */
+struct definition_struct {
+       struct definition p;
+       struct declaration_struct *declaration;
+       struct definition_scope *scope;
+       GArray *fields;                 /* Array of struct field */
 };
 
 struct declaration_variant {
        struct declaration p;
-       struct type_variant *type;
+       GHashTable *fields_by_tag;      /* Tuples (field tag, field index) */
        struct declaration_scope *scope;
-       struct declaration *enum_tag;
-       GArray *fields;                 /* Array of struct field */
-       struct field *current_field;    /* Last field read */
+       GArray *fields;                 /* Array of declaration_field */
+       GQuark tag_name;                /* TODO */
+       /* Tag name must be nonzero and must exist when defining the variant */
 };
 
-struct type_array {
-       struct type p;
-       size_t len;
-       struct type *elem;
-       struct type_scope *scope;
+struct definition_variant {
+       struct definition p;
+       struct declaration_variant *declaration;
+       struct definition_scope *scope;
+       struct definition *enum_tag;
+       GArray *fields;                 /* Array of struct field */
+       struct field *current_field;    /* Last field read */
 };
 
 struct declaration_array {
        struct declaration p;
-       struct type_array *type;
+       size_t len;
+       struct declaration *elem;
        struct declaration_scope *scope;
-       struct field current_element;           /* struct field */
 };
 
-struct type_sequence {
-       struct type p;
-       struct type_integer *len_type;
-       struct type *elem;
-       struct type_scope *scope;
+struct definition_array {
+       struct definition p;
+       struct declaration_array *declaration;
+       struct definition_scope *scope;
+       struct field current_element;           /* struct field */
 };
 
 struct declaration_sequence {
        struct declaration p;
-       struct type_sequence *type;
+       struct declaration_integer *len_declaration;
+       struct declaration *elem;
        struct declaration_scope *scope;
-       struct declaration_integer *len;
+};
+
+struct definition_sequence {
+       struct definition p;
+       struct declaration_sequence *declaration;
+       struct definition_scope *scope;
+       struct definition_integer *len;
        struct field current_element;           /* struct field */
 };
 
-/*
- * type_declaration is for typedef and typealias. They are registered
- * into type scopes.
- */
-int register_type_declaration(GQuark type_name, struct declaration *declaration,
-                             struct type_scope *scope);
-struct declaration *lookup_type_declaration(GQuark type_name,
-                                           struct type_scope *scope);
+int register_declaration(GQuark declaration_name,
+                        struct declaration *declaration,
+                        struct declaration_scope *scope);
+struct declaration *lookup_declaration(GQuark declaration_name,
+                                      struct declaration_scope *scope);
 
 /*
  * Type scopes also contain a separate registry for struct, variant and
- * enum types. Those register types rather than type declarations, so
+ * enum types. Those register types rather than type definitions, so
  * that a named variant can be declared without specifying its target
  * "choice" tag field immediately.
  */
-int register_struct_type(GQuark struct_name, struct type_struct *struct_type,
-                        struct type_scope *scope);
-struct type_struct *lookup_struct_type(GQuark struct_name,
-                                      struct type_scope *scope);
-int register_variant_type(GQuark variant_name,
-                         struct type_variant *variant_type,
-                         struct type_scope *scope);
-struct type_variant *lookup_variant_type(GQuark variant_name,
-                                        struct type_scope *scope);
-int register_enum_type(GQuark enum_name, struct type_enum *enum_type,
-                      struct type_scope *scope);
-struct type_enum *lookup_enum_type(GQuark enum_name,
-                                  struct type_scope *scope);
-
-struct type_scope *new_type_scope(struct type_scope *parent_scope);
-void free_type_scope(struct type_scope *scope);
+int register_struct_declaration(GQuark struct_name,
+                               struct declaration_struct *struct_declaration,
+                               struct declaration_scope *scope);
+struct declaration_struct *
+       lookup_struct_declaration(GQuark struct_name,
+                                 struct declaration_scope *scope);
+int register_variant_declaration(GQuark variant_name,
+                         struct declaration_variant *variant_declaration,
+                         struct declaration_scope *scope);
+struct declaration_variant *lookup_variant_declaration(GQuark variant_name,
+                                        struct declaration_scope *scope);
+int register_enum_declaration(GQuark enum_name,
+                             struct declaration_enum *enum_declaration,
+                             struct declaration_scope *scope);
+struct declaration_enum *
+       lookup_enum_declaration(GQuark enum_name,
+                               struct declaration_scope *scope);
 
-/*
- * field_declaration is for field declarations. They are registered into
- * declaration scopes.
- */
-struct declaration *
-       lookup_field_declaration(GQuark field_name,
-                                struct declaration_scope *scope);
-int register_field_declaration(GQuark field_name,
-                              struct declaration *declaration,
-                              struct declaration_scope *scope);
 struct declaration_scope *
        new_declaration_scope(struct declaration_scope *parent_scope);
 void free_declaration_scope(struct declaration_scope *scope);
 
-void type_ref(struct type *type);
-void type_unref(struct type *type);
+/*
+ * field_definition is for field definitions. They are registered into
+ * definition scopes.
+ */
+struct definition *
+       lookup_definition(GArray *cur_path,     /* array of GQuark */
+                         GArray *lookup_path,  /* array of GQuark */
+                         struct definition_scope *scope);
+int register_field_definition(GQuark field_name,
+                             struct definition *definition,
+                             struct definition_scope *scope);
+struct definition_scope *
+       new_definition_scope(struct definition_scope *parent_scope,
+                            GQuark field_name);
+struct definition_scope *
+       new_dynamic_definition_scope(struct definition_scope *parent_scope,
+                                    GQuark field_name);
+void free_definition_scope(struct definition_scope *scope);
 
 void declaration_ref(struct declaration *declaration);
 void declaration_unref(struct declaration *declaration);
 
-/* Nameless types can be created by passing a NULL name */
+void definition_ref(struct definition *definition);
+void definition_unref(struct definition *definition);
+
+/* Nameless declarations can be created by passing a NULL name */
 
-struct type_integer *integer_type_new(const char *name,
+struct declaration_integer *integer_declaration_new(const char *name,
                                      size_t len, int byte_order,
                                      int signedness, size_t alignment);
 
@@ -381,7 +401,7 @@ struct type_integer *integer_type_new(const char *name,
  * mantissa_len is the length of the number of bytes represented by the mantissa
  * (e.g. result of DBL_MANT_DIG). It includes the leading 1.
  */
-struct type_float *float_type_new(const char *name,
+struct declaration_float *float_declaration_new(const char *name,
                                  size_t mantissa_len,
                                  size_t exp_len, int byte_order,
                                  size_t alignment);
@@ -395,46 +415,52 @@ struct type_float *float_type_new(const char *name,
  * Returns a GArray of GQuark or NULL.
  * Caller must release the GArray with g_array_unref().
  */
-GArray *enum_uint_to_quark_set(const struct type_enum *enum_type, uint64_t v);
+GArray *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 type_enum *enum_type, uint64_t v);
+GArray *enum_int_to_quark_set(const struct declaration_enum *enum_declaration,
+                             uint64_t v);
 
 /*
  * Returns a GArray of struct enum_range or NULL.
  * Callers do _not_ own the returned GArray (and therefore _don't_ need to
  * release it).
  */
-GArray *enum_quark_to_range_set(const struct type_enum *enum_type, GQuark q);
-void enum_signed_insert(struct type_enum *enum_type,
+GArray *enum_quark_to_range_set(const struct declaration_enum *enum_declaration,
+                               GQuark q);
+void enum_signed_insert(struct declaration_enum *enum_declaration,
                         int64_t start, int64_t end, GQuark q);
-void enum_unsigned_insert(struct type_enum *enum_type,
+void enum_unsigned_insert(struct declaration_enum *enum_declaration,
                          uint64_t start, uint64_t end, GQuark q);
-size_t enum_get_nr_enumerators(struct type_enum *enum_type);
-
-struct type_enum *enum_type_new(const char *name,
-                               struct type_integer *integer_type);
-
-struct type_struct *struct_type_new(const char *name,
-                                   struct type_scope *parent_scope);
-void struct_type_add_field(struct type_struct *struct_type,
-                          const char *field_name, struct type *field_type);
+size_t enum_get_nr_enumerators(struct declaration_enum *enum_declaration);
+
+struct declaration_enum *
+       enum_declaration_new(const char *name,
+                            struct declaration_integer *integer_declaration);
+
+struct declaration_struct *
+       struct_declaration_new(const char *name,
+                              struct declaration_scope *parent_scope);
+void struct_declaration_add_field(struct declaration_struct *struct_declaration,
+                                 const char *field_name,
+                                 struct declaration *field_declaration);
 /*
  * Returns the index of a field within a structure.
  */
-unsigned long struct_type_lookup_field_index(struct type_struct *struct_type,
-                                            GQuark field_name);
+unsigned long struct_declaration_lookup_field_index(struct declaration_struct *struct_declaration,
+                                                   GQuark field_name);
 /*
  * field returned only valid as long as the field structure is not appended to.
  */
-struct type_field *
-struct_type_get_field_from_index(struct type_struct *struct_type,
-                                unsigned long index);
+struct declaration_field *
+struct_declaration_get_field_from_index(struct declaration_struct *struct_declaration,
+                                       unsigned long index);
 struct field *
-struct_get_field_from_index(struct declaration_struct *struct_declaration,
+struct_get_field_from_index(struct definition_struct *struct_definition,
                            unsigned long index);
 
 /*
@@ -442,40 +468,44 @@ struct_get_field_from_index(struct declaration_struct *struct_declaration,
  * from numeric values to a single tag. Overlapping tag value ranges are
  * therefore forbidden.
  */
-struct type_variant *variant_type_new(const char *name,
-                                     struct type_scope *parent_scope);
-void variant_type_add_field(struct type_variant *variant_type,
-                           const char *tag_name, struct type *tag_type);
-struct type_field *
-variant_type_get_field_from_tag(struct type_variant *variant_type, GQuark tag);
+struct declaration_variant *variant_declaration_new(const char *name,
+               struct declaration_scope *parent_scope);
+void variant_declaration_add_field(struct declaration_variant *variant_declaration,
+               const char *tag_name,
+               struct declaration *tag_declaration);
+struct declaration_field *
+       variant_declaration_get_field_from_tag(struct declaration_variant *variant_declaration,
+               GQuark tag);
 /*
  * Returns 0 on success, -EPERM on error.
  */
-int variant_declaration_set_tag(struct declaration_variant *variant,
-                               struct declaration *enum_tag);
+int variant_definition_set_tag(struct definition_variant *variant,
+                              struct definition *enum_tag);
 /*
  * Returns the field selected by the current tag value.
  * field returned only valid as long as the variant structure is not appended
  * to.
  */
-struct field *
-variant_get_current_field(struct declaration_variant *variant);
+struct field *variant_get_current_field(struct definition_variant *variant);
 
 /*
- * elem_type passed as parameter now belongs to the array. No need to free it
- * explicitly. "len" is the number of elements in the array.
+ * elem_declaration passed as parameter now belongs to the array. No
+ * need to free it explicitly. "len" is the number of elements in the
+ * array.
  */
-struct type_array *array_type_new(const char *name,
-                                 size_t len, struct type *elem_type,
-                                 struct type_scope *parent_scope);
+struct declaration_array *
+       array_declaration_new(const char *name,
+               size_t len, struct declaration *elem_declaration,
+               struct declaration_scope *parent_scope);
 
 /*
- * int_type and elem_type passed as parameter now belong to the sequence. No
- * need to free them explicitly.
+ * int_declaration and elem_declaration passed as parameter now belong
+ * to the sequence. No need to free them explicitly.
  */
-struct type_sequence *sequence_type_new(const char *name,
-                                       struct type_integer *len_type, 
-                                       struct type *elem_type,
-                                       struct type_scope *parent_scope);
+struct declaration_sequence *
+       sequence_declaration_new(const char *name,
+               struct declaration_integer *len_declaration, 
+               struct declaration *elem_declaration,
+               struct declaration_scope *parent_scope);
 
-#endif /* _BABELTRACE_TYPES_H */
+#endif /* _BABELTRACE_declarationS_H */
This page took 0.032464 seconds and 4 git commands to generate.