Rename "declaration" to "definition"
[babeltrace.git] / include / babeltrace / types.h
index 718d391a0dc9a90aa405da80cc263e8f2d421fd6..144b018a6146264f76819a29cfbda2f4c3612d8e 100644 (file)
@@ -85,18 +85,43 @@ char *get_pos_addr(struct stream_pos *pos)
 }
 
 struct format;
-struct declaration;
-
-/* Type declaration scope */
-struct declaration_scope {
-       /* Hash table mapping type name GQuark to struct type */
-       GHashTable *types;
-       /* Hash table mapping field name GQuark to struct declaration */
-       GHashTable *declarations;
-       struct declaration_scope *parent_scope;
+struct definition;
+
+/* type scope */
+struct type_scope {
+       /* Hash table mapping type name GQuark to "struct declaration" */
+       GHashTable *type_definitions;
+       /* 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;
+       /* Hash table mapping enum name GQuark to "struct type_enum" */
+       GHashTable *enum_types;
+       struct type_scope *parent_scope;
+};
+
+/* definition scope */
+struct definition_scope {
+       /* Hash table mapping field name GQuark to "struct definition" */
+       GHashTable *definitions;
+       struct definition_scope *parent_scope;
+};
+
+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_VARIANT,
+       CTF_TYPE_ARRAY,
+       CTF_TYPE_SEQUENCE,
+       NR_CTF_TYPES,
 };
 
 struct type {
+       enum ctf_type_id id;
        GQuark name;            /* type name */
        size_t alignment;       /* type alignment, in bits */
        int ref;                /* number of references to the type */
@@ -104,25 +129,25 @@ struct 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);
+       struct definition *
+               (*definition_new)(struct type *type,
+                                 struct definition_scope *parent_scope);
        /*
-        * declaration_free called with declaration ref is decremented to 0.
+        * definition_free called with definition ref is decremented to 0.
         */
-       void (*declaration_free)(struct declaration *declaration);
+       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 definition {
        struct type *type;
-       int ref;                /* number of references to the declaration */
+       int ref;                /* number of references to the definition */
 };
 
 /*
@@ -137,8 +162,8 @@ struct type_integer {
        int signedness;
 };
 
-struct declaration_integer {
-       struct declaration p;
+struct definition_integer {
+       struct definition p;
        struct type_integer *type;
        /* Last values read */
        union {
@@ -156,8 +181,8 @@ struct type_float {
        /* TODO: we might want to express more info about NaN, +inf and -inf */
 };
 
-struct declaration_float {
-       struct declaration p;
+struct definition_float {
+       struct definition p;
        struct type_float *type;
        /* Last values read */
        long double value;
@@ -207,9 +232,9 @@ struct type_enum {
        struct enum_table table;
 };
 
-struct declaration_enum {
-       struct declaration p;
-       struct declaration_integer *integer;
+struct definition_enum {
+       struct definition p;
+       struct definition_integer *integer;
        struct type_enum *type;
        /* Last GQuark values read. Keeping a reference on the GQuark array. */
        GArray *value;
@@ -219,10 +244,10 @@ struct type_string {
        struct type p;
 };
 
-struct declaration_string {
-       struct declaration p;
+struct definition_string {
+       struct definition p;
        struct type_string *type;
-       char *value;    /* freed at declaration_string teardown */
+       char *value;    /* freed at definition_string teardown */
 };
 
 struct type_field {
@@ -232,33 +257,37 @@ struct type_field {
 
 struct field {
        GQuark name;
-       struct declaration *declaration;
+       struct definition *definition;
 };
 
 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 declaration_struct {
-       struct declaration p;
+struct definition_struct {
+       struct definition p;
        struct type_struct *type;
-       struct declaration_scope *scope;
+       struct definition_scope *scope;
        GArray *fields;                 /* Array of struct 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 */
+       GQuark tag_name;                /* TODO */
+       /* Tag name must be nonzero and must exist when defining the variant */
 };
 
-struct declaration_variant {
-       struct declaration p;
+struct definition_variant {
+       struct definition p;
        struct type_variant *type;
-       struct declaration_scope *scope;
-       struct declaration *enum_tag;
+       struct definition_scope *scope;
+       struct definition *enum_tag;
        GArray *fields;                 /* Array of struct field */
        struct field *current_field;    /* Last field read */
 };
@@ -267,12 +296,13 @@ struct type_array {
        struct type p;
        size_t len;
        struct type *elem;
+       struct type_scope *scope;
 };
 
-struct declaration_array {
-       struct declaration p;
+struct definition_array {
+       struct definition p;
        struct type_array *type;
-       struct declaration_scope *scope;
+       struct definition_scope *scope;
        struct field current_element;           /* struct field */
 };
 
@@ -280,33 +310,64 @@ struct type_sequence {
        struct type p;
        struct type_integer *len_type;
        struct type *elem;
+       struct type_scope *scope;
 };
 
-struct declaration_sequence {
-       struct declaration p;
+struct definition_sequence {
+       struct definition p;
        struct type_sequence *type;
-       struct declaration_scope *scope;
-       struct declaration_integer *len;
+       struct definition_scope *scope;
+       struct definition_integer *len;
        struct field current_element;           /* struct field */
 };
 
-struct type *lookup_type(GQuark type_name, struct declaration_scope *scope);
-int register_type(struct type *type, struct declaration_scope *scope);
+int register_type(GQuark type_name, struct definition *definition,
+                 struct type_scope *scope);
+struct definition *lookup_type(GQuark type_name,
+                              struct type_scope *scope);
+
+/*
+ * Type scopes also contain a separate registry for struct, variant and
+ * 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);
 
-struct declaration *
-       lookup_declaration(GQuark field_name, struct declaration_scope *scope);
-int register_declaration(GQuark field_name, struct declaration *declaration,
-                        struct declaration_scope *scope);
+/*
+ * field_definition is for field definitions. They are registered into
+ * definition scopes.
+ */
+struct definition *
+       lookup_field_definition(GQuark field_name,
+                               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);
+void free_definition_scope(struct definition_scope *scope);
 
 void type_ref(struct type *type);
 void type_unref(struct type *type);
 
-struct declaration_scope *
-       new_declaration_scope(struct declaration_scope *parent_scope);
-void free_declaration_scope(struct declaration_scope *scope);
-
-void declaration_ref(struct declaration *declaration);
-void declaration_unref(struct declaration *declaration);
+void definition_ref(struct definition *definition);
+void definition_unref(struct definition *definition);
 
 /* Nameless types can be created by passing a NULL name */
 
@@ -355,7 +416,8 @@ 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_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);
 /*
@@ -370,7 +432,7 @@ struct type_field *
 struct_type_get_field_from_index(struct type_struct *struct_type,
                                 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);
 
 /*
@@ -378,7 +440,8 @@ 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_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 *
@@ -386,22 +449,23 @@ variant_type_get_field_from_tag(struct type_variant *variant_type, 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);
+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.
  */
 struct type_array *array_type_new(const char *name,
-                                 size_t len, struct type *elem_type);
+                                 size_t len, struct type *elem_type,
+                                 struct type_scope *parent_scope);
 
 /*
  * int_type and elem_type passed as parameter now belong to the sequence. No
@@ -409,6 +473,7 @@ struct type_array *array_type_new(const char *name,
  */
 struct type_sequence *sequence_type_new(const char *name,
                                        struct type_integer *len_type, 
-                                       struct type *elem_type);
+                                       struct type *elem_type,
+                                       struct type_scope *parent_scope);
 
 #endif /* _BABELTRACE_TYPES_H */
This page took 0.028977 seconds and 4 git commands to generate.