doc/api/libbabeltrace2/DoxygenLayout.xml: use `topics` tab
[babeltrace.git] / src / common / common.h
index 0f2736f00642782a3588b7675b94e7c97e136342..fd9da4e70f98a3430f6f9a44cfb751f31df28e1c 100644 (file)
@@ -1,29 +1,13 @@
-#ifndef BABELTRACE_COMMON_INTERNAL_H
-#define BABELTRACE_COMMON_INTERNAL_H
-
 /*
+ * SPDX-License-Identifier: MIT
+ *
  * 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.
  */
 
+#ifndef BABELTRACE_COMMON_INTERNAL_H
+#define BABELTRACE_COMMON_INTERNAL_H
+
 #include <errno.h>
 #include <glib.h>
 #include <inttypes.h>
 #include <stdbool.h>
 #include <stdint.h>
 #include <stdlib.h>
+#include <stdio.h>
 #include <unistd.h>
+#include <string.h>
 
-#include <babeltrace2/trace-ir/event-class-const.h>
-#include <babeltrace2/trace-ir/field-class-const.h>
-#include <babeltrace2/trace-ir/field-path-const.h>
-#include <babeltrace2/logging.h>
-#include <babeltrace2/value.h>
+#include <babeltrace2/babeltrace.h>
 
-#define __BT_FUNC_STATUS_ENABLE
+#define __BT_IN_BABELTRACE_H
 #include <babeltrace2/func-status.h>
-#undef __BT_FUNC_STATUS_ENABLE
 
 #include "common/assert.h"
 #include "common/macros.h"
 #include "common/safe.h"
 
-#define BT_COMMON_COLOR_RESET              "\033[0m"
-#define BT_COMMON_COLOR_BOLD               "\033[1m"
-#define BT_COMMON_COLOR_FG_DEFAULT         "\033[39m"
-#define BT_COMMON_COLOR_FG_RED             "\033[31m"
-#define BT_COMMON_COLOR_FG_GREEN           "\033[32m"
-#define BT_COMMON_COLOR_FG_YELLOW          "\033[33m"
-#define BT_COMMON_COLOR_FG_BLUE            "\033[34m"
-#define BT_COMMON_COLOR_FG_MAGENTA         "\033[35m"
-#define BT_COMMON_COLOR_FG_CYAN            "\033[36m"
-#define BT_COMMON_COLOR_FG_LIGHT_GRAY      "\033[37m"
-#define BT_COMMON_COLOR_BG_DEFAULT         "\033[49m"
-#define BT_COMMON_COLOR_BG_RED             "\033[41m"
-#define BT_COMMON_COLOR_BG_GREEN           "\033[42m"
-#define BT_COMMON_COLOR_BG_YELLOW          "\033[43m"
-#define BT_COMMON_COLOR_BG_BLUE            "\033[44m"
-#define BT_COMMON_COLOR_BG_MAGENTA         "\033[45m"
-#define BT_COMMON_COLOR_BG_CYAN            "\033[46m"
-#define BT_COMMON_COLOR_BG_LIGHT_GRAY      "\033[47m"
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#define BT_COMMON_COLOR_RESET                  "\033[0m"
+#define BT_COMMON_COLOR_BOLD                   "\033[1m"
+#define BT_COMMON_COLOR_FG_DEFAULT             "\033[39m"
+#define BT_COMMON_COLOR_FG_RED                 "\033[31m"
+#define BT_COMMON_COLOR_FG_GREEN               "\033[32m"
+#define BT_COMMON_COLOR_FG_YELLOW              "\033[33m"
+#define BT_COMMON_COLOR_FG_BLUE                        "\033[34m"
+#define BT_COMMON_COLOR_FG_MAGENTA             "\033[35m"
+#define BT_COMMON_COLOR_FG_CYAN                        "\033[36m"
+#define BT_COMMON_COLOR_FG_LIGHT_GRAY          "\033[37m"
+#define BT_COMMON_COLOR_FG_BOLD_RED            "\033[1m\033[31m"
+#define BT_COMMON_COLOR_FG_BOLD_GREEN          "\033[1m\033[32m"
+#define BT_COMMON_COLOR_FG_BOLD_YELLOW         "\033[1m\033[33m"
+#define BT_COMMON_COLOR_FG_BOLD_BLUE           "\033[1m\033[34m"
+#define BT_COMMON_COLOR_FG_BOLD_MAGENTA                "\033[1m\033[35m"
+#define BT_COMMON_COLOR_FG_BOLD_CYAN           "\033[1m\033[36m"
+#define BT_COMMON_COLOR_FG_BOLD_LIGHT_GRAY     "\033[1m\033[37m"
+#define BT_COMMON_COLOR_FG_BRIGHT_RED          "\033[91m"
+#define BT_COMMON_COLOR_FG_BRIGHT_GREEN                "\033[92m"
+#define BT_COMMON_COLOR_FG_BRIGHT_YELLOW       "\033[93m"
+#define BT_COMMON_COLOR_FG_BRIGHT_BLUE         "\033[94m"
+#define BT_COMMON_COLOR_FG_BRIGHT_MAGENTA      "\033[95m"
+#define BT_COMMON_COLOR_FG_BRIGHT_CYAN         "\033[96m"
+#define BT_COMMON_COLOR_FG_BRIGHT_LIGHT_GRAY   "\033[97m"
+#define BT_COMMON_COLOR_BG_DEFAULT             "\033[49m"
+#define BT_COMMON_COLOR_BG_RED                 "\033[41m"
+#define BT_COMMON_COLOR_BG_GREEN               "\033[42m"
+#define BT_COMMON_COLOR_BG_YELLOW              "\033[43m"
+#define BT_COMMON_COLOR_BG_BLUE                        "\033[44m"
+#define BT_COMMON_COLOR_BG_MAGENTA             "\033[45m"
+#define BT_COMMON_COLOR_BG_CYAN                        "\033[46m"
+#define BT_COMMON_COLOR_BG_LIGHT_GRAY          "\033[47m"
+
+enum bt_common_color_when {
+       BT_COMMON_COLOR_WHEN_AUTO,
+       BT_COMMON_COLOR_WHEN_ALWAYS,
+       BT_COMMON_COLOR_WHEN_NEVER,
+};
+
+struct bt_common_color_codes {
+       const char *reset;
+       const char *bold;
+       const char *fg_default;
+       const char *fg_red;
+       const char *fg_green;
+       const char *fg_yellow;
+       const char *fg_blue;
+       const char *fg_magenta;
+       const char *fg_cyan;
+       const char *fg_light_gray;
+       const char *fg_bright_red;
+       const char *fg_bright_green;
+       const char *fg_bright_yellow;
+       const char *fg_bright_blue;
+       const char *fg_bright_magenta;
+       const char *fg_bright_cyan;
+       const char *fg_bright_light_gray;
+       const char *bg_default;
+       const char *bg_red;
+       const char *bg_green;
+       const char *bg_yellow;
+       const char *bg_blue;
+       const char *bg_magenta;
+       const char *bg_cyan;
+       const char *bg_light_gray;
+};
 
 struct bt_common_lttng_live_url_parts {
        GString *proto;
@@ -80,14 +113,12 @@ struct bt_common_lttng_live_url_parts {
  * Checks if the current process has setuid or setgid access rights.
  * Returns `true` if so.
  */
-BT_HIDDEN
 bool bt_common_is_setuid_setgid(void);
 
 /*
  * Returns the system-wide plugin path, e.g.
  * `/usr/lib/babeltrace2/plugins`. Do not free the return value.
  */
-BT_HIDDEN
 const char *bt_common_get_system_plugin_path(void);
 
 /*
@@ -95,7 +126,6 @@ const char *bt_common_get_system_plugin_path(void);
  * `/home/user/.local/lib/babeltrace2/plugins`. You need to free the
  * return value.
  */
-BT_HIDDEN
 char *bt_common_get_home_plugin_path(int log_level);
 
 /*
@@ -103,77 +133,73 @@ char *bt_common_get_home_plugin_path(int log_level);
  * `paths` is a list of directories separated by `:`. Returns 0 on
  * success.
  */
-BT_HIDDEN
 int bt_common_append_plugin_path_dirs(const char *paths, GPtrArray *dirs);
 
 /*
  * Returns `true` if terminal color codes are supported for this
  * process.
  */
-BT_HIDDEN
 bool bt_common_colors_supported(void);
 
-BT_HIDDEN
 const char *bt_common_color_reset(void);
 
-BT_HIDDEN
 const char *bt_common_color_bold(void);
 
-BT_HIDDEN
 const char *bt_common_color_fg_default(void);
 
-BT_HIDDEN
 const char *bt_common_color_fg_red(void);
 
-BT_HIDDEN
 const char *bt_common_color_fg_green(void);
 
-BT_HIDDEN
 const char *bt_common_color_fg_yellow(void);
 
-BT_HIDDEN
 const char *bt_common_color_fg_blue(void);
 
-BT_HIDDEN
 const char *bt_common_color_fg_magenta(void);
 
-BT_HIDDEN
 const char *bt_common_color_fg_cyan(void);
 
-BT_HIDDEN
 const char *bt_common_color_fg_light_gray(void);
 
-BT_HIDDEN
+const char *bt_common_color_fg_bright_red(void);
+
+const char *bt_common_color_fg_bright_green(void);
+
+const char *bt_common_color_fg_bright_yellow(void);
+
+const char *bt_common_color_fg_bright_blue(void);
+
+const char *bt_common_color_fg_bright_magenta(void);
+
+const char *bt_common_color_fg_bright_cyan(void);
+
+const char *bt_common_color_fg_bright_light_gray(void);
+
 const char *bt_common_color_bg_default(void);
 
-BT_HIDDEN
 const char *bt_common_color_bg_red(void);
 
-BT_HIDDEN
 const char *bt_common_color_bg_green(void);
 
-BT_HIDDEN
 const char *bt_common_color_bg_yellow(void);
 
-BT_HIDDEN
 const char *bt_common_color_bg_blue(void);
 
-BT_HIDDEN
 const char *bt_common_color_bg_magenta(void);
 
-BT_HIDDEN
 const char *bt_common_color_bg_cyan(void);
 
-BT_HIDDEN
 const char *bt_common_color_bg_light_gray(void);
 
+void bt_common_color_get_codes(struct bt_common_color_codes *codes,
+               enum bt_common_color_when use_colors);
+
 /*
  * Returns the substring from `input` to the first character found
  * in the list of characters `end_chars`, unescaping any character
  * found in `escapable_chars`, and sets `*end_pos` to the position of
  * the end (from `input`). The caller owns the returned GString.
  */
-BT_HIDDEN
 GString *bt_common_string_until(const char *input, const char *escapable_chars,
                     const char *end_chars, size_t *end_pos);
 
@@ -184,21 +210,18 @@ GString *bt_common_string_until(const char *input, const char *escapable_chars,
  * prepend and append them manually, although they are not always
  * required. The caller owns the returned GString.
  */
-BT_HIDDEN
 GString *bt_common_shell_quote(const char *input, bool with_single_quotes);
 
 /*
  * Returns `true` if `input` is a string made only of printable
  * characters.
  */
-BT_HIDDEN
 bool bt_common_string_is_printable(const char *input);
 
 /*
  * Destroys the parts of an LTTng live URL as returned by
  * bt_common_parse_lttng_live_url().
  */
-BT_HIDDEN
 void bt_common_destroy_lttng_live_url_parts(
                struct bt_common_lttng_live_url_parts *parts);
 
@@ -208,7 +231,6 @@ void bt_common_destroy_lttng_live_url_parts(
  * up to `error_buf_size` bytes. You must destroy the returned value
  * with bt_common_destroy_lttng_live_url_parts().
  */
-BT_HIDDEN
 struct bt_common_lttng_live_url_parts bt_common_parse_lttng_live_url(
                const char *url, char *error_buf, size_t error_buf_size);
 
@@ -216,14 +238,12 @@ struct bt_common_lttng_live_url_parts bt_common_parse_lttng_live_url(
  * Normalizes (in place) a star globbing pattern to be used with
  * bt_common_star_glob_match(). This function always succeeds.
  */
-BT_HIDDEN
 void bt_common_normalize_star_glob_pattern(char *pattern);
 
 /*
  * Returns `true` if `candidate` (of size `candidate_len`) matches
  * the star globbing pattern `pattern` (of size `pattern_len`).
  */
-BT_HIDDEN
 bool bt_common_star_glob_match(const char *pattern, size_t pattern_len,
                 const char *candidate, size_t candidate_len);
 
@@ -239,7 +259,6 @@ bool bt_common_star_glob_match(const char *pattern, size_t pattern_len,
  *
  * The caller owns the returned GString.
  */
-BT_HIDDEN
 GString *bt_common_normalize_path(const char *path, const char *wd);
 
 typedef void (* bt_common_handle_custom_specifier_func)(void *priv_data,
@@ -294,31 +313,20 @@ typedef void (* bt_common_handle_custom_specifier_func)(void *priv_data,
  * do not return error codes: they abort when there's any error (bad
  * format string, for example).
  */
-BT_HIDDEN
 void bt_common_custom_vsnprintf(char *buf, size_t buf_size,
                char intro,
                bt_common_handle_custom_specifier_func handle_specifier,
                void *priv_data, const char *fmt, va_list *args);
 
-/*
- * Variadic form of bt_common_custom_vsnprintf().
- */
-BT_HIDDEN
-void bt_common_custom_snprintf(char *buf, size_t buf_size,
-               char intro,
-               bt_common_handle_custom_specifier_func handle_specifier,
-               void *priv_data, const char *fmt, ...);
-
 /*
  * Returns the system page size.
  */
-BT_HIDDEN
 size_t bt_common_get_page_size(int log_level);
 
 /*
  * Adds the digit separator `sep` as many times as needed to form groups
  * of `digits_per_group` digits within `str`. `str` must have enough
- * room to accomodate the new separators, that is:
+ * room to accommodate the new separators, that is:
  *
  *     strlen(str) + (strlen(str) / digits_per_group) + 1
  *
@@ -328,7 +336,6 @@ size_t bt_common_get_page_size(int log_level);
  * `strlen(str)` must not be 0. `digits_per_group` must not be 0. `sep`
  * must not be `\0`.
  */
-BT_HIDDEN
 void bt_common_sep_digits(char *str, unsigned int digits_per_group, char sep);
 
 /*
@@ -344,89 +351,96 @@ void bt_common_sep_digits(char *str, unsigned int digits_per_group, char sep);
  *
  * The returned string, on success, is owned by the caller.
  */
-BT_HIDDEN
 GString *bt_common_fold(const char *str, unsigned int total_length,
                unsigned int indent);
 
 /*
- * Wraps read() function to handle EINTR and partial reads.
- * On success, it returns `count` received as parameter. On error, it returns a
- * value smaller than the requested `count`.
+ * Writes the terminal's width to `*width`, its height to `*height`,
+ * and returns 0 on success, or returns -1 on error.
  */
-static inline
-ssize_t bt_common_read(int fd, void *buf, size_t count, int log_level)
-{
-       size_t i = 0;
-       ssize_t ret;
-
-       BT_ASSERT(buf);
-
-       /* Never return an overflow value. */
-       BT_ASSERT(count <= SSIZE_MAX);
-
-       do {
-               ret = read(fd, buf + i, count - i);
-               if (ret < 0) {
-                       if (errno == EINTR) {
-#ifdef BT_LOG_WRITE_CUR_LVL
-                               BT_LOG_WRITE_CUR_LVL(BT_LOG_DEBUG, log_level,
-                                       BT_LOG_TAG,
-                                       "read() call interrupted; retrying...");
-#endif
-                               /* retry operation */
-                               continue;
-                       } else {
-#ifdef BT_LOG_WRITE_ERRNO_CUR_LVL
-                               BT_LOG_WRITE_ERRNO_CUR_LVL(BT_LOG_ERROR,
-                                       log_level, BT_LOG_TAG,
-                                       "Error while reading", ": fd=%d", fd);
-#endif
-                               goto end;
-                       }
-               }
-               i += ret;
-               BT_ASSERT(i <= count);
-       } while (count - i > 0 && ret > 0);
+int bt_common_get_term_size(unsigned int *width, unsigned int *height);
 
-end:
-       if (ret >= 0) {
-               if (i == 0) {
-                       ret = -1;
-               } else {
-                       ret = i;
-               }
-       }
+/*
+ * Appends the textual content of `fp` to `str`, starting from its
+ * current position to the end of the file.
+ *
+ * This function does NOT rewind `fp` once it's done or on error.
+ */
+int bt_common_append_file_content_to_g_string(GString *str, FILE *fp);
 
-       return ret;
-}
+void bt_common_abort(void) __attribute__((noreturn));
 
 static inline
 const char *bt_common_field_class_type_string(enum bt_field_class_type class_type)
 {
        switch (class_type) {
+       case BT_FIELD_CLASS_TYPE_BOOL:
+               return "BOOL";
+       case BT_FIELD_CLASS_TYPE_BIT_ARRAY:
+               return "BIT_ARRAY";
+       case BT_FIELD_CLASS_TYPE_INTEGER:
+               return "INTEGER";
        case BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER:
-               return "BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER";
+               return "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";
+               return "SIGNED_INTEGER";
+       case BT_FIELD_CLASS_TYPE_ENUMERATION:
+               return "ENUMERATION";
        case BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION:
-               return "BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION";
+               return "UNSIGNED_ENUMERATION";
        case BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION:
-               return "BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION";
+               return "SIGNED_ENUMERATION";
+       case BT_FIELD_CLASS_TYPE_REAL:
+               return "REAL";
+       case BT_FIELD_CLASS_TYPE_SINGLE_PRECISION_REAL:
+               return "SINGLE_PRECISION_REAL";
+       case BT_FIELD_CLASS_TYPE_DOUBLE_PRECISION_REAL:
+               return "DOUBLE_PRECISION_REAL";
        case BT_FIELD_CLASS_TYPE_STRING:
-               return "BT_FIELD_CLASS_TYPE_STRING";
+               return "STRING";
        case BT_FIELD_CLASS_TYPE_STRUCTURE:
-               return "BT_FIELD_CLASS_TYPE_STRUCTURE";
+               return "STRUCTURE";
+       case BT_FIELD_CLASS_TYPE_ARRAY:
+               return "ARRAY";
        case BT_FIELD_CLASS_TYPE_STATIC_ARRAY:
-               return "BT_FIELD_CLASS_TYPE_STATIC_ARRAY";
+               return "STATIC_ARRAY";
        case BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY:
-               return "BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY";
+               return "DYNAMIC_ARRAY";
+       case BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITHOUT_LENGTH_FIELD:
+               return "DYNAMIC_ARRAY_WITHOUT_LENGTH_FIELD";
+       case BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITH_LENGTH_FIELD:
+               return "DYNAMIC_ARRAY_WITH_LENGTH_FIELD";
+       case BT_FIELD_CLASS_TYPE_OPTION:
+               return "OPTION";
+       case BT_FIELD_CLASS_TYPE_OPTION_WITHOUT_SELECTOR_FIELD:
+               return "OPTION_WITHOUT_SELECTOR_FIELD";
+       case BT_FIELD_CLASS_TYPE_OPTION_WITH_SELECTOR_FIELD:
+               return "OPTION_WITH_SELECTOR_FIELD";
+       case BT_FIELD_CLASS_TYPE_OPTION_WITH_BOOL_SELECTOR_FIELD:
+               return "OPTION_WITH_BOOL_SELECTOR_FIELD";
+       case BT_FIELD_CLASS_TYPE_OPTION_WITH_INTEGER_SELECTOR_FIELD:
+               return "OPTION_WITH_INTEGER_SELECTOR_FIELD";
+       case BT_FIELD_CLASS_TYPE_OPTION_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD:
+               return "OPTION_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD";
+       case BT_FIELD_CLASS_TYPE_OPTION_WITH_SIGNED_INTEGER_SELECTOR_FIELD:
+               return "OPTION_WITH_SIGNED_INTEGER_SELECTOR_FIELD";
        case BT_FIELD_CLASS_TYPE_VARIANT:
-               return "BT_FIELD_CLASS_TYPE_VARIANT";
-       default:
-               return "(unknown)";
+               return "VARIANT";
+       case BT_FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR_FIELD:
+               return "VARIANT_WITHOUT_SELECTOR_FIELD";
+       case BT_FIELD_CLASS_TYPE_VARIANT_WITH_SELECTOR_FIELD:
+               return "VARIANT_WITH_SELECTOR_FIELD";
+       case BT_FIELD_CLASS_TYPE_VARIANT_WITH_INTEGER_SELECTOR_FIELD:
+               return "VARIANT_WITH_INTEGER_SELECTOR_FIELD";
+       case BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD:
+               return "VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD";
+       case BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_INTEGER_SELECTOR_FIELD:
+               return "VARIANT_WITH_SIGNED_INTEGER_SELECTOR_FIELD";
+       case __BT_FIELD_CLASS_TYPE_BIG_VALUE:
+               bt_common_abort ();
        }
+
+       bt_common_abort();
 };
 
 static inline
@@ -434,33 +448,33 @@ const char *bt_common_field_class_integer_preferred_display_base_string(enum bt_
 {
        switch (base) {
        case BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_BINARY:
-               return "BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_BINARY";
+               return "BINARY";
        case BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_OCTAL:
-               return "BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_OCTAL";
+               return "OCTAL";
        case BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_DECIMAL:
-               return "BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_DECIMAL";
+               return "DECIMAL";
        case BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_HEXADECIMAL:
-               return "BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_HEXADECIMAL";
-       default:
-               return "(unknown)";
+               return "HEXADECIMAL";
        }
+
+       bt_common_abort();
 }
 
 static inline
-const char *bt_common_scope_string(enum bt_scope scope)
+const char *bt_common_scope_string(enum bt_field_path_scope scope)
 {
        switch (scope) {
-       case BT_SCOPE_PACKET_CONTEXT:
-               return "BT_SCOPE_PACKET_CONTEXT";
-       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";
-       default:
-               return "(unknown)";
+       case BT_FIELD_PATH_SCOPE_PACKET_CONTEXT:
+               return "PACKET_CONTEXT";
+       case BT_FIELD_PATH_SCOPE_EVENT_COMMON_CONTEXT:
+               return "EVENT_COMMON_CONTEXT";
+       case BT_FIELD_PATH_SCOPE_EVENT_SPECIFIC_CONTEXT:
+               return "EVENT_SPECIFIC_CONTEXT";
+       case BT_FIELD_PATH_SCOPE_EVENT_PAYLOAD:
+               return "EVENT_PAYLOAD";
        }
+
+       bt_common_abort();
 }
 
 static inline
@@ -469,38 +483,38 @@ const char *bt_common_event_class_log_level_string(
 {
        switch (level) {
        case BT_EVENT_CLASS_LOG_LEVEL_EMERGENCY:
-               return "BT_EVENT_CLASS_LOG_LEVEL_EMERGENCY";
+               return "EMERGENCY";
        case BT_EVENT_CLASS_LOG_LEVEL_ALERT:
-               return "BT_EVENT_CLASS_LOG_LEVEL_ALERT";
+               return "ALERT";
        case BT_EVENT_CLASS_LOG_LEVEL_CRITICAL:
-               return "BT_EVENT_CLASS_LOG_LEVEL_CRITICAL";
+               return "CRITICAL";
        case BT_EVENT_CLASS_LOG_LEVEL_ERROR:
-               return "BT_EVENT_CLASS_LOG_LEVEL_ERROR";
+               return "ERROR";
        case BT_EVENT_CLASS_LOG_LEVEL_WARNING:
-               return "BT_EVENT_CLASS_LOG_LEVEL_WARNING";
+               return "WARNING";
        case BT_EVENT_CLASS_LOG_LEVEL_NOTICE:
-               return "BT_EVENT_CLASS_LOG_LEVEL_NOTICE";
+               return "NOTICE";
        case BT_EVENT_CLASS_LOG_LEVEL_INFO:
-               return "BT_EVENT_CLASS_LOG_LEVEL_INFO";
+               return "INFO";
        case BT_EVENT_CLASS_LOG_LEVEL_DEBUG_SYSTEM:
-               return "BT_EVENT_CLASS_LOG_LEVEL_DEBUG_SYSTEM";
+               return "DEBUG_SYSTEM";
        case BT_EVENT_CLASS_LOG_LEVEL_DEBUG_PROGRAM:
-               return "BT_EVENT_CLASS_LOG_LEVEL_DEBUG_PROGRAM";
+               return "DEBUG_PROGRAM";
        case BT_EVENT_CLASS_LOG_LEVEL_DEBUG_PROCESS:
-               return "BT_EVENT_CLASS_LOG_LEVEL_DEBUG_PROCESS";
+               return "DEBUG_PROCESS";
        case BT_EVENT_CLASS_LOG_LEVEL_DEBUG_MODULE:
-               return "BT_EVENT_CLASS_LOG_LEVEL_DEBUG_MODULE";
+               return "DEBUG_MODULE";
        case BT_EVENT_CLASS_LOG_LEVEL_DEBUG_UNIT:
-               return "BT_EVENT_CLASS_LOG_LEVEL_DEBUG_UNIT";
+               return "DEBUG_UNIT";
        case BT_EVENT_CLASS_LOG_LEVEL_DEBUG_FUNCTION:
-               return "BT_EVENT_CLASS_LOG_LEVEL_DEBUG_FUNCTION";
+               return "DEBUG_FUNCTION";
        case BT_EVENT_CLASS_LOG_LEVEL_DEBUG_LINE:
-               return "BT_EVENT_CLASS_LOG_LEVEL_DEBUG_LINE";
+               return "DEBUG_LINE";
        case BT_EVENT_CLASS_LOG_LEVEL_DEBUG:
-               return "BT_EVENT_CLASS_LOG_LEVEL_DEBUG";
-       default:
-               return "(unknown)";
+               return "DEBUG";
        }
+
+       bt_common_abort();
 };
 
 static inline
@@ -508,63 +522,27 @@ const char *bt_common_value_type_string(enum bt_value_type type)
 {
        switch (type) {
        case BT_VALUE_TYPE_NULL:
-               return "BT_VALUE_TYPE_NULL";
+               return "NULL";
        case BT_VALUE_TYPE_BOOL:
-               return "BT_VALUE_TYPE_BOOL";
+               return "BOOL";
+       case BT_VALUE_TYPE_INTEGER:
+               return "INTEGER";
        case BT_VALUE_TYPE_UNSIGNED_INTEGER:
-               return "BT_VALUE_TYPE_UNSIGNED_INTEGER";
+               return "UNSIGNED_INTEGER";
        case BT_VALUE_TYPE_SIGNED_INTEGER:
-               return "BT_VALUE_TYPE_SIGNED_INTEGER";
+               return "SIGNED_INTEGER";
        case BT_VALUE_TYPE_REAL:
-               return "BT_VALUE_TYPE_REAL";
+               return "REAL";
        case BT_VALUE_TYPE_STRING:
-               return "BT_VALUE_TYPE_STRING";
+               return "STRING";
        case BT_VALUE_TYPE_ARRAY:
-               return "BT_VALUE_TYPE_ARRAY";
+               return "ARRAY";
        case BT_VALUE_TYPE_MAP:
-               return "BT_VALUE_TYPE_MAP";
-       default:
-               return "(unknown)";
+               return "MAP";
        }
-};
-
-static inline
-GString *bt_common_field_path_string(struct bt_field_path *path)
-{
-       GString *str = g_string_new(NULL);
-       uint64_t i;
 
-       BT_ASSERT(path);
-
-       if (!str) {
-               goto end;
-       }
-
-       g_string_append_printf(str, "[%s", bt_common_scope_string(
-               bt_field_path_get_root_scope(path)));
-
-       for (i = 0; i < bt_field_path_get_item_count(path); i++) {
-               const struct bt_field_path_item *fp_item =
-                       bt_field_path_borrow_item_by_index_const(path, i);
-
-               switch (bt_field_path_item_get_type(fp_item)) {
-               case BT_FIELD_PATH_ITEM_TYPE_INDEX:
-                       g_string_append_printf(str, ", %" PRIu64,
-                               bt_field_path_item_index_get_index(fp_item));
-                       break;
-               case BT_FIELD_PATH_ITEM_TYPE_CURRENT_ARRAY_ELEMENT:
-                       g_string_append(str, ", <CUR>");
-                       break;
-               default:
-                       abort();
-               }
-       }
-
-       g_string_append(str, "]");
-
-end:
-       return str;
-}
+       bt_common_abort();
+};
 
 static inline
 const char *bt_common_logging_level_string(
@@ -572,38 +550,34 @@ const char *bt_common_logging_level_string(
 {
        switch (level) {
        case BT_LOGGING_LEVEL_TRACE:
-               return "BT_LOGGING_LEVEL_TRACE";
+               return "TRACE";
        case BT_LOGGING_LEVEL_DEBUG:
-               return "BT_LOGGING_LEVEL_DEBUG";
+               return "DEBUG";
        case BT_LOGGING_LEVEL_INFO:
-               return "BT_LOGGING_LEVEL_INFO";
-       case BT_LOGGING_LEVEL_WARN:
-               return "BT_LOGGING_LEVEL_WARN";
+               return "INFO";
+       case BT_LOGGING_LEVEL_WARNING:
+               return "WARNING";
        case BT_LOGGING_LEVEL_ERROR:
-               return "BT_LOGGING_LEVEL_ERROR";
+               return "ERROR";
        case BT_LOGGING_LEVEL_FATAL:
-               return "BT_LOGGING_LEVEL_FATAL";
+               return "FATAL";
        case BT_LOGGING_LEVEL_NONE:
-               return "BT_LOGGING_LEVEL_NONE";
-       default:
-               return "(unknown)";
+               return "NONE";
        }
+
+       bt_common_abort();
 };
 
 static inline
 const char *bt_common_func_status_string(int status)
 {
        switch (status) {
-       case __BT_FUNC_STATUS_OVERFLOW:
+       case __BT_FUNC_STATUS_OVERFLOW_ERROR:
                return "OVERFLOW";
-       case __BT_FUNC_STATUS_INVALID_PARAMS:
-               return "INVALID_PARAMS";
-       case __BT_FUNC_STATUS_INVALID_OBJECT:
-               return "INVALID_OBJECT";
        case __BT_FUNC_STATUS_MEMORY_ERROR:
                return "MEMORY_ERROR";
-       case __BT_FUNC_STATUS_LOADING_ERROR:
-               return "LOADING_ERROR";
+       case __BT_FUNC_STATUS_USER_ERROR:
+               return "USER_ERROR";
        case __BT_FUNC_STATUS_ERROR:
                return "ERROR";
        case __BT_FUNC_STATUS_OK:
@@ -612,15 +586,17 @@ const char *bt_common_func_status_string(int status)
                return "END";
        case __BT_FUNC_STATUS_NOT_FOUND:
                return "NOT_FOUND";
+       case __BT_FUNC_STATUS_INTERRUPTED:
+               return "INTERRUPTED";
+       case __BT_FUNC_STATUS_NO_MATCH:
+               return "NO_MATCH";
        case __BT_FUNC_STATUS_AGAIN:
                return "AGAIN";
-       case __BT_FUNC_STATUS_UNSUPPORTED:
-               return "UNSUPPORTED";
-       case __BT_FUNC_STATUS_CANCELED:
-               return "CANCELED";
-       default:
-               return "(unknown)";
+       case __BT_FUNC_STATUS_UNKNOWN_OBJECT:
+               return "UNKNOWN_OBJECT";
        }
+
+       bt_common_abort();
 }
 
 #define NS_PER_S_I     INT64_C(1000000000)
@@ -640,7 +616,7 @@ int bt_common_clock_value_from_ns_from_origin(
        uint64_t value_period_cycles;
        int64_t ns_to_add;
 
-       BT_ASSERT(raw_value);
+       BT_ASSERT_DBG(raw_value);
 
        /* Compute offset part of requested value, in nanoseconds */
        if (!bt_safe_to_mul_int64(cc_offset_seconds, NS_PER_S_I)) {
@@ -714,6 +690,95 @@ end:
        return ret;
 }
 
-#include <babeltrace2/undef-func-status.h>
+/*
+ * bt_g_string_append_printf cannot be inlined because it expects a
+ * variadic argument list.
+ */
+__BT_ATTR_FORMAT_PRINTF(2, 3)
+int bt_common_g_string_append_printf(GString *str, const char *fmt, ...);
+
+static inline
+void bt_common_g_string_append(GString *str, const char *s)
+{
+       gsize len, allocated_len, s_len;
+
+       /* str->len excludes \0. */
+       len = str->len;
+       /* Exclude \0. */
+       allocated_len = str->allocated_len - 1;
+       s_len = strlen(s);
+       if (G_UNLIKELY(allocated_len < len + s_len)) {
+               /* Resize. */
+               g_string_set_size(str, len + s_len);
+       } else {
+               str->len = len + s_len;
+       }
+       memcpy(str->str + len, s, s_len + 1);
+}
+
+static inline
+void bt_common_g_string_append_c(GString *str, char c)
+{
+       gsize len, allocated_len, s_len;
+
+       /* str->len excludes \0. */
+       len = str->len;
+       /* Exclude \0. */
+       allocated_len = str->allocated_len - 1;
+       s_len = 1;
+       if (G_UNLIKELY(allocated_len < len + s_len)) {
+               /* Resize. */
+               g_string_set_size(str, len + s_len);
+       } else {
+               str->len = len + s_len;
+       }
+       str->str[len] = c;
+       str->str[len + 1] = '\0';
+}
+
+static inline
+const char *bt_common_component_class_type_string(
+               enum bt_component_class_type type)
+{
+       switch (type) {
+       case BT_COMPONENT_CLASS_TYPE_SOURCE:
+               return "SOURCE";
+       case BT_COMPONENT_CLASS_TYPE_SINK:
+               return "SINK";
+       case BT_COMPONENT_CLASS_TYPE_FILTER:
+               return "FILTER";
+       }
+
+       bt_common_abort();
+}
+
+static inline
+const char *bt_common_message_type_string(enum bt_message_type type)
+{
+       switch (type) {
+       case BT_MESSAGE_TYPE_STREAM_BEGINNING:
+               return "STREAM_BEGINNING";
+       case BT_MESSAGE_TYPE_STREAM_END:
+               return "STREAM_END";
+       case BT_MESSAGE_TYPE_EVENT:
+               return "EVENT";
+       case BT_MESSAGE_TYPE_PACKET_BEGINNING:
+               return "PACKET_BEGINNING";
+       case BT_MESSAGE_TYPE_PACKET_END:
+               return "PACKET_END";
+       case BT_MESSAGE_TYPE_DISCARDED_EVENTS:
+               return "DISCARDED_EVENTS";
+       case BT_MESSAGE_TYPE_DISCARDED_PACKETS:
+               return "DISCARDED_PACKETS";
+       case BT_MESSAGE_TYPE_MESSAGE_ITERATOR_INACTIVITY:
+               return "MESSAGE_ITERATOR_INACTIVITY";
+       }
+
+       bt_common_abort();
+}
+
+#ifdef __cplusplus
+}
+#endif
 
 #endif /* BABELTRACE_COMMON_INTERNAL_H */
This page took 0.0348 seconds and 4 git commands to generate.