+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 definitions, so
+ * that a named variant can be declared without specifying its target
+ * "choice" tag field immediately.
+ */
+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_untagged_variant *untagged_variant_declaration,
+ struct declaration_scope *scope);
+struct declaration_untagged_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);
+
+struct declaration_scope *
+ new_declaration_scope(struct declaration_scope *parent_scope);
+void free_declaration_scope(struct declaration_scope *scope);
+
+/*
+ * field_definition is for field definitions. They are registered into
+ * definition scopes.
+ */
+struct definition *
+ lookup_path_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, const char *root_name);
+void free_definition_scope(struct definition_scope *scope);
+
+GQuark new_definition_path(struct definition_scope *parent_scope,
+ GQuark field_name, const char *root_name);
+
+static inline
+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 definition_ref(struct definition *definition);
+void 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,
+ 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
+ * (e.g. result of DBL_MANT_DIG). It includes the leading 1.
+ */
+struct declaration_float *float_declaration_new(size_t mantissa_len,
+ size_t exp_len, int byte_order,
+ size_t alignment);
+
+/*
+ * A GQuark can be translated to/from strings with g_quark_from_string() and
+ * g_quark_to_string().
+ */
+
+/*
+ * 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,
+ 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,
+ int64_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 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 declaration_enum *enum_declaration,
+ uint64_t start, uint64_t end, GQuark q);
+size_t enum_get_nr_enumerators(struct declaration_enum *enum_declaration);
+
+struct declaration_enum *
+ 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,
+ uint64_t min_align);
+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.
+ */
+int 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 declaration_field *
+struct_declaration_get_field_from_index(struct declaration_struct *struct_declaration,
+ int index);
+struct definition *
+struct_definition_get_field_from_index(struct definition_struct *struct_definition,
+ int index);
+int struct_rw(struct stream_pos *pos, struct definition *definition);
+uint64_t struct_declaration_len(struct declaration_struct *struct_declaration);
+
+/*
+ * The tag enumeration is validated to ensure that it contains only mappings
+ * from numeric values to a single tag. Overlapping tag value ranges are
+ * therefore forbidden.
+ */
+struct declaration_untagged_variant *untagged_variant_declaration_new(
+ struct declaration_scope *parent_scope);
+struct declaration_variant *variant_declaration_new(struct declaration_untagged_variant *untagged_variant,
+ const char *tag);
+
+void untagged_variant_declaration_add_field(struct declaration_untagged_variant *untagged_variant_declaration,
+ const char *field_name,
+ struct declaration *field_declaration);
+struct declaration_field *
+ untagged_variant_declaration_get_field_from_tag(struct declaration_untagged_variant *untagged_variant_declaration,
+ GQuark tag);
+/*
+ * Returns 0 on success, -EPERM on error.
+ */
+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 definition *variant_get_current_field(struct definition_variant *variant);
+int variant_rw(struct stream_pos *pos, struct definition *definition);
+
+/*
+ * 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 declaration_array *
+ 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(const struct definition *field);
+int get_array_len(const struct definition *field);
+
+/*
+ * int_declaration and elem_declaration passed as parameter now belong
+ * to the sequence. No need to free them explicitly.
+ */
+struct declaration_sequence *
+ sequence_declaration_new(const char *length_name,
+ struct declaration *elem_declaration,
+ struct declaration_scope *parent_scope);
+uint64_t sequence_len(struct definition_sequence *sequence);
+struct definition *sequence_index(struct definition_sequence *sequence, uint64_t i);
+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);
+
+/*
+ * Lookup helpers.
+ */
+struct definition *lookup_definition(const struct definition *definition,
+ const char *field_name);
+struct definition_integer *lookup_integer(const struct definition *definition,
+ const char *field_name,
+ int signedness);
+struct definition_enum *bt_lookup_enum(const struct definition *definition,
+ const char *field_name,
+ int signedness);
+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;
+}
+