Add bt_common_append_file_content_to_g_string()
[babeltrace.git] / src / common / common.h
index 23c913efbb809d6f2f5ca72c7f68724cec584b2a..1751f20bd74ad65c47fcb07b1362906f6ac7b7d2 100644 (file)
 #include <stdbool.h>
 #include <stdint.h>
 #include <stdlib.h>
+#include <stdio.h>
 #include <unistd.h>
+#include <string.h>
 
-#include <babeltrace2/graph/self-message-iterator.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/graph/self-component.h>
-#include <babeltrace2/graph/message-iterator-const.h>
-#include <babeltrace2/logging.h>
-#include <babeltrace2/value.h>
+#include <babeltrace2/babeltrace.h>
+
+#define __BT_IN_BABELTRACE_H
+#include <babeltrace2/func-status.h>
 
 #include "common/assert.h"
 #include "common/macros.h"
@@ -330,6 +328,39 @@ size_t bt_common_get_page_size(int log_level);
 BT_HIDDEN
 void bt_common_sep_digits(char *str, unsigned int digits_per_group, char sep);
 
+/*
+ * This is similar to what the command `fold --spaces` does: it wraps
+ * the input lines of `str`, breaking at spaces, and indenting each line
+ * with `indent` spaces so that each line fits the total length
+ * `total_length`.
+ *
+ * If an original line in `str` contains a word which is >= the content
+ * length (`total_length - indent`), then the corresponding folded line
+ * is also larger than the content length. In other words, breaking at
+ * spaces is a best effort, but it might not be possible.
+ *
+ * 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);
+
+/*
+ * Writes the terminal's width to `*width`, its height to `*height`,
+ * and returns 0 on success, or returns -1 on error.
+ */
+BT_HIDDEN
+int bt_common_get_term_size(unsigned int *width, unsigned int *height);
+
+/*
+ * 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.
+ */
+BT_HIDDEN
+int bt_common_append_file_content_to_g_string(GString *str, FILE *fp);
+
 /*
  * Wraps read() function to handle EINTR and partial reads.
  * On success, it returns `count` received as parameter. On error, it returns a
@@ -387,25 +418,29 @@ const char *bt_common_field_class_type_string(enum bt_field_class_type class_typ
 {
        switch (class_type) {
        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";
+               return "SIGNED_INTEGER";
        case BT_FIELD_CLASS_TYPE_REAL:
-               return "BT_FIELD_CLASS_TYPE_REAL";
+               return "REAL";
        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_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_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";
-       case BT_FIELD_CLASS_TYPE_VARIANT:
-               return "BT_FIELD_CLASS_TYPE_VARIANT";
+               return "DYNAMIC_ARRAY";
+       case BT_FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR:
+               return "VARIANT_WITHOUT_SELECTOR";
+       case BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_SELECTOR:
+               return "VARIANT_WITH_UNSIGNED_SELECTOR";
+       case BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_SELECTOR:
+               return "VARIANT_WITH_SIGNED_SELECTOR";
        default:
                return "(unknown)";
        }
@@ -416,30 +451,30 @@ 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";
+               return "HEXADECIMAL";
        default:
                return "(unknown)";
        }
 }
 
 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";
+       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";
        default:
                return "(unknown)";
        }
@@ -451,35 +486,35 @@ 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";
+               return "DEBUG";
        default:
                return "(unknown)";
        }
@@ -490,21 +525,21 @@ 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_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";
+               return "MAP";
        default:
                return "(unknown)";
        }
@@ -548,85 +583,52 @@ end:
        return str;
 }
 
-static inline
-const char *bt_common_self_message_iterator_status_string(
-               enum bt_self_message_iterator_status status)
-{
-       switch (status) {
-       case BT_SELF_MESSAGE_ITERATOR_STATUS_AGAIN:
-               return "BT_SELF_MESSAGE_ITERATOR_STATUS_AGAIN";
-       case BT_SELF_MESSAGE_ITERATOR_STATUS_END:
-               return "BT_SELF_MESSAGE_ITERATOR_STATUS_END";
-       case BT_SELF_MESSAGE_ITERATOR_STATUS_OK:
-               return "BT_SELF_MESSAGE_ITERATOR_STATUS_OK";
-       case BT_SELF_MESSAGE_ITERATOR_STATUS_ERROR:
-               return "BT_SELF_MESSAGE_ITERATOR_STATUS_ERROR";
-       case BT_SELF_MESSAGE_ITERATOR_STATUS_NOMEM:
-               return "BT_SELF_MESSAGE_ITERATOR_STATUS_NOMEM";
-       default:
-               return "(unknown)";
-       }
-};
-
 static inline
 const char *bt_common_logging_level_string(
                enum bt_logging_level level)
 {
        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";
+               return "NONE";
        default:
                return "(unknown)";
        }
 };
 
 static inline
-const char *bt_self_component_status_string(
-               enum bt_self_component_status status)
+const char *bt_common_func_status_string(int status)
 {
        switch (status) {
-       case BT_SELF_COMPONENT_STATUS_OK:
-               return "BT_SELF_COMPONENT_STATUS_OK";
-       case BT_SELF_COMPONENT_STATUS_END:
-               return "BT_SELF_COMPONENT_STATUS_END";
-       case BT_SELF_COMPONENT_STATUS_AGAIN:
-               return "BT_SELF_COMPONENT_STATUS_AGAIN";
-       case BT_SELF_COMPONENT_STATUS_ERROR:
-               return "BT_SELF_COMPONENT_STATUS_ERROR";
-       case BT_SELF_COMPONENT_STATUS_NOMEM:
-               return "BT_SELF_COMPONENT_STATUS_NOMEM";
-       default:
-               return "(unknown)";
-       }
-}
-
-static inline
-const char *bt_message_iterator_status_string(
-               enum bt_message_iterator_status status)
-{
-       switch (status) {
-       case BT_MESSAGE_ITERATOR_STATUS_AGAIN:
-               return "BT_MESSAGE_ITERATOR_STATUS_AGAIN";
-       case BT_MESSAGE_ITERATOR_STATUS_END:
-               return "BT_MESSAGE_ITERATOR_STATUS_END";
-       case BT_MESSAGE_ITERATOR_STATUS_OK:
-               return "BT_MESSAGE_ITERATOR_STATUS_OK";
-       case BT_MESSAGE_ITERATOR_STATUS_ERROR:
-               return "BT_MESSAGE_ITERATOR_STATUS_ERROR";
-       case BT_MESSAGE_ITERATOR_STATUS_NOMEM:
-               return "BT_MESSAGE_ITERATOR_STATUS_NOMEM";
+       case __BT_FUNC_STATUS_OVERFLOW_ERROR:
+               return "OVERFLOW";
+       case __BT_FUNC_STATUS_UNKNOWN_OBJECT:
+               return "UNKNOWN_OBJECT";
+       case __BT_FUNC_STATUS_MEMORY_ERROR:
+               return "MEMORY_ERROR";
+       case __BT_FUNC_STATUS_ERROR:
+               return "ERROR";
+       case __BT_FUNC_STATUS_OK:
+               return "OK";
+       case __BT_FUNC_STATUS_END:
+               return "END";
+       case __BT_FUNC_STATUS_NOT_FOUND:
+               return "NOT_FOUND";
+       case __BT_FUNC_STATUS_AGAIN:
+               return "AGAIN";
+       case __BT_FUNC_STATUS_INTERRUPTED:
+               return "INTERRUPTED";
        default:
                return "(unknown)";
        }
@@ -723,11 +725,50 @@ end:
        return ret;
 }
 
+/*
+ * bt_g_string_append_printf cannot be inlined because it expects a
+ * variadic argument list.
+ */
+BT_HIDDEN
+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
-enum bt_self_message_iterator_status bt_common_message_iterator_status_to_self(
-               enum bt_message_iterator_status status)
+void bt_common_g_string_append_c(GString *str, char c)
 {
-       return (int) status;
+       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';
 }
 
 #endif /* BABELTRACE_COMMON_INTERNAL_H */
This page took 0.028185 seconds and 4 git commands to generate.