From: Jérémie Galarneau Date: Sun, 23 Oct 2016 23:47:52 +0000 (-0400) Subject: Hide new bt_ctf_field_type_* symbols X-Git-Tag: v1.5.0-rc1~10 X-Git-Url: https://git.efficios.com/?p=babeltrace.git;a=commitdiff_plain;h=5ad19bf0ac5a4e6e8f3ef4b0272b143573ff36f0 Hide new bt_ctf_field_type_* symbols Signed-off-by: Jérémie Galarneau --- diff --git a/formats/ctf/ir/field-types.c b/formats/ctf/ir/field-types.c index f898d5af..95b91a6e 100644 --- a/formats/ctf/ir/field-types.c +++ b/formats/ctf/ir/field-types.c @@ -689,6 +689,7 @@ struct bt_ctf_field_type *bt_ctf_field_type_integer_create(unsigned int size) return &integer->parent; } +BT_HIDDEN int bt_ctf_field_type_integer_get_size(struct bt_ctf_field_type *type) { int ret = 0; @@ -739,6 +740,7 @@ end: return ret; } +BT_HIDDEN enum bt_ctf_integer_base bt_ctf_field_type_integer_get_base( struct bt_ctf_field_type *type) { @@ -784,6 +786,7 @@ end: return ret; } +BT_HIDDEN enum bt_ctf_string_encoding bt_ctf_field_type_integer_get_encoding( struct bt_ctf_field_type *type) { @@ -820,6 +823,7 @@ end: return ret; } +BT_HIDDEN struct bt_ctf_clock *bt_ctf_field_type_integer_get_mapped_clock( struct bt_ctf_field_type *type) { @@ -837,6 +841,7 @@ end: return clock; } +BT_HIDDEN int bt_ctf_field_type_integer_set_mapped_clock( struct bt_ctf_field_type *type, struct bt_ctf_clock *clock) @@ -888,6 +893,7 @@ error: return NULL; } +BT_HIDDEN struct bt_ctf_field_type *bt_ctf_field_type_enumeration_get_container_type( struct bt_ctf_field_type *type) { @@ -973,6 +979,7 @@ end: return ret; } +BT_HIDDEN int bt_ctf_field_type_enumeration_add_mapping_unsigned( struct bt_ctf_field_type *type, const char *string, uint64_t range_start, uint64_t range_end) @@ -1037,6 +1044,7 @@ end: return ret; } +BT_HIDDEN const char *bt_ctf_field_type_enumeration_get_mapping_name_unsigned( struct bt_ctf_field_type_enumeration *enumeration_type, uint64_t value) @@ -1118,6 +1126,7 @@ end: return mapping; } +BT_HIDDEN int bt_ctf_field_type_enumeration_get_mapping( struct bt_ctf_field_type *type, int index, const char **string, int64_t *range_start, int64_t *range_end) @@ -1144,6 +1153,7 @@ end: return ret; } +BT_HIDDEN int bt_ctf_field_type_enumeration_get_mapping_unsigned( struct bt_ctf_field_type *type, int index, const char **string, uint64_t *range_start, uint64_t *range_end) @@ -1170,6 +1180,7 @@ end: return ret; } +BT_HIDDEN int bt_ctf_field_type_enumeration_get_mapping_index_by_name( struct bt_ctf_field_type *type, const char *name) { @@ -1206,6 +1217,7 @@ end: return ret; } +BT_HIDDEN int bt_ctf_field_type_enumeration_get_mapping_index_by_value( struct bt_ctf_field_type *type, int64_t value) { @@ -1235,6 +1247,7 @@ end: return ret; } +BT_HIDDEN int bt_ctf_field_type_enumeration_get_mapping_index_by_unsigned_value( struct bt_ctf_field_type *type, uint64_t value) { @@ -1291,6 +1304,7 @@ end: return floating_point ? &floating_point->parent : NULL; } +BT_HIDDEN int bt_ctf_field_type_floating_point_get_exponent_digits( struct bt_ctf_field_type *type) { @@ -1337,6 +1351,7 @@ end: return ret; } +BT_HIDDEN int bt_ctf_field_type_floating_point_get_mantissa_digits( struct bt_ctf_field_type *type) { @@ -1428,6 +1443,7 @@ end: return ret; } +BT_HIDDEN int bt_ctf_field_type_structure_get_field_count( struct bt_ctf_field_type *type) { @@ -1479,6 +1495,7 @@ end: return ret; } +BT_HIDDEN struct bt_ctf_field_type *bt_ctf_field_type_structure_get_field_type_by_name( struct bt_ctf_field_type *type, const char *name) @@ -1546,6 +1563,7 @@ error: return NULL; } +BT_HIDDEN struct bt_ctf_field_type *bt_ctf_field_type_variant_get_tag_type( struct bt_ctf_field_type *type) { @@ -1567,6 +1585,7 @@ end: return tag_type; } +BT_HIDDEN const char *bt_ctf_field_type_variant_get_tag_name( struct bt_ctf_field_type *type) { @@ -1587,6 +1606,7 @@ end: return tag_name; } +BT_HIDDEN int bt_ctf_field_type_variant_set_tag_name( struct bt_ctf_field_type *type, const char *name) { @@ -1655,6 +1675,7 @@ end: return ret; } +BT_HIDDEN struct bt_ctf_field_type *bt_ctf_field_type_variant_get_field_type_by_name( struct bt_ctf_field_type *type, const char *field_name) @@ -1687,6 +1708,7 @@ end: return field_type; } +BT_HIDDEN struct bt_ctf_field_type *bt_ctf_field_type_variant_get_field_type_from_tag( struct bt_ctf_field_type *type, struct bt_ctf_field *tag) @@ -1728,6 +1750,7 @@ end: } +BT_HIDDEN int bt_ctf_field_type_variant_get_field(struct bt_ctf_field_type *type, const char **field_name, struct bt_ctf_field_type **field_type, int index) @@ -1788,6 +1811,7 @@ error: return NULL; } +BT_HIDDEN struct bt_ctf_field_type *bt_ctf_field_type_array_get_element_type( struct bt_ctf_field_type *type) { @@ -1831,6 +1855,7 @@ end: return ret; } +BT_HIDDEN int64_t bt_ctf_field_type_array_get_length(struct bt_ctf_field_type *type) { int64_t ret; @@ -1873,6 +1898,7 @@ error: return NULL; } +BT_HIDDEN struct bt_ctf_field_type *bt_ctf_field_type_sequence_get_element_type( struct bt_ctf_field_type *type) { @@ -1917,6 +1943,7 @@ end: return ret; } +BT_HIDDEN const char *bt_ctf_field_type_sequence_get_length_field_name( struct bt_ctf_field_type *type) { @@ -1951,6 +1978,7 @@ struct bt_ctf_field_type *bt_ctf_field_type_string_create(void) return &string->parent; } +BT_HIDDEN enum bt_ctf_string_encoding bt_ctf_field_type_string_get_encoding( struct bt_ctf_field_type *type) { @@ -1987,6 +2015,7 @@ end: return ret; } +BT_HIDDEN int bt_ctf_field_type_get_alignment(struct bt_ctf_field_type *type) { int ret; @@ -2123,6 +2152,7 @@ end: return ret; } +BT_HIDDEN enum bt_ctf_byte_order bt_ctf_field_type_get_byte_order( struct bt_ctf_field_type *type) { @@ -2199,6 +2229,7 @@ end: return ret; } +BT_HIDDEN enum bt_ctf_type_id bt_ctf_field_type_get_type_id( struct bt_ctf_field_type *type) { @@ -2209,41 +2240,49 @@ enum bt_ctf_type_id bt_ctf_field_type_get_type_id( return type->declaration->id; } +BT_HIDDEN int bt_ctf_field_type_is_integer(struct bt_ctf_field_type *type) { return bt_ctf_field_type_get_type_id(type) == BT_CTF_TYPE_ID_INTEGER; } +BT_HIDDEN int bt_ctf_field_type_is_floating_point(struct bt_ctf_field_type *type) { return bt_ctf_field_type_get_type_id(type) == BT_CTF_TYPE_ID_FLOAT; } +BT_HIDDEN int bt_ctf_field_type_is_enumeration(struct bt_ctf_field_type *type) { return bt_ctf_field_type_get_type_id(type) == BT_CTF_TYPE_ID_ENUM; } +BT_HIDDEN int bt_ctf_field_type_is_string(struct bt_ctf_field_type *type) { return bt_ctf_field_type_get_type_id(type) == BT_CTF_TYPE_ID_STRING; } +BT_HIDDEN int bt_ctf_field_type_is_structure(struct bt_ctf_field_type *type) { return bt_ctf_field_type_get_type_id(type) == BT_CTF_TYPE_ID_STRUCT; } +BT_HIDDEN int bt_ctf_field_type_is_array(struct bt_ctf_field_type *type) { return bt_ctf_field_type_get_type_id(type) == BT_CTF_TYPE_ID_ARRAY; } +BT_HIDDEN int bt_ctf_field_type_is_sequence(struct bt_ctf_field_type *type) { return bt_ctf_field_type_get_type_id(type) == BT_CTF_TYPE_ID_SEQUENCE; } +BT_HIDDEN int bt_ctf_field_type_is_variant(struct bt_ctf_field_type *type) { return bt_ctf_field_type_get_type_id(type) == BT_CTF_TYPE_ID_VARIANT; @@ -3988,6 +4027,7 @@ end: return ret; } +BT_HIDDEN int bt_ctf_field_type_compare(struct bt_ctf_field_type *type_a, struct bt_ctf_field_type *type_b) { @@ -4108,6 +4148,7 @@ int bt_ctf_field_type_get_field_index(struct bt_ctf_field_type *field_type, return field_index; } +BT_HIDDEN struct bt_ctf_field_path *bt_ctf_field_type_variant_get_tag_field_path( struct bt_ctf_field_type *type) { @@ -4125,6 +4166,7 @@ end: return field_path; } +BT_HIDDEN struct bt_ctf_field_path *bt_ctf_field_type_sequence_get_length_field_path( struct bt_ctf_field_type *type) { diff --git a/include/babeltrace/ctf-ir/field-types-internal.h b/include/babeltrace/ctf-ir/field-types-internal.h index 4e401ebe..18ddee65 100644 --- a/include/babeltrace/ctf-ir/field-types-internal.h +++ b/include/babeltrace/ctf-ir/field-types-internal.h @@ -273,4 +273,550 @@ BT_HIDDEN int bt_ctf_field_type_get_field_index(struct bt_ctf_field_type *type, const char *name); +/* + * bt_ctf_field_type_integer_get_size: get an integer type's size. + * + * Get an integer type's size. + * + * @param integer Integer type. + * + * Returns the integer type's size, a negative value on error. + */ +BT_HIDDEN +int bt_ctf_field_type_integer_get_size(struct bt_ctf_field_type *integer); + +/* + * bt_ctf_field_type_integer_get_base: get an integer type's base. + * + * Get an integer type's base used to pretty-print the resulting trace. + * + * @param integer Integer type. + * + * Returns the integer type's base on success, BT_CTF_INTEGER_BASE_UNKNOWN on + * error. + */ +BT_HIDDEN +enum bt_ctf_integer_base bt_ctf_field_type_integer_get_base( + struct bt_ctf_field_type *integer); + +/* + * bt_ctf_field_type_integer_get_encoding: get an integer type's encoding. + * + * @param integer Integer type. + * + * Returns the string field's encoding on success, + * BT_CTF_STRING_ENCODING_UNKNOWN on error. + */ +BT_HIDDEN +enum bt_ctf_string_encoding bt_ctf_field_type_integer_get_encoding( + struct bt_ctf_field_type *integer); + +/** + * bt_ctf_field_type_integer_get_mapped_clock: get an integer type's mapped clock. + * + * @param integer Integer type. + * + * Returns the integer's mapped clock (if any), NULL on error. + */ +BT_HIDDEN +struct bt_ctf_clock *bt_ctf_field_type_integer_get_mapped_clock( + struct bt_ctf_field_type *integer); + +/** + * bt_ctf_field_type_integer_set_mapped_clock: set an integer type's mapped clock. + * + * @param integer Integer type. + * @param clock Clock to map. + * + * Returns 0 on success, a negative value on error. + */ +BT_HIDDEN +int bt_ctf_field_type_integer_set_mapped_clock( + struct bt_ctf_field_type *integer, + struct bt_ctf_clock *clock); + +/* + * bt_ctf_field_type_enumeration_get_container_type: get underlying container. + * + * Get the enumeration type's underlying integer container type. + * + * @param enumeration Enumeration type. + * + * Returns an allocated field type on success, NULL on error. + */ +BT_HIDDEN +struct bt_ctf_field_type *bt_ctf_field_type_enumeration_get_container_type( + struct bt_ctf_field_type *enumeration); + +/* + * bt_ctf_field_type_enumeration_add_mapping_unsigned: add an enumeration + * mapping. + * + * Add a mapping to the enumeration. The range's values are inclusive. + * + * @param enumeration Enumeration type. + * @param name Enumeration mapping name (will be copied). + * @param range_start Enumeration mapping range start. + * @param range_end Enumeration mapping range end. + * + * Returns 0 on success, a negative value on error. + */ +BT_HIDDEN +int bt_ctf_field_type_enumeration_add_mapping_unsigned( + struct bt_ctf_field_type *enumeration, const char *name, + uint64_t range_start, uint64_t range_end); + +/* + * bt_ctf_field_type_enumeration_get_mapping_count: Get the number of mappings + * defined in the enumeration. + * + * @param enumeration Enumeration type. + * + * Returns the mapping count on success, a negative value on error. + */ +BT_HIDDEN +int bt_ctf_field_type_enumeration_get_mapping_count( + struct bt_ctf_field_type *enumeration); + +/* + * bt_ctf_field_type_enumeration_get_mapping: get an enumeration mapping. + * + * @param enumeration Enumeration type. + * @param index Index of mapping. + * @param name Pointer where the mapping's name will be returned (valid for + * the lifetime of the enumeration). + * @param range_start Pointer where the enumeration mapping's range start will + * be returned. + * @param range_end Pointer where the enumeration mapping's range end will + * be returned. + * + * Returns 0 on success, a negative value on error. + */ +BT_HIDDEN +int bt_ctf_field_type_enumeration_get_mapping( + struct bt_ctf_field_type *enumeration, int index, + const char **name, int64_t *range_start, int64_t *range_end); + +/* + * bt_ctf_field_type_enumeration_get_mapping_unsigned: get a mapping. + * + * @param enumeration Enumeration type. + * @param index Index of mapping. + * @param name Pointer where the mapping's name will be returned (valid for + * the lifetime of the enumeration). + * @param range_start Pointer where the enumeration mapping's range start will + * be returned. + * @param range_end Pointer where the enumeration mapping's range end will + * be returned. + * + * Returns 0 on success, a negative value on error. + */ +BT_HIDDEN +int bt_ctf_field_type_enumeration_get_mapping_unsigned( + struct bt_ctf_field_type *enumeration, int index, + const char **name, uint64_t *range_start, + uint64_t *range_end); + +/* + * bt_ctf_field_type_enumeration_get_mapping_index_by_name: get an enumerations' + * mapping index by name. + * + * @param enumeration Enumeration type. + * @param name Mapping name. + * + * Returns mapping index on success, a negative value on error. + */ +BT_HIDDEN +int bt_ctf_field_type_enumeration_get_mapping_index_by_name( + struct bt_ctf_field_type *enumeration, const char *name); + +/* + * bt_ctf_field_type_enumeration_get_mapping_index_by_value: get an + * enumerations' mapping index by value. + * + * @param enumeration Enumeration type. + * @param value Value. + * + * Returns mapping index on success, a negative value on error. + */ +BT_HIDDEN +int bt_ctf_field_type_enumeration_get_mapping_index_by_value( + struct bt_ctf_field_type *enumeration, int64_t value); + +/* + * bt_ctf_field_type_enumeration_get_mapping_index_by_unsigned_value: get an + * enumerations' mapping index by value. + * + * @param enumeration Enumeration type. + * @param value Value. + * + * Returns 0 on success, a negative value on error. + */ +BT_HIDDEN +int bt_ctf_field_type_enumeration_get_mapping_index_by_unsigned_value( + struct bt_ctf_field_type *enumeration, uint64_t value); + +/* + * bt_ctf_field_type_floating_point_get_exponent_digits: get exponent digit + * count. + * + * @param floating_point Floating point type. + * + * Returns the exponent digit count on success, a negative value on error. + */ +BT_HIDDEN +int bt_ctf_field_type_floating_point_get_exponent_digits( + struct bt_ctf_field_type *floating_point); + +/* + * bt_ctf_field_type_floating_point_get_mantissa_digits: get mantissa digit + * count. + * + * @param floating_point Floating point type. + * + * Returns the mantissa digit count on success, a negative value on error. + */ +BT_HIDDEN +int bt_ctf_field_type_floating_point_get_mantissa_digits( + struct bt_ctf_field_type *floating_point); + +/* + * bt_ctf_field_type_structure_get_field_count: Get the number of fields defined + * in the structure. + * + * @param structure Structure type. + * + * Returns the field count on success, a negative value on error. + */ +BT_HIDDEN +int bt_ctf_field_type_structure_get_field_count( + struct bt_ctf_field_type *structure); + +/* + * bt_ctf_field_type_structure_get_field_type_by_name: get a structure field's + * type by name. + * + * @param structure Structure type. + * @param field_name Name of the structure's field. + * + * Returns a field type instance on success, NULL on error. + */ +BT_HIDDEN +struct bt_ctf_field_type *bt_ctf_field_type_structure_get_field_type_by_name( + struct bt_ctf_field_type *structure, const char *field_name); + +/* + * bt_ctf_field_type_variant_get_tag_type: get a variant's tag type. + * + * @param variant Variant type. + * + * Returns a field type instance on success, NULL if unset. + */ +BT_HIDDEN +struct bt_ctf_field_type *bt_ctf_field_type_variant_get_tag_type( + struct bt_ctf_field_type *variant); + +/* + * bt_ctf_field_type_variant_get_tag_name: get a variant's tag name. + * + * @param variant Variant type. + * + * Returns the tag field's name, NULL if unset. + */ +BT_HIDDEN +const char *bt_ctf_field_type_variant_get_tag_name( + struct bt_ctf_field_type *variant); + +/* + * bt_ctf_field_type_variant_set_tag_name: set a variant's tag name. + * + * @param variant Variant type. + * @param name Tag field name. + * + * Returns 0 on success, a negative value on error. + */ +BT_HIDDEN +int bt_ctf_field_type_variant_set_tag_name( + struct bt_ctf_field_type *variant, const char *name); + +/* + * bt_ctf_field_type_variant_get_field_type_by_name: get variant field's type. + * + * @param structure Variant type. + * @param field_name Name of the variant's field. + * + * Returns a field type instance on success, NULL on error. + */ +BT_HIDDEN +struct bt_ctf_field_type *bt_ctf_field_type_variant_get_field_type_by_name( + struct bt_ctf_field_type *variant, const char *field_name); + +/* + * bt_ctf_field_type_variant_get_field_type_from_tag: get variant field's type. + * + * @param variant Variant type. + * @param tag Type tag (enum). + * + * Returns a field type instance on success, NULL on error. + */ +BT_HIDDEN +struct bt_ctf_field_type *bt_ctf_field_type_variant_get_field_type_from_tag( + struct bt_ctf_field_type *variant, struct bt_ctf_field *tag); + +/* + * bt_ctf_field_type_variant_get_field_count: Get the number of fields defined + * in the variant. + * + * @param variant Variant type. + * + * Returns the field count on success, a negative value on error. + */ +BT_HIDDEN +int bt_ctf_field_type_variant_get_field_count( + struct bt_ctf_field_type *variant); + +/* + * bt_ctf_field_type_variant_get_field: get a variant's field name and type. + * + * @param variant Variant type. + * @param field_type Pointer to a const char* where the field's name will + * be returned. + * @param field_type Pointer to a bt_ctf_field_type* where the field's type will + * be returned. + * @param index Index of field. + * + * Returns 0 on success, a negative value on error. + */ +BT_HIDDEN +int bt_ctf_field_type_variant_get_field( + struct bt_ctf_field_type *variant, const char **field_name, + struct bt_ctf_field_type **field_type, int index); + +/* + * bt_ctf_field_type_array_get_element_type: get an array's element type. + * + * @param array Array type. + * + * Returns a field type instance on success, NULL on error. + */ +BT_HIDDEN +struct bt_ctf_field_type *bt_ctf_field_type_array_get_element_type( + struct bt_ctf_field_type *array); + +/* + * bt_ctf_field_type_array_get_length: get an array's length. + * + * @param array Array type. + * + * Returns the array's length on success, a negative value on error. + */ +BT_HIDDEN +int64_t bt_ctf_field_type_array_get_length(struct bt_ctf_field_type *array); + +/* + * bt_ctf_field_type_sequence_get_element_type: get a sequence's element type. + * + * @param sequence Sequence type. + * + * Returns a field type instance on success, NULL on error. + */ +BT_HIDDEN +struct bt_ctf_field_type *bt_ctf_field_type_sequence_get_element_type( + struct bt_ctf_field_type *sequence); + +/* + * bt_ctf_field_type_sequence_get_length_field_name: get length field name. + * + * @param sequence Sequence type. + * + * Returns the sequence's length field on success, NULL on error. + */ +BT_HIDDEN +const char *bt_ctf_field_type_sequence_get_length_field_name( + struct bt_ctf_field_type *sequence); + +/* + * bt_ctf_field_type_string_get_encoding: get a string type's encoding. + * + * Get the string type's encoding. + * + * @param string_type String type. + * + * Returns the string's encoding on success, a BT_CTF_STRING_ENCODING_UNKNOWN + * on error. + */ +BT_HIDDEN +enum bt_ctf_string_encoding bt_ctf_field_type_string_get_encoding( + struct bt_ctf_field_type *string_type); + +/* + * bt_ctf_field_type_get_alignment: get a field type's alignment. + * + * Get the field type's alignment. + * + * @param type Field type. + * + * Returns the field type's alignment on success, a negative value on error and + * 0 if the alignment is undefined (as in the case of a variant). + */ +BT_HIDDEN +int bt_ctf_field_type_get_alignment(struct bt_ctf_field_type *type); + +/* + * bt_ctf_field_type_get_byte_order: get a field type's byte order. + * + * @param type Field type. + * + * Returns the field type's byte order on success, a negative value on error. + */ +BT_HIDDEN +enum bt_ctf_byte_order bt_ctf_field_type_get_byte_order( + struct bt_ctf_field_type *type); + + +/* + * bt_ctf_field_type_variant_get_tag_field_path: get a variant's tag's field + * path. + * + * Get the variant's tag's field path. + * + * @param type Field type. + * + * Returns the field path on success, NULL on error or if no field path is set. + */ +BT_HIDDEN +struct bt_ctf_field_path *bt_ctf_field_type_variant_get_tag_field_path( + struct bt_ctf_field_type *type); + +/* + * bt_ctf_field_type_sequence_get_length_field_path: get a sequence's length's + * field path. + * + * Get the sequence's length's field path. + * + * @param type Field type. + * + * Returns the field path on success, NULL on error or if no field path is set. + */ +BT_HIDDEN +struct bt_ctf_field_path *bt_ctf_field_type_sequence_get_length_field_path( + struct bt_ctf_field_type *type); + +/* + * bt_ctf_field_type_compare: compare two field types recursively + * + * Compare two field types recursively. + * + * The registered tag field type of a variant field type is ignored: + * only the tag strings are compared. + * + * @param type_a Field type A. + * @param type_b Field type B. + * + * Returns 0 if both field types are semantically equivalent, a positive + * value if they are not equivalent, or a negative value on error. + */ +BT_HIDDEN +int bt_ctf_field_type_compare(struct bt_ctf_field_type *type_a, + struct bt_ctf_field_type *type_b); + +/* + * bt_ctf_field_type_get_type_id: get a field type's bt_ctf_type_id. + * + * @param type Field type. + * + * Returns the field type's bt_ctf_type_id, CTF_TYPE_UNKNOWN on error. + */ +BT_HIDDEN +enum bt_ctf_type_id bt_ctf_field_type_get_type_id( + struct bt_ctf_field_type *type); + +/* + * bt_ctf_field_type_is_integer: returns whether or not a given field + * type is an integer type. + * + * @param type Field type. + * + * Returns 1 if the field type is an integer type, 0 otherwise. + */ +BT_HIDDEN +int bt_ctf_field_type_is_integer(struct bt_ctf_field_type *type); + +/* + * bt_ctf_field_type_is_floating_point: returns whether or not a given field + * type is a floating point number type. + * + * @param type Field type. + * + * Returns 1 if the field type is a floating point number type, 0 otherwise. + */ +BT_HIDDEN +int bt_ctf_field_type_is_floating_point(struct bt_ctf_field_type *type); + +/* + * bt_ctf_field_type_is_enumeration: returns whether or not a given field + * type is an enumeration type. + * + * @param type Field type. + * + * Returns 1 if the field type is an enumeration type, 0 otherwise. + */ +BT_HIDDEN +int bt_ctf_field_type_is_enumeration(struct bt_ctf_field_type *type); + +/* + * bt_ctf_field_type_is_string: returns whether or not a given field + * type is a string type. + * + * @param type Field type. + * + * Returns 1 if the field type is a string type, 0 otherwise. + */ +BT_HIDDEN +int bt_ctf_field_type_is_string(struct bt_ctf_field_type *type); + +/* + * bt_ctf_field_type_is_structure: returns whether or not a given field + * type is a structure type. + * + * @param type Field type. + * + * Returns 1 if the field type is a structure type, 0 otherwise. + */ +BT_HIDDEN +int bt_ctf_field_type_is_structure(struct bt_ctf_field_type *type); + +/* + * bt_ctf_field_type_is_array: returns whether or not a given field + * type is an array type. + * + * @param type Field type. + * + * Returns 1 if the field type is an array type, 0 otherwise. + */ +BT_HIDDEN +int bt_ctf_field_type_is_array(struct bt_ctf_field_type *type); + +/* + * bt_ctf_field_type_is_sequence: returns whether or not a given field + * type is a sequence type. + * + * @param type Field type. + * + * Returns 1 if the field type is a sequence type, 0 otherwise. + */ +BT_HIDDEN +int bt_ctf_field_type_is_sequence(struct bt_ctf_field_type *type); + +/* + * bt_ctf_field_type_is_variant: returns whether or not a given field + * type is a variant type. + * + * @param type Field type. + * + * Returns 1 if the field type is a variant type, 0 otherwise. + */ +BT_HIDDEN +int bt_ctf_field_type_is_variant(struct bt_ctf_field_type *type); + #endif /* BABELTRACE_CTF_IR_FIELD_TYPES_INTERNAL_H */ diff --git a/include/babeltrace/ctf-ir/field-types.h b/include/babeltrace/ctf-ir/field-types.h index e38acabf..cce364c4 100644 --- a/include/babeltrace/ctf-ir/field-types.h +++ b/include/babeltrace/ctf-ir/field-types.h @@ -84,18 +84,6 @@ enum bt_ctf_string_encoding { extern struct bt_ctf_field_type *bt_ctf_field_type_integer_create( unsigned int size); -/* - * bt_ctf_field_type_integer_get_size: get an integer type's size. - * - * Get an integer type's size. - * - * @param integer Integer type. - * - * Returns the integer type's size, a negative value on error. - */ -extern int bt_ctf_field_type_integer_get_size( - struct bt_ctf_field_type *integer); - /* * bt_ctf_field_type_integer_get_signed: get an integer type's signedness. * @@ -121,19 +109,6 @@ extern int bt_ctf_field_type_integer_get_signed( extern int bt_ctf_field_type_integer_set_signed( struct bt_ctf_field_type *integer, int is_signed); -/* - * bt_ctf_field_type_integer_get_base: get an integer type's base. - * - * Get an integer type's base used to pretty-print the resulting trace. - * - * @param integer Integer type. - * - * Returns the integer type's base on success, BT_CTF_INTEGER_BASE_UNKNOWN on - * error. - */ -extern enum bt_ctf_integer_base bt_ctf_field_type_integer_get_base( - struct bt_ctf_field_type *integer); - /* * bt_ctf_field_type_integer_set_base: set an integer type's base. * @@ -147,17 +122,6 @@ extern enum bt_ctf_integer_base bt_ctf_field_type_integer_get_base( extern int bt_ctf_field_type_integer_set_base(struct bt_ctf_field_type *integer, enum bt_ctf_integer_base base); -/* - * bt_ctf_field_type_integer_get_encoding: get an integer type's encoding. - * - * @param integer Integer type. - * - * Returns the string field's encoding on success, - * BT_CTF_STRING_ENCODING_UNKNOWN on error. - */ -extern enum bt_ctf_string_encoding bt_ctf_field_type_integer_get_encoding( - struct bt_ctf_field_type *integer); - /* * bt_ctf_field_type_integer_set_encoding: set an integer type's encoding. * @@ -174,28 +138,6 @@ extern int bt_ctf_field_type_integer_set_encoding( struct bt_ctf_field_type *integer, enum bt_ctf_string_encoding encoding); -/** - * bt_ctf_field_type_integer_get_mapped_clock: get an integer type's mapped clock. - * - * @param integer Integer type. - * - * Returns the integer's mapped clock (if any), NULL on error. - */ -extern struct bt_ctf_clock *bt_ctf_field_type_integer_get_mapped_clock( - struct bt_ctf_field_type *integer); - -/** - * bt_ctf_field_type_integer_set_mapped_clock: set an integer type's mapped clock. - * - * @param integer Integer type. - * @param clock Clock to map. - * - * Returns 0 on success, a negative value on error. - */ -extern int bt_ctf_field_type_integer_set_mapped_clock( - struct bt_ctf_field_type *integer, - struct bt_ctf_clock *clock); - /* * bt_ctf_field_type_enumeration_create: create an enumeration field type. * @@ -212,19 +154,6 @@ extern int bt_ctf_field_type_integer_set_mapped_clock( extern struct bt_ctf_field_type *bt_ctf_field_type_enumeration_create( struct bt_ctf_field_type *integer_container_type); -/* - * bt_ctf_field_type_enumeration_get_container_type: get underlying container. - * - * Get the enumeration type's underlying integer container type. - * - * @param enumeration Enumeration type. - * - * Returns an allocated field type on success, NULL on error. - */ -extern -struct bt_ctf_field_type *bt_ctf_field_type_enumeration_get_container_type( - struct bt_ctf_field_type *enumeration); - /* * bt_ctf_field_type_enumeration_add_mapping: add an enumeration mapping. * @@ -241,107 +170,6 @@ extern int bt_ctf_field_type_enumeration_add_mapping( struct bt_ctf_field_type *enumeration, const char *name, int64_t range_start, int64_t range_end); -/* - * bt_ctf_field_type_enumeration_add_mapping_unsigned: add an enumeration - * mapping. - * - * Add a mapping to the enumeration. The range's values are inclusive. - * - * @param enumeration Enumeration type. - * @param name Enumeration mapping name (will be copied). - * @param range_start Enumeration mapping range start. - * @param range_end Enumeration mapping range end. - * - * Returns 0 on success, a negative value on error. - */ -extern int bt_ctf_field_type_enumeration_add_mapping_unsigned( - struct bt_ctf_field_type *enumeration, const char *name, - uint64_t range_start, uint64_t range_end); - -/* - * bt_ctf_field_type_enumeration_get_mapping_count: Get the number of mappings - * defined in the enumeration. - * - * @param enumeration Enumeration type. - * - * Returns the mapping count on success, a negative value on error. - */ -extern int bt_ctf_field_type_enumeration_get_mapping_count( - struct bt_ctf_field_type *enumeration); - -/* - * bt_ctf_field_type_enumeration_get_mapping: get an enumeration mapping. - * - * @param enumeration Enumeration type. - * @param index Index of mapping. - * @param name Pointer where the mapping's name will be returned (valid for - * the lifetime of the enumeration). - * @param range_start Pointer where the enumeration mapping's range start will - * be returned. - * @param range_end Pointer where the enumeration mapping's range end will - * be returned. - * - * Returns 0 on success, a negative value on error. - */ -extern int bt_ctf_field_type_enumeration_get_mapping( - struct bt_ctf_field_type *enumeration, int index, - const char **name, int64_t *range_start, int64_t *range_end); - -/* - * bt_ctf_field_type_enumeration_get_mapping_unsigned: get a mapping. - * - * @param enumeration Enumeration type. - * @param index Index of mapping. - * @param name Pointer where the mapping's name will be returned (valid for - * the lifetime of the enumeration). - * @param range_start Pointer where the enumeration mapping's range start will - * be returned. - * @param range_end Pointer where the enumeration mapping's range end will - * be returned. - * - * Returns 0 on success, a negative value on error. - */ -extern int bt_ctf_field_type_enumeration_get_mapping_unsigned( - struct bt_ctf_field_type *enumeration, int index, - const char **name, uint64_t *range_start, - uint64_t *range_end); - -/* - * bt_ctf_field_type_enumeration_get_mapping_index_by_name: get an enumerations' - * mapping index by name. - * - * @param enumeration Enumeration type. - * @param name Mapping name. - * - * Returns mapping index on success, a negative value on error. - */ -extern int bt_ctf_field_type_enumeration_get_mapping_index_by_name( - struct bt_ctf_field_type *enumeration, const char *name); - -/* - * bt_ctf_field_type_enumeration_get_mapping_index_by_value: get an - * enumerations' mapping index by value. - * - * @param enumeration Enumeration type. - * @param value Value. - * - * Returns mapping index on success, a negative value on error. - */ -extern int bt_ctf_field_type_enumeration_get_mapping_index_by_value( - struct bt_ctf_field_type *enumeration, int64_t value); - -/* - * bt_ctf_field_type_enumeration_get_mapping_index_by_unsigned_value: get an - * enumerations' mapping index by value. - * - * @param enumeration Enumeration type. - * @param value Value. - * - * Returns 0 on success, a negative value on error. - */ -extern int bt_ctf_field_type_enumeration_get_mapping_index_by_unsigned_value( - struct bt_ctf_field_type *enumeration, uint64_t value); - /* * bt_ctf_field_type_floating_point_create: create a floating point field type. * @@ -352,17 +180,6 @@ extern int bt_ctf_field_type_enumeration_get_mapping_index_by_unsigned_value( */ extern struct bt_ctf_field_type *bt_ctf_field_type_floating_point_create(void); -/* - * bt_ctf_field_type_floating_point_get_exponent_digits: get exponent digit - * count. - * - * @param floating_point Floating point type. - * - * Returns the exponent digit count on success, a negative value on error. - */ -extern int bt_ctf_field_type_floating_point_get_exponent_digits( - struct bt_ctf_field_type *floating_point); - /* * bt_ctf_field_type_floating_point_set_exponent_digits: set exponent digit * count. @@ -380,17 +197,6 @@ extern int bt_ctf_field_type_floating_point_set_exponent_digits( struct bt_ctf_field_type *floating_point, unsigned int exponent_digits); -/* - * bt_ctf_field_type_floating_point_get_mantissa_digits: get mantissa digit - * count. - * - * @param floating_point Floating point type. - * - * Returns the mantissa digit count on success, a negative value on error. - */ -extern int bt_ctf_field_type_floating_point_get_mantissa_digits( - struct bt_ctf_field_type *floating_point); - /* * bt_ctf_field_type_floating_point_set_mantissa_digits: set mantissa digit * count. @@ -435,17 +241,6 @@ extern int bt_ctf_field_type_structure_add_field( struct bt_ctf_field_type *field_type, const char *field_name); -/* - * bt_ctf_field_type_structure_get_field_count: Get the number of fields defined - * in the structure. - * - * @param structure Structure type. - * - * Returns the field count on success, a negative value on error. - */ -extern int bt_ctf_field_type_structure_get_field_count( - struct bt_ctf_field_type *structure); - /* * bt_ctf_field_type_structure_get_field: get a structure's field type and name. * @@ -463,19 +258,6 @@ extern int bt_ctf_field_type_structure_get_field( const char **field_name, struct bt_ctf_field_type **field_type, int index); -/* - * bt_ctf_field_type_structure_get_field_type_by_name: get a structure field's - * type by name. - * - * @param structure Structure type. - * @param field_name Name of the structure's field. - * - * Returns a field type instance on success, NULL on error. - */ -extern -struct bt_ctf_field_type *bt_ctf_field_type_structure_get_field_type_by_name( - struct bt_ctf_field_type *structure, const char *field_name); - /* * bt_ctf_field_type_variant_create: create a variant field type. * @@ -491,37 +273,6 @@ struct bt_ctf_field_type *bt_ctf_field_type_structure_get_field_type_by_name( extern struct bt_ctf_field_type *bt_ctf_field_type_variant_create( struct bt_ctf_field_type *enum_tag, const char *tag_name); -/* - * bt_ctf_field_type_variant_get_tag_type: get a variant's tag type. - * - * @param variant Variant type. - * - * Returns a field type instance on success, NULL if unset. - */ -extern struct bt_ctf_field_type *bt_ctf_field_type_variant_get_tag_type( - struct bt_ctf_field_type *variant); - -/* - * bt_ctf_field_type_variant_get_tag_name: get a variant's tag name. - * - * @param variant Variant type. - * - * Returns the tag field's name, NULL if unset. - */ -extern const char *bt_ctf_field_type_variant_get_tag_name( - struct bt_ctf_field_type *variant); - -/* - * bt_ctf_field_type_variant_set_tag_name: set a variant's tag name. - * - * @param variant Variant type. - * @param name Tag field name. - * - * Returns 0 on success, a negative value on error. - */ -extern int bt_ctf_field_type_variant_set_tag_name( - struct bt_ctf_field_type *variant, const char *name); - /* * bt_ctf_field_type_variant_add_field: add a field to a variant. * @@ -541,57 +292,6 @@ extern int bt_ctf_field_type_variant_add_field( struct bt_ctf_field_type *field_type, const char *field_name); -/* - * bt_ctf_field_type_variant_get_field_type_by_name: get variant field's type. - * - * @param structure Variant type. - * @param field_name Name of the variant's field. - * - * Returns a field type instance on success, NULL on error. - */ -extern -struct bt_ctf_field_type *bt_ctf_field_type_variant_get_field_type_by_name( - struct bt_ctf_field_type *variant, const char *field_name); - -/* - * bt_ctf_field_type_variant_get_field_type_from_tag: get variant field's type. - * - * @param variant Variant type. - * @param tag Type tag (enum). - * - * Returns a field type instance on success, NULL on error. - */ -extern -struct bt_ctf_field_type *bt_ctf_field_type_variant_get_field_type_from_tag( - struct bt_ctf_field_type *variant, struct bt_ctf_field *tag); - -/* - * bt_ctf_field_type_variant_get_field_count: Get the number of fields defined - * in the variant. - * - * @param variant Variant type. - * - * Returns the field count on success, a negative value on error. - */ -extern int bt_ctf_field_type_variant_get_field_count( - struct bt_ctf_field_type *variant); - -/* - * bt_ctf_field_type_variant_get_field: get a variant's field name and type. - * - * @param variant Variant type. - * @param field_type Pointer to a const char* where the field's name will - * be returned. - * @param field_type Pointer to a bt_ctf_field_type* where the field's type will - * be returned. - * @param index Index of field. - * - * Returns 0 on success, a negative value on error. - */ -extern int bt_ctf_field_type_variant_get_field( - struct bt_ctf_field_type *variant, const char **field_name, - struct bt_ctf_field_type **field_type, int index); - /* * bt_ctf_field_type_array_create: create an array field type. * @@ -606,26 +306,6 @@ extern int bt_ctf_field_type_variant_get_field( extern struct bt_ctf_field_type *bt_ctf_field_type_array_create( struct bt_ctf_field_type *element_type, unsigned int length); -/* - * bt_ctf_field_type_array_get_element_type: get an array's element type. - * - * @param array Array type. - * - * Returns a field type instance on success, NULL on error. - */ -extern struct bt_ctf_field_type *bt_ctf_field_type_array_get_element_type( - struct bt_ctf_field_type *array); - -/* - * bt_ctf_field_type_array_get_length: get an array's length. - * - * @param array Array type. - * - * Returns the array's length on success, a negative value on error. - */ -extern int64_t bt_ctf_field_type_array_get_length( - struct bt_ctf_field_type *array); - /* * bt_ctf_field_type_sequence_create: create a sequence field type. * @@ -643,26 +323,6 @@ extern struct bt_ctf_field_type *bt_ctf_field_type_sequence_create( struct bt_ctf_field_type *element_type, const char *length_field_name); -/* - * bt_ctf_field_type_sequence_get_element_type: get a sequence's element type. - * - * @param sequence Sequence type. - * - * Returns a field type instance on success, NULL on error. - */ -extern struct bt_ctf_field_type *bt_ctf_field_type_sequence_get_element_type( - struct bt_ctf_field_type *sequence); - -/* - * bt_ctf_field_type_sequence_get_length_field_name: get length field name. - * - * @param sequence Sequence type. - * - * Returns the sequence's length field on success, NULL on error. - */ -extern const char *bt_ctf_field_type_sequence_get_length_field_name( - struct bt_ctf_field_type *sequence); - /* * bt_ctf_field_type_string_create: create a string field type. * @@ -673,19 +333,6 @@ extern const char *bt_ctf_field_type_sequence_get_length_field_name( */ extern struct bt_ctf_field_type *bt_ctf_field_type_string_create(void); -/* - * bt_ctf_field_type_string_get_encoding: get a string type's encoding. - * - * Get the string type's encoding. - * - * @param string_type String type. - * - * Returns the string's encoding on success, a BT_CTF_STRING_ENCODING_UNKNOWN - * on error. - */ -extern enum bt_ctf_string_encoding bt_ctf_field_type_string_get_encoding( - struct bt_ctf_field_type *string_type); - /* * bt_ctf_field_type_string_set_encoding: set a string type's encoding. * @@ -702,18 +349,6 @@ extern int bt_ctf_field_type_string_set_encoding( struct bt_ctf_field_type *string_type, enum bt_ctf_string_encoding encoding); -/* - * bt_ctf_field_type_get_alignment: get a field type's alignment. - * - * Get the field type's alignment. - * - * @param type Field type. - * - * Returns the field type's alignment on success, a negative value on error and - * 0 if the alignment is undefined (as in the case of a variant). - */ -extern int bt_ctf_field_type_get_alignment(struct bt_ctf_field_type *type); - /* * bt_ctf_field_type_set_alignment: set a field type's alignment. * @@ -729,16 +364,6 @@ extern int bt_ctf_field_type_get_alignment(struct bt_ctf_field_type *type); extern int bt_ctf_field_type_set_alignment(struct bt_ctf_field_type *type, unsigned int alignment); -/* - * bt_ctf_field_type_get_byte_order: get a field type's byte order. - * - * @param type Field type. - * - * Returns the field type's byte order on success, a negative value on error. - */ -extern enum bt_ctf_byte_order bt_ctf_field_type_get_byte_order( - struct bt_ctf_field_type *type); - /* * bt_ctf_field_type_set_byte_order: set a field type's byte order. * @@ -753,139 +378,6 @@ extern enum bt_ctf_byte_order bt_ctf_field_type_get_byte_order( extern int bt_ctf_field_type_set_byte_order(struct bt_ctf_field_type *type, enum bt_ctf_byte_order byte_order); -/* - * bt_ctf_field_type_variant_get_tag_field_path: get a variant's tag's field - * path. - * - * Get the variant's tag's field path. - * - * @param type Field type. - * - * Returns the field path on success, NULL on error or if no field path is set. - */ -extern struct bt_ctf_field_path *bt_ctf_field_type_variant_get_tag_field_path( - struct bt_ctf_field_type *type); - -/* - * bt_ctf_field_type_sequence_get_length_field_path: get a sequence's length's - * field path. - * - * Get the sequence's length's field path. - * - * @param type Field type. - * - * Returns the field path on success, NULL on error or if no field path is set. - */ -extern struct bt_ctf_field_path *bt_ctf_field_type_sequence_get_length_field_path( - struct bt_ctf_field_type *type); - -/* - * bt_ctf_field_type_compare: compare two field types recursively - * - * Compare two field types recursively. - * - * The registered tag field type of a variant field type is ignored: - * only the tag strings are compared. - * - * @param type_a Field type A. - * @param type_b Field type B. - * - * Returns 0 if both field types are semantically equivalent, a positive - * value if they are not equivalent, or a negative value on error. - */ -extern int bt_ctf_field_type_compare(struct bt_ctf_field_type *type_a, - struct bt_ctf_field_type *type_b); - -/* - * bt_ctf_field_type_get_type_id: get a field type's bt_ctf_type_id. - * - * @param type Field type. - * - * Returns the field type's bt_ctf_type_id, CTF_TYPE_UNKNOWN on error. - */ -extern enum bt_ctf_type_id bt_ctf_field_type_get_type_id( - struct bt_ctf_field_type *type); - -/* - * bt_ctf_field_type_is_integer: returns whether or not a given field - * type is an integer type. - * - * @param type Field type. - * - * Returns 1 if the field type is an integer type, 0 otherwise. - */ -extern int bt_ctf_field_type_is_integer(struct bt_ctf_field_type *type); - -/* - * bt_ctf_field_type_is_floating_point: returns whether or not a given field - * type is a floating point number type. - * - * @param type Field type. - * - * Returns 1 if the field type is a floating point number type, 0 otherwise. - */ -extern int bt_ctf_field_type_is_floating_point(struct bt_ctf_field_type *type); - -/* - * bt_ctf_field_type_is_enumeration: returns whether or not a given field - * type is an enumeration type. - * - * @param type Field type. - * - * Returns 1 if the field type is an enumeration type, 0 otherwise. - */ -extern int bt_ctf_field_type_is_enumeration(struct bt_ctf_field_type *type); - -/* - * bt_ctf_field_type_is_string: returns whether or not a given field - * type is a string type. - * - * @param type Field type. - * - * Returns 1 if the field type is a string type, 0 otherwise. - */ -extern int bt_ctf_field_type_is_string(struct bt_ctf_field_type *type); - -/* - * bt_ctf_field_type_is_structure: returns whether or not a given field - * type is a structure type. - * - * @param type Field type. - * - * Returns 1 if the field type is a structure type, 0 otherwise. - */ -extern int bt_ctf_field_type_is_structure(struct bt_ctf_field_type *type); - -/* - * bt_ctf_field_type_is_array: returns whether or not a given field - * type is an array type. - * - * @param type Field type. - * - * Returns 1 if the field type is an array type, 0 otherwise. - */ -extern int bt_ctf_field_type_is_array(struct bt_ctf_field_type *type); - -/* - * bt_ctf_field_type_is_sequence: returns whether or not a given field - * type is a sequence type. - * - * @param type Field type. - * - * Returns 1 if the field type is a sequence type, 0 otherwise. - */ -extern int bt_ctf_field_type_is_sequence(struct bt_ctf_field_type *type); - -/* - * bt_ctf_field_type_is_variant: returns whether or not a given field - * type is a variant type. - * - * @param type Field type. - * - * Returns 1 if the field type is a variant type, 0 otherwise. - */ -extern int bt_ctf_field_type_is_variant(struct bt_ctf_field_type *type); - #ifdef __cplusplus } #endif