lib: make trace IR API const-correct
[babeltrace.git] / include / babeltrace / common-internal.h
index 6428adda4a93d84e979c360e184d4f3b6a8e7a73..d27f8967688ca8d6f18fec218d69f596888da141 100644 (file)
@@ -1,13 +1,39 @@
 #ifndef BABELTRACE_COMMON_INTERNAL_H
 #define BABELTRACE_COMMON_INTERNAL_H
 
+/*
+ * Copyright (c) 2018 EfficiOS Inc. and Linux Foundation
+ * Copyright (c) 2018 Philippe Proulx <pproulx@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
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
 #include <stdbool.h>
 #include <babeltrace/assert-internal.h>
 #include <babeltrace/babeltrace-internal.h>
-#include <babeltrace/ctf-ir/field-types.h>
-#include <babeltrace/ctf-ir/field-path.h>
-#include <babeltrace/ctf-ir/event-class.h>
+#include <babeltrace/trace-ir/field-classes-const.h>
+#include <babeltrace/trace-ir/field-path-const.h>
+#include <babeltrace/trace-ir/event-class-const.h>
+#include <babeltrace/values.h>
 #include <stdarg.h>
+#include <inttypes.h>
+#include <stdint.h>
 #include <glib.h>
 
 #define BT_COMMON_COLOR_RESET              "\033[0m"
@@ -279,86 +305,46 @@ BT_HIDDEN
 size_t bt_common_get_page_size(void);
 
 static inline
-const char *bt_common_field_type_id_string(enum bt_field_type_id type_id)
-{
-       switch (type_id) {
-       case BT_FIELD_TYPE_ID_UNKNOWN:
-               return "BT_FIELD_TYPE_ID_UNKNOWN";
-       case BT_FIELD_TYPE_ID_INTEGER:
-               return "BT_FIELD_TYPE_ID_INTEGER";
-       case BT_FIELD_TYPE_ID_FLOAT:
-               return "BT_FIELD_TYPE_ID_FLOAT";
-       case BT_FIELD_TYPE_ID_ENUM:
-               return "BT_FIELD_TYPE_ID_ENUM";
-       case BT_FIELD_TYPE_ID_STRING:
-               return "BT_FIELD_TYPE_ID_STRING";
-       case BT_FIELD_TYPE_ID_STRUCT:
-               return "BT_FIELD_TYPE_ID_STRUCT";
-       case BT_FIELD_TYPE_ID_ARRAY:
-               return "BT_FIELD_TYPE_ID_ARRAY";
-       case BT_FIELD_TYPE_ID_SEQUENCE:
-               return "BT_FIELD_TYPE_ID_SEQUENCE";
-       case BT_FIELD_TYPE_ID_VARIANT:
-               return "BT_FIELD_TYPE_ID_VARIANT";
-       default:
-               return "(unknown)";
-       }
-};
-
-static inline
-const char *bt_common_byte_order_string(enum bt_byte_order bo)
-{
-       switch (bo) {
-       case BT_BYTE_ORDER_UNKNOWN:
-               return "BT_BYTE_ORDER_UNKNOWN";
-       case BT_BYTE_ORDER_UNSPECIFIED:
-               return "BT_BYTE_ORDER_UNSPECIFIED";
-       case BT_BYTE_ORDER_NATIVE:
-               return "BT_BYTE_ORDER_NATIVE";
-       case BT_BYTE_ORDER_LITTLE_ENDIAN:
-               return "BT_BYTE_ORDER_LITTLE_ENDIAN";
-       case BT_BYTE_ORDER_BIG_ENDIAN:
-               return "BT_BYTE_ORDER_BIG_ENDIAN";
-       case BT_BYTE_ORDER_NETWORK:
-               return "BT_BYTE_ORDER_NETWORK";
-       default:
-               return "(unknown)";
-       }
-};
-
-static inline
-const char *bt_common_string_encoding_string(enum bt_string_encoding encoding)
+const char *bt_common_field_class_type_string(enum bt_field_class_type class_type)
 {
-       switch (encoding) {
-       case BT_STRING_ENCODING_UNKNOWN:
-               return "BT_STRING_ENCODING_UNKNOWN";
-       case BT_STRING_ENCODING_NONE:
-               return "BT_STRING_ENCODING_NONE";
-       case BT_STRING_ENCODING_UTF8:
-               return "BT_STRING_ENCODING_UTF8";
-       case BT_STRING_ENCODING_ASCII:
-               return "BT_STRING_ENCODING_ASCII";
+       switch (class_type) {
+       case BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER:
+               return "BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER";
+       case BT_FIELD_CLASS_TYPE_SIGNED_INTEGER:
+               return "BT_FIELD_CLASS_TYPE_SIGNED_INTEGER";
+       case BT_FIELD_CLASS_TYPE_REAL:
+               return "BT_FIELD_CLASS_TYPE_REAL";
+       case BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION:
+               return "BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION";
+       case BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION:
+               return "BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION";
+       case BT_FIELD_CLASS_TYPE_STRING:
+               return "BT_FIELD_CLASS_TYPE_STRING";
+       case BT_FIELD_CLASS_TYPE_STRUCTURE:
+               return "BT_FIELD_CLASS_TYPE_STRUCTURE";
+       case BT_FIELD_CLASS_TYPE_STATIC_ARRAY:
+               return "BT_FIELD_CLASS_TYPE_STATIC_ARRAY";
+       case BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY:
+               return "BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY";
+       case BT_FIELD_CLASS_TYPE_VARIANT:
+               return "BT_FIELD_CLASS_TYPE_VARIANT";
        default:
                return "(unknown)";
        }
 };
 
 static inline
-const char *bt_common_integer_base_string(enum bt_integer_base base)
+const char *bt_common_field_class_integer_preferred_display_base_string(enum bt_field_class_integer_preferred_display_base base)
 {
        switch (base) {
-       case BT_INTEGER_BASE_UNKNOWN:
-               return "BT_INTEGER_BASE_UNKNOWN";
-       case BT_INTEGER_BASE_UNSPECIFIED:
-               return "BT_INTEGER_BASE_UNSPECIFIED";
-       case BT_INTEGER_BASE_BINARY:
-               return "BT_INTEGER_BASE_BINARY";
-       case BT_INTEGER_BASE_OCTAL:
-               return "BT_INTEGER_BASE_OCTAL";
-       case BT_INTEGER_BASE_DECIMAL:
-               return "BT_INTEGER_BASE_DECIMAL";
-       case BT_INTEGER_BASE_HEXADECIMAL:
-               return "BT_INTEGER_BASE_HEXADECIMAL";
+       case BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_BINARY:
+               return "BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_BINARY";
+       case BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_OCTAL:
+               return "BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_OCTAL";
+       case BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_DECIMAL:
+               return "BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_DECIMAL";
+       case BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_HEXADECIMAL:
+               return "BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_HEXADECIMAL";
        default:
                return "(unknown)";
        }
@@ -368,22 +354,18 @@ static inline
 const char *bt_common_scope_string(enum bt_scope scope)
 {
        switch (scope) {
-       case BT_SCOPE_UNKNOWN:
-               return "BT_SCOPE_UNKNOWN";
-       case BT_SCOPE_TRACE_PACKET_HEADER:
-               return "BT_SCOPE_TRACE_PACKET_HEADER";
-       case BT_SCOPE_STREAM_PACKET_CONTEXT:
-               return "BT_SCOPE_STREAM_PACKET_CONTEXT";
-       case BT_SCOPE_STREAM_EVENT_HEADER:
-               return "BT_SCOPE_STREAM_EVENT_HEADER";
-       case BT_SCOPE_STREAM_EVENT_CONTEXT:
-               return "BT_SCOPE_STREAM_EVENT_CONTEXT";
-       case BT_SCOPE_EVENT_CONTEXT:
-               return "BT_SCOPE_EVENT_CONTEXT";
+       case BT_SCOPE_PACKET_HEADER:
+               return "BT_SCOPE_PACKET_HEADER";
+       case BT_SCOPE_PACKET_CONTEXT:
+               return "BT_SCOPE_PACKET_CONTEXT";
+       case BT_SCOPE_EVENT_HEADER:
+               return "BT_SCOPE_EVENT_HEADER";
+       case BT_SCOPE_EVENT_COMMON_CONTEXT:
+               return "BT_SCOPE_EVENT_COMMON_CONTEXT";
+       case BT_SCOPE_EVENT_SPECIFIC_CONTEXT:
+               return "BT_SCOPE_EVENT_SPECIFIC_CONTEXT";
        case BT_SCOPE_EVENT_PAYLOAD:
                return "BT_SCOPE_EVENT_PAYLOAD";
-       case BT_SCOPE_ENV:
-               return "BT_SCOPE_ENV";
        default:
                return "(unknown)";
        }
@@ -394,10 +376,6 @@ const char *bt_common_event_class_log_level_string(
                enum bt_event_class_log_level level)
 {
        switch (level) {
-       case BT_EVENT_CLASS_LOG_LEVEL_UNKNOWN:
-               return "BT_EVENT_CLASS_LOG_LEVEL_UNKNOWN";
-       case BT_EVENT_CLASS_LOG_LEVEL_UNSPECIFIED:
-               return "BT_EVENT_CLASS_LOG_LEVEL_UNSPECIFIED";
        case BT_EVENT_CLASS_LOG_LEVEL_EMERGENCY:
                return "BT_EVENT_CLASS_LOG_LEVEL_EMERGENCY";
        case BT_EVENT_CLASS_LOG_LEVEL_ALERT:
@@ -433,11 +411,34 @@ const char *bt_common_event_class_log_level_string(
        }
 };
 
+static inline
+const char *bt_common_value_type_string(enum bt_value_type type)
+{
+       switch (type) {
+       case BT_VALUE_TYPE_NULL:
+               return "BT_VALUE_TYPE_NULL";
+       case BT_VALUE_TYPE_BOOL:
+               return "BT_VALUE_TYPE_BOOL";
+       case BT_VALUE_TYPE_INTEGER:
+               return "BT_VALUE_TYPE_INTEGER";
+       case BT_VALUE_TYPE_REAL:
+               return "BT_VALUE_TYPE_REAL";
+       case BT_VALUE_TYPE_STRING:
+               return "BT_VALUE_TYPE_STRING";
+       case BT_VALUE_TYPE_ARRAY:
+               return "BT_VALUE_TYPE_ARRAY";
+       case BT_VALUE_TYPE_MAP:
+               return "BT_VALUE_TYPE_MAP";
+       default:
+               return "(unknown)";
+       }
+};
+
 static inline
 GString *bt_field_path_string(struct bt_field_path *path)
 {
        GString *str = g_string_new(NULL);
-       size_t i;
+       uint64_t i;
 
        BT_ASSERT(path);
 
@@ -449,9 +450,8 @@ GString *bt_field_path_string(struct bt_field_path *path)
                bt_field_path_get_root_scope(path)));
 
        for (i = 0; i < bt_field_path_get_index_count(path); i++) {
-               int index = bt_field_path_get_index(path, i);
-
-               g_string_append_printf(str, ", %d", index);
+               g_string_append_printf(str, ", %" PRIu64,
+                       bt_field_path_get_index_by_index(path, i));
        }
 
        g_string_append(str, "]");
This page took 0.02751 seconds and 4 git commands to generate.